2 if(!defined('sugarEntry'))define('sugarEntry', true);
3 /*********************************************************************************
4 * SugarCRM Community Edition is a customer relationship management program developed by
5 * SugarCRM, Inc. Copyright (C) 2004-2012 SugarCRM Inc.
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.
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
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
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.
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.
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 ********************************************************************************/
40 * This class is an implemenatation class for all the rest services
42 require_once('service/v3_1/SugarWebServiceImplv3_1.php');
43 require_once('SugarWebServiceUtilv4.php');
46 class SugarWebServiceImplv4 extends SugarWebServiceImplv3_1 {
48 public function __construct()
50 self::$helperObject = new SugarWebServiceUtilv4();
54 * Log the user into the application
56 * @param UserAuth array $user_auth -- Set user_name and password (password needs to be
57 * in the right encoding for the type of authentication the user is setup for. For Base
58 * sugar validation, password is the MD5 sum of the plain text password.
59 * @param String $application -- The name of the application you are logging in from. (Currently unused).
60 * @param array $name_value_list -- Array of name value pair of extra parameters. As of today only 'language' and 'notifyonsave' is supported
61 * @return Array - id - String id is the session_id of the session that was created.
62 * - module_name - String - module name of user
63 * - name_value_list - Array - The name value pair of user_id, user_name, user_language, user_currency_id, user_currency_name,
64 * - user_default_team_id, user_is_admin, user_default_dateformat, user_default_timeformat
65 * @exception 'SoapFault' -- The SOAP error, if any
67 public function login($user_auth, $application, $name_value_list = array()){
68 $GLOBALS['log']->info("Begin: SugarWebServiceImpl->login({$user_auth['user_name']}, $application, ". print_r($name_value_list, true) .")");
69 global $sugar_config, $system_config;
70 $error = new SoapError();
74 $system_config = new Administration();
75 $system_config->retrieveSettings('system');
76 $authController = new AuthenticationController((!empty($sugar_config['authenticationClass'])? $sugar_config['authenticationClass'] : 'SugarAuthenticate'));
78 if(!empty($user_auth['encryption']) && $user_auth['encryption'] === 'PLAIN' && $authController->authController->userAuthenticateClass != "LDAPAuthenticateUser")
80 $user_auth['password'] = md5($user_auth['password']);
82 $isLoginSuccess = $authController->login($user_auth['user_name'], $user_auth['password'], array('passwordEncrypted' => true));
83 $usr_id=$user->retrieve_user_id($user_auth['user_name']);
85 $user->retrieve($usr_id);
89 if ($_SESSION['hasExpiredPassword'] =='1')
91 $error->set_error('password_expired');
92 $GLOBALS['log']->fatal('password expired for user ' . $user_auth['user_name']);
93 LogicHook::initialize();
94 $GLOBALS['logic_hook']->call_custom_logic('Users', 'login_failed');
95 self::$helperObject->setFaultObject($error);
98 if(!empty($user) && !empty($user->id) && !$user->is_group)
101 global $current_user;
102 $current_user = $user;
105 else if($usr_id && isset($user->user_name) && ($user->getPreference('lockout') == '1'))
107 $error->set_error('lockout_reached');
108 $GLOBALS['log']->fatal('Lockout reached for user ' . $user_auth['user_name']);
109 LogicHook::initialize();
110 $GLOBALS['logic_hook']->call_custom_logic('Users', 'login_failed');
111 self::$helperObject->setFaultObject($error);
114 else if(function_exists('mcrypt_cbc') && $authController->authController->userAuthenticateClass == "LDAPAuthenticateUser"
115 && (empty($user_auth['encryption']) || $user_auth['encryption'] !== 'PLAIN' ) )
117 $password = self::$helperObject->decrypt_string($user_auth['password']);
118 $authController->loggedIn = false; // reset login attempt to try again with decrypted password
119 if($authController->login($user_auth['user_name'], $password) && isset($_SESSION['authenticated_user_id']))
122 else if( $authController->authController->userAuthenticateClass == "LDAPAuthenticateUser"
123 && (empty($user_auth['encryption']) || $user_auth['encryption'] == 'PLAIN' ) )
126 $authController->loggedIn = false; // reset login attempt to try again with md5 password
127 if($authController->login($user_auth['user_name'], md5($user_auth['password']), array('passwordEncrypted' => true))
128 && isset($_SESSION['authenticated_user_id']))
135 $error->set_error('ldap_error');
136 LogicHook::initialize();
137 $GLOBALS['logic_hook']->call_custom_logic('Users', 'login_failed');
138 self::$helperObject->setFaultObject($error);
147 global $current_user;
148 //$current_user = $user;
149 self::$helperObject->login_success($name_value_list);
150 $current_user->loadPreferences();
151 $_SESSION['is_valid_session']= true;
152 $_SESSION['ip_address'] = query_client_ip();
153 $_SESSION['user_id'] = $current_user->id;
154 $_SESSION['type'] = 'user';
155 $_SESSION['avail_modules']= self::$helperObject->get_user_module_list($current_user);
156 $_SESSION['authenticated_user_id'] = $current_user->id;
157 $_SESSION['unique_key'] = $sugar_config['unique_key'];
158 $GLOBALS['log']->info('End: SugarWebServiceImpl->login - successful login');
159 $current_user->call_custom_logic('after_login');
160 $nameValueArray = array();
161 global $current_language;
162 $nameValueArray['user_id'] = self::$helperObject->get_name_value('user_id', $current_user->id);
163 $nameValueArray['user_name'] = self::$helperObject->get_name_value('user_name', $current_user->user_name);
164 $nameValueArray['user_language'] = self::$helperObject->get_name_value('user_language', $current_language);
165 $cur_id = $current_user->getPreference('currency');
166 $nameValueArray['user_currency_id'] = self::$helperObject->get_name_value('user_currency_id', $cur_id);
167 $nameValueArray['user_is_admin'] = self::$helperObject->get_name_value('user_is_admin', is_admin($current_user));
168 $nameValueArray['user_default_team_id'] = self::$helperObject->get_name_value('user_default_team_id', $current_user->default_team );
169 $nameValueArray['user_default_dateformat'] = self::$helperObject->get_name_value('user_default_dateformat', $current_user->getPreference('datef') );
170 $nameValueArray['user_default_timeformat'] = self::$helperObject->get_name_value('user_default_timeformat', $current_user->getPreference('timef') );
172 $num_grp_sep = $current_user->getPreference('num_grp_sep');
173 $dec_sep = $current_user->getPreference('dec_sep');
174 $nameValueArray['user_number_seperator'] = self::$helperObject->get_name_value('user_number_seperator', empty($num_grp_sep) ? $sugar_config['default_number_grouping_seperator'] : $num_grp_sep);
175 $nameValueArray['user_decimal_seperator'] = self::$helperObject->get_name_value('user_decimal_seperator', empty($dec_sep) ? $sugar_config['default_decimal_seperator'] : $dec_sep);
177 $nameValueArray['mobile_max_list_entries'] = self::$helperObject->get_name_value('mobile_max_list_entries', $sugar_config['wl_list_max_entries_per_page'] );
178 $nameValueArray['mobile_max_subpanel_entries'] = self::$helperObject->get_name_value('mobile_max_subpanel_entries', $sugar_config['wl_list_max_entries_per_subpanel'] );
181 $currencyObject = new Currency();
182 $currencyObject->retrieve($cur_id);
183 $nameValueArray['user_currency_name'] = self::$helperObject->get_name_value('user_currency_name', $currencyObject->name);
184 $_SESSION['user_language'] = $current_language;
185 return array('id'=>session_id(), 'module_name'=>'Users', 'name_value_list'=>$nameValueArray);
187 LogicHook::initialize();
188 $GLOBALS['logic_hook']->call_custom_logic('Users', 'login_failed');
189 $error->set_error('invalid_login');
190 self::$helperObject->setFaultObject($error);
191 $GLOBALS['log']->error('End: SugarWebServiceImpl->login - failed login');
196 * Retrieve a list of SugarBean's based on provided IDs. This API will not wotk with report module
198 * @param String $session -- Session ID returned by a previous call to login.
199 * @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)..
200 * @param Array $ids -- An array of SugarBean IDs.
201 * @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.
202 * @param Array $link_name_to_fields_array -- A list of link_names and for each link_name, what fields value to be returned. For ex.'link_name_to_fields_array' => array(array('name' => 'email_addresses', 'value' => array('id', 'email_address', 'opt_out', 'primary_address')))
204 * 'entry_list' -- Array - The records name value pair for the simple data types excluding link field data.
205 * 'relationship_list' -- Array - The records link field data. The example is if asked about accounts email address then return data would look like Array ( [0] => Array ( [name] => email_addresses [records] => Array ( [0] => Array ( [0] => Array ( [name] => id [value] => 3fb16797-8d90-0a94-ac12-490b63a6be67 ) [1] => Array ( [name] => email_address [value] => hr.kid.qa@example.com ) [2] => Array ( [name] => opt_out [value] => 0 ) [3] => Array ( [name] => primary_address [value] => 1 ) ) [1] => Array ( [0] => Array ( [name] => id [value] => 403f8da1-214b-6a88-9cef-490b63d43566 ) [1] => Array ( [name] => email_address [value] => kid.hr@example.name ) [2] => Array ( [name] => opt_out [value] => 0 ) [3] => Array ( [name] => primary_address [value] => 0 ) ) ) ) )
206 * @exception 'SoapFault' -- The SOAP error, if any
208 public function get_entries($session, $module_name, $ids, $select_fields, $link_name_to_fields_array)
210 $result = parent::get_entries($session, $module_name, $ids, $select_fields, $link_name_to_fields_array);
211 $relationshipList = $result['relationship_list'];
212 $returnRelationshipList = array();
213 foreach($relationshipList as $rel){
214 $link_output = array();
215 foreach($rel as $row){
217 foreach($row['records'] as $record){
218 $rowArray[]['link_value'] = $record;
220 $link_output[] = array('name' => $row['name'], 'records' => $rowArray);
222 $returnRelationshipList[]['link_list'] = $link_output;
225 $result['relationship_list'] = $returnRelationshipList;
230 * Retrieve a list of beans. This is the primary method for getting list of SugarBeans from Sugar using the SOAP API.
232 * @param String $session -- Session ID returned by a previous call to login.
233 * @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)..
234 * @param String $query -- SQL where clause without the word 'where'
235 * @param String $order_by -- SQL order by clause without the phrase 'order by'
236 * @param integer $offset -- The record offset to start from.
237 * @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.
238 * @param Array $link_name_to_fields_array -- A list of link_names and for each link_name, what fields value to be returned. For ex.'link_name_to_fields_array' => array(array('name' => 'email_addresses', 'value' => array('id', 'email_address', 'opt_out', 'primary_address')))
239 * @param integer $max_results -- The maximum number of records to return. The default is the sugar configuration value for 'list_max_entries_per_page'
240 * @param integer $deleted -- false if deleted records should not be include, true if deleted records should be included.
241 * @return Array 'result_count' -- integer - The number of records returned
242 * 'next_offset' -- integer - 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.
243 * 'entry_list' -- Array - The records that were retrieved
244 * 'relationship_list' -- Array - The records link field data. The example is if asked about accounts email address then return data would look like Array ( [0] => Array ( [name] => email_addresses [records] => Array ( [0] => Array ( [0] => Array ( [name] => id [value] => 3fb16797-8d90-0a94-ac12-490b63a6be67 ) [1] => Array ( [name] => email_address [value] => hr.kid.qa@example.com ) [2] => Array ( [name] => opt_out [value] => 0 ) [3] => Array ( [name] => primary_address [value] => 1 ) ) [1] => Array ( [0] => Array ( [name] => id [value] => 403f8da1-214b-6a88-9cef-490b63d43566 ) [1] => Array ( [name] => email_address [value] => kid.hr@example.name ) [2] => Array ( [name] => opt_out [value] => 0 ) [3] => Array ( [name] => primary_address [value] => 0 ) ) ) ) )
245 * @exception 'SoapFault' -- The SOAP error, if any
247 function get_entry_list($session, $module_name, $query, $order_by,$offset, $select_fields, $link_name_to_fields_array, $max_results, $deleted, $favorites = false ){
249 $GLOBALS['log']->info('Begin: SugarWebServiceImpl->get_entry_list');
250 global $beanList, $beanFiles;
251 $error = new SoapError();
253 if($module_name == 'CampaignProspects'){
254 $module_name = 'Prospects';
257 if (!self::$helperObject->checkSessionAndModuleAccess($session, 'invalid_session', $module_name, 'read', 'no_access', $error)) {
258 $GLOBALS['log']->error('End: SugarWebServiceImpl->get_entry_list - FAILED on checkSessionAndModuleAccess');
262 if (!self::$helperObject->checkQuery($error, $query, $order_by)) {
263 $GLOBALS['log']->info('End: SugarWebServiceImpl->get_entry_list');
267 // If the maximum number of entries per page was specified, override the configuration value.
268 if($max_results > 0){
269 global $sugar_config;
270 $sugar_config['list_max_entries_per_page'] = $max_results;
273 $class_name = $beanList[$module_name];
274 require_once($beanFiles[$class_name]);
275 $seed = new $class_name();
277 if (!self::$helperObject->checkACLAccess($seed, 'list', $error, 'no_access')) {
278 $GLOBALS['log']->error('End: SugarWebServiceImpl->get_entry_list - FAILED on checkACLAccess');
285 if($offset == '' || $offset == -1){
289 $response = $seed->retrieveTargetList($query, $select_fields, $offset,-1,-1,$deleted);
292 $response = self::$helperObject->get_data_list($seed,$order_by, $query, $offset,-1,-1,$deleted,$favorites);
294 $list = $response['list'];
296 $output_list = array();
297 $linkoutput_list = array();
299 foreach($list as $value) {
300 if(isset($value->emailAddress)){
301 $value->emailAddress->handleLegacyRetrieve($value);
303 $value->fill_in_additional_detail_fields();
305 $output_list[] = self::$helperObject->get_return_value_for_fields($value, $module_name, $select_fields);
306 if(!empty($link_name_to_fields_array)){
307 $linkoutput_list[] = self::$helperObject->get_return_value_for_link_fields($value, $module_name, $link_name_to_fields_array);
311 // Calculate the offset for the start of the next page
312 $next_offset = $offset + sizeof($output_list);
314 $returnRelationshipList = array();
315 foreach($linkoutput_list as $rel){
316 $link_output = array();
317 foreach($rel as $row){
319 foreach($row['records'] as $record){
320 $rowArray[]['link_value'] = $record;
322 $link_output[] = array('name' => $row['name'], 'records' => $rowArray);
324 $returnRelationshipList[]['link_list'] = $link_output;
327 $totalRecordCount = $response['row_count'];
328 if( !empty($sugar_config['disable_count_query']) )
329 $totalRecordCount = -1;
331 $GLOBALS['log']->info('End: SugarWebServiceImpl->get_entry_list - SUCCESS');
332 return array('result_count'=>sizeof($output_list), 'total_count' => $totalRecordCount, 'next_offset'=>$next_offset, 'entry_list'=>$output_list, 'relationship_list' => $returnRelationshipList);
336 * Retrieve the layout metadata for a given module given a specific type and view.
338 * @param String $session -- Session ID returned by a previous call to login.
339 * @param array $module_name(s) -- The name of the module(s) 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)..
340 * @return array $type The type(s) of views requested. Current supported types are 'default' (for application) and 'wireless'
341 * @return array $view The view(s) requested. Current supported types are edit, detail, list, and subpanel.
342 * @exception 'SoapFault' -- The SOAP error, if any
344 function get_module_layout($session, $a_module_names, $a_type, $a_view,$acl_check = TRUE, $md5 = FALSE){
345 $GLOBALS['log']->info('Begin: SugarWebServiceImpl->get_module_layout');
347 global $beanList, $beanFiles;
348 $error = new SoapError();
350 foreach ($a_module_names as $module_name)
352 if (!self::$helperObject->checkSessionAndModuleAccess($session, 'invalid_session', $module_name, 'read', 'no_access', $error))
354 $GLOBALS['log']->error("End: SugarWebServiceImpl->get_module_layout for $module_name - FAILED on checkSessionAndModuleAccess");
358 if( empty($module_name) )
361 $class_name = $beanList[$module_name];
362 require_once($beanFiles[$class_name]);
363 $seed = new $class_name();
365 foreach ($a_view as $view)
367 $aclViewCheck = (strtolower($view) == 'subpanel') ? 'DetailView' : ucfirst(strtolower($view)) . 'View';
368 if(!$acl_check || $seed->ACLAccess($aclViewCheck, true) )
370 foreach ($a_type as $type)
372 $a_vardefs = self::$helperObject->get_module_view_defs($module_name, $type, $view);
374 $results[$module_name][$type][$view] = md5(serialize($a_vardefs));
376 $results[$module_name][$type][$view] = $a_vardefs;
382 $GLOBALS['log']->info('End: SugarWebServiceImpl->get_module_layout ->> '.print_r($results,true) );
389 * Given a list of modules to search and a search string, return the id, module_name, along with the fields
390 * We will support Accounts, Bug Tracker, Cases, Contacts, Leads, Opportunities, Project, ProjectTask, Quotes
392 * @param string $session - Session ID returned by a previous call to login.
393 * @param string $search_string - string to search
394 * @param string[] $modules - array of modules to query
395 * @param int $offset - a specified offset in the query
396 * @param int $max_results - max number of records to return
397 * @param string $assigned_user_id - a user id to filter all records by, leave empty to exclude the filter
398 * @param string[] $select_fields - An array of fields to return. If empty the default return fields will be from the active list view defs.
399 * @param bool $unified_search_only - A boolean indicating if we should only search against those modules participating in the unified search.
400 * @param bool $favorites - A boolean indicating if we should only search against records marked as favorites.
401 * @return Array return_search_result - Array('Accounts' => array(array('name' => 'first_name', 'value' => 'John', 'name' => 'last_name', 'value' => 'Do')))
402 * @exception 'SoapFault' -- The SOAP error, if any
404 function search_by_module($session, $search_string, $modules, $offset, $max_results,$assigned_user_id = '', $select_fields = array(), $unified_search_only = TRUE, $favorites = FALSE){
405 $GLOBALS['log']->info('Begin: SugarWebServiceImpl->search_by_module');
406 global $beanList, $beanFiles;
407 global $sugar_config,$current_language;
409 $error = new SoapError();
410 $output_list = array();
411 if (!self::$helperObject->checkSessionAndModuleAccess($session, 'invalid_session', '', '', '', $error)) {
412 $error->set_error('invalid_login');
413 $GLOBALS['log']->error('End: SugarWebServiceImpl->search_by_module - FAILED on checkSessionAndModuleAccess');
416 global $current_user;
417 if($max_results > 0){
418 $sugar_config['list_max_entries_per_page'] = $max_results;
421 require_once('modules/Home/UnifiedSearchAdvanced.php');
422 require_once 'include/utils.php';
423 $usa = new UnifiedSearchAdvanced();
424 if(!file_exists($cachefile = sugar_cached('modules/unified_search_modules.php'))) {
429 $modules_to_search = array();
430 $unified_search_modules['Users'] = array('fields' => array());
432 $unified_search_modules['ProjectTask'] = array('fields' => array());
434 //If we are ignoring the unified search flag within the vardef we need to re-create the search fields. This allows us to search
435 //against a specific module even though it is not enabled for the unified search within the application.
436 if( !$unified_search_only )
438 foreach ($modules as $singleModule)
440 if( !isset($unified_search_modules[$singleModule]) )
442 $newSearchFields = array('fields' => self::$helperObject->generateUnifiedSearchFields($singleModule) );
443 $unified_search_modules[$singleModule] = $newSearchFields;
449 foreach($unified_search_modules as $module=>$data) {
450 if (in_array($module, $modules)) {
451 $modules_to_search[$module] = $beanList[$module];
455 $GLOBALS['log']->info('SugarWebServiceImpl->search_by_module - search string = ' . $search_string);
457 if(!empty($search_string) && isset($search_string)) {
458 $search_string = trim($GLOBALS['db']->quote(securexss(from_html(clean_string($search_string, 'UNIFIED_SEARCH')))));
459 foreach($modules_to_search as $name => $beanName) {
460 $where_clauses_array = array();
461 $unifiedSearchFields = array () ;
462 foreach ($unified_search_modules[$name]['fields'] as $field=>$def ) {
463 $unifiedSearchFields[$name] [ $field ] = $def ;
464 $unifiedSearchFields[$name] [ $field ]['value'] = $search_string;
467 require_once $beanFiles[$beanName] ;
468 $seed = new $beanName();
469 require_once 'include/SearchForm/SearchForm2.php' ;
470 if ($beanName == "User"
471 || $beanName == "ProjectTask"
473 if(!self::$helperObject->check_modules_access($current_user, $seed->module_dir, 'read')){
476 if(!$seed->ACLAccess('ListView')) {
481 if ($beanName != "User"
482 && $beanName != "ProjectTask"
484 $searchForm = new SearchForm ($seed, $name ) ;
486 $searchForm->setup(array ($name => array()) ,$unifiedSearchFields , '' , 'saved_views' /* hack to avoid setup doing further unwanted processing */ ) ;
487 $where_clauses = $searchForm->generateSearchWhere() ;
488 require_once 'include/SearchForm/SearchForm2.php' ;
489 $searchForm = new SearchForm ($seed, $name ) ;
491 $searchForm->setup(array ($name => array()) ,$unifiedSearchFields , '' , 'saved_views' /* hack to avoid setup doing further unwanted processing */ ) ;
492 $where_clauses = $searchForm->generateSearchWhere() ;
496 if (count($where_clauses) > 0 ) {
497 $where = '('. implode(' ) OR ( ', $where_clauses) . ')';
500 $mod_strings = return_module_language($current_language, $seed->module_dir);
502 if(count($select_fields) > 0)
503 $filterFields = $select_fields;
505 if(file_exists('custom/modules/'.$seed->module_dir.'/metadata/listviewdefs.php'))
506 require_once('custom/modules/'.$seed->module_dir.'/metadata/listviewdefs.php');
508 require_once('modules/'.$seed->module_dir.'/metadata/listviewdefs.php');
510 $filterFields = array();
511 foreach($listViewDefs[$seed->module_dir] as $colName => $param) {
512 if(!empty($param['default']) && $param['default'] == true)
513 $filterFields[] = strtolower($colName);
515 if (!in_array('id', $filterFields))
516 $filterFields[] = 'id';
519 //Pull in any db fields used for the unified search query so the correct joins will be added
520 $selectOnlyQueryFields = array();
521 foreach ($unifiedSearchFields[$name] as $field => $def){
522 if( isset($def['db_field']) && !in_array($field,$filterFields) ){
523 $filterFields[] = $field;
524 $selectOnlyQueryFields[] = $field;
528 //Add the assigned user filter if applicable
529 if (!empty($assigned_user_id) && isset( $seed->field_defs['assigned_user_id']) ) {
530 $ownerWhere = $seed->getOwnerWhere($assigned_user_id);
531 $where = "($where) AND $ownerWhere";
534 if( $beanName == "Employee" )
536 $where = "($where) AND users.deleted = 0 AND users.is_group = 0 AND users.employee_status = 'Active'";
539 $list_params = array();
541 $ret_array = $seed->create_new_list_query('', $where, $filterFields, $list_params, 0, '', true, $seed, true);
542 if(empty($params) or !is_array($params)) $params = array();
543 if(!isset($params['custom_select'])) $params['custom_select'] = '';
544 if(!isset($params['custom_from'])) $params['custom_from'] = '';
545 if(!isset($params['custom_where'])) $params['custom_where'] = '';
546 if(!isset($params['custom_order_by'])) $params['custom_order_by'] = '';
547 $main_query = $ret_array['select'] . $params['custom_select'] . $ret_array['from'] . $params['custom_from'] . $ret_array['where'] . $params['custom_where'] . $ret_array['order_by'] . $params['custom_order_by'];
549 if ($beanName == "User") {
550 $filterFields = array('id', 'user_name', 'first_name', 'last_name', 'email_address');
551 $main_query = "select users.id, ea.email_address, users.user_name, first_name, last_name from users ";
552 $main_query = $main_query . " LEFT JOIN email_addr_bean_rel eabl ON eabl.bean_module = '{$seed->module_dir}'
553 LEFT JOIN email_addresses ea ON (ea.id = eabl.email_address_id) ";
554 $main_query = $main_query . "where ((users.first_name like '{$search_string}') or (users.last_name like '{$search_string}') or (users.user_name like '{$search_string}') or (ea.email_address like '{$search_string}')) and users.deleted = 0 and users.is_group = 0 and users.employee_status = 'Active'";
556 if ($beanName == "ProjectTask") {
557 $filterFields = array('id', 'name', 'project_id', 'project_name');
558 $main_query = "select {$seed->table_name}.project_task_id id,{$seed->table_name}.project_id, {$seed->table_name}.name, project.name project_name from {$seed->table_name} ";
559 $seed->add_team_security_where_clause($main_query);
560 $main_query .= "LEFT JOIN teams ON $seed->table_name.team_id=teams.id AND (teams.deleted=0) ";
561 $main_query .= "LEFT JOIN project ON $seed->table_name.project_id = project.id ";
562 $main_query .= "where {$seed->table_name}.name like '{$search_string}%'";
566 $GLOBALS['log']->info('SugarWebServiceImpl->search_by_module - query = ' . $main_query);
567 if($max_results < -1) {
568 $result = $seed->db->query($main_query);
571 if($max_results == -1) {
572 $limit = $sugar_config['list_max_entries_per_page'];
574 $limit = $max_results;
576 $result = $seed->db->limitQuery($main_query, $offset, $limit + 1);
580 while($row = $seed->db->fetchByAssoc($result)) {
581 $nameValueArray = array();
582 foreach ($filterFields as $field) {
583 if(in_array($field, $selectOnlyQueryFields))
585 $nameValue = array();
586 if (isset($row[$field])) {
587 $nameValueArray[$field] = self::$helperObject->get_name_value($field, $row[$field]);
590 $rowArray[] = $nameValueArray;
592 $output_list[] = array('name' => $name, 'records' => $rowArray);
595 $GLOBALS['log']->info('End: SugarWebServiceImpl->search_by_module');
596 return array('entry_list'=>$output_list);
598 return array('entry_list'=>$output_list);
604 * Get OAuth reqtest token
606 public function oauth_request_token()
608 $GLOBALS['log']->info('Begin: SugarWebServiceImpl->oauth_request_token');
609 require_once "include/SugarOAuthServer.php";
611 $oauth = new SugarOAuthServer(rtrim($GLOBALS['sugar_config']['site_url'],'/').'/service/v4/rest.php');
612 $result = $oauth->requestToken()."&oauth_callback_confirmed=true&authorize_url=".$oauth->authURL();
613 } catch(OAuthException $e) {
614 $GLOBALS['log']->debug("OAUTH Exception: $e");
615 $errorObject = new SoapError();
616 $errorObject->set_error('invalid_login');
617 self::$helperObject->setFaultObject($errorObject);
620 $GLOBALS['log']->info('End: SugarWebServiceImpl->oauth_request_token');
625 * Get OAuth access token
627 public function oauth_access_token()
629 $GLOBALS['log']->info('Begin: SugarWebServiceImpl->oauth_access_token');
630 require_once "include/SugarOAuthServer.php";
632 $oauth = new SugarOAuthServer();
633 $result = $oauth->accessToken();
634 } catch(OAuthException $e) {
635 $GLOBALS['log']->debug("OAUTH Exception: $e");
636 $errorObject = new SoapError();
637 $errorObject->set_error('invalid_login');
638 self::$helperObject->setFaultObject($errorObject);
641 $GLOBALS['log']->info('End: SugarWebServiceImpl->oauth_access_token');
645 public function oauth_access($session='')
647 $GLOBALS['log']->info('Begin: SugarWebServiceImpl->oauth_access');
648 $error = new SoapError();
649 $output_list = array();
650 if (!self::$helperObject->checkSessionAndModuleAccess($session, 'invalid_session', '', '', '', $error)) {
651 $error->set_error('invalid_login');
652 $GLOBALS['log']->info('End: SugarWebServiceImpl->oauth_access');
655 $result = array('id'=>session_id());
657 $GLOBALS['log']->info('End: SugarWebServiceImpl->oauth_access');
663 * Get next job from the queue
664 * @param string $session
665 * @param string $clientid
667 public function job_queue_next($session, $clientid)
669 $GLOBALS['log']->info('Begin: SugarWebServiceImpl->job_queue_next');
670 $error = new SoapError();
671 if (! self::$helperObject->checkSessionAndModuleAccess($session, 'invalid_session', '', 'read', 'no_access', $error)) {
672 $GLOBALS['log']->info('End: SugarWebServiceImpl->job_queue_next denied.');
675 require_once 'include/SugarQueue/SugarJobQueue.php';
676 $queue = new SugarJobQueue();
677 $job = $queue->nextJob($clientid);
683 $GLOBALS['log']->info('End: SugarWebServiceImpl->job_queue_next');
684 return array("results" => $jobid);
688 * Run cleanup and schedule
689 * @param string $session
690 * @param string $clientid
692 public function job_queue_cycle($session, $clientid)
694 $GLOBALS['log']->info('Begin: SugarWebServiceImpl->job_queue_cycle');
695 $error = new SoapError();
696 if (! self::$helperObject->checkSessionAndModuleAccess($session, 'invalid_session', '', 'read', 'no_access', $error)) {
697 $GLOBALS['log']->info('End: SugarWebServiceImpl->job_queue_cycle denied.');
700 require_once 'include/SugarQueue/SugarJobQueue.php';
701 $queue = new SugarJobQueue();
703 $queue->runSchedulers();
704 $GLOBALS['log']->info('End: SugarWebServiceImpl->job_queue_cycle');
705 return array("results" => "ok");
710 * @param string $session
711 * @param string $jobid
712 * @param string $clientid
714 public function job_queue_run($session, $jobid, $clientid)
716 $GLOBALS['log']->info('Begin: SugarWebServiceImpl->job_queue_run');
717 $error = new SoapError();
718 if (! self::$helperObject->checkSessionAndModuleAccess($session, 'invalid_session', '', 'read', 'no_access', $error)) {
719 $GLOBALS['log']->info('End: SugarWebServiceImpl->job_queue_run denied.');
722 $GLOBALS['log']->debug('Starting job $jobid execution as $clientid');
723 require_once 'modules/SchedulersJobs/SchedulersJob.php';
724 $result = SchedulersJob::runJobId($jobid, $clientid);
725 $GLOBALS['log']->info('End: SugarWebServiceImpl->job_queue_run');
726 if($result === true) {
727 return array("results" => true);
729 return array("results" => false, "message" => $result);
734 SugarWebServiceImplv4::$helperObject = new SugarWebServiceUtilv4();