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