modules/Home/quicksearchQuery.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-2011 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('include/SugarObjects/templates/person/Person.php');
  39
  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      * Internal function to construct where clauses
  51      */
  52     function constructWhere(&$query_obj, $focus) {
  53         $table = $focus->getTableName();
  54         if (! empty($table)) {
  55             $table .= ".";
  56         }
  57         $cond_arr = array();
  58
  59         if (!is_array($query_obj['conditions'])) {
  60             $query_obj['conditions'] = array();
  61         }
  62
  63         foreach($query_obj['conditions'] as $condition) {
  64                         if($condition['op'] == 'contains') {
  65                         array_push($cond_arr,$GLOBALS['db']->quote($table.$condition['name'])." like '%".$GLOBALS['db']->quote($condition['value'])."%'");
  66                 } else if($condition['op'] == 'like_custom') {
  67                         $like = '';
  68                    if(!empty($condition['begin'])) $like .= $GLOBALS['db']->quote($condition['begin']);
  69                    $like .= $GLOBALS['db']->quote($condition['value']);
  70                    if(!empty($condition['end'])) $like .= $GLOBALS['db']->quote($condition['end']);
  71
  72                    if ($focus instanceof Person){
  73                                 $nameFormat = $GLOBALS['locale']->getLocaleFormatMacro($GLOBALS['current_user']);
  74                     if ( strpos($nameFormat,'l') > strpos($nameFormat,'f') ) {
  75                         array_push($cond_arr,db_concat(rtrim($table,'.'),array('first_name','last_name')) . " like '$like'");
  76                     }
  77                     else {
  78                         array_push($cond_arr,db_concat(rtrim($table,'.'),array('last_name','first_name')) . " like '$like'");
  79                     }
  80                    }
  81                    else {
  82                         array_push($cond_arr,$GLOBALS['db']->quote($table.$condition['name'])." like '$like'");
  83                    }
  84                 } else { // starts_with
  85                          array_push($cond_arr,$GLOBALS['db']->quote($table.$condition['name'])." like '".$GLOBALS['db']->quote($condition['value'])."%'");
  86                 }
  87             }
  88
  89         $whereClause = '('.implode(" {$query_obj['group']} ",$cond_arr).')';
  90
  91         if($table == 'users.')
  92             $whereClause .= " AND {$table}status='Active'";
  93
  94         // Need to include the default whereStatement
  95                 if(!empty($query_obj['whereExtra'])){
  96             if(!empty($whereClause))$whereClause .= ' AND ';
  97             $whereClause .= html_entity_decode($query_obj['whereExtra'],ENT_QUOTES);
  98                 }
  99
 100         return $whereClause;
 101     }
 102
 103     /**
 104      * Query a module for a list of items
 105      *
 106      * @param array $args
 107      * example for querying Account module with 'a':
 108      * array ('modules' => array('Accounts'), // module to use
 109      *        'field_list' => array('name', 'id'), // fields to select
 110      *        'group' => 'or', // how the conditions should be combined
 111      *        'conditions' => array(array( // array of where conditions to use
 112      *                              'name' => 'name', // field
 113      *                              'op' => 'like_custom', // operation
 114      *                              'end' => '%', // end of the query
 115      *                              'value' => 'a',  // query value
 116      *                              )
 117      *                        ),
 118      *        'order' => 'name', // order by
 119      *        'limit' => '30', // limit, number of records to return
 120      *       )
 121      * @return array list of elements returned
 122      */
 123     function query($args) {
 124         $json = getJSONobj();
 125         global $sugar_config;
 126         global $beanFiles, $beanList;
 127
 128         if($sugar_config['list_max_entries_per_page'] < ($args['limit'] + 1)) // override query limits
 129             $sugar_config['list_max_entries_per_page'] = ($args['limit'] + 1);
 130
 131         $list_return = array();
 132
 133         foreach($args['modules'] as $module) {
 134             require_once($beanFiles[$beanList[$module]]);
 135             $focus = new $beanList[$module];
 136
 137             $query_orderby = '';
 138             if (!empty($args['order'])) {
 139                 $query_orderby = $args['order'];
 140                 if ($focus instanceof Person && $args['order'] == 'name') {
 141                         $query_orderby = 'last_name';
 142                 }
 143             }
 144             $query_limit = '';
 145             if (!empty($args['limit'])) {
 146                 $query_limit = $args['limit'];
 147             }
 148
 149             $query_where = $this->constructWhere($args, $focus);
 150
 151             $list_arr = array();
 152             if($focus->ACLAccess('ListView', true))
 153             {
 154                 $curlist = $focus->get_list($query_orderby, $query_where, 0, $query_limit, -1, 0);
 155                 $list_return = array_merge($list_return,$curlist['list']);
 156             }
 157         }
 158         $list_arr = $this->formatResults($args, $list_return);
 159         return $json->encodeReal($list_arr);
 160     }
 161
 162     protected function formatResults($args, $list_return){
 163         global $sugar_config;
 164         $app_list_strings = null;
 165         $list_arr['totalCount']=count($list_return);
 166         $list_arr['fields']= array();
 167         for($i = 0; $i < count($list_return); $i++) {
 168             $list_arr['fields'][$i]= array();
 169             $list_arr['fields'][$i]['module']= $list_return[$i]->object_name;
 170
 171             //C.L.: Bug 43395 - For Quicksearch, do not return values with salutation and title formatting
 172             if($list_return[$i] instanceof Person)
 173             {
 174                $list_return[$i]->createLocaleFormattedName = false;
 175             }
 176
 177             $listData = $list_return[$i]->get_list_view_data();
 178
 179             foreach($args['field_list'] as $field) {
 180                 // handle enums
 181                 if( (isset($list_return[$i]->field_name_map[$field]['type']) && $list_return[$i]->field_name_map[$field]['type'] == 'enum') ||
 182                     (isset($list_return[$i]->field_name_map[$field]['custom_type']) && $list_return[$i]->field_name_map[$field]['custom_type'] == 'enum')) {
 183
 184                     // get fields to match enum vals
 185                     if(empty($app_list_strings)) {
 186                         if(isset($_SESSION['authenticated_user_language']) && $_SESSION['authenticated_user_language'] != '') $current_language = $_SESSION['authenticated_user_language'];
 187                         else $current_language = $sugar_config['default_language'];
 188                         $app_list_strings = return_app_list_strings_language($current_language);
 189                     }
 190
 191                     // match enum vals to text vals in language pack for return
 192                     if(!empty($app_list_strings[$list_return[$i]->field_name_map[$field]['options']])) {
 193                         $list_return[$i]->$field = $app_list_strings[$list_return[$i]->field_name_map[$field]['options']][$list_return[$i]->$field];
 194                     }
 195                 }
 196
 197
 198                 if (isset($listData[$field]))
 199                         {
 200                     $list_arr['fields'][$i][$field] = $listData[$field];
 201                         }
 202                         else if (isset($list_return[$i]->$field))
 203                 {
 204                     $list_arr['fields'][$i][$field] = $list_return[$i]->$field;
 205                 }
 206                 else {
 207                         $list_arr['fields'][$i][$field] = "";
 208                 }
 209             }
 210         }
 211         if(is_array($list_arr['fields'])) {
 212             foreach ( $list_arr['fields'] as $i => $recordIn ) {
 213                 if(!is_array($recordIn)){
 214                     continue;
 215                 }
 216                 foreach( $recordIn as $col => $dataIn ) {
 217                     if ( !is_scalar($dataIn) ) {
 218                         continue;
 219                     }
 220                     $list_arr['fields'][$i][$col] = html_entity_decode($dataIn,ENT_QUOTES,'UTF-8');
 221                 }
 222             }
 223         }
 224         return $list_arr;
 225     }
 226
 227     /**
 228      * get_contact_array
 229      *
 230      */
 231     function get_contact_array($args) {
 232         $json = getJSONobj();
 233         global $sugar_config, $beanFiles, $beanList, $locale;
 234
 235         if($sugar_config['list_max_entries_per_page'] < ($args['limit'] + 1)) // override query limits
 236             $sugar_config['list_max_entries_per_page'] = ($args['limit'] + 1);
 237
 238         $list_return = array();
 239
 240         foreach($args['modules'] as $module) {
 241             require_once($beanFiles[$beanList[$module]]);
 242             $focus = new $beanList[$module];
 243
 244             $query_orderby = '';
 245             if (!empty($args['order'])) {
 246                 $query_orderby = $args['order'];
 247             }
 248             $query_limit = '';
 249             if (!empty($args['limit'])) {
 250                 $query_limit = $args['limit'];
 251             }
 252             $query_where = $this->constructWhere($args, $focus);
 253             $list_arr = array();
 254             if($focus->ACLAccess('ListView', true)) {
 255                 $curlist = $focus->get_list($query_orderby, $query_where, 0, $query_limit, -1, 0);
 256                 $list_return = array_merge($list_return,$curlist['list']);
 257             }
 258         }
 259         $list_arr['totalCount']=count($list_return);
 260         $list_arr['fields']= array();
 261         for($i = 0; $i < count($list_return); $i++) {
 262             $list_arr['fields'][$i]= array();
 263             $list_arr['fields'][$i]['module']= $list_return[$i]->object_name;
 264             $contactName = "";
 265             foreach($args['field_list'] as $field) {
 266                 // We are overriding the contact_id param and the reports_to_id param to change to 'id'
 267                 if(preg_match('/reports_to_id$/s',$field) || preg_match('/contact_id$/s',$field)) {  // We are overriding the reports_to_id param to change to 'id'
 268                     $list_arr['fields'][$i][$field] = $list_return[$i]->id;
 269                 }
 270                 else {
 271                     $list_arr['fields'][$i][$field] = $list_return[$i]->$field;
 272                 }
 273             } //foreach
 274
 275             $contactName = $locale->getLocaleFormattedName($list_arr['fields'][$i]['first_name'],
 276                                                            $list_arr['fields'][$i]['last_name'],
 277                                                            $list_arr['fields'][$i]['salutation']);
 278
 279             $list_arr['fields'][$i][$args['field_list'][0]] = $contactName;
 280         } //for
 281
 282         $str = $json->encodeReal($list_arr);
 283         return $str;
 284     }
 285
 286
 287     /**
 288      * Returns the list of users, faster than using query method for Users module
 289      *
 290      * @param array $args arguments used to construct query, see query() for example
 291      *
 292      * @return array list of users returned
 293      */
 294     function get_user_array($args) {
 295         global $json;
 296         $json = getJSONobj();
 297
 298         $response = array();
 299
 300         if(showFullName()) { // utils.php, if system is configured to show full name
 301                 $user_array = getUserArrayFromFullName($args['conditions'][0]['value'], true);
 302         } else {
 303             $user_array = get_user_array(false, "Active", '', false, $args['conditions'][0]['value'],' AND portal_only=0 ',false);
 304         }
 305         $response['totalCount']=count($user_array);
 306         $response['fields']=array();
 307         $i=0;
 308         foreach($user_array as $id=>$name) {
 309             array_push($response['fields'], array('id' => (string) $id, 'user_name' => $name, 'module' => 'Users'));
 310             $i++;
 311         }
 312
 313         return $json->encodeReal($response);
 314     }
 315
 316
 317     function externalApi($data) {
 318         require_once('include/externalAPI/ExternalAPIFactory.php');
 319
 320         $api = ExternalAPIFactory::loadAPI($data['api']);
 321
 322         $json = getJSONobj();
 323
 324         $listArray['fields'] = $api->searchDoc($_REQUEST['query']);
 325         $listArray['totalCount'] = count($listArray['fields']);
 326
 327         $listJson = $json->encodeReal($listArray);
 328
 329         return $listJson;
 330     }
 331 }
 332
 333 $json = getJSONobj();
 334 $data = $json->decode(html_entity_decode($_REQUEST['data']));
 335 if(isset($_REQUEST['query']) && !empty($_REQUEST['query'])){
 336     foreach($data['conditions'] as $k=>$v){
 337         if(empty($data['conditions'][$k]['value'])){
 338                 $data['conditions'][$k]['value']=$_REQUEST['query'];
 339         }
 340     }
 341 }
 342
 343 $quicksearchQuery = new quicksearchQuery();
 344
 345 $method = !empty($data['method']) ? $data['method'] : 'query';
 346 if(method_exists($quicksearchQuery, $method)) {
 347    echo $quicksearchQuery->$method($data);
 348 }
 349
 350 ?>