typo3/sysext/lowlevel/class.tx_lowlevel_cleaner_core.php

   1 <?php
   2 /***************************************************************
   3 *  Copyright notice
   4 *
   5 *  (c) 1999-2011 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  * Core functions for cleaning and analysing
  29  *
  30  * @author      Kasper Skårhøj <kasperYYYY@typo3.com>
  31  */
  32
  33
  34 /**
  35  * Core functions for cleaning and analysing
  36  *
  37  * @author      Kasper Skårhøj <kasperYYYY@typo3.com>
  38  * @package TYPO3
  39  * @subpackage tx_lowlevel
  40  */
  41 class tx_lowlevel_cleaner_core extends t3lib_cli {
  42
  43         var $genTree_traverseDeleted = TRUE;
  44         var $genTree_traverseVersions = TRUE;
  45
  46
  47
  48         var $label_infoString = 'The list of records is organized as [table]:[uid]:[field]:[flexpointer]:[softref_key]';
  49         var $pagetreePlugins = array();
  50         var $cleanerModules = array();
  51
  52         var $performanceStatistics = array();
  53
  54         protected $workspaceIndex = array();
  55
  56
  57         /**
  58          * Constructor
  59          *
  60          * @return      void
  61          */
  62         function __construct() {
  63
  64                         // Running parent class constructor
  65                 parent::__construct();
  66
  67                 $this->cleanerModules = (array)$GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['lowlevel']['cleanerModules'];
  68
  69                         // Adding options to help archive:
  70                 $this->cli_options[] = array('-r', 'Execute this tool, otherwise help is shown');
  71                 $this->cli_options[] = array('-v level', 'Verbosity level 0-3', "The value of level can be:\n  0 = all output\n  1 = info and greater (default)\n  2 = warnings and greater\n  3 = errors");
  72                 $this->cli_options[] = array('--refindex mode', 'Mode for reference index handling for operations that require a clean reference index ("update"/"ignore")', 'Options are "check" (default), "update" and "ignore". By default, the reference index is checked before running analysis that require a clean index. If the check fails, the analysis is not run. You can choose to bypass this completely (using value "ignore") or ask to have the index updated right away before the analysis (using value "update")');
  73                 $this->cli_options[] = array('--AUTOFIX [testName]', 'Repairs errors that can be automatically fixed.', 'Only add this option after having run the test without it so you know what will happen when you add this option! The optional parameter "[testName]" works for some tool keys to limit the fixing to a particular test.');
  74                 $this->cli_options[] = array('--dryrun', 'With --AUTOFIX it will only simulate a repair process', 'You may like to use this to see what the --AUTOFIX option will be doing. It will output the whole process like if a fix really occurred but nothing is in fact happening');
  75                 $this->cli_options[] = array('--YES', 'Implicit YES to all questions', 'Use this with EXTREME care. The option "-i" is not affected by this option.');
  76                 $this->cli_options[] = array('-i', 'Interactive', 'Will ask you before running the AUTOFIX on each element.');
  77                 $this->cli_options[] = array('--filterRegex expr', 'Define an expression for preg_match() that must match the element ID in order to auto repair it', 'The element ID is the string in quotation marks when the text \'Cleaning ... in "ELEMENT ID"\'. "expr" is the expression for preg_match(). To match for example "Nature3.JPG" and "Holiday3.JPG" you can use "/.*3.JPG/". To match for example "Image.jpg" and "Image.JPG" you can use "/.*.jpg/i". Try a --dryrun first to see what the matches are!');
  78                 $this->cli_options[] = array('--showhowto', 'Displays HOWTO file for cleaner script.');
  79
  80                         // Setting help texts:
  81                 $this->cli_help['name'] = 'lowlevel_cleaner -- Analysis and clean-up tools for TYPO3 installations';
  82                 $this->cli_help['synopsis'] = 'toolkey ###OPTIONS###';
  83                 $this->cli_help['description'] = "Dispatches to various analysis and clean-up tools which can plug into the API of this script. Typically you can run tests that will take longer than the usual max execution time of PHP. Such tasks could be checking for orphan records in the page tree or flushing all published versions in the system. For the complete list of options, please explore each of the 'toolkey' keywords below:\n\n  ".implode("\n  ", array_keys($this->cleanerModules));
  84                 $this->cli_help['examples'] = "/.../cli_dispatch.phpsh lowlevel_cleaner missing_files -s -r\nThis will show you missing files in the TYPO3 system and only report back if errors were found.";
  85                 $this->cli_help['author'] = "Kasper Skaarhoej, (c) 2006";
  86         }
  87
  88
  89
  90
  91
  92
  93
  94         /**************************
  95          *
  96          * CLI functionality
  97          *
  98          *************************/
  99
 100         /**
 101          * CLI engine
 102          *
 103          * @param       array           Command line arguments
 104          * @return      string
 105          */
 106         function cli_main($argv) {
 107
 108                         // Force user to admin state and set workspace to "Live":
 109                 $GLOBALS['BE_USER']->user['admin'] = 1;
 110                 $GLOBALS['BE_USER']->setWorkspace(0);
 111
 112                         // Print Howto:
 113                 if ($this->cli_isArg('--showhowto')) {
 114                         $howto = t3lib_div::getUrl(t3lib_extMgm::extPath('lowlevel').'HOWTO_clean_up_TYPO3_installations.txt');
 115                         echo wordwrap($howto, 120).LF;
 116                         exit;
 117                 }
 118
 119                         // Print help
 120                 $analysisType = (string)$this->cli_args['_DEFAULT'][1];
 121                 if (!$analysisType) {
 122                         $this->cli_validateArgs();
 123                         $this->cli_help();
 124                         exit;
 125                 }
 126
 127                         // Analysis type:
 128                 switch((string)$analysisType)    {
 129                         default:
 130                                 if (is_array($this->cleanerModules[$analysisType])) {
 131                                         $cleanerMode = t3lib_div::getUserObj($this->cleanerModules[$analysisType][0]);
 132                                         $cleanerMode->cli_validateArgs();
 133
 134                                         if ($this->cli_isArg('-r'))     {       // Run it...
 135                                                 if (!$cleanerMode->checkRefIndex || $this->cli_referenceIndexCheck()) {
 136                                                         $res = $cleanerMode->main();
 137                                                         $this->cli_printInfo($analysisType, $res);
 138
 139                                                                 // Autofix...
 140                                                         if ($this->cli_isArg('--AUTOFIX')) {
 141                                                                 if ($this->cli_isArg('--YES') || $this->cli_keyboardInput_yes("\n\nNOW Running --AUTOFIX on result. OK?".($this->cli_isArg('--dryrun')?' (--dryrun simulation)':''))) {
 142                                                                         $cleanerMode->main_autofix($res);
 143                                                                 } else {
 144                                                                         $this->cli_echo("ABORTING AutoFix...\n", 1);
 145                                                                 }
 146                                                         }
 147                                                 }
 148                                         } else {        // Help only...
 149                                                 $cleanerMode->cli_help();
 150                                                 exit;
 151                                         }
 152                                 } else {
 153                                         $this->cli_echo("ERROR: Analysis Type '".$analysisType."' is unknown.\n", 1);
 154                                         exit;
 155                                 }
 156                         break;
 157                 }
 158         }
 159
 160         /**
 161          * Checks reference index
 162          *
 163          * @return      boolean         TRUE if reference index was OK (either OK, updated or ignored)
 164          */
 165         function cli_referenceIndexCheck() {
 166
 167                         // Reference index option:
 168                 $refIndexMode = isset($this->cli_args['--refindex']) ? $this->cli_args['--refindex'][0] : 'check';
 169                 if (!t3lib_div::inList('update,ignore,check', $refIndexMode)) {
 170                         $this->cli_echo("ERROR: Wrong value for --refindex argument.\n", 1);
 171                         exit;
 172                 }
 173
 174                 switch($refIndexMode) {
 175                         case 'check':
 176                         case 'update':
 177                                 $refIndexObj = t3lib_div::makeInstance('t3lib_refindex');
 178                                 list($headerContent, $bodyContent, $errorCount) = $refIndexObj->updateIndex($refIndexMode=='check', $this->cli_echo());
 179
 180                                 if ($errorCount && $refIndexMode=='check') {
 181                                         $ok = FALSE;
 182                                         $this->cli_echo("ERROR: Reference Index Check failed! (run with '--refindex update' to fix)\n", 1);
 183                                 } else {
 184                                         $ok = TRUE;
 185                                 }
 186                         break;
 187                         case 'ignore':
 188                                 $this->cli_echo("Reference Index Check: Bypassing reference index check...\n");
 189                                 $ok = TRUE;
 190                         break;
 191                 }
 192
 193                 return $ok;
 194         }
 195
 196         /**
 197          * @param       [type]          $matchString: ...
 198          * @return      string          If string, it's the reason for not executing. Returning FALSE means it should execute.
 199          */
 200         function cli_noExecutionCheck($matchString) {
 201
 202                         // Check for filter:
 203                 if ($this->cli_isArg('--filterRegex') && $regex = $this->cli_argValue('--filterRegex', 0)) {
 204                         if (!preg_match($regex, $matchString))  return 'BYPASS: Filter Regex "'.$regex.'" did not match string "'.$matchString.'"';
 205                 }
 206                         // Check for interactive mode
 207                 if ($this->cli_isArg('-i')) {
 208                         if (!$this->cli_keyboardInput_yes(' EXECUTE?')) {
 209                                 return 'BYPASS...';
 210                         }
 211                 }
 212                         // Check for
 213                 if ($this->cli_isArg('--dryrun'))       return 'BYPASS: --dryrun set';
 214         }
 215
 216         /**
 217          * Formats a result array from a test so it fits output in the shell
 218          *
 219          * @param       string          name of the test (eg. function name)
 220          * @param       array           Result array from an analyze function
 221          * @return      void            Outputs with echo - capture content with output buffer if needed.
 222          */
 223         function cli_printInfo($header, $res) {
 224
 225                 $detailLevel = t3lib_utility_Math::forceIntegerInRange($this->cli_isArg('-v') ? $this->cli_argValue('-v') : 1, 0, 3);
 226                 $silent = !$this->cli_echo();
 227
 228                 $severity = array(
 229                         0 => 'MESSAGE',
 230                         1 => 'INFO',
 231                         2 => 'WARNING',
 232                         3 => 'ERROR',
 233                 );
 234
 235                         // Header output:
 236                 if ($detailLevel <= 1) {
 237                         $this->cli_echo(
 238                                 "*********************************************\n".
 239                                 $header.LF.
 240                                 "*********************************************\n");
 241                         $this->cli_echo(wordwrap(trim($res['message'])).LF.LF);
 242                 }
 243
 244                         // Traverse headers for output:
 245                 if (is_array($res['headers'])) {
 246                         foreach($res['headers'] as $key => $value) {
 247
 248                                 if ($detailLevel <= intval($value[2])) {
 249                                         if (is_array($res[$key]) && (count($res[$key]) || !$silent)) {
 250
 251                                                         // Header and explanaion:
 252                                                 $this->cli_echo('---------------------------------------------'.LF, 1);
 253                                                 $this->cli_echo('['.$header.']'.LF, 1);
 254                                                 $this->cli_echo($value[0].' ['.$severity[$value[2]].']'.LF, 1);
 255                                                 $this->cli_echo('---------------------------------------------'.LF, 1);
 256                                                 if (trim($value[1])) {
 257                                                         $this->cli_echo('Explanation: '.wordwrap(trim($value[1])).LF.LF, 1);
 258                                                 }
 259                                         }
 260
 261                                                 // Content:
 262                                         if (is_array($res[$key])) {
 263                                                 if (count($res[$key])) {
 264                                                         if ($this->cli_echo('', 1)) { print_r($res[$key]); }
 265                                                 } else {
 266                                                         $this->cli_echo('(None)'.LF.LF);
 267                                                 }
 268                                         } else {
 269                                                 $this->cli_echo($res[$key].LF.LF);
 270                                         }
 271                                 }
 272                         }
 273                 }
 274         }
 275
 276
 277
 278
 279
 280
 281
 282
 283
 284
 285
 286
 287         /**************************
 288          *
 289          * Page tree traversal
 290          *
 291          *************************/
 292
 293         /**
 294          * Traverses the FULL/part of page tree, mainly to register ALL validly connected records (to find orphans) but also to register deleted records, versions etc.
 295          * Output (in $this->recStats) can be useful for multiple purposes.
 296          *
 297          * @param       integer         Root page id from where to start traversal. Use "0" (zero) to have full page tree (necessary when spotting orphans, otherwise you can run it on parts only)
 298          * @param       integer         Depth to traverse. zero is do not traverse at all. 1 = 1 sublevel, 1000= 1000 sublevels (all...)
 299          * @param       boolean         If >0, will echo information about the traversal process.
 300          * @param       string          Call back function (from this class or subclass)
 301          * @return      void
 302          */
 303         function genTree($rootID, $depth=1000, $echoLevel=0, $callBack='') {
 304
 305                 $pt = t3lib_div::milliseconds();
 306                 $this->performanceStatistics['genTree()'] = '';
 307
 308                         // Initialize:
 309                 if (t3lib_extMgm::isLoaded('workspaces')) {
 310                         $this->workspaceIndex = $GLOBALS['TYPO3_DB']->exec_SELECTgetRows('uid,title', 'sys_workspace', '1=1'.t3lib_BEfunc::deleteClause('sys_workspace'), '', '', '', 'uid');
 311                 }
 312                 $this->workspaceIndex[-1] = TRUE;
 313                 $this->workspaceIndex[0] = TRUE;
 314
 315                 $this->recStats = array(
 316                         'all' => array(),                                                                       // All records connected in tree including versions (the reverse are orphans). All Info and Warning categories below are included here (and therefore safe if you delete the reverse of the list)
 317                         'deleted' => array(),                                                           // Subset of "alL" that are deleted-flagged [Info]
 318                         'versions' => array(),                                                          // Subset of "all" which are offline versions (pid=-1). [Info]
 319                         'versions_published' => array(),                                        // Subset of "versions" that is a count of 1 or more (has been published) [Info]
 320                         'versions_liveWS' => array(),                                           // Subset of "versions" that exists in live workspace [Info]
 321                         'versions_lost_workspace' => array(),                           // Subset of "versions" that doesn't belong to an existing workspace [Warning: Fix by move to live workspace]
 322                         'versions_inside_versioned_page' => array(),            // Subset of "versions" This is versions of elements found inside an already versioned branch / page. In real life this can work out, but is confusing and the backend should prevent this from happening to people. [Warning: Fix by deleting those versions (or publishing them)]
 323                         'illegal_record_under_versioned_page' => array(),       // If a page is "element" or "page" version and records are found attached to it, they might be illegally attached, so this will tell you. [Error: Fix by deleting orphans since they are not registered in "all" category]
 324                         'misplaced_at_rootlevel' => array(),                            // Subset of "all": Those that should not be at root level but are. [Warning: Fix by moving record into page tree]
 325                         'misplaced_inside_tree' => array(),                                     // Subset of "all": Those that are inside page tree but should be at root level [Warning: Fix by setting PID to zero]
 326                 );
 327
 328                         // Start traversal:
 329                 $pt2 = t3lib_div::milliseconds();
 330                 $this->performanceStatistics['genTree_traverse()'] = '';
 331                 $this->performanceStatistics['genTree_traverse():TraverseTables'] = '';
 332                 $this->genTree_traverse($rootID, $depth, $echoLevel, $callBack);
 333                 $this->performanceStatistics['genTree_traverse()'] = t3lib_div::milliseconds()-$pt2;
 334
 335                         // Sort recStats (for diff'able displays)
 336                 foreach($this->recStats as $kk => $vv) {
 337                         foreach($this->recStats[$kk] as $tables => $recArrays) {
 338                                 ksort($this->recStats[$kk][$tables]);
 339                         }
 340                         ksort($this->recStats[$kk]);
 341                 }
 342
 343                 if ($echoLevel>0)       echo LF.LF;
 344
 345
 346                         // Processing performance statistics:
 347                 $this->performanceStatistics['genTree()'] = t3lib_div::milliseconds()-$pt;
 348
 349                         // Count records:
 350                 foreach($GLOBALS['TCA'] as $tableName => $cfg) {
 351                                 // Select all records belonging to page:
 352                         $resSub = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
 353                                 'count(*)',
 354                                 $tableName,
 355                                 ''
 356                         );
 357                         $countRow = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($resSub);
 358                         $this->performanceStatistics['MySQL_count'][$tableName]=$countRow['count(*)'];
 359                         $this->performanceStatistics['CSV'].=LF.$tableName.','.
 360                                                                 $this->performanceStatistics['genTree_traverse():TraverseTables:']['MySQL'][$tableName].','.
 361                                                                 $this->performanceStatistics['genTree_traverse():TraverseTables:']['Proc'][$tableName].','.
 362                                                                 $this->performanceStatistics['MySQL_count'][$tableName];
 363                 }
 364
 365                 $this->performanceStatistics['recStats_size']['(ALL)']=strlen(serialize($this->recStats));
 366                 foreach($this->recStats as $key => $arrcontent) {
 367                         $this->performanceStatistics['recStats_size'][$key]=strlen(serialize($arrcontent));
 368                 }
 369         }
 370
 371         /**
 372          * Recursive traversal of page tree:
 373          *
 374          * @param       integer         Page root id (must be online, valid page record - or zero for page tree root)
 375          * @param       integer         Depth
 376          * @param       integer         Echo Level
 377          * @param       string          Call back function (from this class or subclass)
 378          * @param       string          DON'T set from outside, internal. (indicates we are inside a version of a page)
 379          * @param       integer         DON'T set from outside, internal. (1: Indicates that rootID is a version of a page, 2: ...that it is even a version of a version (which triggers a warning!)
 380          * @param       string          Internal string that accumulates the path
 381          * @return      void
 382          * @access private
 383          */
 384         function genTree_traverse($rootID, $depth, $echoLevel=0, $callBack='', $versionSwapmode='', $rootIsVersion=0, $accumulatedPath='') {
 385
 386                         // Register page:
 387                 $this->recStats['all']['pages'][$rootID] = $rootID;
 388                 $pageRecord = t3lib_BEfunc::getRecordRaw('pages', 'uid='.intval($rootID), 'deleted,title,t3ver_count,t3ver_wsid');
 389                 $accumulatedPath.='/'.$pageRecord['title'];
 390
 391                         // Register if page is deleted:
 392                 if ($pageRecord['deleted']) {
 393                         $this->recStats['deleted']['pages'][$rootID] = $rootID;
 394                 }
 395                         // If rootIsVersion is set it means that the input rootID is that of a version of a page. See below where the recursive call is made.
 396                 if ($rootIsVersion) {
 397                         $this->recStats['versions']['pages'][$rootID] = $rootID;
 398                         if ($pageRecord['t3ver_count']>=1 && $pageRecord['t3ver_wsid']==0)      {       // If it has been published and is in archive now...
 399                                 $this->recStats['versions_published']['pages'][$rootID] = $rootID;
 400                         }
 401                         if ($pageRecord['t3ver_wsid']==0)       {       // If it has been published and is in archive now...
 402                                 $this->recStats['versions_liveWS']['pages'][$rootID] = $rootID;
 403                         }
 404                         if (!isset($this->workspaceIndex[$pageRecord['t3ver_wsid']]))   {       // If it doesn't belong to a workspace...
 405                                 $this->recStats['versions_lost_workspace']['pages'][$rootID] = $rootID;
 406                         }
 407                         if ($rootIsVersion==2)  {       // In case the rootID is a version inside a versioned page
 408                                 $this->recStats['versions_inside_versioned_page']['pages'][$rootID] = $rootID;
 409                         }
 410                 }
 411
 412                 if ($echoLevel>0)
 413                         echo LF.$accumulatedPath.' ['.$rootID.']'.
 414                                 ($pageRecord['deleted'] ? ' (DELETED)':'').
 415                                 ($this->recStats['versions_published']['pages'][$rootID] ? ' (PUBLISHED)':'');
 416                 if ($echoLevel>1 && $this->recStats['versions_lost_workspace']['pages'][$rootID])
 417                         echo LF.'       ERROR! This version belongs to non-existing workspace ('.$pageRecord['t3ver_wsid'].')!';
 418                 if ($echoLevel>1 && $this->recStats['versions_inside_versioned_page']['pages'][$rootID])
 419                         echo LF.'       WARNING! This version is inside an already versioned page or branch!';
 420
 421                         // Call back:
 422                 if ($callBack) {
 423                         $this->$callBack('pages', $rootID, $echoLevel, $versionSwapmode, $rootIsVersion);
 424                 }
 425
 426                 $pt3 = t3lib_div::milliseconds();
 427
 428                         // Traverse tables of records that belongs to page:
 429                 foreach($GLOBALS['TCA'] as $tableName => $cfg) {
 430                         if ($tableName!='pages') {
 431
 432                                         // Select all records belonging to page:
 433                                 $pt4=t3lib_div::milliseconds();
 434                                 $resSub = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
 435                                         'uid'.($GLOBALS['TCA'][$tableName]['ctrl']['delete']?','.$GLOBALS['TCA'][$tableName]['ctrl']['delete']:''),
 436                                         $tableName,
 437                                         'pid='.intval($rootID).
 438                                                 ($this->genTree_traverseDeleted ? '' : t3lib_BEfunc::deleteClause($tableName))
 439                                 );
 440                                 $this->performanceStatistics['genTree_traverse():TraverseTables:']['MySQL']['(ALL)']+= t3lib_div::milliseconds()-$pt4;
 441                                 $this->performanceStatistics['genTree_traverse():TraverseTables:']['MySQL'][$tableName]+= t3lib_div::milliseconds()-$pt4;
 442
 443                                 $pt5=t3lib_div::milliseconds();
 444                                 $count = $GLOBALS['TYPO3_DB']->sql_num_rows($resSub);
 445                                 if ($count) {
 446                                         if ($echoLevel==2)      echo LF.'       \-'.$tableName.' ('.$count.')';
 447                                 }
 448
 449                                 while ($rowSub = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($resSub)) {
 450                                         if ($echoLevel==3)      echo LF.'       \-'.$tableName.':'.$rowSub['uid'];
 451
 452                                                 // If the rootID represents an "element" or "page" version type, we must check if the record from this table is allowed to belong to this:
 453                                         if ($versionSwapmode=='SWAPMODE:-1' || ($versionSwapmode=='SWAPMODE:0' && !$GLOBALS['TCA'][$tableName]['ctrl']['versioning_followPages'])) {
 454                                                         // This is illegal records under a versioned page - therefore not registered in $this->recStats['all'] so they should be orphaned:
 455                                                 $this->recStats['illegal_record_under_versioned_page'][$tableName][$rowSub['uid']] = $rowSub['uid'];
 456                                                 if ($echoLevel>1)       echo LF.'               ERROR! Illegal record ('.$tableName.':'.$rowSub['uid'].') under versioned page!';
 457                                         } else {
 458                                                 $this->recStats['all'][$tableName][$rowSub['uid']] = $rowSub['uid'];
 459
 460                                                         // Register deleted:
 461                                                 if ($GLOBALS['TCA'][$tableName]['ctrl']['delete'] && $rowSub[$GLOBALS['TCA'][$tableName]['ctrl']['delete']]) {
 462                                                         $this->recStats['deleted'][$tableName][$rowSub['uid']] = $rowSub['uid'];
 463                                                         if ($echoLevel==3)      echo ' (DELETED)';
 464                                                 }
 465
 466                                                         // Check location of records regarding tree root:
 467                                                 if (!$GLOBALS['TCA'][$tableName]['ctrl']['rootLevel'] && $rootID==0) {
 468                                                         $this->recStats['misplaced_at_rootlevel'][$tableName][$rowSub['uid']] = $rowSub['uid'];
 469                                                         if ($echoLevel>1)       echo LF.'               ERROR! Misplaced record ('.$tableName.':'.$rowSub['uid'].') on rootlevel!';
 470                                                 }
 471                                                 if ($GLOBALS['TCA'][$tableName]['ctrl']['rootLevel']==1 && $rootID>0) {
 472                                                         $this->recStats['misplaced_inside_tree'][$tableName][$rowSub['uid']] = $rowSub['uid'];
 473                                                         if ($echoLevel>1)       echo LF.'               ERROR! Misplaced record ('.$tableName.':'.$rowSub['uid'].') inside page tree!';
 474                                                 }
 475
 476                                                         // Traverse plugins:
 477                                                 if ($callBack) {
 478                                                         $this->$callBack($tableName, $rowSub['uid'], $echoLevel, $versionSwapmode, $rootIsVersion);
 479                                                 }
 480
 481                                                         // Add any versions of those records:
 482                                                 if ($this->genTree_traverseVersions) {
 483                                                         $versions = t3lib_BEfunc::selectVersionsOfRecord($tableName, $rowSub['uid'], 'uid,t3ver_wsid,t3ver_count'.($GLOBALS['TCA'][$tableName]['ctrl']['delete']?','.$GLOBALS['TCA'][$tableName]['ctrl']['delete']:''), 0, TRUE);
 484                                                         if (is_array($versions)) {
 485                                                                 foreach($versions as $verRec) {
 486                                                                         if (!$verRec['_CURRENT_VERSION']) {
 487                                                                                 if ($echoLevel==3)      echo LF.'               \-[#OFFLINE VERSION: WS#'.$verRec['t3ver_wsid'].'/Cnt:'.$verRec['t3ver_count'].'] '.$tableName.':'.$verRec['uid'].')';
 488                                                                                 $this->recStats['all'][$tableName][$verRec['uid']] = $verRec['uid'];
 489
 490                                                                                         // Register deleted:
 491                                                                                 if ($GLOBALS['TCA'][$tableName]['ctrl']['delete'] && $verRec[$GLOBALS['TCA'][$tableName]['ctrl']['delete']]) {
 492                                                                                         $this->recStats['deleted'][$tableName][$verRec['uid']] = $verRec['uid'];
 493                                                                                         if ($echoLevel==3)      echo ' (DELETED)';
 494                                                                                 }
 495
 496                                                                                         // Register version:
 497                                                                                 $this->recStats['versions'][$tableName][$verRec['uid']] = $verRec['uid'];
 498                                                                                 if ($verRec['t3ver_count']>=1 && $verRec['t3ver_wsid']==0)      {       // Only register published versions in LIVE workspace (published versions in draft workspaces are allowed)
 499                                                                                         $this->recStats['versions_published'][$tableName][$verRec['uid']] = $verRec['uid'];
 500                                                                                         if ($echoLevel==3)      echo ' (PUBLISHED)';
 501                                                                                 }
 502                                                                                 if ($verRec['t3ver_wsid']==0) {
 503                                                                                         $this->recStats['versions_liveWS'][$tableName][$verRec['uid']] = $verRec['uid'];
 504                                                                                 }
 505                                                                                 if (!isset($this->workspaceIndex[$verRec['t3ver_wsid']])) {
 506                                                                                         $this->recStats['versions_lost_workspace'][$tableName][$verRec['uid']] = $verRec['uid'];
 507                                                                                         if ($echoLevel>1)       echo LF.'               ERROR! Version ('.$tableName.':'.$verRec['uid'].') belongs to non-existing workspace ('.$verRec['t3ver_wsid'].')!';
 508                                                                                 }
 509                                                                                 if ($versionSwapmode)   {       // In case we are inside a versioned branch, there should not exists versions inside that "branch".
 510                                                                                         $this->recStats['versions_inside_versioned_page'][$tableName][$verRec['uid']] = $verRec['uid'];
 511                                                                                         if ($echoLevel>1)       echo LF.'               ERROR! This version ('.$tableName.':'.$verRec['uid'].') is inside an already versioned page or branch!';
 512                                                                                 }
 513
 514                                                                                         // Traverse plugins:
 515                                                                                 if ($callBack) {
 516                                                                                         $this->$callBack($tableName, $verRec['uid'], $echoLevel, $versionSwapmode, $rootIsVersion);
 517                                                                                 }
 518                                                                         }
 519                                                                 }
 520                                                         }
 521                                                         unset($versions);
 522                                                 }
 523                                         }
 524                                 }
 525
 526                                 $this->performanceStatistics['genTree_traverse():TraverseTables:']['Proc']['(ALL)']+= t3lib_div::milliseconds()-$pt5;
 527                                 $this->performanceStatistics['genTree_traverse():TraverseTables:']['Proc'][$tableName]+= t3lib_div::milliseconds()-$pt5;
 528
 529                         }
 530                 }
 531                 unset($resSub);
 532                 unset($rowSub);
 533                 $this->performanceStatistics['genTree_traverse():TraverseTables']+= t3lib_div::milliseconds()-$pt3;
 534
 535                         // Find subpages to root ID and traverse (only when rootID is not a version or is a branch-version):
 536                 if (!$versionSwapmode || $versionSwapmode=='SWAPMODE:1') {
 537                         if ($depth>0) {
 538                                 $depth--;
 539                                 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
 540                                         'uid',
 541                                         'pages',
 542                                         'pid='.intval($rootID).
 543                                                 ($this->genTree_traverseDeleted ? '' : t3lib_BEfunc::deleteClause('pages')),
 544                                         '',
 545                                         'sorting'
 546                                 );
 547                                 while ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
 548                                         $this->genTree_traverse($row['uid'], $depth, $echoLevel, $callBack, $versionSwapmode, 0, $accumulatedPath);
 549                                 }
 550                         }
 551
 552                                 // Add any versions of pages
 553                         if ($rootID>0 && $this->genTree_traverseVersions) {
 554                                 $versions = t3lib_BEfunc::selectVersionsOfRecord('pages', $rootID, 'uid,t3ver_oid,t3ver_wsid,t3ver_count,t3ver_swapmode', 0, TRUE);
 555                                 if (is_array($versions)) {
 556                                         foreach($versions as $verRec) {
 557                                                 if (!$verRec['_CURRENT_VERSION']) {
 558                                                         $this->genTree_traverse($verRec['uid'], $depth, $echoLevel, $callBack, 'SWAPMODE:'.t3lib_utility_Math::forceIntegerInRange($verRec['t3ver_swapmode'], -1, 1), $versionSwapmode?2:1, $accumulatedPath.' [#OFFLINE VERSION: WS#'.$verRec['t3ver_wsid'].'/Cnt:'.$verRec['t3ver_count'].']');
 559                                                 }
 560                                         }
 561                                 }
 562                         }
 563                 }
 564         }
 565
 566
 567
 568
 569
 570
 571
 572
 573         /**************************
 574          *
 575          * Helper functions
 576          *
 577          *************************/
 578
 579         /**
 580          * Compile info-string
 581          *
 582          * @param       array           Input record from sys_refindex
 583          * @return      string          String identifying the main record of the reference
 584          */
 585         function infoStr($rec) {
 586                 return $rec['tablename'].':'.$rec['recuid'].':'.$rec['field'].':'.$rec['flexpointer'].':'.$rec['softref_key'].($rec['deleted'] ? ' (DELETED)':'');
 587         }
 588 }
 589 ?>