include/MVC/View/views/view.list.php

   1 <?php
   2 /*********************************************************************************
   3  * SugarCRM Community Edition is a customer relationship management program developed by
   4  * SugarCRM, Inc. Copyright (C) 2004-2012 SugarCRM Inc.
   5  *
   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.
  12  *
  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
  16  * details.
  17  *
  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
  21  * 02110-1301 USA.
  22  *
  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.
  25  *
  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.
  29  *
  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  ********************************************************************************/
  36
  37 require_once('include/MVC/View/SugarView.php');
  38
  39 require_once('include/ListView/ListViewSmarty.php');
  40
  41 require_once('modules/MySettings/StoreQuery.php');
  42 class ViewList extends SugarView{
  43     var $type ='list';
  44     var $lv;
  45     var $searchForm;
  46     var $use_old_search;
  47     var $headers;
  48     var $seed;
  49     var $params;
  50     var $listViewDefs;
  51     var $storeQuery;
  52     var $where = '';
  53     function ViewList(){
  54         parent::SugarView();
  55     }
  56
  57
  58     function oldSearch(){
  59
  60     }
  61     function newSearch(){
  62
  63     }
  64
  65     function listViewPrepare(){
  66         $module = $GLOBALS['module'];
  67
  68         $metadataFile = $this->getMetaDataFile();
  69
  70         if( !file_exists($metadataFile) )
  71             sugar_die($GLOBALS['app_strings']['LBL_NO_ACTION'] );
  72
  73         require($metadataFile);
  74
  75         $this->listViewDefs = $listViewDefs;
  76
  77         if(!empty($this->bean->object_name) && isset($_REQUEST[$module.'2_'.strtoupper($this->bean->object_name).'_offset'])) {//if you click the pagination button, it will populate the search criteria here
  78             if(!empty($_REQUEST['current_query_by_page'])) {//The code support multi browser tabs pagination
  79                 $blockVariables = array('mass', 'uid', 'massupdate', 'delete', 'merge', 'selectCount', 'request_data', 'current_query_by_page',$module.'2_'.strtoupper($this->bean->object_name).'_ORDER_BY' );
  80                 if(isset($_REQUEST['lvso'])){
  81                     $blockVariables[] = 'lvso';
  82                 }
  83                 $current_query_by_page = unserialize(base64_decode($_REQUEST['current_query_by_page']));
  84                 foreach($current_query_by_page as $search_key=>$search_value) {
  85                     if($search_key != $module.'2_'.strtoupper($this->bean->object_name).'_offset' && !in_array($search_key, $blockVariables)) {
  86                         if (!is_array($search_value)) {
  87                             $_REQUEST[$search_key] = $GLOBALS['db']->quote($search_value);
  88                         }
  89                         else {
  90                             foreach ($search_value as $key=>&$val) {
  91                                 $val = $GLOBALS['db']->quote($val);
  92                             }
  93                             $_REQUEST[$search_key] = $search_value;
  94                         }
  95                     }
  96                 }
  97             }
  98         }
  99         if(!empty($_REQUEST['saved_search_select'])) {
 100             if ($_REQUEST['saved_search_select']=='_none' || !empty($_REQUEST['button'])) {
 101                 $_SESSION['LastSavedView'][$_REQUEST['module']] = '';
 102                 unset($_REQUEST['saved_search_select']);
 103                 unset($_REQUEST['saved_search_select_name']);
 104
 105                 //use the current search module, or the current module to clear out layout changes
 106                 if(!empty($_REQUEST['search_module']) || !empty($_REQUEST['module'])){
 107                     $mod = !empty($_REQUEST['search_module']) ? $_REQUEST['search_module'] : $_REQUEST['module'];
 108                     global $current_user;
 109                     //Reset the current display columns to default.
 110                     $current_user->setPreference('ListViewDisplayColumns', array(), 0, $mod);
 111                 }
 112             }
 113             else if(empty($_REQUEST['button']) && (empty($_REQUEST['clear_query']) || $_REQUEST['clear_query']!='true')) {
 114                 $this->saved_search = loadBean('SavedSearch');
 115                 $this->saved_search->retrieveSavedSearch($_REQUEST['saved_search_select']);
 116                 $this->saved_search->populateRequest();
 117             }
 118             elseif(!empty($_REQUEST['button'])) { // click the search button, after retrieving from saved_search
 119                 $_SESSION['LastSavedView'][$_REQUEST['module']] = '';
 120                 unset($_REQUEST['saved_search_select']);
 121                 unset($_REQUEST['saved_search_select_name']);
 122             }
 123         }
 124         $this->storeQuery = new StoreQuery();
 125         if(!isset($_REQUEST['query'])){
 126             $this->storeQuery->loadQuery($this->module);
 127             $this->storeQuery->populateRequest();
 128         }else{
 129             $this->storeQuery->saveFromRequest($this->module);
 130         }
 131
 132         $this->seed = $this->bean;
 133
 134         $displayColumns = array();
 135         if(!empty($_REQUEST['displayColumns'])) {
 136             foreach(explode('|', $_REQUEST['displayColumns']) as $num => $col) {
 137                 if(!empty($this->listViewDefs[$module][$col]))
 138                     $displayColumns[$col] = $this->listViewDefs[$module][$col];
 139             }
 140         }
 141         else {
 142             foreach($this->listViewDefs[$module] as $col => $this->params) {
 143                 if(!empty($this->params['default']) && $this->params['default'])
 144                     $displayColumns[$col] = $this->params;
 145             }
 146         }
 147         $this->params = array('massupdate' => true);
 148         if(!empty($_REQUEST['orderBy'])) {
 149             $this->params['orderBy'] = $_REQUEST['orderBy'];
 150             $this->params['overrideOrder'] = true;
 151             if(!empty($_REQUEST['sortOrder'])) $this->params['sortOrder'] = $_REQUEST['sortOrder'];
 152         }
 153         $this->lv->displayColumns = $displayColumns;
 154
 155         $this->module = $module;
 156
 157         $this->prepareSearchForm();
 158
 159         if(isset($this->options['show_title']) && $this->options['show_title']) {
 160             $moduleName = isset($this->seed->module_dir) ? $this->seed->module_dir : $GLOBALS['mod_strings']['LBL_MODULE_NAME'];
 161             echo $this->getModuleTitle(true);
 162         }
 163     }
 164
 165     function listViewProcess(){
 166         $this->processSearchForm();
 167         $this->lv->searchColumns = $this->searchForm->searchColumns;
 168
 169         if(!$this->headers)
 170             return;
 171         if(empty($_REQUEST['search_form_only']) || $_REQUEST['search_form_only'] == false){
 172             $this->lv->ss->assign("SEARCH",true);
 173             $this->lv->setup($this->seed, 'include/ListView/ListViewGeneric.tpl', $this->where, $this->params);
 174             $savedSearchName = empty($_REQUEST['saved_search_select_name']) ? '' : (' - ' . $_REQUEST['saved_search_select_name']);
 175             echo $this->lv->display();
 176         }
 177     }
 178     function prepareSearchForm()
 179     {
 180         $this->searchForm = null;
 181
 182         //search
 183         $view = 'basic_search';
 184         if(!empty($_REQUEST['search_form_view']) && $_REQUEST['search_form_view'] == 'advanced_search')
 185             $view = $_REQUEST['search_form_view'];
 186         $this->headers = true;
 187
 188         if(!empty($_REQUEST['search_form_only']) && $_REQUEST['search_form_only'])
 189             $this->headers = false;
 190         elseif(!isset($_REQUEST['search_form']) || $_REQUEST['search_form'] != 'false')
 191         {
 192             if(isset($_REQUEST['searchFormTab']) && $_REQUEST['searchFormTab'] == 'advanced_search')
 193             {
 194                 $view = 'advanced_search';
 195             }
 196             else
 197             {
 198                 $view = 'basic_search';
 199             }
 200         }
 201
 202         $this->use_old_search = true;
 203         if ((file_exists('modules/' . $this->module . '/SearchForm.html')
 204                 && !file_exists('modules/' . $this->module . '/metadata/searchdefs.php'))
 205             || (file_exists('custom/modules/' . $this->module . '/SearchForm.html')
 206                 && !file_exists('custom/modules/' . $this->module . '/metadata/searchdefs.php')))
 207         {
 208             require_once('include/SearchForm/SearchForm.php');
 209             $this->searchForm = new SearchForm($this->module, $this->seed);
 210         }
 211         else
 212         {
 213             $this->use_old_search = false;
 214             require_once('include/SearchForm/SearchForm2.php');
 215
 216             $searchMetaData = SearchForm::retrieveSearchDefs($this->module);
 217
 218             $this->searchForm = new SearchForm($this->seed, $this->module, $this->action);
 219             $this->searchForm->setup($searchMetaData['searchdefs'], $searchMetaData['searchFields'], 'SearchFormGeneric.tpl', $view, $this->listViewDefs);
 220             $this->searchForm->lv = $this->lv;
 221         }
 222     }
 223
 224     function processSearchForm(){
 225         if(isset($_REQUEST['query']))
 226         {
 227             // we have a query
 228             if(!empty($_SERVER['HTTP_REFERER']) && preg_match('/action=EditView/', $_SERVER['HTTP_REFERER'])) { // from EditView cancel
 229                 $this->searchForm->populateFromArray($this->storeQuery->query);
 230             }
 231             else {
 232                 $this->searchForm->populateFromRequest();
 233             }
 234
 235             $where_clauses = $this->searchForm->generateSearchWhere(true, $this->seed->module_dir);
 236
 237             if (count($where_clauses) > 0 )$this->where = '('. implode(' ) AND ( ', $where_clauses) . ')';
 238             $GLOBALS['log']->info("List View Where Clause: $this->where");
 239         }
 240         if($this->use_old_search){
 241             switch($view) {
 242                 case 'basic_search':
 243                     $this->searchForm->setup();
 244                     $this->searchForm->displayBasic($this->headers);
 245                     break;
 246                  case 'advanced_search':
 247                     $this->searchForm->setup();
 248                     $this->searchForm->displayAdvanced($this->headers);
 249                     break;
 250                  case 'saved_views':
 251                     echo $this->searchForm->displaySavedViews($this->listViewDefs, $this->lv, $this->headers);
 252                    break;
 253             }
 254         }else{
 255             echo $this->searchForm->display($this->headers);
 256         }
 257     }
 258     function preDisplay(){
 259         $this->lv = new ListViewSmarty();
 260     }
 261     function display(){
 262         if(!$this->bean || !$this->bean->ACLAccess('list')){
 263             ACLController::displayNoAccess();
 264         } else {
 265             $this->listViewPrepare();
 266             $this->listViewProcess();
 267         }
 268     }
 269 }
 270 ?>