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