Add a way for packagers to override some installation details
[mediawiki.git] / includes / installer / OracleUpdater.php
blobaa3c334252204f7df73999cdddaaa9623cb867f9
1 <?php
2 /**
3 * Oracle-specific updater.
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.
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.
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
20 * @file
21 * @ingroup Deployment
24 /**
25 * Class for handling updates to Oracle databases.
27 * @ingroup Deployment
28 * @since 1.17
30 class OracleUpdater extends DatabaseUpdater {
32 /**
33 * Handle to the database subclass
35 * @var DatabaseOracle
37 protected $db;
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' ),
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' ),
56 //1.19
57 array( 'addIndex', 'logging', 'i05', 'patch-logging_type_action_index.sql'),
58 array( 'addTable', 'globaltemplatelinks', 'patch-globaltemplatelinks.sql' ),
59 array( 'addTable', 'globalnamespaces', 'patch-globalnamespaces.sql' ),
60 array( 'addTable', 'globalinterwiki', 'patch-globalinterwiki.sql' ),
61 array( 'addField', 'revision', 'rev_sha1', 'patch-rev_sha1_field.sql' ),
62 array( 'addField', 'archive', 'ar_sha1', 'patch-ar_sha1_field.sql' ),
63 array( 'doRemoveNotNullEmptyDefaults2' ),
64 array( 'addIndex', 'page', 'i03', 'patch-page_redirect_namespace_len.sql' ),
65 array( 'modifyField', 'user', 'ug_group', 'patch-ug_group-length-increase.sql' ),
66 array( 'addField', 'uploadstash', 'us_chunk_inx', 'patch-us_chunk_inx_field.sql' ),
67 array( 'addField', 'job', 'job_timestamp', 'patch-job_timestamp_field.sql' ),
68 array( 'addIndex', 'job', 'i02', 'patch-job_timestamp_index.sql' ),
70 //1.20
71 array( 'addTable', 'config', 'patch-config.sql' ),
73 // KEEP THIS AT THE BOTTOM!!
74 array( 'doRebuildDuplicateFunction' ),
79 /**
80 * MySQL uses datatype defaults for NULL inserted into NOT NULL fields
81 * In namespace case that results into insert of 0 which is default namespace
82 * Oracle inserts NULL, so namespace fields should have a default value
84 protected function doNamespaceDefaults() {
85 $this->output( "Altering namespace fields with default value ... " );
86 $meta = $this->db->fieldInfo( 'page', 'page_namespace' );
87 if ( $meta->defaultValue() != null ) {
88 $this->output( "defaults seem to present on namespace fields\n" );
89 return;
92 $this->applyPatch( 'patch_namespace_defaults.sql', false );
93 $this->output( "ok\n" );
96 /**
97 * Uniform FK names + deferrable state
99 protected function doFKRenameDeferr() {
100 $this->output( "Altering foreign keys ... " );
101 $meta = $this->db->query( 'SELECT COUNT(*) cnt FROM user_constraints WHERE constraint_type = \'R\' AND deferrable = \'DEFERRABLE\'' );
102 $row = $meta->fetchRow();
103 if ( $row && $row['cnt'] > 0 ) {
104 $this->output( "at least one FK is deferrable, considering up to date\n" );
105 return;
108 $this->applyPatch( 'patch_fk_rename_deferred.sql', false );
109 $this->output( "ok\n" );
113 * Recreate functions to 17 schema layout
115 protected function doFunctions17() {
116 $this->output( "Recreating functions ... " );
117 $this->applyPatch( 'patch_create_17_functions.sql', false );
118 $this->output( "ok\n" );
122 * Schema upgrade 16->17
123 * there are no incremental patches prior to this
125 protected function doSchemaUpgrade17() {
126 $this->output( "Updating schema to 17 ... " );
127 // check if iwlinks table exists which was added in 1.17
128 if ( $this->db->tableExists( 'iwlinks' ) ) {
129 $this->output( "schema seem to be up to date.\n" );
130 return;
132 $this->applyPatch( 'patch_16_17_schema_changes.sql', false );
133 $this->output( "ok\n" );
137 * Insert page (page_id = 0) to prevent FK constraint violation
139 protected function doInsertPage0() {
140 $this->output( "Inserting page 0 if missing ... " );
141 $row = array(
142 'page_id' => 0,
143 'page_namespace' => 0,
144 'page_title' => ' ',
145 'page_counter' => 0,
146 'page_is_redirect' => 0,
147 'page_is_new' => 0,
148 'page_random' => 0,
149 'page_touched' => $this->db->timestamp(),
150 'page_latest' => 0,
151 'page_len' => 0
153 $this->db->insert( 'page', $row, 'OracleUpdater:doInserPage0', array( 'IGNORE' ) );
154 $this->output( "ok\n" );
158 * Remove DEFAULT '' NOT NULL constraints from fields as '' is internally
159 * converted to NULL in Oracle
161 protected function doRemoveNotNullEmptyDefaults() {
162 $this->output( "Removing not null empty constraints ... " );
163 $meta = $this->db->fieldInfo( 'categorylinks' , 'cl_sortkey_prefix' );
164 if ( $meta->isNullable() ) {
165 $this->output( "constraints seem to be removed\n" );
166 return;
168 $this->applyPatch( 'patch_remove_not_null_empty_defs.sql', false );
169 $this->output( "ok\n" );
171 protected function doRemoveNotNullEmptyDefaults2() {
172 $this->output( "Removing not null empty constraints ... " );
173 $meta = $this->db->fieldInfo( 'ipblocks' , 'ipb_by_text' );
174 if ( $meta->isNullable() ) {
175 $this->output( "constraints seem to be removed\n" );
176 return;
178 $this->applyPatch( 'patch_remove_not_null_empty_defs2.sql', false );
179 $this->output( "ok\n" );
183 * Removed forcing of invalid state on recentchanges_fk2.
184 * cascading taken in account in the deleting function
186 protected function doRecentchangesFK2Cascade() {
187 $this->output( "Altering RECENTCHANGES_FK2 ... " );
189 $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\'' );
190 $row = $meta->fetchRow();
191 if ( $row ) {
192 $this->output( "FK up to date\n" );
193 return;
196 $this->applyPatch( 'patch_recentchanges_fk2_cascade.sql', false );
197 $this->output( "ok\n" );
201 * rebuilding of the function that duplicates tables for tests
203 protected function doRebuildDuplicateFunction() {
204 $this->output( "Rebuilding duplicate function ... " );
205 $this->applyPatch( 'patch_rebuild_dupfunc.sql', false );
206 $this->output( "ok\n" );
210 * Overload: after this action field info table has to be rebuilt
212 * @param $what array
214 public function doUpdates( $what = array( 'core', 'extensions', 'purge', 'stats' ) ) {
215 parent::doUpdates( $what );
217 $this->db->query( 'BEGIN fill_wiki_info; END;' );
221 * Overload: because of the DDL_MODE tablename escaping is a bit dodgy
223 protected function purgeCache() {
224 # We can't guarantee that the user will be able to use TRUNCATE,
225 # but we know that DELETE is available to us
226 $this->output( "Purging caches..." );
227 $this->db->delete( '/*Q*/'.$this->db->tableName( 'objectcache' ), '*', __METHOD__ );
228 $this->output( "done.\n" );