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