(feature/cleanup) Refactored clickmenu to speed up the BE
[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('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 $ajax; // Is set, if an AJAX call should be handled.
85 var $currentSubScript;
86 var $cMR;
87 var $setTempDBmount; // If not '' (blank) then it will clear (0) or set (>0) Temporary DB mount.
88
89 /**
90 * Initialiation of the class
91 *
92 * @return void
93 */
94 function init() {
95 global $BE_USER,$BACK_PATH;
96
97 // Setting backPath
98 $this->backPath = $BACK_PATH;
99
100 // Setting GPvars:
101 $this->ajax = t3lib_div::_GP('ajax');
102 $this->cMR = t3lib_div::_GP('cMR');
103 $this->currentSubScript = t3lib_div::_GP('currentSubScript');
104 $this->setTempDBmount = t3lib_div::_GP('setTempDBmount');
105
106 // Create page tree object:
107 $this->pagetree = t3lib_div::makeInstance('webPageTree');
108 $this->pagetree->ext_IconMode = $BE_USER->getTSConfigVal('options.pageTree.disableIconLinkToContextmenu');
109 $this->pagetree->ext_showPageId = $BE_USER->getTSConfigVal('options.pageTree.showPageIdWithTitle');
110 $this->pagetree->ext_showNavTitle = $BE_USER->getTSConfigVal('options.pageTree.showNavTitle');
111 $this->pagetree->ext_separateNotinmenuPages = $BE_USER->getTSConfigVal('options.pageTree.separateNotinmenuPages');
112 $this->pagetree->ext_alphasortNotinmenuPages = $BE_USER->getTSConfigVal('options.pageTree.alphasortNotinmenuPages');
113 $this->pagetree->thisScript = 'alt_db_navframe.php';
114 $this->pagetree->addField('alias');
115 $this->pagetree->addField('shortcut');
116 $this->pagetree->addField('shortcut_mode');
117 $this->pagetree->addField('mount_pid');
118 $this->pagetree->addField('mount_pid_ol');
119 $this->pagetree->addField('nav_hide');
120 $this->pagetree->addField('nav_title');
121 $this->pagetree->addField('url');
122
123 // Temporary DB mounts:
124 $this->initializeTemporaryDBmount();
125
126 // Use template rendering only if this is a non-AJAX call:
127 if (!$this->ajax) {
128 // Setting highlight mode:
129 $this->doHighlight = !$BE_USER->getTSConfigVal('options.pageTree.disableTitleHighlight');
130
131 // If highlighting is active, define the CSS class for the active item depending on the workspace
132 if ($this->doHighlight) {
133 if ($BE_USER->workspace === 0) $hlClass = 'active';
134 else $hlClass = 'active active-ws wsver'.$BE_USER->workspace;
135 }
136
137 // Create template object:
138 $this->doc = t3lib_div::makeInstance('template');
139 $this->doc->backPath = $BACK_PATH;
140 $this->doc->docType = 'xhtml_trans';
141
142 // Adding javascript code for AJAX (prototype), drag&drop and the pagetree
143 $this->doc->loadJavascriptLib('contrib/prototype/prototype.js');
144 $this->doc->loadJavascriptLib('tree.js');
145
146 $this->doc->JScode .= $this->doc->wrapScriptTags(
147 ($this->currentSubScript?'top.currentSubScript=unescape("'.rawurlencode($this->currentSubScript).'");':'').'
148 // setting prefs for pagetree and drag & drop
149 Tree.thisScript = "'.$this->pagetree->thisScript.'";
150 '.($this->doHighlight ? 'Tree.highlightClass = "'.$hlClass.'";' : '').'
151
152 DragDrop.changeURL = "'.$this->backPath.'alt_clickmenu.php";
153 DragDrop.backPath = "'.t3lib_div::shortMD5(''.'|'.$GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey']).'";
154 DragDrop.table = "pages";
155
156 // Function, loading the list frame from navigation tree:
157 function jumpTo(id, linkObj, highlightID, bank) { //
158 var theUrl = top.TS.PATH_typo3 + top.currentSubScript + "?id=" + id;
159 top.fsMod.currentBank = bank;
160
161 if (top.condensedMode) top.content.location.href = theUrl;
162 else parent.list_frame.location.href=theUrl;
163
164 '.($this->doHighlight ? 'Tree.highlightActiveItem("web", highlightID + "_" + bank);' : '').'
165 '.(!$GLOBALS['CLIENT']['FORMSTYLE'] ? '' : 'if (linkObj) linkObj.blur(); ').'
166 return false;
167 }
168 '.($this->cMR?"jumpTo(top.fsMod.recentIds['web'],'');":'').'
169 ');
170
171 // Click menu code is added:
172 $this->doc->getContextMenuCode();
173 $this->doc->bodyTagId = 'bodyTag';
174 }
175 }
176
177
178 /**
179 * Main function, rendering the browsable page tree
180 *
181 * @return void
182 */
183 function main() {
184 global $LANG,$CLIENT;
185
186 // Produce browse-tree:
187 $tree = $this->pagetree->getBrowsableTree();
188
189 // Output only the tree if this is an AJAX call:
190 if ($this->ajax) {
191 $this->content = $LANG->csConvObj->utf8_encode($tree, $LANG->charSet);
192 return;
193 }
194
195 // Start page:
196 $this->content = $this->doc->startPage('TYPO3 Page Tree');
197
198 // Outputting workspace info
199 if ($GLOBALS['BE_USER']->workspace!==0 || $GLOBALS['BE_USER']->getTSConfigVal('options.pageTree.onlineWorkspaceInfo')) {
200 switch($GLOBALS['BE_USER']->workspace) {
201 case 0:
202 $wsTitle = '&nbsp;'.$this->doc->icons(2).'['.$LANG->sL('LLL:EXT:lang/locallang_misc.xml:shortcut_onlineWS',1).']';
203 break;
204 case -1:
205 $wsTitle = '['.$LANG->sL('LLL:EXT:lang/locallang_misc.xml:shortcut_offlineWS',1).']';
206 break;
207 default:
208 $wsTitle = '['.$GLOBALS['BE_USER']->workspace.'] '.htmlspecialchars($GLOBALS['BE_USER']->workspaceRec['title']);
209 break;
210 }
211
212 $this->content.= '
213 <div class="bgColor4 workspace-info">'.
214 '<a href="'.htmlspecialchars('mod/user/ws/index.php').'" target="content">'.
215 '<img'.t3lib_iconWorks::skinImg('','gfx/i/sys_workspace.png','width="18" height="16"').' align="top" alt="" />'.
216 '</a>'.$wsTitle.'
217 </div>
218 ';
219 }
220
221 if (!$GLOBALS['BE_USER']->getTSConfigVal('options.pageTree.hideFilter')) {
222 $this->content.= '
223 <div class="bgColor4">
224 Filter: <input type="text" value="" name="_livesearch" id="_livesearch" onkeyup="filter(this.value);"/>
225 </div><br>
226 ';
227 }
228
229 // Outputting Temporary DB mount notice:
230 if ($this->active_tempMountPoint) {
231 $this->content.= '
232 <div class="bgColor4 c-notice">
233 <img'.t3lib_iconWorks::skinImg('','gfx/icon_note.gif','width="18" height="16"').' align="top" alt="" />'.
234 '<a href="'.htmlspecialchars(t3lib_div::linkThisScript(array('setTempDBmount' => 0))).'">'.
235 $LANG->sl('LLL:EXT:lang/locallang_core.php:labels.temporaryDBmount',1).
236 '</a><br/>
237 '.$LANG->sl('LLL:EXT:lang/locallang_core.php:labels.path',1).': <span title="'.htmlspecialchars($this->active_tempMountPoint['_thePathFull']).'">'.htmlspecialchars(t3lib_div::fixed_lgd_cs($this->active_tempMountPoint['_thePath'],-50)).'</span>
238 </div>
239 ';
240 }
241
242 // Outputting page tree:
243 $this->content.= $tree;
244
245 // Outputting refresh-link
246 $this->content.= '
247 <p class="c-refresh">
248 <a href="'.htmlspecialchars(t3lib_div::getIndpEnv('REQUEST_URI')).'">'.
249 '<img'.t3lib_iconWorks::skinImg('','gfx/refresh_n.gif','width="14" height="14"').' title="'.$LANG->sL('LLL:EXT:lang/locallang_core.php:labels.refresh',1).'" alt="" />'.
250 $LANG->sL('LLL:EXT:lang/locallang_core.php:labels.refresh',1).'</a>
251 </p>
252 <br />';
253
254 // CSH icon:
255 $this->content.= t3lib_BEfunc::cshItem('xMOD_csh_corebe', 'pagetree', $GLOBALS['BACK_PATH']);
256
257 // Adding javascript for drag & drop activation and highlighting
258 $this->content .=$this->doc->wrapScriptTags('
259 '.($this->doHighlight ? 'Tree.highlightActiveItem("",top.fsMod.navFrameHighlightedID["web"]);' : '').'
260 '.(!$this->doc->isCMlayers() ? 'Tree.activateDragDrop = false;' : 'Tree.registerDragDropHandlers();')
261 );
262 }
263
264 /**
265 * Outputting the accumulated content to screen
266 *
267 * @return void
268 */
269 function printContent() {
270 // If we handle an AJAX call, send headers:
271 if ($this->ajax) {
272 header('X-JSON: ('.($this->pagetree->ajaxStatus?'true':'false').')');
273 header('Content-type: text/html; charset=utf-8');
274 // If it's the regular call to fully output the tree:
275 } else {
276 $this->content.= $this->doc->endPage();
277 $this->content = $this->doc->insertStylesAndJS($this->content);
278 }
279 echo $this->content;
280 }
281
282
283
284
285
286 /**********************************
287 *
288 * Temporary DB mounts
289 *
290 **********************************/
291
292 /**
293 * Getting temporary DB mount
294 *
295 * @return void
296 */
297 function initializeTemporaryDBmount(){
298 global $BE_USER;
299
300 // Set/Cancel Temporary DB Mount:
301 if (strlen($this->setTempDBmount)) {
302 $set = t3lib_div::intInRange($this->setTempDBmount,0);
303 if ($set>0 && $BE_USER->isInWebMount($set)) { // Setting...:
304 $this->settingTemporaryMountPoint($set);
305 } else { // Clear:
306 $this->settingTemporaryMountPoint(0);
307 }
308 }
309
310 // Getting temporary mount point ID:
311 $temporaryMountPoint = intval($BE_USER->getSessionData('pageTree_temporaryMountPoint'));
312
313 // If mount point ID existed and is within users real mount points, then set it temporarily:
314 if ($temporaryMountPoint > 0 && $BE_USER->isInWebMount($temporaryMountPoint)) {
315 if ($this->active_tempMountPoint = t3lib_BEfunc::readPageAccess($temporaryMountPoint, $BE_USER->getPagePermsClause(1))) {
316 $this->pagetree->MOUNTS = array($temporaryMountPoint);
317 }
318 else {
319 // Clear temporary mount point as we have no access to it any longer
320 $this->settingTemporaryMountPoint(0);
321 }
322 }
323 }
324
325
326 /**
327 * Setting temporary page id as DB mount
328 *
329 * @param integer The page id to set as DB mount
330 * @return void
331 */
332 function settingTemporaryMountPoint($pageId) {
333 global $BE_USER;
334
335 // Setting temporary mount point ID:
336 $BE_USER->setAndSaveSessionData('pageTree_temporaryMountPoint',intval($pageId));
337 }
338 }
339
340
341 // Include extension?
342 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['typo3/alt_db_navframe.php']) {
343 include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['typo3/alt_db_navframe.php']);
344 }
345
346
347
348
349
350 // Make instance:
351 $SOBE = t3lib_div::makeInstance('SC_alt_db_navframe');
352 $SOBE->init();
353 $SOBE->main();
354 $SOBE->printContent();
355
356 ?>