typo3/alt_db_navframe.php

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