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