Update some documentation in CacheTime and ParserCache
[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 /**
25 * Class for handling updates to Postgres databases.
26 *
27 * @ingroup Deployment
28 * @since 1.17
29 */
30
31 class PostgresUpdater extends DatabaseUpdater {
32
33 /**
34 * @var DatabasePostgres
35 */
36 protected $db;
37
38 /**
39 * @todo FIXME: Postgres should use sequential updates like Mysql, Sqlite
40 * and everybody else. It never got refactored like it should've.
41 * @return array
42 */
43 protected function getCoreUpdateList() {
44 return array(
45 # rename tables 1.7.3
46 # r15791 Change reserved word table names "user" and "text"
47 array( 'renameTable', 'user', 'mwuser' ),
48 array( 'renameTable', 'text', 'pagecontent' ),
49 array( 'renameIndex', 'mwuser', 'user_pkey', 'mwuser_pkey' ),
50 array( 'renameIndex', 'mwuser', 'user_user_name_key', 'mwuser_user_name_key' ),
51 array( 'renameIndex', 'pagecontent', 'text_pkey', 'pagecontent_pkey' ),
52
53 # renamed sequences
54 array( 'renameSequence', 'ipblocks_ipb_id_val', 'ipblocks_ipb_id_seq' ),
55 array( 'renameSequence', 'rev_rev_id_val', 'revision_rev_id_seq' ),
56 array( 'renameSequence', 'text_old_id_val', 'text_old_id_seq' ),
57 array( 'renameSequence', 'rc_rc_id_seq', 'recentchanges_rc_id_seq' ),
58 array( 'renameSequence', 'log_log_id_seq', 'logging_log_id_seq' ),
59 array( 'renameSequence', 'pr_id_val', 'page_restrictions_pr_id_seq' ),
60 array( 'renameSequence', 'us_id_seq', 'uploadstash_us_id_seq' ),
61
62 # since r58263
63 array( 'renameSequence', 'category_id_seq', 'category_cat_id_seq' ),
64
65 # new sequences if not renamed above
66 array( 'addSequence', 'logging', false, 'logging_log_id_seq' ),
67 array( 'addSequence', 'page_restrictions', false, 'page_restrictions_pr_id_seq' ),
68 array( 'addSequence', 'filearchive', 'fa_id', 'filearchive_fa_id_seq' ),
69
70 # new tables
71 array( 'addTable', 'category', 'patch-category.sql' ),
72 array( 'addTable', 'page', 'patch-page.sql' ),
73 array( 'addTable', 'querycachetwo', 'patch-querycachetwo.sql' ),
74 array( 'addTable', 'page_props', 'patch-page_props.sql' ),
75 array( 'addTable', 'page_restrictions', 'patch-page_restrictions.sql' ),
76 array( 'addTable', 'profiling', 'patch-profiling.sql' ),
77 array( 'addTable', 'protected_titles', 'patch-protected_titles.sql' ),
78 array( 'addTable', 'redirect', 'patch-redirect.sql' ),
79 array( 'addTable', 'updatelog', 'patch-updatelog.sql' ),
80 array( 'addTable', 'change_tag', 'patch-change_tag.sql' ),
81 array( 'addTable', 'tag_summary', 'patch-tag_summary.sql' ),
82 array( 'addTable', 'valid_tag', 'patch-valid_tag.sql' ),
83 array( 'addTable', 'user_properties', 'patch-user_properties.sql' ),
84 array( 'addTable', 'log_search', 'patch-log_search.sql' ),
85 array( 'addTable', 'l10n_cache', 'patch-l10n_cache.sql' ),
86 array( 'addTable', 'iwlinks', 'patch-iwlinks.sql' ),
87 array( 'addTable', 'msg_resource', 'patch-msg_resource.sql' ),
88 array( 'addTable', 'msg_resource_links', 'patch-msg_resource_links.sql' ),
89 array( 'addTable', 'module_deps', 'patch-module_deps.sql' ),
90 array( 'addTable', 'uploadstash', 'patch-uploadstash.sql' ),
91 array( 'addTable', 'user_former_groups', 'patch-user_former_groups.sql' ),
92 array( 'addTable', 'sites', 'patch-sites.sql' ),
93
94 # Needed before new field
95 array( 'convertArchive2' ),
96
97 # new fields
98 array( 'addPgField', 'updatelog', 'ul_value', 'TEXT' ),
99 array( 'addPgField', 'archive', 'ar_deleted', 'SMALLINT NOT NULL DEFAULT 0' ),
100 array( 'addPgField', 'archive', 'ar_len', 'INTEGER' ),
101 array( 'addPgField', 'archive', 'ar_page_id', 'INTEGER' ),
102 array( 'addPgField', 'archive', 'ar_parent_id', 'INTEGER' ),
103 array( 'addPgField', 'archive', 'ar_content_model', 'TEXT' ),
104 array( 'addPgField', 'archive', 'ar_content_format', 'TEXT' ),
105 array( 'addPgField', 'categorylinks', 'cl_sortkey_prefix', "TEXT NOT NULL DEFAULT ''" ),
106 array( 'addPgField', 'categorylinks', 'cl_collation', "TEXT NOT NULL DEFAULT 0" ),
107 array( 'addPgField', 'categorylinks', 'cl_type', "TEXT NOT NULL DEFAULT 'page'" ),
108 array( 'addPgField', 'image', 'img_sha1', "TEXT NOT NULL DEFAULT ''" ),
109 array( 'addPgField', 'ipblocks', 'ipb_allow_usertalk', 'SMALLINT NOT NULL DEFAULT 0' ),
110 array( 'addPgField', 'ipblocks', 'ipb_anon_only', 'SMALLINT NOT NULL DEFAULT 0' ),
111 array( 'addPgField', 'ipblocks', 'ipb_by_text', "TEXT NOT NULL DEFAULT ''" ),
112 array( 'addPgField', 'ipblocks', 'ipb_block_email', 'SMALLINT NOT NULL DEFAULT 0' ),
113 array( 'addPgField', 'ipblocks', 'ipb_create_account', 'SMALLINT NOT NULL DEFAULT 1' ),
114 array( 'addPgField', 'ipblocks', 'ipb_deleted', 'SMALLINT NOT NULL DEFAULT 0' ),
115 array( 'addPgField', 'ipblocks', 'ipb_enable_autoblock', 'SMALLINT NOT NULL DEFAULT 1' ),
116 array( 'addPgField', 'ipblocks', 'ipb_parent_block_id',
117 'INTEGER DEFAULT NULL REFERENCES ipblocks(ipb_id) ' .
118 'ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED' ),
119 array( 'addPgField', 'filearchive', 'fa_deleted', 'SMALLINT NOT NULL DEFAULT 0' ),
120 array( 'addPgField', 'filearchive', 'fa_sha1', "TEXT NOT NULL DEFAULT ''" ),
121 array( 'addPgField', 'logging', 'log_deleted', 'SMALLINT NOT NULL DEFAULT 0' ),
122 array( 'addPgField', 'logging', 'log_id',
123 "INTEGER NOT NULL PRIMARY KEY DEFAULT nextval('logging_log_id_seq')" ),
124 array( 'addPgField', 'logging', 'log_params', 'TEXT' ),
125 array( 'addPgField', 'mwuser', 'user_editcount', 'INTEGER' ),
126 array( 'addPgField', 'mwuser', 'user_newpass_time', 'TIMESTAMPTZ' ),
127 array( 'addPgField', 'oldimage', 'oi_deleted', 'SMALLINT NOT NULL DEFAULT 0' ),
128 array( 'addPgField', 'oldimage', 'oi_major_mime', "TEXT NOT NULL DEFAULT 'unknown'" ),
129 array( 'addPgField', 'oldimage', 'oi_media_type', 'TEXT' ),
130 array( 'addPgField', 'oldimage', 'oi_metadata', "BYTEA NOT NULL DEFAULT ''" ),
131 array( 'addPgField', 'oldimage', 'oi_minor_mime', "TEXT NOT NULL DEFAULT 'unknown'" ),
132 array( 'addPgField', 'oldimage', 'oi_sha1', "TEXT NOT NULL DEFAULT ''" ),
133 array( 'addPgField', 'page', 'page_content_model', 'TEXT' ),
134 array( 'addPgField', 'page_restrictions', 'pr_id',
135 "INTEGER NOT NULL UNIQUE DEFAULT nextval('page_restrictions_pr_id_seq')" ),
136 array( 'addPgField', 'profiling', 'pf_memory', 'NUMERIC(18,10) NOT NULL DEFAULT 0' ),
137 array( 'addPgField', 'recentchanges', 'rc_deleted', 'SMALLINT NOT NULL DEFAULT 0' ),
138 array( 'addPgField', 'recentchanges', 'rc_log_action', 'TEXT' ),
139 array( 'addPgField', 'recentchanges', 'rc_log_type', 'TEXT' ),
140 array( 'addPgField', 'recentchanges', 'rc_logid', 'INTEGER NOT NULL DEFAULT 0' ),
141 array( 'addPgField', 'recentchanges', 'rc_new_len', 'INTEGER' ),
142 array( 'addPgField', 'recentchanges', 'rc_old_len', 'INTEGER' ),
143 array( 'addPgField', 'recentchanges', 'rc_params', 'TEXT' ),
144 array( 'addPgField', 'redirect', 'rd_interwiki', 'TEXT NULL' ),
145 array( 'addPgField', 'redirect', 'rd_fragment', 'TEXT NULL' ),
146 array( 'addPgField', 'revision', 'rev_deleted', 'SMALLINT NOT NULL DEFAULT 0' ),
147 array( 'addPgField', 'revision', 'rev_len', 'INTEGER' ),
148 array( 'addPgField', 'revision', 'rev_parent_id', 'INTEGER DEFAULT NULL' ),
149 array( 'addPgField', 'revision', 'rev_content_model', 'TEXT' ),
150 array( 'addPgField', 'revision', 'rev_content_format', 'TEXT' ),
151 array( 'addPgField', 'site_stats', 'ss_active_users', "INTEGER DEFAULT '-1'" ),
152 array( 'addPgField', 'user_newtalk', 'user_last_timestamp', 'TIMESTAMPTZ' ),
153 array( 'addPgField', 'logging', 'log_user_text', "TEXT NOT NULL DEFAULT ''" ),
154 array( 'addPgField', 'logging', 'log_page', 'INTEGER' ),
155 array( 'addPgField', 'interwiki', 'iw_api', "TEXT NOT NULL DEFAULT ''" ),
156 array( 'addPgField', 'interwiki', 'iw_wikiid', "TEXT NOT NULL DEFAULT ''" ),
157 array( 'addPgField', 'revision', 'rev_sha1', "TEXT NOT NULL DEFAULT ''" ),
158 array( 'addPgField', 'archive', 'ar_sha1', "TEXT NOT NULL DEFAULT ''" ),
159 array( 'addPgField', 'uploadstash', 'us_chunk_inx', "INTEGER NULL" ),
160 array( 'addPgField', 'job', 'job_timestamp', "TIMESTAMPTZ" ),
161 array( 'addPgField', 'job', 'job_random', "INTEGER NOT NULL DEFAULT 0" ),
162 array( 'addPgField', 'job', 'job_attempts', "INTEGER NOT NULL DEFAULT 0" ),
163 array( 'addPgField', 'job', 'job_token', "TEXT NOT NULL DEFAULT ''" ),
164 array( 'addPgField', 'job', 'job_token_timestamp', "TIMESTAMPTZ" ),
165 array( 'addPgField', 'job', 'job_sha1', "TEXT NOT NULL DEFAULT ''" ),
166 array( 'addPgField', 'archive', 'ar_id',
167 "INTEGER NOT NULL PRIMARY KEY DEFAULT nextval('archive_ar_id_seq')" ),
168 array( 'addPgField', 'externallinks', 'el_id',
169 "INTEGER NOT NULL PRIMARY KEY DEFAULT nextval('externallinks_el_id_seq')" ),
170
171 # type changes
172 array( 'changeField', 'archive', 'ar_deleted', 'smallint', '' ),
173 array( 'changeField', 'archive', 'ar_minor_edit', 'smallint',
174 'ar_minor_edit::smallint DEFAULT 0' ),
175 array( 'changeField', 'filearchive', 'fa_deleted', 'smallint', '' ),
176 array( 'changeField', 'filearchive', 'fa_height', 'integer', '' ),
177 array( 'changeField', 'filearchive', 'fa_metadata', 'bytea', "decode(fa_metadata,'escape')" ),
178 array( 'changeField', 'filearchive', 'fa_size', 'integer', '' ),
179 array( 'changeField', 'filearchive', 'fa_width', 'integer', '' ),
180 array( 'changeField', 'filearchive', 'fa_storage_group', 'text', '' ),
181 array( 'changeField', 'filearchive', 'fa_storage_key', 'text', '' ),
182 array( 'changeField', 'image', 'img_metadata', 'bytea', "decode(img_metadata,'escape')" ),
183 array( 'changeField', 'image', 'img_size', 'integer', '' ),
184 array( 'changeField', 'image', 'img_width', 'integer', '' ),
185 array( 'changeField', 'image', 'img_height', 'integer', '' ),
186 array( 'changeField', 'interwiki', 'iw_local', 'smallint', 'iw_local::smallint' ),
187 array( 'changeField', 'interwiki', 'iw_trans', 'smallint', 'iw_trans::smallint DEFAULT 0' ),
188 array( 'changeField', 'ipblocks', 'ipb_auto', 'smallint', 'ipb_auto::smallint DEFAULT 0' ),
189 array( 'changeField', 'ipblocks', 'ipb_anon_only', 'smallint',
190 "CASE WHEN ipb_anon_only=' ' THEN 0 ELSE ipb_anon_only::smallint END DEFAULT 0" ),
191 array( 'changeField', 'ipblocks', 'ipb_create_account', 'smallint',
192 "CASE WHEN ipb_create_account=' ' THEN 0 ELSE ipb_create_account::smallint END DEFAULT 1" ),
193 array( 'changeField', 'ipblocks', 'ipb_enable_autoblock', 'smallint',
194 "CASE WHEN ipb_enable_autoblock=' ' THEN 0 ELSE ipb_enable_autoblock::smallint END DEFAULT 1" ),
195 array( 'changeField', 'ipblocks', 'ipb_block_email', 'smallint',
196 "CASE WHEN ipb_block_email=' ' THEN 0 ELSE ipb_block_email::smallint END DEFAULT 0" ),
197 array( 'changeField', 'ipblocks', 'ipb_address', 'text', 'ipb_address::text' ),
198 array( 'changeField', 'ipblocks', 'ipb_deleted', 'smallint', 'ipb_deleted::smallint DEFAULT 0' ),
199 array( 'changeField', 'mwuser', 'user_token', 'text', '' ),
200 array( 'changeField', 'mwuser', 'user_email_token', 'text', '' ),
201 array( 'changeField', 'objectcache', 'keyname', 'text', '' ),
202 array( 'changeField', 'oldimage', 'oi_height', 'integer', '' ),
203 array( 'changeField', 'oldimage', 'oi_metadata', 'bytea', "decode(img_metadata,'escape')" ),
204 array( 'changeField', 'oldimage', 'oi_size', 'integer', '' ),
205 array( 'changeField', 'oldimage', 'oi_width', 'integer', '' ),
206 array( 'changeField', 'page', 'page_is_redirect', 'smallint',
207 'page_is_redirect::smallint DEFAULT 0' ),
208 array( 'changeField', 'page', 'page_is_new', 'smallint', 'page_is_new::smallint DEFAULT 0' ),
209 array( 'changeField', 'querycache', 'qc_value', 'integer', '' ),
210 array( 'changeField', 'querycachetwo', 'qcc_value', 'integer', '' ),
211 array( 'changeField', 'recentchanges', 'rc_bot', 'smallint', 'rc_bot::smallint DEFAULT 0' ),
212 array( 'changeField', 'recentchanges', 'rc_deleted', 'smallint', '' ),
213 array( 'changeField', 'recentchanges', 'rc_minor', 'smallint', 'rc_minor::smallint DEFAULT 0' ),
214 array( 'changeField', 'recentchanges', 'rc_new', 'smallint', 'rc_new::smallint DEFAULT 0' ),
215 array( 'changeField', 'recentchanges', 'rc_type', 'smallint', 'rc_type::smallint DEFAULT 0' ),
216 array( 'changeField', 'recentchanges', 'rc_patrolled', 'smallint',
217 'rc_patrolled::smallint DEFAULT 0' ),
218 array( 'changeField', 'revision', 'rev_deleted', 'smallint', 'rev_deleted::smallint DEFAULT 0' ),
219 array( 'changeField', 'revision', 'rev_minor_edit', 'smallint',
220 'rev_minor_edit::smallint DEFAULT 0' ),
221 array( 'changeField', 'templatelinks', 'tl_namespace', 'smallint', 'tl_namespace::smallint' ),
222 array( 'changeField', 'user_newtalk', 'user_ip', 'text', 'host(user_ip)' ),
223 array( 'changeField', 'uploadstash', 'us_image_bits', 'smallint', '' ),
224 array( 'changeField', 'profiling', 'pf_time', 'float', '' ),
225 array( 'changeField', 'profiling', 'pf_memory', 'float', '' ),
226
227 # null changes
228 array( 'changeNullableField', 'oldimage', 'oi_bits', 'NULL' ),
229 array( 'changeNullableField', 'oldimage', 'oi_timestamp', 'NULL' ),
230 array( 'changeNullableField', 'oldimage', 'oi_major_mime', 'NULL' ),
231 array( 'changeNullableField', 'oldimage', 'oi_minor_mime', 'NULL' ),
232 array( 'changeNullableField', 'image', 'img_metadata', 'NOT NULL' ),
233 array( 'changeNullableField', 'filearchive', 'fa_metadata', 'NOT NULL' ),
234 array( 'changeNullableField', 'recentchanges', 'rc_cur_id', 'NULL' ),
235
236 array( 'checkOiDeleted' ),
237
238 # New indexes
239 array( 'addPgIndex', 'archive', 'archive_user_text', '(ar_user_text)' ),
240 array( 'addPgIndex', 'image', 'img_sha1', '(img_sha1)' ),
241 array( 'addPgIndex', 'ipblocks', 'ipb_parent_block_id', '(ipb_parent_block_id)' ),
242 array( 'addPgIndex', 'oldimage', 'oi_sha1', '(oi_sha1)' ),
243 array( 'addPgIndex', 'page', 'page_mediawiki_title', '(page_title) WHERE page_namespace = 8' ),
244 array( 'addPgIndex', 'pagelinks', 'pagelinks_title', '(pl_title)' ),
245 array( 'addPgIndex', 'page_props', 'pp_propname_page', '(pp_propname, pp_page)' ),
246 array( 'addPgIndex', 'revision', 'rev_text_id_idx', '(rev_text_id)' ),
247 array( 'addPgIndex', 'recentchanges', 'rc_timestamp_bot', '(rc_timestamp) WHERE rc_bot = 0' ),
248 array( 'addPgIndex', 'templatelinks', 'templatelinks_from', '(tl_from)' ),
249 array( 'addPgIndex', 'watchlist', 'wl_user', '(wl_user)' ),
250 array( 'addPgIndex', 'logging', 'logging_user_type_time',
251 '(log_user, log_type, log_timestamp)' ),
252 array( 'addPgIndex', 'logging', 'logging_page_id_time', '(log_page,log_timestamp)' ),
253 array( 'addPgIndex', 'iwlinks', 'iwl_prefix_from_title', '(iwl_prefix, iwl_from, iwl_title)' ),
254 array( 'addPgIndex', 'iwlinks', 'iwl_prefix_title_from', '(iwl_prefix, iwl_title, iwl_from)' ),
255 array( 'addPgIndex', 'job', 'job_timestamp_idx', '(job_timestamp)' ),
256 array( 'addPgIndex', 'job', 'job_sha1', '(job_sha1)' ),
257 array( 'addPgIndex', 'job', 'job_cmd_token', '(job_cmd, job_token, job_random)' ),
258 array( 'addPgIndex', 'job', 'job_cmd_token_id', '(job_cmd, job_token, job_id)' ),
259 array( 'addPgIndex', 'filearchive', 'fa_sha1', '(fa_sha1)' ),
260
261 array( 'checkIndex', 'pagelink_unique', array(
262 array( 'pl_from', 'int4_ops', 'btree', 0 ),
263 array( 'pl_namespace', 'int2_ops', 'btree', 0 ),
264 array( 'pl_title', 'text_ops', 'btree', 0 ),
265 ),
266 'CREATE UNIQUE INDEX pagelink_unique ON pagelinks (pl_from,pl_namespace,pl_title)' ),
267 array( 'checkIndex', 'cl_sortkey', array(
268 array( 'cl_to', 'text_ops', 'btree', 0 ),
269 array( 'cl_sortkey', 'text_ops', 'btree', 0 ),
270 array( 'cl_from', 'int4_ops', 'btree', 0 ),
271 ),
272 'CREATE INDEX cl_sortkey ON "categorylinks" ' .
273 'USING "btree" ("cl_to", "cl_sortkey", "cl_from")' ),
274 array( 'checkIndex', 'iwl_prefix_title_from', array(
275 array( 'iwl_prefix', 'text_ops', 'btree', 0 ),
276 array( 'iwl_title', 'text_ops', 'btree', 0 ),
277 array( 'iwl_from', 'int4_ops', 'btree', 0 ),
278 ),
279 'CREATE INDEX iwl_prefix_title_from ON "iwlinks" ' .
280 'USING "btree" ("iwl_prefix", "iwl_title", "iwl_from")' ),
281 array( 'checkIndex', 'logging_times', array(
282 array( 'log_timestamp', 'timestamptz_ops', 'btree', 0 ),
283 ),
284 'CREATE INDEX "logging_times" ON "logging" USING "btree" ("log_timestamp")' ),
285 array( 'dropIndex', 'oldimage', 'oi_name' ),
286 array( 'checkIndex', 'oi_name_archive_name', array(
287 array( 'oi_name', 'text_ops', 'btree', 0 ),
288 array( 'oi_archive_name', 'text_ops', 'btree', 0 ),
289 ),
290 'CREATE INDEX "oi_name_archive_name" ON "oldimage" ' .
291 'USING "btree" ("oi_name", "oi_archive_name")' ),
292 array( 'checkIndex', 'oi_name_timestamp', array(
293 array( 'oi_name', 'text_ops', 'btree', 0 ),
294 array( 'oi_timestamp', 'timestamptz_ops', 'btree', 0 ),
295 ),
296 'CREATE INDEX "oi_name_timestamp" ON "oldimage" ' .
297 'USING "btree" ("oi_name", "oi_timestamp")' ),
298 array( 'checkIndex', 'page_main_title', array(
299 array( 'page_title', 'text_pattern_ops', 'btree', 0 ),
300 ),
301 'CREATE INDEX "page_main_title" ON "page" ' .
302 'USING "btree" ("page_title" "text_pattern_ops") WHERE ("page_namespace" = 0)' ),
303 array( 'checkIndex', 'page_mediawiki_title', array(
304 array( 'page_title', 'text_pattern_ops', 'btree', 0 ),
305 ),
306 'CREATE INDEX "page_mediawiki_title" ON "page" ' .
307 'USING "btree" ("page_title" "text_pattern_ops") WHERE ("page_namespace" = 8)' ),
308 array( 'checkIndex', 'page_project_title', array(
309 array( 'page_title', 'text_pattern_ops', 'btree', 0 ),
310 ),
311 'CREATE INDEX "page_project_title" ON "page" ' .
312 'USING "btree" ("page_title" "text_pattern_ops") ' .
313 'WHERE ("page_namespace" = 4)' ),
314 array( 'checkIndex', 'page_talk_title', array(
315 array( 'page_title', 'text_pattern_ops', 'btree', 0 ),
316 ),
317 'CREATE INDEX "page_talk_title" ON "page" ' .
318 'USING "btree" ("page_title" "text_pattern_ops") ' .
319 'WHERE ("page_namespace" = 1)' ),
320 array( 'checkIndex', 'page_user_title', array(
321 array( 'page_title', 'text_pattern_ops', 'btree', 0 ),
322 ),
323 'CREATE INDEX "page_user_title" ON "page" ' .
324 'USING "btree" ("page_title" "text_pattern_ops") WHERE ' .
325 '("page_namespace" = 2)' ),
326 array( 'checkIndex', 'page_utalk_title', array(
327 array( 'page_title', 'text_pattern_ops', 'btree', 0 ),
328 ),
329 'CREATE INDEX "page_utalk_title" ON "page" ' .
330 'USING "btree" ("page_title" "text_pattern_ops") ' .
331 'WHERE ("page_namespace" = 3)' ),
332 array( 'checkIndex', 'ts2_page_text', array(
333 array( 'textvector', 'tsvector_ops', 'gist', 0 ),
334 ),
335 'CREATE INDEX "ts2_page_text" ON "pagecontent" USING "gist" ("textvector")' ),
336 array( 'checkIndex', 'ts2_page_title', array(
337 array( 'titlevector', 'tsvector_ops', 'gist', 0 ),
338 ),
339 'CREATE INDEX "ts2_page_title" ON "page" USING "gist" ("titlevector")' ),
340
341 array( 'checkOiNameConstraint' ),
342 array( 'checkPageDeletedTrigger' ),
343 array( 'checkRevUserFkey' ),
344 array( 'dropIndex', 'ipblocks', 'ipb_address' ),
345 array( 'checkIndex', 'ipb_address_unique', array(
346 array( 'ipb_address', 'text_ops', 'btree', 0 ),
347 array( 'ipb_user', 'int4_ops', 'btree', 0 ),
348 array( 'ipb_auto', 'int2_ops', 'btree', 0 ),
349 array( 'ipb_anon_only', 'int2_ops', 'btree', 0 ),
350 ),
351 'CREATE UNIQUE INDEX ipb_address_unique ' .
352 'ON ipblocks (ipb_address,ipb_user,ipb_auto,ipb_anon_only)' ),
353
354 array( 'checkIwlPrefix' ),
355
356 # All FK columns should be deferred
357 array( 'changeFkeyDeferrable', 'archive', 'ar_user', 'mwuser(user_id) ON DELETE SET NULL' ),
358 array( 'changeFkeyDeferrable', 'categorylinks', 'cl_from', 'page(page_id) ON DELETE CASCADE' ),
359 array( 'changeFkeyDeferrable', 'externallinks', 'el_from', 'page(page_id) ON DELETE CASCADE' ),
360 array( 'changeFkeyDeferrable', 'filearchive', 'fa_deleted_user',
361 'mwuser(user_id) ON DELETE SET NULL' ),
362 array( 'changeFkeyDeferrable', 'filearchive', 'fa_user', 'mwuser(user_id) ON DELETE SET NULL' ),
363 array( 'changeFkeyDeferrable', 'image', 'img_user', 'mwuser(user_id) ON DELETE SET NULL' ),
364 array( 'changeFkeyDeferrable', 'imagelinks', 'il_from', 'page(page_id) ON DELETE CASCADE' ),
365 array( 'changeFkeyDeferrable', 'ipblocks', 'ipb_by', 'mwuser(user_id) ON DELETE CASCADE' ),
366 array( 'changeFkeyDeferrable', 'ipblocks', 'ipb_user', 'mwuser(user_id) ON DELETE SET NULL' ),
367 array( 'changeFkeyDeferrable', 'ipblocks', 'ipb_parent_block_id',
368 'ipblocks(ipb_id) ON DELETE SET NULL' ),
369 array( 'changeFkeyDeferrable', 'langlinks', 'll_from', 'page(page_id) ON DELETE CASCADE' ),
370 array( 'changeFkeyDeferrable', 'logging', 'log_user', 'mwuser(user_id) ON DELETE SET NULL' ),
371 array( 'changeFkeyDeferrable', 'oldimage', 'oi_name',
372 'image(img_name) ON DELETE CASCADE ON UPDATE CASCADE' ),
373 array( 'changeFkeyDeferrable', 'oldimage', 'oi_user', 'mwuser(user_id) ON DELETE SET NULL' ),
374 array( 'changeFkeyDeferrable', 'pagelinks', 'pl_from', 'page(page_id) ON DELETE CASCADE' ),
375 array( 'changeFkeyDeferrable', 'page_props', 'pp_page', 'page (page_id) ON DELETE CASCADE' ),
376 array( 'changeFkeyDeferrable', 'page_restrictions', 'pr_page',
377 'page(page_id) ON DELETE CASCADE' ),
378 array( 'changeFkeyDeferrable', 'protected_titles', 'pt_user',
379 'mwuser(user_id) ON DELETE SET NULL' ),
380 array( 'changeFkeyDeferrable', 'recentchanges', 'rc_cur_id',
381 'page(page_id) ON DELETE SET NULL' ),
382 array( 'changeFkeyDeferrable', 'recentchanges', 'rc_user',
383 'mwuser(user_id) ON DELETE SET NULL' ),
384 array( 'changeFkeyDeferrable', 'redirect', 'rd_from', 'page(page_id) ON DELETE CASCADE' ),
385 array( 'changeFkeyDeferrable', 'revision', 'rev_page', 'page (page_id) ON DELETE CASCADE' ),
386 array( 'changeFkeyDeferrable', 'revision', 'rev_user', 'mwuser(user_id) ON DELETE RESTRICT' ),
387 array( 'changeFkeyDeferrable', 'templatelinks', 'tl_from', 'page(page_id) ON DELETE CASCADE' ),
388 array( 'changeFkeyDeferrable', 'user_groups', 'ug_user', 'mwuser(user_id) ON DELETE CASCADE' ),
389 array( 'changeFkeyDeferrable', 'user_newtalk', 'user_id', 'mwuser(user_id) ON DELETE CASCADE' ),
390 array( 'changeFkeyDeferrable', 'user_properties', 'up_user',
391 'mwuser(user_id) ON DELETE CASCADE' ),
392 array( 'changeFkeyDeferrable', 'watchlist', 'wl_user', 'mwuser(user_id) ON DELETE CASCADE' ),
393
394 # r81574
395 array( 'addInterwikiType' ),
396 # end
397 array( 'tsearchFixes' ),
398
399 // 1.22
400 array( 'addPgField', 'recentchanges', 'rc_source', "TEXT NOT NULL DEFAULT ''" ),
401 );
402 }
403
404 protected function getOldGlobalUpdates() {
405 global $wgExtNewTables, $wgExtPGNewFields, $wgExtPGAlteredFields, $wgExtNewIndexes;
406
407 $updates = array();
408
409 # Add missing extension tables
410 foreach ( $wgExtNewTables as $tableRecord ) {
411 $updates[] = array(
412 'addTable', $tableRecord[0], $tableRecord[1], true
413 );
414 }
415
416 # Add missing extension fields
417 foreach ( $wgExtPGNewFields as $fieldRecord ) {
418 $updates[] = array(
419 'addPgField', $fieldRecord[0], $fieldRecord[1],
420 $fieldRecord[2]
421 );
422 }
423
424 # Change altered columns
425 foreach ( $wgExtPGAlteredFields as $fieldRecord ) {
426 $updates[] = array(
427 'changeField', $fieldRecord[0], $fieldRecord[1],
428 $fieldRecord[2]
429 );
430 }
431
432 # Add missing extension indexes
433 foreach ( $wgExtNewIndexes as $fieldRecord ) {
434 $updates[] = array(
435 'addPgExtIndex', $fieldRecord[0], $fieldRecord[1],
436 $fieldRecord[2]
437 );
438 }
439
440 return $updates;
441 }
442
443 protected function describeTable( $table ) {
444 $q = <<<END
445 SELECT attname, attnum FROM pg_namespace, pg_class, pg_attribute
446 WHERE pg_class.relnamespace = pg_namespace.oid
447 AND attrelid=pg_class.oid AND attnum > 0
448 AND relname=%s AND nspname=%s
449 END;
450 $res = $this->db->query( sprintf( $q,
451 $this->db->addQuotes( $table ),
452 $this->db->addQuotes( $this->db->getCoreSchema() ) ) );
453 if ( !$res ) {
454 return null;
455 }
456
457 $cols = array();
458 foreach ( $res as $r ) {
459 $cols[] = array(
460 "name" => $r[0],
461 "ord" => $r[1],
462 );
463 }
464
465 return $cols;
466 }
467
468 function describeIndex( $idx ) {
469 // first fetch the key (which is a list of columns ords) and
470 // the table the index applies to (an oid)
471 $q = <<<END
472 SELECT indkey, indrelid FROM pg_namespace, pg_class, pg_index
473 WHERE nspname=%s
474 AND pg_class.relnamespace = pg_namespace.oid
475 AND relname=%s
476 AND indexrelid=pg_class.oid
477 END;
478 $res = $this->db->query(
479 sprintf(
480 $q,
481 $this->db->addQuotes( $this->db->getCoreSchema() ),
482 $this->db->addQuotes( $idx )
483 )
484 );
485 if ( !$res ) {
486 return null;
487 }
488 if ( !( $r = $this->db->fetchRow( $res ) ) ) {
489 return null;
490 }
491
492 $indkey = $r[0];
493 $relid = intval( $r[1] );
494 $indkeys = explode( ' ', $indkey );
495
496 $colnames = array();
497 foreach ( $indkeys as $rid ) {
498 $query = <<<END
499 SELECT attname FROM pg_class, pg_attribute
500 WHERE attrelid=$relid
501 AND attnum=%d
502 AND attrelid=pg_class.oid
503 END;
504 $r2 = $this->db->query( sprintf( $query, $rid ) );
505 if ( !$r2 ) {
506 return null;
507 }
508 if ( !( $row2 = $this->db->fetchRow( $r2 ) ) ) {
509 return null;
510 }
511 $colnames[] = $row2[0];
512 }
513
514 return $colnames;
515 }
516
517 function fkeyDeltype( $fkey ) {
518 $q = <<<END
519 SELECT confdeltype FROM pg_constraint, pg_namespace
520 WHERE connamespace=pg_namespace.oid
521 AND nspname=%s
522 AND conname=%s;
523 END;
524 $r = $this->db->query(
525 sprintf(
526 $q,
527 $this->db->addQuotes( $this->db->getCoreSchema() ),
528 $this->db->addQuotes( $fkey )
529 )
530 );
531 if ( !( $row = $this->db->fetchRow( $r ) ) ) {
532 return null;
533 }
534
535 return $row[0];
536 }
537
538 function ruleDef( $table, $rule ) {
539 $q = <<<END
540 SELECT definition FROM pg_rules
541 WHERE schemaname = %s
542 AND tablename = %s
543 AND rulename = %s
544 END;
545 $r = $this->db->query(
546 sprintf(
547 $q,
548 $this->db->addQuotes( $this->db->getCoreSchema() ),
549 $this->db->addQuotes( $table ),
550 $this->db->addQuotes( $rule )
551 )
552 );
553 $row = $this->db->fetchRow( $r );
554 if ( !$row ) {
555 return null;
556 }
557 $d = $row[0];
558
559 return $d;
560 }
561
562 protected function addSequence( $table, $pkey, $ns ) {
563 if ( !$this->db->sequenceExists( $ns ) ) {
564 $this->output( "Creating sequence $ns\n" );
565 $this->db->query( "CREATE SEQUENCE $ns" );
566 if ( $pkey !== false ) {
567 $this->setDefault( $table, $pkey, '"nextval"(\'"' . $ns . '"\'::"regclass")' );
568 }
569 }
570 }
571
572 protected function renameSequence( $old, $new ) {
573 if ( $this->db->sequenceExists( $new ) ) {
574 $this->output( "...sequence $new already exists.\n" );
575
576 return;
577 }
578 if ( $this->db->sequenceExists( $old ) ) {
579 $this->output( "Renaming sequence $old to $new\n" );
580 $this->db->query( "ALTER SEQUENCE $old RENAME TO $new" );
581 }
582 }
583
584 protected function renameTable( $old, $new, $patch = false ) {
585 if ( $this->db->tableExists( $old ) ) {
586 $this->output( "Renaming table $old to $new\n" );
587 $old = $this->db->realTableName( $old, "quoted" );
588 $new = $this->db->realTableName( $new, "quoted" );
589 $this->db->query( "ALTER TABLE $old RENAME TO $new" );
590 if ( $patch !== false ) {
591 $this->applyPatch( $patch );
592 }
593 }
594 }
595
596 protected function renameIndex(
597 $table, $old, $new, $skipBothIndexExistWarning = false, $a = false, $b = false
598 ) {
599 // First requirement: the table must exist
600 if ( !$this->db->tableExists( $table, __METHOD__ ) ) {
601 $this->output( "...skipping: '$table' table doesn't exist yet.\n" );
602
603 return;
604 }
605
606 // Second requirement: the new index must be missing
607 if ( $this->db->indexExists( $table, $new, __METHOD__ ) ) {
608 $this->output( "...index $new already set on $table table.\n" );
609 if ( !$skipBothIndexExistWarning
610 && $this->db->indexExists( $table, $old, __METHOD__ )
611 ) {
612 $this->output( "...WARNING: $old still exists, despite it has been " .
613 "renamed into $new (which also exists).\n" .
614 " $old should be manually removed if not needed anymore.\n" );
615 }
616
617 return;
618 }
619
620 // Third requirement: the old index must exist
621 if ( !$this->db->indexExists( $table, $old, __METHOD__ ) ) {
622 $this->output( "...skipping: index $old doesn't exist.\n" );
623
624 return;
625 }
626
627 $this->db->query( "ALTER INDEX $old RENAME TO $new" );
628 }
629
630 protected function addPgField( $table, $field, $type ) {
631 $fi = $this->db->fieldInfo( $table, $field );
632 if ( !is_null( $fi ) ) {
633 $this->output( "...column '$table.$field' already exists\n" );
634
635 return;
636 } else {
637 $this->output( "Adding column '$table.$field'\n" );
638 $this->db->query( "ALTER TABLE $table ADD $field $type" );
639 }
640 }
641
642 protected function changeField( $table, $field, $newtype, $default ) {
643 $fi = $this->db->fieldInfo( $table, $field );
644 if ( is_null( $fi ) ) {
645 $this->output( "...ERROR: expected column $table.$field to exist\n" );
646 exit( 1 );
647 }
648
649 if ( $fi->type() === $newtype ) {
650 $this->output( "...column '$table.$field' is already of type '$newtype'\n" );
651 } else {
652 $this->output( "Changing column type of '$table.$field' from '{$fi->type()}' to '$newtype'\n" );
653 $sql = "ALTER TABLE $table ALTER $field TYPE $newtype";
654 if ( strlen( $default ) ) {
655 $res = array();
656 if ( preg_match( '/DEFAULT (.+)/', $default, $res ) ) {
657 $sqldef = "ALTER TABLE $table ALTER $field SET DEFAULT $res[1]";
658 $this->db->query( $sqldef );
659 $default = preg_replace( '/\s*DEFAULT .+/', '', $default );
660 }
661 $sql .= " USING $default";
662 }
663 $this->db->query( $sql );
664 }
665 }
666
667 protected function setDefault( $table, $field, $default ) {
668
669 $info = $this->db->fieldInfo( $table, $field );
670 if ( $info->defaultValue() !== $default ) {
671 $this->output( "Changing '$table.$field' default value\n" );
672 $this->db->query( "ALTER TABLE $table ALTER $field SET DEFAULT " . $default );
673 }
674 }
675
676 protected function changeNullableField( $table, $field, $null ) {
677 $fi = $this->db->fieldInfo( $table, $field );
678 if ( is_null( $fi ) ) {
679 $this->output( "...ERROR: expected column $table.$field to exist\n" );
680 exit( 1 );
681 }
682 if ( $fi->isNullable() ) {
683 # # It's NULL - does it need to be NOT NULL?
684 if ( 'NOT NULL' === $null ) {
685 $this->output( "Changing '$table.$field' to not allow NULLs\n" );
686 $this->db->query( "ALTER TABLE $table ALTER $field SET NOT NULL" );
687 } else {
688 $this->output( "...column '$table.$field' is already set as NULL\n" );
689 }
690 } else {
691 # # It's NOT NULL - does it need to be NULL?
692 if ( 'NULL' === $null ) {
693 $this->output( "Changing '$table.$field' to allow NULLs\n" );
694 $this->db->query( "ALTER TABLE $table ALTER $field DROP NOT NULL" );
695 } else {
696 $this->output( "...column '$table.$field' is already set as NOT NULL\n" );
697 }
698 }
699 }
700
701 public function addPgIndex( $table, $index, $type ) {
702 if ( $this->db->indexExists( $table, $index ) ) {
703 $this->output( "...index '$index' on table '$table' already exists\n" );
704 } else {
705 $this->output( "Creating index '$index' on table '$table' $type\n" );
706 $this->db->query( "CREATE INDEX $index ON $table $type" );
707 }
708 }
709
710 public function addPgExtIndex( $table, $index, $type ) {
711 if ( $this->db->indexExists( $table, $index ) ) {
712 $this->output( "...index '$index' on table '$table' already exists\n" );
713 } else {
714 if ( preg_match( '/^\(/', $type ) ) {
715 $this->output( "Creating index '$index' on table '$table'\n" );
716 $this->db->query( "CREATE INDEX $index ON $table $type" );
717 } else {
718 $this->applyPatch( $type, true, "Creating index '$index' on table '$table'" );
719 }
720 }
721 }
722
723 protected function changeFkeyDeferrable( $table, $field, $clause ) {
724 $fi = $this->db->fieldInfo( $table, $field );
725 if ( is_null( $fi ) ) {
726 $this->output( "WARNING! Column '$table.$field' does not exist but it should! " .
727 "Please report this.\n" );
728
729 return;
730 }
731 if ( $fi->is_deferred() && $fi->is_deferrable() ) {
732 return;
733 }
734 $this->output( "Altering column '$table.$field' to be DEFERRABLE INITIALLY DEFERRED\n" );
735 $conname = $fi->conname();
736 if ( $fi->conname() ) {
737 $conclause = "CONSTRAINT \"$conname\"";
738 $command = "ALTER TABLE $table DROP CONSTRAINT $conname";
739 $this->db->query( $command );
740 } else {
741 $this->output( "Column '$table.$field' does not have a foreign key " .
742 "constraint, will be added\n" );
743 $conclause = "";
744 }
745 $command =
746 "ALTER TABLE $table ADD $conclause " .
747 "FOREIGN KEY ($field) REFERENCES $clause DEFERRABLE INITIALLY DEFERRED";
748 $this->db->query( $command );
749 }
750
751 protected function convertArchive2() {
752 if ( $this->db->tableExists( "archive2" ) ) {
753 if ( $this->db->ruleExists( 'archive', 'archive_insert' ) ) {
754 $this->output( "Dropping rule 'archive_insert'\n" );
755 $this->db->query( 'DROP RULE archive_insert ON archive' );
756 }
757 if ( $this->db->ruleExists( 'archive', 'archive_delete' ) ) {
758 $this->output( "Dropping rule 'archive_delete'\n" );
759 $this->db->query( 'DROP RULE archive_delete ON archive' );
760 }
761 $this->applyPatch(
762 'patch-remove-archive2.sql',
763 false,
764 "Converting 'archive2' back to normal archive table"
765 );
766 } else {
767 $this->output( "...obsolete table 'archive2' does not exist\n" );
768 }
769 }
770
771 protected function checkOiDeleted() {
772 if ( $this->db->fieldInfo( 'oldimage', 'oi_deleted' )->type() !== 'smallint' ) {
773 $this->output( "Changing 'oldimage.oi_deleted' to type 'smallint'\n" );
774 $this->db->query( "ALTER TABLE oldimage ALTER oi_deleted DROP DEFAULT" );
775 $this->db->query(
776 "ALTER TABLE oldimage ALTER oi_deleted TYPE SMALLINT USING (oi_deleted::smallint)" );
777 $this->db->query( "ALTER TABLE oldimage ALTER oi_deleted SET DEFAULT 0" );
778 } else {
779 $this->output( "...column 'oldimage.oi_deleted' is already of type 'smallint'\n" );
780 }
781 }
782
783 protected function checkOiNameConstraint() {
784 if ( $this->db->hasConstraint( "oldimage_oi_name_fkey_cascaded" ) ) {
785 $this->output( "...table 'oldimage' has correct cascading delete/update " .
786 "foreign key to image\n" );
787 } else {
788 if ( $this->db->hasConstraint( "oldimage_oi_name_fkey" ) ) {
789 $this->db->query(
790 "ALTER TABLE oldimage DROP CONSTRAINT oldimage_oi_name_fkey" );
791 }
792 if ( $this->db->hasConstraint( "oldimage_oi_name_fkey_cascade" ) ) {
793 $this->db->query(
794 "ALTER TABLE oldimage DROP CONSTRAINT oldimage_oi_name_fkey_cascade" );
795 }
796 $this->output( "Making foreign key on table 'oldimage' (to image) a cascade delete/update\n" );
797 $this->db->query(
798 "ALTER TABLE oldimage ADD CONSTRAINT oldimage_oi_name_fkey_cascaded " .
799 "FOREIGN KEY (oi_name) REFERENCES image(img_name) " .
800 "ON DELETE CASCADE ON UPDATE CASCADE" );
801 }
802 }
803
804 protected function checkPageDeletedTrigger() {
805 if ( !$this->db->triggerExists( 'page', 'page_deleted' ) ) {
806 $this->applyPatch(
807 'patch-page_deleted.sql',
808 false,
809 "Adding function and trigger 'page_deleted' to table 'page'"
810 );
811 } else {
812 $this->output( "...table 'page' has 'page_deleted' trigger\n" );
813 }
814 }
815
816 protected function dropIndex( $table, $index, $patch = '', $fullpath = false ) {
817 if ( $this->db->indexExists( $table, $index ) ) {
818 $this->output( "Dropping obsolete index '$index'\n" );
819 $this->db->query( "DROP INDEX \"" . $index . "\"" );
820 }
821 }
822
823 protected function checkIndex( $index, $should_be, $good_def ) {
824 $pu = $this->db->indexAttributes( $index );
825 if ( !empty( $pu ) && $pu != $should_be ) {
826 $this->output( "Dropping obsolete version of index '$index'\n" );
827 $this->db->query( "DROP INDEX \"" . $index . "\"" );
828 $pu = array();
829 } else {
830 $this->output( "...no need to drop index '$index'\n" );
831 }
832
833 if ( empty( $pu ) ) {
834 $this->output( "Creating index '$index'\n" );
835 $this->db->query( $good_def );
836 } else {
837 $this->output( "...index '$index' exists\n" );
838 }
839 }
840
841 protected function checkRevUserFkey() {
842 if ( $this->fkeyDeltype( 'revision_rev_user_fkey' ) == 'r' ) {
843 $this->output( "...constraint 'revision_rev_user_fkey' is ON DELETE RESTRICT\n" );
844 } else {
845 $this->applyPatch(
846 'patch-revision_rev_user_fkey.sql',
847 false,
848 "Changing constraint 'revision_rev_user_fkey' to ON DELETE RESTRICT"
849 );
850 }
851 }
852
853 protected function checkIwlPrefix() {
854 if ( $this->db->indexExists( 'iwlinks', 'iwl_prefix' ) ) {
855 $this->applyPatch(
856 'patch-rename-iwl_prefix.sql',
857 false,
858 "Replacing index 'iwl_prefix' with 'iwl_prefix_title_from'"
859 );
860 }
861 }
862
863 protected function addInterwikiType() {
864 $this->applyPatch( 'patch-add_interwiki.sql', false, "Refreshing add_interwiki()" );
865 }
866
867 protected function tsearchFixes() {
868 # Tweak the page_title tsearch2 trigger to filter out slashes
869 # This is create or replace, so harmless to call if not needed
870 $this->applyPatch( 'patch-ts2pagetitle.sql', false, "Refreshing ts2_page_title()" );
871
872 # If the server is 8.3 or higher, rewrite the tsearch2 triggers
873 # in case they have the old 'default' versions
874 # Gather version numbers in case we need them
875 if ( $this->db->getServerVersion() >= 8.3 ) {
876 $this->applyPatch( 'patch-tsearch2funcs.sql', false, "Rewriting tsearch2 triggers" );
877 }
878 }
879 }