template.php

Go to the documentation of this file.

<?php
/***************************************************************
*  Copyright notice
*
*  (c) 1999-2005 Kasper Skaarhoj (kasperYYYY@typo3.com)
*  All rights reserved
*
*  This script is part of the TYPO3 project. The TYPO3 project is
*  free software; you can redistribute it and/or modify
*  it under the terms of the GNU General Public License as published by
*  the Free Software Foundation; either version 2 of the License, or
*  (at your option) any later version.
*
*  The GNU General Public License can be found at
*  http://www.gnu.org/copyleft/gpl.html.
*  A copy is found in the textfile GPL.txt and important notices to the license
*  from the author is found in LICENSE.txt distributed with these scripts.
*
*
*  This script is distributed in the hope that it will be useful,
*  but WITHOUT ANY WARRANTY; without even the implied warranty of
*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
*  GNU General Public License for more details.
*
*  This copyright notice MUST APPEAR in all copies of the script!
***************************************************************/
/**
 * Contains class with layout/output function for TYPO3 Backend Scripts
 *
 * $Id: template.php 4570 2008-12-18 18:37:14Z steffenk $
 * Revised for TYPO3 3.6 2/2003 by Kasper Skaarhoj
 * XHTML-trans compliant
 *
 * @author  Kasper Skaarhoj <kasperYYYY@typo3.com>
 */
/**
 * [CLASS/FUNCTION INDEX of SCRIPT]
 *
 *  145: function fw($str)
 *
 *
 *  169: class template
 *  224:     function template()
 *
 *              SECTION: EVALUATION FUNCTIONS
 *  298:     function wrapClickMenuOnIcon($str,$table,$uid='',$listFr=1,$addParams='',$enDisItems='', $returnOnClick=FALSE)
 *  315:     function viewPageIcon($id,$backPath,$addParams='hspace="3"')
 *  341:     function issueCommand($params,$rUrl='')
 *  356:     function isCMlayers()
 *  366:     function thisBlur()
 *  376:     function helpStyle()
 *  393:     function getHeader($table,$row,$path,$noViewPageIcon=0,$tWrap=array('',''))
 *  419:     function getFileheader($title,$path,$iconfile)
 *  434:     function makeShortcutIcon($gvList,$setList,$modName,$motherModName="")
 *  467:     function makeShortcutUrl($gvList,$setList)
 *  488:     function formWidth($size=48,$textarea=0,$styleOverride='')
 *  513:     function formWidthText($size=48,$styleOverride='',$wrap='')
 *  530:     function redirectUrls($thisLocation='')
 *  554:     function formatTime($tstamp,$type)
 *  571:     function parseTime()
 *
 *              SECTION: PAGE BUILDING FUNCTIONS.
 *  604:     function startPage($title)
 *  686:     function endPage()
 *  720:     function header($text)
 *  741:     function section($label,$text,$nostrtoupper=FALSE,$sH=FALSE,$type=0,$allowHTMLinHeader=FALSE)
 *  765:     function divider($dist)
 *  781:     function spacer($dist)
 *  800:     function sectionHeader($label,$sH=FALSE,$addAttrib='')
 *  817:     function sectionBegin()
 *  838:     function sectionEnd()
 *  858:     function middle()
 *  867:     function endPageJS()
 *  884:     function docBodyTagBegin()
 *  894:     function docStyle()
 *  936:     function insertStylesAndJS($content)
 *  956:     function initCharset()
 *  968:     function generator()
 *
 *              SECTION: OTHER ELEMENTS
 * 1001:     function icons($type, $styleAttribValue='')
 * 1030:     function t3Button($onClick,$label)
 * 1041:     function dfw($string)
 * 1051:     function rfw($string)
 * 1061:     function wrapInCData($string)
 * 1078:     function wrapScriptTags($string, $linebreak=TRUE)
 * 1117:     function table($arr, $layout='')
 * 1159:     function menuTable($arr1,$arr2=array(), $arr3=array())
 * 1192:     function funcMenu($content,$menu)
 * 1210:     function clearCacheMenu($id,$addSaveOptions=0)
 * 1246:     function getContextMenuCode()
 * 1251:     function showClickmenu(table, uid, listFr, enDisItems, backPath, addParams)
 * 1280:     function showClickmenu_noajax(url)
 * 1287:     function showClickmenu_ajax(t3ajax)
 * 1472:     function getDragDropCode($table)
 * 1483:     function cancelDragEvent(event)
 * 1496:     function mouseMoveEvent (event)
 * 1509:     function dragElement(id,elementID)
 * 1528:     function dropElement(id)
 * 1577:     function getTabMenu($mainParams,$elementName,$currentValue,$menuItems,$script='',$addparams='')
 * 1607:     function getTabMenuRaw($menuItems)
 * 1676:     function getDynTabMenu($menuItems,$identString,$toggle=0,$foldout=FALSE,$newRowCharLimit=50,$noWrap=1,$fullWidth=FALSE,$defaultTabIndex=1)
 * 1801:     function getDynTabMenuJScode()
 * 1892:     function getVersionSelector($id,$noAction=FALSE)
 *
 *
 * 2060: class bigDoc extends template
 *
 *
 * 2069: class noDoc extends template
 *
 *
 * 2078: class smallDoc extends template
 *
 *
 * 2087: class mediumDoc extends template
 *
 * TOTAL FUNCTIONS: 57
 * (This index is automatically created/updated by the extension "extdeveval")
 *
 */



