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