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