if (!defined('TYPO3_MODE')) die("Can't include this file directly.");

require_once(PATH_t3lib.'class.t3lib_ajax.php');










/**
 * Deprecated fontwrap function. Is just transparent now.
 *
 * @param   string      Input string
 * @return  string      Output string (in the old days this was wrapped in <font> tags)
 * @deprecated since TYPO3 4.0
 */
function fw($str)   {
    return $str;
}


/**
 * TYPO3 Backend Template Class
 *
 * This class contains functions for starting and ending the HTML of backend modules
 * It also contains methods for outputting sections of content.
 * Further there are functions for making icons, links, setting form-field widths etc.
 * Color scheme and stylesheet definitions are also available here.
 * Finally this file includes the language class for TYPO3's backend.
 *
 * After this file $LANG and $TBE_TEMPLATE are global variables / instances of their respective classes.
 * This file is typically included right after the init.php file,
 * if language and layout is needed.
 *
 * Please refer to Inside TYPO3 for a discussion of how to use this API.
 *
 * @author  Kasper Skaarhoj <kasperYYYY@typo3.com>
 * @package TYPO3
 * @subpackage core
 */
class template {

        // Vars you typically might want to/should set from outside after making instance of this class:
    var $backPath = '';             // 'backPath' pointing back to the PATH_typo3
    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.
    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
    var $JScode='';                 // Additional header code (eg. a JavaScript section) could be accommulated in this var. It will be directly outputted in the header.
    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.
    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.
    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'.
    var $moduleTemplate = '';       // HTML template with markers for module

        // Other vars you can change, but less frequently used:
    var $scriptID='';               // Script ID.
    var $bodyTagId='';              // Id which can be set for the body tag. Default value is based on script ID
    var $bodyTagAdditions='';       // You can add additional attributes to the body-tag through this variable.
    var $inDocStyles='';            // Additional CSS styles which will be added to the <style> section in the header
    var $inDocStylesArray=array();      // Like $inDocStyles but for use as array with associative keys to prevent double inclusion of css code
    var $form_rowsToStylewidth = 9.58;  // Multiplication factor for formWidth() input size (default is 48* this value).
    var $form_largeComp = 1.33;     // Compensation for large documents (used in class.t3lib_tceforms.php)
    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.
    protected $additionalStyleSheets=array();   // Links to additional style sheets

        // TYPO3 Colorscheme.
        // If you want to change this, please do so through a skin using the global var $TBE_STYLES
    var $bgColor = '#F7F3EF';       // Light background color
    var $bgColor2 = '#9BA1A8';      // Steel-blue
    var $bgColor3 = '#F6F2E6';      // dok.color
    var $bgColor4 = '#D9D5C9';      // light tablerow background, brownish
    var $bgColor5 = '#ABBBB4';      // light tablerow background, greenish
    var $bgColor6 = '#E7DBA8';      // light tablerow background, yellowish, for section headers. Light.
    var $hoverColor = '#254D7B';
    var $styleSheetFile = 'stylesheet.css'; // Filename of stylesheet (relative to PATH_typo3)
    var $styleSheetFile2 = '';      // Filename of stylesheet #2 - linked to right after the $this->styleSheetFile script (relative to PATH_typo3)
    var $styleSheetFile_post = '';  // Filename of a post-stylesheet - included right after all inline styles.
    var $backGroundImage = '';      // Background image of page (relative to PATH_typo3)
    var $inDocStyles_TBEstyle = ''; // Inline css styling set from TBE_STYLES array

        // DEV:
    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.

        // INTERNAL
    var $charset = 'iso-8859-1';    // Default charset. see function initCharset()

    var $sectionFlag=0;             // Internal: Indicates if a <div>-output section is open
    var $divClass = '';             // (Default) Class for wrapping <DIV>-tag of page. Is set in class extensions.






