include/MVC/View/SugarView.php

   1 <?php
   2 /*********************************************************************************
   3  * SugarCRM Community Edition is a customer relationship management program developed by
   4  * SugarCRM, Inc. Copyright (C) 2004-2012 SugarCRM Inc.
   5  *
   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.
  12  *
  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
  16  * details.
  17  *
  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
  21  * 02110-1301 USA.
  22  *
  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.
  25  *
  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.
  29  *
  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  ********************************************************************************/
  36
  37 /**
  38  * Base Sugar view
  39  * @api
  40  */
  41 class SugarView
  42 {
  43     /**
  44      * This array is meant to hold an objects/data that we would like to pass between
  45      * the controller and the view.  The bean will automatically be set for us, but this
  46      * is meant to hold anything else.
  47      */
  48     var $view_object_map = array();
  49     /**
  50      * The name of the current module.
  51      */
  52     var $module = '';
  53     /**
  54      * The name of the current action.
  55      */
  56     var $action = '';
  57     /**
  58      */
  59     var $bean = null;
  60     /**
  61      * Sugar_Smarty. This is useful if you have a view and a subview you can
  62      * share the same smarty object.
  63      */
  64     var $ss = null;
  65     /**
  66      * Any errors that occured this can either be set by the view or the controller or the model
  67      */
  68     var $errors = array();
  69     /**
  70      * Set to true if you do not want to display errors from SugarView::displayErrors(); instead they will be returned
  71      */
  72     var $suppressDisplayErrors = false;
  73
  74     /**
  75      * Options for what UI elements to hide/show/
  76      */
  77     var $options = array('show_header' => true, 'show_title' => true, 'show_subpanels' => false, 'show_search' => true, 'show_footer' => true, 'show_javascript' => true, 'view_print' => false,);
  78     var $type = null;
  79     var $responseTime;
  80     var $fileResources;
  81
  82     /**
  83      * Constructor which will peform the setup.
  84      */
  85     public function SugarView(
  86         $bean = null,
  87         $view_object_map = array()
  88         )
  89     {
  90     }
  91
  92     public function init(
  93         $bean = null,
  94         $view_object_map = array()
  95         )
  96     {
  97         $this->bean = $bean;
  98         $this->view_object_map = $view_object_map;
  99         $this->action = $GLOBALS['action'];
 100         $this->module = $GLOBALS['module'];
 101         $this->_initSmarty();
 102     }
 103
 104     protected function _initSmarty()
 105     {
 106         $this->ss = new Sugar_Smarty();
 107         $this->ss->assign('MOD', $GLOBALS['mod_strings']);
 108         $this->ss->assign('APP', $GLOBALS['app_strings']);
 109     }
 110
 111     /**
 112      * This method will be called from the controller and is not meant to be overridden.
 113      */
 114     public function process()
 115     {
 116         LogicHook::initialize();
 117         $this->_checkModule();
 118
 119         //trackView has to be here in order to track for breadcrumbs
 120         $this->_trackView();
 121
 122         //For the ajaxUI, we need to use output buffering to return the page in an ajax friendly format
 123         if ($this->_getOption('json_output')){
 124                         ob_start();
 125                         if(!empty($_REQUEST['ajax_load']) && !empty($_REQUEST['loadLanguageJS'])) {
 126                                 echo $this->_getModLanguageJS();
 127                         }
 128                 }
 129
 130         if ($this->_getOption('show_header')) {
 131             $this->displayHeader();
 132         } else {
 133             $this->renderJavascript();
 134         }
 135
 136         $this->_buildModuleList();
 137         $this->preDisplay();
 138         $this->displayErrors();
 139         $this->display();
 140         if ( !empty($this->module) ) {
 141             $GLOBALS['logic_hook']->call_custom_logic($this->module, 'after_ui_frame');
 142         } else {
 143             $GLOBALS['logic_hook']->call_custom_logic('', 'after_ui_frame');
 144         }
 145
 146         if ($this->_getOption('show_subpanels') && !empty($_REQUEST['record'])) $this->_displaySubPanels();
 147
 148         if ($this->action === 'Login') {
 149             //this is needed for a faster loading login page ie won't render unless the tables are closed
 150             ob_flush();
 151         }
 152         if ($this->_getOption('show_footer')) $this->displayFooter();
 153         $GLOBALS['logic_hook']->call_custom_logic('', 'after_ui_footer');
 154         if ($this->_getOption('json_output'))
 155         {
 156             $content = ob_get_clean();
 157             $module = $this->module;
 158             $ajax_ret = array(
 159                 'content' => mb_detect_encoding($content) == "UTF-8" ? $content : utf8_encode($content),
 160                  'menu' => array(
 161                      'module' => $module,
 162                      'label' => translate($module),
 163                      $this->getMenu($module),
 164                  ),
 165                 'title' => $this->getBrowserTitle(),
 166                 'action' => isset($_REQUEST['action']) ? $_REQUEST['action'] : "",
 167                 'record' => isset($_REQUEST['record']) ? $_REQUEST['record'] : "",
 168                 'favicon' => $this->getFavicon(),
 169             );
 170
 171             if(SugarThemeRegistry::current()->name == 'Classic')
 172                 $ajax_ret['moduleList'] = $this->displayHeader(true);
 173
 174             if(empty($this->responseTime))
 175                 $this->_calculateFooterMetrics();
 176             $ajax_ret['responseTime'] = $this->responseTime;
 177             $json = getJSONobj();
 178             echo $json->encode($ajax_ret);
 179             $GLOBALS['app']->headerDisplayed = false;
 180             ob_flush();
 181         }
 182         //Do not track if there is no module or if module is not a String
 183         $this->_track();
 184     }
 185
 186     /**
 187      * This method will display the errors on the page.
 188      */
 189     public function displayErrors()
 190     {
 191         $errors = '';
 192
 193         foreach($this->errors as $error) {
 194             $errors .= '<span class="error">' . $error . '</span><br>';
 195         }
 196
 197         if ( !$this->suppressDisplayErrors ) {
 198             echo $errors;
 199         }
 200         else {
 201             return $errors;
 202         }
 203     }
 204
 205     /**
 206      * [OVERRIDE] - This method is meant to overidden in a subclass. The purpose of this method is
 207      * to allow a view to do some preprocessing before the display method is called. This becomes
 208      * useful when you have a view defined at the application level and then within a module
 209      * have a sub-view that extends from this application level view.  The application level
 210      * view can do the setup in preDisplay() that is common to itself and any subviews
 211      * and then the subview can just override display(). If it so desires, can also override
 212      * preDisplay().
 213      */
 214     public function preDisplay()
 215     {
 216     }
 217
 218     /**
 219      * [OVERRIDE] - This method is meant to overidden in a subclass. This method
 220      * will handle the actual display logic of the view.
 221      */
 222     public function display()
 223     {
 224     }
 225
 226
 227     /**
 228      * trackView
 229      */
 230     protected function _trackView()
 231     {
 232         $action = strtolower($this->action);
 233         //Skip save, tracked in SugarBean instead
 234         if($action == 'save') {
 235         return;
 236         }
 237
 238
 239         $trackerManager = TrackerManager::getInstance();
 240         $timeStamp = TimeDate::getInstance()->nowDb();
 241         if($monitor = $trackerManager->getMonitor('tracker')){
 242             $monitor->setValue('action', $action);
 243             $monitor->setValue('user_id', $GLOBALS['current_user']->id);
 244             $monitor->setValue('module_name', $this->module);
 245             $monitor->setValue('date_modified', $timeStamp);
 246             $monitor->setValue('visible', (($monitor->action == 'detailview') || ($monitor->action == 'editview')
 247                                             ) ? 1 : 0);
 248
 249             if (!empty($this->bean->id)) {
 250                 $monitor->setValue('item_id', $this->bean->id);
 251                 $monitor->setValue('item_summary', $this->bean->get_summary_text());
 252             }
 253
 254             //If visible is true, but there is no bean, do not track (invalid/unauthorized reference)
 255             //Also, do not track save actions where there is no bean id
 256             if($monitor->visible && empty($this->bean->id)) {
 257             $trackerManager->unsetMonitor($monitor);
 258             return;
 259             }
 260             $trackerManager->saveMonitor($monitor, true, true);
 261         }
 262     }
 263
 264
 265     /**
 266      * Displays the header on section of the page; basically everything before the content
 267      */
 268     public function displayHeader($retModTabs=false)
 269     {
 270         global $theme;
 271         global $max_tabs;
 272         global $app_strings;
 273         global $current_user;
 274         global $sugar_config;
 275         global $app_list_strings;
 276         global $mod_strings;
 277         global $current_language;
 278
 279         $GLOBALS['app']->headerDisplayed = true;
 280
 281         $themeObject = SugarThemeRegistry::current();
 282         $theme = $themeObject->__toString();
 283
 284         $ss = new Sugar_Smarty();
 285         $ss->assign("APP", $app_strings);
 286         $ss->assign("THEME", $theme);
 287         $ss->assign("THEME_IE6COMPAT", $themeObject->ie6compat ? 'true':'false');
 288         $ss->assign("MODULE_NAME", $this->module);
 289         $ss->assign("langHeader", get_language_header());
 290
 291         // set ab testing if exists
 292         $testing = (isset($_REQUEST["testing"]) ? $_REQUEST['testing'] : "a");
 293         $ss->assign("ABTESTING", $testing);
 294
 295         // get browser title
 296         $ss->assign("SYSTEM_NAME", $this->getBrowserTitle());
 297
 298         // get css
 299         $css = $themeObject->getCSS();
 300         if ($this->_getOption('view_print')) {
 301             $css .= '<link rel="stylesheet" type="text/css" href="'.$themeObject->getCSSURL('print.css').'" media="all" />';
 302         }
 303         $ss->assign("SUGAR_CSS",$css);
 304
 305         // get javascript
 306         ob_start();
 307         $this->renderJavascript();
 308
 309         $ss->assign("SUGAR_JS",ob_get_contents().$themeObject->getJS());
 310         ob_end_clean();
 311
 312         // get favicon
 313         if(isset($GLOBALS['sugar_config']['default_module_favicon']))
 314             $module_favicon = $GLOBALS['sugar_config']['default_module_favicon'];
 315         else
 316             $module_favicon = false;
 317
 318         $favicon = $this->getFavicon();
 319         $ss->assign('FAVICON_URL', $favicon['url']);
 320
 321         // build the shortcut menu
 322         $shortcut_menu = array();
 323         foreach ( $this->getMenu() as $key => $menu_item )
 324             $shortcut_menu[$key] = array(
 325                 "URL"         => $menu_item[0],
 326                 "LABEL"       => $menu_item[1],
 327                 "MODULE_NAME" => $menu_item[2],
 328                 "IMAGE"       => $themeObject
 329                     ->getImage($menu_item[2],"border='0' align='absmiddle'",null,null,'.gif',$menu_item[1]),
 330                 );
 331         $ss->assign("SHORTCUT_MENU",$shortcut_menu);
 332
 333         // handle rtl text direction
 334         if(isset($_REQUEST['RTL']) && $_REQUEST['RTL'] == 'RTL'){
 335             $_SESSION['RTL'] = true;
 336         }
 337         if(isset($_REQUEST['LTR']) && $_REQUEST['LTR'] == 'LTR'){
 338             unset($_SESSION['RTL']);
 339         }
 340         if(isset($_SESSION['RTL']) && $_SESSION['RTL']){
 341             $ss->assign("DIR", 'dir="RTL"');
 342         }
 343
 344         // handle resizing of the company logo correctly on the fly
 345         $companyLogoURL = $themeObject->getImageURL('company_logo.png');
 346         $companyLogoURL_arr = explode('?', $companyLogoURL);
 347         $companyLogoURL = $companyLogoURL_arr[0];
 348
 349         $company_logo_attributes = sugar_cache_retrieve('company_logo_attributes');
 350         if(!empty($company_logo_attributes)) {
 351             $ss->assign("COMPANY_LOGO_MD5", $company_logo_attributes[0]);
 352             $ss->assign("COMPANY_LOGO_WIDTH", $company_logo_attributes[1]);
 353             $ss->assign("COMPANY_LOGO_HEIGHT", $company_logo_attributes[2]);
 354         }
 355         else {
 356             // Always need to md5 the file
 357             $ss->assign("COMPANY_LOGO_MD5", md5_file($companyLogoURL));
 358
 359             list($width,$height) = getimagesize($companyLogoURL);
 360             if ( $width > 212 || $height > 40 ) {
 361                 $resizePctWidth  = ($width - 212)/212;
 362                 $resizePctHeight = ($height - 40)/40;
 363                 if ( $resizePctWidth > $resizePctHeight )
 364                     $resizeAmount = $width / 212;
 365                 else
 366                     $resizeAmount = $height / 40;
 367                 $ss->assign("COMPANY_LOGO_WIDTH", round($width * (1/$resizeAmount)));
 368                 $ss->assign("COMPANY_LOGO_HEIGHT", round($height * (1/$resizeAmount)));
 369             }
 370             else {
 371                 $ss->assign("COMPANY_LOGO_WIDTH", $width);
 372                 $ss->assign("COMPANY_LOGO_HEIGHT", $height);
 373             }
 374
 375             // Let's cache the results
 376             sugar_cache_put('company_logo_attributes',
 377                             array(
 378                                 $ss->get_template_vars("COMPANY_LOGO_MD5"),
 379                                 $ss->get_template_vars("COMPANY_LOGO_WIDTH"),
 380                                 $ss->get_template_vars("COMPANY_LOGO_HEIGHT")
 381                                 )
 382             );
 383         }
 384         $ss->assign("COMPANY_LOGO_URL",getJSPath($companyLogoURL)."&logo_md5=".$ss->get_template_vars("COMPANY_LOGO_MD5"));
 385
 386         // get the global links
 387         $gcls = array();
 388         $global_control_links = array();
 389         require("include/globalControlLinks.php");
 390
 391         foreach($global_control_links as $key => $value) {
 392             if ($key == 'users')  {   //represents logout link.
 393                 $ss->assign("LOGOUT_LINK", $value['linkinfo'][key($value['linkinfo'])]);
 394                 $ss->assign("LOGOUT_LABEL", key($value['linkinfo']));//key value for first element.
 395                 continue;
 396             }
 397
 398             foreach ($value as $linkattribute => $attributevalue) {
 399                 // get the main link info
 400                 if ( $linkattribute == 'linkinfo' ) {
 401                     $gcls[$key] = array(
 402                         "LABEL" => key($attributevalue),
 403                         "URL"   => current($attributevalue),
 404                         "SUBMENU" => array(),
 405                         );
 406                    if(substr($gcls[$key]["URL"], 0, 11) == "javascript:") {
 407                        $gcls[$key]["ONCLICK"] = substr($gcls[$key]["URL"],11);
 408                        $gcls[$key]["URL"] = "javascript:void(0)";
 409                    }
 410                 }
 411                 // and now the sublinks
 412                 if ( $linkattribute == 'submenu' && is_array($attributevalue) ) {
 413                     foreach ($attributevalue as $submenulinkkey => $submenulinkinfo)
 414                         $gcls[$key]['SUBMENU'][$submenulinkkey] = array(
 415                             "LABEL" => key($submenulinkinfo),
 416                             "URL"   => current($submenulinkinfo),
 417                         );
 418                        if(substr($gcls[$key]['SUBMENU'][$submenulinkkey]["URL"], 0, 11) == "javascript:") {
 419                            $gcls[$key]['SUBMENU'][$submenulinkkey]["ONCLICK"] = substr($gcls[$key]['SUBMENU'][$submenulinkkey]["URL"],11);
 420                            $gcls[$key]['SUBMENU'][$submenulinkkey]["URL"] = "javascript:void(0)";
 421                        }
 422                 }
 423             }
 424         }
 425         $ss->assign("GCLS",$gcls);
 426
 427         $ss->assign("SEARCH", isset($_REQUEST['query_string']) ? $_REQUEST['query_string'] : '');
 428
 429         if ($this->action == "EditView" || $this->action == "Login")
 430             $ss->assign("ONLOAD", 'onload="set_focus()"');
 431
 432         $ss->assign("AUTHENTICATED",isset($_SESSION["authenticated_user_id"]));
 433
 434         // get other things needed for page style popup
 435         if (isset($_SESSION["authenticated_user_id"])) {
 436             // get the current user name and id
 437             $ss->assign("CURRENT_USER", $current_user->full_name == '' || !showFullName()
 438                 ? $current_user->user_name : $current_user->full_name );
 439             $ss->assign("CURRENT_USER_ID", $current_user->id);
 440
 441             // get the last viewed records
 442             $tracker = new Tracker();
 443             $history = $tracker->get_recently_viewed($current_user->id);
 444             foreach ( $history as $key => $row ) {
 445                 $history[$key]['item_summary_short'] = to_html(getTrackerSubstring($row['item_summary'])); //bug 56373 - need to re-HTML-encode
 446                 $history[$key]['image'] = SugarThemeRegistry::current()
 447                     ->getImage($row['module_name'],'border="0" align="absmiddle"',null,null,'.gif',$row['item_summary']);
 448             }
 449             $ss->assign("recentRecords",$history);
 450         }
 451
 452         $bakModStrings = $mod_strings;
 453         if (isset($_SESSION["authenticated_user_id"]) ) {
 454             // get the module list
 455             $moduleTopMenu = array();
 456
 457             $max_tabs = $current_user->getPreference('max_tabs');
 458             // Attempt to correct if max tabs count is extremely high.
 459             if ( !isset($max_tabs) || $max_tabs <= 0 || $max_tabs > 10 ) {
 460                 $max_tabs = $GLOBALS['sugar_config']['default_max_tabs'];
 461                 $current_user->setPreference('max_tabs', $max_tabs, 0, 'global');
 462             }
 463
 464             $moduleTab = $this->_getModuleTab();
 465             $ss->assign('MODULE_TAB',$moduleTab);
 466
 467
 468             // See if they are using grouped tabs or not (removed in 6.0, returned in 6.1)
 469             $user_navigation_paradigm = $current_user->getPreference('navigation_paradigm');
 470             if ( !isset($user_navigation_paradigm) ) {
 471                 $user_navigation_paradigm = $GLOBALS['sugar_config']['default_navigation_paradigm'];
 472             }
 473
 474
 475             // Get the full module list for later use
 476             foreach ( query_module_access_list($current_user) as $module ) {
 477                 // Bug 25948 - Check for the module being in the moduleList
 478                 if ( isset($app_list_strings['moduleList'][$module]) ) {
 479                     $fullModuleList[$module] = $app_list_strings['moduleList'][$module];
 480                 }
 481             }
 482
 483
 484             if(!should_hide_iframes()) {
 485                 $iFrame = new iFrame();
 486                 $frames = $iFrame->lookup_frames('tab');
 487                 foreach($frames as $key => $values){
 488                         $fullModuleList[$key] = $values;
 489                 }
 490             }
 491             elseif (isset($fullModuleList['iFrames'])) {
 492                 unset($fullModuleList['iFrames']);
 493             }
 494
 495             if ( $user_navigation_paradigm == 'gm' && isset($themeObject->group_tabs) && $themeObject->group_tabs) {
 496                 // We are using grouped tabs
 497                 require_once('include/GroupedTabs/GroupedTabStructure.php');
 498                 $groupedTabsClass = new GroupedTabStructure();
 499                 $modules = query_module_access_list($current_user);
 500                 //handle with submoremodules
 501                 $max_tabs = $current_user->getPreference('max_tabs');
 502                 // If the max_tabs isn't set incorrectly, set it within the range, to the default max sub tabs size
 503                 if ( !isset($max_tabs) || $max_tabs <= 0 || $max_tabs > 10){
 504                     // We have a default value. Use it
 505                     if(isset($GLOBALS['sugar_config']['default_max_tabs'])){
 506                         $max_tabs = $GLOBALS['sugar_config']['default_max_tabs'];
 507                     }
 508                     else{
 509                         $max_tabs = 8;
 510                     }
 511                 }
 512
 513                 $subMoreModules = false;
 514                 $groupTabs = $groupedTabsClass->get_tab_structure(get_val_array($modules));
 515                 // We need to put this here, so the "All" group is valid for the user's preference.
 516                 $groupTabs[$app_strings['LBL_TABGROUP_ALL']]['modules'] = $fullModuleList;
 517
 518
 519                 // Setup the default group tab.
 520                 $allGroup = $app_strings['LBL_TABGROUP_ALL'];
 521                 $ss->assign('currentGroupTab',$allGroup);
 522                 $currentGroupTab = $allGroup;
 523                 $usersGroup = $current_user->getPreference('theme_current_group');
 524                 // Figure out which tab they currently have selected (stored as a user preference)
 525                 if ( !empty($usersGroup) && isset($groupTabs[$usersGroup]) ) {
 526                     $currentGroupTab = $usersGroup;
 527                 } else {
 528                     $current_user->setPreference('theme_current_group',$currentGroupTab);
 529                 }
 530
 531                 $ss->assign('currentGroupTab',$currentGroupTab);
 532                 $usingGroupTabs = true;
 533
 534             } else {
 535                 // Setup the default group tab.
 536                 $ss->assign('currentGroupTab',$app_strings['LBL_TABGROUP_ALL']);
 537
 538                 $usingGroupTabs = false;
 539
 540                 $groupTabs[$app_strings['LBL_TABGROUP_ALL']]['modules'] = $fullModuleList;
 541
 542             }
 543
 544
 545             $topTabList = array();
 546
 547             // Now time to go through each of the tab sets and fix them up.
 548             foreach ( $groupTabs as $tabIdx => $tabData ) {
 549                 $topTabs = $tabData['modules'];
 550                 if ( ! is_array($topTabs) ) {
 551                     $topTabs = array();
 552                 }
 553                 $extraTabs = array();
 554
 555                 // Split it in to the tabs that go across the top, and the ones that are on the extra menu.
 556                 if ( count($topTabs) > $max_tabs ) {
 557                     $extraTabs = array_splice($topTabs,$max_tabs);
 558                 }
 559                 // Make sure the current module is accessable through one of the top tabs
 560                 if ( !isset($topTabs[$moduleTab]) ) {
 561                     // Nope, we need to add it.
 562                     // First, take it out of the extra menu, if it's there
 563                     if ( isset($extraTabs[$moduleTab]) ) {
 564                         unset($extraTabs[$moduleTab]);
 565                     }
 566                     if ( count($topTabs) >= $max_tabs - 1 ) {
 567                         // We already have the maximum number of tabs, so we need to shuffle the last one
 568                         // from the top to the first one of the extras
 569                         $lastElem = array_splice($topTabs,$max_tabs-1);
 570                         $extraTabs = $lastElem + $extraTabs;
 571                     }
 572                     if ( !empty($moduleTab) ) {
 573                         $topTabs[$moduleTab] = $app_list_strings['moduleList'][$moduleTab];
 574                     }
 575                 }
 576
 577
 578                 /*
 579                 // This was removed, but I like the idea, so I left the code in here in case we decide to turn it back on
 580                 // If we are using group tabs, add all the "hidden" tabs to the end of the extra menu
 581                 if ( $usingGroupTabs ) {
 582                     foreach($fullModuleList as $moduleKey => $module ) {
 583                         if ( !isset($topTabs[$moduleKey]) && !isset($extraTabs[$moduleKey]) ) {
 584                             $extraTabs[$moduleKey] = $module;
 585                         }
 586                     }
 587                 }
 588                 */
 589
 590                 // Get a unique list of the top tabs so we can build the popup menus for them
 591                 foreach ( $topTabs as $moduleKey => $module ) {
 592                     $topTabList[$moduleKey] = $module;
 593                 }
 594
 595                 $groupTabs[$tabIdx]['modules'] = $topTabs;
 596                 $groupTabs[$tabIdx]['extra'] = $extraTabs;
 597             }
 598         }
 599
 600         if ( isset($topTabList) && is_array($topTabList) ) {
 601             // Adding shortcuts array to menu array for displaying shortcuts associated with each module
 602             $shortcutTopMenu = array();
 603             foreach($topTabList as $module_key => $label) {
 604                 global $mod_strings;
 605                 $mod_strings = return_module_language($current_language, $module_key);
 606                 foreach ( $this->getMenu($module_key) as $key => $menu_item ) {
 607                     $shortcutTopMenu[$module_key][$key] = array(
 608                         "URL"         => $menu_item[0],
 609                         "LABEL"       => $menu_item[1],
 610                         "MODULE_NAME" => $menu_item[2],
 611                         "IMAGE"       => $themeObject
 612                         ->getImage($menu_item[2],"border='0' align='absmiddle'",null,null,'.gif',$menu_item[1]),
 613                         "ID"          => $menu_item[2]."_link",
 614                         );
 615                 }
 616             }
 617             $ss->assign("groupTabs",$groupTabs);
 618             $ss->assign("shortcutTopMenu",$shortcutTopMenu);
 619             $ss->assign('USE_GROUP_TABS',$usingGroupTabs);
 620
 621             // This is here for backwards compatibility, someday, somewhere, it will be able to be removed
 622             $ss->assign("moduleTopMenu",$groupTabs[$app_strings['LBL_TABGROUP_ALL']]['modules']);
 623             $ss->assign("moduleExtraMenu",$groupTabs[$app_strings['LBL_TABGROUP_ALL']]['extra']);
 624
 625
 626         }
 627
 628         if ( isset($extraTabs) && is_array($extraTabs) ) {
 629             // Adding shortcuts array to extra menu array for displaying shortcuts associated with each module
 630             $shortcutExtraMenu = array();
 631             foreach($extraTabs as $module_key => $label) {
 632                 global $mod_strings;
 633                 $mod_strings = return_module_language($current_language, $module_key);
 634                 foreach ( $this->getMenu($module_key) as $key => $menu_item ) {
 635                     $shortcutExtraMenu[$module_key][$key] = array(
 636                         "URL"         => $menu_item[0],
 637                         "LABEL"       => $menu_item[1],
 638                         "MODULE_NAME" => $menu_item[2],
 639                         "IMAGE"       => $themeObject
 640                         ->getImage($menu_item[2],"border='0' align='absmiddle'",null,null,'.gif',$menu_item[1]),
 641                         "ID"          => $menu_item[2]."_link",
 642                         );
 643                 }
 644             }
 645             $ss->assign("shortcutExtraMenu",$shortcutExtraMenu);
 646         }
 647
 648        if(!empty($current_user)){
 649         $ss->assign("max_tabs", $current_user->getPreference("max_tabs"));
 650        }
 651
 652
 653         $imageURL = SugarThemeRegistry::current()->getImageURL("dashboard.png");
 654         $homeImage = "<img src='$imageURL'>";
 655                 $ss->assign("homeImage",$homeImage);
 656         global $mod_strings;
 657         $mod_strings = $bakModStrings;
 658         $headerTpl = $themeObject->getTemplate('header.tpl');
 659         if (inDeveloperMode() )
 660             $ss->clear_compiled_tpl($headerTpl);
 661
 662         if ($retModTabs)
 663         {
 664             return $ss->fetch($themeObject->getTemplate('_headerModuleList.tpl'));
 665         } else {
 666             $ss->display($headerTpl);
 667
 668             $this->includeClassicFile('modules/Administration/DisplayWarnings.php');
 669
 670             $errorMessages = SugarApplication::getErrorMessages();
 671             if ( !empty($errorMessages)) {
 672                 foreach ( $errorMessages as $error_message ) {
 673                     echo('<p class="error">' . $error_message.'</p>');
 674                 }
 675             }
 676         }
 677
 678     }
 679
 680     function getModuleMenuHTML()
 681     {
 682
 683     }
 684
 685     /**
 686      * If the view is classic then this method will include the file and
 687      * setup any global variables.
 688      *
 689      * @param string $file
 690      */
 691     public function includeClassicFile(
 692         $file
 693         )
 694     {
 695         global $sugar_config, $theme, $current_user, $sugar_version, $sugar_flavor, $mod_strings, $app_strings, $app_list_strings, $action;
 696         global $gridline, $request_string, $modListHeader, $dashletData, $authController, $locale, $currentModule, $import_bean_map, $image_path, $license;
 697         global $user_unique_key, $server_unique_key, $barChartColors, $modules_exempt_from_availability_check, $dictionary, $current_language, $beanList, $beanFiles, $sugar_build, $sugar_codename;
 698         global $timedate, $login_error; // cn: bug 13855 - timedate not available to classic views.
 699         if (!empty($this->module))
 700             $currentModule = $this->module;
 701         require_once ($file);
 702     }
 703
 704     protected function _displayLoginJS()
 705     {
 706         global $sugar_config, $timedate;
 707
 708         if(isset($this->bean->module_dir)){
 709             echo "<script>var module_sugar_grp1 = '{$this->bean->module_dir}';</script>";
 710         }
 711         if(isset($_REQUEST['action'])){
 712             echo "<script>var action_sugar_grp1 = '{$_REQUEST['action']}';</script>";
 713         }
 714         echo '<script>jscal_today = 1000*' . $timedate->asUserTs($timedate->getNow()) . '; if(typeof app_strings == "undefined") app_strings = new Array();</script>';
 715         if (!is_file(sugar_cached("include/javascript/sugar_grp1.js"))) {
 716             $_REQUEST['root_directory'] = ".";
 717             require_once("jssource/minify_utils.php");
 718             ConcatenateFiles(".");
 719         }
 720         echo getVersionedScript('cache/include/javascript/sugar_grp1_jquery.js');
 721         echo getVersionedScript('cache/include/javascript/sugar_grp1_yui.js');
 722         echo getVersionedScript('cache/include/javascript/sugar_grp1.js');
 723         echo getVersionedScript('include/javascript/calendar.js');
 724         echo <<<EOQ
 725         <script>
 726             if ( typeof(SUGAR) == 'undefined' ) {SUGAR = {}};
 727             if ( typeof(SUGAR.themes) == 'undefined' ) SUGAR.themes = {};
 728         </script>
 729 EOQ;
 730         if(isset( $sugar_config['disc_client']) && $sugar_config['disc_client'])
 731             echo getVersionedScript('modules/Sync/headersync.js');
 732     }
 733
 734     /**
 735      * Get JS validation code for views
 736      */
 737     public static function getJavascriptValidation()
 738     {
 739         global $timedate;
 740         $cal_date_format = $timedate->get_cal_date_format();
 741         $timereg = $timedate->get_regular_expression($timedate->get_time_format());
 742         $datereg = $timedate->get_regular_expression($timedate->get_date_format());
 743         $date_pos = '';
 744         foreach ($datereg['positions'] as $type => $pos) {
 745             if (empty($date_pos)) {
 746                 $date_pos .= "'$type': $pos";
 747             } else {
 748                 $date_pos .= ",'$type': $pos";
 749             }
 750         }
 751
 752         $time_separator = $timedate->timeSeparator();
 753         $hour_offset = $timedate->getUserUTCOffset() * 60;
 754
 755         // Add in the number formatting styles here as well, we have been handling this with individual modules.
 756         require_once ('modules/Currencies/Currency.php');
 757         list ($num_grp_sep, $dec_sep) = get_number_seperators();
 758
 759         $the_script = "<script type=\"text/javascript\">\n" . "\tvar time_reg_format = '" .
 760              $timereg['format'] . "';\n" . "\tvar date_reg_format = '" .
 761              $datereg['format'] . "';\n" . "\tvar date_reg_positions = { $date_pos };\n" .
 762              "\tvar time_separator = '$time_separator';\n" .
 763              "\tvar cal_date_format = '$cal_date_format';\n" .
 764              "\tvar time_offset = $hour_offset;\n" . "\tvar num_grp_sep = '$num_grp_sep';\n" .
 765              "\tvar dec_sep = '$dec_sep';\n" . "</script>";
 766
 767         return $the_script;
 768     }
 769
 770     /**
 771      * Called from process(). This method will display the correct javascript.
 772      */
 773     protected function _displayJavascript()
 774     {
 775         global $locale, $sugar_config, $timedate;
 776
 777
 778         if ($this->_getOption('show_javascript')) {
 779             if (!$this->_getOption('show_header')) {
 780                 $langHeader = get_language_header();
 781
 782                 echo <<<EOHTML
 783 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
 784 <html {$langHeader}>
 785 <head>
 786 EOHTML;
 787             }
 788
 789             $js_vars = array(
 790                 "sugar_cache_dir" => "cache/",
 791                 );
 792
 793             if(isset($this->bean->module_dir)){
 794                 $js_vars['module_sugar_grp1'] = $this->bean->module_dir;
 795             }
 796             if(isset($_REQUEST['action'])){
 797                 $js_vars['action_sugar_grp1'] = $_REQUEST['action'];
 798             }
 799             echo '<script>jscal_today = 1000*' . $timedate->asUserTs($timedate->getNow()) . '; if(typeof app_strings == "undefined") app_strings = new Array();</script>';
 800             if (!is_file(sugar_cached("include/javascript/sugar_grp1.js")) || !is_file(sugar_cached("include/javascript/sugar_grp1_yui.js")) || !is_file(sugar_cached("include/javascript/sugar_grp1_jquery.js"))) {
 801                 $_REQUEST['root_directory'] = ".";
 802                 require_once("jssource/minify_utils.php");
 803                 ConcatenateFiles(".");
 804             }
 805             echo getVersionedScript('cache/include/javascript/sugar_grp1_jquery.js');
 806             echo getVersionedScript('cache/include/javascript/sugar_grp1_yui.js');
 807             echo getVersionedScript('cache/include/javascript/sugar_grp1.js');
 808             echo getVersionedScript('include/javascript/calendar.js');
 809
 810             // output necessary config js in the top of the page
 811             $config_js = $this->getSugarConfigJS();
 812             if(!empty($config_js)){
 813                 echo "<script>\n".implode("\n", $config_js)."</script>\n";
 814             }
 815
 816             if ( isset($sugar_config['email_sugarclient_listviewmaxselect']) ) {
 817                 echo "<script>SUGAR.config.email_sugarclient_listviewmaxselect = {$GLOBALS['sugar_config']['email_sugarclient_listviewmaxselect']};</script>";
 818             }
 819
 820             $image_server = (defined('TEMPLATE_URL'))?TEMPLATE_URL . '/':'';
 821             echo '<script type="text/javascript">SUGAR.themes.image_server="' . $image_server . '";</script>'; // cn: bug 12274 - create session-stored key to defend against CSRF
 822             echo '<script type="text/javascript">var name_format = "' . $locale->getLocaleFormatMacro() . '";</script>';
 823             echo self::getJavascriptValidation();
 824             if (!is_file(sugar_cached('jsLanguage/') . $GLOBALS['current_language'] . '.js')) {
 825                 require_once ('include/language/jsLanguage.php');
 826                 jsLanguage::createAppStringsCache($GLOBALS['current_language']);
 827             }
 828             echo getVersionedScript('cache/jsLanguage/'. $GLOBALS['current_language'] . '.js', $GLOBALS['sugar_config']['js_lang_version']);
 829
 830                         echo $this->_getModLanguageJS();
 831
 832             if(isset( $sugar_config['disc_client']) && $sugar_config['disc_client'])
 833                 echo getVersionedScript('modules/Sync/headersync.js');
 834
 835
 836             //echo out the $js_vars variables as javascript variables
 837             echo "<script type='text/javascript'>\n";
 838             foreach($js_vars as $var=>$value)
 839             {
 840                 echo "var {$var} = '{$value}';\n";
 841             }
 842             echo "</script>\n";
 843         }
 844     }
 845
 846         protected function _getModLanguageJS(){
 847                 if (!is_file(sugar_cached('jsLanguage/') . $this->module . '/' . $GLOBALS['current_language'] . '.js')) {
 848                         require_once ('include/language/jsLanguage.php');
 849                         jsLanguage::createModuleStringsCache($this->module, $GLOBALS['current_language']);
 850                 }
 851                 return getVersionedScript("cache/jsLanguage/{$this->module}/". $GLOBALS['current_language'] . '.js', $GLOBALS['sugar_config']['js_lang_version']);
 852         }
 853
 854     /**
 855      * Called from process(). This method will display the footer on the page.
 856      */
 857     public function displayFooter()
 858     {
 859         if (empty($this->responseTime)) {
 860             $this->_calculateFooterMetrics();
 861         }
 862         global $sugar_config;
 863         global $app_strings;
 864         global $mod_strings;
 865                 $themeObject = SugarThemeRegistry::current();
 866         //decide whether or not to show themepicker, default is to show
 867         $showThemePicker = true;
 868         if (isset($sugar_config['showThemePicker'])) {
 869             $showThemePicker = $sugar_config['showThemePicker'];
 870         }
 871
 872         echo "<!-- crmprint -->";
 873         $jsalerts = new jsAlerts();
 874         if ( !isset($_SESSION['isMobile']) )
 875             echo $jsalerts->getScript();
 876
 877         $ss = new Sugar_Smarty();
 878         $ss->assign("AUTHENTICATED",isset($_SESSION["authenticated_user_id"]));
 879         $ss->assign('MOD',return_module_language($GLOBALS['current_language'], 'Users'));
 880
 881                 $bottomLinkList = array();
 882                  if (isset($this->action) && $this->action != "EditView") {
 883                          $bottomLinkList['print'] = array($app_strings['LNK_PRINT'] => getPrintLink());
 884                 }
 885                 $bottomLinkList['backtotop'] = array($app_strings['LNK_BACKTOTOP'] => 'javascript:SUGAR.util.top();');
 886
 887                 $bottomLinksStr = "";
 888                 foreach($bottomLinkList as $key => $value) {
 889                         foreach($value as $text => $link) {
 890                                    $href = $link;
 891                                    if(substr($link, 0, 11) == "javascript:") {
 892                        $onclick = " onclick=\"".substr($link,11)."\"";
 893                        $href = "javascript:void(0)";
 894                    } else {
 895                                 $onclick = "";
 896                         }
 897                 $imageURL = SugarThemeRegistry::current()->getImageURL($key.'.gif');
 898                                 $bottomLinksStr .= "<a href=\"{$href}\"";
 899                                 $bottomLinksStr .= (isset($onclick)) ? $onclick : "";
 900                                 $bottomLinksStr .= "><img src='{$imageURL}' alt=''>"; //keeping alt blank on purpose for 508 (text will be read instead)
 901                                 $bottomLinksStr .= " ".$text."</a>";
 902                         }
 903                 }
 904                 $ss->assign("BOTTOMLINKS",$bottomLinksStr);
 905         if (SugarConfig::getInstance()->get('calculate_response_time', false))
 906             $ss->assign('STATISTICS',$this->_getStatistics());
 907
 908         // Under the License referenced above, you are required to leave in all copyright statements in both
 909         // the code and end-user application.
 910
 911
 912         $copyright = '&copy; 2004-2012 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>';
 913
 914
 915
 916
 917
 918
 919
 920
 921
 922
 923
 924         // The interactive user interfaces in modified source and object code
 925         // versions of this program must display Appropriate Legal Notices, as
 926         // required under Section 5 of the GNU General Public License version
 927         // 3. In accordance with Section 7(b) of the GNU General Public License
 928         // version 3, these Appropriate Legal Notices must retain the display
 929         // of the "Powered by SugarCRM" logo. If the display of the logo is
 930         // not reasonably feasible for technical reasons, the Appropriate
 931         // Legal Notices must display the words "Powered by SugarCRM".
 932         $attribLinkImg = "<img style='margin-top: 2px' border='0' width='120' height='34' src='include/images/poweredby_sugarcrm_65.png' alt='Powered By SugarCRM'>\n";
 933
 934
 935                 // handle resizing of the company logo correctly on the fly
 936         $companyLogoURL = $themeObject->getImageURL('company_logo.png');
 937         $companyLogoURL_arr = explode('?', $companyLogoURL);
 938         $companyLogoURL = $companyLogoURL_arr[0];
 939
 940         $company_logo_attributes = sugar_cache_retrieve('company_logo_attributes');
 941         if(!empty($company_logo_attributes)) {
 942             $ss->assign("COMPANY_LOGO_MD5", $company_logo_attributes[0]);
 943             $ss->assign("COMPANY_LOGO_WIDTH", $company_logo_attributes[1]);
 944             $ss->assign("COMPANY_LOGO_HEIGHT", $company_logo_attributes[2]);
 945         }
 946         else {
 947             // Always need to md5 the file
 948             $ss->assign("COMPANY_LOGO_MD5", md5_file($companyLogoURL));
 949
 950             list($width,$height) = getimagesize($companyLogoURL);
 951             if ( $width > 212 || $height > 40 ) {
 952                 $resizePctWidth  = ($width - 212)/212;
 953                 $resizePctHeight = ($height - 40)/40;
 954                 if ( $resizePctWidth > $resizePctHeight )
 955                     $resizeAmount = $width / 212;
 956                 else
 957                     $resizeAmount = $height / 40;
 958                 $ss->assign("COMPANY_LOGO_WIDTH", round($width * (1/$resizeAmount)));
 959                 $ss->assign("COMPANY_LOGO_HEIGHT", round($height * (1/$resizeAmount)));
 960             }
 961             else {
 962                 $ss->assign("COMPANY_LOGO_WIDTH", $width);
 963                 $ss->assign("COMPANY_LOGO_HEIGHT", $height);
 964             }
 965
 966             // Let's cache the results
 967             sugar_cache_put('company_logo_attributes',
 968                             array(
 969                                 $ss->get_template_vars("COMPANY_LOGO_MD5"),
 970                                 $ss->get_template_vars("COMPANY_LOGO_WIDTH"),
 971                                 $ss->get_template_vars("COMPANY_LOGO_HEIGHT")
 972                                 )
 973             );
 974         }
 975         $ss->assign("COMPANY_LOGO_URL",getJSPath($companyLogoURL)."&logo_md5=".$ss->get_template_vars("COMPANY_LOGO_MD5"));
 976
 977         // Bug 38594 - Add in Trademark wording
 978         $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 />';
 979
 980         //rrs bug: 20923 - if this image does not exist as per the license, then the proper image will be displayed regardless, so no need
 981         //to display an empty image here.
 982         if(file_exists('include/images/poweredby_sugarcrm_65.png')){
 983             $copyright .= $attribLinkImg;
 984         }
 985         // End Required Image
 986         $ss->assign('COPYRIGHT',$copyright);
 987
 988         // here we allocate the help link data
 989         $help_actions_blacklist = array('Login'); // we don't want to show a context help link here
 990         if (!in_array($this->action,$help_actions_blacklist)) {
 991             $url = 'javascript:void(window.open(\'index.php?module=Administration&action=SupportPortal&view=documentation&version='.$GLOBALS['sugar_version'].'&edition='.$GLOBALS['sugar_flavor'].'&lang='.$GLOBALS['current_language'].
 992                         '&help_module='.$this->module.'&help_action='.$this->action.'&key='.$GLOBALS['server_unique_key'].'\'))';
 993             $label = (isset($GLOBALS['app_list_strings']['moduleList'][$this->module]) ?
 994                         $GLOBALS['app_list_strings']['moduleList'][$this->module] : $this->module). ' '.$app_strings['LNK_HELP'];
 995             $ss->assign('HELP_LINK',SugarThemeRegistry::current()->getLink($url, $label, "id='help_link_two'",
 996                 'help-dashlet.png', 'class="icon"',null,null,'','left'));
 997         }
 998         // end
 999
1000
1001         $ss->display(SugarThemeRegistry::current()->getTemplate('footer.tpl'));
1002     }
1003
1004     /**
1005      * Called from process(). This method will display subpanels.
1006      */
1007     protected function _displaySubPanels()
1008     {
1009         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'))) {
1010             $GLOBALS['focus'] = $this->bean;
1011             require_once ('include/SubPanel/SubPanelTiles.php');
1012             $subpanel = new SubPanelTiles($this->bean, $this->module);
1013             echo $subpanel->display();
1014         }
1015     }
1016
1017     protected function _buildModuleList()
1018     {
1019         if (!empty($GLOBALS['current_user']) && empty($GLOBALS['modListHeader']))
1020             $GLOBALS['modListHeader'] = query_module_access_list($GLOBALS['current_user']);
1021     }
1022
1023     /**
1024      * private method used in process() to determine the value of a passed in option
1025      *
1026      * @param string option - the option that we want to know the valye of
1027      * @param bool default - what the default value should be if we do not find the option
1028      *
1029      * @return bool - the value of the option
1030      */
1031     protected function _getOption(
1032         $option,
1033         $default = false
1034         )
1035     {
1036         if (!empty($this->options) && isset($this->options['show_all'])) {
1037             return $this->options['show_all'];
1038         } elseif (!empty($this->options) && isset($this->options[$option])) {
1039             return $this->options[$option];
1040         } else return $default;
1041     }
1042
1043     /**
1044      * track
1045      * Private function to track information about the view request
1046      */
1047     private function _track()
1048     {
1049         if (empty($this->responseTime)) {
1050             $this->_calculateFooterMetrics();
1051         }
1052         if (empty($GLOBALS['current_user']->id)) {
1053             return;
1054         }
1055
1056
1057         $trackerManager = TrackerManager::getInstance();
1058             $trackerManager->save();
1059
1060     }
1061
1062     /**
1063      * Checks to see if the module name passed is valid; dies if it is not
1064      */
1065     protected function _checkModule()
1066     {
1067         if(!empty($this->module) && !file_exists('modules/'.$this->module)){
1068             $error = str_replace("[module]", "$this->module", $GLOBALS['app_strings']['ERR_CANNOT_FIND_MODULE']);
1069             $GLOBALS['log']->fatal($error);
1070             echo $error;
1071             die();
1072         }
1073     }
1074
1075     public function renderJavascript()
1076     {
1077         if ($this->action !== 'Login')
1078             $this->_displayJavascript();
1079         else
1080             $this->_displayLoginJS();
1081     }
1082
1083     private function _calculateFooterMetrics()
1084     {
1085         $endTime = microtime(true);
1086         $deltaTime = $endTime - $GLOBALS['startTime'];
1087         $this->responseTime = number_format(round($deltaTime, 2), 2);
1088         // Print out the resources used in constructing the page.
1089         $this->fileResources = count(get_included_files());
1090     }
1091
1092     private function _getStatistics()
1093     {
1094         $endTime = microtime(true);
1095         $deltaTime = $endTime - $GLOBALS['startTime'];
1096         $response_time_string = $GLOBALS['app_strings']['LBL_SERVER_RESPONSE_TIME'] . ' ' . number_format(round($deltaTime, 2), 2) . ' ' . $GLOBALS['app_strings']['LBL_SERVER_RESPONSE_TIME_SECONDS'];
1097         $return = $response_time_string;
1098        // $return .= '<br />';
1099         if (!empty($GLOBALS['sugar_config']['show_page_resources'])) {
1100             // Print out the resources used in constructing the page.
1101             $included_files = get_included_files();
1102
1103             // take all of the included files and make a list that does not allow for duplicates based on case
1104             // I believe the full get_include_files result set appears to have one entry for each file in real
1105             // case, and one entry in all lower case.
1106             $list_of_files_case_insensitive = array();
1107             foreach($included_files as $key => $name) {
1108                 // preserve the first capitalization encountered.
1109                 $list_of_files_case_insensitive[mb_strtolower($name) ] = $name;
1110             }
1111             $return .= $GLOBALS['app_strings']['LBL_SERVER_RESPONSE_RESOURCES'] . '(' . DBManager::getQueryCount() . ',' . sizeof($list_of_files_case_insensitive) . ')<br>';
1112             // Display performance of the internal and external caches....
1113             $cacheStats = SugarCache::instance()->getCacheStats();
1114             $return .= "External cache (hits/total=ratio) local ({$cacheStats['localHits']}/{$cacheStats['requests']}=" . round($cacheStats['localHits']*100/$cacheStats['requests'], 0) . "%)";
1115             $return .= " external ({$cacheStats['externalHits']}/{$cacheStats['requests']}=" . round($cacheStats['externalHits']*100/$cacheStats['requests'], 0) . "%)<br />";
1116             $return .= " misses ({$cacheStats['misses']}/{$cacheStats['requests']}=" . round($cacheStats['misses']*100/$cacheStats['requests'], 0) . "%)<br />";
1117         }
1118
1119         $return .= $this->logMemoryStatistics();
1120
1121         return $return;
1122     }
1123
1124     /**
1125      * logMemoryStatistics
1126      *
1127      * This function returns a string message containing the memory statistics as well as writes to the memory_usage.log
1128      * file the memory statistics for the SugarView invocation.
1129      *
1130      * @param $newline String of newline character to use (defaults to </ br>)
1131      * @return $message String formatted message about memory statistics
1132      */
1133     protected function logMemoryStatistics($newline='<br>')
1134     {
1135         $log_message = '';
1136
1137         if(!empty($GLOBALS['sugar_config']['log_memory_usage']))
1138         {
1139             if(function_exists('memory_get_usage'))
1140             {
1141                 $memory_usage = memory_get_usage();
1142                 $bytes = $GLOBALS['app_strings']['LBL_SERVER_MEMORY_BYTES'];
1143                 $data = array($memory_usage, $bytes);
1144                 $log_message = string_format($GLOBALS['app_strings']['LBL_SERVER_MEMORY_USAGE'], $data) . $newline;
1145             }
1146
1147             if(function_exists('memory_get_peak_usage'))
1148             {
1149                 $memory_peak_usage = memory_get_peak_usage();
1150                 $bytes = $GLOBALS['app_strings']['LBL_SERVER_MEMORY_BYTES'];
1151                 $data = array($memory_peak_usage, $bytes);
1152                 $log_message .= string_format($GLOBALS['app_strings']['LBL_SERVER_PEAK_MEMORY_USAGE'], $data) . $newline;
1153             }
1154
1155             if(!empty($log_message))
1156             {
1157                 $data = array
1158                 (
1159                    !empty($this->module) ? $this->module : $GLOBALS['app_strings']['LBL_LINK_NONE'],
1160                    !empty($this->action) ? $this->action : $GLOBALS['app_strings']['LBL_LINK_NONE'],
1161                 );
1162
1163                 $output = string_format($GLOBALS['app_strings']['LBL_SERVER_MEMORY_LOG_MESSAGE'], $data) . $newline;
1164                 $output .= $log_message;
1165                 $fp = fopen("memory_usage.log", "ab");
1166                 fwrite($fp, $output);
1167                 fclose($fp);
1168             }
1169         }
1170
1171         return $log_message;
1172     }
1173
1174
1175     /**
1176      * Loads the module shortcuts menu
1177      *
1178      * @param  $module string optional, can specify module to retrieve menu for if not the current one
1179      * @return array module menu
1180      */
1181     public function getMenu(
1182         $module = null
1183         )
1184     {
1185         global $current_language, $current_user, $mod_strings, $app_strings, $module_menu;
1186
1187         if ( empty($module) )
1188             $module = $this->module;
1189
1190         //Need to make sure the mod_strings match the requested module or Menus may fail
1191         $curr_mod_strings = $mod_strings;
1192         $mod_strings = return_module_language ( $current_language, $module ) ;
1193
1194         $module_menu = array();
1195
1196         if (file_exists('modules/' . $module . '/Menu.php')) {
1197             require('modules/' . $module . '/Menu.php');
1198         }
1199         if (file_exists('custom/modules/' . $module . '/Ext/Menus/menu.ext.php')) {
1200             require('custom/modules/' . $module . '/Ext/Menus/menu.ext.php');
1201         }
1202         if (!file_exists('modules/' . $module . '/Menu.php')
1203                 && !file_exists('custom/modules/' . $module . '/Ext/Menus/menu.ext.php')
1204                 && !empty($GLOBALS['mod_strings']['LNK_NEW_RECORD'])) {
1205             $module_menu[] = array("index.php?module=$module&action=EditView&return_module=$module&return_action=DetailView",
1206                 $GLOBALS['mod_strings']['LNK_NEW_RECORD'],"{$GLOBALS['app_strings']['LBL_CREATE_BUTTON_LABEL']}$module" ,$module );
1207             $module_menu[] = array("index.php?module=$module&action=index", $GLOBALS['mod_strings']['LNK_LIST'],
1208                 $module, $module);
1209             if ( ($this->bean instanceOf SugarBean) && !empty($this->bean->importable) )
1210                 if ( !empty($mod_strings['LNK_IMPORT_'.strtoupper($module)]) )
1211                     $module_menu[] = array("index.php?module=Import&action=Step1&import_module=$module&return_module=$module&return_action=index",
1212                         $mod_strings['LNK_IMPORT_'.strtoupper($module)], "Import", $module);
1213                 else
1214                     $module_menu[] = array("index.php?module=Import&action=Step1&import_module=$module&return_module=$module&return_action=index",
1215                         $app_strings['LBL_IMPORT'], "Import", $module);
1216         }
1217         if (file_exists('custom/application/Ext/Menus/menu.ext.php')) {
1218             require('custom/application/Ext/Menus/menu.ext.php');
1219         }
1220
1221         $mod_strings = $curr_mod_strings;
1222         $builtModuleMenu = $module_menu;
1223         unset($module_menu);
1224
1225         return $builtModuleMenu;
1226     }
1227
1228     /**
1229     * Returns the module name which should be highlighted in the module menu
1230      */
1231     protected function _getModuleTab()
1232     {
1233         global $app_list_strings, $moduleTabMap, $current_user;
1234
1235                 $userTabs = query_module_access_list($current_user);
1236                 //If the home tab is in the user array use it as the default tab, otherwise use the first element in the tab array
1237                 $defaultTab = (in_array("Home",$userTabs)) ? "Home" : key($userTabs);
1238
1239         // Need to figure out what tab this module belongs to, most modules have their own tabs, but there are exceptions.
1240         if ( !empty($_REQUEST['module_tab']) )
1241             return $_REQUEST['module_tab'];
1242         elseif ( isset($moduleTabMap[$this->module]) )
1243             return $moduleTabMap[$this->module];
1244         // Special cases
1245         elseif ( $this->module == 'MergeRecords' )
1246             return !empty($_REQUEST['merge_module']) ? $_REQUEST['merge_module'] : $_REQUEST['return_module'];
1247         elseif ( $this->module == 'Users' && $this->action == 'SetTimezone' )
1248             return $defaultTab;
1249         // Default anonymous pages to be under Home
1250         elseif ( !isset($app_list_strings['moduleList'][$this->module]) )
1251             return $defaultTab;
1252         elseif ( isset($_REQUEST['action']) && $_REQUEST['action'] == "ajaxui" )
1253                 return $defaultTab;
1254         else
1255             return $this->module;
1256     }
1257
1258    /**
1259     * Return the "breadcrumbs" to display at the top of the page
1260     *
1261     * @param  bool $show_help optional, true if we show the help links
1262     * @return HTML string containing breadcrumb title
1263     */
1264     public function getModuleTitle(
1265         $show_help = true
1266         )
1267     {
1268         global $sugar_version, $sugar_flavor, $server_unique_key, $current_language, $action;
1269
1270         $theTitle = "<div class='moduleTitle'>\n";
1271
1272         $module = preg_replace("/ /","",$this->module);
1273
1274         $params = $this->_getModuleTitleParams();
1275         $index = 0;
1276
1277                 if(SugarThemeRegistry::current()->directionality == "rtl") {
1278                         $params = array_reverse($params);
1279                 }
1280                 if(count($params) > 1) {
1281                         array_shift($params);
1282                 }
1283                 $count = count($params);
1284         $paramString = '';
1285         foreach($params as $parm){
1286             $index++;
1287             $paramString .= $parm;
1288             if($index < $count){
1289                 $paramString .= $this->getBreadCrumbSymbol();
1290             }
1291         }
1292
1293         if(!empty($paramString)){
1294                $theTitle .= "<h2> $paramString </h2>\n";
1295            }
1296
1297
1298         // bug 56131 - restore conditional so that link doesn't appear where it shouldn't
1299         if($show_help) {
1300             $theTitle .= "<span class='utils'>";
1301             $createImageURL = SugarThemeRegistry::current()->getImageURL('create-record.gif');
1302             $url = ajaxLink("index.php?module=$module&action=EditView&return_module=$module&return_action=DetailView");
1303             $theTitle .= <<<EOHTML
1304 &nbsp;
1305 <a id="create_image" href="{$url}" class="utilsLink">
1306 <img src='{$createImageURL}' alt='{$GLOBALS['app_strings']['LNK_CREATE']}'></a>
1307 <a id="create_link" href="{$url}" class="utilsLink">
1308 {$GLOBALS['app_strings']['LNK_CREATE']}
1309 </a>
1310 EOHTML;
1311             $theTitle .= "</span>";
1312         }
1313
1314         $theTitle .= "<div class='clear'></div></div>\n";
1315         return $theTitle;
1316     }
1317
1318     /**
1319      * Return the metadata file that will be used by this view.
1320      *
1321      * @return string File location of the metadata file.
1322      */
1323     public function getMetaDataFile()
1324     {
1325         $metadataFile = null;
1326         $foundViewDefs = false;
1327         $viewDef = strtolower($this->type) . 'viewdefs';
1328         $coreMetaPath = 'modules/'.$this->module.'/metadata/' . $viewDef . '.php';
1329         if(file_exists('custom/' .$coreMetaPath )){
1330             $metadataFile = 'custom/' . $coreMetaPath;
1331             $foundViewDefs = true;
1332         }else{
1333             if(file_exists('custom/modules/'.$this->module.'/metadata/metafiles.php')){
1334                 require_once('custom/modules/'.$this->module.'/metadata/metafiles.php');
1335                 if(!empty($metafiles[$this->module][$viewDef])){
1336                     $metadataFile = $metafiles[$this->module][$viewDef];
1337                     $foundViewDefs = true;
1338                 }
1339             }elseif(file_exists('modules/'.$this->module.'/metadata/metafiles.php')){
1340                 require_once('modules/'.$this->module.'/metadata/metafiles.php');
1341                 if(!empty($metafiles[$this->module][$viewDef])){
1342                     $metadataFile = $metafiles[$this->module][$viewDef];
1343                     $foundViewDefs = true;
1344                 }
1345             }
1346         }
1347
1348         if(!$foundViewDefs && file_exists($coreMetaPath)){
1349                 $metadataFile = $coreMetaPath;
1350         }
1351         $GLOBALS['log']->debug("metadatafile=". $metadataFile);
1352
1353         return $metadataFile;
1354     }
1355
1356
1357     /**
1358      * Returns an array composing of the breadcrumbs to use for the module title
1359      *
1360      * @param bool $browserTitle true if the returned string is being used for the browser title, meaning
1361      *                           there should be no HTML in the string
1362      * @return array
1363      */
1364     protected function _getModuleTitleParams($browserTitle = false)
1365     {
1366         $params = array($this->_getModuleTitleListParam($browserTitle));
1367                 //$params = array();
1368         if (isset($this->action)){
1369             switch ($this->action) {
1370             case 'EditView':
1371                 if(!empty($this->bean->id) && (empty($_REQUEST['isDuplicate']) || $_REQUEST['isDuplicate'] === 'false')) {
1372                     $params[] = "<a href='index.php?module={$this->module}&action=DetailView&record={$this->bean->id}'>".$this->bean->get_summary_text()."</a>";
1373                     $params[] = $GLOBALS['app_strings']['LBL_EDIT_BUTTON_LABEL'];
1374                 }
1375                 else
1376                     $params[] = $GLOBALS['app_strings']['LBL_CREATE_BUTTON_LABEL'];
1377                 break;
1378             case 'DetailView':
1379                 $beanName = $this->bean->get_summary_text();
1380                 $params[] = $beanName;
1381                 break;
1382             }
1383         }
1384
1385         return $params;
1386     }
1387
1388     /**
1389      * Returns the portion of the array that will represent the listview in the breadcrumb
1390      *
1391      * @param bool $browserTitle true if the returned string is being used for the browser title, meaning
1392      *                           there should be no HTML in the string
1393      * @return string
1394      */
1395     protected function _getModuleTitleListParam( $browserTitle = false )
1396     {
1397         global $current_user;
1398         global $app_strings;
1399
1400         if(!empty($GLOBALS['app_list_strings']['moduleList'][$this->module]))
1401                 $firstParam = $GLOBALS['app_list_strings']['moduleList'][$this->module];
1402         else
1403                 $firstParam = $this->module;
1404
1405         $iconPath = $this->getModuleTitleIconPath($this->module);
1406         if($this->action == "ListView" || $this->action == "index") {
1407             if (!empty($iconPath) && !$browserTitle) {
1408                 if (SugarThemeRegistry::current()->directionality == "ltr") {
1409                         return $app_strings['LBL_SEARCH']."&nbsp;"
1410                                  . "$firstParam";
1411
1412                 } else {
1413                                         return "$firstParam"
1414                                              . "&nbsp;".$app_strings['LBL_SEARCH'];
1415                 }
1416                         } else {
1417                                 return $firstParam;
1418                         }
1419         }
1420         else {
1421                     if (!empty($iconPath) && !$browserTitle) {
1422                                 //return "<a href='index.php?module={$this->module}&action=index'>$this->module</a>";
1423                         } else {
1424                                 return $firstParam;
1425                         }
1426         }
1427     }
1428
1429     protected function getModuleTitleIconPath($module)
1430     {
1431         $iconPath = "";
1432         if(is_file(SugarThemeRegistry::current()->getImageURL('icon_'.$module.'_32.png',false))) {
1433                 $iconPath = SugarThemeRegistry::current()->getImageURL('icon_'.$module.'_32.png');
1434         }
1435         else if (is_file(SugarThemeRegistry::current()->getImageURL('icon_'.ucfirst($module).'_32.png',false))) {
1436                 $iconPath = SugarThemeRegistry::current()->getImageURL('icon_'.ucfirst($module).'_32.png');
1437         }
1438         return $iconPath;
1439     }
1440
1441     /**
1442      * Returns the string which will be shown in the browser's title; defaults to using the same breadcrumb
1443      * as in the module title
1444      *
1445      * @return string
1446      */
1447     public function getBrowserTitle()
1448     {
1449         global $app_strings;
1450
1451         $browserTitle = $app_strings['LBL_BROWSER_TITLE'];
1452         if ( $this->module == 'Users' && ($this->action == 'SetTimezone' || $this->action == 'Login') )
1453             return $browserTitle;
1454         $params = $this->_getModuleTitleParams(true);
1455         foreach ($params as $value )
1456             $browserTitle = strip_tags($value) . ' &raquo; ' . $browserTitle;
1457
1458         return $browserTitle;
1459     }
1460
1461     /**
1462      * Returns the correct breadcrumb symbol according to theme's directionality setting
1463      *
1464      * @return string
1465      */
1466     public function getBreadCrumbSymbol()
1467     {
1468         if(SugarThemeRegistry::current()->directionality == "ltr") {
1469                 return "<span class='pointer'>&raquo;</span>";
1470         }
1471         else {
1472                 return "<span class='pointer'>&laquo;</span>";
1473         }
1474     }
1475
1476     /**
1477      * Fetch config values to be put into an array for JavaScript
1478      *
1479      * @return array
1480      */
1481     protected function getSugarConfigJS(){
1482         global $sugar_config;
1483
1484         // Set all the config parameters in the JS config as necessary
1485         $config_js = array();
1486         // AjaxUI stock banned modules
1487         $config_js[] = "SUGAR.config.stockAjaxBannedModules = ".json_encode(ajaxBannedModules()).";";
1488         if ( isset($sugar_config['quicksearch_querydelay']) ) {
1489             $config_js[] = $this->prepareConfigVarForJs('quicksearch_querydelay', $sugar_config['quicksearch_querydelay']);
1490         }
1491         if ( empty($sugar_config['disableAjaxUI']) ) {
1492             $config_js[] = "SUGAR.config.disableAjaxUI = false;";
1493         }
1494         else{
1495             $config_js[] = "SUGAR.config.disableAjaxUI = true;";
1496         }
1497         if ( !empty($sugar_config['addAjaxBannedModules']) ){
1498             $config_js[] = $this->prepareConfigVarForJs('addAjaxBannedModules', $sugar_config['addAjaxBannedModules']);
1499         }
1500         if ( !empty($sugar_config['overrideAjaxBannedModules']) ){
1501             $config_js[] = $this->prepareConfigVarForJs('overrideAjaxBannedModules', $sugar_config['overrideAjaxBannedModules']);
1502         }
1503         if (!empty($sugar_config['js_available']) && is_array ($sugar_config['js_available']))
1504         {
1505             foreach ($sugar_config['js_available'] as $configKey)
1506             {
1507                 if (isset($sugar_config[$configKey]))
1508                 {
1509                     $jsVariableStatement = $this->prepareConfigVarForJs($configKey, $sugar_config[$configKey]);
1510                     if (!array_search($jsVariableStatement, $config_js))
1511                     {
1512                         $config_js[] = $jsVariableStatement;
1513                     }
1514                 }
1515             }
1516         }
1517
1518         return $config_js;
1519     }
1520
1521     /**
1522      * Utility method to convert sugar_config values into a JS acceptable format.
1523      *
1524      * @param string $key       Config Variable Name
1525      * @param string $value     Config Variable Value
1526      * @return string
1527      */
1528     protected function prepareConfigVarForJs($key, $value)
1529     {
1530         $value = json_encode($value);
1531         return "SUGAR.config.{$key} = {$value};";
1532     }
1533
1534     /**
1535      * getHelpText
1536      *
1537      * This is a protected function that returns the help text portion.  It is called from getModuleTitle.
1538      *
1539      * @param $module String the formatted module name
1540      * @return $theTitle String the HTML for the help text
1541      */
1542     protected function getHelpText($module)
1543     {
1544         $createImageURL = SugarThemeRegistry::current()->getImageURL('create-record.gif');
1545         $url = ajaxLink("index.php?module=$module&action=EditView&return_module=$module&return_action=DetailView");
1546         $theTitle = <<<EOHTML
1547 &nbsp;
1548 <img src='{$createImageURL}' alt='{$GLOBALS['app_strings']['LNK_CREATE']}'>
1549 <a href="{$url}" class="utilsLink">
1550 {$GLOBALS['app_strings']['LNK_CREATE']}
1551 </a>
1552 EOHTML;
1553         return $theTitle;
1554     }
1555
1556     /**
1557      * Retrieves favicon corresponding to currently requested module
1558      *
1559      * @return array
1560      */
1561     protected function getFavicon()
1562     {
1563         // get favicon
1564         if(isset($GLOBALS['sugar_config']['default_module_favicon']))
1565             $module_favicon = $GLOBALS['sugar_config']['default_module_favicon'];
1566         else
1567             $module_favicon = false;
1568
1569         $themeObject = SugarThemeRegistry::current();
1570
1571         $favicon = '';
1572         if ( $module_favicon )
1573             $favicon = $themeObject->getImageURL($this->module.'.gif',false);
1574         if ( !sugar_is_file($favicon) || !$module_favicon )
1575             $favicon = $themeObject->getImageURL('sugar_icon.ico',false);
1576
1577         $extension = pathinfo($favicon, PATHINFO_EXTENSION);
1578         switch ($extension)
1579         {
1580             case 'png':
1581                 $type = 'image/png';
1582                 break;
1583             case 'ico':
1584                 // fall through
1585             default:
1586                 $type = 'image/x-icon';
1587                 break;
1588         }
1589
1590         return array(
1591             'url'  => getJSPath($favicon),
1592             'type' => $type,
1593         );
1594     }
1595
1596
1597     /**
1598      * getCustomFilePathIfExists
1599      *
1600      * This function wraps a call to get_custom_file_if_exists from include/utils.php
1601      *
1602      * @param $file String of filename to check
1603      * @return $file String of filename including custom directory if found
1604      */
1605     protected function getCustomFilePathIfExists($file)
1606     {
1607         return get_custom_file_if_exists($file);
1608     }
1609
1610
1611     /**
1612      * fetchTemplate
1613      *
1614      * This function wraps the call to the fetch function of the Smarty variable for the view
1615      *
1616      * @param $file String path of the file to fetch
1617      * @return $content String content from resulting Smarty fetch operation on template
1618      */
1619     protected function fetchTemplate($file)
1620     {
1621         return $this->ss->fetch($file);
1622     }
1623
1624     /**
1625          * Determines whether the state of the post global array indicates there was an error uploading a
1626      * file that exceeds the post_max_size setting.  Such an error can be detected if:
1627      *  1. The Server['REQUEST_METHOD'] will still point to POST
1628      *  2. POST and FILES global arrays will be returned empty despite the request method
1629      * This also results in a redirect to the home page (due to lack of module and action in POST)
1630      *
1631          * @return boolean indicating true or false
1632          */
1633     public function checkPostMaxSizeError(){
1634          //if the referrer is post, and the post array is empty, then an error has occurred, most likely
1635          //while uploading a file that exceeds the post_max_size.
1636          if(empty($_FILES) && empty($_POST) && isset($_SERVER['REQUEST_METHOD']) && strtolower($_SERVER['REQUEST_METHOD']) == 'post'){
1637              $GLOBALS['log']->fatal($GLOBALS['app_strings']['UPLOAD_ERROR_HOME_TEXT']);
1638              return true;
1639         }
1640         return false;
1641     }
1642
1643
1644 }