soap/SoapSugarUsers.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 require_once('soap/SoapHelperFunctions.php');
  39 require_once('soap/SoapTypes.php');
  40
  41 /*************************************************************************************
  42
  43 THIS IS FOR SUGARCRM USERS
  44
  45
  46 *************************************************************************************/
  47 $disable_date_format = true;
  48
  49 $server->register(
  50     'is_user_admin',
  51     array('session'=>'xsd:string'),
  52     array('return'=>'xsd:int'),
  53     $NAMESPACE);
  54
  55 /**
  56  * Return if the user is an admin or not
  57  *
  58  * @param String $session -- Session ID returned by a previous call to login.
  59  * @return int 1 or 0 depending on if the user is an admin
  60  */
  61 function is_user_admin($session){
  62         if(validate_authenticated($session)){
  63                 global $current_user;
  64                 return is_admin($current_user);
  65
  66         }else{
  67                 return 0;
  68         }
  69 }
  70
  71
  72 $server->register(
  73         'login',
  74         array('user_auth'=>'tns:user_auth', 'application_name'=>'xsd:string'),
  75         array('return'=>'tns:set_entry_result'),
  76         $NAMESPACE);
  77
  78 /**
  79  * Log the user into the application
  80  *
  81  * @param UserAuth array $user_auth -- Set user_name and password (password needs to be
  82  *      in the right encoding for the type of authentication the user is setup for.  For Base
  83  *      sugar validation, password is the MD5 sum of the plain text password.
  84  * @param String $application -- The name of the application you are logging in from.  (Currently unused).
  85  * @return Array(session_id, error) -- session_id is the id of the session that was
  86  *      created.  Error is set if there was any error during creation.
  87  */
  88 function login($user_auth, $application){
  89         global $sugar_config, $system_config;
  90
  91         $error = new SoapError();
  92         $user = new User();
  93         $success = false;
  94         //rrs
  95                 $system_config = new Administration();
  96         $system_config->retrieveSettings('system');
  97         $authController = new AuthenticationController((!empty($sugar_config['authenticationClass'])? $sugar_config['authenticationClass'] : 'SugarAuthenticate'));
  98         //rrs
  99         $isLoginSuccess = $authController->login($user_auth['user_name'], $user_auth['password'], array('passwordEncrypted' => true));
 100         $usr_id=$user->retrieve_user_id($user_auth['user_name']);
 101         if($usr_id) {
 102                 $user->retrieve($usr_id);
 103         }
 104
 105         if ($isLoginSuccess) {
 106                 if ($_SESSION['hasExpiredPassword'] =='1') {
 107                         $error->set_error('password_expired');
 108                         $GLOBALS['log']->fatal('password expired for user ' . $user_auth['user_name']);
 109                         LogicHook::initialize();
 110                         $GLOBALS['logic_hook']->call_custom_logic('Users', 'login_failed');
 111                         return array('id'=>-1, 'error'=>$error);
 112                 } // if
 113                 if(!empty($user) && !empty($user->id) && !$user->is_group) {
 114                         $success = true;
 115                         global $current_user;
 116                         $current_user = $user;
 117                 } // if
 118         } else if($usr_id && isset($user->user_name) && ($user->getPreference('lockout') == '1')) {
 119                         $error->set_error('lockout_reached');
 120                         $GLOBALS['log']->fatal('Lockout reached for user ' . $user_auth['user_name']);
 121                         LogicHook::initialize();
 122                         $GLOBALS['logic_hook']->call_custom_logic('Users', 'login_failed');
 123                         return array('id'=>-1, 'error'=>$error);
 124         } else if(function_exists('mcrypt_cbc')){
 125                 $password = decrypt_string($user_auth['password']);
 126                 $authController = new AuthenticationController((!empty($sugar_config['authenticationClass'])? $sugar_config['authenticationClass'] : 'SugarAuthenticate'));
 127                 if($authController->login($user_auth['user_name'], $password) && isset($_SESSION['authenticated_user_id'])){
 128                         $success = true;
 129                 } // if
 130         } // else if
 131
 132         if($success){
 133                 session_start();
 134                 global $current_user;
 135                 //$current_user = $user;
 136                 login_success();
 137                 $current_user->loadPreferences();
 138                 $_SESSION['is_valid_session']= true;
 139                 $_SESSION['ip_address'] = query_client_ip();
 140                 $_SESSION['user_id'] = $current_user->id;
 141                 $_SESSION['type'] = 'user';
 142                 $_SESSION['avail_modules']= get_user_module_list($current_user);
 143                 $_SESSION['authenticated_user_id'] = $current_user->id;
 144                 $_SESSION['unique_key'] = $sugar_config['unique_key'];
 145
 146                 $current_user->call_custom_logic('after_login');
 147                 return array('id'=>session_id(), 'error'=>$error);
 148         }
 149         $error->set_error('invalid_login');
 150         $GLOBALS['log']->fatal('SECURITY: User authentication for '. $user_auth['user_name']. ' failed');
 151         LogicHook::initialize();
 152         $GLOBALS['logic_hook']->call_custom_logic('Users', 'login_failed');
 153         return array('id'=>-1, 'error'=>$error);
 154
 155 }
 156
 157 //checks if the soap server and client are running on the same machine
 158 $server->register(
 159         'is_loopback',
 160         array(),
 161         array('return'=>'xsd:int'),
 162         $NAMESPACE);
 163
 164 /**
 165  * Check to see if the soap server and client are on the same machine.
 166  * We don't allow a server to sync to itself.
 167  *
 168  * @return true -- if the SOAP server and client are on the same machine
 169  * @return false -- if the SOAP server and client are not on the same machine.
 170  */
 171 function is_loopback(){
 172         if(query_client_ip() == $_SERVER['SERVER_ADDR'])
 173                 return 1;
 174         return 0;
 175 }
 176
 177 /**
 178  * Validate the provided session information is correct and current.  Load the session.
 179  *
 180  * @param String $session_id -- The session ID that was returned by a call to login.
 181  * @return true -- If the session is valid and loaded.
 182  * @return false -- if the session is not valid.
 183  */
 184 function validate_authenticated($session_id){
 185         if(!empty($session_id)){
 186                 session_id($session_id);
 187                 session_start();
 188
 189                 if(!empty($_SESSION['is_valid_session']) && is_valid_ip_address('ip_address') && $_SESSION['type'] == 'user'){
 190
 191                         global $current_user;
 192
 193                         $current_user = new User();
 194                         $current_user->retrieve($_SESSION['user_id']);
 195                         login_success();
 196                         return true;
 197                 }
 198
 199                 session_destroy();
 200         }
 201         LogicHook::initialize();
 202         $GLOBALS['log']->fatal('SECURITY: The session ID is invalid');
 203         $GLOBALS['logic_hook']->call_custom_logic('Users', 'login_failed');
 204         return false;
 205 }
 206
 207 /**
 208  * Use the same logic as in SugarAuthenticate to validate the ip address
 209  *
 210  * @param string $session_var
 211  * @return bool - true if the ip address is valid, false otherwise.
 212  */
 213 function is_valid_ip_address($session_var){
 214         global $sugar_config;
 215         // grab client ip address
 216         $clientIP = query_client_ip();
 217         $classCheck = 0;
 218         // check to see if config entry is present, if not, verify client ip
 219         if (!isset ($sugar_config['verify_client_ip']) || $sugar_config['verify_client_ip'] == true) {
 220                 // check to see if we've got a current ip address in $_SESSION
 221                 // and check to see if the session has been hijacked by a foreign ip
 222                 if (isset ($_SESSION[$session_var])) {
 223                         $session_parts = explode(".", $_SESSION[$session_var]);
 224                         $client_parts = explode(".", $clientIP);
 225             if(count($session_parts) < 4) {
 226                 $classCheck = 0;
 227             }else {
 228                         // match class C IP addresses
 229                         for ($i = 0; $i < 3; $i ++) {
 230                                 if ($session_parts[$i] == $client_parts[$i]) {
 231                                         $classCheck = 1;
 232                                                 continue;
 233                                 } else {
 234                                         $classCheck = 0;
 235                                         break;
 236                                         }
 237                                 }
 238                 }
 239                                 // we have a different IP address
 240                                 if ($_SESSION[$session_var] != $clientIP && empty ($classCheck)) {
 241                                         $GLOBALS['log']->fatal("IP Address mismatch: SESSION IP: {$_SESSION[$session_var]} CLIENT IP: {$clientIP}");
 242                                         return false;
 243                                 }
 244                         } else {
 245                                 return false;
 246                         }
 247         }
 248         return true;
 249 }
 250
 251 $server->register(
 252     'seamless_login',
 253     array('session'=>'xsd:string'),
 254     array('return'=>'xsd:int'),
 255     $NAMESPACE);
 256
 257 /**
 258  * Perform a seamless login.  This is used internally during the sync process.
 259  *
 260  * @param String $session -- Session ID returned by a previous call to login.
 261  * @return true -- if the session was authenticated
 262  * @return false -- if the session could not be authenticated
 263  */
 264 function seamless_login($session){
 265                 if(!validate_authenticated($session)){
 266                         return 0;
 267                 }
 268
 269                 return 1;
 270 }
 271
 272 $server->register(
 273     'get_entry_list',
 274     array('session'=>'xsd:string', 'module_name'=>'xsd:string', 'query'=>'xsd:string', 'order_by'=>'xsd:string','offset'=>'xsd:int', 'select_fields'=>'tns:select_fields', 'max_results'=>'xsd:int', 'deleted'=>'xsd:int'),
 275     array('return'=>'tns:get_entry_list_result'),
 276     $NAMESPACE);
 277
 278 /**
 279  * Retrieve a list of beans.  This is the primary method for getting list of SugarBeans from Sugar using the SOAP API.
 280  *
 281  * @param String $session -- Session ID returned by a previous call to login.
 282  * @param String $module_name -- The name of the module to return records 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)..
 283  * @param String $query -- SQL where clause without the word 'where'
 284  * @param String $order_by -- SQL order by clause without the phrase 'order by'
 285  * @param String $offset -- The record offset to start from.
 286  * @param Array  $select_fields -- A list of the fields to be included in the results. This optional parameter allows for only needed fields to be retrieved.
 287  * @param String $max_results -- The maximum number of records to return.  The default is the sugar configuration value for 'list_max_entries_per_page'
 288  * @param Number $deleted -- false if deleted records should not be include, true if deleted records should be included.
 289  * @return Array 'result_count' -- The number of records returned
 290  *               'next_offset' -- The start of the next page (This will always be the previous offset plus the number of rows returned.  It does not indicate if there is additional data unless you calculate that the next_offset happens to be closer than it should be.
 291  *               'field_list' -- The vardef information on the selected fields.
 292  *                      Array -- 'field'=>  'name' -- the name of the field
 293  *                                          'type' -- the data type of the field
 294  *                                          'label' -- the translation key for the label of the field
 295  *                                          'required' -- Is the field required?
 296  *                                          'options' -- Possible values for a drop down field
 297  *               'entry_list' -- The records that were retrieved
 298  *               'error' -- The SOAP error, if any
 299  */
 300 function get_entry_list($session, $module_name, $query, $order_by,$offset, $select_fields, $max_results, $deleted ){
 301         global  $beanList, $beanFiles, $current_user;
 302         $error = new SoapError();
 303         if(!validate_authenticated($session)){
 304                 $error->set_error('invalid_login');
 305                 return array('result_count'=>-1, 'entry_list'=>array(), 'error'=>$error->get_soap_array());
 306         }
 307     $using_cp = false;
 308     if($module_name == 'CampaignProspects'){
 309         $module_name = 'Prospects';
 310         $using_cp = true;
 311     }
 312         if(empty($beanList[$module_name])){
 313                 $error->set_error('no_module');
 314                 return array('result_count'=>-1, 'entry_list'=>array(), 'error'=>$error->get_soap_array());
 315         }
 316         global $current_user;
 317         if(!check_modules_access($current_user, $module_name, 'read')){
 318                 $error->set_error('no_access');
 319                 return array('result_count'=>-1, 'entry_list'=>array(), 'error'=>$error->get_soap_array());
 320         }
 321
 322         // If the maximum number of entries per page was specified, override the configuration value.
 323         if($max_results > 0){
 324                 global $sugar_config;
 325                 $sugar_config['list_max_entries_per_page'] = $max_results;
 326         }
 327
 328
 329         $class_name = $beanList[$module_name];
 330         require_once($beanFiles[$class_name]);
 331         $seed = new $class_name();
 332         if(! ($seed->ACLAccess('Export') && $seed->ACLAccess('list')))
 333         {
 334                 $error->set_error('no_access');
 335                 return array('result_count'=>-1, 'entry_list'=>array(), 'error'=>$error->get_soap_array());
 336         }
 337
 338         require_once 'include/SugarSQLValidate.php';
 339         $valid = new SugarSQLValidate();
 340         if(!$valid->validateQueryClauses($query, $order_by)) {
 341         $GLOBALS['log']->error("Bad query: $query $order_by");
 342             $error->set_error('no_access');
 343             return array(
 344                         'result_count' => -1,
 345                         'error' => $error->get_soap_array()
 346         );
 347         }
 348         if($query == ''){
 349                 $where = '';
 350         }
 351         if($offset == '' || $offset == -1){
 352                 $offset = 0;
 353         }
 354     if($using_cp){
 355         $response = $seed->retrieveTargetList($query, $select_fields, $offset,-1,-1,$deleted);
 356     }else{
 357         $response = $seed->get_list($order_by, $query, $offset,-1,-1,$deleted,true);
 358     }
 359         $list = $response['list'];
 360
 361
 362         $output_list = array();
 363
 364     $isEmailModule = false;
 365     if($module_name == 'Emails'){
 366         $isEmailModule = true;
 367     }
 368         // retrieve the vardef information on the bean's fields.
 369         $field_list = array();
 370
 371     require_once 'modules/Currencies/Currency.php';
 372
 373     $userCurrencyId = $current_user->getPreference('currency');
 374     $userCurrency = new Currency;
 375     $userCurrency->retrieve($userCurrencyId);
 376
 377         foreach($list as $value)
 378         {
 379                 if(isset($value->emailAddress)){
 380                         $value->emailAddress->handleLegacyRetrieve($value);
 381                 }
 382         if($isEmailModule){
 383             $value->retrieveEmailText();
 384         }
 385                 $value->fill_in_additional_detail_fields();
 386
 387         // bug 55129 - populate currency from user settings
 388         if (property_exists($value, 'currency_id') && $userCurrency->deleted != 1)
 389         {
 390             // walk through all currency-related fields
 391             foreach ($value->field_defs as $temp_field)
 392             {
 393                 if (isset($temp_field['type']) && 'relate' == $temp_field['type']
 394                     && isset($temp_field['module'])  && 'Currencies' == $temp_field['module']
 395                     && isset($temp_field['id_name']) && 'currency_id' == $temp_field['id_name'])
 396                 {
 397                     // populate related properties manually
 398                     $temp_property     = $temp_field['name'];
 399                     $currency_property = $temp_field['rname'];
 400                     $value->$temp_property = $userCurrency->$currency_property;
 401                 }
 402                 else if ($value->currency_id != $userCurrency->id
 403                          && isset($temp_field['type'])
 404                          && 'currency' == $temp_field['type']
 405                          && substr($temp_field['name'], -9) != '_usdollar')
 406                 {
 407                     $temp_property = $temp_field['name'];
 408                     $value->$temp_property *= $userCurrency->conversion_rate;
 409                 }
 410             }
 411
 412             $value->currency_id = $userCurrencyId;
 413         }
 414         // end of bug 55129
 415
 416                 $output_list[] = get_return_value($value, $module_name);
 417                 if(empty($field_list)){
 418                         $field_list = get_field_list($value);
 419                 }
 420         }
 421
 422         // Filter the search results to only include the requested fields.
 423         $output_list = filter_return_list($output_list, $select_fields, $module_name);
 424
 425         // Filter the list of fields to only include information on the requested fields.
 426         $field_list = filter_return_list($field_list,$select_fields, $module_name);
 427
 428         // Calculate the offset for the start of the next page
 429         $next_offset = $offset + sizeof($output_list);
 430
 431         return array('result_count'=>sizeof($output_list), 'next_offset'=>$next_offset,'field_list'=>$field_list, 'entry_list'=>$output_list, 'error'=>$error->get_soap_array());
 432 }
 433
 434 $server->register(
 435     'get_entry',
 436     array('session'=>'xsd:string', 'module_name'=>'xsd:string', 'id'=>'xsd:string', 'select_fields'=>'tns:select_fields'),
 437     array('return'=>'tns:get_entry_result'),
 438     $NAMESPACE);
 439
 440 /**
 441  * Retrieve a single SugarBean based on ID.
 442  *
 443  * @param String $session -- Session ID returned by a previous call to login.
 444  * @param String $module_name -- The name of the module to return records 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)..
 445  * @param String $id -- The SugarBean's ID value.
 446  * @param Array  $select_fields -- A list of the fields to be included in the results. This optional parameter allows for only needed fields to be retrieved.
 447  * @return unknown
 448  */
 449 function get_entry($session, $module_name, $id,$select_fields ){
 450         return get_entries($session, $module_name, array($id), $select_fields);
 451 }
 452
 453 $server->register(
 454     'get_entries',
 455     array('session'=>'xsd:string', 'module_name'=>'xsd:string', 'ids'=>'tns:select_fields', 'select_fields'=>'tns:select_fields'),
 456     array('return'=>'tns:get_entry_result'),
 457     $NAMESPACE);
 458
 459 /**
 460  * Retrieve a list of SugarBean's based on provided IDs.
 461  *
 462  * @param String $session -- Session ID returned by a previous call to login.
 463  * @param String $module_name -- The name of the module to return records 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)..
 464  * @param Array $ids -- An array of SugarBean IDs.
 465  * @param Array $select_fields -- A list of the fields to be included in the results. This optional parameter allows for only needed fields to be retrieved.
 466  * @return Array 'field_list' -- Var def information about the returned fields
 467  *               'entry_list' -- The records that were retrieved
 468  *               'error' -- The SOAP error, if any
 469  */
 470 function get_entries($session, $module_name, $ids,$select_fields ){
 471         global  $beanList, $beanFiles;
 472         $error = new SoapError();
 473         $field_list = array();
 474         $output_list = array();
 475         if(!validate_authenticated($session)){
 476                 $error->set_error('invalid_login');
 477                 return array('field_list'=>$field_list, 'entry_list'=>array(), 'error'=>$error->get_soap_array());
 478         }
 479     $using_cp = false;
 480     if($module_name == 'CampaignProspects'){
 481         $module_name = 'Prospects';
 482         $using_cp = true;
 483     }
 484         if(empty($beanList[$module_name])){
 485                 $error->set_error('no_module');
 486                 return array('field_list'=>$field_list, 'entry_list'=>array(), 'error'=>$error->get_soap_array());
 487         }
 488         global $current_user;
 489         if(!check_modules_access($current_user, $module_name, 'read')){
 490                 $error->set_error('no_access');
 491                 return array('field_list'=>$field_list, 'entry_list'=>array(), 'error'=>$error->get_soap_array());
 492         }
 493
 494         $class_name = $beanList[$module_name];
 495         require_once($beanFiles[$class_name]);
 496
 497         //todo can modify in there to call bean->get_list($order_by, $where, 0, -1, -1, $deleted);
 498         //that way we do not have to call retrieve for each bean
 499         //perhaps also add a select_fields to this, so we only get the fields we need
 500         //and not do a select *
 501         foreach($ids as $id){
 502                 $seed = new $class_name();
 503
 504     if($using_cp){
 505         $seed = $seed->retrieveTarget($id);
 506     }else{
 507                 if ($seed->retrieve($id) == null)
 508                         $seed->deleted = 1;
 509     }
 510
 511     if ($seed->deleted == 1) {
 512         $list = array();
 513         $list[] = array('name'=>'warning', 'value'=>'Access to this object is denied since it has been deleted or does not exist');
 514                 $list[] = array('name'=>'deleted', 'value'=>'1');
 515         $output_list[] = Array('id'=>$id,
 516                                                                 'module_name'=> $module_name,
 517                                                         'name_value_list'=>$list,
 518                                                         );
 519                 continue;
 520     }
 521         if(! $seed->ACLAccess('DetailView')){
 522                 $error->set_error('no_access');
 523                 return array('field_list'=>$field_list, 'entry_list'=>array(), 'error'=>$error->get_soap_array());
 524         }
 525                 $output_list[] = get_return_value($seed, $module_name);
 526
 527                 if(empty($field_list)){
 528                                 $field_list = get_field_list($seed);
 529
 530                 }
 531         }
 532
 533                 $output_list = filter_return_list($output_list, $select_fields, $module_name);
 534                 $field_list = filter_field_list($field_list,$select_fields, $module_name);
 535
 536         return array( 'field_list'=>$field_list, 'entry_list'=>$output_list, 'error'=>$error->get_soap_array());
 537 }
 538
 539 $server->register(
 540     'set_entry',
 541     array('session'=>'xsd:string', 'module_name'=>'xsd:string',  'name_value_list'=>'tns:name_value_list'),
 542     array('return'=>'tns:set_entry_result'),
 543     $NAMESPACE);
 544
 545 /**
 546  * Update or create a single SugarBean.
 547  *
 548  * @param String $session -- Session ID returned by a previous call to login.
 549  * @param String $module_name -- The name of the module to return records 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)..
 550  * @param Array $name_value_list -- The keys of the array are the SugarBean attributes, the values of the array are the values the attributes should have.
 551  * @return Array    'id' -- the ID of the bean that was written to (-1 on error)
 552  *                  'error' -- The SOAP error if any.
 553  */
 554 function set_entry($session,$module_name, $name_value_list){
 555         global  $beanList, $beanFiles;
 556
 557         $error = new SoapError();
 558         if(!validate_authenticated($session)){
 559                 $error->set_error('invalid_login');
 560                 return array('id'=>-1, 'error'=>$error->get_soap_array());
 561         }
 562         if(empty($beanList[$module_name])){
 563                 $error->set_error('no_module');
 564                 return array('id'=>-1, 'error'=>$error->get_soap_array());
 565         }
 566         global $current_user;
 567         if(!check_modules_access($current_user, $module_name, 'write')){
 568                 $error->set_error('no_access');
 569                 return array('id'=>-1, 'error'=>$error->get_soap_array());
 570         }
 571
 572         $class_name = $beanList[$module_name];
 573         require_once($beanFiles[$class_name]);
 574         $seed = new $class_name();
 575
 576         foreach($name_value_list as $value){
 577         if($value['name'] == 'id' && isset($value['value']) && strlen($value['value']) > 0){
 578                         $result = $seed->retrieve($value['value']);
 579             //bug: 44680 - check to ensure the user has access before proceeding.
 580             if(is_null($result))
 581             {
 582                 $error->set_error('no_access');
 583                         return array('id'=>-1, 'error'=>$error->get_soap_array());
 584             }
 585             else
 586             {
 587                 break;
 588             }
 589
 590                 }
 591         }
 592         foreach($name_value_list as $value){
 593         $GLOBALS['log']->debug($value['name']." : ".$value['value']);
 594                 $seed->$value['name'] = $value['value'];
 595         }
 596         if(! $seed->ACLAccess('Save') || ($seed->deleted == 1  &&  !$seed->ACLAccess('Delete')))
 597         {
 598                 $error->set_error('no_access');
 599                 return array('id'=>-1, 'error'=>$error->get_soap_array());
 600         }
 601         $seed->save();
 602         if($seed->deleted == 1){
 603                         $seed->mark_deleted($seed->id);
 604         }
 605         return array('id'=>$seed->id, 'error'=>$error->get_soap_array());
 606
 607 }
 608
 609 $server->register(
 610     'set_entries',
 611     array('session'=>'xsd:string', 'module_name'=>'xsd:string',  'name_value_lists'=>'tns:name_value_lists'),
 612     array('return'=>'tns:set_entries_result'),
 613     $NAMESPACE);
 614
 615 /**
 616  * Update or create a list of SugarBeans
 617  *
 618  * @param String $session -- Session ID returned by a previous call to login.
 619  * @param String $module_name -- The name of the module to return records 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)..
 620  * @param Array $name_value_lists -- Array of Bean specific Arrays where the keys of the array are the SugarBean attributes, the values of the array are the values the attributes should have.
 621  * @return Array    'ids' -- Array of the IDs of the beans that was written to (-1 on error)
 622  *                  'error' -- The SOAP error if any.
 623  */
 624 function set_entries($session,$module_name, $name_value_lists){
 625         $error = new SoapError();
 626
 627         if(!validate_authenticated($session)){
 628                 $error->set_error('invalid_login');
 629
 630                 return array(
 631                         'ids' => array(),
 632                         'error' => $error->get_soap_array()
 633                 );
 634         }
 635
 636         return handle_set_entries($module_name, $name_value_lists, FALSE);
 637 }
 638
 639 /*
 640 NOTE SPECIFIC CODE
 641 */
 642 $server->register(
 643         'set_note_attachment',
 644         array('session'=>'xsd:string','note'=>'tns:note_attachment'),
 645         array('return'=>'tns:set_entry_result'),
 646         $NAMESPACE);
 647
 648 /**
 649  * Add or replace the attachment on a Note.
 650  *
 651  * @param String $session -- Session ID returned by a previous call to login.
 652  * @param Binary $note -- The flie contents of the attachment.
 653  * @return Array 'id' -- The ID of the new note or -1 on error
 654  *               'error' -- The SOAP error if any.
 655  */
 656 function set_note_attachment($session,$note)
 657 {
 658
 659         $error = new SoapError();
 660         if(!validate_authenticated($session)){
 661                 $error->set_error('invalid_login');
 662                 return array('id'=>-1, 'error'=>$error->get_soap_array());
 663         }
 664
 665         require_once('modules/Notes/NoteSoap.php');
 666         $ns = new NoteSoap();
 667         return array('id'=>$ns->saveFile($note), 'error'=>$error->get_soap_array());
 668
 669 }
 670
 671 $server->register(
 672     'get_note_attachment',
 673     array('session'=>'xsd:string', 'id'=>'xsd:string'),
 674     array('return'=>'tns:return_note_attachment'),
 675     $NAMESPACE);
 676
 677 /**
 678  * Retrieve an attachment from a note
 679  * @param String $session -- Session ID returned by a previous call to login.
 680  * @param Binary $note -- The flie contents of the attachment.
 681  * @return Array 'id' -- The ID of the new note or -1 on error
 682  *               'error' -- The SOAP error if any.
 683  *
 684  * @param String $session -- Session ID returned by a previous call to login.
 685  * @param String $id -- The ID of the appropriate Note.
 686  * @return Array 'note_attachment' -- Array String 'id' -- The ID of the Note containing the attachment
 687  *                                          String 'filename' -- The file name of the attachment
 688  *                                          Binary 'file' -- The binary contents of the file.
 689  *               'error' -- The SOAP error if any.
 690  */
 691 function get_note_attachment($session,$id)
 692 {
 693         $error = new SoapError();
 694         if(!validate_authenticated($session)){
 695                 $error->set_error('invalid_login');
 696                 return array('result_count'=>-1, 'entry_list'=>array(), 'error'=>$error->get_soap_array());
 697         }
 698
 699         $note = new Note();
 700
 701         $note->retrieve($id);
 702         if(!$note->ACLAccess('DetailView')){
 703                 $error->set_error('no_access');
 704                 return array('result_count'=>-1, 'entry_list'=>array(), 'error'=>$error->get_soap_array());
 705         }
 706         require_once('modules/Notes/NoteSoap.php');
 707         $ns = new NoteSoap();
 708         if(!isset($note->filename)){
 709                 $note->filename = '';
 710         }
 711         $file= $ns->retrieveFile($id,$note->filename);
 712         if($file == -1){
 713                 $error->set_error('no_file');
 714                 $file = '';
 715         }
 716
 717         return array('note_attachment'=>array('id'=>$id, 'filename'=>$note->filename, 'file'=>$file), 'error'=>$error->get_soap_array());
 718
 719 }
 720 $server->register(
 721     'relate_note_to_module',
 722     array('session'=>'xsd:string', 'note_id'=>'xsd:string', 'module_name'=>'xsd:string', 'module_id'=>'xsd:string'),
 723     array('return'=>'tns:error_value'),
 724     $NAMESPACE);
 725
 726 /**
 727  * Attach a note to another bean.  Once you have created a note to store an
 728  * attachment, the note needs to be related to the bean.
 729  *
 730  * @param String $session -- Session ID returned by a previous call to login.
 731  * @param String $note_id -- The ID of the note that you want to associate with a bean
 732  * @param String $module_name -- The name of the module to return records 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)..
 733  * @param String $module_id -- The ID of the bean that you want to associate the note with
 734  * @return no error for success, error for failure
 735  */
 736 function relate_note_to_module($session,$note_id, $module_name, $module_id){
 737         global  $beanList, $beanFiles;
 738         $error = new SoapError();
 739         if(!validate_authenticated($session)){
 740                 $error->set_error('invalid_login');
 741                 return $error->get_soap_array();
 742         }
 743         if(empty($beanList[$module_name])){
 744                 $error->set_error('no_module');
 745                 return $error->get_soap_array();
 746         }
 747         global $current_user;
 748         if(!check_modules_access($current_user, $module_name, 'read')){
 749                 $error->set_error('no_access');
 750                 return $error->get_soap_array();
 751         }
 752         $class_name = $beanList['Notes'];
 753         require_once($beanFiles[$class_name]);
 754         $seed = new $class_name();
 755         $seed->retrieve($note_id);
 756         if(!$seed->ACLAccess('ListView')){
 757                 $error->set_error('no_access');
 758                 return array('result_count'=>-1, 'entry_list'=>array(), 'error'=>$error->get_soap_array());
 759         }
 760
 761         if($module_name != 'Contacts'){
 762                 $seed->parent_type=$module_name;
 763                 $seed->parent_id = $module_id;
 764
 765         }else{
 766
 767                 $seed->contact_id=$module_id;
 768
 769         }
 770
 771         $seed->save();
 772
 773         return $error->get_soap_array();
 774
 775 }
 776 $server->register(
 777     'get_related_notes',
 778     array('session'=>'xsd:string', 'module_name'=>'xsd:string', 'module_id'=>'xsd:string', 'select_fields'=>'tns:select_fields'),
 779     array('return'=>'tns:get_entry_result'),
 780     $NAMESPACE);
 781
 782 /**
 783  * Retrieve the collection of notes that are related to a bean.
 784  *
 785  * @param String $session -- Session ID returned by a previous call to login.
 786  * @param String $module_name -- The name of the module to return records 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)..
 787  * @param String $module_id -- The ID of the bean that you want to associate the note with
 788  * @param Array  $select_fields -- A list of the fields to be included in the results. This optional parameter allows for only needed fields to be retrieved.
 789  * @return Array    'result_count' -- The number of records returned (-1 on error)
 790  *                  'next_offset' -- The start of the next page (This will always be the previous offset plus the number of rows returned.  It does not indicate if there is additional data unless you calculate that the next_offset happens to be closer than it should be.
 791  *                  'field_list' -- The vardef information on the selected fields.
 792  *                  'entry_list' -- The records that were retrieved
 793  *                  'error' -- The SOAP error, if any
 794  */
 795 function get_related_notes($session,$module_name, $module_id, $select_fields){
 796         global  $beanList, $beanFiles;
 797         $error = new SoapError();
 798         if(!validate_authenticated($session)){
 799                 $error->set_error('invalid_login');
 800                 return array('result_count'=>-1, 'entry_list'=>array(), 'error'=>$error->get_soap_array());
 801         }
 802         if(empty($beanList[$module_name])){
 803                 $error->set_error('no_module');
 804                 return array('result_count'=>-1, 'entry_list'=>array(), 'error'=>$error->get_soap_array());
 805         }
 806         global $current_user;
 807         if(!check_modules_access($current_user, $module_name, 'read')){
 808                 $error->set_error('no_access');
 809                 return array('result_count'=>-1, 'entry_list'=>array(), 'error'=>$error->get_soap_array());
 810         }
 811
 812         $class_name = $beanList[$module_name];
 813         require_once($beanFiles[$class_name]);
 814         $seed = new $class_name();
 815         $seed->retrieve($module_id);
 816         if(!$seed->ACLAccess('DetailView')){
 817                 $error->set_error('no_access');
 818                 return array('result_count'=>-1, 'entry_list'=>array(), 'error'=>$error->get_soap_array());
 819         }
 820         $list = $seed->get_linked_beans('notes','Note', array(), 0, -1, 0);
 821
 822         $output_list = Array();
 823         $field_list = Array();
 824         foreach($list as $value)
 825         {
 826                 $output_list[] = get_return_value($value, 'Notes');
 827         if(empty($field_list))
 828         {
 829                         $field_list = get_field_list($value);
 830                 }
 831         }
 832         $output_list = filter_return_list($output_list, $select_fields, $module_name);
 833         $field_list = filter_field_list($field_list,$select_fields, $module_name);
 834
 835         return array('result_count'=>sizeof($output_list), 'next_offset'=>0,'field_list'=>$field_list, 'entry_list'=>$output_list, 'error'=>$error->get_soap_array());
 836 }
 837
 838 $server->register(
 839         'logout',
 840         array('session'=>'xsd:string'),
 841         array('return'=>'tns:error_value'),
 842         $NAMESPACE);
 843
 844 /**
 845  * Log out of the session.  This will destroy the session and prevent other's from using it.
 846  *
 847  * @param String $session -- Session ID returned by a previous call to login.
 848  * @return Empty error on success, Error on failure
 849  */
 850 function logout($session){
 851         global $current_user;
 852
 853         $error = new SoapError();
 854         LogicHook::initialize();
 855         if(validate_authenticated($session)){
 856                 $current_user->call_custom_logic('before_logout');
 857                 session_destroy();
 858                 $GLOBALS['logic_hook']->call_custom_logic('Users', 'after_logout');
 859                 return $error->get_soap_array();
 860         }
 861         $error->set_error('no_session');
 862         $GLOBALS['logic_hook']->call_custom_logic('Users', 'after_logout');
 863         return $error->get_soap_array();
 864 }
 865
 866 $server->register(
 867     'get_module_fields',
 868     array('session'=>'xsd:string', 'module_name'=>'xsd:string'),
 869     array('return'=>'tns:module_fields'),
 870     $NAMESPACE);
 871
 872 /**
 873  * Retrieve vardef information on the fields of the specified bean.
 874  *
 875  * @param String $session -- Session ID returned by a previous call to login.
 876  * @param String $module_name -- The name of the module to return records 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)..
 877  * @return Array    'module_fields' -- The vardef information on the selected fields.
 878  *                  'error' -- The SOAP error, if any
 879  */
 880 function get_module_fields($session, $module_name){
 881         global  $beanList, $beanFiles;
 882         $error = new SoapError();
 883         $module_fields = array();
 884         if(! validate_authenticated($session)){
 885                 $error->set_error('invalid_session');
 886                 return array('module_fields'=>$module_fields, 'error'=>$error->get_soap_array());
 887         }
 888         if(empty($beanList[$module_name])){
 889                 $error->set_error('no_module');
 890                 return array('module_fields'=>$module_fields, 'error'=>$error->get_soap_array());
 891         }
 892         global $current_user;
 893         if(!check_modules_access($current_user, $module_name, 'read')){
 894                 $error->set_error('no_access');
 895                 return array('module_fields'=>$module_fields, 'error'=>$error->get_soap_array());
 896         }
 897         $class_name = $beanList[$module_name];
 898
 899         if(empty($beanFiles[$class_name]))
 900         {
 901        $error->set_error('no_file');
 902        return array('module_fields'=>$module_fields, 'error'=>$error->get_soap_array());
 903         }
 904
 905         require_once($beanFiles[$class_name]);
 906         $seed = new $class_name();
 907         if($seed->ACLAccess('ListView', true) || $seed->ACLAccess('DetailView', true) ||        $seed->ACLAccess('EditView', true) )
 908     {
 909         return get_return_module_fields($seed, $module_name, $error);
 910     }
 911     else
 912     {
 913         $error->set_error('no_access');
 914         return array('module_fields'=>$module_fields, 'error'=>$error->get_soap_array());
 915     }
 916 }
 917
 918 $server->register(
 919     'get_available_modules',
 920     array('session'=>'xsd:string'),
 921     array('return'=>'tns:module_list'),
 922     $NAMESPACE);
 923
 924 /**
 925  * Retrieve the list of available modules on the system available to the currently logged in user.
 926  *
 927  * @param String $session -- Session ID returned by a previous call to login.
 928  * @return Array    'modules' -- An array of module names
 929  *                  'error' -- The SOAP error, if any
 930  */
 931 function get_available_modules($session){
 932         $error = new SoapError();
 933         $modules = array();
 934         if(! validate_authenticated($session)){
 935                 $error->set_error('invalid_session');
 936                 return array('modules'=> $modules, 'error'=>$error->get_soap_array());
 937         }
 938         $modules = array_keys($_SESSION['avail_modules']);
 939
 940         return array('modules'=> $modules, 'error'=>$error->get_soap_array());
 941 }
 942
 943
 944 $server->register(
 945     'update_portal_user',
 946     array('session'=>'xsd:string', 'portal_name'=>'xsd:string', 'name_value_list'=>'tns:name_value_list'),
 947     array('return'=>'tns:error_value'),
 948     $NAMESPACE);
 949
 950 /**
 951  * Update the properties of a contact that is portal user.  Add the portal user name to the user's properties.
 952  *
 953  * @param String $session -- Session ID returned by a previous call to login.
 954  * @param String $portal_name -- The portal user_name of the contact
 955  * @param Array $name_value_list -- collection of 'name'=>'value' pairs for finding the contact
 956  * @return Empty error on success, Error on failure
 957  */
 958 function update_portal_user($session,$portal_name, $name_value_list){
 959         global  $beanList, $beanFiles;
 960         $error = new SoapError();
 961         if(! validate_authenticated($session)){
 962                 $error->set_error('invalid_session');
 963                 return $error->get_soap_array();
 964         }
 965         $contact = new Contact();
 966
 967         $searchBy = array('deleted'=>0);
 968         foreach($name_value_list as $name_value){
 969                         $searchBy[$name_value['name']] = $name_value['value'];
 970         }
 971         if($contact->retrieve_by_string_fields($searchBy) != null){
 972                 if(!$contact->duplicates_found){
 973                         $contact->portal_name = $portal_name;
 974                         $contact->portal_active = 1;
 975                         if($contact->ACLAccess('Save')){
 976                                 $contact->save();
 977                         }else{
 978                                 $error->set_error('no_access');
 979                         }
 980                         return $error->get_soap_array();
 981                 }
 982                 $error->set_error('duplicates');
 983                 return $error->get_soap_array();
 984         }
 985         $error->set_error('no_records');
 986         return $error->get_soap_array();
 987 }
 988
 989 $server->register(
 990     'get_user_id',
 991     array('session'=>'xsd:string'),
 992     array('return'=>'xsd:string'),
 993     $NAMESPACE);
 994
 995 /**
 996  * Return the user_id of the user that is logged into the current session.
 997  *
 998  * @param String $session -- Session ID returned by a previous call to login.
 999  * @return String -- the User ID of the current session
1000  *                  -1 on error.
1001  */
1002 function get_user_id($session){
1003         if(validate_authenticated($session)){
1004                 global $current_user;
1005                 return $current_user->id;
1006
1007         }else{
1008                 return '-1';
1009         }
1010 }
1011
1012 $server->register(
1013     'get_user_team_id',
1014     array('session'=>'xsd:string'),
1015     array('return'=>'xsd:string'),
1016     $NAMESPACE);
1017
1018 /**
1019  * Return the ID of the default team for the user that is logged into the current session.
1020  *
1021  * @param String $session -- Session ID returned by a previous call to login.
1022  * @return String -- the Team ID of the current user's default team
1023  *                  1 for Community Edition
1024  *                  -1 on error.
1025  */
1026 function get_user_team_id($session){
1027         if(validate_authenticated($session))
1028         {
1029                  return 1;
1030         }else{
1031                 return '-1';
1032         }
1033 }
1034
1035 $server->register(
1036     'get_server_time',
1037     array(),
1038     array('return'=>'xsd:string'),
1039     $NAMESPACE);
1040
1041 /**
1042  * Return the current time on the server in the format 'Y-m-d H:i:s'.  This time is in the server's default timezone.
1043  *
1044  * @return String -- The current date/time 'Y-m-d H:i:s'
1045  */
1046 function get_server_time(){
1047         return date('Y-m-d H:i:s');
1048 }
1049
1050 $server->register(
1051     'get_gmt_time',
1052     array(),
1053     array('return'=>'xsd:string'),
1054     $NAMESPACE);
1055
1056 /**
1057  * Return the current time on the server in the format 'Y-m-d H:i:s'.  This time is in GMT.
1058  *
1059  * @return String -- The current date/time 'Y-m-d H:i:s'
1060  */
1061 function get_gmt_time(){
1062         return TimeDate::getInstance()->nowDb();
1063 }
1064
1065 $server->register(
1066     'get_sugar_flavor',
1067     array(),
1068     array('return'=>'xsd:string'),
1069     $NAMESPACE);
1070
1071 /**
1072  * Retrieve the specific flavor of sugar.
1073  *
1074  * @return String   'CE' -- For Community Edition
1075  *                  'PRO' -- For Professional
1076  *                  'ENT' -- For Enterprise
1077  */
1078 function get_sugar_flavor(){
1079  global $sugar_flavor;
1080
1081  return $sugar_flavor;
1082 }
1083
1084
1085 $server->register(
1086     'get_server_version',
1087     array(),
1088     array('return'=>'xsd:string'),
1089     $NAMESPACE);
1090
1091 /**
1092  * Retrieve the version number of Sugar that the server is running.
1093  *
1094  * @return String -- The current sugar version number.
1095  *                   '1.0' on error.
1096  */
1097 function get_server_version(){
1098
1099         $admin  = new Administration();
1100         $admin->retrieveSettings('info');
1101         if(isset($admin->settings['info_sugar_version'])){
1102                 return $admin->settings['info_sugar_version'];
1103         }else{
1104                 return '1.0';
1105         }
1106
1107 }
1108
1109 $server->register(
1110     'get_relationships',
1111     array('session'=>'xsd:string', 'module_name'=>'xsd:string', 'module_id'=>'xsd:string', 'related_module'=>'xsd:string', 'related_module_query'=>'xsd:string', 'deleted'=>'xsd:int'),
1112     array('return'=>'tns:get_relationships_result'),
1113     $NAMESPACE);
1114
1115 /**
1116  * Retrieve a collection of beans tha are related to the specified bean.
1117  * As of 4.5.1c, all combinations of related modules are supported
1118  *
1119  * @param String $session -- Session ID returned by a previous call to login.
1120  * @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)..
1121  * @param String $module_id -- The ID of the bean in the specified module
1122  * @param String $related_module -- The name of the related module to return records 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)..
1123  * @param String $related_module_query -- A portion of the where clause of the SQL statement to find the related items.  The SQL query will already be filtered to only include the beans that are related to the specified bean.
1124  * @param Number $deleted -- false if deleted records should not be include, true if deleted records should be included.
1125  * @return unknown
1126  */
1127 function get_relationships($session, $module_name, $module_id, $related_module, $related_module_query, $deleted){
1128                 $error = new SoapError();
1129         $ids = array();
1130         if(!validate_authenticated($session)){
1131                 $error->set_error('invalid_login');
1132                 return array('ids'=>$ids,'error'=> $error->get_soap_array());
1133         }
1134         global  $beanList, $beanFiles;
1135         $error = new SoapError();
1136
1137         if(empty($beanList[$module_name]) || empty($beanList[$related_module])){
1138                 $error->set_error('no_module');
1139                 return array('ids'=>$ids, 'error'=>$error->get_soap_array());
1140         }
1141         $class_name = $beanList[$module_name];
1142         require_once($beanFiles[$class_name]);
1143         $mod = new $class_name();
1144         $mod->retrieve($module_id);
1145         if(!$mod->ACLAccess('DetailView')){
1146                 $error->set_error('no_access');
1147                 return array('ids'=>$ids, 'error'=>$error->get_soap_array());
1148         }
1149
1150         require_once 'include/SugarSQLValidate.php';
1151         $valid = new SugarSQLValidate();
1152         if(!$valid->validateQueryClauses($related_module_query)) {
1153         $GLOBALS['log']->error("Bad query: $related_module_query");
1154         $error->set_error('no_access');
1155             return array(
1156                         'result_count' => -1,
1157                         'error' => $error->get_soap_array()
1158                 );
1159     }
1160
1161     $id_list = get_linked_records($related_module, $module_name, $module_id);
1162
1163         if ($id_list === FALSE) {
1164                 $error->set_error('no_relationship_support');
1165                 return array('ids'=>$ids, 'error'=>$error->get_soap_array());
1166         }
1167         elseif (count($id_list) == 0) {
1168                 return array('ids'=>$ids, 'error'=>$error->get_soap_array());
1169         }
1170
1171         $list = array();
1172
1173         $in = "'".implode("', '", $id_list)."'";
1174
1175         $related_class_name = $beanList[$related_module];
1176         require_once($beanFiles[$related_class_name]);
1177         $related_mod = new $related_class_name();
1178
1179         $sql = "SELECT {$related_mod->table_name}.id FROM {$related_mod->table_name} ";
1180
1181
1182         $sql .= " WHERE {$related_mod->table_name}.id IN ({$in}) ";
1183
1184         if (!empty($related_module_query)) {
1185                 $sql .= " AND ( {$related_module_query} )";
1186         }
1187
1188         $result = $related_mod->db->query($sql);
1189         while ($row = $related_mod->db->fetchByAssoc($result)) {
1190                 $list[] = $row['id'];
1191         }
1192
1193         $return_list = array();
1194
1195         foreach($list as $id) {
1196                 $related_class_name = $beanList[$related_module];
1197                 $related_mod = new $related_class_name();
1198                 $related_mod->retrieve($id);
1199
1200                 $return_list[] = array(
1201                         'id' => $id,
1202                         'date_modified' => $related_mod->date_modified,
1203                         'deleted' => $related_mod->deleted
1204                 );
1205         }
1206
1207         return array('ids' => $return_list, 'error' => $error->get_soap_array());
1208 }
1209
1210
1211 $server->register(
1212     'set_relationship',
1213     array('session'=>'xsd:string','set_relationship_value'=>'tns:set_relationship_value'),
1214     array('return'=>'tns:error_value'),
1215     $NAMESPACE);
1216
1217 /**
1218  * Set a single relationship between two beans.  The items are related by module name and id.
1219  *
1220  * @param String $session -- Session ID returned by a previous call to login.
1221  * @param Array $set_relationship_value --
1222  *      'module1' -- 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)..
1223  *      'module1_id' -- The ID of the bean in the specified module
1224  *      'module2' -- The name of the module that the related 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)..
1225  *      'module2_id' -- The ID of the bean in the specified module
1226  * @return Empty error on success, Error on failure
1227  */
1228 function set_relationship($session, $set_relationship_value){
1229         $error = new SoapError();
1230         if(!validate_authenticated($session)){
1231                 $error->set_error('invalid_login');
1232                 return $error->get_soap_array();
1233         }
1234         return handle_set_relationship($set_relationship_value, $session);
1235 }
1236
1237 $server->register(
1238     'set_relationships',
1239     array('session'=>'xsd:string','set_relationship_list'=>'tns:set_relationship_list'),
1240     array('return'=>'tns:set_relationship_list_result'),
1241     $NAMESPACE);
1242
1243 /**
1244  * Setup several relationships between pairs of beans.  The items are related by module name and id.
1245  *
1246  * @param String $session -- Session ID returned by a previous call to login.
1247  * @param Array $set_relationship_list -- One for each relationship to setup.  Each entry is itself an array.
1248  *      'module1' -- 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)..
1249  *      'module1_id' -- The ID of the bean in the specified module
1250  *      'module2' -- The name of the module that the related 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)..
1251  *      'module2_id' -- The ID of the bean in the specified module
1252  * @return Empty error on success, Error on failure
1253  */
1254 function set_relationships($session, $set_relationship_list){
1255         $error = new SoapError();
1256         if(!validate_authenticated($session)){
1257                 $error->set_error('invalid_login');
1258                 return -1;
1259         }
1260         $count = 0;
1261         $failed = 0;
1262         foreach($set_relationship_list as $set_relationship_value){
1263                 $reter = handle_set_relationship($set_relationship_value, $session);
1264                 if($reter['number'] == 0){
1265                         $count++;
1266                 }else{
1267                         $failed++;
1268                 }
1269         }
1270         return array('created'=>$count , 'failed'=>$failed, 'error'=>$error);
1271 }
1272
1273
1274
1275 //INTERNAL FUNCTION NOT EXPOSED THROUGH SOAP
1276 /**
1277  * (Internal) Create a relationship between two beans.
1278  *
1279  * @param Array $set_relationship_value --
1280  *      'module1' -- 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)..
1281  *      'module1_id' -- The ID of the bean in the specified module
1282  *      'module2' -- The name of the module that the related 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)..
1283  *      'module2_id' -- The ID of the bean in the specified module
1284  * @return Empty error on success, Error on failure
1285  */
1286 function handle_set_relationship($set_relationship_value, $session='')
1287 {
1288     global  $beanList, $beanFiles;
1289     $error = new SoapError();
1290
1291     $module1 = $set_relationship_value['module1'];
1292     $module1_id = $set_relationship_value['module1_id'];
1293     $module2 = $set_relationship_value['module2'];
1294     $module2_id = $set_relationship_value['module2_id'];
1295
1296     if(empty($beanList[$module1]) || empty($beanList[$module2]) )
1297     {
1298         $error->set_error('no_module');
1299         return $error->get_soap_array();
1300     }
1301     $class_name = $beanList[$module1];
1302     require_once($beanFiles[$class_name]);
1303     $mod = new $class_name();
1304     $mod->retrieve($module1_id);
1305         if(!$mod->ACLAccess('DetailView')){
1306                 $error->set_error('no_access');
1307                 return $error->get_soap_array();
1308         }
1309         if($module1 == "Contacts" && $module2 == "Users"){
1310                 $key = 'contacts_users_id';
1311         }
1312         else{
1313         $key = array_search(strtolower($module2),$mod->relationship_fields);
1314         if(!$key) {
1315             $key = Relationship::retrieve_by_modules($module1, $module2, $GLOBALS['db']);
1316
1317             // BEGIN SnapLogic fix for bug 32064
1318             if ($module1 == "Quotes" && $module2 == "ProductBundles") {
1319                 // Alternative solution is perhaps to
1320                 // do whatever Sugar does when the same
1321                 // request is received from the web:
1322                 $pb_cls = $beanList[$module2];
1323                 $pb = new $pb_cls();
1324                 $pb->retrieve($module2_id);
1325
1326                 // Check if this relationship already exists
1327                 $query = "SELECT count(*) AS count FROM product_bundle_quote WHERE quote_id = '{$module1_id}' AND bundle_id = '{$module2_id}' AND deleted = '0'";
1328                 $result = $GLOBALS['db']->query($query, true, "Error checking for previously existing relationship between quote and product_bundle");
1329                 $row = $GLOBALS['db']->fetchByAssoc($result);
1330                 if(isset($row['count']) && $row['count'] > 0){
1331                     return $error->get_soap_array();
1332                 }
1333
1334                 $query = "SELECT MAX(bundle_index)+1 AS idx FROM product_bundle_quote WHERE quote_id = '{$module1_id}' AND deleted='0'";
1335                 $result = $GLOBALS['db']->query($query, true, "Error getting bundle_index");
1336                 $GLOBALS['log']->debug("*********** Getting max bundle_index");
1337                 $GLOBALS['log']->debug($query);
1338                 $row = $GLOBALS['db']->fetchByAssoc($result);
1339
1340                 $idx = 0;
1341                 if ($row) {
1342                     $idx = $row['idx'];
1343                 }
1344
1345                 $pb->set_productbundle_quote_relationship($module1_id,$module2_id,$idx);
1346                 $pb->save();
1347                 return $error->get_soap_array();
1348
1349             } else if ($module1 == "ProductBundles" && $module2 == "Products") {
1350                 // And, well, similar things apply in this case
1351                 $pb_cls = $beanList[$module1];
1352                 $pb = new $pb_cls();
1353                 $pb->retrieve($module1_id);
1354
1355                 // Check if this relationship already exists
1356                 $query = "SELECT count(*) AS count FROM product_bundle_product WHERE bundle_id = '{$module1_id}' AND product_id = '{$module2_id}' AND deleted = '0'";
1357                 $result = $GLOBALS['db']->query($query, true, "Error checking for previously existing relationship between quote and product_bundle");
1358                 $row = $GLOBALS['db']->fetchByAssoc($result);
1359                 if(isset($row['count']) && $row['count'] > 0){
1360                     return $error->get_soap_array();
1361                 }
1362
1363                 $query = "SELECT MAX(product_index)+1 AS idx FROM product_bundle_product WHERE bundle_id='{$module1_id}'";
1364                 $result = $GLOBALS['db']->query($query, true, "Error getting bundle_index");
1365                 $GLOBALS['log']->debug("*********** Getting max bundle_index");
1366                 $GLOBALS['log']->debug($query);
1367                 $row = $GLOBALS['db']->fetchByAssoc($result);
1368
1369                 $idx = 0;
1370                 if ($row) {
1371                     $idx = $row['idx'];
1372                 }
1373                 $pb->set_productbundle_product_relationship($module2_id,$idx,$module1_id);
1374                 $pb->save();
1375
1376                 $prod_cls = $beanList[$module2];
1377                 $prod = new $prod_cls();
1378                 $prod->retrieve($module2_id);
1379                 $prod->quote_id = $pb->quote_id;
1380                 $prod->save();
1381                 return $error->get_soap_array();
1382             }
1383             // END SnapLogic fix for bug 32064
1384
1385                 if (!empty($key)) {
1386                         $mod->load_relationship($key);
1387                         $mod->$key->add($module2_id);
1388                         return $error->get_soap_array();
1389                 } // if
1390         }
1391     }
1392
1393     if(!$key)
1394     {
1395         $error->set_error('no_module');
1396         return $error->get_soap_array();
1397     }
1398
1399     if(($module1 == 'Meetings' || $module1 == 'Calls') && ($module2 == 'Contacts' || $module2 == 'Users')){
1400         $key = strtolower($module2);
1401         $mod->load_relationship($key);
1402         $mod->$key->add($module2_id);
1403     }
1404     else if ($module1 == 'Contacts' && ($module2 == 'Notes' || $module2 == 'Calls' || $module2 == 'Meetings' || $module2 == 'Tasks') && !empty($session)){
1405         $mod->$key = $module2_id;
1406         $mod->save_relationship_changes(false);
1407         if (!empty($mod->account_id)) {
1408             // when setting a relationship from a Contact to these activities, if the Contacts is related to an Account,
1409             // we want to associate that Account to the activity as well
1410             $ret = set_relationship($session, array('module1'=>'Accounts', 'module1_id'=>$mod->account_id, 'module2'=>$module2, 'module2_id'=>$module2_id));
1411         }
1412     }
1413     else{
1414         $mod->$key = $module2_id;
1415         $mod->save_relationship_changes(false);
1416     }
1417
1418     return $error->get_soap_array();
1419 }
1420
1421
1422 $server->register(
1423         'set_document_revision',
1424         array('session'=>'xsd:string','note'=>'tns:document_revision'),
1425         array('return'=>'tns:set_entry_result'),
1426         $NAMESPACE);
1427
1428 /**
1429  * Enter description here...
1430  *
1431  * @param String $session -- Session ID returned by a previous call to login.
1432  * @param unknown_type $document_revision
1433  * @return unknown
1434  */
1435 function set_document_revision($session,$document_revision)
1436 {
1437
1438         $error = new SoapError();
1439         if(!validate_authenticated($session)){
1440                 $error->set_error('invalid_login');
1441                 return array('id'=>-1, 'error'=>$error->get_soap_array());
1442         }
1443
1444         require_once('modules/Documents/DocumentSoap.php');
1445         $dr = new DocumentSoap();
1446         return array('id'=>$dr->saveFile($document_revision), 'error'=>$error->get_soap_array());
1447
1448 }
1449
1450 $server->register(
1451         'search_by_module',
1452         array('user_name'=>'xsd:string','password'=>'xsd:string','search_string'=>'xsd:string', 'modules'=>'tns:select_fields', 'offset'=>'xsd:int', 'max_results'=>'xsd:int'),
1453         array('return'=>'tns:get_entry_list_result'),
1454         $NAMESPACE);
1455
1456 /**
1457  * Given a list of modules to search and a search string, return the id, module_name, along with the fields
1458  * as specified in the $query_array
1459  *
1460  * @param string $user_name             - username of the Sugar User
1461  * @param string $password                      - password of the Sugar User
1462  * @param string $search_string         - string to search
1463  * @param string[] $modules                     - array of modules to query
1464  * @param int $offset                           - a specified offset in the query
1465  * @param int $max_results                      - max number of records to return
1466  * @return get_entry_list_result        - id, module_name, and list of fields from each record
1467  */
1468 function search_by_module($user_name, $password, $search_string, $modules, $offset, $max_results){
1469         global  $beanList, $beanFiles;
1470
1471         $error = new SoapError();
1472     $hasLoginError = false;
1473
1474     if(empty($user_name) && !empty($password))
1475     {
1476         if(!validate_authenticated($password))
1477         {
1478             $hasLoginError = true;
1479         }
1480     } else if(!validate_user($user_name, $password)) {
1481                 $hasLoginError = true;
1482         }
1483
1484     //If there is a login error, then return the error here
1485     if($hasLoginError)
1486     {
1487         $error->set_error('invalid_login');
1488         return array('result_count'=>-1, 'entry_list'=>array(), 'error'=>$error->get_soap_array());
1489     }
1490
1491         global $current_user;
1492         if($max_results > 0){
1493                 global $sugar_config;
1494                 $sugar_config['list_max_entries_per_page'] = $max_results;
1495         }
1496         //  MRF - BUG:19552 - added a join for accounts' emails below
1497         $query_array = array('Accounts'=>array('where'=>array('Accounts' => array(0 => "accounts.name like '{0}%'"), 'EmailAddresses' => array(0 => "ea.email_address like '{0}%'")),'fields'=>"accounts.id, accounts.name"),
1498                                 'Bugs'=>array('where'=>array('Bugs' => array(0 => "bugs.name like '{0}%'", 1 => "bugs.bug_number = {0}")),'fields'=>"bugs.id, bugs.name, bugs.bug_number"),
1499                                                         'Cases'=>array('where'=>array('Cases' => array(0 => "cases.name like '{0}%'", 1 => "cases.case_number = {0}")),'fields'=>"cases.id, cases.name, cases.case_number"),
1500                                                         'Leads'=>array('where'=>array('Leads' => array(0 => "leads.first_name like '{0}%'",1 => "leads.last_name like '{0}%'"), 'EmailAddresses' => array(0 => "ea.email_address like '{0}%'")), 'fields'=>"leads.id, leads.first_name, leads.last_name, leads.status"),
1501                                                         'Project'=>array('where'=>array('Project' => array(0 => "project.name like '{0}%'")), 'fields'=>"project.id, project.name"),
1502                             'ProjectTask'=>array('where'=>array('ProjectTask' => array(0 => "project.id = '{0}'")), 'fields'=>"project_task.id, project_task.name"),
1503                                                         'Contacts'=>array('where'=>array('Contacts' => array(0 => "contacts.first_name like '{0}%'", 1 => "contacts.last_name like '{0}%'"), 'EmailAddresses' => array(0 => "ea.email_address like '{0}%'")),'fields'=>"contacts.id, contacts.first_name, contacts.last_name"),
1504                                                         'Opportunities'=>array('where'=>array('Opportunities' => array(0 => "opportunities.name like '{0}%'")), 'fields'=>"opportunities.id, opportunities.name"),
1505                                                         'Users'=>array('where'=>array('EmailAddresses' => array(0 => "ea.email_address like '{0}%'")),'fields'=>"users.id, users.user_name, users.first_name, ea.email_address"),
1506                                                 );
1507
1508         if(!empty($search_string) && isset($search_string)){
1509                 foreach($modules as $module_name){
1510                         $class_name = $beanList[$module_name];
1511                         require_once($beanFiles[$class_name]);
1512                         $seed = new $class_name();
1513                         if(empty($beanList[$module_name])){
1514                                 continue;
1515                         }
1516                         if(!check_modules_access($current_user, $module_name, 'read')){
1517                                 continue;
1518                         }
1519                         if(! $seed->ACLAccess('ListView'))
1520                         {
1521                                 continue;
1522                         }
1523
1524                         if(isset($query_array[$module_name])){
1525                                 $query = '';
1526                                 $tmpQuery = '';
1527                                 //split here to do while loop
1528                                 foreach($query_array[$module_name]['where'] as $key => $value){
1529                                         foreach($value as $where_clause){
1530                                                 $addQuery = true;
1531                                                 if(!empty($query))
1532                                                         $tmpQuery = ' UNION ';
1533                                                 $tmpQuery .= "SELECT ".$query_array[$module_name]['fields']." FROM $seed->table_name ";
1534                                                 // We need to confirm that the user is a member of the team of the item.
1535
1536
1537                                 if($module_name == 'ProjectTask'){
1538                                     $tmpQuery .= "INNER JOIN project ON $seed->table_name.project_id = project.id ";
1539                                 }
1540
1541                                 if(isset($seed->emailAddress) && $key == 'EmailAddresses'){
1542                                         $tmpQuery .= " INNER JOIN email_addr_bean_rel eabl  ON eabl.bean_id = $seed->table_name.id and eabl.deleted=0";
1543                                         $tmpQuery .= " INNER JOIN email_addresses ea ON (ea.id = eabl.email_address_id) ";
1544                                 }
1545                                                 $where = "WHERE (";
1546                                                 $search_terms = explode(", ", $search_string);
1547                                                 $termCount = count($search_terms);
1548                                                 $count = 1;
1549                                                 if($key != 'EmailAddresses'){
1550                                                         foreach($search_terms as $term){
1551                                                                 if(!strpos($where_clause, 'number')){
1552                                                                         $where .= string_format($where_clause,array($GLOBALS['db']->quote($term)));
1553                                                                 }elseif(is_numeric($term)){
1554                                                                         $where .= string_format($where_clause,array($GLOBALS['db']->quote($term)));
1555                                                                 }else{
1556                                                                         $addQuery = false;
1557                                                                 }
1558                                                                 if($count < $termCount){
1559                                                                         $where .= " OR ";
1560                                                                 }
1561                                                                 $count++;
1562                                                         }
1563                                                 }else{
1564                             $where .= '(';
1565                             foreach ($search_terms as $term)
1566                             {
1567                                 $where .= "ea.email_address LIKE '".$GLOBALS['db']->quote($term)."'";
1568                                 if ($count < $termCount)
1569                                 {
1570                                     $where .= " OR ";
1571                                 }
1572                                 $count++;
1573                             }
1574                             $where .= ')';
1575                                                 }
1576                                                 $tmpQuery .= $where;
1577                                                 $tmpQuery .= ") AND $seed->table_name.deleted = 0";
1578                                                 if($addQuery)
1579                                                         $query .= $tmpQuery;
1580                                         }
1581                                 }
1582                                 //grab the items from the db
1583                                 $result = $seed->db->query($query, $offset, $max_results);
1584
1585                                 while(($row = $seed->db->fetchByAssoc($result)) != null){
1586                                         $list = array();
1587                                         $fields = explode(", ", $query_array[$module_name]['fields']);
1588                                         foreach($fields as $field){
1589                                                 $field_names = explode(".", $field);
1590                                                 $list[$field] = array('name'=>$field_names[1], 'value'=>$row[$field_names[1]]);
1591                                         }
1592
1593                                         $output_list[] = array('id'=>$row['id'],
1594                                                                            'module_name'=>$module_name,
1595                                                                            'name_value_list'=>$list);
1596                                         if(empty($field_list)){
1597                                                 $field_list = get_field_list($row);
1598                                         }
1599                                 }//end while
1600                         }
1601                 }//end foreach
1602         }
1603
1604         $next_offset = $offset + sizeof($output_list);
1605
1606         return array('result_count'=>sizeof($output_list), 'next_offset'=>$next_offset,'field_list'=>$field_list, 'entry_list'=>$output_list, 'error'=>$error->get_soap_array());
1607
1608 }//end function
1609
1610
1611 $server->register(
1612 'get_mailmerge_document',
1613 array('session'=>'xsd:string','file_name'=>'xsd:string', 'fields' => 'tns:select_fields'),
1614 array('return'=>'tns:get_sync_result_encoded'),
1615 $NAMESPACE);
1616
1617 /**
1618  * Get MailMerge document
1619  *
1620  * @param String $session -- Session ID returned by a previous call to login.
1621  * @param unknown_type $file_name
1622  * @param unknown_type $fields
1623  * @return unknown
1624  */
1625 function get_mailmerge_document($session, $file_name, $fields)
1626 {
1627     global  $beanList, $beanFiles, $app_list_strings;
1628     $error = new SoapError();
1629     if(!validate_authenticated($session))
1630     {
1631         $error->set_error('invalid_login');
1632         return array('result'=>'', 'error'=>$error->get_soap_array());
1633     }
1634     if(!preg_match('/^sugardata[\.\d\s]+\.php$/', $file_name)) {
1635         $error->set_error('no_records');
1636         return array('result'=>'', 'error'=>$error->get_soap_array());
1637     }
1638     $html = '';
1639
1640     $file_name = sugar_cached('MergedDocuments/').pathinfo($file_name, PATHINFO_BASENAME);
1641
1642     $master_fields = array();
1643     $related_fields = array();
1644
1645     if(file_exists($file_name))
1646     {
1647         include($file_name);
1648
1649         $class1 = $merge_array['master_module'];
1650         $beanL = $beanList[$class1];
1651         $bean1 = $beanFiles[$beanL];
1652         require_once($bean1);
1653         $seed1 = new $beanL();
1654
1655         if(!empty($merge_array['related_module']))
1656         {
1657             $class2 = $merge_array['related_module'];
1658             $beanR = $beanList[$class2];
1659             $bean2 = $beanFiles[$beanR];
1660             require_once($bean2);
1661             $seed2 = new $beanR();
1662         }
1663
1664         //parse fields
1665         //$token1 = strtolower($class1);
1666         if($class1 == 'Prospects'){
1667             $class1 = 'CampaignProspects';
1668         }
1669         foreach($fields as $field)
1670         {
1671             $pos = strpos(strtolower($field), strtolower($class1));
1672             $pos2 = strpos(strtolower($field), strtolower($class2));
1673             if($pos !== false){
1674                 $fieldName = str_replace(strtolower($class1).'_', '', strtolower($field));
1675                 array_push($master_fields, $fieldName);
1676             }else if($pos2 !== false){
1677                 $fieldName = str_replace(strtolower($class2).'_', '', strtolower($field));
1678                 array_push($related_fields, $fieldName);
1679             }
1680         }
1681
1682         $html = '<html ' . get_language_header() .'><body><table border = 1><tr>';
1683
1684         foreach($master_fields as $master_field){
1685             $html .= '<td>'.$class1.'_'.$master_field.'</td>';
1686         }
1687         foreach($related_fields as $related_field){
1688             $html .= '<td>'.$class2.'_'.$related_field.'</td>';
1689         }
1690         $html .= '</tr>';
1691
1692         $ids = $merge_array['ids'];
1693         $is_prospect_merge = ($seed1->object_name == 'Prospect');
1694         foreach($ids as $key=>$value){
1695             if($is_prospect_merge){
1696                 $seed1 = $seed1->retrieveTarget($key);
1697             }else{
1698                 $seed1->retrieve($key);
1699             }
1700             $html .= '<tr>';
1701             foreach($master_fields as $master_field){
1702                 if(isset($seed1->$master_field)){
1703                     if($seed1->field_name_map[$master_field]['type'] == 'enum'){
1704                         //pull in the translated dom
1705                          $html .='<td>'.$app_list_strings[$seed1->field_name_map[$master_field]['options']][$seed1->$master_field].'</td>';
1706                     }else{
1707                         $html .='<td>'.$seed1->$master_field.'</td>';
1708                     }
1709                 }
1710                 else{
1711                     $html .= '<td></td>';
1712                     }
1713             }
1714             if(isset($value) && !empty($value)){
1715                 $seed2->retrieve($value);
1716                 foreach($related_fields as $related_field){
1717                     if(isset($seed2->$related_field)){
1718                         if($seed2->field_name_map[$related_field]['type'] == 'enum'){
1719                             //pull in the translated dom
1720                             $html .='<td>'.$app_list_strings[$seed2->field_name_map[$related_field]['options']][$seed2->$related_field].'</td>';
1721                         }else{
1722                             $html .= '<td>'.$seed2->$related_field.'</td>';
1723                         }
1724                     }
1725                     else{
1726                         $html .= '<td></td>';
1727                     }
1728                 }
1729             }
1730             $html .= '</tr>';
1731         }
1732         $html .= "</table></body></html>";
1733      }
1734
1735     $result = base64_encode($html);
1736     return array('result' => $result, 'error' => $error);
1737 }
1738
1739 $server->register(
1740 'get_mailmerge_document2',
1741 array('session'=>'xsd:string','file_name'=>'xsd:string', 'fields' => 'tns:select_fields'),
1742 array('return'=>'tns:get_mailmerge_document_result'),
1743 $NAMESPACE);
1744
1745 /**
1746  * Enter description here...
1747  *
1748  * @param String $session -- Session ID returned by a previous call to login.
1749  * @param unknown_type $file_name
1750  * @param unknown_type $fields
1751  * @return unknown
1752  */
1753 function get_mailmerge_document2($session, $file_name, $fields)
1754 {
1755     global  $beanList, $beanFiles, $app_list_strings, $app_strings;
1756
1757     $error = new SoapError();
1758     if(!validate_authenticated($session))
1759     {
1760         $GLOBALS['log']->error('invalid_login');
1761         $error->set_error('invalid_login');
1762         return array('result'=>'', 'error'=>$error->get_soap_array());
1763     }
1764     if(!preg_match('/^sugardata[\.\d\s]+\.php$/', $file_name)) {
1765         $GLOBALS['log']->error($app_strings['ERR_NO_SUCH_FILE'] . " ({$file_name})");
1766         $error->set_error('no_records');
1767         return array('result'=>'', 'error'=>$error->get_soap_array());
1768     }
1769     $html = '';
1770
1771     $file_name = sugar_cached('MergedDocuments/').pathinfo($file_name, PATHINFO_BASENAME);
1772
1773     $master_fields = array();
1774     $related_fields = array();
1775
1776     if(file_exists($file_name))
1777     {
1778         include($file_name);
1779
1780         $class1 = $merge_array['master_module'];
1781         $beanL = $beanList[$class1];
1782         $bean1 = $beanFiles[$beanL];
1783         require_once($bean1);
1784         $seed1 = new $beanL();
1785
1786         if(!empty($merge_array['related_module']))
1787         {
1788             $class2 = $merge_array['related_module'];
1789             $beanR = $beanList[$class2];
1790             $bean2 = $beanFiles[$beanR];
1791             require_once($bean2);
1792             $seed2 = new $beanR();
1793         }
1794
1795         //parse fields
1796         //$token1 = strtolower($class1);
1797         if($class1 == 'Prospects'){
1798             $class1 = 'CampaignProspects';
1799         }
1800         foreach($fields as $field)
1801         {
1802                 $pos = strpos(strtolower($field), strtolower($class1));
1803             $pos2 = strpos(strtolower($field), strtolower($class2));
1804             if($pos !== false){
1805                 $fieldName = str_replace(strtolower($class1).'_', '', strtolower($field));
1806                 array_push($master_fields, $fieldName);
1807             }else if($pos2 !== false){
1808                 $fieldName = str_replace(strtolower($class2).'_', '', strtolower($field));
1809                 array_push($related_fields, $fieldName);
1810             }
1811         }
1812
1813         $html = '<html ' . get_language_header() . '><body><table border = 1><tr>';
1814
1815         foreach($master_fields as $master_field){
1816             $html .= '<td>'.$class1.'_'.$master_field.'</td>';
1817         }
1818         foreach($related_fields as $related_field){
1819             $html .= '<td>'.$class2.'_'.$related_field.'</td>';
1820         }
1821         $html .= '</tr>';
1822
1823         $ids = $merge_array['ids'];
1824         $resultIds = array();
1825         $is_prospect_merge = ($seed1->object_name == 'Prospect');
1826         if($is_prospect_merge){
1827                 $pSeed = $seed1;
1828         }
1829         foreach($ids as $key=>$value){
1830
1831             if($is_prospect_merge){
1832                 $seed1 = $pSeed->retrieveTarget($key);
1833             }else{
1834                 $seed1->retrieve($key);
1835             }
1836              $resultIds[] = array('name' => $seed1->module_name, 'value' => $key);
1837             $html .= '<tr>';
1838             foreach($master_fields as $master_field){
1839                 if(isset($seed1->$master_field)){
1840                     if($seed1->field_name_map[$master_field]['type'] == 'enum'){
1841                         //pull in the translated dom
1842                          $html .='<td>'.$app_list_strings[$seed1->field_name_map[$master_field]['options']][$seed1->$master_field].'</td>';
1843                     } else if ($seed1->field_name_map[$master_field]['type'] == 'multienum') {
1844
1845                         if(isset($app_list_strings[$seed1->field_name_map[$master_field]['options']]) )
1846                         {
1847                             $items = unencodeMultienum($seed1->$master_field);
1848                             $output = array();
1849                             foreach($items as $item) {
1850                                 if ( !empty($app_list_strings[$seed1->field_name_map[$master_field]['options']][$item]) )
1851                                 {
1852                                     array_push($output, $app_list_strings[$seed1->field_name_map[$master_field]['options']][$item]);
1853
1854                                 }
1855
1856                             } // foreach
1857
1858                             $encoded_output = encodeMultienumValue($output);
1859                             $html .= "<td>$encoded_output</td>";
1860
1861                         }
1862                     } else {
1863                        $html .='<td>'.$seed1->$master_field.'</td>';
1864                     }
1865                 }
1866                 else{
1867                     $html .= '<td></td>';
1868                     }
1869             }
1870             if(isset($value) && !empty($value)){
1871                 $resultIds[] = array('name' => $seed2->module_name, 'value' => $value);
1872                                 $seed2->retrieve($value);
1873                 foreach($related_fields as $related_field){
1874                     if(isset($seed2->$related_field)){
1875                         if($seed2->field_name_map[$related_field]['type'] == 'enum'){
1876                             //pull in the translated dom
1877                             $html .='<td>'.$app_list_strings[$seed2->field_name_map[$related_field]['options']][$seed2->$related_field].'</td>';
1878                         }else{
1879                             $html .= '<td>'.$seed2->$related_field.'</td>';
1880                         }
1881                     }
1882                     else{
1883                         $html .= '<td></td>';
1884                     }
1885                 }
1886             }
1887             $html .= '</tr>';
1888         }
1889         $html .= "</table></body></html>";
1890      }
1891     $result = base64_encode($html);
1892
1893     return array('html' => $result, 'name_value_list' => $resultIds, 'error' => $error);
1894 }
1895
1896 $server->register(
1897         'get_document_revision',
1898         array('session'=>'xsd:string','i'=>'xsd:string'),
1899         array('return'=>'tns:return_document_revision'),
1900         $NAMESPACE);
1901
1902 /**
1903  * This method is used as a result of the .htaccess lock down on the cache directory. It will allow a
1904  * properly authenticated user to download a document that they have proper rights to download.
1905  *
1906  * @param String $session -- Session ID returned by a previous call to login.
1907  * @param String $id      -- ID of the document revision to obtain
1908  * @return return_document_revision - this is a complex type as defined in SoapTypes.php
1909  */
1910 function get_document_revision($session,$id)
1911 {
1912     global $sugar_config;
1913
1914     $error = new SoapError();
1915     if(!validate_authenticated($session)){
1916         $error->set_error('invalid_login');
1917         return array('id'=>-1, 'error'=>$error->get_soap_array());
1918     }
1919
1920
1921     $dr = new DocumentRevision();
1922     $dr->retrieve($id);
1923     if(!empty($dr->filename)){
1924         $filename = "upload://{$dr->id}";
1925         $contents = base64_encode(sugar_file_get_contents($filename));
1926         return array('document_revision'=>array('id' => $dr->id, 'document_name' => $dr->document_name, 'revision' => $dr->revision, 'filename' => $dr->filename, 'file' => $contents), 'error'=>$error->get_soap_array());
1927     }else{
1928         $error->set_error('no_records');
1929         return array('id'=>-1, 'error'=>$error->get_soap_array());
1930     }
1931
1932 }
1933 $server->register(
1934     'set_campaign_merge',
1935     array('session'=>'xsd:string', 'targets'=>'tns:select_fields', 'campaign_id'=>'xsd:string'),
1936     array('return'=>'tns:error_value'),
1937     $NAMESPACE);
1938 /**
1939 *   Once we have successfuly done a mail merge on a campaign, we need to notify Sugar of the targets
1940 *   and the campaign_id for tracking purposes
1941 *
1942 * @param session        the session id of the authenticated user
1943 * @param targets        a string array of ids identifying the targets used in the merge
1944 * @param campaign_id    the campaign_id used for the merge
1945 *
1946 * @return error_value
1947 */
1948 function set_campaign_merge($session,$targets, $campaign_id){
1949     $error = new SoapError();
1950     if(!validate_authenticated($session)){
1951         $error->set_error('invalid_login');
1952         return $error->get_soap_array();
1953     }
1954     if (empty($campaign_id) or !is_array($targets) or count($targets) == 0) {
1955         $GLOBALS['log']->debug('set_campaign_merge: Merge action status will not be updated, because, campaign_id is null or no targets were selected.');
1956     } else {
1957         require_once('modules/Campaigns/utils.php');
1958         campaign_log_mail_merge($campaign_id,$targets);
1959     }
1960
1961     return $error->get_soap_array();
1962 }
1963 $server->register(
1964     'get_entries_count',
1965     array('session'=>'xsd:string', 'module_name'=>'xsd:string', 'query'=>'xsd:string', 'deleted' => 'xsd:int'),
1966     array('return'=>'tns:get_entries_count_result'),
1967     $NAMESPACE);
1968
1969 /**
1970 *   Retrieve number of records in a given module
1971 *
1972 * @param session        the session id of the authenticated user
1973 * @param module_name    module to retrieve number of records from
1974 * @param query          allows webservice user to provide a WHERE clause
1975 * @param deleted        specify whether or not to include deleted records
1976 *
1977 @return get_entries_count_result - this is a complex type as defined in SoapTypes.php
1978 */
1979 function get_entries_count($session, $module_name, $query, $deleted) {
1980         global $beanList, $beanFiles, $current_user;
1981
1982         $error = new SoapError();
1983
1984         if (!validate_authenticated($session)) {
1985                 $error->set_error('invalid_login');
1986                 return array(
1987                         'result_count' => -1,
1988                         'error' => $error->get_soap_array()
1989                 );
1990         }
1991
1992         if (empty($beanList[$module_name])) {
1993                 $error->set_error('no_module');
1994                 return array(
1995                         'result_count' => -1,
1996                         'error' => $error->get_soap_array()
1997                 );
1998         }
1999
2000         if(!check_modules_access($current_user, $module_name, 'list')){
2001                 $error->set_error('no_access');
2002                 return array(
2003                         'result_count' => -1,
2004                         'error' => $error->get_soap_array()
2005                 );
2006         }
2007
2008         $class_name = $beanList[$module_name];
2009         require_once($beanFiles[$class_name]);
2010         $seed = new $class_name();
2011
2012         if (!$seed->ACLAccess('ListView')) {
2013                 $error->set_error('no_access');
2014                 return array(
2015                         'result_count' => -1,
2016                         'error' => $error->get_soap_array()
2017                 );
2018         }
2019
2020         $sql = 'SELECT COUNT(*) result_count FROM ' . $seed->table_name . ' ';
2021
2022
2023     if (isset($seed->custom_fields)) {
2024         $customJoin = $seed->custom_fields->getJOIN();
2025         $sql .= $customJoin ? $customJoin['join'] : '';
2026     }
2027
2028         // build WHERE clauses, if any
2029         $where_clauses = array();
2030         if (!empty($query)) {
2031             require_once 'include/SugarSQLValidate.php';
2032             $valid = new SugarSQLValidate();
2033             if(!$valid->validateQueryClauses($query)) {
2034             $GLOBALS['log']->error("Bad query: $query");
2035                 $error->set_error('no_access');
2036                 return array(
2037                         'result_count' => -1,
2038                         'error' => $error->get_soap_array()
2039                 );
2040             }
2041                 $where_clauses[] = $query;
2042         }
2043         if ($deleted == 0) {
2044                 $where_clauses[] = $seed->table_name . '.deleted = 0';
2045         }
2046
2047         // if WHERE clauses exist, add them to query
2048         if (!empty($where_clauses)) {
2049                 $sql .= ' WHERE ' . implode(' AND ', $where_clauses);
2050         }
2051
2052         $res = $GLOBALS['db']->query($sql);
2053         $row = $GLOBALS['db']->fetchByAssoc($res);
2054
2055         return array(
2056                 'result_count' => $row['result_count'],
2057                 'error' => $error->get_soap_array()
2058         );
2059 }
2060
2061 $server->register(
2062     'set_entries_details',
2063     array('session'=>'xsd:string', 'module_name'=>'xsd:string',  'name_value_lists'=>'tns:name_value_lists', 'select_fields' => 'tns:select_fields'),
2064     array('return'=>'tns:set_entries_detail_result'),
2065     $NAMESPACE);
2066
2067 /**
2068  * Update or create a list of SugarBeans, returning details about the records created/updated
2069  *
2070  * @param String $session -- Session ID returned by a previous call to login.
2071  * @param String $module_name -- The name of the module to return records 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)..
2072  * @param Array $name_value_lists -- Array of Bean specific Arrays where the keys of the array are the SugarBean attributes, the values of the array are the values the attributes should have.
2073  * @param Array  $select_fields -- A list of the fields to be included in the results. This optional parameter allows for only needed fields to be retrieved.
2074  * @return Array    'name_value_lists' --  Array of Bean specific Arrays where the keys of the array are the SugarBean attributes, the values of the array are the values the attributes should have.
2075  *                  'error' -- The SOAP error if any.
2076  */
2077 function set_entries_details($session, $module_name, $name_value_lists, $select_fields) {
2078         $error = new SoapError();
2079
2080         if(!validate_authenticated($session)){
2081                 $error->set_error('invalid_login');
2082
2083                 return array(
2084                         'ids' => array(),
2085                         'error' => $error->get_soap_array()
2086                 );
2087         }
2088
2089         return handle_set_entries($module_name, $name_value_lists, $select_fields);
2090 }
2091
2092 // INTERNAL FUNCTION NOT EXPOSED THROUGH API
2093 function handle_set_entries($module_name, $name_value_lists, $select_fields = FALSE) {
2094         global $beanList, $beanFiles, $app_list_strings, $current_user;
2095
2096         $error = new SoapError();
2097         $ret_values = array();
2098
2099         if(empty($beanList[$module_name])){
2100                 $error->set_error('no_module');
2101                 return array('ids'=>array(), 'error'=>$error->get_soap_array());
2102         }
2103
2104     if(!check_modules_access($current_user, $module_name, 'write')){
2105                 $error->set_error('no_access');
2106                 return array('ids'=>-1, 'error'=>$error->get_soap_array());
2107         }
2108
2109         $class_name = $beanList[$module_name];
2110         require_once($beanFiles[$class_name]);
2111         $ids = array();
2112         $count = 1;
2113         $total = sizeof($name_value_lists);
2114
2115         foreach($name_value_lists as $name_value_list){
2116                 $seed = new $class_name();
2117
2118                 $seed->update_vcal = false;
2119
2120         //See if we can retrieve the seed by a given id value
2121                 foreach($name_value_list as $value)
2122         {
2123                         if($value['name'] == 'id')
2124             {
2125                                 $seed->retrieve($value['value']);
2126                                 break;
2127                         }
2128                 }
2129
2130
2131         $dataValues = array();
2132
2133                 foreach($name_value_list as $value)
2134         {
2135                         $val = $value['value'];
2136
2137                         if($seed->field_name_map[$value['name']]['type'] == 'enum' || $seed->field_name_map[$value['name']]['type'] == 'radioenum')
2138             {
2139                                 $vardef = $seed->field_name_map[$value['name']];
2140                                 if(isset($app_list_strings[$vardef['options']]) && !isset($app_list_strings[$vardef['options']][$val]) )
2141                 {
2142                             if ( in_array($val,$app_list_strings[$vardef['options']]) )
2143                     {
2144                                 $val = array_search($val,$app_list_strings[$vardef['options']]);
2145                             }
2146                         }
2147
2148                         } else if($seed->field_name_map[$value['name']]['type'] == 'multienum') {
2149
2150                 $vardef = $seed->field_name_map[$value['name']];
2151
2152                 if(isset($app_list_strings[$vardef['options']]) && !isset($app_list_strings[$vardef['options']][$value]) )
2153                 {
2154                                         $items = explode(",", $val);
2155                                         $parsedItems = array();
2156                                         foreach ($items as $item)
2157                     {
2158                                                 if ( in_array($item, $app_list_strings[$vardef['options']]) )
2159                         {
2160                                                         $keyVal = array_search($item,$app_list_strings[$vardef['options']]);
2161                                                         array_push($parsedItems, $keyVal);
2162                                                 }
2163                                         }
2164
2165                                 if (!empty($parsedItems))
2166                     {
2167                                                 $val = encodeMultienumValue($parsedItems);
2168                                 }
2169                         }
2170                         }
2171
2172             //Apply the non-empty values now since this will be used for duplicate checks
2173             //allow string or int of 0 to be updated if set.
2174             if(!empty($val) || ($val==='0' || $val===0))
2175             {
2176                 $seed->$value['name'] = $val;
2177             }
2178             //Store all the values in dataValues Array to apply later
2179             $dataValues[$value['name']] = $val;
2180                 }
2181
2182                 if($count == $total)
2183         {
2184                         $seed->update_vcal = false;
2185                 }
2186                 $count++;
2187
2188                 //Add the account to a contact
2189                 if($module_name == 'Contacts'){
2190                         $GLOBALS['log']->debug('Creating Contact Account');
2191                         add_create_account($seed);
2192                         $duplicate_id = check_for_duplicate_contacts($seed);
2193                         if($duplicate_id == null)
2194             {
2195                                 if($seed->ACLAccess('Save') && ($seed->deleted != 1 || $seed->ACLAccess('Delete')))
2196                 {
2197                     //Now apply the values, since this is not a duplicate we can just pass false for the $firstSync argument
2198                     apply_values($seed, $dataValues, false);
2199                                         $seed->save();
2200                                         if($seed->deleted == 1){
2201                                                 $seed->mark_deleted($seed->id);
2202                                         }
2203                                         $ids[] = $seed->id;
2204                                 }
2205                         }else{
2206                                 //since we found a duplicate we should set the sync flag
2207                                 if( $seed->ACLAccess('Save'))
2208                 {
2209                     //Determine if this is a first time sync.  We find out based on whether or not a contacts_users relationship exists
2210                     $seed->id = $duplicate_id;
2211                     $seed->load_relationship("user_sync");
2212                     $beans = $seed->user_sync->getBeans();
2213                     $first_sync = empty($beans);
2214
2215                     //Now apply the values and indicate whether or not this is a first time sync
2216                     apply_values($seed, $dataValues, $first_sync);
2217                                         $seed->contacts_users_id = $current_user->id;
2218                                         $seed->save();
2219                                         $ids[] = $duplicate_id;//we have a conflict
2220                                 }
2221                         }
2222
2223         } else if($module_name == 'Meetings' || $module_name == 'Calls'){
2224                         //we are going to check if we have a meeting in the system
2225                         //with the same outlook_id. If we do find one then we will grab that
2226                         //id and save it
2227                         if( $seed->ACLAccess('Save') && ($seed->deleted != 1 || $seed->ACLAccess('Delete'))){
2228                                 if(empty($seed->id) && !isset($seed->id)){
2229                                         if(!empty($seed->outlook_id) && isset($seed->outlook_id)){
2230                                                 //at this point we have an object that does not have
2231                                                 //the id set, but does have the outlook_id set
2232                                                 //so we need to query the db to find if we already
2233                                                 //have an object with this outlook_id, if we do
2234                                                 //then we can set the id, otherwise this is a new object
2235                                                 $order_by = "";
2236                                                 $query = $seed->table_name.".outlook_id = '".$seed->outlook_id."'";
2237                                                 $response = $seed->get_list($order_by, $query, 0,-1,-1,0);
2238                                                 $list = $response['list'];
2239                                                 if(count($list) > 0){
2240                                                         foreach($list as $value)
2241                                                         {
2242                                                                 $seed->id = $value->id;
2243                                                                 break;
2244                                                         }
2245                                                 }//fi
2246                                         }//fi
2247                                 }//fi
2248                                 if (empty($seed->reminder_time)) {
2249                     $seed->reminder_time = -1;
2250                 }
2251                                 if($seed->reminder_time == -1){
2252                                         $defaultRemindrTime = $current_user->getPreference('reminder_time');
2253                                         if ($defaultRemindrTime != -1){
2254                         $seed->reminder_checked = '1';
2255                         $seed->reminder_time = $defaultRemindrTime;
2256                                         }
2257                                 }
2258                                 $seed->save();
2259                                 if ($seed->deleted == 1) {
2260                                         $seed->mark_deleted($seed->id);
2261                                 }
2262                                 $ids[] = $seed->id;
2263                         }//fi
2264                 }
2265                 else
2266                 {
2267                         if( $seed->ACLAccess('Save') && ($seed->deleted != 1 || $seed->ACLAccess('Delete'))){
2268                                 $seed->save();
2269                                 $ids[] = $seed->id;
2270                         }
2271                 }
2272
2273                 // if somebody is calling set_entries_detail() and wants fields returned...
2274                 if ($select_fields !== FALSE) {
2275                         $ret_values[$count] = array();
2276
2277                         foreach ($select_fields as $select_field) {
2278                                 if (isset($seed->$select_field)) {
2279                                         $ret_values[$count][] = get_name_value($select_field, $seed->$select_field);
2280                                 }
2281                         }
2282                 }
2283         }
2284
2285         // handle returns for set_entries_detail() and set_entries()
2286         if ($select_fields !== FALSE) {
2287                 return array(
2288                         'name_value_lists' => $ret_values,
2289                         'error' => $error->get_soap_array()
2290                 );
2291         }
2292         else {
2293                 return array(
2294                         'ids' => $ids,
2295                         'error' => $error->get_soap_array()
2296                 );
2297         }
2298 }
2299