modules/Home/quicksearchQuery.php

   1 <?php
   2 if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
   3 /*********************************************************************************
   4  * SugarCRM 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         return $whereClause;
  95     }
  96
  97     /**
  98      * Query a module for a list of items
  99      *
 100      * @param array $args
 101      * example for querying Account module with 'a':
 102      * array ('modules' => array('Accounts'), // module to use
 103      *        'field_list' => array('name', 'id'), // fields to select
 104      *        'group' => 'or', // how the conditions should be combined
 105      *        'conditions' => array(array( // array of where conditions to use
 106      *                              'name' => 'name', // field
 107      *                              'op' => 'like_custom', // operation
 108      *                              'end' => '%', // end of the query
 109      *                              'value' => 'a',  // query value
 110      *                              )
 111      *                        ),
 112      *        'order' => 'name', // order by
 113      *        'limit' => '30', // limit, number of records to return
 114      *       )
 115      * @return array list of elements returned
 116      */
 117     function query($args) {
 118         $json = getJSONobj();
 119         global $sugar_config;
 120         global $beanFiles, $beanList;
 121
 122         if($sugar_config['list_max_entries_per_page'] < ($args['limit'] + 1)) // override query limits
 123             $sugar_config['list_max_entries_per_page'] = ($args['limit'] + 1);
 124
 125         $list_return = array();
 126
 127         foreach($args['modules'] as $module) {
 128             require_once($beanFiles[$beanList[$module]]);
 129             $focus = new $beanList[$module];
 130
 131             $query_orderby = '';
 132             if (!empty($args['order'])) {
 133                 $query_orderby = $args['order'];
 134                 if ($focus instanceof Person && $args['order'] == 'name') {
 135                         $query_orderby = 'last_name';
 136                 }
 137             }
 138             $query_limit = '';
 139             if (!empty($args['limit'])) {
 140                 $query_limit = $args['limit'];
 141             }
 142
 143             $query_where = $this->constructWhere($args, $focus);
 144
 145             $list_arr = array();
 146             if($focus->ACLAccess('ListView', true)) {
 147                 $GLOBALS['log']->fatal($query_where);
 148                 $curlist = $focus->get_list($query_orderby, $query_where, 0, $query_limit, -1, 0);
 149                 $list_return = array_merge($list_return,$curlist['list']);
 150             }
 151         }
 152         $list_arr = $this->formatResults($args, $list_return);
 153         return $json->encodeReal($list_arr);
 154     }
 155
 156     protected function formatResults($args, $list_return){
 157         $app_list_strings = null;
 158         $list_arr['totalCount']=count($list_return);
 159         $list_arr['fields']= array();
 160         for($i = 0; $i < count($list_return); $i++) {
 161             $list_arr['fields'][$i]= array();
 162             $list_arr['fields'][$i]['module']= $list_return[$i]->object_name;
 163             $listData = $list_return[$i]->get_list_view_data();
 164
 165             foreach($args['field_list'] as $field) {
 166                 // handle enums
 167                 if( (isset($list_return[$i]->field_name_map[$field]['type']) && $list_return[$i]->field_name_map[$field]['type'] == 'enum') ||
 168                     (isset($list_return[$i]->field_name_map[$field]['custom_type']) && $list_return[$i]->field_name_map[$field]['custom_type'] == 'enum')) {
 169
 170                     // get fields to match enum vals
 171                     if(empty($app_list_strings)) {
 172                         if(isset($_SESSION['authenticated_user_language']) && $_SESSION['authenticated_user_language'] != '') $current_language = $_SESSION['authenticated_user_language'];
 173                         else $current_language = $sugar_config['default_language'];
 174                         $app_list_strings = return_app_list_strings_language($current_language);
 175                     }
 176
 177                     // match enum vals to text vals in language pack for return
 178                     if(!empty($app_list_strings[$list_return[$i]->field_name_map[$field]['options']])) {
 179                         $list_return[$i]->$field = $app_list_strings[$list_return[$i]->field_name_map[$field]['options']][$list_return[$i]->$field];
 180                     }
 181                 }
 182
 183
 184                 if (isset($listData[$field]))
 185                         {
 186                     $list_arr['fields'][$i][$field] = $listData[$field];
 187                         }
 188                         else if (isset($list_return[$i]->$field))
 189                 {
 190                     $list_arr['fields'][$i][$field] = $list_return[$i]->$field;
 191                 }
 192                 else {
 193                         $list_arr['fields'][$i][$field] = "";
 194                 }
 195             }
 196         }
 197         if(is_array($list_arr['fields'])) {
 198             foreach ( $list_arr['fields'] as $i => $recordIn ) {
 199                 if(!is_array($recordIn)){
 200                     continue;
 201                 }
 202                 foreach( $recordIn as $col => $dataIn ) {
 203                     if ( !is_scalar($dataIn) ) {
 204                         continue;
 205                     }
 206                     $list_arr['fields'][$i][$col] = html_entity_decode($dataIn,ENT_QUOTES,'UTF-8');
 207                 }
 208             }
 209         }
 210         return $list_arr;
 211     }
 212
 213     /**
 214      * get_contact_array
 215      *
 216      */
 217     function get_contact_array($args) {
 218         $json = getJSONobj();
 219         global $sugar_config, $beanFiles, $beanList, $locale;
 220
 221         if($sugar_config['list_max_entries_per_page'] < ($args['limit'] + 1)) // override query limits
 222             $sugar_config['list_max_entries_per_page'] = ($args['limit'] + 1);
 223
 224         $list_return = array();
 225
 226         foreach($args['modules'] as $module) {
 227             require_once($beanFiles[$beanList[$module]]);
 228             $focus = new $beanList[$module];
 229
 230             $query_orderby = '';
 231             if (!empty($args['order'])) {
 232                 $query_orderby = $args['order'];
 233             }
 234             $query_limit = '';
 235             if (!empty($args['limit'])) {
 236                 $query_limit = $args['limit'];
 237             }
 238             $query_where = $this->constructWhere($args, $focus);
 239             $list_arr = array();
 240             if($focus->ACLAccess('ListView', true)) {
 241                 $curlist = $focus->get_list($query_orderby, $query_where, 0, $query_limit, -1, 0);
 242                 $list_return = array_merge($list_return,$curlist['list']);
 243             }
 244         }
 245         $list_arr['totalCount']=count($list_return);
 246         $list_arr['fields']= array();
 247         for($i = 0; $i < count($list_return); $i++) {
 248             $list_arr['fields'][$i]= array();
 249             $list_arr['fields'][$i]['module']= $list_return[$i]->object_name;
 250             $contactName = "";
 251             foreach($args['field_list'] as $field) {
 252                 // We are overriding the contact_id param and the reports_to_id param to change to 'id'
 253                 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'
 254                     $list_arr['fields'][$i][$field] = $list_return[$i]->id;
 255                 }
 256                 else {
 257                     $list_arr['fields'][$i][$field] = $list_return[$i]->$field;
 258                 }
 259             } //foreach
 260
 261             $contactName = $locale->getLocaleFormattedName($list_arr['fields'][$i]['first_name'],
 262                                                            $list_arr['fields'][$i]['last_name'],
 263                                                            $list_arr['fields'][$i]['salutation']);
 264
 265             $list_arr['fields'][$i][$args['field_list'][0]] = $contactName;
 266         } //for
 267
 268         $str = $json->encodeReal($list_arr);
 269         return $str;
 270     }
 271
 272     /**
 273      * Returns the list of users, faster than using query method for Users module
 274      *
 275      * @param array $args arguments used to construct query, see query() for example
 276      *
 277      * @return array list of users returned
 278      */
 279     function get_user_array($args) {
 280         global $json;
 281         $json = getJSONobj();
 282
 283         $response = array();
 284
 285         if(showFullName()) { // utils.php, if system is configured to show full name
 286                 $user_array = getUserArrayFromFullName($args['conditions'][0]['value']);
 287         } else {
 288             $user_array = get_user_array(false, "Active", '', false, $args['conditions'][0]['value'],null,false);
 289         }
 290         $response['totalCount']=count($user_array);
 291         $response['fields']=array();
 292         $i=0;
 293         foreach($user_array as $id=>$name) {
 294             array_push($response['fields'], array('id' => $id, 'user_name' => $name, 'module' => 'Users'));
 295             $i++;
 296         }
 297
 298         return $json->encodeReal($response);
 299     }
 300
 301 }
 302
 303 $json = getJSONobj();
 304 $data = $json->decode(html_entity_decode($_REQUEST['data']));
 305 if(isset($_REQUEST['query']) && !empty($_REQUEST['query'])){
 306     foreach($data['conditions'] as $k=>$v){
 307         if(empty($data['conditions'][$k]['value'])){
 308                 $data['conditions'][$k]['value']=$_REQUEST['query'];
 309         }
 310     }
 311 }
 312
 313 $quicksearchQuery = new quicksearchQuery();
 314
 315 $method = !empty($data['method']) ? $data['method'] : 'query';
 316 if(method_exists($quicksearchQuery, $method)) {
 317    echo $quicksearchQuery->$method($data);
 318 }
 319
 320 ?>