2 if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
3 /*********************************************************************************
4 * SugarCRM is a customer relationship management program developed by
5 * SugarCRM, Inc. Copyright (C) 2004-2011 SugarCRM Inc.
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 ********************************************************************************/
45 require_once('include/templates/TemplateGroupChooser.php');
48 class SavedSearch extends SugarBean {
56 var $assigned_user_id;
57 var $assigned_user_name;
58 var $modified_by_name;
64 var $object_name = 'SavedSearch';
65 var $table_name = 'saved_search';
67 var $module_dir = 'SavedSearch';
68 var $field_defs = array();
69 var $field_defs_map = array();
73 function SavedSearch($columns = array(), $orderBy = null, $sortOrder = 'DESC') {
75 $this->columns = $columns;
76 $this->orderBy = $orderBy;
77 $this->sortOrder = $sortOrder;
78 $this->setupCustomFields('SavedSearch');
79 foreach ($this->field_defs as $field) {
80 $this->field_name_map[$field['name']] = $field;
86 function getForm($module, $inline = true) {
87 global $db, $current_user, $currentModule, $current_language, $app_strings;
90 $saved_search_mod_strings = return_module_language($current_language, 'SavedSearch');
92 $query = 'SELECT id, name FROM saved_search
95 assigned_user_id = \'' . $current_user->id . '\' AND
96 search_module = \'' . $module . '\'
98 $result = $db->query($query, true, "Error filling in saved search list: ");
100 $savedSearchArray['_none'] = $app_strings['LBL_NONE'];
101 while ($row = $db->fetchByAssoc($result)) {
102 $savedSearchArray[$row['id']] = $row['name'];
105 $sugarSmarty = new Sugar_Smarty();
106 $sugarSmarty->assign('SEARCH_MODULE', $module);
107 $sugarSmarty->assign('MOD', $saved_search_mod_strings);
108 $sugarSmarty->assign('DELETE', $app_strings['LBL_DELETE_BUTTON_LABEL']);
109 $sugarSmarty->assign('UPDATE', $app_strings['LBL_UPDATE']);
110 $sugarSmarty->assign('SAVE', $app_strings['LBL_SAVE_BUTTON_LABEL']);
113 $chooser = new TemplateGroupChooser();
115 $chooser->args['id'] = 'edit_tabs';
116 $chooser->args['left_size'] = 7;
117 $chooser->args['right_size'] = 7;
118 $chooser->args['values_array'][0] = array();
119 $chooser->args['values_array'][1] = array();
121 if(isset($_REQUEST['saved_search_select']) && $_REQUEST['saved_search_select']!='_none') {
122 $this->retrieveSavedSearch($_REQUEST['saved_search_select']);
125 if((!empty($_REQUEST['displayColumns']) && $_REQUEST['displayColumns'] != 'undefined') || (isset($this->contents['displayColumns']) && $this->contents['displayColumns'] != 'undefined')) {
126 // columns to display
127 if(!empty($_REQUEST['displayColumns']) && $_REQUEST['displayColumns'] != 'undefined') $temp_displayColumns = $_REQUEST['displayColumns'];
128 else $temp_displayColumns = $this->contents['displayColumns'];
129 foreach(explode('|', $temp_displayColumns) as $num => $name) {
130 if (!isset($this->columns[$name])) {
131 // Ignore any column that is not on the list.
134 $chooser->args['values_array'][0][$name] = trim(translate($this->columns[$name]['label'], $module), ':');
136 // columns not displayed
137 foreach(array_diff(array_keys($this->columns), array_values(explode('|', $temp_displayColumns))) as $num => $name) {
138 $chooser->args['values_array'][1][$name] = trim(translate($this->columns[$name]['label'], $module), ':');
142 foreach($this->columns as $name => $val) {
143 if(!empty($val['default']) && $val['default'])
144 $chooser->args['values_array'][0][$name] = trim(translate($val['label'], $module), ':');
146 $chooser->args['values_array'][1][$name] = trim(translate($val['label'], $module), ':');
150 if(!empty($_REQUEST['sortOrder'])) $this->sortOrder = $_REQUEST['sortOrder'];
151 if(!empty($_REQUEST['orderBy'])) $this->orderBy = $_REQUEST['orderBy'];
153 $chooser->args['left_name'] = 'display_tabs';
154 $chooser->args['right_name'] = 'hide_tabs';
155 $chooser->args['alt_tip'] = $app_strings['LBL_SORT'];
157 $chooser->args['left_label'] = $app_strings['LBL_DISPLAY_COLUMNS'];
158 $chooser->args['right_label'] = $app_strings['LBL_HIDE_COLUMNS'];
159 $chooser->args['title'] = '';
160 $sugarSmarty->assign('columnChooser', $chooser->display());
162 $sugarSmarty->assign('selectedOrderBy', $this->orderBy);
163 if(empty($this->sortOrder)) $this->sortOrder = 'ASC';
164 $sugarSmarty->assign('selectedSortOrder', $this->sortOrder);
166 $lastSavedView = (empty($_SESSION['LastSavedView'][$module]) ? '' : $_SESSION['LastSavedView'][$module]);
167 $sugarSmarty->assign('columnsMeta', $json->encode($this->columns));
168 $sugarSmarty->assign('lastSavedView', $lastSavedView);
169 $sugarSmarty->assign('SAVED_SEARCHES_OPTIONS', get_select_options_with_id($savedSearchArray, $lastSavedView));
171 $json = getJSONobj();
173 return $sugarSmarty->fetch('modules/SavedSearch/SavedSearchForm.tpl');
176 function getSelect($module) {
179 global $db, $current_user, $currentModule, $current_lang, $app_strings;
180 $saved_search_mod_strings = return_module_language($current_lang, 'SavedSearch');
182 $query = 'SELECT id, name FROM saved_search
185 assigned_user_id = \'' . $current_user->id . '\' AND
186 search_module = \'' . $module . '\'
188 $result = $db->query($query, true, "Error filling in saved search list: ");
190 $savedSearchArray['_none'] = $app_strings['LBL_NONE'];
191 while ($row = $db->fetchByAssoc($result)) {
192 $savedSearchArray[$row['id']] = $row['name'];
195 $sugarSmarty = new Sugar_Smarty();
196 $sugarSmarty->assign('SEARCH_MODULE', $module);
197 $sugarSmarty->assign('MOD', $saved_search_mod_strings);
199 if(!empty($_SESSION['LastSavedView'][$module]) && (($_REQUEST['action'] == 'ListView') || ($_REQUEST['action'] == 'index')))
200 $selectedSearch = $_SESSION['LastSavedView'][$module];
202 $selectedSearch = '';
204 $sugarSmarty->assign('SAVED_SEARCHES_OPTIONS', get_select_options_with_id($savedSearchArray, $selectedSearch));
206 return $sugarSmarty->fetch('modules/SavedSearch/SavedSearchSelects.tpl');
209 function returnSavedSearch($id, $searchFormTab = 'advanced_search', $showDiv='no') {
210 global $db, $current_user, $currentModule;
211 $this->retrieveSavedSearch($id);
213 $header = 'Location: index.php?action=index&module=';
215 $saved_search_name = '';
216 $header .= $this->contents['search_module'];
217 if(empty($_SESSION['LastSavedView'])) $_SESSION['LastSavedView'] = array();
218 $_SESSION['LastSavedView'][$this->contents['search_module']] = $id;
219 $saved_search_id = $id;
220 $saved_search_name = $this->name;
221 $search_form_tab = $this->contents['searchFormTab'];
222 $query = $this->contents['query'];
223 $orderBy = empty($this->contents['orderBy'])? 'name' : $this->contents['orderBy'];
224 //Reduce the params to avoid the problems caused by URL max length in IE.
225 header($header . '&saved_search_select=' . $saved_search_id . '&saved_search_select_name=' . $saved_search_name . '&orderBy=' . $orderBy . '&sortOrder=' . $this->contents['sortOrder'] . '&query=' . $query . '&searchFormTab='. $search_form_tab .'&showSSDIV=' . $showDiv);
228 function returnSavedSearchContents($id) {
229 global $db, $current_user, $currentModule;
230 $query = 'SELECT id, name, contents, search_module FROM saved_search
232 id = \'' . $id . '\'';
233 $result = $db->query($query, true, "Error filling in saved search list: ");
235 $header = 'Location: index.php?action=index&module=';
237 $saved_search_name = '';
238 while ($row = $db->fetchByAssoc($result, -1, false)) {
239 $header .= $row['search_module'];
240 if(empty($_SESSION['LastSavedView'])) $_SESSION['LastSavedView'] = array();
241 $_SESSION['LastSavedView'][$row['search_module']] = $row['id'];
242 $contents = unserialize(base64_decode($row['contents']));
243 $saved_search_id = $row['id'];
244 $saved_search_name = $row['name'];
250 function handleDelete($id) {
251 $this->mark_deleted($id);
252 header("Location: index.php?action=index&module={$_REQUEST['search_module']}&advanced={$_REQUEST['advanced']}&query=true&clear_query=true");
255 function handleSave($prefix, $redirect = true, $useRequired = false, $id = null) {
258 global $current_user;
259 $focus = new SavedSearch();
260 if($id) $focus->retrieve($id);
262 if($useRequired && !checkRequired($prefix, array_keys($focus->required_fields))) {
266 $ignored_inputs = array('PHPSESSID', 'module', 'action', 'saved_search_name', 'saved_search_select', 'advanced', 'Calls_divs', 'ACLRoles_divs');
268 $contents = $_REQUEST;
269 if($id == null) $focus->name = $contents['saved_search_name'];
270 $focus->search_module = $contents['search_module'];
272 foreach($contents as $input => $value) {
273 if(in_array($input, $ignored_inputs)) unset($contents[$input]);
275 $contents['advanced'] = true;
277 $focus->contents = base64_encode(serialize($contents));
279 $focus->assigned_user_id = $current_user->id;
280 $focus->new_schema = true;
282 $saved_search_id = $focus->save();
284 $GLOBALS['log']->debug("Saved record with id of " . $focus->id);
285 $orderBy = empty($contents['orderBy'])? 'name' : $contents['orderBy'];
286 $search_query = "&orderBy=" . $orderBy . "&sortOrder=".$contents['sortOrder'] . "&query=" . $_REQUEST['query'] . "&searchFormTab=" . $_REQUEST['searchFormTab'].'&showSSDIV=' . $contents['showSSDIV'];
288 $this->handleRedirect($focus->search_module, $search_query, $saved_search_id, 'true');
291 function handleRedirect($return_module, $search_query, $saved_search_id, $advanced = 'false') {
292 $_SESSION['LastSavedView'][$return_module] = $saved_search_id;
293 $return_action = 'index';
294 //Reduce the params to avoid the problems caused by URL max length in IE ( the reduced params can be get from saved search according to saved_search_id).
295 header("Location: index.php?action=$return_action&module=$return_module&saved_search_select={$saved_search_id}{$search_query}&advanced={$advanced}");
299 function fill_in_additional_list_fields() {
300 global $app_list_strings;
301 // Fill in the assigned_user_name
302 $this->search_module = $app_list_strings['moduleList'][$this->contents['search_module']];
303 $this->assigned_user_name = get_assigned_user_name($this->assigned_user_id);
308 function retrieveSavedSearch($id) {
309 parent::retrieve($id);
310 $this->contents = unserialize(base64_decode($this->contents));
313 function populateRequest(){
314 foreach($this->contents as $key=>$val){
315 // todo wp: remove this
316 if($key != 'advanced' && $key != 'module' && !strpos($key, '_ORDER_BY') && $key != 'lvso') { // cn: bug 6546 storequery stomps correct value for 'module' in Activities
317 $_REQUEST[$key] = $val;