Handle empty sets correctly
[mediawiki.git] / maintenance / updaters.inc
blob1b434439abafb53b95eabe9ffbf360e0574ff7b8
1 <?php
2 /**
3  * @addtogroup Maintenance
4  */
6  /** */
8 if ( !defined( 'MEDIAWIKI' ) ) {
9         echo "This file is not a valid entry point\n";
10         exit( 1 );
13 require_once 'convertLinks.inc';
14 require_once 'userDupes.inc';
15 require_once 'deleteDefaultMessages.php';
16 # Extension updates
17 require_once( "$IP/includes/Hooks.php" );
19 /**
20  * List of update functions to call on a MySQL-based MediaWiki installation,
21  * in sequence. First item is function name, rest are parameters to pass.
22  */
23 $wgMysqlUpdates = array(
24         // 1.2
25         // update_passwords obsolete
26         array( 'add_field', 'ipblocks',      'ipb_id',           'patch-ipblocks.sql' ),
27         array( 'add_field', 'ipblocks',      'ipb_expiry',       'patch-ipb_expiry.sql' ),
28         array( 'do_interwiki_update' ),
29         array( 'do_index_update' ),
30         // do_linkscc_update obsolete
31         array( 'add_table', 'hitcounter',                        'patch-hitcounter.sql' ),
32         array( 'add_field', 'recentchanges', 'rc_type',          'patch-rc_type.sql' ),
33         
34         // 1.3
35         array( 'add_field', 'user',          'user_real_name',   'patch-user-realname.sql' ),
36         array( 'add_table', 'querycache',                        'patch-querycache.sql' ),
37         array( 'add_table', 'objectcache',                       'patch-objectcache.sql' ),
38         array( 'add_table', 'categorylinks',                     'patch-categorylinks.sql' ),
39         // do_linkscc_1_3_update obsolete
40         array( 'do_old_links_update' ),
41         array( 'add_field', 'recentchanges', 'rc_ip',            'patch-rc_ip.sql' ),
42         
43         // 1.4
44         array( 'do_image_name_unique_update' ),
45         array( 'add_field', 'recentchanges', 'rc_id',            'patch-rc_id.sql' ),
46         array( 'add_field', 'recentchanges', 'rc_patrolled',     'patch-rc-patrol.sql' ),
47         array( 'add_table', 'logging',                           'patch-logging.sql' ),
48         // do_user_rights_update obsolete
49         array( 'add_field', 'user',          'user_token',       'patch-user_token.sql' ),
50         // old, old_articleid, patch-remove-old-title-namespace.sql obsolete
51         // user_groups, patch-userlevels.sql obsolete
52         // do_group_update() obsolete
53         array( 'do_watchlist_update' ),
54         array( 'do_user_update' ),
55         // do_copy_newtalk_to_watchlist obsolete
56         
57         // 1.5
58         array( 'do_schema_restructuring' ),
59         array( 'add_field', 'logging',       'log_params',       'patch-log_params.sql' ),
60         array( 'do_logging_encoding' ),
61         array( 'add_field', 'archive',       'ar_rev_id',        'patch-archive-rev_id.sql' ),
62         array( 'add_field', 'page',          'page_len',         'patch-page_len.sql' ),
63         array( 'do_inverse_timestamp' ),
64         array( 'do_text_id' ),
65         array( 'add_field', 'revision',      'rev_deleted',      'patch-rev_deleted.sql' ),
66         array( 'add_field', 'image',         'img_width',        'patch-img_width.sql' ),
67         array( 'add_field', 'image',         'img_metadata',     'patch-img_metadata.sql' ),
68         array( 'add_field', 'user',          'user_email_token', 'patch-user_email_token.sql' ),
69         array( 'add_field', 'archive',       'ar_text_id',       'patch-archive-text_id.sql' ),
70         array( 'do_namespace_size' ),
71         array( 'add_field', 'image',         'img_media_type',   'patch-img_media_type.sql' ),
72         array( 'do_pagelinks_update' ),
73         array( 'do_drop_img_type' ),
74         array( 'do_user_unique_update' ),
75         array( 'do_user_groups_update' ),
76         array( 'add_field', 'site_stats',    'ss_total_pages',   'patch-ss_total_articles.sql' ),
77         array( 'add_table', 'user_newtalk',                      'patch-usernewtalk2.sql' ),
78         array( 'add_table', 'transcache',                        'patch-transcache.sql' ),
79         array( 'add_field', 'interwiki',     'iw_trans',         'patch-interwiki-trans.sql' ),
80         array( 'add_table', 'trackbacks',                        'patch-trackbacks.sql' ),
81         
82         // 1.6
83         array( 'do_watchlist_null' ),
84         // do_image_index_update obsolete
85         array( 'do_logging_timestamp_index' ),
86         array( 'add_field', 'ipblocks',        'ipb_range_start',  'patch-ipb_range_start.sql' ),
87         array( 'do_page_random_update' ),
88         array( 'add_field', 'user',            'user_registration','patch-user_registration.sql' ),
89         array( 'do_templatelinks_update' ),
90         array( 'add_table', 'externallinks',                       'patch-externallinks.sql' ),
91         array( 'add_table', 'job',                                 'patch-job.sql' ),
92         array( 'add_field', 'site_stats',      'ss_images',        'patch-ss_images.sql' ),
93         array( 'add_table', 'langlinks',                           'patch-langlinks.sql' ),
94         array( 'add_table', 'querycache_info',                     'patch-querycacheinfo.sql' ),
95         array( 'add_table', 'filearchive',                         'patch-filearchive.sql' ),
96         array( 'add_field', 'ipblocks',        'ipb_anon_only',    'patch-ipb_anon_only.sql' ),
97         array( 'do_rc_indices_update' ),
98         
99         // 1.9
100         array( 'add_field', 'user',          'user_newpass_time', 'patch-user_newpass_time.sql' ),
101         array( 'add_table', 'redirect',                           'patch-redirect.sql' ),
102         array( 'add_table', 'querycachetwo', 'patch-querycachetwo.sql' ),
103         array( 'add_field', 'ipblocks',      'ipb_enable_autoblock', 'patch-ipb_optional_autoblock.sql' ),
104         array( 'do_backlinking_indices_update' ),
105         array( 'add_field', 'recentchanges', 'rc_old_len',        'patch-rc_len.sql' ),
106         array( 'add_field', 'user',          'user_editcount',    'patch-user_editcount.sql' ),
107         
108         // 1.10
109         array( 'do_restrictions_update' ),
110         array( 'add_field', 'logging',       'log_id',           'patch-log_id.sql' ),
111         array( 'add_field', 'revision',      'rev_parent_id',    'patch-rev_parent_id.sql' ),
112         array( 'add_field', 'page_restrictions', 'pr_id',        'patch-page_restrictions_sortkey.sql' ),
113         array( 'add_field', 'revision',      'rev_len',          'patch-rev_len.sql' ),
114         array( 'add_field', 'recentchanges', 'rc_deleted',       'patch-rc_deleted.sql' ),
115         array( 'add_field', 'logging',       'log_deleted',      'patch-log_deleted.sql' ),
116         array( 'add_field', 'archive',       'ar_deleted',       'patch-ar_deleted.sql' ),
117         array( 'add_field', 'ipblocks',      'ipb_deleted',      'patch-ipb_deleted.sql' ),
118         array( 'add_field', 'filearchive',   'fa_deleted',       'patch-fa_deleted.sql' ),
119         array( 'add_field', 'archive',       'ar_len',           'patch-ar_len.sql' ),
120         
121         // 1.11
122         array( 'add_field', 'ipblocks',      'ipb_block_email',  'patch-ipb_emailban.sql' ),
123         array( 'do_categorylinks_indices_update' ),
124         array( 'add_field', 'oldimage',      'oi_metadata',      'patch-oi_metadata.sql'),
125         array( 'do_archive_user_index' ),
126         array( 'do_image_user_index' ),
127         array( 'do_oldimage_user_index' ),
128         array( 'add_field', 'archive',       'ar_page_id',       'patch-archive-page_id.sql'),
129         array( 'add_field', 'image',         'img_sha1',         'patch-img_sha1.sql' ),
130         array( 'add_table', 'protected_titles',                  'patch-protected_titles.sql' ),
131         
132         // 1.13
133         array( 'add_field', 'ipblocks',      'ipb_by_text',      'patch-ipb_by_text.sql' ),
134         array( 'add_table', 'page_props',                        'patch-page_props.sql' ),
135         array( 'add_table', 'updatelog',                         'patch-updatelog.sql' ),
136         array( 'add_table', 'category',                          'patch-category.sql' ),
137         array( 'do_category_population' ),
141 # For extensions only, should be populated via hooks
142 # $wgDBtype should be checked to specifiy the proper file
143 $wgExtNewTables = array(); // table, dir
144 $wgExtNewFields = array(); // table, column, dir
145 $wgExtPGNewFields = array(); // table, column attributes; for PostgreSQL
146 $wgExtNewIndexes = array(); // table, index, dir
148 # Helper function: check if the given key is present in the updatelog table.
149 # Obviously, only use this for updates that occur after the updatelog table was
150 # created!
151 function update_row_exists( $key ) {
152         $dbr = wfGetDB( DB_SLAVE );
153         $row = $dbr->selectRow(
154                 'updatelog',
155                 '1',
156                 array( 'ul_key' => $key ),
157                 __FUNCTION__
158         );
159         return (bool)$row;
162 function rename_table( $from, $to, $patch ) {
163         global $wgDatabase;
164         if ( $wgDatabase->tableExists( $from ) ) {
165                 if ( $wgDatabase->tableExists( $to ) ) {
166                         echo "...can't move table $from to $to, $to already exists.\n";
167                 } else {
168                         echo "Moving table $from to $to...";
169                         dbsource( archive($patch), $wgDatabase );
170                         echo "ok\n";
171                 }
172         } else {
173                 // Source table does not exist
174                 // Renames are done before creations, so this is typical for a new installation
175                 // Ignore silently
176         }
179 function add_table( $name, $patch, $fullpath=false ) {
180         global $wgDatabase;
181         if ( $wgDatabase->tableExists( $name ) ) {
182                 echo "...$name table already exists.\n";
183         } else {
184                 echo "Creating $name table...";
185                 if( $fullpath ) {
186                         dbsource( $patch, $wgDatabase );
187                 } else {
188                         dbsource( archive($patch), $wgDatabase );
189                 }
190                 echo "ok\n";
191         }
194 function add_field( $table, $field, $patch, $fullpath=false ) {
195         global $wgDatabase;
196         if ( !$wgDatabase->tableExists( $table ) ) {
197                 echo "...$table table does not exist, skipping new field patch\n";
198         } elseif ( $wgDatabase->fieldExists( $table, $field ) ) {
199                 echo "...have $field field in $table table.\n";
200         } else {
201                 echo "Adding $field field to table $table...";
202                 if( $fullpath ) {
203                         dbsource( $patch, $wgDatabase );
204                 } else {
205                         dbsource( archive($patch), $wgDatabase );
206                 }
207                 echo "ok\n";
208         }
211 function add_index( $table, $index, $patch, $fullpath=false ) {
212         global $wgDatabase;
213         if( $wgDatabase->indexExists( $table, $index ) ) {
214                 echo "...$index key already set on $table table.\n";
215         } else {
216                 echo "Adding $index key to table $table... ";
217                 if( $fullpath ) {
218                         dbsource( $patch, $wgDatabase );
219                 } else {
220                         dbsource( archive($patch), $wgDatabase );
221                 }
222                 echo "ok\n";
223         }
226 function do_revision_updates() {
227         global $wgSoftwareRevision;
228         if ( $wgSoftwareRevision < 1001 ) {
229                 update_passwords();
230         }
233 function update_passwords() {
234         wfDebugDieBacktrace( "This function needs to be updated or removed.\n" );
236         global $wgDatabase;
237         $fname = "Update script: update_passwords()";
238         print "\nIt appears that you need to update the user passwords in your\n" .
239           "database. If you have already done this (if you've run this update\n" .
240           "script once before, for example), doing so again will make all your\n" .
241           "user accounts inaccessible, so be sure you only do this once.\n" .
242           "Update user passwords? (yes/no)";
244         $resp = readconsole();
245     if ( ! ( "Y" == $resp{0} || "y" == $resp{0} ) ) { return; }
247         $sql = "SELECT user_id,user_password FROM user";
248         $source = $wgDatabase->query( $sql, $fname );
250         while ( $row = $wgDatabase->fetchObject( $source ) ) {
251                 $id = $row->user_id;
252                 $oldpass = $row->user_password;
253                 $newpass = md5( "{$id}-{$oldpass}" );
255                 $sql = "UPDATE user SET user_password='{$newpass}' " .
256                   "WHERE user_id={$id}";
257                 $wgDatabase->query( $sql, $fname );
258         }
261 function do_interwiki_update() {
262         # Check that interwiki table exists; if it doesn't source it
263         global $wgDatabase, $IP;
264         if( $wgDatabase->tableExists( "interwiki" ) ) {
265                 echo "...already have interwiki table\n";
266                 return true;
267         }
268         echo "Creating interwiki table: ";
269         dbsource( archive("patch-interwiki.sql") );
270         echo "ok\n";
271         echo "Adding default interwiki definitions: ";
272         dbsource( "$IP/maintenance/interwiki.sql" );
273         echo "ok\n";
276 function do_index_update() {
277         # Check that proper indexes are in place
278         global $wgDatabase;
279         $meta = $wgDatabase->fieldInfo( "recentchanges", "rc_timestamp" );
280         if( !$meta->isMultipleKey() ) {
281                 echo "Updating indexes to 20031107: ";
282                 dbsource( archive("patch-indexes.sql") );
283                 echo "ok\n";
284                 return true;
285         }
286         echo "...indexes seem up to 20031107 standards\n";
287         return false;
290 function do_image_index_update() {
291         global $wgDatabase;
293         $meta = $wgDatabase->fieldInfo( "image", "img_major_mime" );
294         if( !$meta->isMultipleKey() ) {
295                 echo "Updating indexes to 20050912: ";
296                 dbsource( archive("patch-mimesearch-indexes.sql") );
297                 echo "ok\n";
298                 return true;
299         }
300         echo "...indexes seem up to 20050912 standards\n";
301         return false;
304 function do_image_name_unique_update() {
305         global $wgDatabase;
306         if( $wgDatabase->indexExists( 'image', 'PRIMARY' ) ) {
307                 echo "...image primary key already set.\n";
308         } else {
309                 echo "Making img_name the primary key... ";
310                 dbsource( archive("patch-image_name_primary.sql"), $wgDatabase );
311                 echo "ok\n";
312         }
315 function do_logging_timestamp_index() {
316         global $wgDatabase;
317         if( $wgDatabase->indexExists( 'logging', 'times' ) ) {
318                 echo "...timestamp key on logging already exists.\n";
319         } else {
320                 echo "Adding timestamp key on logging table... ";
321                 dbsource( archive("patch-logging-times-index.sql"), $wgDatabase );
322                 echo "ok\n";
323         }
326 function do_archive_user_index() {
327         global $wgDatabase;
328         if( $wgDatabase->indexExists( 'archive', 'usertext_timestamp' ) ) {
329                 echo "...usertext,timestamp key on archive already exists.\n";
330         } else {
331                 echo "Adding usertext,timestamp key on archive table... ";
332                 dbsource( archive("patch-archive-user-index.sql"), $wgDatabase );
333                 echo "ok\n";
334         }
337 function do_image_user_index() {
338         global $wgDatabase;
339         if( $wgDatabase->indexExists( 'image', 'img_usertext_timestamp' ) ) {
340                 echo "...usertext,timestamp key on image already exists.\n";
341         } else {
342                 echo "Adding usertext,timestamp key on image table... ";
343                 dbsource( archive("patch-image-user-index.sql"), $wgDatabase );
344                 echo "ok\n";
345         }
348 function do_oldimage_user_index() {
349         global $wgDatabase;
350         if( $wgDatabase->indexExists( 'oldimage', 'oi_usertext_timestamp' ) ) {
351                 echo "...usertext,timestamp key on oldimage already exists.\n";
352         } else {
353                 echo "Adding usertext,timestamp key on oldimage table... ";
354                 dbsource( archive("patch-oldimage-user-index.sql"), $wgDatabase );
355                 echo "ok\n";
356         }
359 function do_watchlist_update() {
360         global $wgDatabase;
361         $fname = 'do_watchlist_update';
362         if( $wgDatabase->fieldExists( 'watchlist', 'wl_notificationtimestamp' ) ) {
363                 echo "The watchlist table is already set up for email notification.\n";
364         } else {
365                 echo "Adding wl_notificationtimestamp field for email notification management.";
366                 /* ALTER TABLE watchlist ADD (wl_notificationtimestamp varchar(14) binary NOT NULL default '0'); */
367                 dbsource( archive( 'patch-email-notification.sql' ), $wgDatabase );
368                 echo "ok\n";
369         }
370         # Check if we need to add talk page rows to the watchlist
371         $talk = $wgDatabase->selectField( 'watchlist', 'count(*)', 'wl_namespace & 1', $fname );
372         $nontalk = $wgDatabase->selectField( 'watchlist', 'count(*)', 'NOT (wl_namespace & 1)', $fname );
373         if ( $talk != $nontalk ) {
374                 echo "Adding missing watchlist talk page rows... ";
375                 flush();
377                 $wgDatabase->insertSelect( 'watchlist', 'watchlist', 
378                         array(
379                                 'wl_user' => 'wl_user',
380                                 'wl_namespace' => 'wl_namespace | 1',
381                                 'wl_title' => 'wl_title',
382                                 'wl_notificationtimestamp' => 'wl_notificationtimestamp'
383                         ), array( 'NOT (wl_namespace & 1)' ), $fname, 'IGNORE' );
384                 echo "ok\n";
385         } else {
386                 echo "...watchlist talk page rows already present\n";
387         }
390 function do_copy_newtalk_to_watchlist() {
391         global $wgDatabase;
392         global $wgCommandLineMode;      # this needs to be saved while getID() and getName() are called
394         $res = $wgDatabase->safeQuery( 'SELECT user_id, user_ip FROM !',
395                 $wgDatabase->tableName( 'user_newtalk' ) );
396         $num_newtalks=$wgDatabase->numRows($res);
397         echo "Now converting ".$num_newtalks." user_newtalk entries to watchlist table entries ... \n";
399         $user = new User();
400         for ( $i = 1; $i <= $num_newtalks; $i++ ) {
401                 $wluser = $wgDatabase->fetchObject( $res );
402                 if ($wluser->user_id == 0) { # anonymous users ... have IP numbers as "names"
403                         if ($user->isIP($wluser->user_ip)) { # do only if it really looks like an IP number (double checked)
404                                 $wgDatabase->replace( 'watchlist',
405                                         array(array('wl_user','wl_namespace', 'wl_title', 'wl_notificationtimestamp' )),
406                                           array('wl_user'                       => 0,
407                                                 'wl_namespace'                  => NS_USER_TALK,
408                                                 'wl_title'                      => $wluser->user_ip,
409                                                 'wl_notificationtimestamp'      => '19700101000000'
410                                                 ), 'updaters.inc::do_watchlist_update2'
411                                         );
412                         }
413                 } else { # normal users ... have user_ids
414                         $user->setID($wluser->user_id);
415                         $wgDatabase->replace( 'watchlist',
416                                 array(array('wl_user','wl_namespace', 'wl_title', 'wl_notificationtimestamp' )),
417                                   array('wl_user'                       => $user->getID(),
418                                         'wl_namespace'                  => NS_USER_TALK,
419                                         'wl_title'                      => $user->getName(),
420                                         'wl_notificationtimestamp'      => '19700101000000'
421                                         ), 'updaters.inc::do_watchlist_update3'
422                                 );
423                 }
424         }
425         echo "Done.\n";
429 function do_user_update() {
430         global $wgDatabase;
431         if( $wgDatabase->fieldExists( 'user', 'user_emailauthenticationtimestamp' ) ) {
432                 echo "User table contains old email authentication field. Dropping... ";
433                 dbsource( archive( 'patch-email-authentication.sql' ), $wgDatabase );
434                 echo "ok\n";
435         } else {
436                 echo "...user table does not contain old email authentication field.\n";
437         }
441  * 1.4 betas were missing the 'binary' marker from logging.log_title,
442  * which causes a collation mismatch error on joins in MySQL 4.1.
443  */
444 function do_logging_encoding() {
445         global $wgDatabase, $wgDBtype;
446         if ($wgDBtype != 'mysql')
447                 return;
448         $logging = $wgDatabase->tableName( 'logging' );
449         $res = $wgDatabase->query( "SELECT log_title FROM $logging LIMIT 0" );
450         $flags = explode( ' ', mysql_field_flags( $res->result, 0 ) );
451         $wgDatabase->freeResult( $res );
453         if( in_array( 'binary', $flags ) ) {
454                 echo "Logging table has correct title encoding.\n";
455         } else {
456                 echo "Fixing title encoding on logging table... ";
457                 dbsource( archive( 'patch-logging-title.sql' ), $wgDatabase );
458                 echo "ok\n";
459         }
462 function do_schema_restructuring() {
463         global $wgDatabase;
464         $fname="do_schema_restructuring";
465         if ( $wgDatabase->tableExists( 'page' ) ) {
466                 echo "...page table already exists.\n";
467         } else {
468                 echo "...converting from cur/old to page/revision/text DB structure.\n"; flush();
469                 echo wfTimestamp( TS_DB );
470                 echo "......checking for duplicate entries.\n"; flush();
472                 list ($cur, $old, $page, $revision, $text) = $wgDatabase->tableNamesN( 'cur', 'old', 'page', 'revision', 'text' );
474                 $rows = $wgDatabase->query( "SELECT cur_title, cur_namespace, COUNT(cur_namespace) AS c
475                                 FROM $cur GROUP BY cur_title, cur_namespace HAVING c>1", $fname );
477                 if ( $wgDatabase->numRows( $rows ) > 0 ) {
478                         echo wfTimestamp( TS_DB );
479                         echo "......<b>Found duplicate entries</b>\n";
480                         echo ( sprintf( "<b>      %-60s %3s %5s</b>\n", 'Title', 'NS', 'Count' ) );
481                         while ( $row = $wgDatabase->fetchObject( $rows ) ) {
482                                 if ( ! isset( $duplicate[$row->cur_namespace] ) ) {
483                                         $duplicate[$row->cur_namespace] = array();
484                                 }
485                                 $duplicate[$row->cur_namespace][] = $row->cur_title;
486                                 echo ( sprintf( "      %-60s %3s %5s\n", $row->cur_title, $row->cur_namespace, $row->c ) );
487                         }
488                         $sql = "SELECT cur_title, cur_namespace, cur_id, cur_timestamp FROM $cur WHERE ";
489                         $firstCond = true;
490                         foreach ( $duplicate as $ns => $titles ) {
491                                 if ( $firstCond ) {
492                                         $firstCond = false;
493                                 } else {
494                                         $sql .= ' OR ';
495                                 }
496                                 $sql .= "( cur_namespace = {$ns} AND cur_title in (";
497                                 $first = true;
498                                 foreach ( $titles as $t ) {
499                                         if ( $first ) {
500                                                 $sql .= $wgDatabase->addQuotes( $t );
501                                                 $first = false;
502                                         } else {
503                                                 $sql .= ', ' . $wgDatabase->addQuotes( $t );
504                                         }
505                                 }
506                                 $sql .= ") ) \n";
507                         }
508                         # By sorting descending, the most recent entry will be the first in the list.
509                         # All following entries will be deleted by the next while-loop.
510                         $sql .= 'ORDER BY cur_namespace, cur_title, cur_timestamp DESC';
512                         $rows = $wgDatabase->query( $sql, $fname );
514                         $prev_title = $prev_namespace = false;
515                         $deleteId = array();
517                         while ( $row = $wgDatabase->fetchObject( $rows ) ) {
518                                 if ( $prev_title == $row->cur_title && $prev_namespace == $row->cur_namespace ) {
519                                         $deleteId[] = $row->cur_id;
520                                 }
521                                 $prev_title     = $row->cur_title;
522                                 $prev_namespace = $row->cur_namespace;
523                         }
524                         $sql = "DELETE FROM $cur WHERE cur_id IN ( " . join( ',', $deleteId ) . ')';
525                         $rows = $wgDatabase->query( $sql, $fname );
526                         echo wfTimestamp( TS_DB );
527                         echo "......<b>Deleted</b> ".$wgDatabase->affectedRows()." records.\n";
528                 }
531                 echo wfTimestamp( TS_DB );
532                 echo "......Creating tables.\n";
533                 $wgDatabase->query("CREATE TABLE $page (
534                         page_id int(8) unsigned NOT NULL auto_increment,
535                         page_namespace int NOT NULL,
536                         page_title varchar(255) binary NOT NULL,
537                         page_restrictions tinyblob NOT NULL,
538                         page_counter bigint(20) unsigned NOT NULL default '0',
539                         page_is_redirect tinyint(1) unsigned NOT NULL default '0',
540                         page_is_new tinyint(1) unsigned NOT NULL default '0',
541                         page_random real unsigned NOT NULL,
542                         page_touched char(14) binary NOT NULL default '',
543                         page_latest int(8) unsigned NOT NULL,
544                         page_len int(8) unsigned NOT NULL,
546                         PRIMARY KEY page_id (page_id),
547                         UNIQUE INDEX name_title (page_namespace,page_title),
548                         INDEX (page_random),
549                         INDEX (page_len)
550                         ) TYPE=InnoDB", $fname );
551                 $wgDatabase->query("CREATE TABLE $revision (
552                         rev_id int(8) unsigned NOT NULL auto_increment,
553                         rev_page int(8) unsigned NOT NULL,
554                         rev_comment tinyblob NOT NULL,
555                         rev_user int(5) unsigned NOT NULL default '0',
556                         rev_user_text varchar(255) binary NOT NULL default '',
557                         rev_timestamp char(14) binary NOT NULL default '',
558                         rev_minor_edit tinyint(1) unsigned NOT NULL default '0',
559                         rev_deleted tinyint(1) unsigned NOT NULL default '0',
560                         rev_len int(8) unsigned,
561                         rev_parent_id int(8) unsigned default NULL,
562                         PRIMARY KEY rev_page_id (rev_page, rev_id),
563                         UNIQUE INDEX rev_id (rev_id),
564                         INDEX rev_timestamp (rev_timestamp),
565                         INDEX page_timestamp (rev_page,rev_timestamp),
566                         INDEX user_timestamp (rev_user,rev_timestamp),
567                         INDEX usertext_timestamp (rev_user_text,rev_timestamp)
568                         ) TYPE=InnoDB", $fname );
570                 echo wfTimestamp( TS_DB );
571                 echo "......Locking tables.\n";
572                 $wgDatabase->query( "LOCK TABLES $page WRITE, $revision WRITE, $old WRITE, $cur WRITE", $fname );
574                 $maxold = intval( $wgDatabase->selectField( 'old', 'max(old_id)', '', $fname ) );
575                 echo wfTimestamp( TS_DB );
576                 echo "......maxold is {$maxold}\n";
578                 echo wfTimestamp( TS_DB );
579                 global $wgLegacySchemaConversion;
580                 if( $wgLegacySchemaConversion ) {
581                         // Create HistoryBlobCurStub entries.
582                         // Text will be pulled from the leftover 'cur' table at runtime.
583                         echo "......Moving metadata from cur; using blob references to text in cur table.\n";
584                         $cur_text = "concat('O:18:\"historyblobcurstub\":1:{s:6:\"mCurId\";i:',cur_id,';}')";
585                         $cur_flags = "'object'";
586                 } else {
587                         // Copy all cur text in immediately: this may take longer but avoids
588                         // having to keep an extra table around.
589                         echo "......Moving text from cur.\n";
590                         $cur_text = 'cur_text';
591                         $cur_flags = "''";
592                 }
593                 $wgDatabase->query( "INSERT INTO $old (old_namespace, old_title, old_text, old_comment, old_user, old_user_text,
594                                 old_timestamp, old_minor_edit, old_flags)
595                         SELECT cur_namespace, cur_title, $cur_text, cur_comment, cur_user, cur_user_text, cur_timestamp, cur_minor_edit, $cur_flags
596                         FROM $cur", $fname );
598                 echo wfTimestamp( TS_DB );
599                 echo "......Setting up revision table.\n";
600                 $wgDatabase->query( "INSERT INTO $revision (rev_id, rev_page, rev_comment, rev_user, rev_user_text, rev_timestamp,
601                                 rev_minor_edit)
602                         SELECT old_id, cur_id, old_comment, old_user, old_user_text,
603                                 old_timestamp, old_minor_edit
604                         FROM $old,$cur WHERE old_namespace=cur_namespace AND old_title=cur_title", $fname );
606                 echo wfTimestamp( TS_DB );
607                 echo "......Setting up page table.\n";
608                 $wgDatabase->query( "INSERT INTO $page (page_id, page_namespace, page_title, page_restrictions, page_counter,
609                                 page_is_redirect, page_is_new, page_random, page_touched, page_latest, page_len)
610                         SELECT cur_id, cur_namespace, cur_title, cur_restrictions, cur_counter, cur_is_redirect, cur_is_new,
611                                 cur_random, cur_touched, rev_id, LENGTH(cur_text)
612                         FROM $cur,$revision
613                         WHERE cur_id=rev_page AND rev_timestamp=cur_timestamp AND rev_id > {$maxold}", $fname );
615                 echo wfTimestamp( TS_DB );
616                 echo "......Unlocking tables.\n";
617                 $wgDatabase->query( "UNLOCK TABLES", $fname );
619                 echo wfTimestamp( TS_DB );
620                 echo "......Renaming old.\n";
621                 $wgDatabase->query( "ALTER TABLE $old RENAME TO $text", $fname );
623                 echo wfTimestamp( TS_DB );
624                 echo "...done.\n";
625         }
628 function do_inverse_timestamp() {
629         global $wgDatabase;
630         if( $wgDatabase->fieldExists( 'revision', 'inverse_timestamp' ) ) {
631                 echo "Removing revision.inverse_timestamp and fixing indexes... ";
632                 dbsource( archive( 'patch-inverse_timestamp.sql' ), $wgDatabase );
633                 echo "ok\n";
634         } else {
635                 echo "revision timestamp indexes already up to 2005-03-13\n";
636         }
639 function do_text_id() {
640         global $wgDatabase;
641         if( $wgDatabase->fieldExists( 'revision', 'rev_text_id' ) ) {
642                 echo "...rev_text_id already in place.\n";
643         } else {
644                 echo "Adding rev_text_id field... ";
645                 dbsource( archive( 'patch-rev_text_id.sql' ), $wgDatabase );
646                 echo "ok\n";
647         }
650 function do_namespace_size() {
651         $tables = array(
652                 'page'          => 'page',
653                 'archive'       => 'ar',
654                 'recentchanges' => 'rc',
655                 'watchlist'     => 'wl',
656                 'querycache'    => 'qc',
657                 'logging'       => 'log',
658         );
659         foreach( $tables as $table => $prefix ) {
660                 do_namespace_size_on( $table, $prefix );
661                 flush();
662         }
665 function do_namespace_size_on( $table, $prefix ) {
666         global $wgDatabase, $wgDBtype;
667         if ($wgDBtype != 'mysql')
668                 return;
669         $field = $prefix . '_namespace';
671         $tablename = $wgDatabase->tableName( $table );
672         $result = $wgDatabase->query( "SHOW COLUMNS FROM $tablename LIKE '$field'" );
673         $info = $wgDatabase->fetchObject( $result );
674         $wgDatabase->freeResult( $result );
676         if( substr( $info->Type, 0, 3 ) == 'int' ) {
677                 echo "...$field is already a full int ($info->Type).\n";
678         } else {
679                 echo "Promoting $field from $info->Type to int... ";
681                 $sql = "ALTER TABLE $tablename MODIFY $field int NOT NULL";
682                 $wgDatabase->query( $sql );
684                 echo "ok\n";
685         }
688 function do_pagelinks_update() {
689         global $wgDatabase;
690         if( $wgDatabase->tableExists( 'pagelinks' ) ) {
691                 echo "...already have pagelinks table.\n";
692         } else {
693                 echo "Converting links and brokenlinks tables to pagelinks... ";
694                 dbsource( archive( 'patch-pagelinks.sql' ), $wgDatabase );
695                 echo "ok\n";
696                 flush();
698                 global $wgCanonicalNamespaceNames;
699                 foreach( $wgCanonicalNamespaceNames as $ns => $name ) {
700                         if( $ns != 0 ) {
701                                 do_pagelinks_namespace( $ns );
702                         }
703                 }
704         }
707 function do_pagelinks_namespace( $namespace ) {
708         global $wgDatabase, $wgContLang;
710         $ns = intval( $namespace );
711         echo "Cleaning up broken links for namespace $ns... ";
713         $pagelinks = $wgDatabase->tableName( 'pagelinks' );
714         $name = $wgContLang->getNsText( $ns );
715         $prefix = $wgDatabase->strencode( $name );
716         $likeprefix = str_replace( '_', '\\_', $prefix);
718         $sql = "UPDATE $pagelinks
719                    SET pl_namespace=$ns,
720                        pl_title=TRIM(LEADING '$prefix:' FROM pl_title)
721                  WHERE pl_namespace=0
722                    AND pl_title LIKE '$likeprefix:%'";
724         $wgDatabase->query( $sql, 'do_pagelinks_namespace' );
725         echo "ok\n";
728 function do_drop_img_type() {
729         global $wgDatabase;
731         if( $wgDatabase->fieldExists( 'image', 'img_type' ) ) {
732                 echo "Dropping unused img_type field in image table... ";
733                 dbsource( archive( 'patch-drop_img_type.sql' ), $wgDatabase );
734                 echo "ok\n";
735         } else {
736                 echo "No img_type field in image table; Good.\n";
737         }
740 function do_old_links_update() {
741         global $wgDatabase;
742         if( $wgDatabase->tableExists( 'pagelinks' ) ) {
743                 echo "Already have pagelinks; skipping old links table updates.\n";
744         } else {
745                 convertLinks(); flush();
746         }
749 function do_user_unique_update() {
750         global $wgDatabase;
751         $duper = new UserDupes( $wgDatabase );
752         if( $duper->hasUniqueIndex() ) {
753                 echo "Already have unique user_name index.\n";
754         } else {
755                 if( !$duper->clearDupes() ) {
756                         echo "WARNING: This next step will probably fail due to unfixed duplicates...\n";
757                 }
758                 echo "Adding unique index on user_name... ";
759                 dbsource( archive( 'patch-user_nameindex.sql' ), $wgDatabase );
760                 echo "ok\n";
761         }
764 function do_user_groups_update() {
765         $fname = 'do_user_groups_update';
766         global $wgDatabase;
768         if( $wgDatabase->tableExists( 'user_groups' ) ) {
769                 echo "...user_groups table already exists.\n";
770                 return do_user_groups_reformat();
771         }
773         echo "Adding user_groups table... ";
774         dbsource( archive( 'patch-user_groups.sql' ), $wgDatabase );
775         echo "ok\n";
777         if( !$wgDatabase->tableExists( 'user_rights' ) ) {
778                 if( $wgDatabase->fieldExists( 'user', 'user_rights' ) ) {
779                         echo "Upgrading from a 1.3 or older database? Breaking out user_rights for conversion...";
780                         dbsource( archive( 'patch-user_rights.sql' ), $wgDatabase );
781                         echo "ok\n";
782                 } else {
783                         echo "*** WARNING: couldn't locate user_rights table or field for upgrade.\n";
784                         echo "*** You may need to manually configure some sysops by manipulating\n";
785                         echo "*** the user_groups table.\n";
786                         return;
787                 }
788         }
790         echo "Converting user_rights table to user_groups... ";
791         $result = $wgDatabase->select( 'user_rights',
792                 array( 'ur_user', 'ur_rights' ),
793                 array( "ur_rights != ''" ),
794                 $fname );
796         while( $row = $wgDatabase->fetchObject( $result ) ) {
797                 $groups = array_unique(
798                         array_map( 'trim',
799                                 explode( ',', $row->ur_rights ) ) );
801                 foreach( $groups as $group ) {
802                         $wgDatabase->insert( 'user_groups',
803                                 array(
804                                         'ug_user'  => $row->ur_user,
805                                         'ug_group' => $group ),
806                                 $fname );
807                 }
808         }
809         $wgDatabase->freeResult( $result );
810         echo "ok\n";
813 function do_user_groups_reformat() {
814         # Check for bogus formats from previous 1.5 alpha code.
815         global $wgDatabase;
816         $info = $wgDatabase->fieldInfo( 'user_groups', 'ug_group' );
818         if( $info->type() == 'int' ) {
819                 $oldug = $wgDatabase->tableName( 'user_groups' );
820                 $newug = $wgDatabase->tableName( 'user_groups_bogus' );
821                 echo "user_groups is in bogus intermediate format. Renaming to $newug... ";
822                 $wgDatabase->query( "ALTER TABLE $oldug RENAME TO $newug" );
823                 echo "ok\n";
825                 echo "Re-adding fresh user_groups table... ";
826                 dbsource( archive( 'patch-user_groups.sql' ), $wgDatabase );
827                 echo "ok\n";
829                 echo "***\n";
830                 echo "*** WARNING: You will need to manually fix up user permissions in the user_groups\n";
831                 echo "*** table. Old 1.5 alpha versions did some pretty funky stuff...\n";
832                 echo "***\n";
833         } else {
834                 echo "...user_groups is in current format.\n";
835         }
839 function do_watchlist_null() {
840         # Make sure wl_notificationtimestamp can be NULL,
841         # and update old broken items.
842         global $wgDatabase;
843         $info = $wgDatabase->fieldInfo( 'watchlist', 'wl_notificationtimestamp' );
845         if( !$info->nullable() ) {
846                 echo "Making wl_notificationtimestamp nullable... ";
847                 dbsource( archive( 'patch-watchlist-null.sql' ), $wgDatabase );
848                 echo "ok\n";
849         } else {
850                 echo "...wl_notificationtimestamp is already nullable.\n";
851         }
856  * @bug 3946
857  */
858 function do_page_random_update() {
859         global $wgDatabase;
861         echo "Setting page_random to a random value on rows where it equals 0...";
863         $page = $wgDatabase->tableName( 'page' );
864         $wgDatabase->query( "UPDATE $page SET page_random = RAND() WHERE page_random = 0", 'do_page_random_update' );
865         $rows = $wgDatabase->affectedRows();
867         echo "changed $rows rows\n";
870 function do_templatelinks_update() {
871         global $wgDatabase, $wgLoadBalancer;
872         $fname = 'do_templatelinks_update';
874         if ( $wgDatabase->tableExists( 'templatelinks' ) ) {
875                 echo "...templatelinks table already exists\n";
876                 return;
877         }
878         echo "Creating templatelinks table...\n";
879         dbsource( archive('patch-templatelinks.sql'), $wgDatabase );
880         echo "Populating...\n";
881         if ( isset( $wgLoadBalancer ) && $wgLoadBalancer->getServerCount() > 1 ) {
882                 // Slow, replication-friendly update
883                 $res = $wgDatabase->select( 'pagelinks', array( 'pl_from', 'pl_namespace', 'pl_title' ),
884                         array( 'pl_namespace' => NS_TEMPLATE ), $fname );
885                 $count = 0;
886                 while ( $row = $wgDatabase->fetchObject( $res ) ) {
887                         $count = ($count + 1) % 100;
888                         if ( $count == 0 ) {
889                                 if ( function_exists( 'wfWaitForSlaves' ) ) {
890                                         wfWaitForSlaves( 10 );
891                                 } else {
892                                         sleep( 1 );
893                                 }
894                         }
895                         $wgDatabase->insert( 'templatelinks',
896                                 array(
897                                         'tl_from' => $row->pl_from,
898                                         'tl_namespace' => $row->pl_namespace,
899                                         'tl_title' => $row->pl_title,
900                                 ), $fname
901                         );
903                 }
904                 $wgDatabase->freeResult( $res );
905         } else {
906                 // Fast update
907                 $wgDatabase->insertSelect( 'templatelinks', 'pagelinks',
908                         array(
909                                 'tl_from' => 'pl_from',
910                                 'tl_namespace' => 'pl_namespace',
911                                 'tl_title' => 'pl_title'
912                         ), array(
913                                 'pl_namespace' => 10
914                         ), $fname
915                 );
916         }
917         echo "Done. Please run maintenance/refreshLinks.php for a more thorough templatelinks update.\n";
920 // Add index on ( rc_namespace, rc_user_text ) [Jul. 2006]
921 // Add index on ( rc_user_text, rc_timestamp ) [Nov. 2006]
922 function do_rc_indices_update() {
923         global $wgDatabase;
924         echo( "Checking for additional recent changes indices...\n" );
926         $indexes = array(
927                 'rc_ns_usertext' => 'patch-recentchanges-utindex.sql',
928                 'rc_user_text' => 'patch-rc_user_text-index.sql',
929         );
930         
931         foreach( $indexes as $index => $patch ) {
932                 $info = $wgDatabase->indexInfo( 'recentchanges', $index, __METHOD__ );
933                 if( !$info ) {
934                         echo( "...index `{$index}` not found; adding..." );
935                         dbsource( archive( $patch ) );
936                         echo( "done.\n" );
937                 } else {
938                         echo( "...index `{$index}` seems ok.\n" );
939                 }
940         }
943 function index_has_field($table, $index, $field) {
944         global $wgDatabase;
945         echo( "Checking if $table index $index includes field $field...\n" );
946         $info = $wgDatabase->indexInfo( $table, $index, __METHOD__ );
947         if( $info ) {
948                 foreach($info as $row) {
949                         if($row->Column_name == $field) {
950                                 echo( "...index $index on table $table seems to be ok\n" );
951                                 return true;
952                         }
953                 }
954         }
955         echo( "...index $index on table $table has no field $field; adding\n" );
956         return false;
959 function do_backlinking_indices_update() {
960         echo( "Checking for backlinking indices...\n" );
961         if (!index_has_field('pagelinks', 'pl_namespace', 'pl_from') ||
962                 !index_has_field('templatelinks', 'tl_namespace', 'tl_from') ||
963                 !index_has_field('imagelinks', 'il_to', 'il_from'))
964         {       
965                 dbsource( archive( 'patch-backlinkindexes.sql' ) );
966         }
969 function do_categorylinks_indices_update() {
970         echo( "Checking for categorylinks indices...\n" );
971         if (!index_has_field('categorylinks', 'cl_sortkey', 'cl_from'))
972         {       
973                 dbsource( archive( 'patch-categorylinksindex.sql' ) );
974         }
977 function do_stats_init() {
978         // Sometimes site_stats table is not properly populated.
979         global $wgDatabase;
980         echo "Checking site_stats row...";
981         $row = $wgDatabase->selectRow( 'site_stats', '*', array( 'ss_row_id' => 1 ), __METHOD__ );
982         if( $row === false ) {
983                 echo "data is missing! rebuilding...\n";
984                 
985                 global $IP;
986                 require_once "$IP/maintenance/initStats.inc";
987                 wfInitStats();
988         } else {
989                 echo "ok.\n";
990         }
993 function purge_cache() {
994         global $wgDatabase;
995         # We can't guarantee that the user will be able to use TRUNCATE,
996         # but we know that DELETE is available to us
997         echo( "Purging caches..." );
998         $wgDatabase->delete( 'objectcache', '*', __METHOD__ );
999         echo( "done.\n" );
1002 function do_all_updates( $shared = false, $purge = true ) {
1003         global $wgNewTables, $wgNewFields, $wgRenamedTables, $wgSharedDB, $wgDatabase, $wgDBtype, $IP;
1005         wfRunHooks('LoadExtensionSchemaUpdates');
1007         $doUser = !$wgSharedDB || $shared;
1009         if ($wgDBtype === 'postgres') {
1010                 do_postgres_updates();
1011                 return;
1012         }
1013         
1014         # Run core updates in sequence...
1015         global $wgMysqlUpdates;
1016         foreach( $wgMysqlUpdates as $params ) {
1017                 $func = array_shift( $params );
1018                 call_user_func_array( $func, $params );
1019                 flush();
1020         }
1021         
1022         /// @fixme clean up this mess too!
1023         global $wgExtNewTables, $wgExtNewFields, $wgExtNewIndexes;
1024         # Add missing extension tables
1025         foreach ( $wgExtNewTables as $tableRecord ) {
1026                 add_table( $tableRecord[0], $tableRecord[1], true );
1027                 flush();
1028         }
1029         # Add missing extension fields
1030         foreach ( $wgExtNewFields as $fieldRecord ) {
1031                 if ( $fieldRecord[0] != 'user' || $doUser ) {
1032                         add_field( $fieldRecord[0], $fieldRecord[1], $fieldRecord[2], true );
1033                 }
1034                 flush();
1035         }
1036         # Add missing extension indexes
1037         foreach ( $wgExtNewIndexes as $fieldRecord ) {
1038                 add_index( $fieldRecord[0], $fieldRecord[1], $fieldRecord[2], true );
1039                 flush();
1040         }
1043         echo "Deleting old default messages (this may take a long time!)..."; flush();
1044         deleteDefaultMessages();
1045         echo "Done\n"; flush();
1046         
1047         do_stats_init(); flush();
1048         
1049         if( $purge ) {
1050                 purge_cache();
1051                 flush();
1052         }
1055 function archive($name) {
1056         global $wgDBtype, $IP;
1057         switch ($wgDBtype) {
1058         case "postgres":
1059                 return "$IP/maintenance/postgres/archives/$name";
1060         default:
1061                 return "$IP/maintenance/archives/$name";
1062         }
1065 function do_restrictions_update() {
1066         # Adding page_restrictions table, obsoleting page.page_restrictions.
1067         #  Migrating old restrictions to new table
1068         # -- Andrew Garrett, January 2007.
1070         global $wgDatabase;
1072         $name = 'page_restrictions';
1073         $patch = 'patch-page_restrictions.sql';
1074         $patch2 = 'patch-page_restrictions_sortkey.sql';
1076         if ( $wgDatabase->tableExists( $name ) ) {
1077                 echo "...$name table already exists.\n";
1078         } else {
1079                 echo "Creating $name table...";
1080                 dbsource( archive($patch), $wgDatabase );
1081                 dbsource( archive($patch2), $wgDatabase );
1082                 echo "ok\n";
1084                 echo "Migrating old restrictions to new table...";
1086                 $res = $wgDatabase->select( 'page', array( 'page_id', 'page_restrictions' ), array("page_restrictions!=''", "page_restrictions!='edit=:move='"), __METHOD__ );
1088                 $count = 0;
1090                 while ($row = $wgDatabase->fetchObject($res) ) {
1091                         $count = ($count + 1) % 100;
1093                         if ($count == 0) {
1094                                 if ( function_exists( 'wfWaitForSlaves' ) ) {
1095                                         wfWaitForSlaves( 10 );
1096                                 } else {
1097                                         sleep( 1 );
1098                                 }
1099                         }
1101                         # Figure out what the restrictions are..
1102                         $id = $row->page_id;
1103                         $flatrestrictions = explode( ':', $row->page_restrictions );
1105                         $restrictions = array ();
1106                         foreach( $flatrestrictions as $restriction ) {
1107                                 $thisrestriction = explode( '=', $restriction, 2 );
1108                                 if( count( $thisrestriction ) == 1 ) {
1109                                         // Compatibility with old protections from before
1110                                         // separate move protection was added.
1111                                         list( $level ) = $thisrestriction;
1112                                         if( $level ) {
1113                                                 $restrictions['edit'] = $level;
1114                                                 $restrictions['move'] = $level;
1115                                         }
1116                                 } else {
1117                                         list( $type, $level ) = $thisrestriction;
1118                                         if( $level ) {
1119                                                 $restrictions[$type] = $level;
1120                                         }
1121                                 }
1123                         $wgDatabase->update( 'page', array ( 'page_restrictions' => ''), array( 'page_id' => $id ), __METHOD__ );
1125                         }
1126                         
1127                         foreach( $restrictions as $type => $level ) {
1128                                 $wgDatabase->insert( 'page_restrictions', array ( 'pr_page' => $id,
1129                                                                                         'pr_type' => $type,
1130                                                                                         'pr_level' => $level,
1131                                                                                         'pr_cascade' => 0,
1132                                                                                         'pr_expiry' => 'infinity' ),
1133                                                                                         __METHOD__ );
1134                         }
1135                 }
1136                 print "ok\n";
1137         }
1140 function do_category_population() {
1141         if( update_row_exists( 'populate category' ) ) {
1142                 echo "...category table already populated.\n";
1143                 return;
1144         }
1145         require_once( 'populateCategory.inc' );
1146         echo "Populating category table, printing progress markers.  ".
1147 "For large databases, you\n".
1148 "may want to hit Ctrl-C and do this manually with maintenance/\n".
1149 "populateCategory.php.\n";
1150         populateCategory( '', 10, 0, true );
1151         echo "Done populating category table.\n";
1154 function
1155 pg_describe_table($table)
1157 global  $wgDatabase, $wgDBmwschema;
1158         $q = <<<END
1159 SELECT attname, attnum FROM pg_namespace, pg_class, pg_attribute
1160         WHERE pg_class.relnamespace = pg_namespace.oid 
1161           AND attrelid=pg_class.oid AND attnum > 0
1162           AND relname=%s AND nspname=%s
1163 END;
1164         $res = $wgDatabase->query(sprintf($q,
1165                         $wgDatabase->addQuotes($table),
1166                         $wgDatabase->addQuotes($wgDBmwschema)));
1167         if (!$res)
1168                 return null;
1170         $cols = array();
1171         while ($r = $wgDatabase->fetchRow($res)) {
1172                 $cols[] = array(        
1173                                 "name" => $r[0],
1174                                 "ord" => $r[1],
1175                         );
1176         }
1177         return $cols;
1180 function
1181 pg_describe_index($idx)
1183 global  $wgDatabase, $wgDBmwschema;
1185         // first fetch the key (which is a list of columns ords) and
1186         // the table the index applies to (an oid)
1187         $q = <<<END
1188 SELECT indkey, indrelid FROM pg_namespace, pg_class, pg_index
1189         WHERE nspname=%s
1190           AND pg_class.relnamespace = pg_namespace.oid
1191           AND relname=%s
1192           AND indexrelid=pg_class.oid
1193 END;
1194         $res = $wgDatabase->query(sprintf($q,
1195                         $wgDatabase->addQuotes($wgDBmwschema),
1196                         $wgDatabase->addQuotes($idx)));
1197         if (!$res)
1198                 return null;
1199         if (!($r = $wgDatabase->fetchRow($res))) {
1200                 $wgDatabase->freeResult($res);
1201                 return null;
1202         }
1204         $indkey = $r[0];
1205         $relid = intval($r[1]);
1206         $indkeys = explode(" ", $indkey);
1207         $wgDatabase->freeResult($res);
1209         $colnames = array();
1210         foreach ($indkeys as $rid) {
1211                 $query = <<<END
1212 SELECT attname FROM pg_class, pg_attribute
1213         WHERE attrelid=$relid
1214           AND attnum=%d
1215           AND attrelid=pg_class.oid
1216 END;
1217                 $r2 = $wgDatabase->query(sprintf($query, $rid));
1218                 if (!$r2)
1219                         return null;
1220                 if (!($row2 = $wgDatabase->fetchRow($r2))) {
1221                         $wgDatabase->freeResult($r2);
1222                         return null;
1223                 }
1224                 $colnames[] = $row2[0];
1225                 $wgDatabase->freeResult($r2);
1226         }
1228         return $colnames;
1231 function
1232 pg_index_exists($table, $index)
1234 global  $wgDatabase, $wgDBmwschema;
1235         $exists = $wgDatabase->selectField("pg_indexes", "indexname",
1236                         array(  "indexname" => $index,
1237                                 "tablename" => $table,
1238                                 "schemaname" => $wgDBmwschema));
1239         return $exists === $index;
1242 function
1243 pg_fkey_deltype($fkey)
1245 global  $wgDatabase, $wgDBmwschema;
1246         $q = <<<END
1247 SELECT confdeltype FROM pg_constraint, pg_namespace
1248         WHERE connamespace=pg_namespace.oid
1249           AND nspname=%s
1250           AND conname=%s;
1251 END;
1252         $r = $wgDatabase->query(sprintf($q,
1253                 $wgDatabase->addQuotes($wgDBmwschema),
1254                 $wgDatabase->addQuotes($fkey)));
1255         if (!($row = $wgDatabase->fetchRow($r)))
1256                 return null;
1257         return $row[0];
1260 function
1261 pg_rule_def($table, $rule)
1263 global  $wgDatabase, $wgDBmwschema;
1264         $q = <<<END
1265 SELECT definition FROM pg_rules
1266         WHERE schemaname = %s
1267           AND tablename = %s
1268           AND rulename = %s
1269 END;
1270         $r = $wgDatabase->query(sprintf($q,
1271                         $wgDatabase->addQuotes($wgDBmwschema),
1272                         $wgDatabase->addQuotes($table),
1273                         $wgDatabase->addQuotes($rule)));
1274         $row = $wgDatabase->fetchRow($r);
1275         if (!$row)
1276                 return null;
1277         $d = $row[0];
1278         $wgDatabase->freeResult($r);
1279         return $d;
1282 function do_postgres_updates() {
1283         global $wgDatabase, $wgVersion, $wgDBmwschema, $wgDBts2schema, $wgShowExceptionDetails, $wgDBuser;
1285         ## Gather version numbers in case we need them
1286         $version = $wgDatabase->getServerVersion(); ## long string
1287         $numver = $wgDatabase->numeric_version; ## X.Y e.g. 8.3
1289         $wgShowExceptionDetails = 1;
1291         # Just in case their LocalSettings.php does not have this:
1292         if ( !isset( $wgDBmwschema ))
1293                 $wgDBmwschema = 'mediawiki';
1295         # Verify that this user is configured correctly
1296         $safeuser = $wgDatabase->addQuotes($wgDBuser);
1297         $SQL = "SELECT array_to_string(useconfig,'*') FROM pg_catalog.pg_user WHERE usename = $safeuser";
1298         $config = pg_fetch_result( $wgDatabase->doQuery( $SQL ), 0, 0 );
1299         $conf = array();
1300         foreach( explode( '*', $config ) as $c ) {
1301                 list( $x,$y ) = explode( '=', $c );
1302                 $conf[$x] = $y;
1303         }
1304         if( !array_key_exists( 'search_path', $conf ) ) {
1305                 $search_path = '';
1306         }
1307         else {
1308                 $search_path = $conf['search_path'];
1309         }
1310         if( strpos( $search_path, $wgDBmwschema ) === false ) {
1311                 echo "Adding in schema \"$wgDBmwschema\" to search_path for user \"$wgDBuser\"\n";
1312                 $search_path = "$wgDBmwschema, $search_path";
1313         }
1314         if( strpos( $search_path, $wgDBts2schema ) === false ) {
1315                 echo "Adding in schema \"$wgDBts2schema\" to search_path for user \"$wgDBuser\"\n";
1316                 $search_path = "$search_path, $wgDBts2schema";
1317         }
1318         if( array_key_exists( 'search_path', $conf ) === false || $search_path != $conf['search_path'] ) {
1319                 $wgDatabase->doQuery( "ALTER USER $wgDBuser SET search_path = $search_path" );
1320                 $wgDatabase->doQuery( "SET search_path = $search_path" );
1321         }
1322         else {
1323                 $path = $conf['search_path'];
1324                 echo "... search_path for user \"$wgDBuser\" looks correct ($path)\n";
1325         }
1326         $goodconf = array(
1327                 'client_min_messages' => 'error',
1328                 'DateStyle'           => 'ISO, YMD',
1329                 'TimeZone'            => 'GMT'
1330         );
1331         foreach( array_keys( $goodconf ) AS $key ) {
1332                 $value = $goodconf[$key];
1333                 if( !array_key_exists( $key, $conf ) or $conf[$key] !== $value ) {
1334                         echo "Setting $key to '$value' for user \"$wgDBuser\"\n";
1335                         $wgDatabase->doQuery( "ALTER USER $wgDBuser SET $key = '$value'" );
1336                         $wgDatabase->doQuery( "SET $key = '$value'" );
1337                 }
1338                 else {
1339                         echo "... default value of \"$key\" is correctly set to \"$value\" for user \"$wgDBuser\"\n";
1340                 }
1341         }
1343         $newsequences = array(
1344                 "log_log_id_seq",
1345                 "pr_id_val",
1346         );
1348         $newtables = array(
1349                 array("category",          "patch-category.sql"),
1350                 array("mediawiki_version", "patch-mediawiki_version.sql"),
1351                 array("mwuser",            "patch-mwuser.sql"),
1352                 array("pagecontent",       "patch-pagecontent.sql"),
1353                 array("querycachetwo",     "patch-querycachetwo.sql"),
1354                 array("page_props",        "patch-page_props.sql"),
1355                 array("page_restrictions", "patch-page_restrictions.sql"),
1356                 array("profiling",         "patch-profiling.sql"),
1357                 array("protected_titles",  "patch-protected_titles.sql"),
1358                 array("redirect",          "patch-redirect.sql"),
1359                 array("updatelog",         "patch-updatelog.sql"),
1360         );
1362         $newcols = array(
1363                 array("archive",       "ar_deleted",           "SMALLINT NOT NULL DEFAULT 0"),
1364                 array("archive",       "ar_len",               "INTEGER"),
1365                 array("archive",       "ar_page_id",           "INTEGER"),
1366                 array("image",         "img_sha1",             "TEXT NOT NULL DEFAULT ''"),
1367                 array("ipblocks",      "ipb_anon_only",        "CHAR NOT NULL DEFAULT '0'"),
1368                 array("ipblocks",      "ipb_by_text",          "TEXT NOT NULL DEFAULT ''"),
1369                 array("ipblocks",      "ipb_block_email",      "CHAR NOT NULL DEFAULT '0'"),
1370                 array("ipblocks",      "ipb_create_account",   "CHAR NOT NULL DEFAULT '1'"),
1371                 array("ipblocks",      "ipb_deleted",          "SMALLINT NOT NULL DEFAULT 0"),
1372                 array("ipblocks",      "ipb_enable_autoblock", "CHAR NOT NULL DEFAULT '1'"),
1373                 array("filearchive",   "fa_deleted",           "SMALLINT NOT NULL DEFAULT 0"),
1374                 array("logging",       "log_deleted",          "SMALLINT NOT NULL DEFAULT 0"),
1375                 array("logging",       "log_id",               "INTEGER NOT NULL PRIMARY KEY DEFAULT nextval('log_log_id_seq')"),
1376                 array("logging",       "log_params",           "TEXT"),
1377                 array("mwuser",        "user_editcount",       "INTEGER"),
1378                 array("mwuser",        "user_newpass_time",    "TIMESTAMPTZ"),
1379                 array("oldimage",      "oi_deleted",           "SMALLINT NOT NULL DEFAULT 0"),
1380                 array("oldimage",      "oi_metadata",          "BYTEA NOT NULL DEFAULT ''"),
1381                 array("oldimage",      "oi_media_type",        "TEXT"),
1382                 array("oldimage",      "oi_major_mime",        "TEXT NOT NULL DEFAULT 'unknown'"),
1383                 array("oldimage",      "oi_minor_mime",        "TEXT NOT NULL DEFAULT 'unknown'"),
1384                 array("oldimage",      "oi_sha1",              "TEXT NOT NULL DEFAULT ''"),
1385                 array("page_restrictions", "pr_id",            "INTEGER NOT NULL UNIQUE DEFAULT nextval('pr_id_val')"),
1386                 array("recentchanges", "rc_deleted",           "SMALLINT NOT NULL DEFAULT 0"),
1387                 array("recentchanges", "rc_log_action",        "TEXT"),
1388         array("recentchanges", "rc_log_type",          "TEXT"),
1389         array("recentchanges", "rc_logid",             "INTEGER NOT NULL DEFAULT 0"),
1390                 array("recentchanges", "rc_new_len",           "INTEGER"),
1391                 array("recentchanges", "rc_old_len",           "INTEGER"),
1392                 array("recentchanges", "rc_params",            "TEXT"),
1393                 array("revision",      "rev_len",              "INTEGER"),
1394                 array("revision",      "rev_deleted",          "SMALLINT NOT NULL DEFAULT 0"),
1395         );
1398         # table, column, desired type, USING clause if needed (with new default if needed)
1399         $typechanges = array(
1400                 array("archive",      "ar_deleted",      "smallint", ""),
1401                 array("archive",      "ar_minor_edit",   "smallint", "ar_minor_edit::smallint DEFAULT 0"),
1402                 array("filearchive",  "fa_deleted",      "smallint", ""),
1403                 array("filearchive",  "fa_height",       "integer",  ""),
1404                 array("filearchive",  "fa_metadata",     "bytea",    "decode(fa_metadata,'escape')"),
1405                 array("filearchive",  "fa_size",         "integer",  ""),
1406                 array("filearchive",  "fa_width",        "integer",  ""),
1407                 array("filearchive",  "fa_storage_group","text",     ""),
1408                 array("filearchive",  "fa_storage_key",  "text",     ""),
1409                 array("image",        "img_metadata",    "bytea",    "decode(img_metadata,'escape')"),
1410                 array("image",        "img_size",        "integer",  ""),
1411                 array("image",        "img_width",       "integer",  ""),
1412                 array("image",        "img_height",      "integer",  ""),
1413                 array("interwiki",    "iw_local",        "smallint", "iw_local::smallint DEFAULT 0"),
1414                 array("interwiki",    "iw_trans",        "smallint", "iw_trans::smallint DEFAULT 0"),
1415                 array("ipblocks",     "ipb_auto",        "smallint", "ipb_auto::smallint DEFAULT 0"),
1416                 array("ipblocks",     "ipb_anon_only",   "smallint", "ipb_anon_only::smallint DEFAULT 0"),
1417                 array("ipblocks",     "ipb_create_account", "smallint", "ipb_create_account::smallint DEFAULT 1"),
1418                 array("ipblocks",     "ipb_enable_autoblock", "smallint", "ipb_enable_autoblock::smallint DEFAULT 1"),
1419                 array("ipblocks",     "ipb_block_email", "smallint", "ipb_block_email::smallint DEFAULT 0"),
1420                 array("ipblocks",     "ipb_address",     "text",     "ipb_address::text"),
1421                 array("ipblocks",     "ipb_deleted",     "smallint", "ipb_deleted::smallint"),
1422                 array("math",         "math_inputhash",  "bytea",    "decode(math_inputhash,'escape')"),
1423                 array("math",         "math_outputhash", "bytea",    "decode(math_outputhash,'escape')"),
1424                 array("mwuser",       "user_token",      "text",     ""),
1425                 array("mwuser",       "user_email_token","text",     ""),
1426                 array("objectcache",  "keyname",         "text",     ""),
1427                 array("oldimage",     "oi_height",       "integer",  ""),
1428                 array("oldimage",     "oi_size",         "integer",  ""),
1429                 array("oldimage",     "oi_width",        "integer",  ""),
1430                 array("page",         "page_is_redirect","smallint", "page_is_redirect::smallint DEFAULT 0"),
1431                 array("page",         "page_is_new",     "smallint", "page_is_new::smallint DEFAULT 0"),
1432                 array("querycache",   "qc_value",        "integer",  ""),
1433                 array("querycachetwo","qcc_value",       "integer",  ""),
1434                 array("recentchanges","rc_bot",          "smallint", "rc_bot::smallint DEFAULT 0"),
1435                 array("recentchanges","rc_deleted",      "smallint", ""),
1436                 array("recentchanges","rc_minor",        "smallint", "rc_minor::smallint DEFAULT 0"),
1437                 array("recentchanges","rc_new",          "smallint", "rc_new::smallint DEFAULT 0"),
1438                 array("recentchanges","rc_type",         "smallint", "rc_type::smallint DEFAULT 0"),
1439                 array("recentchanges","rc_patrolled",    "smallint", "rc_patrolled::smallint DEFAULT 0"),
1440                 array("revision",     "rev_minor_edit",  "smallint", "rev_minor_edit::smallint DEFAULT 0"),
1441                 array("templatelinks","tl_namespace",    "smallint", "tl_namespace::smallint"),
1442                 array("user_newtalk", "user_ip",         "text",     "host(user_ip)"),
1443         );
1445         $newindexes = array(
1446                 array("archive",       "archive_user_text", "(ar_user_text)"),
1447                 array("image",         "img_sha1",          "(img_sha1)"),
1448                 array("oldimage",      "oi_sha1",           "(oi_sha1)"),
1449                 array("revision",      "rev_text_id_idx",   "(rev_text_id)"),
1450         );
1452         $newrules = array(
1453         );
1455         foreach ($newsequences as $ns) {
1456                 if ($wgDatabase->sequenceExists($ns)) {
1457                         echo "... sequence \"$ns\" already exists\n";
1458                         continue;
1459                 }
1461                 echo "Creating sequence \"$ns\"\n";
1462                 $wgDatabase->query("CREATE SEQUENCE $ns");
1463         }
1465         foreach ($newtables as $nt) {
1466                 if ($wgDatabase->tableExists($nt[0])) {
1467                         echo "... table \"$nt[0]\" already exists\n";
1468                         continue;
1469                 }
1471                 echo "Creating table \"$nt[0]\"\n";
1472                 dbsource(archive($nt[1]));
1473         }
1475         ## Needed before newcols
1476         if ($wgDatabase->tableExists("archive2")) {
1477                 echo "Converting \"archive2\" back to normal archive table\n";
1478                 if ($wgDatabase->ruleExists("archive", "archive_insert")) {
1479                         echo "Dropping rule \"archive_insert\"\n";
1480                         $wgDatabase->query("DROP RULE archive_insert ON archive");
1481                 }
1482                 if ($wgDatabase->ruleExists("archive", "archive_delete")) {
1483                         echo "Dropping rule \"archive_delete\"\n";
1484                         $wgDatabase->query("DROP RULE archive_delete ON archive");
1485                 }
1486                 dbsource(archive("patch-remove-archive2.sql"));
1487         }
1488         else
1489                 echo "... obsolete table \"archive2\" does not exist\n";
1491         foreach ($newcols as $nc) {
1492                 $fi = $wgDatabase->fieldInfo($nc[0], $nc[1]);
1493                 if (!is_null($fi)) {
1494                         echo "... column \"$nc[0].$nc[1]\" already exists\n";
1495                         continue;
1496                 }
1498                 echo "Adding column \"$nc[0].$nc[1]\"\n";
1499                 $wgDatabase->query("ALTER TABLE $nc[0] ADD $nc[1] $nc[2]");
1500         }
1502         foreach ($typechanges as $tc) {
1503                 $fi = $wgDatabase->fieldInfo($tc[0], $tc[1]);
1504                 if (is_null($fi)) {
1505                         echo "... error: expected column $tc[0].$tc[1] to exist\n";
1506                         exit(1);
1507                 }
1509                 if ($fi->type() === $tc[2])
1510                         echo "... column \"$tc[0].$tc[1]\" is already of type \"$tc[2]\"\n";
1511                 else {
1512                         echo "Changing column type of \"$tc[0].$tc[1]\" from \"{$fi->type()}\" to \"$tc[2]\"\n";
1513                         $sql = "ALTER TABLE $tc[0] ALTER $tc[1] TYPE $tc[2]";
1514                         if (strlen($tc[3])) {
1515                                 $default = array();
1516                                 if (preg_match( '/DEFAULT (.+)/', $tc[3], $default)) {
1517                                         $sqldef = "ALTER TABLE $tc[0] ALTER $tc[1] SET DEFAULT $default[1]";
1518                                         $wgDatabase->query($sqldef);
1519                                         $tc[3] = preg_replace( '/\s*DEFAULT .+/', '', $tc[3]);
1520                                 }
1521                                 $sql .= " USING $tc[3]";
1522                         }
1523                         $sql .= ";\nCOMMIT;\n";
1524                         $wgDatabase->query($sql);
1525                 }
1526         }
1528         if ($wgDatabase->fieldInfo('oldimage','oi_deleted')->type() !== 'smallint') {
1529                 echo "Changing \"oldimage.oi_deleted\" to type \"smallint\"\n";
1530                 $wgDatabase->query( "ALTER TABLE oldimage ALTER oi_deleted DROP DEFAULT" );
1531                 $wgDatabase->query( "ALTER TABLE oldimage ALTER oi_deleted TYPE SMALLINT USING (oi_deleted::smallint)" );
1532                 $wgDatabase->query( "ALTER TABLE oldimage ALTER oi_deleted SET DEFAULT 0" );
1533         }
1534         else
1535                 echo "... column \"oldimage.oi_deleted\" is already of type \"smallint\"\n";
1538         foreach ($newindexes as $ni) {
1539                 if (pg_index_exists($ni[0], $ni[1])) {
1540                         echo "... index \"$ni[1]\" on table \"$ni[0]\" already exists\n";
1541                         continue;
1542                 }
1543                 echo "Creating index \"$ni[1]\" on table \"$ni[0]\" $ni[2]\n";
1544                 $wgDatabase->query( "CREATE INDEX $ni[1] ON $ni[0] $ni[2]" );
1545         }
1547         foreach ($newrules as $nr) {
1548                 if ($wgDatabase->ruleExists($nr[0], $nr[1])) {
1549                         echo "... rule \"$nr[1]\" on table \"$nr[0]\" already exists\n";
1550                         continue;
1551                 }
1552                 echo "Adding rule \"$nr[1]\" to table \"$nr[0]\"\n";
1553                 dbsource(archive($nr[2]));
1554         }
1556         if ($wgDatabase->hasConstraint("oldimage_oi_name_fkey")) {
1557                 echo "Making foriegn key on table \"oldimage\" (to image) a cascade delete\n";
1558                 $wgDatabase->query( "ALTER TABLE oldimage DROP CONSTRAINT oldimage_oi_name_fkey" );
1559                 $wgDatabase->query( "ALTER TABLE oldimage ADD CONSTRAINT oldimage_oi_name_fkey_cascade ".
1560                         "FOREIGN KEY (oi_name) REFERENCES image(img_name) ON DELETE CASCADE" );
1561         }
1562         else
1563                 echo "... table \"oldimage\" has correct cascade delete foreign key to image\n";
1565         if (!$wgDatabase->triggerExists("page", "page_deleted")) {
1566                 echo "Adding function and trigger \"page_deleted\" to table \"page\"\n";
1567                 dbsource(archive('patch-page_deleted.sql'));
1568         }
1569         else
1570                 echo "... table \"page\" has \"page_deleted\" trigger\n";
1572         $fi = $wgDatabase->fieldInfo("recentchanges", "rc_cur_id");
1573         if (!$fi->nullable()) {
1574                 echo "Removing NOT NULL constraint from \"recentchanges.rc_cur_id\"\n";
1575                 dbsource(archive('patch-rc_cur_id-not-null.sql'));
1576         }
1577         else
1578                 echo "... column \"recentchanges.rc_cur_id\" has a NOT NULL constraint\n";
1580         $pu = pg_describe_index("pagelink_unique");
1581         if (!is_null($pu) && ($pu[0] != "pl_from" || $pu[1] != "pl_namespace" || $pu[2] != "pl_title")) {
1582                 echo "Dropping obsolete version of index \"pagelink_unique index\"\n";
1583                 $wgDatabase->query("DROP INDEX pagelink_unique");
1584                 $pu = null;
1585         }
1586         else
1587                 echo "... obsolete version of index \"pagelink_unique index\" does not exist\n";
1589         if (is_null($pu)) {
1590                 echo "Creating index \"pagelink_unique index\"\n";
1591                 $wgDatabase->query("CREATE UNIQUE INDEX pagelink_unique ON pagelinks (pl_from,pl_namespace,pl_title)");
1592         }
1593         else
1594                 echo "... index \"pagelink_unique_index\" aready exists\n";
1596         if (pg_fkey_deltype("revision_rev_user_fkey") == 'r') {
1597                 echo "... constraint \"revision_rev_user_fkey\" is ON DELETE RESTRICT\n";
1598         }
1599         else {
1600                 echo "Changing constraint \"revision_rev_user_fkey\" to ON DELETE RESTRICT\n";
1601                 dbsource(archive('patch-revision_rev_user_fkey.sql'));
1602         }
1604         global $wgExtNewTables, $wgExtPGNewFields, $wgExtNewIndexes;
1605         # Add missing extension tables
1606         foreach ( $wgExtNewTables as $nt ) {
1607                 if ($wgDatabase->tableExists($nt[0])) {
1608                         echo "... table \"$nt[0]\" already exists\n";
1609                         continue;
1610                 }
1611                 echo "Creating table \"$nt[0]\"\n";
1612                 dbsource($nt[1]);
1613         }
1614         # Add missing extension fields
1615         foreach ( $wgExtPGNewFields as $nc ) {
1616                 $fi = $wgDatabase->fieldInfo($nc[0], $nc[1]);
1617                 if (!is_null($fi)) {
1618                         echo "... column \"$nc[0].$nc[1]\" already exists\n";
1619                         continue;
1620                 }
1621                 echo "Adding column \"$nc[0].$nc[1]\"\n";
1622                 $wgDatabase->query( "ALTER TABLE $nc[0] ADD $nc[1] $nc[2]" );
1623         }
1624         # Add missing extension indexes
1625         foreach ( $wgExtNewIndexes as $ni ) {
1626                 if (pg_index_exists($ni[0], $ni[1])) {
1627                         echo "... index \"$ni[1]\" on table \"$ni[0]\" already exists\n";
1628                         continue;
1629                 }
1630                 echo "Creating index \"$ni[1]\" on table \"$ni[0]\"\n";
1631                 dbsource($ni[2]);
1632         }
1634         # Tweak the page_title tsearch2 trigger to filter out slashes
1635         # This is create or replace, so harmless to call if not needed
1636         dbsource(archive('patch-ts2pagetitle.sql'));
1638         ## If the server is 8.3 or higher, rewrite teh tsearch2 triggers
1639         ## in case they have the old 'default' versions
1640         if ( $numver >= 8.3 )
1641                 dbsource(archive('patch-tsearch2funcs.sql'));
1643         return;