service/v3_1/SugarWebServiceUtilv3_1.php

   1 <?php
   2 /*********************************************************************************
   3  * SugarCRM Community Edition is a customer relationship management program developed by
   4  * SugarCRM, Inc. Copyright (C) 2004-2011 SugarCRM Inc.
   5  *
   6  * This program is free software; you can redistribute it and/or modify it under
   7  * the terms of the GNU Affero General Public License version 3 as published by the
   8  * Free Software Foundation with the addition of the following permission added
   9  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
  10  * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
  11  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
  12  *
  13  * This program is distributed in the hope that it will be useful, but WITHOUT
  14  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  15  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
  16  * details.
  17  *
  18  * You should have received a copy of the GNU Affero General Public License along with
  19  * this program; if not, see http://www.gnu.org/licenses or write to the Free
  20  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  21  * 02110-1301 USA.
  22  *
  23  * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
  24  * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
  25  *
  26  * The interactive user interfaces in modified source and object code versions
  27  * of this program must display Appropriate Legal Notices, as required under
  28  * Section 5 of the GNU Affero General Public License version 3.
  29  *
  30  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
  31  * these Appropriate Legal Notices must retain the display of the "Powered by
  32  * SugarCRM" logo. If the display of the logo is not reasonably feasible for
  33  * technical reasons, the Appropriate Legal Notices must display the words
  34  * "Powered by SugarCRM".
  35  ********************************************************************************/
  36
  37 require_once('service/v3/SugarWebServiceUtilv3.php');
  38 class SugarWebServiceUtilv3_1 extends SugarWebServiceUtilv3
  39 {
  40
  41     function get_return_module_fields($value, $module,$fields, $translate=true)
  42     {
  43                 $GLOBALS['log']->info('Begin: SoapHelperWebServices->get_return_module_fields');
  44                 global $module_name;
  45                 $module_name = $module;
  46                 $result = $this->get_field_list($value,$fields,  $translate);
  47                 $GLOBALS['log']->info('End: SoapHelperWebServices->get_return_module_fields');
  48
  49                 $tableName = $value->getTableName();
  50
  51                 return Array('module_name'=>$module, 'table_name' => $tableName,
  52                                         'module_fields'=> $result['module_fields'],
  53                                         'link_fields'=> $result['link_fields'],
  54                                         );
  55         } // fn
  56
  57
  58     /**
  59          * Track a view for a particular bean.
  60          *
  61          * @param SugarBean $seed
  62          * @param string $current_view
  63          */
  64     function trackView($seed, $current_view)
  65     {
  66         $trackerManager = TrackerManager::getInstance();
  67                 if($monitor = $trackerManager->getMonitor('tracker'))
  68                 {
  69                 $monitor->setValue('date_modified', TimeDate::getInstance()->nowDb());
  70                 $monitor->setValue('user_id', $GLOBALS['current_user']->id);
  71                 $monitor->setValue('module_name', $seed->module_dir);
  72                 $monitor->setValue('action', $current_view);
  73                 $monitor->setValue('item_id', $seed->id);
  74                 $monitor->setValue('item_summary', $seed->get_summary_text());
  75                 $monitor->setValue('visible',true);
  76                 $trackerManager->saveMonitor($monitor, TRUE, TRUE);
  77                 }
  78     }
  79
  80     /**
  81      * Convert modules list to Web services result
  82      *
  83      * @param array $list List of module candidates (only keys are used)
  84      * @param array $availModules List of module availability from Session
  85      */
  86     public function getModulesFromList($list, $availModules)
  87     {
  88         global $app_list_strings;
  89         $enabled_modules = array();
  90         $availModulesKey = array_flip($availModules);
  91         foreach ($list as $key=>$value)
  92         {
  93             if( isset($availModulesKey[$key]) )
  94             {
  95                 $label = !empty( $app_list_strings['moduleList'][$key] ) ? $app_list_strings['moduleList'][$key] : '';
  96                     $acl = self::checkModuleRoleAccess($key);
  97                     $enabled_modules[] = array('module_key' => $key,'module_label' => $label, 'acls' => $acl);
  98             }
  99         }
 100         return $enabled_modules;
 101     }
 102
 103     /**
 104      * Examine the wireless_module_registry to determine which modules have been enabled for the mobile view.
 105      *
 106      * @param array $availModules An array of all the modules the user already has access to.
 107      * @return array Modules enalbed for mobile view.
 108      */
 109     function get_visible_mobile_modules($availModules)
 110     {
 111         foreach ( array ( '','custom/') as $prefix)
 112         {
 113                 if(file_exists($prefix.'include/MVC/Controller/wireless_module_registry.php'))
 114                         require $prefix.'include/MVC/Controller/wireless_module_registry.php' ;
 115         }
 116         return $this->getModulesFromList($wireless_module_registry, $availModules);
 117     }
 118
 119     /**
 120      * Examine the application to determine which modules have been enabled..
 121      *
 122      * @param array $availModules An array of all the modules the user already has access to.
 123      * @return array Modules enabled within the application.
 124      */
 125     function get_visible_modules($availModules)
 126     {
 127         require_once("modules/MySettings/TabController.php");
 128         $controller = new TabController();
 129         $tabs = $controller->get_tabs_system();
 130         return $this->getModulesFromList($tabs[0], $availModules);
 131     }
 132
 133     /**
 134      * Generate unifed search fields for a particular module even if the module does not participate in the unified search.
 135      *
 136      * @param string $moduleName
 137      * @return array An array of fields to be searched against.
 138      */
 139     function generateUnifiedSearchFields($moduleName)
 140     {
 141         global $beanList, $beanFiles, $dictionary;
 142
 143         if(!isset($beanList[$moduleName]))
 144             return array();
 145
 146         $beanName = $beanList[$moduleName];
 147
 148         if (!isset($beanFiles[$beanName]))
 149             return array();
 150
 151         if($beanName == 'aCase')
 152             $beanName = 'Case';
 153
 154         $manager = new VardefManager ( );
 155         $manager->loadVardef( $moduleName , $beanName ) ;
 156
 157         // obtain the field definitions used by generateSearchWhere (duplicate code in view.list.php)
 158         if(file_exists('custom/modules/'.$moduleName.'/metadata/metafiles.php')){
 159             require('custom/modules/'.$moduleName.'/metadata/metafiles.php');
 160         }elseif(file_exists('modules/'.$moduleName.'/metadata/metafiles.php')){
 161             require('modules/'.$moduleName.'/metadata/metafiles.php');
 162         }
 163
 164         if(!empty($metafiles[$moduleName]['searchfields']))
 165             require $metafiles[$moduleName]['searchfields'] ;
 166         elseif(file_exists("modules/{$moduleName}/metadata/SearchFields.php"))
 167             require "modules/{$moduleName}/metadata/SearchFields.php" ;
 168
 169         $fields = array();
 170         foreach ( $dictionary [ $beanName ][ 'fields' ] as $field => $def )
 171         {
 172             if (strpos($field,'email') !== false)
 173                 $field = 'email' ;
 174
 175             //bug: 38139 - allow phone to be searched through Global Search
 176             if (strpos($field,'phone') !== false)
 177                 $field = 'phone' ;
 178
 179             if ( isset($def['unified_search']) && $def['unified_search'] && isset ( $searchFields [ $moduleName ] [ $field ]  ))
 180             {
 181                     $fields [ $field ] = $searchFields [ $moduleName ] [ $field ] ;
 182             }
 183         }
 184
 185         //If no fields with the unified flag have been set then lets add a default field.
 186         if( empty($fields) )
 187         {
 188             if( isset($dictionary[$beanName]['fields']['name']) && isset($searchFields[$moduleName]['name'])  )
 189                 $fields['name'] = $searchFields[$moduleName]['name'];
 190             else
 191             {
 192                 if( isset($dictionary[$beanName]['fields']['first_name']) && isset($searchFields[$moduleName]['first_name']) )
 193                     $fields['first_name'] = $searchFields[$moduleName]['first_name'];
 194                 if( isset($dictionary[$beanName]['fields']['last_name']) && isset($searchFields[$moduleName]['last_name'])  )
 195                     $fields['last_name'] = $searchFields[$moduleName]['last_name'];
 196             }
 197         }
 198
 199                 return $fields;
 200     }
 201
 202     /**
 203      * Check a module for acces to a set of available actions.
 204      *
 205      * @param string $module
 206      * @return array results containing access and boolean indicating access
 207      */
 208     function checkModuleRoleAccess($module)
 209     {
 210         $results = array();
 211         $actions = array('edit','delete','list','view','import','export');
 212         foreach ($actions as $action)
 213         {
 214             $access = ACLController::checkAccess($module, $action, true);
 215             $results[] = array('action' => $action, 'access' => $access);
 216         }
 217
 218         return $results;
 219     }
 220
 221     function get_field_list($value,$fields,  $translate=true) {
 222
 223             $GLOBALS['log']->info('Begin: SoapHelperWebServices->get_field_list');
 224                 $module_fields = array();
 225                 $link_fields = array();
 226                 if(!empty($value->field_defs)){
 227
 228                         foreach($value->field_defs as $var){
 229                                 if(!empty($fields) && !in_array( $var['name'], $fields))continue;
 230                                 if(isset($var['source']) && ($var['source'] != 'db' && $var['source'] != 'non-db' &&$var['source'] != 'custom_fields') && $var['name'] != 'email1' && $var['name'] != 'email2' && (!isset($var['type'])|| $var['type'] != 'relate'))continue;
 231                                 if ((isset($var['source']) && $var['source'] == 'non_db') && (isset($var['type']) && $var['type'] != 'link')) {
 232                                         continue;
 233                                 }
 234                                 $required = 0;
 235                                 $options_dom = array();
 236                                 $options_ret = array();
 237                                 // Apparently the only purpose of this check is to make sure we only return fields
 238                                 //   when we've read a record.  Otherwise this function is identical to get_module_field_list
 239                                 if( isset($var['required']) && ($var['required'] || $var['required'] == 'true' ) ){
 240                                         $required = 1;
 241                                 }
 242
 243                                 if($var['type'] == 'bool')
 244                                     $var['options'] = 'checkbox_dom';
 245
 246                                 if(isset($var['options'])){
 247                                         $options_dom = translate($var['options'], $value->module_dir);
 248                                         if(!is_array($options_dom)) $options_dom = array();
 249                                         foreach($options_dom as $key=>$oneOption)
 250                                                 $options_ret[$key] = $this->get_name_value($key,$oneOption);
 251                                 }
 252
 253                     if(!empty($var['dbType']) && $var['type'] == 'bool') {
 254                         $options_ret['type'] = $this->get_name_value('type', $var['dbType']);
 255                     }
 256
 257                     $entry = array();
 258                     $entry['name'] = $var['name'];
 259                     $entry['type'] = $var['type'];
 260                     $entry['group'] = isset($var['group']) ? $var['group'] : '';
 261                     $entry['id_name'] = isset($var['id_name']) ? $var['id_name'] : '';
 262
 263                     if ($var['type'] == 'link') {
 264                             $entry['relationship'] = (isset($var['relationship']) ? $var['relationship'] : '');
 265                             $entry['module'] = (isset($var['module']) ? $var['module'] : '');
 266                             $entry['bean_name'] = (isset($var['bean_name']) ? $var['bean_name'] : '');
 267                                         $link_fields[$var['name']] = $entry;
 268                     } else {
 269                             if($translate) {
 270                                 $entry['label'] = isset($var['vname']) ? translate($var['vname'], $value->module_dir) : $var['name'];
 271                             } else {
 272                                 $entry['label'] = isset($var['vname']) ? $var['vname'] : $var['name'];
 273                             }
 274                             $entry['required'] = $required;
 275                             $entry['options'] = $options_ret;
 276                             $entry['related_module'] = (isset($var['id_name']) && isset($var['module'])) ? $var['module'] : '';
 277                             $entry['calculated'] =  (isset($var['calculated']) && $var['calculated']) ? true : false;
 278                                         if(isset($var['default'])) {
 279                                            $entry['default_value'] = $var['default'];
 280                                         }
 281                                         if( $var['type'] == 'parent' && isset($var['type_name']) )
 282                                            $entry['type_name'] = $var['type_name'];
 283
 284                                         $module_fields[$var['name']] = $entry;
 285                     } // else
 286                         } //foreach
 287                 } //if
 288
 289                 if($value->module_dir == 'Meetings' || $value->module_dir == 'Calls')
 290                 {
 291                     if( isset($module_fields['duration_minutes']) && isset($GLOBALS['app_list_strings']['duration_intervals']))
 292                     {
 293                         $options_dom = $GLOBALS['app_list_strings']['duration_intervals'];
 294                         $options_ret = array();
 295                         foreach($options_dom as $key=>$oneOption)
 296                                                 $options_ret[$key] = $this->get_name_value($key,$oneOption);
 297
 298                         $module_fields['duration_minutes']['options'] = $options_ret;
 299                     }
 300                 }
 301
 302                 if($value->module_dir == 'Bugs'){
 303                         require_once('modules/Releases/Release.php');
 304                         $seedRelease = new Release();
 305                         $options = $seedRelease->get_releases(TRUE, "Active");
 306                         $options_ret = array();
 307                         foreach($options as $name=>$value){
 308                                 $options_ret[] =  array('name'=> $name , 'value'=>$value);
 309                         }
 310                         if(isset($module_fields['fixed_in_release'])){
 311                                 $module_fields['fixed_in_release']['type'] = 'enum';
 312                                 $module_fields['fixed_in_release']['options'] = $options_ret;
 313                         }
 314             if(isset($module_fields['found_in_release'])){
 315                 $module_fields['found_in_release']['type'] = 'enum';
 316                 $module_fields['found_in_release']['options'] = $options_ret;
 317             }
 318                         if(isset($module_fields['release'])){
 319                                 $module_fields['release']['type'] = 'enum';
 320                                 $module_fields['release']['options'] = $options_ret;
 321                         }
 322                         if(isset($module_fields['release_name'])){
 323                                 $module_fields['release_name']['type'] = 'enum';
 324                                 $module_fields['release_name']['options'] = $options_ret;
 325                         }
 326                 }
 327
 328                 if(isset($value->assigned_user_name) && isset($module_fields['assigned_user_id'])) {
 329                         $module_fields['assigned_user_name'] = $module_fields['assigned_user_id'];
 330                         $module_fields['assigned_user_name']['name'] = 'assigned_user_name';
 331                 }
 332                 if(isset($value->assigned_name) && isset($module_fields['team_id'])) {
 333                         $module_fields['team_name'] = $module_fields['team_id'];
 334                         $module_fields['team_name']['name'] = 'team_name';
 335                 }
 336                 if(isset($module_fields['modified_user_id'])) {
 337                         $module_fields['modified_by_name'] = $module_fields['modified_user_id'];
 338                         $module_fields['modified_by_name']['name'] = 'modified_by_name';
 339                 }
 340                 if(isset($module_fields['created_by'])) {
 341                         $module_fields['created_by_name'] = $module_fields['created_by'];
 342                         $module_fields['created_by_name']['name'] = 'created_by_name';
 343                 }
 344
 345                 $GLOBALS['log']->info('End: SoapHelperWebServices->get_field_list');
 346                 return array('module_fields' => $module_fields, 'link_fields' => $link_fields);
 347         }
 348
 349         /**
 350          * Return the contents of a file base64 encoded
 351          *
 352          * @param string $filename - Full path of filename
 353          * @param bool $remove - Indicates if the file should be removed after the contents is retrieved.
 354          *
 355          * @return string - Contents base64'd.
 356          */
 357         function get_file_contents_base64($filename, $remove = FALSE)
 358         {
 359             $contents = "";
 360             if( file_exists($filename) )
 361             {
 362                 $contents =  base64_encode(file_get_contents($filename));
 363                 if($remove)
 364                 @unlink($filename);
 365             }
 366
 367             return $contents;
 368         }
 369
 370         function get_module_view_defs($module_name, $type, $view){
 371         require_once('include/MVC/View/SugarView.php');
 372         $metadataFile = null;
 373         $results = array();
 374         $view = strtolower($view);
 375         switch (strtolower($type)){
 376             case 'wireless':
 377                 if( $view == 'list'){
 378                     require_once('include/SugarWireless/SugarWirelessListView.php');
 379                     $GLOBALS['module'] = $module_name; //WirelessView keys off global variable not instance variable...
 380                     $v = new SugarWirelessListView();
 381                     $results = $v->getMetaDataFile();
 382                 }
 383                 elseif ($view == 'subpanel')
 384                     $results = $this->get_subpanel_defs($module_name, $type);
 385                 else{
 386                     require_once('include/SugarWireless/SugarWirelessView.php');
 387                     $v = new SugarWirelessView();
 388                     $v->module = $module_name;
 389                     $fullView = ucfirst($view) . 'View';
 390                     $meta = $v->getMetaDataFile('Wireless' . $fullView);
 391                     $metadataFile = $meta['filename'];
 392                     require($metadataFile);
 393                     //Wireless detail metadata may actually be just edit metadata.
 394                     $results = isset($viewdefs[$meta['module_name']][$fullView] ) ? $viewdefs[$meta['module_name']][$fullView] : $viewdefs[$meta['module_name']]['EditView'];
 395                 }
 396
 397                 break;
 398             case 'default':
 399             default:
 400                 if ($view == 'subpanel')
 401                     $results = $this->get_subpanel_defs($module_name, $type);
 402                 else
 403                 {
 404                     $v = new SugarView(null,array());
 405                     $v->module = $module_name;
 406                     $v->type = $view;
 407                     $fullView = ucfirst($view) . 'View';
 408                     $metadataFile = $v->getMetaDataFile();
 409                     require_once($metadataFile);
 410                     if($view == 'list')
 411                         $results = $listViewDefs[$module_name];
 412                     else
 413                         $results = $viewdefs[$module_name][$fullView];
 414                 }
 415         }
 416
 417         return $results;
 418     }
 419
 420     /**
 421      * Equivalent of get_list function within SugarBean but allows the possibility to pass in an indicator
 422      * if the list should filter for favorites.  Should eventually update the SugarBean function as well.
 423      *
 424      */
 425     function get_data_list($seed, $order_by = "", $where = "", $row_offset = 0, $limit=-1, $max=-1, $show_deleted = 0, $favorites = false, $singleSelect=false)
 426         {
 427                 $GLOBALS['log']->debug("get_list:  order_by = '$order_by' and where = '$where' and limit = '$limit'");
 428                 if(isset($_SESSION['show_deleted']))
 429                 {
 430                         $show_deleted = 1;
 431                 }
 432                 $order_by=$seed->process_order_by($order_by, null);
 433
 434                 if($seed->bean_implements('ACL') && ACLController::requireOwner($seed->module_dir, 'list') )
 435                 {
 436                         global $current_user;
 437                         $owner_where = $seed->getOwnerWhere($current_user->id);
 438                         if(!empty($owner_where)){
 439                                 if(empty($where)){
 440                                         $where = $owner_where;
 441                                 }else{
 442                                         $where .= ' AND '.  $owner_where;
 443                                 }
 444                         }
 445                 }
 446                 $params = array();
 447                 if($favorites)
 448                   $params['favorites'] = true;
 449
 450                 $query = $seed->create_new_list_query($order_by, $where,array(),$params, $show_deleted,'',false,null,$singleSelect);
 451                 return $seed->process_list_query($query, $row_offset, $limit, $max, $where);
 452         }
 453
 454     /**
 455      * Add ACL values to metadata files.
 456      *
 457      * @param String $module_name
 458      * @param String $view_type (wireless or detail)
 459      * @param String $view  (list, detail,edit, etc)
 460      * @param array $metadata The metadata for the view type and view.
 461      * @return unknown
 462      */
 463         function addFieldLevelACLs($module_name,$view_type, $view, $metadata)
 464         {
 465             $functionName = "metdataAclParser" . ucfirst($view_type) . ucfirst($view);
 466             if( method_exists($this, $functionName) )
 467                return $this->$functionName($module_name, $metadata);
 468             else
 469                return $metadata;
 470         }
 471
 472         /**
 473          * Parse wireless listview metadata and add ACL values.
 474          *
 475          * @param String $module_name
 476          * @param array $metadata
 477          * @return array Metadata with acls added
 478          */
 479         function metdataAclParserWirelessList($module_name, $metadata)
 480         {
 481             global  $beanList, $beanFiles;
 482             $class_name = $beanList[$module_name];
 483             require_once($beanFiles[$class_name]);
 484             $seed = new $class_name();
 485
 486             $results = array();
 487             foreach ($metadata as $field_name => $entry)
 488             {
 489                 if($seed->bean_implements('ACL'))
 490                     $entry['acl'] = $this->getFieldLevelACLValue($seed->module_dir, strtolower($field_name));
 491                 else
 492                     $entry['acl'] = 99;
 493
 494                 $results[$field_name] = $entry;
 495             }
 496
 497             return $results;
 498         }
 499
 500         /**
 501          * Parse wireless detailview metadata and add ACL values.
 502          *
 503          * @param String $module_name
 504          * @param array $metadata
 505          * @return array Metadata with acls added
 506          */
 507         function metdataAclParserWirelessEdit($module_name, $metadata)
 508         {
 509             global  $beanList, $beanFiles;
 510             $class_name = $beanList[$module_name];
 511             require_once($beanFiles[$class_name]);
 512             $seed = new $class_name();
 513
 514             $results = array();
 515             $results['templateMeta'] = $metadata['templateMeta'];
 516             $aclRows = array();
 517             //Wireless metadata only has a single panel definition.
 518             foreach ($metadata['panels'] as $row)
 519             {
 520                 $aclRow = array();
 521                 foreach ($row as $field)
 522                 {
 523                     $aclField = array();
 524                     if( is_string($field) )
 525                         $aclField['name'] = $field;
 526                     else
 527                         $aclField = $field;
 528
 529                     if($seed->bean_implements('ACL'))
 530                         $aclField['acl'] = $this->getFieldLevelACLValue($seed->module_dir, $aclField['name']);
 531                     else
 532                         $aclField['acl'] = 99;
 533
 534                     $aclRow[] = $aclField;
 535                 }
 536                 $aclRows[] = $aclRow;
 537             }
 538
 539             $results['panels'] = $aclRows;
 540             return $results;
 541         }
 542         /**
 543          * Return the field level acl raw value.  We cannot use the hasAccess call as we do not have a valid bean
 544          * record at the moment and therefore can not specify the is_owner flag.  We need the raw access value so we
 545          * can do the computation on the client side.  TODO: Move function into ACLField class.
 546          *
 547          * @param String $module Name of the module
 548          * @param String $field Name of the field
 549          * @return int
 550          */
 551         function getFieldLevelACLValue($module, $field, $current_user = null)
 552         {
 553             if($current_user == null)
 554                $current_user = $GLOBALS['current_user'];
 555
 556             if( is_admin($current_user) )
 557                  return 99;
 558
 559             if(!isset($_SESSION['ACL'][$current_user->id][$module]['fields'][$field])){
 560                          return 99;
 561                 }
 562
 563                 return $_SESSION['ACL'][$current_user->id][$module]['fields'][$field];
 564         }
 565 }