    /**
     * Constructor
     * Imports relevant parts from global $TBE_STYLES (colorscheme)
     *
     * @return  void
     */
    function template() {
        global $TBE_STYLES;

            // Setting default scriptID:
        if (($temp_M = (string) t3lib_div::_GET('M')) && $GLOBALS['TBE_MODULES']['_PATHS'][$temp_M]) {
            $this->scriptID = ereg_replace('^.*\/(sysext|ext)\/', 'ext/', $GLOBALS['TBE_MODULES']['_PATHS'][$temp_M] . 'index.php');
        } else {
            $this->scriptID = ereg_replace('^.*\/(sysext|ext)\/', 'ext/', substr(PATH_thisScript, strlen(PATH_site)));
        }
        if (TYPO3_mainDir!='typo3/' && substr($this->scriptID,0,strlen(TYPO3_mainDir)) == TYPO3_mainDir)    {
            $this->scriptID = 'typo3/'.substr($this->scriptID,strlen(TYPO3_mainDir));   // This fixes if TYPO3_mainDir has been changed so the script ids are STILL "typo3/..."
        }

        $this->bodyTagId = ereg_replace('[^[:alnum:]-]','-',$this->scriptID);

            // Individual configuration per script? If so, make a recursive merge of the arrays:
        if (is_array($TBE_STYLES['scriptIDindex'][$this->scriptID]))    {
            $ovr = $TBE_STYLES['scriptIDindex'][$this->scriptID];       // Make copy
            $TBE_STYLES = t3lib_div::array_merge_recursive_overrule($TBE_STYLES,$ovr);      // merge styles.
            unset($TBE_STYLES['scriptIDindex'][$this->scriptID]);   // Have to unset - otherwise the second instantiation will do it again!
        }

            // Color scheme:
        if ($TBE_STYLES['mainColors']['bgColor'])   $this->bgColor=$TBE_STYLES['mainColors']['bgColor'];
        if ($TBE_STYLES['mainColors']['bgColor1'])  $this->bgColor1=$TBE_STYLES['mainColors']['bgColor1'];
        if ($TBE_STYLES['mainColors']['bgColor2'])  $this->bgColor2=$TBE_STYLES['mainColors']['bgColor2'];
        if ($TBE_STYLES['mainColors']['bgColor3'])  $this->bgColor3=$TBE_STYLES['mainColors']['bgColor3'];
        if ($TBE_STYLES['mainColors']['bgColor4'])  $this->bgColor4=$TBE_STYLES['mainColors']['bgColor4'];
        if ($TBE_STYLES['mainColors']['bgColor5'])  $this->bgColor5=$TBE_STYLES['mainColors']['bgColor5'];
        if ($TBE_STYLES['mainColors']['bgColor6'])  $this->bgColor6=$TBE_STYLES['mainColors']['bgColor6'];
        if ($TBE_STYLES['mainColors']['hoverColor'])    $this->hoverColor=$TBE_STYLES['mainColors']['hoverColor'];

            // Main Stylesheets:
        if ($TBE_STYLES['stylesheet'])  $this->styleSheetFile = $TBE_STYLES['stylesheet'];
        if ($TBE_STYLES['stylesheet2']) $this->styleSheetFile2 = $TBE_STYLES['stylesheet2'];
        if ($TBE_STYLES['styleSheetFile_post']) $this->styleSheetFile_post = $TBE_STYLES['styleSheetFile_post'];
        if ($TBE_STYLES['inDocStyles_TBEstyle'])    $this->inDocStyles_TBEstyle = $TBE_STYLES['inDocStyles_TBEstyle'];

            // Background image
        if ($TBE_STYLES['background'])  $this->backGroundImage = $TBE_STYLES['background'];
    }
















    /*****************************************
     *
     * EVALUATION FUNCTIONS
     * Various centralized processing
     *
     *****************************************/

