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