2 /*********************************************************************************
3 * SugarCRM Community Edition is a customer relationship management program developed by
4 * SugarCRM, Inc. Copyright (C) 2004-2012 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/tabs.php');
39 require_once('include/ListView/ListViewSmarty.php');
41 require_once('include/TemplateHandler/TemplateHandler.php');
42 require_once('include/EditView/EditView2.php');
43 require_once('include/FileLocator/FileLocator.php');
46 class SearchForm extends EditView{
49 var $action = 'index';
50 var $searchdefs = array();
51 var $listViewDefs = array();
55 var $view = 'SearchForm';
56 var $displayView = 'basic_search';
61 var $parsedView = 'basic';
64 var $displaySavedSearch = true;
65 //show the advanced tab
66 var $showAdvanced = true;
68 var $showBasic = true;
69 //array of custom tab to show declare in searchdefs (no custom tab if false)
70 var $showCustom = false;
73 // hide saved searches drop and down near the search button
74 var $showSavedSearchesOptions = true;
76 var $displayType = 'searchView';
79 * @var FileLocatorInterface
88 function SearchForm($seed, $module, $action = 'index', $options = array()){
89 $this->th = new TemplateHandler();
90 $this->th->loadSmarty();
92 $this->module = $module;
93 $this->action = $action;
94 $this->tabs = array(array('title' => $GLOBALS['app_strings']['LNK_BASIC_SEARCH'],
95 'link' => $module . '|basic_search',
96 'key' => $module . '|basic_search',
99 array('title' => $GLOBALS['app_strings']['LNK_ADVANCED_SEARCH'],
100 'link' => $module . '|advanced_search',
101 'key' => $module . '|advanced_search',
102 'name' => 'advanced',
103 'displayDiv' => 'display:none'),
105 $this->searchColumns = array () ;
106 $this->setOptions($options);
109 public function getFileLocator()
111 if (!$this->fileLocator) {
112 $ref = new ReflectionClass($this->options['locator_class']);
113 $this->fileLocator = $ref->newInstanceArgs($this->options['locator_class_params']);
116 return $this->fileLocator;
119 public function setOptions($options)
122 'locator_class' => 'FileLocator',
123 'locator_class_params' => array(
125 'custom/modules/' . $this->module . '/tpls/SearchForm',
126 'modules/' . $this->module . '/tpls/SearchForm',
127 'custom/include/SearchForm/tpls',
128 'include/SearchForm/tpls'
133 $this->options = empty($options) ? $defaults : $options;
136 function setup($searchdefs, $searchFields = array(), $tpl, $displayView = 'basic_search', $listViewDefs = array()){
137 $this->searchdefs = $searchdefs[$this->module];
139 //used by advanced search
140 $this->listViewDefs = $listViewDefs;
141 $this->displayView = $displayView;
142 $this->view = $this->view.'_'.$displayView;
143 $tokens = explode('_', $this->displayView);
144 $this->parsedView = $tokens[0];
145 if($this->displayView != 'saved_views'){
146 $this->_build_field_defs();
149 $this->searchFields = $searchFields[$this->module];
151 // Setup the tab array.
152 $this->tabs = array();
153 if($this->showBasic){
155 $this->tabs[]=array('title' => $GLOBALS['app_strings']['LNK_BASIC_SEARCH'],
156 'link' => $this->module . '|basic_search',
157 'key' => $this->module . '|basic_search',
161 if($this->showAdvanced){
163 $this->tabs[]=array('title' => $GLOBALS['app_strings']['LNK_ADVANCED_SEARCH'],
164 'link' => $this->module . '|advanced_search',
165 'key' => $this->module . '|advanced_search',
166 'name' => 'advanced',
167 'displayDiv' => 'display:none');
169 if(isset($this->showCustom) && is_array($this->showCustom)){
170 foreach($this->showCustom as $v){
172 $this->tabs[]=array('title' => $GLOBALS['app_strings']["LNK_" . strtoupper($v)],
173 'link' => $this->module . '|' . $v,
174 'key' => $this->module . '|' . $v,
175 'name' => str_replace('_search','',$v),
176 'displayDiv' => 'display:none',);
181 function display($header = true){
182 global $theme, $timedate, $current_user;
186 $this->th->ss->assign('module', $this->module);
187 $this->th->ss->assign('action', $this->action);
188 $this->th->ss->assign('displayView', $this->displayView);
189 $this->th->ss->assign('APP', $GLOBALS['app_strings']);
190 //Show the tabs only if there is more than one
192 $this->th->ss->assign('TABS', $this->_displayTabs($this->module . '|' . $this->displayView));
194 $this->th->ss->assign('searchTableColumnCount',
195 ((isset($this->searchdefs['templateMeta']['maxColumns']) ? $this->searchdefs['templateMeta']['maxColumns'] : 2) * 2 ) - 1);
196 $this->th->ss->assign('fields', $this->fieldDefs);
197 $this->th->ss->assign('customFields', $this->customFieldDefs);
198 $this->th->ss->assign('formData', $this->formData);
199 $time_format = $timedate->get_user_time_format();
200 $this->th->ss->assign('TIME_FORMAT', $time_format);
201 $this->th->ss->assign('USER_DATEFORMAT', $timedate->get_user_date_format());
202 $this->th->ss->assign('CALENDAR_FDOW', $current_user->get_first_day_of_week());
204 $date_format = $timedate->get_cal_date_format();
205 $time_separator = ":";
206 if(preg_match('/\d+([^\d])\d+([^\d]*)/s', $time_format, $match)) {
207 $time_separator = $match[1];
209 // Create Smarty variables for the Calendar picker widget
210 $t23 = strpos($time_format, '23') !== false ? '%H' : '%I';
211 if(!isset($match[2]) || $match[2] == '') {
212 $this->th->ss->assign('CALENDAR_FORMAT', $date_format . ' ' . $t23 . $time_separator . "%M");
214 $pm = $match[2] == "pm" ? "%P" : "%p";
215 $this->th->ss->assign('CALENDAR_FORMAT', $date_format . ' ' . $t23 . $time_separator . "%M" . $pm);
217 $this->th->ss->assign('TIME_SEPARATOR', $time_separator);
219 //Show and hide the good tab form
220 foreach($this->tabs as $tabkey=>$viewtab){
221 $viewName=str_replace(array($this->module . '|','_search'),'',$viewtab['key']);
222 if(strpos($this->view,$viewName)!==false){
223 $this->tabs[$tabkey]['displayDiv']='';
224 //if this is advanced tab, use form with saved search sub form built in
225 if($viewName=='advanced'){
226 $this->tpl = 'SearchFormGenericAdvanced.tpl';
227 if ($this->action =='ListView') {
228 $this->th->ss->assign('DISPLAY_SEARCH_HELP', true);
230 $this->th->ss->assign('DISPLAY_SAVED_SEARCH', $this->displaySavedSearch);
231 $this->th->ss->assign('SAVED_SEARCH', $this->displaySavedSearch());
232 //this determines whether the saved search subform should be rendered open or not
233 if(isset($_REQUEST['showSSDIV']) && $_REQUEST['showSSDIV']=='yes'){
234 $this->th->ss->assign('SHOWSSDIV', 'yes');
235 $this->th->ss->assign('DISPLAYSS', '');
237 $this->th->ss->assign('SHOWSSDIV', 'no');
238 $this->th->ss->assign('DISPLAYSS', 'display:none');
242 $this->tabs[$tabkey]['displayDiv']='display:none';
247 $this->th->ss->assign('TAB_ARRAY', $this->tabs);
250 if ( isset($this->searchdefs['templateMeta']['widths'])
251 && isset($this->searchdefs['templateMeta']['maxColumns'])) {
252 $totalWidth = ( $this->searchdefs['templateMeta']['widths']['label'] +
253 $this->searchdefs['templateMeta']['widths']['field'] ) *
254 $this->searchdefs['templateMeta']['maxColumns'];
255 // redo the widths in case they are too big
256 if ( $totalWidth > 100 ) {
257 $resize = 100 / $totalWidth;
258 $this->searchdefs['templateMeta']['widths']['label'] =
259 $this->searchdefs['templateMeta']['widths']['label'] * $resize;
260 $this->searchdefs['templateMeta']['widths']['field'] =
261 $this->searchdefs['templateMeta']['widths']['field'] * $resize;
264 $this->th->ss->assign('templateMeta', $this->searchdefs['templateMeta']);
265 $this->th->ss->assign('HAS_ADVANCED_SEARCH', !empty($this->searchdefs['layout']['advanced_search']));
266 $this->th->ss->assign('displayType', $this->displayType);
267 // return the form of the shown tab only
268 if($this->showSavedSearchesOptions){
269 $this->th->ss->assign('SAVED_SEARCHES_OPTIONS', $this->displaySavedSearchSelect());
271 if ($this->module == 'Documents'){
272 $this->th->ss->assign('DOCUMENTS_MODULE', true);
274 $return_txt = $this->th->displayTemplate($this->seed->module_dir, 'SearchForm_'.$this->parsedView, $this->getFileLocator()->locate($this->tpl));
276 $this->th->ss->assign('return_txt', $return_txt);
277 $header_txt = $this->th->displayTemplate($this->seed->module_dir, 'SearchFormHeader', $this->getFileLocator()->locate('header.tpl'));
278 //pass in info to render the select dropdown below the form
279 $footer_txt = $this->th->displayTemplate($this->seed->module_dir, 'SearchFormFooter', $this->getFileLocator()->locate('footer.tpl'));
280 $return_txt = $header_txt.$footer_txt;
285 function displaySavedSearch(){
286 $savedSearch = new SavedSearch($this->listViewDefs[$this->module], $this->lv->data['pageData']['ordering']['orderBy'], $this->lv->data['pageData']['ordering']['sortOrder']);
287 return $savedSearch->getForm($this->module, false);
291 function displaySavedSearchSelect(){
292 $savedSearch = new SavedSearch($this->listViewDefs[$this->module], $this->lv->data['pageData']['ordering']['orderBy'], $this->lv->data['pageData']['ordering']['sortOrder']);
293 return $savedSearch->getSelect($this->module);
299 * displays the tabs (top of the search form)
301 * @param string $currentKey key in $this->tabs to show as the current tab
303 * @return string html
305 function _displayTabs($currentKey)
307 if(isset($_REQUEST['saved_search_select']) && $_REQUEST['saved_search_select']!='_none') {
308 $saved_search=loadBean('SavedSearch');
309 $saved_search->retrieveSavedSearch($_REQUEST['saved_search_select']);
313 if(!empty($_REQUEST['displayColumns']))
314 $str .= 'SUGAR.savedViews.displayColumns = "' . $_REQUEST['displayColumns'] . '";';
315 elseif(isset($saved_search->contents['displayColumns']) && !empty($saved_search->contents['displayColumns']))
316 $str .= 'SUGAR.savedViews.displayColumns = "' . $saved_search->contents['displayColumns'] . '";';
317 if(!empty($_REQUEST['hideTabs']))
318 $str .= 'SUGAR.savedViews.hideTabs = "' . $_REQUEST['hideTabs'] . '";';
319 elseif(isset($saved_search->contents['hideTabs']) && !empty($saved_search->contents['hideTabs']))
320 $str .= 'SUGAR.savedViews.hideTabs = "' . $saved_search->contents['hideTabs'] . '";';
321 if(!empty($_REQUEST['orderBy']))
322 $str .= 'SUGAR.savedViews.selectedOrderBy = "' . $_REQUEST['orderBy'] . '";';
323 elseif(isset($saved_search->contents['orderBy']) && !empty($saved_search->contents['orderBy']))
324 $str .= 'SUGAR.savedViews.selectedOrderBy = "' . $saved_search->contents['orderBy'] . '";';
325 if(!empty($_REQUEST['sortOrder']))
326 $str .= 'SUGAR.savedViews.selectedSortOrder = "' . $_REQUEST['sortOrder'] . '";';
327 elseif(isset($saved_search->contents['sortOrder']) && !empty($saved_search->contents['sortOrder']))
328 $str .= 'SUGAR.savedViews.selectedSortOrder = "' . $saved_search->contents['sortOrder'] . '";';
338 function _build_field_defs(){
339 $this->formData = array();
340 $this->fieldDefs = array();
341 foreach($this->searchdefs['layout'][$this->displayView] as $data){
343 //Fields may be listed but disabled so that when they are enabled, they have the correct custom display data.
344 if (isset($data['enabled']) && $data['enabled'] == false)
346 $data['name'] = $data['name'].'_'.$this->parsedView;
347 $this->formData[] = array('field' => $data);
348 $this->fieldDefs[$data['name']]= $data;
350 $this->formData[] = array('field' => array('name'=>$data.'_'.$this->parsedView));
355 $this->seed->fill_in_additional_detail_fields();
356 // hack to make the employee status field for the Users/Employees module display correctly
357 if($this->seed->object_name == 'Employee' || $this->seed->object_name == 'User'){
358 $this->seed->field_defs['employee_status']['type'] = 'enum';
359 $this->seed->field_defs['employee_status']['massupdate'] = true;
360 $this->seed->field_defs['employee_status']['options'] = 'employee_status_dom';
361 unset($this->seed->field_defs['employee_status']['function']);
364 foreach($this->seed->toArray() as $name => $value) {
365 $fvName = $name.'_'.$this->parsedView;
366 if(!empty($this->fieldDefs[$fvName]))
367 $this->fieldDefs[$fvName] = array_merge($this->seed->field_defs[$name], $this->fieldDefs[$fvName]);
369 $this->fieldDefs[$fvName] = $this->seed->field_defs[$name];
370 $this->fieldDefs[$fvName]['name'] = $this->fieldDefs[$fvName]['name'].'_'.$this->parsedView;
373 if(isset($this->fieldDefs[$fvName]['type']) && $this->fieldDefs[$fvName]['type'] == 'relate') {
374 if(isset($this->fieldDefs[$fvName]['id_name'])) {
375 $this->fieldDefs[$fvName]['id_name'] .= '_'.$this->parsedView;
379 if(isset($this->fieldDefs[$fvName]['options']) && isset($GLOBALS['app_list_strings'][$this->fieldDefs[$fvName]['options']]))
382 $this->fieldDefs[$fvName]['options'] = $GLOBALS['app_list_strings'][$this->fieldDefs[$fvName]['options']];
383 //Hack to add blanks for parent types on search views
384 if ($this->fieldDefs[$fvName]['type'] == "parent_type" || $this->fieldDefs[$fvName]['type'] == "parent")
386 $this->fieldDefs[$fvName]['options'] = array_merge(array(""=>""), $this->fieldDefs[$fvName]['options']);
390 if(isset($this->fieldDefs[$fvName]['function'])) {
392 $this->fieldDefs[$fvName]['type']='multienum';
394 if(is_array($this->fieldDefs[$fvName]['function'])) {
395 $this->fieldDefs[$fvName]['function']['preserveFunctionValue']=true;
398 $function = $this->fieldDefs[$fvName]['function'];
400 if(is_array($function) && isset($function['name'])){
401 $function_name = $this->fieldDefs[$fvName]['function']['name'];
403 $function_name = $this->fieldDefs[$fvName]['function'];
406 if(!empty($this->fieldDefs[$fvName]['function']['returns']) && $this->fieldDefs[$fvName]['function']['returns'] == 'html'){
407 if(!empty($this->fieldDefs[$fvName]['function']['include'])){
408 require_once($this->fieldDefs[$fvName]['function']['include']);
410 $value = call_user_func($function_name, $this->seed, $name, $value, $this->view);
411 $this->fieldDefs[$fvName]['value'] = $value;
413 if(!isset($function['params']) || !is_array($function['params'])) {
414 $this->fieldDefs[$fvName]['options'] = call_user_func($function_name, $this->seed, $name, $value, $this->view);
416 $this->fieldDefs[$fvName]['options'] = call_user_func_array($function_name, $function['params']);
420 if(isset($this->fieldDefs[$name]['type']) && $this->fieldDefs[$fvName]['type'] == 'function'
421 && isset($this->fieldDefs[$fvName]['function_name']))
423 $value = $this->callFunction($this->fieldDefs[$fvName]);
424 $this->fieldDefs[$fvName]['value'] = $value;
427 $this->fieldDefs[$name]['value'] = $value;
430 if((!empty($_REQUEST[$fvName]) || (isset($_REQUEST[$fvName]) && $_REQUEST[$fvName] == '0'))
431 && empty($this->fieldDefs[$fvName]['function']['preserveFunctionValue'])) {
432 $value = $_REQUEST[$fvName];
433 $this->fieldDefs[$fvName]['value'] = $value;
444 * Populate the searchFields from an array
446 * @param array $array array to search through
447 * @param string $switchVar variable to use in switch statement
448 * @param bool $addAllBeanFields true to process at all bean fields
450 function populateFromArray(&$array, $switchVar = null, $addAllBeanFields = true) {
452 if((!empty($array['searchFormTab']) || !empty($switchVar)) && !empty($this->searchFields)) {
453 $arrayKeys = array_keys($array);
454 $searchFieldsKeys = array_keys($this->searchFields);
455 if(empty($switchVar)) $switchVar = $array['searchFormTab'];
456 //name of the search tab
457 $SearchName=str_replace('_search', '', $switchVar);
458 if($switchVar=='saved_views'){
459 foreach($this->searchFields as $name => $params) {
460 foreach($this->tabs as $tabName){
461 if(!empty($array[$name . '_' . $tabName['name']])) {
462 $this->searchFields[$name]['value'] = $array[$name . '_' . $tabName['name']];
463 if(empty($this->fieldDefs[$name . '_' . $tabName['name']]['value'])) $this->fieldDefs[$name . '_' . $tabName['name']]['value'] = $array[$name . '_' . $tabName['name']];
467 if($addAllBeanFields) {
468 foreach($this->seed->field_name_map as $key => $params) {
469 if(!in_array($key, $searchFieldsKeys)) {
470 foreach($this->tabs->name as $tabName){
471 if(in_array($key . '_' . $tabName['name'], $arrayKeys) ) {
472 $this->searchFields[$key] = array('query_type' => 'default',
473 'value' => $array[$key . '_' . $tabName['name']]);
481 $fromMergeRecords = isset($array['merge_module']);
483 foreach($this->searchFields as $name => $params) {
484 $long_name = $name.'_'.$SearchName;
485 /*nsingh 21648: Add additional check for bool values=0. empty() considers 0 to be empty Only repopulates if value is 0 or 1:( */
486 if (isset($array[$long_name]) && ( $array[$long_name] !== '' || (isset($this->fieldDefs[$long_name]['type']) && $this->fieldDefs[$long_name]['type'] == 'bool'&& ($array[$long_name]=='0' || $array[$long_name]=='1'))))
488 $this->searchFields[$name]['value'] = $array[$long_name];
489 if(empty($this->fieldDefs[$long_name]['value'])) {
490 $this->fieldDefs[$long_name]['value'] = $array[$long_name];
493 else if(!empty($array[$name]) && !$fromMergeRecords) // basic
495 $this->searchFields[$name]['value'] = $array[$name];
496 if(empty($this->fieldDefs[$long_name]['value'])) {
497 $this->fieldDefs[$long_name]['value'] = $array[$name];
501 if(!empty($params['enable_range_search']) && isset($this->searchFields[$name]['value']))
503 if(preg_match('/^range_(.*?)$/', $long_name, $match) && isset($array[$match[1].'_range_choice']))
505 $this->searchFields[$name]['operator'] = $array[$match[1].'_range_choice'];
509 if(!empty($params['is_date_field']) && isset($this->searchFields[$name]['value']))
512 // FG - bug 45287 - to db conversion is ok, but don't adjust timezone (not now), otherwise you'll jump to the day before (if at GMT-xx)
513 $date_value = $timedate->to_db_date($this->searchFields[$name]['value'], false);
514 $this->searchFields[$name]['value'] = $date_value == '' ? $this->searchFields[$name]['value'] : $date_value;
518 if((empty($array['massupdate']) || $array['massupdate'] == 'false') && $addAllBeanFields) {
519 foreach($this->seed->field_name_map as $key => $params) {
520 if($key != 'assigned_user_name' && $key != 'modified_by_name')
522 $long_name = $key.'_'.$SearchName;
524 if(in_array($key.'_'.$SearchName, $arrayKeys) && !in_array($key, $searchFieldsKeys))
526 $this->searchFields[$key] = array('query_type' => 'default', 'value' => $array[$long_name]);
528 if (!empty($params['type']) && $params['type'] == 'parent'
529 && !empty($params['type_name']) && !empty($this->searchFields[$key]['value']))
531 require_once('include/SugarFields/SugarFieldHandler.php');
532 $sfh = new SugarFieldHandler();
533 $sf = $sfh->getSugarField('Parent');
535 $this->searchFields[$params['type_name']] = array('query_type' => 'default',
536 'value' => $sf->getSearchInput($params['type_name'], $array));
539 if(empty($this->fieldDefs[$long_name]['value'])) {
540 $this->fieldDefs[$long_name]['value'] = $array[$long_name];
550 if ( is_array($this->searchFields) ) {
551 foreach ( $this->searchFields as $fieldName => $field ) {
552 if ( !empty($field['value']) && is_string($field['value']) ) {
553 $this->searchFields[$fieldName]['value'] = trim($field['value']);
561 * Populate the searchFields from $_REQUEST
563 * @param string $switchVar variable to use in switch statement
564 * @param bool $addAllBeanFields true to process at all bean fields
566 function populateFromRequest($switchVar = null, $addAllBeanFields = true) {
567 $this->populateFromArray($_REQUEST, $switchVar, $addAllBeanFields);
572 * Parse date expression and return WHERE clause
573 * @param string $operator Date expression operator
574 * @param string DB field name
575 * @param string DB field type
577 protected function parseDateExpression($operator, $db_field, $field_type = '')
579 if ($field_type == "date") {
586 $dates = TimeDate::getInstance()->parseDateRange($operator, null, $adjForTZ);
587 if(empty($dates)) return '';
588 $start = $this->seed->db->convert($this->seed->db->quoted($dates[0]->asDb()), $type);
589 $end = $this->seed->db->convert($this->seed->db->quoted($dates[1]->asDb()), $type);
590 return "($db_field >= $start AND $db_field <= $end)";
594 * generateSearchWhere
596 * This function serves as the central piece of SearchForm2.php
597 * It is responsible for creating the WHERE clause for a given search operation
599 * @param bool $add_custom_fields boolean indicating whether or not custom fields should be added
600 * @param string $module Module to search against
602 * @return string the SQL WHERE clause based on the arguments supplied in SearchForm2 instance
604 public function generateSearchWhere($add_custom_fields = false, $module='') {
607 $db = $this->seed->db;
608 $this->searchColumns = array () ;
609 $values = $this->searchFields;
611 $where_clauses = array();
613 $table_name = $this->seed->object_name;
614 $this->seed->fill_in_additional_detail_fields();
616 //rrs check for team_id
618 foreach($this->searchFields as $field=>$parms) {
619 $customField = false;
620 // Jenny - Bug 7462: We need a type check here to avoid database errors
621 // when searching for numeric fields. This is a temporary fix until we have
622 // a generic search form validation mechanism.
623 $type = (!empty($this->seed->field_name_map[$field]['type']))?$this->seed->field_name_map[$field]['type']:'';
625 //If range search is enabled for the field, we first check if this is the starting range
626 if(!empty($parms['enable_range_search']) && empty($type))
628 if(preg_match('/^start_range_(.*?)$/', $field, $match))
630 $real_field = $match[1];
631 $start_field = 'start_range_' . $real_field;
632 $end_field = 'end_range_' . $real_field;
634 if(isset($this->searchFields[$start_field]['value']) && isset($this->searchFields[$end_field]['value']))
636 $this->searchFields[$real_field]['value'] = $this->searchFields[$start_field]['value'] . '<>' . $this->searchFields[$end_field]['value'];
637 $this->searchFields[$real_field]['operator'] = 'between';
638 $parms['value'] = $this->searchFields[$real_field]['value'];
639 $parms['operator'] = 'between';
641 $field_type = isset($this->seed->field_name_map[$real_field]['type']) ? $this->seed->field_name_map[$real_field]['type'] : '';
642 if($field_type == 'datetimecombo' || $field_type == 'datetime')
647 $field = $real_field;
648 unset($this->searchFields[$end_field]['value']);
650 } else if (preg_match('/^range_(.*?)$/', $field, $match) && isset($this->searchFields[$field]['value'])) {
651 $real_field = $match[1];
653 //Special case for datetime and datetimecombo fields. By setting the type here we allow an actual between search
654 if(in_array($parms['operator'], array('=', 'between', "not_equal", 'less_than', 'greater_than', 'less_than_equals', 'greater_than_equals')))
656 $field_type = isset($this->seed->field_name_map[$real_field]['type']) ? $this->seed->field_name_map[$real_field]['type'] : '';
657 if(strtolower($field_type) == 'readonly' && isset($this->seed->field_name_map[$real_field]['dbType'])) {
658 $field_type = $this->seed->field_name_map[$real_field]['dbType'];
660 if($field_type == 'datetimecombo' || $field_type == 'datetime' || $field_type == 'int')
666 $this->searchFields[$real_field]['value'] = $this->searchFields[$field]['value'];
667 $this->searchFields[$real_field]['operator'] = $this->searchFields[$field]['operator'];
668 $params['value'] = $this->searchFields[$field]['value'];
669 $params['operator'] = $this->searchFields[$field]['operator'];
670 unset($this->searchFields[$field]['value']);
671 $field = $real_field;
673 //Skip this range search field, it is the end field THIS IS NEEDED or the end range date will break the query
678 //Test to mark whether or not the field is a custom field
679 if(!empty($this->seed->field_name_map[$field]['source'])
680 && ($this->seed->field_name_map[$field]['source'] == 'custom_fields' ||
681 //Non-db custom fields, such as custom relates
682 ($this->seed->field_name_map[$field]['source'] == 'non-db'
683 && (!empty($this->seed->field_name_map[$field]['custom_module']) ||
684 isset($this->seed->field_name_map[$field]['ext2']))))){
688 if ($type == 'int' && isset($parms['value']) && !empty($parms['value'])) {
689 require_once ('include/SugarFields/SugarFieldHandler.php');
690 $intField = SugarFieldHandler::getSugarField('int');
691 $newVal = $intField->getSearchWhereValue($parms['value']);
692 $parms['value'] = $newVal;
693 } elseif($type == 'html' && $customField) {
698 if(isset($parms['value']) && $parms['value'] != "") {
700 $operator = $db->isNumericType($type)?'=':'like';
701 if(!empty($parms['operator'])) {
702 $operator = strtolower($parms['operator']);
705 if(is_array($parms['value'])) {
708 // always construct the where clause for multiselects using the 'like' form to handle combinations of multiple $vals and multiple $parms
709 if(!empty($this->seed->field_name_map[$field]['isMultiSelect']) && $this->seed->field_name_map[$field]['isMultiSelect']) {
710 // construct the query for multenums
711 // use the 'like' query as both custom and OOB multienums are implemented with types that cannot be used with an 'in'
712 $operator = 'custom_enum';
713 $table_name = $this->seed->table_name ;
715 $table_name .= "_cstm" ;
716 $db_field = $table_name . "." . $field;
718 foreach($parms['value'] as $val) {
719 if($val != ' ' and $val != '') {
720 $qVal = $db->quote($val);
721 if (!empty($field_value)) {
722 $field_value .= ' or ';
724 $field_value .= "$db_field like '%^$qVal^%'";
726 $field_value .= '('.$db_field . ' IS NULL or '.$db_field."='^^' or ".$db_field."='')";
731 $operator = $operator != 'subquery' ? 'in' : $operator;
732 foreach($parms['value'] as $val) {
733 if($val != ' ' and $val != '') {
734 if (!empty($field_value)) {
737 $field_value .= $db->quoteType($type, $val);
739 // Bug 41209: adding a new operator "isnull" here
740 // to handle the case when blank is selected from dropdown.
741 // In that case, $val is empty.
742 // When $val is empty, we need to use "IS NULL",
743 // as "in (null)" won't work
744 else if ($operator=='in') {
745 $operator = 'isnull';
751 $field_value = $parms['value'];
754 //set db_fields array.
755 if(!isset($parms['db_field'])) {
756 $parms['db_field'] = array($field);
759 //This if-else block handles the shortcut checkbox selections for "My Items" and "Closed Only"
760 if(!empty($parms['my_items'])) {
761 if( $parms['value'] == false ) {
764 //my items is checked.
765 global $current_user;
766 $field_value = $db->quote($current_user->id);
769 } else if(!empty($parms['closed_values']) && is_array($parms['closed_values'])) {
770 if( $parms['value'] == false ) {
774 foreach($parms['closed_values'] as $closed_value)
776 $field_value .= "," . $db->quoted($closed_value);
778 $field_value = substr($field_value, 1);
785 if($field_value != '' || $operator=='isnull') {
787 $this->searchColumns [ strtoupper($field) ] = $field ;
789 foreach ($parms['db_field'] as $db_field) {
790 if (strstr($db_field, '.') === false) {
791 //Try to get the table for relate fields from link defs
792 if ($type == 'relate' && !empty($this->seed->field_name_map[$field]['link'])
793 && !empty($this->seed->field_name_map[$field]['rname'])) {
794 $link = $this->seed->field_name_map[$field]['link'];
795 $relname = $link['relationship'];
796 if (($this->seed->load_relationship($link))){
798 $db_field = $this->seed->field_name_map[$field]['name'];
800 //Best Guess for table name
801 $db_field = strtolower($link['module']) . '.' . $db_field;
806 else if ($type == 'parent') {
807 if (!empty($this->searchFields['parent_type'])) {
808 $parentType = $this->searchFields['parent_type'];
809 $rel_module = $parentType['value'];
810 global $beanFiles, $beanList;
811 if(!empty($beanFiles[$beanList[$rel_module]])) {
812 require_once($beanFiles[$beanList[$rel_module]]);
813 $rel_seed = new $beanList[$rel_module]();
814 $db_field = 'parent_' . $rel_module . '_' . $rel_seed->table_name . '.name';
818 // Relate fields in custom modules and custom relate fields
819 else if ($type == 'relate' && $customField && !empty($this->seed->field_name_map[$field]['module'])) {
820 $db_field = !empty($this->seed->field_name_map[$field]['name'])?$this->seed->field_name_map[$field]['name']:'name';
822 else if(!$customField){
823 if ( !empty($this->seed->field_name_map[$field]['db_concat_fields']) )
824 $db_field = $db->concat($this->seed->table_name, $this->seed->field_name_map[$db_field]['db_concat_fields']);
826 $db_field = $this->seed->table_name . "." . $db_field;
828 if ( !empty($this->seed->field_name_map[$field]['db_concat_fields']) )
829 $db_field = $db->concat($this->seed->table_name . "_cstm.", $this->seed->field_name_map[$db_field]['db_concat_fields']);
831 $db_field = $this->seed->table_name . "_cstm." . $db_field;
836 if($type == 'date') {
837 // The regular expression check is to circumvent special case YYYY-MM
839 if(preg_match('/^\d{4}.\d{1,2}$/', $field_value) != 0) { // preg_match returns number of matches
840 $db_field = $this->seed->db->convert($db_field, "date_format", array("%Y-%m"));
842 $field_value = $timedate->to_db_date($field_value, false);
843 $db_field = $this->seed->db->convert($db_field, "date_format", array("%Y-%m-%d"));
847 if($type == 'datetime' || $type == 'datetimecombo') {
849 if($operator == '=' || $operator == 'between') {
850 // FG - bug45287 - If User asked for a range, takes edges from it.
851 $placeholderPos = strpos($field_value, "<>");
852 if ($placeholderPos !== FALSE && $placeholderPos > 0)
854 $datesLimit = explode("<>", $field_value);
855 $dateStart = $timedate->getDayStartEndGMT($datesLimit[0]);
856 $dateEnd = $timedate->getDayStartEndGMT($datesLimit[1]);
858 $dates['end'] = $dateEnd['end'];
859 $dates['enddate'] = $dateEnd['enddate'];
860 $dates['endtime'] = $dateEnd['endtime'];
864 $dates = $timedate->getDayStartEndGMT($field_value);
866 // FG - bug45287 - Note "start" and "end" are the correct interval at GMT timezone
867 $field_value = array($dates["start"], $dates["end"]);
868 $operator = 'between';
869 } else if($operator == 'not_equal') {
870 $dates = $timedate->getDayStartEndGMT($field_value);
871 $field_value = array($dates["start"], $dates["end"]);
872 $operator = 'date_not_equal';
873 } else if($operator == 'greater_than') {
874 $dates = $timedate->getDayStartEndGMT($field_value);
875 $field_value = $dates["end"];
876 } else if($operator == 'less_than') {
877 $dates = $timedate->getDayStartEndGMT($field_value);
878 $field_value = $dates["start"];
879 } else if($operator == 'greater_than_equals') {
880 $dates = $timedate->getDayStartEndGMT($field_value);
881 $field_value = $dates["start"];
882 } else if($operator == 'less_than_equals') {
883 $dates = $timedate->getDayStartEndGMT($field_value);
884 $field_value = $dates["end"];
886 } catch(Exception $timeException) {
887 //In the event that a date value is given that cannot be correctly processed by getDayStartEndGMT method,
888 //just skip searching on this field and continue. This may occur if user switches locale date formats
889 //in another browser screen, but re-runs a search with the previous format on another screen
890 $GLOBALS['log']->error($timeException->getMessage());
895 if($type == 'decimal' || $type == 'float' || $type == 'currency' || (!empty($parms['enable_range_search']) && empty($parms['is_date_field']))) {
896 require_once('modules/Currencies/Currency.php');
898 //we need to handle formatting either a single value or 2 values in case the 'between' search option is set
899 //start by splitting the string if the between operator exists
900 $fieldARR = explode('<>', $field_value);
901 //set the first pass through boolean
903 foreach($fieldARR as $fv){
904 //reset the field value, it will be rebuild in the foreach loop below
905 $tmpfield_value = unformat_number($fv);
907 if ( $type == 'currency' && stripos($field,'_usdollar')!==FALSE ) {
908 // It's a US Dollar field, we need to do some conversions from the user's local currency
909 $currency_id = $GLOBALS['current_user']->getPreference('currency');
910 if ( empty($currency_id) ) {
913 if ( $currency_id != -99 ) {
914 $currency = new Currency();
915 $currency->retrieve($currency_id);
916 $tmpfield_value = $currency->convertToDollar($tmpfield_value);
919 $values[] = $tmpfield_value;
922 $field_value = join('<>',$values);
924 if(!empty($parms['enable_range_search']) && $parms['operator'] == '=' && $type != 'int')
926 // Databases can't really search for floating point numbers, because they can't be accurately described in binary,
927 // So we have to fuzz out the math a little bit
928 $field_value = array(($field_value - 0.01) , ($field_value + 0.01));
929 $operator = 'between';
934 if($db->supports("case_sensitive") && isset($parms['query_type']) && $parms['query_type'] == 'case_insensitive') {
935 $db_field = 'upper(' . $db_field . ")";
936 $field_value = strtoupper($field_value);
944 //Here we make a last attempt to determine the field type if possible
945 if(empty($type) && isset($parms['db_field']) && isset($parms['db_field'][0]) && isset($this->seed->field_defs[$parms['db_field'][0]]['type']))
947 $type = $this->seed->field_defs[$parms['db_field'][0]]['type'];
950 switch(strtolower($operator)) {
953 if ( isset($parms['subquery_in_clause']) ) {
954 if ( !is_array($parms['subquery_in_clause']) ) {
955 $in = $parms['subquery_in_clause'];
957 elseif ( isset($parms['subquery_in_clause'][$field_value]) ) {
958 $in = $parms['subquery_in_clause'][$field_value];
961 $sq = $parms['subquery'];
964 if (isset($sq['OR'])){
969 if(empty($q) || strlen($q)<2) continue;
973 $where .= " {$db_field} $in ({$q} ".$this->seed->db->quoted($field_value.'%').") ";
976 }elseif(!empty($parms['query_type']) && $parms['query_type'] == 'format'){
977 $stringFormatParams = array(0 => $field_value, 1 => $GLOBALS['current_user']->id);
978 $where .= "{$db_field} $in (".string_format($parms['subquery'], $stringFormatParams).")";
980 //Bug#37087: Re-write our sub-query to it is executed first and contents stored in a derived table to avoid mysql executing the query
981 //outside in. Additional details: http://bugs.mysql.com/bug.php?id=9021
982 $where .= "{$db_field} $in (select * from ({$parms['subquery']} ".$this->seed->db->quoted($field_value.'%').") as {$field}_derived)";
988 if($type == 'bool' && $field_value == 0) {
989 // Bug 43452 - FG - Added parenthesis surrounding the OR (without them the WHERE clause would be broken)
990 $where .= "( " . $db_field . " = '0' OR " . $db_field . " IS NULL )";
993 //check to see if this is coming from unified search or not
994 $UnifiedSearch = !empty($parms['force_unifiedsearch']);
995 if(isset($_REQUEST['action']) && $_REQUEST['action'] == 'UnifiedSearch'){
996 $UnifiedSearch = true;
999 //check to see if this is a universal search OR the field has db_concat_fields set in vardefs, AND the field name is "last_name"
1000 //BUG 45709: Tasks Advanced Search: Contact Name field does not return matches on full names
1001 //Frank: Adding Surabhi's fix back which seem to have gone missing in CottonCandy merge
1002 if(($UnifiedSearch || !empty($this->seed->field_name_map[$field]['db_concat_fields'])) && strpos($db_field, 'last_name') !== false){
1003 //split the string value, and the db field name
1004 $string = explode(' ', $field_value);
1005 $column_name = explode('.', $db_field);
1006 //when a search is done with a space, we concatenate and search against the full name.
1007 if(count($string)>1){
1008 //add where clause against concatenated fields
1009 $where .= $this->seed->db->concat($column_name[0],array('first_name','last_name')) . " LIKE ".$this->seed->db->quoted($field_value.'%');
1010 $where .= ' OR ' . $this->seed->db->concat($column_name[0],array('last_name','first_name')) . " LIKE ".$this->seed->db->quoted($field_value.'%');
1012 //no space was found, add normal where clause
1013 $where .= $db_field . " like ".$this->seed->db->quoted(sql_like_string($field_value, $like_char));
1018 //Check if this is a first_name, last_name search
1019 if(isset($this->seed->field_name_map) && isset($this->seed->field_name_map[$db_field]))
1021 $vardefEntry = $this->seed->field_name_map[$db_field];
1022 if(!empty($vardefEntry['db_concat_fields']) && in_array('first_name', $vardefEntry['db_concat_fields']) && in_array('last_name', $vardefEntry['db_concat_fields']))
1024 if(!empty($GLOBALS['app_list_strings']['salutation_dom']) && is_array($GLOBALS['app_list_strings']['salutation_dom']))
1026 foreach($GLOBALS['app_list_strings']['salutation_dom'] as $salutation)
1028 if(!empty($salutation) && strpos($field_value, $salutation) === 0)
1030 $field_value = trim(substr($field_value, strlen($salutation)));
1038 //field is not last name or this is not from global unified search, so do normal where clause
1039 $where .= $db_field . " like ".$this->seed->db->quoted(sql_like_string($field_value, $like_char));
1044 $where .= $db_field . ' not in ('.$field_value.')';
1047 $where .= $db_field . ' in ('.$field_value.')';
1050 if($type == 'bool' && $field_value == 0) {
1051 $where .= "($db_field = 0 OR $db_field IS NULL)";
1054 $where .= $db_field . " = ".$db->quoteType($type, $field_value);
1057 // tyoung bug 15971 - need to add these special cases into the $where query
1059 $where .= $field_value;
1062 if(!is_array($field_value)) {
1063 $field_value = explode('<>', $field_value);
1065 $field_value[0] = $db->quoteType($type, $field_value[0]);
1066 $field_value[1] = $db->quoteType($type, $field_value[1]);
1067 $where .= "($db_field >= {$field_value[0]} AND $db_field <= {$field_value[1]})";
1069 case 'date_not_equal':
1070 if(!is_array($field_value)) {
1071 $field_value = explode('<>', $field_value);
1073 $field_value[0] = $db->quoteType($type, $field_value[0]);
1074 $field_value[1] = $db->quoteType($type, $field_value[1]);
1075 $where .= "($db_field IS NULL OR $db_field < {$field_value[0]} OR $db_field > {$field_value[1]})";
1078 $this->seed->listview_inner_join[] = $parms['innerjoin'] . " '" . $parms['value'] . "%')";
1081 $field_value = $db->quoteType($type, $field_value);
1082 $where .= "($db_field IS NULL OR $db_field != $field_value)";
1084 case 'greater_than':
1085 $field_value = $db->quoteType($type, $field_value);
1086 $where .= "$db_field > $field_value";
1088 case 'greater_than_equals':
1089 $field_value = $db->quoteType($type, $field_value);
1090 $where .= "$db_field >= $field_value";
1093 $field_value = $db->quoteType($type, $field_value);
1094 $where .= "$db_field < $field_value";
1096 case 'less_than_equals':
1097 $field_value = $db->quoteType($type, $field_value);
1098 $where .= "$db_field <= $field_value";
1105 case 'last_30_days':
1106 case 'next_30_days':
1110 if (!empty($field) && !empty($this->seed->field_name_map[$field]['type'])) {
1111 $where .= $this->parseDateExpression(strtolower($operator), $db_field, $this->seed->field_name_map[$field]['type']);
1113 $where .= $this->parseDateExpression(strtolower($operator), $db_field);
1117 $where .= "($db_field IS NULL OR $db_field = '')";
1118 if ($field_value != '')
1119 $where .= ' OR ' . $db_field . " in (".$field_value.')';
1125 if(!empty($where)) {
1127 array_push($where_clauses, '( '.$where.' )');
1130 array_push($where_clauses, $where);
1136 return $where_clauses;
1142 * isEmptyDropdownField
1144 * This function checks to see if a blank dropdown field was supplied. This scenario will occur where
1145 * a dropdown select is in single selection mode
1147 * @param $value Mixed dropdown value
1149 private function isEmptyDropdownField($name='', $value=array())
1151 $result = is_array($value) && isset($value[0]) && $value[0] == '';
1152 $GLOBALS['log']->debug("Found empty value for {$name} dropdown search key");
1157 * Return the search defs for a particular module.
1162 public static function retrieveSearchDefs($module)
1164 $searchdefs = array();
1165 $searchFields = array();
1167 if(file_exists('custom/modules/'.$module.'/metadata/metafiles.php'))
1169 require('custom/modules/'.$module.'/metadata/metafiles.php');
1171 elseif(file_exists('modules/'.$module.'/metadata/metafiles.php'))
1173 require('modules/'.$module.'/metadata/metafiles.php');
1176 if (file_exists('custom/modules/'.$module.'/metadata/searchdefs.php'))
1178 require('custom/modules/'.$module.'/metadata/searchdefs.php');
1180 elseif (!empty($metafiles[$module]['searchdefs']))
1182 require($metafiles[$module]['searchdefs']);
1184 elseif (file_exists('modules/'.$module.'/metadata/searchdefs.php'))
1186 require('modules/'.$module.'/metadata/searchdefs.php');
1190 if(!empty($metafiles[$module]['searchfields']))
1192 require($metafiles[$module]['searchfields']);
1194 elseif(file_exists('modules/'.$module.'/metadata/SearchFields.php'))
1196 require('modules/'.$module.'/metadata/SearchFields.php');
1198 if(file_exists('custom/modules/'.$module.'/metadata/SearchFields.php'))
1200 require('custom/modules/'.$module.'/metadata/SearchFields.php');
1203 return array('searchdefs' => $searchdefs, 'searchFields' => $searchFields );