typo3/classes/class.modulemenu.php

   1 <?php
   2 /***************************************************************
   3 *  Copyright notice
   4 *
   5 *  (c) 2007 Ingo Renner <ingo@typo3.org>
   6 *  All rights reserved
   7 *
   8 *  This script is part of the TYPO3 project. The TYPO3 project is
   9 *  free software; you can redistribute it and/or modify
  10 *  it under the terms of the GNU General Public License as published by
  11 *  the Free Software Foundation; either version 2 of the License, or
  12 *  (at your option) any later version.
  13 *
  14 *  The GNU General Public License can be found at
  15 *  http://www.gnu.org/copyleft/gpl.html.
  16 *  A copy is found in the textfile GPL.txt and important notices to the license
  17 *  from the author is found in LICENSE.txt distributed with these scripts.
  18 *
  19 *
  20 *  This script is distributed in the hope that it will be useful,
  21 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  22 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  23 *  GNU General Public License for more details.
  24 *
  25 *  This copyright notice MUST APPEAR in all copies of the script!
  26 ***************************************************************/
  27
  28
  29 /**
  30  * class to render the TYPO3 backend menu for the modules
  31  *
  32  * @author      Ingo Renner <ingo@typo3.org>
  33  * @package TYPO3
  34  * @subpackage core
  35  */
  36 class ModuleMenu {
  37
  38         /**
  39          * module loading object
  40          *
  41          * @var t3lib_loadModules
  42          */
  43         protected $moduleLoader;
  44
  45         private $backPath;
  46         private $linkModules;
  47         private $loadedModules;
  48         private $fsMod; //TODO find a more descriptive name, left over from alt_menu_functions
  49
  50         /**
  51          * constructor, initializes several variables
  52          *
  53          * @return      void
  54          */
  55         public function __construct() {
  56
  57                 $this->backPath    = '';
  58                 $this->fsMod       = array();
  59                 $this->linkModules = true;
  60
  61                         // Loads the backend modules available for the logged in user.
  62                 $this->moduleLoader = t3lib_div::makeInstance('t3lib_loadModules');
  63                 $this->moduleLoader->observeWorkspaces = true;
  64                 $this->moduleLoader->load($GLOBALS['TBE_MODULES']);
  65                 $this->loadedModules = $this->moduleLoader->modules;
  66
  67         }
  68
  69         /**
  70          * sets the path back to /typo3/
  71          *
  72          * @param       string  path back to /typo3/
  73          * @return      void
  74          */
  75         public function setBackPath($backPath) {
  76                 if(!is_string($backPath)) {
  77                         throw new InvalidArgumentException('parameter $backPath must be of type string', 1193315266);
  78                 }
  79
  80                 $this->backPath = $backPath;
  81         }
  82
  83         /**
  84          * loads the collapse states for the main modules from user's configuration (uc)
  85          *
  86          * @return      array           collapse states
  87          */
  88         private function getCollapsedStates() {
  89
  90                 $collapsedStates = array();
  91                 if($GLOBALS['BE_USER']->uc['moduleData']['moduleMenu']) {
  92                         $collapsedStates = $GLOBALS['BE_USER']->uc['moduleData']['moduleMenu'];
  93                 }
  94
  95                 return $collapsedStates;
  96         }
  97
  98         /**
  99          * returns the loaded modules
 100          *
 101          * @return      array   array of loaded modules
 102          */
 103         public function getLoadedModules() {
 104                 return $this->loadedModules;
 105         }
 106
 107         /**
 108          * renders the backend menu as unordered list
 109          *
 110          * @return      string          menu html code to use in the backend
 111          */
 112         public function render() {
 113                 $menu    = '';
 114                 $onBlur  = $GLOBALS['CLIENT']['FORMSTYLE'] ? 'this.blur();' : '';
 115
 116                 $rawModuleData = $this->getRawModuleData();
 117
 118                 foreach($rawModuleData as $moduleKey => $moduleData) {
 119
 120                         $moduleLabel = $moduleData['title'];
 121                         if($moduleData['link'] && $this->linkModules) {
 122                                 $moduleLabel = '<a href="#" onclick="top.goToModule(\''.$moduleData['name'].'\');'.$onBlur.'return false;">'.$moduleLabel.'</a>';
 123                         }
 124
 125                         $menu .= '<li><div>'.$moduleData['icon']['html'].' '.$moduleLabel.'</div>';
 126
 127                                 // traverse submodules
 128                         if(is_array($moduleData['subitems'])) {
 129                                 $menu .= $this->renderSubModules($moduleData['subitems']);
 130                         }
 131
 132                         $menu .= '</li>'."\n";
 133                 }
 134
 135                 return '<ul id="typo3-menu">'."\n".$menu.'</ul>'."\n";
 136         }
 137
 138         /**
 139          * renders submodules
 140          *
 141          * @param       array           array of (sub)module data
 142          * @return      string          (sub)module html code
 143          */
 144         public function renderSubModules($modules) {
 145                 $moduleMenu = '';
 146                 $onBlur     = $GLOBALS['CLIENT']['FORMSTYLE'] ? 'this.blur();' : '';
 147
 148                 foreach($modules as $moduleKey => $moduleData) {
 149                                 // Setting additional JavaScript
 150                         $additionalJavascript = '';
 151                         if($moduleData['parentNavigationFrameScript']) {
 152                                 $parentModuleName     = substr($moduleData['name'], 0, strpos($moduleData['name'], '_'));
 153                                 $additionalJavascript = "+'&id='+top.rawurlencode(top.fsMod.recentIds['".$parentModuleName."'])";
 154                         }
 155
 156                         if($moduleData['link'] && $this->linkModules) {
 157
 158                                 $onClickString = htmlspecialchars('top.goToModule(\''.$moduleData['name'].'\');'.$onBlur.'return false;');
 159                                 $submoduleLink = '<a href="#" onclick="'.$onClickString.'" title="'.$moduleData['description'].'">'
 160                                         .$moduleData['icon']['html'].' '
 161                                         .'<span>'.htmlspecialchars($moduleData['title']).'</span>'
 162                                         .'</a>';
 163                         }
 164
 165                         $moduleMenu .= '<li>'.$submoduleLink.'</li>'."\n";
 166                 }
 167
 168                 return '<ul>'."\n".$moduleMenu.'</ul>'."\n";
 169         }
 170
 171         /**
 172          * gets the raw module data
 173          *
 174          * @return      array           multi dimension array with module data
 175          */
 176         public function getRawModuleData() {
 177                 $modules = array();
 178
 179                         // Remove the 'doc' module?
 180                 if($GLOBALS['BE_USER']->getTSConfigVal('options.disableDocModuleInAB')) {
 181                         unset($this->loadedModules['doc']);
 182                 }
 183
 184                 foreach($this->loadedModules as $moduleName => $moduleData) {
 185                         $moduleNavigationFramePrefix = $this->getNavigationFramePrefix($moduleData);
 186
 187                         if($moduleNavigationFramePrefix) {
 188                                 $this->fsMod[$moduleName] = 'fsMod.recentIds["'.$moduleName.'"]="";';
 189                         }
 190
 191                         $moduleLink = '';
 192                         if(!is_array($moduleData['sub'])) {
 193                                 $moduleLink = $moduleData['script'];
 194                         }
 195                         $moduleLink = t3lib_div::resolveBackPath($moduleLink);
 196
 197                         $moduleKey   = $moduleName.'_tab';
 198                         $moduleCssId = 'ID_'.t3lib_div::md5int($moduleName);
 199                         $moduleIcon  = $this->getModuleIcon($moduleKey);
 200
 201                         if($moduleLink && $moduleNavigationFramePrefix) {
 202                                 $moduleLink = $moduleNavigationFramePrefix.rawurlencode($moduleLink);
 203                         }
 204
 205                         $modules[$moduleKey] = array(
 206                                 'name'    => $moduleName,
 207                                 'title'   => $GLOBALS['LANG']->moduleLabels['tabs'][$moduleKey],
 208                                 'onclick' => 'top.goToModule(\''.$moduleName.'\');',
 209                                 'cssId'   => $moduleCssId,
 210                                 'icon'    => $moduleIcon,
 211                                 'link'    => $moduleLink,
 212                                 'prefix'  => $moduleNavigationFramePrefix
 213                         );
 214
 215                         if(is_array($moduleData['sub'])) {
 216
 217                                 foreach($moduleData['sub'] as $submoduleName => $submoduleData) {
 218                                         $submoduleLink = t3lib_div::resolveBackPath($submoduleData['script']);
 219                                         $submoduleNavigationFramePrefix = $this->getNavigationFramePrefix($moduleData, $submoduleData);
 220
 221                                         $submoduleKey         = $moduleName.'_'.$submoduleName.'_tab';
 222                                         $submoduleCssId       = 'ID_'.t3lib_div::md5int($moduleName.'_'.$submoduleName);
 223                                         $submoduleIcon        = $this->getModuleIcon($submoduleKey);
 224                                         $submoduleDescription = $GLOBALS['LANG']->moduleLabels['labels'][$submoduleKey.'label'];
 225
 226                                         $originalLink = $submoduleLink;
 227                                         if($submoduleLink && $submoduleNavigationFramePrefix) {
 228                                                 $submoduleLink = $submoduleNavigationFramePrefix.rawurlencode($submoduleLink);
 229                                         }
 230
 231                                         $modules[$moduleKey]['subitems'][$submoduleKey] = array(
 232                                                 'name'         => $moduleName.'_'.$submoduleName,
 233                                                 'title'        => $GLOBALS['LANG']->moduleLabels['tabs'][$submoduleKey],
 234                                                 'onclick'      => 'top.goToModule(\''.$moduleName.'_'.$submoduleName.'\');',
 235                                                 'cssId'        => $submoduleCssId,
 236                                                 'icon'         => $submoduleIcon,
 237                                                 'link'         => $submoduleLink,
 238                                                 'originalLink' => $originalLink,
 239                                                 'prefix'       => $submoduleNavigationFramePrefix,
 240                                                 'description'  => $submoduleDescription
 241                                         );
 242
 243                                         if($moduleData['navFrameScript']) {
 244                                                 $modules[$moduleKey]['subitems'][$submoduleKey]['parentNavigationFrameScript'] = $moduleData['navFrameScript'];
 245                                         }
 246                                 }
 247                         }
 248                 }
 249
 250                 return $modules;
 251         }
 252
 253         /**
 254          * gets the module icon and its size
 255          *
 256          * @param       string          module key
 257          * @return      array           icon data array with 'filename', 'size', and 'html'
 258          */
 259         private function getModuleIcon($moduleKey) {
 260                 $icon             = array();
 261                 $iconFileRelative = $this->getModuleIconRelative($GLOBALS['LANG']->moduleLabels['tabs_images'][$moduleKey]);
 262                 $iconFileAbsolute = $this->getModuleIconAbsolute($GLOBALS['LANG']->moduleLabels['tabs_images'][$moduleKey]);
 263                 $iconSizes        = @getimagesize($iconFileAbsolute);
 264                 $iconTitle        = $GLOBALS['LANG']->moduleLabels['tabs'][$moduleKey];
 265
 266                 $icon['filename'] = $iconFileRelative;
 267                 $icon['size']     = $iconSizes[3];
 268                 $icon['title']    = htmlspecialchars($iconTitle);
 269                 $icon['html']     = '<img src="'.$iconFileRelative.'" '.$iconSizes[3].' title="'.htmlspecialchars($iconTitle).'" alt="'.htmlspecialchars($iconTitle).'" />';
 270
 271                 return $icon;
 272         }
 273
 274         /**
 275          * Returns the filename readable for the script from PATH_typo3.
 276          * That means absolute names are just returned while relative names are
 277          * prepended with the path pointing back to typo3/ dir
 278          *
 279          * @param       string          icon filename
 280          * @return      string          icon filename with absolute path
 281          * @see getModuleIconRelative()
 282          */
 283         private function getModuleIconAbsolute($iconFilename) {
 284
 285                 if(!t3lib_div::isAbsPath($iconFilename))        {
 286                         $iconFilename = $this->backPath.$iconFilename;
 287                 }
 288
 289                 return $iconFilename;
 290         }
 291
 292         /**
 293          * Returns relative path to the icon filename for use in img-tags
 294          *
 295          * @param       string          icon filename
 296          * @return      string          icon filename with relative path
 297          * @see getModuleIconAbsolute()
 298          */
 299         private function getModuleIconRelative($iconFilename) {
 300                 if(t3lib_div::isAbsPath($iconFilename)) {
 301                         $iconFilename = '../'.substr($iconFilename, strlen(PATH_site));
 302                 }
 303
 304                 return $this->backPath.$iconFilename;
 305         }
 306
 307         /**
 308          * Returns a prefix used to call the navigation frame with parameters which then will call the scripts defined in the modules info array.
 309          *
 310          * @param       array           module data array
 311          * @param       array           submodule data array
 312          * @return      string          result URL string
 313          */
 314         private function getNavigationFramePrefix($moduleData, $subModuleData = array()) {
 315                 $prefix = '';
 316
 317                 $navigationFrameScript = $moduleData['navFrameScript'];
 318                 if($subModuleData['navFrameScript']) {
 319                         $navigationFrameScript = $subModuleData['navFrameScript'];
 320                 }
 321
 322                 $navigationFrameParameter = $moduleData['navFrameScriptParam'];
 323                 if($subModuleData['navFrameScriptParam']) {
 324                         $navigationFrameParameter = $subModuleData['navFrameScriptParam'];
 325                 }
 326
 327                 if($navigationFrameScript) {
 328                         $navigationFrameScript = t3lib_div::resolveBackPath($navigationFrameScript);
 329                         $navigationFrameScript = $this->appendQuestionmarkToLink($navigationFrameScript);
 330
 331                         if($GLOBALS['BE_USER']->uc['condensedMode']) {
 332                                 $prefix = $navigationFrameScript.$navigationFrameParameter.'&currentSubScript=';
 333                         } else {
 334                                 $prefix = 'alt_mod_frameset.php?'
 335                                                  .'fW="+top.TS.navFrameWidth+"'
 336                                                  .'&nav="+top.TS.PATH_typo3+"'
 337                                                  .rawurlencode($navigationFrameScript.$navigationFrameParameter)
 338                                                  .'&script=';
 339                         }
 340                 }
 341
 342                 return $prefix;
 343         }
 344
 345         /**
 346          * generates javascript code to switch between modules
 347          *
 348          * @return      string          javascript code snippet to switch modules
 349          */
 350         public function getGotoModuleJavascript() {
 351
 352                 $moduleJavascriptCommands = array();
 353                 $rawModuleData            = $this->getRawModuleData();
 354
 355                 foreach($rawModuleData as $mainModuleKey => $mainModuleData) {
 356                         if($mainModuleData['subitems']) {
 357                                 foreach($mainModuleData['subitems'] as $subModuleKey => $subModuleData) {
 358
 359                                         $parentModuleName  = substr($subModuleData['name'], 0, strpos($subModuleData['name'], '_'));
 360                                         $javascriptCommand = '';
 361
 362                                                 // Setting additional JavaScript if frameset script:
 363                                         $additionalJavascript = '';
 364                                         if($subModuleData['parentNavigationFrameScript']) {
 365                                                 $additionalJavascript = "+'&id='+top.rawurlencode(top.fsMod.recentIds['".$parentModuleName."'])";
 366                                         }
 367
 368                                         if($subModuleData['link'] && $this->linkModules) {
 369                                                         // For condensed mode, send &cMR parameter to frameset script.
 370                                                 if($additionalJavascript && $GLOBALS['BE_USER']->uc['condensedMode']) {
 371                                                         $additionalJavascript .= "+(cMR?'&cMR=1':'')";
 372                                                 }
 373
 374                                                 $javascriptCommand = '
 375                                                         top.content.location=top.getModuleUrl(top.TS.PATH_typo3+"'.$this->appendQuestionmarkToLink($subModuleData['link']).'"'.$additionalJavascript.'+additionalGetVariables);
 376                                                         top.fsMod.currentMainLoaded="'.$parentModuleName.'";
 377                                                 ';
 378
 379                                                 if($subModuleData['navFrameScript']) {
 380                                                         $javascriptCommand .= '
 381                                                                 top.currentSubScript="'.$subModuleData['originalLink'].'";';
 382                                                 }
 383
 384                                                 if(!$GLOBALS['BE_USER']->uc['condensedMode'] && $subModuleData['parentNavigationFrameScript']) {
 385                                                         $additionalJavascript = "+'&id='+top.rawurlencode(top.fsMod.recentIds['".$parentModuleName."'])";
 386
 387                                                         $submoduleNavigationFrameScript = $subModuleData['navigationFrameScript'] ? $subModuleData['navigationFrameScript'] : $subModuleData['parentNavigationFrameScript'];
 388                                                         $submoduleNavigationFrameScript = t3lib_div::resolveBackPath($submoduleNavigationFrameScript);
 389
 390                                                                 // add GET parameters for sub module to the navigation script
 391                                                         $submoduleNavigationFrameScript = $this->appendQuestionmarkToLink($submoduleNavigationFrameScript).$subModuleData['navigationFrameScript'];
 392
 393                                                         $javascriptCommand = '
 394                                                                 if (top.content.list_frame && top.fsMod.currentMainLoaded=="'.$parentModuleName.'") {
 395                                                                         top.currentSubScript="'.$subModuleData['originalLink'].'";
 396                                                                         top.content.list_frame.location=top.getModuleUrl(top.TS.PATH_typo3+"'.$this->appendQuestionmarkToLink($subModuleData['originalLink']).'"'.$additionalJavascript.'+additionalGetVariables);
 397                                                                         if(top.currentSubNavScript!="'.$submoduleNavigationFrameScript.'") {
 398                                                                                 top.currentSubNavScript="'.$submoduleNavigationFrameScript.'";
 399                                                                                 top.content.nav_frame.location=top.getModuleUrl(top.TS.PATH_typo3+"'.$submoduleNavigationFrameScript.'");
 400                                                                         }
 401                                                                 } else {
 402                                                                         top.content.location=top.TS.PATH_typo3+(
 403                                                                                 top.nextLoadModuleUrl?
 404                                                                                 "'.($subModuleData['prefix'] ? $this->appendQuestionmarkToLink($subModuleData['link']).'&exScript=' : '').'listframe_loader.php":
 405                                                                                 "'.$this->appendQuestionmarkToLink($subModuleData['link']).'"'.$additionalJavascript.'+additionalGetVariables
 406                                                                         );
 407                                                                         top.fsMod.currentMainLoaded="'.$parentModuleName.'";
 408                                                                         top.currentSubScript="'.$subModuleData['originalLink'].'";
 409                                                                 }
 410                                                         ';
 411                                                 }
 412
 413                                                 $javascriptCommand .= '
 414                                                                 top.highlightModuleMenuItem("'.$subModuleData['cssId'].'");
 415                                                 ';
 416                                                 $moduleJavascriptCommands[] = "case '".$subModuleData['name']."': \n ".$javascriptCommand." \n break;";
 417                                         }
 418                                 }
 419                         } elseif(!$mainModuleData['subitems'] && !empty($mainModuleData['link'])) {
 420                                 // main module has no sub modules but instead is linked itself (doc module)
 421                                 $javascriptCommand = '
 422                                         top.content.location=top.getModuleUrl(top.TS.PATH_typo3+"'.$this->appendQuestionmarkToLink($mainModuleData['link']).'"+additionalGetVariables);
 423                                         top.highlightModuleMenuItem("'.$mainModuleData['cssId'].'", 1);
 424                                 ';
 425                                 $moduleJavascriptCommands[] = "case '".$mainModuleData['name']."': \n ".$javascriptCommand." \n break;";
 426                         }
 427                 }
 428
 429                 $javascriptCode = '
 430         /**
 431          * Function used to switch switch module.
 432          */
 433         var currentModuleLoaded = "";
 434         function goToModule(modName,cMR_flag,addGetVars)        {       //
 435                 var additionalGetVariables = "";
 436                 if (addGetVars) additionalGetVariables = addGetVars;
 437
 438                 var cMR = 0;
 439                 if (cMR_flag)   cMR = 1;
 440
 441                 currentModuleLoaded = modName;
 442
 443                 switch(modName) {'
 444                         ."\n".implode("\n", $moduleJavascriptCommands)."\n".'
 445                 }
 446         }';
 447
 448                 return $javascriptCode;
 449         }
 450
 451         /**
 452          * Appends a '?' if there is none in the string already
 453          *
 454          * @param       string          Link URL
 455          * @return      string          link URl appended with ? if there wasn't one
 456          */
 457         private function appendQuestionmarkToLink($link)        {
 458                 if(!strstr($link, '?')) {
 459                         $link .= '?';
 460                 }
 461
 462                 return $link;
 463         }
 464
 465         /**
 466          * renders the logout button form
 467          *
 468          * @return      string          html code snippet displaying the logout button
 469          */
 470         public function renderLogoutButton()    {
 471                 $buttonLabel      = $GLOBALS['BE_USER']->user['ses_backuserid'] ? 'LLL:EXT:lang/locallang_core.php:buttons.exit' : 'LLL:EXT:lang/locallang_core.php:buttons.logout';
 472
 473                 $buttonForm = '
 474                 <form action="logout.php" target="_top">
 475                         <input type="submit" value="'.$GLOBALS['LANG']->sL($buttonLabel, 1).'" />
 476                 </form>';
 477
 478                 return $buttonForm;
 479         }
 480
 481         /**
 482          * turns linking of modules on or off
 483          *
 484          * @param       boolean         status for linking modules with a-tags, set to false to turn lining off
 485          */
 486         public function setLinkModules($linkModules) {
 487                 if(!is_bool($linkModules)) {
 488                         throw new InvalidArgumentException('parameter $linkModules must be of type bool', 1193326558);
 489                 }
 490
 491                 $this->linkModules = $linkModules;
 492         }
 493
 494         /**
 495          * gets the frameset (leftover) helper
 496          *
 497          * @return      array   array of javascript snippets
 498          */
 499         public function getFsMod() {
 500                 return $this->fsMod;
 501         }
 502 }
 503
 504
 505 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['typo3/classes/class.modulemenu.php'])      {
 506         include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['typo3/classes/class.modulemenu.php']);
 507 }
 508
 509 ?>