modules/Home/QuickSearch.php

   1 <?php
   2 /*********************************************************************************
   3  * SugarCRM Community Edition is a customer relationship management program developed by
   4  * SugarCRM, Inc. Copyright (C) 2004-2012 SugarCRM Inc.
   5  *
   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.
  12  *
  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
  16  * details.
  17  *
  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
  21  * 02110-1301 USA.
  22  *
  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.
  25  *
  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.
  29  *
  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  ********************************************************************************/
  36
  37
  38 require_once('include/SugarObjects/templates/person/Person.php');
  39 require_once('include/MVC/SugarModule.php');
  40
  41 /**
  42  * quicksearchQuery class, handles AJAX calls from quicksearch.js
  43  *
  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
  47  */
  48 class quicksearchQuery
  49 {
  50     /**
  51      * Condition operators
  52      * @var string
  53      */
  54     const CONDITION_CONTAINS    = 'contains';
  55     const CONDITION_LIKE_CUSTOM = 'like_custom';
  56     const CONDITION_EQUAL       = 'equal';
  57
  58     protected $extra_where;
  59
  60     /**
  61      * Query a module for a list of items
  62      *
  63      * @param array $args
  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
  73      *                              )
  74      *                        ),
  75      *        'order' => 'name', // order by
  76      *        'limit' => '30', // limit, number of records to return
  77      *       )
  78      * @return array list of elements returned
  79      */
  80     public function query($args)
  81     {
  82         $args = $this->prepareArguments($args);
  83         $args = $this->updateQueryArguments($args);
  84         $data = $this->getRawResults($args);
  85
  86         return $this->getFormattedJsonResults($data, $args);
  87     }
  88
  89     /**
  90      * get_contact_array
  91      *
  92      */
  93     public function get_contact_array($args)
  94     {
  95         $args    = $this->prepareArguments($args);
  96         $args    = $this->updateContactArrayArguments($args);
  97         $data    = $this->getRawResults($args);
  98         $results = $this->prepareResults($data, $args);
  99
 100         return $this->getFilteredJsonResults($results);
 101     }
 102
 103     /**
 104      * Returns the list of users, faster than using query method for Users module
 105      *
 106      * @param array $args arguments used to construct query, see query() for example
 107      * @return array list of users returned
 108      */
 109     public function get_user_array($args)
 110     {
 111         $condition = $args['conditions'][0]['value'];
 112         $results   = $this->getUserResults($condition);
 113
 114         return $this->getJsonEncodedData($results);
 115     }
 116
 117
 118     /**
 119      * Returns search results from external API
 120      *
 121      * @param array $args
 122      * @return array
 123      */
 124     public function externalApi($args)
 125     {
 126         require_once('include/externalAPI/ExternalAPIFactory.php');
 127         $data = array();
 128         try {
 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());
 134         }
 135
 136         return $this->getJsonEncodedData($data);
 137     }
 138
 139
 140     /**
 141      * Internal function to construct where clauses
 142      *
 143      * @param Object $focus
 144      * @param array $args
 145      * @return string
 146      */
 147     protected function constructWhere($focus, $args)
 148     {
 149         global $db, $locale, $current_user;
 150
 151         $table = $focus->getTableName();
 152         if (!empty($table)) {
 153             $table_prefix = $db->getValidDBName($table).".";
 154         } else {
 155             $table_prefix = '';
 156         }
 157         $conditionArray = array();
 158
 159         if (!is_array($args['conditions'])) {
 160             $args['conditions'] = array();
 161         }
 162
 163         foreach($args['conditions'] as $condition)
 164         {
 165             switch ($condition['op'])
 166             {
 167                 case self::CONDITION_CONTAINS:
 168                     array_push(
 169                         $conditionArray,
 170                         sprintf(
 171                             "%s like '%%%s%%'",
 172                             $table_prefix . $db->getValidDBName($condition['name']),
 173                             $db->quote($condition['value']
 174                     )));
 175                     break;
 176
 177                 case self::CONDITION_LIKE_CUSTOM:
 178                     $like = '';
 179                     if (!empty($condition['begin'])) {
 180                         $like .= $db->quote($condition['begin']);
 181                     }
 182                     $like .= $db->quote($condition['value']);
 183
 184                     if (!empty($condition['end'])) {
 185                         $like .= $db->quote($condition['end']);
 186                     }
 187
 188                     if ($focus instanceof Person){
 189                         $nameFormat = $locale->getLocaleFormatMacro($current_user);
 190
 191                         if (strpos($nameFormat,'l') > strpos($nameFormat,'f')) {
 192                             array_push(
 193                                 $conditionArray,
 194                                 $db->concat($table, array('first_name','last_name')) . " like '$like'"
 195                             );
 196                         } else {
 197                             array_push(
 198                                 $conditionArray,
 199                                 $db->concat($table, array('last_name','first_name')) . " like '$like'"
 200                             );
 201                         }
 202                     }
 203                     else {
 204                         array_push(
 205                             $conditionArray,
 206                             $table_prefix . $db->getValidDBName($condition['name']) . sprintf(" like '%s'", $like)
 207                         );
 208                     }
 209                     break;
 210
 211                 case self::CONDITION_EQUAL:
 212                     if ($condition['value']) {
 213                         array_push(
 214                             $conditionArray,
 215                             sprintf("(%s = '%s')", $db->getValidDBName($condition['name']), $db->quote($condition['value']))
 216                             );
 217                     }
 218                     break;
 219
 220                 default:
 221                     array_push(
 222                         $conditionArray,
 223                         $table_prefix.$db->getValidDBName($condition['name']) . sprintf(" like '%s%%'", $db->quote($condition['value']))
 224                     );
 225             }
 226         }
 227
 228         $whereClause = sprintf('(%s)', implode(" {$args['group']} ", $conditionArray));
 229         if(!empty($this->extra_where)) {
 230             $whereClause .= " AND ({$this->extra_where})";
 231         }
 232
 233         if ($table == 'users') {
 234             $whereClause .= sprintf(" AND users.status='Active'");
 235         }
 236
 237         return $whereClause;
 238     }
 239
 240     /**
 241      * Returns formatted data
 242      *
 243      * @param array $results
 244      * @param array $args
 245      * @return array
 246      */
 247     protected function formatResults($results, $args)
 248     {
 249         global $sugar_config;
 250
 251         $app_list_strings = null;
 252         $data['totalCount'] = count($results);
 253         $data['fields']     = array();
 254
 255         for ($i = 0; $i < count($results); $i++) {
 256             $data['fields'][$i] = array();
 257             $data['fields'][$i]['module'] = $results[$i]->object_name;
 258
 259             //C.L.: Bug 43395 - For Quicksearch, do not return values with salutation and title formatting
 260             if($results[$i] instanceof Person)
 261             {
 262                 $results[$i]->createLocaleFormattedName = false;
 263             }
 264             $listData = $results[$i]->get_list_view_data();
 265
 266             foreach ($args['field_list'] as $field) {
 267                 // handle enums
 268                 if ((isset($results[$i]->field_name_map[$field]['type']) && $results[$i]->field_name_map[$field]['type'] == 'enum')
 269                     || (isset($results[$i]->field_name_map[$field]['custom_type']) && $results[$i]->field_name_map[$field]['custom_type'] == 'enum')) {
 270
 271                     // get fields to match enum vals
 272                     if(empty($app_list_strings)) {
 273                         if(isset($_SESSION['authenticated_user_language']) && $_SESSION['authenticated_user_language'] != '') $current_language = $_SESSION['authenticated_user_language'];
 274                         else $current_language = $sugar_config['default_language'];
 275                         $app_list_strings = return_app_list_strings_language($current_language);
 276                     }
 277
 278                     // match enum vals to text vals in language pack for return
 279                     if(!empty($app_list_strings[$results[$i]->field_name_map[$field]['options']])) {
 280                         $results[$i]->$field = $app_list_strings[$results[$i]->field_name_map[$field]['options']][$results[$i]->$field];
 281                     }
 282                 }
 283
 284
 285                 if (isset($listData[$field])) {
 286                     $data['fields'][$i][$field] = $listData[$field];
 287                 } else if (isset($results[$i]->$field)) {
 288                     $data['fields'][$i][$field] = $results[$i]->$field;
 289                 } else {
 290                     $data['fields'][$i][$field] = '';
 291                 }
 292             }
 293         }
 294
 295         if (is_array($data['fields'])) {
 296             foreach ($data['fields'] as $i => $recordIn) {
 297                 if (!is_array($recordIn)) {
 298                     continue;
 299                 }
 300
 301                 foreach ($recordIn as $col => $dataIn) {
 302                     if (!is_scalar($dataIn)) {
 303                         continue;
 304                     }
 305
 306                     $data['fields'][$i][$col] = html_entity_decode($dataIn, ENT_QUOTES, 'UTF-8');
 307                 }
 308             }
 309         }
 310
 311         return $data;
 312     }
 313
 314     /**
 315      * Filter duplicate results from the list
 316      *
 317      * @param array $list
 318      * @return  array
 319      */
 320     protected function filterResults($list)
 321     {
 322         $fieldsFiltered = array();
 323         foreach ($list['fields'] as $field) {
 324             $found = false;
 325             foreach ($fieldsFiltered as $item) {
 326                 if ($item === $field) {
 327                     $found = true;
 328                     break;
 329                 }
 330             }
 331
 332             if (!$found) {
 333                 $fieldsFiltered[] = $field;
 334             }
 335         }
 336
 337         $list['totalCount'] = count($fieldsFiltered);
 338         $list['fields']     = $fieldsFiltered;
 339
 340         return $list;
 341     }
 342
 343     /**
 344      * Returns raw search results. Filters should be applied later.
 345      *
 346      * @param array $args
 347      * @param boolean $singleSelect
 348      * @return array
 349      */
 350     protected function getRawResults($args, $singleSelect = false)
 351     {
 352         $orderBy = !empty($args['order']) ? $args['order'] : '';
 353         $limit   = !empty($args['limit']) ? intval($args['limit']) : '';
 354         $data    = array();
 355
 356         foreach ($args['modules'] as $module) {
 357             $focus = SugarModule::get($module)->loadBean();
 358
 359             $orderBy = $focus->db->getValidDBName(($args['order_by_name'] && $focus instanceof Person && $args['order'] == 'name') ? 'last_name' : $orderBy);
 360
 361             if ($focus->ACLAccess('ListView', true)) {
 362                 $where = $this->constructWhere($focus, $args);
 363                 $data  = $this->updateData($data, $focus, $orderBy, $where, $limit, $singleSelect);
 364             }
 365         }
 366
 367         return $data;
 368     }
 369
 370     /**
 371      * Returns search results with all fixes applied
 372      *
 373      * @param array $data
 374      * @param array $args
 375      * @return array
 376      */
 377     protected function prepareResults($data, $args)
 378     {
 379         $results['totalCount'] = $count = count($data);
 380         $results['fields']     = array();
 381
 382         for ($i = 0; $i < $count; $i++) {
 383             $field = array();
 384             $field['module'] = $data[$i]->object_name;
 385
 386             $field = $this->overrideContactId($field, $data[$i], $args);
 387             $field = $this->updateContactName($field, $args);
 388
 389             $results['fields'][$i] = $this->prepareField($field, $args);
 390         }
 391
 392         return $results;
 393     }
 394
 395     /**
 396      * Returns user search results
 397      *
 398      * @param string $condition
 399      * @return array
 400      */
 401     protected function getUserResults($condition)
 402     {
 403         $users = $this->getUserArray($condition);
 404
 405         $results = array();
 406         $results['totalCount'] = count($users);
 407         $results['fields']     = array();
 408
 409         foreach ($users as $id => $name) {
 410             array_push(
 411                 $results['fields'],
 412                 array(
 413                     'id' => (string) $id,
 414                     'user_name' => $name,
 415                     'module' => 'Users'
 416             ));
 417         }
 418
 419         return $results;
 420     }
 421
 422     /**
 423      * Merges current module search results to given list and returns it
 424      *
 425      * @param array $data
 426      * @param SugarBean $focus
 427      * @param string $orderBy
 428      * @param string $where
 429      * @param string $limit
 430      * @param boolean $singleSelect
 431      * @return array
 432      */
 433     protected function updateData($data, $focus, $orderBy, $where, $limit, $singleSelect = false)
 434     {
 435         $result = $focus->get_list($orderBy, $where, 0, $limit, -1, 0, $singleSelect);
 436
 437         return array_merge($data, $result['list']);
 438     }
 439
 440     /**
 441      * Updates search result with proper contact name
 442      *
 443      * @param array $result
 444      * @param array $args
 445      * @return string
 446      */
 447     protected function updateContactName($result, $args)
 448     {
 449         global $locale;
 450
 451         $result[$args['field_list'][0]] = $locale->getLocaleFormattedName(
 452             $result['first_name'],
 453             $result['last_name'],
 454             $result['salutation']
 455         );
 456
 457         return $result;
 458     }
 459
 460     /**
 461      * Overrides contact_id and reports_to_id params (to 'id')
 462      *
 463      * @param array $result
 464      * @param object $data
 465      * @param array $args
 466      * @return array
 467      */
 468     protected function overrideContactId($result, $data, $args)
 469     {
 470         foreach ($args['field_list'] as $field) {
 471             $result[$field] = (preg_match('/reports_to_id$/s',$field)
 472                                || preg_match('/contact_id$/s',$field))
 473                 ? $data->id // "reports_to_id" to "id"
 474                 : $data->$field;
 475         }
 476
 477         return $result;
 478     }
 479
 480     /**
 481      * Returns prepared arguments. Should be redefined in child classes.
 482      *
 483      * @param array $arguments
 484      * @return array
 485      */
 486     protected function prepareArguments($args)
 487     {
 488         global $sugar_config;
 489
 490         // override query limits
 491         if ($sugar_config['list_max_entries_per_page'] < ($args['limit'] + 1)) {
 492             $sugar_config['list_max_entries_per_page'] = ($args['limit'] + 1);
 493         }
 494
 495         $defaults = array(
 496             'order_by_name' => false,
 497         );
 498         $this->extra_where = '';
 499
 500         // Sanitize group
 501         /* BUG: 52684 properly check for 'and' jeff@neposystems.com */
 502         if(!empty($args['group'])  && strcasecmp($args['group'], 'and') == 0) {
 503             $args['group'] = 'AND';
 504         } else {
 505             $args['group'] = 'OR';
 506         }
 507
 508         return array_merge($defaults, $args);
 509     }
 510
 511     /**
 512      * Returns prepared field array. Should be redefined in child classes.
 513      *
 514      * @param array $field
 515      * @param array $args
 516      * @return array
 517      */
 518     protected function prepareField($field, $args)
 519     {
 520         return $field;
 521     }
 522
 523     /**
 524      * Returns user array
 525      *
 526      * @param string $condition
 527      * @return array
 528      */
 529     protected function getUserArray($condition)
 530     {
 531         return (showFullName())
 532             // utils.php, if system is configured to show full name
 533             ? getUserArrayFromFullName($condition, true)
 534             : get_user_array(false, 'Active', '', false, $condition,' AND portal_only=0 ',false);
 535     }
 536
 537     /**
 538      * Returns additional where condition for non private teams
 539      *
 540      * @param array $args
 541      * @return string
 542      */
 543     protected function getNonPrivateTeamsWhere($args)
 544     {
 545         global $db;
 546
 547         $where = sprintf(
 548             "(teams.name like '%s%%' or teams.name_2 like '%s%%')",
 549             $db->quote($args['conditions'][0]['value']),
 550             $db->quote($args['conditions'][0]['value'])
 551         );
 552
 553         $where .= (!empty($args['conditions'][1]) && $args['conditions'][1]['name'] == 'user_id')
 554             ? sprintf(
 555                 " AND teams.id in (select team_id from team_memberships where user_id = '%s')",
 556                 $db->quote($args['conditions'][1]['value'])
 557             )
 558             : ' AND teams.private = 0';
 559
 560         return $where;
 561     }
 562
 563     /**
 564      * Returns JSON encoded data
 565      *
 566      * @param array $data
 567      * @return string
 568      */
 569     protected function getJsonEncodedData($data)
 570     {
 571         $json = getJSONobj();
 572
 573         return $json->encodeReal($data);
 574     }
 575
 576     /**
 577      * Returns formatted JSON encoded search results
 578      *
 579      * @param array $args
 580      * @param array $results
 581      * @return string
 582      */
 583     protected function getFormattedJsonResults($results, $args)
 584     {
 585         $results = $this->formatResults($results, $args);
 586
 587         return $this->getJsonEncodedData($results);
 588     }
 589
 590     /**
 591      * Returns filtered JSON encoded search results
 592      *
 593      * @param array $results
 594      * @return string
 595      */
 596     protected function getFilteredJsonResults($results)
 597     {
 598         $results = $this->filterResults($results);
 599
 600         return $this->getJsonEncodedData($results);
 601     }
 602
 603     /**
 604      * Returns updated arguments array
 605      *
 606      * @param array $args
 607      * @return array
 608      */
 609     protected function updateQueryArguments($args)
 610     {
 611         $args['order_by_name'] = true;
 612
 613         return $args;
 614     }
 615
 616     /**
 617      * Returns updated arguments array for contact query
 618      *
 619      * @param array $args
 620      * @return array
 621      */
 622     protected function updateContactArrayArguments($args)
 623     {
 624         return $args;
 625     }
 626
 627     /**
 628      * Returns updated arguments array for team query
 629      *
 630      * @param array $args
 631      * @return array
 632      */
 633     protected function updateTeamArrayArguments($args)
 634     {
 635         $this->extra_where = $this->getNonPrivateTeamsWhere($args);
 636         $args['modules'] = array('Teams');
 637
 638         return $args;
 639     }
 640 }