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-2012 SugarCRM Inc.
   6  *
   7  * This program is free software; you can redistribute it and/or modify it under
   8  * the terms of the GNU Affero General Public License version 3 as published by the
   9  * Free Software Foundation with the addition of the following permission added
  10  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
  11  * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
  12  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
  13  *
  14  * This program is distributed in the hope that it will be useful, but WITHOUT
  15  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  16  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
  17  * details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License along with
  20  * this program; if not, see http://www.gnu.org/licenses or write to the Free
  21  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  22  * 02110-1301 USA.
  23  *
  24  * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
  25  * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
  26  *
  27  * The interactive user interfaces in modified source and object code versions
  28  * of this program must display Appropriate Legal Notices, as required under
  29  * Section 5 of the GNU Affero General Public License version 3.
  30  *
  31  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
  32  * these Appropriate Legal Notices must retain the display of the "Powered by
  33  * SugarCRM" logo. If the display of the logo is not reasonably feasible for
  34  * technical reasons, the Appropriate Legal Notices must display the words
  35  * "Powered by SugarCRM".
  36  ********************************************************************************/
  37
  38
  39 /**
  40  * 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         $value = clean_sensitive_data($value->field_defs, $value);
 505         return Array('id'=>$value->id,
 506                                 'module_name'=> $module,
 507                                 'name_value_list'=>get_name_value_list_for_fields($value, $fields)
 508                                 );
 509 }
 510
 511 function getRelationshipResults($bean, $link_field_name, $link_module_fields) {
 512         global  $beanList, $beanFiles;
 513         $bean->load_relationship($link_field_name);
 514         if (isset($bean->$link_field_name)) {
 515                 // get the query object for this link field
 516                 $query_array = $bean->$link_field_name->getQuery(true,array(),0,'',true);
 517                 $params = array();
 518                 $params['joined_tables'] = $query_array['join_tables'];
 519
 520                 // get the related module name and instantiate a bean for that.
 521                 $submodulename = $bean->$link_field_name->getRelatedModuleName();
 522                 $submoduleclass = $beanList[$submodulename];
 523                 require_once($beanFiles[$submoduleclass]);
 524
 525                 $submodule = new $submoduleclass();
 526                 $filterFields = filter_fields($submodule, $link_module_fields);
 527                 $relFields = $bean->$link_field_name->getRelatedFields();
 528                 $roleSelect = '';
 529
 530                 if(!empty($relFields)){
 531                         foreach($link_module_fields as $field){
 532                                 if(!empty($relFields[$field])){
 533                                         $roleSelect .= ', ' . $query_array['join_tables'][0] . '.'. $field;
 534                                 }
 535                         }
 536                 }
 537                 // create a query
 538                 $subquery = $submodule->create_new_list_query('','',$filterFields,$params, 0,'', true,$bean);
 539                 $query =  $subquery['select'].$roleSelect .   $subquery['from'].$query_array['join']. $subquery['where'];
 540
 541                 $result = $submodule->db->query($query, true);
 542                 $list = array();
 543                 while($row = $submodule->db->fetchByAssoc($result)) {
 544                         $list[] = $row;
 545                 }
 546                 return array('rows' => $list, 'fields_set_on_rows' => $filterFields);
 547         } else {
 548                 return false;
 549         } // else
 550
 551 } // fn
 552
 553 function get_return_value_for_link_fields($bean, $module, $link_name_to_value_fields_array) {
 554         global $module_name, $current_user;
 555         $module_name = $module;
 556         if($module == 'Users' && $bean->id != $current_user->id){
 557                 $bean->user_hash = '';
 558         }
 559         $bean = clean_sensitive_data($value->field_defs, $bean);
 560
 561         if (empty($link_name_to_value_fields_array) || !is_array($link_name_to_value_fields_array)) {
 562                 return array();
 563         }
 564
 565         $link_output = array();
 566         foreach($link_name_to_value_fields_array as $link_name_value_fields) {
 567                 if (!is_array($link_name_value_fields) || !isset($link_name_value_fields['name']) || !isset($link_name_value_fields['value'])) {
 568                         continue;
 569                 }
 570                 $link_field_name = $link_name_value_fields['name'];
 571                 $link_module_fields = $link_name_value_fields['value'];
 572                 if (is_array($link_module_fields) && !empty($link_module_fields)) {
 573                         $result = getRelationshipResults($bean, $link_field_name, $link_module_fields);
 574                         if (!$result) {
 575                                 $link_output[] = array('name' => $link_field_name, 'records' => array());
 576                                 continue;
 577                         }
 578                         $list = $result['rows'];
 579                         $filterFields = $result['fields_set_on_rows'];
 580                         if ($list) {
 581                                 $rowArray = array();
 582                                 foreach($list as $row) {
 583                                         $nameValueArray = array();
 584                                         foreach ($filterFields as $field) {
 585                                                 $nameValue = array();
 586                                                 if (isset($row[$field])) {
 587                                                         $nameValue['name'] = $field;
 588                                                         $nameValue['value'] = $row[$field];
 589                                                         $nameValueArray[] = $nameValue;
 590                                                 } // if
 591                                         } // foreach
 592                                         $rowArray[] = $nameValueArray;
 593                                 } // foreach
 594                                 $link_output[] = array('name' => $link_field_name, 'records' => $rowArray);
 595                         } // if
 596                 } // if
 597         } // foreach
 598         return $link_output;
 599 } // fn
 600
 601 /**
 602  *
 603  * @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).
 604  * @param String $module_id -- The ID of the bean in the specified module
 605  * @param String $link_field_name - The relationship name for which to create realtionships.
 606  * @param Array $related_ids -- The array of ids for which we want to create relationships
 607  * @return true on success, false on failure
 608  */
 609 function new_handle_set_relationship($module_name, $module_id, $link_field_name, $related_ids) {
 610     global  $beanList, $beanFiles;
 611
 612     if(empty($beanList[$module_name])) {
 613         return false;
 614     } // if
 615     $class_name = $beanList[$module_name];
 616     require_once($beanFiles[$class_name]);
 617     $mod = new $class_name();
 618     $mod->retrieve($module_id);
 619         if(!$mod->ACLAccess('DetailView')){
 620                 return false;
 621         }
 622
 623     foreach($related_ids as $ids) {
 624         $GLOBALS['log']->debug("ids = " . $ids );
 625     }
 626
 627         if ($mod->load_relationship($link_field_name)) {
 628                 $mod->$link_field_name->add($related_ids);
 629                 return true;
 630         } else {
 631                 return false;
 632         }
 633 }
 634
 635 function new_handle_set_entries($module_name, $name_value_lists, $select_fields = FALSE) {
 636         global $beanList, $beanFiles, $app_list_strings;
 637         global $current_user;
 638
 639         $ret_values = array();
 640
 641         $class_name = $beanList[$module_name];
 642         require_once($beanFiles[$class_name]);
 643         $ids = array();
 644         $count = 1;
 645         $total = sizeof($name_value_lists);
 646         foreach($name_value_lists as $name_value_list){
 647                 $seed = new $class_name();
 648
 649                 $seed->update_vcal = false;
 650                 foreach($name_value_list as $value){
 651                         if($value['name'] == 'id'){
 652                                 $seed->retrieve($value['value']);
 653                                 break;
 654                         }
 655                 }
 656
 657                 foreach($name_value_list as $value) {
 658                         $val = $value['value'];
 659                         if($seed->field_name_map[$value['name']]['type'] == 'enum'){
 660                                 $vardef = $seed->field_name_map[$value['name']];
 661                                 if(isset($app_list_strings[$vardef['options']]) && !isset($app_list_strings[$vardef['options']][$value]) ) {
 662                             if ( in_array($val,$app_list_strings[$vardef['options']]) ){
 663                                 $val = array_search($val,$app_list_strings[$vardef['options']]);
 664                             }
 665                         }
 666                         }
 667                         $seed->$value['name'] = $val;
 668                 }
 669
 670                 if($count == $total){
 671                         $seed->update_vcal = false;
 672                 }
 673                 $count++;
 674
 675                 //Add the account to a contact
 676                 if($module_name == 'Contacts'){
 677                         $GLOBALS['log']->debug('Creating Contact Account');
 678                         add_create_account($seed);
 679                         $duplicate_id = check_for_duplicate_contacts($seed);
 680                         if($duplicate_id == null){
 681                                 if($seed->ACLAccess('Save') && ($seed->deleted != 1 || $seed->ACLAccess('Delete'))){
 682                                         $seed->save();
 683                                         if($seed->deleted == 1){
 684                                                 $seed->mark_deleted($seed->id);
 685                                         }
 686                                         $ids[] = $seed->id;
 687                                 }
 688                         }
 689                         else{
 690                                 //since we found a duplicate we should set the sync flag
 691                                 if( $seed->ACLAccess('Save')){
 692                                         $seed = new $class_name();
 693                                         $seed->id = $duplicate_id;
 694                                         $seed->contacts_users_id = $current_user->id;
 695                                         $seed->save();
 696                                         $ids[] = $duplicate_id;//we have a conflict
 697                                 }
 698                         }
 699                 }
 700                 else if($module_name == 'Meetings' || $module_name == 'Calls'){
 701                         //we are going to check if we have a meeting in the system
 702                         //with the same outlook_id. If we do find one then we will grab that
 703                         //id and save it
 704                         if( $seed->ACLAccess('Save') && ($seed->deleted != 1 || $seed->ACLAccess('Delete'))){
 705                                 if(empty($seed->id) && !isset($seed->id)){
 706                                         if(!empty($seed->outlook_id) && isset($seed->outlook_id)){
 707                                                 //at this point we have an object that does not have
 708                                                 //the id set, but does have the outlook_id set
 709                                                 //so we need to query the db to find if we already
 710                                                 //have an object with this outlook_id, if we do
 711                                                 //then we can set the id, otherwise this is a new object
 712                                                 $order_by = "";
 713                                                 $query = $seed->table_name.".outlook_id = '".$GLOBALS['db']->quote($seed->outlook_id)."'";
 714                                                 $response = $seed->get_list($order_by, $query, 0,-1,-1,0);
 715                                                 $list = $response['list'];
 716                                                 if(count($list) > 0){
 717                                                         foreach($list as $value)
 718                                                         {
 719                                                                 $seed->id = $value->id;
 720                                                                 break;
 721                                                         }
 722                                                 }//fi
 723                                         }//fi
 724                                 }//fi
 725                                 $seed->save();
 726                 if($seed->deleted == 1){
 727                     $seed->mark_deleted($seed->id);
 728                 }
 729                                 $ids[] = $seed->id;
 730                         }//fi
 731                 }
 732                 else
 733                 {
 734                         if( $seed->ACLAccess('Save') && ($seed->deleted != 1 || $seed->ACLAccess('Delete'))){
 735                                 $seed->save();
 736                                 $ids[] = $seed->id;
 737                         }
 738                 }
 739
 740                 // if somebody is calling set_entries_detail() and wants fields returned...
 741                 if ($select_fields !== FALSE) {
 742                         $ret_values[$count] = array();
 743
 744                         foreach ($select_fields as $select_field) {
 745                                 if (isset($seed->$select_field)) {
 746                                         $ret_values[$count][] = get_name_value($select_field, $seed->$select_field);
 747                                 }
 748                         }
 749                 }
 750         }
 751
 752         // handle returns for set_entries_detail() and set_entries()
 753         if ($select_fields !== FALSE) {
 754                 return array(
 755                         'name_value_lists' => $ret_values,
 756                 );
 757         }
 758         else {
 759                 return array(
 760                         'ids' => $ids,
 761                 );
 762         }
 763 }
 764
 765 function get_return_value($value, $module, $returnDomValue = false){
 766         global $module_name, $current_user;
 767         $module_name = $module;
 768         if($module == 'Users' && $value->id != $current_user->id){
 769                 $value->user_hash = '';
 770         }
 771         $value = clean_sensitive_data($value->field_defs, $value);
 772         return Array('id'=>$value->id,
 773                                 'module_name'=> $module,
 774                                 'name_value_list'=>get_name_value_list($value, $returnDomValue)
 775                                 );
 776 }
 777
 778
 779 function get_encoded_Value($value) {
 780
 781     // XML 1.0 doesn't allow those...
 782     $value = preg_replace("/([\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F])/", '', $value);
 783     $value = htmlspecialchars($value, ENT_NOQUOTES, "utf-8");
 784     return "<value>$value</value>";
 785 }
 786
 787 function get_name_value_xml($val, $module_name){
 788         $xml = '<item>';
 789                         $xml .= '<id>'.$val['id'].'</id>';
 790                         $xml .= '<module>'.$module_name.'</module>';
 791                         $xml .= '<name_value_list>';
 792                         foreach($val['name_value_list'] as $name=>$nv){
 793                                 $xml .= '<name_value>';
 794                                 $xml .= '<name>'.htmlspecialchars($nv['name']).'</name>';
 795                 $xml .= get_encoded_Value($nv['value']);
 796                                 $xml .= '</name_value>';
 797                         }
 798                         $xml .= '</name_value_list>';
 799                         $xml .= '</item>';
 800                         return $xml;
 801 }
 802
 803 function new_get_return_module_fields($value, $module, $translate=true){
 804         global $module_name;
 805         $module_name = $module;
 806         $result = new_get_field_list($value, $translate);
 807         return Array('module_name'=>$module,
 808                                 'module_fields'=> $result['module_fields'],
 809                                 'link_fields'=> $result['link_fields'],
 810                                 );
 811 }
 812
 813 function get_return_module_fields($value, $module, $error, $translate=true){
 814         global $module_name;
 815         $module_name = $module;
 816         return Array('module_name'=>$module,
 817                                 'module_fields'=> get_field_list($value, $translate),
 818                                 'error'=>get_name_value_list($value)
 819                                 );
 820 }
 821
 822 function get_return_error_value($error_num, $error_name, $error_description){
 823         return Array('number'=>$error_num,
 824                                 'name'=> $error_name,
 825                                 'description'=> $error_description
 826                                 );
 827 }
 828
 829 function filter_field_list(&$field_list, $select_fields, $module_name){
 830         return filter_return_list($field_list, $select_fields, $module_name);
 831 }
 832
 833
 834 /**
 835  * Filter the results of a list query.  Limit the fields returned.
 836  *
 837  * @param Array $output_list -- The array of list data
 838  * @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.
 839  * @param String $module_name -- The name of the module this being worked on
 840  * @return The filtered array of list data.
 841  */
 842 function filter_return_list(&$output_list, $select_fields, $module_name){
 843
 844         for($sug = 0; $sug < sizeof($output_list) ; $sug++){
 845                 if($module_name == 'Contacts'){
 846                         global $invalid_contact_fields;
 847                         if(is_array($invalid_contact_fields)){
 848                                 foreach($invalid_contact_fields as $name=>$val){
 849                                         unset($output_list[$sug]['field_list'][$name]);
 850                                         unset($output_list[$sug]['name_value_list'][$name]);
 851
 852                                 }
 853                         }
 854                 }
 855
 856                 if( !empty($output_list[$sug]['name_value_list']) && is_array($output_list[$sug]['name_value_list']) && !empty($select_fields) && is_array($select_fields)){
 857                         foreach($output_list[$sug]['name_value_list'] as $name=>$value)
 858                                         if(!in_array($value['name'], $select_fields)){
 859                                                 unset($output_list[$sug]['name_value_list'][$name]);
 860                                                 unset($output_list[$sug]['field_list'][$name]);
 861                                         }
 862                 }
 863         }
 864         return $output_list;
 865 }
 866
 867 function login_success(){
 868         global $current_language, $sugar_config, $app_strings, $app_list_strings;
 869         $current_language = $sugar_config['default_language'];
 870         $app_strings = return_application_language($current_language);
 871         $app_list_strings = return_app_list_strings_language($current_language);
 872 }
 873
 874
 875 /*
 876  *      Given an account_name, either create the account or assign to a contact.
 877  */
 878 function add_create_account($seed)
 879 {
 880         global $current_user;
 881         $account_name = $seed->account_name;
 882         $account_id = $seed->account_id;
 883         $assigned_user_id = $current_user->id;
 884
 885         // check if it already exists
 886     $focus = new Account();
 887     if( $focus->ACLAccess('Save')){
 888                 $class = get_class($seed);
 889                 $temp = new $class();
 890                 $temp->retrieve($seed->id);
 891                 if ((! isset($account_name) || $account_name == ''))
 892                 {
 893                         return;
 894                 }
 895                 if (!isset($seed->accounts)){
 896                         $seed->load_relationship('accounts');
 897                 }
 898
 899                 if($seed->account_name == '' && isset($temp->account_id)){
 900                         $seed->accounts->delete($seed->id, $temp->account_id);
 901                         return;
 902                 }
 903
 904             $arr = array();
 905
 906             $query = "select id, deleted from {$focus->table_name} ";
 907             $query .= " WHERE name='".$seed->db->quote($account_name)."'";
 908             $query .=" ORDER BY deleted ASC";
 909             $result = $seed->db->query($query, true);
 910
 911             $row = $seed->db->fetchByAssoc($result, false);
 912
 913                 // we found a row with that id
 914             if (!empty($row['id']))
 915             {
 916                 // if it exists but was deleted, just remove it entirely
 917                 if ( !empty($row['deleted']))
 918                 {
 919                     $query2 = "delete from {$focus->table_name} WHERE id='". $seed->db->quote($row['id'])."'";
 920                     $result2 = $seed->db->query($query2, true);
 921                         }
 922                         // else just use this id to link the contact to the account
 923                 else
 924                 {
 925                         $focus->id = $row['id'];
 926                 }
 927             }
 928
 929                 // if we didnt find the account, so create it
 930             if (empty($focus->id))
 931             {
 932                 $focus->name = $account_name;
 933
 934                         if ( isset($assigned_user_id))
 935                         {
 936                    $focus->assigned_user_id = $assigned_user_id;
 937                    $focus->modified_user_id = $assigned_user_id;
 938                         }
 939                 $focus->save();
 940             }
 941
 942             if($seed->accounts != null && $temp->account_id != null && $temp->account_id != $focus->id){
 943                 $seed->accounts->delete($seed->id, $temp->account_id);
 944             }
 945
 946             if(isset($focus->id) && $focus->id != ''){
 947                         $seed->account_id = $focus->id;
 948                 }
 949     }
 950 }
 951
 952 function check_for_duplicate_contacts($seed){
 953
 954         if(isset($seed->id)){
 955                 return null;
 956         }
 957
 958         $trimmed_email = trim($seed->email1);
 959     $trimmed_email2 = trim($seed->email2);
 960         $trimmed_last = trim($seed->last_name);
 961         $trimmed_first = trim($seed->first_name);
 962         if(!empty($trimmed_email) || !empty($trimmed_email2)){
 963
 964                 //obtain a list of contacts which contain the same email address
 965                 $contacts = $seed->emailAddress->getBeansByEmailAddress($trimmed_email);
 966         $contacts2 = $seed->emailAddress->getBeansByEmailAddress($trimmed_email2);
 967         $contacts = array_merge($contacts, $contacts2);
 968                 if(count($contacts) == 0){
 969                         return null;
 970                 }else{
 971             foreach($contacts as $contact){
 972                                 if(!empty($trimmed_last) && strcmp($trimmed_last, $contact->last_name) == 0){
 973                     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)){
 974                                                 //bug: 39234 - check if the account names are the same
 975                                                 //if the incoming contact's account_name is empty OR it is not empty and is the same
 976                                                 //as an existing contact's account name, then find the match.
 977                         $contact->load_relationship('accounts');
 978                                                 if(empty($seed->account_name) || strcmp($seed->account_name, $contact->account_name) == 0){
 979                                                     $GLOBALS['log']->info('End: SoapHelperWebServices->check_for_duplicate_contacts - duplicte found ' . $contact->id);
 980                                                         return $contact->id;
 981                                                 }
 982                                         }
 983                                 }
 984                         }
 985                         return null;
 986                 }
 987         } else {
 988         //This section of code is executed if no emails are supplied in the $seed instance
 989
 990         //This query is looking for the id of Contact records that do not have a primary email address based on the matching
 991         //first and last name and the record being not deleted.  If any such records are found we will take the first one and assume
 992         //that it is the duplicate record
 993             $query = "SELECT c.id as id FROM contacts c
 994 LEFT OUTER JOIN email_addr_bean_rel eabr ON eabr.bean_id = c.id
 995 WHERE c.first_name = '{$trimmed_first}' AND c.last_name = '{$trimmed_last}' AND c.deleted = 0 AND eabr.id IS NULL";
 996
 997         //Apply the limit query filter to this since we only need the first record
 998         $result = $GLOBALS['db']->getOne($query);
 999         return !empty($result) ? $result : null;
1000     }
1001 }
1002
1003 /*
1004  * Given a client version and a server version, determine if the right hand side(server version) is greater
1005  *
1006  * @param left           the client sugar version
1007  * @param right          the server version
1008  *
1009  * return               true if the server version is greater or they are equal
1010  *                      false if the client version is greater
1011  */
1012 function is_server_version_greater($left, $right){
1013     if(count($left) == 0 && count($right) == 0){
1014         return false;
1015     }
1016     else if(count($left) == 0 || count($right) == 0){
1017         return true;
1018     }
1019     else if($left[0] == $right[0]){
1020         array_shift($left);
1021         array_shift($right);
1022         return is_server_version_greater($left, $right);
1023     }
1024     else if($left[0] < $right[0]){
1025        return true;
1026     }
1027     else
1028         return false;
1029 }
1030
1031 function getFile( $zip_file, $file_in_zip ){
1032     $base_upgrade_dir = sugar_cached("/upgrades");
1033     $base_tmp_upgrade_dir   = "$base_upgrade_dir/temp";
1034     $my_zip_dir = mk_temp_dir( $base_tmp_upgrade_dir );
1035     unzip_file( $zip_file, $file_in_zip, $my_zip_dir );
1036     return( "$my_zip_dir/$file_in_zip" );
1037 }
1038
1039 function getManifest( $zip_file ){
1040     ini_set("max_execution_time", "3600");
1041     return( getFile( $zip_file, "manifest.php" ) );
1042 }
1043
1044 if(!function_exists("get_encoded")){
1045 /*HELPER FUNCTIONS*/
1046 function get_encoded($object){
1047                 return  base64_encode(serialize($object));
1048 }
1049 function get_decoded($object){
1050                 return  unserialize(base64_decode($object));
1051
1052 }
1053
1054 /**
1055  * decrypt a string use the TripleDES algorithm. This meant to be
1056  * modified if the end user chooses a different algorithm
1057  *
1058  * @param $string - the string to decrypt
1059  *
1060  * @return a decrypted string if we can decrypt, the original string otherwise
1061  */
1062 function decrypt_string($string){
1063         if(function_exists('mcrypt_cbc')){
1064
1065                 $focus = new Administration();
1066                 $focus->retrieveSettings();
1067                 $key = '';
1068                 if(!empty($focus->settings['ldap_enc_key'])){
1069                         $key = $focus->settings['ldap_enc_key'];
1070                 }
1071                 if(empty($key))
1072                         return $string;
1073                 $buffer = $string;
1074                 $key = substr(md5($key),0,24);
1075             $iv = "password";
1076             return mcrypt_cbc(MCRYPT_3DES, $key, pack("H*", $buffer), MCRYPT_DECRYPT, $iv);
1077         }else{
1078                 return $string;
1079         }
1080 }
1081
1082 }
1083
1084 function canViewPath( $path, $base ){
1085   $path = realpath( $path );
1086   $base = realpath( $base );
1087   return 0 !== strncmp( $path, $base, strlen( $base ) );
1088 }
1089
1090
1091 /**
1092  * apply_values
1093  *
1094  * This function applies the given values to the bean object.  If it is a first time sync
1095  * then empty values will not be copied over.
1096  *
1097  * @param Mixed $seed Object representing SugarBean instance
1098  * @param Array $dataValues Array of fields/values to set on the SugarBean instance
1099  * @param boolean $firstSync Boolean indicating whether or not this is a first time sync
1100  */
1101 function apply_values($seed, $dataValues, $firstSync)
1102 {
1103     if(!$seed instanceof SugarBean || !is_array($dataValues))
1104     {
1105         return;
1106     }
1107
1108     foreach($dataValues as $field=>$value)
1109     {
1110         if($firstSync)
1111         {
1112             //If this is a first sync AND the value is not empty then we set it
1113             if(!empty($value))
1114             {
1115                 $seed->$field = $value;
1116             }
1117         } else {
1118             $seed->$field = $value;
1119         }
1120     }
1121 }
1122
1123 /*END HELPER*/
1124
1125 ?>