service/v3_1/SugarWebServiceImplv3_1.php

   1 <?php
   2 if(!defined('sugarEntry'))define('sugarEntry', true);
   3 /*********************************************************************************
   4  * SugarCRM Community Edition is a customer relationship management program developed by
   5  * SugarCRM, Inc. Copyright (C) 2004-2012 SugarCRM Inc.
   6  *
   7  * This program is free software; you can redistribute it and/or modify it under
   8  * the terms of the GNU Affero General Public License version 3 as published by the
   9  * Free Software Foundation with the addition of the following permission added
  10  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
  11  * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
  12  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
  13  *
  14  * This program is distributed in the hope that it will be useful, but WITHOUT
  15  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  16  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
  17  * details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License along with
  20  * this program; if not, see http://www.gnu.org/licenses or write to the Free
  21  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  22  * 02110-1301 USA.
  23  *
  24  * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
  25  * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
  26  *
  27  * The interactive user interfaces in modified source and object code versions
  28  * of this program must display Appropriate Legal Notices, as required under
  29  * Section 5 of the GNU Affero General Public License version 3.
  30  *
  31  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
  32  * these Appropriate Legal Notices must retain the display of the "Powered by
  33  * SugarCRM" logo. If the display of the logo is not reasonably feasible for
  34  * technical reasons, the Appropriate Legal Notices must display the words
  35  * "Powered by SugarCRM".
  36  ********************************************************************************/
  37
  38
  39 /**
  40  * This class is an implemenatation class for all the rest services
  41  */
  42 require_once('service/v3/SugarWebServiceImplv3.php');
  43 require_once('SugarWebServiceUtilv3_1.php');
  44
  45
  46 class SugarWebServiceImplv3_1 extends SugarWebServiceImplv3 {
  47
  48     public function __construct()
  49     {
  50         self::$helperObject = new SugarWebServiceUtilv3_1();
  51     }
  52
  53    /**
  54     * Retrieve a single SugarBean based on ID.
  55     *
  56     * @param String $session -- Session ID returned by a previous call to login.
  57     * @param String $module_name -- The name of the module to return records from.  This name should be the name the module was developed under (changing a tab name is studio does not affect the name that should be passed into this method)..
  58     * @param String $id -- The SugarBean's ID value.
  59     * @param Array  $select_fields -- A list of the fields to be included in the results. This optional parameter allows for only needed fields to be retrieved.
  60     * @param Array $link_name_to_fields_array -- A list of link_names and for each link_name, what fields value to be returned. For ex.'link_name_to_fields_array' => array(array('name' =>  'email_addresses', 'value' => array('id', 'email_address', 'opt_out', 'primary_address')))
  61     * @param bool $trackView -- Should we track the record accessed.
  62     * @return Array
  63     *        'entry_list' -- Array - The records name value pair for the simple data types excluding link field data.
  64     *        'relationship_list' -- Array - The records link field data. The example is if asked about accounts email address then return data would look like Array ( [0] => Array ( [name] => email_addresses [records] => Array ( [0] => Array ( [0] => Array ( [name] => id [value] => 3fb16797-8d90-0a94-ac12-490b63a6be67 ) [1] => Array ( [name] => email_address [value] => hr.kid.qa@example.com ) [2] => Array ( [name] => opt_out [value] => 0 ) [3] => Array ( [name] => primary_address [value] => 1 ) ) [1] => Array ( [0] => Array ( [name] => id [value] => 403f8da1-214b-6a88-9cef-490b63d43566 ) [1] => Array ( [name] => email_address [value] => kid.hr@example.name ) [2] => Array ( [name] => opt_out [value] => 0 ) [3] => Array ( [name] => primary_address [value] => 0 ) ) ) ) )
  65     * @exception 'SoapFault' -- The SOAP error, if any
  66     */
  67     function get_entry($session, $module_name, $id,$select_fields, $link_name_to_fields_array,$track_view = FALSE)
  68     {
  69         $GLOBALS['log']->info('Begin: SugarWebServiceImpl->get_entry');
  70         return self::get_entries($session, $module_name, array($id), $select_fields, $link_name_to_fields_array, $track_view);
  71         $GLOBALS['log']->info('end: SugarWebServiceImpl->get_entry');
  72     }
  73
  74     /**
  75      * Retrieve the md5 hash of the vardef entries for a particular module.
  76      *
  77      * @param String $session -- Session ID returned by a previous call to login.
  78      * @param String $module_name -- The name of the module to return records from.  This name should be the name the module was developed under (changing a tab name is studio does not affect the name that should be passed into this method)..
  79      * @return String The md5 hash of the vardef definition.
  80      * @exception 'SoapFault' -- The SOAP error, if any
  81      */
  82     function get_module_fields_md5($session, $module_name){
  83
  84         $GLOBALS['log']->info('Begin: SugarWebServiceImpl->get_module_fields_md5(v3_1) for module: '. print_r($module_name, true));
  85
  86         $results = array();
  87         if( is_array($module_name) )
  88         {
  89             foreach ($module_name as $module)
  90                 $results[$module] = md5(serialize(self::get_module_fields($session, $module)));
  91         }
  92         else
  93             $results[$module_name] = md5(serialize(self::get_module_fields($session, $module_name)));
  94
  95         $GLOBALS['log']->info('End: SugarWebServiceImpl->get_module_fields_md5 (v3_1) for module: ' . print_r($module_name, true));
  96
  97         return $results;
  98     }
  99
 100     /**
 101      * Retrieve the md5 hash of a layout metadata for a given module given a specific type and view.
 102      *
 103      * @param String $session -- Session ID returned by a previous call to login.
 104      * @param array $module_name(s) -- The name of the module to return records from.  This name should be the name the module was developed under (changing a tab name is studio does not affect the name that should be passed into this method)..
 105      * @return array $type(s) The type of view requested.  Current supported types are 'default' (for application) and 'wireless'
 106      * @return array $view(s) The view requested.  Current supported types are edit, detail, and list.
 107      * @exception 'SoapFault' -- The SOAP error, if any
 108      */
 109     function get_module_layout_md5($session, $module_name, $type, $view, $acl_check = TRUE){
 110         $GLOBALS['log']->info('Begin: SugarWebServiceImpl->get_module_layout_md5');
 111         $results = self::get_module_layout($session, $module_name, $type, $view, $acl_check, TRUE);
 112             return array('md5'=> $results);
 113         $GLOBALS['log']->info('End: SugarWebServiceImpl->get_module_layout_md5');
 114     }
 115
 116
 117     /**
 118     * Retrieve a list of SugarBean's based on provided IDs. This API will not wotk with report module
 119     *
 120     * @param String $session -- Session ID returned by a previous call to login.
 121     * @param String $module_name -- The name of the module to return records from.  This name should be the name the module was developed under (changing a tab name is studio does not affect the name that should be passed into this method)..
 122     * @param Array $ids -- An array of SugarBean IDs.
 123     * @param Array $select_fields -- A list of the fields to be included in the results. This optional parameter allows for only needed fields to be retrieved.
 124     * @param Array $link_name_to_fields_array -- A list of link_names and for each link_name, what fields value to be returned. For ex.'link_name_to_fields_array' => array(array('name' =>  'email_addresses', 'value' => array('id', 'email_address', 'opt_out', 'primary_address')))
 125     * @param bool $trackView -- Should we track the record accessed.
 126     * @return Array
 127     *        'entry_list' -- Array - The records name value pair for the simple data types excluding link field data.
 128     *        'relationship_list' -- Array - The records link field data. The example is if asked about accounts email address then return data would look like Array ( [0] => Array ( [name] => email_addresses [records] => Array ( [0] => Array ( [0] => Array ( [name] => id [value] => 3fb16797-8d90-0a94-ac12-490b63a6be67 ) [1] => Array ( [name] => email_address [value] => hr.kid.qa@example.com ) [2] => Array ( [name] => opt_out [value] => 0 ) [3] => Array ( [name] => primary_address [value] => 1 ) ) [1] => Array ( [0] => Array ( [name] => id [value] => 403f8da1-214b-6a88-9cef-490b63d43566 ) [1] => Array ( [name] => email_address [value] => kid.hr@example.name ) [2] => Array ( [name] => opt_out [value] => 0 ) [3] => Array ( [name] => primary_address [value] => 0 ) ) ) ) )
 129     * @exception 'SoapFault' -- The SOAP error, if any
 130     */
 131     function get_entries($session, $module_name, $ids, $select_fields, $link_name_to_fields_array, $track_view = FALSE)
 132     {
 133         $GLOBALS['log']->info('Begin: SugarWebServiceImpl->get_entries');
 134         global  $beanList, $beanFiles;
 135         $error = new SoapError();
 136
 137         $linkoutput_list = array();
 138         $output_list = array();
 139         $using_cp = false;
 140         if($module_name == 'CampaignProspects')
 141         {
 142             $module_name = 'Prospects';
 143             $using_cp = true;
 144         }
 145         if (!self::$helperObject->checkSessionAndModuleAccess($session, 'invalid_session', $module_name, 'read', 'no_access', $error))
 146         {
 147             $GLOBALS['log']->info('No Access: SugarWebServiceImpl->get_entries');
 148             return;
 149         } // if
 150
 151         $class_name = $beanList[$module_name];
 152         require_once($beanFiles[$class_name]);
 153
 154         $temp = new $class_name();
 155         foreach($ids as $id)
 156         {
 157             $seed = @clone($temp);
 158             if($using_cp)
 159                 $seed = $seed->retrieveTarget($id);
 160             else
 161             {
 162                 if ($seed->retrieve($id) == null)
 163                     $seed->deleted = 1;
 164             }
 165
 166             if ($seed->deleted == 1)
 167             {
 168                 $list = array();
 169                 $list[] = array('name'=>'warning', 'value'=>'Access to this object is denied since it has been deleted or does not exist');
 170                 $list[] = array('name'=>'deleted', 'value'=>'1');
 171                 $output_list[] = Array('id'=>$id,'module_name'=> $module_name,'name_value_list'=>$list,);
 172                 continue;
 173             }
 174             if (!self::$helperObject->checkACLAccess($seed, 'DetailView', $error, 'no_access'))
 175             {
 176                 return;
 177             }
 178             $output_list[] = self::$helperObject->get_return_value_for_fields($seed, $module_name, $select_fields);
 179             if (!empty($link_name_to_fields_array))
 180             {
 181                 $linkoutput_list[] = self::$helperObject->get_return_value_for_link_fields($seed, $module_name, $link_name_to_fields_array);
 182             }
 183
 184             $GLOBALS['log']->info('Should we track view: ' . $track_view);
 185             if($track_view)
 186             {
 187                 self::$helperObject->trackView($seed, 'detailview');
 188             }
 189         }
 190
 191         $GLOBALS['log']->info('End: SugarWebServiceImpl->get_entries');
 192         return array('entry_list'=>$output_list, 'relationship_list' => $linkoutput_list);
 193     }
 194
 195     /**
 196      * Update or create a single SugarBean.
 197      *
 198      * @param String $session -- Session ID returned by a previous call to login.
 199      * @param String $module_name -- The name of the module to return records from.  This name should be the name the module was developed under (changing a tab name is studio does not affect the name that should be passed into this method)..
 200      * @param Array $name_value_list -- The keys of the array are the SugarBean attributes, the values of the array are the values the attributes should have.
 201      * @param Bool $track_view -- Should the tracker be notified that the action was performed on the bean.
 202      * @return Array    'id' -- the ID of the bean that was written to (-1 on error)
 203      * @exception 'SoapFault' -- The SOAP error, if any
 204      */
 205     function set_entry($session,$module_name, $name_value_list, $track_view = FALSE){
 206         global  $beanList, $beanFiles, $current_user;
 207
 208         $GLOBALS['log']->info('Begin: SugarWebServiceImpl->set_entry');
 209         if (self::$helperObject->isLogLevelDebug()) {
 210             $GLOBALS['log']->debug('SoapHelperWebServices->set_entry - input data is ' . var_export($name_value_list, true));
 211         } // if
 212         $error = new SoapError();
 213         if (!self::$helperObject->checkSessionAndModuleAccess($session, 'invalid_session', $module_name, 'write', 'no_access', $error)) {
 214             $GLOBALS['log']->info('End: SugarWebServiceImpl->set_entry');
 215             return;
 216         } // if
 217         $class_name = $beanList[$module_name];
 218         require_once($beanFiles[$class_name]);
 219         $seed = new $class_name();
 220         foreach($name_value_list as $name=>$value){
 221             if(is_array($value) &&  $value['name'] == 'id'){
 222                 $seed->retrieve($value['value']);
 223                 break;
 224             }else if($name === 'id' ){
 225
 226                 $seed->retrieve($value);
 227             }
 228         }
 229
 230         $return_fields = array();
 231         foreach($name_value_list as $name=>$value){
 232             if($module_name == 'Users' && !empty($seed->id) && ($seed->id != $current_user->id) && $name == 'user_hash'){
 233                 continue;
 234             }
 235             if(!empty($seed->field_name_map[$name]['sensitive'])) {
 236                     continue;
 237             }
 238
 239             if(!is_array($value)){
 240                 $seed->$name = $value;
 241                 $return_fields[] = $name;
 242             }else{
 243                 $seed->$value['name'] = $value['value'];
 244                 $return_fields[] = $value['name'];
 245             }
 246         }
 247         if (!self::$helperObject->checkACLAccess($seed, 'Save', $error, 'no_access') || ($seed->deleted == 1  && !self::$helperObject->checkACLAccess($seed, 'Delete', $error, 'no_access'))) {
 248             $GLOBALS['log']->info('End: SugarWebServiceImpl->set_entry');
 249             return;
 250         } // if
 251
 252         $seed->save(self::$helperObject->checkSaveOnNotify());
 253
 254         $return_entry_list = self::$helperObject->get_name_value_list_for_fields($seed, $return_fields );
 255
 256         if($seed->deleted == 1){
 257             $seed->mark_deleted($seed->id);
 258         }
 259
 260         if($track_view){
 261             self::$helperObject->trackView($seed, 'editview');
 262         }
 263
 264         $GLOBALS['log']->info('End: SugarWebServiceImpl->set_entry');
 265         return array('id'=>$seed->id, 'entry_list' => $return_entry_list);
 266     } // fn
 267
 268
 269     /**
 270      * Log the user into the application
 271      *
 272      * @param UserAuth array $user_auth -- Set user_name and password (password needs to be
 273      *      in the right encoding for the type of authentication the user is setup for.  For Base
 274      *      sugar validation, password is the MD5 sum of the plain text password.
 275      * @param String $application -- The name of the application you are logging in from.  (Currently unused).
 276      * @param array $name_value_list -- Array of name value pair of extra parameters. As of today only 'language' and 'notifyonsave' is supported
 277      * @return Array - id - String id is the session_id of the session that was created.
 278      *                           - module_name - String - module name of user
 279      *                           - name_value_list - Array - The name value pair of user_id, user_name, user_language, user_currency_id, user_currency_name,
 280      *                                         - user_default_team_id, user_is_admin, user_default_dateformat, user_default_timeformat
 281      * @exception 'SoapFault' -- The SOAP error, if any
 282      */
 283     public function login($user_auth, $application, $name_value_list = array()){
 284         $GLOBALS['log']->info('Begin: SugarWebServiceImpl->login');
 285         global $sugar_config, $system_config;
 286         $error = new SoapError();
 287         $user = new User();
 288         $success = false;
 289         //rrs
 290         $system_config = new Administration();
 291         $system_config->retrieveSettings('system');
 292         $authController = new AuthenticationController((!empty($sugar_config['authenticationClass'])? $sugar_config['authenticationClass'] : 'SugarAuthenticate'));
 293         //rrs
 294         if(!empty($user_auth['encryption']) && $user_auth['encryption'] === 'PLAIN' && $authController->authController->userAuthenticateClass != "LDAPAuthenticateUser")
 295         {
 296             $user_auth['password'] = md5($user_auth['password']);
 297         }
 298         $isLoginSuccess = $authController->login($user_auth['user_name'], $user_auth['password'], array('passwordEncrypted' => true));
 299         $usr_id=$user->retrieve_user_id($user_auth['user_name']);
 300         if($usr_id)
 301             $user->retrieve($usr_id);
 302
 303         if ($isLoginSuccess)
 304         {
 305             if ($_SESSION['hasExpiredPassword'] =='1')
 306             {
 307                 $error->set_error('password_expired');
 308                 $GLOBALS['log']->fatal('password expired for user ' . $user_auth['user_name']);
 309                 LogicHook::initialize();
 310                 $GLOBALS['logic_hook']->call_custom_logic('Users', 'login_failed');
 311                 self::$helperObject->setFaultObject($error);
 312                 return;
 313             }
 314             if(!empty($user) && !empty($user->id) && !$user->is_group)
 315             {
 316                 $success = true;
 317                 global $current_user;
 318                 $current_user = $user;
 319             }
 320         }
 321         else if($usr_id && isset($user->user_name) && ($user->getPreference('lockout') == '1'))
 322         {
 323             $error->set_error('lockout_reached');
 324             $GLOBALS['log']->fatal('Lockout reached for user ' . $user_auth['user_name']);
 325             LogicHook::initialize();
 326             $GLOBALS['logic_hook']->call_custom_logic('Users', 'login_failed');
 327             self::$helperObject->setFaultObject($error);
 328             return;
 329         }
 330         else if( $authController->authController->userAuthenticateClass == "LDAPAuthenticateUser"
 331                  && (empty($user_auth['encryption']) || $user_auth['encryption'] !== 'PLAIN' ) )
 332         {
 333             $error->set_error('ldap_error');
 334             LogicHook::initialize();
 335             $GLOBALS['logic_hook']->call_custom_logic('Users', 'login_failed');
 336             self::$helperObject->setFaultObject($error);
 337             return;
 338         }
 339         else if(function_exists('mcrypt_cbc'))
 340         {
 341             $password = self::$helperObject->decrypt_string($user_auth['password']);
 342             if($authController->login($user_auth['user_name'], $password) && isset($_SESSION['authenticated_user_id']))
 343                 $success = true;
 344         }
 345
 346         if($success)
 347         {
 348             session_start();
 349             global $current_user;
 350             //$current_user = $user;
 351             self::$helperObject->login_success($name_value_list);
 352             $current_user->loadPreferences();
 353             $_SESSION['is_valid_session']= true;
 354             $_SESSION['ip_address'] = query_client_ip();
 355             $_SESSION['user_id'] = $current_user->id;
 356             $_SESSION['type'] = 'user';
 357             $_SESSION['avail_modules']= self::$helperObject->get_user_module_list($current_user);
 358             $_SESSION['authenticated_user_id'] = $current_user->id;
 359             $_SESSION['unique_key'] = $sugar_config['unique_key'];
 360             $current_user->call_custom_logic('after_login');
 361             $GLOBALS['log']->info('End: SugarWebServiceImpl->login - succesful login');
 362             $nameValueArray = array();
 363             global $current_language;
 364             $nameValueArray['user_id'] = self::$helperObject->get_name_value('user_id', $current_user->id);
 365             $nameValueArray['user_name'] = self::$helperObject->get_name_value('user_name', $current_user->user_name);
 366             $nameValueArray['user_language'] = self::$helperObject->get_name_value('user_language', $current_language);
 367             $cur_id = $current_user->getPreference('currency');
 368             $nameValueArray['user_currency_id'] = self::$helperObject->get_name_value('user_currency_id', $cur_id);
 369             $nameValueArray['user_is_admin'] = self::$helperObject->get_name_value('user_is_admin', is_admin($current_user));
 370             $nameValueArray['user_default_team_id'] = self::$helperObject->get_name_value('user_default_team_id', $current_user->default_team );
 371             $nameValueArray['user_default_dateformat'] = self::$helperObject->get_name_value('user_default_dateformat', $current_user->getPreference('datef') );
 372             $nameValueArray['user_default_timeformat'] = self::$helperObject->get_name_value('user_default_timeformat', $current_user->getPreference('timef') );
 373
 374             $num_grp_sep = $current_user->getPreference('num_grp_sep');
 375             $dec_sep = $current_user->getPreference('dec_sep');
 376             $nameValueArray['user_number_seperator'] = self::$helperObject->get_name_value('user_number_seperator', empty($num_grp_sep) ? $sugar_config['default_number_grouping_seperator'] : $num_grp_sep);
 377             $nameValueArray['user_decimal_seperator'] = self::$helperObject->get_name_value('user_decimal_seperator', empty($dec_sep) ? $sugar_config['default_decimal_seperator'] : $dec_sep);
 378
 379             $nameValueArray['mobile_max_list_entries'] = self::$helperObject->get_name_value('mobile_max_list_entries', $sugar_config['wl_list_max_entries_per_page'] );
 380             $nameValueArray['mobile_max_subpanel_entries'] = self::$helperObject->get_name_value('mobile_max_subpanel_entries', $sugar_config['wl_list_max_entries_per_subpanel'] );
 381
 382             if($application == 'mobile')
 383             {
 384                 $modules = $availModuleNames = array();
 385                 $availModules = array_keys($_SESSION['avail_modules']); //ACL check already performed.
 386                 $modules = self::$helperObject->get_visible_mobile_modules($availModules);
 387                 $nameValueArray['available_modules'] = $modules;
 388                 //Get the vardefs md5
 389                 foreach($modules as $mod_def)
 390                     $availModuleNames[] = $mod_def['module_key'];
 391
 392                 $nameValueArray['vardefs_md5'] = self::get_module_fields_md5(session_id(), $availModuleNames);
 393             }
 394
 395             $currencyObject = new Currency();
 396             $currencyObject->retrieve($cur_id);
 397             $nameValueArray['user_currency_name'] = self::$helperObject->get_name_value('user_currency_name', $currencyObject->name);
 398             $_SESSION['user_language'] = $current_language;
 399             return array('id'=>session_id(), 'module_name'=>'Users', 'name_value_list'=>$nameValueArray);
 400         }
 401         LogicHook::initialize();
 402         $GLOBALS['logic_hook']->call_custom_logic('Users', 'login_failed');
 403         $error->set_error('invalid_login');
 404         self::$helperObject->setFaultObject($error);
 405         $GLOBALS['log']->info('End: SugarWebServiceImpl->login - failed login');
 406     }
 407
 408     /**
 409      * Retrieve the list of available modules on the system available to the currently logged in user.
 410      *
 411      * @param String $session -- Session ID returned by a previous call to login.
 412      * @param String $filter --  Valid values are: all     - Return all modules,
 413      *                                             default - Return all visible modules for the application
 414      *                                             mobile  - Return all visible modules for the mobile view
 415      * @return Array    'modules' -- Array - An array of module names
 416      * @exception 'SoapFault' -- The SOAP error, if any
 417      */
 418     function get_available_modules($session,$filter='all'){
 419         $GLOBALS['log']->info('Begin: SugarWebServiceImpl->get_available_modules');
 420
 421         $error = new SoapError();
 422         if (!self::$helperObject->checkSessionAndModuleAccess($session, 'invalid_session', '', '', '', $error)) {
 423                 $error->set_error('invalid_login');
 424                 $GLOBALS['log']->info('End: SugarWebServiceImpl->get_available_modules');
 425                 return;
 426         } // if
 427
 428         $modules = array();
 429         $availModules = array_keys($_SESSION['avail_modules']); //ACL check already performed.
 430         switch ($filter){
 431             case 'default':
 432                 $modules = self::$helperObject->get_visible_modules($availModules);
 433                break;
 434             case 'mobile':
 435                 $modules = self::$helperObject->get_visible_mobile_modules($availModules);
 436                 break;
 437             case 'all':
 438             default:
 439                 $modules = self::$helperObject->getModulesFromList(array_flip($availModules), $availModules);
 440         }
 441
 442         $GLOBALS['log']->info('End: SugarWebServiceImpl->get_available_modules');
 443         return array('modules'=> $modules);
 444     } // fn
 445
 446
 447     /**
 448      * Enter description here...
 449      *
 450      * @param string $session   - Session ID returned by a previous call to login.
 451      * @param array $modules Array of modules to return
 452      * @param bool $MD5 Should the results be md5d
 453      */
 454     function get_language_definition($session, $modules, $MD5 = FALSE)
 455     {
 456         $GLOBALS['log']->info('Begin: SugarWebServiceImpl->get_language_file');
 457         global  $beanList, $beanFiles;
 458         global $sugar_config,$current_language;
 459
 460         $error = new SoapError();
 461         $output_list = array();
 462         if (!self::$helperObject->checkSessionAndModuleAccess($session, 'invalid_session', '', '', '', $error))
 463         {
 464             $error->set_error('invalid_login');
 465             $GLOBALS['log']->info('End: SugarWebServiceImpl->get_report_pdf');
 466             return;
 467         }
 468
 469         if( is_string($modules) )
 470             $modules = array($modules);
 471
 472         $results = array();
 473         foreach ($modules as $mod)
 474         {
 475             if( strtolower($mod) == 'app_strings' )
 476             {
 477                 $values = return_application_language($current_language);
 478                 $key = 'app_strings';
 479             }
 480             else if ( strtolower($mod) == 'app_list_strings' )
 481             {
 482                 $values = return_app_list_strings_language($current_language);
 483                 $key = 'app_list_strings';
 484             }
 485             else
 486             {
 487                 $values = return_module_language($current_language, $mod);
 488                 $key = $mod;
 489             }
 490
 491             if( $MD5 )
 492                 $values = md5(serialize($values));
 493
 494             $results[$key] = $values;
 495         }
 496
 497         return $results;
 498     }
 499
 500
 501     /**
 502      * Retrieve the layout metadata for a given module given a specific type and view.
 503      *
 504      * @param String $session -- Session ID returned by a previous call to login.
 505      * @param array $module_name(s) -- The name of the module(s) to return records from.  This name should be the name the module was developed under (changing a tab name is studio does not affect the name that should be passed into this method)..
 506      * @return array $type The type(s) of views requested.  Current supported types are 'default' (for application) and 'wireless'
 507      * @return array $view The view(s) requested.  Current supported types are edit, detail, list, and subpanel.
 508      * @exception 'SoapFault' -- The SOAP error, if any
 509      */
 510     function get_module_layout($session, $a_module_names, $a_type, $a_view,$acl_check = TRUE, $md5 = FALSE){
 511         $GLOBALS['log']->fatal('Begin: SugarWebServiceImpl->get_module_layout');
 512
 513         global  $beanList, $beanFiles;
 514         $error = new SoapError();
 515         $results = array();
 516         foreach ($a_module_names as $module_name)
 517         {
 518             if (!self::$helperObject->checkSessionAndModuleAccess($session, 'invalid_session', $module_name, 'read', 'no_access', $error))
 519             {
 520                 $GLOBALS['log']->info('End: SugarWebServiceImpl->get_module_layout');
 521                 continue;
 522             }
 523
 524             $class_name = $beanList[$module_name];
 525             require_once($beanFiles[$class_name]);
 526             $seed = new $class_name();
 527
 528             foreach ($a_view as $view)
 529             {
 530                 $aclViewCheck = (strtolower($view) == 'subpanel') ? 'DetailView' : ucfirst(strtolower($view)) . 'View';
 531                 if(!$acl_check || $seed->ACLAccess($aclViewCheck, true) )
 532                 {
 533                     foreach ($a_type as $type)
 534                     {
 535                         $a_vardefs = self::$helperObject->get_module_view_defs($module_name, $type, $view);
 536                         if($md5)
 537                             $results[$module_name][$type][$view] = md5(serialize($a_vardefs));
 538                         else
 539                             $results[$module_name][$type][$view] = $a_vardefs;
 540                     }
 541                 }
 542             }
 543         }
 544
 545         $GLOBALS['log']->info('End: SugarWebServiceImpl->get_module_layout');
 546
 547         return $results;
 548     }
 549
 550     /**
 551      * Retrieve a list of beans.  This is the primary method for getting list of SugarBeans from Sugar using the SOAP API.
 552      *
 553      * @param String $session -- Session ID returned by a previous call to login.
 554      * @param String $module_name -- The name of the module to return records from.  This name should be the name the module was developed under (changing a tab name is studio does not affect the name that should be passed into this method)..
 555      * @param String $query -- SQL where clause without the word 'where'
 556      * @param String $order_by -- SQL order by clause without the phrase 'order by'
 557      * @param integer $offset -- The record offset to start from.
 558      * @param Array  $select_fields -- A list of the fields to be included in the results. This optional parameter allows for only needed fields to be retrieved.
 559      * @param Array $link_name_to_fields_array -- A list of link_names and for each link_name, what fields value to be returned. For ex.'link_name_to_fields_array' => array(array('name' =>  'email_addresses', 'value' => array('id', 'email_address', 'opt_out', 'primary_address')))
 560     * @param integer $max_results -- The maximum number of records to return.  The default is the sugar configuration value for 'list_max_entries_per_page'
 561      * @param integer $deleted -- false if deleted records should not be include, true if deleted records should be included.
 562      * @return Array 'result_count' -- integer - The number of records returned
 563      *               'next_offset' -- integer - The start of the next page (This will always be the previous offset plus the number of rows returned.  It does not indicate if there is additional data unless you calculate that the next_offset happens to be closer than it should be.
 564      *               'entry_list' -- Array - The records that were retrieved
 565      *                   'relationship_list' -- Array - The records link field data. The example is if asked about accounts email address then return data would look like Array ( [0] => Array ( [name] => email_addresses [records] => Array ( [0] => Array ( [0] => Array ( [name] => id [value] => 3fb16797-8d90-0a94-ac12-490b63a6be67 ) [1] => Array ( [name] => email_address [value] => hr.kid.qa@example.com ) [2] => Array ( [name] => opt_out [value] => 0 ) [3] => Array ( [name] => primary_address [value] => 1 ) ) [1] => Array ( [0] => Array ( [name] => id [value] => 403f8da1-214b-6a88-9cef-490b63d43566 ) [1] => Array ( [name] => email_address [value] => kid.hr@example.name ) [2] => Array ( [name] => opt_out [value] => 0 ) [3] => Array ( [name] => primary_address [value] => 0 ) ) ) ) )
 566     * @exception 'SoapFault' -- The SOAP error, if any
 567     */
 568     function get_entry_list($session, $module_name, $query, $order_by,$offset, $select_fields, $link_name_to_fields_array, $max_results, $deleted, $favorites = false ){
 569
 570         $GLOBALS['log']->info('Begin: SugarWebServiceImpl->get_entry_list');
 571         global  $beanList, $beanFiles;
 572         $error = new SoapError();
 573         $using_cp = false;
 574         if($module_name == 'CampaignProspects'){
 575             $module_name = 'Prospects';
 576             $using_cp = true;
 577         }
 578         if (!self::$helperObject->checkSessionAndModuleAccess($session, 'invalid_session', $module_name, 'read', 'no_access', $error)) {
 579             $GLOBALS['log']->info('End: SugarWebServiceImpl->get_entry_list');
 580             return;
 581         } // if
 582
 583         if (!self::$helperObject->checkQuery($error, $query, $order_by)) {
 584                 $GLOBALS['log']->info('End: SugarWebServiceImpl->get_entry_list');
 585                 return;
 586         } // if
 587
 588         // If the maximum number of entries per page was specified, override the configuration value.
 589         if($max_results > 0){
 590             global $sugar_config;
 591             $sugar_config['list_max_entries_per_page'] = $max_results;
 592         } // if
 593
 594         $class_name = $beanList[$module_name];
 595         require_once($beanFiles[$class_name]);
 596         $seed = new $class_name();
 597
 598         if (!self::$helperObject->checkACLAccess($seed, 'Export', $error, 'no_access')) {
 599             $GLOBALS['log']->info('End: SugarWebServiceImpl->get_entry_list');
 600             return;
 601         } // if
 602
 603         if (!self::$helperObject->checkACLAccess($seed, 'list', $error, 'no_access')) {
 604             $GLOBALS['log']->info('End: SugarWebServiceImpl->get_entry_list');
 605             return;
 606         } // if
 607
 608         if($query == ''){
 609             $where = '';
 610         } // if
 611         if($offset == '' || $offset == -1){
 612             $offset = 0;
 613         } // if
 614         if($using_cp){
 615             $response = $seed->retrieveTargetList($query, $select_fields, $offset,-1,-1,$deleted);
 616         }else
 617         {
 618             $response = self::$helperObject->get_data_list($seed,$order_by, $query, $offset,-1,-1,$deleted,$favorites);
 619         } // else
 620         $list = $response['list'];
 621
 622         $output_list = array();
 623         $linkoutput_list = array();
 624
 625         foreach($list as $value) {
 626             if(isset($value->emailAddress)){
 627                 $value->emailAddress->handleLegacyRetrieve($value);
 628             } // if
 629             $value->fill_in_additional_detail_fields();
 630
 631             $output_list[] = self::$helperObject->get_return_value_for_fields($value, $module_name, $select_fields);
 632             if(!empty($link_name_to_fields_array)){
 633                 $linkoutput_list[] = self::$helperObject->get_return_value_for_link_fields($value, $module_name, $link_name_to_fields_array);
 634             }
 635         } // foreach
 636
 637         // Calculate the offset for the start of the next page
 638         $next_offset = $offset + sizeof($output_list);
 639
 640                 $returnRelationshipList = array();
 641                 foreach($linkoutput_list as $rel){
 642                         $link_output = array();
 643                         foreach($rel as $row){
 644                                 $rowArray = array();
 645                                 foreach($row['records'] as $record){
 646                                         $rowArray[]['link_value'] = $record;
 647                                 }
 648                                 $link_output[] = array('name' => $row['name'], 'records' => $rowArray);
 649                         }
 650                         $returnRelationshipList[]['link_list'] = $link_output;
 651                 }
 652
 653                 $totalRecordCount = $response['row_count'];
 654         if( !empty($sugar_config['disable_count_query']) )
 655             $totalRecordCount = -1;
 656
 657         $GLOBALS['log']->info('End: SugarWebServiceImpl->get_entry_list');
 658         return array('result_count'=>sizeof($output_list), 'total_count' => $totalRecordCount, 'next_offset'=>$next_offset, 'entry_list'=>$output_list, 'relationship_list' => $returnRelationshipList);
 659     } // fn
 660
 661
 662
 663     /**
 664      * Given a list of modules to search and a search string, return the id, module_name, along with the fields
 665      * We will support Accounts, Bug Tracker, Cases, Contacts, Leads, Opportunities, Project, ProjectTask, Quotes
 666      *
 667      * @param string $session                   - Session ID returned by a previous call to login.
 668      * @param string $search_string     - string to search
 669      * @param string[] $modules                 - array of modules to query
 670      * @param int $offset                               - a specified offset in the query
 671      * @param int $max_results                  - max number of records to return
 672      * @param string $assigned_user_id  - a user id to filter all records by, leave empty to exclude the filter
 673      * @param string[] $select_fields   - An array of fields to return.  If empty the default return fields will be from the active list view defs.
 674      * @param bool $unified_search_only - A boolean indicating if we should only search against those modules participating in the unified search.
 675      * @return Array return_search_result       - Array('Accounts' => array(array('name' => 'first_name', 'value' => 'John', 'name' => 'last_name', 'value' => 'Do')))
 676      * @exception 'SoapFault' -- The SOAP error, if any
 677      */
 678     function search_by_module($session, $search_string, $modules, $offset, $max_results,$assigned_user_id = '', $select_fields = array(), $unified_search_only = TRUE){
 679         $GLOBALS['log']->info('Begin: SugarWebServiceImpl->search_by_module');
 680         global  $beanList, $beanFiles;
 681         global $sugar_config,$current_language;
 682
 683         $error = new SoapError();
 684         $output_list = array();
 685         if (!self::$helperObject->checkSessionAndModuleAccess($session, 'invalid_session', '', '', '', $error)) {
 686                 $error->set_error('invalid_login');
 687                 $GLOBALS['log']->info('End: SugarWebServiceImpl->search_by_module');
 688                 return;
 689         }
 690         global $current_user;
 691         if($max_results > 0){
 692                 $sugar_config['list_max_entries_per_page'] = $max_results;
 693         }
 694
 695         require_once('modules/Home/UnifiedSearchAdvanced.php');
 696         require_once 'include/utils.php';
 697         $usa = new UnifiedSearchAdvanced();
 698         if(!file_exists($cachedfile = sugar_cached('modules/unified_search_modules.php'))) {
 699             $usa->buildCache();
 700         }
 701
 702         include($cachedfile);
 703         $modules_to_search = array();
 704         $unified_search_modules['Users'] =   array('fields' => array());
 705
 706         $unified_search_modules['ProjectTask'] =   array('fields' => array());
 707
 708         //If we are ignoring the unified search flag within the vardef we need to re-create the search fields.  This allows us to search
 709         //against a specific module even though it is not enabled for the unified search within the application.
 710         if( !$unified_search_only )
 711         {
 712             foreach ($modules as $singleModule)
 713             {
 714                 if( !isset($unified_search_modules[$singleModule]) )
 715                 {
 716                     $newSearchFields = array('fields' => self::$helperObject->generateUnifiedSearchFields($singleModule) );
 717                     $unified_search_modules[$singleModule] = $newSearchFields;
 718                 }
 719             }
 720         }
 721
 722
 723         foreach($unified_search_modules as $module=>$data) {
 724                 if (in_array($module, $modules)) {
 725                 $modules_to_search[$module] = $beanList[$module];
 726                 } // if
 727         } // foreach
 728
 729         $GLOBALS['log']->info('SugarWebServiceImpl->search_by_module - search string = ' . $search_string);
 730
 731         if(!empty($search_string) && isset($search_string)) {
 732                 $search_string = trim($GLOBALS['db']->quote(securexss(from_html(clean_string($search_string, 'UNIFIED_SEARCH')))));
 733                 foreach($modules_to_search as $name => $beanName) {
 734                         $where_clauses_array = array();
 735                         $unifiedSearchFields = array () ;
 736                         foreach ($unified_search_modules[$name]['fields'] as $field=>$def ) {
 737                                 $unifiedSearchFields[$name] [ $field ] = $def ;
 738                                 $unifiedSearchFields[$name] [ $field ]['value'] = $search_string;
 739                         }
 740
 741                         require_once $beanFiles[$beanName] ;
 742                         $seed = new $beanName();
 743                         require_once 'include/SearchForm/SearchForm2.php' ;
 744                         if ($beanName == "User"
 745                             || $beanName == "ProjectTask"
 746                             ) {
 747                                 if(!self::$helperObject->check_modules_access($current_user, $seed->module_dir, 'read')){
 748                                         continue;
 749                                 } // if
 750                                 if(!$seed->ACLAccess('ListView')) {
 751                                         continue;
 752                                 } // if
 753                         }
 754
 755                         if ($beanName != "User"
 756                             && $beanName != "ProjectTask"
 757                             ) {
 758                                 $searchForm = new SearchForm ($seed, $name ) ;
 759
 760                                 $searchForm->setup(array ($name => array()) ,$unifiedSearchFields , '' , 'saved_views' /* hack to avoid setup doing further unwanted processing */ ) ;
 761                                 $where_clauses = $searchForm->generateSearchWhere() ;
 762                                 require_once 'include/SearchForm/SearchForm2.php' ;
 763                                 $searchForm = new SearchForm ($seed, $name ) ;
 764
 765                                 $searchForm->setup(array ($name => array()) ,$unifiedSearchFields , '' , 'saved_views' /* hack to avoid setup doing further unwanted processing */ ) ;
 766                                 $where_clauses = $searchForm->generateSearchWhere() ;
 767                                 $emailQuery = false;
 768
 769                                 $where = '';
 770                                 if (count($where_clauses) > 0 ) {
 771                                         $where = '('. implode(' ) OR ( ', $where_clauses) . ')';
 772                                 }
 773
 774                                 $mod_strings = return_module_language($current_language, $seed->module_dir);
 775
 776                                 if(count($select_fields) > 0)
 777                                     $filterFields = $select_fields;
 778                                 else {
 779                                     if(file_exists('custom/modules/'.$seed->module_dir.'/metadata/listviewdefs.php'))
 780                                            require_once('custom/modules/'.$seed->module_dir.'/metadata/listviewdefs.php');
 781                                         else
 782                                                 require_once('modules/'.$seed->module_dir.'/metadata/listviewdefs.php');
 783
 784                                         $filterFields = array();
 785                                         foreach($listViewDefs[$seed->module_dir] as $colName => $param) {
 786                                 if(!empty($param['default']) && $param['default'] == true)
 787                                     $filterFields[] = strtolower($colName);
 788                             }
 789                             if (!in_array('id', $filterFields))
 790                                 $filterFields[] = 'id';
 791                                 }
 792
 793                                 //Pull in any db fields used for the unified search query so the correct joins will be added
 794                                 $selectOnlyQueryFields = array();
 795                                 foreach ($unifiedSearchFields[$name] as $field => $def){
 796                                     if( isset($def['db_field']) && !in_array($field,$filterFields) ){
 797                                         $filterFields[] = $field;
 798                                         $selectOnlyQueryFields[] = $field;
 799                                     }
 800                                 }
 801
 802                     //Add the assigned user filter if applicable
 803                     if (!empty($assigned_user_id) && isset( $seed->field_defs['assigned_user_id']) ) {
 804                        $ownerWhere = $seed->getOwnerWhere($assigned_user_id);
 805                        $where = "($where) AND $ownerWhere";
 806                     }
 807
 808                     if( $beanName == "Employee" )
 809                     {
 810                         $where = "($where) AND users.deleted = 0 AND users.is_group = 0 AND users.employee_status = 'Active'";
 811                     }
 812
 813                                 $ret_array = $seed->create_new_list_query('', $where, $filterFields, array(), 0, '', true, $seed, true);
 814                         if(empty($params) or !is_array($params)) $params = array();
 815                         if(!isset($params['custom_select'])) $params['custom_select'] = '';
 816                         if(!isset($params['custom_from'])) $params['custom_from'] = '';
 817                         if(!isset($params['custom_where'])) $params['custom_where'] = '';
 818                         if(!isset($params['custom_order_by'])) $params['custom_order_by'] = '';
 819                                 $main_query = $ret_array['select'] . $params['custom_select'] . $ret_array['from'] . $params['custom_from'] . $ret_array['where'] . $params['custom_where'] . $ret_array['order_by'] . $params['custom_order_by'];
 820                         } else {
 821                                 if ($beanName == "User") {
 822                                         $filterFields = array('id', 'user_name', 'first_name', 'last_name', 'email_address');
 823                                         $main_query = "select users.id, ea.email_address, users.user_name, first_name, last_name from users ";
 824                                         $main_query = $main_query . " LEFT JOIN email_addr_bean_rel eabl ON eabl.bean_module = '{$seed->module_dir}'
 825     LEFT JOIN email_addresses ea ON (ea.id = eabl.email_address_id) ";
 826                                         $main_query = $main_query . "where ((users.first_name like '{$search_string}') or (users.last_name like '{$search_string}') or (users.user_name like '{$search_string}') or (ea.email_address like '{$search_string}')) and users.deleted = 0 and users.is_group = 0 and users.employee_status = 'Active'";
 827                                 } // if
 828                                 if ($beanName == "ProjectTask") {
 829                                         $filterFields = array('id', 'name', 'project_id', 'project_name');
 830                                         $main_query = "select {$seed->table_name}.project_task_id id,{$seed->table_name}.project_id, {$seed->table_name}.name, project.name project_name from {$seed->table_name} ";
 831                                         $seed->add_team_security_where_clause($main_query);
 832                                         $main_query .= "LEFT JOIN teams ON $seed->table_name.team_id=teams.id AND (teams.deleted=0) ";
 833                             $main_query .= "LEFT JOIN project ON $seed->table_name.project_id = project.id ";
 834                             $main_query .= "where {$seed->table_name}.name like '{$search_string}%'";
 835                                 } // if
 836                         } // else
 837
 838                         $GLOBALS['log']->info('SugarWebServiceImpl->search_by_module - query = ' . $main_query);
 839                         if($max_results < -1) {
 840                                 $result = $seed->db->query($main_query);
 841                         }
 842                         else {
 843                                 if($max_results == -1) {
 844                                         $limit = $sugar_config['list_max_entries_per_page'];
 845                     } else {
 846                         $limit = $max_results;
 847                     }
 848                     $result = $seed->db->limitQuery($main_query, $offset, $limit + 1);
 849                         }
 850
 851                         $rowArray = array();
 852                         while($row = $seed->db->fetchByAssoc($result)) {
 853                                 $nameValueArray = array();
 854                                 foreach ($filterFields as $field) {
 855                                     if(in_array($field, $selectOnlyQueryFields))
 856                                         continue;
 857                                         $nameValue = array();
 858                                         if (isset($row[$field])) {
 859                                                 $nameValueArray[$field] = self::$helperObject->get_name_value($field, $row[$field]);
 860                                         } // if
 861                                 } // foreach
 862                                 $rowArray[] = $nameValueArray;
 863                         } // while
 864                         $output_list[] = array('name' => $name, 'records' => $rowArray);
 865                 } // foreach
 866
 867         $GLOBALS['log']->info('End: SugarWebServiceImpl->search_by_module');
 868         return array('entry_list'=>$output_list);
 869         } // if
 870         return array('entry_list'=>$output_list);
 871     } // fn
 872 }
 873
 874 SugarWebServiceImplv3_1::$helperObject = new SugarWebServiceUtilv3_1();