ba00dec5959db17fd5eb64ffd2712f701db6a1aa
[lhc/web/wiklou.git] / includes / installer / PostgresUpdater.php
1 <?php
2 /**
3 * PostgreSQL-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 use Wikimedia\Rdbms\DatabasePostgres;
25
26 /**
27 * Class for handling updates to Postgres databases.
28 *
29 * @ingroup Deployment
30 * @since 1.17
31 */
32 class PostgresUpdater extends DatabaseUpdater {
33
34 /**
35 * @var DatabasePostgres
36 */
37 protected $db;
38
39 /**
40 * @todo FIXME: Postgres should use sequential updates like Mysql, Sqlite
41 * and everybody else. It never got refactored like it should've.
42 * @return array
43 */
44 protected function getCoreUpdateList() {
45 return [
46 # rename tables 1.7.3
47 # r15791 Change reserved word table names "user" and "text"
48 [ 'renameTable', 'user', 'mwuser' ],
49 [ 'renameTable', 'text', 'pagecontent' ],
50 [ 'renameIndex', 'mwuser', 'user_pkey', 'mwuser_pkey' ],
51 [ 'renameIndex', 'mwuser', 'user_user_name_key', 'mwuser_user_name_key' ],
52 [ 'renameIndex', 'pagecontent', 'text_pkey', 'pagecontent_pkey' ],
53
54 # renamed sequences
55 [ 'renameSequence', 'ipblocks_ipb_id_val', 'ipblocks_ipb_id_seq' ],
56 [ 'renameSequence', 'rev_rev_id_val', 'revision_rev_id_seq' ],
57 [ 'renameSequence', 'text_old_id_val', 'text_old_id_seq' ],
58 [ 'renameSequence', 'rc_rc_id_seq', 'recentchanges_rc_id_seq' ],
59 [ 'renameSequence', 'log_log_id_seq', 'logging_log_id_seq' ],
60 [ 'renameSequence', 'pr_id_val', 'page_restrictions_pr_id_seq' ],
61 [ 'renameSequence', 'us_id_seq', 'uploadstash_us_id_seq' ],
62
63 # since r58263
64 [ 'renameSequence', 'category_id_seq', 'category_cat_id_seq' ],
65
66 # new sequences if not renamed above
67 [ 'addSequence', 'logging', false, 'logging_log_id_seq' ],
68 [ 'addSequence', 'page_restrictions', false, 'page_restrictions_pr_id_seq' ],
69 [ 'addSequence', 'filearchive', 'fa_id', 'filearchive_fa_id_seq' ],
70 [ 'addSequence', 'archive', false, 'archive_ar_id_seq' ],
71 [ 'addSequence', 'externallinks', false, 'externallinks_el_id_seq' ],
72 [ 'addSequence', 'watchlist', false, 'watchlist_wl_id_seq' ],
73 [ 'addSequence', 'change_tag', false, 'change_tag_ct_id_seq' ],
74 [ 'addSequence', 'tag_summary', false, 'tag_summary_ts_id_seq' ],
75
76 # new tables
77 [ 'addTable', 'category', 'patch-category.sql' ],
78 [ 'addTable', 'page', 'patch-page.sql' ],
79 [ 'addTable', 'querycachetwo', 'patch-querycachetwo.sql' ],
80 [ 'addTable', 'page_props', 'patch-page_props.sql' ],
81 [ 'addTable', 'page_restrictions', 'patch-page_restrictions.sql' ],
82 [ 'addTable', 'profiling', 'patch-profiling.sql' ],
83 [ 'addTable', 'protected_titles', 'patch-protected_titles.sql' ],
84 [ 'addTable', 'redirect', 'patch-redirect.sql' ],
85 [ 'addTable', 'updatelog', 'patch-updatelog.sql' ],
86 [ 'addTable', 'change_tag', 'patch-change_tag.sql' ],
87 [ 'addTable', 'tag_summary', 'patch-tag_summary.sql' ],
88 [ 'addTable', 'valid_tag', 'patch-valid_tag.sql' ],
89 [ 'addTable', 'user_properties', 'patch-user_properties.sql' ],
90 [ 'addTable', 'log_search', 'patch-log_search.sql' ],
91 [ 'addTable', 'l10n_cache', 'patch-l10n_cache.sql' ],
92 [ 'addTable', 'iwlinks', 'patch-iwlinks.sql' ],
93 [ 'addTable', 'module_deps', 'patch-module_deps.sql' ],
94 [ 'addTable', 'uploadstash', 'patch-uploadstash.sql' ],
95 [ 'addTable', 'user_former_groups', 'patch-user_former_groups.sql' ],
96 [ 'addTable', 'sites', 'patch-sites.sql' ],
97 [ 'addTable', 'bot_passwords', 'patch-bot_passwords.sql' ],
98
99 # Needed before new field
100 [ 'convertArchive2' ],
101
102 # new fields
103 [ 'addPgField', 'updatelog', 'ul_value', 'TEXT' ],
104 [ 'addPgField', 'archive', 'ar_deleted', 'SMALLINT NOT NULL DEFAULT 0' ],
105 [ 'addPgField', 'archive', 'ar_len', 'INTEGER' ],
106 [ 'addPgField', 'archive', 'ar_page_id', 'INTEGER' ],
107 [ 'addPgField', 'archive', 'ar_parent_id', 'INTEGER' ],
108 [ 'addPgField', 'archive', 'ar_content_model', 'TEXT' ],
109 [ 'addPgField', 'archive', 'ar_content_format', 'TEXT' ],
110 [ 'addPgField', 'categorylinks', 'cl_sortkey_prefix', "TEXT NOT NULL DEFAULT ''" ],
111 [ 'addPgField', 'categorylinks', 'cl_collation', "TEXT NOT NULL DEFAULT 0" ],
112 [ 'addPgField', 'categorylinks', 'cl_type', "TEXT NOT NULL DEFAULT 'page'" ],
113 [ 'addPgField', 'image', 'img_sha1', "TEXT NOT NULL DEFAULT ''" ],
114 [ 'addPgField', 'ipblocks', 'ipb_allow_usertalk', 'SMALLINT NOT NULL DEFAULT 0' ],
115 [ 'addPgField', 'ipblocks', 'ipb_anon_only', 'SMALLINT NOT NULL DEFAULT 0' ],
116 [ 'addPgField', 'ipblocks', 'ipb_by_text', "TEXT NOT NULL DEFAULT ''" ],
117 [ 'addPgField', 'ipblocks', 'ipb_block_email', 'SMALLINT NOT NULL DEFAULT 0' ],
118 [ 'addPgField', 'ipblocks', 'ipb_create_account', 'SMALLINT NOT NULL DEFAULT 1' ],
119 [ 'addPgField', 'ipblocks', 'ipb_deleted', 'SMALLINT NOT NULL DEFAULT 0' ],
120 [ 'addPgField', 'ipblocks', 'ipb_enable_autoblock', 'SMALLINT NOT NULL DEFAULT 1' ],
121 [ 'addPgField', 'ipblocks', 'ipb_parent_block_id',
122 'INTEGER DEFAULT NULL REFERENCES ipblocks(ipb_id) ' .
123 'ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED' ],
124 [ 'addPgField', 'filearchive', 'fa_deleted', 'SMALLINT NOT NULL DEFAULT 0' ],
125 [ 'addPgField', 'filearchive', 'fa_sha1', "TEXT NOT NULL DEFAULT ''" ],
126 [ 'addPgField', 'logging', 'log_deleted', 'SMALLINT NOT NULL DEFAULT 0' ],
127 [ 'addPgField', 'logging', 'log_id',
128 "INTEGER NOT NULL PRIMARY KEY DEFAULT nextval('logging_log_id_seq')" ],
129 [ 'addPgField', 'logging', 'log_params', 'TEXT' ],
130 [ 'addPgField', 'mwuser', 'user_editcount', 'INTEGER' ],
131 [ 'addPgField', 'mwuser', 'user_newpass_time', 'TIMESTAMPTZ' ],
132 [ 'addPgField', 'oldimage', 'oi_deleted', 'SMALLINT NOT NULL DEFAULT 0' ],
133 [ 'addPgField', 'oldimage', 'oi_major_mime', "TEXT NOT NULL DEFAULT 'unknown'" ],
134 [ 'addPgField', 'oldimage', 'oi_media_type', 'TEXT' ],
135 [ 'addPgField', 'oldimage', 'oi_metadata', "BYTEA NOT NULL DEFAULT ''" ],
136 [ 'addPgField', 'oldimage', 'oi_minor_mime', "TEXT NOT NULL DEFAULT 'unknown'" ],
137 [ 'addPgField', 'oldimage', 'oi_sha1', "TEXT NOT NULL DEFAULT ''" ],
138 [ 'addPgField', 'page', 'page_content_model', 'TEXT' ],
139 [ 'addPgField', 'page_restrictions', 'pr_id',
140 "INTEGER NOT NULL UNIQUE DEFAULT nextval('page_restrictions_pr_id_seq')" ],
141 [ 'addPgField', 'profiling', 'pf_memory', 'NUMERIC(18,10) NOT NULL DEFAULT 0' ],
142 [ 'addPgField', 'recentchanges', 'rc_deleted', 'SMALLINT NOT NULL DEFAULT 0' ],
143 [ 'addPgField', 'recentchanges', 'rc_log_action', 'TEXT' ],
144 [ 'addPgField', 'recentchanges', 'rc_log_type', 'TEXT' ],
145 [ 'addPgField', 'recentchanges', 'rc_logid', 'INTEGER NOT NULL DEFAULT 0' ],
146 [ 'addPgField', 'recentchanges', 'rc_new_len', 'INTEGER' ],
147 [ 'addPgField', 'recentchanges', 'rc_old_len', 'INTEGER' ],
148 [ 'addPgField', 'recentchanges', 'rc_params', 'TEXT' ],
149 [ 'addPgField', 'redirect', 'rd_interwiki', 'TEXT NULL' ],
150 [ 'addPgField', 'redirect', 'rd_fragment', 'TEXT NULL' ],
151 [ 'addPgField', 'revision', 'rev_deleted', 'SMALLINT NOT NULL DEFAULT 0' ],
152 [ 'addPgField', 'revision', 'rev_len', 'INTEGER' ],
153 [ 'addPgField', 'revision', 'rev_parent_id', 'INTEGER DEFAULT NULL' ],
154 [ 'addPgField', 'revision', 'rev_content_model', 'TEXT' ],
155 [ 'addPgField', 'revision', 'rev_content_format', 'TEXT' ],
156 [ 'addPgField', 'site_stats', 'ss_active_users', "INTEGER DEFAULT '-1'" ],
157 [ 'addPgField', 'user_newtalk', 'user_last_timestamp', 'TIMESTAMPTZ' ],
158 [ 'addPgField', 'logging', 'log_user_text', "TEXT NOT NULL DEFAULT ''" ],
159 [ 'addPgField', 'logging', 'log_page', 'INTEGER' ],
160 [ 'addPgField', 'interwiki', 'iw_api', "TEXT NOT NULL DEFAULT ''" ],
161 [ 'addPgField', 'interwiki', 'iw_wikiid', "TEXT NOT NULL DEFAULT ''" ],
162 [ 'addPgField', 'revision', 'rev_sha1', "TEXT NOT NULL DEFAULT ''" ],
163 [ 'addPgField', 'archive', 'ar_sha1', "TEXT NOT NULL DEFAULT ''" ],
164 [ 'addPgField', 'uploadstash', 'us_chunk_inx', "INTEGER NULL" ],
165 [ 'addPgField', 'job', 'job_timestamp', "TIMESTAMPTZ" ],
166 [ 'addPgField', 'job', 'job_random', "INTEGER NOT NULL DEFAULT 0" ],
167 [ 'addPgField', 'job', 'job_attempts', "INTEGER NOT NULL DEFAULT 0" ],
168 [ 'addPgField', 'job', 'job_token', "TEXT NOT NULL DEFAULT ''" ],
169 [ 'addPgField', 'job', 'job_token_timestamp', "TIMESTAMPTZ" ],
170 [ 'addPgField', 'job', 'job_sha1', "TEXT NOT NULL DEFAULT ''" ],
171 [ 'addPgField', 'archive', 'ar_id',
172 "INTEGER NOT NULL PRIMARY KEY DEFAULT nextval('archive_ar_id_seq')" ],
173 [ 'addPgField', 'externallinks', 'el_id',
174 "INTEGER NOT NULL PRIMARY KEY DEFAULT nextval('externallinks_el_id_seq')" ],
175 [ 'addPgField', 'uploadstash', 'us_props', "BYTEA" ],
176
177 # type changes
178 [ 'changeField', 'archive', 'ar_deleted', 'smallint', '' ],
179 [ 'changeField', 'archive', 'ar_minor_edit', 'smallint',
180 'ar_minor_edit::smallint DEFAULT 0' ],
181 [ 'changeField', 'filearchive', 'fa_deleted', 'smallint', '' ],
182 [ 'changeField', 'filearchive', 'fa_height', 'integer', '' ],
183 [ 'changeField', 'filearchive', 'fa_metadata', 'bytea', "decode(fa_metadata,'escape')" ],
184 [ 'changeField', 'filearchive', 'fa_size', 'integer', '' ],
185 [ 'changeField', 'filearchive', 'fa_width', 'integer', '' ],
186 [ 'changeField', 'filearchive', 'fa_storage_group', 'text', '' ],
187 [ 'changeField', 'filearchive', 'fa_storage_key', 'text', '' ],
188 [ 'changeField', 'image', 'img_metadata', 'bytea', "decode(img_metadata,'escape')" ],
189 [ 'changeField', 'image', 'img_size', 'integer', '' ],
190 [ 'changeField', 'image', 'img_width', 'integer', '' ],
191 [ 'changeField', 'image', 'img_height', 'integer', '' ],
192 [ 'changeField', 'interwiki', 'iw_local', 'smallint', 'iw_local::smallint' ],
193 [ 'changeField', 'interwiki', 'iw_trans', 'smallint', 'iw_trans::smallint DEFAULT 0' ],
194 [ 'changeField', 'ipblocks', 'ipb_auto', 'smallint', 'ipb_auto::smallint DEFAULT 0' ],
195 [ 'changeField', 'ipblocks', 'ipb_anon_only', 'smallint',
196 "CASE WHEN ipb_anon_only=' ' THEN 0 ELSE ipb_anon_only::smallint END DEFAULT 0" ],
197 [ 'changeField', 'ipblocks', 'ipb_create_account', 'smallint',
198 "CASE WHEN ipb_create_account=' ' THEN 0 ELSE ipb_create_account::smallint END DEFAULT 1" ],
199 [ 'changeField', 'ipblocks', 'ipb_enable_autoblock', 'smallint',
200 "CASE WHEN ipb_enable_autoblock=' ' THEN 0 ELSE ipb_enable_autoblock::smallint END DEFAULT 1" ],
201 [ 'changeField', 'ipblocks', 'ipb_block_email', 'smallint',
202 "CASE WHEN ipb_block_email=' ' THEN 0 ELSE ipb_block_email::smallint END DEFAULT 0" ],
203 [ 'changeField', 'ipblocks', 'ipb_address', 'text', 'ipb_address::text' ],
204 [ 'changeField', 'ipblocks', 'ipb_deleted', 'smallint', 'ipb_deleted::smallint DEFAULT 0' ],
205 [ 'changeField', 'mwuser', 'user_token', 'text', '' ],
206 [ 'changeField', 'mwuser', 'user_email_token', 'text', '' ],
207 [ 'changeField', 'objectcache', 'keyname', 'text', '' ],
208 [ 'changeField', 'oldimage', 'oi_height', 'integer', '' ],
209 [ 'changeField', 'oldimage', 'oi_metadata', 'bytea', "decode(img_metadata,'escape')" ],
210 [ 'changeField', 'oldimage', 'oi_size', 'integer', '' ],
211 [ 'changeField', 'oldimage', 'oi_width', 'integer', '' ],
212 [ 'changeField', 'page', 'page_is_redirect', 'smallint',
213 'page_is_redirect::smallint DEFAULT 0' ],
214 [ 'changeField', 'page', 'page_is_new', 'smallint', 'page_is_new::smallint DEFAULT 0' ],
215 [ 'changeField', 'querycache', 'qc_value', 'integer', '' ],
216 [ 'changeField', 'querycachetwo', 'qcc_value', 'integer', '' ],
217 [ 'changeField', 'recentchanges', 'rc_bot', 'smallint', 'rc_bot::smallint DEFAULT 0' ],
218 [ 'changeField', 'recentchanges', 'rc_deleted', 'smallint', '' ],
219 [ 'changeField', 'recentchanges', 'rc_minor', 'smallint', 'rc_minor::smallint DEFAULT 0' ],
220 [ 'changeField', 'recentchanges', 'rc_new', 'smallint', 'rc_new::smallint DEFAULT 0' ],
221 [ 'changeField', 'recentchanges', 'rc_type', 'smallint', 'rc_type::smallint DEFAULT 0' ],
222 [ 'changeField', 'recentchanges', 'rc_patrolled', 'smallint',
223 'rc_patrolled::smallint DEFAULT 0' ],
224 [ 'changeField', 'revision', 'rev_deleted', 'smallint', 'rev_deleted::smallint DEFAULT 0' ],
225 [ 'changeField', 'revision', 'rev_minor_edit', 'smallint',
226 'rev_minor_edit::smallint DEFAULT 0' ],
227 [ 'changeField', 'templatelinks', 'tl_namespace', 'smallint', 'tl_namespace::smallint' ],
228 [ 'changeField', 'user_newtalk', 'user_ip', 'text', 'host(user_ip)' ],
229 [ 'changeField', 'uploadstash', 'us_image_bits', 'smallint', '' ],
230 [ 'changeField', 'profiling', 'pf_time', 'float', '' ],
231 [ 'changeField', 'profiling', 'pf_memory', 'float', '' ],
232
233 # null changes
234 [ 'changeNullableField', 'oldimage', 'oi_bits', 'NULL' ],
235 [ 'changeNullableField', 'oldimage', 'oi_timestamp', 'NULL' ],
236 [ 'changeNullableField', 'oldimage', 'oi_major_mime', 'NULL' ],
237 [ 'changeNullableField', 'oldimage', 'oi_minor_mime', 'NULL' ],
238 [ 'changeNullableField', 'image', 'img_metadata', 'NOT NULL' ],
239 [ 'changeNullableField', 'filearchive', 'fa_metadata', 'NOT NULL' ],
240 [ 'changeNullableField', 'recentchanges', 'rc_cur_id', 'NULL' ],
241 [ 'changeNullableField', 'recentchanges', 'rc_cur_time', 'NULL' ],
242
243 [ 'checkOiDeleted' ],
244
245 # New indexes
246 [ 'addPgIndex', 'archive', 'archive_user_text', '(ar_user_text)' ],
247 [ 'addPgIndex', 'image', 'img_sha1', '(img_sha1)' ],
248 [ 'addPgIndex', 'ipblocks', 'ipb_parent_block_id', '(ipb_parent_block_id)' ],
249 [ 'addPgIndex', 'oldimage', 'oi_sha1', '(oi_sha1)' ],
250 [ 'addPgIndex', 'page', 'page_mediawiki_title', '(page_title) WHERE page_namespace = 8' ],
251 [ 'addPgIndex', 'pagelinks', 'pagelinks_title', '(pl_title)' ],
252 [ 'addPgIndex', 'page_props', 'pp_propname_page', '(pp_propname, pp_page)' ],
253 [ 'addPgIndex', 'revision', 'rev_text_id_idx', '(rev_text_id)' ],
254 [ 'addPgIndex', 'recentchanges', 'rc_timestamp_bot', '(rc_timestamp) WHERE rc_bot = 0' ],
255 [ 'addPgIndex', 'templatelinks', 'templatelinks_from', '(tl_from)' ],
256 [ 'addPgIndex', 'watchlist', 'wl_user', '(wl_user)' ],
257 [ 'addPgIndex', 'watchlist', 'wl_user_notificationtimestamp',
258 '(wl_user, wl_notificationtimestamp)' ],
259 [ 'addPgIndex', 'logging', 'logging_user_type_time',
260 '(log_user, log_type, log_timestamp)' ],
261 [ 'addPgIndex', 'logging', 'logging_page_id_time', '(log_page,log_timestamp)' ],
262 [ 'addPgIndex', 'iwlinks', 'iwl_prefix_from_title', '(iwl_prefix, iwl_from, iwl_title)' ],
263 [ 'addPgIndex', 'iwlinks', 'iwl_prefix_title_from', '(iwl_prefix, iwl_title, iwl_from)' ],
264 [ 'addPgIndex', 'job', 'job_timestamp_idx', '(job_timestamp)' ],
265 [ 'addPgIndex', 'job', 'job_sha1', '(job_sha1)' ],
266 [ 'addPgIndex', 'job', 'job_cmd_token', '(job_cmd, job_token, job_random)' ],
267 [ 'addPgIndex', 'job', 'job_cmd_token_id', '(job_cmd, job_token, job_id)' ],
268 [ 'addPgIndex', 'filearchive', 'fa_sha1', '(fa_sha1)' ],
269 [ 'addPgIndex', 'logging', 'logging_user_text_type_time',
270 '(log_user_text, log_type, log_timestamp)' ],
271 [ 'addPgIndex', 'logging', 'logging_user_text_time', '(log_user_text, log_timestamp)' ],
272
273 [ 'checkIndex', 'pagelink_unique', [
274 [ 'pl_from', 'int4_ops', 'btree', 0 ],
275 [ 'pl_namespace', 'int2_ops', 'btree', 0 ],
276 [ 'pl_title', 'text_ops', 'btree', 0 ],
277 ],
278 'CREATE UNIQUE INDEX pagelink_unique ON pagelinks (pl_from,pl_namespace,pl_title)' ],
279 [ 'checkIndex', 'cl_sortkey', [
280 [ 'cl_to', 'text_ops', 'btree', 0 ],
281 [ 'cl_sortkey', 'text_ops', 'btree', 0 ],
282 [ 'cl_from', 'int4_ops', 'btree', 0 ],
283 ],
284 'CREATE INDEX cl_sortkey ON "categorylinks" ' .
285 'USING "btree" ("cl_to", "cl_sortkey", "cl_from")' ],
286 [ 'checkIndex', 'iwl_prefix_title_from', [
287 [ 'iwl_prefix', 'text_ops', 'btree', 0 ],
288 [ 'iwl_title', 'text_ops', 'btree', 0 ],
289 [ 'iwl_from', 'int4_ops', 'btree', 0 ],
290 ],
291 'CREATE INDEX iwl_prefix_title_from ON "iwlinks" ' .
292 'USING "btree" ("iwl_prefix", "iwl_title", "iwl_from")' ],
293 [ 'checkIndex', 'logging_times', [
294 [ 'log_timestamp', 'timestamptz_ops', 'btree', 0 ],
295 ],
296 'CREATE INDEX "logging_times" ON "logging" USING "btree" ("log_timestamp")' ],
297 [ 'dropPgIndex', 'oldimage', 'oi_name' ],
298 [ 'checkIndex', 'oi_name_archive_name', [
299 [ 'oi_name', 'text_ops', 'btree', 0 ],
300 [ 'oi_archive_name', 'text_ops', 'btree', 0 ],
301 ],
302 'CREATE INDEX "oi_name_archive_name" ON "oldimage" ' .
303 'USING "btree" ("oi_name", "oi_archive_name")' ],
304 [ 'checkIndex', 'oi_name_timestamp', [
305 [ 'oi_name', 'text_ops', 'btree', 0 ],
306 [ 'oi_timestamp', 'timestamptz_ops', 'btree', 0 ],
307 ],
308 'CREATE INDEX "oi_name_timestamp" ON "oldimage" ' .
309 'USING "btree" ("oi_name", "oi_timestamp")' ],
310 [ 'checkIndex', 'page_main_title', [
311 [ 'page_title', 'text_pattern_ops', 'btree', 0 ],
312 ],
313 'CREATE INDEX "page_main_title" ON "page" ' .
314 'USING "btree" ("page_title" "text_pattern_ops") WHERE ("page_namespace" = 0)' ],
315 [ 'checkIndex', 'page_mediawiki_title', [
316 [ 'page_title', 'text_pattern_ops', 'btree', 0 ],
317 ],
318 'CREATE INDEX "page_mediawiki_title" ON "page" ' .
319 'USING "btree" ("page_title" "text_pattern_ops") WHERE ("page_namespace" = 8)' ],
320 [ 'checkIndex', 'page_project_title', [
321 [ 'page_title', 'text_pattern_ops', 'btree', 0 ],
322 ],
323 'CREATE INDEX "page_project_title" ON "page" ' .
324 'USING "btree" ("page_title" "text_pattern_ops") ' .
325 'WHERE ("page_namespace" = 4)' ],
326 [ 'checkIndex', 'page_talk_title', [
327 [ 'page_title', 'text_pattern_ops', 'btree', 0 ],
328 ],
329 'CREATE INDEX "page_talk_title" ON "page" ' .
330 'USING "btree" ("page_title" "text_pattern_ops") ' .
331 'WHERE ("page_namespace" = 1)' ],
332 [ 'checkIndex', 'page_user_title', [
333 [ 'page_title', 'text_pattern_ops', 'btree', 0 ],
334 ],
335 'CREATE INDEX "page_user_title" ON "page" ' .
336 'USING "btree" ("page_title" "text_pattern_ops") WHERE ' .
337 '("page_namespace" = 2)' ],
338 [ 'checkIndex', 'page_utalk_title', [
339 [ 'page_title', 'text_pattern_ops', 'btree', 0 ],
340 ],
341 'CREATE INDEX "page_utalk_title" ON "page" ' .
342 'USING "btree" ("page_title" "text_pattern_ops") ' .
343 'WHERE ("page_namespace" = 3)' ],
344 [ 'checkIndex', 'ts2_page_text', [
345 [ 'textvector', 'tsvector_ops', 'gist', 0 ],
346 ],
347 'CREATE INDEX "ts2_page_text" ON "pagecontent" USING "gist" ("textvector")' ],
348 [ 'checkIndex', 'ts2_page_title', [
349 [ 'titlevector', 'tsvector_ops', 'gist', 0 ],
350 ],
351 'CREATE INDEX "ts2_page_title" ON "page" USING "gist" ("titlevector")' ],
352
353 [ 'checkOiNameConstraint' ],
354 [ 'checkPageDeletedTrigger' ],
355 [ 'checkRevUserFkey' ],
356 [ 'dropPgIndex', 'ipblocks', 'ipb_address' ],
357 [ 'checkIndex', 'ipb_address_unique', [
358 [ 'ipb_address', 'text_ops', 'btree', 0 ],
359 [ 'ipb_user', 'int4_ops', 'btree', 0 ],
360 [ 'ipb_auto', 'int2_ops', 'btree', 0 ],
361 [ 'ipb_anon_only', 'int2_ops', 'btree', 0 ],
362 ],
363 'CREATE UNIQUE INDEX ipb_address_unique ' .
364 'ON ipblocks (ipb_address,ipb_user,ipb_auto,ipb_anon_only)' ],
365
366 [ 'checkIwlPrefix' ],
367
368 # All FK columns should be deferred
369 [ 'changeFkeyDeferrable', 'archive', 'ar_user', 'mwuser(user_id) ON DELETE SET NULL' ],
370 [ 'changeFkeyDeferrable', 'categorylinks', 'cl_from', 'page(page_id) ON DELETE CASCADE' ],
371 [ 'changeFkeyDeferrable', 'externallinks', 'el_from', 'page(page_id) ON DELETE CASCADE' ],
372 [ 'changeFkeyDeferrable', 'filearchive', 'fa_deleted_user',
373 'mwuser(user_id) ON DELETE SET NULL' ],
374 [ 'changeFkeyDeferrable', 'filearchive', 'fa_user', 'mwuser(user_id) ON DELETE SET NULL' ],
375 [ 'changeFkeyDeferrable', 'image', 'img_user', 'mwuser(user_id) ON DELETE SET NULL' ],
376 [ 'changeFkeyDeferrable', 'imagelinks', 'il_from', 'page(page_id) ON DELETE CASCADE' ],
377 [ 'changeFkeyDeferrable', 'ipblocks', 'ipb_by', 'mwuser(user_id) ON DELETE CASCADE' ],
378 [ 'changeFkeyDeferrable', 'ipblocks', 'ipb_user', 'mwuser(user_id) ON DELETE SET NULL' ],
379 [ 'changeFkeyDeferrable', 'ipblocks', 'ipb_parent_block_id',
380 'ipblocks(ipb_id) ON DELETE SET NULL' ],
381 [ 'changeFkeyDeferrable', 'langlinks', 'll_from', 'page(page_id) ON DELETE CASCADE' ],
382 [ 'changeFkeyDeferrable', 'logging', 'log_user', 'mwuser(user_id) ON DELETE SET NULL' ],
383 [ 'changeFkeyDeferrable', 'oldimage', 'oi_name',
384 'image(img_name) ON DELETE CASCADE ON UPDATE CASCADE' ],
385 [ 'changeFkeyDeferrable', 'oldimage', 'oi_user', 'mwuser(user_id) ON DELETE SET NULL' ],
386 [ 'changeFkeyDeferrable', 'pagelinks', 'pl_from', 'page(page_id) ON DELETE CASCADE' ],
387 [ 'changeFkeyDeferrable', 'page_props', 'pp_page', 'page (page_id) ON DELETE CASCADE' ],
388 [ 'changeFkeyDeferrable', 'page_restrictions', 'pr_page',
389 'page(page_id) ON DELETE CASCADE' ],
390 [ 'changeFkeyDeferrable', 'protected_titles', 'pt_user',
391 'mwuser(user_id) ON DELETE SET NULL' ],
392 [ 'changeFkeyDeferrable', 'recentchanges', 'rc_user',
393 'mwuser(user_id) ON DELETE SET NULL' ],
394 [ 'changeFkeyDeferrable', 'redirect', 'rd_from', 'page(page_id) ON DELETE CASCADE' ],
395 [ 'changeFkeyDeferrable', 'revision', 'rev_page', 'page (page_id) ON DELETE CASCADE' ],
396 [ 'changeFkeyDeferrable', 'revision', 'rev_user', 'mwuser(user_id) ON DELETE RESTRICT' ],
397 [ 'changeFkeyDeferrable', 'templatelinks', 'tl_from', 'page(page_id) ON DELETE CASCADE' ],
398 [ 'changeFkeyDeferrable', 'user_groups', 'ug_user', 'mwuser(user_id) ON DELETE CASCADE' ],
399 [ 'changeFkeyDeferrable', 'user_newtalk', 'user_id', 'mwuser(user_id) ON DELETE CASCADE' ],
400 [ 'changeFkeyDeferrable', 'user_properties', 'up_user',
401 'mwuser(user_id) ON DELETE CASCADE' ],
402 [ 'changeFkeyDeferrable', 'watchlist', 'wl_user', 'mwuser(user_id) ON DELETE CASCADE' ],
403
404 # r81574
405 [ 'addInterwikiType' ],
406 # end
407 [ 'tsearchFixes' ],
408
409 // 1.23
410 [ 'addPgField', 'recentchanges', 'rc_source', "TEXT NOT NULL DEFAULT ''" ],
411 [ 'addPgField', 'page', 'page_links_updated', "TIMESTAMPTZ NULL" ],
412 [ 'addPgField', 'mwuser', 'user_password_expires', 'TIMESTAMPTZ NULL' ],
413 [ 'changeFieldPurgeTable', 'l10n_cache', 'lc_value', 'bytea',
414 "replace(lc_value,'\','\\\\')::bytea" ],
415 // 1.23.9
416 [ 'rebuildTextSearch' ],
417
418 // 1.24
419 [ 'addPgField', 'page_props', 'pp_sortkey', 'float NULL' ],
420 [ 'addPgIndex', 'page_props', 'pp_propname_sortkey_page',
421 '( pp_propname, pp_sortkey, pp_page ) WHERE ( pp_sortkey IS NOT NULL )' ],
422 [ 'addPgField', 'page', 'page_lang', 'TEXT default NULL' ],
423 [ 'addPgField', 'pagelinks', 'pl_from_namespace', 'INTEGER NOT NULL DEFAULT 0' ],
424 [ 'addPgField', 'templatelinks', 'tl_from_namespace', 'INTEGER NOT NULL DEFAULT 0' ],
425 [ 'addPgField', 'imagelinks', 'il_from_namespace', 'INTEGER NOT NULL DEFAULT 0' ],
426
427 // 1.25
428 [ 'dropTable', 'hitcounter' ],
429 [ 'dropField', 'site_stats', 'ss_total_views', 'patch-drop-ss_total_views.sql' ],
430 [ 'dropField', 'page', 'page_counter', 'patch-drop-page_counter.sql' ],
431 [ 'dropFkey', 'recentchanges', 'rc_cur_id' ],
432
433 // 1.27
434 [ 'dropTable', 'msg_resource_links' ],
435 [ 'dropTable', 'msg_resource' ],
436 [
437 'addPgField', 'watchlist', 'wl_id',
438 "INTEGER NOT NULL PRIMARY KEY DEFAULT nextval('watchlist_wl_id_seq')"
439 ],
440
441 // 1.28
442 [ 'addPgIndex', 'recentchanges', 'rc_name_type_patrolled_timestamp',
443 '( rc_namespace, rc_type, rc_patrolled, rc_timestamp )' ],
444 [ 'addPgField', 'change_tag', 'ct_id',
445 "INTEGER NOT NULL PRIMARY KEY DEFAULT nextval('change_tag_ct_id_seq')" ],
446 [ 'addPgField', 'tag_summary', 'ts_id',
447 "INTEGER NOT NULL PRIMARY KEY DEFAULT nextval('tag_summary_ts_id_seq')" ],
448
449 // 1.29
450 [ 'addPgField', 'externallinks', 'el_index_60', "BYTEA NOT NULL DEFAULT ''" ],
451 [ 'addPgIndex', 'externallinks', 'el_index_60', '( el_index_60, el_id )' ],
452 [ 'addPgIndex', 'externallinks', 'el_from_index_60', '( el_from, el_index_60, el_id )' ],
453 [ 'addPgField', 'user_groups', 'ug_expiry', "TIMESTAMPTZ NULL" ],
454 [ 'addPgIndex', 'user_groups', 'user_groups_expiry', '( ug_expiry )' ],
455
456 // 1.30
457 [ 'addPgEnumValue', 'media_type', '3D' ],
458 [ 'setDefault', 'revision', 'rev_comment', '' ],
459 [ 'changeNullableField', 'revision', 'rev_comment', 'NOT NULL', true ],
460 [ 'setDefault', 'archive', 'ar_comment', '' ],
461 [ 'changeNullableField', 'archive', 'ar_comment', 'NOT NULL', true ],
462 [ 'addPgField', 'archive', 'ar_comment_id', 'INTEGER NOT NULL DEFAULT 0' ],
463 [ 'setDefault', 'ipblocks', 'ipb_reason', '' ],
464 [ 'addPgField', 'ipblocks', 'ipb_reason_id', 'INTEGER NOT NULL DEFAULT 0' ],
465 [ 'setDefault', 'image', 'img_description', '' ],
466 [ 'setDefault', 'oldimage', 'oi_description', '' ],
467 [ 'changeNullableField', 'oldimage', 'oi_description', 'NOT NULL', true ],
468 [ 'addPgField', 'oldimage', 'oi_description_id', 'INTEGER NOT NULL DEFAULT 0' ],
469 [ 'setDefault', 'filearchive', 'fa_deleted_reason', '' ],
470 [ 'changeNullableField', 'filearchive', 'fa_deleted_reason', 'NOT NULL', true ],
471 [ 'addPgField', 'filearchive', 'fa_deleted_reason_id', 'INTEGER NOT NULL DEFAULT 0' ],
472 [ 'setDefault', 'filearchive', 'fa_description', '' ],
473 [ 'addPgField', 'filearchive', 'fa_description_id', 'INTEGER NOT NULL DEFAULT 0' ],
474 [ 'setDefault', 'recentchanges', 'rc_comment', '' ],
475 [ 'changeNullableField', 'recentchanges', 'rc_comment', 'NOT NULL', true ],
476 [ 'addPgField', 'recentchanges', 'rc_comment_id', 'INTEGER NOT NULL DEFAULT 0' ],
477 [ 'setDefault', 'logging', 'log_comment', '' ],
478 [ 'changeNullableField', 'logging', 'log_comment', 'NOT NULL', true ],
479 [ 'addPgField', 'logging', 'log_comment_id', 'INTEGER NOT NULL DEFAULT 0' ],
480 [ 'setDefault', 'protected_titles', 'pt_reason', '' ],
481 [ 'changeNullableField', 'protected_titles', 'pt_reason', 'NOT NULL', true ],
482 [ 'addPgField', 'protected_titles', 'pt_reason_id', 'INTEGER NOT NULL DEFAULT 0' ],
483 [ 'addTable', 'comment', 'patch-comment-table.sql' ],
484
485 // This field was added in 1.31, but is put here so it can be used by 'migrateComments'
486 [ 'addPgField', 'image', 'img_description_id', 'INTEGER NOT NULL DEFAULT 0' ],
487
488 [ 'migrateComments' ],
489 [ 'addIndex', 'site_stats', 'site_stats_pkey', 'patch-site_stats-pk.sql' ],
490 [ 'addTable', 'ip_changes', 'patch-ip_changes.sql' ],
491
492 // 1.31
493 [ 'addTable', 'slots', 'patch-slots-table.sql' ],
494 [ 'dropPgIndex', 'slots', 'slot_role_inherited' ],
495 [ 'dropPgField', 'slots', 'slot_inherited' ],
496 [ 'addPgField', 'slots', 'slot_origin', 'INTEGER NOT NULL' ],
497 [
498 'addPgIndex',
499 'slots',
500 'slot_revision_origin_role',
501 '( slot_revision_id, slot_origin, slot_role_id )',
502 ],
503 [ 'addTable', 'content', 'patch-content-table.sql' ],
504 [ 'addTable', 'content_models', 'patch-content_models-table.sql' ],
505 [ 'addTable', 'slot_roles', 'patch-slot_roles-table.sql' ],
506 [ 'migrateArchiveText' ],
507 [ 'addTable', 'actor', 'patch-actor-table.sql' ],
508 [ 'setDefault', 'revision', 'rev_user', 0 ],
509 [ 'setDefault', 'revision', 'rev_user_text', '' ],
510 [ 'setDefault', 'archive', 'ar_user', 0 ],
511 [ 'changeNullableField', 'archive', 'ar_user', 'NOT NULL', true ],
512 [ 'setDefault', 'archive', 'ar_user_text', '' ],
513 [ 'addPgField', 'archive', 'ar_actor', 'INTEGER NOT NULL DEFAULT 0' ],
514 [ 'addPgIndex', 'archive', 'archive_actor', '( ar_actor )' ],
515 [ 'setDefault', 'ipblocks', 'ipb_by', 0 ],
516 [ 'addPgField', 'ipblocks', 'ipb_by_actor', 'INTEGER NOT NULL DEFAULT 0' ],
517 [ 'setDefault', 'image', 'img_user', 0 ],
518 [ 'changeNullableField', 'image', 'img_user', 'NOT NULL', true ],
519 [ 'setDefault', 'image', 'img_user_text', '' ],
520 [ 'addPgField', 'image', 'img_actor', 'INTEGER NOT NULL DEFAULT 0' ],
521 [ 'setDefault', 'oldimage', 'oi_user', 0 ],
522 [ 'changeNullableField', 'oldimage', 'oi_user', 'NOT NULL', true ],
523 [ 'setDefault', 'oldimage', 'oi_user_text', '' ],
524 [ 'addPgField', 'oldimage', 'oi_actor', 'INTEGER NOT NULL DEFAULT 0' ],
525 [ 'setDefault', 'filearchive', 'fa_user', 0 ],
526 [ 'changeNullableField', 'filearchive', 'fa_user', 'NOT NULL', true ],
527 [ 'setDefault', 'filearchive', 'fa_user_text', '' ],
528 [ 'addPgField', 'filearchive', 'fa_actor', 'INTEGER NOT NULL DEFAULT 0' ],
529 [ 'setDefault', 'recentchanges', 'rc_user', 0 ],
530 [ 'changeNullableField', 'recentchanges', 'rc_user', 'NOT NULL', true ],
531 [ 'setDefault', 'recentchanges', 'rc_user_text', '' ],
532 [ 'addPgField', 'recentchanges', 'rc_actor', 'INTEGER NOT NULL DEFAULT 0' ],
533 [ 'setDefault', 'logging', 'log_user', 0 ],
534 [ 'changeNullableField', 'logging', 'log_user', 'NOT NULL', true ],
535 [ 'addPgField', 'logging', 'log_actor', 'INTEGER NOT NULL DEFAULT 0' ],
536 [ 'addPgIndex', 'logging', 'logging_actor_time_backwards', '( log_timestamp, log_actor )' ],
537 [ 'addPgIndex', 'logging', 'logging_actor_type_time', '( log_actor, log_type, log_timestamp )' ],
538 [ 'addPgIndex', 'logging', 'logging_actor_time', '( log_actor, log_timestamp )' ],
539 [ 'migrateActors' ],
540 [ 'modifyTable', 'site_stats', 'patch-site_stats-modify.sql' ],
541 [ 'populateArchiveRevId' ],
542 [ 'dropPgIndex', 'recentchanges', 'rc_namespace_title' ],
543 [
544 'addPgIndex',
545 'recentchanges',
546 'rc_namespace_title_timestamp', '( rc_namespace, rc_title, rc_timestamp )'
547 ],
548 ];
549 }
550
551 protected function getOldGlobalUpdates() {
552 global $wgExtNewTables, $wgExtPGNewFields, $wgExtPGAlteredFields, $wgExtNewIndexes;
553
554 $updates = [];
555
556 # Add missing extension tables
557 foreach ( $wgExtNewTables as $tableRecord ) {
558 $updates[] = [
559 'addTable', $tableRecord[0], $tableRecord[1], true
560 ];
561 }
562
563 # Add missing extension fields
564 foreach ( $wgExtPGNewFields as $fieldRecord ) {
565 $updates[] = [
566 'addPgField', $fieldRecord[0], $fieldRecord[1],
567 $fieldRecord[2]
568 ];
569 }
570
571 # Change altered columns
572 foreach ( $wgExtPGAlteredFields as $fieldRecord ) {
573 $updates[] = [
574 'changeField', $fieldRecord[0], $fieldRecord[1],
575 $fieldRecord[2]
576 ];
577 }
578
579 # Add missing extension indexes
580 foreach ( $wgExtNewIndexes as $fieldRecord ) {
581 $updates[] = [
582 'addPgExtIndex', $fieldRecord[0], $fieldRecord[1],
583 $fieldRecord[2]
584 ];
585 }
586
587 return $updates;
588 }
589
590 protected function describeTable( $table ) {
591 $q = <<<END
592 SELECT attname, attnum FROM pg_namespace, pg_class, pg_attribute
593 WHERE pg_class.relnamespace = pg_namespace.oid
594 AND attrelid=pg_class.oid AND attnum > 0
595 AND relname=%s AND nspname=%s
596 END;
597 $res = $this->db->query( sprintf( $q,
598 $this->db->addQuotes( $table ),
599 $this->db->addQuotes( $this->db->getCoreSchema() ) ) );
600 if ( !$res ) {
601 return null;
602 }
603
604 $cols = [];
605 foreach ( $res as $r ) {
606 $cols[] = [
607 "name" => $r[0],
608 "ord" => $r[1],
609 ];
610 }
611
612 return $cols;
613 }
614
615 function describeIndex( $idx ) {
616 // first fetch the key (which is a list of columns ords) and
617 // the table the index applies to (an oid)
618 $q = <<<END
619 SELECT indkey, indrelid FROM pg_namespace, pg_class, pg_index
620 WHERE nspname=%s
621 AND pg_class.relnamespace = pg_namespace.oid
622 AND relname=%s
623 AND indexrelid=pg_class.oid
624 END;
625 $res = $this->db->query(
626 sprintf(
627 $q,
628 $this->db->addQuotes( $this->db->getCoreSchema() ),
629 $this->db->addQuotes( $idx )
630 )
631 );
632 if ( !$res ) {
633 return null;
634 }
635 $r = $this->db->fetchRow( $res );
636 if ( !$r ) {
637 return null;
638 }
639
640 $indkey = $r[0];
641 $relid = intval( $r[1] );
642 $indkeys = explode( ' ', $indkey );
643
644 $colnames = [];
645 foreach ( $indkeys as $rid ) {
646 $query = <<<END
647 SELECT attname FROM pg_class, pg_attribute
648 WHERE attrelid=$relid
649 AND attnum=%d
650 AND attrelid=pg_class.oid
651 END;
652 $r2 = $this->db->query( sprintf( $query, $rid ) );
653 if ( !$r2 ) {
654 return null;
655 }
656 $row2 = $this->db->fetchRow( $r2 );
657 if ( !$row2 ) {
658 return null;
659 }
660 $colnames[] = $row2[0];
661 }
662
663 return $colnames;
664 }
665
666 function fkeyDeltype( $fkey ) {
667 $q = <<<END
668 SELECT confdeltype FROM pg_constraint, pg_namespace
669 WHERE connamespace=pg_namespace.oid
670 AND nspname=%s
671 AND conname=%s;
672 END;
673 $r = $this->db->query(
674 sprintf(
675 $q,
676 $this->db->addQuotes( $this->db->getCoreSchema() ),
677 $this->db->addQuotes( $fkey )
678 )
679 );
680 $row = $this->db->fetchRow( $r );
681 if ( !$row ) {
682 return null;
683 }
684
685 return $row[0];
686 }
687
688 function ruleDef( $table, $rule ) {
689 $q = <<<END
690 SELECT definition FROM pg_rules
691 WHERE schemaname = %s
692 AND tablename = %s
693 AND rulename = %s
694 END;
695 $r = $this->db->query(
696 sprintf(
697 $q,
698 $this->db->addQuotes( $this->db->getCoreSchema() ),
699 $this->db->addQuotes( $table ),
700 $this->db->addQuotes( $rule )
701 )
702 );
703 $row = $this->db->fetchRow( $r );
704 if ( !$row ) {
705 return null;
706 }
707 $d = $row[0];
708
709 return $d;
710 }
711
712 protected function addSequence( $table, $pkey, $ns ) {
713 if ( !$this->db->sequenceExists( $ns ) ) {
714 $this->output( "Creating sequence $ns\n" );
715 $this->db->query( "CREATE SEQUENCE $ns" );
716 if ( $pkey !== false ) {
717 $this->setDefault( $table, $pkey, '"nextval"(\'"' . $ns . '"\'::"regclass")' );
718 }
719 }
720 }
721
722 protected function dropSequence( $table, $ns ) {
723 if ( $this->db->sequenceExists( $ns ) ) {
724 $this->output( "Dropping sequence $ns\n" );
725 $this->db->query( "DROP SEQUENCE $ns CASCADE" );
726 }
727 }
728
729 protected function renameSequence( $old, $new ) {
730 if ( $this->db->sequenceExists( $new ) ) {
731 $this->output( "...sequence $new already exists.\n" );
732
733 return;
734 }
735 if ( $this->db->sequenceExists( $old ) ) {
736 $this->output( "Renaming sequence $old to $new\n" );
737 $this->db->query( "ALTER SEQUENCE $old RENAME TO $new" );
738 }
739 }
740
741 protected function renameTable( $old, $new, $patch = false ) {
742 if ( $this->db->tableExists( $old ) ) {
743 $this->output( "Renaming table $old to $new\n" );
744 $old = $this->db->realTableName( $old, "quoted" );
745 $new = $this->db->realTableName( $new, "quoted" );
746 $this->db->query( "ALTER TABLE $old RENAME TO $new" );
747 if ( $patch !== false ) {
748 $this->applyPatch( $patch );
749 }
750 }
751 }
752
753 protected function renameIndex(
754 $table, $old, $new, $skipBothIndexExistWarning = false, $a = false, $b = false
755 ) {
756 // First requirement: the table must exist
757 if ( !$this->db->tableExists( $table, __METHOD__ ) ) {
758 $this->output( "...skipping: '$table' table doesn't exist yet.\n" );
759
760 return;
761 }
762
763 // Second requirement: the new index must be missing
764 if ( $this->db->indexExists( $table, $new, __METHOD__ ) ) {
765 $this->output( "...index $new already set on $table table.\n" );
766 if ( !$skipBothIndexExistWarning
767 && $this->db->indexExists( $table, $old, __METHOD__ )
768 ) {
769 $this->output( "...WARNING: $old still exists, despite it has been " .
770 "renamed into $new (which also exists).\n" .
771 " $old should be manually removed if not needed anymore.\n" );
772 }
773
774 return;
775 }
776
777 // Third requirement: the old index must exist
778 if ( !$this->db->indexExists( $table, $old, __METHOD__ ) ) {
779 $this->output( "...skipping: index $old doesn't exist.\n" );
780
781 return;
782 }
783
784 $this->db->query( "ALTER INDEX $old RENAME TO $new" );
785 }
786
787 protected function dropPgField( $table, $field ) {
788 $fi = $this->db->fieldInfo( $table, $field );
789 if ( is_null( $fi ) ) {
790 $this->output( "...$table table does not contain $field field.\n" );
791
792 return;
793 } else {
794 $this->output( "Dropping column '$table.$field'\n" );
795 $this->db->query( "ALTER TABLE $table DROP COLUMN $field" );
796 }
797 }
798
799 protected function addPgField( $table, $field, $type ) {
800 $fi = $this->db->fieldInfo( $table, $field );
801 if ( !is_null( $fi ) ) {
802 $this->output( "...column '$table.$field' already exists\n" );
803
804 return;
805 } else {
806 $this->output( "Adding column '$table.$field'\n" );
807 $this->db->query( "ALTER TABLE $table ADD $field $type" );
808 }
809 }
810
811 protected function changeField( $table, $field, $newtype, $default ) {
812 $fi = $this->db->fieldInfo( $table, $field );
813 if ( is_null( $fi ) ) {
814 $this->output( "...ERROR: expected column $table.$field to exist\n" );
815 exit( 1 );
816 }
817
818 if ( $fi->type() === $newtype ) {
819 $this->output( "...column '$table.$field' is already of type '$newtype'\n" );
820 } else {
821 $this->output( "Changing column type of '$table.$field' from '{$fi->type()}' to '$newtype'\n" );
822 $sql = "ALTER TABLE $table ALTER $field TYPE $newtype";
823 if ( strlen( $default ) ) {
824 $res = [];
825 if ( preg_match( '/DEFAULT (.+)/', $default, $res ) ) {
826 $sqldef = "ALTER TABLE $table ALTER $field SET DEFAULT $res[1]";
827 $this->db->query( $sqldef );
828 $default = preg_replace( '/\s*DEFAULT .+/', '', $default );
829 }
830 $sql .= " USING $default";
831 }
832 $this->db->query( $sql );
833 }
834 }
835
836 protected function changeFieldPurgeTable( $table, $field, $newtype, $default ) {
837 # # For a cache table, empty it if the field needs to be changed, because the old contents
838 # # may be corrupted. If the column is already the desired type, refrain from purging.
839 $fi = $this->db->fieldInfo( $table, $field );
840 if ( is_null( $fi ) ) {
841 $this->output( "...ERROR: expected column $table.$field to exist\n" );
842 exit( 1 );
843 }
844
845 if ( $fi->type() === $newtype ) {
846 $this->output( "...column '$table.$field' is already of type '$newtype'\n" );
847 } else {
848 $this->output( "Purging data from cache table '$table'\n" );
849 $this->db->query( "DELETE from $table" );
850 $this->output( "Changing column type of '$table.$field' from '{$fi->type()}' to '$newtype'\n" );
851 $sql = "ALTER TABLE $table ALTER $field TYPE $newtype";
852 if ( strlen( $default ) ) {
853 $res = [];
854 if ( preg_match( '/DEFAULT (.+)/', $default, $res ) ) {
855 $sqldef = "ALTER TABLE $table ALTER $field SET DEFAULT $res[1]";
856 $this->db->query( $sqldef );
857 $default = preg_replace( '/\s*DEFAULT .+/', '', $default );
858 }
859 $sql .= " USING $default";
860 }
861 $this->db->query( $sql );
862 }
863 }
864
865 protected function setDefault( $table, $field, $default ) {
866 $info = $this->db->fieldInfo( $table, $field );
867 if ( $info->defaultValue() !== $default ) {
868 $this->output( "Changing '$table.$field' default value\n" );
869 $this->db->query( "ALTER TABLE $table ALTER $field SET DEFAULT "
870 . $this->db->addQuotes( $default ) );
871 }
872 }
873
874 protected function changeNullableField( $table, $field, $null, $update = false ) {
875 $fi = $this->db->fieldInfo( $table, $field );
876 if ( is_null( $fi ) ) {
877 $this->output( "...ERROR: expected column $table.$field to exist\n" );
878 exit( 1 );
879 }
880 if ( $fi->isNullable() ) {
881 # # It's NULL - does it need to be NOT NULL?
882 if ( 'NOT NULL' === $null ) {
883 $this->output( "Changing '$table.$field' to not allow NULLs\n" );
884 if ( $update ) {
885 $this->db->query( "UPDATE $table SET $field = DEFAULT WHERE $field IS NULL" );
886 }
887 $this->db->query( "ALTER TABLE $table ALTER $field SET NOT NULL" );
888 } else {
889 $this->output( "...column '$table.$field' is already set as NULL\n" );
890 }
891 } else {
892 # # It's NOT NULL - does it need to be NULL?
893 if ( 'NULL' === $null ) {
894 $this->output( "Changing '$table.$field' to allow NULLs\n" );
895 $this->db->query( "ALTER TABLE $table ALTER $field DROP NOT NULL" );
896 } else {
897 $this->output( "...column '$table.$field' is already set as NOT NULL\n" );
898 }
899 }
900 }
901
902 public function addPgIndex( $table, $index, $type ) {
903 if ( $this->db->indexExists( $table, $index ) ) {
904 $this->output( "...index '$index' on table '$table' already exists\n" );
905 } else {
906 $this->output( "Creating index '$index' on table '$table' $type\n" );
907 $this->db->query( "CREATE INDEX $index ON $table $type" );
908 }
909 }
910
911 public function addPgExtIndex( $table, $index, $type ) {
912 if ( $this->db->indexExists( $table, $index ) ) {
913 $this->output( "...index '$index' on table '$table' already exists\n" );
914 } else {
915 if ( preg_match( '/^\(/', $type ) ) {
916 $this->output( "Creating index '$index' on table '$table'\n" );
917 $this->db->query( "CREATE INDEX $index ON $table $type" );
918 } else {
919 $this->applyPatch( $type, true, "Creating index '$index' on table '$table'" );
920 }
921 }
922 }
923
924 /**
925 * Add a value to an existing PostgreSQL enum type
926 * @since 1.31
927 * @param string $type Type name. Must be in the core schema.
928 * @param string $value Value to add.
929 */
930 public function addPgEnumValue( $type, $value ) {
931 $row = $this->db->selectRow(
932 [
933 't' => 'pg_catalog.pg_type',
934 'n' => 'pg_catalog.pg_namespace',
935 'e' => 'pg_catalog.pg_enum',
936 ],
937 [ 't.typname', 't.typtype', 'e.enumlabel' ],
938 [
939 't.typname' => $type,
940 'n.nspname' => $this->db->getCoreSchema(),
941 ],
942 __METHOD__,
943 [],
944 [
945 'n' => [ 'JOIN', 't.typnamespace = n.oid' ],
946 'e' => [ 'LEFT JOIN', [ 'e.enumtypid = t.oid', 'e.enumlabel' => $value ] ],
947 ]
948 );
949
950 if ( !$row ) {
951 $this->output( "...Type $type does not exist, skipping modify enum.\n" );
952 } elseif ( $row->typtype !== 'e' ) {
953 $this->output( "...Type $type does not seem to be an enum, skipping modify enum.\n" );
954 } elseif ( $row->enumlabel === $value ) {
955 $this->output( "...Enum type $type already contains value '$value'.\n" );
956 } else {
957 $this->output( "...Adding value '$value' to enum type $type.\n" );
958 $etype = $this->db->addIdentifierQuotes( $type );
959 $evalue = $this->db->addQuotes( $value );
960 $this->db->query( "ALTER TYPE $etype ADD VALUE $evalue" );
961 }
962 }
963
964 protected function dropFkey( $table, $field ) {
965 $fi = $this->db->fieldInfo( $table, $field );
966 if ( is_null( $fi ) ) {
967 $this->output( "WARNING! Column '$table.$field' does not exist but it should! " .
968 "Please report this.\n" );
969 return;
970 }
971 $conname = $fi->conname();
972 if ( $fi->conname() ) {
973 $this->output( "Dropping foreign key constraint on '$table.$field'\n" );
974 $conclause = "CONSTRAINT \"$conname\"";
975 $command = "ALTER TABLE $table DROP CONSTRAINT $conname";
976 $this->db->query( $command );
977 } else {
978 $this->output( "...foreign key constraint on '$table.$field' already does not exist\n" );
979 };
980 }
981
982 protected function changeFkeyDeferrable( $table, $field, $clause ) {
983 $fi = $this->db->fieldInfo( $table, $field );
984 if ( is_null( $fi ) ) {
985 $this->output( "WARNING! Column '$table.$field' does not exist but it should! " .
986 "Please report this.\n" );
987
988 return;
989 }
990 if ( $fi->is_deferred() && $fi->is_deferrable() ) {
991 return;
992 }
993 $this->output( "Altering column '$table.$field' to be DEFERRABLE INITIALLY DEFERRED\n" );
994 $conname = $fi->conname();
995 if ( $fi->conname() ) {
996 $conclause = "CONSTRAINT \"$conname\"";
997 $command = "ALTER TABLE $table DROP CONSTRAINT $conname";
998 $this->db->query( $command );
999 } else {
1000 $this->output( "Column '$table.$field' does not have a foreign key " .
1001 "constraint, will be added\n" );
1002 $conclause = "";
1003 }
1004 $command =
1005 "ALTER TABLE $table ADD $conclause " .
1006 "FOREIGN KEY ($field) REFERENCES $clause DEFERRABLE INITIALLY DEFERRED";
1007 $this->db->query( $command );
1008 }
1009
1010 protected function convertArchive2() {
1011 if ( $this->db->tableExists( "archive2" ) ) {
1012 if ( $this->db->ruleExists( 'archive', 'archive_insert' ) ) {
1013 $this->output( "Dropping rule 'archive_insert'\n" );
1014 $this->db->query( 'DROP RULE archive_insert ON archive' );
1015 }
1016 if ( $this->db->ruleExists( 'archive', 'archive_delete' ) ) {
1017 $this->output( "Dropping rule 'archive_delete'\n" );
1018 $this->db->query( 'DROP RULE archive_delete ON archive' );
1019 }
1020 $this->applyPatch(
1021 'patch-remove-archive2.sql',
1022 false,
1023 "Converting 'archive2' back to normal archive table"
1024 );
1025 } else {
1026 $this->output( "...obsolete table 'archive2' does not exist\n" );
1027 }
1028 }
1029
1030 protected function checkOiDeleted() {
1031 if ( $this->db->fieldInfo( 'oldimage', 'oi_deleted' )->type() !== 'smallint' ) {
1032 $this->output( "Changing 'oldimage.oi_deleted' to type 'smallint'\n" );
1033 $this->db->query( "ALTER TABLE oldimage ALTER oi_deleted DROP DEFAULT" );
1034 $this->db->query(
1035 "ALTER TABLE oldimage ALTER oi_deleted TYPE SMALLINT USING (oi_deleted::smallint)" );
1036 $this->db->query( "ALTER TABLE oldimage ALTER oi_deleted SET DEFAULT 0" );
1037 } else {
1038 $this->output( "...column 'oldimage.oi_deleted' is already of type 'smallint'\n" );
1039 }
1040 }
1041
1042 protected function checkOiNameConstraint() {
1043 if ( $this->db->hasConstraint( "oldimage_oi_name_fkey_cascaded" ) ) {
1044 $this->output( "...table 'oldimage' has correct cascading delete/update " .
1045 "foreign key to image\n" );
1046 } else {
1047 if ( $this->db->hasConstraint( "oldimage_oi_name_fkey" ) ) {
1048 $this->db->query(
1049 "ALTER TABLE oldimage DROP CONSTRAINT oldimage_oi_name_fkey" );
1050 }
1051 if ( $this->db->hasConstraint( "oldimage_oi_name_fkey_cascade" ) ) {
1052 $this->db->query(
1053 "ALTER TABLE oldimage DROP CONSTRAINT oldimage_oi_name_fkey_cascade" );
1054 }
1055 $this->output( "Making foreign key on table 'oldimage' (to image) a cascade delete/update\n" );
1056 $this->db->query(
1057 "ALTER TABLE oldimage ADD CONSTRAINT oldimage_oi_name_fkey_cascaded " .
1058 "FOREIGN KEY (oi_name) REFERENCES image(img_name) " .
1059 "ON DELETE CASCADE ON UPDATE CASCADE" );
1060 }
1061 }
1062
1063 protected function checkPageDeletedTrigger() {
1064 if ( !$this->db->triggerExists( 'page', 'page_deleted' ) ) {
1065 $this->applyPatch(
1066 'patch-page_deleted.sql',
1067 false,
1068 "Adding function and trigger 'page_deleted' to table 'page'"
1069 );
1070 } else {
1071 $this->output( "...table 'page' has 'page_deleted' trigger\n" );
1072 }
1073 }
1074
1075 protected function dropPgIndex( $table, $index ) {
1076 if ( $this->db->indexExists( $table, $index ) ) {
1077 $this->output( "Dropping obsolete index '$index'\n" );
1078 $this->db->query( "DROP INDEX \"" . $index . "\"" );
1079 }
1080 }
1081
1082 protected function checkIndex( $index, $should_be, $good_def ) {
1083 $pu = $this->db->indexAttributes( $index );
1084 if ( !empty( $pu ) && $pu != $should_be ) {
1085 $this->output( "Dropping obsolete version of index '$index'\n" );
1086 $this->db->query( "DROP INDEX \"" . $index . "\"" );
1087 $pu = [];
1088 } else {
1089 $this->output( "...no need to drop index '$index'\n" );
1090 }
1091
1092 if ( empty( $pu ) ) {
1093 $this->output( "Creating index '$index'\n" );
1094 $this->db->query( $good_def );
1095 } else {
1096 $this->output( "...index '$index' exists\n" );
1097 }
1098 }
1099
1100 protected function checkRevUserFkey() {
1101 if ( $this->fkeyDeltype( 'revision_rev_user_fkey' ) == 'r' ) {
1102 $this->output( "...constraint 'revision_rev_user_fkey' is ON DELETE RESTRICT\n" );
1103 } else {
1104 $this->applyPatch(
1105 'patch-revision_rev_user_fkey.sql',
1106 false,
1107 "Changing constraint 'revision_rev_user_fkey' to ON DELETE RESTRICT"
1108 );
1109 }
1110 }
1111
1112 protected function checkIwlPrefix() {
1113 if ( $this->db->indexExists( 'iwlinks', 'iwl_prefix' ) ) {
1114 $this->applyPatch(
1115 'patch-rename-iwl_prefix.sql',
1116 false,
1117 "Replacing index 'iwl_prefix' with 'iwl_prefix_title_from'"
1118 );
1119 }
1120 }
1121
1122 protected function addInterwikiType() {
1123 $this->applyPatch( 'patch-add_interwiki.sql', false, "Refreshing add_interwiki()" );
1124 }
1125
1126 protected function tsearchFixes() {
1127 # Tweak the page_title tsearch2 trigger to filter out slashes
1128 # This is create or replace, so harmless to call if not needed
1129 $this->applyPatch( 'patch-ts2pagetitle.sql', false, "Refreshing ts2_page_title()" );
1130
1131 # If the server is 8.3 or higher, rewrite the tsearch2 triggers
1132 # in case they have the old 'default' versions
1133 # Gather version numbers in case we need them
1134 if ( $this->db->getServerVersion() >= 8.3 ) {
1135 $this->applyPatch( 'patch-tsearch2funcs.sql', false, "Rewriting tsearch2 triggers" );
1136 }
1137 }
1138
1139 protected function rebuildTextSearch() {
1140 if ( $this->updateRowExists( 'patch-textsearch_bug66650.sql' ) ) {
1141 $this->output( "...T68650 already fixed or not applicable.\n" );
1142 return;
1143 };
1144 $this->applyPatch( 'patch-textsearch_bug66650.sql', false,
1145 'Rebuilding text search for T68650' );
1146 }
1147 }