- Fixed t3lib_cli that negative numbers (like "-2") is not seen as a parameter
[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_dontSeparateNotinmenuPages;
77 var $ext_dontAlphasortNotinmenuPages;
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)) $treeArr = $this->tree;
181
182 $out = '
183 <!-- TYPO3 tree structure. -->
184 <ul class="tree">
185 ';
186
187 // -- evaluate AJAX request
188 // IE takes anchor as parameter
189 $PM = t3lib_div::_GP('PM');
190 if(($PMpos = strpos($PM, '#')) !== false) { $PM = substr($PM, 0, $PMpos); }
191 $PM = explode('_', $PM);
192 if(($isAjaxCall = t3lib_div::_GP('ajax')) && is_array($PM) && count($PM)==4) {
193 if($PM[1]) {
194 $expandedPageUid = $PM[2];
195 $ajaxOutput = '';
196 $invertedDepthOfAjaxRequestedItem = 0; // We don't know yet. Will be set later.
197 $doExpand = true;
198 } else {
199 $collapsedPageUid = $PM[2];
200 $doCollapse = true;
201 }
202 }
203
204 // we need to count the opened <ul>'s every time we dig into another level,
205 // so we know how many we have to close when all children are done rendering
206 $closeDepth = array();
207
208 foreach($treeArr as $k => $v) {
209 $classAttr = $v['row']['_CSSCLASS'];
210 $uid = $v['row']['uid'];
211 $idAttr = htmlspecialchars($this->domIdPrefix.$this->getId($v['row']).'_'.$v['bank']);
212 $itemHTML = '';
213
214 // if this item is the start of a new level,
215 // then a new level <ul> is needed, but not in ajax mode
216 if($v['isFirst'] && !($doCollapse) && !($doExpand && $expandedPageUid == $uid)) {
217 $itemHTML = '<ul>';
218 }
219
220 // add CSS classes to the list item
221 if($v['hasSub']) { $classAttr .= ($classAttr) ? ' expanded': 'expanded'; }
222 if($v['isLast']) { $classAttr .= ($classAttr) ? ' last' : 'last'; }
223
224 $itemHTML .='
225 <li id="'.$idAttr.'"'.($classAttr ? ' class="'.$classAttr.'"' : '').'>'.
226 $v['HTML'].
227 $this->wrapTitle($this->getTitleStr($v['row'],$titleLen),$v['row'],$v['bank'])."\n";
228
229
230 if(!$v['hasSub']) { $itemHTML .= '</li>'; }
231
232 // we have to remember if this is the last one
233 // on level X so the last child on level X+1 closes the <ul>-tag
234 if($v['isLast'] && !($doExpand && $expandedPageUid == $uid)) { $closeDepth[$v['invertedDepth']] = 1; }
235
236
237 // if this is the last one and does not have subitems, we need to close
238 // the tree as long as the upper levels have last items too
239 if($v['isLast'] && !$v['hasSub'] && !$doCollapse && !($doExpand && $expandedPageUid == $uid)) {
240 for ($i = $v['invertedDepth']; $closeDepth[$i] == 1; $i++) {
241 $closeDepth[$i] = 0;
242 $itemHTML .= '</ul></li>';
243 }
244 }
245
246 // ajax request: collapse
247 if($doCollapse && $collapsedPageUid == $uid) {
248 $this->ajaxStatus = true;
249 return $itemHTML;
250 }
251
252 // ajax request: expand
253 if($doExpand && $expandedPageUid == $uid) {
254 $ajaxOutput .= $itemHTML;
255 $invertedDepthOfAjaxRequestedItem = $v['invertedDepth'];
256 } elseif($invertedDepthOfAjaxRequestedItem) {
257 if($v['invertedDepth'] < $invertedDepthOfAjaxRequestedItem) {
258 $ajaxOutput .= $itemHTML;
259 } else {
260 $this->ajaxStatus = true;
261 return $ajaxOutput;
262 }
263 }
264
265 $out .= $itemHTML;
266 }
267
268 if($ajaxOutput) {
269 $this->ajaxStatus = true;
270 return $ajaxOutput;
271 }
272
273 // finally close the first ul
274 $out .= '</ul>';
275 return $out;
276 }
277
278
279 /**
280 * Generate the plus/minus icon for the browsable tree.
281 *
282 * @param array record for the entry
283 * @param integer The current entry number
284 * @param integer The total number of entries. If equal to $a, a "bottom" element is returned.
285 * @param integer The number of sub-elements to the current element.
286 * @param boolean The element was expanded to render subelements if this flag is set.
287 * @return string Image tag with the plus/minus icon.
288 * @access private
289 * @see t3lib_pageTree::PMicon()
290 */
291 function PMicon($row,$a,$c,$nextCount,$exp) {
292 $PM = $nextCount ? ($exp ? 'minus' : 'plus') : 'join';
293 $BTM = ($a == $c) ? 'bottom' : '';
294 $icon = '<img'.t3lib_iconWorks::skinImg($this->backPath,'gfx/ol/'.$PM.$BTM.'.gif','width="18" height="16"').' alt="" />';
295
296 if ($nextCount) {
297 $cmd = $this->bank.'_'.($exp?'0_':'1_').$row['uid'].'_'.$this->treeName;
298 $icon = $this->PMiconATagWrap($icon,$cmd,!$exp);
299 }
300 return $icon;
301 }
302
303
304 /**
305 * Wrap the plus/minus icon in a link
306 *
307 * @param string HTML string to wrap, probably an image tag.
308 * @param string Command for 'PM' get var
309 * @return string Link-wrapped input string
310 * @access private
311 */
312 function PMiconATagWrap($icon, $cmd, $isExpand = true) {
313 if ($this->thisScript) {
314 // activate dynamic ajax-based tree
315 $js = htmlspecialchars('Tree.load(\''.$cmd.'\', '.intval($isExpand).', this);');
316 return '<a class="pm" onclick="'.$js.'">'.$icon.'</a>';
317 } else {
318 return $icon;
319 }
320 }
321
322
323 /**
324 * Will create and return the HTML code for a browsable tree
325 * Is based on the mounts found in the internal array ->MOUNTS (set in the constructor)
326 *
327 * @return string HTML code for the browsable tree
328 */
329 function getBrowsableTree() {
330
331 // Get stored tree structure AND updating it if needed according to incoming PM GET var.
332 $this->initializePositionSaving();
333
334 // Init done:
335 $titleLen = intval($this->BE_USER->uc['titleLen']);
336 $treeArr = array();
337
338 // Traverse mounts:
339 foreach($this->MOUNTS as $idx => $uid) {
340
341 // Set first:
342 $this->bank = $idx;
343 $isOpen = $this->stored[$idx][$uid] || $this->expandFirst;
344
345 // Save ids while resetting everything else.
346 $curIds = $this->ids;
347 $this->reset();
348 $this->ids = $curIds;
349
350 // Set PM icon for root of mount:
351 $cmd = $this->bank.'_'.($isOpen? "0_" : "1_").$uid.'_'.$this->treeName;
352 $icon='<img'.t3lib_iconWorks::skinImg($this->backPath,'gfx/ol/'.($isOpen?'minus':'plus').'only.gif').' alt="" />';
353 $firstHtml = $this->PMiconATagWrap($icon,$cmd);
354
355 // Preparing rootRec for the mount
356 if ($uid) {
357 $rootRec = $this->getRecord($uid);
358 $firstHtml.=$this->getIcon($rootRec);
359 } else {
360 // Artificial record for the tree root, id=0
361 $rootRec = $this->getRootRecord($uid);
362 $firstHtml.=$this->getRootIcon($rootRec);
363 }
364
365 if (is_array($rootRec)) {
366 // In case it was swapped inside getRecord due to workspaces.
367 $uid = $rootRec['uid'];
368
369 // Add the root of the mount to ->tree
370 $this->tree[] = array('HTML'=>$firstHtml, 'row'=>$rootRec, 'bank'=>$this->bank, 'hasSub'=>true, 'invertedDepth'=>1000);
371
372 // If the mount is expanded, go down:
373 if ($isOpen) {
374 // Set depth:
375 if ($this->addSelfId) { $this->ids[] = $uid; }
376 $this->getTree($uid, 999, '', $rootRec['_SUBCSSCLASS']);
377 }
378 // Add tree:
379 $treeArr=array_merge($treeArr,$this->tree);
380 }
381 }
382 return $this->printTree($treeArr);
383 }
384
385
386 /**
387 * Fetches the data for the tree
388 *
389 * @param integer item id for which to select subitems (parent id)
390 * @param integer Max depth (recursivity limit)
391 * @param string ? (internal)
392 * @return integer The count of items on the level
393 */
394 function getTree($uid, $depth=999, $blankLineCode='', $subCSSclass='') {
395
396 // Buffer for id hierarchy is reset:
397 $this->buffer_idH = array();
398
399 // Init vars
400 $depth = intval($depth);
401 $HTML = '';
402 $a = 0;
403
404 $res = $this->getDataInit($uid, $subCSSclass);
405 $c = $this->getDataCount($res);
406 $crazyRecursionLimiter = 999;
407
408 $inMenuPages = array();
409 $outOfMenuPages = array();
410 $outOfMenuPagesTextIndex = array();
411 while ($crazyRecursionLimiter > 0 && $row = $this->getDataNext($res,$subCSSclass)) {
412 $crazyRecursionLimiter--;
413
414 // Not in menu:
415 if (!$this->ext_dontSeparateNotinmenuPages && (t3lib_div::inList('5,6',$row['doktype']) || $row['doktype']>=200 || $row['nav_hide'])) {
416 $outOfMenuPages[] = $row;
417 $outOfMenuPagesTextIndex[] = ($row['doktype']>=200 ? 'zzz'.$row['doktype'].'_' : '').$row['title'];
418 } else {
419 $inMenuPages[] = $row;
420 }
421 }
422
423 $label_shownAlphabetically = "";
424 if (count($outOfMenuPages)) {
425 // Sort out-of-menu pages:
426 $outOfMenuPages_alphabetic = array();
427 if (!$this->ext_dontAlphasortNotinmenuPages) {
428 asort($outOfMenuPagesTextIndex);
429 $label_shownAlphabetically = " (alphabetic)";
430 }
431 foreach($outOfMenuPagesTextIndex as $idx => $txt) {
432 $outOfMenuPages_alphabetic[] = $outOfMenuPages[$idx];
433 }
434
435 // Merge:
436 $outOfMenuPages_alphabetic[0]['_FIRST_NOT_IN_MENU']=TRUE;
437 $allRows = array_merge($inMenuPages,$outOfMenuPages_alphabetic);
438 } else {
439 $allRows = $inMenuPages;
440 }
441
442 // Traverse the records:
443 foreach ($allRows as $row) {
444 $a++;
445
446 $newID = $row['uid'];
447 $this->tree[]=array(); // Reserve space.
448 end($this->tree);
449 $treeKey = key($this->tree); // Get the key for this space
450 $LN = ($a==$c) ? 'blank' : 'line';
451
452 // If records should be accumulated, do so
453 if ($this->setRecs) { $this->recs[$row['uid']] = $row; }
454
455 // Accumulate the id of the element in the internal arrays
456 $this->ids[]=$idH[$row['uid']]['uid'] = $row['uid'];
457 $this->ids_hierarchy[$depth][] = $row['uid'];
458
459 // Make a recursive call to the next level
460 if ($depth > 1 && $this->expandNext($newID) && !$row['php_tree_stop']) {
461 $nextCount=$this->getTree(
462 $newID,
463 $depth-1,
464 $blankLineCode.','.$LN,
465 $row['_SUBCSSCLASS']
466 );
467 if (count($this->buffer_idH)) { $idH[$row['uid']]['subrow']=$this->buffer_idH; }
468 $exp = 1; // Set "did expand" flag
469 } else {
470 $nextCount = $this->getCount($newID);
471 $exp = 0; // Clear "did expand" flag
472 }
473
474 // Set HTML-icons, if any:
475 if ($this->makeHTML) {
476 if ($row['_FIRST_NOT_IN_MENU']) {
477 $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>';
478 } else {
479 $HTML = '';
480 }
481
482 $HTML.= $this->PMicon($row,$a,$c,$nextCount,$exp);
483 $HTML.= $this->wrapStop($this->getIcon($row),$row);
484 }
485
486 // Finally, add the row/HTML content to the ->tree array in the reserved key.
487 $this->tree[$treeKey] = array(
488 'row' => $row,
489 'HTML' => $HTML,
490 'hasSub' => $nextCount&&$this->expandNext($newID),
491 'isFirst'=> $a==1,
492 'isLast' => false,
493 'invertedDepth'=> $depth,
494 'blankLineCode'=> $blankLineCode,
495 'bank' => $this->bank
496 );
497 }
498
499 if($a) { $this->tree[$treeKey]['isLast'] = true; }
500
501 $this->getDataFree($res);
502 $this->buffer_idH = $idH;
503 return $c;
504 }
505 }
506
507 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['typo3/class.webpagetree.php']) {
508 include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['typo3/class.webpagetree.php']);
509 }
510 ?>