(bugfix) Fixed #6883: Added missing functions in typo3/template.php
[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 as well as the click menu code
143 $this->doc->getDragDropCode('pages');
144 $this->doc->getContextMenuCode();
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 // Function, loading the list frame from navigation tree:
153 function jumpTo(id, linkObj, highlightID, bank) { //
154 var theUrl = top.TS.PATH_typo3 + top.currentSubScript + "?id=" + id;
155 top.fsMod.currentBank = bank;
156
157 if (top.condensedMode) top.content.location.href = theUrl;
158 else parent.list_frame.location.href=theUrl;
159
160 '.($this->doHighlight ? 'Tree.highlightActiveItem("web", highlightID + "_" + bank);' : '').'
161 '.(!$GLOBALS['CLIENT']['FORMSTYLE'] ? '' : 'if (linkObj) linkObj.blur(); ').'
162 return false;
163 }
164 '.($this->cMR?"jumpTo(top.fsMod.recentIds['web'],'');":'').'
165 ');
166
167 $this->doc->bodyTagId = 'bodyTag';
168 }
169 }
170
171
172 /**
173 * Main function, rendering the browsable page tree
174 *
175 * @return void
176 */
177 function main() {
178 global $LANG,$CLIENT;
179
180 // Produce browse-tree:
181 $tree = $this->pagetree->getBrowsableTree();
182
183 // Output only the tree if this is an AJAX call:
184 if ($this->ajax) {
185 $this->content = $LANG->csConvObj->utf8_encode($tree, $LANG->charSet);
186 return;
187 }
188
189 // Start page:
190 $this->content = $this->doc->startPage('TYPO3 Page Tree');
191
192 // Outputting workspace info
193 if ($GLOBALS['BE_USER']->workspace!==0 || $GLOBALS['BE_USER']->getTSConfigVal('options.pageTree.onlineWorkspaceInfo')) {
194 switch($GLOBALS['BE_USER']->workspace) {
195 case 0:
196 $wsTitle = '&nbsp;'.$this->doc->icons(2).'['.$LANG->sL('LLL:EXT:lang/locallang_misc.xml:shortcut_onlineWS',1).']';
197 break;
198 case -1:
199 $wsTitle = '['.$LANG->sL('LLL:EXT:lang/locallang_misc.xml:shortcut_offlineWS',1).']';
200 break;
201 default:
202 $wsTitle = '['.$GLOBALS['BE_USER']->workspace.'] '.htmlspecialchars($GLOBALS['BE_USER']->workspaceRec['title']);
203 break;
204 }
205
206 $this->content.= '
207 <div class="bgColor4 workspace-info">'.
208 '<a href="'.htmlspecialchars('mod/user/ws/index.php').'" target="content">'.
209 '<img'.t3lib_iconWorks::skinImg('','gfx/i/sys_workspace.png','width="18" height="16"').' align="top" alt="" />'.
210 '</a>'.$wsTitle.'
211 </div>
212 ';
213 }
214
215 if (!$GLOBALS['BE_USER']->getTSConfigVal('options.pageTree.hideFilter')) {
216 $this->content.= '
217 <div class="bgColor4">
218 Filter: <input type="text" value="" name="_livesearch" id="_livesearch" onkeyup="filter(this.value);"/>
219 </div><br>
220 ';
221 }
222
223 // Outputting Temporary DB mount notice:
224 if ($this->active_tempMountPoint) {
225 $this->content.= '
226 <div class="bgColor4 c-notice">
227 <img'.t3lib_iconWorks::skinImg('','gfx/icon_note.gif','width="18" height="16"').' align="top" alt="" />'.
228 '<a href="'.htmlspecialchars(t3lib_div::linkThisScript(array('setTempDBmount' => 0))).'">'.
229 $LANG->sl('LLL:EXT:lang/locallang_core.php:labels.temporaryDBmount',1).
230 '</a><br/>
231 '.$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>
232 </div>
233 ';
234 }
235
236 // Outputting page tree:
237 $this->content.= $tree;
238
239 // Outputting refresh-link
240 $this->content.= '
241 <p class="c-refresh">
242 <a href="'.htmlspecialchars(t3lib_div::getIndpEnv('REQUEST_URI')).'">'.
243 '<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="" />'.
244 $LANG->sL('LLL:EXT:lang/locallang_core.php:labels.refresh',1).'</a>
245 </p>
246 <br />';
247
248 // CSH icon:
249 $this->content.= t3lib_BEfunc::cshItem('xMOD_csh_corebe', 'pagetree', $GLOBALS['BACK_PATH']);
250
251 // Adding javascript for drag & drop activation and highlighting
252 $this->content .= $this->doc->wrapScriptTags('
253 '.($this->doHighlight ? 'Tree.highlightActiveItem("",top.fsMod.navFrameHighlightedID["web"]);' : '').'
254 '.(!$this->doc->isCMlayers() ? 'Tree.activateDragDrop = false;' : 'Tree.registerDragDropHandlers();')
255 );
256 }
257
258 /**
259 * Outputting the accumulated content to screen
260 *
261 * @return void
262 */
263 function printContent() {
264 // If we handle an AJAX call, send headers:
265 if ($this->ajax) {
266 header('X-JSON: ('.($this->pagetree->ajaxStatus?'true':'false').')');
267 header('Content-type: text/html; charset=utf-8');
268 // If it's the regular call to fully output the tree:
269 } else {
270 $this->content.= $this->doc->endPage();
271 $this->content = $this->doc->insertStylesAndJS($this->content);
272 }
273 echo $this->content;
274 }
275
276
277
278
279
280 /**********************************
281 *
282 * Temporary DB mounts
283 *
284 **********************************/
285
286 /**
287 * Getting temporary DB mount
288 *
289 * @return void
290 */
291 function initializeTemporaryDBmount(){
292 global $BE_USER;
293
294 // Set/Cancel Temporary DB Mount:
295 if (strlen($this->setTempDBmount)) {
296 $set = t3lib_div::intInRange($this->setTempDBmount,0);
297 if ($set>0 && $BE_USER->isInWebMount($set)) { // Setting...:
298 $this->settingTemporaryMountPoint($set);
299 } else { // Clear:
300 $this->settingTemporaryMountPoint(0);
301 }
302 }
303
304 // Getting temporary mount point ID:
305 $temporaryMountPoint = intval($BE_USER->getSessionData('pageTree_temporaryMountPoint'));
306
307 // If mount point ID existed and is within users real mount points, then set it temporarily:
308 if ($temporaryMountPoint > 0 && $BE_USER->isInWebMount($temporaryMountPoint)) {
309 if ($this->active_tempMountPoint = t3lib_BEfunc::readPageAccess($temporaryMountPoint, $BE_USER->getPagePermsClause(1))) {
310 $this->pagetree->MOUNTS = array($temporaryMountPoint);
311 }
312 else {
313 // Clear temporary mount point as we have no access to it any longer
314 $this->settingTemporaryMountPoint(0);
315 }
316 }
317 }
318
319
320 /**
321 * Setting temporary page id as DB mount
322 *
323 * @param integer The page id to set as DB mount
324 * @return void
325 */
326 function settingTemporaryMountPoint($pageId) {
327 global $BE_USER;
328
329 // Setting temporary mount point ID:
330 $BE_USER->setAndSaveSessionData('pageTree_temporaryMountPoint',intval($pageId));
331 }
332 }
333
334
335 // Include extension?
336 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['typo3/alt_db_navframe.php']) {
337 include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['typo3/alt_db_navframe.php']);
338 }
339
340
341
342
343
344 // Make instance:
345 $SOBE = t3lib_div::makeInstance('SC_alt_db_navframe');
346 $SOBE->init();
347 $SOBE->main();
348 $SOBE->printContent();
349
350 ?>