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
 154                         // get HTML-Template
 155
 156
 157                         // Adding javascript code for AJAX (prototype), drag&drop and the pagetree as well as the click menu code
 158                 $this->doc->getDragDropCode('pages');
 159                 $this->doc->getContextMenuCode();
 160                 $this->doc->loadJavascriptLib('contrib/scriptaculous/scriptaculous.js?load=effects');
 161
 162                 $this->doc->JScode .= $this->doc->wrapScriptTags(
 163                 ($this->currentSubScript?'top.currentSubScript=unescape("'.rawurlencode($this->currentSubScript).'");':'').'
 164                 // setting prefs for pagetree and drag & drop
 165                 '.($this->doHighlight ? 'Tree.highlightClass = "'.$hlClass.'";' : '').'
 166
 167                 // Function, loading the list frame from navigation tree:
 168                 function jumpTo(id, linkObj, highlightID, bank) { //
 169                         var theUrl = top.TS.PATH_typo3 + top.currentSubScript + "?id=" + id;
 170                         top.fsMod.currentBank = bank;
 171
 172                         if (top.condensedMode) top.content.location.href = theUrl;
 173                         else                   parent.list_frame.location.href=theUrl;
 174
 175                         '.($this->doHighlight ? 'Tree.highlightActiveItem("web", highlightID + "_" + bank);' : '').'
 176                         '.(!$GLOBALS['CLIENT']['FORMSTYLE'] ? '' : 'if (linkObj) linkObj.blur(); ').'
 177                         return false;
 178                 }
 179                 '.($this->cMR?"jumpTo(top.fsMod.recentIds['web'],'');":'').
 180
 181                         ($this->hasFilterBox ? 'var TYPO3PageTreeFilter = new PageTreeFilter();' : '') . '
 182
 183                 ');
 184
 185                 $this->doc->bodyTagId = 'typo3-pagetree';
 186         }
 187
 188
 189         /**
 190          * Main function, rendering the browsable page tree
 191          *
 192          * @return      void
 193          */
 194         function main() {
 195                 global $LANG,$CLIENT;
 196
 197                         // Produce browse-tree:
 198                 $tree = $this->pagetree->getBrowsableTree();
 199
 200
 201                         // Outputting Temporary DB mount notice:
 202                 if ($this->active_tempMountPoint)       {
 203                         $this->content.= '
 204         <div class="bgColor4 c-notice">
 205                 <img'.t3lib_iconWorks::skinImg('','gfx/icon_note.gif','width="18" height="16"').' align="top" alt="" />'.
 206                 '<a href="'.htmlspecialchars(t3lib_div::linkThisScript(array('setTempDBmount' => 0))).'">'.
 207                 $LANG->sl('LLL:EXT:lang/locallang_core.xml:labels.temporaryDBmount',1).
 208                 '</a><br/>
 209                 '.$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>
 210         </div>
 211                         ';
 212                 }
 213
 214                         // Outputting page tree:
 215                 $this->content .= '<div id="PageTreeDiv">'.$tree.'</div>';
 216
 217                         // Adding javascript for drag & drop activation and highlighting
 218                 $this->content .= $this->doc->wrapScriptTags('
 219                         '.($this->doHighlight ? 'Tree.highlightActiveItem("",top.fsMod.navFrameHighlightedID["web"]);' : '').'
 220                         '.(!$this->doc->isCMlayers() ? 'Tree.activateDragDrop = false;' : 'Tree.registerDragDropHandlers();')
 221                 );
 222
 223                         // Setting up the buttons and markers for docheader
 224                 $docHeaderButtons = $this->getButtons();
 225                 $markers = array(
 226                         'IMG_RESET'     => '<img'.t3lib_iconWorks::skinImg($GLOBALS['BACK_PATH'], 'gfx/close_gray.gif', ' width="16" height="16"').' id="treeFilterReset" alt="Reset Filter" />',
 227                         'WORKSPACEINFO' => $this->getWorkspaceInfo(),
 228                         'CONTENT'       => $this->content
 229                 );
 230                 $subparts = array();
 231
 232                 if (!$this->hasFilterBox) {
 233                         $subparts['###SECOND_ROW###'] = '';
 234                 }
 235                         // Build the <body> for the module
 236                 $this->content = $this->doc->startPage('TYPO3 Page Tree');
 237                 $this->content.= $this->doc->moduleBody($this->pageinfo, $docHeaderButtons, $markers, $subparts);
 238                 $this->content.= $this->doc->endPage();
 239
 240                 $this->content = $this->doc->insertStylesAndJS($this->content);
 241         }
 242
 243         /**
 244          * Outputting the accumulated content to screen
 245          *
 246          * @return      void
 247          */
 248         function printContent() {
 249                 echo $this->content;
 250         }
 251
 252         /**
 253          * Create the panel of buttons for submitting the form or otherwise perform operations.
 254          *
 255          * @return      array   all available buttons as an assoc. array
 256          */
 257         protected function getButtons() {
 258                 global $LANG;
 259
 260                 $buttons = array(
 261                         'csh' => '',
 262                         'new_page' => '',
 263                         'refresh' => '',
 264                 );
 265
 266                         // New Page
 267                 $onclickNewPageWizard = 'top.content.list_frame.location.href=top.TS.PATH_typo3+\'db_new.php?pagesOnly=1&id=\'+Tree.pageID;"';
 268                 $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>';
 269
 270                         // Refresh
 271                 $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>';
 272
 273                         // CSH
 274                 $buttons['csh'] = str_replace('typo3-csh-inline','typo3-csh-inline show-right',t3lib_BEfunc::cshItem('xMOD_csh_corebe', 'pagetree', $GLOBALS['BACK_PATH'], '', TRUE));
 275
 276                 return $buttons;
 277         }
 278
 279         /**
 280          * Create the workspace information
 281          *
 282          * @return      string  HTML containing workspace info
 283          */
 284         protected function getWorkspaceInfo() {
 285                 global $LANG;
 286
 287                 if ($GLOBALS['BE_USER']->workspace!==0 || $GLOBALS['BE_USER']->getTSConfigVal('options.pageTree.onlineWorkspaceInfo'))  {
 288                         switch($GLOBALS['BE_USER']->workspace)  {
 289                                 case 0:
 290                                         $wsTitle = '&nbsp;'.$this->doc->icons(2).'['.$LANG->sL('LLL:EXT:lang/locallang_misc.xml:shortcut_onlineWS',1).']';
 291                                 break;
 292                                 case -1:
 293                                         $wsTitle = '['.$LANG->sL('LLL:EXT:lang/locallang_misc.xml:shortcut_offlineWS',1).']';
 294                                 break;
 295                                 default:
 296                                         $wsTitle = '['.$GLOBALS['BE_USER']->workspace.'] '.htmlspecialchars($GLOBALS['BE_USER']->workspaceRec['title']);
 297                                 break;
 298                         }
 299
 300                         $workspaceInfo = '
 301                                 <div class="bgColor4 workspace-info">
 302                                         <a href="'.htmlspecialchars('mod/user/ws/index.php').'" target="content">'.
 303                                         '<img'.t3lib_iconWorks::skinImg('','gfx/i/sys_workspace.png','width="18" height="16"').' align="top" alt="" />'.
 304                                         '</a>'.$wsTitle.'
 305                                 </div>
 306                         ';
 307                 }
 308
 309                 return $workspaceInfo;
 310         }
 311
 312
 313         /**********************************
 314          *
 315          * Temporary DB mounts
 316          *
 317          **********************************/
 318
 319         /**
 320          * Getting temporary DB mount
 321          *
 322          * @return      void
 323          */
 324         function initializeTemporaryDBmount(){
 325                 global $BE_USER;
 326
 327                         // Set/Cancel Temporary DB Mount:
 328                 if (strlen($this->setTempDBmount))      {
 329                         $set = t3lib_div::intInRange($this->setTempDBmount,0);
 330                         if ($set>0 && $BE_USER->isInWebMount($set))     {       // Setting...:
 331                                 $this->settingTemporaryMountPoint($set);
 332                         } else {        // Clear:
 333                                 $this->settingTemporaryMountPoint(0);
 334                         }
 335                 }
 336
 337                         // Getting temporary mount point ID:
 338                 $temporaryMountPoint = intval($BE_USER->getSessionData('pageTree_temporaryMountPoint'));
 339
 340                         // If mount point ID existed and is within users real mount points, then set it temporarily:
 341                 if ($temporaryMountPoint > 0 && $BE_USER->isInWebMount($temporaryMountPoint))   {
 342                         if ($this->active_tempMountPoint = t3lib_BEfunc::readPageAccess($temporaryMountPoint, $BE_USER->getPagePermsClause(1))) {
 343                                 $this->pagetree->MOUNTS = array($temporaryMountPoint);
 344                         }
 345                         else {
 346                                 // Clear temporary mount point as we have no access to it any longer
 347                                 $this->settingTemporaryMountPoint(0);
 348                         }
 349                 }
 350         }
 351
 352
 353         /**
 354          * Setting temporary page id as DB mount
 355          *
 356          * @param       integer         The page id to set as DB mount
 357          * @return      void
 358          */
 359         function settingTemporaryMountPoint($pageId)    {
 360                 $GLOBALS['BE_USER']->setAndSaveSessionData('pageTree_temporaryMountPoint',intval($pageId));
 361         }
 362
 363
 364         /**********************************
 365          *
 366          * AJAX Calls
 367          *
 368          **********************************/
 369
 370         /**
 371          * Makes the AJAX call to expand or collapse the pagetree.
 372          * Called by typo3/ajax.php
 373          *
 374          * @param       array           $params: additional parameters (not used here)
 375          * @param       TYPO3AJAX       &$ajaxObj: reference of the TYPO3AJAX object of this request
 376          * @return      void
 377          */
 378         public function ajaxExpandCollapse($params, &$ajaxObj) {
 379                 global $LANG;
 380
 381                 $this->init();
 382                 $tree = $this->pagetree->getBrowsableTree();
 383                 if (!$this->pagetree->ajaxStatus) {
 384                         $ajaxObj->setError($tree);
 385                 } else  {
 386                         $ajaxObj->addContent('tree', $tree);
 387                 }
 388         }
 389 }
 390
 391
 392
 393 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['typo3/alt_db_navframe.php'])       {
 394         include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['typo3/alt_db_navframe.php']);
 395 }
 396
 397
 398 // Make instance if it is not an AJAX call
 399 if (!(TYPO3_REQUESTTYPE & TYPO3_REQUESTTYPE_AJAX)) {
 400         $SOBE = t3lib_div::makeInstance('SC_alt_db_navframe');
 401         $SOBE->init();
 402         $SOBE->initPage();
 403         $SOBE->main();
 404         $SOBE->printContent();
 405 }
 406
 407 ?>