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-2013 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 require_once('include/Dashlets/Dashlet.php');
39 require_once('include/ListView/ListViewSmarty.php');
40 require_once('include/generic/LayoutManager.php');
43 * Generic Dashlet class
46 class DashletGeneric extends Dashlet {
48 * Fields that are searchable
53 * Displayable columns (ones available to display)
58 * Bean file used in this Dashlet
63 * collection of filters to apply
68 * Number of Rows to display
71 var $displayRows = '5';
73 * Actual columns to display, will be a subset of $columns
76 var $displayColumns = null;
78 * Flag to display only the current users's items.
81 var $myItemsOnly = true;
83 * Flag to display "myItemsOnly" checkbox in the DashletGenericConfigure.
86 var $showMyItemsOnly = true;
88 * location of Smarty template file for display
91 var $displayTpl = 'include/Dashlets/DashletGenericDisplay.tpl';
93 * location of smarty template file for configuring
96 var $configureTpl = 'include/Dashlets/DashletGenericConfigure.tpl';
98 * smarty object for the generic configuration template
102 /** search inputs to be populated in configure template.
103 * modify this after processDisplayOptions, but before displayOptions to modify search inputs
106 var $currentSearchFields;
108 * ListView Smarty Class
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'];
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();
136 * Sets up the display options template
138 * @return string HTML that shows options
140 function processDisplayOptions() {
141 require_once('include/templates/TemplateGroupChooser.php');
143 $this->configureSS = new Sugar_Smarty();
145 $chooser = new TemplateGroupChooser();
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();
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, ':');
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, ':');
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, ':');
180 $chooser->args['values_array'][1][$name] = trim($translated, ':');
184 $chooser->args['left_name'] = 'display_tabs';
185 $chooser->args['right_name'] = 'hide_tabs';
186 $chooser->args['max_left'] = '6';
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());
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'];
204 $currentSearchFields = array();
205 foreach($this->searchFields as $name=>$params) {
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';
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';
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]));
220 else { // ability to create spacers in input fields
221 $currentSearchFields['blank' + $count]['label'] = '';
222 $currentSearchFields['blank' + $count]['input'] = '';
226 $this->currentSearchFields = $currentSearchFields;
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'],
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);
243 $this->configureSS->assign('dashletTitle', $this->title);
246 $displayRowOptions = $GLOBALS['sugar_config']['dashlet_display_row_options'];
247 $this->configureSS->assign('displayRowOptions', $displayRowOptions);
248 $this->configureSS->assign('displayRowSelect', $this->displayRows);
250 if($this->isAutoRefreshable()) {
251 $this->configureSS->assign('isRefreshable', true);
252 $this->configureSS->assign('autoRefreshOptions', $this->getAutoRefreshOptions());
253 $this->configureSS->assign('autoRefreshSelect', $this->autoRefresh);
257 * Displays the options for this Dashlet
259 * @return string HTML that shows options
261 function displayOptions() {
262 $this->processDisplayOptions();
263 return parent::displayOptions() . $this->configureSS->fetch($this->configureTpl);
266 function buildWhere() {
267 global $current_user;
269 $returnArray = array();
271 if(!is_array($this->filters)) {
273 $this->filters = array();
274 foreach($this->searchFields as $name => $params) {
275 if(!empty($params['default']))
276 $this->filters[$name] = $params['default'];
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];
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'];
291 switch($widgetDef['type']) {// handle different types
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'];
301 $filter = 'queryFilter' . $params;
303 array_push($returnArray, $widgetClass->$filter($widgetDef, true));
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;
310 // No break here, we want to run through the default handler
312 if (isset($widgetDef['link']) && $this->seedBean->load_relationship($widgetDef['link'])) {
313 $widgetDef['module'] = $this->seedBean->$widgetDef['link']->focus->module_name;
314 $widgetDef['link'] = $this->seedBean->$widgetDef['link']->getRelationshipObject()->name;
316 // No break - run through the default handler
318 $widgetDef['input_name0'] = $params;
319 if(is_array($params) && !empty($params)) { // handle array query
320 array_push($returnArray, $widgetClass->queryFilterone_of($widgetDef, false));
323 array_push($returnArray, $widgetClass->queryFilterStarts_With($widgetDef, true));
325 $widgetDef['input_name0'] = $params;
331 if($this->myItemsOnly) array_push($returnArray, $this->seedBean->table_name . '.' . "assigned_user_id = '" . $current_user->id . "'");
336 protected function loadCustomMetadata()
338 $customMetadate = 'custom/modules/'.$this->seedBean->module_dir.'/metadata/dashletviewdefs.php';
339 if ( file_exists ( $customMetadate )){
340 require($customMetadate);
341 $this->searchFields = $dashletData[$this->seedBean->module_dir.'Dashlet']['searchFields'];
342 foreach($this->searchFields as $key =>$def){
343 if($key == 'assigned_user_name'){
344 $this->searchFields['assigned_user_id'] = $def;
345 unset($this->searchFields['assigned_user_name'] );
350 $this->columns = $dashletData[$this->seedBean->module_dir.'Dashlet']['columns'];
355 * Does all dashlet processing, here's your chance to modify the rows being displayed!
357 function process($lvsParams = array()) {
358 $currentSearchFields = array();
359 $configureView = true; // configure view or regular view
361 $whereArray = array();
362 $lvsParams['massupdate'] = false;
364 $this->loadCustomMetadata();
365 $this->addCustomFields();
367 if(isset($this->filters) || $this->myItemsOnly) {
368 $whereArray = $this->buildWhere();
371 $this->lvs->export = false;
372 $this->lvs->multiSelect = false;
374 $displayColumns = array();
375 if(!empty($this->displayColumns)) { // use user specified columns
376 foreach($this->displayColumns as $name => $val) {
377 $displayColumns[strtoupper($val)] = $this->columns[$val];
378 $displayColumns[strtoupper($val)]['label'] = trim($displayColumns[strtoupper($val)]['label'], ':');// strip : at the end of headers
381 else if (isset($this->columns)){
383 foreach($this->columns as $name => $val) {
384 if(!empty($val['default']) && $val['default']) {
385 $displayColumns[strtoupper($name)] = $val;
386 $displayColumns[strtoupper($name)]['label'] = trim($displayColumns[strtoupper($name)]['label'], ':');
390 $this->lvs->displayColumns = $displayColumns;
393 $this->lvs->lvd->setVariableName($this->seedBean->object_name, array());
394 $lvdOrderBy = $this->lvs->lvd->getOrderBy(); // has this list been ordered, if not use default
396 $nameRelatedFields = array();
398 //bug: 44592 - dashlet sort order was not being preserved between logins
399 if(!empty($lvsParams['orderBy']) && !empty($lvsParams['sortOrder']))
401 $lvsParams['overrideOrder'] = true;
405 if(empty($lvdOrderBy['orderBy'])) {
406 foreach($displayColumns as $colName => $colParams) {
407 if(!empty($colParams['defaultOrderColumn'])) {
408 $lvsParams['overrideOrder'] = true;
409 $lvsParams['orderBy'] = $colName;
410 $lvsParams['sortOrder'] = $colParams['defaultOrderColumn']['sortOrder'];
415 // Check for 'last_name' column sorting with related fields (last_name, first_name)
416 // See ListViewData.php for actual sorting change.
417 if ($lvdOrderBy['orderBy'] == 'last_name' && !empty($displayColumns['NAME']) && !empty($displayColumns['NAME']['related_fields']) &&
418 in_array('last_name', $displayColumns['NAME']['related_fields']) &&
419 in_array('first_name', $displayColumns['NAME']['related_fields'])) {
420 $lvsParams['overrideLastNameOrder'] = true;
423 if(!empty($this->displayTpl))
427 if(!empty($whereArray)){
428 $where = '(' . implode(') AND (', $whereArray) . ')';
430 $this->lvs->setup($this->seedBean, $this->displayTpl, $where , $lvsParams, 0, $this->displayRows/*, $filterFields*/);
431 if(in_array('CREATED_BY', array_keys($displayColumns))) { // handle the created by field
432 foreach($this->lvs->data['data'] as $row => $data) {
433 $this->lvs->data['data'][$row]['CREATED_BY'] = get_assigned_user_name($data['CREATED_BY']);
436 // assign a baseURL w/ the action set as DisplayDashlet
437 foreach($this->lvs->data['pageData']['urls'] as $type => $url) {
438 // awu Replacing action=DisplayDashlet with action=DynamicAction&DynamicAction=DisplayDashlet
439 if($type == 'orderBy')
440 $this->lvs->data['pageData']['urls'][$type] = preg_replace('/(action=.*&)/Ui', 'action=DynamicAction&DynamicAction=displayDashlet&', $url);
442 $this->lvs->data['pageData']['urls'][$type] = preg_replace('/(action=.*&)/Ui', 'action=DynamicAction&DynamicAction=displayDashlet&', $url) . '&sugar_body_only=1&id=' . $this->id;
445 $this->lvs->ss->assign('dashletId', $this->id);
450 * Displays the Dashlet, must call process() prior to calling this
452 * @return string HTML that displays Dashlet
455 return parent::display() . $this->lvs->display(false) . $this->processAutoRefresh();
459 * Filter the $_REQUEST and only save only the needed options
460 * @param array $req the array to pull options from
462 * @return array options array
464 function saveOptions($req) {
467 $this->loadCustomMetadata();
468 foreach($req as $name => $value) {
469 if(!is_array($value)) $req[$name] = trim($value);
471 $options['filters'] = array();
472 foreach($this->searchFields as $name=>$params) {
473 $widgetDef = $this->seedBean->field_defs[$name];
475 if($widgetDef['name']=='created_by_name' && $req['created_by']) $widgetDef['name'] = 'created_by';
476 if($widgetDef['name']=='modified_by_name' && $req['modified_user_id']) $widgetDef['name'] = 'modified_user_id';
478 if($widgetDef['type'] == 'datetimecombo' || $widgetDef['type'] == 'datetime' || $widgetDef['type'] == 'date') { // special case datetime types
479 $options['filters'][$widgetDef['name']] = array();
480 if(!empty($req['type_' . $widgetDef['name']])) { // save the type of date filter
481 $options['filters'][$widgetDef['name']]['type'] = $req['type_' . $widgetDef['name']];
483 if(!empty($req['date_' . $widgetDef['name']])) { // save the date
484 $options['filters'][$widgetDef['name']]['date'] = $req['date_' . $widgetDef['name']];
487 elseif(!empty($req[$widgetDef['name']])) {
488 $options['filters'][$widgetDef['name']] = $req[$widgetDef['name']];
491 if(!empty($req['dashletTitle'])) {
492 $options['title'] = $req['dashletTitle'];
495 // Don't save the options for myItemsOnly if we're not even showing the options.
496 if($this->showMyItemsOnly){
497 if(!empty($req['myItemsOnly'])) {
498 $options['myItemsOnly'] = $req['myItemsOnly'];
501 $options['myItemsOnly'] = false;
504 $options['displayRows'] = empty($req['displayRows']) ? '5' : $req['displayRows'];
506 if(!empty($req['displayColumnsDef'])) {
507 $options['displayColumns'] = explode('|', $req['displayColumnsDef']);
509 $options['autoRefresh'] = empty($req['autoRefresh']) ? '0' : $req['autoRefresh'];
514 * Internal function to add custom fields
517 function addCustomFields() {
518 foreach($this->seedBean->field_defs as $fieldName => $def) {
519 if(!empty($def['type']) && $def['type'] == 'html')
521 if(isset($def['vname'])) {
522 $translated = translate($def['vname'], $this->seedBean->module_dir);
523 if(is_array($translated)) $translated = $def['vname'];
524 if(!empty($def['source']) && $def['source'] == 'custom_fields') {
525 if(isset($this->columns[$fieldName]['default']) && $this->columns[$fieldName]['default']){
526 $this->columns[$fieldName] = array('width' => '10',
527 'label' => $translated,
530 $this->columns[$fieldName] = array('width' => '10',
531 'label' => $translated);