typo3/alt_db_navframe.php

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