Added feature #7150: Add pageUnavailable_handling for system problems and maintenance
[Packages/TYPO3.CMS.git] / typo3 / class.webpagetree.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 1999-2006 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 * Page navigation tree for the Web module
29 *
30 * Revised for TYPO3 3.6 2/2003 by Kasper Skaarhoj
31 * XHTML compliant
32 *
33 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
34 * @author Benjamin Mack <bmack@xnos.org>
35 *
36 *
37 * [CLASS/FUNCTION INDEX of SCRIPT]
38 *
39 *
40 *
41 * 71: class webPageTree extends t3lib_browseTree
42 * 81: function webPageTree()
43 * 92: function wrapIcon($icon,&$row)
44 * 130: function wrapStop($str,$row)
45 * 146: function wrapTitle($title,$row,$bank=0)
46 * 165: function printTree($treeArr = '')
47 * 271: function PMicon($row,$a,$c,$nextCount,$exp)
48 * 292: function PMiconATagWrap($icon, $cmd, $isExpand = true)
49 * 309: function getBrowsableTree()
50 * 377: function getTree($uid, $depth=999, $depthData='',$blankLineCode='',$subCSSclass='')
51 *
52 *
53 * TOTAL FUNCTIONS: 9
54 * (This index is automatically created/updated by the extension "extdeveval")
55 *
56 */
57
58
59 require_once(PATH_t3lib.'class.t3lib_browsetree.php');
60
61
62 /**
63 * Extension class for the t3lib_browsetree class, specially made
64 * for browsing pages in the Web module
65 *
66 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
67 * @author Benjamin Mack <bmack@xnos.org>
68 * @package TYPO3
69 * @subpackage core
70 * @see class t3lib_browseTree
71 */
72 class webPageTree extends t3lib_browseTree {
73
74 var $ext_showPageId;
75 var $ext_IconMode;
76 var $ext_separateNotinmenuPages;
77 var $ext_alphasortNotinmenuPages;
78 var $ajaxStatus = false; // Indicates, whether the ajax call was successful, i.e. the requested page has been found
79
80 /**
81 * Calls init functions
82 *
83 * @return void
84 */
85 function webPageTree() {
86 $this->init();
87 }
88
89 /**
90 * Wrapping icon in browse tree
91 *
92 * @param string Icon IMG code
93 * @param array Data row for element.
94 * @return string Page icon
95 */
96 function wrapIcon($icon,&$row) {
97 // If the record is locked, present a warning sign.
98 if ($lockInfo=t3lib_BEfunc::isRecordLocked('pages',$row['uid'])) {
99 $aOnClick = 'alert('.$GLOBALS['LANG']->JScharCode($lockInfo['msg']).');return false;';
100 $lockIcon='<a href="#" onclick="'.htmlspecialchars($aOnClick).'">'.
101 '<img'.t3lib_iconWorks::skinImg('','gfx/recordlock_warning3.gif','width="17" height="12"').' title="'.htmlspecialchars($lockInfo['msg']).'" alt="" />'.
102 '</a>';
103 } else $lockIcon = '';
104
105 // Add title attribute to input icon tag
106 $thePageIcon = $this->addTagAttributes($icon, $this->titleAttrib.'="'.$this->getTitleAttrib($row).'"');
107
108 // Wrap icon in click-menu link.
109 if (!$this->ext_IconMode) {
110 $thePageIcon = $GLOBALS['TBE_TEMPLATE']->wrapClickMenuOnIcon($thePageIcon,'pages',$row['uid'],0,'&bank='.$this->bank);
111 } elseif (!strcmp($this->ext_IconMode,'titlelink')) {
112 $aOnClick = 'return jumpTo(\''.$this->getJumpToParam($row).'\',this,\''.$this->treeName.'\');';
113 $thePageIcon='<a href="#" onclick="'.htmlspecialchars($aOnClick).'">'.$thePageIcon.'</a>';
114 }
115
116 // Wrap icon in a drag/drop span.
117 $dragDropIcon = '<span class="dragIcon" id="dragIconID_'.$row['uid'].'">'.$thePageIcon.'</span>';
118
119 // Add Page ID:
120 $pageIdStr = '';
121 if ($this->ext_showPageId) { $pageIdStr = '['.$row['uid'].']&nbsp;'; }
122
123 // Call stats information hook
124 $stat = '';
125 if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['GLOBAL']['recStatInfoHooks'])) {
126 $_params = array('pages',$row['uid']);
127 foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['GLOBAL']['recStatInfoHooks'] as $_funcRef) {
128 $stat.=t3lib_div::callUserFunction($_funcRef,$_params,$this);
129 }
130 }
131
132 return $dragDropIcon.$lockIcon.$pageIdStr.$stat;
133 }
134
135 /**
136 * Adds a red "+" to the input string, $str, if the field "php_tree_stop" in the $row (pages) is set
137 *
138 * @param string Input string, like a page title for the tree
139 * @param array record row with "php_tree_stop" field
140 * @return string Modified string
141 * @access private
142 */
143 function wrapStop($str,$row) {
144 if ($row['php_tree_stop']) {
145 $str.='<a href="'.htmlspecialchars(t3lib_div::linkThisScript(array('setTempDBmount' => $row['uid']))).'" class="typo3-red">+</a> ';
146 }
147 return $str;
148 }
149
150 /**
151 * Wrapping $title in a-tags.
152 *
153 * @param string Title string
154 * @param string Item record
155 * @param integer Bank pointer (which mount point number)
156 * @return string
157 * @access private
158 */
159 function wrapTitle($title,$row,$bank=0) {
160 $aOnClick = 'return jumpTo(\''.$this->getJumpToParam($row).'\',this,\''.$this->domIdPrefix.$this->getId($row).'\','.$bank.');';
161 $CSM = '';
162 if ($GLOBALS['TYPO3_CONF_VARS']['BE']['useOnContextMenuHandler']) {
163 $CSM = ' oncontextmenu="'.htmlspecialchars($GLOBALS['TBE_TEMPLATE']->wrapClickMenuOnIcon('','pages',$row['uid'],0,'&bank='.$this->bank,'',TRUE)).';"';
164 }
165 $thePageTitle='<a href="#" onclick="'.htmlspecialchars($aOnClick).'"'.$CSM.'>'.$title.'</a>';
166
167 // Wrap title in a drag/drop span.
168 return '<span class="dragTitle" id="dragTitleID_'.$row['uid'].'">'.$thePageTitle.'</span>';
169 }
170
171
172 /**
173 * Compiles the HTML code for displaying the structure found inside the ->tree array
174 *
175 * @param array "tree-array" - if blank string, the internal ->tree array is used.
176 * @return string The HTML code for the tree
177 */
178 function printTree($treeArr = '') {
179 $titleLen = intval($this->BE_USER->uc['titleLen']);
180 if (!is_array($treeArr)) {
181 $treeArr = $this->tree;
182 }
183
184 $out = '
185 <!-- TYPO3 tree structure. -->
186 <ul class="tree" id="treeRoot">
187 ';
188
189 // -- evaluate AJAX request
190 // IE takes anchor as parameter
191 $PM = t3lib_div::_GP('PM');
192 if(($PMpos = strpos($PM, '#')) !== false) { $PM = substr($PM, 0, $PMpos); }
193 $PM = explode('_', $PM);
194 if((TYPO3_REQUESTTYPE & TYPO3_REQUESTTYPE_AJAX) && is_array($PM) && count($PM)==4) {
195 if($PM[1]) {
196 $expandedPageUid = $PM[2];
197 $ajaxOutput = '';
198 $invertedDepthOfAjaxRequestedItem = 0; // We don't know yet. Will be set later.
199 $doExpand = true;
200 } else {
201 $collapsedPageUid = $PM[2];
202 $doCollapse = true;
203 }
204 }
205
206 // we need to count the opened <ul>'s every time we dig into another level,
207 // so we know how many we have to close when all children are done rendering
208 $closeDepth = array();
209
210 foreach($treeArr as $k => $v) {
211 $classAttr = $v['row']['_CSSCLASS'];
212 $uid = $v['row']['uid'];
213 $idAttr = htmlspecialchars($this->domIdPrefix.$this->getId($v['row']).'_'.$v['bank']);
214 $itemHTML = '';
215
216 // if this item is the start of a new level,
217 // then a new level <ul> is needed, but not in ajax mode
218 if($v['isFirst'] && !($doCollapse) && !($doExpand && $expandedPageUid == $uid)) {
219 $itemHTML = '<ul>';
220 }
221
222 // add CSS classes to the list item
223 if($v['hasSub']) { $classAttr .= ($classAttr) ? ' expanded': 'expanded'; }
224 if($v['isLast']) { $classAttr .= ($classAttr) ? ' last' : 'last'; }
225
226 $itemHTML .='
227 <li id="'.$idAttr.'"'.($classAttr ? ' class="'.$classAttr.'"' : '').'>'.
228 $v['HTML'].
229 $this->wrapTitle($this->getTitleStr($v['row'],$titleLen),$v['row'],$v['bank'])."\n";
230
231
232 if(!$v['hasSub']) { $itemHTML .= '</li>'; }
233
234 // we have to remember if this is the last one
235 // on level X so the last child on level X+1 closes the <ul>-tag
236 if($v['isLast'] && !($doExpand && $expandedPageUid == $uid)) { $closeDepth[$v['invertedDepth']] = 1; }
237
238
239 // if this is the last one and does not have subitems, we need to close
240 // the tree as long as the upper levels have last items too
241 if($v['isLast'] && !$v['hasSub'] && !$doCollapse && !($doExpand && $expandedPageUid == $uid)) {
242 for ($i = $v['invertedDepth']; $closeDepth[$i] == 1; $i++) {
243 $closeDepth[$i] = 0;
244 $itemHTML .= '</ul></li>';
245 }
246 }
247
248 // ajax request: collapse
249 if($doCollapse && $collapsedPageUid == $uid) {
250 $this->ajaxStatus = true;
251 return $itemHTML;
252 }
253
254 // ajax request: expand
255 if($doExpand && $expandedPageUid == $uid) {
256 $ajaxOutput .= $itemHTML;
257 $invertedDepthOfAjaxRequestedItem = $v['invertedDepth'];
258 } elseif($invertedDepthOfAjaxRequestedItem) {
259 if($v['invertedDepth'] < $invertedDepthOfAjaxRequestedItem) {
260 $ajaxOutput .= $itemHTML;
261 } else {
262 $this->ajaxStatus = true;
263 return $ajaxOutput;
264 }
265 }
266
267 $out .= $itemHTML;
268 }
269
270 if($ajaxOutput) {
271 $this->ajaxStatus = true;
272 return $ajaxOutput;
273 }
274
275 // finally close the first ul
276 $out .= '</ul>';
277 return $out;
278 }
279
280
281 /**
282 * Generate the plus/minus icon for the browsable tree.
283 *
284 * @param array record for the entry
285 * @param integer The current entry number
286 * @param integer The total number of entries. If equal to $a, a "bottom" element is returned.
287 * @param integer The number of sub-elements to the current element.
288 * @param boolean The element was expanded to render subelements if this flag is set.
289 * @return string Image tag with the plus/minus icon.
290 * @access private
291 * @see t3lib_pageTree::PMicon()
292 */
293 function PMicon($row,$a,$c,$nextCount,$exp) {
294 $PM = $nextCount ? ($exp ? 'minus' : 'plus') : 'join';
295 $BTM = ($a == $c) ? 'bottom' : '';
296 $icon = '<img'.t3lib_iconWorks::skinImg($this->backPath,'gfx/ol/'.$PM.$BTM.'.gif','width="18" height="16"').' alt="" />';
297
298 if ($nextCount) {
299 $cmd = $this->bank.'_'.($exp?'0_':'1_').$row['uid'].'_'.$this->treeName;
300 $icon = $this->PMiconATagWrap($icon,$cmd,!$exp);
301 }
302 return $icon;
303 }
304
305
306 /**
307 * Wrap the plus/minus icon in a link
308 *
309 * @param string HTML string to wrap, probably an image tag.
310 * @param string Command for 'PM' get var
311 * @return string Link-wrapped input string
312 * @access private
313 */
314 function PMiconATagWrap($icon, $cmd, $isExpand = true) {
315 if ($this->thisScript) {
316 // activate dynamic ajax-based tree
317 $js = htmlspecialchars('Tree.load(\''.$cmd.'\', '.intval($isExpand).', this);');
318 return '<a class="pm" onclick="'.$js.'">'.$icon.'</a>';
319 } else {
320 return $icon;
321 }
322 }
323
324
325 /**
326 * Will create and return the HTML code for a browsable tree
327 * Is based on the mounts found in the internal array ->MOUNTS (set in the constructor)
328 *
329 * @return string HTML code for the browsable tree
330 */
331 function getBrowsableTree() {
332
333 // Get stored tree structure AND updating it if needed according to incoming PM GET var.
334 $this->initializePositionSaving();
335
336 // Init done:
337 $titleLen = intval($this->BE_USER->uc['titleLen']);
338 $treeArr = array();
339
340 // Traverse mounts:
341 foreach($this->MOUNTS as $idx => $uid) {
342
343 // Set first:
344 $this->bank = $idx;
345 $isOpen = $this->stored[$idx][$uid] || $this->expandFirst;
346
347 // Save ids while resetting everything else.
348 $curIds = $this->ids;
349 $this->reset();
350 $this->ids = $curIds;
351
352 // Set PM icon for root of mount:
353 $cmd = $this->bank.'_'.($isOpen? "0_" : "1_").$uid.'_'.$this->treeName;
354 $icon='<img'.t3lib_iconWorks::skinImg($this->backPath,'gfx/ol/'.($isOpen?'minus':'plus').'only.gif').' alt="" />';
355 $firstHtml = $this->PMiconATagWrap($icon,$cmd);
356
357 // Preparing rootRec for the mount
358 if ($uid) {
359 $rootRec = $this->getRecord($uid);
360 $firstHtml.=$this->getIcon($rootRec);
361 } else {
362 // Artificial record for the tree root, id=0
363 $rootRec = $this->getRootRecord($uid);
364 $firstHtml.=$this->getRootIcon($rootRec);
365 }
366
367 if (is_array($rootRec)) {
368 // In case it was swapped inside getRecord due to workspaces.
369 $uid = $rootRec['uid'];
370
371 // Add the root of the mount to ->tree
372 $this->tree[] = array('HTML'=>$firstHtml, 'row'=>$rootRec, 'bank'=>$this->bank, 'hasSub'=>true, 'invertedDepth'=>1000);
373
374 // If the mount is expanded, go down:
375 if ($isOpen) {
376 // Set depth:
377 if ($this->addSelfId) { $this->ids[] = $uid; }
378 $this->getTree($uid, 999, '', $rootRec['_SUBCSSCLASS']);
379 }
380 // Add tree:
381 $treeArr=array_merge($treeArr,$this->tree);
382 }
383 }
384 return $this->printTree($treeArr);
385 }
386
387
388 /**
389 * Fetches the data for the tree
390 *
391 * @param integer item id for which to select subitems (parent id)
392 * @param integer Max depth (recursivity limit)
393 * @param string ? (internal)
394 * @return integer The count of items on the level
395 */
396 function getTree($uid, $depth=999, $blankLineCode='', $subCSSclass='') {
397
398 // Buffer for id hierarchy is reset:
399 $this->buffer_idH = array();
400
401 // Init vars
402 $depth = intval($depth);
403 $HTML = '';
404 $a = 0;
405
406 $res = $this->getDataInit($uid, $subCSSclass);
407 $c = $this->getDataCount($res);
408 $crazyRecursionLimiter = 999;
409
410 $inMenuPages = array();
411 $outOfMenuPages = array();
412 $outOfMenuPagesTextIndex = array();
413 while ($crazyRecursionLimiter > 0 && $row = $this->getDataNext($res,$subCSSclass)) {
414 $crazyRecursionLimiter--;
415
416 // Not in menu:
417 // @TODO: RFC #7370: doktype 2&5 are deprecated since TYPO3 4.2-beta1
418 if ($this->ext_separateNotinmenuPages && (t3lib_div::inList('5,6',$row['doktype']) || $row['doktype']>=200 || $row['nav_hide'])) {
419 $outOfMenuPages[] = $row;
420 $outOfMenuPagesTextIndex[] = ($row['doktype']>=200 ? 'zzz'.$row['doktype'].'_' : '').$row['title'];
421 } else {
422 $inMenuPages[] = $row;
423 }
424 }
425
426 $label_shownAlphabetically = "";
427 if (count($outOfMenuPages)) {
428 // Sort out-of-menu pages:
429 $outOfMenuPages_alphabetic = array();
430 if ($this->ext_alphasortNotinmenuPages) {
431 asort($outOfMenuPagesTextIndex);
432 $label_shownAlphabetically = " (alphabetic)";
433 }
434 foreach($outOfMenuPagesTextIndex as $idx => $txt) {
435 $outOfMenuPages_alphabetic[] = $outOfMenuPages[$idx];
436 }
437
438 // Merge:
439 $outOfMenuPages_alphabetic[0]['_FIRST_NOT_IN_MENU']=TRUE;
440 $allRows = array_merge($inMenuPages,$outOfMenuPages_alphabetic);
441 } else {
442 $allRows = $inMenuPages;
443 }
444
445 // Traverse the records:
446 foreach ($allRows as $row) {
447 $a++;
448
449 $newID = $row['uid'];
450 $this->tree[]=array(); // Reserve space.
451 end($this->tree);
452 $treeKey = key($this->tree); // Get the key for this space
453 $LN = ($a==$c) ? 'blank' : 'line';
454
455 // If records should be accumulated, do so
456 if ($this->setRecs) { $this->recs[$row['uid']] = $row; }
457
458 // Accumulate the id of the element in the internal arrays
459 $this->ids[]=$idH[$row['uid']]['uid'] = $row['uid'];
460 $this->ids_hierarchy[$depth][] = $row['uid'];
461
462 // Make a recursive call to the next level
463 if ($depth > 1 && $this->expandNext($newID) && !$row['php_tree_stop']) {
464 $nextCount=$this->getTree(
465 $newID,
466 $depth-1,
467 $blankLineCode.','.$LN,
468 $row['_SUBCSSCLASS']
469 );
470 if (count($this->buffer_idH)) { $idH[$row['uid']]['subrow']=$this->buffer_idH; }
471 $exp = 1; // Set "did expand" flag
472 } else {
473 $nextCount = $this->getCount($newID);
474 $exp = 0; // Clear "did expand" flag
475 }
476
477 // Set HTML-icons, if any:
478 if ($this->makeHTML) {
479 if ($row['_FIRST_NOT_IN_MENU']) {
480 $HTML = '<img'.t3lib_iconWorks::skinImg($this->backPath,'gfx/ol/line.gif').' alt="" /><br/><img'.t3lib_iconWorks::skinImg($this->backPath,'gfx/ol/line.gif').' alt="" /><i>Not shown in menu'.$label_shownAlphabetically.':</i><br>';
481 } else {
482 $HTML = '';
483 }
484
485 $HTML.= $this->PMicon($row,$a,$c,$nextCount,$exp);
486 $HTML.= $this->wrapStop($this->getIcon($row),$row);
487 }
488
489 // Finally, add the row/HTML content to the ->tree array in the reserved key.
490 $this->tree[$treeKey] = array(
491 'row' => $row,
492 'HTML' => $HTML,
493 'hasSub' => $nextCount&&$this->expandNext($newID),
494 'isFirst'=> $a==1,
495 'isLast' => false,
496 'invertedDepth'=> $depth,
497 'blankLineCode'=> $blankLineCode,
498 'bank' => $this->bank
499 );
500 }
501
502 if($a) { $this->tree[$treeKey]['isLast'] = true; }
503
504 $this->getDataFree($res);
505 $this->buffer_idH = $idH;
506 return $c;
507 }
508 }
509
510 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['typo3/class.webpagetree.php']) {
511 include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['typo3/class.webpagetree.php']);
512 }
513 ?>