2 if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
3 /*********************************************************************************
4 * SugarCRM Community Edition is a customer relationship management program developed by
5 * SugarCRM, Inc. Copyright (C) 2004-2011 SugarCRM Inc.
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.
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
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
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.
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.
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 ********************************************************************************/
38 /*********************************************************************************
40 * Description: TODO: To be written.
41 * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.
42 * All Rights Reserved.
43 * Contributor(s): ______________________________________..
44 ********************************************************************************/
48 class UnifiedSearchAdvanced {
50 var $query_string = '';
52 function __construct(){
53 if(!empty($_REQUEST['query_string'])){
54 $query_string = trim($_REQUEST['query_string']);
55 if(!empty($query_string)){
56 $this->query_string = $query_string;
61 function getDropDownDiv($tpl = 'modules/Home/UnifiedSearchAdvanced.tpl') {
62 global $app_list_strings, $app_strings;
64 if(!file_exists($GLOBALS['sugar_config']['cache_dir'].'modules/unified_search_modules.php'))
69 include($GLOBALS['sugar_config']['cache_dir'].'modules/unified_search_modules.php');
71 if(!file_exists('custom/modules/unified_search_modules_display.php'))
73 $this->createUnifiedSearchModulesDisplay();
76 include('custom/modules/unified_search_modules_display.php');
78 global $mod_strings, $modListHeader, $app_list_strings, $current_user, $app_strings, $beanList;
79 $users_modules = $current_user->getPreference('globalSearch', 'search');
81 // preferences are empty, select all
82 if(empty($users_modules)) {
83 $users_modules = array();
84 foreach($unified_search_modules_display as $module=>$data) {
85 if (!empty($data['visible']) ) {
86 $users_modules[$module] = $beanList[$module];
89 $current_user->setPreference('globalSearch', $users_modules, 0, 'search');
92 $sugar_smarty = new Sugar_Smarty();
94 $modules_to_search = array();
96 foreach($users_modules as $key=>$module)
98 if(ACLController::checkAccess($key, 'list', true))
100 $modules_to_search[$key]['checked'] = true;
104 if(!empty($this->query_string))
106 $sugar_smarty->assign('query_string', securexss($this->query_string));
108 $sugar_smarty->assign('query_string', '');
111 $sugar_smarty->assign('MOD', return_module_language($GLOBALS['current_language'], 'Administration'));
112 $sugar_smarty->assign('APP', $app_strings);
113 $sugar_smarty->assign('USE_SEARCH_GIF', 0);
114 $sugar_smarty->assign('LBL_SEARCH_BUTTON_LABEL', $app_strings['LBL_SEARCH_BUTTON_LABEL']);
116 $json_enabled = array();
117 $json_disabled = array();
119 //Now add the rest of the modules that are searchable via Global Search settings
120 foreach($unified_search_modules_display as $module=>$data)
122 if(!isset($modules_to_search[$module]) && $data['visible'] && ACLController::checkAccess($module, 'list', true))
124 $modules_to_search[$module]['checked'] = false;
125 } else if (isset($modules_to_search[$module]) && !$data['visible']) {
126 unset($modules_to_search[$module]);
130 //Create the two lists (doing it this way preserves the user's ordering choice for enabled modules)
131 foreach($modules_to_search as $module=>$data)
133 $label = isset($app_list_strings['moduleList'][$module]) ? $app_list_strings['moduleList'][$module] : $module;
134 if(!empty($data['checked']))
136 $json_enabled[] = array("module" => $module, 'label' => $label);
138 $json_disabled[] = array("module" => $module, 'label' => $label);
142 $sugar_smarty->assign('enabled_modules', json_encode($json_enabled));
143 $sugar_smarty->assign('disabled_modules', json_encode($json_disabled));
145 $showDiv = $current_user->getPreference('showGSDiv', 'search');
151 $sugar_smarty->assign('SHOWGSDIV', $showDiv);
152 $sugar_smarty->debugging = true;
153 return $sugar_smarty->fetch($tpl);
158 if(!file_exists($GLOBALS['sugar_config']['cache_dir'].'modules/unified_search_modules.php'))
162 include $GLOBALS['sugar_config']['cache_dir'].'modules/unified_search_modules.php';
164 if(!file_exists('custom/modules/unified_search_modules_display.php'))
166 $this->createUnifiedSearchModulesDisplay();
168 include('custom/modules/unified_search_modules_display.php');
171 require_once 'include/ListView/ListViewSmarty.php';
173 global $modListHeader, $beanList, $beanFiles, $current_language, $app_strings, $current_user, $mod_strings;
174 $home_mod_strings = return_module_language($current_language, 'Home');
177 $this->query_string = $GLOBALS['db']->quote(securexss(from_html(clean_string($this->query_string, 'UNIFIED_SEARCH'))));
179 if(!empty($_REQUEST['advanced']) && $_REQUEST['advanced'] != 'false') {
180 $modules_to_search = array();
181 if(!empty($_REQUEST['search_modules']))
183 foreach(explode (',', $_REQUEST['search_modules'] ) as $e)
185 $modules_to_search[$e] = $beanList[$e];
189 $current_user->setPreference('showGSDiv', isset($_REQUEST['showGSDiv']) ? $_REQUEST['showGSDiv'] : 'no', 0, 'search');
190 $current_user->setPreference('globalSearch', $modules_to_search, 0, 'search'); // save selections to user preference
192 $users_modules = $current_user->getPreference('globalSearch', 'search');
193 $modules_to_search = array();
195 if(!empty($users_modules)) {
196 // use user's previous selections
197 foreach ( $users_modules as $key => $value ) {
198 if (isset($unified_search_modules_display[$key]) && !empty($unified_search_modules_display[$key]['visible'])) {
199 $modules_to_search[$key] = $beanList[$key];
203 foreach($unified_search_modules_display as $module=>$data) {
204 if (!empty($data['visible']) ) {
205 $modules_to_search[$module] = $beanList[$module];
209 $current_user->setPreference('globalSearch', $modules_to_search, 'search');
213 $templateFile = 'modules/Home/UnifiedSearchAdvancedForm.tpl';
214 if(file_exists('custom/' . $templateFile))
216 $templateFile = 'custom/'.$templateFile;
219 echo $this->getDropDownDiv($templateFile);
221 $module_results = array();
222 $module_counts = array();
223 $has_results = false;
225 if(!empty($this->query_string)) {
226 foreach($modules_to_search as $moduleName => $beanName) {
227 require_once $beanFiles[$beanName] ;
228 $seed = new $beanName();
230 $lv = new ListViewSmarty();
231 $lv->lvd->additionalDetails = false;
232 $mod_strings = return_module_language($current_language, $seed->module_dir);
234 //retrieve the original list view defs and store for processing in case of custom layout changes
235 require('modules/'.$seed->module_dir.'/metadata/listviewdefs.php');
236 $orig_listViewDefs = $listViewDefs;
238 if(file_exists('custom/modules/'.$seed->module_dir.'/metadata/listviewdefs.php'))
240 require('custom/modules/'.$seed->module_dir.'/metadata/listviewdefs.php');
243 if ( !isset($listViewDefs) || !isset($listViewDefs[$seed->module_dir]) )
248 $unifiedSearchFields = array () ;
249 $innerJoins = array();
250 foreach ( $unified_search_modules[ $moduleName ]['fields'] as $field=>$def )
252 $listViewCheckField = strtoupper($field);
253 //check to see if the field is in listview defs
254 if ( empty($listViewDefs[$seed->module_dir][$listViewCheckField]['default']) ) {
255 //check to see if field is in original list view defs (in case we are using custom layout defs)
256 if (!empty($orig_listViewDefs[$seed->module_dir][$listViewCheckField]['default']) ) {
257 //if we are here then the layout has been customized, but the field is still needed for query creation
258 $listViewDefs[$seed->module_dir][$listViewCheckField] = $orig_listViewDefs[$seed->module_dir][$listViewCheckField];
263 //bug: 34125 we might want to try to use the LEFT JOIN operator instead of the INNER JOIN in the case we are
264 //joining against a field that has not been populated.
265 if(!empty($def['innerjoin']) )
267 if (empty($def['db_field']) )
271 $innerJoins[$field] = $def;
272 $def['innerjoin'] = str_replace('INNER', 'LEFT', $def['innerjoin']);
274 $unifiedSearchFields[ $moduleName ] [ $field ] = $def ;
275 $unifiedSearchFields[ $moduleName ] [ $field ][ 'value' ] = $this->query_string ;
279 * Use searchForm2->generateSearchWhere() to create the search query, as it can generate SQL for the full set of comparisons required
280 * generateSearchWhere() expects to find the search conditions for a field in the 'value' parameter of the searchFields entry for that field
282 require_once $beanFiles[$beanName] ;
283 $seed = new $beanName();
284 require_once 'include/SearchForm/SearchForm2.php' ;
285 $searchForm = new SearchForm ( $seed, $moduleName ) ;
287 $searchForm->setup (array ( $moduleName => array() ) , $unifiedSearchFields , '' , 'saved_views' /* hack to avoid setup doing further unwanted processing */ ) ;
288 $where_clauses = $searchForm->generateSearchWhere() ;
289 //add inner joins back into the where clause
290 $params = array('custom_select' => "");
291 foreach($innerJoins as $field=>$def) {
292 if (isset ($def['db_field'])) {
293 foreach($def['db_field'] as $dbfield)
294 $where_clauses[] = $dbfield . " LIKE '" . $this->query_string . "%'";
295 $params['custom_select'] .= ", $dbfield";
296 $params['distinct'] = true;
297 //$filterFields[$dbfield] = $dbfield;
301 if (count($where_clauses) > 0)
303 $where = '(('. implode(' ) OR ( ', $where_clauses) . '))';
306 $displayColumns = array();
307 foreach($listViewDefs[$seed->module_dir] as $colName => $param)
309 if(!empty($param['default']) && $param['default'] == true)
311 $param['url_sort'] = true;//bug 27933
312 $displayColumns[$colName] = $param;
316 if(count($displayColumns) > 0)
318 $lv->displayColumns = $displayColumns;
320 $lv->displayColumns = $listViewDefs[$seed->module_dir];
324 $lv->mergeduplicates = false;
325 $lv->multiSelect = false;
328 $lv->showMassupdateFields = false;
334 $lv->overlib = false;
337 $lv->setup($seed, 'include/ListView/ListViewNoMassUpdate.tpl', $where, $params, 0, 10);
339 $module_results[$moduleName] = '<br /><br />' . get_form_header($GLOBALS['app_list_strings']['moduleList'][$seed->module_dir] . ' (' . $lv->data['pageData']['offsets']['total'] . ')', '', false);
340 $module_counts[$moduleName] = $lv->data['pageData']['offsets']['total'];
342 if($lv->data['pageData']['offsets']['total'] == 0) {
343 //$module_results[$moduleName] .= "<li class='noBullet' id='whole_subpanel_{$moduleName}'><div id='div_{$moduleName}'><h2>" . $home_mod_strings['LBL_NO_RESULTS_IN_MODULE'] . '</h2></div></li>';
344 $module_results[$moduleName] .= '<h2>' . $home_mod_strings['LBL_NO_RESULTS_IN_MODULE'] . '</h2>';
347 //$module_results[$moduleName] .= "<li class='noBullet' id='whole_subpanel_{$moduleName}'><div id='div_{$moduleName}'>" . $lv->display(false, false) . '</div></li>';
348 $module_results[$moduleName] .= $lv->display(false, false);
355 foreach($module_counts as $name=>$value) {
356 echo $module_results[$name];
358 } else if(empty($_REQUEST['form_only'])) {
359 echo $home_mod_strings['LBL_NO_RESULTS'];
360 echo $home_mod_strings['LBL_NO_RESULTS_TIPS'];
365 function buildCache()
368 global $beanList, $beanFiles, $dictionary;
370 $supported_modules = array();
372 foreach($beanList as $moduleName=>$beanName)
374 if (!isset($beanFiles[$beanName]))
377 $beanName = BeanFactory::getObjectName($moduleName);
379 $manager = new VardefManager ( );
380 $manager->loadVardef( $moduleName , $beanName ) ;
382 // obtain the field definitions used by generateSearchWhere (duplicate code in view.list.php)
383 if(file_exists('custom/modules/'.$moduleName.'/metadata/metafiles.php')){
384 require('custom/modules/'.$moduleName.'/metadata/metafiles.php');
385 }elseif(file_exists('modules/'.$moduleName.'/metadata/metafiles.php')){
386 require('modules/'.$moduleName.'/metadata/metafiles.php');
390 if(!empty($metafiles[$moduleName]['searchfields']))
392 require $metafiles[$moduleName]['searchfields'] ;
393 } else if(file_exists("modules/{$moduleName}/metadata/SearchFields.php")) {
394 require "modules/{$moduleName}/metadata/SearchFields.php" ;
397 //Load custom SearchFields.php if it exists
398 if(file_exists("custom/modules/{$moduleName}/metadata/SearchFields.php"))
400 require "custom/modules/{$moduleName}/metadata/SearchFields.php" ;
403 //If there are $searchFields are empty, just continue, there are no search fields defined for the module
404 if(empty($searchFields))
409 $isCustomModule = preg_match('/^([a-z0-9]{1,5})_([a-z0-9_]+)$/i' , $moduleName);
411 //If the bean supports unified search or if it's a custom module bean and unified search is not defined
412 if(!empty($dictionary[$beanName]['unified_search']) || $isCustomModule)
415 foreach ( $dictionary [ $beanName ][ 'fields' ] as $field => $def )
417 // We cannot enable or disable unified_search for email in the vardefs as we don't actually have a vardef entry for 'email'
418 // the searchFields entry for 'email' doesn't correspond to any vardef entry. Instead it contains SQL to directly perform the search.
419 // So as a proxy we allow any field in the vardefs that has a name starting with 'email...' to be tagged with the 'unified_search' parameter
421 if (strpos($field,'email') !== false)
426 //bug: 38139 - allow phone to be searched through Global Search
427 if (strpos($field,'phone') !== false)
432 if ( !empty($def['unified_search']) && isset ( $searchFields [ $moduleName ] [ $field ] ))
434 $fields [ $field ] = $searchFields [ $moduleName ] [ $field ] ;
438 foreach ($searchFields[$moduleName] as $field => $def)
441 isset($def['force_unifiedsearch'])
442 and $def['force_unifiedsearch']
445 $fields[$field] = $def;
449 if(count($fields) > 0) {
450 $supported_modules [$moduleName] ['fields'] = $fields;
451 if (isset($dictionary[$beanName]['unified_search_default_enabled']) && $dictionary[$beanName]['unified_search_default_enabled'] === TRUE)
453 $supported_modules [$moduleName]['default'] = true;
455 $supported_modules [$moduleName]['default'] = false;
463 ksort($supported_modules);
464 write_array_to_file('unified_search_modules', $supported_modules, $GLOBALS['sugar_config']['cache_dir'].'modules/unified_search_modules.php');
471 function modifyGlobalSearchSettings()
473 global $mod_strings, $app_strings, $app_list_strings;
475 if(!file_exists('custom/modules/unified_search_modules_display.php'))
477 $this->createUnifiedSearchModulesDisplay();
480 include('custom/modules/unified_search_modules_display.php');
482 $sugar_smarty = new Sugar_Smarty();
483 $sugar_smarty->assign('APP', $app_strings);
484 $sugar_smarty->assign('MOD', $mod_strings);
486 //Add the translated attribute for display label
487 $json_enabled = array();
488 $json_disabled = array();
489 foreach($unified_search_modules_display as $module=>$data)
491 $label = isset($app_list_strings['moduleList'][$module]) ? $app_list_strings['moduleList'][$module] : $module;
492 if($data['visible'] === true)
494 $json_enabled[] = array("module" => $module, 'label' => $label);
496 $json_disabled[] = array("module" => $module, 'label' => $label);
500 //If the file doesn't exist
501 if(!file_exists($GLOBALS['sugar_config']['cache_dir'].'modules/unified_search_modules.php'))
506 include($GLOBALS['sugar_config']['cache_dir'].'modules/unified_search_modules.php');
508 //Now add any new modules that may have since been added to unified_search_modules.php
509 foreach($unified_search_modules as $module=>$data)
511 if(!isset($unified_search_modules_display[$module]))
513 $label = isset($app_list_strings['moduleList'][$module]) ? $app_list_strings['moduleList'][$module] : $module;
516 $json_enabled[] = array("module" => $module, 'label' => $label);
518 $json_disabled[] = array("module" => $module, 'label' => $label);
523 $sugar_smarty->assign('enabled_modules', json_encode($json_enabled));
524 $sugar_smarty->assign('disabled_modules', json_encode($json_disabled));
526 //uasort($unified_search_modules_display, 'unified_search_modules_cmp');
527 $tpl = 'modules/Administration/templates/GlobalSearchSettings.tpl';
528 if(file_exists('custom/' . $tpl))
530 $tpl = 'custom/' . $tpl;
532 return $sugar_smarty->fetch($tpl);
537 * saveGlobalSearchSettings
538 * This method handles the administrator's request to save the searchable modules selected and stores
539 * the results in the unified_search_modules_display.php file
542 function saveGlobalSearchSettings()
544 if(!file_exists('custom/modules/unified_search_modules_display.php'))
546 $this->createUnifiedSearchModulesDisplay();
549 include('custom/modules/unified_search_modules_display.php');
551 if(isset($_REQUEST['enabled_modules']))
553 $new_unified_search_modules_display = array();
555 foreach(explode (',', $_REQUEST['enabled_modules'] ) as $module)
557 $new_unified_search_modules_display[$module]['visible'] = true;
560 foreach($unified_search_modules_display as $module=>$data)
562 if(!isset($new_unified_search_modules_display[$module]))
564 $new_unified_search_modules_display[$module]['visible'] = false;
568 $this->writeUnifiedSearchModulesDisplayFile($new_unified_search_modules_display);
573 public static function unlinkUnifiedSearchModulesFile() {
574 //clear the unified_search_module.php file
575 if(file_exists($GLOBALS['sugar_config']['cache_dir'].'modules/unified_search_modules.php'))
577 $GLOBALS['log']->info("unlink {$GLOBALS['sugar_config']['cache_dir']}modules/unified_search_modules.php file");
578 unlink($GLOBALS['sugar_config']['cache_dir'].'modules/unified_search_modules.php');
583 * createUnifiedSearchModulesDisplay
584 * method to create the unified_search_modules_display.php file
587 function createUnifiedSearchModulesDisplay()
589 //Make directory if it doesn't exist
590 if(!file_exists('cache/modules'))
592 mkdir_recursive('cache/modules');
595 //Load unified_search_modules.php file
596 if(!file_exists($GLOBALS['sugar_config']['cache_dir'].'modules/unified_search_modules.php'))
601 include($GLOBALS['sugar_config']['cache_dir'].'modules/unified_search_modules.php');
603 $unified_search_modules_display = array();
605 if(!empty($unified_search_modules))
607 foreach($unified_search_modules as $module=>$data)
609 $unified_search_modules_display[$module]['visible'] = (isset($data['default']) && $data['default']) ? true : false;
613 $this->writeUnifiedSearchModulesDisplayFile($unified_search_modules_display);
618 * writeUnifiedSearchModulesDisplayFile
619 * Private method to handle writing the unified_search_modules_display value to file
621 * @param mixed The array of the unified search modules and their display attributes
622 * @return boolean value indication whether or not file was successfully written
623 * @throws Exception Thrown if the file write operation fails
625 private function writeUnifiedSearchModulesDisplayFile($unified_search_modules_display)
627 if(is_null($unified_search_modules_display) || empty($unified_search_modules_display))
632 if(!write_array_to_file("unified_search_modules_display", $unified_search_modules_display, 'custom/modules/unified_search_modules_display.php'))
634 //Log error message and throw Exception
636 $msg = string_format($app_strings['ERR_FILE_WRITE'], array('custom/modules/unified_search_modules_display.php'));
637 $GLOBALS['log']->error($msg);
638 throw new Exception($msg);
646 function unified_search_modules_cmp($a, $b) {
647 if(!isset($a['translated']) || !isset($b['translated']))
652 $name1 = strtolower($a['translated']);
653 $name2 = strtolower($b['translated']);
655 return $name1 < $name2 ? -1 : 1;