includes/installer/OracleUpdater.php

   1 <?php
   2 /**
   3  * Oracle-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  * Class for handling updates to Oracle databases.
  26  *
  27  * @ingroup Deployment
  28  * @since 1.17
  29  */
  30 class OracleUpdater extends DatabaseUpdater {
  31
  32         /**
  33          * Handle to the database subclass
  34          *
  35          * @var DatabaseOracle
  36          */
  37         protected $db;
  38
  39         protected function getCoreUpdateList() {
  40                 return [
  41                         [ 'disableContentHandlerUseDB' ],
  42
  43                         // 1.17
  44                         [ 'doNamespaceDefaults' ],
  45                         [ 'doFKRenameDeferr' ],
  46                         [ 'doFunctions17' ],
  47                         [ 'doSchemaUpgrade17' ],
  48                         [ 'doInsertPage0' ],
  49                         [ 'doRemoveNotNullEmptyDefaults' ],
  50                         [ 'addTable', 'user_former_groups', 'patch-user_former_groups.sql' ],
  51
  52                         // 1.18
  53                         [ 'addIndex', 'user', 'i02', 'patch-user_email_index.sql' ],
  54                         [ 'modifyField', 'user_properties', 'up_property', 'patch-up_property.sql' ],
  55                         [ 'addTable', 'uploadstash', 'patch-uploadstash.sql' ],
  56                         [ 'doRecentchangesFK2Cascade' ],
  57
  58                         // 1.19
  59                         [ 'addIndex', 'logging', 'i05', 'patch-logging_type_action_index.sql' ],
  60                         [ 'addField', 'revision', 'rev_sha1', 'patch-rev_sha1_field.sql' ],
  61                         [ 'addField', 'archive', 'ar_sha1', 'patch-ar_sha1_field.sql' ],
  62                         [ 'doRemoveNotNullEmptyDefaults2' ],
  63                         [ 'addIndex', 'page', 'i03', 'patch-page_redirect_namespace_len.sql' ],
  64                         [ 'addField', 'uploadstash', 'us_chunk_inx', 'patch-us_chunk_inx_field.sql' ],
  65                         [ 'addField', 'job', 'job_timestamp', 'patch-job_timestamp_field.sql' ],
  66                         [ 'addIndex', 'job', 'i02', 'patch-job_timestamp_index.sql' ],
  67                         [ 'doPageRestrictionsPKUKFix' ],
  68
  69                         // 1.20
  70                         [ 'addIndex', 'ipblocks', 'i05', 'patch-ipblocks_i05_index.sql' ],
  71                         [ 'addIndex', 'revision', 'i05', 'patch-revision_i05_index.sql' ],
  72                         [ 'dropField', 'category', 'cat_hidden', 'patch-cat_hidden.sql' ],
  73
  74                         // 1.21
  75                         [ 'addField', 'revision', 'rev_content_format',
  76                                 'patch-revision-rev_content_format.sql' ],
  77                         [ 'addField', 'revision', 'rev_content_model',
  78                                 'patch-revision-rev_content_model.sql' ],
  79                         [ 'addField', 'archive', 'ar_content_format', 'patch-archive-ar_content_format.sql' ],
  80                         [ 'addField', 'archive', 'ar_content_model', 'patch-archive-ar_content_model.sql' ],
  81                         [ 'addField', 'archive', 'ar_id', 'patch-archive-ar_id.sql' ],
  82                         [ 'addField', 'externallinks', 'el_id', 'patch-externallinks-el_id.sql' ],
  83                         [ 'addField', 'page', 'page_content_model', 'patch-page-page_content_model.sql' ],
  84                         [ 'enableContentHandlerUseDB' ],
  85                         [ 'dropField', 'site_stats', 'ss_admins', 'patch-ss_admins.sql' ],
  86                         [ 'dropField', 'recentchanges', 'rc_moved_to_title', 'patch-rc_moved.sql' ],
  87                         [ 'addTable', 'sites', 'patch-sites.sql' ],
  88                         [ 'addField', 'filearchive', 'fa_sha1', 'patch-fa_sha1.sql' ],
  89                         [ 'addField', 'job', 'job_token', 'patch-job_token.sql' ],
  90                         [ 'addField', 'job', 'job_attempts', 'patch-job_attempts.sql' ],
  91                         [ 'addField', 'uploadstash', 'us_props', 'patch-uploadstash-us_props.sql' ],
  92                         [ 'modifyField', 'user_groups', 'ug_group', 'patch-ug_group-length-increase-255.sql' ],
  93                         [ 'modifyField', 'user_former_groups', 'ufg_group',
  94                                 'patch-ufg_group-length-increase-255.sql' ],
  95
  96                         // 1.23
  97                         [ 'addIndex', 'logging', 'i06', 'patch-logging_user_text_type_time_index.sql' ],
  98                         [ 'addIndex', 'logging', 'i07', 'patch-logging_user_text_time_index.sql' ],
  99                         [ 'addField', 'user', 'user_password_expires', 'patch-user_password_expire.sql' ],
 100                         [ 'addField', 'page', 'page_links_updated', 'patch-page_links_updated.sql' ],
 101                         [ 'addField', 'recentchanges', 'rc_source', 'patch-rc_source.sql' ],
 102
 103                         // 1.24
 104                         [ 'addField', 'page', 'page_lang', 'patch-page-page_lang.sql' ],
 105
 106                         // 1.25
 107                         [ 'dropTable', 'hitcounter' ],
 108                         [ 'dropField', 'site_stats', 'ss_total_views', 'patch-drop-ss_total_views.sql' ],
 109                         [ 'dropField', 'page', 'page_counter', 'patch-drop-page_counter.sql' ],
 110
 111                         // 1.27
 112                         [ 'dropTable', 'msg_resource_links' ],
 113                         [ 'dropTable', 'msg_resource' ],
 114                         [ 'addField', 'watchlist', 'wl_id', 'patch-watchlist-wl_id.sql' ],
 115
 116                         // 1.28
 117                         [ 'addIndex', 'recentchanges', 'rc_name_type_patrolled_timestamp',
 118                                 'patch-add-rc_name_type_patrolled_timestamp_index.sql' ],
 119                         [ 'addField', 'change_tag', 'ct_id', 'patch-change_tag-ct_id.sql' ],
 120                         [ 'addField', 'tag_summary', 'ts_id', 'patch-tag_summary-ts_id.sql' ],
 121
 122                         // 1.29
 123                         [ 'addField', 'externallinks', 'el_index_60', 'patch-externallinks-el_index_60.sql' ],
 124                         [ 'addField', 'user_groups', 'ug_expiry', 'patch-user_groups-ug_expiry.sql' ],
 125
 126                         // 1.30
 127                         [ 'doAutoIncrementTriggers' ],
 128
 129                         // KEEP THIS AT THE BOTTOM!!
 130                         [ 'doRebuildDuplicateFunction' ],
 131
 132                 ];
 133         }
 134
 135         /**
 136          * MySQL uses datatype defaults for NULL inserted into NOT NULL fields
 137          * In namespace case that results into insert of 0 which is default namespace
 138          * Oracle inserts NULL, so namespace fields should have a default value
 139          */
 140         protected function doNamespaceDefaults() {
 141                 $meta = $this->db->fieldInfo( 'page', 'page_namespace' );
 142                 if ( $meta->defaultValue() != null ) {
 143                         return;
 144                 }
 145
 146                 $this->applyPatch(
 147                         'patch_namespace_defaults.sql',
 148                         false,
 149                         'Altering namespace fields with default value'
 150                 );
 151         }
 152
 153         /**
 154          * Uniform FK names + deferrable state
 155          */
 156         protected function doFKRenameDeferr() {
 157                 $meta = $this->db->query( '
 158                         SELECT COUNT(*) cnt
 159                         FROM user_constraints
 160                         WHERE constraint_type = \'R\' AND deferrable = \'DEFERRABLE\''
 161                 );
 162                 $row = $meta->fetchRow();
 163                 if ( $row && $row['cnt'] > 0 ) {
 164                         return;
 165                 }
 166
 167                 $this->applyPatch( 'patch_fk_rename_deferred.sql', false, "Altering foreign keys ... " );
 168         }
 169
 170         /**
 171          * Recreate functions to 17 schema layout
 172          */
 173         protected function doFunctions17() {
 174                 $this->applyPatch( 'patch_create_17_functions.sql', false, "Recreating functions" );
 175         }
 176
 177         /**
 178          * Schema upgrade 16->17
 179          * there are no incremental patches prior to this
 180          */
 181         protected function doSchemaUpgrade17() {
 182                 // check if iwlinks table exists which was added in 1.17
 183                 if ( $this->db->tableExists( 'iwlinks' ) ) {
 184                         return;
 185                 }
 186                 $this->applyPatch( 'patch_16_17_schema_changes.sql', false, "Updating schema to 17" );
 187         }
 188
 189         /**
 190          * Insert page (page_id = 0) to prevent FK constraint violation
 191          */
 192         protected function doInsertPage0() {
 193                 $this->output( "Inserting page 0 if missing ... " );
 194                 $row = [
 195                         'page_id' => 0,
 196                         'page_namespace' => 0,
 197                         'page_title' => ' ',
 198                         'page_is_redirect' => 0,
 199                         'page_is_new' => 0,
 200                         'page_random' => 0,
 201                         'page_touched' => $this->db->timestamp(),
 202                         'page_latest' => 0,
 203                         'page_len' => 0
 204                 ];
 205                 $this->db->insert( 'page', $row, 'OracleUpdater:doInserPage0', [ 'IGNORE' ] );
 206                 $this->output( "ok\n" );
 207         }
 208
 209         /**
 210          * Remove DEFAULT '' NOT NULL constraints from fields as '' is internally
 211          * converted to NULL in Oracle
 212          */
 213         protected function doRemoveNotNullEmptyDefaults() {
 214                 $meta = $this->db->fieldInfo( 'categorylinks', 'cl_sortkey_prefix' );
 215                 if ( $meta->isNullable() ) {
 216                         return;
 217                 }
 218                 $this->applyPatch(
 219                         'patch_remove_not_null_empty_defs.sql',
 220                         false,
 221                         'Removing not null empty constraints'
 222                 );
 223         }
 224
 225         protected function doRemoveNotNullEmptyDefaults2() {
 226                 $meta = $this->db->fieldInfo( 'ipblocks', 'ipb_by_text' );
 227                 if ( $meta->isNullable() ) {
 228                         return;
 229                 }
 230                 $this->applyPatch(
 231                         'patch_remove_not_null_empty_defs2.sql',
 232                         false,
 233                         'Removing not null empty constraints'
 234                 );
 235         }
 236
 237         /**
 238          * Removed forcing of invalid state on recentchanges_fk2.
 239          * cascading taken in account in the deleting function
 240          */
 241         protected function doRecentchangesFK2Cascade() {
 242                 $meta = $this->db->query( 'SELECT 1 FROM all_constraints WHERE owner = \'' .
 243                         strtoupper( $this->db->getDBname() ) .
 244                         '\' AND constraint_name = \'' .
 245                         $this->db->tablePrefix() .
 246                         'RECENTCHANGES_FK2\' AND delete_rule = \'CASCADE\''
 247                 );
 248                 $row = $meta->fetchRow();
 249                 if ( $row ) {
 250                         return;
 251                 }
 252
 253                 $this->applyPatch( 'patch_recentchanges_fk2_cascade.sql', false, "Altering RECENTCHANGES_FK2" );
 254         }
 255
 256         /**
 257          * Fixed wrong PK, UK definition
 258          */
 259         protected function doPageRestrictionsPKUKFix() {
 260                 $this->output( "Altering PAGE_RESTRICTIONS keys ... " );
 261
 262                 $meta = $this->db->query( 'SELECT column_name FROM all_cons_columns WHERE owner = \'' .
 263                         strtoupper( $this->db->getDBname() ) .
 264                         '\' AND constraint_name = \'' .
 265                         $this->db->tablePrefix() .
 266                         'PAGE_RESTRICTIONS_PK\' AND rownum = 1'
 267                 );
 268                 $row = $meta->fetchRow();
 269                 if ( $row['column_name'] == 'PR_ID' ) {
 270                         $this->output( "seems to be up to date.\n" );
 271
 272                         return;
 273                 }
 274
 275                 $this->applyPatch( 'patch-page_restrictions_pkuk_fix.sql', false );
 276                 $this->output( "ok\n" );
 277         }
 278
 279         /**
 280          * Add auto-increment triggers
 281          */
 282         protected function doAutoIncrementTriggers() {
 283                 $this->output( "Adding auto-increment triggers ... " );
 284
 285                 $meta = $this->db->query( 'SELECT trigger_name FROM user_triggers WHERE table_owner = \'' .
 286                         strtoupper( $this->db->getDBname() ) .
 287                         '\' AND trigger_name = \'' .
 288                         $this->db->tablePrefix() .
 289                         'PAGE_DEFAULT_PAGE_ID\''
 290                 );
 291                 $row = $meta->fetchRow();
 292                 if ( $row['column_name'] ) {
 293                         $this->output( "seems to be up to date.\n" );
 294
 295                         return;
 296                 }
 297
 298                 $this->applyPatch( 'patch-auto_increment_triggers.sql', false );
 299
 300                 $this->output( "ok\n" );
 301         }
 302
 303         /**
 304          * rebuilding of the function that duplicates tables for tests
 305          */
 306         protected function doRebuildDuplicateFunction() {
 307                 $this->applyPatch( 'patch_rebuild_dupfunc.sql', false, "Rebuilding duplicate function" );
 308         }
 309
 310         /**
 311          * Overload: after this action field info table has to be rebuilt
 312          *
 313          * @param array $what
 314          */
 315         public function doUpdates( array $what = [ 'core', 'extensions', 'purge', 'stats' ] ) {
 316                 parent::doUpdates( $what );
 317
 318                 $this->db->query( 'BEGIN fill_wiki_info; END;' );
 319         }
 320
 321         /**
 322          * Overload: because of the DDL_MODE tablename escaping is a bit dodgy
 323          */
 324         public function purgeCache() {
 325                 # We can't guarantee that the user will be able to use TRUNCATE,
 326                 # but we know that DELETE is available to us
 327                 $this->output( "Purging caches..." );
 328                 $this->db->delete( '/*Q*/' . $this->db->tableName( 'objectcache' ), '*', __METHOD__ );
 329                 $this->output( "done.\n" );
 330         }
 331 }