]> CyberLeo.Net >> Repos - Github/sugarcrm.git/blob - service/core/SoapHelperWebService.php
Release 6.4.1
[Github/sugarcrm.git] / service / core / SoapHelperWebService.php
1 <?php
2 if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
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 global $disable_date_format;
40 $disable_date_format = true;
41
42 class SoapHelperWebServices {
43
44         function get_field_list($value, $fields, $translate=true)
45         {
46                 $GLOBALS['log']->info('Begin: SoapHelperWebServices->get_field_list('.print_r($value, true).', '.print_r($fields, true).", $translate");
47                 $module_fields = array();
48                 $link_fields = array();
49                 if(!empty($value->field_defs)){
50
51                         foreach($value->field_defs as $var){
52                                 if(!empty($fields) && !in_array( $var['name'], $fields))continue;
53                                 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;
54                                 if ($var['source'] == 'non_db' && (isset($var['type']) && $var['type'] != 'link')) {
55                                         continue;
56                                 }
57                                 $required = 0;
58                                 $options_dom = array();
59                                 $options_ret = array();
60                                 // Apparently the only purpose of this check is to make sure we only return fields
61                                 //   when we've read a record.  Otherwise this function is identical to get_module_field_list
62
63                                 if( isset($var['required']) && $var['required'] && $var['required'] !== 'false' ){
64                                         $required = 1;
65                                 }
66                                 if(isset($var['options'])){
67                                         $options_dom = translate($var['options'], $value->module_dir);
68                                         if(!is_array($options_dom)) $options_dom = array();
69                                         foreach($options_dom as $key=>$oneOption)
70                                                 $options_ret[$key] = $this->get_name_value($key,$oneOption);
71                                 }
72
73                     if(!empty($var['dbType']) && $var['type'] == 'bool') {
74                         $options_ret['type'] = $this->get_name_value('type', $var['dbType']);
75                     }
76
77                     $entry = array();
78                     $entry['name'] = $var['name'];
79                     $entry['type'] = $var['type'];
80                     if ($var['type'] == 'link') {
81                             $entry['relationship'] = (isset($var['relationship']) ? $var['relationship'] : '');
82                             $entry['module'] = (isset($var['module']) ? $var['module'] : '');
83                             $entry['bean_name'] = (isset($var['bean_name']) ? $var['bean_name'] : '');
84                                         $link_fields[$var['name']] = $entry;
85                     } else {
86                             if($translate) {
87                                 $entry['label'] = isset($var['vname']) ? translate($var['vname'], $value->module_dir) : $var['name'];
88                             } else {
89                                 $entry['label'] = isset($var['vname']) ? $var['vname'] : $var['name'];
90                             }
91                             $entry['required'] = $required;
92                             $entry['options'] = $options_ret;
93                                         if(isset($var['default'])) {
94                                            $entry['default_value'] = $var['default'];
95                                         }
96                                         $module_fields[$var['name']] = $entry;
97                     } // else
98                         } //foreach
99                 } //if
100
101                 if($value->module_dir == 'Bugs'){
102                         require_once('modules/Releases/Release.php');
103                         $seedRelease = new Release();
104                         $options = $seedRelease->get_releases(TRUE, "Active");
105                         $options_ret = array();
106                         foreach($options as $name=>$value){
107                                 $options_ret[] =  array('name'=> $name , 'value'=>$value);
108                         }
109                         if(isset($module_fields['fixed_in_release'])){
110                                 $module_fields['fixed_in_release']['type'] = 'enum';
111                                 $module_fields['fixed_in_release']['options'] = $options_ret;
112                         }
113                         if(isset($module_fields['release'])){
114                                 $module_fields['release']['type'] = 'enum';
115                                 $module_fields['release']['options'] = $options_ret;
116                         }
117                         if(isset($module_fields['release_name'])){
118                                 $module_fields['release_name']['type'] = 'enum';
119                                 $module_fields['release_name']['options'] = $options_ret;
120                         }
121                 }
122
123                 if(isset($value->assigned_user_name) && isset($module_fields['assigned_user_id'])) {
124                         $module_fields['assigned_user_name'] = $module_fields['assigned_user_id'];
125                         $module_fields['assigned_user_name']['name'] = 'assigned_user_name';
126                 }
127                 if(isset($module_fields['modified_user_id'])) {
128                         $module_fields['modified_by_name'] = $module_fields['modified_user_id'];
129                         $module_fields['modified_by_name']['name'] = 'modified_by_name';
130                 }
131                 if(isset($module_fields['created_by'])) {
132                         $module_fields['created_by_name'] = $module_fields['created_by'];
133                         $module_fields['created_by_name']['name'] = 'created_by_name';
134                 }
135
136         $return = array('module_fields' => $module_fields, 'link_fields' => $link_fields);
137         $GLOBALS['log']->info('End: SoapHelperWebServices->get_field_list ->> '.print_r($return, true));
138                 return $return;
139         } // fn
140
141         function setFaultObject($errorObject) {
142                 if ($this->isLogLevelDebug()) {
143                         $GLOBALS['log']->debug('SoapHelperWebServices->setFaultObject - ' . var_export($errorObject, true));
144                 }
145                 global $service_object;
146                 $service_object->error($errorObject);
147         } // fn
148
149 /**
150  * Validate the user session based on user name and password hash.
151  *
152  * @param string $user_name -- The user name to create a session for
153  * @param string $password -- The MD5 sum of the user's password
154  * @return true -- If the session is created
155  * @return false -- If the session is not created
156  */
157 function validate_user($user_name, $password){
158         $GLOBALS['log']->info('Begin: SoapHelperWebServices->validate_user');
159         global $server, $current_user, $sugar_config, $system_config;
160         $user = new User();
161         $user->user_name = $user_name;
162         $system_config = new Administration();
163         $system_config->retrieveSettings('system');
164         $authController = new AuthenticationController((!empty($sugar_config['authenticationClass'])? $sugar_config['authenticationClass'] : 'SugarAuthenticate'));
165         // Check to see if the user name and password are consistent.
166         if($user->authenticate_user($password)){
167                 // we also need to set the current_user.
168                 $user->retrieve($user->id);
169                 $current_user = $user;
170
171                 $GLOBALS['log']->info('End: SoapHelperWebServices->validate_user - validation passed');
172                 return true;
173         }else if(function_exists('mcrypt_cbc')){
174                 $password = $this->decrypt_string($password);
175                 if($authController->login($user_name, $password) && isset($_SESSION['authenticated_user_id'])){
176                         $user->retrieve($_SESSION['authenticated_user_id']);
177                         $current_user = $user;
178                         $GLOBALS['log']->info('End: SoapHelperWebServices->validate_user - validation passed');
179                         return true;
180                 }
181         }else{
182                 $GLOBALS['log']->fatal("SECURITY: failed attempted login for $user_name using SOAP api");
183                 $server->setError("Invalid username and/or password");
184                 return false;
185         }
186
187 }
188
189         /**
190          * Validate the provided session information is correct and current.  Load the session.
191          *
192          * @param String $session_id -- The session ID that was returned by a call to login.
193          * @return true -- If the session is valid and loaded.
194          * @return false -- if the session is not valid.
195          */
196         function validate_authenticated($session_id){
197                 $GLOBALS['log']->info('Begin: SoapHelperWebServices->validate_authenticated');
198                 if(!empty($session_id)){
199
200                         // only initialize session once in case this method is called multiple times
201                         if(!session_id()) {
202                            session_id($session_id);
203                            session_start();
204                         }
205
206                         if(!empty($_SESSION['is_valid_session']) && $this->is_valid_ip_address('ip_address') && $_SESSION['type'] == 'user'){
207
208                                 global $current_user;
209                                 require_once('modules/Users/User.php');
210                                 $current_user = new User();
211                                 $current_user->retrieve($_SESSION['user_id']);
212                                 $this->login_success();
213                                 $GLOBALS['log']->info('Begin: SoapHelperWebServices->validate_authenticated - passed');
214                                 $GLOBALS['log']->info('End: SoapHelperWebServices->validate_authenticated');
215                                 return true;
216                         }
217
218                         $GLOBALS['log']->debug("calling destroy");
219                         session_destroy();
220                 }
221                 LogicHook::initialize();
222                 $GLOBALS['logic_hook']->call_custom_logic('Users', 'login_failed');
223                 $GLOBALS['log']->info('End: SoapHelperWebServices->validate_authenticated - validation failed');
224                 return false;
225         }
226
227         /**
228          * Use the same logic as in SugarAuthenticate to validate the ip address
229          *
230          * @param string $session_var
231          * @return bool - true if the ip address is valid, false otherwise.
232          */
233         function is_valid_ip_address($session_var){
234                 global $sugar_config;
235                 // grab client ip address
236                 $clientIP = query_client_ip();
237                 $classCheck = 0;
238                 // check to see if config entry is present, if not, verify client ip
239                 if (!isset ($sugar_config['verify_client_ip']) || $sugar_config['verify_client_ip'] == true) {
240                         // check to see if we've got a current ip address in $_SESSION
241                         // and check to see if the session has been hijacked by a foreign ip
242                         if (isset ($_SESSION[$session_var])) {
243                                 $session_parts = explode(".", $_SESSION[$session_var]);
244                                 $client_parts = explode(".", $clientIP);
245                     if(count($session_parts) < 4) {
246                         $classCheck = 0;
247                     }else {
248                                 // match class C IP addresses
249                                 for ($i = 0; $i < 3; $i ++) {
250                                         if ($session_parts[$i] == $client_parts[$i]) {
251                                                 $classCheck = 1;
252                                                         continue;
253                                         } else {
254                                                 $classCheck = 0;
255                                                 break;
256                                                 }
257                                         }
258                         }
259                                         // we have a different IP address
260                                         if ($_SESSION[$session_var] != $clientIP && empty ($classCheck)) {
261                                                 $GLOBALS['log']->fatal("IP Address mismatch: SESSION IP: {$_SESSION[$session_var]} CLIENT IP: {$clientIP}");
262                                                 return false;
263                                         }
264                                 } else {
265                                         return false;
266                                 }
267                 }
268                 return true;
269         }
270
271         function checkSessionAndModuleAccess($session, $login_error_key, $module_name, $access_level, $module_access_level_error_key, $errorObject) {
272                 $GLOBALS['log']->info('Begin: SoapHelperWebServices->checkSessionAndModuleAccess - ' . $module_name);
273                 if(!$this->validate_authenticated($session)){
274                         $GLOBALS['log']->error('SoapHelperWebServices->checkSessionAndModuleAccess - validate_authenticated failed - ' . $module_name);
275                         $errorObject->set_error('invalid_session');
276                         $this->setFaultObject($errorObject);
277                         $GLOBALS['log']->info('End: SoapHelperWebServices->checkSessionAndModuleAccess -' . $module_name);
278                         return false;
279                 } // if
280
281                 global  $beanList, $beanFiles;
282                 if (!empty($module_name)) {
283                         if(empty($beanList[$module_name])){
284                                 $GLOBALS['log']->error('SoapHelperWebServices->checkSessionAndModuleAccess - module does not exists - ' . $module_name);
285                                 $errorObject->set_error('no_module');
286                                 $this->setFaultObject($errorObject);
287                                 $GLOBALS['log']->info('End: SoapHelperWebServices->checkSessionAndModuleAccess -' . $module_name);
288                                 return false;
289                         } // if
290                         global $current_user;
291                         if(!$this->check_modules_access($current_user, $module_name, $access_level)){
292                                 $GLOBALS['log']->error('SoapHelperWebServices->checkSessionAndModuleAccess - no module access - ' . $module_name);
293                                 $errorObject->set_error('no_access');
294                                 $this->setFaultObject($errorObject);
295                                 $GLOBALS['log']->info('End: SoapHelperWebServices->checkSessionAndModuleAccess - ' . $module_name);
296                                 return false;
297                         }
298                 } // if
299                 $GLOBALS['log']->info('End: SoapHelperWebServices->checkSessionAndModuleAccess - ' . $module_name);
300                 return true;
301         } // fn
302
303         function checkACLAccess($bean, $viewType, $errorObject, $error_key) {
304                 $GLOBALS['log']->info('Begin: SoapHelperWebServices->checkACLAccess');
305                 if(!$bean->ACLAccess($viewType)) {
306                         $GLOBALS['log']->error('SoapHelperWebServices->checkACLAccess - no ACLAccess');
307                         $errorObject->set_error($error_key);
308                         $this->setFaultObject($errorObject);
309                         $GLOBALS['log']->info('End: SoapHelperWebServices->checkACLAccess');
310                         return false;
311                 } // if
312                 $GLOBALS['log']->info('End: SoapHelperWebServices->checkACLAccess');
313                 return true;
314         } // fn
315
316         function checkQuery($errorObject, $query, $order_by = '')
317     {
318         require_once 'include/SugarSQLValidate.php';
319         $valid = new SugarSQLValidate();
320         if(!$valid->validateQueryClauses($query, $order_by)) {
321                 $GLOBALS['log']->error("SoapHelperWebServices->checkQuery - bad query: $query $order_by");
322             $errorObject->set_error('no_access');
323                 $this->setFaultObject($errorObject);
324                 return false;
325         }
326         return true;
327     }
328
329         function get_name_value($field,$value){
330                 return array('name'=>$field, 'value'=>$value);
331         }
332
333         function get_user_module_list($user){
334                 $GLOBALS['log']->info('Begin: SoapHelperWebServices->get_user_module_list');
335                 global $app_list_strings, $current_language;
336                 $app_list_strings = return_app_list_strings_language($current_language);
337                 $modules = query_module_access_list($user);
338                 ACLController :: filterModuleList($modules, false);
339                 global $modInvisList;
340
341                 foreach($modInvisList as $invis){
342                         $modules[$invis] = 'read_only';
343                 }
344
345                 $actions = ACLAction::getUserActions($user->id,true);
346                 foreach($actions as $key=>$value){
347                         if(isset($value['module']) && $value['module']['access']['aclaccess'] < ACL_ALLOW_ENABLED){
348                                 if ($value['module']['access']['aclaccess'] == ACL_ALLOW_DISABLED) {
349                                         unset($modules[$key]);
350                                 } else {
351                                         $modules[$key] = 'read_only';
352                                 } // else
353                         } else {
354                                 $modules[$key] = '';
355                         } // else
356                 } // foreach
357                 $GLOBALS['log']->info('End: SoapHelperWebServices->get_user_module_list');
358                 return $modules;
359
360         }
361
362         function check_modules_access($user, $module_name, $action='write'){
363                 $GLOBALS['log']->info('Begin: SoapHelperWebServices->check_modules_access');
364                 if(!isset($_SESSION['avail_modules'])){
365                         $_SESSION['avail_modules'] = $this->get_user_module_list($user);
366                 }
367                 if(isset($_SESSION['avail_modules'][$module_name])){
368                         if($action == 'write' && $_SESSION['avail_modules'][$module_name] == 'read_only'){
369                                 if(is_admin($user)) {
370                                         $GLOBALS['log']->info('End: SoapHelperWebServices->check_modules_access - SUCCESS: Admin can even write to read_only module');
371                                         return true;
372                                 } // if
373                                 $GLOBALS['log']->info('End: SoapHelperWebServices->check_modules_access - FAILED: write action on read_only module only available to admins');
374                                 return false;
375                         }elseif($action == 'write' && strcmp(strtolower($module_name), 'users') == 0 && !$user->isAdminForModule($module_name)){
376                  //rrs bug: 46000 - If the client is trying to write to the Users module and is not an admin then we need to stop them
377                 return false;
378             }
379                         $GLOBALS['log']->info('End: SoapHelperWebServices->check_modules_access - SUCCESS');
380                         return true;
381                 }
382                 $GLOBALS['log']->info('End: SoapHelperWebServices->check_modules_access - FAILED: Module info not available in $_SESSION');
383                 return false;
384
385     }
386
387
388         function get_name_value_list($value){
389                 $GLOBALS['log']->info('Begin: SoapHelperWebServices->get_name_value_list');
390                 global $app_list_strings;
391                 $list = array();
392                 if(!empty($value->field_defs)){
393                         if(isset($value->assigned_user_name)) {
394                                 $list['assigned_user_name'] = $this->get_name_value('assigned_user_name', $value->assigned_user_name);
395                         }
396                         if(isset($value->modified_by_name)) {
397                                 $list['modified_by_name'] = $this->get_name_value('modified_by_name', $value->modified_by_name);
398                         }
399                         if(isset($value->created_by_name)) {
400                                 $list['created_by_name'] = $this->get_name_value('created_by_name', $value->created_by_name);
401                         }
402                         foreach($value->field_defs as $var){
403                                 if(isset($var['source']) && ($var['source'] != 'db' && $var['source'] != 'custom_fields') && $var['name'] != 'email1' && $var['name'] != 'email2' && (!isset($var['type'])|| $var['type'] != 'relate'))continue;
404
405                                 if(isset($value->$var['name'])){
406                                         $val = $value->$var['name'];
407                                         $type = $var['type'];
408
409                                         if(strcmp($type, 'date') == 0){
410                                                 $val = substr($val, 0, 10);
411                                         }elseif(strcmp($type, 'enum') == 0 && !empty($var['options'])){
412                                                 //$val = $app_list_strings[$var['options']][$val];
413                                         }
414
415                                         $list[$var['name']] = $this->get_name_value($var['name'], $val);
416                                 }
417                         }
418                 }
419                 $GLOBALS['log']->info('End: SoapHelperWebServices->get_name_value_list');
420                 return $list;
421
422         }
423
424         function filter_fields($value, $fields) {
425                 $GLOBALS['log']->info('Begin: SoapHelperWebServices->filter_fields');
426                 global $invalid_contact_fields;
427                 $filterFields = array();
428                 foreach($fields as $field){
429                         if (is_array($invalid_contact_fields)) {
430                                 if (in_array($field, $invalid_contact_fields)) {
431                                         continue;
432                                 } // if
433                         } // if
434                         if (isset($value->field_defs[$field])) {
435                                 $var = $value->field_defs[$field];
436                                 if(isset($var['source']) && ($var['source'] != 'db' && $var['source'] != 'custom_fields') && $var['name'] != 'email1' && $var['name'] != 'email2' && (!isset($var['type'])|| $var['type'] != 'relate')) {
437
438                                         if($value->module_dir == 'Emails' && (($var['name'] == 'description') || ($var['name'] == 'description_html') || ($var['name'] == 'from_addr_name') || ($var['name'] == 'reply_to_addr') || ($var['name'] == 'to_addrs_names') || ($var['name'] == 'cc_addrs_names') || ($var['name'] == 'bcc_addrs_names') || ($var['name'] == 'raw_source'))) {
439
440                                         } else {
441                                                 continue;
442                                         }
443                                 }
444                         } // if
445                         $filterFields[] = $field;
446                 } // foreach
447                 $GLOBALS['log']->info('End: SoapHelperWebServices->filter_fields');
448                 return $filterFields;
449         } // fn
450
451         function get_name_value_list_for_fields($value, $fields) {
452                 $GLOBALS['log']->info('Begin: SoapHelperWebServices->get_name_value_list_for_fields');
453                 global $app_list_strings;
454                 global $invalid_contact_fields;
455
456                 $list = array();
457                 if(!empty($value->field_defs)){
458                         if(empty($fields))$fields = array_keys($value->field_defs);
459                         if(isset($value->assigned_user_name) && in_array('assigned_user_name', $fields)) {
460                                 $list['assigned_user_name'] = $this->get_name_value('assigned_user_name', $value->assigned_user_name);
461                         }
462                         if(isset($value->modified_by_name) && in_array('modified_by_name', $fields)) {
463                                 $list['modified_by_name'] = $this->get_name_value('modified_by_name', $value->modified_by_name);
464                         }
465                         if(isset($value->created_by_name) && in_array('created_by_name', $fields)) {
466                                 $list['created_by_name'] = $this->get_name_value('created_by_name', $value->created_by_name);
467                         }
468
469                         $filterFields = $this->filter_fields($value, $fields);
470                         foreach($filterFields as $field){
471                                 $var = $value->field_defs[$field];
472                                 if(isset($value->$var['name'])){
473                                         $val = $value->$var['name'];
474                                         $type = $var['type'];
475
476                                         if(strcmp($type, 'date') == 0){
477                                                 $val = substr($val, 0, 10);
478                                         }elseif(strcmp($type, 'enum') == 0 && !empty($var['options'])){
479                                                 //$val = $app_list_strings[$var['options']][$val];
480                                         }
481
482                                         $list[$var['name']] = $this->get_name_value($var['name'], $val);
483                                 } // if
484                         } // foreach
485                 } // if
486                 $GLOBALS['log']->info('End: SoapHelperWebServices->get_name_value_list_for_fields');
487                 if ($this->isLogLevelDebug()) {
488                         $GLOBALS['log']->debug('SoapHelperWebServices->get_name_value_list_for_fields - return data = ' . var_export($list, true));
489                 } // if
490                 return $list;
491
492         } // fn
493
494         function array_get_name_value_list($array){
495                 $GLOBALS['log']->info('Begin: SoapHelperWebServices->array_get_name_value_list');
496                 $list = array();
497                 foreach($array as $name=>$value){
498                         $list[$name] = $this->get_name_value($name, $value);
499                 }
500                 $GLOBALS['log']->info('End: SoapHelperWebServices->array_get_name_value_list');
501                 return $list;
502
503         }
504
505         function array_get_name_value_lists($array){
506                 $GLOBALS['log']->info('Begin: SoapHelperWebServices->array_get_name_value_lists');
507             $list = array();
508             foreach($array as $name=>$value){
509                 $tmp_value=$value;
510                 if(is_array($value)){
511                     $tmp_value = array();
512                     foreach($value as $k=>$v){
513                         $tmp_value[$k] = $this->get_name_value($k, $v);
514                     }
515                 }
516                 $list[$name] = $this->get_name_value($name, $tmp_value);
517             }
518                 $GLOBALS['log']->info('End: SoapHelperWebServices->array_get_name_value_lists');
519             return $list;
520         }
521
522         function name_value_lists_get_array($list){
523                 $GLOBALS['log']->info('Begin: SoapHelperWebServices->name_value_lists_get_array');
524             $array = array();
525             foreach($list as $key=>$value){
526                 if(isset($value['value']) && isset($value['name'])){
527                     if(is_array($value['value'])){
528                         $array[$value['name']]=array();
529                         foreach($value['value'] as $v){
530                             $array[$value['name']][$v['name']]=$v['value'];
531                         }
532                     }else{
533                         $array[$value['name']]=$value['value'];
534                     }
535                 }
536             }
537                 $GLOBALS['log']->info('End: SoapHelperWebServices->name_value_lists_get_array');
538             return $array;
539         }
540
541         function array_get_return_value($array, $module){
542
543                 $GLOBALS['log']->info('Begin/End: SoapHelperWebServices->array_get_return_value');
544                 return Array('id'=>$array['id'],
545                                         'module_name'=> $module,
546                                         'name_value_list'=>$this->array_get_name_value_list($array)
547                                         );
548         }
549
550         function get_return_value_for_fields($value, $module, $fields) {
551                 $GLOBALS['log']->info('Begin: SoapHelperWebServices->get_return_value_for_fields');
552                 global $module_name, $current_user;
553                 $module_name = $module;
554                 if($module == 'Users' && $value->id != $current_user->id){
555                         $value->user_hash = '';
556                 }
557                 $GLOBALS['log']->info('End: SoapHelperWebServices->get_return_value_for_fields');
558                 return Array('id'=>$value->id,
559                                         'module_name'=> $module,
560                                         'name_value_list'=>$this->get_name_value_list_for_fields($value, $fields)
561                                         );
562         }
563
564 /**
565  * Fetch and array of related records
566  *
567  * @param String $bean -- Primary record
568  * @param String $link_field_name -- The name of the relationship
569  * @param Array $link_module_fields -- The keys of the array are the SugarBean attributes, the values of the array are the values the attributes should have.
570  * @param String $optional_where -- IGNORED
571  * @return Array 'rows/fields_set_on_rows' -- The list of records and what fields were actually set for thos erecords
572 */
573
574         function getRelationshipResults($bean, $link_field_name, $link_module_fields, $optional_where = '') {
575                 $GLOBALS['log']->info('Begin: SoapHelperWebServices->getRelationshipResults');
576                 require_once('include/TimeDate.php');
577                 global $current_user, $disable_date_format,  $timedate;
578
579                 $bean->load_relationship($link_field_name);
580                 if (isset($bean->$link_field_name)) {
581                         //First get all the related beans
582             $related_beans = $bean->$link_field_name->getBeans();
583                         $filterFields = $this->filter_fields($submodule, $link_module_fields);
584             //Create a list of field/value rows based on $link_module_fields
585                         $list = array();
586             foreach($related_beans as $id => $bean)
587             {
588                 $row = array();
589                 foreach ($filterFields as $field) {
590                     if (isset($bean->$field))
591                     {
592                         if (isset($bean->field_defs[$field]['type']) && $bean->field_defs[$field]['type'] == 'date') {
593                             $row[$field] = $timedate->to_display_date_time($bean->$field);
594                         }
595                         $row[$field] = $bean->$field;
596                     }
597                     else
598                     {
599                         $row[$field] = "";
600                     }
601                 }
602                 //Users can't see other user's hashes
603                 if(is_a($bean, 'User') && $current_user->id != $bean->id && isset($row['user_hash'])) {
604                     $row['user_hash'] = "";
605                 }
606                 $list[] = $row;
607             }
608                         $GLOBALS['log']->info('End: SoapHelperWebServices->getRelationshipResults');
609                         return array('rows' => $list, 'fields_set_on_rows' => $filterFields);
610                 } else {
611                         $GLOBALS['log']->info('End: SoapHelperWebServices->getRelationshipResults - ' . $link_field_name . ' relationship does not exists');
612                         return false;
613                 } // else
614
615         } // fn
616
617         function get_return_value_for_link_fields($bean, $module, $link_name_to_value_fields_array) {
618                 $GLOBALS['log']->info('Begin: SoapHelperWebServices->get_return_value_for_link_fields');
619                 global $module_name, $current_user;
620                 $module_name = $module;
621                 if($module == 'Users' && $bean->id != $current_user->id){
622                         $bean->user_hash = '';
623                 }
624
625                 if (empty($link_name_to_value_fields_array) || !is_array($link_name_to_value_fields_array)) {
626                         $GLOBALS['log']->debug('End: SoapHelperWebServices->get_return_value_for_link_fields - Invalid link information passed ');
627                         return array();
628                 }
629
630                 if ($this->isLogLevelDebug()) {
631                         $GLOBALS['log']->debug('SoapHelperWebServices->get_return_value_for_link_fields - link info = ' . var_export($link_name_to_value_fields_array, true));
632                 } // if
633                 $link_output = array();
634                 foreach($link_name_to_value_fields_array as $link_name_value_fields) {
635                         if (!is_array($link_name_value_fields) || !isset($link_name_value_fields['name']) || !isset($link_name_value_fields['value'])) {
636                                 continue;
637                         }
638                         $link_field_name = $link_name_value_fields['name'];
639                         $link_module_fields = $link_name_value_fields['value'];
640                         if (is_array($link_module_fields) && !empty($link_module_fields)) {
641                                 $result = $this->getRelationshipResults($bean, $link_field_name, $link_module_fields);
642                                 if (!$result) {
643                                         $link_output[] = array('name' => $link_field_name, 'records' => array());
644                                         continue;
645                                 }
646                                 $list = $result['rows'];
647                                 $filterFields = $result['fields_set_on_rows'];
648                                 if ($list) {
649                                         $rowArray = array();
650                                         foreach($list as $row) {
651                                                 $nameValueArray = array();
652                                                 foreach ($filterFields as $field) {
653                                                         $nameValue = array();
654                                                         if (isset($row[$field])) {
655                                                                 $nameValueArray[$field] = $this->get_name_value($field, $row[$field]);
656                                                         } // if
657                                                 } // foreach
658                                                 $rowArray[] = $nameValueArray;
659                                         } // foreach
660                                         $link_output[] = array('name' => $link_field_name, 'records' => $rowArray);
661                                 } // if
662                         } // if
663                 } // foreach
664                 $GLOBALS['log']->debug('End: SoapHelperWebServices->get_return_value_for_link_fields');
665                 if ($this->isLogLevelDebug()) {
666                         $GLOBALS['log']->debug('SoapHelperWebServices->get_return_value_for_link_fields - output = ' . var_export($link_output, true));
667                 } // if
668                 return $link_output;
669         } // fn
670
671         /**
672          *
673          * @param String $module_name -- The name of the module that the primary record is 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).
674          * @param String $module_id -- The ID of the bean in the specified module
675          * @param String $link_field_name - The relationship name for which to create realtionships.
676          * @param Array $related_ids -- The array of ids for which we want to create relationships
677          * @param Array $name_value_list -- The array of name value pair of additional attributes to be set when adding this relationship
678          * @param int delete -- If 0 then add relationship else delete this relationship data
679          * @return true on success, false on failure
680          */
681         function new_handle_set_relationship($module_name, $module_id, $link_field_name, $related_ids, $name_value_list, $delete) {
682                 $GLOBALS['log']->info('Begin: SoapHelperWebServices->new_handle_set_relationship');
683             global  $beanList, $beanFiles;
684
685             if(empty($beanList[$module_name])) {
686                         $GLOBALS['log']->debug('SoapHelperWebServices->new_handle_set_relationship - module ' . $module_name . ' does not exists' );
687                         $GLOBALS['log']->info('End: SoapHelperWebServices->new_handle_set_relationship');
688                 return false;
689             } // if
690             $class_name = $beanList[$module_name];
691             require_once($beanFiles[$class_name]);
692             $mod = new $class_name();
693             $mod->retrieve($module_id);
694                 if(!$mod->ACLAccess('DetailView')){
695                         $GLOBALS['log']->info('End: SoapHelperWebServices->new_handle_set_relationship');
696                         return false;
697                 }
698
699                 if ($mod->load_relationship($link_field_name)) {
700                         if (!$delete) {
701                                 $name_value_pair = array();
702                                 if (!empty($name_value_list)) {
703                                         $relFields = $mod->$link_field_name->getRelatedFields();
704                                         if(!empty($relFields)){
705                                                 $relFieldsKeys = array_keys($relFields);
706                                                 foreach($name_value_list as $key => $value) {
707                                                         if (in_array($value['name'], $relFieldsKeys)) {
708                                                                 $name_value_pair[$value['name']] = $value['value'];
709                                                         } // if
710                                                 } // foreach
711                                         } // if
712                                 }
713                                 $mod->$link_field_name->add($related_ids, $name_value_pair);
714                         } else {
715                                 foreach($related_ids as $id) {
716                                         $mod->$link_field_name->delete($module_id, $id);
717                                 } // foreach
718                         } // else
719                         $GLOBALS['log']->info('End: SoapHelperWebServices->new_handle_set_relationship');
720                         return true;
721                 } else {
722                         $GLOBALS['log']->info('End: SoapHelperWebServices->new_handle_set_relationship');
723                         return false;
724                 }
725         }
726
727         function new_handle_set_entries($module_name, $name_value_lists, $select_fields = FALSE) {
728                 $GLOBALS['log']->info('Begin: SoapHelperWebServices->new_handle_set_entries');
729                 global $beanList, $beanFiles, $current_user, $app_list_strings;
730
731                 $ret_values = array();
732
733                 $class_name = $beanList[$module_name];
734                 require_once($beanFiles[$class_name]);
735                 $ids = array();
736                 $count = 1;
737                 $total = sizeof($name_value_lists);
738                 foreach($name_value_lists as $name_value_list){
739                         $seed = new $class_name();
740
741                         $seed->update_vcal = false;
742                         foreach($name_value_list as $value){
743                                 if($value['name'] == 'id'){
744                                         $seed->retrieve($value['value']);
745                                         break;
746                                 }
747                         }
748
749                         foreach($name_value_list as $value) {
750                                 $val = $value['value'];
751                                 if($seed->field_name_map[$value['name']]['type'] == 'enum'){
752                                         $vardef = $seed->field_name_map[$value['name']];
753                                         if(isset($app_list_strings[$vardef['options']]) && !isset($app_list_strings[$vardef['options']][$value]) ) {
754                                                 if ( in_array($val,$app_list_strings[$vardef['options']]) ){
755                                                         $val = array_search($val,$app_list_strings[$vardef['options']]);
756                                                 }
757                                         }
758                                 }
759                                 if($module_name == 'Users' && !empty($seed->id) && ($seed->id != $current_user->id) && $value['name'] == 'user_hash'){
760                                         continue;
761                                 }
762
763                                 $seed->$value['name'] = $val;
764                         }
765
766                         if($count == $total){
767                                 $seed->update_vcal = false;
768                         }
769                         $count++;
770
771                         //Add the account to a contact
772                         if($module_name == 'Contacts'){
773                                 $GLOBALS['log']->debug('Creating Contact Account');
774                                 $this->add_create_account($seed);
775                                 $duplicate_id = $this->check_for_duplicate_contacts($seed);
776                                 if($duplicate_id == null){
777                                         if($seed->ACLAccess('Save') && ($seed->deleted != 1 || $seed->ACLAccess('Delete'))){
778                                                 $seed->save();
779                                                 if($seed->deleted == 1){
780                                                         $seed->mark_deleted($seed->id);
781                                                 }
782                                                 $ids[] = $seed->id;
783                                         }
784                                 }
785                                 else{
786                                         //since we found a duplicate we should set the sync flag
787                                         if( $seed->ACLAccess('Save')){
788                                                 $seed = new $class_name();
789                                                 $seed->id = $duplicate_id;
790                                                 $seed->contacts_users_id = $current_user->id;
791                                                 $seed->save();
792                                                 $ids[] = $duplicate_id;//we have a conflict
793                                         }
794                                 }
795                         }
796                         else if($module_name == 'Meetings' || $module_name == 'Calls'){
797                                 //we are going to check if we have a meeting in the system
798                                 //with the same outlook_id. If we do find one then we will grab that
799                                 //id and save it
800                                 if( $seed->ACLAccess('Save') && ($seed->deleted != 1 || $seed->ACLAccess('Delete'))){
801                                         if(empty($seed->id) && !isset($seed->id)){
802                                                 if(!empty($seed->outlook_id) && isset($seed->outlook_id)){
803                                                         //at this point we have an object that does not have
804                                                         //the id set, but does have the outlook_id set
805                                                         //so we need to query the db to find if we already
806                                                         //have an object with this outlook_id, if we do
807                                                         //then we can set the id, otherwise this is a new object
808                                                         $order_by = "";
809                                                         $query = $seed->table_name.".outlook_id = '".$GLOBALS['db']->quote($seed->outlook_id)."'";
810                                                         $response = $seed->get_list($order_by, $query, 0,-1,-1,0);
811                                                         $list = $response['list'];
812                                                         if(count($list) > 0){
813                                                                 foreach($list as $value)
814                                                                 {
815                                                                         $seed->id = $value->id;
816                                                                         break;
817                                                                 }
818                                                         }//fi
819                                                 }//fi
820                                         }//fi
821                                     if (empty($seed->reminder_time)) {
822                         $seed->reminder_time = -1;
823                     }
824                     if($seed->reminder_time == -1){
825                         $defaultRemindrTime = $current_user->getPreference('reminder_time');
826                         if ($defaultRemindrTime != -1){
827                             $seed->reminder_checked = '1';
828                             $seed->reminder_time = $defaultRemindrTime;
829                         }
830                     }
831                                         $seed->save();
832                                         $ids[] = $seed->id;
833                                 }//fi
834                         }
835                         else
836                         {
837                                 if( $seed->ACLAccess('Save') && ($seed->deleted != 1 || $seed->ACLAccess('Delete'))){
838                                         $seed->save();
839                                         $ids[] = $seed->id;
840                                 }
841                         }
842
843                         // if somebody is calling set_entries_detail() and wants fields returned...
844                         if ($select_fields !== FALSE) {
845                                 $ret_values[$count] = array();
846
847                                 foreach ($select_fields as $select_field) {
848                                         if (isset($seed->$select_field)) {
849                                                 $ret_values[$count][$select_field] = $this->get_name_value($select_field, $seed->$select_field);
850                                         }
851                                 }
852                         }
853                 }
854
855                 // handle returns for set_entries_detail() and set_entries()
856                 if ($select_fields !== FALSE) {
857                         $GLOBALS['log']->info('End: SoapHelperWebServices->new_handle_set_entries');
858                         return array(
859                                 'name_value_lists' => $ret_values,
860                         );
861                 }
862                 else {
863                         $GLOBALS['log']->info('End: SoapHelperWebServices->new_handle_set_entries');
864                         return array(
865                                 'ids' => $ids,
866                         );
867                 }
868         }
869
870         function get_return_value($value, $module){
871                 $GLOBALS['log']->info('Begin: SoapHelperWebServices->get_return_value');
872                 global $module_name, $current_user;
873                 $module_name = $module;
874                 if($module == 'Users' && $value->id != $current_user->id){
875                         $value->user_hash = '';
876                 }
877                 $GLOBALS['log']->info('End: SoapHelperWebServices->new_handle_set_entries');
878                 return Array('id'=>$value->id,
879                                         'module_name'=> $module,
880                                         'name_value_list'=>$this->get_name_value_list($value)
881                                         );
882         }
883
884
885         function get_return_module_fields($value, $module,$fields, $translate=true){
886                 $GLOBALS['log']->info('Begin: SoapHelperWebServices->get_return_module_fields');
887                 global $module_name;
888                 $module_name = $module;
889                 $result = $this->get_field_list($value,$fields,  $translate);
890                 $GLOBALS['log']->info('End: SoapHelperWebServices->get_return_module_fields');
891                 return Array('module_name'=>$module,
892                                         'module_fields'=> $result['module_fields'],
893                                         'link_fields'=> $result['link_fields'],
894                                         );
895         } // fn
896
897         function login_success($name_value_list = array()){
898                 $GLOBALS['log']->info('Begin: SoapHelperWebServices->login_success');
899                 global $current_language, $sugar_config, $app_strings, $app_list_strings;
900                 $current_language = $sugar_config['default_language'];
901                 if (is_array($name_value_list) && !empty($name_value_list)) {
902                         foreach($name_value_list as $key => $value) {
903                                 if (isset($value['name']) && ($value['name'] == 'language')) {
904                                         $language = $value['value'];
905                                         $supportedLanguages = $sugar_config['languages'];
906                                         if (array_key_exists($language, $supportedLanguages)) {
907                                                 $current_language = $language;
908                                         } // if
909                                 } // if
910                                 if (isset($value['name']) && ($value['name'] == 'notifyonsave')) {
911                                         if ($value['value']) {
912                                                 $_SESSION['notifyonsave'] = true;
913                                         }
914                                 } // if
915                         } // foreach
916                 } else {
917                         if (isset($_SESSION['user_language'])) {
918                                 $current_language = $_SESSION['user_language'];
919                         } // if
920                 }
921                 $GLOBALS['log']->info("Users language is = " . $current_language);
922                 $app_strings = return_application_language($current_language);
923                 $app_list_strings = return_app_list_strings_language($current_language);
924                 $GLOBALS['log']->info('End: SoapHelperWebServices->login_success');
925         } // fn
926
927
928         function checkSaveOnNotify() {
929             $notifyonsave = false;
930             if (isset($_SESSION['notifyonsave']) && $_SESSION['notifyonsave'] == true) {
931                 $notifyonsave = true;
932             } // if
933                 return $notifyonsave;
934         }
935         /*
936          *      Given an account_name, either create the account or assign to a contact.
937          */
938         function add_create_account($seed) {
939                 $GLOBALS['log']->info('Begin: SoapHelperWebServices->add_create_account');
940                 global $current_user;
941                 $account_name = $seed->account_name;
942                 $account_id = $seed->account_id;
943                 $assigned_user_id = $current_user->id;
944
945                 // check if it already exists
946             $focus = new Account();
947             if($focus->ACLAccess('Save')) {
948                         $class = get_class($seed);
949                         $temp = new $class();
950                         $temp->retrieve($seed->id);
951                         if ( empty($account_name) && empty($account_id)) {
952                                 return;
953                         } // if
954                         if (!isset($seed->accounts)){
955                             $seed->load_relationship('accounts');
956                         } // if
957
958                         if($seed->account_name == '' && isset($temp->account_id)){
959                                 $seed->accounts->delete($seed->id, $temp->account_id);
960                                 $GLOBALS['log']->info('End: SoapHelperWebServices->add_create_account');
961                                 return;
962                         }
963                     $arr = array();
964
965             if(!empty($account_id))  // bug # 44280
966             {
967                $query = "select id, deleted from {$focus->table_name} WHERE id='".$seed->db->quote($account_id)."'";
968             }
969             else
970             {
971                $query = "select id, deleted from {$focus->table_name} WHERE name='".$seed->db->quote($account_name)."'";
972             }
973             $result = $seed->db->query($query, true);
974
975                     $row = $seed->db->fetchByAssoc($result, false);
976
977                         // we found a row with that id
978                     if (isset($row['id']) && $row['id'] != -1)
979                     {
980                         // if it exists but was deleted, just remove it entirely
981                         if ( isset($row['deleted']) && $row['deleted'] == 1)
982                         {
983                             $query2 = "delete from {$focus->table_name} WHERE id='". $seed->db->quote($row['id'])."'";
984                             $result2 = $seed->db->query($query2, true);
985                                 }
986                                 // else just use this id to link the contact to the account
987                         else
988                         {
989                                 $focus->id = $row['id'];
990                         }
991                     }
992
993                         // if we didnt find the account, so create it
994                     if (! isset($focus->id) || $focus->id == '')
995                     {
996                         $focus->name = $account_name;
997
998                                 if ( isset($assigned_user_id))
999                                 {
1000                            $focus->assigned_user_id = $assigned_user_id;
1001                            $focus->modified_user_id = $assigned_user_id;
1002                                 }
1003                         $focus->save();
1004                     }
1005
1006                     if($seed->accounts != null && $temp->account_id != null && $temp->account_id != $focus->id){
1007                         $seed->accounts->delete($seed->id, $temp->account_id);
1008                     }
1009
1010                     if(isset($focus->id) && $focus->id != ''){
1011                                 $seed->account_id = $focus->id;
1012                         } // if
1013                         $GLOBALS['log']->info('End: SoapHelperWebServices->add_create_account');
1014
1015             } else {
1016                         $GLOBALS['log']->info('End: SoapHelperWebServices->add_create_account - Insufficient ACLAccess');
1017             } // else
1018         } // fn
1019
1020         function check_for_duplicate_contacts($seed){
1021                 $GLOBALS['log']->info('Begin: SoapHelperWebServices->check_for_duplicate_contacts');
1022                 require_once('modules/Contacts/Contact.php');
1023
1024                 if(isset($seed->id)){
1025                         $GLOBALS['log']->info('End: SoapHelperWebServices->check_for_duplicate_contacts - no duplicte found');
1026                         return null;
1027                 }
1028
1029                 $query = '';
1030
1031                 $trimmed_email = trim($seed->email1);
1032         $trimmed_email2 = trim($seed->email2);
1033             $trimmed_last = trim($seed->last_name);
1034             $trimmed_first = trim($seed->first_name);
1035                 if(!empty($trimmed_email) || !empty($trimmed_email2)){
1036
1037                         //obtain a list of contacts which contain the same email address
1038                         $contacts = $seed->emailAddress->getBeansByEmailAddress($trimmed_email);
1039             $contacts2 = $seed->emailAddress->getBeansByEmailAddress($trimmed_email2);
1040             $contacts = array_merge($contacts, $contacts2);
1041                         if(count($contacts) == 0){
1042                                 $GLOBALS['log']->info('End: SoapHelperWebServices->check_for_duplicate_contacts - no duplicte found');
1043                                 return null;
1044                         }else{
1045                                 foreach($contacts as $contact){
1046                                         if(!empty($trimmed_last) && strcmp($trimmed_last, $contact->last_name) == 0){
1047                                                 if((!empty($trimmed_email) || !empty($trimmed_email2)) && (strcmp($trimmed_email, $contact->email1) == 0 || strcmp($trimmed_email, $contact->email2) == 0 || strcmp($trimmed_email2, $contact->email) == 0 || strcmp($trimmed_email2, $contact->email2) == 0)){
1048                                                         $contact->load_relationship('accounts');
1049                                                         if(empty($seed->account_name) || strcmp($seed->account_name, $contact->account_name) == 0){
1050                                 $GLOBALS['log']->info('End: SoapHelperWebServices->check_for_duplicate_contacts - duplicte found ' . $contact->id);
1051                                                                 return $contact->id;
1052                                                         }
1053                                                 }
1054                                         }
1055                                 }
1056                                 $GLOBALS['log']->info('End: SoapHelperWebServices->check_for_duplicate_contacts - no duplicte found');
1057                                 return null;
1058                         }
1059                 }else
1060                         $GLOBALS['log']->info('End: SoapHelperWebServices->check_for_duplicate_contacts - no duplicte found');
1061                         return null;
1062         }
1063
1064
1065         /**
1066          * decrypt a string use the TripleDES algorithm. This meant to be
1067          * modified if the end user chooses a different algorithm
1068          *
1069          * @param $string - the string to decrypt
1070          *
1071          * @return a decrypted string if we can decrypt, the original string otherwise
1072          */
1073         function decrypt_string($string){
1074                 $GLOBALS['log']->info('Begin: SoapHelperWebServices->decrypt_string');
1075                 if(function_exists('mcrypt_cbc')){
1076                         require_once('modules/Administration/Administration.php');
1077                         $focus = new Administration();
1078                         $focus->retrieveSettings();
1079                         $key = '';
1080                         if(!empty($focus->settings['ldap_enc_key'])){
1081                                 $key = $focus->settings['ldap_enc_key'];
1082                         }
1083                         if(empty($key)) {
1084                                 $GLOBALS['log']->info('End: SoapHelperWebServices->decrypt_string - empty key');
1085                                 return $string;
1086                         } // if
1087                         $buffer = $string;
1088                         $key = substr(md5($key),0,24);
1089                     $iv = "password";
1090                         $GLOBALS['log']->info('End: SoapHelperWebServices->decrypt_string');
1091                     return mcrypt_cbc(MCRYPT_3DES, $key, pack("H*", $buffer), MCRYPT_DECRYPT, $iv);
1092                 }else{
1093                         $GLOBALS['log']->info('End: SoapHelperWebServices->decrypt_string');
1094                         return $string;
1095                 }
1096         } // fn
1097
1098         function isLogLevelDebug() {
1099                 if (isset($GLOBALS['sugar_config']['logger'])) {
1100                         if (isset($GLOBALS['sugar_config']['logger']['level'])) {
1101                                 return ($GLOBALS['sugar_config']['logger']['level'] == 'debug');
1102                         } // if
1103                 }
1104                 return false;
1105         } // fn
1106 } // clazz
1107
1108 ?>