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.
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');
42 class DashletGeneric extends Dashlet {
44 * Fields that are searchable
49 * Displayable columns (ones available to display)
54 * Bean file used in this Dashlet
59 * collection of filters to apply
64 * Number of Rows to display
67 var $displayRows = '5';
69 * Actual columns to display, will be a subset of $columns
72 var $displayColumns = null;
74 * Flag to display only the current users's items.
77 var $myItemsOnly = true;
79 * Flag to display "myItemsOnly" checkbox in the DashletGenericConfigure.
82 var $showMyItemsOnly = true;
84 * location of Smarty template file for display
87 var $displayTpl = 'include/Dashlets/DashletGenericDisplay.tpl';
89 * location of smarty template file for configuring
92 var $configureTpl = 'include/Dashlets/DashletGenericConfigure.tpl';
94 * smarty object for the generic configuration template
98 /** search inputs to be populated in configure template.
99 * modify this after processDisplayOptions, but before displayOptions to modify search inputs
102 var $currentSearchFields;
104 * ListView Smarty Class
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'];
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();
132 * Sets up the display options template
134 * @return string HTML that shows options
136 function processDisplayOptions() {
137 require_once('include/templates/TemplateGroupChooser.php');
139 $this->configureSS = new Sugar_Smarty();
141 $chooser = new TemplateGroupChooser();
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();
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, ':');
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, ':');
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, ':');
176 $chooser->args['values_array'][1][$name] = trim($translated, ':');
180 $chooser->args['left_name'] = 'display_tabs';
181 $chooser->args['right_name'] = 'hide_tabs';
182 $chooser->args['max_left'] = '6';
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());
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'];
200 foreach($this->searchFields as $name=>$params) {
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';
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';
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]));
215 else { // ability to create spacers in input fields
216 $currentSearchFields['blank' + $count]['label'] = '';
217 $currentSearchFields['blank' + $count]['input'] = '';
221 $this->currentSearchFields = $currentSearchFields;
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 'clear' => $GLOBALS['app_strings']['LBL_CLEAR_BUTTON_LABEL'],
230 'autoRefresh' => $GLOBALS['app_strings']['LBL_DASHLET_CONFIGURE_AUTOREFRESH'],
232 $this->configureSS->assign('id', $this->id);
233 $this->configureSS->assign('showMyItemsOnly', $this->showMyItemsOnly);
234 $this->configureSS->assign('myItemsOnly', $this->myItemsOnly);
235 $this->configureSS->assign('searchFields', $this->currentSearchFields);
236 $this->configureSS->assign('showClearButton', $this->isConfigPanelClearShown);
238 $this->configureSS->assign('dashletTitle', $this->title);
241 $displayRowOptions = $GLOBALS['sugar_config']['dashlet_display_row_options'];
242 $this->configureSS->assign('displayRowOptions', $displayRowOptions);
243 $this->configureSS->assign('displayRowSelect', $this->displayRows);
245 if($this->isAutoRefreshable()) {
246 $this->configureSS->assign('isRefreshable', true);
247 $this->configureSS->assign('autoRefreshOptions', $this->getAutoRefreshOptions());
248 $this->configureSS->assign('autoRefreshSelect', $this->autoRefresh);
252 * Displays the options for this Dashlet
254 * @return string HTML that shows options
256 function displayOptions() {
257 $this->processDisplayOptions();
258 return parent::displayOptions() . $this->configureSS->fetch($this->configureTpl);
261 function buildWhere() {
262 global $current_user;
264 $returnArray = array();
266 if(!is_array($this->filters)) {
268 $this->filters = array();
269 foreach($this->searchFields as $name => $params) {
270 if(!empty($params['default']))
271 $this->filters[$name] = $params['default'];
274 foreach($this->filters as $name=>$params) {
275 if(!empty($params)) {
276 if($name == 'assigned_user_id' && $this->myItemsOnly) continue; // don't handle assigned user filter if filtering my items only
277 $widgetDef = $this->seedBean->field_defs[$name];
279 $widgetClass = $this->layoutManager->getClassFromWidgetDef($widgetDef, true);
280 $widgetDef['table'] = $this->seedBean->table_name;
281 $widgetDef['table_alias'] = $this->seedBean->table_name;
282 if(!empty($widgetDef['source']) && $widgetDef['source'] == 'custom_fields'){
283 $widgetDef['table'] = $this->seedBean->table_name."_cstm";
284 $widgetDef['table_alias'] = $widgetDef['table'];
286 switch($widgetDef['type']) {// handle different types
289 case 'datetimecombo':
290 if(is_array($params) && !empty($params)) {
291 if(!empty($params['date']))
292 $widgetDef['input_name0'] = $params['date'];
293 $filter = 'queryFilter' . $params['type'];
296 $filter = 'queryFilter' . $params;
298 array_push($returnArray, $widgetClass->$filter($widgetDef, true));
300 case 'assigned_user_name':
301 // This type runs through the SugarWidgetFieldname class, and needs a little extra help to make it through
302 if ( ! isset($widgetDef['column_key']) ) {
303 $widgetDef['column_key'] = $name;
305 // No break here, we want to run through the default handler
307 $widgetDef['input_name0'] = $params;
308 if(is_array($params) && !empty($params)) { // handle array query
309 array_push($returnArray, $widgetClass->queryFilterone_of($widgetDef, false));
312 array_push($returnArray, $widgetClass->queryFilterStarts_With($widgetDef, true));
314 $widgetDef['input_name0'] = $params;
320 if($this->myItemsOnly) array_push($returnArray, $this->seedBean->table_name . '.' . "assigned_user_id = '" . $current_user->id . "'");
325 protected function loadCustomMetadata()
327 $customMetadate = 'custom/modules/'.$this->seedBean->module_dir.'/metadata/dashletviewdefs.php';
328 if ( file_exists ( $customMetadate )){
329 require($customMetadate);
330 $this->searchFields = $dashletData[$this->seedBean->module_dir.'Dashlet']['searchFields'];
331 foreach($this->searchFields as $key =>$def){
332 if($key == 'assigned_user_name'){
333 $this->searchFields['assigned_user_id'] = $def;
334 unset($this->searchFields['assigned_user_name'] );
339 $this->columns = $dashletData[$this->seedBean->module_dir.'Dashlet']['columns'];
344 * Does all dashlet processing, here's your chance to modify the rows being displayed!
346 function process($lvsParams = array()) {
347 $currentSearchFields = array();
348 $configureView = true; // configure view or regular view
350 $whereArray = array();
351 $lvsParams['massupdate'] = false;
353 $this->loadCustomMetadata();
354 $this->addCustomFields();
356 if(isset($this->filters) || $this->myItemsOnly) {
357 $whereArray = $this->buildWhere();
360 $this->lvs->export = false;
361 $this->lvs->multiSelect = false;
363 $displayColumns = array();
364 if(!empty($this->displayColumns)) { // use user specified columns
365 foreach($this->displayColumns as $name => $val) {
366 $displayColumns[strtoupper($val)] = $this->columns[$val];
367 $displayColumns[strtoupper($val)]['label'] = trim($displayColumns[strtoupper($val)]['label'], ':');// strip : at the end of headers
370 else if (isset($this->columns)){
372 foreach($this->columns as $name => $val) {
373 if(!empty($val['default']) && $val['default']) {
374 $displayColumns[strtoupper($name)] = $val;
375 $displayColumns[strtoupper($name)]['label'] = trim($displayColumns[strtoupper($name)]['label'], ':');
379 $this->lvs->displayColumns = $displayColumns;
382 $this->lvs->lvd->setVariableName($this->seedBean->object_name, array());
383 $lvdOrderBy = $this->lvs->lvd->getOrderBy(); // has this list been ordered, if not use default
385 $nameRelatedFields = array();
387 //bug: 44592 - dashlet sort order was not being preserved between logins
388 if(!empty($lvsParams['orderBy']) && !empty($lvsParams['sortOrder']))
390 $lvsParams['overrideOrder'] = true;
394 if(empty($lvdOrderBy['orderBy'])) {
395 foreach($displayColumns as $colName => $colParams) {
396 if(!empty($colParams['defaultOrderColumn'])) {
397 $lvsParams['overrideOrder'] = true;
398 $lvsParams['orderBy'] = $colName;
399 $lvsParams['sortOrder'] = $colParams['defaultOrderColumn']['sortOrder'];
404 // Check for 'last_name' column sorting with related fields (last_name, first_name)
405 // See ListViewData.php for actual sorting change.
406 if ($lvdOrderBy['orderBy'] == 'last_name' && !empty($displayColumns['NAME']) && !empty($displayColumns['NAME']['related_fields']) &&
407 in_array('last_name', $displayColumns['NAME']['related_fields']) &&
408 in_array('first_name', $displayColumns['NAME']['related_fields'])) {
409 $lvsParams['overrideLastNameOrder'] = true;
412 if(!empty($this->displayTpl))
416 if(!empty($whereArray)){
417 $where = '(' . implode(') AND (', $whereArray) . ')';
419 $this->lvs->setup($this->seedBean, $this->displayTpl, $where , $lvsParams, 0, $this->displayRows/*, $filterFields*/);
420 if(in_array('CREATED_BY', array_keys($displayColumns))) { // handle the created by field
421 foreach($this->lvs->data['data'] as $row => $data) {
422 $this->lvs->data['data'][$row]['CREATED_BY'] = get_assigned_user_name($data['CREATED_BY']);
425 // assign a baseURL w/ the action set as DisplayDashlet
426 foreach($this->lvs->data['pageData']['urls'] as $type => $url) {
427 // awu Replacing action=DisplayDashlet with action=DynamicAction&DynamicAction=DisplayDashlet
428 if($type == 'orderBy')
429 $this->lvs->data['pageData']['urls'][$type] = preg_replace('/(action=.*&)/Ui', 'action=DynamicAction&DynamicAction=displayDashlet&', $url);
431 $this->lvs->data['pageData']['urls'][$type] = preg_replace('/(action=.*&)/Ui', 'action=DynamicAction&DynamicAction=displayDashlet&', $url) . '&sugar_body_only=1&id=' . $this->id;
434 $this->lvs->ss->assign('dashletId', $this->id);
439 * Displays the Dashlet, must call process() prior to calling this
441 * @return string HTML that displays Dashlet
444 return parent::display() . $this->lvs->display(false) . $this->processAutoRefresh();
448 * Filter the $_REQUEST and only save only the needed options
449 * @param array $req the array to pull options from
451 * @return array options array
453 function saveOptions($req) {
456 $this->loadCustomMetadata();
457 foreach($req as $name => $value) {
458 if(!is_array($value)) $req[$name] = trim($value);
460 $options['filters'] = array();
461 foreach($this->searchFields as $name=>$params) {
462 $widgetDef = $this->seedBean->field_defs[$name];
464 if($widgetDef['name']=='created_by_name' && $req['created_by']) $widgetDef['name'] = 'created_by';
465 if($widgetDef['name']=='modified_by_name' && $req['modified_user_id']) $widgetDef['name'] = 'modified_user_id';
467 if($widgetDef['type'] == 'datetimecombo' || $widgetDef['type'] == 'datetime' || $widgetDef['type'] == 'date') { // special case datetime types
468 $options['filters'][$widgetDef['name']] = array();
469 if(!empty($req['type_' . $widgetDef['name']])) { // save the type of date filter
470 $options['filters'][$widgetDef['name']]['type'] = $req['type_' . $widgetDef['name']];
472 if(!empty($req['date_' . $widgetDef['name']])) { // save the date
473 $options['filters'][$widgetDef['name']]['date'] = $req['date_' . $widgetDef['name']];
476 elseif(!empty($req[$widgetDef['name']])) {
477 $options['filters'][$widgetDef['name']] = $req[$widgetDef['name']];
480 if(!empty($req['dashletTitle'])) {
481 $options['title'] = $req['dashletTitle'];
484 if(!empty($req['myItemsOnly'])) {
485 $options['myItemsOnly'] = $req['myItemsOnly'];
488 $options['myItemsOnly'] = false;
490 $options['displayRows'] = empty($req['displayRows']) ? '5' : $req['displayRows'];
492 if(!empty($req['displayColumnsDef'])) {
493 $options['displayColumns'] = explode('|', $req['displayColumnsDef']);
495 $options['autoRefresh'] = empty($req['autoRefresh']) ? '0' : $req['autoRefresh'];
500 * Internal function to add custom fields
503 function addCustomFields() {
504 foreach($this->seedBean->field_defs as $fieldName => $def) {
505 if(!empty($def['type']) && $def['type'] == 'html')
507 if(isset($def['vname'])) {
508 $translated = translate($def['vname'], $this->seedBean->module_dir);
509 if(is_array($translated)) $translated = $def['vname'];
510 if(!empty($def['source']) && $def['source'] == 'custom_fields') {
511 if(isset($this->columns[$fieldName]['default']) && $this->columns[$fieldName]['default']){
512 $this->columns[$fieldName] = array('width' => '10',
513 'label' => $translated,
516 $this->columns[$fieldName] = array('width' => '10',
517 'label' => $translated);