service/v3/SugarWebServiceUtilv3.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/core/SoapHelperWebService.php');
  38 class SugarWebServiceUtilv3 extends SoapHelperWebServices {
  39
  40     function filter_fields($value, $fields)
  41     {
  42         $GLOBALS['log']->info('Begin: SoapHelperWebServices->filter_fields');
  43         global $invalid_contact_fields;
  44         $filterFields = array();
  45         foreach($fields as $field)
  46         {
  47             if (is_array($invalid_contact_fields))
  48             {
  49                 if (in_array($field, $invalid_contact_fields))
  50                 {
  51                     continue;
  52                 }
  53             }
  54             if (isset($value->field_defs[$field]))
  55             {
  56                 $var = $value->field_defs[$field];
  57                 if( isset($var['source'])
  58                     && ($var['source'] != 'db' && $var['source'] != 'custom_fields' && $var['source'] != 'non-db')
  59                     && $var['name'] != 'email1' && $var['name'] != 'email2'
  60                     && (!isset($var['type'])|| $var['type'] != 'relate')) {
  61
  62                     if( $value->module_dir == 'Emails'
  63                         && (($var['name'] == 'description') || ($var['name'] == 'description_html') || ($var['name'] == 'from_addr_name')
  64                             || ($var['name'] == 'reply_to_addr') || ($var['name'] == 'to_addrs_names') || ($var['name'] == 'cc_addrs_names')
  65                             || ($var['name'] == 'bcc_addrs_names') || ($var['name'] == 'raw_source')))
  66                     {
  67
  68                     }
  69                     else
  70                     {
  71                         continue;
  72                     }
  73                 }
  74             }
  75             $filterFields[] = $field;
  76         }
  77         $GLOBALS['log']->info('End: SoapHelperWebServices->filter_fields');
  78         return $filterFields;
  79     }
  80
  81     function getRelationshipResults($bean, $link_field_name, $link_module_fields, $optional_where = '', $order_by = '') {
  82                 $GLOBALS['log']->info('Begin: SoapHelperWebServices->getRelationshipResults');
  83                 require_once('include/TimeDate.php');
  84                 global  $beanList, $beanFiles, $current_user;
  85                 global $disable_date_format;
  86
  87                 $bean->load_relationship($link_field_name);
  88                 if (isset($bean->$link_field_name)) {
  89                         // get the query object for this link field
  90                         $query_array = $bean->$link_field_name->getQuery(true,array(),0,'',true);
  91                         if (isset($query_array['where'])) {
  92                                 $query_array['where'] = str_ireplace("where", "", $query_array['where']);
  93                                 if (!empty($optional_where)) {
  94                                         $optional_where = $query_array['where'] . " and " . $optional_where;
  95                                 } else {
  96                                         $optional_where = $query_array['where'];
  97                                 } // else
  98                         } // if
  99
 100                         $params = array();
 101                         $params['joined_tables'] = $query_array['join_tables'];
 102
 103                         // get the related module name and instantiate a bean for that.
 104                         $submodulename = $bean->$link_field_name->getRelatedModuleName();
 105                         $submoduleclass = $beanList[$submodulename];
 106                         require_once($beanFiles[$submoduleclass]);
 107                         $submodule = new $submoduleclass();
 108                         $filterFields = $this->filter_fields($submodule, $link_module_fields);
 109                         $relFields = $bean->$link_field_name->getRelatedFields();
 110                         $roleSelect = '';
 111
 112                         $idSetInSubModule = false;
 113                         if($submodulename == 'Users' && !in_array('id', $link_module_fields)){
 114                                 $link_module_fields[] = 'id';
 115                                 $idSetInSubModule = true;
 116                         }
 117
 118                         if(!empty($relFields)){
 119                                 foreach($link_module_fields as $field){
 120                                         if(!empty($relFields[$field])){
 121                                                 $roleSelect .= ', ' . $query_array['join_tables'][0] . '.'. $field;
 122                                         }
 123                                 }
 124                         }
 125                         // create a query
 126                         $subquery = $submodule->create_new_list_query($order_by,$optional_where ,$filterFields,$params, 0,'', true,$bean);
 127                         $query =  $subquery['select'].$roleSelect .   $subquery['from'].$query_array['join']. $subquery['where'].$subquery['order_by'];
 128                         $GLOBALS['log']->info('SoapHelperWebServices->getRelationshipResults query = ' . $query);
 129
 130                         $result = $submodule->db->query($query, true);
 131                         $list = array();
 132                         while($row = $submodule->db->fetchByAssoc($result)) {
 133                                 if (!$disable_date_format) {
 134                                         foreach ($filterFields as $field) {
 135                                                 if (isset($submodule->field_defs[$field]) &&
 136                                                         isset($submodule->field_defs[$field]['type']) &&
 137                                                         isset($row[$field])) {
 138
 139                                                                 if ($submodule->field_defs[$field]['type'] == 'date') {
 140                                                                         global $timedate;
 141                                                                         $row[$field] = $timedate->to_display_date_time($row[$field]);
 142                                                                 }
 143                                                                 if ($submodule->field_defs[$field]['type'] == 'currency') {
 144                                                                         // TODO: convert data from db to user preferred format absed on the community input
 145                                                                 } // if
 146                                                 } // if
 147
 148                                         } // foreach
 149                                 }
 150                                 if($submodulename == 'Users' && $current_user->id != $row['id']) {
 151                                         $row['user_hash'] = "";
 152                                 } // if
 153                                 if ($idSetInSubModule) {
 154                                         unset($row['id']);
 155                                 } // if
 156                                 $list[] = $row;
 157                         }
 158                         $GLOBALS['log']->info('End: SoapHelperWebServices->getRelationshipResults');
 159                         return array('rows' => $list, 'fields_set_on_rows' => $filterFields);
 160                 } else {
 161                         $GLOBALS['log']->info('End: SoapHelperWebServices->getRelationshipResults - ' . $link_field_name . ' relationship does not exists');
 162                         return false;
 163                 } // else
 164
 165         } // fn
 166
 167         function get_field_list($value, $fields, $translate=true) {
 168
 169             $GLOBALS['log']->info('Begin: SoapHelperWebServices->get_field_list');
 170                 $module_fields = array();
 171                 $link_fields = array();
 172                 if(!empty($value->field_defs)){
 173
 174                         foreach($value->field_defs as $var){
 175                                 if(!empty($fields) && !in_array( $var['name'], $fields))continue;
 176                                 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;
 177                                 if ((isset($var['source']) && $var['source'] == 'non_db') || (isset($var['type']) && $var['type'] == 'link')) {
 178                                         continue;
 179                                 }
 180                                 $required = 0;
 181                                 $options_dom = array();
 182                                 $options_ret = array();
 183                                 // Apparently the only purpose of this check is to make sure we only return fields
 184                                 //   when we've read a record.  Otherwise this function is identical to get_module_field_list
 185                                 if( isset($var['required']) && ($var['required'] || $var['required'] == 'true' ) ){
 186                                         $required = 1;
 187                                 }
 188
 189                                 if(isset($var['options'])){
 190                                         $options_dom = translate($var['options'], $value->module_dir);
 191                                         if(!is_array($options_dom)) $options_dom = array();
 192                                         foreach($options_dom as $key=>$oneOption)
 193                                                 $options_ret[$key] = $this->get_name_value($key,$oneOption);
 194                                 }
 195
 196                     if(!empty($var['dbType']) && $var['type'] == 'bool') {
 197                         $options_ret['type'] = $this->get_name_value('type', $var['dbType']);
 198                     }
 199
 200                     $entry = array();
 201                     $entry['name'] = $var['name'];
 202                     $entry['type'] = $var['type'];
 203                     $entry['group'] = isset($var['group']) ? $var['group'] : '';
 204                     $entry['id_name'] = isset($var['id_name']) ? $var['id_name'] : '';
 205
 206                     if ($var['type'] == 'link') {
 207                             $entry['relationship'] = (isset($var['relationship']) ? $var['relationship'] : '');
 208                             $entry['module'] = (isset($var['module']) ? $var['module'] : '');
 209                             $entry['bean_name'] = (isset($var['bean_name']) ? $var['bean_name'] : '');
 210                                         $link_fields[$var['name']] = $entry;
 211                     } else {
 212                             if($translate) {
 213                                 $entry['label'] = isset($var['vname']) ? translate($var['vname'], $value->module_dir) : $var['name'];
 214                             } else {
 215                                 $entry['label'] = isset($var['vname']) ? $var['vname'] : $var['name'];
 216                             }
 217                             $entry['required'] = $required;
 218                             $entry['options'] = $options_ret;
 219                             $entry['related_module'] = (isset($var['id_name']) && isset($var['module'])) ? $var['module'] : '';
 220                                         if(isset($var['default'])) {
 221                                            $entry['default_value'] = $var['default'];
 222                                         }
 223                                         $module_fields[$var['name']] = $entry;
 224                     } // else
 225                         } //foreach
 226                 } //if
 227
 228                 if($value->module_dir == 'Bugs'){
 229                         require_once('modules/Releases/Release.php');
 230                         $seedRelease = new Release();
 231                         $options = $seedRelease->get_releases(TRUE, "Active");
 232                         $options_ret = array();
 233                         foreach($options as $name=>$value){
 234                                 $options_ret[] =  array('name'=> $name , 'value'=>$value);
 235                         }
 236                         if(isset($module_fields['fixed_in_release'])){
 237                                 $module_fields['fixed_in_release']['type'] = 'enum';
 238                                 $module_fields['fixed_in_release']['options'] = $options_ret;
 239                         }
 240                         if(isset($module_fields['release'])){
 241                                 $module_fields['release']['type'] = 'enum';
 242                                 $module_fields['release']['options'] = $options_ret;
 243                         }
 244                         if(isset($module_fields['release_name'])){
 245                                 $module_fields['release_name']['type'] = 'enum';
 246                                 $module_fields['release_name']['options'] = $options_ret;
 247                         }
 248                 }
 249
 250                 if(isset($value->assigned_user_name) && isset($module_fields['assigned_user_id'])) {
 251                         $module_fields['assigned_user_name'] = $module_fields['assigned_user_id'];
 252                         $module_fields['assigned_user_name']['name'] = 'assigned_user_name';
 253                 }
 254                 if(isset($value->assigned_name) && isset($module_fields['team_id'])) {
 255                         $module_fields['team_name'] = $module_fields['team_id'];
 256                         $module_fields['team_name']['name'] = 'team_name';
 257                 }
 258                 if(isset($module_fields['modified_user_id'])) {
 259                         $module_fields['modified_by_name'] = $module_fields['modified_user_id'];
 260                         $module_fields['modified_by_name']['name'] = 'modified_by_name';
 261                 }
 262                 if(isset($module_fields['created_by'])) {
 263                         $module_fields['created_by_name'] = $module_fields['created_by'];
 264                         $module_fields['created_by_name']['name'] = 'created_by_name';
 265                 }
 266
 267                 $GLOBALS['log']->info('End: SoapHelperWebServices->get_field_list');
 268                 return array('module_fields' => $module_fields, 'link_fields' => $link_fields);
 269         }
 270
 271         function get_subpanel_defs($module, $type)
 272         {
 273             global $beanList, $beanFiles;
 274             $results = array();
 275             switch ($type)
 276             {
 277                 case 'wireless':
 278                     if (file_exists('custom/modules/'.$module.'/metadata/wireless.subpaneldefs.php'))
 279                          require_once('custom/modules/'.$module.'/metadata/wireless.subpaneldefs.php');
 280                     else if (file_exists('modules/'.$module.'/metadata/wireless.subpaneldefs.php'))
 281                          require_once('modules/'.$module.'/metadata/wireless.subpaneldefs.php');
 282                     break;
 283
 284                 case 'default':
 285                 default:
 286                     if (file_exists ('modules/'.$module.'/metadata/subpaneldefs.php' ))
 287                         require ('modules/'.$module.'/metadata/subpaneldefs.php');
 288                     if ( file_exists('custom/modules/'.$module.'/Ext/Layoutdefs/layoutdefs.ext.php' ))
 289                         require ('custom/modules/'.$module.'/Ext/Layoutdefs/layoutdefs.ext.php');
 290             }
 291
 292             //Filter results for permissions
 293             foreach ($layout_defs[$module]['subpanel_setup'] as $subpanel => $subpaneldefs)
 294             {
 295                 $moduleToCheck = $subpaneldefs['module'];
 296                 if(!isset($beanList[$moduleToCheck]))
 297                    continue;
 298                 $class_name = $beanList[$moduleToCheck];
 299                 $bean = new $class_name();
 300                 if($bean->ACLAccess('list'))
 301                     $results[$subpanel] = $subpaneldefs;
 302             }
 303
 304             return $results;
 305
 306         }
 307
 308     function get_module_view_defs($module_name, $type, $view){
 309         require_once('include/MVC/View/SugarView.php');
 310         $metadataFile = null;
 311         $results = array();
 312         $view = strtolower($view);
 313         switch (strtolower($type)){
 314             case 'wireless':
 315                 if( $view == 'list'){
 316                     require_once('include/SugarWireless/SugarWirelessListView.php');
 317                     $GLOBALS['module'] = $module_name; //WirelessView keys off global variable not instance variable...
 318                     $v = new SugarWirelessListView();
 319                     $results = $v->getMetaDataFile();
 320                 }
 321                 elseif ($view == 'subpanel')
 322                     $results = $this->get_subpanel_defs($module_name, $type);
 323                 else{
 324                     require_once('include/SugarWireless/SugarWirelessView.php');
 325                     $v = new SugarWirelessView();
 326                     $v->module = $module_name;
 327                     $fullView = ucfirst($view) . 'View';
 328                     $meta = $v->getMetaDataFile('Wireless' . $fullView);
 329                     $metadataFile = $meta['filename'];
 330                     require_once($metadataFile);
 331                     //Wireless detail metadata may actually be just edit metadata.
 332                     $results = isset($viewdefs[$meta['module_name']][$fullView] ) ? $viewdefs[$meta['module_name']][$fullView] : $viewdefs[$meta['module_name']]['EditView'];
 333                 }
 334
 335                 break;
 336             case 'default':
 337             default:
 338                 if ($view == 'subpanel')
 339                     $results = $this->get_subpanel_defs($module_name, $type);
 340                 else
 341                 {
 342                     $v = new SugarView(null,array());
 343                     $v->module = $module_name;
 344                     $v->type = $view;
 345                     $fullView = ucfirst($view) . 'View';
 346                     $metadataFile = $v->getMetaDataFile();
 347                     require_once($metadataFile);
 348                     if($view == 'list')
 349                         $results = $listViewDefs[$module_name];
 350                     else
 351                         $results = $viewdefs[$module_name][$fullView];
 352                 }
 353         }
 354
 355         return $results;
 356     }
 357
 358     /**
 359      * Examine the wireless_module_registry to determine which modules have been enabled for the mobile view.
 360      *
 361      * @param array $availModules An array of all the modules the user already has access to.
 362      * @return array Modules enalbed for mobile view.
 363      */
 364     function get_visible_mobile_modules($availModules){
 365         $enabled_modules = array();
 366         $availModulesKey = array_flip($availModules);
 367         foreach ( array ( '','custom/') as $prefix)
 368         {
 369                 if(file_exists($prefix.'include/MVC/Controller/wireless_module_registry.php'))
 370                         require $prefix.'include/MVC/Controller/wireless_module_registry.php' ;
 371         }
 372
 373         foreach ( $wireless_module_registry as $e => $def )
 374         {
 375                 if( isset($availModulesKey[$e]) )
 376                 $enabled_modules[] = $e;
 377         }
 378
 379         return $enabled_modules;
 380     }
 381
 382     /**
 383      * Examine the application to determine which modules have been enabled..
 384      *
 385      * @param array $availModules An array of all the modules the user already has access to.
 386      * @return array Modules enabled within the application.
 387      */
 388     function get_visible_modules($availModules) {
 389         require_once("modules/MySettings/TabController.php");
 390         $controller = new TabController();
 391         $tabs = $controller->get_tabs_system();
 392         $enabled_modules= array();
 393         $availModulesKey = array_flip($availModules);
 394         foreach ($tabs[0] as $key=>$value)
 395         {
 396             if( isset($availModulesKey[$key]) )
 397                 $enabled_modules[] = $key;
 398         }
 399
 400         return $enabled_modules;
 401     }
 402
 403     /**
 404      * Retrieve all of the upcoming activities for a particular user.
 405      *
 406      * @return array
 407      */
 408     function get_upcoming_activities()
 409     {
 410         global $beanList;
 411         $maxCount = 10;
 412
 413         $activityModules = array('Meetings' => array('date_field' => 'date_start','status' => 'Planned','status_field' => 'status', 'status_opp' => '='),
 414                                  'Calls' => array('date_field' => 'date_start','status' => 'Planned','status_field' => 'status', 'status_opp' => '='),
 415                                  'Tasks' => array('date_field' =>'date_due','status' => 'Not Started','status_field' => 'status','status_opp' => '='),
 416                                  'Opportunities' => array('date_field' => 'date_closed','status' => array('Closed Won','Closed Lost'), 'status_field' => 'sales_stage', 'status_opp' => '!=') );
 417         $results = array();
 418         foreach ($activityModules as $module => $meta)
 419         {
 420             if(!self::check_modules_access($GLOBALS['current_user'], $module, 'read'))
 421             {
 422                 $GLOBALS['log']->debug("SugarWebServiceImpl->get_last_viewed: NO ACCESS to $module");
 423                 continue;
 424             }
 425
 426             $class_name = $beanList[$module];
 427                 $seed = new $class_name();
 428             $query = $this->generateUpcomingActivitiesWhereClause($seed, $meta);
 429
 430             $response = $seed->get_list(/* Order by date field */"{$meta['date_field']} ASC",  /*Where clause */$query, /* No Offset */ 0,
 431                                         /* No limit */-1, /* Max 10 items */10, /*No Deleted */ 0 );
 432
 433             $result = array();
 434
 435             if( isset($response['list']) )
 436                 $result = $this->format_upcoming_activities_entries($response['list'],$meta['date_field']);
 437
 438             $results = array_merge($results,$result);
 439         }
 440
 441         //Sort the result list by the date due flag in ascending order
 442         usort( $results, array( $this , "cmp_datedue" ) ) ;
 443
 444         //Only return a subset of the results.
 445         $results = array_slice($results, 0, $maxCount);
 446
 447         return $results;
 448     }
 449
 450     function generateUpcomingActivitiesWhereClause($seed,$meta)
 451     {
 452         $query = array();
 453         $query_date = TimeDate::getInstance()->nowDb();
 454         $query[] = " {$seed->table_name}.{$meta['date_field']} > '$query_date'"; //Add date filter
 455         $query[] = "{$seed->table_name}.assigned_user_id = '{$GLOBALS['current_user']->id}' "; //Add assigned user filter
 456         if(is_array($meta['status_field']))
 457         {
 458             foreach ($meta['status'] as $field)
 459                 $query[] = "{$seed->table_name}.{$meta['status_field']} {$meta['status_opp']} '{$field}' ";
 460         }
 461         else
 462             $query[] = "{$seed->table_name}.{$meta['status_field']} {$meta['status_opp']} '{$meta['status']}' ";
 463
 464         return implode(" AND ",$query);
 465     }
 466     /**
 467      * Given a list of bean entries, format the expected response.
 468      *
 469      * @param array $list An array containing a bean list.
 470      * @param string $date_field Name of the field storing the date field we are examining
 471      * @return array The results.
 472      */
 473     function format_upcoming_activities_entries($list,$date_field)
 474     {
 475         $results = array();
 476         foreach ($list as $bean)
 477         {
 478             $results[] = array('id' => $bean->id, 'module' => $bean->module_dir,'date_due' => $bean->$date_field,
 479                                 'summary' => $bean->get_summary_text() );
 480         }
 481
 482         return $results;
 483     }
 484
 485     /**
 486      * Sort the array for upcoming activities based on the date due flag ascending.
 487      *
 488      * @param array $a
 489      * @param array $b
 490      * @return int Indicates equality for date due flag
 491      */
 492     static function cmp_datedue( $a, $b )
 493     {
 494         $a_date = strtotime( $a['date_due'] ) ;
 495         $b_date = strtotime( $b['date_due'] ) ;
 496
 497         if( $a_date == $b_date ) return 0 ;
 498         return ($a_date > $b_date ) ? 1 : -1;
 499   }
 500
 501 }