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