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/Sugar_Smarty.php');
39 require_once('include/utils/layout_utils.php');
49 * Title of the Dashlet
52 var $title = 'Generic Dashlet';
54 * true if the Dashlet has configuration options.
57 var $isConfigurable = false;
59 * true if the Dashlet is refreshable (ie charts that provide their own refresh)
62 var $isRefreshable = true;
64 * true if the Dashlet configuration options panel has the clear button
67 public $isConfigPanelClearShown = true;
69 * true if the Dashlet contains javascript
72 var $hasScript = false;
74 * Language strings, must be loaded at the Dashlet level w/ loadLanguage
79 * Time period in minutes to refresh the dashlet (0 for never)
80 * Do not refresh if $isRefreshable is set to false
82 * To support auto refresh all refreshable dashlets that override process() must call processAutoRefresh()
85 var $autoRefresh = "0";
92 public function Dashlet($id)
98 * Returns the HTML for the configure icon
100 * @return string HTML
102 public function setConfigureIcon()
104 if($this->isConfigurable) {
105 $additionalTitle = '<td nowrap width="1%" style="padding-right: 0px;"><div class="dashletToolSet"><a href="javascript:void(0)" onclick="SUGAR.mySugar.configureDashlet(\''
106 . $this->id . '\'); return false;">'
107 . SugarThemeRegistry::current()->getImage('dashlet-header-edit','title="' . translate('LBL_DASHLET_EDIT', 'Home') . '" alt="' . translate('LBL_DASHLET_EDIT', 'Home') . '" border="0" align="absmiddle"').'</a>'
111 $additionalTitle = '<td nowrap width="1%" style="padding-right: 0px;"><div class="dashletToolSet">';
114 return $additionalTitle;
118 * Returns the HTML for the refresh icon
120 * @return string HTML
122 public function setRefreshIcon()
124 $additionalTitle = '';
125 if($this->isRefreshable) {
126 $additionalTitle .= '<a href="javascript:void(0)" onclick="SUGAR.mySugar.retrieveDashlet(\''
127 . $this->id . '\'); return false;">'
128 . SugarThemeRegistry::current()->getImage('dashlet-header-refresh','border="0" align="absmiddle" title="' . translate('LBL_DASHLET_REFRESH', 'Home') . '" alt="' . translate('LBL_DASHLET_REFRESH', 'Home') . '"')
132 return $additionalTitle;
136 * Returns the HTML for the delete icon
138 * @return string HTML
140 public function setDeleteIcon()
142 global $sugar_config;
144 if (!empty($sugar_config['lock_homepage']) && $sugar_config['lock_homepage'] == true) {
145 return '</div></td></tr></table>';
147 $additionalTitle = '<a href="javascript:void(0)" onclick="SUGAR.mySugar.deleteDashlet(\''
148 . $this->id . '\'); return false;">'
149 . SugarThemeRegistry::current()->getImage('dashlet-header-close','border="0" align="absmiddle" title="' . translate('LBL_DASHLET_DELETE', 'Home') . '" alt="' . translate('LBL_DASHLET_DELETE', 'Home') . '"')
150 . '</a></div></td></tr></table>';
151 return $additionalTitle;
155 * @deprecated No longer needed, replaced with Dashlet::getHeader() and Dashlet::getFooter()
157 * @param string $text
158 * @return string HTML
160 public function getTitle($text = '')
166 * Called when Dashlet is displayed
168 * @param string $text text after the title
169 * @return string Header html
171 public function getHeader($text = '')
173 global $sugar_config;
175 $title = '<table width="100%" cellspacing="0" cellpadding="0" border="0"><tr><td width="99%">' . $text . '</td>';
176 $title .= $this->setConfigureIcon();
177 $title .= $this->setRefreshIcon();
178 $title .= $this->setDeleteIcon();
181 if(empty($sugar_config['lock_homepage']) || $sugar_config['lock_homepage'] == false) $str .= 'onmouseover="this.style.cursor = \'move\';" ';
182 $str .= 'id="dashlet_header_' . $this->id . '" class="hd"><div class="tl"></div><div class="hd-center">' . get_form_header($this->title, $title, false) . '</div><div class="tr"></div></div><div class="bd"><div class="ml"></div><div class="bd-center">';
188 * Called when Dashlet is displayed
190 * @return string footer HTML
192 public function getFooter()
194 $footer = '</div><div class="mr"></div></div><div class="ft"><div class="bl"></div><div class="ft-center"></div><div class="br"></div></div>';
200 * Called when Dashlet is displayed, override this
202 * @param string $text text after the title
203 * @return string title HTML
205 public function display($text = '')
211 * Called when Dashlets configuration options are called
213 public function displayOptions()
218 * Override if you need to do pre-processing before display is called
220 public function process()
225 * Processes and displays the auto refresh code for the dashlet
227 * @param int $dashletOffset
228 * @return string HTML code
230 protected function processAutoRefresh($dashletOffset = 0)
232 global $sugar_config;
234 if ( empty($dashletOffset) ) {
236 $module = $_REQUEST['module'];
237 if(isset($_REQUEST[$module.'2_'.strtoupper($this->seedBean->object_name).'_offset'])) {
238 $dashletOffset = $_REQUEST[$module.'2_'.strtoupper($this->seedBean->object_name).'_offset'];
242 if ( !$this->isRefreshable ) {
245 if ( !empty($sugar_config['dashlet_auto_refresh_min']) && $sugar_config['dashlet_auto_refresh_min'] == -1 ) {
248 $autoRefreshSS = new Sugar_Smarty();
249 $autoRefreshSS->assign('dashletOffset', $dashletOffset);
250 $autoRefreshSS->assign('dashletId', $this->id);
251 $autoRefreshSS->assign('strippedDashletId', str_replace("-","",$this->id)); //javascript doesn't like "-" in function names
252 if ( empty($this->autoRefresh) ) {
253 $this->autoRefresh = 0;
255 elseif ( !empty($sugar_config['dashlet_auto_refresh_min']) ) {
256 $this->autoRefresh = min($sugar_config['dashlet_auto_refresh_min'],$this->autoRefresh);
258 $autoRefreshSS->assign('dashletRefreshInterval', $this->autoRefresh * 1000);
259 $tpl = 'include/Dashlets/DashletGenericAutoRefresh.tpl';
260 if ( $_REQUEST['action'] == "DynamicAction" ) {
261 $tpl = 'include/Dashlets/DashletGenericAutoRefreshDynamic.tpl';
264 return $autoRefreshSS->fetch($tpl);
268 * Override this if your dashlet is configurable (this is called when the the configureDashlet form is shown)
269 * Filters the array for only the parameters it needs to save
271 * @param array $req the array to pull options from
272 * @return array options array
274 public function saveOptions($req)
279 * Sets the language strings
281 * @param string $dashletClassname classname of the dashlet
282 * @param string $dashletDirectory directory path of the dashlet
284 public function loadLanguage($dashletClassname, $dashletDirectory = 'modules/Home/Dashlets/')
286 global $current_language, $dashletStrings;
288 if(!isset($dashletStrings[$dashletClassname])) {
289 // load current language strings for current language, else default to english
290 if(is_file($dashletDirectory . $dashletClassname . '/' . $dashletClassname . '.' . $current_language . '.lang.php')
291 || is_file('custom/' . $dashletDirectory . $dashletClassname . '/' . $dashletClassname . '.' . $current_language . '.lang.php') ) {
292 if(is_file($dashletDirectory . $dashletClassname . '/' . $dashletClassname . '.' . $current_language . '.lang.php')) {
293 require($dashletDirectory . $dashletClassname . '/' . $dashletClassname . '.' . $current_language . '.lang.php');
295 if(is_file('custom/' . $dashletDirectory . $dashletClassname . '/' . $dashletClassname . '.' . $current_language . '.lang.php')) {
296 require('custom/' . $dashletDirectory . $dashletClassname . '/' . $dashletClassname . '.' . $current_language . '.lang.php');
300 if(is_file($dashletDirectory . $dashletClassname . '/' . $dashletClassname . '.en_us.lang.php')) {
301 require($dashletDirectory . $dashletClassname . '/' . $dashletClassname . '.en_us.lang.php');
303 if(is_file('custom/' . $dashletDirectory . $dashletClassname . '/' . $dashletClassname . '.en_us.lang.php')) {
304 require('custom/' . $dashletDirectory . $dashletClassname . '/' . $dashletClassname . '.en_us.lang.php');
309 $this->dashletStrings = $dashletStrings[$dashletClassname];
313 * Generic way to store an options array into UserPreferences
315 * @param array $optionsArray the array to save
317 public function storeOptions($optionsArray)
319 global $current_user;
321 $dashletDefs = $current_user->getPreference('dashlets', 'Home'); // load user's dashlets config
322 $dashletDefs[$this->id]['options'] = $optionsArray;
323 $current_user->setPreference('dashlets', $dashletDefs, 0, 'Home');
327 * Generic way to retrieve options array from UserPreferences
329 * @return array options array stored in UserPreferences
331 public function loadOptions()
333 global $current_user;
335 $dashletDefs = $current_user->getPreference('dashlets', 'Home'); // load user's dashlets config
336 if(isset($dashletDefs[$this->id]['options']))
337 return $dashletDefs[$this->id]['options'];
343 * Override this in the subclass. It is used to determine whether the dashlet can be displayed.
345 * @return bool indicating whether or not the current user has access to display this Dashlet.
347 public function hasAccess()
353 * Returns the available auto refresh settings you can set a dashlet to
355 * @return array options available
357 protected function getAutoRefreshOptions()
359 $options = $GLOBALS['app_list_strings']['dashlet_auto_refresh_options'];
361 if ( isset($GLOBALS['sugar_config']['dashlet_auto_refresh_min']) ) {
362 foreach ( $options as $time => $desc ) {
363 if ( $time != -1 && $time < $GLOBALS['sugar_config']['dashlet_auto_refresh_min'] ) {
364 unset($options[$time]);
373 * Returns true if the dashlet is auto refreshable
377 protected function isAutoRefreshable()
379 return $this->isRefreshable &&
380 ( isset($GLOBALS['sugar_config']['dashlet_auto_refresh_min']) ?
381 $GLOBALS['sugar_config']['dashlet_auto_refresh_min'] != -1 : true );