* Update version numbers of all system extension that have been changed since TYPO3 4.1
[Packages/TYPO3.CMS.git] / typo3 / sysext / lowlevel / HOWTO_clean_up_TYPO3_installations.txt
1 INTRODUCTION
2 For various reasons your TYPO3 installation may over time accumulate data with integrity problems or data you wish to delete completely.
3 For instance, why keep old versions of published content? Keep that in your backup - don't load your running website with that overhead!
4 Or what about deleted records? Why not flush them - they also fill up your database and filesystem and most likely you can rely on your backups in case of an emergency recovery?
5 Also, relations between records and files inside TYPO3 may be lost over time for various reasons. If your website runs as it should such "integrity problems" are mostly easy to automatically repair by simply removing the references pointing to a missing record or file. 
6 However, it might also be "soft references" from eg. typolinks (<link 123>...</link>) or a file references in a TypoScript template (something.file = fileadmin/template/miss_me.jpg) which are missing. Those cannot be automatically repaired but the cleanup script incorporates warnings that will tell you about these problems if they exist and you can manually fix them.
7 This script provides solutions to these problems by offering an array of tools that can analyze your TYPO3 installation for various problems and in some cases offer fixes for them. Also third party extensions can plug additional functionality into the script.
8
9
10
11 PREPARATIONS:
12 THERE IS ABSOLUTELY NO WARRANTY associated with this script! It is completely on your OWN RISK that you run it. It may cause accidential data loss due to software bugs or circumstances that it does not know about yet - or data loss might happen due to misuse!
13
14 ALWAYS make a complete backup of your website! That means:
15 * Dump the complete database to an SQL file. This can usually be done from the command line like this:
16         mysqldump [database name] -u [database user] -p --add-drop-table > ./mywebsite.sql
17 * Save all files in the webroot of your site. I usually do this from the command line like this:
18         tar czf ./mywebsite.tgz [webroot directory of your site]
19
20 Before running with the --AUTOFIX option ALWAYS make sure to add the parameter "--dryrun" to see what would be fixed.
21
22 Also, NEVER BYPASS the REFERENCE INDEX CHECK if --AUTOFIX is used for those tools which require a clean reference index.
23
24 It could be a good idea to run a myisamchk on your database just to make sure MySQL has everything pulled together right. Something like this will do:
25         myisamchk [path_to_mysql_databases]/[database_name]/*.MYI -s -r
26
27
28
29 RUNNING the SCRIPT:
30 The "[base command]" is:
31         [typo3_site_directory]/typo3/cli_dispatch.phpsh lowlevel_cleaner
32
33 Try this first. If it all works out you should see a help-screen. Otherwise there will be instructions about what to do. For instance, you will have to create a backend user, "_cli_lowlevel", with any random password since you never need to log in with the user. Never mind permissions, they are not important since this script will force the user to run as "admin" in "Live" workspace.
34 You can use the script entirely by following the help screens. However, through this document you get some idea about the best order of events since they may affect each other.
35
36 For each of the tools in the test you can see a help screen by running:
37         [base command] [toolkey]
38
39 Example with the tool "orphan_records":
40         [typo3_site_directory]/typo3/cli_dispatch.phpsh lowlevel_cleaner orphan_records
41
42
43
44 SUGGESTED ORDER OF CLEAN UP:
45 The suggested order below assumes that you are interested in running all these tests. Maybe you are not! So you should check the description of each one and if there is any of the tests you wish not to run, just leave it out. It kind of gets simpler that way since the complexity mostly is when you wish to run all tests successively in which case there is an optimal order that ensures you don't have to run the tests all over again.
46
47 [base command] orphan_records -r --AUTOFIX
48         - As a beginning, get all orphaned records out of the system since you probably want to. Since orphan records may keep some missing relations from being detected it's a good idea to get them out immediately.
49
50 [base command] versions -r --AUTOFIX
51         - Flush all published versions now if you like. Published versions may also keep references to records which could affect other tests, hence do it now if you want to.
52         
53 [base command] tx_templavoila_unusedce -r --AUTOFIX
54         - (Assumes usage of "TemplaVoila" extension!)
55         - This should be done AFTER flushing published versions (since versions could reference elements that might be safe to remove)
56         - This should be done BEFORE flushing deleted versions (since this tool will create new deleted records), given that you want to completely flush them of course.
57         - You should run it over again until there remains no more unused elements. You need to do this because deleting elements might generate new unused elements if the now-deleted elements had references.
58
59 [base command] double_files -r --AUTOFIX
60         - Fix any files referenced twice or more before you delete records (which could potentially delete a file that is referenced by another file).
61
62 [base command] deleted -r --AUTOFIX
63         - Flush deleted records. As a rule of thumb, tools that create deleted records should be run before this one so the deleted records they create are also flushed (if you like to of course)
64         
65 [base command] missing_relations -r --AUTOFIX
66         - Remove missing relations at this point.
67         - If you get an error like this; "t3lib_refindex::setReferenceValue(): ERROR: No reference record with hash="132ddb399c0b15593f0d95a58159439f" was found!" just run the test again until no errors occur. The reason is that another fixed reference in the same record and field changed the reference index hash. Running the test again will find the new hash string which will then work for you.
68
69 [base command] cleanflexform -r --AUTOFIX
70         - After the "deleted" tool since we cannot clean-up deleted records and to make sure nothing unimportant is cleaned up
71
72 [base command] rte_images -r --AUTOFIX
73         - Will be affected by flushed deleted records, versions and orphans so must be run after any of those tests.
74         
75
76
77 EXECUTED ANYTIME:
78 These can be executed anytime, however you should wait till all deleted records and versions are flushed so you don't waste system resources on fixing deleted records.
79
80         [base command] missing_files -r --AUTOFIX
81         [base command] lost_files -r --AUTOFIX
82
83
84
85 NIGHTLY REPORTS OF PROBLEMS IN THE SYSTEM:
86 If you wish to scan your TYPO3 installations for problems with a cronjob or so, a shell script that outputs a report could look like this:
87
88         #!/bin/sh
89         /[WEBROOT_ABS_PATH]/typo3/dummy_4.0/typo3/cli_dispatch.phpsh lowlevel_cleaner orphan_records -r -v 2 -s
90         /[WEBROOT_ABS_PATH]/typo3/dummy_4.0/typo3/cli_dispatch.phpsh lowlevel_cleaner versions -r -v 2 -s
91         /[WEBROOT_ABS_PATH]/typo3/dummy_4.0/typo3/cli_dispatch.phpsh lowlevel_cleaner tx_templavoila_unusedce -r --refindex update -v 2 -s
92         /[WEBROOT_ABS_PATH]/typo3/dummy_4.0/typo3/cli_dispatch.phpsh lowlevel_cleaner double_files -r --refindex update -v 2 -s
93         /[WEBROOT_ABS_PATH]/typo3/dummy_4.0/typo3/cli_dispatch.phpsh lowlevel_cleaner deleted -r -v 1 -s
94         /[WEBROOT_ABS_PATH]/typo3/dummy_4.0/typo3/cli_dispatch.phpsh lowlevel_cleaner missing_relations -r --refindex update -v 2 -s
95         /[WEBROOT_ABS_PATH]/typo3/dummy_4.0/typo3/cli_dispatch.phpsh lowlevel_cleaner cleanflexform -r -v 2 -s
96         /[WEBROOT_ABS_PATH]/typo3/dummy_4.0/typo3/cli_dispatch.phpsh lowlevel_cleaner rte_images -r --refindex update -v 2 -s
97         /[WEBROOT_ABS_PATH]/typo3/dummy_4.0/typo3/cli_dispatch.phpsh lowlevel_cleaner missing_files -r --refindex update -v 2 -s 
98         /[WEBROOT_ABS_PATH]/typo3/dummy_4.0/typo3/cli_dispatch.phpsh lowlevel_cleaner lost_files -r --refindex update -v 2 -s   
99
100 You may wish to set the verbosity level (-v) to "3" instead of "2" as in the case above, depending on how important you consider the warnings.
101 You might also wish to disable tests like "deleted" which would report deleted records - something that might not warrant a warning, frankly speaking...
102 If you append "--AUTOFIX --YES" to each test it will actually perform clean up operations after checking, however it is NOT RECOMMENDED to do that as a nightly cron-job! In addition you should study what repair operations each test does to your system before using it!
103
104
105 ADDING YOUR OWN TOOLS TO THE TEST:
106 You can plug additional analysis tools into the cleaner script. All you need to do is create a class with a few specific functions and configure the cleaner to use it. You should encapsulate your class in an extension (as always).
107 In the steps below, substitute these strings with corresponding values:
108         - YOUREXTKEYNOUS = Your extension key, no underscores!
109         - YOUREXTKEY = Your full extension key
110         - CLEANERTOOL = Name prefix for your cleaner module
111
112 STEP1: Set up your class as a tool for the cleaner:
113 - In the "ext_localconf.php" file of your extension, add this:
114
115         $TYPO3_CONF_VARS['EXTCONF']['lowlevel']['cleanerModules']['tx_YOUREXTKEYNOUS_CLEANERTOOL'] = 
116                 array('EXT:YOUREXTKEY/class.YOUREXTKEYNOUS_CLEANERTOOL.php:tx_YOUREXTKEYNOUS_CLEANERTOOL');
117
118 - In your extension, create this PHP file:
119         YOUREXTKEY/class.YOUREXTKEYNOUS_CLEANERTOOL.php
120
121 - Finally, make sure to "Clear cache in typo3conf/" after having done this!
122
123 STEP2: Build your cleaner class:
124 - In the new PHP file, create a class with these basic functions:
125
126         class YOUREXTKEYNOUS_CLEANERTOOL extends tx_lowlevel_cleaner_core {
127
128                 /**
129                  * Constructor
130                  */
131                 function YOUREXTKEYNOUS_CLEANERTOOL()   {
132                         parent::tx_lowlevel_cleaner_core();
133
134                                 // Setting up help:
135                         $this->cli_options[] = array('--option1 value', 'Description...');
136                         $this->cli_options[] = array('--option2 value', 'Description...');
137
138                         $this->cli_help['name'] = 'YOUREXTKEYNOUS_CLEANERTOOL -- DESCRIPTION HERE!';
139                         $this->cli_help['description'] = trim('LONG DESCRIPTION HERE');
140
141                         $this->cli_help['examples'] = 'EXAMPLES HERE';
142                 }
143
144                 /**
145                  * Analyze and return result
146                  */
147                 function main() {
148
149                                 // Initialize result array:
150                         $resultArray = array(
151                                 'message' => $this->cli_help['name'].
152                                                         chr(10).chr(10).
153                                                         $this->cli_help['description'],
154                                 'headers' => array(
155                                         'SOME_ANALYSIS_1' => array('HEADER','DESCRIPTION',VERBOSITY_LEVEL 0-3),
156                                         'SOME_ANALYSIS_2' => array('HEADER','DESCRIPTION',VERBOSITY_LEVEL 0-3),
157                                         'SOME_ANALYSIS_...' => array('HEADER','DESCRIPTION',VERBOSITY_LEVEL 0-3),
158                                 ),
159                                 'SOME_ANALYSIS_1' => array(),
160                                 'SOME_ANALYSIS_2' => array(),
161                                 'SOME_ANALYSIS_...' => array(),
162                         );
163
164                                 // HERE you run your analysis and put result into 
165                                 // $resultArray['SOME_ANALYSIS_1']
166                                 // $resultArray['SOME_ANALYSIS_2']
167                                 // $resultArray['SOME_ANALYSIS_...']
168
169                         return $resultArray;
170                 }
171
172                 /**
173                  * Mandatory autofix function
174                  */
175                 function main_autoFix($resultArray)     {
176                         // HERE you traverse the result array and AUTOFIX what can be fixed
177                         // Make sure to use $this->cli_noExecutionCheck() - see examples from bundled tools
178                 }
179         }
180
181
182 STEP3: Develop your tool to do something...
183 - You should now be able to see your tool appear in the list of tools and you should see output from it when you choose it.
184 - Make sure to study the bundled tools from EXT:lowlevel/clmods/. Try to deliver the same high quality of documentation and coding style from there. In particular how the constructor is used to set help-message information.
185 - Also, take a look at t3lib_cli which is the very base class - you can use the functions in there in your script.