soap/SoapHelperFunctions.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 /**
  40  * Retrieve field data for a provided SugarBean.
  41  *
  42  * @param SugarBean $value -- The bean to retrieve the field information for.
  43  * @return Array -- 'field'=>   'name' -- the name of the field
  44  *                              'type' -- the data type of the field
  45  *                              'label' -- the translation key for the label of the field
  46  *                              'required' -- Is the field required?
  47  *                              'options' -- Possible values for a drop down field
  48  */
  49 function get_field_list($value, $translate=true){
  50         $list = array();
  51
  52         if(!empty($value->field_defs)){
  53
  54                 foreach($value->field_defs as $var){
  55                         if(isset($var['source']) && ($var['source'] != 'db' && $var['source'] != 'custom_fields') && $var['name'] != 'email1' && $var['name'] != 'email2' && (!isset($var['type'])|| $var['type'] != 'relate'))continue;
  56                         $required = 0;
  57                         $options_dom = array();
  58                         $options_ret = array();
  59                         // Apparently the only purpose of this check is to make sure we only return fields
  60                         //   when we've read a record.  Otherwise this function is identical to get_module_field_list
  61                         if(!empty($var['required'])) {
  62                                 $required = 1;
  63                         }
  64                         if(isset($var['options'])){
  65                                 $options_dom = translate($var['options'], $value->module_dir);
  66                                 if(!is_array($options_dom)) $options_dom = array();
  67                                 foreach($options_dom as $key=>$oneOption)
  68                                         $options_ret[] = get_name_value($key,$oneOption);
  69                         }
  70
  71             if(!empty($var['dbType']) && $var['type'] == 'bool') {
  72                 $options_ret[] = get_name_value('type', $var['dbType']);
  73             }
  74
  75             $entry = array();
  76             $entry['name'] = $var['name'];
  77             $entry['type'] = $var['type'];
  78             if($translate) {
  79             $entry['label'] = isset($var['vname']) ? translate($var['vname'], $value->module_dir) : $var['name'];
  80             } else {
  81             $entry['label'] = isset($var['vname']) ? $var['vname'] : $var['name'];
  82             }
  83             $entry['required'] = $required;
  84             $entry['options'] = $options_ret;
  85                         if(isset($var['default'])) {
  86                            $entry['default_value'] = $var['default'];
  87                         }
  88
  89                         $list[$var['name']] = $entry;
  90                 } //foreach
  91         } //if
  92
  93         if($value->module_dir == 'Bugs'){
  94
  95                 $seedRelease = new Release();
  96                 $options = $seedRelease->get_releases(TRUE, "Active");
  97                 $options_ret = array();
  98                 foreach($options as $name=>$value){
  99                         $options_ret[] =  array('name'=> $name , 'value'=>$value);
 100                 }
 101                 if(isset($list['fixed_in_release'])){
 102                         $list['fixed_in_release']['type'] = 'enum';
 103                         $list['fixed_in_release']['options'] = $options_ret;
 104                 }
 105                 if(isset($list['release'])){
 106                         $list['release']['type'] = 'enum';
 107                         $list['release']['options'] = $options_ret;
 108                 }
 109                 if(isset($list['release_name'])){
 110                         $list['release_name']['type'] = 'enum';
 111                         $list['release_name']['options'] = $options_ret;
 112                 }
 113         }
 114     if($value->module_dir == 'Emails'){
 115         $fields = array('from_addr_name', 'reply_to_addr', 'to_addrs_names', 'cc_addrs_names', 'bcc_addrs_names');
 116         foreach($fields as $field){
 117             $var = $value->field_defs[$field];
 118
 119             $required = 0;
 120             $entry = array();
 121             $entry['name'] = $var['name'];
 122             $entry['type'] = $var['type'];
 123             if($translate) {
 124             $entry['label'] = isset($var['vname']) ? translate($var['vname'], $value->module_dir) : $var['name'];
 125             } else {
 126             $entry['label'] = isset($var['vname']) ? $var['vname'] : $var['name'];
 127             }
 128             $entry['required'] = $required;
 129             $entry['options'] = array();
 130                         if(isset($var['default'])) {
 131                            $entry['default_value'] = $var['default'];
 132                         }
 133
 134                         $list[$var['name']] = $entry;
 135         }
 136     }
 137
 138         if(isset($value->assigned_user_name) && isset($list['assigned_user_id'])) {
 139                 $list['assigned_user_name'] = $list['assigned_user_id'];
 140                 $list['assigned_user_name']['name'] = 'assigned_user_name';
 141         }
 142         if(isset($list['modified_user_id'])) {
 143                 $list['modified_by_name'] = $list['modified_user_id'];
 144                 $list['modified_by_name']['name'] = 'modified_by_name';
 145         }
 146         if(isset($list['created_by'])) {
 147                 $list['created_by_name'] = $list['created_by'];
 148                 $list['created_by_name']['name'] = 'created_by_name';
 149         }
 150         return $list;
 151 }
 152
 153 function new_get_field_list($value, $translate=true) {
 154         $module_fields = array();
 155         $link_fields = array();
 156
 157         if(!empty($value->field_defs)){
 158
 159                 foreach($value->field_defs as $var){
 160                         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;
 161                         if ($var['source'] == 'non_db' && (isset($var['type']) && $var['type'] != 'link')) {
 162                                 continue;
 163                         }
 164                         $required = 0;
 165                         $options_dom = array();
 166                         $options_ret = array();
 167                         // Apparently the only purpose of this check is to make sure we only return fields
 168                         //   when we've read a record.  Otherwise this function is identical to get_module_field_list
 169                         if(!empty($var['required'])) {
 170                                 $required = 1;
 171                         }
 172                         if(isset($var['options'])){
 173                                 $options_dom = translate($var['options'], $value->module_dir);
 174                                 if(!is_array($options_dom)) $options_dom = array();
 175                                 foreach($options_dom as $key=>$oneOption)
 176                                         $options_ret[] = get_name_value($key,$oneOption);
 177                         }
 178
 179             if(!empty($var['dbType']) && $var['type'] == 'bool') {
 180                 $options_ret[] = get_name_value('type', $var['dbType']);
 181             }
 182
 183             $entry = array();
 184             $entry['name'] = $var['name'];
 185             $entry['type'] = $var['type'];
 186             if ($var['type'] == 'link') {
 187                     $entry['relationship'] = (isset($var['relationship']) ? $var['relationship'] : '');
 188                     $entry['module'] = (isset($var['module']) ? $var['module'] : '');
 189                     $entry['bean_name'] = (isset($var['bean_name']) ? $var['bean_name'] : '');
 190                                 $link_fields[$var['name']] = $entry;
 191             } else {
 192                     if($translate) {
 193                         $entry['label'] = isset($var['vname']) ? translate($var['vname'], $value->module_dir) : $var['name'];
 194                     } else {
 195                         $entry['label'] = isset($var['vname']) ? $var['vname'] : $var['name'];
 196                     }
 197                     $entry['required'] = $required;
 198                     $entry['options'] = $options_ret;
 199                                 if(isset($var['default'])) {
 200                                    $entry['default_value'] = $var['default'];
 201                                 }
 202                                 $module_fields[$var['name']] = $entry;
 203             } // else
 204                 } //foreach
 205         } //if
 206
 207         if($value->module_dir == 'Bugs'){
 208
 209                 $seedRelease = new Release();
 210                 $options = $seedRelease->get_releases(TRUE, "Active");
 211                 $options_ret = array();
 212                 foreach($options as $name=>$value){
 213                         $options_ret[] =  array('name'=> $name , 'value'=>$value);
 214                 }
 215                 if(isset($module_fields['fixed_in_release'])){
 216                         $module_fields['fixed_in_release']['type'] = 'enum';
 217                         $module_fields['fixed_in_release']['options'] = $options_ret;
 218                 }
 219                 if(isset($module_fields['release'])){
 220                         $module_fields['release']['type'] = 'enum';
 221                         $module_fields['release']['options'] = $options_ret;
 222                 }
 223                 if(isset($module_fields['release_name'])){
 224                         $module_fields['release_name']['type'] = 'enum';
 225                         $module_fields['release_name']['options'] = $options_ret;
 226                 }
 227         }
 228
 229         if(isset($value->assigned_user_name) && isset($module_fields['assigned_user_id'])) {
 230                 $module_fields['assigned_user_name'] = $module_fields['assigned_user_id'];
 231                 $module_fields['assigned_user_name']['name'] = 'assigned_user_name';
 232         }
 233         if(isset($module_fields['modified_user_id'])) {
 234                 $module_fields['modified_by_name'] = $module_fields['modified_user_id'];
 235                 $module_fields['modified_by_name']['name'] = 'modified_by_name';
 236         }
 237         if(isset($module_fields['created_by'])) {
 238                 $module_fields['created_by_name'] = $module_fields['created_by'];
 239                 $module_fields['created_by_name']['name'] = 'created_by_name';
 240         }
 241
 242         return array('module_fields' => $module_fields, 'link_fields' => $link_fields);
 243 } // fn
 244
 245 function setFaultObject($errorObject) {
 246         global $soap_server_object;
 247         $soap_server_object->fault($errorObject->getFaultCode(), $errorObject->getName(), '', $errorObject->getDescription());
 248 } // fn
 249
 250 function checkSessionAndModuleAccess($session, $login_error_key, $module_name, $access_level, $module_access_level_error_key, $errorObject) {
 251         if(!validate_authenticated($session)){
 252                 $errorObject->set_error('invalid_login');
 253                 setFaultObject($errorObject);
 254                 return false;
 255         } // if
 256
 257         global  $beanList, $beanFiles;
 258         if (!empty($module_name)) {
 259                 if(empty($beanList[$module_name])){
 260                         $errorObject->set_error('no_module');
 261                         setFaultObject($errorObject);
 262                         return false;
 263                 } // if
 264                 global $current_user;
 265                 if(!check_modules_access($current_user, $module_name, $access_level)){
 266                         $errorObject->set_error('no_access');
 267                         setFaultObject($errorObject);
 268                         return false;
 269                 }
 270         } // if
 271         return true;
 272 } // fn
 273
 274 function checkACLAccess($bean, $viewType, $errorObject, $error_key) {
 275         if(!$bean->ACLAccess($viewType)){
 276                 $errorObject->set_error($error_key);
 277                 setFaultObject($errorObject);
 278                 return false;
 279         } // if
 280         return true;
 281 } // fn
 282
 283 function get_name_value($field,$value){
 284         return array('name'=>$field, 'value'=>$value);
 285 }
 286
 287 function get_user_module_list($user){
 288         global $app_list_strings, $current_language, $beanList, $beanFiles;
 289
 290         $app_list_strings = return_app_list_strings_language($current_language);
 291         $modules = query_module_access_list($user);
 292         ACLController :: filterModuleList($modules, false);
 293         global $modInvisList;
 294
 295         foreach($modInvisList as $invis){
 296                 $modules[$invis] = 'read_only';
 297         }
 298
 299         $actions = ACLAction::getUserActions($user->id,true);
 300         foreach($actions as $key=>$value){
 301                 if(isset($value['module']) && $value['module']['access']['aclaccess'] < ACL_ALLOW_ENABLED){
 302                         if ($value['module']['access']['aclaccess'] == ACL_ALLOW_DISABLED) {
 303                                 unset($modules[$key]);
 304                         } else {
 305                                 $modules[$key] = 'read_only';
 306                         } // else
 307                 } else {
 308                         $modules[$key] = '';
 309                 } // else
 310         } // foreach
 311
 312         //Remove all modules that don't have a beanFiles entry associated with it
 313         foreach($modules as $module_name=>$module)
 314         {
 315         if ( isset($beanList[$module_name]) ) {
 316             $class_name = $beanList[$module_name];
 317             if(empty($beanFiles[$class_name])) {
 318                 unset($modules[$module_name]);
 319             }
 320         } else {
 321             unset($modules[$module_name]);
 322         }
 323         }
 324
 325         return $modules;
 326
 327 }
 328
 329 function check_modules_access($user, $module_name, $action='write'){
 330         if(!isset($_SESSION['avail_modules'])){
 331                 $_SESSION['avail_modules'] = get_user_module_list($user);
 332         }
 333     if(isset($_SESSION['avail_modules'][$module_name])){
 334                 if($action == 'write' && $_SESSION['avail_modules'][$module_name] == 'read_only'){
 335                         if(is_admin($user))return true;
 336                         return false;
 337                 }elseif($action == 'write' && strcmp(strtolower($module_name), 'users') == 0 && !$user->isAdminForModule($module_name)){
 338             //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
 339             return false;
 340         }
 341                 return true;
 342         }
 343         return false;
 344
 345 }
 346
 347 function get_name_value_list($value, $returnDomValue = false){
 348         global $app_list_strings;
 349         $list = array();
 350         if(!empty($value->field_defs)){
 351                 if(isset($value->assigned_user_name)) {
 352                         $list['assigned_user_name'] = get_name_value('assigned_user_name', $value->assigned_user_name);
 353                 }
 354                 if(isset($value->modified_by_name)) {
 355                         $list['modified_by_name'] = get_name_value('modified_by_name', $value->modified_by_name);
 356                 }
 357                 if(isset($value->created_by_name)) {
 358                         $list['created_by_name'] = get_name_value('created_by_name', $value->created_by_name);
 359                 }
 360                 foreach($value->field_defs as $var){
 361                         if(isset($var['source']) && ($var['source'] != 'db' && $var['source'] != 'custom_fields') && $var['name'] != 'email1' && $var['name'] != 'email2' && (!isset($var['type'])|| $var['type'] != 'relate')){
 362
 363                                         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'))) {
 364
 365                                         } else {
 366                                                 continue;
 367                                         }
 368                                 }
 369
 370                         if(isset($value->$var['name'])){
 371                                 $val = $value->$var['name'];
 372                                 $type = $var['type'];
 373
 374                                 if(strcmp($type, 'date') == 0){
 375                                         $val = substr($val, 0, 10);
 376                                 }elseif(strcmp($type, 'enum') == 0 && !empty($var['options']) && $returnDomValue){
 377                                         $val = $app_list_strings[$var['options']][$val];
 378                                 }
 379
 380                                 $list[$var['name']] = get_name_value($var['name'], $val);
 381                         }
 382                 }
 383         }
 384         return $list;
 385
 386 }
 387
 388 function filter_fields($value, $fields) {
 389         global $invalid_contact_fields;
 390         $filterFields = array();
 391         foreach($fields as $field){
 392                 if (is_array($invalid_contact_fields)) {
 393                         if (in_array($field, $invalid_contact_fields)) {
 394                                 continue;
 395                         } // if
 396                 } // if
 397                 if (isset($value->field_defs[$field])) {
 398                         $var = $value->field_defs[$field];
 399                         if(isset($var['source']) && ($var['source'] != 'db' && $var['source'] != 'custom_fields') && $var['name'] != 'email1' && $var['name'] != 'email2' && (!isset($var['type'])|| $var['type'] != 'relate')) {
 400
 401                                 continue;
 402                         }
 403                 } // if
 404         // No valid field should be caught by this quoting.
 405                 $filterFields[] = getValidDBName($field);
 406         } // foreach
 407         return $filterFields;
 408 } // fn
 409
 410 function get_name_value_list_for_fields($value, $fields) {
 411         global $app_list_strings;
 412         global $invalid_contact_fields;
 413
 414         $list = array();
 415         if(!empty($value->field_defs)){
 416                 if(isset($value->assigned_user_name) && in_array('assigned_user_name', $fields)) {
 417                         $list['assigned_user_name'] = get_name_value('assigned_user_name', $value->assigned_user_name);
 418                 }
 419                 if(isset($value->modified_by_name) && in_array('modified_by_name', $fields)) {
 420                         $list['modified_by_name'] = get_name_value('modified_by_name', $value->modified_by_name);
 421                 }
 422                 if(isset($value->created_by_name) && in_array('created_by_name', $fields)) {
 423                         $list['created_by_name'] = get_name_value('created_by_name', $value->created_by_name);
 424                 }
 425
 426                 $filterFields = filter_fields($value, $fields);
 427                 foreach($filterFields as $field){
 428                         $var = $value->field_defs[$field];
 429                         if(isset($value->$var['name'])){
 430                                 $val = $value->$var['name'];
 431                                 $type = $var['type'];
 432
 433                                 if(strcmp($type, 'date') == 0){
 434                                         $val = substr($val, 0, 10);
 435                                 }elseif(strcmp($type, 'enum') == 0 && !empty($var['options'])){
 436                                         $val = $app_list_strings[$var['options']][$val];
 437                                 }
 438
 439                                 $list[$var['name']] = get_name_value($var['name'], $val);
 440                         } // if
 441                 } // foreach
 442         } // if
 443         return $list;
 444
 445 } // fn
 446
 447
 448 function array_get_name_value_list($array){
 449         $list = array();
 450         foreach($array as $name=>$value){
 451
 452                                 $list[$name] = get_name_value($name, $value);
 453         }
 454         return $list;
 455
 456 }
 457
 458 function array_get_name_value_lists($array){
 459     $list = array();
 460     foreach($array as $name=>$value){
 461         $tmp_value=$value;
 462         if(is_array($value)){
 463             $tmp_value = array();
 464             foreach($value as $k=>$v){
 465                 $tmp_value[] = get_name_value($k, $v);
 466             }
 467         }
 468         $list[] = get_name_value($name, $tmp_value);
 469     }
 470     return $list;
 471 }
 472
 473 function name_value_lists_get_array($list){
 474     $array = array();
 475     foreach($list as $key=>$value){
 476         if(isset($value['value']) && isset($value['name'])){
 477             if(is_array($value['value'])){
 478                 $array[$value['name']]=array();
 479                 foreach($value['value'] as $v){
 480                     $array[$value['name']][$v['name']]=$v['value'];
 481                 }
 482             }else{
 483                 $array[$value['name']]=$value['value'];
 484             }
 485         }
 486     }
 487     return $array;
 488 }
 489
 490 function array_get_return_value($array, $module){
 491
 492         return Array('id'=>$array['id'],
 493                                 'module_name'=> $module,
 494                                 'name_value_list'=>array_get_name_value_list($array)
 495                                 );
 496 }
 497
 498 function get_return_value_for_fields($value, $module, $fields) {
 499         global $module_name, $current_user;
 500         $module_name = $module;
 501         if($module == 'Users' && $value->id != $current_user->id){
 502                 $value->user_hash = '';
 503         }
 504         return Array('id'=>$value->id,
 505                                 'module_name'=> $module,
 506                                 'name_value_list'=>get_name_value_list_for_fields($value, $fields)
 507                                 );
 508 }
 509
 510 function getRelationshipResults($bean, $link_field_name, $link_module_fields) {
 511         global  $beanList, $beanFiles;
 512         $bean->load_relationship($link_field_name);
 513         if (isset($bean->$link_field_name)) {
 514                 // get the query object for this link field
 515                 $query_array = $bean->$link_field_name->getQuery(true,array(),0,'',true);
 516                 $params = array();
 517                 $params['joined_tables'] = $query_array['join_tables'];
 518
 519                 // get the related module name and instantiate a bean for that.
 520                 $submodulename = $bean->$link_field_name->getRelatedModuleName();
 521                 $submoduleclass = $beanList[$submodulename];
 522                 require_once($beanFiles[$submoduleclass]);
 523
 524                 $submodule = new $submoduleclass();
 525                 $filterFields = filter_fields($submodule, $link_module_fields);
 526                 $relFields = $bean->$link_field_name->getRelatedFields();
 527                 $roleSelect = '';
 528
 529                 if(!empty($relFields)){
 530                         foreach($link_module_fields as $field){
 531                                 if(!empty($relFields[$field])){
 532                                         $roleSelect .= ', ' . $query_array['join_tables'][0] . '.'. $field;
 533                                 }
 534                         }
 535                 }
 536                 // create a query
 537                 $subquery = $submodule->create_new_list_query('','',$filterFields,$params, 0,'', true,$bean);
 538                 $query =  $subquery['select'].$roleSelect .   $subquery['from'].$query_array['join']. $subquery['where'];
 539
 540                 $result = $submodule->db->query($query, true);
 541                 $list = array();
 542                 while($row = $submodule->db->fetchByAssoc($result)) {
 543                         $list[] = $row;
 544                 }
 545                 return array('rows' => $list, 'fields_set_on_rows' => $filterFields);
 546         } else {
 547                 return false;
 548         } // else
 549
 550 } // fn
 551
 552 function get_return_value_for_link_fields($bean, $module, $link_name_to_value_fields_array) {
 553         global $module_name, $current_user;
 554         $module_name = $module;
 555         if($module == 'Users' && $bean->id != $current_user->id){
 556                 $bean->user_hash = '';
 557         }
 558
 559         if (empty($link_name_to_value_fields_array) || !is_array($link_name_to_value_fields_array)) {
 560                 return array();
 561         }
 562
 563         $link_output = array();
 564         foreach($link_name_to_value_fields_array as $link_name_value_fields) {
 565                 if (!is_array($link_name_value_fields) || !isset($link_name_value_fields['name']) || !isset($link_name_value_fields['value'])) {
 566                         continue;
 567                 }
 568                 $link_field_name = $link_name_value_fields['name'];
 569                 $link_module_fields = $link_name_value_fields['value'];
 570                 if (is_array($link_module_fields) && !empty($link_module_fields)) {
 571                         $result = getRelationshipResults($bean, $link_field_name, $link_module_fields);
 572                         if (!$result) {
 573                                 $link_output[] = array('name' => $link_field_name, 'records' => array());
 574                                 continue;
 575                         }
 576                         $list = $result['rows'];
 577                         $filterFields = $result['fields_set_on_rows'];
 578                         if ($list) {
 579                                 $rowArray = array();
 580                                 foreach($list as $row) {
 581                                         $nameValueArray = array();
 582                                         foreach ($filterFields as $field) {
 583                                                 $nameValue = array();
 584                                                 if (isset($row[$field])) {
 585                                                         $nameValue['name'] = $field;
 586                                                         $nameValue['value'] = $row[$field];
 587                                                         $nameValueArray[] = $nameValue;
 588                                                 } // if
 589                                         } // foreach
 590                                         $rowArray[] = $nameValueArray;
 591                                 } // foreach
 592                                 $link_output[] = array('name' => $link_field_name, 'records' => $rowArray);
 593                         } // if
 594                 } // if
 595         } // foreach
 596         return $link_output;
 597 } // fn
 598
 599 /**
 600  *
 601  * @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).
 602  * @param String $module_id -- The ID of the bean in the specified module
 603  * @param String $link_field_name - The relationship name for which to create realtionships.
 604  * @param Array $related_ids -- The array of ids for which we want to create relationships
 605  * @return true on success, false on failure
 606  */
 607 function new_handle_set_relationship($module_name, $module_id, $link_field_name, $related_ids) {
 608     global  $beanList, $beanFiles;
 609
 610     if(empty($beanList[$module_name])) {
 611         return false;
 612     } // if
 613     $class_name = $beanList[$module_name];
 614     require_once($beanFiles[$class_name]);
 615     $mod = new $class_name();
 616     $mod->retrieve($module_id);
 617         if(!$mod->ACLAccess('DetailView')){
 618                 return false;
 619         }
 620
 621     foreach($related_ids as $ids) {
 622         $GLOBALS['log']->debug("ids = " . $ids );
 623     }
 624
 625         if ($mod->load_relationship($link_field_name)) {
 626                 $mod->$link_field_name->add($related_ids);
 627                 return true;
 628         } else {
 629                 return false;
 630         }
 631 }
 632
 633 function new_handle_set_entries($module_name, $name_value_lists, $select_fields = FALSE) {
 634         global $beanList, $beanFiles, $app_list_strings;
 635         global $current_user;
 636
 637         $ret_values = array();
 638
 639         $class_name = $beanList[$module_name];
 640         require_once($beanFiles[$class_name]);
 641         $ids = array();
 642         $count = 1;
 643         $total = sizeof($name_value_lists);
 644         foreach($name_value_lists as $name_value_list){
 645                 $seed = new $class_name();
 646
 647                 $seed->update_vcal = false;
 648                 foreach($name_value_list as $value){
 649                         if($value['name'] == 'id'){
 650                                 $seed->retrieve($value['value']);
 651                                 break;
 652                         }
 653                 }
 654
 655                 foreach($name_value_list as $value) {
 656                         $val = $value['value'];
 657                         if($seed->field_name_map[$value['name']]['type'] == 'enum'){
 658                                 $vardef = $seed->field_name_map[$value['name']];
 659                                 if(isset($app_list_strings[$vardef['options']]) && !isset($app_list_strings[$vardef['options']][$value]) ) {
 660                             if ( in_array($val,$app_list_strings[$vardef['options']]) ){
 661                                 $val = array_search($val,$app_list_strings[$vardef['options']]);
 662                             }
 663                         }
 664                         }
 665                         $seed->$value['name'] = $val;
 666                 }
 667
 668                 if($count == $total){
 669                         $seed->update_vcal = false;
 670                 }
 671                 $count++;
 672
 673                 //Add the account to a contact
 674                 if($module_name == 'Contacts'){
 675                         $GLOBALS['log']->debug('Creating Contact Account');
 676                         add_create_account($seed);
 677                         $duplicate_id = check_for_duplicate_contacts($seed);
 678                         if($duplicate_id == null){
 679                                 if($seed->ACLAccess('Save') && ($seed->deleted != 1 || $seed->ACLAccess('Delete'))){
 680                                         $seed->save();
 681                                         if($seed->deleted == 1){
 682                                                 $seed->mark_deleted($seed->id);
 683                                         }
 684                                         $ids[] = $seed->id;
 685                                 }
 686                         }
 687                         else{
 688                                 //since we found a duplicate we should set the sync flag
 689                                 if( $seed->ACLAccess('Save')){
 690                                         $seed = new $class_name();
 691                                         $seed->id = $duplicate_id;
 692                                         $seed->contacts_users_id = $current_user->id;
 693                                         $seed->save();
 694                                         $ids[] = $duplicate_id;//we have a conflict
 695                                 }
 696                         }
 697                 }
 698                 else if($module_name == 'Meetings' || $module_name == 'Calls'){
 699                         //we are going to check if we have a meeting in the system
 700                         //with the same outlook_id. If we do find one then we will grab that
 701                         //id and save it
 702                         if( $seed->ACLAccess('Save') && ($seed->deleted != 1 || $seed->ACLAccess('Delete'))){
 703                                 if(empty($seed->id) && !isset($seed->id)){
 704                                         if(!empty($seed->outlook_id) && isset($seed->outlook_id)){
 705                                                 //at this point we have an object that does not have
 706                                                 //the id set, but does have the outlook_id set
 707                                                 //so we need to query the db to find if we already
 708                                                 //have an object with this outlook_id, if we do
 709                                                 //then we can set the id, otherwise this is a new object
 710                                                 $order_by = "";
 711                                                 $query = $seed->table_name.".outlook_id = '".$GLOBALS['db']->quote($seed->outlook_id)."'";
 712                                                 $response = $seed->get_list($order_by, $query, 0,-1,-1,0);
 713                                                 $list = $response['list'];
 714                                                 if(count($list) > 0){
 715                                                         foreach($list as $value)
 716                                                         {
 717                                                                 $seed->id = $value->id;
 718                                                                 break;
 719                                                         }
 720                                                 }//fi
 721                                         }//fi
 722                                 }//fi
 723                                 $seed->save();
 724                                 $ids[] = $seed->id;
 725                         }//fi
 726                 }
 727                 else
 728                 {
 729                         if( $seed->ACLAccess('Save') && ($seed->deleted != 1 || $seed->ACLAccess('Delete'))){
 730                                 $seed->save();
 731                                 $ids[] = $seed->id;
 732                         }
 733                 }
 734
 735                 // if somebody is calling set_entries_detail() and wants fields returned...
 736                 if ($select_fields !== FALSE) {
 737                         $ret_values[$count] = array();
 738
 739                         foreach ($select_fields as $select_field) {
 740                                 if (isset($seed->$select_field)) {
 741                                         $ret_values[$count][] = get_name_value($select_field, $seed->$select_field);
 742                                 }
 743                         }
 744                 }
 745         }
 746
 747         // handle returns for set_entries_detail() and set_entries()
 748         if ($select_fields !== FALSE) {
 749                 return array(
 750                         'name_value_lists' => $ret_values,
 751                 );
 752         }
 753         else {
 754                 return array(
 755                         'ids' => $ids,
 756                 );
 757         }
 758 }
 759
 760 function get_return_value($value, $module, $returnDomValue = false){
 761         global $module_name, $current_user;
 762         $module_name = $module;
 763         if($module == 'Users' && $value->id != $current_user->id){
 764                 $value->user_hash = '';
 765         }
 766         return Array('id'=>$value->id,
 767                                 'module_name'=> $module,
 768                                 'name_value_list'=>get_name_value_list($value, $returnDomValue)
 769                                 );
 770 }
 771
 772
 773 function get_encoded_Value($value) {
 774
 775     $value = htmlspecialchars($value);
 776
 777     // bug 47683, special characters cause OPI parser to fail
 778     // htmlspecialchars or htmlentities does not convert control characters
 779     // so we have to convert them by ourselves.
 780     // Per http://en.wikipedia.org/wiki/XML#Valid_characters
 781     // 00 is not allowed in XML
 782     // 09, 0A, 0D and 85 does not require escaping
 783     // CDATA is also needed
 784     $conv_table = array();
 785     $conv_table["\x00"] = ""; // not allowed in XML so remove it
 786     $conv_table["\x01"] = "&#x01;";
 787     $conv_table["\x02"] = "&#x02;";
 788     $conv_table["\x03"] = "&#x03;";
 789     $conv_table["\x04"] = "&#x04;";
 790     $conv_table["\x05"] = "&#x05;";
 791     $conv_table["\x06"] = "&#x06;";
 792     $conv_table["\x07"] = "&#x07;";
 793     $conv_table["\x08"] = "&#x08;";
 794     //$conv_table["\x09"] = "&#x09;";
 795     //$conv_table["\x0A"] = "&#x0A;";
 796     $conv_table["\x0B"] = "&#x0B;";
 797     $conv_table["\x0C"] = "&#x0C;";
 798     //$conv_table["\x0D"] = "&#x0D;";
 799     $conv_table["\x0E"] = "&#x0E;";
 800     $conv_table["\x0F"] = "&#x0F;";
 801     $conv_table["\x10"] = "&#x10";
 802     $conv_table["\x11"] = "&#x11;";
 803     $conv_table["\x12"] = "&#x12;";
 804     $conv_table["\x13"] = "&#x13;";
 805     $conv_table["\x14"] = "&#x14;";
 806     $conv_table["\x15"] = "&#x15;";
 807     $conv_table["\x16"] = "&#x16;";
 808     $conv_table["\x17"] = "&#x17;";
 809     $conv_table["\x18"] = "&#x18;";
 810     $conv_table["\x19"] = "&#x19;";
 811     $conv_table["\x1A"] = "&#x1A;";
 812     $conv_table["\x1B"] = "&#x1B;";
 813     $conv_table["\x1C"] = "&#x1C;";
 814     $conv_table["\x1D"] = "&#x1D;";
 815     $conv_table["\x1E"] = "&#x1E;";
 816     $conv_table["\x1F"] = "&#x1F;";
 817     $conv_table["\x80"] = "&#x80;";
 818     $conv_table["\x81"] = "&#x81;";
 819     $conv_table["\x82"] = "&#x82;";
 820     $conv_table["\x83"] = "&#x83;";
 821     $conv_table["\x84"] = "&#x84;";
 822     $conv_table["\x85"] = "&#x85;";
 823     $conv_table["\x86"] = "&#x86;";
 824     $conv_table["\x87"] = "&#x87;";
 825     $conv_table["\x88"] = "&#x88;";
 826     $conv_table["\x89"] = "&#x89;";
 827     $conv_table["\x8A"] = "&#x8A;";
 828     $conv_table["\x8B"] = "&#x8B;";
 829     $conv_table["\x8C"] = "&#x8C;";
 830     $conv_table["\x8D"] = "&#x8D;";
 831     $conv_table["\x8E"] = "&#x8E;";
 832     $conv_table["\x8F"] = "&#x8F;";
 833     $conv_table["\x90"] = "&#x90;";
 834     $conv_table["\x91"] = "&#x91;";
 835     $conv_table["\x92"] = "&#x92;";
 836     $conv_table["\x93"] = "&#x93;";
 837     $conv_table["\x94"] = "&#x94;";
 838     $conv_table["\x95"] = "&#x95;";
 839     $conv_table["\x96"] = "&#x96;";
 840     $conv_table["\x97"] = "&#x97;";
 841     $conv_table["\x98"] = "&#x98;";
 842     $conv_table["\x99"] = "&#x99;";
 843     $conv_table["\x9A"] = "&#x9A;";
 844     $conv_table["\x9B"] = "&#x9B;";
 845     $conv_table["\x9C"] = "&#x9C;";
 846     $conv_table["\x9D"] = "&#x9D;";
 847     $conv_table["\x9E"] = "&#x9E;";
 848     $conv_table["\x9F"] = "&#x9F;";
 849
 850     // convert
 851     $value = strtr($value, $conv_table);
 852
 853     // wrap it with CDATA
 854     $value = '<value><![CDATA['.$value.']]></value>';
 855
 856     return $value;
 857 }
 858
 859 function get_name_value_xml($val, $module_name){
 860         $xml = '<item>';
 861                         $xml .= '<id>'.$val['id'].'</id>';
 862                         $xml .= '<module>'.$module_name.'</module>';
 863                         $xml .= '<name_value_list>';
 864                         foreach($val['name_value_list'] as $name=>$nv){
 865                                 $xml .= '<name_value>';
 866                                 $xml .= '<name>'.htmlspecialchars($nv['name']).'</name>';
 867                                 $xml .= get_encoded_Value($nv['value']);
 868                                 $xml .= '</name_value>';
 869                         }
 870                         $xml .= '</name_value_list>';
 871                         $xml .= '</item>';
 872                         return $xml;
 873 }
 874
 875 function new_get_return_module_fields($value, $module, $translate=true){
 876         global $module_name;
 877         $module_name = $module;
 878         $result = new_get_field_list($value, $translate);
 879         return Array('module_name'=>$module,
 880                                 'module_fields'=> $result['module_fields'],
 881                                 'link_fields'=> $result['link_fields'],
 882                                 );
 883 }
 884
 885 function get_return_module_fields($value, $module, $error, $translate=true){
 886         global $module_name;
 887         $module_name = $module;
 888         return Array('module_name'=>$module,
 889                                 'module_fields'=> get_field_list($value, $translate),
 890                                 'error'=>get_name_value_list($value)
 891                                 );
 892 }
 893
 894 function get_return_error_value($error_num, $error_name, $error_description){
 895         return Array('number'=>$error_num,
 896                                 'name'=> $error_name,
 897                                 'description'=> $error_description
 898                                 );
 899 }
 900
 901 function filter_field_list(&$field_list, $select_fields, $module_name){
 902         return filter_return_list($field_list, $select_fields, $module_name);
 903 }
 904
 905
 906 /**
 907  * Filter the results of a list query.  Limit the fields returned.
 908  *
 909  * @param Array $output_list -- The array of list data
 910  * @param Array $select_fields -- The list of fields that should be returned.  If this array is specfied, only the fields in the array will be returned.
 911  * @param String $module_name -- The name of the module this being worked on
 912  * @return The filtered array of list data.
 913  */
 914 function filter_return_list(&$output_list, $select_fields, $module_name){
 915
 916         for($sug = 0; $sug < sizeof($output_list) ; $sug++){
 917                 if($module_name == 'Contacts'){
 918                         global $invalid_contact_fields;
 919                         if(is_array($invalid_contact_fields)){
 920                                 foreach($invalid_contact_fields as $name=>$val){
 921                                         unset($output_list[$sug]['field_list'][$name]);
 922                                         unset($output_list[$sug]['name_value_list'][$name]);
 923
 924                                 }
 925                         }
 926                 }
 927
 928                 if( !empty($output_list[$sug]['name_value_list']) && is_array($output_list[$sug]['name_value_list']) && !empty($select_fields) && is_array($select_fields)){
 929                         foreach($output_list[$sug]['name_value_list'] as $name=>$value)
 930                                         if(!in_array($value['name'], $select_fields)){
 931                                                 unset($output_list[$sug]['name_value_list'][$name]);
 932                                                 unset($output_list[$sug]['field_list'][$name]);
 933                                         }
 934                 }
 935         }
 936         return $output_list;
 937 }
 938
 939 function login_success(){
 940         global $current_language, $sugar_config, $app_strings, $app_list_strings;
 941         $current_language = $sugar_config['default_language'];
 942         $app_strings = return_application_language($current_language);
 943         $app_list_strings = return_app_list_strings_language($current_language);
 944 }
 945
 946
 947 /*
 948  *      Given an account_name, either create the account or assign to a contact.
 949  */
 950 function add_create_account($seed)
 951 {
 952         global $current_user;
 953         $account_name = $seed->account_name;
 954         $account_id = $seed->account_id;
 955         $assigned_user_id = $current_user->id;
 956
 957         // check if it already exists
 958     $focus = new Account();
 959     if( $focus->ACLAccess('Save')){
 960                 $class = get_class($seed);
 961                 $temp = new $class();
 962                 $temp->retrieve($seed->id);
 963                 if ((! isset($account_name) || $account_name == ''))
 964                 {
 965                         return;
 966                 }
 967                 if (!isset($seed->accounts)){
 968                         $seed->load_relationship('accounts');
 969                 }
 970
 971                 if($seed->account_name == '' && isset($temp->account_id)){
 972                         $seed->accounts->delete($seed->id, $temp->account_id);
 973                         return;
 974                 }
 975
 976             $arr = array();
 977
 978
 979
 980             $query = "select id, deleted from {$focus->table_name} WHERE name='".$seed->db->quote($account_name)."'";
 981             $query .=" ORDER BY deleted ASC";
 982             $result = $seed->db->query($query, true);
 983
 984             $row = $seed->db->fetchByAssoc($result, false);
 985
 986                 // we found a row with that id
 987             if (isset($row['id']) && $row['id'] != -1)
 988             {
 989                 // if it exists but was deleted, just remove it entirely
 990                 if ( isset($row['deleted']) && $row['deleted'] == 1)
 991                 {
 992                     $query2 = "delete from {$focus->table_name} WHERE id='". $seed->db->quote($row['id'])."'";
 993                     $result2 = $seed->db->query($query2, true);
 994                         }
 995                         // else just use this id to link the contact to the account
 996                 else
 997                 {
 998                         $focus->id = $row['id'];
 999                 }
1000             }
1001
1002                 // if we didnt find the account, so create it
1003             if (! isset($focus->id) || $focus->id == '')
1004             {
1005                 $focus->name = $account_name;
1006
1007                         if ( isset($assigned_user_id))
1008                         {
1009                    $focus->assigned_user_id = $assigned_user_id;
1010                    $focus->modified_user_id = $assigned_user_id;
1011                         }
1012                 $focus->save();
1013             }
1014
1015             if($seed->accounts != null && $temp->account_id != null && $temp->account_id != $focus->id){
1016                 $seed->accounts->delete($seed->id, $temp->account_id);
1017             }
1018
1019             if(isset($focus->id) && $focus->id != ''){
1020                         $seed->account_id = $focus->id;
1021                 }
1022     }
1023 }
1024
1025 function check_for_duplicate_contacts($seed){
1026
1027         if(isset($seed->id)){
1028                 return null;
1029         }
1030
1031         $trimmed_email = trim($seed->email1);
1032     $trimmed_email2 = trim($seed->email2);
1033         $trimmed_last = trim($seed->last_name);
1034         $trimmed_first = trim($seed->first_name);
1035         if(!empty($trimmed_email) || !empty($trimmed_email2)){
1036
1037                 //obtain a list of contacts which contain the same email address
1038                 $contacts = $seed->emailAddress->getBeansByEmailAddress($trimmed_email);
1039         $contacts2 = $seed->emailAddress->getBeansByEmailAddress($trimmed_email2);
1040         $contacts = array_merge($contacts, $contacts2);
1041                 if(count($contacts) == 0){
1042                         return null;
1043                 }else{
1044             foreach($contacts as $contact){
1045                                 if(!empty($trimmed_last) && strcmp($trimmed_last, $contact->last_name) == 0){
1046                     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)){
1047                                                 //bug: 39234 - check if the account names are the same
1048                                                 //if the incoming contact's account_name is empty OR it is not empty and is the same
1049                                                 //as an existing contact's account name, then find the match.
1050                         $contact->load_relationship('accounts');
1051                                                 if(empty($seed->account_name) || strcmp($seed->account_name, $contact->account_name) == 0){
1052                                                     $GLOBALS['log']->info('End: SoapHelperWebServices->check_for_duplicate_contacts - duplicte found ' . $contact->id);
1053                                                         return $contact->id;
1054                                                 }
1055                                         }
1056                                 }
1057                         }
1058                         return null;
1059                 }
1060         } else {
1061         //This section of code is executed if no emails are supplied in the $seed instance
1062
1063         //This query is looking for the id of Contact records that do not have a primary email address based on the matching
1064         //first and last name and the record being not deleted.  If any such records are found we will take the first one and assume
1065         //that it is the duplicate record
1066             $query = "SELECT c.id as id FROM contacts c
1067 LEFT OUTER JOIN email_addr_bean_rel eabr ON eabr.bean_id = c.id
1068 WHERE c.first_name = '{$trimmed_first}' AND c.last_name = '{$trimmed_last}' AND c.deleted = 0 AND eabr.id IS NULL";
1069
1070         //Apply the limit query filter to this since we only need the first record
1071         $result = $GLOBALS['db']->getOne($query);
1072         return !empty($result) ? $result : null;
1073     }
1074 }
1075
1076 /*
1077  * Given a client version and a server version, determine if the right hand side(server version) is greater
1078  *
1079  * @param left           the client sugar version
1080  * @param right          the server version
1081  *
1082  * return               true if the server version is greater or they are equal
1083  *                      false if the client version is greater
1084  */
1085 function is_server_version_greater($left, $right){
1086     if(count($left) == 0 && count($right) == 0){
1087         return false;
1088     }
1089     else if(count($left) == 0 || count($right) == 0){
1090         return true;
1091     }
1092     else if($left[0] == $right[0]){
1093         array_shift($left);
1094         array_shift($right);
1095         return is_server_version_greater($left, $right);
1096     }
1097     else if($left[0] < $right[0]){
1098        return true;
1099     }
1100     else
1101         return false;
1102 }
1103
1104 function getFile( $zip_file, $file_in_zip ){
1105     $base_upgrade_dir = sugar_cached("/upgrades");
1106     $base_tmp_upgrade_dir   = "$base_upgrade_dir/temp";
1107     $my_zip_dir = mk_temp_dir( $base_tmp_upgrade_dir );
1108     unzip_file( $zip_file, $file_in_zip, $my_zip_dir );
1109     return( "$my_zip_dir/$file_in_zip" );
1110 }
1111
1112 function getManifest( $zip_file ){
1113     ini_set("max_execution_time", "3600");
1114     return( getFile( $zip_file, "manifest.php" ) );
1115 }
1116
1117 if(!function_exists("get_encoded")){
1118 /*HELPER FUNCTIONS*/
1119 function get_encoded($object){
1120                 return  base64_encode(serialize($object));
1121 }
1122 function get_decoded($object){
1123                 return  unserialize(base64_decode($object));
1124
1125 }
1126
1127 /**
1128  * decrypt a string use the TripleDES algorithm. This meant to be
1129  * modified if the end user chooses a different algorithm
1130  *
1131  * @param $string - the string to decrypt
1132  *
1133  * @return a decrypted string if we can decrypt, the original string otherwise
1134  */
1135 function decrypt_string($string){
1136         if(function_exists('mcrypt_cbc')){
1137
1138                 $focus = new Administration();
1139                 $focus->retrieveSettings();
1140                 $key = '';
1141                 if(!empty($focus->settings['ldap_enc_key'])){
1142                         $key = $focus->settings['ldap_enc_key'];
1143                 }
1144                 if(empty($key))
1145                         return $string;
1146                 $buffer = $string;
1147                 $key = substr(md5($key),0,24);
1148             $iv = "password";
1149             return mcrypt_cbc(MCRYPT_3DES, $key, pack("H*", $buffer), MCRYPT_DECRYPT, $iv);
1150         }else{
1151                 return $string;
1152         }
1153 }
1154
1155 }
1156
1157 function canViewPath( $path, $base ){
1158   $path = realpath( $path );
1159   $base = realpath( $base );
1160   return 0 !== strncmp( $path, $base, strlen( $base ) );
1161 }
1162
1163
1164 /**
1165  * apply_values
1166  *
1167  * This function applies the given values to the bean object.  If it is a first time sync
1168  * then empty values will not be copied over.
1169  *
1170  * @param Mixed $seed Object representing SugarBean instance
1171  * @param Array $dataValues Array of fields/values to set on the SugarBean instance
1172  * @param boolean $firstSync Boolean indicating whether or not this is a first time sync
1173  */
1174 function apply_values($seed, $dataValues, $firstSync)
1175 {
1176     if(!$seed instanceof SugarBean || !is_array($dataValues))
1177     {
1178         return;
1179     }
1180
1181     foreach($dataValues as $field=>$value)
1182     {
1183         if($firstSync)
1184         {
1185             //If this is a first sync AND the value is not empty then we set it
1186             if(!empty($value))
1187             {
1188                 $seed->$field = $value;
1189             }
1190         } else {
1191             $seed->$field = $value;
1192         }
1193     }
1194 }
1195
1196 /*END HELPER*/
1197
1198 ?>