include/Dashlets/DashletGeneric.php

   1 <?php
   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.
   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 require_once('include/Dashlets/Dashlet.php');
  39 require_once('include/ListView/ListViewSmarty.php');
  40 require_once('include/generic/LayoutManager.php');
  41
  42 /**
  43  * Generic Dashlet class
  44  * @api
  45  */
  46 class DashletGeneric extends Dashlet {
  47    /**
  48      * Fields that are searchable
  49      * @var array
  50      */
  51     var $searchFields;
  52     /**
  53      * Displayable columns (ones available to display)
  54      * @var array
  55      */
  56     var $columns;
  57     /**
  58      * Bean file used in this Dashlet
  59      * @var bean
  60      */
  61     var $seedBean;
  62     /**
  63      * collection of filters to apply
  64      * @var array
  65      */
  66     var $filters = null;
  67     /**
  68      * Number of Rows to display
  69      * @var int
  70      */
  71     var $displayRows = '5';
  72     /**
  73      * Actual columns to display, will be a subset of $columns
  74      * @var array
  75      */
  76     var $displayColumns = null;
  77     /**
  78      * Flag to display only the current users's items.
  79      * @var bool
  80      */
  81     var $myItemsOnly = true;
  82     /**
  83      * Flag to display "myItemsOnly" checkbox in the DashletGenericConfigure.
  84      * @var bool
  85      */
  86     var $showMyItemsOnly = true;
  87     /**
  88      * location of Smarty template file for display
  89      * @var string
  90      */
  91     var $displayTpl = 'include/Dashlets/DashletGenericDisplay.tpl';
  92     /**
  93      * location of smarty template file for configuring
  94      * @var string
  95      */
  96     var $configureTpl = 'include/Dashlets/DashletGenericConfigure.tpl';
  97     /**
  98      * smarty object for the generic configuration template
  99      * @var string
 100      */
 101     var $configureSS;
 102     /** search inputs to be populated in configure template.
 103      *  modify this after processDisplayOptions, but before displayOptions to modify search inputs
 104      *  @var array
 105      */
 106     var $currentSearchFields;
 107     /**
 108      * ListView Smarty Class
 109      * @var Smarty
 110      */
 111     var $lvs;
 112     var $layoutManager;
 113
 114     function DashletGeneric($id, $options = null) {
 115         parent::Dashlet($id);
 116         $this->isConfigurable = true;
 117         if(isset($options)) {
 118             if(!empty($options['filters'])) $this->filters = $options['filters'];
 119             if(!empty($options['title'])) $this->title = $options['title'];
 120             if(!empty($options['displayRows'])) $this->displayRows = $options['displayRows'];
 121             if(!empty($options['displayColumns'])) $this->displayColumns = $options['displayColumns'];
 122             if(isset($options['myItemsOnly'])) $this->myItemsOnly = $options['myItemsOnly'];
 123             if(isset($options['autoRefresh'])) $this->autoRefresh = $options['autoRefresh'];
 124         }
 125
 126         $this->layoutManager = new LayoutManager();
 127         $this->layoutManager->setAttribute('context', 'Report');
 128         // fake a reporter object here just to pass along the db type used in many widgets.
 129         // this should be taken out when sugarwidgets change
 130         $temp = (object) array('db' => &$GLOBALS['db'], 'report_def_str' => '');
 131         $this->layoutManager->setAttributePtr('reporter', $temp);
 132         $this->lvs = new ListViewSmarty();
 133     }
 134
 135     /**
 136      * Sets up the display options template
 137      *
 138      * @return string HTML that shows options
 139      */
 140     function processDisplayOptions() {
 141          require_once('include/templates/TemplateGroupChooser.php');
 142
 143         $this->configureSS = new Sugar_Smarty();
 144         // column chooser
 145         $chooser = new TemplateGroupChooser();
 146
 147         $chooser->args['id'] = 'edit_tabs';
 148         $chooser->args['left_size'] = 5;
 149         $chooser->args['right_size'] = 5;
 150         $chooser->args['values_array'][0] = array();
 151         $chooser->args['values_array'][1] = array();
 152
 153         $this->loadCustomMetadata();
 154         // Bug 39517 - Don't add custom fields automatically to the available fields to display in the listview
 155         //$this->addCustomFields();
 156         if($this->displayColumns) {
 157              // columns to display
 158              foreach($this->displayColumns as $num => $name) {
 159                     // defensive code for array being returned
 160                     $translated = translate($this->columns[$name]['label'], $this->seedBean->module_dir);
 161                     if(is_array($translated)) $translated = $this->columns[$name]['label'];
 162                     $chooser->args['values_array'][0][$name] = trim($translated, ':');
 163              }
 164              // columns not displayed
 165              foreach(array_diff(array_keys($this->columns), array_values($this->displayColumns)) as $num => $name) {
 166                     // defensive code for array being returned
 167                     $translated = translate($this->columns[$name]['label'], $this->seedBean->module_dir);
 168                     if(is_array($translated)) $translated = $this->columns[$name]['label'];
 169                     $chooser->args['values_array'][1][$name] = trim($translated, ':');
 170              }
 171         }
 172         else {
 173              foreach($this->columns as $name => $val) {
 174                 // defensive code for array being returned
 175                 $translated = translate($this->columns[$name]['label'], $this->seedBean->module_dir);
 176                 if(is_array($translated)) $translated = $this->columns[$name]['label'];
 177                 if(!empty($val['default']) && $val['default'])
 178                     $chooser->args['values_array'][0][$name] = trim($translated, ':');
 179                 else
 180                     $chooser->args['values_array'][1][$name] = trim($translated, ':');
 181             }
 182         }
 183
 184         $chooser->args['left_name'] = 'display_tabs';
 185         $chooser->args['right_name'] = 'hide_tabs';
 186         $chooser->args['max_left'] = '6';
 187
 188         $chooser->args['left_label'] =  $GLOBALS['app_strings']['LBL_DISPLAY_COLUMNS'];
 189         $chooser->args['right_label'] =  $GLOBALS['app_strings']['LBL_HIDE_COLUMNS'];
 190         $chooser->args['title'] =  '';
 191         $this->configureSS->assign('columnChooser', $chooser->display());
 192
 193         $query = false;
 194         $count = 0;
 195
 196         if(!is_array($this->filters)) {
 197             // use default search params
 198             $this->filters = array();
 199             foreach($this->searchFields as $name => $params) {
 200                 if(!empty($params['default']))
 201                     $this->filters[$name] = $params['default'];
 202             }
 203         }
 204         $currentSearchFields = array();
 205         foreach($this->searchFields as $name=>$params) {
 206             if(!empty($name)) {
 207                 $name = strtolower($name);
 208                 $currentSearchFields[$name] = array();
 209                 $widgetDef = $this->seedBean->field_defs[$name];
 210                 if($widgetDef['type'] == 'enum') $widgetDef['remove_blank'] = true; // remove the blank option for the dropdown
 211                 if($widgetDef['name'] == 'assigned_user_name') $widgetDef['name'] = 'assigned_user_id';
 212                 //bug 39170 - begin
 213                 if($widgetDef['name'] == 'created_by_name') $name = $widgetDef['name'] = 'created_by';
 214                 if($widgetDef['name'] == 'modified_by_name') $name = $widgetDef['name'] = 'modified_user_id';
 215                 //bug 39170 - end
 216                 $widgetDef['input_name0'] = empty($this->filters[$name]) ? '' : $this->filters[$name];
 217                 $currentSearchFields[$name]['label'] = !empty($params['label']) ? translate($params['label'], $this->seedBean->module_dir) : translate($widgetDef['vname'], $this->seedBean->module_dir);
 218                 $currentSearchFields[$name]['input'] = $this->layoutManager->widgetDisplayInput($widgetDef, true, (empty($this->filters[$name]) ? '' : $this->filters[$name]));
 219             }
 220             else { // ability to create spacers in input fields
 221                 $currentSearchFields['blank' + $count]['label'] = '';
 222                 $currentSearchFields['blank' + $count]['input'] = '';
 223                 $count++;
 224             }
 225         }
 226         $this->currentSearchFields = $currentSearchFields;
 227
 228         $this->configureSS->assign('strings', array('general' => $GLOBALS['mod_strings']['LBL_DASHLET_CONFIGURE_GENERAL'],
 229                                      'filters' => $GLOBALS['mod_strings']['LBL_DASHLET_CONFIGURE_FILTERS'],
 230                                      'myItems' => $GLOBALS['mod_strings']['LBL_DASHLET_CONFIGURE_MY_ITEMS_ONLY'],
 231                                      'displayRows' => $GLOBALS['mod_strings']['LBL_DASHLET_CONFIGURE_DISPLAY_ROWS'],
 232                                      'title' => $GLOBALS['mod_strings']['LBL_DASHLET_CONFIGURE_TITLE'],
 233                                      'save' => $GLOBALS['app_strings']['LBL_SAVE_BUTTON_LABEL'],
 234                                      'clear' => $GLOBALS['app_strings']['LBL_CLEAR_BUTTON_LABEL'],
 235                                      'autoRefresh' => $GLOBALS['app_strings']['LBL_DASHLET_CONFIGURE_AUTOREFRESH'],
 236                                      ));
 237         $this->configureSS->assign('id', $this->id);
 238         $this->configureSS->assign('showMyItemsOnly', $this->showMyItemsOnly);
 239         $this->configureSS->assign('myItemsOnly', $this->myItemsOnly);
 240         $this->configureSS->assign('searchFields', $this->currentSearchFields);
 241         $this->configureSS->assign('showClearButton', $this->isConfigPanelClearShown);
 242         // title
 243         $this->configureSS->assign('dashletTitle', $this->title);
 244
 245         // display rows
 246         $displayRowOptions = $GLOBALS['sugar_config']['dashlet_display_row_options'];
 247         $this->configureSS->assign('displayRowOptions', $displayRowOptions);
 248         $this->configureSS->assign('displayRowSelect', $this->displayRows);
 249
 250         if($this->isAutoRefreshable()) {
 251                 $this->configureSS->assign('isRefreshable', true);
 252                         $this->configureSS->assign('autoRefreshOptions', $this->getAutoRefreshOptions());
 253                         $this->configureSS->assign('autoRefreshSelect', $this->autoRefresh);
 254                 }
 255     }
 256     /**
 257      * Displays the options for this Dashlet
 258      *
 259      * @return string HTML that shows options
 260      */
 261     function displayOptions() {
 262         $this->processDisplayOptions();
 263         return parent::displayOptions() . $this->configureSS->fetch($this->configureTpl);
 264     }
 265
 266     function buildWhere() {
 267         global $current_user;
 268
 269         $returnArray = array();
 270
 271         if(!is_array($this->filters)) {
 272             // use defaults
 273             $this->filters = array();
 274             foreach($this->searchFields as $name => $params) {
 275                 if(!empty($params['default']))
 276                     $this->filters[$name] = $params['default'];
 277             }
 278         }
 279         foreach($this->filters as $name=>$params) {
 280             if(!empty($params)) {
 281                 if($name == 'assigned_user_id' && $this->myItemsOnly) continue; // don't handle assigned user filter if filtering my items only
 282                 $widgetDef = $this->seedBean->field_defs[$name];
 283
 284                 $widgetClass = $this->layoutManager->getClassFromWidgetDef($widgetDef, true);
 285                 $widgetDef['table'] = $this->seedBean->table_name;
 286                 $widgetDef['table_alias'] = $this->seedBean->table_name;
 287                                 if(!empty($widgetDef['source']) && $widgetDef['source'] == 'custom_fields'){
 288                     $widgetDef['table'] = $this->seedBean->table_name."_cstm";
 289                     $widgetDef['table_alias'] = $widgetDef['table'];
 290                 }
 291                 switch($widgetDef['type']) {// handle different types
 292                     case 'date':
 293                     case 'datetime':
 294                     case 'datetimecombo':
 295                         if(is_array($params) && !empty($params)) {
 296                             if(!empty($params['date']))
 297                                 $widgetDef['input_name0'] = $params['date'];
 298                             $filter = 'queryFilter' . $params['type'];
 299                         }
 300                         else {
 301                             $filter = 'queryFilter' . $params;
 302                         }
 303                         array_push($returnArray, $widgetClass->$filter($widgetDef, true));
 304                         break;
 305                     case 'assigned_user_name':
 306                         // This type runs through the SugarWidgetFieldname class, and needs a little extra help to make it through
 307                         if ( ! isset($widgetDef['column_key']) ) {
 308                             $widgetDef['column_key'] = $name;
 309                         }
 310                         // No break here, we want to run through the default handler
 311                     default:
 312                         $widgetDef['input_name0'] = $params;
 313                         if(is_array($params) && !empty($params)) { // handle array query
 314                             array_push($returnArray, $widgetClass->queryFilterone_of($widgetDef, false));
 315                         }
 316                         else {
 317                             array_push($returnArray, $widgetClass->queryFilterStarts_With($widgetDef, true));
 318                         }
 319                         $widgetDef['input_name0'] = $params;
 320                     break;
 321                 }
 322             }
 323         }
 324
 325         if($this->myItemsOnly) array_push($returnArray, $this->seedBean->table_name . '.' . "assigned_user_id = '" . $current_user->id . "'");
 326
 327         return $returnArray;
 328     }
 329
 330         protected function loadCustomMetadata()
 331         {
 332         $customMetadate = 'custom/modules/'.$this->seedBean->module_dir.'/metadata/dashletviewdefs.php';
 333         if ( file_exists ( $customMetadate )){
 334                 require($customMetadate);
 335                         $this->searchFields = $dashletData[$this->seedBean->module_dir.'Dashlet']['searchFields'];
 336                         foreach($this->searchFields  as $key =>$def){
 337                                 if($key == 'assigned_user_name'){
 338                                         $this->searchFields['assigned_user_id'] = $def;
 339                                         unset($this->searchFields['assigned_user_name'] );
 340                                         break;
 341                                 }
 342                         }
 343
 344                 $this->columns = $dashletData[$this->seedBean->module_dir.'Dashlet']['columns'];
 345         }
 346         }
 347
 348     /**
 349      * Does all dashlet processing, here's your chance to modify the rows being displayed!
 350      */
 351     function process($lvsParams = array()) {
 352         $currentSearchFields = array();
 353         $configureView = true; // configure view or regular view
 354         $query = false;
 355         $whereArray = array();
 356         $lvsParams['massupdate'] = false;
 357
 358                 $this->loadCustomMetadata();
 359         $this->addCustomFields();
 360         // apply filters
 361         if(isset($this->filters) || $this->myItemsOnly) {
 362             $whereArray = $this->buildWhere();
 363         }
 364
 365         $this->lvs->export = false;
 366         $this->lvs->multiSelect = false;
 367         // columns
 368         $displayColumns = array();
 369         if(!empty($this->displayColumns)) { // use user specified columns
 370                 foreach($this->displayColumns as $name => $val) {
 371                 $displayColumns[strtoupper($val)] = $this->columns[$val];
 372                 $displayColumns[strtoupper($val)]['label'] = trim($displayColumns[strtoupper($val)]['label'], ':');// strip : at the end of headers
 373             }
 374         }
 375         else if (isset($this->columns)){
 376            // use the default
 377             foreach($this->columns as $name => $val) {
 378                 if(!empty($val['default']) && $val['default']) {
 379                     $displayColumns[strtoupper($name)] = $val;
 380                     $displayColumns[strtoupper($name)]['label'] = trim($displayColumns[strtoupper($name)]['label'], ':');
 381                 }
 382             }
 383         }
 384         $this->lvs->displayColumns = $displayColumns;
 385
 386
 387         $this->lvs->lvd->setVariableName($this->seedBean->object_name, array());
 388         $lvdOrderBy = $this->lvs->lvd->getOrderBy(); // has this list been ordered, if not use default
 389
 390         $nameRelatedFields = array();
 391
 392         //bug: 44592 - dashlet sort order was not being preserved between logins
 393         if(!empty($lvsParams['orderBy']) && !empty($lvsParams['sortOrder']))
 394         {
 395             $lvsParams['overrideOrder'] = true;
 396         }
 397         else
 398         {
 399             if(empty($lvdOrderBy['orderBy'])) {
 400                 foreach($displayColumns as $colName => $colParams) {
 401                     if(!empty($colParams['defaultOrderColumn'])) {
 402                         $lvsParams['overrideOrder'] = true;
 403                         $lvsParams['orderBy'] = $colName;
 404                         $lvsParams['sortOrder'] = $colParams['defaultOrderColumn']['sortOrder'];
 405                     }
 406                 }
 407             }
 408         }
 409                 // Check for 'last_name' column sorting with related fields (last_name, first_name)
 410                 // See ListViewData.php for actual sorting change.
 411                 if ($lvdOrderBy['orderBy'] == 'last_name' && !empty($displayColumns['NAME']) && !empty($displayColumns['NAME']['related_fields']) &&
 412                         in_array('last_name', $displayColumns['NAME']['related_fields']) &&
 413                         in_array('first_name', $displayColumns['NAME']['related_fields'])) {
 414                                 $lvsParams['overrideLastNameOrder'] = true;
 415                 }
 416
 417         if(!empty($this->displayTpl))
 418         {
 419                 //MFH BUG #14296
 420             $where = '';
 421             if(!empty($whereArray)){
 422                 $where = '(' . implode(') AND (', $whereArray) . ')';
 423             }
 424             $this->lvs->setup($this->seedBean, $this->displayTpl, $where , $lvsParams, 0, $this->displayRows/*, $filterFields*/);
 425             if(in_array('CREATED_BY', array_keys($displayColumns))) { // handle the created by field
 426                 foreach($this->lvs->data['data'] as $row => $data) {
 427                     $this->lvs->data['data'][$row]['CREATED_BY'] = get_assigned_user_name($data['CREATED_BY']);
 428                 }
 429             }
 430             // assign a baseURL w/ the action set as DisplayDashlet
 431             foreach($this->lvs->data['pageData']['urls'] as $type => $url) {
 432                 // awu Replacing action=DisplayDashlet with action=DynamicAction&DynamicAction=DisplayDashlet
 433                 if($type == 'orderBy')
 434                     $this->lvs->data['pageData']['urls'][$type] = preg_replace('/(action=.*&)/Ui', 'action=DynamicAction&DynamicAction=displayDashlet&', $url);
 435                 else
 436                     $this->lvs->data['pageData']['urls'][$type] = preg_replace('/(action=.*&)/Ui', 'action=DynamicAction&DynamicAction=displayDashlet&', $url) . '&sugar_body_only=1&id=' . $this->id;
 437             }
 438
 439             $this->lvs->ss->assign('dashletId', $this->id);
 440         }
 441     }
 442
 443    /**
 444      * Displays the Dashlet, must call process() prior to calling this
 445      *
 446      * @return string HTML that displays Dashlet
 447      */
 448     function display() {
 449         return parent::display() . $this->lvs->display(false) . $this->processAutoRefresh();
 450     }
 451
 452     /**
 453      * Filter the $_REQUEST and only save only the needed options
 454      * @param array $req the array to pull options from
 455      *
 456      * @return array options array
 457      */
 458     function saveOptions($req) {
 459         $options = array();
 460
 461                 $this->loadCustomMetadata();
 462         foreach($req as $name => $value) {
 463             if(!is_array($value)) $req[$name] = trim($value);
 464         }
 465         $options['filters'] = array();
 466         foreach($this->searchFields as $name=>$params) {
 467             $widgetDef = $this->seedBean->field_defs[$name];
 468             //bug39170 - begin
 469             if($widgetDef['name']=='created_by_name' && $req['created_by']) $widgetDef['name'] = 'created_by';
 470             if($widgetDef['name']=='modified_by_name' && $req['modified_user_id']) $widgetDef['name'] = 'modified_user_id';
 471             //bug39170 - end
 472             if($widgetDef['type'] == 'datetimecombo' || $widgetDef['type'] == 'datetime' || $widgetDef['type'] == 'date') { // special case datetime types
 473                 $options['filters'][$widgetDef['name']] = array();
 474                 if(!empty($req['type_' . $widgetDef['name']])) { // save the type of date filter
 475                     $options['filters'][$widgetDef['name']]['type'] = $req['type_' . $widgetDef['name']];
 476                 }
 477                 if(!empty($req['date_' . $widgetDef['name']])) { // save the date
 478                     $options['filters'][$widgetDef['name']]['date'] = $req['date_' . $widgetDef['name']];
 479                 }
 480             }
 481             elseif(!empty($req[$widgetDef['name']])) {
 482                 $options['filters'][$widgetDef['name']] = $req[$widgetDef['name']];
 483             }
 484         }
 485         if(!empty($req['dashletTitle'])) {
 486             $options['title'] = $req['dashletTitle'];
 487         }
 488
 489         // Don't save the options for myItemsOnly if we're not even showing the options.
 490         if($this->showMyItemsOnly){
 491             if(!empty($req['myItemsOnly'])) {
 492                  $options['myItemsOnly'] = $req['myItemsOnly'];
 493             }
 494             else {
 495                 $options['myItemsOnly'] = false;
 496             }
 497         }
 498         $options['displayRows'] = empty($req['displayRows']) ? '5' : $req['displayRows'];
 499         // displayColumns
 500         if(!empty($req['displayColumnsDef'])) {
 501             $options['displayColumns'] = explode('|', $req['displayColumnsDef']);
 502         }
 503         $options['autoRefresh'] = empty($req['autoRefresh']) ? '0' : $req['autoRefresh'];
 504         return $options;
 505     }
 506
 507     /**
 508      * Internal function to add custom fields
 509      *
 510      */
 511     function addCustomFields() {
 512         foreach($this->seedBean->field_defs as $fieldName => $def) {
 513             if(!empty($def['type']) && $def['type'] == 'html')
 514                 continue;
 515             if(isset($def['vname'])) {
 516                 $translated = translate($def['vname'], $this->seedBean->module_dir);
 517                 if(is_array($translated)) $translated = $def['vname'];
 518                 if(!empty($def['source']) && $def['source'] == 'custom_fields') {
 519                         if(isset($this->columns[$fieldName]['default']) && $this->columns[$fieldName]['default']){
 520                                 $this->columns[$fieldName] = array('width' => '10',
 521                                                        'label' => $translated,
 522                                                        'default' => 1);
 523                         }else{
 524                     $this->columns[$fieldName] = array('width' => '10',
 525                                                        'label' => $translated);
 526                         }
 527
 528                 }
 529             }
 530         }
 531     }
 532 }
 533 ?>