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