modules/SavedSearch/SavedSearch.php

   1 <?php
   2 if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
   3 /*********************************************************************************
   4  * SugarCRM is a customer relationship management program developed by
   5  * SugarCRM, Inc. Copyright (C) 2004-2011 SugarCRM Inc.
   6  *
   7  * This program is free software; you can redistribute it and/or modify it under
   8  * the terms of the GNU Affero General Public License version 3 as published by the
   9  * Free Software Foundation with the addition of the following permission added
  10  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
  11  * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
  12  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
  13  *
  14  * This program is distributed in the hope that it will be useful, but WITHOUT
  15  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  16  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
  17  * details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License along with
  20  * this program; if not, see http://www.gnu.org/licenses or write to the Free
  21  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  22  * 02110-1301 USA.
  23  *
  24  * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
  25  * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
  26  *
  27  * The interactive user interfaces in modified source and object code versions
  28  * of this program must display Appropriate Legal Notices, as required under
  29  * Section 5 of the GNU Affero General Public License version 3.
  30  *
  31  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
  32  * these Appropriate Legal Notices must retain the display of the "Powered by
  33  * SugarCRM" logo. If the display of the logo is not reasonably feasible for
  34  * technical reasons, the Appropriate Legal Notices must display the words
  35  * "Powered by SugarCRM".
  36  ********************************************************************************/
  37
  38 /*********************************************************************************
  39
  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');
  46
  47
  48 class SavedSearch extends SugarBean {
  49         var $db;
  50     var $field_name_map;
  51
  52         // Stored fields
  53         var $id;
  54         var $date_entered;
  55         var $date_modified;
  56         var $assigned_user_id;
  57         var $assigned_user_name;
  58         var $modified_by_name;
  59         var $name;
  60         var $description;
  61         var $content;
  62         var $search_module;
  63
  64         var $object_name = 'SavedSearch';
  65         var $table_name = 'saved_search';
  66
  67         var $module_dir = 'SavedSearch';
  68         var $field_defs = array();
  69         var $field_defs_map = array();
  70
  71     var $columns;
  72
  73         function SavedSearch($columns = array(), $orderBy = null, $sortOrder = 'DESC') {
  74                 parent::SugarBean();
  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;
  81                 }
  82
  83         }
  84
  85         // Saved Search Form
  86         function getForm($module, $inline = true) {
  87             global $db, $current_user, $currentModule, $current_language, $app_strings;
  88         $json = getJSONobj();
  89
  90                 $saved_search_mod_strings = return_module_language($current_language, 'SavedSearch');
  91
  92                 $query = 'SELECT id, name FROM saved_search
  93                                   WHERE
  94                                         deleted = \'0\' AND
  95                                         assigned_user_id = \'' . $current_user->id . '\' AND
  96                                         search_module =  \'' . $module . '\'
  97                                   ORDER BY name';
  98             $result = $db->query($query, true, "Error filling in saved search list: ");
  99
 100                 $savedSearchArray['_none'] = $app_strings['LBL_NONE'];
 101             while ($row = $db->fetchByAssoc($result)) {
 102                 $savedSearchArray[$row['id']] = $row['name'];
 103             }
 104
 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']);
 111
 112         // Column Chooser
 113         $chooser = new TemplateGroupChooser();
 114
 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();
 120
 121         if(isset($_REQUEST['saved_search_select']) && $_REQUEST['saved_search_select']!='_none') {
 122             $this->retrieveSavedSearch($_REQUEST['saved_search_select']);
 123         }
 124
 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.
 132                                 continue;
 133                         }
 134                     $chooser->args['values_array'][0][$name] = trim(translate($this->columns[$name]['label'], $module), ':');
 135              }
 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), ':');
 139              }
 140         }
 141         else {
 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), ':');
 145                 else
 146                     $chooser->args['values_array'][1][$name] = trim(translate($val['label'], $module), ':');
 147             }
 148         }
 149
 150         if(!empty($_REQUEST['sortOrder'])) $this->sortOrder = $_REQUEST['sortOrder'];
 151         if(!empty($_REQUEST['orderBy'])) $this->orderBy = $_REQUEST['orderBy'];
 152
 153         $chooser->args['left_name'] = 'display_tabs';
 154         $chooser->args['right_name'] = 'hide_tabs';
 155         $chooser->args['alt_tip'] = $app_strings['LBL_SORT'];
 156
 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());
 161
 162         $sugarSmarty->assign('selectedOrderBy', $this->orderBy);
 163         if(empty($this->sortOrder)) $this->sortOrder = 'ASC';
 164         $sugarSmarty->assign('selectedSortOrder', $this->sortOrder);
 165
 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));
 170
 171         $json = getJSONobj();
 172
 173         return $sugarSmarty->fetch('modules/SavedSearch/SavedSearchForm.tpl');
 174         }
 175
 176     function getSelect($module) {
 177
 178
 179         global $db, $current_user, $currentModule, $current_lang, $app_strings;
 180         $saved_search_mod_strings = return_module_language($current_lang, 'SavedSearch');
 181
 182         $query = 'SELECT id, name FROM saved_search
 183                   WHERE
 184                     deleted = \'0\' AND
 185                     assigned_user_id = \'' . $current_user->id . '\' AND
 186                     search_module =  \'' . $module . '\'
 187                   ORDER BY name';
 188         $result = $db->query($query, true, "Error filling in saved search list: ");
 189
 190         $savedSearchArray['_none'] = $app_strings['LBL_NONE'];
 191         while ($row = $db->fetchByAssoc($result)) {
 192             $savedSearchArray[$row['id']] = $row['name'];
 193         }
 194
 195         $sugarSmarty = new Sugar_Smarty();
 196         $sugarSmarty->assign('SEARCH_MODULE', $module);
 197         $sugarSmarty->assign('MOD', $saved_search_mod_strings);
 198
 199         if(!empty($_SESSION['LastSavedView'][$module]) && (($_REQUEST['action'] == 'ListView') || ($_REQUEST['action'] == 'index')))
 200             $selectedSearch = $_SESSION['LastSavedView'][$module];
 201         else
 202             $selectedSearch = '';
 203
 204         $sugarSmarty->assign('SAVED_SEARCHES_OPTIONS', get_select_options_with_id($savedSearchArray, $selectedSearch));
 205
 206         return $sugarSmarty->fetch('modules/SavedSearch/SavedSearchSelects.tpl');
 207     }
 208
 209     function returnSavedSearch($id, $searchFormTab = 'advanced_search', $showDiv='no') {
 210         global $db, $current_user, $currentModule;
 211         $this->retrieveSavedSearch($id);
 212
 213         $header = 'Location: index.php?action=index&module=';
 214
 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);
 226 }
 227
 228     function returnSavedSearchContents($id) {
 229                 global $db, $current_user, $currentModule;
 230                 $query = 'SELECT id, name, contents, search_module FROM saved_search
 231                                   WHERE
 232                                         id = \'' . $id . '\'';
 233             $result = $db->query($query, true, "Error filling in saved search list: ");
 234
 235             $header = 'Location: index.php?action=index&module=';
 236             $contents = '';
 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'];
 245             }
 246
 247             return $contents;
 248         }
 249
 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");
 253         }
 254
 255         function handleSave($prefix, $redirect = true, $useRequired = false, $id = null) {
 256
 257
 258                 global $current_user;
 259                 $focus = new SavedSearch();
 260                 if($id) $focus->retrieve($id);
 261
 262                 if($useRequired && !checkRequired($prefix, array_keys($focus->required_fields))) {
 263                         return null;
 264                 }
 265
 266                 $ignored_inputs = array('PHPSESSID', 'module', 'action', 'saved_search_name', 'saved_search_select', 'advanced', 'Calls_divs', 'ACLRoles_divs');
 267
 268         $contents = $_REQUEST;
 269                 if($id == null) $focus->name = $contents['saved_search_name'];
 270                 $focus->search_module = $contents['search_module'];
 271
 272                 foreach($contents as $input => $value) {
 273                         if(in_array($input, $ignored_inputs)) unset($contents[$input]);
 274                 }
 275                 $contents['advanced'] = true;
 276
 277                 $focus->contents = base64_encode(serialize($contents));
 278
 279                 $focus->assigned_user_id = $current_user->id;
 280                 $focus->new_schema = true;
 281
 282                 $saved_search_id = $focus->save();
 283
 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'];
 287
 288         $this->handleRedirect($focus->search_module, $search_query, $saved_search_id, 'true');
 289     }
 290
 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}");
 296         die();
 297         }
 298
 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);
 304
 305         }
 306
 307
 308     function retrieveSavedSearch($id) {
 309         parent::retrieve($id);
 310         $this->contents = unserialize(base64_decode($this->contents));
 311     }
 312
 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;
 318                 $_GET[$key] = $val;
 319             }
 320         }
 321     }
 322 }
 323
 324 ?>