    /**
     * Makes click menu link (context sensitive menu)
     * 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)
     * 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)
     *
     * @param   string      String to be wrapped in link, typ. image tag.
     * @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
     * @param   integer     If icon is for database record this is the UID for the record from $table
     * @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.
     * @param   string      Additional GET parameters for the link to alt_clickmenu.php
     * @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.
     * @param   boolean     If set, will return only the onclick JavaScript, not the whole link.
     * @return  string      The link-wrapped input string.
     */
    function wrapClickMenuOnIcon($str,$table,$uid='',$listFr=1,$addParams='',$enDisItems='', $returnOnClick=FALSE)  {
        $backPath = rawurlencode($this->backPath).'|'.t3lib_div::shortMD5($this->backPath.'|'.$GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey']);
        $onClick = 'showClickmenu("'.$table.'","'.$uid.'","'.$listFr.'","'.str_replace('+','%2B',$enDisItems).'","'.str_replace('&','&amp;',addcslashes($backPath,'"')).'","'.str_replace('&','&amp;',addcslashes($addParams,'"')).'");return false;';
        return $returnOnClick ? $onClick : '<a href="#" onclick="'.htmlspecialchars($onClick).'"'.($GLOBALS['TYPO3_CONF_VARS']['BE']['useOnContextMenuHandler'] ? ' oncontextmenu="'.htmlspecialchars($onClick).'"' : '').'>'.$str.'</a>';
    }

    /**
     * Makes link to page $id in frontend (view page)
     * Returns an magnifier-glass icon which links to the frontend index.php document for viewing the page with id $id
     * $id must be a page-uid
     * If the BE_USER has access to Web>List then a link to that module is shown as well (with return-url)
     *
     * @param   integer     The page id
     * @param   string      The current "BACK_PATH" (the back relative to the typo3/ directory)
     * @param   string      Additional parameters for the image tag(s)
     * @return  string      HTML string with linked icon(s)
     */
    function viewPageIcon($id,$backPath,$addParams='hspace="3"')    {
        global $BE_USER;
        $str = '';
            // If access to Web>List for user, then link to that module.
        if ($BE_USER->check('modules','web_list'))  {
            $href=$backPath.'db_list.php?id='.$id.'&returnUrl='.rawurlencode(t3lib_div::getIndpEnv('REQUEST_URI'));
            $str.= '<a href="'.htmlspecialchars($href).'">'.
                    '<img'.t3lib_iconWorks::skinImg($backPath,'gfx/list.gif','width="11" height="11"').' title="'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.showList',1).'"'.($addParams?' '.trim($addParams):'').' alt="" />'.
                    '</a>';
        }
            // Make link to view page
        $str.= '<a href="#" onclick="'.htmlspecialchars(t3lib_BEfunc::viewOnClick($id,$backPath,t3lib_BEfunc::BEgetRootLine($id))).'">'.
                '<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="" />'.
                '</a>';
        return $str;
    }

    /**
     * Returns a URL with a command to TYPO3 Core Engine (tce_db.php)
     * See description of the API elsewhere.
     *
     * @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"
     * @param   string      Redirect URL if any other that t3lib_div::getIndpEnv('REQUEST_URI') is wished
     * @return  string      URL to tce_db.php + parameters (backpath is taken from $this->backPath)
     * @see t3lib_BEfunc::editOnClick()
     */
    function issueCommand($params,$rUrl='') {
        $rUrl = $rUrl ? $rUrl : t3lib_div::getIndpEnv('REQUEST_URI');
        return $this->backPath.'tce_db.php?'.
                $params.
                '&redirect='.($rUrl==-1?"'+T3_THIS_LOCATION+'":rawurlencode($rUrl)).
                '&vC='.rawurlencode($GLOBALS['BE_USER']->veriCode()).
                '&prErr=1&uPT=1';
    }

    /**
     * Returns true if click-menu layers can be displayed for the current user/browser
     * Use this to test if click-menus (context sensitive menus) can and should be displayed in the backend.
     *
     * @return  boolean
     */
    function isCMlayers()   {
        return !$GLOBALS['BE_USER']->uc['disableCMlayers'] && $GLOBALS['CLIENT']['FORMSTYLE'] && !($GLOBALS['CLIENT']['SYSTEM']=='mac' && $GLOBALS['CLIENT']['BROWSER']=='Opera');
    }

    /**
     * Returns 'this.blur();' if the client supports CSS styles
     * Use this in links to remove the underlining after being clicked
     *
     * @return  string
     */
    function thisBlur() {
        return ($GLOBALS['CLIENT']['FORMSTYLE']?'this.blur();':'');
    }

    /**
     * Returns ' style='cursor:help;'' if the client supports CSS styles
     * Use for <a>-links to help texts
     *
     * @return  string
     */
    function helpStyle()    {
        return $GLOBALS['CLIENT']['FORMSTYLE'] ? ' style="cursor:help;"':'';
    }

    /**
     * Makes the header (icon+title) for a page (or other record). Used in most modules under Web>*
     * $table and $row must be a tablename/record from that table
     * $path will be shown as alt-text for the icon.
     * The title will be truncated to 45 chars.
     *
     * @param   string      Table name
     * @param   array       Record row
     * @param   string      Alt text
     * @param   boolean     Set $noViewPageIcon true if you don't want a magnifier-icon for viewing the page in the frontend
     * @param   array       $tWrap is an array with indexes 0 and 1 each representing HTML-tags (start/end) which will wrap the title
     * @return  string      HTML content
     */
    function getHeader($table,$row,$path,$noViewPageIcon=0,$tWrap=array('','')) {
        global $TCA;
        if (is_array($row) && $row['uid'])  {
            $iconImgTag=t3lib_iconWorks::getIconImage($table,$row,$this->backPath,'title="'.htmlspecialchars($path).'"');
            $title= strip_tags($row[$TCA[$table]['ctrl']['label']]);
            $viewPage = $noViewPageIcon ? '' : $this->viewPageIcon($row['uid'],$this->backPath,'');
            if ($table=='pages')    $path.=' - '.t3lib_BEfunc::titleAttribForPages($row,'',0);
        } else {
            $iconImgTag='<img'.t3lib_iconWorks::skinImg($this->backPath,'gfx/i/_icon_website.gif',$wHattribs='width="18" height="16"').' title="'.htmlspecialchars($path).'" alt="" />';
            $title=$GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'];
        }

        return '<span class="typo3-moduleHeader">'.$this->wrapClickMenuOnIcon($iconImgTag,$table,$row['uid']).
                $viewPage.
                $tWrap[0].htmlspecialchars(t3lib_div::fixed_lgd_cs($title,45)).$tWrap[1].'</span>';
    }

    /**
     * Like ->getHeader() but for files in the File>* main module/submodules
     * Returns the file-icon with the path of the file set in the alt/title attribute. Shows the file-name after the icon.
     *
     * @param   string      Title string, expected to be the filepath
     * @param   string      Alt text
     * @param   string      The icon file (relative to TYPO3 dir)
     * @return  string      HTML content
     */
    function getFileheader($title,$path,$iconfile)  {
        $fileInfo = t3lib_div::split_fileref($title);
        $title = htmlspecialchars(t3lib_div::fixed_lgd_cs($fileInfo['path'],-35)).'<b>'.htmlspecialchars($fileInfo['file']).'</b>';
        return '<span class="typo3-moduleHeader"><img'.t3lib_iconWorks::skinImg($this->backPath,$iconfile,'width="18" height="16"').' title="'.htmlspecialchars($path).'" alt="" />'.$title.'</span>';
    }

    /**
     * Returns a linked shortcut-icon which will call the shortcut frame and set a shortcut there back to the calling page/module
     *
     * @param   string      Is the list of GET variables to store (if any)
     * @param   string      Is the list of SET[] variables to store (if any) - SET[] variables a stored in $GLOBALS["SOBE"]->MOD_SETTINGS for backend modules
     * @param   string      Module name string
     * @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.
     * @return  string      HTML content
     */
    function makeShortcutIcon($gvList,$setList,$modName,$motherModName="")  {
        $backPath=$this->backPath;
        $storeUrl=$this->makeShortcutUrl($gvList,$setList);
        $pathInfo = parse_url(t3lib_div::getIndpEnv('REQUEST_URI'));

            // Add the module identifier automatically if typo3/mod.php is used:
        if (ereg('typo3/mod\.php$', $pathInfo['path']) && isset($GLOBALS['TBE_MODULES']['_PATHS'][$modName])) {
            $storeUrl = '&M='.$modName.$storeUrl;
        }

        if (!strcmp($motherModName,'1'))    {
            $mMN="&motherModName='+top.currentModuleLoaded+'";
        } elseif ($motherModName)   {
            $mMN='&motherModName='.rawurlencode($motherModName);
        } else $mMN='';

        $onClick = 'top.ShortcutManager.createShortcut('
            .$GLOBALS['LANG']->JScharCode($GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.makeShortcut')).', '
            .'\''.$backPath.'\', '
            .'\''.rawurlencode($modName).'\', '
            .'\''.rawurlencode($pathInfo['path']."?".$storeUrl).$mMN.'\''
        .');return false;';

        $sIcon = '<a href="#" onclick="'.htmlspecialchars($onClick).'"><img'.t3lib_iconWorks::skinImg($backPath,'gfx/shortcut.gif','width="14" height="14"').' title="'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.makeShortcut',1).'" alt="" /></a>';
        return $sIcon;
    }

    /**
     * MAKE url for storing
     * Internal func
     *
     * @param   string      Is the list of GET variables to store (if any)
     * @param   string      Is the list of SET[] variables to store (if any) - SET[] variables a stored in $GLOBALS["SOBE"]->MOD_SETTINGS for backend modules
     * @return  string
     * @access private
     * @see makeShortcutIcon()
     */
    function makeShortcutUrl($gvList,$setList)  {
        $GET = t3lib_div::_GET();
        $storeArray = array_merge(
            t3lib_div::compileSelectedGetVarsFromArray($gvList,$GET),
            array('SET'=>t3lib_div::compileSelectedGetVarsFromArray($setList, (array)$GLOBALS['SOBE']->MOD_SETTINGS))
        );
        $storeUrl = t3lib_div::implodeArrayForUrl('',$storeArray);
        return $storeUrl;
    }

    /**
     * Returns <input> attributes to set the width of an text-type input field.
     * For client browsers with no CSS support the cols/size attribute is returned.
     * For CSS compliant browsers (recommended) a ' style="width: ...px;"' is returned.
     *
     * @param   integer     A relative number which multiplied with approx. 10 will lead to the width in pixels
     * @param   boolean     A flag you can set for textareas - DEPRECATED, use ->formWidthText() for textareas!!!
     * @param   string      A string which will be returned as attribute-value for style="" instead of the calculated width (if CSS is enabled)
     * @return  string      Tag attributes for an <input> tag (regarding width)
     * @see formWidthText()
     */
    function formWidth($size=48,$textarea=0,$styleOverride='') {
        $wAttrib = $textarea?'cols':'size';
        if (!$GLOBALS['CLIENT']['FORMSTYLE'])   {   // If not setting the width by style-attribute
            $size = $size;
            $retVal = ' '.$wAttrib.'="'.$size.'"';
        } else {    // Setting width by style-attribute. 'cols' MUST be avoided with NN6+
            $pixels = ceil($size*$this->form_rowsToStylewidth);
            $retVal = $styleOverride ? ' style="'.$styleOverride.'"' : ' style="width:'.$pixels.'px;"';
        }
        return $retVal;
    }

    /**
     * This function is dedicated to textareas, which has the wrapping on/off option to observe.
     * EXAMPLE:
     *      <textarea rows="10" wrap="off" '.$GLOBALS["TBE_TEMPLATE"]->formWidthText(48,"","off").'>
     *   or
     *      <textarea rows="10" wrap="virtual" '.$GLOBALS["TBE_TEMPLATE"]->formWidthText(48,"","virtual").'>
     *
     * @param   integer     A relative number which multiplied with approx. 10 will lead to the width in pixels
     * @param   string      A string which will be returned as attribute-value for style="" instead of the calculated width (if CSS is enabled)
     * @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.
     * @return  string      Tag attributes for an <input> tag (regarding width)
     * @see formWidth()
     */
    function formWidthText($size=48,$styleOverride='',$wrap='') {
        $wTags = $this->formWidth($size,1,$styleOverride);
            // 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...
        if (strtolower(trim($wrap))!='off' && $GLOBALS['CLIENT']['BROWSER']=='net' && $GLOBALS['CLIENT']['VERSION']>=5) {
            $wTags.=' cols="'.$size.'"';
        }
        return $wTags;
    }

    /**
     * Returns JavaScript variables setting the returnUrl and thisScript location for use by JavaScript on the page.
     * Used in fx. db_list.php (Web>List)
     *
     * @param   string      URL to "this location" / current script
     * @return  string
     * @see typo3/db_list.php
     */
    function redirectUrls($thisLocation='') {
        $thisLocation = $thisLocation?$thisLocation:t3lib_div::linkThisScript(
        array(
            'CB'=>'',
            'SET'=>'',
            'cmd' => '',
            'popViewId'=>''
        ));

        $out ="
    var T3_RETURN_URL = '".str_replace('%20','',rawurlencode(t3lib_div::_GP('returnUrl')))."';
    var T3_THIS_LOCATION = '".str_replace('%20','',rawurlencode($thisLocation))."';
        ";
        return $out;
    }

    /**
     * Returns a formatted string of $tstamp
     * Uses $GLOBALS['TYPO3_CONF_VARS']['SYS']['hhmm'] and $GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'] to format date and time
     *
     * @param   integer     UNIX timestamp, seconds since 1970
     * @param   integer     How much data to show: $type = 1: hhmm, $type = 10: ddmmmyy
     * @return  string      Formatted timestamp
     */
    function formatTime($tstamp,$type)  {
        $dateStr = '';
        switch($type)   {
            case 1: $dateStr = date($GLOBALS['TYPO3_CONF_VARS']['SYS']['hhmm'],$tstamp);
            break;
            case 10: $dateStr = date($GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'],$tstamp);
            break;
        }
        return $dateStr;
    }

    /**
     * Returns script parsetime IF ->parseTimeFlag is set and user is "admin"
     * Automatically outputted in page end
     *
     * @return  string
     */
    function parseTime()    {
        if ($this->parseTimeFlag && $GLOBALS['BE_USER']->isAdmin()) {
            return '<p>(ParseTime: '.(t3lib_div::milliseconds()-$GLOBALS['PARSETIME_START']).' ms</p>
                    <p>REQUEST_URI-length: '.strlen(t3lib_div::getIndpEnv('REQUEST_URI')).')</p>';
        }
    }












    /*****************************************
     *
     *  PAGE BUILDING FUNCTIONS.
     *  Use this to build the HTML of your backend modules
     *
     *****************************************/

    /**
     * Returns page start
     * This includes the proper header with charset, title, meta tag and beginning body-tag.
     *
     * @param   string      HTML Page title for the header
     * @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)
     * @see endPage()
     */
    function startPage($title)  {
            // hook pre start page
        if (isset($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/template.php']['preStartPageHook'])) {
            $preStartPageHook =& $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/template.php']['preStartPageHook'];
            if (is_array($preStartPageHook)) {
                $hookParameters = array(
                    'title' => &$title,
                );
                foreach ($preStartPageHook as $hookFunction)    {
                    t3lib_div::callUserFunction($hookFunction, $hookParameters, $this);
                }
            }
        }

            // Get META tag containing the currently selected charset for backend output. The function sets $this->charSet.
        $charSet = $this->initCharset();
        $generator = $this->generator();

            // For debugging: If this outputs "QuirksMode"/"BackCompat" (IE) the browser runs in quirks-mode. Otherwise the value is "CSS1Compat"
#       $this->JScodeArray[]='alert(document.compatMode);';

            // Send HTTP header for selected charset. Added by Robert Lemke 23.10.2003
        header ('Content-Type:text/html;charset='.$this->charset);

        switch($this->docType)  {
            case 'html_3':
                $headerStart = '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">';
                break;
            case 'xhtml_strict':
                $headerStart = '<!DOCTYPE html
    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<?xml version="1.0" encoding="'.$this->charset.'"?>
<?xml-stylesheet href="#internalStyle" type="text/css"?>
';
                break;
            case 'xhtml_frames':
                $headerStart = '<!DOCTYPE html
     PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
<?xml version="1.0" encoding="'.$this->charset.'"?>
';
                break;
            // The fallthrough is intended as XHTML 1.0 transitional is the default for the BE.
            case 'xhtml_trans':
            default:
                $headerStart = '<!DOCTYPE html
     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<?xml version="1.0" encoding="'.$this->charset.'"?>
<?xml-stylesheet href="#internalStyle" type="text/css"?>
';
        }

        // This loads the tabulator-in-textarea feature. It automatically modifies
        // every textarea which is found.
        if (!$GLOBALS['BE_USER']->uc['disableTabInTextarea']) {
            $this->loadJavascriptLib('tab.js');
        }

            // Construct page header.
        $str = $headerStart.'
<html>
<head>
    <!-- TYPO3 Script ID: '.htmlspecialchars($this->scriptID).' -->
    '.$charSet.'
    '.$generator.'
    <title>'.htmlspecialchars($title).'</title>
    '.$this->docStyle().'
    '.implode("\n", $this->JScodeLibArray).'
    '.$this->JScode.'
    '.$this->wrapScriptTags(implode("\n", $this->JScodeArray)).'
    <!--###POSTJSMARKER###-->
</head>
';
        $this->JScodeLibArray=array();
        $this->JScode='';
        $this->JScodeArray=array();

        if ($this->docType=='xhtml_frames') {
            return $str;
        } else
$str.=$this->docBodyTagBegin().
($this->divClass?'

<!-- Wrapping DIV-section for whole page BEGIN -->
<div class="'.$this->divClass.'">
':'').trim($this->form);
        return $str;
    }

    /**
     * Returns page end; This includes finishing form, div, body and html tags.
     *
     * @return  string      The HTML end of a page
     * @see startPage()
     */
    function endPage()  {
        $str = $this->sectionEnd().
                $this->postCode.
                $this->endPageJS().
                $this->wrapScriptTags(t3lib_BEfunc::getUpdateSignalCode()).
                $this->parseTime().
                ($this->form?'
</form>':'');

        if ($this->docType!='xhtml_frames') {

            $str .= ($this->divClass?'

<!-- Wrapping DIV-section for whole page END -->
</div>':'').'
</body> ';

        }

        $str .= '</html>';

            // Logging: Can't find better place to put it:
        if (TYPO3_DLOG) t3lib_div::devLog('END of BACKEND session', 'template', 0, array('_FLUSH' => true));

        return $str;
    }

    /**
     * Returns the header-bar in the top of most backend modules
     * Closes section if open.
     *
     * @param   string      The text string for the header
     * @return  string      HTML content
     */
    function header($text)  {
        $str='

    <!-- MAIN Header in page top -->
    <h2>'.htmlspecialchars($text).'</h2>
';
        return $this->sectionEnd().$str;
    }

    /**
     * Begins an output section and sets header and content
     *
     * @param   string      The header
     * @param   string      The HTML-content
     * @param   boolean     A flag that will prevent the header from being converted to uppercase
     * @param   boolean     Defines the type of header (if set, "<h3>" rather than the default "h4")
     * @param   integer     The number of an icon to show with the header (see the icon-function). -1,1,2,3
     * @param   boolean     If set, HTML tags are allowed in $label (otherwise this value is by default htmlspecialchars()'ed)
     * @return  string      HTML content
     * @see icons(), sectionHeader()
     */
    function section($label,$text,$nostrtoupper=FALSE,$sH=FALSE,$type=0,$allowHTMLinHeader=FALSE)   {
        $str='';

            // Setting header
        if ($label) {
            if (!$allowHTMLinHeader)    $label = htmlspecialchars($label);
            $str.=$this->sectionHeader($this->icons($type).$label, $sH, $nostrtoupper ? '' : ' class="uppercase"');
        }
            // Setting content
        $str.='

    <!-- Section content -->
'.$text;

        return $this->sectionBegin().$str;
    }

    /**
     * Inserts a divider image
     * Ends a section (if open) before inserting the image
     *
     * @param   integer     The margin-top/-bottom of the <hr> ruler.
     * @return  string      HTML content
     */
    function divider($dist) {
        $dist = intval($dist);
        $str='

    <!-- DIVIDER -->
    <hr style="margin-top: '.$dist.'px; margin-bottom: '.$dist.'px;" />
';
        return $this->sectionEnd().$str;
    }

    /**
     * Returns a blank <div>-section with a height
     *
     * @param   integer     Padding-top for the div-section (should be margin-top but konqueror (3.1) doesn't like it :-(
     * @return  string      HTML content
     */
    function spacer($dist)  {
        if ($dist>0)    {
            return '

    <!-- Spacer element -->
    <div style="padding-top: '.intval($dist).'px;"></div>
';
        }
    }

    /**
     * Make a section header.
     * Begins a section if not already open.
     *
     * @param   string      The label between the <h3> or <h4> tags. (Allows HTML)
     * @param   boolean     If set, <h3> is used, otherwise <h4>
     * @param   string      Additional attributes to h-tag, eg. ' class=""'
     * @return  string      HTML content
     */
    function sectionHeader($label,$sH=FALSE,$addAttrib='')  {
        $tag = ($sH?'h3':'h4');
        $str='

    <!-- Section header -->
    <'.$tag.$addAttrib.'>'.$label.'</'.$tag.'>
';
        return $this->sectionBegin().$str;
    }

    /**
     * Begins an output section.
     * Returns the <div>-begin tag AND sets the ->sectionFlag true (if the ->sectionFlag is not already set!)
     * 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!
     *
     * @return  string      HTML content
     */
    function sectionBegin() {
        if (!$this->sectionFlag)    {
            $this->sectionFlag=1;
            $str='

    <!-- ***********************
          Begin output section.
         *********************** -->
    <div>
';
            return $str;
        } else return '';
    }

    /**
     * Ends and output section
     * Returns the </div>-end tag AND clears the ->sectionFlag (but does so only IF the sectionFlag is set - that is a section is 'open')
     * See sectionBegin() also.
     *
     * @return  string      HTML content
     */
    function sectionEnd()   {
        if ($this->sectionFlag) {
            $this->sectionFlag=0;
            return '
    </div>
    <!-- *********************
          End output section.
         ********************* -->
';
        } else return '';
    }

    /**
     * Originally it printed a kind of divider.
     * Deprecated. Just remove function calls to it or call the divider() function instead.
     *
     * @return  void
     * @internal
     * @deprecated since TYPO3 4.0
     */
    function middle()   {
    }

    /**
     * If a form-tag is defined in ->form then and end-tag for that <form> element is outputted
     * Further a JavaScript section is outputted which will update the top.busy session-expiry object (unless $this->endJS is set to false)
     *
     * @return  string      HTML content (<script> tag section)
     */
    function endPageJS()    {
        return ($this->endJS?'
    <script type="text/javascript">
          /*<![CDATA[*/
        if (top.busy && top.busy.loginRefreshed) {
            top.busy.loginRefreshed();
        }
         /*]]>*/
    </script>':'');
    }

    /**
     * Creates the bodyTag.
     * You can add to the bodyTag by $this->bodyTagAdditions
     *
     * @return  string      HTML body tag
     */
    function docBodyTagBegin()  {
        $bodyContent = 'body onclick="if (top.menuReset) top.menuReset();" '.trim($this->bodyTagAdditions.($this->bodyTagId ? ' id="'.$this->bodyTagId.'"' : ''));
        return '<'.trim($bodyContent).'>';
    }

    /**
     * Outputting document style
     *
     * @return  string      HTML style section/link tags
     */
    function docStyle() {

            // Request background image:
        if ($this->backGroundImage) {
            $this->inDocStylesArray[]=' BODY { background-image: url('.$this->backPath.$this->backGroundImage.'); }';
        }

            // Add inDoc styles variables as well:
        $this->inDocStylesArray[] = $this->inDocStyles;
        $this->inDocStylesArray[] = $this->inDocStyles_TBEstyle;

            // Implode it all:
        $inDocStyles = implode('
                    ',$this->inDocStylesArray);

            // The default color scheme should also in full be represented in the stylesheet.
        $style=trim('
            '.($this->styleSheetFile?'<link rel="stylesheet" type="text/css" href="'.$this->backPath.$this->styleSheetFile.'" />':'').'
            '.($this->styleSheetFile2?'<link rel="stylesheet" type="text/css" href="'.$this->backPath.$this->styleSheetFile2.'" />':'').'
            <style type="text/css" id="internalStyle">
                /*<![CDATA[*/
                    '.trim($inDocStyles).'
                    /*###POSTCSSMARKER###*/
                /*]]>*/
            </style>
            '.($this->styleSheetFile_post?'<link rel="stylesheet" type="text/css" href="'.$this->backPath.$this->styleSheetFile_post.'" />':'').'
            '.implode("\n", $this->additionalStyleSheets)
        )
        ;
        $this->inDocStyles='';
        $this->inDocStylesArray=array();

        return '
            '.$style;
    }

    /**
     * Insert additional style sheet link
     *
     * @param   string      $key: some key identifying the style sheet
     * @param   string      $href: uri to the style sheet file
     * @param   string      $title: value for the title attribute of the link element
     * @return  string      $relation: value for the rel attribute of the link element
     * @return  void
     */
    function addStyleSheet($key, $href, $title='', $relation='stylesheet') {
        if (!isset($this->additionalStyleSheets[$key])) {
            $this->additionalStyleSheets[$key] = '<link rel="' . $relation . '" type="text/css" href="' . $href . '"' . ($title ? (' title="' . $title . '"') : '') . ' />';
        }
     }

    /**
     * Insert post rendering document style into already rendered content
     * This is needed for extobjbase
     *
     * @param   string      style-content to insert.
     * @return  string      content with inserted styles
     */
    function insertStylesAndJS($content)    {
            // insert accumulated CSS
        $this->inDocStylesArray[] = $this->inDocStyles;
        $styles = "\n".implode("\n", $this->inDocStylesArray);
        $content = str_replace('/*###POSTCSSMARKER###*/',$styles,$content);

            // insert accumulated JS
        $jscode = $this->JScode."\n".$this->wrapScriptTags(implode("\n", $this->JScodeArray));
        $content = str_replace('<!--###POSTJSMARKER###-->',$jscode,$content);

        return $content;
    }

    /**
     * Initialize the charset.
     * Sets the internal $this->charset variable to the charset defined in $GLOBALS["LANG"] (or the default as set in this class)
     * Returns the meta-tag for the document header
     *
     * @return  string      <meta> tag with charset from $this->charset or $GLOBALS['LANG']->charSet
     */
    function initCharset()  {
            // Set charset to the charset provided by the current backend users language selection:
        $this->charset = $GLOBALS['LANG']->charSet ? $GLOBALS['LANG']->charSet : $this->charset;
            // Return meta tag:
        return '<meta http-equiv="Content-Type" content="text/html; charset='.$this->charset.'" />';
    }

    /**
     * Returns generator meta tag
     *
     * @return  string      <meta> tag with name "generator"
     */
    function generator()    {
        $str = 'TYPO3 '.TYPO3_branch.', http://typo3.com, &#169; Kasper Sk&#229;rh&#248;j 1998-2008, extensions are copyright of their respective owners.';
        return '<meta name="generator" content="'.$str .'" />';
    }








    /*****************************************
     *
     * OTHER ELEMENTS
     * Tables, buttons, formatting dimmed/red strings
     *
     ******************************************/


    /**
     * Returns an image-tag with an 18x16 icon of the following types:
     *
     * $type:
     * -1:  OK icon (Check-mark)
     * 1:   Notice (Speach-bubble)
     * 2:   Warning (Yellow triangle)
     * 3:   Fatal error (Red stop sign)
     *
     * @param   integer     See description
     * @param   string      Value for style attribute
     * @return  string      HTML image tag (if applicable)
     */
    function icons($type, $styleAttribValue='') {
        switch($type)   {
            case '3':
                $icon = 'gfx/icon_fatalerror.gif';
            break;
            case '2':
                $icon = 'gfx/icon_warning.gif';
            break;
            case '1':
                $icon = 'gfx/icon_note.gif';
            break;
            case '-1':
                $icon = 'gfx/icon_ok.gif';
            break;
            default:
            break;
        }
        if ($icon)  {
            return '<img'.t3lib_iconWorks::skinImg($this->backPath,$icon,'width="18" height="16"').' class="absmiddle"'.($styleAttribValue ? ' style="'.htmlspecialchars($styleAttribValue).'"' : '').' alt="" />';
        }
    }

    /**
     * Returns an <input> button with the $onClick action and $label
     *
     * @param   string      The value of the onclick attribute of the input tag (submit type)
     * @param   string      The label for the button (which will be htmlspecialchar'ed)
     * @return  string      A <input> tag of the type "submit"
     */
    function t3Button($onClick,$label)  {
        $button = '<input type="submit" onclick="'.htmlspecialchars($onClick).'; return false;" value="'.htmlspecialchars($label).'" />';
        return $button;
    }

    /**
     * dimmed-fontwrap. Returns the string wrapped in a <span>-tag defining the color to be gray/dimmed
     *
     * @param   string      Input string
     * @return  string      Output string
     */
    function dfw($string)   {
        return '<span class="typo3-dimmed">'.$string.'</span>';
    }