2 /*********************************************************************************
3 * SugarCRM is a customer relationship management program developed by
4 * SugarCRM, Inc. Copyright (C) 2004-2011 SugarCRM Inc.
6 * This program is free software; you can redistribute it and/or modify it under
7 * the terms of the GNU Affero General Public License version 3 as published by the
8 * Free Software Foundation with the addition of the following permission added
9 * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
10 * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
11 * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
13 * This program is distributed in the hope that it will be useful, but WITHOUT
14 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15 * FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
18 * You should have received a copy of the GNU Affero General Public License along with
19 * this program; if not, see http://www.gnu.org/licenses or write to the Free
20 * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
23 * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
24 * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
26 * The interactive user interfaces in modified source and object code versions
27 * of this program must display Appropriate Legal Notices, as required under
28 * Section 5 of the GNU Affero General Public License version 3.
30 * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
31 * these Appropriate Legal Notices must retain the display of the "Powered by
32 * SugarCRM" logo. If the display of the logo is not reasonably feasible for
33 * technical reasons, the Appropriate Legal Notices must display the words
34 * "Powered by SugarCRM".
35 ********************************************************************************/
40 * This array is meant to hold an objects/data that we would like to pass between
41 * the controller and the view. The bean will automatically be set for us, but this
42 * is meant to hold anything else.
44 var $view_object_map = array();
46 * The name of the current module.
50 * The name of the current action.
57 * Sugar_Smarty. This is useful if you have a view and a subview you can
58 * share the same smarty object.
62 * Any errors that occured this can either be set by the view or the controller or the model
64 var $errors = array();
66 * Options for what UI elements to hide/show/
68 var $options = array('show_header' => true, 'show_title' => true, 'show_subpanels' => false, 'show_search' => true, 'show_footer' => true, 'show_javascript' => true, 'view_print' => false,);
74 * Constructor which will peform the setup.
76 public function SugarView(
78 $view_object_map = array()
85 $view_object_map = array()
89 $this->view_object_map = $view_object_map;
90 $this->action = $GLOBALS['action'];
91 $this->module = $GLOBALS['module'];
95 protected function _initSmarty()
97 $this->ss = new Sugar_Smarty();
98 $this->ss->assign('MOD', $GLOBALS['mod_strings']);
99 $this->ss->assign('APP', $GLOBALS['app_strings']);
103 * This method will be called from the controller and is not meant to be overridden.
105 public function process()
107 LogicHook::initialize();
108 $this->_checkModule();
110 //trackView has to be here in order to track for breadcrumbs
113 if ($this->_getOption('show_header')) {
114 $this->displayHeader();
116 $this->renderJavascript();
119 $this->_buildModuleList();
121 $this->displayErrors();
123 $GLOBALS['logic_hook']->call_custom_logic('', 'after_ui_frame');
124 if ($this->_getOption('show_subpanels')) $this->_displaySubPanels();
125 if ($this->action === 'Login') {
126 //this is needed for a faster loading login page ie won't render unless the tables are closed
129 if ($this->_getOption('show_footer')) $this->displayFooter();
130 $GLOBALS['logic_hook']->call_custom_logic('', 'after_ui_footer');
131 //Do not track if there is no module or if module is not a String
136 * This method will display the errors on the page.
138 public function displayErrors()
140 foreach($this->errors as $error) {
141 echo '<span class="error">' . $error . '</span><br>';
146 * [OVERRIDE] - This method is meant to overidden in a subclass. The purpose of this method is
147 * to allow a view to do some preprocessing before the display method is called. This becomes
148 * useful when you have a view defined at the application level and then within a module
149 * have a sub-view that extends from this application level view. The application level
150 * view can do the setup in preDisplay() that is common to itself and any subviews
151 * and then the subview can just override display(). If it so desires, can also override
154 public function preDisplay()
159 * [OVERRIDE] - This method is meant to overidden in a subclass. This method
160 * will handle the actual display logic of the view.
162 public function display()
170 protected function _trackView()
172 $action = strtolower($this->action);
173 //Skip save, tracked in SugarBean instead
174 if($action == 'save') {
179 $trackerManager = TrackerManager::getInstance();
180 $timeStamp = gmdate($GLOBALS['timedate']->get_db_date_time_format());
181 if($monitor = $trackerManager->getMonitor('tracker')){
182 $monitor->setValue('action', $action);
183 $monitor->setValue('user_id', $GLOBALS['current_user']->id);
184 $monitor->setValue('module_name', $this->module);
185 $monitor->setValue('date_modified', $timeStamp);
186 $monitor->setValue('visible', (($monitor->action == 'detailview') || ($monitor->action == 'editview')
189 if (!empty($this->bean->id)) {
190 $monitor->setValue('item_id', $this->bean->id);
191 $monitor->setValue('item_summary', $this->bean->get_summary_text());
194 //If visible is true, but there is no bean, do not track (invalid/unauthorized reference)
195 //Also, do not track save actions where there is no bean id
196 if($monitor->visible && empty($this->bean->id)) {
197 $trackerManager->unsetMonitor($monitor);
200 $trackerManager->saveMonitor($monitor, true, true);
206 * Displays the header on section of the page; basically everything before the content
208 public function displayHeader()
213 global $current_user;
214 global $sugar_config;
215 global $app_list_strings;
217 global $current_language;
219 $GLOBALS['app']->headerDisplayed = true;
221 $themeObject = SugarThemeRegistry::current();
222 $theme = $themeObject->__toString();
224 $ss = new Sugar_Smarty();
225 $ss->assign("APP", $app_strings);
226 $ss->assign("THEME", $theme);
227 $ss->assign("THEME_IE6COMPAT", $themeObject->ie6compat ? 'true':'false');
228 $ss->assign("MODULE_NAME", $this->module);
231 $ss->assign("SYSTEM_NAME", $this->getBrowserTitle());
234 $css = $themeObject->getCSS();
235 if ($this->_getOption('view_print')) {
236 $css .= '<link rel="stylesheet" type="text/css" href="'.$themeObject->getCSSURL('print.css').'" media="all" />';
238 $ss->assign("SUGAR_CSS",$css);
242 $this->renderJavascript();
244 $ss->assign("SUGAR_JS",ob_get_contents().$themeObject->getJS());
248 if(isset($GLOBALS['sugar_config']['default_module_favicon']))
249 $module_favicon = $GLOBALS['sugar_config']['default_module_favicon'];
251 $module_favicon = false;
254 if ( $module_favicon )
255 $favicon = $themeObject->getImageURL($this->module.'.gif',false);
256 if ( !sugar_is_file($favicon) || !$module_favicon )
257 $favicon = $themeObject->getImageURL('sugar_icon.ico',false);
258 $ss->assign('FAVICON_URL',getJSPath($favicon));
260 // build the shortcut menu
261 $shortcut_menu = array();
262 foreach ( $this->getMenu() as $key => $menu_item )
263 $shortcut_menu[$key] = array(
264 "URL" => $menu_item[0],
265 "LABEL" => $menu_item[1],
266 "MODULE_NAME" => $menu_item[2],
267 "IMAGE" => $themeObject
268 ->getImage($menu_item[2],"alt='".$menu_item[1]."' border='0' align='absmiddle'"),
270 $ss->assign("SHORTCUT_MENU",$shortcut_menu);
272 // handle rtl text direction
273 if(isset($_REQUEST['RTL']) && $_REQUEST['RTL'] == 'RTL'){
274 $_SESSION['RTL'] = true;
276 if(isset($_REQUEST['LTR']) && $_REQUEST['LTR'] == 'LTR'){
277 unset($_SESSION['RTL']);
279 if(isset($_SESSION['RTL']) && $_SESSION['RTL']){
280 $ss->assign("DIR", 'dir="RTL"');
283 // handle resizing of the company logo correctly on the fly
284 $companyLogoURL = $themeObject->getImageURL('company_logo.png');
285 $companyLogoURL_arr = explode('?', $companyLogoURL);
286 $companyLogoURL = $companyLogoURL_arr[0];
288 $company_logo_attributes = sugar_cache_retrieve('company_logo_attributes');
289 if(!empty($company_logo_attributes)) {
290 $ss->assign("COMPANY_LOGO_MD5", $company_logo_attributes[0]);
291 $ss->assign("COMPANY_LOGO_WIDTH", $company_logo_attributes[1]);
292 $ss->assign("COMPANY_LOGO_HEIGHT", $company_logo_attributes[2]);
295 // Always need to md5 the file
296 $ss->assign("COMPANY_LOGO_MD5", md5_file($companyLogoURL));
298 list($width,$height) = getimagesize($companyLogoURL);
299 if ( $width > 212 || $height > 40 ) {
300 $resizePctWidth = ($width - 212)/212;
301 $resizePctHeight = ($height - 40)/40;
302 if ( $resizePctWidth > $resizePctHeight )
303 $resizeAmount = $width / 212;
305 $resizeAmount = $height / 40;
306 $ss->assign("COMPANY_LOGO_WIDTH", round($width * (1/$resizeAmount)));
307 $ss->assign("COMPANY_LOGO_HEIGHT", round($height * (1/$resizeAmount)));
310 $ss->assign("COMPANY_LOGO_WIDTH", $width);
311 $ss->assign("COMPANY_LOGO_HEIGHT", $height);
314 // Let's cache the results
315 sugar_cache_put('company_logo_attributes',
317 $ss->get_template_vars("COMPANY_LOGO_MD5"),
318 $ss->get_template_vars("COMPANY_LOGO_WIDTH"),
319 $ss->get_template_vars("COMPANY_LOGO_HEIGHT")
323 $ss->assign("COMPANY_LOGO_URL",getJSPath($companyLogoURL)."&logo_md5=".$ss->get_template_vars("COMPANY_LOGO_MD5"));
325 // get the global links
327 $global_control_links = array();
328 require("include/globalControlLinks.php");
330 foreach($global_control_links as $key => $value) {
331 if ($key == 'users') { //represents logout link.
332 $ss->assign("LOGOUT_LINK", $value['linkinfo'][key($value['linkinfo'])]);
333 $ss->assign("LOGOUT_LABEL", key($value['linkinfo']));//key value for first element.
337 foreach ($value as $linkattribute => $attributevalue) {
338 // get the main link info
339 if ( $linkattribute == 'linkinfo' ) {
341 "LABEL" => key($attributevalue),
342 "URL" => current($attributevalue),
343 "SUBMENU" => array(),
345 if(substr($gcls[$key]["URL"], 0, 11) == "javascript:") {
346 $gcls[$key]["ONCLICK"] = substr($gcls[$key]["URL"],11);
347 $gcls[$key]["URL"] = "#";
350 // and now the sublinks
351 if ( $linkattribute == 'submenu' && is_array($attributevalue) ) {
352 foreach ($attributevalue as $submenulinkkey => $submenulinkinfo)
353 $gcls[$key]['SUBMENU'][$submenulinkkey] = array(
354 "LABEL" => key($submenulinkinfo),
355 "URL" => current($submenulinkinfo),
357 if(substr($gcls[$key]['SUBMENU'][$submenulinkkey]["URL"], 0, 11) == "javascript:") {
358 $gcls[$key]['SUBMENU'][$submenulinkkey]["ONCLICK"] = substr($gcls[$key]['SUBMENU'][$submenulinkkey]["URL"],11);
359 $gcls[$key]['SUBMENU'][$submenulinkkey]["URL"] = "#";
364 $ss->assign("GCLS",$gcls);
366 $ss->assign("SEARCH", isset($_REQUEST['query_string']) ? $_REQUEST['query_string'] : '');
368 if ($this->action == "EditView" || $this->action == "Login")
369 $ss->assign("ONLOAD", 'onload="set_focus()"');
371 $ss->assign("AUTHENTICATED",isset($_SESSION["authenticated_user_id"]));
373 // get other things needed for page style popup
374 if (isset($_SESSION["authenticated_user_id"])) {
375 // get the current user name and id
376 $ss->assign("CURRENT_USER", $current_user->full_name == '' || !showFullName()
377 ? $current_user->user_name : $current_user->full_name );
378 $ss->assign("CURRENT_USER_ID", $current_user->id);
380 // get the last viewed records
381 $tracker = new Tracker();
382 $history = $tracker->get_recently_viewed($current_user->id);
383 foreach ( $history as $key => $row ) {
384 $history[$key]['item_summary_short'] = getTrackerSubstring($row['item_summary']);
385 $history[$key]['image'] = SugarThemeRegistry::current()
386 ->getImage($row['module_name'],'border="0" align="absmiddle" alt="'.$row['item_summary'].'"');
388 $ss->assign("recentRecords",$history);
391 $bakModStrings = $mod_strings;
392 if (isset($_SESSION["authenticated_user_id"]) ) {
393 // get the module list
394 $moduleTopMenu = array();
396 $max_tabs = $current_user->getPreference('max_tabs');
397 // Attempt to correct if max tabs count is waaay too high.
398 if ( !isset($max_tabs) || $max_tabs <= 0 || $max_tabs > 10 ) {
399 $max_tabs = $GLOBALS['sugar_config']['default_max_tabs'];
400 $current_user->setPreference('max_tabs', $max_tabs, 0, 'global');
403 $moduleTab = $this->_getModuleTab();
404 $ss->assign('MODULE_TAB',$moduleTab);
407 // See if they are using grouped tabs or not (removed in 6.0, returned in 6.1)
408 $user_navigation_paradigm = $current_user->getPreference('navigation_paradigm');
409 if ( !isset($user_navigation_paradigm) ) {
410 $user_navigation_paradigm = $GLOBALS['sugar_config']['default_navigation_paradigm'];
414 // Get the full module list for later use
415 foreach ( query_module_access_list($current_user) as $module ) {
416 // Bug 25948 - Check for the module being in the moduleList
417 if ( isset($app_list_strings['moduleList'][$module]) ) {
418 $fullModuleList[$module] = $app_list_strings['moduleList'][$module];
423 if(!should_hide_iframes()) {
424 $iFrame = new iFrame();
425 $frames = $iFrame->lookup_frames('tab');
426 foreach($frames as $key => $values){
427 $fullModuleList[$key] = $values;
430 elseif (isset($fullModuleList['iFrames'])) {
431 unset($fullModuleList['iFrames']);
434 if ( $user_navigation_paradigm == 'gm' && isset($themeObject->group_tabs) && $themeObject->group_tabs) {
435 // We are using grouped tabs
436 require_once('include/GroupedTabs/GroupedTabStructure.php');
437 $groupedTabsClass = new GroupedTabStructure();
438 $modules = query_module_access_list($current_user);
439 //handle with submoremodules
440 $max_tabs = $current_user->getPreference('max_tabs');
441 // If the max_tabs isn't set incorrectly, set it within the range, to the default max sub tabs size
442 if ( !isset($max_tabs) || $max_tabs <= 0 || $max_tabs > 10){
443 // We have a default value. Use it
444 if(isset($GLOBALS['sugar_config']['default_max_subtabs'])){
445 // As of 6.1, we shouldn't have a max subtabs higher than 10.
446 // If it's larger, bring it down to the max and save it in the config override
447 if($GLOBALS['sugar_config']['default_max_subtabs'] > 10){
448 require_once('modules/Configurator/Configurator.php');
449 $configurator = new Configurator();
450 $configurator->config['default_max_subtabs'] = '10';
451 $configurator->handleOverride();
452 $configurator->clearCache();
454 $max_tabs = $GLOBALS['sugar_config']['default_max_subtabs'];
461 $subMoreModules = false;
462 $groupTabs = $groupedTabsClass->get_tab_structure(get_val_array($modules));
463 // We need to put this here, so the "All" group is valid for the user's preference.
464 $groupTabs[$app_strings['LBL_TABGROUP_ALL']]['modules'] = $fullModuleList;
467 // Setup the default group tab.
468 $allGroup = $app_strings['LBL_TABGROUP_ALL'];
469 $ss->assign('currentGroupTab',$allGroup);
470 $currentGroupTab = $allGroup;
471 $usersGroup = $current_user->getPreference('theme_current_group');
472 // Figure out which tab they currently have selected (stored as a user preference)
473 if ( !empty($usersGroup) && isset($groupTabs[$usersGroup]) ) {
474 $currentGroupTab = $usersGroup;
476 $current_user->setPreference('theme_current_group',$currentGroupTab);
479 $ss->assign('currentGroupTab',$currentGroupTab);
480 $usingGroupTabs = true;
483 // Setup the default group tab.
484 $ss->assign('currentGroupTab',$app_strings['LBL_TABGROUP_ALL']);
486 $usingGroupTabs = false;
488 $groupTabs[$app_strings['LBL_TABGROUP_ALL']]['modules'] = $fullModuleList;
493 $topTabList = array();
495 // Now time to go through each of the tab sets and fix them up.
496 foreach ( $groupTabs as $tabIdx => $tabData ) {
497 $topTabs = $tabData['modules'];
498 if ( ! is_array($topTabs) ) {
501 $extraTabs = array();
503 // Split it in to the tabs that go across the top, and the ones that are on the extra menu.
504 if ( count($topTabs) > $max_tabs ) {
505 $extraTabs = array_splice($topTabs,$max_tabs);
507 // Make sure the current module is accessable through one of the top tabs
508 if ( !isset($topTabs[$moduleTab]) ) {
509 // Nope, we need to add it.
510 // First, take it out of the extra menu, if it's there
511 if ( isset($extraTabs[$moduleTab]) ) {
512 unset($extraTabs[$moduleTab]);
514 if ( count($topTabs) >= $max_tabs - 1 ) {
515 // We already have the maximum number of tabs, so we need to shuffle the last one
516 // from the top to the first one of the extras
517 $lastElem = array_splice($topTabs,$max_tabs-1);
518 $extraTabs = $lastElem + $extraTabs;
520 $topTabs[$moduleTab] = $app_list_strings['moduleList'][$moduleTab];
525 // This was removed, but I like the idea, so I left the code in here in case we decide to turn it back on
526 // If we are using group tabs, add all the "hidden" tabs to the end of the extra menu
527 if ( $usingGroupTabs ) {
528 foreach($fullModuleList as $moduleKey => $module ) {
529 if ( !isset($topTabs[$moduleKey]) && !isset($extraTabs[$moduleKey]) ) {
530 $extraTabs[$moduleKey] = $module;
536 // Get a unique list of the top tabs so we can build the popup menus for them
537 foreach ( $topTabs as $moduleKey => $module ) {
538 $topTabList[$moduleKey] = $module;
541 $groupTabs[$tabIdx]['modules'] = $topTabs;
542 $groupTabs[$tabIdx]['extra'] = $extraTabs;
546 if ( isset($topTabList) && is_array($topTabList) ) {
547 // Adding shortcuts array to menu array for displaying shortcuts associated with each module
548 $shortcutTopMenu = array();
549 foreach($topTabList as $module_key => $label) {
551 $mod_strings = return_module_language($current_language, $module_key);
552 foreach ( $this->getMenu($module_key) as $key => $menu_item ) {
553 $shortcutTopMenu[$module_key][$key] = array(
554 "URL" => $menu_item[0],
555 "LABEL" => $menu_item[1],
556 "MODULE_NAME" => $menu_item[2],
557 "IMAGE" => $themeObject
558 ->getImage($menu_item[2],"alt='".$menu_item[1]."' border='0' align='absmiddle'"),
562 $ss->assign("groupTabs",$groupTabs);
563 $ss->assign("shortcutTopMenu",$shortcutTopMenu);
564 $ss->assign('USE_GROUP_TABS',$usingGroupTabs);
566 // This is here for backwards compatibility, someday, somewhere, it will be able to be removed
567 $ss->assign("moduleTopMenu",$groupTabs[$app_strings['LBL_TABGROUP_ALL']]['modules']);
568 $ss->assign("moduleExtraMenu",$groupTabs[$app_strings['LBL_TABGROUP_ALL']]['extra']);
573 $mod_strings = $bakModStrings;
574 $headerTpl = $themeObject->getTemplate('header.tpl');
575 if ( isset($GLOBALS['sugar_config']['developerMode']) && $GLOBALS['sugar_config']['developerMode'] )
576 $ss->clear_compiled_tpl($headerTpl);
577 $ss->display($headerTpl);
579 $this->includeClassicFile('modules/Administration/DisplayWarnings.php');
582 * If the view is classic then this method will include the file and
583 * setup any global variables.
585 * @param string $file
587 public function includeClassicFile(
591 global $sugar_config, $theme, $current_user, $sugar_version, $sugar_flavor, $mod_strings, $app_strings, $app_list_strings, $action, $timezones;
592 global $gridline, $request_string, $modListHeader, $dashletData, $authController, $locale, $currentModule, $import_bean_map, $image_path, $license;
593 global $user_unique_key, $server_unique_key, $barChartColors, $modules_exempt_from_availability_check, $dictionary, $current_language, $beanList, $beanFiles, $sugar_build, $sugar_codename;
594 global $timedate, $login_error; // cn: bug 13855 - timedate not available to classic views.
595 $currentModule = $this->module;
596 require_once ($file);
599 protected function _displayLoginJS()
601 global $sugar_config;
603 if(isset($this->bean->module_dir)){
604 echo "<script>var module_sugar_grp1 = '{$this->bean->module_dir}';</script>";
606 if(isset($_REQUEST['action'])){
607 echo "<script>var action_sugar_grp1 = '{$_REQUEST['action']}';</script>";
609 echo '<script>jscal_today = ' . (1000*strtotime($GLOBALS['timedate']->handle_offset(gmdate($GLOBALS['timedate']->get_db_date_time_format()), $GLOBALS['timedate']->get_db_date_time_format()))) . '; if(typeof app_strings == "undefined") app_strings = new Array();</script>';
610 if (!is_file("include/javascript/sugar_grp1.js")) {
611 $_REQUEST['root_directory'] = ".";
612 require_once("jssource/minify_utils.php");
613 ConcatenateFiles(".");
615 echo '<script type="text/javascript" src="' . getJSPath('include/javascript/sugar_grp1_yui.js') . '"></script>';
616 echo '<script type="text/javascript" src="' . getJSPath('include/javascript/sugar_grp1.js') . '"></script>';
617 echo '<script type="text/javascript" src="' . getJSPath('jscalendar/lang/calendar-' . substr($GLOBALS['current_language'], 0, 2) . '.js') . '"></script>';
620 if ( typeof(SUGAR) == 'undefined' ) {SUGAR = {}};
621 if ( typeof(SUGAR.themes) == 'undefined' ) SUGAR.themes = {};
624 if(isset( $sugar_config['disc_client']) && $sugar_config['disc_client'])
625 echo '<script type="text/javascript" src="' . getJSPath('modules/Sync/headersync.js') . '"></script>';
629 * Called from process(). This method will display the correct javascript.
631 protected function _displayJavascript()
633 global $locale, $sugar_config;
636 if ($this->_getOption('show_javascript')) {
637 if (!$this->_getOption('show_header'))
639 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
644 echo "<script>var sugar_cache_dir = '{$GLOBALS['sugar_config']['cache_dir']}';</script>";
645 echo "<script>var sugar_upload_dir = '{$GLOBALS['sugar_config']['upload_dir']}';</script>";
647 if(isset($this->bean->module_dir)){
648 echo "<script>var module_sugar_grp1 = '{$this->bean->module_dir}';</script>";
650 if(isset($_REQUEST['action'])){
651 echo "<script>var action_sugar_grp1 = '{$_REQUEST['action']}';</script>";
653 echo '<script>jscal_today = ' . (1000*strtotime($GLOBALS['timedate']->handle_offset(gmdate($GLOBALS['timedate']->get_db_date_time_format()), $GLOBALS['timedate']->get_db_date_time_format()))) . '; if(typeof app_strings == "undefined") app_strings = new Array();</script>';
654 if (!is_file("include/javascript/sugar_grp1.js") || !is_file("include/javascript/sugar_grp1_yui.js")) {
655 $_REQUEST['root_directory'] = ".";
656 require_once("jssource/minify_utils.php");
657 ConcatenateFiles(".");
659 echo '<script type="text/javascript" src="' . getJSPath('include/javascript/sugar_grp1_yui.js') . '"></script>';
660 echo '<script type="text/javascript" src="' . getJSPath('include/javascript/sugar_grp1.js') . '"></script>';
661 echo '<script type="text/javascript" src="' . getJSPath('jscalendar/lang/calendar-' . substr($GLOBALS['current_language'], 0, 2) . '.js') . '"></script>';
663 if ( isset($sugar_config['quicksearch_querydelay']) ) {
664 echo "<script>SUGAR.config.quicksearch_querydelay = {$GLOBALS['sugar_config']['quicksearch_querydelay']};</script>";
666 // cn: bug 12274 - prepare secret guid for asynchronous calls
667 if (!isset($_SESSION['asynchronous_key']) || empty($_SESSION['asynchronous_key'])) {
668 $_SESSION['asynchronous_key'] = create_guid();
670 $image_server = (defined('TEMPLATE_URL'))?TEMPLATE_URL . '/':'';
671 echo '<script type="text/javascript">var asynchronous_key = "' . $_SESSION['asynchronous_key'] . '";SUGAR.themes.image_server="' . $image_server . '";</script>'; // cn: bug 12274 - create session-stored key to defend against CSRF
672 echo '<script type="text/javascript"> var name_format = "' . $locale->getLocaleFormatMacro() . '";</script>';
673 echo $GLOBALS['timedate']->get_javascript_validation();
674 if (!is_file($GLOBALS['sugar_config']['cache_dir'] . 'jsLanguage/' . $GLOBALS['current_language'] . '.js')) {
675 require_once ('include/language/jsLanguage.php');
676 jsLanguage::createAppStringsCache($GLOBALS['current_language']);
678 echo '<script type="text/javascript" src="' . $GLOBALS['sugar_config']['cache_dir'] . 'jsLanguage/' . $GLOBALS['current_language'] . '.js?s=' . $GLOBALS['js_version_key'] . '&c=' . $GLOBALS['sugar_config']['js_custom_version'] . '&j=' . $GLOBALS['sugar_config']['js_lang_version'] . '"></script>';
679 if (!is_file($GLOBALS['sugar_config']['cache_dir'] . 'jsLanguage/' . $this->module . '/' . $GLOBALS['current_language'] . '.js')) {
680 require_once ('include/language/jsLanguage.php');
681 jsLanguage::createModuleStringsCache($this->module, $GLOBALS['current_language']);
683 echo '<script type="text/javascript" src="' . $GLOBALS['sugar_config']['cache_dir'] . 'jsLanguage/' . $this->module . '/' . $GLOBALS['current_language'] . '.js?s=' . $GLOBALS['js_version_key'] . '&c=' . $GLOBALS['sugar_config']['js_custom_version'] . '&j=' . $GLOBALS['sugar_config']['js_lang_version'] . '"></script>';
684 if(isset( $sugar_config['disc_client']) && $sugar_config['disc_client'])
685 echo '<script type="text/javascript" src="' . getJSPath('modules/Sync/headersync.js') . '"></script>';
686 echo '<script src="' . getJSPath('include/javascript/yui3/build/yui/yui-min.js') . '" type="text/javascript"></script>';
689 if (isset($_REQUEST['popup']) && !empty($_REQUEST['popup'])) {
690 // cn: bug 12274 - add security metadata envelope for async calls in popups
691 echo '<script type="text/javascript">var asynchronous_key = "' . $_SESSION['asynchronous_key'] . '";</script>'; // cn: bug 12274 - create session-stored key to defend against CSRF
696 * Called from process(). This method will display the footer on the page.
698 public function displayFooter()
700 if (empty($this->responseTime)) {
701 $this->_calculateFooterMetrics();
703 global $sugar_config;
706 //decide whether or not to show themepicker, default is to show
707 $showThemePicker = true;
708 if (isset($sugar_config['showThemePicker'])) {
709 $showThemePicker = $sugar_config['showThemePicker'];
712 echo "<!-- crmprint -->";
713 $jsalerts = new jsAlerts();
714 if ( !isset($_SESSION['isMobile']) )
715 echo $jsalerts->getScript();
717 $ss = new Sugar_Smarty();
718 $ss->assign("AUTHENTICATED",isset($_SESSION["authenticated_user_id"]));
719 $ss->assign('MOD',return_module_language($GLOBALS['current_language'], 'Users'));
721 if (SugarConfig::getInstance()->get('calculate_response_time', false))
722 $ss->assign('STATISTICS',$this->_getStatistics());
724 // Under the License referenced above, you are required to leave in all copyright statements in both
725 // the code and end-user application.
728 $copyright = '© 2004-2011 SugarCRM Inc. The Program is provided AS IS, without warranty. Licensed under <a href="LICENSE.txt" target="_blank" class="copyRightLink">AGPLv3</a>.<br>This program is free software; you can redistribute it and/or modify it under the terms of the <br><a href="LICENSE.txt" target="_blank" class="copyRightLink"> GNU Affero General Public License version 3</a> as published by the Free Software Foundation, including the additional permission set forth in the source code header.<br>';
740 // The interactive user interfaces in modified source and object code
741 // versions of this program must display Appropriate Legal Notices, as
742 // required under Section 5 of the GNU General Public License version
743 // 3. In accordance with Section 7(b) of the GNU General Public License
744 // version 3, these Appropriate Legal Notices must retain the display
745 // of the "Powered by SugarCRM" logo. If the display of the logo is
746 // not reasonably feasible for technical reasons, the Appropriate
747 // Legal Notices must display the words "Powered by SugarCRM".
748 $attribLinkImg = "<img style='margin-top: 2px' border='0' width='106' height='23' src='include/images/poweredby_sugarcrm.png' alt='Powered By SugarCRM'>\n";
752 // Bug 38594 - Add in Trademark wording
753 $copyright .= 'SugarCRM is a trademark of SugarCRM, Inc. All other company and product names may be trademarks of the respective companies with which they are associated.<br />';
755 //rrs bug: 20923 - if this image does not exist as per the license, then the proper image will be displaye regardless, so no need
756 //to display an empty image here.
757 if(file_exists('include/images/poweredby_sugarcrm.png')){
758 $copyright .= $attribLinkImg;
760 // End Required Image
761 $ss->assign('COPYRIGHT',$copyright);
762 $ss->display(SugarThemeRegistry::current()->getTemplate('footer.tpl'));
766 * Called from process(). This method will display subpanels.
768 protected function _displaySubPanels()
770 if (isset($this->bean) && !empty($this->bean->id) && (file_exists('modules/' . $this->module . '/metadata/subpaneldefs.php') || file_exists('custom/modules/' . $this->module . '/metadata/subpaneldefs.php') || file_exists('custom/modules/' . $this->module . '/Ext/Layoutdefs/layoutdefs.ext.php'))) {
771 $GLOBALS['focus'] = $this->bean;
772 require_once ('include/SubPanel/SubPanelTiles.php');
773 $subpanel = new SubPanelTiles($this->bean, $this->module);
774 echo $subpanel->display();
778 protected function _buildModuleList()
780 if (!empty($GLOBALS['current_user']) && empty($GLOBALS['modListHeader']))
781 $GLOBALS['modListHeader'] = query_module_access_list($GLOBALS['current_user']);
785 * private method used in process() to determine the value of a passed in option
787 * @param string option - the option that we want to know the valye of
788 * @param bool default - what the default value should be if we do not find the option
790 * @return bool - the value of the option
792 protected function _getOption(
797 if (!empty($this->options) && isset($this->options['show_all'])) {
798 return $this->options['show_all'];
799 } elseif (!empty($this->options) && isset($this->options[$option])) {
800 return $this->options[$option];
801 } else return $default;
806 * Private function to track information about the view request
808 private function _track()
810 if (empty($this->responseTime)) {
811 $this->_calculateFooterMetrics();
813 if (empty($GLOBALS['current_user']->id)) {
818 $trackerManager = TrackerManager::getInstance();
819 $trackerManager->save();
824 * Checks to see if the module name passed is valid; dies if it is not
826 protected function _checkModule()
828 if(!empty($this->module) && !file_exists('modules/'.$this->module)){
829 $error = str_replace("[module]", "$this->module", $GLOBALS['app_strings']['ERR_CANNOT_FIND_MODULE']);
830 $GLOBALS['log']->fatal($error);
836 public function renderJavascript()
838 if ($this->action !== 'Login')
839 $this->_displayJavascript();
841 $this->_displayLoginJS();
844 private function _calculateFooterMetrics()
846 $endTime = microtime(true);
847 $deltaTime = $endTime - $GLOBALS['startTime'];
848 $this->responseTime = number_format(round($deltaTime, 2), 2);
849 // Print out the resources used in constructing the page.
850 $included_files = get_included_files();
851 // take all of the included files and make a list that does not allow for duplicates based on case
852 // I believe the full get_include_files result set appears to have one entry for each file in real
853 // case, and one entry in all lower case.
854 $list_of_files_case_insensitive = array();
855 foreach($included_files as $key => $name) {
856 // preserve the first capitalization encountered.
857 $list_of_files_case_insensitive[mb_strtolower($name) ] = $name;
859 $this->fileResources = sizeof($list_of_files_case_insensitive);
862 private function _getStatistics()
864 $endTime = microtime(true);
865 $deltaTime = $endTime - $GLOBALS['startTime'];
866 $response_time_string = $GLOBALS['app_strings']['LBL_SERVER_RESPONSE_TIME'] . " " . number_format(round($deltaTime, 2), 2) . " " . $GLOBALS['app_strings']['LBL_SERVER_RESPONSE_TIME_SECONDS'];
867 $return = $response_time_string;
869 if (!empty($GLOBALS['sugar_config']['show_page_resources'])) {
870 // Print out the resources used in constructing the page.
871 $included_files = get_included_files();
873 // take all of the included files and make a list that does not allow for duplicates based on case
874 // I believe the full get_include_files result set appears to have one entry for each file in real
875 // case, and one entry in all lower case.
876 $list_of_files_case_insensitive = array();
877 foreach($included_files as $key => $name) {
878 // preserve the first capitalization encountered.
879 $list_of_files_case_insensitive[mb_strtolower($name) ] = $name;
881 $return .= $GLOBALS['app_strings']['LBL_SERVER_RESPONSE_RESOURCES'] . '(' . DBManager::getQueryCount() . ',' . sizeof($list_of_files_case_insensitive) . ')<br>';
882 // Display performance of the internal and external caches....
883 $return .= "External cache (hits/total=ratio) local ({$GLOBALS['external_cache_request_local_hits']}/{$GLOBALS['external_cache_request_local_total']}=" . round($GLOBALS['external_cache_request_local_hits']*100/$GLOBALS['external_cache_request_local_total'], 0) . "%)";
884 if ($GLOBALS['external_cache_request_external_total']) {
885 // Only display out of process cache results if there was at least one attempt to retrieve from the out of process cache (this signifies that it was enabled).
886 $return .= " external ({$GLOBALS['external_cache_request_external_hits']}/{$GLOBALS['external_cache_request_external_total']}=" . round($GLOBALS['external_cache_request_external_hits']*100/$GLOBALS['external_cache_request_external_total'], 0) . "%)<br />";
894 * Loads the module shortcuts menu
896 * @param $module string optional, can specify module to retrieve menu for if not the current one
897 * @return array module menu
899 public function getMenu(
903 global $current_language, $current_user, $mod_strings, $app_strings;
905 if ( empty($module) )
906 $module = $this->module;
908 $module_menu = sugar_cache_retrieve("{$current_user->id}_{$module}_module_menu_{$current_language}");
909 if ( !is_array($module_menu) ) {
910 $final_module_menu = array();
912 if (file_exists('modules/' . $module . '/Menu.php')) {
913 $GLOBALS['module_menu'] = $module_menu = array();
914 require('modules/' . $module . '/Menu.php');
915 $final_module_menu = array_merge($final_module_menu,$GLOBALS['module_menu'],$module_menu);
917 if (file_exists('custom/modules/' . $module . '/Ext/Menus/menu.ext.php')) {
918 $GLOBALS['module_menu'] = $module_menu = array();
919 require('custom/modules/' . $module . '/Ext/Menus/menu.ext.php');
920 $final_module_menu = array_merge($final_module_menu,$GLOBALS['module_menu'],$module_menu);
922 if (!file_exists('modules/' . $module . '/Menu.php')
923 && !file_exists('custom/modules/' . $module . '/Ext/Menus/menu.ext.php')
924 && !empty($GLOBALS['mod_strings']['LNK_NEW_RECORD'])) {
925 $final_module_menu[] = array("index.php?module=$module&action=EditView&return_module=$module&return_action=DetailView",
926 $GLOBALS['mod_strings']['LNK_NEW_RECORD'],"{$GLOBALS['app_strings']['LBL_CREATE_BUTTON_LABEL']}$module" ,$module );
927 $final_module_menu[] = array("index.php?module=$module&action=index", $GLOBALS['mod_strings']['LNK_LIST'],
929 if ( ($this->bean instanceOf SugarBean) && !empty($this->bean->importable) )
930 if ( !empty($mod_strings['LNK_IMPORT_'.strtoupper($module)]) )
931 $final_module_menu[] = array("index.php?module=Import&action=Step1&import_module=$module&return_module=$module&return_action=index",
932 $mod_strings['LNK_IMPORT_'.strtoupper($module)], "Import", $module);
934 $final_module_menu[] = array("index.php?module=Import&action=Step1&import_module=$module&return_module=$module&return_action=index",
935 $app_strings['LBL_IMPORT'], "Import", $module);
937 if (file_exists('custom/application/Ext/Menus/menu.ext.php')) {
938 $GLOBALS['module_menu'] = $module_menu = array();
939 require('custom/application/Ext/Menus/menu.ext.php');
940 $final_module_menu = array_merge($final_module_menu,$GLOBALS['module_menu'],$module_menu);
942 $module_menu = $final_module_menu;
943 sugar_cache_put("{$current_user->id}_{$module}_module_menu_{$current_language}",$module_menu);
950 * Returns the module name which should be highlighted in the module menu
952 protected function _getModuleTab()
954 global $app_list_strings, $moduleTabMap;
956 // Need to figure out what tab this module belongs to, most modules have their own tabs, but there are exceptions.
957 if ( !empty($_REQUEST['module_tab']) )
958 return $_REQUEST['module_tab'];
959 elseif ( isset($moduleTabMap[$this->module]) )
960 return $moduleTabMap[$this->module];
962 elseif ( $this->module == 'MergeRecords' )
963 return $_REQUEST['return_module'];
964 elseif ( $this->module == 'Users' && $this->action == 'SetTimezone' )
966 // Default anonymous pages to be under Home
967 elseif ( !isset($app_list_strings['moduleList'][$this->module]) )
970 return $this->module;
974 * Return the "breadcrumbs" to display at the top of the page
976 * @param bool $show_help optional, true if we show the help links
977 * @return HTML string containing breadcrumb title
979 public function getModuleTitle(
983 global $sugar_version, $sugar_flavor, $server_unique_key, $current_language, $action;
985 $theTitle = "<div class='moduleTitle'>\n<h2>";
987 $module = preg_replace("/ /","",$this->module);
989 $params = $this->_getModuleTitleParams();
990 $count = count($params);
993 foreach($params as $parm){
997 $theTitle .= "<span class='pointer'>»</span>";
1000 $theTitle .= "</h2>\n";
1003 $theTitle .= "<span class='utils'>";
1004 if (isset($this->action) && $this->action != "EditView") {
1005 $printImageURL = SugarThemeRegistry::current()->getImageURL('print.gif');
1006 $theTitle .= <<<EOHTML
1007 <a href="javascript:void window.open('index.php?{$GLOBALS['request_string']}','printwin','menubar=1,status=0,resizable=1,scrollbars=1,toolbar=0,location=1')" class='utilsLink'>
1008 <img src="{$printImageURL}" alt="{$GLOBALS['app_strings']['LNK_PRINT']}"></a>
1009 <a href="javascript:void window.open('index.php?{$GLOBALS['request_string']}','printwin','menubar=1,status=0,resizable=1,scrollbars=1,toolbar=0,location=1')" class='utilsLink'>
1010 {$GLOBALS['app_strings']['LNK_PRINT']}
1014 $helpImageURL = SugarThemeRegistry::current()->getImageURL('help.gif');
1015 $theTitle .= <<<EOHTML
1017 <a href="index.php?module=Administration&action=SupportPortal&view=documentation&version={$sugar_version}&edition={$sugar_flavor}&lang={$current_language}&help_module={$module}&help_action={$this->action}&key={$server_unique_key}" class="utilsLink" target="_blank">
1018 <img src='{$helpImageURL}' alt='{$GLOBALS['app_strings']['LNK_HELP']}'></a>
1019 <a href="index.php?module=Administration&action=SupportPortal&view=documentation&version={$sugar_version}&edition={$sugar_flavor}&lang={$current_language}&help_module={$module}&help_action={$this->action}&key={$server_unique_key}" class="utilsLink" target="_blank">
1020 {$GLOBALS['app_strings']['LNK_HELP']}
1025 $theTitle .= "</span></div>\n";
1030 * Return the metadata file that will be used by this view.
1032 * @return string File location of the metadata file.
1034 public function getMetaDataFile(){
1036 $metadataFile = null;
1037 $foundViewDefs = false;
1038 $viewDef = strtolower($this->type) . 'viewdefs';
1039 $coreMetaPath = 'modules/'.$this->module.'/metadata/' . $viewDef . '.php';
1040 if(file_exists('custom/' .$coreMetaPath )){
1041 $metadataFile = 'custom/' . $coreMetaPath;
1042 $foundViewDefs = true;
1044 if(file_exists('custom/modules/'.$this->module.'/metadata/metafiles.php')){
1045 require_once('custom/modules/'.$this->module.'/metadata/metafiles.php');
1046 if(!empty($metafiles[$this->module][$viewDef])){
1047 $metadataFile = $metafiles[$this->module][$viewDef];
1048 $foundViewDefs = true;
1050 }elseif(file_exists('modules/'.$this->module.'/metadata/metafiles.php')){
1051 require_once('modules/'.$this->module.'/metadata/metafiles.php');
1052 if(!empty($metafiles[$this->module][$viewDef])){
1053 $metadataFile = $metafiles[$this->module][$viewDef];
1054 $foundViewDefs = true;
1059 if(!$foundViewDefs && file_exists($coreMetaPath)){
1060 $metadataFile = $coreMetaPath;
1062 $GLOBALS['log']->debug("metadatafile=". $metadataFile);
1064 return $metadataFile;
1069 * Returns an array composing of the breadcrumbs to use for the module title
1073 protected function _getModuleTitleParams($bTitle=false)
1075 $params = array($this->_getModuleTitleListParam($bTitle));
1077 if (isset($this->action)){
1078 switch ($this->action) {
1080 if(!empty($this->bean->id)) {
1081 $params[] = "<a href='index.php?module={$this->module}&action=DetailView&record={$this->bean->id}'>".$this->bean->get_summary_text()."</a>";
1082 $params[] = $GLOBALS['app_strings']['LBL_EDIT_BUTTON_LABEL'];
1085 $params[] = $GLOBALS['app_strings']['LBL_CREATE_BUTTON_LABEL'];
1088 $beanName = $this->bean->get_summary_text();
1089 $params[] = $beanName;
1098 * Returns the portion of the array that will represent the listview in the breadcrumb
1102 protected function _getModuleTitleListParam($bTitle=false)
1104 global $current_user;
1105 global $app_strings;
1107 if(!empty($GLOBALS['app_list_strings']['moduleList'][$this->module]))
1108 $firstParam = $GLOBALS['app_list_strings']['moduleList'][$this->module];
1110 $firstParam = $this->module;
1112 $iconPath = $this->getModuleTitleIconPath($this->module);
1113 if($this->action == "ListView" || $this->action == "index")
1115 if (!empty($iconPath) && !$bTitle) {
1116 return "<a href='index.php?module={$this->module}&action=index'>"
1117 . "<img src='{$iconPath}' alt='".$this->module."' title='".$this->module."' align='absmiddle'></a>"
1118 . "<span class='pointer'>»</span>".$app_strings['LBL_SEARCH'];
1124 if (!empty($iconPath) && !$bTitle) {
1125 return "<a href='index.php?module={$this->module}&action=index'>"
1126 . "<img src='{$iconPath}' alt='".$this->module."' title='".$this->module."' align='absmiddle'></a>";
1128 return "<a href='index.php?module={$this->module}&action=index'>{$firstParam}</a>";
1133 protected function getModuleTitleIconPath($module) {
1135 if(is_file(SugarThemeRegistry::current()->getImageURL('icon_'.$module.'_32.png',false)))
1137 $iconPath = SugarThemeRegistry::current()->getImageURL('icon_'.$module.'_32.png');
1138 } else if (is_file(SugarThemeRegistry::current()->getImageURL('icon_'.ucfirst($module).'_32.png',false)))
1140 $iconPath = SugarThemeRegistry::current()->getImageURL('icon_'.ucfirst($module).'_32.png');
1146 * Returns the string which will be shown in the browser's title; defaults to using the same breadcrumb
1147 * as in the module title
1151 public function getBrowserTitle()
1153 global $app_strings;
1155 $browserTitle = $app_strings['LBL_BROWSER_TITLE'];
1156 if ( $this->module == 'Users' && ($this->action == 'SetTimezone' || $this->action == 'Login') )
1157 return $browserTitle;
1158 $params = $this->_getModuleTitleParams(true);
1159 foreach ($params as $value )
1160 $browserTitle = strip_tags($value) . ' » ' . $browserTitle;
1162 return $browserTitle;