Changed private declarations to protected
[Packages/TYPO3.CMS.git] / typo3 / alt_db_navframe.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 1999-2008 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 $markers = array(
227 'IMG_RESET' => '<img'.t3lib_iconWorks::skinImg($GLOBALS['BACK_PATH'], 'gfx/close_gray.gif', ' width="16" height="16"').' id="treeFilterReset" alt="Reset Filter" />',
228 'WORKSPACEINFO' => $this->getWorkspaceInfo(),
229 'CONTENT' => $this->content
230 );
231 $subparts = array();
232
233 if (!$this->hasFilterBox) {
234 $subparts['###SECOND_ROW###'] = '';
235 }
236 // Build the <body> for the module
237 $this->content = $this->doc->startPage('TYPO3 Page Tree');
238 $this->content.= $this->doc->moduleBody($this->pageinfo, $docHeaderButtons, $markers, $subparts);
239 $this->content.= $this->doc->endPage();
240
241 $this->content = $this->doc->insertStylesAndJS($this->content);
242 }
243
244 /**
245 * Outputting the accumulated content to screen
246 *
247 * @return void
248 */
249 function printContent() {
250 echo $this->content;
251 }
252
253 /**
254 * Create the panel of buttons for submitting the form or otherwise perform operations.
255 *
256 * @return array all available buttons as an assoc. array
257 */
258 protected function getButtons() {
259 global $LANG;
260
261 $buttons = array(
262 'csh' => '',
263 'new_page' => '',
264 'refresh' => '',
265 );
266
267 // New Page
268 $onclickNewPageWizard = 'top.content.list_frame.location.href=top.TS.PATH_typo3+\'db_new.php?pagesOnly=1&id=\'+Tree.pageID;"';
269 $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>';
270
271 // Refresh
272 $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>';
273
274 // CSH
275 $buttons['csh'] = str_replace('typo3-csh-inline','typo3-csh-inline show-right',t3lib_BEfunc::cshItem('xMOD_csh_corebe', 'pagetree', $GLOBALS['BACK_PATH']));
276
277 return $buttons;
278 }
279
280 /**
281 * Create the workspace information
282 *
283 * @return string HTML containing workspace info
284 */
285 protected function getWorkspaceInfo() {
286 global $LANG;
287
288 if ($GLOBALS['BE_USER']->workspace!==0 || $GLOBALS['BE_USER']->getTSConfigVal('options.pageTree.onlineWorkspaceInfo')) {
289 switch($GLOBALS['BE_USER']->workspace) {
290 case 0:
291 $wsTitle = '&nbsp;'.$this->doc->icons(2).'['.$LANG->sL('LLL:EXT:lang/locallang_misc.xml:shortcut_onlineWS',1).']';
292 break;
293 case -1:
294 $wsTitle = '['.$LANG->sL('LLL:EXT:lang/locallang_misc.xml:shortcut_offlineWS',1).']';
295 break;
296 default:
297 $wsTitle = '['.$GLOBALS['BE_USER']->workspace.'] '.htmlspecialchars($GLOBALS['BE_USER']->workspaceRec['title']);
298 break;
299 }
300
301 $workspaceInfo = '
302 <div class="bgColor4 workspace-info">
303 <a href="'.htmlspecialchars('mod/user/ws/index.php').'" target="content">'.
304 '<img'.t3lib_iconWorks::skinImg('','gfx/i/sys_workspace.png','width="18" height="16"').' align="top" alt="" />'.
305 '</a>'.$wsTitle.'
306 </div>
307 ';
308 }
309
310 return $workspaceInfo;
311 }
312
313
314 /**********************************
315 *
316 * Temporary DB mounts
317 *
318 **********************************/
319
320 /**
321 * Getting temporary DB mount
322 *
323 * @return void
324 */
325 function initializeTemporaryDBmount(){
326 global $BE_USER;
327
328 // Set/Cancel Temporary DB Mount:
329 if (strlen($this->setTempDBmount)) {
330 $set = t3lib_div::intInRange($this->setTempDBmount,0);
331 if ($set>0 && $BE_USER->isInWebMount($set)) { // Setting...:
332 $this->settingTemporaryMountPoint($set);
333 } else { // Clear:
334 $this->settingTemporaryMountPoint(0);
335 }
336 }
337
338 // Getting temporary mount point ID:
339 $temporaryMountPoint = intval($BE_USER->getSessionData('pageTree_temporaryMountPoint'));
340
341 // If mount point ID existed and is within users real mount points, then set it temporarily:
342 if ($temporaryMountPoint > 0 && $BE_USER->isInWebMount($temporaryMountPoint)) {
343 if ($this->active_tempMountPoint = t3lib_BEfunc::readPageAccess($temporaryMountPoint, $BE_USER->getPagePermsClause(1))) {
344 $this->pagetree->MOUNTS = array($temporaryMountPoint);
345 }
346 else {
347 // Clear temporary mount point as we have no access to it any longer
348 $this->settingTemporaryMountPoint(0);
349 }
350 }
351 }
352
353
354 /**
355 * Setting temporary page id as DB mount
356 *
357 * @param integer The page id to set as DB mount
358 * @return void
359 */
360 function settingTemporaryMountPoint($pageId) {
361 $GLOBALS['BE_USER']->setAndSaveSessionData('pageTree_temporaryMountPoint',intval($pageId));
362 }
363
364
365 /**********************************
366 *
367 * AJAX Calls
368 *
369 **********************************/
370
371 /**
372 * Makes the AJAX call to expand or collapse the pagetree.
373 * Called by typo3/ajax.php
374 *
375 * @param array $params: additional parameters (not used here)
376 * @param TYPO3AJAX &$ajaxObj: reference of the TYPO3AJAX object of this request
377 * @return void
378 */
379 public function ajaxExpandCollapse($params, &$ajaxObj) {
380 global $LANG;
381
382 $this->init();
383 $tree = $this->pagetree->getBrowsableTree();
384 if (!$this->pagetree->ajaxStatus) {
385 $ajaxObj->setError($tree);
386 } else {
387 $ajaxObj->addContent('tree', $tree);
388 }
389 }
390 }
391
392
393 // Include extension?
394 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['typo3/alt_db_navframe.php']) {
395 include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['typo3/alt_db_navframe.php']);
396 }
397
398
399 // Make instance if it is not an AJAX call
400 if (!(TYPO3_REQUESTTYPE & TYPO3_REQUESTTYPE_AJAX)) {
401 $SOBE = t3lib_div::makeInstance('SC_alt_db_navframe');
402 $SOBE->init();
403 $SOBE->initPage();
404 $SOBE->main();
405 $SOBE->printContent();
406 }
407
408 ?>