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     if (isset($related_mod->custom_fields)) {
1183         $customJoin = $related_mod->custom_fields->getJOIN();
1184         $sql .= $customJoin ? $customJoin['join'] : '';
1185     }
1186
1187         $sql .= " WHERE {$related_mod->table_name}.id IN ({$in}) ";
1188
1189         if (!empty($related_module_query)) {
1190                 $sql .= " AND ( {$related_module_query} )";
1191         }
1192
1193         $result = $related_mod->db->query($sql);
1194         while ($row = $related_mod->db->fetchByAssoc($result)) {
1195                 $list[] = $row['id'];
1196         }
1197
1198         $return_list = array();
1199
1200         foreach($list as $id) {
1201                 $related_class_name = $beanList[$related_module];
1202                 $related_mod = new $related_class_name();
1203                 $related_mod->retrieve($id);
1204
1205                 $return_list[] = array(
1206                         'id' => $id,
1207                         'date_modified' => $related_mod->date_modified,
1208                         'deleted' => $related_mod->deleted
1209                 );
1210         }
1211
1212         return array('ids' => $return_list, 'error' => $error->get_soap_array());
1213 }
1214
1215
1216 $server->register(
1217     'set_relationship',
1218     array('session'=>'xsd:string','set_relationship_value'=>'tns:set_relationship_value'),
1219     array('return'=>'tns:error_value'),
1220     $NAMESPACE);
1221
1222 /**
1223  * Set a single relationship between two beans.  The items are related by module name and id.
1224  *
1225  * @param String $session -- Session ID returned by a previous call to login.
1226  * @param Array $set_relationship_value --
1227  *      '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)..
1228  *      'module1_id' -- The ID of the bean in the specified module
1229  *      '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)..
1230  *      'module2_id' -- The ID of the bean in the specified module
1231  * @return Empty error on success, Error on failure
1232  */
1233 function set_relationship($session, $set_relationship_value){
1234         $error = new SoapError();
1235         if(!validate_authenticated($session)){
1236                 $error->set_error('invalid_login');
1237                 return $error->get_soap_array();
1238         }
1239         return handle_set_relationship($set_relationship_value, $session);
1240 }
1241
1242 $server->register(
1243     'set_relationships',
1244     array('session'=>'xsd:string','set_relationship_list'=>'tns:set_relationship_list'),
1245     array('return'=>'tns:set_relationship_list_result'),
1246     $NAMESPACE);
1247
1248 /**
1249  * Setup several relationships between pairs of beans.  The items are related by module name and id.
1250  *
1251  * @param String $session -- Session ID returned by a previous call to login.
1252  * @param Array $set_relationship_list -- One for each relationship to setup.  Each entry is itself an array.
1253  *      '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)..
1254  *      'module1_id' -- The ID of the bean in the specified module
1255  *      '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)..
1256  *      'module2_id' -- The ID of the bean in the specified module
1257  * @return Empty error on success, Error on failure
1258  */
1259 function set_relationships($session, $set_relationship_list){
1260         $error = new SoapError();
1261         if(!validate_authenticated($session)){
1262                 $error->set_error('invalid_login');
1263                 return -1;
1264         }
1265         $count = 0;
1266         $failed = 0;
1267         foreach($set_relationship_list as $set_relationship_value){
1268                 $reter = handle_set_relationship($set_relationship_value, $session);
1269                 if($reter['number'] == 0){
1270                         $count++;
1271                 }else{
1272                         $failed++;
1273                 }
1274         }
1275         return array('created'=>$count , 'failed'=>$failed, 'error'=>$error);
1276 }
1277
1278
1279
1280 //INTERNAL FUNCTION NOT EXPOSED THROUGH SOAP
1281 /**
1282  * (Internal) Create a relationship between two beans.
1283  *
1284  * @param Array $set_relationship_value --
1285  *      '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)..
1286  *      'module1_id' -- The ID of the bean in the specified module
1287  *      '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)..
1288  *      'module2_id' -- The ID of the bean in the specified module
1289  * @return Empty error on success, Error on failure
1290  */
1291 function handle_set_relationship($set_relationship_value, $session='')
1292 {
1293     global  $beanList, $beanFiles;
1294     $error = new SoapError();
1295
1296     $module1 = $set_relationship_value['module1'];
1297     $module1_id = $set_relationship_value['module1_id'];
1298     $module2 = $set_relationship_value['module2'];
1299     $module2_id = $set_relationship_value['module2_id'];
1300
1301     if(empty($beanList[$module1]) || empty($beanList[$module2]) )
1302     {
1303         $error->set_error('no_module');
1304         return $error->get_soap_array();
1305     }
1306     $class_name = $beanList[$module1];
1307     require_once($beanFiles[$class_name]);
1308     $mod = new $class_name();
1309     $mod->retrieve($module1_id);
1310         if(!$mod->ACLAccess('DetailView')){
1311                 $error->set_error('no_access');
1312                 return $error->get_soap_array();
1313         }
1314         if($module1 == "Contacts" && $module2 == "Users"){
1315                 $key = 'contacts_users_id';
1316         }
1317         else{
1318         $key = array_search(strtolower($module2),$mod->relationship_fields);
1319         if(!$key) {
1320             $key = Relationship::retrieve_by_modules($module1, $module2, $GLOBALS['db']);
1321
1322             // BEGIN SnapLogic fix for bug 32064
1323             if ($module1 == "Quotes" && $module2 == "ProductBundles") {
1324                 // Alternative solution is perhaps to
1325                 // do whatever Sugar does when the same
1326                 // request is received from the web:
1327                 $pb_cls = $beanList[$module2];
1328                 $pb = new $pb_cls();
1329                 $pb->retrieve($module2_id);
1330
1331                 // Check if this relationship already exists
1332                 $query = "SELECT count(*) AS count FROM product_bundle_quote WHERE quote_id = '{$module1_id}' AND bundle_id = '{$module2_id}' AND deleted = '0'";
1333                 $result = $GLOBALS['db']->query($query, true, "Error checking for previously existing relationship between quote and product_bundle");
1334                 $row = $GLOBALS['db']->fetchByAssoc($result);
1335                 if(isset($row['count']) && $row['count'] > 0){
1336                     return $error->get_soap_array();
1337                 }
1338
1339                 $query = "SELECT MAX(bundle_index)+1 AS idx FROM product_bundle_quote WHERE quote_id = '{$module1_id}' AND deleted='0'";
1340                 $result = $GLOBALS['db']->query($query, true, "Error getting bundle_index");
1341                 $GLOBALS['log']->debug("*********** Getting max bundle_index");
1342                 $GLOBALS['log']->debug($query);
1343                 $row = $GLOBALS['db']->fetchByAssoc($result);
1344
1345                 $idx = 0;
1346                 if ($row) {
1347                     $idx = $row['idx'];
1348                 }
1349
1350                 $pb->set_productbundle_quote_relationship($module1_id,$module2_id,$idx);
1351                 $pb->save();
1352                 return $error->get_soap_array();
1353
1354             } else if ($module1 == "ProductBundles" && $module2 == "Products") {
1355                 // And, well, similar things apply in this case
1356                 $pb_cls = $beanList[$module1];
1357                 $pb = new $pb_cls();
1358                 $pb->retrieve($module1_id);
1359
1360                 // Check if this relationship already exists
1361                 $query = "SELECT count(*) AS count FROM product_bundle_product WHERE bundle_id = '{$module1_id}' AND product_id = '{$module2_id}' AND deleted = '0'";
1362                 $result = $GLOBALS['db']->query($query, true, "Error checking for previously existing relationship between quote and product_bundle");
1363                 $row = $GLOBALS['db']->fetchByAssoc($result);
1364                 if(isset($row['count']) && $row['count'] > 0){
1365                     return $error->get_soap_array();
1366                 }
1367
1368                 $query = "SELECT MAX(product_index)+1 AS idx FROM product_bundle_product WHERE bundle_id='{$module1_id}'";
1369                 $result = $GLOBALS['db']->query($query, true, "Error getting bundle_index");
1370                 $GLOBALS['log']->debug("*********** Getting max bundle_index");
1371                 $GLOBALS['log']->debug($query);
1372                 $row = $GLOBALS['db']->fetchByAssoc($result);
1373
1374                 $idx = 0;
1375                 if ($row) {
1376                     $idx = $row['idx'];
1377                 }
1378                 $pb->set_productbundle_product_relationship($module2_id,$idx,$module1_id);
1379                 $pb->save();
1380
1381                 $prod_cls = $beanList[$module2];
1382                 $prod = new $prod_cls();
1383                 $prod->retrieve($module2_id);
1384                 $prod->quote_id = $pb->quote_id;
1385                 $prod->save();
1386                 return $error->get_soap_array();
1387             }
1388             // END SnapLogic fix for bug 32064
1389
1390                 if (!empty($key)) {
1391                         $mod->load_relationship($key);
1392                         $mod->$key->add($module2_id);
1393                         return $error->get_soap_array();
1394                 } // if
1395         }
1396     }
1397
1398     if(!$key)
1399     {
1400         $error->set_error('no_module');
1401         return $error->get_soap_array();
1402     }
1403
1404     if(($module1 == 'Meetings' || $module1 == 'Calls') && ($module2 == 'Contacts' || $module2 == 'Users')){
1405         $key = strtolower($module2);
1406         $mod->load_relationship($key);
1407         $mod->$key->add($module2_id);
1408     }
1409     else if ($module1 == 'Contacts' && ($module2 == 'Notes' || $module2 == 'Calls' || $module2 == 'Meetings' || $module2 == 'Tasks') && !empty($session)){
1410         $mod->$key = $module2_id;
1411         $mod->save_relationship_changes(false);
1412         if (!empty($mod->account_id)) {
1413             // when setting a relationship from a Contact to these activities, if the Contacts is related to an Account,
1414             // we want to associate that Account to the activity as well
1415             $ret = set_relationship($session, array('module1'=>'Accounts', 'module1_id'=>$mod->account_id, 'module2'=>$module2, 'module2_id'=>$module2_id));
1416         }
1417     }
1418     else{
1419         $mod->$key = $module2_id;
1420         $mod->save_relationship_changes(false);
1421     }
1422
1423     return $error->get_soap_array();
1424 }
1425
1426
1427 $server->register(
1428         'set_document_revision',
1429         array('session'=>'xsd:string','note'=>'tns:document_revision'),
1430         array('return'=>'tns:set_entry_result'),
1431         $NAMESPACE);
1432
1433 /**
1434  * Enter description here...
1435  *
1436  * @param String $session -- Session ID returned by a previous call to login.
1437  * @param unknown_type $document_revision
1438  * @return unknown
1439  */
1440 function set_document_revision($session,$document_revision)
1441 {
1442
1443         $error = new SoapError();
1444         if(!validate_authenticated($session)){
1445                 $error->set_error('invalid_login');
1446                 return array('id'=>-1, 'error'=>$error->get_soap_array());
1447         }
1448
1449         require_once('modules/Documents/DocumentSoap.php');
1450         $dr = new DocumentSoap();
1451         return array('id'=>$dr->saveFile($document_revision), 'error'=>$error->get_soap_array());
1452
1453 }
1454
1455 $server->register(
1456         'search_by_module',
1457         array('user_name'=>'xsd:string','password'=>'xsd:string','search_string'=>'xsd:string', 'modules'=>'tns:select_fields', 'offset'=>'xsd:int', 'max_results'=>'xsd:int'),
1458         array('return'=>'tns:get_entry_list_result'),
1459         $NAMESPACE);
1460
1461 /**
1462  * Given a list of modules to search and a search string, return the id, module_name, along with the fields
1463  * as specified in the $query_array
1464  *
1465  * @param string $user_name             - username of the Sugar User
1466  * @param string $password                      - password of the Sugar User
1467  * @param string $search_string         - string to search
1468  * @param string[] $modules                     - array of modules to query
1469  * @param int $offset                           - a specified offset in the query
1470  * @param int $max_results                      - max number of records to return
1471  * @return get_entry_list_result        - id, module_name, and list of fields from each record
1472  */
1473 function search_by_module($user_name, $password, $search_string, $modules, $offset, $max_results){
1474         global  $beanList, $beanFiles;
1475
1476         $error = new SoapError();
1477     $hasLoginError = false;
1478
1479     if(empty($user_name) && !empty($password))
1480     {
1481         if(!validate_authenticated($password))
1482         {
1483             $hasLoginError = true;
1484         }
1485     } else if(!validate_user($user_name, $password)) {
1486                 $hasLoginError = true;
1487         }
1488
1489     //If there is a login error, then return the error here
1490     if($hasLoginError)
1491     {
1492         $error->set_error('invalid_login');
1493         return array('result_count'=>-1, 'entry_list'=>array(), 'error'=>$error->get_soap_array());
1494     }
1495
1496         global $current_user;
1497         if($max_results > 0){
1498                 global $sugar_config;
1499                 $sugar_config['list_max_entries_per_page'] = $max_results;
1500         }
1501         //  MRF - BUG:19552 - added a join for accounts' emails below
1502         $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"),
1503                                 'Bugs'=>array('where'=>array('Bugs' => array(0 => "bugs.name like '{0}%'", 1 => "bugs.bug_number = {0}")),'fields'=>"bugs.id, bugs.name, bugs.bug_number"),
1504                                                         'Cases'=>array('where'=>array('Cases' => array(0 => "cases.name like '{0}%'", 1 => "cases.case_number = {0}")),'fields'=>"cases.id, cases.name, cases.case_number"),
1505                                                         '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"),
1506                                                         'Project'=>array('where'=>array('Project' => array(0 => "project.name like '{0}%'")), 'fields'=>"project.id, project.name"),
1507                             'ProjectTask'=>array('where'=>array('ProjectTask' => array(0 => "project.id = '{0}'")), 'fields'=>"project_task.id, project_task.name"),
1508                                                         '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"),
1509                                                         'Opportunities'=>array('where'=>array('Opportunities' => array(0 => "opportunities.name like '{0}%'")), 'fields'=>"opportunities.id, opportunities.name"),
1510                                                         'Users'=>array('where'=>array('EmailAddresses' => array(0 => "ea.email_address like '{0}%'")),'fields'=>"users.id, users.user_name, users.first_name, ea.email_address"),
1511                                                 );
1512
1513         if(!empty($search_string) && isset($search_string)){
1514                 foreach($modules as $module_name){
1515                         $class_name = $beanList[$module_name];
1516                         require_once($beanFiles[$class_name]);
1517                         $seed = new $class_name();
1518                         if(empty($beanList[$module_name])){
1519                                 continue;
1520                         }
1521                         if(!check_modules_access($current_user, $module_name, 'read')){
1522                                 continue;
1523                         }
1524                         if(! $seed->ACLAccess('ListView'))
1525                         {
1526                                 continue;
1527                         }
1528
1529                         if(isset($query_array[$module_name])){
1530                                 $query = '';
1531                                 $tmpQuery = '';
1532                                 //split here to do while loop
1533                                 foreach($query_array[$module_name]['where'] as $key => $value){
1534                                         foreach($value as $where_clause){
1535                                                 $addQuery = true;
1536                                                 if(!empty($query))
1537                                                         $tmpQuery = ' UNION ';
1538                                                 $tmpQuery .= "SELECT ".$query_array[$module_name]['fields']." FROM $seed->table_name ";
1539                                                 // We need to confirm that the user is a member of the team of the item.
1540
1541
1542                                 if($module_name == 'ProjectTask'){
1543                                     $tmpQuery .= "INNER JOIN project ON $seed->table_name.project_id = project.id ";
1544                                 }
1545
1546                                 if(isset($seed->emailAddress) && $key == 'EmailAddresses'){
1547                                         $tmpQuery .= " INNER JOIN email_addr_bean_rel eabl  ON eabl.bean_id = $seed->table_name.id and eabl.deleted=0";
1548                                         $tmpQuery .= " INNER JOIN email_addresses ea ON (ea.id = eabl.email_address_id) ";
1549                                 }
1550                                                 $where = "WHERE (";
1551                                                 $search_terms = explode(", ", $search_string);
1552                                                 $termCount = count($search_terms);
1553                                                 $count = 1;
1554                                                 if($key != 'EmailAddresses'){
1555                                                         foreach($search_terms as $term){
1556                                                                 if(!strpos($where_clause, 'number')){
1557                                                                         $where .= string_format($where_clause,array($GLOBALS['db']->quote($term)));
1558                                                                 }elseif(is_numeric($term)){
1559                                                                         $where .= string_format($where_clause,array($GLOBALS['db']->quote($term)));
1560                                                                 }else{
1561                                                                         $addQuery = false;
1562                                                                 }
1563                                                                 if($count < $termCount){
1564                                                                         $where .= " OR ";
1565                                                                 }
1566                                                                 $count++;
1567                                                         }
1568                                                 }else{
1569                             $where .= '(';
1570                             foreach ($search_terms as $term)
1571                             {
1572                                 $where .= "ea.email_address LIKE '".$GLOBALS['db']->quote($term)."'";
1573                                 if ($count < $termCount)
1574                                 {
1575                                     $where .= " OR ";
1576                                 }
1577                                 $count++;
1578                             }
1579                             $where .= ')';
1580                                                 }
1581                                                 $tmpQuery .= $where;
1582                                                 $tmpQuery .= ") AND $seed->table_name.deleted = 0";
1583                                                 if($addQuery)
1584                                                         $query .= $tmpQuery;
1585                                         }
1586                                 }
1587                                 //grab the items from the db
1588                                 $result = $seed->db->query($query, $offset, $max_results);
1589
1590                                 while(($row = $seed->db->fetchByAssoc($result)) != null){
1591                                         $list = array();
1592                                         $fields = explode(", ", $query_array[$module_name]['fields']);
1593                                         foreach($fields as $field){
1594                                                 $field_names = explode(".", $field);
1595                                                 $list[$field] = array('name'=>$field_names[1], 'value'=>$row[$field_names[1]]);
1596                                         }
1597
1598                                         $output_list[] = array('id'=>$row['id'],
1599                                                                            'module_name'=>$module_name,
1600                                                                            'name_value_list'=>$list);
1601                                         if(empty($field_list)){
1602                                                 $field_list = get_field_list($row);
1603                                         }
1604                                 }//end while
1605                         }
1606                 }//end foreach
1607         }
1608
1609         $next_offset = $offset + sizeof($output_list);
1610
1611         return array('result_count'=>sizeof($output_list), 'next_offset'=>$next_offset,'field_list'=>$field_list, 'entry_list'=>$output_list, 'error'=>$error->get_soap_array());
1612
1613 }//end function
1614
1615
1616 $server->register(
1617 'get_mailmerge_document',
1618 array('session'=>'xsd:string','file_name'=>'xsd:string', 'fields' => 'tns:select_fields'),
1619 array('return'=>'tns:get_sync_result_encoded'),
1620 $NAMESPACE);
1621
1622 /**
1623  * Get MailMerge document
1624  *
1625  * @param String $session -- Session ID returned by a previous call to login.
1626  * @param unknown_type $file_name
1627  * @param unknown_type $fields
1628  * @return unknown
1629  */
1630 function get_mailmerge_document($session, $file_name, $fields)
1631 {
1632     global  $beanList, $beanFiles, $app_list_strings;
1633     $error = new SoapError();
1634     if(!validate_authenticated($session))
1635     {
1636         $error->set_error('invalid_login');
1637         return array('result'=>'', 'error'=>$error->get_soap_array());
1638     }
1639     if(!preg_match('/^sugardata[\.\d\s]+\.php$/', $file_name)) {
1640         $error->set_error('no_records');
1641         return array('result'=>'', 'error'=>$error->get_soap_array());
1642     }
1643     $html = '';
1644
1645     $file_name = sugar_cached('MergedDocuments/').pathinfo($file_name, PATHINFO_BASENAME);
1646
1647     $master_fields = array();
1648     $related_fields = array();
1649
1650     if(file_exists($file_name))
1651     {
1652         include($file_name);
1653
1654         $class1 = $merge_array['master_module'];
1655         $beanL = $beanList[$class1];
1656         $bean1 = $beanFiles[$beanL];
1657         require_once($bean1);
1658         $seed1 = new $beanL();
1659
1660         if(!empty($merge_array['related_module']))
1661         {
1662             $class2 = $merge_array['related_module'];
1663             $beanR = $beanList[$class2];
1664             $bean2 = $beanFiles[$beanR];
1665             require_once($bean2);
1666             $seed2 = new $beanR();
1667         }
1668
1669         //parse fields
1670         //$token1 = strtolower($class1);
1671         if($class1 == 'Prospects'){
1672             $class1 = 'CampaignProspects';
1673         }
1674         foreach($fields as $field)
1675         {
1676             $pos = strpos(strtolower($field), strtolower($class1));
1677             $pos2 = strpos(strtolower($field), strtolower($class2));
1678             if($pos !== false){
1679                 $fieldName = str_replace(strtolower($class1).'_', '', strtolower($field));
1680                 array_push($master_fields, $fieldName);
1681             }else if($pos2 !== false){
1682                 $fieldName = str_replace(strtolower($class2).'_', '', strtolower($field));
1683                 array_push($related_fields, $fieldName);
1684             }
1685         }
1686
1687         $html = '<html ' . get_language_header() .'><body><table border = 1><tr>';
1688
1689         foreach($master_fields as $master_field){
1690             $html .= '<td>'.$class1.'_'.$master_field.'</td>';
1691         }
1692         foreach($related_fields as $related_field){
1693             $html .= '<td>'.$class2.'_'.$related_field.'</td>';
1694         }
1695         $html .= '</tr>';
1696
1697         $ids = $merge_array['ids'];
1698         $is_prospect_merge = ($seed1->object_name == 'Prospect');
1699         foreach($ids as $key=>$value){
1700             if($is_prospect_merge){
1701                 $seed1 = $seed1->retrieveTarget($key);
1702             }else{
1703                 $seed1->retrieve($key);
1704             }
1705             $html .= '<tr>';
1706             foreach($master_fields as $master_field){
1707                 if(isset($seed1->$master_field)){
1708                     if($seed1->field_name_map[$master_field]['type'] == 'enum'){
1709                         //pull in the translated dom
1710                          $html .='<td>'.$app_list_strings[$seed1->field_name_map[$master_field]['options']][$seed1->$master_field].'</td>';
1711                     }else{
1712                         $html .='<td>'.$seed1->$master_field.'</td>';
1713                     }
1714                 }
1715                 else{
1716                     $html .= '<td></td>';
1717                     }
1718             }
1719             if(isset($value) && !empty($value)){
1720                 $seed2->retrieve($value);
1721                 foreach($related_fields as $related_field){
1722                     if(isset($seed2->$related_field)){
1723                         if($seed2->field_name_map[$related_field]['type'] == 'enum'){
1724                             //pull in the translated dom
1725                             $html .='<td>'.$app_list_strings[$seed2->field_name_map[$related_field]['options']][$seed2->$related_field].'</td>';
1726                         }else{
1727                             $html .= '<td>'.$seed2->$related_field.'</td>';
1728                         }
1729                     }
1730                     else{
1731                         $html .= '<td></td>';
1732                     }
1733                 }
1734             }
1735             $html .= '</tr>';
1736         }
1737         $html .= "</table></body></html>";
1738      }
1739
1740     $result = base64_encode($html);
1741     return array('result' => $result, 'error' => $error);
1742 }
1743
1744 $server->register(
1745 'get_mailmerge_document2',
1746 array('session'=>'xsd:string','file_name'=>'xsd:string', 'fields' => 'tns:select_fields'),
1747 array('return'=>'tns:get_mailmerge_document_result'),
1748 $NAMESPACE);
1749
1750 /**
1751  * Enter description here...
1752  *
1753  * @param String $session -- Session ID returned by a previous call to login.
1754  * @param unknown_type $file_name
1755  * @param unknown_type $fields
1756  * @return unknown
1757  */
1758 function get_mailmerge_document2($session, $file_name, $fields)
1759 {
1760     global  $beanList, $beanFiles, $app_list_strings, $app_strings;
1761
1762     $error = new SoapError();
1763     if(!validate_authenticated($session))
1764     {
1765         $GLOBALS['log']->error('invalid_login');
1766         $error->set_error('invalid_login');
1767         return array('result'=>'', 'error'=>$error->get_soap_array());
1768     }
1769     if(!preg_match('/^sugardata[\.\d\s]+\.php$/', $file_name)) {
1770         $GLOBALS['log']->error($app_strings['ERR_NO_SUCH_FILE'] . " ({$file_name})");
1771         $error->set_error('no_records');
1772         return array('result'=>'', 'error'=>$error->get_soap_array());
1773     }
1774     $html = '';
1775
1776     $file_name = sugar_cached('MergedDocuments/').pathinfo($file_name, PATHINFO_BASENAME);
1777
1778     $master_fields = array();
1779     $related_fields = array();
1780
1781     if(file_exists($file_name))
1782     {
1783         include($file_name);
1784
1785         $class1 = $merge_array['master_module'];
1786         $beanL = $beanList[$class1];
1787         $bean1 = $beanFiles[$beanL];
1788         require_once($bean1);
1789         $seed1 = new $beanL();
1790
1791         if(!empty($merge_array['related_module']))
1792         {
1793             $class2 = $merge_array['related_module'];
1794             $beanR = $beanList[$class2];
1795             $bean2 = $beanFiles[$beanR];
1796             require_once($bean2);
1797             $seed2 = new $beanR();
1798         }
1799
1800         //parse fields
1801         //$token1 = strtolower($class1);
1802         if($class1 == 'Prospects'){
1803             $class1 = 'CampaignProspects';
1804         }
1805         foreach($fields as $field)
1806         {
1807                 $pos = strpos(strtolower($field), strtolower($class1));
1808             $pos2 = strpos(strtolower($field), strtolower($class2));
1809             if($pos !== false){
1810                 $fieldName = str_replace(strtolower($class1).'_', '', strtolower($field));
1811                 array_push($master_fields, $fieldName);
1812             }else if($pos2 !== false){
1813                 $fieldName = str_replace(strtolower($class2).'_', '', strtolower($field));
1814                 array_push($related_fields, $fieldName);
1815             }
1816         }
1817
1818         $html = '<html ' . get_language_header() . '><body><table border = 1><tr>';
1819
1820         foreach($master_fields as $master_field){
1821             $html .= '<td>'.$class1.'_'.$master_field.'</td>';
1822         }
1823         foreach($related_fields as $related_field){
1824             $html .= '<td>'.$class2.'_'.$related_field.'</td>';
1825         }
1826         $html .= '</tr>';
1827
1828         $ids = $merge_array['ids'];
1829         $resultIds = array();
1830         $is_prospect_merge = ($seed1->object_name == 'Prospect');
1831         if($is_prospect_merge){
1832                 $pSeed = $seed1;
1833         }
1834         foreach($ids as $key=>$value){
1835
1836             if($is_prospect_merge){
1837                 $seed1 = $pSeed->retrieveTarget($key);
1838             }else{
1839                 $seed1->retrieve($key);
1840             }
1841              $resultIds[] = array('name' => $seed1->module_name, 'value' => $key);
1842             $html .= '<tr>';
1843             foreach($master_fields as $master_field){
1844                 if(isset($seed1->$master_field)){
1845                     if($seed1->field_name_map[$master_field]['type'] == 'enum'){
1846                         //pull in the translated dom
1847                          $html .='<td>'.$app_list_strings[$seed1->field_name_map[$master_field]['options']][$seed1->$master_field].'</td>';
1848                     } else if ($seed1->field_name_map[$master_field]['type'] == 'multienum') {
1849
1850                         if(isset($app_list_strings[$seed1->field_name_map[$master_field]['options']]) )
1851                         {
1852                             $items = unencodeMultienum($seed1->$master_field);
1853                             $output = array();
1854                             foreach($items as $item) {
1855                                 if ( !empty($app_list_strings[$seed1->field_name_map[$master_field]['options']][$item]) )
1856                                 {
1857                                     array_push($output, $app_list_strings[$seed1->field_name_map[$master_field]['options']][$item]);
1858
1859                                 }
1860
1861                             } // foreach
1862
1863                             $encoded_output = encodeMultienumValue($output);
1864                             $html .= "<td>$encoded_output</td>";
1865
1866                         }
1867                     } else {
1868                        $html .='<td>'.$seed1->$master_field.'</td>';
1869                     }
1870                 }
1871                 else{
1872                     $html .= '<td></td>';
1873                     }
1874             }
1875             if(isset($value) && !empty($value)){
1876                 $resultIds[] = array('name' => $seed2->module_name, 'value' => $value);
1877                                 $seed2->retrieve($value);
1878                 foreach($related_fields as $related_field){
1879                     if(isset($seed2->$related_field)){
1880                         if($seed2->field_name_map[$related_field]['type'] == 'enum'){
1881                             //pull in the translated dom
1882                             $html .='<td>'.$app_list_strings[$seed2->field_name_map[$related_field]['options']][$seed2->$related_field].'</td>';
1883                         }else{
1884                             $html .= '<td>'.$seed2->$related_field.'</td>';
1885                         }
1886                     }
1887                     else{
1888                         $html .= '<td></td>';
1889                     }
1890                 }
1891             }
1892             $html .= '</tr>';
1893         }
1894         $html .= "</table></body></html>";
1895      }
1896     $result = base64_encode($html);
1897
1898     return array('html' => $result, 'name_value_list' => $resultIds, 'error' => $error);
1899 }
1900
1901 $server->register(
1902         'get_document_revision',
1903         array('session'=>'xsd:string','i'=>'xsd:string'),
1904         array('return'=>'tns:return_document_revision'),
1905         $NAMESPACE);
1906
1907 /**
1908  * This method is used as a result of the .htaccess lock down on the cache directory. It will allow a
1909  * properly authenticated user to download a document that they have proper rights to download.
1910  *
1911  * @param String $session -- Session ID returned by a previous call to login.
1912  * @param String $id      -- ID of the document revision to obtain
1913  * @return return_document_revision - this is a complex type as defined in SoapTypes.php
1914  */
1915 function get_document_revision($session,$id)
1916 {
1917     global $sugar_config;
1918
1919     $error = new SoapError();
1920     if(!validate_authenticated($session)){
1921         $error->set_error('invalid_login');
1922         return array('id'=>-1, 'error'=>$error->get_soap_array());
1923     }
1924
1925
1926     $dr = new DocumentRevision();
1927     $dr->retrieve($id);
1928     if(!empty($dr->filename)){
1929         $filename = "upload://{$dr->id}";
1930         $contents = base64_encode(sugar_file_get_contents($filename));
1931         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());
1932     }else{
1933         $error->set_error('no_records');
1934         return array('id'=>-1, 'error'=>$error->get_soap_array());
1935     }
1936
1937 }
1938 $server->register(
1939     'set_campaign_merge',
1940     array('session'=>'xsd:string', 'targets'=>'tns:select_fields', 'campaign_id'=>'xsd:string'),
1941     array('return'=>'tns:error_value'),
1942     $NAMESPACE);
1943 /**
1944 *   Once we have successfuly done a mail merge on a campaign, we need to notify Sugar of the targets
1945 *   and the campaign_id for tracking purposes
1946 *
1947 * @param session        the session id of the authenticated user
1948 * @param targets        a string array of ids identifying the targets used in the merge
1949 * @param campaign_id    the campaign_id used for the merge
1950 *
1951 * @return error_value
1952 */
1953 function set_campaign_merge($session,$targets, $campaign_id){
1954     $error = new SoapError();
1955     if(!validate_authenticated($session)){
1956         $error->set_error('invalid_login');
1957         return $error->get_soap_array();
1958     }
1959     if (empty($campaign_id) or !is_array($targets) or count($targets) == 0) {
1960         $GLOBALS['log']->debug('set_campaign_merge: Merge action status will not be updated, because, campaign_id is null or no targets were selected.');
1961     } else {
1962         require_once('modules/Campaigns/utils.php');
1963         campaign_log_mail_merge($campaign_id,$targets);
1964     }
1965
1966     return $error->get_soap_array();
1967 }
1968 $server->register(
1969     'get_entries_count',
1970     array('session'=>'xsd:string', 'module_name'=>'xsd:string', 'query'=>'xsd:string', 'deleted' => 'xsd:int'),
1971     array('return'=>'tns:get_entries_count_result'),
1972     $NAMESPACE);
1973
1974 /**
1975 *   Retrieve number of records in a given module
1976 *
1977 * @param session        the session id of the authenticated user
1978 * @param module_name    module to retrieve number of records from
1979 * @param query          allows webservice user to provide a WHERE clause
1980 * @param deleted        specify whether or not to include deleted records
1981 *
1982 @return get_entries_count_result - this is a complex type as defined in SoapTypes.php
1983 */
1984 function get_entries_count($session, $module_name, $query, $deleted) {
1985         global $beanList, $beanFiles, $current_user;
1986
1987         $error = new SoapError();
1988
1989         if (!validate_authenticated($session)) {
1990                 $error->set_error('invalid_login');
1991                 return array(
1992                         'result_count' => -1,
1993                         'error' => $error->get_soap_array()
1994                 );
1995         }
1996
1997         if (empty($beanList[$module_name])) {
1998                 $error->set_error('no_module');
1999                 return array(
2000                         'result_count' => -1,
2001                         'error' => $error->get_soap_array()
2002                 );
2003         }
2004
2005         if(!check_modules_access($current_user, $module_name, 'list')){
2006                 $error->set_error('no_access');
2007                 return array(
2008                         'result_count' => -1,
2009                         'error' => $error->get_soap_array()
2010                 );
2011         }
2012
2013         $class_name = $beanList[$module_name];
2014         require_once($beanFiles[$class_name]);
2015         $seed = new $class_name();
2016
2017         if (!$seed->ACLAccess('ListView')) {
2018                 $error->set_error('no_access');
2019                 return array(
2020                         'result_count' => -1,
2021                         'error' => $error->get_soap_array()
2022                 );
2023         }
2024
2025         $sql = 'SELECT COUNT(*) result_count FROM ' . $seed->table_name . ' ';
2026
2027
2028     if (isset($seed->custom_fields)) {
2029         $customJoin = $seed->custom_fields->getJOIN();
2030         $sql .= $customJoin ? $customJoin['join'] : '';
2031     }
2032
2033         // build WHERE clauses, if any
2034         $where_clauses = array();
2035         if (!empty($query)) {
2036             require_once 'include/SugarSQLValidate.php';
2037             $valid = new SugarSQLValidate();
2038             if(!$valid->validateQueryClauses($query)) {
2039             $GLOBALS['log']->error("Bad query: $query");
2040                 $error->set_error('no_access');
2041                 return array(
2042                         'result_count' => -1,
2043                         'error' => $error->get_soap_array()
2044                 );
2045             }
2046                 $where_clauses[] = $query;
2047         }
2048         if ($deleted == 0) {
2049                 $where_clauses[] = $seed->table_name . '.deleted = 0';
2050         }
2051
2052         // if WHERE clauses exist, add them to query
2053         if (!empty($where_clauses)) {
2054                 $sql .= ' WHERE ' . implode(' AND ', $where_clauses);
2055         }
2056
2057         $res = $GLOBALS['db']->query($sql);
2058         $row = $GLOBALS['db']->fetchByAssoc($res);
2059
2060         return array(
2061                 'result_count' => $row['result_count'],
2062                 'error' => $error->get_soap_array()
2063         );
2064 }
2065
2066 $server->register(
2067     'set_entries_details',
2068     array('session'=>'xsd:string', 'module_name'=>'xsd:string',  'name_value_lists'=>'tns:name_value_lists', 'select_fields' => 'tns:select_fields'),
2069     array('return'=>'tns:set_entries_detail_result'),
2070     $NAMESPACE);
2071
2072 /**
2073  * Update or create a list of SugarBeans, returning details about the records created/updated
2074  *
2075  * @param String $session -- Session ID returned by a previous call to login.
2076  * @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)..
2077  * @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.
2078  * @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.
2079  * @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.
2080  *                  'error' -- The SOAP error if any.
2081  */
2082 function set_entries_details($session, $module_name, $name_value_lists, $select_fields) {
2083         $error = new SoapError();
2084
2085         if(!validate_authenticated($session)){
2086                 $error->set_error('invalid_login');
2087
2088                 return array(
2089                         'ids' => array(),
2090                         'error' => $error->get_soap_array()
2091                 );
2092         }
2093
2094         return handle_set_entries($module_name, $name_value_lists, $select_fields);
2095 }
2096
2097 // INTERNAL FUNCTION NOT EXPOSED THROUGH API
2098 function handle_set_entries($module_name, $name_value_lists, $select_fields = FALSE) {
2099         global $beanList, $beanFiles, $app_list_strings, $current_user;
2100
2101         $error = new SoapError();
2102         $ret_values = array();
2103
2104         if(empty($beanList[$module_name])){
2105                 $error->set_error('no_module');
2106                 return array('ids'=>array(), 'error'=>$error->get_soap_array());
2107         }
2108
2109     if(!check_modules_access($current_user, $module_name, 'write')){
2110                 $error->set_error('no_access');
2111                 return array('ids'=>-1, 'error'=>$error->get_soap_array());
2112         }
2113
2114         $class_name = $beanList[$module_name];
2115         require_once($beanFiles[$class_name]);
2116         $ids = array();
2117         $count = 1;
2118         $total = sizeof($name_value_lists);
2119
2120         foreach($name_value_lists as $name_value_list){
2121                 $seed = new $class_name();
2122
2123                 $seed->update_vcal = false;
2124
2125         //See if we can retrieve the seed by a given id value
2126                 foreach($name_value_list as $value)
2127         {
2128                         if($value['name'] == 'id')
2129             {
2130                                 $seed->retrieve($value['value']);
2131                                 break;
2132                         }
2133                 }
2134
2135
2136         $dataValues = array();
2137
2138                 foreach($name_value_list as $value)
2139         {
2140                         $val = $value['value'];
2141
2142                         if($seed->field_name_map[$value['name']]['type'] == 'enum' || $seed->field_name_map[$value['name']]['type'] == 'radioenum')
2143             {
2144                                 $vardef = $seed->field_name_map[$value['name']];
2145                                 if(isset($app_list_strings[$vardef['options']]) && !isset($app_list_strings[$vardef['options']][$val]) )
2146                 {
2147                             if ( in_array($val,$app_list_strings[$vardef['options']]) )
2148                     {
2149                                 $val = array_search($val,$app_list_strings[$vardef['options']]);
2150                             }
2151                         }
2152
2153                         } else if($seed->field_name_map[$value['name']]['type'] == 'multienum') {
2154
2155                 $vardef = $seed->field_name_map[$value['name']];
2156
2157                 if(isset($app_list_strings[$vardef['options']]) && !isset($app_list_strings[$vardef['options']][$value]) )
2158                 {
2159                                         $items = explode(",", $val);
2160                                         $parsedItems = array();
2161                                         foreach ($items as $item)
2162                     {
2163                                                 if ( in_array($item, $app_list_strings[$vardef['options']]) )
2164                         {
2165                                                         $keyVal = array_search($item,$app_list_strings[$vardef['options']]);
2166                                                         array_push($parsedItems, $keyVal);
2167                                                 }
2168                                         }
2169
2170                                 if (!empty($parsedItems))
2171                     {
2172                                                 $val = encodeMultienumValue($parsedItems);
2173                                 }
2174                         }
2175                         }
2176
2177             //Apply the non-empty values now since this will be used for duplicate checks
2178             //allow string or int of 0 to be updated if set.
2179             if(!empty($val) || ($val==='0' || $val===0))
2180             {
2181                 $seed->$value['name'] = $val;
2182             }
2183             //Store all the values in dataValues Array to apply later
2184             $dataValues[$value['name']] = $val;
2185                 }
2186
2187                 if($count == $total)
2188         {
2189                         $seed->update_vcal = false;
2190                 }
2191                 $count++;
2192
2193                 //Add the account to a contact
2194                 if($module_name == 'Contacts'){
2195                         $GLOBALS['log']->debug('Creating Contact Account');
2196                         add_create_account($seed);
2197                         $duplicate_id = check_for_duplicate_contacts($seed);
2198                         if($duplicate_id == null)
2199             {
2200                                 if($seed->ACLAccess('Save') && ($seed->deleted != 1 || $seed->ACLAccess('Delete')))
2201                 {
2202                     //Now apply the values, since this is not a duplicate we can just pass false for the $firstSync argument
2203                     apply_values($seed, $dataValues, false);
2204                                         $seed->save();
2205                                         if($seed->deleted == 1){
2206                                                 $seed->mark_deleted($seed->id);
2207                                         }
2208                                         $ids[] = $seed->id;
2209                                 }
2210                         }else{
2211                                 //since we found a duplicate we should set the sync flag
2212                                 if( $seed->ACLAccess('Save'))
2213                 {
2214                     //Determine if this is a first time sync.  We find out based on whether or not a contacts_users relationship exists
2215                     $seed->id = $duplicate_id;
2216                     $seed->load_relationship("user_sync");
2217                     $beans = $seed->user_sync->getBeans();
2218                     $first_sync = empty($beans);
2219
2220                     //Now apply the values and indicate whether or not this is a first time sync
2221                     apply_values($seed, $dataValues, $first_sync);
2222                                         $seed->contacts_users_id = $current_user->id;
2223                                         $seed->save();
2224                                         $ids[] = $duplicate_id;//we have a conflict
2225                                 }
2226                         }
2227
2228         } else if($module_name == 'Meetings' || $module_name == 'Calls'){
2229                         //we are going to check if we have a meeting in the system
2230                         //with the same outlook_id. If we do find one then we will grab that
2231                         //id and save it
2232                         if( $seed->ACLAccess('Save') && ($seed->deleted != 1 || $seed->ACLAccess('Delete'))){
2233                                 if(empty($seed->id) && !isset($seed->id)){
2234                                         if(!empty($seed->outlook_id) && isset($seed->outlook_id)){
2235                                                 //at this point we have an object that does not have
2236                                                 //the id set, but does have the outlook_id set
2237                                                 //so we need to query the db to find if we already
2238                                                 //have an object with this outlook_id, if we do
2239                                                 //then we can set the id, otherwise this is a new object
2240                                                 $order_by = "";
2241                                                 $query = $seed->table_name.".outlook_id = '".$seed->outlook_id."'";
2242                                                 $response = $seed->get_list($order_by, $query, 0,-1,-1,0);
2243                                                 $list = $response['list'];
2244                                                 if(count($list) > 0){
2245                                                         foreach($list as $value)
2246                                                         {
2247                                                                 $seed->id = $value->id;
2248                                                                 break;
2249                                                         }
2250                                                 }//fi
2251                                         }//fi
2252                                 }//fi
2253                                 if (empty($seed->reminder_time)) {
2254                     $seed->reminder_time = -1;
2255                 }
2256                                 if($seed->reminder_time == -1){
2257                                         $defaultRemindrTime = $current_user->getPreference('reminder_time');
2258                                         if ($defaultRemindrTime != -1){
2259                         $seed->reminder_checked = '1';
2260                         $seed->reminder_time = $defaultRemindrTime;
2261                                         }
2262                                 }
2263                                 $seed->save();
2264                                 if ($seed->deleted == 1) {
2265                                         $seed->mark_deleted($seed->id);
2266                                 }
2267                                 $ids[] = $seed->id;
2268                         }//fi
2269                 }
2270                 else
2271                 {
2272                         if( $seed->ACLAccess('Save') && ($seed->deleted != 1 || $seed->ACLAccess('Delete'))){
2273                                 $seed->save();
2274                                 $ids[] = $seed->id;
2275                         }
2276                 }
2277
2278                 // if somebody is calling set_entries_detail() and wants fields returned...
2279                 if ($select_fields !== FALSE) {
2280                         $ret_values[$count] = array();
2281
2282                         foreach ($select_fields as $select_field) {
2283                                 if (isset($seed->$select_field)) {
2284                                         $ret_values[$count][] = get_name_value($select_field, $seed->$select_field);
2285                                 }
2286                         }
2287                 }
2288         }
2289
2290         // handle returns for set_entries_detail() and set_entries()
2291         if ($select_fields !== FALSE) {
2292                 return array(
2293                         'name_value_lists' => $ret_values,
2294                         'error' => $error->get_soap_array()
2295                 );
2296         }
2297         else {
2298                 return array(
2299                         'ids' => $ids,
2300                         'error' => $error->get_soap_array()
2301                 );
2302         }
2303 }
2304