includes/installer/MssqlUpdater.php

   1 <?php
   2 /**
   3  * Microsoft SQL Server-specific installer.
   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 use Wikimedia\Rdbms\DatabaseMssql;
  25
  26 /**
  27  * Class for setting up the MediaWiki database using Microsoft SQL Server.
  28  *
  29  * @ingroup Deployment
  30  * @since 1.23
  31  */
  32
  33 class MssqlUpdater extends DatabaseUpdater {
  34
  35         /**
  36          * @var DatabaseMssql
  37          */
  38         protected $db;
  39
  40         protected function getCoreUpdateList() {
  41                 return [
  42                         // 1.23
  43                         [ 'addField', 'mwuser', 'user_password_expires', 'patch-user_password_expires.sql' ],
  44
  45                         // 1.24
  46                         [ 'addField', 'page', 'page_lang', 'patch-page_page_lang.sql' ],
  47
  48                         // 1.25
  49                         [ 'dropTable', 'hitcounter' ],
  50                         [ 'dropField', 'site_stats', 'ss_total_views', 'patch-drop-ss_total_views.sql' ],
  51                         [ 'dropField', 'page', 'page_counter', 'patch-drop-page_counter.sql' ],
  52                         // scripts were updated in 1.27 due to SQL errors; retaining old updatekeys so that people
  53                         // updating from 1.23->1.25->1.27 do not execute these scripts twice even though the
  54                         // updatekeys no longer make sense as they are.
  55                         [ 'updateSchema', 'categorylinks', 'cl_type-category_types-ck',
  56                                 'patch-categorylinks-constraints.sql' ],
  57                         [ 'updateSchema', 'filearchive', 'fa_major_mime-major_mime-ck',
  58                                 'patch-filearchive-constraints.sql' ],
  59                         [ 'updateSchema', 'oldimage', 'oi_major_mime-major_mime-ck',
  60                                 'patch-oldimage-constraints.sql' ],
  61                         [ 'updateSchema', 'image', 'img_major_mime-major_mime-ck', 'patch-image-constraints.sql' ],
  62                         [ 'updateSchema', 'uploadstash', 'us_media_type-media_type-ck',
  63                                 'patch-uploadstash-constraints.sql' ],
  64
  65                         [ 'modifyField', 'image', 'img_major_mime',
  66                                 'patch-img_major_mime-chemical.sql' ],
  67                         [ 'modifyField', 'oldimage', 'oi_major_mime',
  68                                 'patch-oi_major_mime-chemical.sql' ],
  69                         [ 'modifyField', 'filearchive', 'fa_major_mime',
  70                                 'patch-fa_major_mime-chemical.sql' ],
  71
  72                         // 1.27
  73                         [ 'dropTable', 'msg_resource_links' ],
  74                         [ 'dropTable', 'msg_resource' ],
  75                         [ 'addField', 'watchlist', 'wl_id', 'patch-watchlist-wl_id.sql' ],
  76                         [ 'dropField', 'mwuser', 'user_options', 'patch-drop-user_options.sql' ],
  77                         [ 'addTable', 'bot_passwords', 'patch-bot_passwords.sql' ],
  78                         [ 'addField', 'pagelinks', 'pl_from_namespace', 'patch-pl_from_namespace.sql' ],
  79                         [ 'addField', 'templatelinks', 'tl_from_namespace', 'patch-tl_from_namespace.sql' ],
  80                         [ 'addField', 'imagelinks', 'il_from_namespace', 'patch-il_from_namespace.sql' ],
  81                         [ 'dropIndex', 'categorylinks', 'cl_collation', 'patch-kill-cl_collation_index.sql' ],
  82                         [ 'addIndex', 'categorylinks', 'cl_collation_ext',
  83                                 'patch-add-cl_collation_ext_index.sql' ],
  84                         [ 'dropField', 'recentchanges', 'rc_cur_time', 'patch-drop-rc_cur_time.sql' ],
  85                         [ 'addField', 'page_props', 'pp_sortkey', 'patch-pp_sortkey.sql' ],
  86                         [ 'updateSchema', 'oldimage', 'oldimage varchar', 'patch-oldimage-schema.sql' ],
  87                         [ 'updateSchema', 'filearchive', 'filearchive varchar', 'patch-filearchive-schema.sql' ],
  88                         [ 'updateSchema', 'image', 'image varchar', 'patch-image-schema.sql' ],
  89                         [ 'updateSchema', 'recentchanges', 'recentchanges-drop-fks',
  90                                 'patch-recentchanges-drop-fks.sql' ],
  91                         [ 'updateSchema', 'logging', 'logging-drop-fks', 'patch-logging-drop-fks.sql' ],
  92                         [ 'updateSchema', 'archive', 'archive-drop-fks', 'patch-archive-drop-fks.sql' ],
  93
  94                         // 1.28
  95                         [ 'addIndex', 'recentchanges', 'rc_name_type_patrolled_timestamp',
  96                                 'patch-add-rc_name_type_patrolled_timestamp_index.sql' ],
  97                         [ 'addField', 'change_tag', 'ct_id', 'patch-change_tag-ct_id.sql' ],
  98
  99                         // 1.29
 100                         [ 'addField', 'externallinks', 'el_index_60', 'patch-externallinks-el_index_60.sql' ],
 101                         [ 'dropIndex', 'oldimage', 'oi_name_archive_name',
 102                                 'patch-alter-table-oldimage.sql' ],
 103
 104                         // 1.30
 105                         [ 'modifyField', 'image', 'img_media_type', 'patch-add-3d.sql' ],
 106                         [ 'addIndex', 'site_stats', 'PRIMARY', 'patch-site_stats-pk.sql' ],
 107
 108                         // Should have been in 1.30
 109                         [ 'addTable', 'comment', 'patch-comment-table.sql' ],
 110                         // This field was added in 1.31, but is put here so it can be used by 'migrateComments'
 111                         [ 'addField', 'image', 'img_description_id', 'patch-image-img_description_id.sql' ],
 112                         // Should have been in 1.30
 113                         [ 'migrateComments' ],
 114
 115                         // 1.31
 116                         [ 'addTable', 'slot_roles', 'patch-slot_roles.sql' ],
 117                         [ 'addTable', 'content_models', 'patch-content_models.sql' ],
 118                         [ 'addTable', 'content', 'patch-content.sql' ],
 119                         [ 'addTable', 'slots', 'patch-slots.sql' ],
 120                         [ 'addField', 'slots', 'slot_origin', 'patch-slot-origin.sql' ],
 121                         [ 'migrateArchiveText' ],
 122                         [ 'addTable', 'actor', 'patch-actor-table.sql' ],
 123                         [ 'migrateActors' ],
 124                         [ 'modifyField', 'revision', 'rev_text_id', 'patch-rev_text_id-default.sql' ],
 125                         [ 'modifyTable', 'site_stats', 'patch-site_stats-modify.sql' ],
 126                         [ 'populateArchiveRevId' ],
 127                         [ 'modifyField', 'recentchanges', 'rc_patrolled', 'patch-rc_patrolled_type.sql' ],
 128                         [ 'addIndex', 'recentchanges', 'rc_namespace_title_timestamp',
 129                                 'patch-recentchanges-nttindex.sql' ],
 130
 131                         // 1.32
 132                         [ 'addTable', 'change_tag_def', 'patch-change_tag_def.sql' ],
 133                         [ 'populateExternallinksIndex60' ],
 134                         [ 'modifyfield', 'externallinks', 'el_index_60',
 135                                 'patch-externallinks-el_index_60-drop-default.sql' ],
 136                         [ 'runMaintenance', DeduplicateArchiveRevId::class, 'maintenance/deduplicateArchiveRevId.php' ],
 137                         [ 'addField', 'change_tag', 'ct_tag_id', 'patch-change_tag-tag_id.sql' ],
 138                         [ 'addIndex', 'archive', 'ar_revid_uniq', 'patch-archive-ar_rev_id-unique.sql' ],
 139                         [ 'populateContentTables' ],
 140                         [ 'addIndex', 'logging', 'log_type_action', 'patch-logging-log-type-action-index.sql' ],
 141                         [ 'dropIndex', 'logging', 'type_action', 'patch-logging-drop-type-action-index.sql' ],
 142                         [ 'addIndex', 'interwiki', 'PRIMARY', 'patch-interwiki-pk.sql' ],
 143                         [ 'addIndex', 'protected_titles', 'PRIMARY', 'patch-protected_titles-pk.sql' ],
 144                         [ 'addIndex', 'page_props', 'PRIMARY', 'patch-page_props-pk.sql' ],
 145                         [ 'addIndex', 'site_identifiers', 'PRIMARY', 'patch-site_identifiers-pk.sql' ],
 146                         [ 'addIndex', 'recentchanges', 'rc_this_oldid', 'patch-recentchanges-rc_this_oldid-index.sql' ],
 147                         [ 'dropTable', 'transcache' ],
 148                         [ 'runMaintenance', PopulateChangeTagDef::class, 'maintenance/populateChangeTagDef.php' ],
 149                         [ 'addIndex', 'change_tag', 'change_tag_rc_tag_id',
 150                                 'patch-change_tag-change_tag_rc_tag_id.sql' ],
 151                         [ 'addField', 'ipblocks', 'ipb_sitewide', 'patch-ipb_sitewide.sql' ],
 152                         [ 'addTable', 'ipblocks_restrictions', 'patch-ipblocks_restrictions-table.sql' ],
 153                         [ 'migrateImageCommentTemp' ],
 154
 155                         // 1.33
 156                         [ 'dropField', 'change_tag', 'ct_tag', 'patch-drop-ct_tag.sql' ],
 157                         [ 'dropTable', 'valid_tag' ],
 158                         [ 'dropTable', 'tag_summary' ],
 159                         [ 'dropField', 'protected_titles', 'pt_reason', 'patch-drop-comment-fields.sql' ],
 160                 ];
 161         }
 162
 163         protected function applyPatch( $path, $isFullPath = false, $msg = null ) {
 164                 $prevScroll = $this->db->scrollableCursor( false );
 165                 $prevPrep = $this->db->prepareStatements( false );
 166                 parent::applyPatch( $path, $isFullPath, $msg );
 167                 $this->db->scrollableCursor( $prevScroll );
 168                 $this->db->prepareStatements( $prevPrep );
 169                 return true;
 170         }
 171
 172         /**
 173          * General schema update for a table that touches more than one field or requires
 174          * destructive actions (such as dropping and recreating the table). NOTE: Usage of
 175          * this function is highly discouraged, use it's successor DatabaseUpdater::modifyTable
 176          * instead.
 177          *
 178          * @param string $table
 179          * @param string $updatekey
 180          * @param string $patch
 181          * @param bool $fullpath
 182          * @return bool
 183          */
 184         protected function updateSchema( $table, $updatekey, $patch, $fullpath = false ) {
 185                 if ( !$this->db->tableExists( $table, __METHOD__ ) ) {
 186                         $this->output( "...$table table does not exist, skipping schema update patch.\n" );
 187                 } elseif ( $this->updateRowExists( $updatekey ) ) {
 188                         $this->output( "...$table already had schema updated by $patch.\n" );
 189                 } else {
 190                         $apply = $this->applyPatch( $patch, $fullpath, "Updating schema of table $table" );
 191                         if ( $apply ) {
 192                                 $this->insertUpdateRow( $updatekey );
 193                         }
 194                         return $apply;
 195                 }
 196
 197                 return true;
 198         }
 199 }