2 /*********************************************************************************
3 * SugarCRM Community Edition is a customer relationship management program developed by
4 * SugarCRM, Inc. Copyright (C) 2004-2013 SugarCRM Inc.
6 * This program is free software; you can redistribute it and/or modify it under
7 * the terms of the GNU Affero General Public License version 3 as published by the
8 * Free Software Foundation with the addition of the following permission added
9 * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
10 * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
11 * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
13 * This program is distributed in the hope that it will be useful, but WITHOUT
14 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15 * FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
18 * You should have received a copy of the GNU Affero General Public License along with
19 * this program; if not, see http://www.gnu.org/licenses or write to the Free
20 * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
23 * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
24 * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
26 * The interactive user interfaces in modified source and object code versions
27 * of this program must display Appropriate Legal Notices, as required under
28 * Section 5 of the GNU Affero General Public License version 3.
30 * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
31 * these Appropriate Legal Notices must retain the display of the "Powered by
32 * SugarCRM" logo. If the display of the logo is not reasonably feasible for
33 * technical reasons, the Appropriate Legal Notices must display the words
34 * "Powered by SugarCRM".
35 ********************************************************************************/
38 require_once('include/SugarObjects/templates/person/Person.php');
39 require_once('include/MVC/SugarModule.php');
42 * quicksearchQuery class, handles AJAX calls from quicksearch.js
44 * @copyright 2004-2007 SugarCRM Inc.
45 * @license http://www.sugarcrm.com/crm/products/sugar-professional-eula.html SugarCRM Professional End User License
46 * @since Class available since Release 4.5.1
48 class quicksearchQuery
54 const CONDITION_CONTAINS = 'contains';
55 const CONDITION_LIKE_CUSTOM = 'like_custom';
56 const CONDITION_EQUAL = 'equal';
58 protected $extra_where;
61 * Query a module for a list of items
64 * example for querying Account module with 'a':
65 * array ('modules' => array('Accounts'), // module to use
66 * 'field_list' => array('name', 'id'), // fields to select
67 * 'group' => 'or', // how the conditions should be combined
68 * 'conditions' => array(array( // array of where conditions to use
69 * 'name' => 'name', // field
70 * 'op' => 'like_custom', // operation
71 * 'end' => '%', // end of the query
72 * 'value' => 'a', // query value
75 * 'order' => 'name', // order by
76 * 'limit' => '30', // limit, number of records to return
78 * @return array list of elements returned
80 public function query($args)
82 $args = $this->prepareArguments($args);
83 $args = $this->updateQueryArguments($args);
84 $data = $this->getRawResults($args);
86 return $this->getFormattedJsonResults($data, $args);
93 public function get_contact_array($args)
95 $args = $this->prepareArguments($args);
96 $args = $this->updateContactArrayArguments($args);
97 $data = $this->getRawResults($args);
98 $results = $this->prepareResults($data, $args);
100 return $this->getFilteredJsonResults($results);
104 * Returns the list of users, faster than using query method for Users module
106 * @param array $args arguments used to construct query, see query() for example
107 * @return array list of users returned
109 public function get_user_array($args)
111 $condition = $args['conditions'][0]['value'];
112 $results = $this->getUserResults($condition);
114 return $this->getJsonEncodedData($results);
119 * Returns search results from external API
124 public function externalApi($args)
126 require_once('include/externalAPI/ExternalAPIFactory.php');
129 $api = ExternalAPIFactory::loadAPI($args['api']);
130 $data['fields'] = $api->searchDoc($_REQUEST['query']);
131 $data['totalCount'] = count($data['fields']);
132 } catch(Exception $ex) {
133 $GLOBALS['log']->error($ex->getMessage());
136 return $this->getJsonEncodedData($data);
141 * Internal function to construct where clauses
143 * @param Object $focus
147 protected function constructWhere($focus, $args)
149 global $db, $locale, $current_user;
151 $table = $focus->getTableName();
152 if (!empty($table)) {
153 $table_prefix = $db->getValidDBName($table).".";
157 $conditionArray = array();
159 if (!is_array($args['conditions'])) {
160 $args['conditions'] = array();
163 foreach($args['conditions'] as $condition)
165 switch ($condition['op'])
167 case self::CONDITION_CONTAINS:
172 $table_prefix . $db->getValidDBName($condition['name']),
173 $db->quote($condition['value']
177 case self::CONDITION_LIKE_CUSTOM:
179 if (!empty($condition['begin'])) {
180 $like .= $db->quote($condition['begin']);
182 $like .= $db->quote($condition['value']);
184 if (!empty($condition['end'])) {
185 $like .= $db->quote($condition['end']);
188 if ($focus instanceof Person){
189 $nameFormat = $locale->getLocaleFormatMacro($current_user);
191 if (strpos($nameFormat,'l') > strpos($nameFormat,'f')) {
194 $db->concat($table, array('first_name','last_name')) . " like '$like'"
199 $db->concat($table, array('last_name','first_name')) . " like '$like'"
206 $table_prefix . $db->getValidDBName($condition['name']) . sprintf(" like '%s'", $like)
211 case self::CONDITION_EQUAL:
212 if ($condition['value']) {
215 sprintf("(%s = '%s')", $db->getValidDBName($condition['name']), $db->quote($condition['value']))
223 $table_prefix.$db->getValidDBName($condition['name']) . sprintf(" like '%s%%'", $db->quote($condition['value']))
228 $whereClauseArray = array();
229 if (!empty($conditionArray)) {
230 $whereClauseArray[] = sprintf('(%s)', implode(" {$args['group']} ", $conditionArray));
232 if(!empty($this->extra_where)) {
233 $whereClauseArray[] = "({$this->extra_where})";
236 if ($table == 'users') {
237 $whereClauseArray[] = "users.status='Active'";
240 return implode(' AND ', $whereClauseArray);
244 * Returns formatted data
246 * @param array $results
250 protected function formatResults($results, $args)
252 global $sugar_config;
254 $app_list_strings = null;
255 $data['totalCount'] = count($results);
256 $data['fields'] = array();
258 for ($i = 0; $i < count($results); $i++) {
259 $data['fields'][$i] = array();
260 $data['fields'][$i]['module'] = $results[$i]->object_name;
262 //C.L.: Bug 43395 - For Quicksearch, do not return values with salutation and title formatting
263 if($results[$i] instanceof Person)
265 $results[$i]->createLocaleFormattedName = false;
267 $listData = $results[$i]->get_list_view_data();
269 foreach ($args['field_list'] as $field) {
271 if ((isset($results[$i]->field_name_map[$field]['type']) && $results[$i]->field_name_map[$field]['type'] == 'enum')
272 || (isset($results[$i]->field_name_map[$field]['custom_type']) && $results[$i]->field_name_map[$field]['custom_type'] == 'enum')) {
274 // get fields to match enum vals
275 if(empty($app_list_strings)) {
276 if(isset($_SESSION['authenticated_user_language']) && $_SESSION['authenticated_user_language'] != '') $current_language = $_SESSION['authenticated_user_language'];
277 else $current_language = $sugar_config['default_language'];
278 $app_list_strings = return_app_list_strings_language($current_language);
281 // match enum vals to text vals in language pack for return
282 if(!empty($app_list_strings[$results[$i]->field_name_map[$field]['options']])) {
283 $results[$i]->$field = $app_list_strings[$results[$i]->field_name_map[$field]['options']][$results[$i]->$field];
288 if (isset($listData[$field])) {
289 $data['fields'][$i][$field] = $listData[$field];
290 } else if (isset($results[$i]->$field)) {
291 $data['fields'][$i][$field] = $results[$i]->$field;
293 $data['fields'][$i][$field] = '';
298 if (is_array($data['fields'])) {
299 foreach ($data['fields'] as $i => $recordIn) {
300 if (!is_array($recordIn)) {
304 foreach ($recordIn as $col => $dataIn) {
305 if (!is_scalar($dataIn)) {
309 $data['fields'][$i][$col] = html_entity_decode($dataIn, ENT_QUOTES, 'UTF-8');
318 * Filter duplicate results from the list
323 protected function filterResults($list)
325 $fieldsFiltered = array();
326 foreach ($list['fields'] as $field) {
328 foreach ($fieldsFiltered as $item) {
329 if ($item === $field) {
336 $fieldsFiltered[] = $field;
340 $list['totalCount'] = count($fieldsFiltered);
341 $list['fields'] = $fieldsFiltered;
347 * Returns raw search results. Filters should be applied later.
350 * @param boolean $singleSelect
353 protected function getRawResults($args, $singleSelect = false)
355 $orderBy = !empty($args['order']) ? $args['order'] : '';
356 $limit = !empty($args['limit']) ? intval($args['limit']) : '';
359 foreach ($args['modules'] as $module) {
360 $focus = SugarModule::get($module)->loadBean();
362 $orderBy = $focus->db->getValidDBName(($args['order_by_name'] && $focus instanceof Person && $args['order'] == 'name') ? 'last_name' : $orderBy);
364 if ($focus->ACLAccess('ListView', true)) {
365 $where = $this->constructWhere($focus, $args);
366 $data = $this->updateData($data, $focus, $orderBy, $where, $limit, $singleSelect);
375 * Returns search results with all fixes applied
381 protected function prepareResults($data, $args)
383 $results['totalCount'] = $count = count($data);
384 $results['fields'] = array();
386 for ($i = 0; $i < $count; $i++) {
388 $field['module'] = $data[$i]->object_name;
390 $field = $this->overrideContactId($field, $data[$i], $args);
391 $field = $this->updateContactName($field, $args);
393 $results['fields'][$i] = $this->prepareField($field, $args);
400 * Returns user search results
402 * @param string $condition
405 protected function getUserResults($condition)
407 $users = $this->getUserArray($condition);
410 $results['totalCount'] = count($users);
411 $results['fields'] = array();
413 foreach ($users as $id => $name) {
417 'id' => (string) $id,
418 'user_name' => $name,
427 * Merges current module search results to given list and returns it
430 * @param SugarBean $focus
431 * @param string $orderBy
432 * @param string $where
433 * @param string $limit
434 * @param boolean $singleSelect
437 protected function updateData($data, $focus, $orderBy, $where, $limit, $singleSelect = false)
439 $result = $focus->get_list($orderBy, $where, 0, $limit, -1, 0, $singleSelect);
441 return array_merge($data, $result['list']);
445 * Updates search result with proper contact name
447 * @param array $result
451 protected function updateContactName($result, $args)
455 $result[$args['field_list'][0]] = $locale->getLocaleFormattedName(
456 $result['first_name'],
457 $result['last_name'],
458 $result['salutation']
465 * Overrides contact_id and reports_to_id params (to 'id')
467 * @param array $result
468 * @param object $data
472 protected function overrideContactId($result, $data, $args)
474 foreach ($args['field_list'] as $field) {
475 $result[$field] = (preg_match('/reports_to_id$/s',$field)
476 || preg_match('/contact_id$/s',$field))
477 ? $data->id // "reports_to_id" to "id"
485 * Returns prepared arguments. Should be redefined in child classes.
487 * @param array $arguments
490 protected function prepareArguments($args)
492 global $sugar_config;
494 // override query limits
495 if ($sugar_config['list_max_entries_per_page'] < ($args['limit'] + 1)) {
496 $sugar_config['list_max_entries_per_page'] = ($args['limit'] + 1);
500 'order_by_name' => false,
502 $this->extra_where = '';
505 /* BUG: 52684 properly check for 'and' jeff@neposystems.com */
506 if(!empty($args['group']) && strcasecmp($args['group'], 'and') == 0) {
507 $args['group'] = 'AND';
509 $args['group'] = 'OR';
512 return array_merge($defaults, $args);
516 * Returns prepared field array. Should be redefined in child classes.
518 * @param array $field
522 protected function prepareField($field, $args)
530 * @param string $condition
533 protected function getUserArray($condition)
535 return (showFullName())
536 // utils.php, if system is configured to show full name
537 ? getUserArrayFromFullName($condition, true)
538 : get_user_array(false, 'Active', '', false, $condition,' AND portal_only=0 ',false);
542 * Returns additional where condition for non private teams
547 protected function getNonPrivateTeamsWhere($args)
552 "(teams.name like '%s%%' or teams.name_2 like '%s%%')",
553 $db->quote($args['conditions'][0]['value']),
554 $db->quote($args['conditions'][0]['value'])
557 $where .= (!empty($args['conditions'][1]) && $args['conditions'][1]['name'] == 'user_id')
559 " AND teams.id in (select team_id from team_memberships where user_id = '%s')",
560 $db->quote($args['conditions'][1]['value'])
562 : ' AND teams.private = 0';
568 * Returns JSON encoded data
573 protected function getJsonEncodedData($data)
575 $json = getJSONobj();
577 return $json->encodeReal($data);
581 * Returns formatted JSON encoded search results
584 * @param array $results
587 protected function getFormattedJsonResults($results, $args)
589 $results = $this->formatResults($results, $args);
591 return $this->getJsonEncodedData($results);
595 * Returns filtered JSON encoded search results
597 * @param array $results
600 protected function getFilteredJsonResults($results)
602 $results = $this->filterResults($results);
604 return $this->getJsonEncodedData($results);
608 * Returns updated arguments array
613 protected function updateQueryArguments($args)
615 $args['order_by_name'] = true;
621 * Returns updated arguments array for contact query
626 protected function updateContactArrayArguments($args)
632 * Returns updated arguments array for team query
637 protected function updateTeamArrayArguments($args)
639 $this->extra_where = $this->getNonPrivateTeamsWhere($args);
640 $args['modules'] = array('Teams');