2 /*********************************************************************************
3 * SugarCRM Community Edition is a customer relationship management program developed by
4 * SugarCRM, Inc. Copyright (C) 2004-2013 SugarCRM Inc.
6 * This program is free software; you can redistribute it and/or modify it under
7 * the terms of the GNU Affero General Public License version 3 as published by the
8 * Free Software Foundation with the addition of the following permission added
9 * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
10 * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
11 * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
13 * This program is distributed in the hope that it will be useful, but WITHOUT
14 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15 * FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
18 * You should have received a copy of the GNU Affero General Public License along with
19 * this program; if not, see http://www.gnu.org/licenses or write to the Free
20 * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
23 * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
24 * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
26 * The interactive user interfaces in modified source and object code versions
27 * of this program must display Appropriate Legal Notices, as required under
28 * Section 5 of the GNU Affero General Public License version 3.
30 * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
31 * these Appropriate Legal Notices must retain the display of the "Powered by
32 * SugarCRM" logo. If the display of the logo is not reasonably feasible for
33 * technical reasons, the Appropriate Legal Notices must display the words
34 * "Powered by SugarCRM".
35 ********************************************************************************/
38 require_once('include/tabs.php');
39 require_once('include/ListView/ListViewSmarty.php');
40 require_once('include/TemplateHandler/TemplateHandler.php');
41 require_once('include/EditView/EditView2.php');
44 class SearchForm extends EditView{
47 var $action = 'index';
48 var $searchdefs = array();
49 var $listViewDefs = array();
53 var $view = 'SearchForm';
54 var $displayView = 'basic_search';
59 var $parsedView = 'basic';
62 var $displaySavedSearch = true;
63 //show the advanced tab
64 var $showAdvanced = true;
66 var $showBasic = true;
67 //array of custom tab to show declare in searchdefs (no custom tab if false)
68 var $showCustom = false;
71 // hide saved searches drop and down near the search button
72 var $showSavedSearchesOptions = true;
74 var $displayType = 'searchView';
81 public function SearchForm($seed, $module, $action = 'index', $options = array())
83 $this->th = new TemplateHandler();
84 $this->th->loadSmarty();
86 $this->module = $module;
87 $this->action = $action;
88 $this->tabs = array(array('title' => $GLOBALS['app_strings']['LNK_BASIC_SEARCH'],
89 'link' => $module . '|basic_search',
90 'key' => $module . '|basic_search',
93 array('title' => $GLOBALS['app_strings']['LNK_ADVANCED_SEARCH'],
94 'link' => $module . '|advanced_search',
95 'key' => $module . '|advanced_search',
97 'displayDiv' => 'display:none'),
99 $this->searchColumns = array () ;
100 $this->setOptions($options);
103 function setup($searchdefs, $searchFields = array(), $tpl, $displayView = 'basic_search', $listViewDefs = array()){
104 $this->searchdefs = $searchdefs[$this->module];
106 //used by advanced search
107 $this->listViewDefs = $listViewDefs;
108 $this->displayView = $displayView;
109 $this->view = $this->view.'_'.$displayView;
110 $tokens = explode('_', $this->displayView);
111 $this->parsedView = $tokens[0];
112 $this->searchFields = $searchFields[$this->module];
113 if($this->displayView != 'saved_views'){
114 $this->_build_field_defs();
118 // Setup the tab array.
119 $this->tabs = array();
120 if($this->showBasic){
122 $this->tabs[]=array('title' => $GLOBALS['app_strings']['LNK_BASIC_SEARCH'],
123 'link' => $this->module . '|basic_search',
124 'key' => $this->module . '|basic_search',
128 if($this->showAdvanced){
130 $this->tabs[]=array('title' => $GLOBALS['app_strings']['LNK_ADVANCED_SEARCH'],
131 'link' => $this->module . '|advanced_search',
132 'key' => $this->module . '|advanced_search',
133 'name' => 'advanced',
134 'displayDiv' => 'display:none');
136 if(isset($this->showCustom) && is_array($this->showCustom)){
137 foreach($this->showCustom as $v){
139 $this->tabs[]=array('title' => $GLOBALS['app_strings']["LNK_" . strtoupper($v)],
140 'link' => $this->module . '|' . $v,
141 'key' => $this->module . '|' . $v,
142 'name' => str_replace('_search','',$v),
143 'displayDiv' => 'display:none',);
148 function display($header = true){
149 global $theme, $timedate, $current_user;
153 $this->th->ss->assign('module', $this->module);
154 $this->th->ss->assign('action', $this->action);
155 $this->th->ss->assign('displayView', $this->displayView);
156 $this->th->ss->assign('APP', $GLOBALS['app_strings']);
157 //Show the tabs only if there is more than one
159 $this->th->ss->assign('TABS', $this->_displayTabs($this->module . '|' . $this->displayView));
161 $this->th->ss->assign('searchTableColumnCount',
162 ((isset($this->searchdefs['templateMeta']['maxColumns']) ? $this->searchdefs['templateMeta']['maxColumns'] : 2) * 2 ) - 1);
163 $this->th->ss->assign('fields', $this->fieldDefs);
164 $this->th->ss->assign('customFields', $this->customFieldDefs);
165 $this->th->ss->assign('formData', $this->formData);
166 $time_format = $timedate->get_user_time_format();
167 $this->th->ss->assign('TIME_FORMAT', $time_format);
168 $this->th->ss->assign('USER_DATEFORMAT', $timedate->get_user_date_format());
169 $this->th->ss->assign('CALENDAR_FDOW', $current_user->get_first_day_of_week());
171 $date_format = $timedate->get_cal_date_format();
172 $time_separator = ":";
173 if(preg_match('/\d+([^\d])\d+([^\d]*)/s', $time_format, $match)) {
174 $time_separator = $match[1];
176 // Create Smarty variables for the Calendar picker widget
177 $t23 = strpos($time_format, '23') !== false ? '%H' : '%I';
178 if(!isset($match[2]) || $match[2] == '') {
179 $this->th->ss->assign('CALENDAR_FORMAT', $date_format . ' ' . $t23 . $time_separator . "%M");
181 $pm = $match[2] == "pm" ? "%P" : "%p";
182 $this->th->ss->assign('CALENDAR_FORMAT', $date_format . ' ' . $t23 . $time_separator . "%M" . $pm);
184 $this->th->ss->assign('TIME_SEPARATOR', $time_separator);
186 //Show and hide the good tab form
187 foreach($this->tabs as $tabkey=>$viewtab){
188 $viewName=str_replace(array($this->module . '|','_search'),'',$viewtab['key']);
189 if(strpos($this->view,$viewName)!==false){
190 $this->tabs[$tabkey]['displayDiv']='';
191 //if this is advanced tab, use form with saved search sub form built in
192 if($viewName=='advanced'){
193 $this->tpl = 'SearchFormGenericAdvanced.tpl';
194 if ($this->action =='ListView') {
195 $this->th->ss->assign('DISPLAY_SEARCH_HELP', true);
197 $this->th->ss->assign('DISPLAY_SAVED_SEARCH', $this->displaySavedSearch);
198 $this->th->ss->assign('SAVED_SEARCH', $this->displaySavedSearch());
199 //this determines whether the saved search subform should be rendered open or not
200 if(isset($_REQUEST['showSSDIV']) && $_REQUEST['showSSDIV']=='yes'){
201 $this->th->ss->assign('SHOWSSDIV', 'yes');
202 $this->th->ss->assign('DISPLAYSS', '');
204 $this->th->ss->assign('SHOWSSDIV', 'no');
205 $this->th->ss->assign('DISPLAYSS', 'display:none');
209 $this->tabs[$tabkey]['displayDiv']='display:none';
214 $this->th->ss->assign('TAB_ARRAY', $this->tabs);
217 if ( isset($this->searchdefs['templateMeta']['widths'])
218 && isset($this->searchdefs['templateMeta']['maxColumns'])) {
219 $totalWidth = ( $this->searchdefs['templateMeta']['widths']['label'] +
220 $this->searchdefs['templateMeta']['widths']['field'] ) *
221 $this->searchdefs['templateMeta']['maxColumns'];
222 // redo the widths in case they are too big
223 if ( $totalWidth > 100 ) {
224 $resize = 100 / $totalWidth;
225 $this->searchdefs['templateMeta']['widths']['label'] =
226 $this->searchdefs['templateMeta']['widths']['label'] * $resize;
227 $this->searchdefs['templateMeta']['widths']['field'] =
228 $this->searchdefs['templateMeta']['widths']['field'] * $resize;
231 $this->th->ss->assign('templateMeta', $this->searchdefs['templateMeta']);
232 $this->th->ss->assign('HAS_ADVANCED_SEARCH', !empty($this->searchdefs['layout']['advanced_search']));
233 $this->th->ss->assign('displayType', $this->displayType);
234 // return the form of the shown tab only
235 if($this->showSavedSearchesOptions){
236 $this->th->ss->assign('SAVED_SEARCHES_OPTIONS', $this->displaySavedSearchSelect());
238 if ($this->module == 'Documents'){
239 $this->th->ss->assign('DOCUMENTS_MODULE', true);
242 $return_txt = $this->th->displayTemplate($this->seed->module_dir, 'SearchForm_'.$this->parsedView, $this->locateFile($this->tpl));
245 $this->th->ss->assign('return_txt', $return_txt);
246 $header_txt = $this->th->displayTemplate($this->seed->module_dir, 'SearchFormHeader', $this->locateFile('header.tpl'));
247 //pass in info to render the select dropdown below the form
248 $footer_txt = $this->th->displayTemplate($this->seed->module_dir, 'SearchFormFooter', $this->locateFile('footer.tpl'));
249 $return_txt = $header_txt.$footer_txt;
256 * @param array $options
257 * @return SearchForm2
259 public function setOptions($options = null)
262 'locator_class' => 'FileLocator',
263 'locator_class_params' => array(
265 'custom/modules/' . $this->module . '/tpls/SearchForm',
266 'modules/' . $this->module . '/tpls/SearchForm',
267 'custom/include/SearchForm/tpls',
268 'include/SearchForm/tpls'
273 $this->options = empty($options) ? $defaults : $options;
281 public function getOptions()
283 return $this->options;
288 * Locate a file in the custom or stock folders. Look in the custom folders first.
290 * @param string $file The file we are looking for
291 * @return bool|string If the file is found return the path, False if not
293 protected function locateFile($file)
295 $paths = isset($this->options['locator_class_params'])?$this->options['locator_class_params'][0]:array();
296 foreach ($paths as $path) {
297 if (is_file($path . '/' . $file)) {
298 return $path . '/' . $file;
305 function displaySavedSearch()
307 $savedSearch = new SavedSearch($this->listViewDefs[$this->module], $this->lv->data['pageData']['ordering']['orderBy'], $this->lv->data['pageData']['ordering']['sortOrder']);
308 return $savedSearch->getForm($this->module, false);
312 function displaySavedSearchSelect(){
313 $savedSearch = new SavedSearch($this->listViewDefs[$this->module], $this->lv->data['pageData']['ordering']['orderBy'], $this->lv->data['pageData']['ordering']['sortOrder']);
314 return $savedSearch->getSelect($this->module);
320 * displays the tabs (top of the search form)
322 * @param string $currentKey key in $this->tabs to show as the current tab
324 * @return string html
326 function _displayTabs($currentKey)
328 if(isset($_REQUEST['saved_search_select']) && $_REQUEST['saved_search_select']!='_none') {
329 $saved_search=loadBean('SavedSearch');
330 $saved_search->retrieveSavedSearch($_REQUEST['saved_search_select']);
334 if(!empty($_REQUEST['displayColumns']))
335 $str .= 'SUGAR.savedViews.displayColumns = "' . $_REQUEST['displayColumns'] . '";';
336 elseif(isset($saved_search->contents['displayColumns']) && !empty($saved_search->contents['displayColumns']))
337 $str .= 'SUGAR.savedViews.displayColumns = "' . $saved_search->contents['displayColumns'] . '";';
338 if(!empty($_REQUEST['hideTabs']))
339 $str .= 'SUGAR.savedViews.hideTabs = "' . $_REQUEST['hideTabs'] . '";';
340 elseif(isset($saved_search->contents['hideTabs']) && !empty($saved_search->contents['hideTabs']))
341 $str .= 'SUGAR.savedViews.hideTabs = "' . $saved_search->contents['hideTabs'] . '";';
342 if(!empty($_REQUEST['orderBy']))
343 $str .= 'SUGAR.savedViews.selectedOrderBy = "' . $_REQUEST['orderBy'] . '";';
344 elseif(isset($saved_search->contents['orderBy']) && !empty($saved_search->contents['orderBy']))
345 $str .= 'SUGAR.savedViews.selectedOrderBy = "' . $saved_search->contents['orderBy'] . '";';
346 if(!empty($_REQUEST['sortOrder']))
347 $str .= 'SUGAR.savedViews.selectedSortOrder = "' . $_REQUEST['sortOrder'] . '";';
348 elseif(isset($saved_search->contents['sortOrder']) && !empty($saved_search->contents['sortOrder']))
349 $str .= 'SUGAR.savedViews.selectedSortOrder = "' . $saved_search->contents['sortOrder'] . '";';
359 function _build_field_defs(){
360 $this->formData = array();
361 $this->fieldDefs = array();
362 foreach($this->searchdefs['layout'][$this->displayView] as $data){
364 //Fields may be listed but disabled so that when they are enabled, they have the correct custom display data.
365 if (isset($data['enabled']) && $data['enabled'] == false)
367 $data['name'] = $data['name'].'_'.$this->parsedView;
368 $this->formData[] = array('field' => $data);
369 $this->fieldDefs[$data['name']]= $data;
371 $this->formData[] = array('field' => array('name'=>$data.'_'.$this->parsedView));
376 $this->seed->fill_in_additional_detail_fields();
377 // hack to make the employee status field for the Users/Employees module display correctly
378 if($this->seed->object_name == 'Employee' || $this->seed->object_name == 'User'){
379 $this->seed->field_defs['employee_status']['type'] = 'enum';
380 $this->seed->field_defs['employee_status']['massupdate'] = true;
381 $this->seed->field_defs['employee_status']['options'] = 'employee_status_dom';
382 unset($this->seed->field_defs['employee_status']['function']);
385 foreach($this->seed->toArray() as $name => $value) {
386 $fvName = $name.'_'.$this->parsedView;
387 if(!empty($this->fieldDefs[$fvName]))
388 $this->fieldDefs[$fvName] = array_merge($this->seed->field_defs[$name], $this->fieldDefs[$fvName]);
390 $this->fieldDefs[$fvName] = $this->seed->field_defs[$name];
391 $this->fieldDefs[$fvName]['name'] = $this->fieldDefs[$fvName]['name'].'_'.$this->parsedView;
394 if(isset($this->fieldDefs[$fvName]['type']) && $this->fieldDefs[$fvName]['type'] == 'relate') {
395 if(isset($this->fieldDefs[$fvName]['id_name'])) {
396 $this->fieldDefs[$fvName]['id_name'] .= '_'.$this->parsedView;
400 if(isset($this->fieldDefs[$fvName]['options']) && isset($GLOBALS['app_list_strings'][$this->fieldDefs[$fvName]['options']]))
403 $this->fieldDefs[$fvName]['options'] = $GLOBALS['app_list_strings'][$this->fieldDefs[$fvName]['options']];
404 //Hack to add blanks for parent types on search views
405 //53131 - add blank option for SearchField options with def 'options_add_blank' set to true
406 if ($this->fieldDefs[$fvName]['type'] == "parent_type" || $this->fieldDefs[$fvName]['type'] == "parent" || (isset($this->searchFields[$name]['options_add_blank']) && $this->searchFields[$name]['options_add_blank']) )
408 //Bug 54929: Do not use array_merge() as it changes integer keys in the array.
409 $this->fieldDefs[$fvName]['options'][''] = '';
413 if(isset($this->fieldDefs[$fvName]['function'])) {
415 $this->fieldDefs[$fvName]['type']='multienum';
417 if(is_array($this->fieldDefs[$fvName]['function'])) {
418 $this->fieldDefs[$fvName]['function']['preserveFunctionValue']=true;
421 $function = $this->fieldDefs[$fvName]['function'];
423 if(is_array($function) && isset($function['name'])){
424 $function_name = $this->fieldDefs[$fvName]['function']['name'];
426 $function_name = $this->fieldDefs[$fvName]['function'];
429 if(!empty($this->fieldDefs[$fvName]['function']['returns']) && $this->fieldDefs[$fvName]['function']['returns'] == 'html'){
430 if(!empty($this->fieldDefs[$fvName]['function']['include'])){
431 require_once($this->fieldDefs[$fvName]['function']['include']);
433 $value = call_user_func($function_name, $this->seed, $name, $value, $this->view);
434 $this->fieldDefs[$fvName]['value'] = $value;
436 if(!isset($function['params']) || !is_array($function['params'])) {
437 $this->fieldDefs[$fvName]['options'] = call_user_func($function_name, $this->seed, $name, $value, $this->view);
439 $this->fieldDefs[$fvName]['options'] = call_user_func_array($function_name, $function['params']);
443 if(isset($this->fieldDefs[$name]['type']) && $this->fieldDefs[$fvName]['type'] == 'function'
444 && isset($this->fieldDefs[$fvName]['function_name']))
446 $value = $this->callFunction($this->fieldDefs[$fvName]);
447 $this->fieldDefs[$fvName]['value'] = $value;
450 $this->fieldDefs[$name]['value'] = $value;
453 if((!empty($_REQUEST[$fvName]) || (isset($_REQUEST[$fvName]) && $_REQUEST[$fvName] == '0'))
454 && empty($this->fieldDefs[$fvName]['function']['preserveFunctionValue'])) {
455 $value = $_REQUEST[$fvName];
456 $this->fieldDefs[$fvName]['value'] = $value;
467 * Populate the searchFields from an array
469 * @param array $array array to search through
470 * @param string $switchVar variable to use in switch statement
471 * @param bool $addAllBeanFields true to process at all bean fields
473 function populateFromArray(&$array, $switchVar = null, $addAllBeanFields = true) {
475 if((!empty($array['searchFormTab']) || !empty($switchVar)) && !empty($this->searchFields)) {
476 $arrayKeys = array_keys($array);
477 $searchFieldsKeys = array_keys($this->searchFields);
478 if(empty($switchVar)) $switchVar = $array['searchFormTab'];
479 //name of the search tab
480 $SearchName=str_replace('_search', '', $switchVar);
481 if($switchVar=='saved_views'){
482 foreach($this->searchFields as $name => $params) {
483 foreach($this->tabs as $tabName){
484 if(!empty($array[$name . '_' . $tabName['name']])) {
485 $this->searchFields[$name]['value'] = $array[$name . '_' . $tabName['name']];
486 if(empty($this->fieldDefs[$name . '_' . $tabName['name']]['value'])) $this->fieldDefs[$name . '_' . $tabName['name']]['value'] = $array[$name . '_' . $tabName['name']];
490 if($addAllBeanFields) {
491 foreach($this->seed->field_name_map as $key => $params) {
492 if(!in_array($key, $searchFieldsKeys)) {
493 foreach($this->tabs->name as $tabName){
494 if(in_array($key . '_' . $tabName['name'], $arrayKeys) ) {
495 $this->searchFields[$key] = array('query_type' => 'default',
496 'value' => $array[$key . '_' . $tabName['name']]);
504 $fromMergeRecords = isset($array['merge_module']);
506 foreach($this->searchFields as $name => $params) {
507 $long_name = $name.'_'.$SearchName;
508 /*nsingh 21648: Add additional check for bool values=0. empty() considers 0 to be empty Only repopulates if value is 0 or 1:( */
509 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'))))
511 $this->searchFields[$name]['value'] = $array[$long_name];
512 if(empty($this->fieldDefs[$long_name]['value'])) {
513 $this->fieldDefs[$long_name]['value'] = $array[$long_name];
516 else if(!empty($array[$name]) && !$fromMergeRecords) // basic
518 $this->searchFields[$name]['value'] = $array[$name];
519 if(empty($this->fieldDefs[$long_name]['value'])) {
520 $this->fieldDefs[$long_name]['value'] = $array[$name];
524 if(!empty($params['enable_range_search']) && isset($this->searchFields[$name]['value']))
526 if(preg_match('/^range_(.*?)$/', $long_name, $match) && isset($array[$match[1].'_range_choice']))
528 $this->searchFields[$name]['operator'] = $array[$match[1].'_range_choice'];
532 if(!empty($params['is_date_field']) && isset($this->searchFields[$name]['value']))
535 // 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)
536 $date_value = $timedate->to_db_date($this->searchFields[$name]['value'], false);
537 $this->searchFields[$name]['value'] = $date_value == '' ? $this->searchFields[$name]['value'] : $date_value;
541 if((empty($array['massupdate']) || $array['massupdate'] == 'false') && $addAllBeanFields) {
542 foreach($this->seed->field_name_map as $key => $params) {
543 if($key != 'assigned_user_name' && $key != 'modified_by_name')
545 $long_name = $key.'_'.$SearchName;
547 if(in_array($key.'_'.$SearchName, $arrayKeys) && !in_array($key, $searchFieldsKeys))
549 $this->searchFields[$key] = array('query_type' => 'default', 'value' => $array[$long_name]);
551 if (!empty($params['type']) && $params['type'] == 'parent'
552 && !empty($params['type_name']) && !empty($this->searchFields[$key]['value']))
554 require_once('include/SugarFields/SugarFieldHandler.php');
555 $sfh = new SugarFieldHandler();
556 $sf = $sfh->getSugarField('Parent');
558 $this->searchFields[$params['type_name']] = array('query_type' => 'default',
559 'value' => $sf->getSearchInput($params['type_name'], $array));
562 if(empty($this->fieldDefs[$long_name]['value'])) {
563 $this->fieldDefs[$long_name]['value'] = $array[$long_name];
573 if ( is_array($this->searchFields) ) {
574 foreach ( $this->searchFields as $fieldName => $field ) {
575 if ( !empty($field['value']) && is_string($field['value']) ) {
576 $this->searchFields[$fieldName]['value'] = trim($field['value']);
584 * Populate the searchFields from $_REQUEST
586 * @param string $switchVar variable to use in switch statement
587 * @param bool $addAllBeanFields true to process at all bean fields
589 function populateFromRequest($switchVar = null, $addAllBeanFields = true) {
590 $this->populateFromArray($_REQUEST, $switchVar, $addAllBeanFields);
595 * Parse date expression and return WHERE clause
596 * @param string $operator Date expression operator
597 * @param string DB field name
598 * @param string DB field type
600 protected function parseDateExpression($operator, $db_field, $field_type = '')
602 if ($field_type == "date") {
609 $dates = TimeDate::getInstance()->parseDateRange($operator, null, $adjForTZ);
610 if(empty($dates)) return '';
611 $start = $this->seed->db->convert($this->seed->db->quoted($dates[0]->asDb()), $type);
612 $end = $this->seed->db->convert($this->seed->db->quoted($dates[1]->asDb()), $type);
613 return "($db_field >= $start AND $db_field <= $end)";
617 * generateSearchWhere
619 * This function serves as the central piece of SearchForm2.php
620 * It is responsible for creating the WHERE clause for a given search operation
622 * @param bool $add_custom_fields boolean indicating whether or not custom fields should be added
623 * @param string $module Module to search against
625 * @return string the SQL WHERE clause based on the arguments supplied in SearchForm2 instance
627 public function generateSearchWhere($add_custom_fields = false, $module='') {
630 $db = $this->seed->db;
631 $this->searchColumns = array () ;
632 $values = $this->searchFields;
634 $where_clauses = array();
636 $table_name = $this->seed->object_name;
637 $this->seed->fill_in_additional_detail_fields();
639 //rrs check for team_id
641 foreach($this->searchFields as $field=>$parms) {
642 $customField = false;
643 // Jenny - Bug 7462: We need a type check here to avoid database errors
644 // when searching for numeric fields. This is a temporary fix until we have
645 // a generic search form validation mechanism.
646 $type = (!empty($this->seed->field_name_map[$field]['type']))?$this->seed->field_name_map[$field]['type']:'';
648 //If range search is enabled for the field, we first check if this is the starting range
649 if(!empty($parms['enable_range_search']) && empty($type))
651 if(preg_match('/^start_range_(.*?)$/', $field, $match))
653 $real_field = $match[1];
654 $start_field = 'start_range_' . $real_field;
655 $end_field = 'end_range_' . $real_field;
657 if(isset($this->searchFields[$start_field]['value']) && isset($this->searchFields[$end_field]['value']))
659 $this->searchFields[$real_field]['value'] = $this->searchFields[$start_field]['value'] . '<>' . $this->searchFields[$end_field]['value'];
660 $this->searchFields[$real_field]['operator'] = 'between';
661 $parms['value'] = $this->searchFields[$real_field]['value'];
662 $parms['operator'] = 'between';
664 $field_type = isset($this->seed->field_name_map[$real_field]['type']) ? $this->seed->field_name_map[$real_field]['type'] : '';
665 if($field_type == 'datetimecombo' || $field_type == 'datetime')
670 $field = $real_field;
671 unset($this->searchFields[$end_field]['value']);
673 } else if (preg_match('/^range_(.*?)$/', $field, $match) && isset($this->searchFields[$field]['value'])) {
674 $real_field = $match[1];
676 //Special case for datetime and datetimecombo fields. By setting the type here we allow an actual between search
677 if(in_array($parms['operator'], array('=', 'between', "not_equal", 'less_than', 'greater_than', 'less_than_equals', 'greater_than_equals')))
679 $field_type = isset($this->seed->field_name_map[$real_field]['type']) ? $this->seed->field_name_map[$real_field]['type'] : '';
680 if(strtolower($field_type) == 'readonly' && isset($this->seed->field_name_map[$real_field]['dbType'])) {
681 $field_type = $this->seed->field_name_map[$real_field]['dbType'];
683 if($field_type == 'datetimecombo' || $field_type == 'datetime' || $field_type == 'int')
689 $this->searchFields[$real_field]['value'] = $this->searchFields[$field]['value'];
690 $this->searchFields[$real_field]['operator'] = $this->searchFields[$field]['operator'];
691 $params['value'] = $this->searchFields[$field]['value'];
692 $params['operator'] = $this->searchFields[$field]['operator'];
693 unset($this->searchFields[$field]['value']);
694 $field = $real_field;
696 //Skip this range search field, it is the end field THIS IS NEEDED or the end range date will break the query
701 //Test to mark whether or not the field is a custom field
702 if(!empty($this->seed->field_name_map[$field]['source'])
703 && ($this->seed->field_name_map[$field]['source'] == 'custom_fields' ||
704 //Non-db custom fields, such as custom relates
705 ($this->seed->field_name_map[$field]['source'] == 'non-db'
706 && (!empty($this->seed->field_name_map[$field]['custom_module']) ||
707 isset($this->seed->field_name_map[$field]['ext2']))))){
711 if ($type == 'int' && isset($parms['value']) && !empty($parms['value'])) {
712 require_once ('include/SugarFields/SugarFieldHandler.php');
713 $intField = SugarFieldHandler::getSugarField('int');
714 $newVal = $intField->getSearchWhereValue($parms['value']);
715 $parms['value'] = $newVal;
716 } elseif($type == 'html' && $customField) {
721 if(isset($parms['value']) && $parms['value'] != "") {
723 $operator = $db->isNumericType($type)?'=':'like';
724 if(!empty($parms['operator'])) {
725 $operator = strtolower($parms['operator']);
728 if(is_array($parms['value'])) {
731 // always construct the where clause for multiselects using the 'like' form to handle combinations of multiple $vals and multiple $parms
732 if(!empty($this->seed->field_name_map[$field]['isMultiSelect']) && $this->seed->field_name_map[$field]['isMultiSelect']) {
733 // construct the query for multenums
734 // use the 'like' query as both custom and OOB multienums are implemented with types that cannot be used with an 'in'
735 $operator = 'custom_enum';
736 $table_name = $this->seed->table_name ;
738 $table_name .= "_cstm" ;
739 $db_field = $table_name . "." . $field;
741 foreach($parms['value'] as $val) {
742 if($val != ' ' and $val != '') {
743 $qVal = $db->quote($val);
744 if (!empty($field_value)) {
745 $field_value .= ' or ';
747 $field_value .= "$db_field like '%^$qVal^%'";
749 $field_value .= '('.$db_field . ' IS NULL or '.$db_field."='^^' or ".$db_field."='')";
754 $operator = $operator != 'subquery' ? 'in' : $operator;
755 foreach($parms['value'] as $val) {
756 if($val != ' ' and $val != '') {
757 if (!empty($field_value)) {
760 $field_value .= $db->quoteType($type, $val);
762 // Bug 41209: adding a new operator "isnull" here
763 // to handle the case when blank is selected from dropdown.
764 // In that case, $val is empty.
765 // When $val is empty, we need to use "IS NULL",
766 // as "in (null)" won't work
767 else if ($operator=='in') {
768 $operator = 'isnull';
774 $field_value = $parms['value'];
777 //set db_fields array.
778 if(!isset($parms['db_field'])) {
779 $parms['db_field'] = array($field);
782 //This if-else block handles the shortcut checkbox selections for "My Items" and "Closed Only"
783 if(!empty($parms['my_items'])) {
784 if( $parms['value'] == false ) {
787 //my items is checked.
788 global $current_user;
789 $field_value = $db->quote($current_user->id);
792 } else if(!empty($parms['closed_values']) && is_array($parms['closed_values'])) {
793 if( $parms['value'] == false ) {
797 foreach($parms['closed_values'] as $closed_value)
799 $field_value .= "," . $db->quoted($closed_value);
801 $field_value = substr($field_value, 1);
808 if($field_value != '' || $operator=='isnull') {
810 $this->searchColumns [ strtoupper($field) ] = $field ;
812 foreach ($parms['db_field'] as $db_field) {
813 if (strstr($db_field, '.') === false) {
814 //Try to get the table for relate fields from link defs
815 if ($type == 'relate' && !empty($this->seed->field_name_map[$field]['link'])
816 && !empty($this->seed->field_name_map[$field]['rname'])) {
817 $link = $this->seed->field_name_map[$field]['link'];
818 $relname = $link['relationship'];
819 if (($this->seed->load_relationship($link))){
821 $db_field = $this->seed->field_name_map[$field]['name'];
823 //Best Guess for table name
824 $db_field = strtolower($link['module']) . '.' . $db_field;
829 else if ($type == 'parent') {
830 if (!empty($this->searchFields['parent_type'])) {
831 $parentType = $this->searchFields['parent_type'];
832 $rel_module = $parentType['value'];
833 global $beanFiles, $beanList;
834 if(!empty($beanFiles[$beanList[$rel_module]])) {
835 require_once($beanFiles[$beanList[$rel_module]]);
836 $rel_seed = new $beanList[$rel_module]();
837 $db_field = 'parent_' . $rel_module . '_' . $rel_seed->table_name . '.name';
841 // Relate fields in custom modules and custom relate fields
842 else if ($type == 'relate' && $customField && !empty($this->seed->field_name_map[$field]['module'])) {
843 $db_field = !empty($this->seed->field_name_map[$field]['name'])?$this->seed->field_name_map[$field]['name']:'name';
845 else if(!$customField){
846 if ( !empty($this->seed->field_name_map[$field]['db_concat_fields']) )
847 $db_field = $db->concat($this->seed->table_name, $this->seed->field_name_map[$db_field]['db_concat_fields']);
849 $db_field = $this->seed->table_name . "." . $db_field;
851 if ( !empty($this->seed->field_name_map[$field]['db_concat_fields']) )
852 $db_field = $db->concat($this->seed->table_name . "_cstm.", $this->seed->field_name_map[$db_field]['db_concat_fields']);
854 $db_field = $this->seed->table_name . "_cstm." . $db_field;
859 if($type == 'date') {
860 // The regular expression check is to circumvent special case YYYY-MM
862 if(preg_match('/^\d{4}.\d{1,2}$/', $field_value) != 0) { // preg_match returns number of matches
863 $db_field = $this->seed->db->convert($db_field, "date_format", array("%Y-%m"));
865 $field_value = $timedate->to_db_date($field_value, false);
866 $db_field = $this->seed->db->convert($db_field, "date_format", array("%Y-%m-%d"));
870 if($type == 'datetime' || $type == 'datetimecombo') {
872 if($operator == '=' || $operator == 'between') {
873 // FG - bug45287 - If User asked for a range, takes edges from it.
874 $placeholderPos = strpos($field_value, "<>");
875 if ($placeholderPos !== FALSE && $placeholderPos > 0)
877 $datesLimit = explode("<>", $field_value);
878 $dateStart = $timedate->getDayStartEndGMT($datesLimit[0]);
879 $dateEnd = $timedate->getDayStartEndGMT($datesLimit[1]);
881 $dates['end'] = $dateEnd['end'];
882 $dates['enddate'] = $dateEnd['enddate'];
883 $dates['endtime'] = $dateEnd['endtime'];
887 $dates = $timedate->getDayStartEndGMT($field_value);
889 // FG - bug45287 - Note "start" and "end" are the correct interval at GMT timezone
890 $field_value = array($dates["start"], $dates["end"]);
891 $operator = 'between';
892 } else if($operator == 'not_equal') {
893 $dates = $timedate->getDayStartEndGMT($field_value);
894 $field_value = array($dates["start"], $dates["end"]);
895 $operator = 'date_not_equal';
896 } else if($operator == 'greater_than') {
897 $dates = $timedate->getDayStartEndGMT($field_value);
898 $field_value = $dates["end"];
899 } else if($operator == 'less_than') {
900 $dates = $timedate->getDayStartEndGMT($field_value);
901 $field_value = $dates["start"];
902 } else if($operator == 'greater_than_equals') {
903 $dates = $timedate->getDayStartEndGMT($field_value);
904 $field_value = $dates["start"];
905 } else if($operator == 'less_than_equals') {
906 $dates = $timedate->getDayStartEndGMT($field_value);
907 $field_value = $dates["end"];
909 } catch(Exception $timeException) {
910 //In the event that a date value is given that cannot be correctly processed by getDayStartEndGMT method,
911 //just skip searching on this field and continue. This may occur if user switches locale date formats
912 //in another browser screen, but re-runs a search with the previous format on another screen
913 $GLOBALS['log']->error($timeException->getMessage());
918 if($type == 'decimal' || $type == 'float' || $type == 'currency' || (!empty($parms['enable_range_search']) && empty($parms['is_date_field']))) {
919 require_once('modules/Currencies/Currency.php');
921 //we need to handle formatting either a single value or 2 values in case the 'between' search option is set
922 //start by splitting the string if the between operator exists
923 $fieldARR = explode('<>', $field_value);
924 //set the first pass through boolean
926 foreach($fieldARR as $fv){
927 //reset the field value, it will be rebuild in the foreach loop below
928 $tmpfield_value = unformat_number($fv);
930 if ( $type == 'currency' && stripos($field,'_usdollar')!==FALSE ) {
931 // It's a US Dollar field, we need to do some conversions from the user's local currency
932 $currency_id = $GLOBALS['current_user']->getPreference('currency');
933 if ( empty($currency_id) ) {
936 if ( $currency_id != -99 ) {
937 $currency = new Currency();
938 $currency->retrieve($currency_id);
939 $tmpfield_value = $currency->convertToDollar($tmpfield_value);
942 $values[] = $tmpfield_value;
945 $field_value = join('<>',$values);
947 if(!empty($parms['enable_range_search']) && $parms['operator'] == '=' && $type != 'int')
949 // Databases can't really search for floating point numbers, because they can't be accurately described in binary,
950 // So we have to fuzz out the math a little bit
951 $field_value = array(($field_value - 0.01) , ($field_value + 0.01));
952 $operator = 'between';
957 if($db->supports("case_sensitive") && isset($parms['query_type']) && $parms['query_type'] == 'case_insensitive') {
958 $db_field = 'upper(' . $db_field . ")";
959 $field_value = strtoupper($field_value);
967 //Here we make a last attempt to determine the field type if possible
968 if(empty($type) && isset($parms['db_field']) && isset($parms['db_field'][0]) && isset($this->seed->field_defs[$parms['db_field'][0]]['type']))
970 $type = $this->seed->field_defs[$parms['db_field'][0]]['type'];
973 switch(strtolower($operator)) {
976 if ( isset($parms['subquery_in_clause']) ) {
977 if ( !is_array($parms['subquery_in_clause']) ) {
978 $in = $parms['subquery_in_clause'];
980 elseif ( isset($parms['subquery_in_clause'][$field_value]) ) {
981 $in = $parms['subquery_in_clause'][$field_value];
984 $sq = $parms['subquery'];
987 if (isset($sq['OR'])){
992 if(empty($q) || strlen($q)<2) continue;
996 $where .= " {$db_field} $in ({$q} ".$this->seed->db->quoted($field_value.'%').") ";
999 }elseif(!empty($parms['query_type']) && $parms['query_type'] == 'format'){
1000 $stringFormatParams = array(0 => $field_value, 1 => $GLOBALS['current_user']->id);
1001 $where .= "{$db_field} $in (".string_format($parms['subquery'], $stringFormatParams).")";
1003 //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
1004 //outside in. Additional details: http://bugs.mysql.com/bug.php?id=9021
1005 $where .= "{$db_field} $in (select * from ({$parms['subquery']} ".$this->seed->db->quoted($field_value.'%').") {$field}_derived)";
1011 if($type == 'bool' && $field_value == 0)
1013 // Bug 43452 - FG - Added parenthesis surrounding the OR (without them the WHERE clause would be broken)
1014 $where .= "( " . $db_field . " = '0' OR " . $db_field . " IS NULL )";
1018 // check to see if this is coming from unified search or not
1019 $UnifiedSearch = !empty($parms['force_unifiedsearch']);
1020 if(isset($_REQUEST['action']) && $_REQUEST['action'] == 'UnifiedSearch'){
1021 $UnifiedSearch = true;
1024 // If it is a unified search and if the search contains more then 1 word (contains space)
1025 // and if it's the last element from db_field (so we do the concat only once, not for every db_field element)
1026 // we concat the db_field array() (both original, and in reverse order) and search for the whole string in it
1027 if ( $UnifiedSearch && strpos($field_value, ' ') !== false && strpos($db_field, $parms['db_field'][count($parms['db_field']) - 1]) !== false )
1029 // Get the table name used for concat
1030 $concat_table = explode('.', $db_field);
1031 $concat_table = $concat_table[0];
1032 // Get the fields for concatenating
1033 $concat_fields = $parms['db_field'];
1035 // If db_fields (e.g. contacts.first_name) contain table name, need to remove it
1036 for ($i = 0; $i < count($concat_fields); $i++)
1038 if (strpos($concat_fields[$i], $concat_table) !== false)
1040 $concat_fields[$i] = substr($concat_fields[$i], strlen($concat_table) + 1);
1044 // Concat the fields and search for the value
1045 $where .= $this->seed->db->concat($concat_table, $concat_fields) . " LIKE " . $this->seed->db->quoted($field_value . $like_char);
1046 $where .= ' OR ' . $this->seed->db->concat($concat_table, array_reverse($concat_fields)) . " LIKE " . $this->seed->db->quoted($field_value . $like_char);
1050 //Check if this is a first_name, last_name search
1051 if(isset($this->seed->field_name_map) && isset($this->seed->field_name_map[$db_field]))
1053 $vardefEntry = $this->seed->field_name_map[$db_field];
1054 if(!empty($vardefEntry['db_concat_fields']) && in_array('first_name', $vardefEntry['db_concat_fields']) && in_array('last_name', $vardefEntry['db_concat_fields']))
1056 if(!empty($GLOBALS['app_list_strings']['salutation_dom']) && is_array($GLOBALS['app_list_strings']['salutation_dom']))
1058 foreach($GLOBALS['app_list_strings']['salutation_dom'] as $salutation)
1060 if(!empty($salutation) && strpos($field_value, $salutation) === 0)
1062 $field_value = trim(substr($field_value, strlen($salutation)));
1070 //field is not last name or this is not from global unified search, so do normal where clause
1071 $where .= $db_field . " like ".$this->seed->db->quoted(sql_like_string($field_value, $like_char));
1076 $where .= $db_field . ' not in ('.$field_value.')';
1079 $where .= $db_field . ' in ('.$field_value.')';
1082 if($type == 'bool' && $field_value == 0) {
1083 $where .= "($db_field = 0 OR $db_field IS NULL)";
1086 $where .= $db_field . " = ".$db->quoteType($type, $field_value);
1089 // tyoung bug 15971 - need to add these special cases into the $where query
1091 $where .= $field_value;
1094 if(!is_array($field_value)) {
1095 $field_value = explode('<>', $field_value);
1097 $field_value[0] = $db->quoteType($type, $field_value[0]);
1098 $field_value[1] = $db->quoteType($type, $field_value[1]);
1099 $where .= "($db_field >= {$field_value[0]} AND $db_field <= {$field_value[1]})";
1101 case 'date_not_equal':
1102 if(!is_array($field_value)) {
1103 $field_value = explode('<>', $field_value);
1105 $field_value[0] = $db->quoteType($type, $field_value[0]);
1106 $field_value[1] = $db->quoteType($type, $field_value[1]);
1107 $where .= "($db_field IS NULL OR $db_field < {$field_value[0]} OR $db_field > {$field_value[1]})";
1110 $this->seed->listview_inner_join[] = $parms['innerjoin'] . " '" . $parms['value'] . "%')";
1113 $field_value = $db->quoteType($type, $field_value);
1114 $where .= "($db_field IS NULL OR $db_field != $field_value)";
1116 case 'greater_than':
1117 $field_value = $db->quoteType($type, $field_value);
1118 $where .= "$db_field > $field_value";
1120 case 'greater_than_equals':
1121 $field_value = $db->quoteType($type, $field_value);
1122 $where .= "$db_field >= $field_value";
1125 $field_value = $db->quoteType($type, $field_value);
1126 $where .= "$db_field < $field_value";
1128 case 'less_than_equals':
1129 $field_value = $db->quoteType($type, $field_value);
1130 $where .= "$db_field <= $field_value";
1137 case 'last_30_days':
1138 case 'next_30_days':
1142 if (!empty($field) && !empty($this->seed->field_name_map[$field]['type'])) {
1143 $where .= $this->parseDateExpression(strtolower($operator), $db_field, $this->seed->field_name_map[$field]['type']);
1145 $where .= $this->parseDateExpression(strtolower($operator), $db_field);
1149 $where .= "($db_field IS NULL OR $db_field = '')";
1150 if ($field_value != '')
1151 $where .= ' OR ' . $db_field . " in (".$field_value.')';
1157 if(!empty($where)) {
1159 array_push($where_clauses, '( '.$where.' )');
1162 array_push($where_clauses, $where);
1168 return $where_clauses;
1174 * isEmptyDropdownField
1176 * This function checks to see if a blank dropdown field was supplied. This scenario will occur where
1177 * a dropdown select is in single selection mode
1179 * @param $value Mixed dropdown value
1181 private function isEmptyDropdownField($name='', $value=array())
1183 $result = is_array($value) && isset($value[0]) && $value[0] == '';
1184 $GLOBALS['log']->debug("Found empty value for {$name} dropdown search key");
1189 * Return the search defs for a particular module.
1194 public static function retrieveSearchDefs($module)
1196 $searchdefs = array();
1197 $searchFields = array();
1199 if(file_exists('custom/modules/'.$module.'/metadata/metafiles.php'))
1201 require('custom/modules/'.$module.'/metadata/metafiles.php');
1203 elseif(file_exists('modules/'.$module.'/metadata/metafiles.php'))
1205 require('modules/'.$module.'/metadata/metafiles.php');
1208 if (file_exists('custom/modules/'.$module.'/metadata/searchdefs.php'))
1210 require('custom/modules/'.$module.'/metadata/searchdefs.php');
1212 elseif (!empty($metafiles[$module]['searchdefs']))
1214 require($metafiles[$module]['searchdefs']);
1216 elseif (file_exists('modules/'.$module.'/metadata/searchdefs.php'))
1218 require('modules/'.$module.'/metadata/searchdefs.php');
1222 if(!empty($metafiles[$module]['searchfields']))
1224 require($metafiles[$module]['searchfields']);
1226 elseif(file_exists('modules/'.$module.'/metadata/SearchFields.php'))
1228 require('modules/'.$module.'/metadata/SearchFields.php');
1230 if(file_exists('custom/modules/'.$module.'/metadata/SearchFields.php'))
1232 require('custom/modules/'.$module.'/metadata/SearchFields.php');
1235 return array('searchdefs' => $searchdefs, 'searchFields' => $searchFields );