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-2012 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         $beanName = BeanFactory::getObjectName($moduleName);
 152
 153         $manager = new VardefManager ( );
 154         $manager->loadVardef( $moduleName , $beanName ) ;
 155
 156         // obtain the field definitions used by generateSearchWhere (duplicate code in view.list.php)
 157         if(file_exists('custom/modules/'.$moduleName.'/metadata/metafiles.php')){
 158             require('custom/modules/'.$moduleName.'/metadata/metafiles.php');
 159         }elseif(file_exists('modules/'.$moduleName.'/metadata/metafiles.php')){
 160             require('modules/'.$moduleName.'/metadata/metafiles.php');
 161         }
 162
 163         if(!empty($metafiles[$moduleName]['searchfields']))
 164             require $metafiles[$moduleName]['searchfields'] ;
 165         elseif(file_exists("modules/{$moduleName}/metadata/SearchFields.php"))
 166             require "modules/{$moduleName}/metadata/SearchFields.php" ;
 167
 168         $fields = array();
 169         foreach ( $dictionary [ $beanName ][ 'fields' ] as $field => $def )
 170         {
 171             if (strpos($field,'email') !== false)
 172                 $field = 'email' ;
 173
 174             //bug: 38139 - allow phone to be searched through Global Search
 175             if (strpos($field,'phone') !== false)
 176                 $field = 'phone' ;
 177
 178             if ( isset($def['unified_search']) && $def['unified_search'] && isset ( $searchFields [ $moduleName ] [ $field ]  ))
 179             {
 180                     $fields [ $field ] = $searchFields [ $moduleName ] [ $field ] ;
 181             }
 182         }
 183
 184         //If no fields with the unified flag have been set then lets add a default field.
 185         if( empty($fields) )
 186         {
 187             if( isset($dictionary[$beanName]['fields']['name']) && isset($searchFields[$moduleName]['name'])  )
 188                 $fields['name'] = $searchFields[$moduleName]['name'];
 189             else
 190             {
 191                 if( isset($dictionary[$beanName]['fields']['first_name']) && isset($searchFields[$moduleName]['first_name']) )
 192                     $fields['first_name'] = $searchFields[$moduleName]['first_name'];
 193                 if( isset($dictionary[$beanName]['fields']['last_name']) && isset($searchFields[$moduleName]['last_name'])  )
 194                     $fields['last_name'] = $searchFields[$moduleName]['last_name'];
 195             }
 196         }
 197
 198                 return $fields;
 199     }
 200
 201     /**
 202      * Check a module for acces to a set of available actions.
 203      *
 204      * @param string $module
 205      * @return array results containing access and boolean indicating access
 206      */
 207     function checkModuleRoleAccess($module)
 208     {
 209         $results = array();
 210         $actions = array('edit','delete','list','view','import','export');
 211         foreach ($actions as $action)
 212         {
 213             $access = ACLController::checkAccess($module, $action, true);
 214             $results[] = array('action' => $action, 'access' => $access);
 215         }
 216
 217         return $results;
 218     }
 219
 220     function get_field_list($value,$fields,  $translate=true) {
 221
 222             $GLOBALS['log']->info('Begin: SoapHelperWebServices->get_field_list');
 223                 $module_fields = array();
 224                 $link_fields = array();
 225                 if(!empty($value->field_defs)){
 226
 227                         foreach($value->field_defs as $var){
 228                                 if(!empty($fields) && !in_array( $var['name'], $fields))continue;
 229                                 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;
 230                                 if ((isset($var['source']) && $var['source'] == 'non_db') && (isset($var['type']) && $var['type'] != 'link')) {
 231                                         continue;
 232                                 }
 233                                 $required = 0;
 234                                 $options_dom = array();
 235                                 $options_ret = array();
 236                                 // Apparently the only purpose of this check is to make sure we only return fields
 237                                 //   when we've read a record.  Otherwise this function is identical to get_module_field_list
 238                                 if( isset($var['required']) && ($var['required'] || $var['required'] == 'true' ) ){
 239                                         $required = 1;
 240                                 }
 241
 242                                 if($var['type'] == 'bool')
 243                                     $var['options'] = 'checkbox_dom';
 244
 245                                 if(isset($var['options'])){
 246                                         $options_dom = translate($var['options'], $value->module_dir);
 247                                         if(!is_array($options_dom)) $options_dom = array();
 248                                         foreach($options_dom as $key=>$oneOption)
 249                                                 $options_ret[$key] = $this->get_name_value($key,$oneOption);
 250                                 }
 251
 252                     if(!empty($var['dbType']) && $var['type'] == 'bool') {
 253                         $options_ret['type'] = $this->get_name_value('type', $var['dbType']);
 254                     }
 255
 256                     $entry = array();
 257                     $entry['name'] = $var['name'];
 258                     $entry['type'] = $var['type'];
 259                     $entry['group'] = isset($var['group']) ? $var['group'] : '';
 260                     $entry['id_name'] = isset($var['id_name']) ? $var['id_name'] : '';
 261
 262                     if ($var['type'] == 'link') {
 263                             $entry['relationship'] = (isset($var['relationship']) ? $var['relationship'] : '');
 264                             $entry['module'] = (isset($var['module']) ? $var['module'] : '');
 265                             $entry['bean_name'] = (isset($var['bean_name']) ? $var['bean_name'] : '');
 266                                         $link_fields[$var['name']] = $entry;
 267                     } else {
 268                             if($translate) {
 269                                 $entry['label'] = isset($var['vname']) ? translate($var['vname'], $value->module_dir) : $var['name'];
 270                             } else {
 271                                 $entry['label'] = isset($var['vname']) ? $var['vname'] : $var['name'];
 272                             }
 273                             $entry['required'] = $required;
 274                             $entry['options'] = $options_ret;
 275                             $entry['related_module'] = (isset($var['id_name']) && isset($var['module'])) ? $var['module'] : '';
 276                             $entry['calculated'] =  (isset($var['calculated']) && $var['calculated']) ? true : false;
 277                                         if(isset($var['default'])) {
 278                                            $entry['default_value'] = $var['default'];
 279                                         }
 280                                         if( $var['type'] == 'parent' && isset($var['type_name']) )
 281                                            $entry['type_name'] = $var['type_name'];
 282
 283                                         $module_fields[$var['name']] = $entry;
 284                     } // else
 285                         } //foreach
 286                 } //if
 287
 288                 if($value->module_dir == 'Meetings' || $value->module_dir == 'Calls')
 289                 {
 290                     if( isset($module_fields['duration_minutes']) && isset($GLOBALS['app_list_strings']['duration_intervals']))
 291                     {
 292                         $options_dom = $GLOBALS['app_list_strings']['duration_intervals'];
 293                         $options_ret = array();
 294                         foreach($options_dom as $key=>$oneOption)
 295                                                 $options_ret[$key] = $this->get_name_value($key,$oneOption);
 296
 297                         $module_fields['duration_minutes']['options'] = $options_ret;
 298                     }
 299                 }
 300
 301                 if($value->module_dir == 'Bugs'){
 302                         require_once('modules/Releases/Release.php');
 303                         $seedRelease = new Release();
 304                         $options = $seedRelease->get_releases(TRUE, "Active");
 305                         $options_ret = array();
 306                         foreach($options as $name=>$value){
 307                                 $options_ret[] =  array('name'=> $name , 'value'=>$value);
 308                         }
 309                         if(isset($module_fields['fixed_in_release'])){
 310                                 $module_fields['fixed_in_release']['type'] = 'enum';
 311                                 $module_fields['fixed_in_release']['options'] = $options_ret;
 312                         }
 313             if(isset($module_fields['found_in_release'])){
 314                 $module_fields['found_in_release']['type'] = 'enum';
 315                 $module_fields['found_in_release']['options'] = $options_ret;
 316             }
 317                         if(isset($module_fields['release'])){
 318                                 $module_fields['release']['type'] = 'enum';
 319                                 $module_fields['release']['options'] = $options_ret;
 320                         }
 321                         if(isset($module_fields['release_name'])){
 322                                 $module_fields['release_name']['type'] = 'enum';
 323                                 $module_fields['release_name']['options'] = $options_ret;
 324                         }
 325                 }
 326
 327                 if(isset($value->assigned_user_name) && isset($module_fields['assigned_user_id'])) {
 328                         $module_fields['assigned_user_name'] = $module_fields['assigned_user_id'];
 329                         $module_fields['assigned_user_name']['name'] = 'assigned_user_name';
 330                 }
 331                 if(isset($value->assigned_name) && isset($module_fields['team_id'])) {
 332                         $module_fields['team_name'] = $module_fields['team_id'];
 333                         $module_fields['team_name']['name'] = 'team_name';
 334                 }
 335                 if(isset($module_fields['modified_user_id'])) {
 336                         $module_fields['modified_by_name'] = $module_fields['modified_user_id'];
 337                         $module_fields['modified_by_name']['name'] = 'modified_by_name';
 338                 }
 339                 if(isset($module_fields['created_by'])) {
 340                         $module_fields['created_by_name'] = $module_fields['created_by'];
 341                         $module_fields['created_by_name']['name'] = 'created_by_name';
 342                 }
 343
 344                 $GLOBALS['log']->info('End: SoapHelperWebServices->get_field_list');
 345                 return array('module_fields' => $module_fields, 'link_fields' => $link_fields);
 346         }
 347
 348         /**
 349          * Return the contents of a file base64 encoded
 350          *
 351          * @param string $filename - Full path of filename
 352          * @param bool $remove - Indicates if the file should be removed after the contents is retrieved.
 353          *
 354          * @return string - Contents base64'd.
 355          */
 356         function get_file_contents_base64($filename, $remove = FALSE)
 357         {
 358             $contents = "";
 359             if( file_exists($filename) )
 360             {
 361                 $contents =  base64_encode(file_get_contents($filename));
 362                 if($remove)
 363                 @unlink($filename);
 364             }
 365
 366             return $contents;
 367         }
 368
 369         function get_module_view_defs($module_name, $type, $view){
 370         require_once('include/MVC/View/SugarView.php');
 371         $metadataFile = null;
 372         $results = array();
 373         $view = strtolower($view);
 374         switch (strtolower($type)){
 375             case 'wireless':
 376                 if( $view == 'list'){
 377                     require_once('include/SugarWireless/SugarWirelessListView.php');
 378                     $GLOBALS['module'] = $module_name; //WirelessView keys off global variable not instance variable...
 379                     $v = new SugarWirelessListView();
 380                     $results = $v->getMetaDataFile();
 381                 }
 382                 elseif ($view == 'subpanel')
 383                     $results = $this->get_subpanel_defs($module_name, $type);
 384                 else{
 385                     require_once('include/SugarWireless/SugarWirelessView.php');
 386                     $v = new SugarWirelessView();
 387                     $v->module = $module_name;
 388                     $fullView = ucfirst($view) . 'View';
 389                     $meta = $v->getMetaDataFile('Wireless' . $fullView);
 390                     $metadataFile = $meta['filename'];
 391                     require($metadataFile);
 392                     //Wireless detail metadata may actually be just edit metadata.
 393                     $results = isset($viewdefs[$meta['module_name']][$fullView] ) ? $viewdefs[$meta['module_name']][$fullView] : $viewdefs[$meta['module_name']]['EditView'];
 394                 }
 395
 396                 break;
 397             case 'default':
 398             default:
 399                 if ($view == 'subpanel')
 400                     $results = $this->get_subpanel_defs($module_name, $type);
 401                 else
 402                 {
 403                     $v = new SugarView(null,array());
 404                     $v->module = $module_name;
 405                     $v->type = $view;
 406                     $fullView = ucfirst($view) . 'View';
 407                     $metadataFile = $v->getMetaDataFile();
 408                     require_once($metadataFile);
 409                     if($view == 'list')
 410                         $results = $listViewDefs[$module_name];
 411                     else
 412                         $results = $viewdefs[$module_name][$fullView];
 413                 }
 414         }
 415
 416         return $results;
 417     }
 418
 419     /**
 420      * Equivalent of get_list function within SugarBean but allows the possibility to pass in an indicator
 421      * if the list should filter for favorites.  Should eventually update the SugarBean function as well.
 422      *
 423      */
 424     function get_data_list($seed, $order_by = "", $where = "", $row_offset = 0, $limit=-1, $max=-1, $show_deleted = 0, $favorites = false, $singleSelect=false)
 425         {
 426                 $GLOBALS['log']->debug("get_list:  order_by = '$order_by' and where = '$where' and limit = '$limit'");
 427                 if(isset($_SESSION['show_deleted']))
 428                 {
 429                         $show_deleted = 1;
 430                 }
 431                 $order_by=$seed->process_order_by($order_by, null);
 432
 433                 if($seed->bean_implements('ACL') && ACLController::requireOwner($seed->module_dir, 'list') )
 434                 {
 435                         global $current_user;
 436                         $owner_where = $seed->getOwnerWhere($current_user->id);
 437                         if(!empty($owner_where)){
 438                                 if(empty($where)){
 439                                         $where = $owner_where;
 440                                 }else{
 441                                         $where .= ' AND '.  $owner_where;
 442                                 }
 443                         }
 444                 }
 445                 $params = array();
 446                 if($favorites)
 447                   $params['favorites'] = true;
 448
 449                 $query = $seed->create_new_list_query($order_by, $where,array(),$params, $show_deleted,'',false,null,$singleSelect);
 450                 return $seed->process_list_query($query, $row_offset, $limit, $max, $where);
 451         }
 452
 453     /**
 454      * Add ACL values to metadata files.
 455      *
 456      * @param String $module_name
 457      * @param String $view_type (wireless or detail)
 458      * @param String $view  (list, detail,edit, etc)
 459      * @param array $metadata The metadata for the view type and view.
 460      * @return unknown
 461      */
 462         function addFieldLevelACLs($module_name,$view_type, $view, $metadata)
 463         {
 464             $functionName = "metdataAclParser" . ucfirst($view_type) . ucfirst($view);
 465             if( method_exists($this, $functionName) )
 466                return $this->$functionName($module_name, $metadata);
 467             else
 468                return $metadata;
 469         }
 470
 471         /**
 472          * Parse wireless listview metadata and add ACL values.
 473          *
 474          * @param String $module_name
 475          * @param array $metadata
 476          * @return array Metadata with acls added
 477          */
 478         function metdataAclParserWirelessList($module_name, $metadata)
 479         {
 480             global  $beanList, $beanFiles;
 481             $class_name = $beanList[$module_name];
 482             require_once($beanFiles[$class_name]);
 483             $seed = new $class_name();
 484
 485             $results = array();
 486             foreach ($metadata as $field_name => $entry)
 487             {
 488                 if($seed->bean_implements('ACL'))
 489                     $entry['acl'] = $this->getFieldLevelACLValue($seed->module_dir, strtolower($field_name));
 490                 else
 491                     $entry['acl'] = 99;
 492
 493                 $results[$field_name] = $entry;
 494             }
 495
 496             return $results;
 497         }
 498
 499         /**
 500          * Parse wireless detailview metadata and add ACL values.
 501          *
 502          * @param String $module_name
 503          * @param array $metadata
 504          * @return array Metadata with acls added
 505          */
 506         function metdataAclParserWirelessEdit($module_name, $metadata)
 507         {
 508             global  $beanList, $beanFiles;
 509             $class_name = $beanList[$module_name];
 510             require_once($beanFiles[$class_name]);
 511             $seed = new $class_name();
 512
 513             $results = array();
 514             $results['templateMeta'] = $metadata['templateMeta'];
 515             $aclRows = array();
 516             //Wireless metadata only has a single panel definition.
 517             foreach ($metadata['panels'] as $row)
 518             {
 519                 $aclRow = array();
 520                 foreach ($row as $field)
 521                 {
 522                     $aclField = array();
 523                     if( is_string($field) )
 524                         $aclField['name'] = $field;
 525                     else
 526                         $aclField = $field;
 527
 528                     if($seed->bean_implements('ACL'))
 529                         $aclField['acl'] = $this->getFieldLevelACLValue($seed->module_dir, $aclField['name']);
 530                     else
 531                         $aclField['acl'] = 99;
 532
 533                     $aclRow[] = $aclField;
 534                 }
 535                 $aclRows[] = $aclRow;
 536             }
 537
 538             $results['panels'] = $aclRows;
 539             return $results;
 540         }
 541         /**
 542          * Return the field level acl raw value.  We cannot use the hasAccess call as we do not have a valid bean
 543          * record at the moment and therefore can not specify the is_owner flag.  We need the raw access value so we
 544          * can do the computation on the client side.  TODO: Move function into ACLField class.
 545          *
 546          * @param String $module Name of the module
 547          * @param String $field Name of the field
 548          * @return int
 549          */
 550         function getFieldLevelACLValue($module, $field, $current_user = null)
 551         {
 552             if($current_user == null)
 553                $current_user = $GLOBALS['current_user'];
 554
 555             if( is_admin($current_user) )
 556                  return 99;
 557
 558             if(!isset($_SESSION['ACL'][$current_user->id][$module]['fields'][$field])){
 559                          return 99;
 560                 }
 561
 562                 return $_SESSION['ACL'][$current_user->id][$module]['fields'][$field];
 563         }
 564 }