Merge "Update docs/hooks.txt for ShowSearchHitTitle"
[mediawiki.git] / includes / installer / MysqlUpdater.php
blobd95222cbe1d117aa9003999a997c88b9f8a314f5
1 <?php
2 /**
3 * MySQL-specific updater.
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.
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.
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
20 * @file
21 * @ingroup Deployment
24 /**
25 * Mysql update list and mysql-specific update functions.
27 * @ingroup Deployment
28 * @since 1.17
30 class MysqlUpdater extends DatabaseUpdater {
31 protected function getCoreUpdateList() {
32 return [
33 [ 'disableContentHandlerUseDB' ],
35 // 1.2
36 [ 'addField', 'ipblocks', 'ipb_id', 'patch-ipblocks.sql' ],
37 [ 'addField', 'ipblocks', 'ipb_expiry', 'patch-ipb_expiry.sql' ],
38 [ 'doInterwikiUpdate' ],
39 [ 'doIndexUpdate' ],
40 [ 'addField', 'recentchanges', 'rc_type', 'patch-rc_type.sql' ],
41 [ 'addIndex', 'recentchanges', 'new_name_timestamp', 'patch-rc-newindex.sql' ],
43 // 1.3
44 [ 'addField', 'user', 'user_real_name', 'patch-user-realname.sql' ],
45 [ 'addTable', 'querycache', 'patch-querycache.sql' ],
46 [ 'addTable', 'objectcache', 'patch-objectcache.sql' ],
47 [ 'addTable', 'categorylinks', 'patch-categorylinks.sql' ],
48 [ 'doOldLinksUpdate' ],
49 [ 'doFixAncientImagelinks' ],
50 [ 'addField', 'recentchanges', 'rc_ip', 'patch-rc_ip.sql' ],
52 // 1.4
53 [ 'addIndex', 'image', 'PRIMARY', 'patch-image_name_primary.sql' ],
54 [ 'addField', 'recentchanges', 'rc_id', 'patch-rc_id.sql' ],
55 [ 'addField', 'recentchanges', 'rc_patrolled', 'patch-rc-patrol.sql' ],
56 [ 'addTable', 'logging', 'patch-logging.sql' ],
57 [ 'addField', 'user', 'user_token', 'patch-user_token.sql' ],
58 [ 'addField', 'watchlist', 'wl_notificationtimestamp', 'patch-email-notification.sql' ],
59 [ 'doWatchlistUpdate' ],
60 [ 'dropField', 'user', 'user_emailauthenticationtimestamp',
61 'patch-email-authentication.sql' ],
63 // 1.5
64 [ 'doSchemaRestructuring' ],
65 [ 'addField', 'logging', 'log_params', 'patch-log_params.sql' ],
66 [ 'checkBin', 'logging', 'log_title', 'patch-logging-title.sql', ],
67 [ 'addField', 'archive', 'ar_rev_id', 'patch-archive-rev_id.sql' ],
68 [ 'addField', 'page', 'page_len', 'patch-page_len.sql' ],
69 [ 'dropField', 'revision', 'inverse_timestamp', 'patch-inverse_timestamp.sql' ],
70 [ 'addField', 'revision', 'rev_text_id', 'patch-rev_text_id.sql' ],
71 [ 'addField', 'revision', 'rev_deleted', 'patch-rev_deleted.sql' ],
72 [ 'addField', 'image', 'img_width', 'patch-img_width.sql' ],
73 [ 'addField', 'image', 'img_metadata', 'patch-img_metadata.sql' ],
74 [ 'addField', 'user', 'user_email_token', 'patch-user_email_token.sql' ],
75 [ 'addField', 'archive', 'ar_text_id', 'patch-archive-text_id.sql' ],
76 [ 'doNamespaceSize' ],
77 [ 'addField', 'image', 'img_media_type', 'patch-img_media_type.sql' ],
78 [ 'doPagelinksUpdate' ],
79 [ 'dropField', 'image', 'img_type', 'patch-drop_img_type.sql' ],
80 [ 'doUserUniqueUpdate' ],
81 [ 'doUserGroupsUpdate' ],
82 [ 'addField', 'site_stats', 'ss_total_pages', 'patch-ss_total_articles.sql' ],
83 [ 'addTable', 'user_newtalk', 'patch-usernewtalk2.sql' ],
84 [ 'addTable', 'transcache', 'patch-transcache.sql' ],
85 [ 'addField', 'interwiki', 'iw_trans', 'patch-interwiki-trans.sql' ],
87 // 1.6
88 [ 'doWatchlistNull' ],
89 [ 'addIndex', 'logging', 'times', 'patch-logging-times-index.sql' ],
90 [ 'addField', 'ipblocks', 'ipb_range_start', 'patch-ipb_range_start.sql' ],
91 [ 'doPageRandomUpdate' ],
92 [ 'addField', 'user', 'user_registration', 'patch-user_registration.sql' ],
93 [ 'doTemplatelinksUpdate' ],
94 [ 'addTable', 'externallinks', 'patch-externallinks.sql' ],
95 [ 'addTable', 'job', 'patch-job.sql' ],
96 [ 'addField', 'site_stats', 'ss_images', 'patch-ss_images.sql' ],
97 [ 'addTable', 'langlinks', 'patch-langlinks.sql' ],
98 [ 'addTable', 'querycache_info', 'patch-querycacheinfo.sql' ],
99 [ 'addTable', 'filearchive', 'patch-filearchive.sql' ],
100 [ 'addField', 'ipblocks', 'ipb_anon_only', 'patch-ipb_anon_only.sql' ],
101 [ 'addIndex', 'recentchanges', 'rc_ns_usertext', 'patch-recentchanges-utindex.sql' ],
102 [ 'addIndex', 'recentchanges', 'rc_user_text', 'patch-rc_user_text-index.sql' ],
104 // 1.9
105 [ 'addField', 'user', 'user_newpass_time', 'patch-user_newpass_time.sql' ],
106 [ 'addTable', 'redirect', 'patch-redirect.sql' ],
107 [ 'addTable', 'querycachetwo', 'patch-querycachetwo.sql' ],
108 [ 'addField', 'ipblocks', 'ipb_enable_autoblock', 'patch-ipb_optional_autoblock.sql' ],
109 [ 'doBacklinkingIndicesUpdate' ],
110 [ 'addField', 'recentchanges', 'rc_old_len', 'patch-rc_len.sql' ],
111 [ 'addField', 'user', 'user_editcount', 'patch-user_editcount.sql' ],
113 // 1.10
114 [ 'doRestrictionsUpdate' ],
115 [ 'addField', 'logging', 'log_id', 'patch-log_id.sql' ],
116 [ 'addField', 'revision', 'rev_parent_id', 'patch-rev_parent_id.sql' ],
117 [ 'addField', 'page_restrictions', 'pr_id', 'patch-page_restrictions_sortkey.sql' ],
118 [ 'addField', 'revision', 'rev_len', 'patch-rev_len.sql' ],
119 [ 'addField', 'recentchanges', 'rc_deleted', 'patch-rc_deleted.sql' ],
120 [ 'addField', 'logging', 'log_deleted', 'patch-log_deleted.sql' ],
121 [ 'addField', 'archive', 'ar_deleted', 'patch-ar_deleted.sql' ],
122 [ 'addField', 'ipblocks', 'ipb_deleted', 'patch-ipb_deleted.sql' ],
123 [ 'addField', 'filearchive', 'fa_deleted', 'patch-fa_deleted.sql' ],
124 [ 'addField', 'archive', 'ar_len', 'patch-ar_len.sql' ],
126 // 1.11
127 [ 'addField', 'ipblocks', 'ipb_block_email', 'patch-ipb_emailban.sql' ],
128 [ 'doCategorylinksIndicesUpdate' ],
129 [ 'addField', 'oldimage', 'oi_metadata', 'patch-oi_metadata.sql' ],
130 [ 'addIndex', 'archive', 'usertext_timestamp', 'patch-archive-user-index.sql' ],
131 [ 'addIndex', 'image', 'img_usertext_timestamp', 'patch-image-user-index.sql' ],
132 [ 'addIndex', 'oldimage', 'oi_usertext_timestamp', 'patch-oldimage-user-index.sql' ],
133 [ 'addField', 'archive', 'ar_page_id', 'patch-archive-page_id.sql' ],
134 [ 'addField', 'image', 'img_sha1', 'patch-img_sha1.sql' ],
136 // 1.12
137 [ 'addTable', 'protected_titles', 'patch-protected_titles.sql' ],
139 // 1.13
140 [ 'addField', 'ipblocks', 'ipb_by_text', 'patch-ipb_by_text.sql' ],
141 [ 'addTable', 'page_props', 'patch-page_props.sql' ],
142 [ 'addTable', 'updatelog', 'patch-updatelog.sql' ],
143 [ 'addTable', 'category', 'patch-category.sql' ],
144 [ 'doCategoryPopulation' ],
145 [ 'addField', 'archive', 'ar_parent_id', 'patch-ar_parent_id.sql' ],
146 [ 'addField', 'user_newtalk', 'user_last_timestamp', 'patch-user_last_timestamp.sql' ],
147 [ 'doPopulateParentId' ],
148 [ 'checkBin', 'protected_titles', 'pt_title', 'patch-pt_title-encoding.sql', ],
149 [ 'doMaybeProfilingMemoryUpdate' ],
150 [ 'doFilearchiveIndicesUpdate' ],
152 // 1.14
153 [ 'addField', 'site_stats', 'ss_active_users', 'patch-ss_active_users.sql' ],
154 [ 'doActiveUsersInit' ],
155 [ 'addField', 'ipblocks', 'ipb_allow_usertalk', 'patch-ipb_allow_usertalk.sql' ],
157 // 1.15
158 [ 'addTable', 'change_tag', 'patch-change_tag.sql' ],
159 [ 'addTable', 'tag_summary', 'patch-tag_summary.sql' ],
160 [ 'addTable', 'valid_tag', 'patch-valid_tag.sql' ],
162 // 1.16
163 [ 'addTable', 'user_properties', 'patch-user_properties.sql' ],
164 [ 'addTable', 'log_search', 'patch-log_search.sql' ],
165 [ 'addField', 'logging', 'log_user_text', 'patch-log_user_text.sql' ],
166 # listed separately from the previous update because 1.16 was released without this update
167 [ 'doLogUsertextPopulation' ],
168 [ 'doLogSearchPopulation' ],
169 [ 'addTable', 'l10n_cache', 'patch-l10n_cache.sql' ],
170 [ 'addIndex', 'log_search', 'ls_field_val', 'patch-log_search-rename-index.sql' ],
171 [ 'addIndex', 'change_tag', 'change_tag_rc_tag', 'patch-change_tag-indexes.sql' ],
172 [ 'addField', 'redirect', 'rd_interwiki', 'patch-rd_interwiki.sql' ],
173 [ 'doUpdateTranscacheField' ],
174 [ 'doUpdateMimeMinorField' ],
176 // 1.17
177 [ 'addTable', 'iwlinks', 'patch-iwlinks.sql' ],
178 [ 'addIndex', 'iwlinks', 'iwl_prefix_title_from', 'patch-rename-iwl_prefix.sql' ],
179 [ 'addField', 'updatelog', 'ul_value', 'patch-ul_value.sql' ],
180 [ 'addField', 'interwiki', 'iw_api', 'patch-iw_api_and_wikiid.sql' ],
181 [ 'dropIndex', 'iwlinks', 'iwl_prefix', 'patch-kill-iwl_prefix.sql' ],
182 [ 'addField', 'categorylinks', 'cl_collation', 'patch-categorylinks-better-collation.sql' ],
183 [ 'doClFieldsUpdate' ],
184 [ 'addTable', 'module_deps', 'patch-module_deps.sql' ],
185 [ 'dropIndex', 'archive', 'ar_page_revid', 'patch-archive_kill_ar_page_revid.sql' ],
186 [ 'addIndex', 'archive', 'ar_revid', 'patch-archive_ar_revid.sql' ],
187 [ 'doLangLinksLengthUpdate' ],
189 // 1.18
190 [ 'doUserNewTalkTimestampNotNull' ],
191 [ 'addIndex', 'user', 'user_email', 'patch-user_email_index.sql' ],
192 [ 'modifyField', 'user_properties', 'up_property', 'patch-up_property.sql' ],
193 [ 'addTable', 'uploadstash', 'patch-uploadstash.sql' ],
194 [ 'addTable', 'user_former_groups', 'patch-user_former_groups.sql' ],
196 // 1.19
197 [ 'addIndex', 'logging', 'type_action', 'patch-logging-type-action-index.sql' ],
198 [ 'addField', 'revision', 'rev_sha1', 'patch-rev_sha1.sql' ],
199 [ 'doMigrateUserOptions' ],
200 [ 'dropField', 'user', 'user_options', 'patch-drop-user_options.sql' ],
201 [ 'addField', 'archive', 'ar_sha1', 'patch-ar_sha1.sql' ],
202 [ 'addIndex', 'page', 'page_redirect_namespace_len',
203 'patch-page_redirect_namespace_len.sql' ],
204 [ 'addField', 'uploadstash', 'us_chunk_inx', 'patch-uploadstash_chunk.sql' ],
205 [ 'addfield', 'job', 'job_timestamp', 'patch-jobs-add-timestamp.sql' ],
207 // 1.20
208 [ 'addIndex', 'revision', 'page_user_timestamp', 'patch-revision-user-page-index.sql' ],
209 [ 'addField', 'ipblocks', 'ipb_parent_block_id', 'patch-ipb-parent-block-id.sql' ],
210 [ 'addIndex', 'ipblocks', 'ipb_parent_block_id', 'patch-ipb-parent-block-id-index.sql' ],
211 [ 'dropField', 'category', 'cat_hidden', 'patch-cat_hidden.sql' ],
213 // 1.21
214 [ 'addField', 'revision', 'rev_content_format', 'patch-revision-rev_content_format.sql' ],
215 [ 'addField', 'revision', 'rev_content_model', 'patch-revision-rev_content_model.sql' ],
216 [ 'addField', 'archive', 'ar_content_format', 'patch-archive-ar_content_format.sql' ],
217 [ 'addField', 'archive', 'ar_content_model', 'patch-archive-ar_content_model.sql' ],
218 [ 'addField', 'page', 'page_content_model', 'patch-page-page_content_model.sql' ],
219 [ 'enableContentHandlerUseDB' ],
220 [ 'dropField', 'site_stats', 'ss_admins', 'patch-drop-ss_admins.sql' ],
221 [ 'dropField', 'recentchanges', 'rc_moved_to_title', 'patch-rc_moved.sql' ],
222 [ 'addTable', 'sites', 'patch-sites.sql' ],
223 [ 'addField', 'filearchive', 'fa_sha1', 'patch-fa_sha1.sql' ],
224 [ 'addField', 'job', 'job_token', 'patch-job_token.sql' ],
225 [ 'addField', 'job', 'job_attempts', 'patch-job_attempts.sql' ],
226 [ 'doEnableProfiling' ],
227 [ 'addField', 'uploadstash', 'us_props', 'patch-uploadstash-us_props.sql' ],
228 [ 'modifyField', 'user_groups', 'ug_group', 'patch-ug_group-length-increase-255.sql' ],
229 [ 'modifyField', 'user_former_groups', 'ufg_group',
230 'patch-ufg_group-length-increase-255.sql' ],
231 [ 'addIndex', 'page_props', 'pp_propname_page',
232 'patch-page_props-propname-page-index.sql' ],
233 [ 'addIndex', 'image', 'img_media_mime', 'patch-img_media_mime-index.sql' ],
235 // 1.22
236 [ 'doIwlinksIndexNonUnique' ],
237 [ 'addIndex', 'iwlinks', 'iwl_prefix_from_title',
238 'patch-iwlinks-from-title-index.sql' ],
239 [ 'addField', 'archive', 'ar_id', 'patch-archive-ar_id.sql' ],
240 [ 'addField', 'externallinks', 'el_id', 'patch-externallinks-el_id.sql' ],
242 // 1.23
243 [ 'addField', 'recentchanges', 'rc_source', 'patch-rc_source.sql' ],
244 [ 'addIndex', 'logging', 'log_user_text_type_time',
245 'patch-logging_user_text_type_time_index.sql' ],
246 [ 'addIndex', 'logging', 'log_user_text_time', 'patch-logging_user_text_time_index.sql' ],
247 [ 'addField', 'page', 'page_links_updated', 'patch-page_links_updated.sql' ],
248 [ 'addField', 'user', 'user_password_expires', 'patch-user_password_expire.sql' ],
250 // 1.24
251 [ 'addField', 'page_props', 'pp_sortkey', 'patch-pp_sortkey.sql' ],
252 [ 'dropField', 'recentchanges', 'rc_cur_time', 'patch-drop-rc_cur_time.sql' ],
253 [ 'addIndex', 'watchlist', 'wl_user_notificationtimestamp',
254 'patch-watchlist-user-notificationtimestamp-index.sql' ],
255 [ 'addField', 'page', 'page_lang', 'patch-page_lang.sql' ],
256 [ 'addField', 'pagelinks', 'pl_from_namespace', 'patch-pl_from_namespace.sql' ],
257 [ 'addField', 'templatelinks', 'tl_from_namespace', 'patch-tl_from_namespace.sql' ],
258 [ 'addField', 'imagelinks', 'il_from_namespace', 'patch-il_from_namespace.sql' ],
259 [ 'modifyField', 'image', 'img_major_mime',
260 'patch-img_major_mime-chemical.sql' ],
261 [ 'modifyField', 'oldimage', 'oi_major_mime',
262 'patch-oi_major_mime-chemical.sql' ],
263 [ 'modifyField', 'filearchive', 'fa_major_mime',
264 'patch-fa_major_mime-chemical.sql' ],
266 // 1.25
267 [ 'doUserNewTalkUseridUnsigned' ],
268 // note this patch covers other _comment and _description fields too
269 [ 'modifyField', 'recentchanges', 'rc_comment', 'patch-editsummary-length.sql' ],
271 // 1.26
272 [ 'dropTable', 'hitcounter' ],
273 [ 'dropField', 'site_stats', 'ss_total_views', 'patch-drop-ss_total_views.sql' ],
274 [ 'dropField', 'page', 'page_counter', 'patch-drop-page_counter.sql' ],
276 // 1.27
277 [ 'dropTable', 'msg_resource_links' ],
278 [ 'dropTable', 'msg_resource' ],
279 [ 'addTable', 'bot_passwords', 'patch-bot_passwords.sql' ],
280 [ 'addField', 'watchlist', 'wl_id', 'patch-watchlist-wl_id.sql' ],
281 [ 'dropIndex', 'categorylinks', 'cl_collation', 'patch-kill-cl_collation_index.sql' ],
282 [ 'addIndex', 'categorylinks', 'cl_collation_ext',
283 'patch-add-cl_collation_ext_index.sql' ],
284 [ 'doCollationUpdate' ],
286 // 1.28
287 [ 'addIndex', 'recentchanges', 'rc_name_type_patrolled_timestamp',
288 'patch-add-rc_name_type_patrolled_timestamp_index.sql' ],
289 [ 'doRevisionPageRevIndexNonUnique' ],
290 [ 'doNonUniquePlTlIl' ],
291 [ 'addField', 'change_tag', 'ct_id', 'patch-change_tag-ct_id.sql' ],
292 [ 'addField', 'tag_summary', 'ts_id', 'patch-tag_summary-ts_id.sql' ],
293 [ 'modifyField', 'recentchanges', 'rc_ip', 'patch-rc_ip_modify.sql' ],
295 // 1.29
296 [ 'addField', 'externallinks', 'el_index_60', 'patch-externallinks-el_index_60.sql' ],
301 * 1.4 betas were missing the 'binary' marker from logging.log_title,
302 * which causes a collation mismatch error on joins in MySQL 4.1.
304 * @param string $table Table name
305 * @param string $field Field name to check
306 * @param string $patchFile Path to the patch to correct the field
307 * @return bool
309 protected function checkBin( $table, $field, $patchFile ) {
310 if ( !$this->doTable( $table ) ) {
311 return true;
314 /** @var MySQLField $fieldInfo */
315 $fieldInfo = $this->db->fieldInfo( $table, $field );
316 if ( $fieldInfo->isBinary() ) {
317 $this->output( "...$table table has correct $field encoding.\n" );
318 } else {
319 $this->applyPatch( $patchFile, false, "Fixing $field encoding on $table table" );
324 * Check whether an index contain a field
326 * @param string $table Table name
327 * @param string $index Index name to check
328 * @param string $field Field that should be in the index
329 * @return bool
331 protected function indexHasField( $table, $index, $field ) {
332 if ( !$this->doTable( $table ) ) {
333 return true;
336 $info = $this->db->indexInfo( $table, $index, __METHOD__ );
337 if ( $info ) {
338 foreach ( $info as $row ) {
339 if ( $row->Column_name == $field ) {
340 $this->output( "...index $index on table $table includes field $field.\n" );
342 return true;
346 $this->output( "...index $index on table $table has no field $field; added.\n" );
348 return false;
352 * Check that interwiki table exists; if it doesn't source it
354 protected function doInterwikiUpdate() {
355 global $IP;
357 if ( !$this->doTable( 'interwiki' ) ) {
358 return true;
361 if ( $this->db->tableExists( "interwiki", __METHOD__ ) ) {
362 $this->output( "...already have interwiki table\n" );
364 return;
367 $this->applyPatch( 'patch-interwiki.sql', false, 'Creating interwiki table' );
368 $this->applyPatch(
369 "$IP/maintenance/interwiki.sql",
370 true,
371 'Adding default interwiki definitions'
376 * Check that proper indexes are in place
378 protected function doIndexUpdate() {
379 $meta = $this->db->fieldInfo( 'recentchanges', 'rc_timestamp' );
380 if ( $meta === false ) {
381 throw new MWException( 'Missing rc_timestamp field of recentchanges table. Should not happen.' );
383 if ( $meta->isMultipleKey() ) {
384 $this->output( "...indexes seem up to 20031107 standards.\n" );
386 return;
389 $this->applyPatch( 'patch-indexes.sql', true, "Updating indexes to 20031107" );
392 protected function doOldLinksUpdate() {
393 $cl = $this->maintenance->runChild( 'ConvertLinks' );
394 $cl->execute();
397 protected function doFixAncientImagelinks() {
398 $info = $this->db->fieldInfo( 'imagelinks', 'il_from' );
399 if ( !$info || $info->type() !== 'string' ) {
400 $this->output( "...il_from OK\n" );
402 return;
405 $applied = $this->applyPatch(
406 'patch-fix-il_from.sql',
407 false,
408 'Fixing ancient broken imagelinks table.'
411 if ( $applied ) {
412 $this->output( "NOTE: you will have to run maintenance/refreshLinks.php after this." );
417 * Check if we need to add talk page rows to the watchlist
419 function doWatchlistUpdate() {
420 $talk = $this->db->selectField( 'watchlist', 'count(*)', 'wl_namespace & 1', __METHOD__ );
421 $nontalk = $this->db->selectField(
422 'watchlist',
423 'count(*)',
424 'NOT (wl_namespace & 1)',
425 __METHOD__
427 if ( $talk == $nontalk ) {
428 $this->output( "...watchlist talk page rows already present.\n" );
430 return;
433 $this->output( "Adding missing watchlist talk page rows... " );
434 $this->db->insertSelect( 'watchlist', 'watchlist',
436 'wl_user' => 'wl_user',
437 'wl_namespace' => 'wl_namespace | 1',
438 'wl_title' => 'wl_title',
439 'wl_notificationtimestamp' => 'wl_notificationtimestamp'
440 ], [ 'NOT (wl_namespace & 1)' ], __METHOD__, 'IGNORE' );
441 $this->output( "done.\n" );
443 $this->output( "Adding missing watchlist subject page rows... " );
444 $this->db->insertSelect( 'watchlist', 'watchlist',
446 'wl_user' => 'wl_user',
447 'wl_namespace' => 'wl_namespace & ~1',
448 'wl_title' => 'wl_title',
449 'wl_notificationtimestamp' => 'wl_notificationtimestamp'
450 ], [ 'wl_namespace & 1' ], __METHOD__, 'IGNORE' );
451 $this->output( "done.\n" );
454 function doSchemaRestructuring() {
455 if ( $this->db->tableExists( 'page', __METHOD__ ) ) {
456 $this->output( "...page table already exists.\n" );
458 return;
461 $this->output( "...converting from cur/old to page/revision/text DB structure.\n" );
462 $this->output( wfTimestamp( TS_DB ) );
463 $this->output( "......checking for duplicate entries.\n" );
465 list( $cur, $old, $page, $revision, $text ) = $this->db->tableNamesN(
466 'cur',
467 'old',
468 'page',
469 'revision',
470 'text'
473 $rows = $this->db->query( "
474 SELECT cur_title, cur_namespace, COUNT(cur_namespace) AS c
475 FROM $cur
476 GROUP BY cur_title, cur_namespace
477 HAVING c>1",
478 __METHOD__
481 if ( $rows->numRows() > 0 ) {
482 $this->output( wfTimestamp( TS_DB ) );
483 $this->output( "......<b>Found duplicate entries</b>\n" );
484 $this->output( sprintf( "<b> %-60s %3s %5s</b>\n", 'Title', 'NS', 'Count' ) );
485 $duplicate = [];
486 foreach ( $rows as $row ) {
487 if ( !isset( $duplicate[$row->cur_namespace] ) ) {
488 $duplicate[$row->cur_namespace] = [];
491 $duplicate[$row->cur_namespace][] = $row->cur_title;
492 $this->output( sprintf(
493 " %-60s %3s %5s\n",
494 $row->cur_title, $row->cur_namespace,
495 $row->c
496 ) );
498 $sql = "SELECT cur_title, cur_namespace, cur_id, cur_timestamp FROM $cur WHERE ";
499 $firstCond = true;
500 foreach ( $duplicate as $ns => $titles ) {
501 if ( $firstCond ) {
502 $firstCond = false;
503 } else {
504 $sql .= ' OR ';
506 $sql .= "( cur_namespace = {$ns} AND cur_title in (";
507 $first = true;
508 foreach ( $titles as $t ) {
509 if ( $first ) {
510 $sql .= $this->db->addQuotes( $t );
511 $first = false;
512 } else {
513 $sql .= ', ' . $this->db->addQuotes( $t );
516 $sql .= ") ) \n";
518 # By sorting descending, the most recent entry will be the first in the list.
519 # All following entries will be deleted by the next while-loop.
520 $sql .= 'ORDER BY cur_namespace, cur_title, cur_timestamp DESC';
522 $rows = $this->db->query( $sql, __METHOD__ );
524 $prev_title = $prev_namespace = false;
525 $deleteId = [];
527 foreach ( $rows as $row ) {
528 if ( $prev_title == $row->cur_title && $prev_namespace == $row->cur_namespace ) {
529 $deleteId[] = $row->cur_id;
531 $prev_title = $row->cur_title;
532 $prev_namespace = $row->cur_namespace;
534 $sql = "DELETE FROM $cur WHERE cur_id IN ( " . implode( ',', $deleteId ) . ')';
535 $this->db->query( $sql, __METHOD__ );
536 $this->output( wfTimestamp( TS_DB ) );
537 $this->output( "......<b>Deleted</b> " . $this->db->affectedRows() . " records.\n" );
540 $this->output( wfTimestamp( TS_DB ) );
541 $this->output( "......Creating tables.\n" );
542 $this->db->query( "CREATE TABLE $page (
543 page_id int(8) unsigned NOT NULL auto_increment,
544 page_namespace int NOT NULL,
545 page_title varchar(255) binary NOT NULL,
546 page_restrictions tinyblob NOT NULL,
547 page_is_redirect tinyint(1) unsigned NOT NULL default '0',
548 page_is_new tinyint(1) unsigned NOT NULL default '0',
549 page_random real unsigned NOT NULL,
550 page_touched char(14) binary NOT NULL default '',
551 page_latest int(8) unsigned NOT NULL,
552 page_len int(8) unsigned NOT NULL,
554 PRIMARY KEY page_id (page_id),
555 UNIQUE INDEX name_title (page_namespace,page_title),
556 INDEX (page_random),
557 INDEX (page_len)
558 ) ENGINE=InnoDB", __METHOD__ );
559 $this->db->query( "CREATE TABLE $revision (
560 rev_id int(8) unsigned NOT NULL auto_increment,
561 rev_page int(8) unsigned NOT NULL,
562 rev_comment tinyblob NOT NULL,
563 rev_user int(5) unsigned NOT NULL default '0',
564 rev_user_text varchar(255) binary NOT NULL default '',
565 rev_timestamp char(14) binary NOT NULL default '',
566 rev_minor_edit tinyint(1) unsigned NOT NULL default '0',
567 rev_deleted tinyint(1) unsigned NOT NULL default '0',
568 rev_len int(8) unsigned,
569 rev_parent_id int(8) unsigned default NULL,
570 PRIMARY KEY rev_page_id (rev_page, rev_id),
571 UNIQUE INDEX rev_id (rev_id),
572 INDEX rev_timestamp (rev_timestamp),
573 INDEX page_timestamp (rev_page,rev_timestamp),
574 INDEX user_timestamp (rev_user,rev_timestamp),
575 INDEX usertext_timestamp (rev_user_text,rev_timestamp)
576 ) ENGINE=InnoDB", __METHOD__ );
578 $this->output( wfTimestamp( TS_DB ) );
579 $this->output( "......Locking tables.\n" );
580 $this->db->query(
581 "LOCK TABLES $page WRITE, $revision WRITE, $old WRITE, $cur WRITE",
582 __METHOD__
585 $maxold = intval( $this->db->selectField( 'old', 'max(old_id)', '', __METHOD__ ) );
586 $this->output( wfTimestamp( TS_DB ) );
587 $this->output( "......maxold is {$maxold}\n" );
589 $this->output( wfTimestamp( TS_DB ) );
590 global $wgLegacySchemaConversion;
591 if ( $wgLegacySchemaConversion ) {
592 // Create HistoryBlobCurStub entries.
593 // Text will be pulled from the leftover 'cur' table at runtime.
594 $this->output( "......Moving metadata from cur; using blob references to text in cur table.\n" );
595 $cur_text = "concat('O:18:\"historyblobcurstub\":1:{s:6:\"mCurId\";i:',cur_id,';}')";
596 $cur_flags = "'object'";
597 } else {
598 // Copy all cur text in immediately: this may take longer but avoids
599 // having to keep an extra table around.
600 $this->output( "......Moving text from cur.\n" );
601 $cur_text = 'cur_text';
602 $cur_flags = "''";
604 $this->db->query(
605 "INSERT INTO $old (old_namespace, old_title, old_text, old_comment, old_user,
606 old_user_text, old_timestamp, old_minor_edit, old_flags)
607 SELECT cur_namespace, cur_title, $cur_text, cur_comment, cur_user, cur_user_text,
608 cur_timestamp, cur_minor_edit, $cur_flags
609 FROM $cur",
610 __METHOD__
613 $this->output( wfTimestamp( TS_DB ) );
614 $this->output( "......Setting up revision table.\n" );
615 $this->db->query(
616 "INSERT INTO $revision (rev_id, rev_page, rev_comment, rev_user,
617 rev_user_text, rev_timestamp, rev_minor_edit)
618 SELECT old_id, cur_id, old_comment, old_user, old_user_text,
619 old_timestamp, old_minor_edit
620 FROM $old,$cur WHERE old_namespace=cur_namespace AND old_title=cur_title",
621 __METHOD__
624 $this->output( wfTimestamp( TS_DB ) );
625 $this->output( "......Setting up page table.\n" );
626 $this->db->query(
627 "INSERT INTO $page (page_id, page_namespace, page_title,
628 page_restrictions, page_is_redirect, page_is_new, page_random,
629 page_touched, page_latest, page_len)
630 SELECT cur_id, cur_namespace, cur_title, cur_restrictions,
631 cur_is_redirect, cur_is_new, cur_random, cur_touched, rev_id, LENGTH(cur_text)
632 FROM $cur,$revision
633 WHERE cur_id=rev_page AND rev_timestamp=cur_timestamp AND rev_id > {$maxold}",
634 __METHOD__
637 $this->output( wfTimestamp( TS_DB ) );
638 $this->output( "......Unlocking tables.\n" );
639 $this->db->query( "UNLOCK TABLES", __METHOD__ );
641 $this->output( wfTimestamp( TS_DB ) );
642 $this->output( "......Renaming old.\n" );
643 $this->db->query( "ALTER TABLE $old RENAME TO $text", __METHOD__ );
645 $this->output( wfTimestamp( TS_DB ) );
646 $this->output( "...done.\n" );
649 protected function doNamespaceSize() {
650 $tables = [
651 'page' => 'page',
652 'archive' => 'ar',
653 'recentchanges' => 'rc',
654 'watchlist' => 'wl',
655 'querycache' => 'qc',
656 'logging' => 'log',
658 foreach ( $tables as $table => $prefix ) {
659 $field = $prefix . '_namespace';
661 $tablename = $this->db->tableName( $table );
662 $result = $this->db->query( "SHOW COLUMNS FROM $tablename LIKE '$field'", __METHOD__ );
663 $info = $this->db->fetchObject( $result );
665 if ( substr( $info->Type, 0, 3 ) == 'int' ) {
666 $this->output( "...$field is already a full int ($info->Type).\n" );
667 } else {
668 $this->output( "Promoting $field from $info->Type to int... " );
669 $this->db->query( "ALTER TABLE $tablename MODIFY $field int NOT NULL", __METHOD__ );
670 $this->output( "done.\n" );
675 protected function doPagelinksUpdate() {
676 if ( $this->db->tableExists( 'pagelinks', __METHOD__ ) ) {
677 $this->output( "...already have pagelinks table.\n" );
679 return;
682 $this->applyPatch(
683 'patch-pagelinks.sql',
684 false,
685 'Converting links and brokenlinks tables to pagelinks'
688 global $wgContLang;
689 foreach ( $wgContLang->getNamespaces() as $ns => $name ) {
690 if ( $ns == 0 ) {
691 continue;
694 $this->output( "Cleaning up broken links for namespace $ns... " );
695 $this->db->update( 'pagelinks',
697 'pl_namespace' => $ns,
698 "pl_title = TRIM(LEADING {$this->db->addQuotes( "$name:" )} FROM pl_title)",
701 'pl_namespace' => 0,
702 'pl_title' . $this->db->buildLike( "$name:", $this->db->anyString() ),
704 __METHOD__
706 $this->output( "done.\n" );
710 protected function doUserUniqueUpdate() {
711 if ( !$this->doTable( 'user' ) ) {
712 return true;
715 $duper = new UserDupes( $this->db, [ $this, 'output' ] );
716 if ( $duper->hasUniqueIndex() ) {
717 $this->output( "...already have unique user_name index.\n" );
719 return;
722 if ( !$duper->clearDupes() ) {
723 $this->output( "WARNING: This next step will probably fail due to unfixed duplicates...\n" );
725 $this->applyPatch( 'patch-user_nameindex.sql', false, "Adding unique index on user_name" );
728 protected function doUserGroupsUpdate() {
729 if ( !$this->doTable( 'user_groups' ) ) {
730 return true;
733 if ( $this->db->tableExists( 'user_groups', __METHOD__ ) ) {
734 $info = $this->db->fieldInfo( 'user_groups', 'ug_group' );
735 if ( $info->type() == 'int' ) {
736 $oldug = $this->db->tableName( 'user_groups' );
737 $newug = $this->db->tableName( 'user_groups_bogus' );
738 $this->output( "user_groups table exists but is in bogus intermediate " .
739 "format. Renaming to $newug... " );
740 $this->db->query( "ALTER TABLE $oldug RENAME TO $newug", __METHOD__ );
741 $this->output( "done.\n" );
743 $this->applyPatch( 'patch-user_groups.sql', false, "Re-adding fresh user_groups table" );
745 $this->output( "***\n" );
746 $this->output( "*** WARNING: You will need to manually fix up user " .
747 "permissions in the user_groups\n" );
748 $this->output( "*** table. Old 1.5 alpha versions did some pretty funky stuff...\n" );
749 $this->output( "***\n" );
750 } else {
751 $this->output( "...user_groups table exists and is in current format.\n" );
754 return;
757 $this->applyPatch( 'patch-user_groups.sql', false, "Adding user_groups table" );
759 if ( !$this->db->tableExists( 'user_rights', __METHOD__ ) ) {
760 if ( $this->db->fieldExists( 'user', 'user_rights', __METHOD__ ) ) {
761 $this->applyPatch(
762 'patch-user_rights.sql',
763 false,
764 'Upgrading from a 1.3 or older database? Breaking out user_rights for conversion'
766 } else {
767 $this->output( "*** WARNING: couldn't locate user_rights table or field for upgrade.\n" );
768 $this->output( "*** You may need to manually configure some sysops by manipulating\n" );
769 $this->output( "*** the user_groups table.\n" );
771 return;
775 $this->output( "Converting user_rights table to user_groups... " );
776 $result = $this->db->select( 'user_rights',
777 [ 'ur_user', 'ur_rights' ],
778 [ "ur_rights != ''" ],
779 __METHOD__ );
781 foreach ( $result as $row ) {
782 $groups = array_unique(
783 array_map( 'trim',
784 explode( ',', $row->ur_rights ) ) );
786 foreach ( $groups as $group ) {
787 $this->db->insert( 'user_groups',
789 'ug_user' => $row->ur_user,
790 'ug_group' => $group ],
791 __METHOD__ );
794 $this->output( "done.\n" );
798 * Make sure wl_notificationtimestamp can be NULL,
799 * and update old broken items.
801 protected function doWatchlistNull() {
802 $info = $this->db->fieldInfo( 'watchlist', 'wl_notificationtimestamp' );
803 if ( !$info ) {
804 return;
806 if ( $info->isNullable() ) {
807 $this->output( "...wl_notificationtimestamp is already nullable.\n" );
809 return;
812 $this->applyPatch(
813 'patch-watchlist-null.sql',
814 false,
815 'Making wl_notificationtimestamp nullable'
820 * Set page_random field to a random value where it is equals to 0.
822 * @see bug 3946
824 protected function doPageRandomUpdate() {
825 $page = $this->db->tableName( 'page' );
826 $this->db->query( "UPDATE $page SET page_random = RAND() WHERE page_random = 0", __METHOD__ );
827 $rows = $this->db->affectedRows();
829 if ( $rows ) {
830 $this->output( "Set page_random to a random value on $rows rows where it was set to 0\n" );
831 } else {
832 $this->output( "...no page_random rows needed to be set\n" );
836 protected function doTemplatelinksUpdate() {
837 if ( $this->db->tableExists( 'templatelinks', __METHOD__ ) ) {
838 $this->output( "...templatelinks table already exists\n" );
840 return;
843 $this->applyPatch( 'patch-templatelinks.sql', false, "Creating templatelinks table" );
845 $this->output( "Populating...\n" );
846 if ( wfGetLB()->getServerCount() > 1 ) {
847 // Slow, replication-friendly update
848 $res = $this->db->select( 'pagelinks', [ 'pl_from', 'pl_namespace', 'pl_title' ],
849 [ 'pl_namespace' => NS_TEMPLATE ], __METHOD__ );
850 $count = 0;
851 foreach ( $res as $row ) {
852 $count = ( $count + 1 ) % 100;
853 if ( $count == 0 ) {
854 wfGetLBFactory()->waitForReplication( [ 'wiki' => wfWikiID() ] );
856 $this->db->insert( 'templatelinks',
858 'tl_from' => $row->pl_from,
859 'tl_namespace' => $row->pl_namespace,
860 'tl_title' => $row->pl_title,
861 ], __METHOD__
864 } else {
865 // Fast update
866 $this->db->insertSelect( 'templatelinks', 'pagelinks',
868 'tl_from' => 'pl_from',
869 'tl_namespace' => 'pl_namespace',
870 'tl_title' => 'pl_title'
871 ], [
872 'pl_namespace' => 10
873 ], __METHOD__
876 $this->output( "Done. Please run maintenance/refreshLinks.php for a more " .
877 "thorough templatelinks update.\n" );
880 protected function doBacklinkingIndicesUpdate() {
881 if ( !$this->indexHasField( 'pagelinks', 'pl_namespace', 'pl_from' ) ||
882 !$this->indexHasField( 'templatelinks', 'tl_namespace', 'tl_from' ) ||
883 !$this->indexHasField( 'imagelinks', 'il_to', 'il_from' )
885 $this->applyPatch( 'patch-backlinkindexes.sql', false, "Updating backlinking indices" );
890 * Adding page_restrictions table, obsoleting page.page_restrictions.
891 * Migrating old restrictions to new table
892 * -- Andrew Garrett, January 2007.
894 protected function doRestrictionsUpdate() {
895 if ( $this->db->tableExists( 'page_restrictions', __METHOD__ ) ) {
896 $this->output( "...page_restrictions table already exists.\n" );
898 return;
901 $this->applyPatch(
902 'patch-page_restrictions.sql',
903 false,
904 'Creating page_restrictions table (1/2)'
906 $this->applyPatch(
907 'patch-page_restrictions_sortkey.sql',
908 false,
909 'Creating page_restrictions table (2/2)'
911 $this->output( "done.\n" );
913 $this->output( "Migrating old restrictions to new table...\n" );
914 $task = $this->maintenance->runChild( 'UpdateRestrictions' );
915 $task->execute();
918 protected function doCategorylinksIndicesUpdate() {
919 if ( !$this->indexHasField( 'categorylinks', 'cl_sortkey', 'cl_from' ) ) {
920 $this->applyPatch( 'patch-categorylinksindex.sql', false, "Updating categorylinks Indices" );
924 protected function doCategoryPopulation() {
925 if ( $this->updateRowExists( 'populate category' ) ) {
926 $this->output( "...category table already populated.\n" );
928 return;
931 $this->output(
932 "Populating category table, printing progress markers. " .
933 "For large databases, you\n" .
934 "may want to hit Ctrl-C and do this manually with maintenance/\n" .
935 "populateCategory.php.\n"
937 $task = $this->maintenance->runChild( 'PopulateCategory' );
938 $task->execute();
939 $this->output( "Done populating category table.\n" );
942 protected function doPopulateParentId() {
943 if ( !$this->updateRowExists( 'populate rev_parent_id' ) ) {
944 $this->output(
945 "Populating rev_parent_id fields, printing progress markers. For large\n" .
946 "databases, you may want to hit Ctrl-C and do this manually with\n" .
947 "maintenance/populateParentId.php.\n" );
949 $task = $this->maintenance->runChild( 'PopulateParentId' );
950 $task->execute();
954 protected function doMaybeProfilingMemoryUpdate() {
955 if ( !$this->doTable( 'profiling' ) ) {
956 return true;
959 if ( !$this->db->tableExists( 'profiling', __METHOD__ ) ) {
960 return true;
961 } elseif ( $this->db->fieldExists( 'profiling', 'pf_memory', __METHOD__ ) ) {
962 $this->output( "...profiling table has pf_memory field.\n" );
964 return true;
967 return $this->applyPatch(
968 'patch-profiling-memory.sql',
969 false,
970 'Adding pf_memory field to table profiling'
974 protected function doFilearchiveIndicesUpdate() {
975 $info = $this->db->indexInfo( 'filearchive', 'fa_user_timestamp', __METHOD__ );
976 if ( !$info ) {
977 $this->applyPatch( 'patch-filearchive-user-index.sql', false, "Updating filearchive indices" );
980 return true;
983 protected function doNonUniquePlTlIl() {
984 $info = $this->db->indexInfo( 'pagelinks', 'pl_namespace' );
985 if ( is_array( $info ) && $info[0]->Non_unique ) {
986 $this->output( "...pl_namespace, tl_namespace, il_to indices are already non-UNIQUE.\n" );
988 return true;
990 if ( $this->skipSchema ) {
991 $this->output( "...skipping schema change (making pl_namespace, tl_namespace " .
992 "and il_to indices non-UNIQUE).\n" );
994 return false;
997 return $this->applyPatch(
998 'patch-pl-tl-il-nonunique.sql',
999 false,
1000 'Making pl_namespace, tl_namespace and il_to indices non-UNIQUE'
1004 protected function doUpdateMimeMinorField() {
1005 if ( $this->updateRowExists( 'mime_minor_length' ) ) {
1006 $this->output( "...*_mime_minor fields are already long enough.\n" );
1008 return;
1011 $this->applyPatch(
1012 'patch-mime_minor_length.sql',
1013 false,
1014 'Altering all *_mime_minor fields to 100 bytes in size'
1018 protected function doClFieldsUpdate() {
1019 if ( $this->updateRowExists( 'cl_fields_update' ) ) {
1020 $this->output( "...categorylinks up-to-date.\n" );
1022 return;
1025 $this->applyPatch(
1026 'patch-categorylinks-better-collation2.sql',
1027 false,
1028 'Updating categorylinks (again)'
1032 protected function doLangLinksLengthUpdate() {
1033 $langlinks = $this->db->tableName( 'langlinks' );
1034 $res = $this->db->query( "SHOW COLUMNS FROM $langlinks LIKE 'll_lang'" );
1035 $row = $this->db->fetchObject( $res );
1037 if ( $row && $row->Type == "varbinary(10)" ) {
1038 $this->applyPatch(
1039 'patch-langlinks-ll_lang-20.sql',
1040 false,
1041 'Updating length of ll_lang in langlinks'
1043 } else {
1044 $this->output( "...ll_lang is up-to-date.\n" );
1048 protected function doUserNewTalkTimestampNotNull() {
1049 if ( !$this->doTable( 'user_newtalk' ) ) {
1050 return true;
1053 $info = $this->db->fieldInfo( 'user_newtalk', 'user_last_timestamp' );
1054 if ( $info === false ) {
1055 return;
1057 if ( $info->isNullable() ) {
1058 $this->output( "...user_last_timestamp is already nullable.\n" );
1060 return;
1063 $this->applyPatch(
1064 'patch-user-newtalk-timestamp-null.sql',
1065 false,
1066 'Making user_last_timestamp nullable'
1070 protected function doIwlinksIndexNonUnique() {
1071 $info = $this->db->indexInfo( 'iwlinks', 'iwl_prefix_title_from' );
1072 if ( is_array( $info ) && $info[0]->Non_unique ) {
1073 $this->output( "...iwl_prefix_title_from index is already non-UNIQUE.\n" );
1075 return true;
1077 if ( $this->skipSchema ) {
1078 $this->output( "...skipping schema change (making iwl_prefix_title_from index non-UNIQUE).\n" );
1080 return false;
1083 return $this->applyPatch(
1084 'patch-iwl_prefix_title_from-non-unique.sql',
1085 false,
1086 'Making iwl_prefix_title_from index non-UNIQUE'
1090 protected function doUserNewTalkUseridUnsigned() {
1091 if ( !$this->doTable( 'user_newtalk' ) ) {
1092 return true;
1095 $info = $this->db->fieldInfo( 'user_newtalk', 'user_id' );
1096 if ( $info === false ) {
1097 return true;
1099 if ( $info->isUnsigned() ) {
1100 $this->output( "...user_id is already unsigned int.\n" );
1102 return true;
1105 return $this->applyPatch(
1106 'patch-user-newtalk-userid-unsigned.sql',
1107 false,
1108 'Making user_id unsigned int'
1112 protected function doRevisionPageRevIndexNonUnique() {
1113 if ( !$this->doTable( 'revision' ) ) {
1114 return true;
1115 } elseif ( !$this->db->indexExists( 'revision', 'rev_page_id' ) ) {
1116 $this->output( "...rev_page_id index not found on revision.\n" );
1117 return true;
1120 if ( !$this->db->indexUnique( 'revision', 'rev_page_id' ) ) {
1121 $this->output( "...rev_page_id index already non-unique.\n" );
1122 return true;
1125 return $this->applyPatch(
1126 'patch-revision-page-rev-index-nonunique.sql',
1127 false,
1128 'Making rev_page_id index non-unique'
1132 public function getSchemaVars() {
1133 global $wgDBTableOptions;
1135 $vars = [];
1136 $vars['wgDBTableOptions'] = str_replace( 'TYPE', 'ENGINE', $wgDBTableOptions );
1137 $vars['wgDBTableOptions'] = str_replace(
1138 'CHARSET=mysql4',
1139 'CHARSET=binary',
1140 $vars['wgDBTableOptions']
1143 return $vars;