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                         // KEEP THIS AT THE BOTTOM!!
 127                         [ 'doRebuildDuplicateFunction' ],
 128
 129                 ];
 130         }
 131
 132         /**
 133          * MySQL uses datatype defaults for NULL inserted into NOT NULL fields
 134          * In namespace case that results into insert of 0 which is default namespace
 135          * Oracle inserts NULL, so namespace fields should have a default value
 136          */
 137         protected function doNamespaceDefaults() {
 138                 $meta = $this->db->fieldInfo( 'page', 'page_namespace' );
 139                 if ( $meta->defaultValue() != null ) {
 140                         return;
 141                 }
 142
 143                 $this->applyPatch(
 144                         'patch_namespace_defaults.sql',
 145                         false,
 146                         'Altering namespace fields with default value'
 147                 );
 148         }
 149
 150         /**
 151          * Uniform FK names + deferrable state
 152          */
 153         protected function doFKRenameDeferr() {
 154                 $meta = $this->db->query( '
 155                         SELECT COUNT(*) cnt
 156                         FROM user_constraints
 157                         WHERE constraint_type = \'R\' AND deferrable = \'DEFERRABLE\''
 158                 );
 159                 $row = $meta->fetchRow();
 160                 if ( $row && $row['cnt'] > 0 ) {
 161                         return;
 162                 }
 163
 164                 $this->applyPatch( 'patch_fk_rename_deferred.sql', false, "Altering foreign keys ... " );
 165         }
 166
 167         /**
 168          * Recreate functions to 17 schema layout
 169          */
 170         protected function doFunctions17() {
 171                 $this->applyPatch( 'patch_create_17_functions.sql', false, "Recreating functions" );
 172         }
 173
 174         /**
 175          * Schema upgrade 16->17
 176          * there are no incremental patches prior to this
 177          */
 178         protected function doSchemaUpgrade17() {
 179                 // check if iwlinks table exists which was added in 1.17
 180                 if ( $this->db->tableExists( 'iwlinks' ) ) {
 181                         return;
 182                 }
 183                 $this->applyPatch( 'patch_16_17_schema_changes.sql', false, "Updating schema to 17" );
 184         }
 185
 186         /**
 187          * Insert page (page_id = 0) to prevent FK constraint violation
 188          */
 189         protected function doInsertPage0() {
 190                 $this->output( "Inserting page 0 if missing ... " );
 191                 $row = [
 192                         'page_id' => 0,
 193                         'page_namespace' => 0,
 194                         'page_title' => ' ',
 195                         'page_is_redirect' => 0,
 196                         'page_is_new' => 0,
 197                         'page_random' => 0,
 198                         'page_touched' => $this->db->timestamp(),
 199                         'page_latest' => 0,
 200                         'page_len' => 0
 201                 ];
 202                 $this->db->insert( 'page', $row, 'OracleUpdater:doInserPage0', [ 'IGNORE' ] );
 203                 $this->output( "ok\n" );
 204         }
 205
 206         /**
 207          * Remove DEFAULT '' NOT NULL constraints from fields as '' is internally
 208          * converted to NULL in Oracle
 209          */
 210         protected function doRemoveNotNullEmptyDefaults() {
 211                 $meta = $this->db->fieldInfo( 'categorylinks', 'cl_sortkey_prefix' );
 212                 if ( $meta->isNullable() ) {
 213                         return;
 214                 }
 215                 $this->applyPatch(
 216                         'patch_remove_not_null_empty_defs.sql',
 217                         false,
 218                         'Removing not null empty constraints'
 219                 );
 220         }
 221
 222         protected function doRemoveNotNullEmptyDefaults2() {
 223                 $meta = $this->db->fieldInfo( 'ipblocks', 'ipb_by_text' );
 224                 if ( $meta->isNullable() ) {
 225                         return;
 226                 }
 227                 $this->applyPatch(
 228                         'patch_remove_not_null_empty_defs2.sql',
 229                         false,
 230                         'Removing not null empty constraints'
 231                 );
 232         }
 233
 234         /**
 235          * Removed forcing of invalid state on recentchanges_fk2.
 236          * cascading taken in account in the deleting function
 237          */
 238         protected function doRecentchangesFK2Cascade() {
 239                 $meta = $this->db->query( 'SELECT 1 FROM all_constraints WHERE owner = \'' .
 240                         strtoupper( $this->db->getDBname() ) .
 241                         '\' AND constraint_name = \'' .
 242                         $this->db->tablePrefix() .
 243                         'RECENTCHANGES_FK2\' AND delete_rule = \'CASCADE\''
 244                 );
 245                 $row = $meta->fetchRow();
 246                 if ( $row ) {
 247                         return;
 248                 }
 249
 250                 $this->applyPatch( 'patch_recentchanges_fk2_cascade.sql', false, "Altering RECENTCHANGES_FK2" );
 251         }
 252
 253         /**
 254          * Fixed wrong PK, UK definition
 255          */
 256         protected function doPageRestrictionsPKUKFix() {
 257                 $this->output( "Altering PAGE_RESTRICTIONS keys ... " );
 258
 259                 $meta = $this->db->query( 'SELECT column_name FROM all_cons_columns WHERE owner = \'' .
 260                         strtoupper( $this->db->getDBname() ) .
 261                         '\' AND constraint_name = \'' .
 262                         $this->db->tablePrefix() .
 263                         'PAGE_RESTRICTIONS_PK\' AND rownum = 1'
 264                 );
 265                 $row = $meta->fetchRow();
 266                 if ( $row['column_name'] == 'PR_ID' ) {
 267                         $this->output( "seems to be up to date.\n" );
 268
 269                         return;
 270                 }
 271
 272                 $this->applyPatch( 'patch-page_restrictions_pkuk_fix.sql', false );
 273                 $this->output( "ok\n" );
 274         }
 275
 276         /**
 277          * rebuilding of the function that duplicates tables for tests
 278          */
 279         protected function doRebuildDuplicateFunction() {
 280                 $this->applyPatch( 'patch_rebuild_dupfunc.sql', false, "Rebuilding duplicate function" );
 281         }
 282
 283         /**
 284          * Overload: after this action field info table has to be rebuilt
 285          *
 286          * @param array $what
 287          */
 288         public function doUpdates( $what = [ 'core', 'extensions', 'purge', 'stats' ] ) {
 289                 parent::doUpdates( $what );
 290
 291                 $this->db->query( 'BEGIN fill_wiki_info; END;' );
 292         }
 293
 294         /**
 295          * Overload: because of the DDL_MODE tablename escaping is a bit dodgy
 296          */
 297         public function purgeCache() {
 298                 # We can't guarantee that the user will be able to use TRUNCATE,
 299                 # but we know that DELETE is available to us
 300                 $this->output( "Purging caches..." );
 301                 $this->db->delete( '/*Q*/' . $this->db->tableName( 'objectcache' ), '*', __METHOD__ );
 302                 $this->output( "done.\n" );
 303         }
 304 }