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($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                 $class_name = $beanList[$module_name];
 316                 if(empty($beanFiles[$class_name]))
 317                 {
 318                    unset($modules[$module_name]);
 319                 }
 320         }
 321
 322         return $modules;
 323
 324 }
 325
 326 function check_modules_access($user, $module_name, $action='write'){
 327         if(!isset($_SESSION['avail_modules'])){
 328                 $_SESSION['avail_modules'] = get_user_module_list($user);
 329         }
 330         if(isset($_SESSION['avail_modules'][$module_name])){
 331                 if($action == 'write' && $_SESSION['avail_modules'][$module_name] == 'read_only'){
 332                         if(is_admin($user))return true;
 333                         return false;
 334                 }
 335                 return true;
 336         }
 337         return false;
 338
 339 }
 340
 341 function get_name_value_list($value, $returnDomValue = false){
 342         global $app_list_strings;
 343         $list = array();
 344         if(!empty($value->field_defs)){
 345                 if(isset($value->assigned_user_name)) {
 346                         $list['assigned_user_name'] = get_name_value('assigned_user_name', $value->assigned_user_name);
 347                 }
 348                 if(isset($value->modified_by_name)) {
 349                         $list['modified_by_name'] = get_name_value('modified_by_name', $value->modified_by_name);
 350                 }
 351                 if(isset($value->created_by_name)) {
 352                         $list['created_by_name'] = get_name_value('created_by_name', $value->created_by_name);
 353                 }
 354                 foreach($value->field_defs as $var){
 355                         if(isset($var['source']) && ($var['source'] != 'db' && $var['source'] != 'custom_fields') && $var['name'] != 'email1' && $var['name'] != 'email2' && (!isset($var['type'])|| $var['type'] != 'relate')){
 356
 357                                         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'))) {
 358
 359                                         } else {
 360                                                 continue;
 361                                         }
 362                                 }
 363
 364                         if(isset($value->$var['name'])){
 365                                 $val = $value->$var['name'];
 366                                 $type = $var['type'];
 367
 368                                 if(strcmp($type, 'date') == 0){
 369                                         $val = substr($val, 0, 10);
 370                                 }elseif(strcmp($type, 'enum') == 0 && !empty($var['options']) && $returnDomValue){
 371                                         $val = $app_list_strings[$var['options']][$val];
 372                                 }
 373
 374                                 $list[$var['name']] = get_name_value($var['name'], $val);
 375                         }
 376                 }
 377         }
 378         return $list;
 379
 380 }
 381
 382 function filter_fields($value, $fields) {
 383         global $invalid_contact_fields;
 384         $filterFields = array();
 385         foreach($fields as $field){
 386                 if (is_array($invalid_contact_fields)) {
 387                         if (in_array($field, $invalid_contact_fields)) {
 388                                 continue;
 389                         } // if
 390                 } // if
 391                 if (isset($value->field_defs[$field])) {
 392                         $var = $value->field_defs[$field];
 393                         if(isset($var['source']) && ($var['source'] != 'db' && $var['source'] != 'custom_fields') && $var['name'] != 'email1' && $var['name'] != 'email2' && (!isset($var['type'])|| $var['type'] != 'relate')) {
 394
 395                                 continue;
 396                         }
 397                 } // if
 398                 $filterFields[] = $field;
 399         } // foreach
 400         return $filterFields;
 401 } // fn
 402
 403 function get_name_value_list_for_fields($value, $fields) {
 404         global $app_list_strings;
 405         global $invalid_contact_fields;
 406
 407         $list = array();
 408         if(!empty($value->field_defs)){
 409                 if(isset($value->assigned_user_name) && in_array('assigned_user_name', $fields)) {
 410                         $list['assigned_user_name'] = get_name_value('assigned_user_name', $value->assigned_user_name);
 411                 }
 412                 if(isset($value->modified_by_name) && in_array('modified_by_name', $fields)) {
 413                         $list['modified_by_name'] = get_name_value('modified_by_name', $value->modified_by_name);
 414                 }
 415                 if(isset($value->created_by_name) && in_array('created_by_name', $fields)) {
 416                         $list['created_by_name'] = get_name_value('created_by_name', $value->created_by_name);
 417                 }
 418
 419                 $filterFields = filter_fields($value, $fields);
 420                 foreach($filterFields as $field){
 421                         $var = $value->field_defs[$field];
 422                         if(isset($value->$var['name'])){
 423                                 $val = $value->$var['name'];
 424                                 $type = $var['type'];
 425
 426                                 if(strcmp($type, 'date') == 0){
 427                                         $val = substr($val, 0, 10);
 428                                 }elseif(strcmp($type, 'enum') == 0 && !empty($var['options'])){
 429                                         $val = $app_list_strings[$var['options']][$val];
 430                                 }
 431
 432                                 $list[$var['name']] = get_name_value($var['name'], $val);
 433                         } // if
 434                 } // foreach
 435         } // if
 436         return $list;
 437
 438 } // fn
 439
 440
 441 function array_get_name_value_list($array){
 442         $list = array();
 443         foreach($array as $name=>$value){
 444
 445                                 $list[$name] = get_name_value($name, $value);
 446         }
 447         return $list;
 448
 449 }
 450
 451 function array_get_name_value_lists($array){
 452     $list = array();
 453     foreach($array as $name=>$value){
 454         $tmp_value=$value;
 455         if(is_array($value)){
 456             $tmp_value = array();
 457             foreach($value as $k=>$v){
 458                 $tmp_value[] = get_name_value($k, $v);
 459             }
 460         }
 461         $list[] = get_name_value($name, $tmp_value);
 462     }
 463     return $list;
 464 }
 465
 466 function name_value_lists_get_array($list){
 467     $array = array();
 468     foreach($list as $key=>$value){
 469         if(isset($value['value']) && isset($value['name'])){
 470             if(is_array($value['value'])){
 471                 $array[$value['name']]=array();
 472                 foreach($value['value'] as $v){
 473                     $array[$value['name']][$v['name']]=$v['value'];
 474                 }
 475             }else{
 476                 $array[$value['name']]=$value['value'];
 477             }
 478         }
 479     }
 480     return $array;
 481 }
 482
 483 function array_get_return_value($array, $module){
 484
 485         return Array('id'=>$array['id'],
 486                                 'module_name'=> $module,
 487                                 'name_value_list'=>array_get_name_value_list($array)
 488                                 );
 489 }
 490
 491 function get_return_value_for_fields($value, $module, $fields) {
 492         global $module_name, $current_user;
 493         $module_name = $module;
 494         if($module == 'Users' && $value->id != $current_user->id){
 495                 $value->user_hash = '';
 496         }
 497         return Array('id'=>$value->id,
 498                                 'module_name'=> $module,
 499                                 'name_value_list'=>get_name_value_list_for_fields($value, $fields)
 500                                 );
 501 }
 502
 503 function getRelationshipResults($bean, $link_field_name, $link_module_fields, $optional_where = '') {
 504         global  $beanList, $beanFiles;
 505         $bean->load_relationship($link_field_name);
 506         if (isset($bean->$link_field_name)) {
 507                 // get the query object for this link field
 508                 $query_array = $bean->$link_field_name->getQuery(true,array(),0,'',true);
 509                 $params = array();
 510                 $params['joined_tables'] = $query_array['join_tables'];
 511
 512                 // get the related module name and instantiate a bean for that.
 513                 $submodulename = $bean->$link_field_name->getRelatedModuleName();
 514                 $submoduleclass = $beanList[$submodulename];
 515                 require_once($beanFiles[$submoduleclass]);
 516
 517                 $submodule = new $submoduleclass();
 518                 $filterFields = filter_fields($submodule, $link_module_fields);
 519                 $relFields = $bean->$link_field_name->getRelatedFields();
 520                 $roleSelect = '';
 521
 522                 if(!empty($relFields)){
 523                         foreach($link_module_fields as $field){
 524                                 if(!empty($relFields[$field])){
 525                                         $roleSelect .= ', ' . $query_array['join_tables'][0] . '.'. $field;
 526                                 }
 527                         }
 528                 }
 529                 // create a query
 530                 $subquery = $submodule->create_new_list_query('',$optional_where ,$filterFields,$params, 0,'', true,$bean);
 531                 $query =  $subquery['select'].$roleSelect .   $subquery['from'].$query_array['join']. $subquery['where'];
 532
 533                 $result = $submodule->db->query($query, true);
 534                 $list = array();
 535                 while($row = $submodule->db->fetchByAssoc($result)) {
 536                         $list[] = $row;
 537                 }
 538                 return array('rows' => $list, 'fields_set_on_rows' => $filterFields);
 539         } else {
 540                 return false;
 541         } // else
 542
 543 } // fn
 544
 545 function get_return_value_for_link_fields($bean, $module, $link_name_to_value_fields_array) {
 546         global $module_name, $current_user;
 547         $module_name = $module;
 548         if($module == 'Users' && $bean->id != $current_user->id){
 549                 $bean->user_hash = '';
 550         }
 551
 552         if (empty($link_name_to_value_fields_array) || !is_array($link_name_to_value_fields_array)) {
 553                 return array();
 554         }
 555
 556         $link_output = array();
 557         foreach($link_name_to_value_fields_array as $link_name_value_fields) {
 558                 if (!is_array($link_name_value_fields) || !isset($link_name_value_fields['name']) || !isset($link_name_value_fields['value'])) {
 559                         continue;
 560                 }
 561                 $link_field_name = $link_name_value_fields['name'];
 562                 $link_module_fields = $link_name_value_fields['value'];
 563                 if (is_array($link_module_fields) && !empty($link_module_fields)) {
 564                         $result = getRelationshipResults($bean, $link_field_name, $link_module_fields);
 565                         if (!$result) {
 566                                 $link_output[] = array('name' => $link_field_name, 'records' => array());
 567                                 continue;
 568                         }
 569                         $list = $result['rows'];
 570                         $filterFields = $result['fields_set_on_rows'];
 571                         if ($list) {
 572                                 $rowArray = array();
 573                                 foreach($list as $row) {
 574                                         $nameValueArray = array();
 575                                         foreach ($filterFields as $field) {
 576                                                 $nameValue = array();
 577                                                 if (isset($row[$field])) {
 578                                                         $nameValue['name'] = $field;
 579                                                         $nameValue['value'] = $row[$field];
 580                                                         $nameValueArray[] = $nameValue;
 581                                                 } // if
 582                                         } // foreach
 583                                         $rowArray[] = $nameValueArray;
 584                                 } // foreach
 585                                 $link_output[] = array('name' => $link_field_name, 'records' => $rowArray);
 586                         } // if
 587                 } // if
 588         } // foreach
 589         return $link_output;
 590 } // fn
 591
 592 /**
 593  *
 594  * @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).
 595  * @param String $module_id -- The ID of the bean in the specified module
 596  * @param String $link_field_name - The relationship name for which to create realtionships.
 597  * @param Array $related_ids -- The array of ids for which we want to create relationships
 598  * @return true on success, false on failure
 599  */
 600 function new_handle_set_relationship($module_name, $module_id, $link_field_name, $related_ids) {
 601     global  $beanList, $beanFiles;
 602
 603     if(empty($beanList[$module_name])) {
 604         return false;
 605     } // if
 606     $class_name = $beanList[$module_name];
 607     require_once($beanFiles[$class_name]);
 608     $mod = new $class_name();
 609     $mod->retrieve($module_id);
 610         if(!$mod->ACLAccess('DetailView')){
 611                 return false;
 612         }
 613
 614     foreach($related_ids as $ids) {
 615         $GLOBALS['log']->debug("ids = " . $ids );
 616     }
 617
 618         if ($mod->load_relationship($link_field_name)) {
 619                 $mod->$link_field_name->add($related_ids);
 620                 return true;
 621         } else {
 622                 return false;
 623         }
 624 }
 625
 626 function new_handle_set_entries($module_name, $name_value_lists, $select_fields = FALSE) {
 627         global $beanList, $beanFiles, $app_list_strings;
 628         global $current_user;
 629
 630         $ret_values = array();
 631
 632         $class_name = $beanList[$module_name];
 633         require_once($beanFiles[$class_name]);
 634         $ids = array();
 635         $count = 1;
 636         $total = sizeof($name_value_lists);
 637         foreach($name_value_lists as $name_value_list){
 638                 $seed = new $class_name();
 639
 640                 $seed->update_vcal = false;
 641                 foreach($name_value_list as $value){
 642                         if($value['name'] == 'id'){
 643                                 $seed->retrieve($value['value']);
 644                                 break;
 645                         }
 646                 }
 647
 648                 foreach($name_value_list as $value) {
 649                         $val = $value['value'];
 650                         if($seed->field_name_map[$value['name']]['type'] == 'enum'){
 651                                 $vardef = $seed->field_name_map[$value['name']];
 652                                 if(isset($app_list_strings[$vardef['options']]) && !isset($app_list_strings[$vardef['options']][$value]) ) {
 653                             if ( in_array($val,$app_list_strings[$vardef['options']]) ){
 654                                 $val = array_search($val,$app_list_strings[$vardef['options']]);
 655                             }
 656                         }
 657                         }
 658                         $seed->$value['name'] = $val;
 659                 }
 660
 661                 if($count == $total){
 662                         $seed->update_vcal = false;
 663                 }
 664                 $count++;
 665
 666                 //Add the account to a contact
 667                 if($module_name == 'Contacts'){
 668                         $GLOBALS['log']->debug('Creating Contact Account');
 669                         add_create_account($seed);
 670                         $duplicate_id = check_for_duplicate_contacts($seed);
 671                         if($duplicate_id == null){
 672                                 if($seed->ACLAccess('Save') && ($seed->deleted != 1 || $seed->ACLAccess('Delete'))){
 673                                         $seed->save();
 674                                         if($seed->deleted == 1){
 675                                                 $seed->mark_deleted($seed->id);
 676                                         }
 677                                         $ids[] = $seed->id;
 678                                 }
 679                         }
 680                         else{
 681                                 //since we found a duplicate we should set the sync flag
 682                                 if( $seed->ACLAccess('Save')){
 683                                         $seed = new $class_name();
 684                                         $seed->id = $duplicate_id;
 685                                         $seed->contacts_users_id = $current_user->id;
 686                                         $seed->save();
 687                                         $ids[] = $duplicate_id;//we have a conflict
 688                                 }
 689                         }
 690                 }
 691                 else if($module_name == 'Meetings' || $module_name == 'Calls'){
 692                         //we are going to check if we have a meeting in the system
 693                         //with the same outlook_id. If we do find one then we will grab that
 694                         //id and save it
 695                         if( $seed->ACLAccess('Save') && ($seed->deleted != 1 || $seed->ACLAccess('Delete'))){
 696                                 if(empty($seed->id) && !isset($seed->id)){
 697                                         if(!empty($seed->outlook_id) && isset($seed->outlook_id)){
 698                                                 //at this point we have an object that does not have
 699                                                 //the id set, but does have the outlook_id set
 700                                                 //so we need to query the db to find if we already
 701                                                 //have an object with this outlook_id, if we do
 702                                                 //then we can set the id, otherwise this is a new object
 703                                                 $order_by = "";
 704                                                 $query = $seed->table_name.".outlook_id = '".$seed->outlook_id."'";
 705                                                 $response = $seed->get_list($order_by, $query, 0,-1,-1,0);
 706                                                 $list = $response['list'];
 707                                                 if(count($list) > 0){
 708                                                         foreach($list as $value)
 709                                                         {
 710                                                                 $seed->id = $value->id;
 711                                                                 break;
 712                                                         }
 713                                                 }//fi
 714                                         }//fi
 715                                 }//fi
 716                                 $seed->save();
 717                                 $ids[] = $seed->id;
 718                         }//fi
 719                 }
 720                 else
 721                 {
 722                         if( $seed->ACLAccess('Save') && ($seed->deleted != 1 || $seed->ACLAccess('Delete'))){
 723                                 $seed->save();
 724                                 $ids[] = $seed->id;
 725                         }
 726                 }
 727
 728                 // if somebody is calling set_entries_detail() and wants fields returned...
 729                 if ($select_fields !== FALSE) {
 730                         $ret_values[$count] = array();
 731
 732                         foreach ($select_fields as $select_field) {
 733                                 if (isset($seed->$select_field)) {
 734                                         $ret_values[$count][] = get_name_value($select_field, $seed->$select_field);
 735                                 }
 736                         }
 737                 }
 738         }
 739
 740         // handle returns for set_entries_detail() and set_entries()
 741         if ($select_fields !== FALSE) {
 742                 return array(
 743                         'name_value_lists' => $ret_values,
 744                 );
 745         }
 746         else {
 747                 return array(
 748                         'ids' => $ids,
 749                 );
 750         }
 751 }
 752
 753 function get_return_value($value, $module, $returnDomValue = false){
 754         global $module_name, $current_user;
 755         $module_name = $module;
 756         if($module == 'Users' && $value->id != $current_user->id){
 757                 $value->user_hash = '';
 758         }
 759         return Array('id'=>$value->id,
 760                                 'module_name'=> $module,
 761                                 'name_value_list'=>get_name_value_list($value, $returnDomValue)
 762                                 );
 763 }
 764
 765
 766 function get_name_value_xml($val, $module_name){
 767         $xml = '<item>';
 768                         $xml .= '<id>'.$val['id'].'</id>';
 769                         $xml .= '<module>'.$module_name.'</module>';
 770                         $xml .= '<name_value_list>';
 771                         foreach($val['name_value_list'] as $name=>$nv){
 772                                 $xml .= '<name_value>';
 773                                 $xml .= '<name>'.htmlspecialchars($nv['name']).'</name>';
 774                                 $xml .= '<value>'.htmlspecialchars($nv['value']).'</value>';
 775                                 $xml .= '</name_value>';
 776                         }
 777                         $xml .= '</name_value_list>';
 778                         $xml .= '</item>';
 779                         return $xml;
 780 }
 781
 782 function new_get_return_module_fields($value, $module, $translate=true){
 783         global $module_name;
 784         $module_name = $module;
 785         $result = new_get_field_list($value, $translate);
 786         return Array('module_name'=>$module,
 787                                 'module_fields'=> $result['module_fields'],
 788                                 'link_fields'=> $result['link_fields'],
 789                                 );
 790 }
 791
 792 function get_return_module_fields($value, $module, $error, $translate=true){
 793         global $module_name;
 794         $module_name = $module;
 795         return Array('module_name'=>$module,
 796                                 'module_fields'=> get_field_list($value, $translate),
 797                                 'error'=>get_name_value_list($value)
 798                                 );
 799 }
 800
 801 function get_return_error_value($error_num, $error_name, $error_description){
 802         return Array('number'=>$error_num,
 803                                 'name'=> $error_name,
 804                                 'description'=> $error_description
 805                                 );
 806 }
 807
 808 function filter_field_list(&$field_list, $select_fields, $module_name){
 809         return filter_return_list($field_list, $select_fields, $module_name);
 810 }
 811
 812
 813 /**
 814  * Filter the results of a list query.  Limit the fields returned.
 815  *
 816  * @param Array $output_list -- The array of list data
 817  * @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.
 818  * @param String $module_name -- The name of the module this being worked on
 819  * @return The filtered array of list data.
 820  */
 821 function filter_return_list(&$output_list, $select_fields, $module_name){
 822
 823         for($sug = 0; $sug < sizeof($output_list) ; $sug++){
 824                 if($module_name == 'Contacts'){
 825                         global $invalid_contact_fields;
 826                         if(is_array($invalid_contact_fields)){
 827                                 foreach($invalid_contact_fields as $name=>$val){
 828                                         unset($output_list[$sug]['field_list'][$name]);
 829                                         unset($output_list[$sug]['name_value_list'][$name]);
 830
 831                                 }
 832                         }
 833                 }
 834
 835                 if( !empty($output_list[$sug]['name_value_list']) && is_array($output_list[$sug]['name_value_list']) && !empty($select_fields) && is_array($select_fields)){
 836                         foreach($output_list[$sug]['name_value_list'] as $name=>$value)
 837                                         if(!in_array($value['name'], $select_fields)){
 838                                                 unset($output_list[$sug]['name_value_list'][$name]);
 839                                                 unset($output_list[$sug]['field_list'][$name]);
 840                                         }
 841                 }
 842         }
 843         return $output_list;
 844 }
 845
 846 function login_success(){
 847         global $current_language, $sugar_config, $app_strings, $app_list_strings;
 848         $current_language = $sugar_config['default_language'];
 849         $app_strings = return_application_language($current_language);
 850         $app_list_strings = return_app_list_strings_language($current_language);
 851 }
 852
 853
 854 /*
 855  *      Given an account_name, either create the account or assign to a contact.
 856  */
 857 function add_create_account($seed)
 858 {
 859         global $current_user;
 860         $account_name = $seed->account_name;
 861         $account_id = $seed->account_id;
 862         $assigned_user_id = $current_user->id;
 863
 864         // check if it already exists
 865     $focus = new Account();
 866     if( $focus->ACLAccess('Save')){
 867                 $class = get_class($seed);
 868                 $temp = new $class();
 869                 $temp->retrieve($seed->id);
 870                 if ((! isset($account_name) || $account_name == ''))
 871                 {
 872                         return;
 873                 }
 874                 if (!isset($seed->accounts)){
 875                         $seed->load_relationship('accounts');
 876                 }
 877
 878                 if($seed->account_name == '' && isset($temp->account_id)){
 879                         $seed->accounts->delete($seed->id, $temp->account_id);
 880                         return;
 881                 }
 882
 883             $arr = array();
 884
 885
 886
 887             $query = "select id, deleted from {$focus->table_name} WHERE name='".$seed->db->quote($account_name)."'";
 888             $query .=" ORDER BY deleted ASC";
 889             $result = $seed->db->query($query) or sugar_die("Error selecting sugarbean: ".mysql_error());
 890
 891             $row = $seed->db->fetchByAssoc($result, -1, false);
 892
 893                 // we found a row with that id
 894             if (isset($row['id']) && $row['id'] != -1)
 895             {
 896                 // if it exists but was deleted, just remove it entirely
 897                 if ( isset($row['deleted']) && $row['deleted'] == 1)
 898                 {
 899                     $query2 = "delete from {$focus->table_name} WHERE id='". $seed->db->quote($row['id'])."'";
 900                     $result2 = $seed->db->query($query2) or sugar_die("Error deleting existing sugarbean: ".mysql_error());
 901                         }
 902                         // else just use this id to link the contact to the account
 903                 else
 904                 {
 905                         $focus->id = $row['id'];
 906                 }
 907             }
 908
 909                 // if we didnt find the account, so create it
 910             if (! isset($focus->id) || $focus->id == '')
 911             {
 912                 $focus->name = $account_name;
 913
 914                         if ( isset($assigned_user_id))
 915                         {
 916                    $focus->assigned_user_id = $assigned_user_id;
 917                    $focus->modified_user_id = $assigned_user_id;
 918                         }
 919                 $focus->save();
 920             }
 921
 922             if($seed->accounts != null && $temp->account_id != null && $temp->account_id != $focus->id){
 923                 $seed->accounts->delete($seed->id, $temp->account_id);
 924             }
 925
 926             if(isset($focus->id) && $focus->id != ''){
 927                         $seed->account_id = $focus->id;
 928                 }
 929     }
 930 }
 931
 932 function check_for_duplicate_contacts($seed){
 933
 934
 935         if(isset($seed->id)){
 936                 return null;
 937         }
 938
 939         $query = '';
 940
 941         $trimmed_email = trim($seed->email1);
 942         $trimmed_last = trim($seed->last_name);
 943         $trimmed_first = trim($seed->first_name);
 944         if(!empty($trimmed_email)){
 945
 946                 //obtain a list of contacts which contain the same email address
 947                 $contacts = $seed->emailAddress->getBeansByEmailAddress($trimmed_email);
 948                 if(count($contacts) == 0){
 949                         return null;
 950                 }else{
 951                         foreach($contacts as $contact){
 952                                 if(!empty($trimmed_last) && strcmp($trimmed_last, $contact->last_name) == 0){
 953                                         if(!empty($trimmed_email) && strcmp($trimmed_email, $contact->email1) == 0){
 954                                                 if(!empty($trimmed_email)){
 955                                                         if(strcmp($trimmed_email, $contact->email1) == 0){
 956                                                                 //bug: 39234 - check if the account names are the same
 957                                                                 //if the incoming contact's account_name is empty OR it is not empty and is the same
 958                                                                 //as an existing contact's account name, then find the match.
 959                                                                 $contact->load_relationship('accounts');
 960                                                                 if(empty($seed->account_name) || strcmp($seed->account_name, $contact->account_name) == 0){
 961                                                                         $GLOBALS['log']->info('End: SoapHelperWebServices->check_for_duplicate_contacts - duplicte found ' . $contact->id);
 962                                                                         return $contact->id;
 963                                                                 }
 964                                                         }
 965                                                 }else{
 966                                                         return $contact->id;
 967                                                 }
 968                                         }
 969                                 }
 970                         }
 971                         return null;
 972                 }
 973         }else{
 974             $query = "contacts.last_name = '".$seed->db->quote($trimmed_last,false)."'";
 975         $query .= " AND contacts.first_name = '".$seed->db->quote($trimmed_first,false)."'";
 976         $contacts = $seed->get_list('', $query);
 977         if (count($contacts) == 0){
 978             return null;
 979         }else{
 980             foreach($contacts['list'] as $contact){
 981                 if (empty($contact->email1)){
 982                     return $contact->id;
 983                 }
 984             }
 985             return null;
 986         }
 987         }
 988 }
 989
 990 /*
 991  * Given a client version and a server version, determine if the right hand side(server version) is greater
 992  *
 993  * @param left           the client sugar version
 994  * @param right          the server version
 995  *
 996  * return               true if the server version is greater or they are equal
 997  *                      false if the client version is greater
 998  */
 999 function is_server_version_greater($left, $right){
1000     if(count($left) == 0 && count($right) == 0){
1001         return false;
1002     }
1003     else if(count($left) == 0 || count($right) == 0){
1004         return true;
1005     }
1006     else if($left[0] == $right[0]){
1007         array_shift($left);
1008         array_shift($right);
1009         return is_server_version_greater($left, $right);
1010     }
1011     else if($left[0] < $right[0]){
1012        return true;
1013     }
1014     else
1015         return false;
1016 }
1017
1018 function getFile( $zip_file, $file_in_zip ){
1019     global $sugar_config;
1020     $base_upgrade_dir = $sugar_config['upload_dir'] . "/upgrades";
1021     $base_tmp_upgrade_dir   = "$base_upgrade_dir/temp";
1022     $my_zip_dir = mk_temp_dir( $base_tmp_upgrade_dir );
1023     unzip_file( $zip_file, $file_in_zip, $my_zip_dir );
1024     return( "$my_zip_dir/$file_in_zip" );
1025 }
1026
1027 function getManifest( $zip_file ){
1028     ini_set("max_execution_time", "3600");
1029     return( getFile( $zip_file, "manifest.php" ) );
1030 }
1031
1032 if(!function_exists("get_encoded")){
1033 /*HELPER FUNCTIONS*/
1034 function get_encoded($object){
1035                 return  base64_encode(serialize($object));
1036 }
1037 function get_decoded($object){
1038                 return  unserialize(base64_decode($object));
1039
1040 }
1041
1042 /**
1043  * decrypt a string use the TripleDES algorithm. This meant to be
1044  * modified if the end user chooses a different algorithm
1045  *
1046  * @param $string - the string to decrypt
1047  *
1048  * @return a decrypted string if we can decrypt, the original string otherwise
1049  */
1050 function decrypt_string($string){
1051         if(function_exists('mcrypt_cbc')){
1052
1053                 $focus = new Administration();
1054                 $focus->retrieveSettings();
1055                 $key = '';
1056                 if(!empty($focus->settings['ldap_enc_key'])){
1057                         $key = $focus->settings['ldap_enc_key'];
1058                 }
1059                 if(empty($key))
1060                         return $string;
1061                 $buffer = $string;
1062                 $key = substr(md5($key),0,24);
1063             $iv = "password";
1064             return mcrypt_cbc(MCRYPT_3DES, $key, pack("H*", $buffer), MCRYPT_DECRYPT, $iv);
1065         }else{
1066                 return $string;
1067         }
1068 }
1069
1070 }
1071
1072 function canViewPath( $path, $base ){
1073   $path = realpath( $path );
1074   $base = realpath( $base );
1075   return 0 !== strncmp( $path, $base, strlen( $base ) );
1076 }
1077 /*END HELPER*/
1078
1079 ?>