Remove unused local variables, update formatting and documentation
[lhc/web/wiklou.git] / includes / installer / MysqlUpdater.php
1 <?php
2 /**
3 * MySQL-specific updater.
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
19 *
20 * @file
21 * @ingroup Deployment
22 */
23
24 /**
25 * Mysql update list and mysql-specific update functions.
26 *
27 * @ingroup Deployment
28 * @since 1.17
29 */
30 class MysqlUpdater extends DatabaseUpdater {
31
32 protected function getCoreUpdateList() {
33 return array(
34 array( 'disableContentHandlerUseDB' ),
35
36 // 1.2
37 array( 'addField', 'ipblocks', 'ipb_id', 'patch-ipblocks.sql' ),
38 array( 'addField', 'ipblocks', 'ipb_expiry', 'patch-ipb_expiry.sql' ),
39 array( 'doInterwikiUpdate' ),
40 array( 'doIndexUpdate' ),
41 array( 'addTable', 'hitcounter', 'patch-hitcounter.sql' ),
42 array( 'addField', 'recentchanges', 'rc_type', 'patch-rc_type.sql' ),
43
44 // 1.3
45 array( 'addField', 'user', 'user_real_name', 'patch-user-realname.sql' ),
46 array( 'addTable', 'querycache', 'patch-querycache.sql' ),
47 array( 'addTable', 'objectcache', 'patch-objectcache.sql' ),
48 array( 'addTable', 'categorylinks', 'patch-categorylinks.sql' ),
49 array( 'doOldLinksUpdate' ),
50 array( 'doFixAncientImagelinks' ),
51 array( 'addField', 'recentchanges', 'rc_ip', 'patch-rc_ip.sql' ),
52
53 // 1.4
54 array( 'addIndex', 'image', 'PRIMARY', 'patch-image_name_primary.sql' ),
55 array( 'addField', 'recentchanges', 'rc_id', 'patch-rc_id.sql' ),
56 array( 'addField', 'recentchanges', 'rc_patrolled', 'patch-rc-patrol.sql' ),
57 array( 'addTable', 'logging', 'patch-logging.sql' ),
58 array( 'addField', 'user', 'user_token', 'patch-user_token.sql' ),
59 array( 'addField', 'watchlist', 'wl_notificationtimestamp', 'patch-email-notification.sql' ),
60 array( 'doWatchlistUpdate' ),
61 array( 'dropField', 'user', 'user_emailauthenticationtimestamp',
62 'patch-email-authentication.sql' ),
63
64 // 1.5
65 array( 'doSchemaRestructuring' ),
66 array( 'addField', 'logging', 'log_params', 'patch-log_params.sql' ),
67 array( 'checkBin', 'logging', 'log_title', 'patch-logging-title.sql', ),
68 array( 'addField', 'archive', 'ar_rev_id', 'patch-archive-rev_id.sql' ),
69 array( 'addField', 'page', 'page_len', 'patch-page_len.sql' ),
70 array( 'dropField', 'revision', 'inverse_timestamp', 'patch-inverse_timestamp.sql' ),
71 array( 'addField', 'revision', 'rev_text_id', 'patch-rev_text_id.sql' ),
72 array( 'addField', 'revision', 'rev_deleted', 'patch-rev_deleted.sql' ),
73 array( 'addField', 'image', 'img_width', 'patch-img_width.sql' ),
74 array( 'addField', 'image', 'img_metadata', 'patch-img_metadata.sql' ),
75 array( 'addField', 'user', 'user_email_token', 'patch-user_email_token.sql' ),
76 array( 'addField', 'archive', 'ar_text_id', 'patch-archive-text_id.sql' ),
77 array( 'doNamespaceSize' ),
78 array( 'addField', 'image', 'img_media_type', 'patch-img_media_type.sql' ),
79 array( 'doPagelinksUpdate' ),
80 array( 'dropField', 'image', 'img_type', 'patch-drop_img_type.sql' ),
81 array( 'doUserUniqueUpdate' ),
82 array( 'doUserGroupsUpdate' ),
83 array( 'addField', 'site_stats', 'ss_total_pages', 'patch-ss_total_articles.sql' ),
84 array( 'addTable', 'user_newtalk', 'patch-usernewtalk2.sql' ),
85 array( 'addTable', 'transcache', 'patch-transcache.sql' ),
86 array( 'addField', 'interwiki', 'iw_trans', 'patch-interwiki-trans.sql' ),
87
88 // 1.6
89 array( 'doWatchlistNull' ),
90 array( 'addIndex', 'logging', 'times', 'patch-logging-times-index.sql' ),
91 array( 'addField', 'ipblocks', 'ipb_range_start', 'patch-ipb_range_start.sql' ),
92 array( 'doPageRandomUpdate' ),
93 array( 'addField', 'user', 'user_registration', 'patch-user_registration.sql' ),
94 array( 'doTemplatelinksUpdate' ),
95 array( 'addTable', 'externallinks', 'patch-externallinks.sql' ),
96 array( 'addTable', 'job', 'patch-job.sql' ),
97 array( 'addField', 'site_stats', 'ss_images', 'patch-ss_images.sql' ),
98 array( 'addTable', 'langlinks', 'patch-langlinks.sql' ),
99 array( 'addTable', 'querycache_info', 'patch-querycacheinfo.sql' ),
100 array( 'addTable', 'filearchive', 'patch-filearchive.sql' ),
101 array( 'addField', 'ipblocks', 'ipb_anon_only', 'patch-ipb_anon_only.sql' ),
102 array( 'addIndex', 'recentchanges', 'rc_ns_usertext', 'patch-recentchanges-utindex.sql' ),
103 array( 'addIndex', 'recentchanges', 'rc_user_text', 'patch-rc_user_text-index.sql' ),
104
105 // 1.9
106 array( 'addField', 'user', 'user_newpass_time', 'patch-user_newpass_time.sql' ),
107 array( 'addTable', 'redirect', 'patch-redirect.sql' ),
108 array( 'addTable', 'querycachetwo', 'patch-querycachetwo.sql' ),
109 array( 'addField', 'ipblocks', 'ipb_enable_autoblock', 'patch-ipb_optional_autoblock.sql' ),
110 array( 'doBacklinkingIndicesUpdate' ),
111 array( 'addField', 'recentchanges', 'rc_old_len', 'patch-rc_len.sql' ),
112 array( 'addField', 'user', 'user_editcount', 'patch-user_editcount.sql' ),
113
114 // 1.10
115 array( 'doRestrictionsUpdate' ),
116 array( 'addField', 'logging', 'log_id', 'patch-log_id.sql' ),
117 array( 'addField', 'revision', 'rev_parent_id', 'patch-rev_parent_id.sql' ),
118 array( 'addField', 'page_restrictions', 'pr_id', 'patch-page_restrictions_sortkey.sql' ),
119 array( 'addField', 'revision', 'rev_len', 'patch-rev_len.sql' ),
120 array( 'addField', 'recentchanges', 'rc_deleted', 'patch-rc_deleted.sql' ),
121 array( 'addField', 'logging', 'log_deleted', 'patch-log_deleted.sql' ),
122 array( 'addField', 'archive', 'ar_deleted', 'patch-ar_deleted.sql' ),
123 array( 'addField', 'ipblocks', 'ipb_deleted', 'patch-ipb_deleted.sql' ),
124 array( 'addField', 'filearchive', 'fa_deleted', 'patch-fa_deleted.sql' ),
125 array( 'addField', 'archive', 'ar_len', 'patch-ar_len.sql' ),
126
127 // 1.11
128 array( 'addField', 'ipblocks', 'ipb_block_email', 'patch-ipb_emailban.sql' ),
129 array( 'doCategorylinksIndicesUpdate' ),
130 array( 'addField', 'oldimage', 'oi_metadata', 'patch-oi_metadata.sql' ),
131 array( 'addIndex', 'archive', 'usertext_timestamp', 'patch-archive-user-index.sql' ),
132 array( 'addIndex', 'image', 'img_usertext_timestamp', 'patch-image-user-index.sql' ),
133 array( 'addIndex', 'oldimage', 'oi_usertext_timestamp', 'patch-oldimage-user-index.sql' ),
134 array( 'addField', 'archive', 'ar_page_id', 'patch-archive-page_id.sql' ),
135 array( 'addField', 'image', 'img_sha1', 'patch-img_sha1.sql' ),
136
137 // 1.12
138 array( 'addTable', 'protected_titles', 'patch-protected_titles.sql' ),
139
140 // 1.13
141 array( 'addField', 'ipblocks', 'ipb_by_text', 'patch-ipb_by_text.sql' ),
142 array( 'addTable', 'page_props', 'patch-page_props.sql' ),
143 array( 'addTable', 'updatelog', 'patch-updatelog.sql' ),
144 array( 'addTable', 'category', 'patch-category.sql' ),
145 array( 'doCategoryPopulation' ),
146 array( 'addField', 'archive', 'ar_parent_id', 'patch-ar_parent_id.sql' ),
147 array( 'addField', 'user_newtalk', 'user_last_timestamp', 'patch-user_last_timestamp.sql' ),
148 array( 'doPopulateParentId' ),
149 array( 'checkBin', 'protected_titles', 'pt_title', 'patch-pt_title-encoding.sql', ),
150 array( 'doMaybeProfilingMemoryUpdate' ),
151 array( 'doFilearchiveIndicesUpdate' ),
152
153 // 1.14
154 array( 'addField', 'site_stats', 'ss_active_users', 'patch-ss_active_users.sql' ),
155 array( 'doActiveUsersInit' ),
156 array( 'addField', 'ipblocks', 'ipb_allow_usertalk', 'patch-ipb_allow_usertalk.sql' ),
157
158 // 1.15
159 array( 'doUniquePlTlIl' ),
160 array( 'addTable', 'change_tag', 'patch-change_tag.sql' ),
161 array( 'addTable', 'tag_summary', 'patch-tag_summary.sql' ),
162 array( 'addTable', 'valid_tag', 'patch-valid_tag.sql' ),
163
164 // 1.16
165 array( 'addTable', 'user_properties', 'patch-user_properties.sql' ),
166 array( 'addTable', 'log_search', 'patch-log_search.sql' ),
167 array( 'addField', 'logging', 'log_user_text', 'patch-log_user_text.sql' ),
168 # listed separately from the previous update because 1.16 was released without this update
169 array( 'doLogUsertextPopulation' ),
170 array( 'doLogSearchPopulation' ),
171 array( 'addTable', 'l10n_cache', 'patch-l10n_cache.sql' ),
172 array( 'addIndex', 'log_search', 'ls_field_val', 'patch-log_search-rename-index.sql' ),
173 array( 'addIndex', 'change_tag', 'change_tag_rc_tag', 'patch-change_tag-indexes.sql' ),
174 array( 'addField', 'redirect', 'rd_interwiki', 'patch-rd_interwiki.sql' ),
175 array( 'doUpdateTranscacheField' ),
176 array( 'doUpdateMimeMinorField' ),
177
178 // 1.17
179 array( 'addTable', 'iwlinks', 'patch-iwlinks.sql' ),
180 array( 'addIndex', 'iwlinks', 'iwl_prefix_title_from', 'patch-rename-iwl_prefix.sql' ),
181 array( 'addField', 'updatelog', 'ul_value', 'patch-ul_value.sql' ),
182 array( 'addField', 'interwiki', 'iw_api', 'patch-iw_api_and_wikiid.sql' ),
183 array( 'dropIndex', 'iwlinks', 'iwl_prefix', 'patch-kill-iwl_prefix.sql' ),
184 array( 'addField', 'categorylinks', 'cl_collation', 'patch-categorylinks-better-collation.sql' ),
185 array( 'doClFieldsUpdate' ),
186 array( 'doCollationUpdate' ),
187 array( 'addTable', 'msg_resource', 'patch-msg_resource.sql' ),
188 array( 'addTable', 'module_deps', 'patch-module_deps.sql' ),
189 array( 'dropIndex', 'archive', 'ar_page_revid', 'patch-archive_kill_ar_page_revid.sql' ),
190 array( 'addIndex', 'archive', 'ar_revid', 'patch-archive_ar_revid.sql' ),
191 array( 'doLangLinksLengthUpdate' ),
192
193 // 1.18
194 array( 'doUserNewTalkTimestampNotNull' ),
195 array( 'addIndex', 'user', 'user_email', 'patch-user_email_index.sql' ),
196 array( 'modifyField', 'user_properties', 'up_property', 'patch-up_property.sql' ),
197 array( 'addTable', 'uploadstash', 'patch-uploadstash.sql' ),
198 array( 'addTable', 'user_former_groups', 'patch-user_former_groups.sql' ),
199
200 // 1.19
201 array( 'addIndex', 'logging', 'type_action', 'patch-logging-type-action-index.sql' ),
202 array( 'addField', 'revision', 'rev_sha1', 'patch-rev_sha1.sql' ),
203 array( 'doMigrateUserOptions' ),
204 array( 'dropField', 'user', 'user_options', 'patch-drop-user_options.sql' ),
205 array( 'addField', 'archive', 'ar_sha1', 'patch-ar_sha1.sql' ),
206 array( 'addIndex', 'page', 'page_redirect_namespace_len',
207 'patch-page_redirect_namespace_len.sql' ),
208 array( 'addField', 'uploadstash', 'us_chunk_inx', 'patch-uploadstash_chunk.sql' ),
209 array( 'addfield', 'job', 'job_timestamp', 'patch-jobs-add-timestamp.sql' ),
210
211 // 1.20
212 array( 'addIndex', 'revision', 'page_user_timestamp', 'patch-revision-user-page-index.sql' ),
213 array( 'addField', 'ipblocks', 'ipb_parent_block_id', 'patch-ipb-parent-block-id.sql' ),
214 array( 'addIndex', 'ipblocks', 'ipb_parent_block_id', 'patch-ipb-parent-block-id-index.sql' ),
215 array( 'dropField', 'category', 'cat_hidden', 'patch-cat_hidden.sql' ),
216
217 // 1.21
218 array( 'addField', 'revision', 'rev_content_format', 'patch-revision-rev_content_format.sql' ),
219 array( 'addField', 'revision', 'rev_content_model', 'patch-revision-rev_content_model.sql' ),
220 array( 'addField', 'archive', 'ar_content_format', 'patch-archive-ar_content_format.sql' ),
221 array( 'addField', 'archive', 'ar_content_model', 'patch-archive-ar_content_model.sql' ),
222 array( 'addField', 'page', 'page_content_model', 'patch-page-page_content_model.sql' ),
223 array( 'enableContentHandlerUseDB' ),
224 array( 'dropField', 'site_stats', 'ss_admins', 'patch-drop-ss_admins.sql' ),
225 array( 'dropField', 'recentchanges', 'rc_moved_to_title', 'patch-rc_moved.sql' ),
226 array( 'addTable', 'sites', 'patch-sites.sql' ),
227 array( 'addField', 'filearchive', 'fa_sha1', 'patch-fa_sha1.sql' ),
228 array( 'addField', 'job', 'job_token', 'patch-job_token.sql' ),
229 array( 'addField', 'job', 'job_attempts', 'patch-job_attempts.sql' ),
230 array( 'doEnableProfiling' ),
231 array( 'addField', 'uploadstash', 'us_props', 'patch-uploadstash-us_props.sql' ),
232 array( 'modifyField', 'user_groups', 'ug_group', 'patch-ug_group-length-increase-255.sql' ),
233 array( 'modifyField', 'user_former_groups', 'ufg_group',
234 'patch-ufg_group-length-increase-255.sql' ),
235 array( 'addIndex', 'page_props', 'pp_propname_page',
236 'patch-page_props-propname-page-index.sql' ),
237 array( 'addIndex', 'image', 'img_media_mime', 'patch-img_media_mime-index.sql' ),
238
239 // 1.22
240 array( 'doIwlinksIndexNonUnique' ),
241 array( 'addIndex', 'iwlinks', 'iwl_prefix_from_title',
242 'patch-iwlinks-from-title-index.sql' ),
243 array( 'addField', 'archive', 'ar_id', 'patch-archive-ar_id.sql' ),
244 array( 'addField', 'externallinks', 'el_id', 'patch-externallinks-el_id.sql' ),
245 array( 'addField', 'recentchanges', 'rc_source', 'patch-rc_source.sql' ),
246 );
247 }
248
249 /**
250 * 1.4 betas were missing the 'binary' marker from logging.log_title,
251 * which causes a collation mismatch error on joins in MySQL 4.1.
252 *
253 * @param string $table Table name
254 * @param string $field Field name to check
255 * @param string $patchFile Path to the patch to correct the field
256 * @return bool
257 */
258 protected function checkBin( $table, $field, $patchFile ) {
259 if ( !$this->doTable( $table ) ) {
260 return true;
261 }
262
263 /** @var MySQLField $fieldInfo */
264 $fieldInfo = $this->db->fieldInfo( $table, $field );
265 if ( $fieldInfo->isBinary() ) {
266 $this->output( "...$table table has correct $field encoding.\n" );
267 } else {
268 $this->applyPatch( $patchFile, false, "Fixing $field encoding on $table table" );
269 }
270 }
271
272 /**
273 * Check whether an index contain a field
274 *
275 * @param string $table Table name
276 * @param string $index Index name to check
277 * @param string $field Field that should be in the index
278 * @return bool
279 */
280 protected function indexHasField( $table, $index, $field ) {
281 if ( !$this->doTable( $table ) ) {
282 return true;
283 }
284
285 $info = $this->db->indexInfo( $table, $index, __METHOD__ );
286 if ( $info ) {
287 foreach ( $info as $row ) {
288 if ( $row->Column_name == $field ) {
289 $this->output( "...index $index on table $table includes field $field.\n" );
290
291 return true;
292 }
293 }
294 }
295 $this->output( "...index $index on table $table has no field $field; added.\n" );
296
297 return false;
298 }
299
300 /**
301 * Check that interwiki table exists; if it doesn't source it
302 */
303 protected function doInterwikiUpdate() {
304 global $IP;
305
306 if ( !$this->doTable( 'interwiki' ) ) {
307 return true;
308 }
309
310 if ( $this->db->tableExists( "interwiki", __METHOD__ ) ) {
311 $this->output( "...already have interwiki table\n" );
312
313 return;
314 }
315
316 $this->applyPatch( 'patch-interwiki.sql', false, 'Creating interwiki table' );
317 $this->applyPatch(
318 "$IP/maintenance/interwiki.sql",
319 true,
320 'Adding default interwiki definitions'
321 );
322 }
323
324 /**
325 * Check that proper indexes are in place
326 */
327 protected function doIndexUpdate() {
328 $meta = $this->db->fieldInfo( 'recentchanges', 'rc_timestamp' );
329 if ( $meta === false ) {
330 throw new MWException( 'Missing rc_timestamp field of recentchanges table. Should not happen.' );
331 }
332 if ( $meta->isMultipleKey() ) {
333 $this->output( "...indexes seem up to 20031107 standards.\n" );
334
335 return;
336 }
337
338 $this->applyPatch( 'patch-indexes.sql', true, "Updating indexes to 20031107" );
339 }
340
341 protected function doOldLinksUpdate() {
342 $cl = $this->maintenance->runChild( 'ConvertLinks' );
343 $cl->execute();
344 }
345
346 protected function doFixAncientImagelinks() {
347 $info = $this->db->fieldInfo( 'imagelinks', 'il_from' );
348 if ( !$info || $info->type() !== 'string' ) {
349 $this->output( "...il_from OK\n" );
350
351 return;
352 }
353
354 $applied = $this->applyPatch(
355 'patch-fix-il_from.sql',
356 false,
357 'Fixing ancient broken imagelinks table.'
358 );
359
360 if ( $applied ) {
361 $this->output( "NOTE: you will have to run maintenance/refreshLinks.php after this." );
362 }
363 }
364
365 /**
366 * Check if we need to add talk page rows to the watchlist
367 */
368 function doWatchlistUpdate() {
369 $talk = $this->db->selectField( 'watchlist', 'count(*)', 'wl_namespace & 1', __METHOD__ );
370 $nontalk = $this->db->selectField(
371 'watchlist',
372 'count(*)',
373 'NOT (wl_namespace & 1)',
374 __METHOD__
375 );
376 if ( $talk == $nontalk ) {
377 $this->output( "...watchlist talk page rows already present.\n" );
378
379 return;
380 }
381
382 $this->output( "Adding missing watchlist talk page rows... " );
383 $this->db->insertSelect( 'watchlist', 'watchlist',
384 array(
385 'wl_user' => 'wl_user',
386 'wl_namespace' => 'wl_namespace | 1',
387 'wl_title' => 'wl_title',
388 'wl_notificationtimestamp' => 'wl_notificationtimestamp'
389 ), array( 'NOT (wl_namespace & 1)' ), __METHOD__, 'IGNORE' );
390 $this->output( "done.\n" );
391 }
392
393 function doSchemaRestructuring() {
394 if ( $this->db->tableExists( 'page', __METHOD__ ) ) {
395 $this->output( "...page table already exists.\n" );
396
397 return;
398 }
399
400 $this->output( "...converting from cur/old to page/revision/text DB structure.\n" );
401 $this->output( wfTimestamp( TS_DB ) );
402 $this->output( "......checking for duplicate entries.\n" );
403
404 list( $cur, $old, $page, $revision, $text ) = $this->db->tableNamesN(
405 'cur',
406 'old',
407 'page',
408 'revision',
409 'text'
410 );
411
412 $rows = $this->db->query( "
413 SELECT cur_title, cur_namespace, COUNT(cur_namespace) AS c
414 FROM $cur
415 GROUP BY cur_title, cur_namespace
416 HAVING c>1",
417 __METHOD__
418 );
419
420 if ( $rows->numRows() > 0 ) {
421 $this->output( wfTimestamp( TS_DB ) );
422 $this->output( "......<b>Found duplicate entries</b>\n" );
423 $this->output( sprintf( "<b> %-60s %3s %5s</b>\n", 'Title', 'NS', 'Count' ) );
424 $duplicate = array();
425 foreach ( $rows as $row ) {
426 if ( !isset( $duplicate[$row->cur_namespace] ) ) {
427 $duplicate[$row->cur_namespace] = array();
428 }
429
430 $duplicate[$row->cur_namespace][] = $row->cur_title;
431 $this->output( sprintf(
432 " %-60s %3s %5s\n",
433 $row->cur_title, $row->cur_namespace,
434 $row->c
435 ) );
436 }
437 $sql = "SELECT cur_title, cur_namespace, cur_id, cur_timestamp FROM $cur WHERE ";
438 $firstCond = true;
439 foreach ( $duplicate as $ns => $titles ) {
440 if ( $firstCond ) {
441 $firstCond = false;
442 } else {
443 $sql .= ' OR ';
444 }
445 $sql .= "( cur_namespace = {$ns} AND cur_title in (";
446 $first = true;
447 foreach ( $titles as $t ) {
448 if ( $first ) {
449 $sql .= $this->db->addQuotes( $t );
450 $first = false;
451 } else {
452 $sql .= ', ' . $this->db->addQuotes( $t );
453 }
454 }
455 $sql .= ") ) \n";
456 }
457 # By sorting descending, the most recent entry will be the first in the list.
458 # All following entries will be deleted by the next while-loop.
459 $sql .= 'ORDER BY cur_namespace, cur_title, cur_timestamp DESC';
460
461 $rows = $this->db->query( $sql, __METHOD__ );
462
463 $prev_title = $prev_namespace = false;
464 $deleteId = array();
465
466 foreach ( $rows as $row ) {
467 if ( $prev_title == $row->cur_title && $prev_namespace == $row->cur_namespace ) {
468 $deleteId[] = $row->cur_id;
469 }
470 $prev_title = $row->cur_title;
471 $prev_namespace = $row->cur_namespace;
472 }
473 $sql = "DELETE FROM $cur WHERE cur_id IN ( " . join( ',', $deleteId ) . ')';
474 $this->db->query( $sql, __METHOD__ );
475 $this->output( wfTimestamp( TS_DB ) );
476 $this->output( "......<b>Deleted</b> " . $this->db->affectedRows() . " records.\n" );
477 }
478
479 $this->output( wfTimestamp( TS_DB ) );
480 $this->output( "......Creating tables.\n" );
481 $this->db->query( "CREATE TABLE $page (
482 page_id int(8) unsigned NOT NULL auto_increment,
483 page_namespace int NOT NULL,
484 page_title varchar(255) binary NOT NULL,
485 page_restrictions tinyblob NOT NULL,
486 page_counter bigint(20) unsigned NOT NULL default '0',
487 page_is_redirect tinyint(1) unsigned NOT NULL default '0',
488 page_is_new tinyint(1) unsigned NOT NULL default '0',
489 page_random real unsigned NOT NULL,
490 page_touched char(14) binary NOT NULL default '',
491 page_latest int(8) unsigned NOT NULL,
492 page_len int(8) unsigned NOT NULL,
493
494 PRIMARY KEY page_id (page_id),
495 UNIQUE INDEX name_title (page_namespace,page_title),
496 INDEX (page_random),
497 INDEX (page_len)
498 ) ENGINE=InnoDB", __METHOD__ );
499 $this->db->query( "CREATE TABLE $revision (
500 rev_id int(8) unsigned NOT NULL auto_increment,
501 rev_page int(8) unsigned NOT NULL,
502 rev_comment tinyblob NOT NULL,
503 rev_user int(5) unsigned NOT NULL default '0',
504 rev_user_text varchar(255) binary NOT NULL default '',
505 rev_timestamp char(14) binary NOT NULL default '',
506 rev_minor_edit tinyint(1) unsigned NOT NULL default '0',
507 rev_deleted tinyint(1) unsigned NOT NULL default '0',
508 rev_len int(8) unsigned,
509 rev_parent_id int(8) unsigned default NULL,
510 PRIMARY KEY rev_page_id (rev_page, rev_id),
511 UNIQUE INDEX rev_id (rev_id),
512 INDEX rev_timestamp (rev_timestamp),
513 INDEX page_timestamp (rev_page,rev_timestamp),
514 INDEX user_timestamp (rev_user,rev_timestamp),
515 INDEX usertext_timestamp (rev_user_text,rev_timestamp)
516 ) ENGINE=InnoDB", __METHOD__ );
517
518 $this->output( wfTimestamp( TS_DB ) );
519 $this->output( "......Locking tables.\n" );
520 $this->db->query(
521 "LOCK TABLES $page WRITE, $revision WRITE, $old WRITE, $cur WRITE",
522 __METHOD__
523 );
524
525 $maxold = intval( $this->db->selectField( 'old', 'max(old_id)', '', __METHOD__ ) );
526 $this->output( wfTimestamp( TS_DB ) );
527 $this->output( "......maxold is {$maxold}\n" );
528
529 $this->output( wfTimestamp( TS_DB ) );
530 global $wgLegacySchemaConversion;
531 if ( $wgLegacySchemaConversion ) {
532 // Create HistoryBlobCurStub entries.
533 // Text will be pulled from the leftover 'cur' table at runtime.
534 $this->output( "......Moving metadata from cur; using blob references to text in cur table.\n" );
535 $cur_text = "concat('O:18:\"historyblobcurstub\":1:{s:6:\"mCurId\";i:',cur_id,';}')";
536 $cur_flags = "'object'";
537 } else {
538 // Copy all cur text in immediately: this may take longer but avoids
539 // having to keep an extra table around.
540 $this->output( "......Moving text from cur.\n" );
541 $cur_text = 'cur_text';
542 $cur_flags = "''";
543 }
544 $this->db->query(
545 "INSERT INTO $old (old_namespace, old_title, old_text, old_comment, old_user,
546 old_user_text, old_timestamp, old_minor_edit, old_flags)
547 SELECT cur_namespace, cur_title, $cur_text, cur_comment, cur_user, cur_user_text,
548 cur_timestamp, cur_minor_edit, $cur_flags
549 FROM $cur",
550 __METHOD__
551 );
552
553 $this->output( wfTimestamp( TS_DB ) );
554 $this->output( "......Setting up revision table.\n" );
555 $this->db->query(
556 "INSERT INTO $revision (rev_id, rev_page, rev_comment, rev_user,
557 rev_user_text, rev_timestamp, rev_minor_edit)
558 SELECT old_id, cur_id, old_comment, old_user, old_user_text,
559 old_timestamp, old_minor_edit
560 FROM $old,$cur WHERE old_namespace=cur_namespace AND old_title=cur_title",
561 __METHOD__
562 );
563
564 $this->output( wfTimestamp( TS_DB ) );
565 $this->output( "......Setting up page table.\n" );
566 $this->db->query(
567 "INSERT INTO $page (page_id, page_namespace, page_title,
568 page_restrictions, page_counter, page_is_redirect, page_is_new, page_random,
569 page_touched, page_latest, page_len)
570 SELECT cur_id, cur_namespace, cur_title, cur_restrictions, cur_counter,
571 cur_is_redirect, cur_is_new, cur_random, cur_touched, rev_id, LENGTH(cur_text)
572 FROM $cur,$revision
573 WHERE cur_id=rev_page AND rev_timestamp=cur_timestamp AND rev_id > {$maxold}",
574 __METHOD__
575 );
576
577 $this->output( wfTimestamp( TS_DB ) );
578 $this->output( "......Unlocking tables.\n" );
579 $this->db->query( "UNLOCK TABLES", __METHOD__ );
580
581 $this->output( wfTimestamp( TS_DB ) );
582 $this->output( "......Renaming old.\n" );
583 $this->db->query( "ALTER TABLE $old RENAME TO $text", __METHOD__ );
584
585 $this->output( wfTimestamp( TS_DB ) );
586 $this->output( "...done.\n" );
587 }
588
589 protected function doNamespaceSize() {
590 $tables = array(
591 'page' => 'page',
592 'archive' => 'ar',
593 'recentchanges' => 'rc',
594 'watchlist' => 'wl',
595 'querycache' => 'qc',
596 'logging' => 'log',
597 );
598 foreach ( $tables as $table => $prefix ) {
599 $field = $prefix . '_namespace';
600
601 $tablename = $this->db->tableName( $table );
602 $result = $this->db->query( "SHOW COLUMNS FROM $tablename LIKE '$field'", __METHOD__ );
603 $info = $this->db->fetchObject( $result );
604
605 if ( substr( $info->Type, 0, 3 ) == 'int' ) {
606 $this->output( "...$field is already a full int ($info->Type).\n" );
607 } else {
608 $this->output( "Promoting $field from $info->Type to int... " );
609 $this->db->query( "ALTER TABLE $tablename MODIFY $field int NOT NULL", __METHOD__ );
610 $this->output( "done.\n" );
611 }
612 }
613 }
614
615 protected function doPagelinksUpdate() {
616 if ( $this->db->tableExists( 'pagelinks', __METHOD__ ) ) {
617 $this->output( "...already have pagelinks table.\n" );
618
619 return;
620 }
621
622 $this->applyPatch(
623 'patch-pagelinks.sql',
624 false,
625 'Converting links and brokenlinks tables to pagelinks'
626 );
627
628 global $wgContLang;
629 foreach ( MWNamespace::getCanonicalNamespaces() as $ns => $name ) {
630 if ( $ns == 0 ) {
631 continue;
632 }
633
634 $this->output( "Cleaning up broken links for namespace $ns... " );
635
636 $pagelinks = $this->db->tableName( 'pagelinks' );
637 $name = $wgContLang->getNsText( $ns );
638 $prefix = $this->db->strencode( $name );
639 $likeprefix = str_replace( '_', '\\_', $prefix );
640
641 $sql = "UPDATE $pagelinks
642 SET pl_namespace=$ns,
643 pl_title=TRIM(LEADING '$prefix:' FROM pl_title)
644 WHERE pl_namespace=0
645 AND pl_title LIKE '$likeprefix:%'";
646
647 $this->db->query( $sql, __METHOD__ );
648 $this->output( "done.\n" );
649 }
650 }
651
652 protected function doUserUniqueUpdate() {
653 if ( !$this->doTable( 'user' ) ) {
654 return true;
655 }
656
657 $duper = new UserDupes( $this->db, array( $this, 'output' ) );
658 if ( $duper->hasUniqueIndex() ) {
659 $this->output( "...already have unique user_name index.\n" );
660
661 return;
662 }
663
664 if ( !$duper->clearDupes() ) {
665 $this->output( "WARNING: This next step will probably fail due to unfixed duplicates...\n" );
666 }
667 $this->applyPatch( 'patch-user_nameindex.sql', false, "Adding unique index on user_name" );
668 }
669
670 protected function doUserGroupsUpdate() {
671 if ( !$this->doTable( 'user_groups' ) ) {
672 return true;
673 }
674
675 if ( $this->db->tableExists( 'user_groups', __METHOD__ ) ) {
676 $info = $this->db->fieldInfo( 'user_groups', 'ug_group' );
677 if ( $info->type() == 'int' ) {
678 $oldug = $this->db->tableName( 'user_groups' );
679 $newug = $this->db->tableName( 'user_groups_bogus' );
680 $this->output( "user_groups table exists but is in bogus intermediate " .
681 "format. Renaming to $newug... " );
682 $this->db->query( "ALTER TABLE $oldug RENAME TO $newug", __METHOD__ );
683 $this->output( "done.\n" );
684
685 $this->applyPatch( 'patch-user_groups.sql', false, "Re-adding fresh user_groups table" );
686
687 $this->output( "***\n" );
688 $this->output( "*** WARNING: You will need to manually fix up user " .
689 "permissions in the user_groups\n" );
690 $this->output( "*** table. Old 1.5 alpha versions did some pretty funky stuff...\n" );
691 $this->output( "***\n" );
692 } else {
693 $this->output( "...user_groups table exists and is in current format.\n" );
694 }
695
696 return;
697 }
698
699 $this->applyPatch( 'patch-user_groups.sql', false, "Adding user_groups table" );
700
701 if ( !$this->db->tableExists( 'user_rights', __METHOD__ ) ) {
702 if ( $this->db->fieldExists( 'user', 'user_rights', __METHOD__ ) ) {
703 $this->applyPatch(
704 'patch-user_rights.sql',
705 false,
706 'Upgrading from a 1.3 or older database? Breaking out user_rights for conversion'
707 );
708 } else {
709 $this->output( "*** WARNING: couldn't locate user_rights table or field for upgrade.\n" );
710 $this->output( "*** You may need to manually configure some sysops by manipulating\n" );
711 $this->output( "*** the user_groups table.\n" );
712
713 return;
714 }
715 }
716
717 $this->output( "Converting user_rights table to user_groups... " );
718 $result = $this->db->select( 'user_rights',
719 array( 'ur_user', 'ur_rights' ),
720 array( "ur_rights != ''" ),
721 __METHOD__ );
722
723 foreach ( $result as $row ) {
724 $groups = array_unique(
725 array_map( 'trim',
726 explode( ',', $row->ur_rights ) ) );
727
728 foreach ( $groups as $group ) {
729 $this->db->insert( 'user_groups',
730 array(
731 'ug_user' => $row->ur_user,
732 'ug_group' => $group ),
733 __METHOD__ );
734 }
735 }
736 $this->output( "done.\n" );
737 }
738
739 /**
740 * Make sure wl_notificationtimestamp can be NULL,
741 * and update old broken items.
742 */
743 protected function doWatchlistNull() {
744 $info = $this->db->fieldInfo( 'watchlist', 'wl_notificationtimestamp' );
745 if ( !$info ) {
746 return;
747 }
748 if ( $info->isNullable() ) {
749 $this->output( "...wl_notificationtimestamp is already nullable.\n" );
750
751 return;
752 }
753
754 $this->applyPatch(
755 'patch-watchlist-null.sql',
756 false,
757 'Making wl_notificationtimestamp nullable'
758 );
759 }
760
761 /**
762 * Set page_random field to a random value where it is equals to 0.
763 *
764 * @see bug 3946
765 */
766 protected function doPageRandomUpdate() {
767 $page = $this->db->tableName( 'page' );
768 $this->db->query( "UPDATE $page SET page_random = RAND() WHERE page_random = 0", __METHOD__ );
769 $rows = $this->db->affectedRows();
770
771 if ( $rows ) {
772 $this->output( "Set page_random to a random value on $rows rows where it was set to 0\n" );
773 } else {
774 $this->output( "...no page_random rows needed to be set\n" );
775 }
776 }
777
778 protected function doTemplatelinksUpdate() {
779 if ( $this->db->tableExists( 'templatelinks', __METHOD__ ) ) {
780 $this->output( "...templatelinks table already exists\n" );
781
782 return;
783 }
784
785 $this->applyPatch( 'patch-templatelinks.sql', false, "Creating templatelinks table" );
786
787 $this->output( "Populating...\n" );
788 if ( wfGetLB()->getServerCount() > 1 ) {
789 // Slow, replication-friendly update
790 $res = $this->db->select( 'pagelinks', array( 'pl_from', 'pl_namespace', 'pl_title' ),
791 array( 'pl_namespace' => NS_TEMPLATE ), __METHOD__ );
792 $count = 0;
793 foreach ( $res as $row ) {
794 $count = ( $count + 1 ) % 100;
795 if ( $count == 0 ) {
796 wfWaitForSlaves();
797 }
798 $this->db->insert( 'templatelinks',
799 array(
800 'tl_from' => $row->pl_from,
801 'tl_namespace' => $row->pl_namespace,
802 'tl_title' => $row->pl_title,
803 ), __METHOD__
804 );
805 }
806 } else {
807 // Fast update
808 $this->db->insertSelect( 'templatelinks', 'pagelinks',
809 array(
810 'tl_from' => 'pl_from',
811 'tl_namespace' => 'pl_namespace',
812 'tl_title' => 'pl_title'
813 ), array(
814 'pl_namespace' => 10
815 ), __METHOD__
816 );
817 }
818 $this->output( "Done. Please run maintenance/refreshLinks.php for a more " .
819 "thorough templatelinks update.\n" );
820 }
821
822 protected function doBacklinkingIndicesUpdate() {
823 if ( !$this->indexHasField( 'pagelinks', 'pl_namespace', 'pl_from' ) ||
824 !$this->indexHasField( 'templatelinks', 'tl_namespace', 'tl_from' ) ||
825 !$this->indexHasField( 'imagelinks', 'il_to', 'il_from' )
826 ) {
827 $this->applyPatch( 'patch-backlinkindexes.sql', false, "Updating backlinking indices" );
828 }
829 }
830
831 /**
832 * Adding page_restrictions table, obsoleting page.page_restrictions.
833 * Migrating old restrictions to new table
834 * -- Andrew Garrett, January 2007.
835 */
836 protected function doRestrictionsUpdate() {
837 if ( $this->db->tableExists( 'page_restrictions', __METHOD__ ) ) {
838 $this->output( "...page_restrictions table already exists.\n" );
839
840 return;
841 }
842
843 $this->applyPatch(
844 'patch-page_restrictions.sql',
845 false,
846 'Creating page_restrictions table (1/2)'
847 );
848 $this->applyPatch(
849 'patch-page_restrictions_sortkey.sql',
850 false,
851 'Creating page_restrictions table (2/2)'
852 );
853 $this->output( "done.\n" );
854
855 $this->output( "Migrating old restrictions to new table...\n" );
856 $task = $this->maintenance->runChild( 'UpdateRestrictions' );
857 $task->execute();
858 }
859
860 protected function doCategorylinksIndicesUpdate() {
861 if ( !$this->indexHasField( 'categorylinks', 'cl_sortkey', 'cl_from' ) ) {
862 $this->applyPatch( 'patch-categorylinksindex.sql', false, "Updating categorylinks Indices" );
863 }
864 }
865
866 protected function doCategoryPopulation() {
867 if ( $this->updateRowExists( 'populate category' ) ) {
868 $this->output( "...category table already populated.\n" );
869
870 return;
871 }
872
873 $this->output(
874 "Populating category table, printing progress markers. " .
875 "For large databases, you\n" .
876 "may want to hit Ctrl-C and do this manually with maintenance/\n" .
877 "populateCategory.php.\n"
878 );
879 $task = $this->maintenance->runChild( 'PopulateCategory' );
880 $task->execute();
881 $this->output( "Done populating category table.\n" );
882 }
883
884 protected function doPopulateParentId() {
885 if ( !$this->updateRowExists( 'populate rev_parent_id' ) ) {
886 $this->output(
887 "Populating rev_parent_id fields, printing progress markers. For large\n" .
888 "databases, you may want to hit Ctrl-C and do this manually with\n" .
889 "maintenance/populateParentId.php.\n" );
890
891 $task = $this->maintenance->runChild( 'PopulateParentId' );
892 $task->execute();
893 }
894 }
895
896 protected function doEnableProfiling() {
897 global $wgProfileToDatabase;
898
899 if ( !$this->doTable( 'profiling' ) ) {
900 return true;
901 }
902
903 if ( $wgProfileToDatabase === true && !$this->db->tableExists( 'profiling', __METHOD__ ) ) {
904 $this->applyPatch( 'patch-profiling.sql', false, 'Add profiling table' );
905 }
906 }
907
908 protected function doMaybeProfilingMemoryUpdate() {
909 if ( !$this->doTable( 'profiling' ) ) {
910 return true;
911 }
912
913 if ( !$this->db->tableExists( 'profiling', __METHOD__ ) ) {
914 return true;
915 } elseif ( $this->db->fieldExists( 'profiling', 'pf_memory', __METHOD__ ) ) {
916 $this->output( "...profiling table has pf_memory field.\n" );
917
918 return true;
919 }
920
921 return $this->applyPatch(
922 'patch-profiling-memory.sql',
923 false,
924 'Adding pf_memory field to table profiling'
925 );
926 }
927
928 protected function doFilearchiveIndicesUpdate() {
929 $info = $this->db->indexInfo( 'filearchive', 'fa_user_timestamp', __METHOD__ );
930 if ( !$info ) {
931 $this->applyPatch( 'patch-filearchive-user-index.sql', false, "Updating filearchive indices" );
932 }
933
934 return true;
935 }
936
937 protected function doUniquePlTlIl() {
938 $info = $this->db->indexInfo( 'pagelinks', 'pl_namespace' );
939 if ( is_array( $info ) && !$info[0]->Non_unique ) {
940 $this->output( "...pl_namespace, tl_namespace, il_to indices are already UNIQUE.\n" );
941
942 return true;
943 }
944 if ( $this->skipSchema ) {
945 $this->output( "...skipping schema change (making pl_namespace, tl_namespace " .
946 "and il_to indices UNIQUE).\n" );
947
948 return false;
949 }
950
951 return $this->applyPatch(
952 'patch-pl-tl-il-unique.sql',
953 false,
954 'Making pl_namespace, tl_namespace and il_to indices UNIQUE'
955 );
956 }
957
958 protected function doUpdateMimeMinorField() {
959 if ( $this->updateRowExists( 'mime_minor_length' ) ) {
960 $this->output( "...*_mime_minor fields are already long enough.\n" );
961
962 return;
963 }
964
965 $this->applyPatch(
966 'patch-mime_minor_length.sql',
967 false,
968 'Altering all *_mime_minor fields to 100 bytes in size'
969 );
970 }
971
972 protected function doClFieldsUpdate() {
973 if ( $this->updateRowExists( 'cl_fields_update' ) ) {
974 $this->output( "...categorylinks up-to-date.\n" );
975
976 return;
977 }
978
979 $this->applyPatch(
980 'patch-categorylinks-better-collation2.sql',
981 false,
982 'Updating categorylinks (again)'
983 );
984 }
985
986 protected function doLangLinksLengthUpdate() {
987 $langlinks = $this->db->tableName( 'langlinks' );
988 $res = $this->db->query( "SHOW COLUMNS FROM $langlinks LIKE 'll_lang'" );
989 $row = $this->db->fetchObject( $res );
990
991 if ( $row && $row->Type == "varbinary(10)" ) {
992 $this->applyPatch(
993 'patch-langlinks-ll_lang-20.sql',
994 false,
995 'Updating length of ll_lang in langlinks'
996 );
997 } else {
998 $this->output( "...ll_lang is up-to-date.\n" );
999 }
1000 }
1001
1002 protected function doUserNewTalkTimestampNotNull() {
1003 if ( !$this->doTable( 'user_newtalk' ) ) {
1004 return true;
1005 }
1006
1007 $info = $this->db->fieldInfo( 'user_newtalk', 'user_last_timestamp' );
1008 if ( $info === false ) {
1009 return;
1010 }
1011 if ( $info->isNullable() ) {
1012 $this->output( "...user_last_timestamp is already nullable.\n" );
1013
1014 return;
1015 }
1016
1017 $this->applyPatch(
1018 'patch-user-newtalk-timestamp-null.sql',
1019 false,
1020 'Making user_last_timestamp nullable'
1021 );
1022 }
1023
1024 protected function doIwlinksIndexNonUnique() {
1025 $info = $this->db->indexInfo( 'iwlinks', 'iwl_prefix_title_from' );
1026 if ( is_array( $info ) && $info[0]->Non_unique ) {
1027 $this->output( "...iwl_prefix_title_from index is already non-UNIQUE.\n" );
1028
1029 return true;
1030 }
1031 if ( $this->skipSchema ) {
1032 $this->output( "...skipping schema change (making iwl_prefix_title_from index non-UNIQUE).\n" );
1033
1034 return false;
1035 }
1036
1037 return $this->applyPatch(
1038 'patch-iwl_prefix_title_from-non-unique.sql',
1039 false,
1040 'Making iwl_prefix_title_from index non-UNIQUE'
1041 );
1042 }
1043 }