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