typo3/template.php

   1 <?php
   2 /***************************************************************
   3 *  Copyright notice
   4 *
   5 *  (c) 1999-2010 Kasper Skårhøj (kasperYYYY@typo3.com)
   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  * Contains class with layout/output function for TYPO3 Backend Scripts
  29  *
  30  * $Id$
  31  * Revised for TYPO3 3.6 2/2003 by Kasper Skårhøj
  32  * XHTML-trans compliant
  33  *
  34  * @author      Kasper Skårhøj <kasperYYYY@typo3.com>
  35  */
  36 /**
  37  * [CLASS/FUNCTION INDEX of SCRIPT]
  38  *
  39  *  145: function fw($str)
  40  *
  41  *
  42  *  169: class template
  43  *  224:     function template()
  44  *
  45  *              SECTION: EVALUATION FUNCTIONS
  46  *  298:     function wrapClickMenuOnIcon($str,$table,$uid='',$listFr=1,$addParams='',$enDisItems='', $returnOnClick=FALSE)
  47  *  315:     function viewPageIcon($id,$backPath,$addParams='hspace="3"')
  48  *  341:     function issueCommand($params,$rUrl='')
  49  *  356:     function isCMlayers()
  50  *  366:     function thisBlur()
  51  *  376:     function helpStyle()
  52  *  393:     function getHeader($table,$row,$path,$noViewPageIcon=0,$tWrap=array('',''))
  53  *  419:     function getFileheader($title,$path,$iconfile)
  54  *  434:     function makeShortcutIcon($gvList,$setList,$modName,$motherModName="")
  55  *  467:     function makeShortcutUrl($gvList,$setList)
  56  *  488:     function formWidth($size=48,$textarea=0,$styleOverride='')
  57  *  513:     function formWidthText($size=48,$styleOverride='',$wrap='')
  58  *  530:     function redirectUrls($thisLocation='')
  59  *  554:     function formatTime($tstamp,$type)
  60  *  571:     function parseTime()
  61  *
  62  *              SECTION: PAGE BUILDING FUNCTIONS.
  63  *  604:     function startPage($title)
  64  *  686:     function endPage()
  65  *  720:     function header($text)
  66  *  741:     function section($label,$text,$nostrtoupper=FALSE,$sH=FALSE,$type=0,$allowHTMLinHeader=FALSE)
  67  *  765:     function divider($dist)
  68  *  781:     function spacer($dist)
  69  *  800:     function sectionHeader($label,$sH=FALSE,$addAttrib='')
  70  *  817:     function sectionBegin()
  71  *  838:     function sectionEnd()
  72  *  858:     function middle()
  73  *  867:     function endPageJS()
  74  *  884:     function docBodyTagBegin()
  75  *  894:     function docStyle()
  76  *  936:     function insertStylesAndJS($content)
  77  *  956:     function initCharset()
  78  *  968:     function generator()
  79  *
  80  *              SECTION: OTHER ELEMENTS
  81  * 1001:     function icons($type, $styleAttribValue='')
  82  * 1030:     function t3Button($onClick,$label)
  83  * 1041:     function dfw($string)
  84  * 1051:     function rfw($string)
  85  * 1061:     function wrapInCData($string)
  86  * 1078:     function wrapScriptTags($string, $linebreak=TRUE)
  87  * 1117:     function table($arr, $layout='')
  88  * 1159:     function menuTable($arr1,$arr2=array(), $arr3=array())
  89  * 1192:     function funcMenu($content,$menu)
  90  * 1210:     function clearCacheMenu($id,$addSaveOptions=0)
  91  * 1246:     function getContextMenuCode()
  92  * 1251:     function showClickmenu(table, uid, listFr, enDisItems, backPath, addParams)
  93  * 1280:     function showClickmenu_noajax(url)
  94  * 1287:     function showClickmenu_ajax(t3ajax)
  95  * 1472:     function getDragDropCode($table)
  96  * 1483:     function cancelDragEvent(event)
  97  * 1496:     function mouseMoveEvent (event)
  98  * 1509:     function dragElement(id,elementID)
  99  * 1528:     function dropElement(id)
 100  * 1577:     function getTabMenu($mainParams,$elementName,$currentValue,$menuItems,$script='',$addparams='')
 101  * 1607:     function getTabMenuRaw($menuItems)
 102  * 1676:     function getDynTabMenu($menuItems,$identString,$toggle=0,$foldout=FALSE,$newRowCharLimit=50,$noWrap=1,$fullWidth=FALSE,$defaultTabIndex=1)
 103  * 1801:     function getDynTabMenuJScode()
 104  * 1892:     function getVersionSelector($id,$noAction=FALSE)
 105  *
 106  *
 107  * 2060: class bigDoc extends template
 108  *
 109  *
 110  * 2069: class noDoc extends template
 111  *
 112  *
 113  * 2078: class smallDoc extends template
 114  *
 115  *
 116  * 2087: class mediumDoc extends template
 117  *
 118  * TOTAL FUNCTIONS: 57
 119  * (This index is automatically created/updated by the extension "extdeveval")
 120  *
 121  */
 122
 123
 124
 125 if (!defined('TYPO3_MODE'))     die("Can't include this file directly.");
 126
 127
 128 /**
 129  * Deprecated fontwrap function. Is just transparent now.
 130  *
 131  * @param       string          Input string
 132  * @return      string          Output string (in the old days this was wrapped in <font> tags)
 133  * @deprecated since TYPO3 3.6, will be removed in TYPO3 4.6
 134  */
 135 function fw($str) {
 136         t3lib_div::logDeprecatedFunction();
 137         return $str;
 138 }
 139
 140
 141 /**
 142  * TYPO3 Backend Template Class
 143  *
 144  * This class contains functions for starting and ending the HTML of backend modules
 145  * It also contains methods for outputting sections of content.
 146  * Further there are functions for making icons, links, setting form-field widths etc.
 147  * Color scheme and stylesheet definitions are also available here.
 148  * Finally this file includes the language class for TYPO3's backend.
 149  *
 150  * After this file $LANG and $TBE_TEMPLATE are global variables / instances of their respective classes.
 151  * This file is typically included right after the init.php file,
 152  * if language and layout is needed.
 153  *
 154  * Please refer to Inside TYPO3 for a discussion of how to use this API.
 155  *
 156  * @author      Kasper Skårhøj <kasperYYYY@typo3.com>
 157  * @package TYPO3
 158  * @subpackage core
 159  */
 160 class template {
 161
 162                 // Vars you typically might want to/should set from outside after making instance of this class:
 163         var $backPath = '';                             // 'backPath' pointing back to the PATH_typo3
 164         var $form='';                                   // This can be set to the HTML-code for a formtag. Useful when you need a form to span the whole page; Inserted exactly after the body-tag.
 165         var $JScodeLibArray = array();          // Similar to $JScode (see below) but used as an associative array to prevent double inclusion of JS code. This is used to include certain external Javascript libraries before the inline JS code. <script>-Tags are not wrapped around automatically
 166         var $JScode='';                                 // Additional header code (eg. a JavaScript section) could be accommulated in this var. It will be directly outputted in the header.
 167         var $extJScode = '';                            // Additional header code for ExtJS. It will be included in document header and inserted in a Ext.onReady(function()
 168         var $JScodeArray = array();             // Similar to $JScode but for use as array with associative keys to prevent double inclusion of JS code. a <script> tag is automatically wrapped around.
 169         var $postCode='';                               // Additional 'page-end' code could be accommulated in this var. It will be outputted at the end of page before </body> and some other internal page-end code.
 170         var $docType = '';                              // Doc-type used in the header. Default is xhtml_trans. You can also set it to 'html_3', 'xhtml_strict' or 'xhtml_frames'.
 171         var $moduleTemplate = '';               // HTML template with markers for module
 172         protected $moduleTemplateFilename = ''; // the base file (not overlaid by TBE_STYLES) for the current module, useful for hooks when finding out which modules is rendered currently
 173
 174                 // Other vars you can change, but less frequently used:
 175         var $scriptID='';                               // Script ID.
 176         var $bodyTagId='';                              // Id which can be set for the body tag. Default value is based on script ID
 177         var $bodyTagAdditions='';               // You can add additional attributes to the body-tag through this variable.
 178         var $inDocStyles='';                    // Additional CSS styles which will be added to the <style> section in the header
 179         var $inDocStylesArray=array();          // Like $inDocStyles but for use as array with associative keys to prevent double inclusion of css code
 180         var $form_rowsToStylewidth = 9.58;      // Multiplication factor for formWidth() input size (default is 48* this value).
 181         var $form_largeComp = 1.33;             // Compensation for large documents (used in class.t3lib_tceforms.php)
 182         var $endJS=1;                                   // If set, then a JavaScript section will be outputted in the bottom of page which will try and update the top.busy session expiry object.
 183
 184                 // TYPO3 Colorscheme.
 185                 // If you want to change this, please do so through a skin using the global var $TBE_STYLES
 186         var $bgColor = '#F7F3EF';               // Light background color
 187         var $bgColor2 = '#9BA1A8';              // Steel-blue
 188         var $bgColor3 = '#F6F2E6';              // dok.color
 189         var $bgColor4 = '#D9D5C9';              // light tablerow background, brownish
 190         var $bgColor5 = '#ABBBB4';              // light tablerow background, greenish
 191         var $bgColor6 = '#E7DBA8';              // light tablerow background, yellowish, for section headers. Light.
 192         var $hoverColor = '#254D7B';
 193         var $styleSheetFile = '';       // Filename of stylesheet (relative to PATH_typo3)
 194         var $styleSheetFile2 = '';              // Filename of stylesheet #2 - linked to right after the $this->styleSheetFile script (relative to PATH_typo3)
 195         var $styleSheetFile_post = '';  // Filename of a post-stylesheet - included right after all inline styles.
 196         var $backGroundImage = '';              // Background image of page (relative to PATH_typo3)
 197         var $inDocStyles_TBEstyle = ''; // Inline css styling set from TBE_STYLES array
 198
 199         /**
 200          * Whether to use the X-UA-Compatible meta tag
 201          * @var boolean
 202          */
 203         protected $useCompatibilityTag = TRUE;
 204
 205                 // Skinning
 206                 // stylesheets from core
 207         protected $stylesheetsCore = array(
 208                 'structure' => 'stylesheets/structure/',
 209                 'visual' => 'stylesheets/visual/',
 210                 'generatedSprites' => '../typo3temp/sprites/',
 211         );
 212
 213                 // include these CSS directories from skins by default
 214         protected $stylesheetsSkins = array(
 215                 'structure' => 'stylesheets/structure/',
 216                 'visual' => 'stylesheets/visual/',
 217         );
 218
 219                 // DEV:
 220         var $parseTimeFlag = 0;                 // Will output the parsetime of the scripts in milliseconds (for admin-users). Set this to false when releasing TYPO3. Only for dev.
 221
 222                 // INTERNAL
 223         var $charset = 'iso-8859-1';    // Default charset. see function initCharset()
 224
 225         var $sectionFlag=0;                             // Internal: Indicates if a <div>-output section is open
 226         var $divClass = '';                             // (Default) Class for wrapping <DIV>-tag of page. Is set in class extensions.
 227
 228         var $pageHeaderBlock = '';
 229         var $endOfPageJsBlock = '';
 230
 231         var $hasDocheader = true;
 232
 233         /**
 234          * @var t3lib_PageRenderer
 235          */
 236         protected $pageRenderer;
 237         protected $pageHeaderFooterTemplateFile = '';   // alternative template file
 238
 239         /**
 240          * Whether flashmessages should be rendered or not
 241          *
 242          * @var $showFlashMessages
 243          */
 244         public $showFlashMessages = TRUE;
 245
 246         /**
 247          * Constructor
 248          * Imports relevant parts from global $TBE_STYLES (colorscheme)
 249          *
 250          * @return      void
 251          */
 252         function template()     {
 253                 global $TBE_STYLES;
 254
 255                         // Initializes the page rendering object:
 256                 $this->getPageRenderer();
 257
 258                         // Setting default scriptID:
 259                 if (($temp_M = (string) t3lib_div::_GET('M')) && $GLOBALS['TBE_MODULES']['_PATHS'][$temp_M]) {
 260                         $this->scriptID = preg_replace('/^.*\/(sysext|ext)\//', 'ext/', $GLOBALS['TBE_MODULES']['_PATHS'][$temp_M] . 'index.php');
 261                 } else {
 262                         $this->scriptID = preg_replace('/^.*\/(sysext|ext)\//', 'ext/', substr(PATH_thisScript, strlen(PATH_site)));
 263                 }
 264                 if (TYPO3_mainDir!='typo3/' && substr($this->scriptID,0,strlen(TYPO3_mainDir)) == TYPO3_mainDir)        {
 265                         $this->scriptID = 'typo3/'.substr($this->scriptID,strlen(TYPO3_mainDir));       // This fixes if TYPO3_mainDir has been changed so the script ids are STILL "typo3/..."
 266                 }
 267
 268                 $this->bodyTagId = preg_replace('/[^A-Za-z0-9-]/','-',$this->scriptID);
 269
 270                         // Individual configuration per script? If so, make a recursive merge of the arrays:
 271                 if (is_array($TBE_STYLES['scriptIDindex'][$this->scriptID]))    {
 272                         $ovr = $TBE_STYLES['scriptIDindex'][$this->scriptID];           // Make copy
 273                         $TBE_STYLES = t3lib_div::array_merge_recursive_overrule($TBE_STYLES,$ovr);              // merge styles.
 274                         unset($TBE_STYLES['scriptIDindex'][$this->scriptID]);   // Have to unset - otherwise the second instantiation will do it again!
 275                 }
 276
 277                         // Color scheme:
 278                 if ($TBE_STYLES['mainColors']['bgColor'])       $this->bgColor=$TBE_STYLES['mainColors']['bgColor'];
 279                 if ($TBE_STYLES['mainColors']['bgColor1'])      $this->bgColor1=$TBE_STYLES['mainColors']['bgColor1'];
 280                 if ($TBE_STYLES['mainColors']['bgColor2'])      $this->bgColor2=$TBE_STYLES['mainColors']['bgColor2'];
 281                 if ($TBE_STYLES['mainColors']['bgColor3'])      $this->bgColor3=$TBE_STYLES['mainColors']['bgColor3'];
 282                 if ($TBE_STYLES['mainColors']['bgColor4'])      $this->bgColor4=$TBE_STYLES['mainColors']['bgColor4'];
 283                 if ($TBE_STYLES['mainColors']['bgColor5'])      $this->bgColor5=$TBE_STYLES['mainColors']['bgColor5'];
 284                 if ($TBE_STYLES['mainColors']['bgColor6'])      $this->bgColor6=$TBE_STYLES['mainColors']['bgColor6'];
 285                 if ($TBE_STYLES['mainColors']['hoverColor'])    $this->hoverColor=$TBE_STYLES['mainColors']['hoverColor'];
 286
 287                         // Main Stylesheets:
 288                 if ($TBE_STYLES['stylesheet'])  $this->styleSheetFile = $TBE_STYLES['stylesheet'];
 289                 if ($TBE_STYLES['stylesheet2']) $this->styleSheetFile2 = $TBE_STYLES['stylesheet2'];
 290                 if ($TBE_STYLES['styleSheetFile_post']) $this->styleSheetFile_post = $TBE_STYLES['styleSheetFile_post'];
 291                 if ($TBE_STYLES['inDocStyles_TBEstyle'])        $this->inDocStyles_TBEstyle = $TBE_STYLES['inDocStyles_TBEstyle'];
 292
 293                         // include all stylesheets
 294                 foreach ($this->getSkinStylesheetDirectories() as $stylesheetDirectory) {
 295                         $this->addStylesheetDirectory($stylesheetDirectory);
 296                 }
 297
 298                         // Background image
 299                 if ($TBE_STYLES['background'])  $this->backGroundImage = $TBE_STYLES['background'];
 300         }
 301
 302
 303         /**
 304          * Gets instance of PageRenderer
 305          *
 306          * @return      t3lib_PageRenderer
 307          */
 308         public function getPageRenderer() {
 309                 if (!isset($this->pageRenderer)) {
 310                         $this->pageRenderer = t3lib_div::makeInstance('t3lib_PageRenderer');
 311                         $this->pageRenderer->setTemplateFile(
 312                                 TYPO3_mainDir . 'templates/template_page_backend.html'
 313                         );
 314                         $this->pageRenderer->setLanguage($GLOBALS['LANG']->lang);
 315                         $this->pageRenderer->enableConcatenateFiles();
 316                         $this->pageRenderer->enableCompressCss();
 317                         $this->pageRenderer->enableCompressJavascript();
 318                 }
 319                 if (intval($GLOBALS['TYPO3_CONF_VARS']['BE']['debug']) === 1) {
 320                         $this->pageRenderer->enableDebugMode();
 321                 }
 322                 return $this->pageRenderer;
 323         }
 324
 325
 326
 327
 328
 329
 330
 331
 332
 333
 334
 335
 336
 337         /*****************************************
 338          *
 339          * EVALUATION FUNCTIONS
 340          * Various centralized processing
 341          *
 342          *****************************************/
 343
 344         /**
 345          * Makes click menu link (context sensitive menu)
 346          * Returns $str (possibly an <|img> tag/icon) wrapped in a link which will activate the context sensitive menu for the record ($table/$uid) or file ($table = file)
 347          * The link will load the top frame with the parameter "&item" which is the table,uid and listFr arguments imploded by "|": rawurlencode($table.'|'.$uid.'|'.$listFr)
 348          *
 349          * @param       string          String to be wrapped in link, typ. image tag.
 350          * @param       string          Table name/File path. If the icon is for a database record, enter the tablename from $TCA. If a file then enter the absolute filepath
 351          * @param       integer         If icon is for database record this is the UID for the record from $table
 352          * @param       boolean         Tells the top frame script that the link is coming from a "list" frame which means a frame from within the backend content frame.
 353          * @param       string          Additional GET parameters for the link to alt_clickmenu.php
 354          * @param       string          Enable / Disable click menu items. Example: "+new,view" will display ONLY these two items (and any spacers in between), "new,view" will display all BUT these two items.
 355          * @param       boolean         If set, will return only the onclick JavaScript, not the whole link.
 356          * @return      string          The link-wrapped input string.
 357          */
 358         function wrapClickMenuOnIcon($str,$table,$uid='',$listFr=1,$addParams='',$enDisItems='', $returnOnClick=FALSE)  {
 359                 $backPath = rawurlencode($this->backPath).'|'.t3lib_div::shortMD5($this->backPath.'|'.$GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey']);
 360                 $onClick = 'showClickmenu("'.$table.'","'.$uid.'","'.$listFr.'","'.str_replace('+','%2B',$enDisItems).'","'.str_replace('&','&amp;',addcslashes($backPath,'"')).'","'.str_replace('&','&amp;',addcslashes($addParams,'"')).'");return false;';
 361                 return $returnOnClick ? $onClick : '<a href="#" onclick="'.htmlspecialchars($onClick).'"'.($GLOBALS['TYPO3_CONF_VARS']['BE']['useOnContextMenuHandler'] ? ' oncontextmenu="'.htmlspecialchars($onClick).'"' : '').'>'.$str.'</a>';
 362         }
 363
 364         /**
 365          * Makes link to page $id in frontend (view page)
 366          * Returns an magnifier-glass icon which links to the frontend index.php document for viewing the page with id $id
 367          * $id must be a page-uid
 368          * If the BE_USER has access to Web>List then a link to that module is shown as well (with return-url)
 369          *
 370          * @param       integer         The page id
 371          * @param       string          The current "BACK_PATH" (the back relative to the typo3/ directory)
 372          * @param       string          Additional parameters for the image tag(s)
 373          * @return      string          HTML string with linked icon(s)
 374          */
 375         function viewPageIcon($id,$backPath,$addParams='hspace="3"')    {
 376                 global $BE_USER;
 377                 $str = '';
 378                         // If access to Web>List for user, then link to that module.
 379                 $str .= t3lib_extMgm::createListViewLink(
 380                         $id,
 381                         '&returnUrl=' . rawurlencode(t3lib_div::getIndpEnv('REQUEST_URI')),
 382                         $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.showList', TRUE)
 383                 );
 384
 385                         // Make link to view page
 386                 $str.= '<a href="#" onclick="'.htmlspecialchars(t3lib_BEfunc::viewOnClick($id,$backPath,t3lib_BEfunc::BEgetRootLine($id))).'">'.
 387                                 '<img'.t3lib_iconWorks::skinImg($backPath,'gfx/zoom.gif','width="12" height="12"').' title="'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.showPage',1).'"'.($addParams?' '.trim($addParams):"").' hspace="3" alt="" />'.
 388                                 '</a>';
 389                 return $str;
 390         }
 391
 392         /**
 393          * Returns a URL with a command to TYPO3 Core Engine (tce_db.php)
 394          * See description of the API elsewhere.
 395          *
 396          * @param       string          $params is a set of GET params to send to tce_db.php. Example: "&cmd[tt_content][123][move]=456" or "&data[tt_content][123][hidden]=1&data[tt_content][123][title]=Hello%20World"
 397          * @param       string          Redirect URL if any other that t3lib_div::getIndpEnv('REQUEST_URI') is wished
 398          * @return      string          URL to tce_db.php + parameters (backpath is taken from $this->backPath)
 399          * @see t3lib_BEfunc::editOnClick()
 400          */
 401         function issueCommand($params,$rUrl='') {
 402                 $rUrl = $rUrl ? $rUrl : t3lib_div::getIndpEnv('REQUEST_URI');
 403                 return $this->backPath.'tce_db.php?'.
 404                                 $params.
 405                                 '&redirect='.($rUrl==-1?"'+T3_THIS_LOCATION+'":rawurlencode($rUrl)).
 406                                 '&vC='.rawurlencode($GLOBALS['BE_USER']->veriCode()).
 407                                 '&prErr=1&uPT=1';
 408         }
 409
 410         /**
 411          * Returns true if click-menu layers can be displayed for the current user/browser
 412          * Use this to test if click-menus (context sensitive menus) can and should be displayed in the backend.
 413          *
 414          * @return      boolean
 415          */
 416         function isCMlayers()   {
 417                 return !$GLOBALS['BE_USER']->uc['disableCMlayers'] && $GLOBALS['CLIENT']['FORMSTYLE'] && !($GLOBALS['CLIENT']['SYSTEM']=='mac' && $GLOBALS['CLIENT']['BROWSER']=='Opera');
 418         }
 419
 420         /**
 421          * Returns 'this.blur();' if the client supports CSS styles
 422          * Use this in links to remove the underlining after being clicked
 423          *
 424          * @return      string
 425          * @deprecated since TYPO3 4.5, will be removed in TYPO3 4.7
 426          */
 427         function thisBlur()     {
 428                 t3lib_div::logDeprecatedFunction();
 429                 return ($GLOBALS['CLIENT']['FORMSTYLE']?'this.blur();':'');
 430         }
 431
 432         /**
 433          * Returns ' style='cursor:help;'' if the client supports CSS styles
 434          * Use for <a>-links to help texts
 435          *
 436          * @return      string
 437          * @deprecated since TYPO3 4.5, will be removed in TYPO3 4.7
 438          */
 439         function helpStyle()    {
 440                 t3lib_div::logDeprecatedFunction();
 441                 return $GLOBALS['CLIENT']['FORMSTYLE'] ? ' style="cursor:help;"':'';
 442         }
 443
 444         /**
 445          * Makes the header (icon+title) for a page (or other record). Used in most modules under Web>*
 446          * $table and $row must be a tablename/record from that table
 447          * $path will be shown as alt-text for the icon.
 448          * The title will be truncated to 45 chars.
 449          *
 450          * @param       string          Table name
 451          * @param       array           Record row
 452          * @param       string          Alt text
 453          * @param       boolean         Set $noViewPageIcon true if you don't want a magnifier-icon for viewing the page in the frontend
 454          * @param       array           $tWrap is an array with indexes 0 and 1 each representing HTML-tags (start/end) which will wrap the title
 455          * @return      string          HTML content
 456          */
 457         function getHeader($table,$row,$path,$noViewPageIcon=0,$tWrap=array('',''))     {
 458                 global $TCA;
 459                 if (is_array($row) && $row['uid'])      {
 460                         $iconImgTag=t3lib_iconWorks::getSpriteIconForRecord($table, $row , array('title' => htmlspecialchars($path)));
 461                         $title= strip_tags($row[$TCA[$table]['ctrl']['label']]);
 462                         $viewPage = $noViewPageIcon ? '' : $this->viewPageIcon($row['uid'],$this->backPath,'');
 463                         if ($table=='pages')    $path.=' - '.t3lib_BEfunc::titleAttribForPages($row,'',0);
 464                 } else {
 465                         $iconImgTag = t3lib_iconWorks::getSpriteIcon('apps-pagetree-page-domain', array('title' => htmlspecialchars($path)));
 466                         $title=$GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'];
 467                 }
 468
 469                 return '<span class="typo3-moduleHeader">'.$this->wrapClickMenuOnIcon($iconImgTag,$table,$row['uid']).
 470                                 $viewPage.
 471                                 $tWrap[0].htmlspecialchars(t3lib_div::fixed_lgd_cs($title,45)).$tWrap[1].'</span>';
 472         }
 473
 474         /**
 475          * Like ->getHeader() but for files in the File>* main module/submodules
 476          * Returns the file-icon with the path of the file set in the alt/title attribute. Shows the file-name after the icon.
 477          *
 478          * @param       string          Title string, expected to be the filepath
 479          * @param       string          Alt text
 480          * @param       string          The icon file (relative to TYPO3 dir)
 481          * @return      string          HTML content
 482          */
 483         function getFileheader($title,$path,$iconfile)  {
 484                 $fileInfo = t3lib_div::split_fileref($title);
 485                 $title = htmlspecialchars(t3lib_div::fixed_lgd_cs($fileInfo['path'],-35)).'<strong>'.htmlspecialchars($fileInfo['file']).'</strong>';
 486                 return '<span class="typo3-moduleHeader"><img'.t3lib_iconWorks::skinImg($this->backPath,$iconfile,'width="18" height="16"').' title="'.htmlspecialchars($path).'" alt="" />'.$title.'</span>';
 487         }
 488
 489         /**
 490          * Returns a linked shortcut-icon which will call the shortcut frame and set a shortcut there back to the calling page/module
 491          *
 492          * @param       string          Is the list of GET variables to store (if any)
 493          * @param       string          Is the list of SET[] variables to store (if any) - SET[] variables a stored in $GLOBALS["SOBE"]->MOD_SETTINGS for backend modules
 494          * @param       string          Module name string
 495          * @param       string          Is used to enter the "parent module name" if the module is a submodule under eg. Web>* or File>*. You can also set this value to "1" in which case the currentLoadedModule is sent to the shortcut script (so - not a fixed value!) - that is used in file_edit.php and wizard_rte.php scripts where those scripts are really running as a part of another module.
 496          * @return      string          HTML content
 497          */
 498         function makeShortcutIcon($gvList,$setList,$modName,$motherModName="")  {
 499                 $backPath=$this->backPath;
 500                 $storeUrl=$this->makeShortcutUrl($gvList,$setList);
 501                 $pathInfo = parse_url(t3lib_div::getIndpEnv('REQUEST_URI'));
 502
 503                         // Add the module identifier automatically if typo3/mod.php is used:
 504                 if (preg_match('/typo3\/mod\.php$/', $pathInfo['path']) && isset($GLOBALS['TBE_MODULES']['_PATHS'][$modName])) {
 505                         $storeUrl = '&M='.$modName.$storeUrl;
 506                 }
 507
 508                 if (!strcmp($motherModName,'1'))        {
 509                         $mMN="&motherModName='+top.currentModuleLoaded+'";
 510                 } elseif ($motherModName)       {
 511                         $mMN='&motherModName='.rawurlencode($motherModName);
 512                 } else $mMN='';
 513
 514                 $onClick = 'top.ShortcutManager.createShortcut('
 515                         .$GLOBALS['LANG']->JScharCode($GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.makeShortcut')).', '
 516                         .'\''.$backPath.'\', '
 517                         .'\''.rawurlencode($modName).'\', '
 518                         .'\''.rawurlencode($pathInfo['path']."?".$storeUrl).$mMN.'\''
 519                 .');return false;';
 520
 521                 $sIcon = '<a href="#" onclick="' . htmlspecialchars($onClick).'" title="' . $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.makeShortcut', TRUE) . '">'
 522                         . t3lib_iconworks::getSpriteIcon('actions-system-shortcut-new') . '</a>';
 523                 return $sIcon;
 524         }
 525
 526         /**
 527          * MAKE url for storing
 528          * Internal func
 529          *
 530          * @param       string          Is the list of GET variables to store (if any)
 531          * @param       string          Is the list of SET[] variables to store (if any) - SET[] variables a stored in $GLOBALS["SOBE"]->MOD_SETTINGS for backend modules
 532          * @return      string
 533          * @access private
 534          * @see makeShortcutIcon()
 535          */
 536         function makeShortcutUrl($gvList,$setList)      {
 537                 $GET = t3lib_div::_GET();
 538                 $storeArray = array_merge(
 539                         t3lib_div::compileSelectedGetVarsFromArray($gvList,$GET),
 540                         array('SET'=>t3lib_div::compileSelectedGetVarsFromArray($setList, (array)$GLOBALS['SOBE']->MOD_SETTINGS))
 541                 );
 542                 $storeUrl = t3lib_div::implodeArrayForUrl('',$storeArray);
 543                 return $storeUrl;
 544         }
 545
 546         /**
 547          * Returns <input> attributes to set the width of an text-type input field.
 548          * For client browsers with no CSS support the cols/size attribute is returned.
 549          * For CSS compliant browsers (recommended) a ' style="width: ...px;"' is returned.
 550          *
 551          * @param       integer         A relative number which multiplied with approx. 10 will lead to the width in pixels
 552          * @param       boolean         A flag you can set for textareas - DEPRECATED, use ->formWidthText() for textareas!!!
 553          * @param       string          A string which will be returned as attribute-value for style="" instead of the calculated width (if CSS is enabled)
 554          * @return      string          Tag attributes for an <input> tag (regarding width)
 555          * @see formWidthText()
 556          */
 557         function formWidth($size=48,$textarea=0,$styleOverride='') {
 558                 $wAttrib = $textarea?'cols':'size';
 559                 if (!$GLOBALS['CLIENT']['FORMSTYLE'])   {       // If not setting the width by style-attribute
 560                         $size = $size;
 561                         $retVal = ' '.$wAttrib.'="'.$size.'"';
 562                 } else {        // Setting width by style-attribute. 'cols' MUST be avoided with NN6+
 563                         $pixels = ceil($size*$this->form_rowsToStylewidth);
 564                         $retVal = $styleOverride ? ' style="'.$styleOverride.'"' : ' style="width:'.$pixels.'px;"';
 565                 }
 566                 return $retVal;
 567         }
 568
 569         /**
 570          * This function is dedicated to textareas, which has the wrapping on/off option to observe.
 571          * EXAMPLE:
 572          *              <textarea rows="10" wrap="off" '.$GLOBALS["TBE_TEMPLATE"]->formWidthText(48,"","off").'>
 573          *   or
 574          *              <textarea rows="10" wrap="virtual" '.$GLOBALS["TBE_TEMPLATE"]->formWidthText(48,"","virtual").'>
 575          *
 576          * @param       integer         A relative number which multiplied with approx. 10 will lead to the width in pixels
 577          * @param       string          A string which will be returned as attribute-value for style="" instead of the calculated width (if CSS is enabled)
 578          * @param       string          Pass on the wrap-attribute value you use in your <textarea>! This will be used to make sure that some browsers will detect wrapping alright.
 579          * @return      string          Tag attributes for an <input> tag (regarding width)
 580          * @see formWidth()
 581          */
 582         function formWidthText($size=48,$styleOverride='',$wrap='') {
 583                 $wTags = $this->formWidth($size,1,$styleOverride);
 584                         // Netscape 6+/Mozilla seems to have this ODD problem where there WILL ALWAYS be wrapping with the cols-attribute set and NEVER without the col-attribute...
 585                 if (strtolower(trim($wrap))!='off' && $GLOBALS['CLIENT']['BROWSER']=='net' && $GLOBALS['CLIENT']['VERSION']>=5) {
 586                         $wTags.=' cols="'.$size.'"';
 587                 }
 588                 return $wTags;
 589         }
 590
 591         /**
 592          * Returns JavaScript variables setting the returnUrl and thisScript location for use by JavaScript on the page.
 593          * Used in fx. db_list.php (Web>List)
 594          *
 595          * @param       string          URL to "this location" / current script
 596          * @return      string
 597          * @see typo3/db_list.php
 598          */
 599         function redirectUrls($thisLocation='') {
 600                 $thisLocation = $thisLocation?$thisLocation:t3lib_div::linkThisScript(
 601                 array(
 602                         'CB'=>'',
 603                         'SET'=>'',
 604                         'cmd' => '',
 605                         'popViewId'=>''
 606                 ));
 607
 608                 $out ="
 609         var T3_RETURN_URL = '".str_replace('%20','',rawurlencode(t3lib_div::sanitizeLocalUrl(t3lib_div::_GP('returnUrl'))))."';
 610         var T3_THIS_LOCATION = '".str_replace('%20','',rawurlencode($thisLocation))."';
 611                 ";
 612                 return $out;
 613         }
 614
 615         /**
 616          * Returns a formatted string of $tstamp
 617          * Uses $GLOBALS['TYPO3_CONF_VARS']['SYS']['hhmm'] and $GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'] to format date and time
 618          *
 619          * @param       integer         UNIX timestamp, seconds since 1970
 620          * @param       integer         How much data to show: $type = 1: hhmm, $type = 10:     ddmmmyy
 621          * @return      string          Formatted timestamp
 622          */
 623         function formatTime($tstamp,$type)      {
 624                 $dateStr = '';
 625                 switch($type)   {
 626                         case 1: $dateStr = date($GLOBALS['TYPO3_CONF_VARS']['SYS']['hhmm'],$tstamp);
 627                         break;
 628                         case 10: $dateStr = date($GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'],$tstamp);
 629                         break;
 630                 }
 631                 return $dateStr;
 632         }
 633
 634         /**
 635          * Returns script parsetime IF ->parseTimeFlag is set and user is "admin"
 636          * Automatically outputted in page end
 637          *
 638          * @return      string
 639          */
 640         function parseTime()    {
 641                 if ($this->parseTimeFlag && $GLOBALS['BE_USER']->isAdmin()) {
 642                         return '<p>(ParseTime: '.(t3lib_div::milliseconds()-$GLOBALS['PARSETIME_START']).' ms</p>
 643                                         <p>REQUEST_URI-length: '.strlen(t3lib_div::getIndpEnv('REQUEST_URI')).')</p>';
 644                 }
 645         }
 646
 647         /**
 648          * Defines whether to use the X-UA-Compatible meta tag.
 649          *
 650          * @param boolean $useCompatibilityTag Whether to use the tag
 651          * @return void
 652          */
 653         public function useCompatibilityTag($useCompatibilityTag = TRUE) {
 654                 $this->useCompatibilityTag = (bool) $useCompatibilityTag;
 655         }
 656
 657
 658
 659
 660
 661
 662
 663
 664
 665
 666
 667
 668         /*****************************************
 669          *
 670          *      PAGE BUILDING FUNCTIONS.
 671          *      Use this to build the HTML of your backend modules
 672          *
 673          *****************************************/
 674
 675         /**
 676          * Returns page start
 677          * This includes the proper header with charset, title, meta tag and beginning body-tag.
 678          *
 679          * @param       string          HTML Page title for the header
 680          * @return      string          Returns the whole header section of a HTML-document based on settings in internal variables (like styles, javascript code, charset, generator and docType)
 681          * @see endPage()
 682          */
 683         function startPage($title)      {
 684                         // hook pre start page
 685                 if (isset($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/template.php']['preStartPageHook'])) {
 686                         $preStartPageHook =& $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/template.php']['preStartPageHook'];
 687                         if (is_array($preStartPageHook)) {
 688                                 $hookParameters = array(
 689                                         'title' => &$title,
 690                                 );
 691                                 foreach ($preStartPageHook as $hookFunction)    {
 692                                         t3lib_div::callUserFunction($hookFunction, $hookParameters, $this);
 693                                 }
 694                         }
 695                 }
 696
 697                 $this->pageRenderer->backPath = $this->backPath;
 698
 699                         // alternative template for Header and Footer
 700                 if ($this->pageHeaderFooterTemplateFile) {
 701                         $file =  t3lib_div::getFileAbsFileName($this->pageHeaderFooterTemplateFile, TRUE);
 702                         if ($file) {
 703                                 $this->pageRenderer->setTemplateFile($file);
 704                         }
 705                 }
 706                         // For debugging: If this outputs "QuirksMode"/"BackCompat" (IE) the browser runs in quirks-mode. Otherwise the value is "CSS1Compat"
 707 #               $this->JScodeArray[]='alert(document.compatMode);';
 708
 709                         // Send HTTP header for selected charset. Added by Robert Lemke 23.10.2003
 710                 $this->initCharset();
 711                 header ('Content-Type:text/html;charset='.$this->charset);
 712
 713                         // Standard HTML tag
 714                 $htmlTag = '<html xmlns="http://www.w3.org/1999/xhtml">';
 715
 716                 switch($this->docType)  {
 717                         case 'html_3':
 718                                 $headerStart = '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">';
 719                                 $htmlTag = '<html>';
 720                                 // disable rendering of XHTML tags
 721                                 $this->getPageRenderer()->setRenderXhtml(FALSE);
 722                                 break;
 723                         case 'xhtml_strict':
 724                                 $headerStart = '<!DOCTYPE html
 725         PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
 726         "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">';
 727                                 break;
 728                         case 'xhtml_frames':
 729                                 $headerStart = '<!DOCTYPE html
 730         PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
 731         "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">';
 732                                 break;
 733                         case 'xhtml_trans':
 734                                 $headerStart = '<!DOCTYPE html
 735      PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 736      "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">';
 737                                 // The fallthrough is intended as HTML5, as this is the default for the BE since TYPO3 4.5
 738                         case 'html_5':
 739                         default:
 740                                 $headerStart = '<!DOCTYPE html>' . LF;
 741                                 $htmlTag = '<html>';
 742                                 // disable rendering of XHTML tags
 743                                 $this->getPageRenderer()->setRenderXhtml(FALSE);
 744                                 break;
 745                 }
 746
 747                 $this->pageRenderer->setHtmlTag($htmlTag);
 748
 749                 // This loads the tabulator-in-textarea feature. It automatically modifies
 750                 // every textarea which is found.
 751                 if (!$GLOBALS['BE_USER']->uc['disableTabInTextarea']) {
 752                         $this->loadJavascriptLib('tab.js');
 753                 }
 754
 755                         // include the JS for the Context Sensitive Help
 756                 $this->loadCshJavascript();
 757
 758                         // Get the browser info
 759                 $browserInfo = t3lib_utility_Client::getBrowserInfo(t3lib_div::getIndpEnv('HTTP_USER_AGENT'));
 760
 761                         // Set the XML prologue
 762                 $xmlPrologue = '<?xml version="1.0" encoding="' . $this->charset . '"?>';
 763
 764                         // Set the XML stylesheet
 765                 $xmlStylesheet = '<?xml-stylesheet href="#internalStyle" type="text/css"?>';
 766
 767                         // Add the XML prologue for XHTML doctypes
 768                 if (strpos($this->doctype, 'xhtml') !== FALSE) {
 769                                 // Put the XML prologue before or after the doctype declaration according to browser
 770                         if ($browserInfo['browser'] === 'msie' && $browserInfo['version'] < 7) {
 771                                 $headerStart = $headerStart . LF . $xmlPrologue;
 772                         } else {
 773                                 $headerStart = $xmlPrologue . LF . $headerStart;
 774                         }
 775
 776                                 // Add the xml stylesheet according to doctype
 777                         if ($this->docType !== 'xhtml_frames') {
 778                                 $headerStart = $headerStart . LF . $xmlStylesheet;
 779                         }
 780                 }
 781
 782                 $this->pageRenderer->setXmlPrologAndDocType($headerStart);
 783                 $this->pageRenderer->setHeadTag('<head>' . LF. '<!-- TYPO3 Script ID: '.htmlspecialchars($this->scriptID).' -->');
 784                 $this->pageRenderer->setCharSet($this->charset);
 785                 $this->pageRenderer->addMetaTag($this->generator());
 786                 if ($this->useCompatibilityTag) {
 787                         $this->pageRenderer->addMetaTag($this->xUaCompatible());
 788                 }
 789                 $this->pageRenderer->setTitle($title);
 790
 791                 // add docstyles
 792                 $this->docStyle();
 793
 794
 795                         // add jsCode for overriding the console with a debug panel connection
 796                 $this->pageRenderer->addJsInlineCode(
 797                         'consoleOverrideWithDebugPanel',
 798                         'if (typeof top.Ext === "object") {
 799                                 top.Ext.onReady(function() {
 800                                         if (typeof console === "undefined") {
 801                                                 if (top && top.TYPO3 && top.TYPO3.Backend && top.TYPO3.Backend.DebugConsole) {
 802                                                         console = top.TYPO3.Backend.DebugConsole;
 803                                                 } else {
 804                                                         console = {
 805                                                                 log: Ext.log,
 806                                                                 info: Ext.log,
 807                                                                 warn: Ext.log,
 808                                                                 error: Ext.log
 809                                                         }
 810                                                 }
 811                                         }
 812                                 });
 813                         }
 814                 ');
 815
 816                 $this->pageRenderer->addHeaderData($this->JScode);
 817
 818                 foreach ($this->JScodeArray as $name => $code) {
 819                         $this->pageRenderer->addJsInlineCode($name, $code);
 820                 }
 821
 822                 if (count($this->JScodeLibArray)) {
 823                         foreach($this->JScodeLibArray as $library) {
 824                                 $this->pageRenderer->addHeaderData($library);
 825                         }
 826                 }
 827
 828                 if ($this->extJScode) {
 829                         $this->pageRenderer->addExtOnReadyCode($this->extJScode);
 830                 }
 831
 832                         // hook for additional headerData
 833                 if (isset($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/template.php']['preHeaderRenderHook'])) {
 834                         $preHeaderRenderHook =& $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/template.php']['preHeaderRenderHook'];
 835                         if (is_array($preHeaderRenderHook)) {
 836                                 $hookParameters = array(
 837                                         'pageRenderer' => &$this->pageRenderer,
 838                                 );
 839                                 foreach ($preHeaderRenderHook as $hookFunction) {
 840                                         t3lib_div::callUserFunction($hookFunction, $hookParameters, $this);
 841                                 }
 842                         }
 843                 }
 844
 845                         // Construct page header.
 846                 $str = $this->pageRenderer->render(t3lib_PageRenderer::PART_HEADER);
 847
 848                 $this->JScodeLibArray = array();
 849                 $this->JScode = $this->extJScode = '';
 850                 $this->JScodeArray = array();
 851
 852                 $this->endOfPageJsBlock = $this->pageRenderer->render(t3lib_PageRenderer::PART_FOOTER);
 853
 854                 if ($this->docType=='xhtml_frames')     {
 855                         return $str;
 856                 } else
 857 $str.=$this->docBodyTagBegin().
 858 ($this->divClass?'
 859
 860 <!-- Wrapping DIV-section for whole page BEGIN -->
 861 <div class="' . $this->divClass . '">
 862 ' : '' ) . trim($this->form);
 863                 return $str;
 864         }
 865
 866         /**
 867          * Returns page end; This includes finishing form, div, body and html tags.
 868          *
 869          * @return      string          The HTML end of a page
 870          * @see startPage()
 871          */
 872         function endPage()      {
 873                 $str = $this->sectionEnd().
 874                                 $this->postCode.
 875                                 $this->endPageJS().
 876                                 $this->wrapScriptTags(t3lib_BEfunc::getUpdateSignalCode()).
 877                                 $this->parseTime().
 878                                 ($this->form?'
 879 </form>':'');
 880                         // if something is in buffer like debug, put it to end of page
 881                 if (ob_get_contents()) {
 882                         $str .= ob_get_clean();
 883                         header('Content-Encoding: None');
 884                 }
 885
 886                 if ($this->docType !== 'xhtml_frames') {
 887
 888                         $str .= ($this->divClass?'
 889
 890 <!-- Wrapping DIV-section for whole page END -->
 891 </div>':'') . $this->endOfPageJsBlock ;
 892
 893                 }
 894
 895
 896                         // Logging: Can't find better place to put it:
 897                 if (TYPO3_DLOG) t3lib_div::devLog('END of BACKEND session', 'template', 0, array('_FLUSH' => true));
 898
 899                 return $str;
 900         }
 901
 902         /**
 903          * Returns the header-bar in the top of most backend modules
 904          * Closes section if open.
 905          *
 906          * @param       string          The text string for the header
 907          * @return      string          HTML content
 908          */
 909         function header($text)  {
 910                 $str='
 911
 912         <!-- MAIN Header in page top -->
 913         <h2>'.htmlspecialchars($text).'</h2>
 914 ';
 915                 return $this->sectionEnd().$str;
 916         }
 917
 918         /**
 919          * Begins an output section and sets header and content
 920          *
 921          * @param       string          The header
 922          * @param       string          The HTML-content
 923          * @param       boolean         A flag that will prevent the header from being converted to uppercase
 924          * @param       boolean         Defines the type of header (if set, "<h3>" rather than the default "h4")
 925          * @param       integer         The number of an icon to show with the header (see the icon-function). -1,1,2,3
 926          * @param       boolean         If set, HTML tags are allowed in $label (otherwise this value is by default htmlspecialchars()'ed)
 927          * @return      string          HTML content
 928          * @see icons(), sectionHeader()
 929          */
 930         function section($label,$text,$nostrtoupper=FALSE,$sH=FALSE,$type=0,$allowHTMLinHeader=FALSE)   {
 931                 $str='';
 932
 933                         // Setting header
 934                 if ($label)     {
 935                         if (!$allowHTMLinHeader)        $label = htmlspecialchars($label);
 936                         $str.=$this->sectionHeader($this->icons($type).$label, $sH, $nostrtoupper ? '' : ' class="uppercase"');
 937                 }
 938                         // Setting content
 939                 $str.='
 940
 941         <!-- Section content -->
 942 '.$text;
 943
 944                 return $this->sectionBegin().$str;
 945         }
 946
 947         /**
 948          * Inserts a divider image
 949          * Ends a section (if open) before inserting the image
 950          *
 951          * @param       integer         The margin-top/-bottom of the <hr> ruler.
 952          * @return      string          HTML content
 953          */
 954         function divider($dist) {
 955                 $dist = intval($dist);
 956                 $str='
 957
 958         <!-- DIVIDER -->
 959         <hr style="margin-top: '.$dist.'px; margin-bottom: '.$dist.'px;" />
 960 ';
 961                 return $this->sectionEnd().$str;
 962         }
 963
 964         /**
 965          * Returns a blank <div>-section with a height
 966          *
 967          * @param       integer         Padding-top for the div-section (should be margin-top but konqueror (3.1) doesn't like it :-(
 968          * @return      string          HTML content
 969          */
 970         function spacer($dist)  {
 971                 if ($dist>0)    {
 972                         return '
 973
 974         <!-- Spacer element -->
 975         <div style="padding-top: '.intval($dist).'px;"></div>
 976 ';
 977                 }
 978         }
 979
 980         /**
 981          * Make a section header.
 982          * Begins a section if not already open.
 983          *
 984          * @param       string          The label between the <h3> or <h4> tags. (Allows HTML)
 985          * @param       boolean         If set, <h3> is used, otherwise <h4>
 986          * @param       string          Additional attributes to h-tag, eg. ' class=""'
 987          * @return      string          HTML content
 988          */
 989         function sectionHeader($label, $sH=FALSE, $addAttrib='') {
 990                 $tag = ($sH ? 'h3' : 'h4');
 991                 if ($addAttrib && substr($addAttrib, 0, 1) !== ' ') {
 992                         $addAttrib = ' ' . $addAttrib;
 993                 }
 994                 $str='
 995
 996         <!-- Section header -->
 997         <' . $tag . $addAttrib . '>' . $label . '</' . $tag . '>
 998 ';
 999                 return $this->sectionBegin() . $str;
1000         }
1001
1002         /**
1003          * Begins an output section.
1004          * Returns the <div>-begin tag AND sets the ->sectionFlag true (if the ->sectionFlag is not already set!)
1005          * You can call this function even if a section is already begun since the function will only return something if the sectionFlag is not already set!
1006          *
1007          * @return      string          HTML content
1008          */
1009         function sectionBegin() {
1010                 if (!$this->sectionFlag)        {
1011                         $this->sectionFlag=1;
1012                         $str='
1013
1014         <!-- ***********************
1015               Begin output section.
1016              *********************** -->
1017         <div>
1018 ';
1019                         return $str;
1020                 } else return '';
1021         }
1022
1023         /**
1024          * Ends and output section
1025          * Returns the </div>-end tag AND clears the ->sectionFlag (but does so only IF the sectionFlag is set - that is a section is 'open')
1026          * See sectionBegin() also.
1027          *
1028          * @return      string          HTML content
1029          */
1030         function sectionEnd()   {
1031                 if ($this->sectionFlag) {
1032                         $this->sectionFlag=0;
1033                         return '
1034         </div>
1035         <!-- *********************
1036               End output section.
1037              ********************* -->
1038 ';
1039                 } else return '';
1040         }
1041
1042         /**
1043          * Originally it printed a kind of divider.
1044          * Deprecated. Just remove function calls to it or call the divider() function instead.
1045          *
1046          * @return      void
1047          * @internal
1048          * @deprecated since TYPO3 3.6, will be removed in TYPO3 4.6
1049          */
1050         function middle()       {
1051                 t3lib_div::logDeprecatedFunction();
1052         }
1053
1054         /**
1055          * If a form-tag is defined in ->form then and end-tag for that <form> element is outputted
1056          * Further a JavaScript section is outputted which will update the top.busy session-expiry object (unless $this->endJS is set to false)
1057          *
1058          * @return      string          HTML content (<script> tag section)
1059          */
1060         function endPageJS()    {
1061                 return ($this->endJS?'
1062         <script type="text/javascript">
1063                   /*<![CDATA[*/
1064                 if (top.busy && top.busy.loginRefreshed) {
1065                         top.busy.loginRefreshed();
1066                 }
1067                  /*]]>*/
1068         </script>':'');
1069         }
1070
1071         /**
1072          * Creates the bodyTag.
1073          * You can add to the bodyTag by $this->bodyTagAdditions
1074          *
1075          * @return      string          HTML body tag
1076          */
1077         function docBodyTagBegin()      {
1078                 $bodyContent = 'body onclick="if (top.menuReset) top.menuReset();" '.trim($this->bodyTagAdditions.($this->bodyTagId ? ' id="'.$this->bodyTagId.'"' : ''));
1079                 return '<'.trim($bodyContent).'>';
1080         }
1081
1082         /**
1083          * Outputting document style
1084          *
1085          * @return      string          HTML style section/link tags
1086          */
1087         function docStyle()     {
1088
1089                         // Request background image:
1090                 if ($this->backGroundImage)     {
1091                         $this->inDocStylesArray[]=' BODY { background-image: url('.$this->backPath.$this->backGroundImage.'); }';
1092                 }
1093
1094                         // Add inDoc styles variables as well:
1095                 $this->inDocStylesArray[] = $this->inDocStyles;
1096                 $this->inDocStylesArray[] = $this->inDocStyles_TBEstyle;
1097
1098                         // Implode it all:
1099                 $inDocStyles = implode(LF, $this->inDocStylesArray);
1100
1101                 if ($this->styleSheetFile) {
1102                         $this->pageRenderer->addCssFile($this->backPath . $this->styleSheetFile);
1103                 }
1104                 if ($this->styleSheetFile2) {
1105                         $this->pageRenderer->addCssFile($this->backPath . $this->styleSheetFile2);
1106                 }
1107
1108                 $this->pageRenderer->addCssInlineBlock('inDocStyles', $inDocStyles . LF . '/*###POSTCSSMARKER###*/');
1109                 if ($this->styleSheetFile_post) {
1110                         $this->pageRenderer->addCssFile($this->backPath . $this->styleSheetFile_post);
1111                 }
1112
1113         }
1114
1115         /**
1116          * Insert additional style sheet link
1117          *
1118          * @param       string          $key: some key identifying the style sheet
1119          * @param       string          $href: uri to the style sheet file
1120          * @param       string          $title: value for the title attribute of the link element
1121          * @return      string          $relation: value for the rel attribute of the link element
1122          * @return      void
1123          */
1124         function addStyleSheet($key, $href, $title='', $relation='stylesheet') {
1125                 if (strpos($href, '://') !== FALSE || substr($href, 0, 1) === '/') {
1126                         $file = $href;
1127                 } else {
1128                         $file = $this->backPath . $href;
1129                 }
1130                 $this->pageRenderer->addCssFile($file, $relation, 'screen', $title);
1131         }
1132
1133         /**
1134          * Add all *.css files of the directory $path to the stylesheets
1135          *
1136          * @param       string          directory to add
1137          * @return      void
1138          */
1139         function addStyleSheetDirectory($path) {
1140                         // calculation needed, when TYPO3 source is used via a symlink
1141                         // absolute path to the stylesheets
1142                 $filePath = dirname(t3lib_div::getIndpEnv('SCRIPT_FILENAME')) . '/' . $GLOBALS['BACK_PATH'] . $path;
1143                         // clean the path
1144                 $resolvedPath = t3lib_div::resolveBackPath($filePath);
1145                         // read all files in directory and sort them alphabetically
1146                 $files = t3lib_div::getFilesInDir($resolvedPath, 'css', FALSE, 1);
1147                 foreach ($files as $file) {
1148                         $this->pageRenderer->addCssFile($GLOBALS['BACK_PATH'] . $path . $file, 'stylesheet', 'all');
1149                 }
1150         }
1151
1152         /**
1153          * Insert post rendering document style into already rendered content
1154          * This is needed for extobjbase
1155          *
1156          * @param       string          style-content to insert.
1157          * @return      string          content with inserted styles
1158          */
1159         function insertStylesAndJS($content)    {
1160                         // insert accumulated CSS
1161                 $this->inDocStylesArray[] = $this->inDocStyles;
1162                 $styles = LF.implode(LF, $this->inDocStylesArray);
1163                 $content = str_replace('/*###POSTCSSMARKER###*/',$styles,$content);
1164
1165                         // insert accumulated JS
1166                 $jscode = $this->JScode.LF.$this->wrapScriptTags(implode(LF, $this->JScodeArray));
1167                 $content = str_replace('<!--###POSTJSMARKER###-->',$jscode,$content);
1168
1169                 return $content;
1170         }
1171
1172         /**
1173          * Returns an array of all stylesheet directories belonging to core and skins
1174          *
1175          * @return      array   Stylesheet directories
1176          */
1177         public function getSkinStylesheetDirectories() {
1178                 $stylesheetDirectories = array();
1179
1180                         // add default core stylesheets
1181                 foreach ($this->stylesheetsCore as $stylesheetDir) {
1182                         $stylesheetDirectories[] = $stylesheetDir;
1183                 }
1184
1185                         // Stylesheets from skins
1186                         // merge default css directories ($this->stylesheetsSkin) with additional ones and include them
1187                 if (is_array($GLOBALS['TBE_STYLES']['skins'])) {
1188                                 // loop over all registered skins
1189                         foreach ($GLOBALS['TBE_STYLES']['skins'] as $skinExtKey => $skin) {
1190                                 $skinStylesheetDirs = $this->stylesheetsSkins;
1191
1192                                         // skins can add custom stylesheetDirectories using
1193                                         // $TBE_STYLES['skins'][$_EXTKEY]['stylesheetDirectories']
1194                                 if (is_array($skin['stylesheetDirectories'])) {
1195                                         $skinStylesheetDirs = array_merge($skinStylesheetDirs, $skin['stylesheetDirectories']);
1196                                 }
1197
1198                                         // add all registered directories
1199                                 foreach ($skinStylesheetDirs as $stylesheetDir) {
1200                                                 // for EXT:myskin/stylesheets/ syntax
1201                                         if (substr($stylesheetDir, 0, 4) === 'EXT:') {
1202                                                 list($extKey, $path) = explode('/', substr($stylesheetDir, 4), 2);
1203                                                 if (strcmp($extKey, '') && t3lib_extMgm::isLoaded($extKey) && strcmp($path, '')) {
1204                                                         $stylesheetDirectories[] = t3lib_extMgm::extRelPath($extKey) . $path;
1205                                                 }
1206                                         } else {
1207                                                 // for relative paths
1208                                                 $stylesheetDirectories[] = t3lib_extMgm::extRelPath($skinExtKey) . $stylesheetDir;
1209                                         }
1210                                 }
1211                         }
1212                 }
1213                 return $stylesheetDirectories;
1214         }
1215
1216         /**
1217          * Initialize the charset.
1218          * Sets the internal $this->charset variable to the charset defined in $GLOBALS["LANG"] (or the default as set in this class)
1219          * Returns the meta-tag for the document header
1220          *
1221          * @return      string          <meta> tag with charset from $this->charset or $GLOBALS['LANG']->charSet
1222          */
1223         function initCharset()  {
1224                         // Set charset to the charset provided by the current backend users language selection:
1225                 $this->charset = $GLOBALS['LANG']->charSet ? $GLOBALS['LANG']->charSet : $this->charset;
1226                         // Return meta tag:
1227                 return '<meta http-equiv="Content-Type" content="text/html; charset='.$this->charset.'" />';
1228         }
1229
1230         /**
1231          * Returns generator meta tag
1232          *
1233          * @return      string          <meta> tag with name "generator"
1234          */
1235         function generator()    {
1236                 $str = 'TYPO3 '.TYPO3_branch.', http://typo3.com, &#169; Kasper Sk&#229;rh&#248;j 1998-2009, extensions are copyright of their respective owners.';
1237                 return '<meta name="generator" content="'.$str .'" />';
1238         }
1239
1240         /**
1241          * Returns X-UA-Compatible meta tag
1242          *
1243          * @param       string          $content Content of the compatible tag (default: IE-8)
1244          * @return      string          <meta http-equiv="X-UA-Compatible" content="???" />
1245          */
1246         public function xUaCompatible($content = 'IE=8') {
1247                 return '<meta http-equiv="X-UA-Compatible" content="' . $content . '" />';
1248         }
1249
1250
1251
1252
1253
1254
1255
1256         /*****************************************
1257          *
1258          * OTHER ELEMENTS
1259          * Tables, buttons, formatting dimmed/red strings
1260          *
1261          ******************************************/
1262
1263
1264         /**
1265          * Returns an image-tag with an 18x16 icon of the following types:
1266          *
1267          * $type:
1268          * -1:  OK icon (Check-mark)
1269          * 1:   Notice (Speach-bubble)
1270          * 2:   Warning (Yellow triangle)
1271          * 3:   Fatal error (Red stop sign)
1272          *
1273          * @param       integer         See description
1274          * @param       string          Value for style attribute
1275          * @return      string          HTML image tag (if applicable)
1276          */
1277         function icons($type, $styleAttribValue='')     {
1278                 switch($type)   {
1279                         case '3':
1280                                 $icon = 'status-dialog-error';
1281                         break;
1282                         case '2':
1283                                 $icon = 'status-dialog-warning';
1284                         break;
1285                         case '1':
1286                                 $icon = 'status-dialog-notification';
1287                         break;
1288                         case '-1':
1289                                 $icon = 'status-dialog-ok';
1290                         break;
1291                         default:
1292                         break;
1293                 }
1294                 if ($icon)      {
1295                         return t3lib_iconWorks::getSpriteIcon($icon);
1296                 }
1297         }
1298
1299         /**
1300          * Returns an <input> button with the $onClick action and $label
1301          *
1302          * @param       string          The value of the onclick attribute of the input tag (submit type)
1303          * @param       string          The label for the button (which will be htmlspecialchar'ed)
1304          * @return      string          A <input> tag of the type "submit"
1305          */
1306         function t3Button($onClick,$label)      {
1307                 $button = '<input type="submit" onclick="'.htmlspecialchars($onClick).'; return false;" value="'.htmlspecialchars($label).'" />';
1308                 return $button;
1309         }
1310
1311         /**
1312          * dimmed-fontwrap. Returns the string wrapped in a <span>-tag defining the color to be gray/dimmed
1313          *
1314          * @param       string          Input string
1315          * @return      string          Output string
1316          */
1317         function dfw($string)   {
1318                 return '<span class="typo3-dimmed">'.$string.'</span>';
1319         }
1320
1321         /**
1322          * red-fontwrap. Returns the string wrapped in a <span>-tag defining the color to be red
1323          *
1324          * @param       string          Input string
1325          * @return      string          Output string
1326          */
1327         function rfw($string)   {
1328                 return '<span class="typo3-red">'.$string.'</span>';
1329         }
1330
1331         /**
1332          * Returns string wrapped in CDATA "tags" for XML / XHTML (wrap content of <script> and <style> sections in those!)
1333          *
1334          * @param       string          Input string
1335          * @return      string          Output string
1336          */
1337         function wrapInCData($string)   {
1338                 $string = '/*<![CDATA[*/'.
1339                         $string.
1340                         '/*]]>*/';
1341
1342                 return $string;
1343         }
1344
1345         /**
1346          * Wraps the input string in script tags.
1347          * Automatic re-identing of the JS code is done by using the first line as ident reference.
1348          * This is nice for identing JS code with PHP code on the same level.
1349          *
1350          * @param       string          Input string
1351          * @param       boolean         Wrap script element in linebreaks? Default is TRUE.
1352          * @return      string          Output string
1353          */
1354         function wrapScriptTags($string, $linebreak=TRUE)       {
1355                 if(trim($string)) {
1356                                 // <script wrapped in nl?
1357                         $cr = $linebreak? LF : '';
1358
1359                                 // remove nl from the beginning
1360                         $string = preg_replace ('/^\n+/', '', $string);
1361                                 // re-ident to one tab using the first line as reference
1362                         $match = array();
1363                         if(preg_match('/^(\t+)/',$string,$match)) {
1364                                 $string = str_replace($match[1],TAB, $string);
1365                         }
1366                         $string = $cr.'<script type="text/javascript">
1367 /*<![CDATA[*/
1368 '.$string.'
1369 /*]]>*/
1370 </script>'.$cr;
1371                 }
1372                 return trim($string);
1373         }
1374
1375                 // These vars defines the layout for the table produced by the table() function.
1376                 // You can override these values from outside if you like.
1377         var $tableLayout = array(
1378                 'defRow' => array(
1379                         'defCol' => array('<td valign="top">','</td>')
1380                 )
1381         );
1382         var $table_TR = '<tr>';
1383         var $table_TABLE = '<table border="0" cellspacing="0" cellpadding="0" class="typo3-dblist" id="typo3-tmpltable">';
1384
1385         /**
1386          * Returns a table based on the input $data
1387          *
1388          * @param       array           Multidim array with first levels = rows, second levels = cells
1389          * @param       array           If set, then this provides an alternative layout array instead of $this->tableLayout
1390          * @return      string          The HTML table.
1391          * @internal
1392          */
1393         function table($data, $layout = '') {
1394                 $result = '';
1395                 if (is_array($data)) {
1396                         $tableLayout = (is_array($layout) ? $layout : $this->tableLayout);
1397
1398                         $rowCount = 0;
1399                         foreach ($data as $tableRow) {
1400                                 if ($rowCount % 2) {
1401                                         $layout = is_array($tableLayout['defRowOdd']) ? $tableLayout['defRowOdd'] : $tableLayout['defRow'];
1402                                 } else {
1403                                         $layout = is_array($tableLayout['defRowEven']) ? $tableLayout['defRowEven'] : $tableLayout['defRow'];
1404                                 }
1405                                 $rowLayout = is_array($tableLayout[$rowCount]) ? $tableLayout[$rowCount] : $layout;
1406                                 $rowResult = '';
1407                                 if (is_array($tableRow)) {
1408                                         $cellCount = 0;
1409                                         foreach ($tableRow as $tableCell) {
1410                                                 $cellWrap = (is_array($layout[$cellCount])    ? $layout[$cellCount]    : $layout['defCol']);
1411                                                 $cellWrap = (is_array($rowLayout['defCol'])   ? $rowLayout['defCol']   : $cellWrap);
1412                                                 $cellWrap = (is_array($rowLayout[$cellCount]) ? $rowLayout[$cellCount] : $cellWrap);
1413                                                 $rowResult .= $cellWrap[0] . $tableCell . $cellWrap[1];
1414                                                 $cellCount++;
1415                                         }
1416                                 }
1417                                 $rowWrap = (is_array($layout['tr'])    ? $layout['tr']    : array($this->table_TR, '</tr>'));
1418                                 $rowWrap = (is_array($rowLayout['tr']) ? $rowLayout['tr'] : $rowWrap);
1419                                 $result .= $rowWrap[0] . $rowResult . $rowWrap[1];
1420                                 $rowCount++;
1421                         }
1422                         $tableWrap = is_array($tableLayout['table']) ? $tableLayout['table'] : array($this->table_TABLE, '</table>');
1423                         $result = $tableWrap[0] . $result . $tableWrap[1];
1424                 }
1425                 return $result;
1426         }
1427
1428         /**
1429          * Constructs a table with content from the $arr1, $arr2 and $arr3.
1430          * Used in eg. ext/belog/mod/index.php - refer to that for examples
1431          *
1432          * @param       array           Menu elements on first level
1433          * @param       array           Secondary items
1434          * @param       array           Third-level items
1435          * @return      string          HTML content, <table>...</table>
1436          */
1437         function menuTable($arr1,$arr2=array(), $arr3=array())  {
1438                 $rows = max(array(count($arr1),count($arr2),count($arr3)));
1439
1440                 $menu='
1441                 <table border="0" cellpadding="0" cellspacing="0" id="typo3-tablemenu">';
1442                 for($a=0;$a<$rows;$a++) {
1443                         $menu.='<tr>';
1444                         $cls=array();
1445                         $valign='middle';
1446                         $cls[]='<td valign="'.$valign.'">'.$arr1[$a][0].'</td><td>'.$arr1[$a][1].'</td>';
1447                         if (count($arr2))       {
1448                                 $cls[]='<td valign="'.$valign.'">'.$arr2[$a][0].'</td><td>'.$arr2[$a][1].'</td>';
1449                                 if (count($arr3))       {
1450                                         $cls[]='<td valign="'.$valign.'">'.$arr3[$a][0].'</td><td>'.$arr3[$a][1].'</td>';
1451                                 }
1452                         }
1453                         $menu.=implode($cls,'<td>&nbsp;&nbsp;</td>');
1454                         $menu.='</tr>';
1455                 }
1456                 $menu.='
1457                 </table>
1458                 ';
1459                 return $menu;
1460         }
1461
1462         /**
1463          * Returns a one-row/two-celled table with $content and $menu side by side.
1464          * The table is a 100% width table and each cell is aligned left / right
1465          *
1466          * @param       string          Content cell content (left)
1467          * @param       string          Menu cell content (right)
1468          * @return      string          HTML output
1469          */
1470         function funcMenu($content,$menu)       {
1471                 return '
1472                         <table border="0" cellpadding="0" cellspacing="0" width="100%" id="typo3-funcmenu">
1473                                 <tr>
1474                                         <td valign="top" nowrap="nowrap">'.$content.'</td>
1475                                         <td valign="top" align="right" nowrap="nowrap">'.$menu.'</td>
1476                                 </tr>
1477                         </table>';
1478         }
1479
1480         /**
1481          * Creates a selector box with clear-cache items.
1482          * Rather specialized functions - at least don't use it with $addSaveOptions unless you know what you do...
1483          *
1484          * @param       integer         The page uid of the "current page" - the one that will be cleared as "clear cache for this page".
1485          * @param       boolean         If $addSaveOptions is set, then also the array of save-options for TCE_FORMS will appear.
1486          * @return      string          <select> tag with content - a selector box for clearing the cache
1487          */
1488         function clearCacheMenu($id,$addSaveOptions=0)  {
1489                 global $BE_USER;
1490                 $opt=array();
1491                 if ($addSaveOptions)    {
1492                         $opt[]='<option value="">'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:rm.menu',1).'</option>';
1493                         $opt[]='<option value="TBE_EDITOR.checkAndDoSubmit(1);">'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:rm.saveDoc',1).'</option>';
1494                         $opt[]='<option value="document.editform.closeDoc.value=-2; TBE_EDITOR.checkAndDoSubmit(1);">'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:rm.saveCloseDoc',1).'</option>';
1495                         if ($BE_USER->uc['allSaveFunctions'])   $opt[]='<option value="document.editform.closeDoc.value=-3; TBE_EDITOR.checkAndDoSubmit(1);">'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:rm.saveCloseAllDocs',1).'</option>';
1496                         $opt[]='<option value="document.editform.closeDoc.value=2; document.editform.submit();">'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:rm.closeDoc',1).'</option>';
1497                         $opt[]='<option value="document.editform.closeDoc.value=3; document.editform.submit();">'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:rm.closeAllDocs',1).'</option>';
1498                         $opt[]='<option value=""></option>';
1499                 }
1500                 $opt[]='<option value="">[ '.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:rm.clearCache_clearCache',1).' ]</option>';
1501                 if ($id) $opt[]='<option value="'.$id.'">'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:rm.clearCache_thisPage',1).'</option>';
1502                 if ($BE_USER->isAdmin() || $BE_USER->getTSConfigVal('options.clearCache.pages')) $opt[]='<option value="pages">'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:rm.clearCache_pages',1).'</option>';
1503                 if ($BE_USER->isAdmin() || $BE_USER->getTSConfigVal('options.clearCache.all')) $opt[]='<option value="all">'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:rm.clearCache_all',1).'</option>';
1504
1505                 $onChange = 'if (!this.options[this.selectedIndex].value) {
1506                                 this.selectedIndex=0;
1507                         } else if (this.options[this.selectedIndex].value.indexOf(\';\')!=-1) {
1508                                 eval(this.options[this.selectedIndex].value);
1509                         }else{
1510                                 window.location.href=\''.$this->backPath.'tce_db.php?vC='.$BE_USER->veriCode().'&redirect='.rawurlencode(t3lib_div::getIndpEnv('REQUEST_URI')).'&cacheCmd=\'+this.options[this.selectedIndex].value;
1511                         }';
1512                 $af_content = '<select name="cacheCmd" onchange="'.htmlspecialchars($onChange).'">'.implode('',$opt).'</select>';
1513
1514                 if (count($opt)>1)      {
1515                         return $af_content;
1516                 }
1517         }
1518
1519
1520         /**
1521          * Includes a javascript library that exists in the core /typo3/ directory. The
1522          * backpath is automatically applied
1523          *
1524          * @param       string          $lib: Library name. Call it with the full path
1525          *                              like "contrib/prototype/prototype.js" to load it
1526          * @return      void
1527          */
1528         function loadJavascriptLib($lib)        {
1529                 $this->pageRenderer->addJsFile($this->backPath . $lib);
1530         }
1531
1532
1533
1534         /**
1535          * Includes the necessary Javascript function for the clickmenu (context sensitive menus) in the document
1536          *
1537          * @return      array   Deprecated: Includes the code already in the doc, so the return array is always empty.
1538          *                      Please just call this function without expecting a return value for future calls
1539          */
1540         function getContextMenuCode()   {
1541                $this->pageRenderer->loadPrototype();
1542                $this->loadJavascriptLib('js/clickmenu.js');
1543
1544                $this->JScodeArray['clickmenu'] = '
1545                                Clickmenu.clickURL = "'.$this->backPath.'alt_clickmenu.php";
1546                                Clickmenu.ajax     = '.($this->isCMLayers() ? 'true' : 'false' ).';';
1547
1548                        // return array deprecated since 4.2
1549                return array('','','');
1550         }
1551
1552         /**
1553          * Includes the necessary javascript file (tree.js) for use on pages which have the
1554          * drag and drop functionality (usually pages and folder display trees)
1555          *
1556          * @param       string          indicator of which table the drag and drop function should work on (pages or folders)
1557          * @return      array           If values are present: [0] = A <script> section for the HTML page header, [1] = onmousemove/onload handler for HTML tag or alike, [2] = One empty <div> layer for the follow-mouse drag element
1558          */
1559         function getDragDropCode($table)        {
1560                 $this->pageRenderer->loadPrototype();
1561                 $this->loadJavascriptLib('js/common.js');
1562                 $this->loadJavascriptLib('js/tree.js');
1563
1564                         // setting prefs for drag & drop
1565                 $this->JScodeArray['dragdrop'] = '
1566                         DragDrop.changeURL = "'.$this->backPath.'alt_clickmenu.php";
1567                         DragDrop.backPath  = "'.t3lib_div::shortMD5(''.'|'.$GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey']).'";
1568                         DragDrop.table     = "'.$table.'";
1569                 ';
1570
1571                        // return array deprecated since 4.2
1572                return array('','','');
1573         }
1574
1575          /**
1576          * This loads everything needed for the Context Sensitive Help (CSH)
1577          *
1578          * @return void
1579          */
1580         protected function loadCshJavascript() {
1581                 $this->pageRenderer->loadExtJS();
1582                 $this->pageRenderer->addExtOnReadyCode('
1583                         Ext.getBody().on({
1584                                 click: {
1585                                         delegate: "a",
1586                                         scope:this,
1587                                         fn:function(event, link) {
1588                                                 var element = Ext.fly(link);
1589                                                 if (element.hasClass("typo3-csh-link") || element.hasClass("t3-help-link")) {
1590                                                         event.stopEvent();
1591                                                         top.TYPO3.ContextHelpWindow.open(link.rel);
1592                                                 }
1593                                         }
1594                                 }
1595                         });
1596                 ');
1597         }
1598
1599         /**
1600          * Creates a tab menu from an array definition
1601          *
1602          * Returns a tab menu for a module
1603          * Requires the JS function jumpToUrl() to be available
1604          *
1605          * @param       mixed           $id is the "&id=" parameter value to be sent to the module, but it can be also a parameter array which will be passed instead of the &id=...
1606          * @param       string          $elementName it the form elements name, probably something like "SET[...]"
1607          * @param       string          $currentValue is the value to be selected currently.
1608          * @param       array           $menuItems is an array with the menu items for the selector box
1609          * @param       string          $script is the script to send the &id to, if empty it's automatically found
1610          * @param       string          $addParams is additional parameters to pass to the script.
1611          * @return      string          HTML code for tab menu
1612          * @author      René Fritz <r.fritz@colorcube.de>
1613          */
1614         function getTabMenu($mainParams,$elementName,$currentValue,$menuItems,$script='',$addparams='') {
1615                 $content='';
1616
1617                 if (is_array($menuItems))       {
1618                         if (!is_array($mainParams)) {
1619                                 $mainParams = array('id' => $mainParams);
1620                         }
1621                         $mainParams = t3lib_div::implodeArrayForUrl('',$mainParams);
1622
1623                         if (!$script) {$script=basename(PATH_thisScript);}
1624
1625                         $menuDef = array();
1626                         foreach($menuItems as $value => $label) {
1627                                 $menuDef[$value]['isActive'] = !strcmp($currentValue,$value);
1628                                 $menuDef[$value]['label'] = t3lib_div::deHSCentities(htmlspecialchars($label));
1629                                 $menuDef[$value]['url'] = $script . '?' . $mainParams . $addparams . '&' . $elementName . '=' . $value;
1630                         }
1631                         $content = $this->getTabMenuRaw($menuDef);
1632
1633                 }
1634                 return $content;
1635         }
1636
1637         /**
1638          * Creates the HTML content for the tab menu
1639          *
1640          * @param       array           Menu items for tabs
1641          * @return      string          Table HTML
1642          * @access private
1643          */
1644         function getTabMenuRaw($menuItems)      {
1645                 $content='';
1646
1647                 if (is_array($menuItems))       {
1648                         $options='';
1649
1650                         $count = count($menuItems);
1651                         $widthLeft = 1;
1652                         $addToAct = 5;
1653
1654                         $widthRight = max (1,floor(30-pow($count,1.72)));
1655                         $widthTabs = 100 - $widthRight - $widthLeft;
1656                         $widthNo = floor(($widthTabs - $addToAct)/$count);
1657                         $addToAct = max ($addToAct,$widthTabs-($widthNo*$count));
1658                         $widthAct = $widthNo + $addToAct;
1659                         $widthRight = 100 - ($widthLeft + ($count*$widthNo) + $addToAct);
1660
1661                         foreach($menuItems as $id => $def) {
1662                                 $isActive = $def['isActive'];
1663                                 $class = $isActive ? 'tabact' : 'tab';
1664                                 $width = $isActive ? $widthAct : $widthNo;
1665
1666                                         // @rene: Here you should probably wrap $label and $url in htmlspecialchars() in order to make sure its XHTML compatible! I did it for $url already since that is VERY likely to break.
1667                                 $label = $def['label'];
1668                                 $url = htmlspecialchars($def['url']);
1669                                 $params = $def['addParams'];
1670
1671                                 $options .= '<td width="' . $width . '%" class="' . $class . '"><a href="' . $url . '" ' . $params . '>' . $label . '</a></td>';
1672                         }
1673
1674                         if ($options)   {
1675                                 $content .= '
1676                                 <!-- Tab menu -->
1677                                 <table cellpadding="0" cellspacing="0" border="0" width="100%" id="typo3-tabmenu">
1678                                         <tr>
1679                                                         <td width="'.$widthLeft.'%">&nbsp;</td>
1680                                                         '.$options.'
1681                                                 <td width="'.$widthRight.'%">&nbsp;</td>
1682                                         </tr>
1683                                 </table>
1684                                 <div class="hr" style="margin:0px"></div>';
1685                         }
1686
1687                 }
1688                 return $content;
1689         }
1690
1691         /**
1692          * Creates a DYNAMIC tab-menu where the tabs are switched between with DHTML.
1693          * Should work in MSIE, Mozilla, Opera and Konqueror. On Konqueror I did find a serious problem: <textarea> fields loose their content when you switch tabs!
1694          *
1695          * @param       array           Numeric array where each entry is an array in itself with associative keys: "label" contains the label for the TAB, "content" contains the HTML content that goes into the div-layer of the tabs content. "description" contains description text to be shown in the layer. "linkTitle" is short text for the title attribute of the tab-menu link (mouse-over text of tab). "stateIcon" indicates a standard status icon (see ->icon(), values: -1, 1, 2, 3). "icon" is an image tag placed before the text.
1696          * @param       string          Identification string. This should be unique for every instance of a dynamic menu!
1697          * @param       integer         If "1", then enabling one tab does not hide the others - they simply toggles each sheet on/off. This makes most sense together with the $foldout option. If "-1" then it acts normally where only one tab can be active at a time BUT you can click a tab and it will close so you have no active tabs.
1698          * @param       boolean         If set, the tabs are rendered as headers instead over each sheet. Effectively this means there is no tab menu, but rather a foldout/foldin menu. Make sure to set $toggle as well for this option.
1699          * @param       integer         Character limit for a new row, 0 by default, because this parameter is deprecated since TYPO3 4.5
1700          * @param       boolean         If set, tab table cells are not allowed to wrap their content
1701          * @param       boolean         If set, the tabs will span the full width of their position
1702          * @param       integer         Default tab to open (for toggle <=0). Value corresponds to integer-array index + 1 (index zero is "1", index "1" is 2 etc.). A value of zero (or something non-existing) will result in no default tab open.
1703          * @param       integer         If set to '1' empty tabs will be remove, If set to '2' empty tabs will be disabled
1704          * @return      string          JavaScript section for the HTML header.
1705          */
1706         public function getDynTabMenu($menuItems, $identString, $toggle = 0, $foldout = FALSE, $newRowCharLimit = 0, $noWrap = 1, $fullWidth = FALSE, $defaultTabIndex = 1, $dividers2tabs = 2) {
1707                         // load the static code, if not already done with the function below
1708                 $this->loadJavascriptLib('js/tabmenu.js');
1709
1710                 $content = '';
1711
1712                 if (is_array($menuItems))       {
1713
1714                                 // Init:
1715                         $options = array(array());
1716                         $divs = array();
1717                         $JSinit = array();
1718                         $id = $this->getDynTabMenuId($identString);
1719                         $noWrap = $noWrap ? ' nowrap="nowrap"' : '';
1720
1721                                 // Traverse menu items
1722                         $c=0;
1723                         $tabRows=0;
1724                         $titleLenCount = 0;
1725                         foreach($menuItems as $index => $def) {
1726                                         // Need to add one so checking for first index in JavaScript
1727                                         // is different than if it is not set at all.
1728                                 $index += 1;
1729
1730                                         // Switch to next tab row if needed
1731                                 if (!$foldout && (($newRowCharLimit > 0 && $titleLenCount > $newRowCharLimit) | ($def['newline'] === TRUE && $titleLenCount > 0))) {
1732                                         $titleLenCount=0;
1733                                         $tabRows++;
1734                                         $options[$tabRows] = array();
1735                                 }
1736
1737                                 if ($toggle==1) {
1738                                         $onclick = 'this.blur(); DTM_toggle("'.$id.'","'.$index.'"); return false;';
1739                                 } else {
1740                                         $onclick = 'this.blur(); DTM_activate("'.$id.'","'.$index.'", '.($toggle<0?1:0).'); return false;';
1741                                 }
1742
1743                                 $isEmpty = !(strcmp(trim($def['content']),'') || strcmp(trim($def['icon']),''));
1744
1745                                         // "Removes" empty tabs
1746                                 if ($isEmpty && $dividers2tabs == 1) {
1747                                         continue;
1748                                 }
1749
1750                                 $mouseOverOut = ' onmouseover="DTM_mouseOver(this);" onmouseout="DTM_mouseOut(this);"';
1751                                 $requiredIcon = '<img name="' . $id . '-' . $index . '-REQ" src="' . $GLOBALS['BACK_PATH'] . 'gfx/clear.gif" class="t3-TCEforms-reqTabImg" alt="" />';
1752
1753                                 if (!$foldout)  {
1754                                                 // Create TAB cell:
1755                                         $options[$tabRows][] = '
1756                                                         <td class="'.($isEmpty ? 'disabled' : 'tab').'" id="'.$id.'-'.$index.'-MENU"'.$noWrap.$mouseOverOut.'>'.
1757                                                         ($isEmpty ? '' : '<a href="#" onclick="'.htmlspecialchars($onclick).'"'.($def['linkTitle'] ? ' title="'.htmlspecialchars($def['linkTitle']).'"':'').'>').
1758                                                         $def['icon'].
1759                                                         ($def['label'] ? htmlspecialchars($def['label']) : '&nbsp;').
1760                                                         $requiredIcon.
1761                                                         $this->icons($def['stateIcon'],'margin-left: 10px;').
1762                                                         ($isEmpty ? '' : '</a>').
1763                                                         '</td>';
1764                                         $titleLenCount+= strlen($def['label']);
1765                                 } else {
1766                                                 // Create DIV layer for content:
1767                                         $divs[] = '
1768                                                 <div class="'.($isEmpty ? 'disabled' : 'tab').'" id="'.$id.'-'.$index.'-MENU"'.$mouseOverOut.'>'.
1769                                                         ($isEmpty ? '' : '<a href="#" onclick="'.htmlspecialchars($onclick).'"'.($def['linkTitle'] ? ' title="'.htmlspecialchars($def['linkTitle']).'"':'').'>').
1770                                                         $def['icon'].
1771                                                         ($def['label'] ? htmlspecialchars($def['label']) : '&nbsp;').
1772                                                         $requiredIcon.
1773                                                         ($isEmpty ? '' : '</a>').
1774                                                         '</div>';
1775                                 }
1776
1777                                         // Create DIV layer for content:
1778                                 $divs[] = '
1779                                                 <div style="display: none;" id="'.$id.'-'.$index.'-DIV" class="c-tablayer">'.
1780                                                         ($def['description'] ? '<p class="c-descr">'.nl2br(htmlspecialchars($def['description'])).'</p>' : '').
1781                                                         $def['content'].
1782                                                         '</div>';
1783                                         // Create initialization string:
1784                                 $JSinit[] = '
1785                                                 DTM_array["'.$id.'"]['.$c.'] = "'.$id.'-'.$index.'";
1786                                 ';
1787                                         // If not empty and we have the toggle option on, check if the tab needs to be expanded
1788                                 if ($toggle == 1 && !$isEmpty) {
1789                                         $JSinit[] = '
1790                                                 if (top.DTM_currentTabs["'.$id.'-'.$index.'"]) { DTM_toggle("'.$id.'","'.$index.'",1); }
1791                                         ';
1792                                 }
1793
1794                                 $c++;
1795                         }
1796
1797                                 // Render menu:
1798                         if (count($options))    {
1799
1800                                         // Tab menu is compiled:
1801                                 if (!$foldout)  {
1802                                         $tabContent = '';
1803                                         for($a=0;$a<=$tabRows;$a++)     {
1804                                                 $tabContent.= '
1805
1806                                         <!-- Tab menu -->
1807                                         <table cellpadding="0" cellspacing="0" border="0"'.($fullWidth ? ' width="100%"' : '').' class="typo3-dyntabmenu">
1808                                                 <tr>
1809                                                                 '.implode('',$options[$a]).'
1810                                                 </tr>
1811                                         </table>';
1812                                         }
1813                                         $content.= '<div class="typo3-dyntabmenu-tabs">'.$tabContent.'</div>';
1814                                 }
1815
1816                                         // Div layers are added:
1817                                 $content.= '
1818                                 <!-- Div layers for tab menu: -->
1819                                 <div class="typo3-dyntabmenu-divs'.($foldout?'-foldout':'').'">
1820                                 '.implode('',$divs).'</div>';
1821
1822                                         // Java Script section added:
1823                                 $content.= '
1824                                 <!-- Initialization JavaScript for the menu -->
1825                                 <script type="text/javascript">
1826                                         DTM_array["'.$id.'"] = new Array();
1827                                         '.implode('',$JSinit).'
1828                                         '.($toggle<=0 ? 'DTM_activate("'.$id.'", top.DTM_currentTabs["'.$id.'"]?top.DTM_currentTabs["'.$id.'"]:'.intval($defaultTabIndex).', 0);' : '').'
1829                                 </script>
1830
1831                                 ';
1832                         }
1833
1834                 }
1835                 return $content;
1836         }
1837
1838         /**
1839          * Creates the id for dynTabMenus.
1840          *
1841          * @param       string          $identString: Identification string. This should be unique for every instance of a dynamic menu!
1842          * @return      string          The id with a short MD5 of $identString and prefixed "DTM-", like "DTM-2e8791854a"
1843          */
1844         function getDynTabMenuId($identString) {
1845                 $id = 'DTM-'.t3lib_div::shortMD5($identString);
1846                 return $id;
1847         }
1848
1849         /**
1850          * Returns dynamic tab menu header JS code.
1851          * This is now incorporated automatically when the function template::getDynTabMenu is called
1852          * (as long as it is called before $this->startPage())
1853          * The return value is not needed anymore
1854          *
1855          * @deprecated since TYPO3 4.5, as the getDynTabMenu() function includes the function automatically since TYPO3 4.3
1856          * @return      string          JavaScript section for the HTML header. (return value is deprecated since TYPO3 4.3, will be removed in TYPO3 4.5)
1857          */
1858         function getDynTabMenuJScode()  {
1859                 t3lib_div::logDeprecatedFunction();
1860                 $this->loadJavascriptLib('js/tabmenu.js');
1861                 // return value deprecated since TYPO3 4.3
1862                 return '';
1863         }
1864
1865         /**
1866          * Creates the version selector for the page id inputted.
1867          * Requires the core version management extension, "version" to be loaded.
1868          *
1869          * @param       integer         Page id to create selector for.
1870          * @param       boolean         If set, there will be no button for swapping page.
1871          * @return      void
1872          */
1873         function getVersionSelector($id,$noAction=FALSE)        {
1874
1875                 if ($id>0)      {
1876                         if (t3lib_extMgm::isLoaded('version') && $GLOBALS['BE_USER']->workspace==0)     {
1877
1878                                         // Get Current page record:
1879                                 $curPage = t3lib_BEfunc::getRecord('pages',$id);
1880                                         // If the selected page is not online, find the right ID
1881                                 $onlineId = ($curPage['pid']==-1 ? $curPage['t3ver_oid'] : $id);
1882                                         // Select all versions of online version:
1883                                 $versions = t3lib_BEfunc::selectVersionsOfRecord('pages', $onlineId, 'uid,pid,t3ver_label,t3ver_oid,t3ver_wsid,t3ver_id');
1884
1885                                         // If more than one was found...:
1886                                 if (count($versions)>1) {
1887                                         $selectorLabel = '<strong>' . $GLOBALS['LANG']->sL('LLL:EXT:version/locallang.xml:versionSelect.label', TRUE) . '</strong>';
1888
1889                                                 // Create selector box entries:
1890                                         $opt = array();
1891                                         foreach($versions as $vRow)     {
1892                                                 if ($vRow['uid'] == $onlineId) {
1893                                                                 //Live version
1894                                                         $label = '[' . $GLOBALS['LANG']->sL('LLL:EXT:version/locallang.xml:versionSelect.live', TRUE) . ']';
1895                                                 } else {
1896                                                         $label = $vRow['t3ver_label'] . ' (' . $GLOBALS['LANG']->sL('LLL:EXT:version/locallang.xml:versionId', TRUE) . ' ' . $vRow['t3ver_id'] .
1897                                                                 ($vRow['t3ver_wsid'] != 0 ? ' ' . $GLOBALS['LANG']->sL('LLL:EXT:version/locallang.xml:workspaceId', TRUE) . ' ' . $vRow['t3ver_wsid'] : '') . ')';
1898                                                 }
1899
1900                                                 $opt[] = '<option value="' . htmlspecialchars(t3lib_div::linkThisScript(array('id' => $vRow['uid']))) . '"' .
1901                                                         ($id == $vRow['uid'] ? ' selected="selected"' : '') . '>' .
1902                                                         htmlspecialchars($label) . '</option>';
1903                                         }
1904
1905                                                 // Add management link:
1906                                         $management = '<input type="button" value="' . $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:ver.mgm', TRUE) . '" onclick="window.location.href=\'' .
1907                                                         htmlspecialchars($this->backPath . t3lib_extMgm::extRelPath('version') . 'cm1/index.php?table=pages&uid=' . $onlineId) . '\';" />';
1908                                                 // Create onchange handler:
1909                                         $onChange = "window.location.href=this.options[this.selectedIndex].value;";
1910
1911                                                 // Controls:
1912                                         if ($id == $onlineId) {
1913                                                 $controls .= '<img' . t3lib_iconWorks::skinImg($this->backPath, 'gfx/blinkarrow_left.gif','width="5" height="9"') .
1914                                                         ' class="absmiddle" alt="" /> <strong>' . $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:ver.online', TRUE) .
1915                                                         '</strong>';
1916                                         } elseif (!$noAction) {
1917                                                 $controls .= '<a href="' . $this->issueCommand('&cmd[pages][' . $onlineId . '][version][swapWith]=' . $id .
1918                                                         '&cmd[pages][' . $onlineId . '][version][action]=swap', t3lib_div::linkThisScript(array('id' => $onlineId))) .
1919                                                         '" class="nobr">' . t3lib_iconWorks::getSpriteIcon('actions-version-swap-version', array(
1920                                                                 'title' => $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:ver.swapPage', TRUE),
1921                                                                 'style' => 'margin-left:5px;vertical-align:bottom;'
1922                                                         )) . '<strong>' . $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:ver.swap', TRUE) . '</strong></a>';
1923                                         }
1924
1925                                                 // Write out HTML code:
1926                                         return '
1927
1928                                                 <!--
1929                                                         Version selector:
1930                                                 -->
1931                                                 <table border="0" cellpadding="0" cellspacing="0" id="typo3-versionSelector">
1932                                                         <tr>
1933                                                                 <td>' . $selectorLabel . '</td>
1934                                                                 <td>
1935                                                                         <select onchange="' . htmlspecialchars($onChange) . '">
1936                                                                                 ' . implode('', $opt) . '
1937                                                                         </select></td>
1938                                                                 <td>' . $controls . '</td>
1939                                                                 <td>' . $management . '</td>
1940                                                         </tr>
1941                                                 </table>
1942                                         ';
1943                                 }
1944                         } elseif ($GLOBALS['BE_USER']->workspace !== 0) {
1945
1946                                         // Write out HTML code:
1947                                 switch($GLOBALS['BE_USER']->workspace) {
1948                                         case 0:
1949                                                 $wsTitle = $GLOBALS['LANG']->sL('LLL:EXT:version/locallang.xml:live', TRUE);
1950                                         break;
1951                                         case -1:
1952                                                 $wsTitle = $GLOBALS['LANG']->sL('LLL:EXT:version/locallang.xml:draft', TRUE);
1953                                         break;
1954                                         default:
1955                                                 $wsTitle = $GLOBALS['BE_USER']->workspaceRec['title'];
1956                                         break;
1957                                 }
1958
1959                                 if (t3lib_BEfunc::isPidInVersionizedBranch($id) == 'branchpoint') {
1960                                         return '
1961
1962                                                 <!--
1963                                                         Version selector:
1964                                                 -->
1965                                                 <table border="0" cellpadding="0" cellspacing="0" id="typo3-versionSelector">
1966                                                         <tr>
1967                                                                 <td>' . $selectorLabel . '</td>
1968                                                                 <td>Workspace: "' . htmlspecialchars($wsTitle) . '"</td>
1969                                                                 <td><em>' . $GLOBALS['LANG']->sL('LLL:EXT:version/locallang.xml:versionSelect.inBranch', TRUE) . '</em></td>
1970                                                         </tr>
1971                                                 </table>
1972                                         ';
1973                                 } else {
1974                                                 // Get Current page record:
1975                                         $curPage = t3lib_BEfunc::getRecord('pages', $id);
1976                                                 // If the selected page is not online, find the right ID
1977                                         $onlineId = ($curPage['pid']==-1 ? $curPage['t3ver_oid'] : $id);
1978                                                 // The version of page:
1979                                         $verPage = t3lib_BEfunc::getWorkspaceVersionOfRecord($GLOBALS['BE_USER']->workspace, 'pages', $onlineId);
1980
1981                                         if (!$verPage) {
1982
1983                                                 if (!count(t3lib_BEfunc::countVersionsOfRecordsOnPage($GLOBALS['BE_USER']->workspace, $onlineId))) {
1984                                                         if ($GLOBALS['BE_USER']->workspaceVersioningTypeAccess(0)) {
1985
1986                                                                 $onClick = $this->issueCommand('&cmd[pages][' . $onlineId . '][version][action]=new&cmd[pages][' . $onlineId . '][version][treeLevels]=0',
1987                                                                         t3lib_div::linkThisScript(array(
1988                                                                                 'id' => $onlineId
1989                                                                         )));
1990                                                                 $onClick = 'window.location.href=\'' . $onClick . '\'; return false;';
1991                                                                         // Write out HTML code:
1992                                                                 return '
1993
1994                                                                         <!--
1995                                                                                 No version yet, create one?
1996                                                                         -->
1997                                                                         <table border="0" cellpadding="0" cellspacing="0" id="typo3-versionSelector">
1998                                                                                 <tr>
1999                                                                                         <td>' . $selectorLabel . '</td>
2000                                                                                         <td>' . $GLOBALS['LANG']->sL('LLL:EXT:version/locallang.xml:workspace', TRUE) . ': "' . htmlspecialchars($wsTitle) . '"</td>
2001                                                                                         <td>
2002                                                                                                 <input type="button" value="New version of page" name="_" onclick="' . htmlspecialchars($onClick) . '" /></td>
2003                                                                                 </tr>
2004                                                                         </table>
2005                                                                 ';
2006                                                         }
2007                                                 } elseif ($GLOBALS['TYPO3_CONF_VARS']['BE']['elementVersioningOnly'] == FALSE && $GLOBALS['TYPO3_CONF_VARS']['BE']['newPagesVersioningType'] == 0) {
2008                                                                 // only add this info if old/deprecated newPagesVersioning is allowed
2009                                                         return '
2010
2011                                                                 <!--
2012                                                                         Version selector:
2013                                                                 -->
2014                                                                 <table border="0" cellpadding="0" cellspacing="0" id="typo3-versionSelector">
2015                                                                         <tr>
2016                                                                                 <td>' . $selectorLabel . '</td>
2017                                                                                 <td>' . $GLOBALS['LANG']->sL('LLL:EXT:version/locallang.xml:workspace', TRUE) . ': "' . htmlspecialchars($wsTitle) . '"</td>
2018                                                                                 <td><em>' . $GLOBALS['LANG']->sL('LLL:EXT:version/locallang.xml:versionSelect.versionsFound', TRUE) . '</em></td>
2019                                                                         </tr>
2020                                                                 </table>
2021                                                         ';
2022                                                 }
2023                                         } elseif ($verPage['t3ver_swapmode']==0) {
2024                                                 $onClick = $this->issueCommand('&cmd[pages][' . $onlineId . '][version][action]=swap&cmd[pages][' .
2025                                                         $onlineId . '][version][swapWith]=' . $verPage['uid'],
2026                                                         t3lib_div::linkThisScript(array(
2027                                                                 'id' => $onlineId
2028                                                         )));
2029                                                 $onClick = 'window.location.href=\'' . $onClick . '\'; return false;';
2030
2031                                                         // Write out HTML code:
2032                                                 return '
2033
2034                                                         <!--
2035                                                                 Version selector:
2036                                                         -->
2037                                                         <table border="0" cellpadding="0" cellspacing="0" id="typo3-versionSelector">
2038                                                                 <tr>
2039                                                                         <td>' . $selectorLabel . '</td>
2040                                                                         <td>' . $GLOBALS['LANG']->sL('LLL:EXT:version/locallang.xml:workspace', TRUE) . ': "' . htmlspecialchars($wsTitle) . '"</td>
2041                                                                         <td>
2042                                                                                 <input type="button" value="' . $GLOBALS['LANG']->sL('LLL:EXT:version/locallang.xml:versionSelect.publish', TRUE) .
2043                                                                                         '" onclick="' . htmlspecialchars($onClick) . '" /></td>
2044                                                                 </tr>
2045                                                         </table>
2046                                                 ';
2047                                         }
2048                                 }
2049                         }
2050                 }
2051         }
2052
2053         /**
2054          * Function to load a HTML template file with markers.
2055          * When calling from own extension, use  syntax getHtmlTemplate('EXT:extkey/template.html')
2056          *
2057          * @param       string          tmpl name, usually in the typo3/template/ directory
2058          * @return      string          HTML of template
2059          */
2060         function getHtmlTemplate($filename)     {
2061                         // setting the name of the original HTML template
2062                 $this->moduleTemplateFilename = $filename;
2063
2064                 if ($GLOBALS['TBE_STYLES']['htmlTemplates'][$filename]) {
2065                         $filename = $GLOBALS['TBE_STYLES']['htmlTemplates'][$filename];
2066                 }
2067                 if (t3lib_div::isFirstPartOfStr($filename, 'EXT:')) {
2068                         $filename = t3lib_div::getFileAbsFileName($filename, TRUE, TRUE);
2069                 } else if (!t3lib_div::isAbsPath($filename)) {
2070                         $filename = t3lib_div::resolveBackPath($this->backPath . $filename);
2071                 } else if (!t3lib_div::isAllowedAbsPath($filename)) {
2072                         $filename = '';
2073                 }
2074                 $htmlTemplate = '';
2075                 if ($filename !== '') {
2076                         $htmlTemplate = t3lib_div::getURL($filename);
2077                 }
2078                 return $htmlTemplate;
2079         }
2080
2081         /**
2082          * Define the template for the module
2083          *
2084          * @param       string          filename
2085          */
2086         public function setModuleTemplate($filename) {
2087                         // Load Prototype lib for IE event
2088                 $this->pageRenderer->loadPrototype();
2089                 $this->loadJavascriptLib('js/iecompatibility.js');
2090                 $this->moduleTemplate = $this->getHtmlTemplate($filename);
2091         }
2092
2093         /**
2094          * Put together the various elements for the module <body> using a static HTML
2095          * template
2096          *
2097          * @param       array           Record of the current page, used for page path and info
2098          * @param       array           HTML for all buttons
2099          * @param       array           HTML for all other markers
2100          * @return      string          Composite HTML
2101          */
2102         public function moduleBody($pageRecord = array(), $buttons = array(), $markerArray = array(), $subpartArray = array()) {
2103                         // Get the HTML template for the module
2104                 $moduleBody = t3lib_parsehtml::getSubpart($this->moduleTemplate, '###FULLDOC###');
2105                         // Add CSS
2106                 $this->inDocStylesArray[] = 'html { overflow: hidden; }';
2107                         // Add JS code to the <head> for IE
2108                 $this->JScode.= $this->wrapScriptTags('
2109                                 // workaround since IE6 cannot deal with relative height for scrolling elements
2110                         function resizeDocBody()        {
2111                                 $("typo3-docbody").style.height = (document.body.offsetHeight - parseInt($("typo3-docheader").getStyle("height")));
2112                         }
2113                         if (Prototype.Browser.IE) {
2114                                 var version = parseFloat(navigator.appVersion.split(\';\')[1].strip().split(\' \')[1]);
2115                                 if (version == 6) {
2116                                         Event.observe(window, "resize", resizeDocBody, false);
2117                                         Event.observe(window, "load", resizeDocBody, false);
2118                                 }
2119                         }
2120                 ');
2121
2122                         // Get the page path for the docheader
2123                 $markerArray['PAGEPATH'] = $this->getPagePath($pageRecord);
2124                         // Get the page info for the docheader
2125                 $markerArray['PAGEINFO'] = $this->getPageInfo($pageRecord);
2126                         // Get all the buttons for the docheader
2127                 $docHeaderButtons = $this->getDocHeaderButtons($buttons);
2128                         // Merge docheader buttons with the marker array
2129                 $markerArray = array_merge($markerArray, $docHeaderButtons);
2130                         // replacing subparts
2131                 foreach ($subpartArray as $marker => $content) {
2132                         $moduleBody = t3lib_parsehtml::substituteSubpart($moduleBody, $marker, $content);
2133                 }
2134
2135                         // adding flash messages
2136                 if ($this->showFlashMessages) {
2137                         $flashMessages = t3lib_FlashMessageQueue::renderFlashMessages();
2138                         if (!empty($flashMessages)) {
2139                                 $markerArray['FLASHMESSAGES'] = '<div id="typo3-messages">' . $flashMessages . '</div>';
2140
2141                                         // if there is no dedicated marker for the messages present
2142                                         // then force them to appear before the content
2143                                 if (strpos($moduleBody, '###FLASHMESSAGES###') === FALSE) {
2144                                         $moduleBody = str_replace(
2145                                                 '###CONTENT###',
2146                                                 '###FLASHMESSAGES######CONTENT###',
2147                                                 $moduleBody
2148                                         );
2149                                 }
2150                         }
2151                 }
2152
2153                         // Hook for adding more markers/content to the page, like the version selector
2154                 if (isset($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/template.php']['moduleBodyPostProcess'])) {
2155                         $params = array(
2156                                 'moduleTemplateFilename' => &$this->moduleTemplateFilename,
2157                                 'moduleTemplate' => &$this->moduleTemplate,
2158                                 'moduleBody' => &$moduleBody,
2159                                 'markers' => &$markerArray,
2160                                 'parentObject' => &$this
2161                         );
2162                         foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/template.php']['moduleBodyPostProcess'] as $funcRef) {
2163                                 t3lib_div::callUserFunction($funcRef, $params, $this);
2164                         }
2165                 }
2166
2167                         // replacing all markers with the finished markers and return the HTML content
2168                 return t3lib_parsehtml::substituteMarkerArray($moduleBody, $markerArray, '###|###');
2169
2170         }
2171
2172         /**
2173          * Fill the button lists with the defined HTML
2174          *
2175          * @param       array           HTML for all buttons
2176          * @return      array           Containing HTML for both buttonlists
2177          */
2178         protected function getDocHeaderButtons($buttons) {
2179                 $markers = array();
2180                         // Fill buttons for left and right float
2181                 $floats = array('left', 'right');
2182                 foreach($floats as $key) {
2183                                 // Get the template for each float
2184                         $buttonTemplate = t3lib_parsehtml::getSubpart($this->moduleTemplate, '###BUTTON_GROUPS_' . strtoupper($key) . '###');
2185                                 // Fill the button markers in this float
2186                         $buttonTemplate = t3lib_parsehtml::substituteMarkerArray($buttonTemplate, $buttons, '###|###', true);
2187                                 // getting the wrap for each group
2188                         $buttonWrap = t3lib_parsehtml::getSubpart($this->moduleTemplate, '###BUTTON_GROUP_WRAP###');
2189                                 // looping through the groups (max 6) and remove the empty groups
2190                         for ($groupNumber = 1; $groupNumber < 6; $groupNumber++) {
2191                                 $buttonMarker = '###BUTTON_GROUP' . $groupNumber . '###';
2192                                 $buttonGroup = t3lib_parsehtml::getSubpart($buttonTemplate, $buttonMarker);
2193                                 if (trim($buttonGroup)) {
2194                                         if ($buttonWrap) {
2195                                                 $buttonGroup = t3lib_parsehtml::substituteMarker($buttonWrap, '###BUTTONS###', $buttonGroup);
2196                                         }
2197                                         $buttonTemplate = t3lib_parsehtml::substituteSubpart($buttonTemplate, $buttonMarker, trim($buttonGroup));
2198                                 }
2199                         }
2200                                 // replace the marker with the template and remove all line breaks (for IE compat)
2201                         $markers['BUTTONLIST_' . strtoupper($key)] = str_replace(LF, '', $buttonTemplate);
2202                 }
2203
2204                         // Hook for manipulating docHeaderButtons
2205                 if (isset($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/template.php']['docHeaderButtonsHook'])) {
2206                         $params = array(
2207                                 'buttons'       => $buttons,
2208                                 'markers'       => &$markers,
2209                                 'pObj'          => &$this
2210                         );
2211                         foreach($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/template.php']['docHeaderButtonsHook'] as $funcRef)    {
2212                                 t3lib_div::callUserFunction($funcRef, $params, $this);
2213                         }
2214                 }
2215
2216                 return $markers;
2217         }
2218
2219         /**
2220          * Generate the page path for docheader
2221          *
2222          * @param       array   Current page
2223          * @return      string  Page path
2224          */
2225         protected function getPagePath($pageRecord) {
2226                         // Is this a real page
2227                 if ($pageRecord['uid']) {
2228                         $title = substr($pageRecord['_thePathFull'], 0, -1);
2229                                 // remove current page title
2230                         $pos = strrpos($title, '/');
2231                         if ($pos !== FALSE) {
2232                                 $title = substr($title, 0, $pos) . '/';
2233                         }
2234                 } else {
2235                         $title = '';
2236                 }
2237
2238                         // Setting the path of the page
2239                 $pagePath = $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.path', 1) . ': <span class="typo3-docheader-pagePath">';
2240
2241                         // crop the title to title limit (or 50, if not defined)
2242                 $cropLength = (empty($GLOBALS['BE_USER']->uc['titleLen'])) ? 50 : $GLOBALS['BE_USER']->uc['titleLen'];
2243                 $croppedTitle = t3lib_div::fixed_lgd_cs($title, -$cropLength);
2244                 if ($croppedTitle !== $title) {
2245                         $pagePath .= '<abbr title="' . htmlspecialchars($title) . '">' . htmlspecialchars($croppedTitle) . '</abbr>';
2246                 } else {
2247                         $pagePath .= htmlspecialchars($title);
2248                 }
2249                 $pagePath .= '</span>';
2250                 return $pagePath;
2251         }
2252
2253         /**
2254          * Setting page icon with clickmenu + uid for docheader
2255          *
2256          * @param       array   Current page
2257          * @return      string  Page info
2258          */
2259         protected function getPageInfo($pageRecord) {
2260                 global $BE_USER;
2261                                 // Add icon with clickmenu, etc:
2262                 if ($pageRecord['uid']) {       // If there IS a real page
2263                         $alttext = t3lib_BEfunc::getRecordIconAltText($pageRecord, 'pages');
2264                         $iconImg = t3lib_iconWorks::getSpriteIconForRecord('pages', $pageRecord, array('title'=>$alttext));
2265                                 // Make Icon:
2266                         $theIcon = $GLOBALS['SOBE']->doc->wrapClickMenuOnIcon($iconImg, 'pages', $pageRecord['uid']);
2267                         $uid = $pageRecord['uid'];
2268                         $title = t3lib_BEfunc::getRecordTitle('pages', $pageRecord);
2269                 } else {        // On root-level of page tree
2270                                 // Make Icon
2271                         $iconImg = t3lib_iconWorks::getSpriteIcon('apps-pagetree-root', array('title' => htmlspecialchars($GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'])));
2272                         if($BE_USER->user['admin']) {
2273                                 $theIcon = $GLOBALS['SOBE']->doc->wrapClickMenuOnIcon($iconImg, 'pages', 0);
2274                         } else {
2275                                 $theIcon = $iconImg;
2276                         }
2277                         $uid = '0';
2278                         $title = $GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'];
2279                 }
2280
2281                         // Setting icon with clickmenu + uid
2282                 $pageInfo = $theIcon . '<strong>' . htmlspecialchars($title) . '&nbsp;[' . $uid . ']</strong>';
2283                 return $pageInfo;
2284         }
2285
2286
2287
2288
2289
2290                 }
2291
2292
2293 // ******************************
2294 // Extension classes of the template class.
2295 // These are meant to provide backend screens with different widths.
2296 // They still do because of the different class-prefixes used for the <div>-sections
2297 // but obviously the final width is determined by the stylesheet used.
2298 // ******************************
2299
2300 /**
2301  * Extension class for "template" - used for backend pages which are wide. Typically modules taking up all the space in the "content" frame of the backend
2302  * The class were more significant in the past than today.
2303  *
2304  */
2305 class bigDoc extends template {
2306         var $divClass = 'typo3-bigDoc';
2307 }
2308
2309 /**
2310  * Extension class for "template" - used for backend pages without the "document" background image
2311  * The class were more significant in the past than today.
2312  *
2313  */
2314 class noDoc extends template {
2315         var $divClass = 'typo3-noDoc';
2316 }
2317
2318 /**
2319  * Extension class for "template" - used for backend pages which were narrow (like the Web>List modules list frame. Or the "Show details" pop up box)
2320  * The class were more significant in the past than today.
2321  *
2322  */
2323 class smallDoc extends template {
2324         var $divClass = 'typo3-smallDoc';
2325 }
2326
2327 /**
2328  * Extension class for "template" - used for backend pages which were medium wide. Typically submodules to Web or File which were presented in the list-frame when the content frame were divided into a navigation and list frame.
2329  * The class were more significant in the past than today. But probably you should use this one for most modules you make.
2330  *
2331  */
2332 class mediumDoc extends template {
2333         var $divClass = 'typo3-mediumDoc';
2334 }
2335
2336
2337 /**
2338  * Extension class for "template" - used in the context of frontend editing.
2339  */
2340 class frontendDoc extends template {
2341
2342         /**
2343          * Gets instance of PageRenderer
2344          *
2345          * @return      t3lib_PageRenderer
2346          */
2347         public function getPageRenderer() {
2348                 if (!isset($this->pageRenderer)) {
2349                         $this->pageRenderer = $GLOBALS['TSFE']->getPageRenderer();
2350                 }
2351                 return $this->pageRenderer;
2352         }
2353
2354         /**
2355          * Used in the frontend context to insert header data via TSFE->additionalHeaderData.
2356          * Mimics header inclusion from template->startPage().
2357          *
2358          * @return      void
2359          */
2360         public function insertHeaderData() {
2361
2362                 $this->backPath = $GLOBALS['TSFE']->backPath = TYPO3_mainDir;
2363                 $this->pageRenderer->setBackPath($this->backPath);
2364                 $this->docStyle();
2365
2366                         // add applied JS/CSS to $GLOBALS['TSFE']
2367                 if ($this->JScode) {
2368                         $this->pageRenderer->addHeaderData($this->JScode);
2369                 }
2370                 if (count($this->JScodeArray)) {
2371                         foreach ($this->JScodeArray as $name => $code) {
2372                                 $this->pageRenderer->addJsInlineCode($name, $code);
2373                         }
2374                 }
2375         }
2376 }
2377
2378
2379 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['typo3/template.php'])      {
2380         include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['typo3/template.php']);
2381 }
2382
2383
2384
2385 // ******************************
2386 // The template is loaded
2387 // ******************************
2388 $GLOBALS['TBE_TEMPLATE'] = t3lib_div::makeInstance('template');
2389
2390
2391 ?>