fixed bug #7642: Page tree Filter use wrong div for collapse
[Packages/TYPO3.CMS.git] / typo3 / alt_db_navframe.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 1999-2005 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 * $Id$
31 * Revised for TYPO3 3.6 2/2003 by Kasper Skaarhoj
32 * XHTML compliant
33 *
34 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
35 */
36 /**
37 * [CLASS/FUNCTION INDEX of SCRIPT]
38 *
39 *
40 * 192: class SC_alt_db_navframe
41 * 210: function init()
42 * 313: function main()
43 * 387: function printContent()
44 *
45 * SECTION: Temporary DB mounts
46 * 415: function initializeTemporaryDBmount()
47 * 449: function settingTemporaryMountPoint($pageId)
48 *
49 * TOTAL FUNCTIONS: 9
50 * (This index is automatically created/updated by the extension "extdeveval")
51 *
52 */
53
54
55 $BACK_PATH = '';
56 require_once('init.php');
57 require('template.php');
58 require_once('class.webpagetree.php');
59
60
61 /**
62 * Main script class for the page tree navigation frame
63 *
64 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
65 * @package TYPO3
66 * @subpackage core
67 */
68 class SC_alt_db_navframe {
69
70 // Internal:
71 var $content;
72 var $pagetree;
73
74 /**
75 * document template object
76 *
77 * @var template
78 */
79 var $doc;
80 var $active_tempMountPoint = 0; // Temporary mount point (record), if any
81 var $backPath;
82
83 // Internal, static: GPvar:
84 var $currentSubScript;
85 var $cMR;
86 var $setTempDBmount; // If not '' (blank) then it will clear (0) or set (>0) Temporary DB mount.
87
88 var $template; // a static HTML template, usually in templates/alt_db_navframe.html
89 var $hasFilterBox; //depends on userTS-setting
90
91 /**
92 * Initialiation of the class
93 *
94 * @return void
95 */
96 function init() {
97 global $BE_USER,$BACK_PATH;
98
99 // Setting backPath
100 $this->backPath = $BACK_PATH;
101
102 // Setting GPvars:
103 $this->cMR = t3lib_div::_GP('cMR');
104 $this->currentSubScript = t3lib_div::_GP('currentSubScript');
105 $this->setTempDBmount = t3lib_div::_GP('setTempDBmount');
106
107 // look for User setting
108 $this->hasFilterBox = !$BE_USER->getTSConfigVal('options.pageTree.hideFilter');
109
110 // Create page tree object:
111 $this->pagetree = t3lib_div::makeInstance('webPageTree');
112 $this->pagetree->ext_IconMode = $BE_USER->getTSConfigVal('options.pageTree.disableIconLinkToContextmenu');
113 $this->pagetree->ext_showPageId = $BE_USER->getTSConfigVal('options.pageTree.showPageIdWithTitle');
114 $this->pagetree->ext_showNavTitle = $BE_USER->getTSConfigVal('options.pageTree.showNavTitle');
115 $this->pagetree->ext_separateNotinmenuPages = $BE_USER->getTSConfigVal('options.pageTree.separateNotinmenuPages');
116 $this->pagetree->ext_alphasortNotinmenuPages = $BE_USER->getTSConfigVal('options.pageTree.alphasortNotinmenuPages');
117 $this->pagetree->thisScript = 'alt_db_navframe.php';
118 $this->pagetree->addField('alias');
119 $this->pagetree->addField('shortcut');
120 $this->pagetree->addField('shortcut_mode');
121 $this->pagetree->addField('mount_pid');
122 $this->pagetree->addField('mount_pid_ol');
123 $this->pagetree->addField('nav_hide');
124 $this->pagetree->addField('nav_title');
125 $this->pagetree->addField('url');
126
127 // Temporary DB mounts:
128 $this->initializeTemporaryDBmount();
129 }
130
131
132 /**
133 * initialization for the visual parts of the class
134 * Use template rendering only if this is a non-AJAX call
135 *
136 * @return void
137 */
138 public function initPage() {
139 global $BE_USER;
140
141 // Setting highlight mode:
142 $this->doHighlight = !$BE_USER->getTSConfigVal('options.pageTree.disableTitleHighlight');
143
144 // If highlighting is active, define the CSS class for the active item depending on the workspace
145 if ($this->doHighlight) {
146 $hlClass = ($BE_USER->workspace === 0 ? 'active' : 'active active-ws wsver'.$BE_USER->workspace);
147 }
148
149 // Create template object:
150 $this->doc = t3lib_div::makeInstance('template');
151 $this->doc->backPath = $BACK_PATH;
152 $this->doc->setModuleTemplate('templates/alt_db_navframe.html');
153 $this->doc->docType = 'xhtml_trans';
154
155 // get HTML-Template
156
157
158 // Adding javascript code for AJAX (prototype), drag&drop and the pagetree as well as the click menu code
159 $this->doc->getDragDropCode('pages');
160 $this->doc->getContextMenuCode();
161 $this->doc->loadJavascriptLib('contrib/scriptaculous/scriptaculous.js?load=effects');
162
163 $this->doc->JScode .= $this->doc->wrapScriptTags(
164 ($this->currentSubScript?'top.currentSubScript=unescape("'.rawurlencode($this->currentSubScript).'");':'').'
165 // setting prefs for pagetree and drag & drop
166 '.($this->doHighlight ? 'Tree.highlightClass = "'.$hlClass.'";' : '').'
167
168 // Function, loading the list frame from navigation tree:
169 function jumpTo(id, linkObj, highlightID, bank) { //
170 var theUrl = top.TS.PATH_typo3 + top.currentSubScript + "?id=" + id;
171 top.fsMod.currentBank = bank;
172
173 if (top.condensedMode) top.content.location.href = theUrl;
174 else parent.list_frame.location.href=theUrl;
175
176 '.($this->doHighlight ? 'Tree.highlightActiveItem("web", highlightID + "_" + bank);' : '').'
177 '.(!$GLOBALS['CLIENT']['FORMSTYLE'] ? '' : 'if (linkObj) linkObj.blur(); ').'
178 return false;
179 }
180 '.($this->cMR?"jumpTo(top.fsMod.recentIds['web'],'');":'').
181
182 ($this->hasFilterBox ? 'var TYPO3PageTreeFilter = new PageTreeFilter();' : '') . '
183
184 ');
185
186 $this->doc->bodyTagId = 'typo3-pagetree';
187 }
188
189
190 /**
191 * Main function, rendering the browsable page tree
192 *
193 * @return void
194 */
195 function main() {
196 global $LANG,$CLIENT;
197
198 // Produce browse-tree:
199 $tree = $this->pagetree->getBrowsableTree();
200
201
202 // Outputting Temporary DB mount notice:
203 if ($this->active_tempMountPoint) {
204 $this->content.= '
205 <div class="bgColor4 c-notice">
206 <img'.t3lib_iconWorks::skinImg('','gfx/icon_note.gif','width="18" height="16"').' align="top" alt="" />'.
207 '<a href="'.htmlspecialchars(t3lib_div::linkThisScript(array('setTempDBmount' => 0))).'">'.
208 $LANG->sl('LLL:EXT:lang/locallang_core.xml:labels.temporaryDBmount',1).
209 '</a><br/>
210 '.$LANG->sl('LLL:EXT:lang/locallang_core.xml:labels.path',1).': <span title="'.htmlspecialchars($this->active_tempMountPoint['_thePathFull']).'">'.htmlspecialchars(t3lib_div::fixed_lgd_cs($this->active_tempMountPoint['_thePath'],-50)).'</span>
211 </div>
212 ';
213 }
214
215 // Outputting page tree:
216 $this->content .= '<div id="PageTreeDiv">'.$tree.'</div>';
217
218 // Adding javascript for drag & drop activation and highlighting
219 $this->content .= $this->doc->wrapScriptTags('
220 '.($this->doHighlight ? 'Tree.highlightActiveItem("",top.fsMod.navFrameHighlightedID["web"]);' : '').'
221 '.(!$this->doc->isCMlayers() ? 'Tree.activateDragDrop = false;' : 'Tree.registerDragDropHandlers();')
222 );
223
224 // Setting up the buttons and markers for docheader
225 $docHeaderButtons = $this->getButtons();
226 $docHeaderButtons['filtertoggle'] = $this->getFilterToggle();
227 $markers = array(
228 'STYLE' => $GLOBALS['BE_USER']->uc['moduleData']['pageTree']['filterBox'] ? ' style="display:none;"' : '',
229 'IMG_RESET' => '<img'.t3lib_iconWorks::skinImg($GLOBALS['BACK_PATH'], 'gfx/close_gray.gif', ' width="16" height="16"').' id="treeFilterReset" alt="Reset Filter" />',
230 'WORKSPACEINFO' => $this->getWorkspaceInfo(),
231 'CONTENT' => $this->content
232 );
233
234 // Build the <body> for the module
235 $this->content = $this->doc->startPage('TYPO3 Page Tree');
236 $this->content.= $this->doc->moduleBody($this->pageinfo, $docHeaderButtons, $markers);
237 $this->content.= $this->doc->endPage();
238 $this->content = $this->doc->insertStylesAndJS($this->content);
239 }
240
241 /**
242 * Outputting the accumulated content to screen
243 *
244 * @return void
245 */
246 function printContent() {
247 echo $this->content;
248 }
249
250 /**
251 * Create the panel of buttons for submitting the form or otherwise perform operations.
252 *
253 * @return array all available buttons as an assoc. array
254 */
255 private function getButtons() {
256 global $LANG;
257
258 $buttons = array(
259 'csh' => '',
260 'new_page' => '',
261 'refresh' => '',
262 );
263
264 // New Page
265 $onclickNewPageWizard = 'top.content.list_frame.location.href=top.TS.PATH_typo3+\'db_new.php?id=1&pagesOnly=1\';"';
266 $buttons['new_page'] = '<a href="#" onclick="' . $onclickNewPageWizard . '"><img' . t3lib_iconWorks::skinImg('', 'gfx/new_page.gif') . ' title="' . $LANG->sL('LLL:EXT:cms/layout/locallang.xml:newPage', 1) . '" alt="" /></a>';
267
268 // Refresh
269 $buttons['refresh'] = '<a href="' . htmlspecialchars(t3lib_div::getIndpEnv('REQUEST_URI')) . '"><img' . t3lib_iconWorks::skinImg('', 'gfx/refresh_n.gif') . ' title="' . $LANG->sL('LLL:EXT:lang/locallang_core.php:labels.refresh', 1) . '" alt="" /></a>';
270
271 // CSH
272 $buttons['csh'] = str_replace('typo3-csh-inline','typo3-csh-inline show-right',t3lib_BEfunc::cshItem('xMOD_csh_corebe', 'pagetree', $GLOBALS['BACK_PATH']));
273
274 return $buttons;
275 }
276
277 /**
278 * Create the workspace information
279 *
280 * @return string HTML containing workspace info
281 */
282 private function getWorkspaceInfo() {
283 global $LANG;
284
285 if ($GLOBALS['BE_USER']->workspace!==0 || $GLOBALS['BE_USER']->getTSConfigVal('options.pageTree.onlineWorkspaceInfo')) {
286 switch($GLOBALS['BE_USER']->workspace) {
287 case 0:
288 $wsTitle = '&nbsp;'.$this->doc->icons(2).'['.$LANG->sL('LLL:EXT:lang/locallang_misc.xml:shortcut_onlineWS',1).']';
289 break;
290 case -1:
291 $wsTitle = '['.$LANG->sL('LLL:EXT:lang/locallang_misc.xml:shortcut_offlineWS',1).']';
292 break;
293 default:
294 $wsTitle = '['.$GLOBALS['BE_USER']->workspace.'] '.htmlspecialchars($GLOBALS['BE_USER']->workspaceRec['title']);
295 break;
296 }
297
298 $workspaceInfo = '
299 <div class="bgColor4 workspace-info">
300 <a href="'.htmlspecialchars('mod/user/ws/index.php').'" target="content">'.
301 '<img'.t3lib_iconWorks::skinImg('','gfx/i/sys_workspace.png','width="18" height="16"').' align="top" alt="" />'.
302 '</a>'.$wsTitle.'
303 </div>
304 ';
305 }
306
307 return $workspaceInfo;
308 }
309
310 /**
311 * Create the filter toggle
312 *
313 * @return string HTML for filter toggle
314 */
315 private function getFilterToggle() {
316 $filterToggle = '';
317
318 if($this->hasFilterBox) {
319 $filterToggle = '
320 <a href="#" id="toggleTreeFilter">
321 <img' . t3lib_iconWorks::skinImg('', $GLOBALS['BE_USER']->uc['moduleData']['pageTree']['filterBox'] ? 'gfx/arrowright.png' : 'gfx/arrowdown.png') . ' title="toggle filter" alt="" />
322 <span>' . $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_misc.xml:pageTree_filter', 1) . '</span>
323 </a>
324 ';
325 }
326
327 return $filterToggle;
328 }
329
330
331
332 /**********************************
333 *
334 * Temporary DB mounts
335 *
336 **********************************/
337
338 /**
339 * Getting temporary DB mount
340 *
341 * @return void
342 */
343 function initializeTemporaryDBmount(){
344 global $BE_USER;
345
346 // Set/Cancel Temporary DB Mount:
347 if (strlen($this->setTempDBmount)) {
348 $set = t3lib_div::intInRange($this->setTempDBmount,0);
349 if ($set>0 && $BE_USER->isInWebMount($set)) { // Setting...:
350 $this->settingTemporaryMountPoint($set);
351 } else { // Clear:
352 $this->settingTemporaryMountPoint(0);
353 }
354 }
355
356 // Getting temporary mount point ID:
357 $temporaryMountPoint = intval($BE_USER->getSessionData('pageTree_temporaryMountPoint'));
358
359 // If mount point ID existed and is within users real mount points, then set it temporarily:
360 if ($temporaryMountPoint > 0 && $BE_USER->isInWebMount($temporaryMountPoint)) {
361 if ($this->active_tempMountPoint = t3lib_BEfunc::readPageAccess($temporaryMountPoint, $BE_USER->getPagePermsClause(1))) {
362 $this->pagetree->MOUNTS = array($temporaryMountPoint);
363 }
364 else {
365 // Clear temporary mount point as we have no access to it any longer
366 $this->settingTemporaryMountPoint(0);
367 }
368 }
369 }
370
371
372 /**
373 * Setting temporary page id as DB mount
374 *
375 * @param integer The page id to set as DB mount
376 * @return void
377 */
378 function settingTemporaryMountPoint($pageId) {
379 $GLOBALS['BE_USER']->setAndSaveSessionData('pageTree_temporaryMountPoint',intval($pageId));
380 }
381
382
383 /**********************************
384 *
385 * AJAX Calls
386 *
387 **********************************/
388
389 /**
390 * Makes the AJAX call to expand or collapse the pagetree.
391 * Called by typo3/ajax.php
392 *
393 * @param array $params: additional parameters (not used here)
394 * @param TYPO3AJAX &$ajaxObj: reference of the TYPO3AJAX object of this request
395 * @return void
396 */
397 public function ajaxExpandCollapse($params, &$ajaxObj) {
398 global $LANG;
399
400 $this->init();
401 $tree = $this->pagetree->getBrowsableTree();
402 if (!$this->pagetree->ajaxStatus) {
403 $ajaxObj->setError($tree);
404 } else {
405 $ajaxObj->addContent('tree', $tree);
406 }
407 }
408
409 /**
410 * Makes the AJAX call to expand or collapse the filterbox.
411 * Called by typo3/ajax.php
412 *
413 * @param array $params: additional parameters (not used here)
414 * @param TYPO3AJAX &$ajaxObj: reference of the TYPO3AJAX object of this request
415 * @return void
416 */
417 public function ajaxSaveFilterboxStatus(array $params, &$ajaxObj) {
418 $state = t3lib_div::_POST('state') === 'true' ? 1 : 0;
419
420 $GLOBALS['BE_USER']->uc['moduleData']['pageTree']['filterBox'] = $state;
421 $GLOBALS['BE_USER']->writeUC();
422 }
423
424 }
425
426
427 // Include extension?
428 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['typo3/alt_db_navframe.php']) {
429 include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['typo3/alt_db_navframe.php']);
430 }
431
432
433 // Make instance if it is not an AJAX call
434 if (!(TYPO3_REQUESTTYPE & TYPO3_REQUESTTYPE_AJAX)) {
435 $SOBE = t3lib_div::makeInstance('SC_alt_db_navframe');
436 $SOBE->init();
437 $SOBE->initPage();
438 $SOBE->main();
439 $SOBE->printContent();
440 }
441
442 ?>