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