From 6bbd4bca6c1341395988fdfdcf4788ce187edfa9 Mon Sep 17 00:00:00 2001 From: Erik Bernhardson Date: Fri, 25 Oct 2013 13:10:42 -0700 Subject: [PATCH] Revert "Revert "Add new recentchanges field rc_source to replace rc_type"" This reverts commit 113f49bb21487f813548fa4e75ecb568c433ecbf after the schema change has been completed. Change-Id: I5412466444526986e1209d0982dd62cd5b387ad1 --- RELEASE-NOTES-1.22 | 9 ++ includes/changes/RecentChange.php | 14 +++ includes/installer/MysqlUpdater.php | 1 + includes/installer/PostgresUpdater.php | 3 + includes/installer/SqliteUpdater.php | 3 + maintenance/archives/patch-rc_source.sql | 16 +++ maintenance/populateRecentChangesSource.php | 105 ++++++++++++++++++++ maintenance/postgres/tables.sql | 1 + maintenance/rebuildrecentchanges.php | 1 + maintenance/tables.sql | 4 + 10 files changed, 157 insertions(+) create mode 100644 maintenance/archives/patch-rc_source.sql create mode 100644 maintenance/populateRecentChangesSource.php diff --git a/RELEASE-NOTES-1.22 b/RELEASE-NOTES-1.22 index 4cfd6618c4..b8e9ecd0fb 100644 --- a/RELEASE-NOTES-1.22 +++ b/RELEASE-NOTES-1.22 @@ -412,6 +412,15 @@ changes to languages because of Bugzilla reports. * (bug 46751) Made Buryat (Russia) (буряад) (bxr) fallback to Russian. === Other changes in 1.22 === +* The rc_type field in the recentchanges table has been superseded by a new + rc_source field. The rc_source field is a string representation of the + change type where rc_type was a numeric constant. This field is not yet + queried but will be in a future point release of 1.22. +** Utilize update.php to create and populate this new field. On larger wiki's + which do not wish to update recentchanges table in one large update please + review the sql and comments in maintenance/archives/patch-rc_source.sql. +** The rc_type field of recentchanges will be deprecated in a future point + release. * BREAKING CHANGE: Implementation of MediaWiki's JS and JSON value encoding has changed: ** MediaWiki no longer supports PHP installations in which the native JSON diff --git a/includes/changes/RecentChange.php b/includes/changes/RecentChange.php index 980bd0a041..282890f726 100644 --- a/includes/changes/RecentChange.php +++ b/includes/changes/RecentChange.php @@ -30,6 +30,7 @@ * rc_namespace namespace # * rc_title non-prefixed db key * rc_type is new entry, used to determine whether updating is necessary + * rc_source string representation of change source * rc_minor is minor * rc_cur_id page_id of associated page entry * rc_user user id who made the entry @@ -64,6 +65,14 @@ * @todo document functions and variables */ class RecentChange { + + // Constants for the rc_source field. Extensions may also have + // their own source constants. + const SRC_EDIT = 'mw.edit'; + const SRC_NEW = 'mw.new'; + const SRC_LOG = 'mw.log'; + const SRC_EXTERNAL = 'mw.external'; // obsolete + var $mAttribs = array(), $mExtra = array(); /** @@ -159,6 +168,7 @@ class RecentChange { 'rc_this_oldid', 'rc_last_oldid', 'rc_type', + 'rc_source', 'rc_patrolled', 'rc_ip', 'rc_old_len', @@ -489,6 +499,7 @@ class RecentChange { 'rc_namespace' => $title->getNamespace(), 'rc_title' => $title->getDBkey(), 'rc_type' => RC_EDIT, + 'rc_source' => self::SRC_EDIT, 'rc_minor' => $minor ? 1 : 0, 'rc_cur_id' => $title->getArticleID(), 'rc_user' => $user->getId(), @@ -548,6 +559,7 @@ class RecentChange { 'rc_namespace' => $title->getNamespace(), 'rc_title' => $title->getDBkey(), 'rc_type' => RC_NEW, + 'rc_source' => self::SRC_NEW, 'rc_minor' => $minor ? 1 : 0, 'rc_cur_id' => $title->getArticleID(), 'rc_user' => $user->getId(), @@ -657,6 +669,7 @@ class RecentChange { 'rc_namespace' => $target->getNamespace(), 'rc_title' => $target->getDBkey(), 'rc_type' => RC_LOG, + 'rc_source' => self::SRC_LOG, 'rc_minor' => 0, 'rc_cur_id' => $target->getArticleID(), 'rc_user' => $user->getId(), @@ -716,6 +729,7 @@ class RecentChange { 'rc_comment' => $row->rev_comment, 'rc_minor' => $row->rev_minor_edit ? 1 : 0, 'rc_type' => $row->page_is_new ? RC_NEW : RC_EDIT, + 'rc_source' => $row->page_is_new ? self::SRC_NEW : self::SRC_EDIT, 'rc_cur_id' => $row->page_id, 'rc_this_oldid' => $row->rev_id, 'rc_last_oldid' => isset( $row->rc_last_oldid ) ? $row->rc_last_oldid : 0, diff --git a/includes/installer/MysqlUpdater.php b/includes/installer/MysqlUpdater.php index 6ff7af0e0f..059407348c 100644 --- a/includes/installer/MysqlUpdater.php +++ b/includes/installer/MysqlUpdater.php @@ -239,6 +239,7 @@ class MysqlUpdater extends DatabaseUpdater { 'patch-iwlinks-from-title-index.sql' ), array( 'addField', 'archive', 'ar_id', 'patch-archive-ar_id.sql' ), array( 'addField', 'externallinks', 'el_id', 'patch-externallinks-el_id.sql' ), + array( 'addField', 'recentchanges', 'rc_source', 'patch-rc_source.sql' ), ); } diff --git a/includes/installer/PostgresUpdater.php b/includes/installer/PostgresUpdater.php index dfe7865e84..32e75108ec 100644 --- a/includes/installer/PostgresUpdater.php +++ b/includes/installer/PostgresUpdater.php @@ -395,6 +395,9 @@ class PostgresUpdater extends DatabaseUpdater { array( 'addInterwikiType' ), # end array( 'tsearchFixes' ), + + // 1.22 + array( 'addPgField', 'recentchanges', 'rc_source', "TEXT NOT NULL DEFAULT ''" ), ); } diff --git a/includes/installer/SqliteUpdater.php b/includes/installer/SqliteUpdater.php index 78ca51106f..020993a2a2 100644 --- a/includes/installer/SqliteUpdater.php +++ b/includes/installer/SqliteUpdater.php @@ -114,6 +114,9 @@ class SqliteUpdater extends DatabaseUpdater { array( 'addIndex', 'iwlinks', 'iwl_prefix_from_title', 'patch-iwlinks-from-title-index.sql' ), array( 'addField', 'archive', 'ar_id', 'patch-archive-ar_id.sql' ), array( 'addField', 'externallinks', 'el_id', 'patch-externallinks-el_id.sql' ), + + // 1.22 + array( 'addField', 'recentchanges', 'rc_source', 'patch-rc_source.sql' ), ); } diff --git a/maintenance/archives/patch-rc_source.sql b/maintenance/archives/patch-rc_source.sql new file mode 100644 index 0000000000..7dedd7451b --- /dev/null +++ b/maintenance/archives/patch-rc_source.sql @@ -0,0 +1,16 @@ +-- first step of migrating recentchanges rc_type to rc_source +ALTER TABLE /*$wgDBprefix*/recentchanges + ADD rc_source varbinary(16) NOT NULL default ''; + +-- Populate rc_source field with the data from rc_type +-- Large wiki's might prefer the PopulateRecentChangeSource maintenance +-- script to batch updates into groups rather than all at once. +UPDATE /*$wgDBprefix*/recentchanges + SET rc_source = CASE + WHEN rc_type = 0 THEN 'mw.edit' + WHEN rc_type = 1 THEN 'mw.new' + WHEN rc_type = 3 THEN 'mw.log' + WHEN rc_type = 5 THEN 'mw.external' + ELSE '' + END +WHERE rc_source = ''; diff --git a/maintenance/populateRecentChangesSource.php b/maintenance/populateRecentChangesSource.php new file mode 100644 index 0000000000..0e8e501252 --- /dev/null +++ b/maintenance/populateRecentChangesSource.php @@ -0,0 +1,105 @@ +mDescription = "Populates rc_source field of the recentchanges table with the data in rc_type."; + $this->setBatchSize( 100 ); + } + + protected function doDBUpdates() { + $dbw = $this->getDB( DB_MASTER ); + if ( !$dbw->fieldExists( 'recentchanges', 'rc_source' ) ) { + $this->error( 'rc_source field in recentchanges table does not exist.' ); + } + + $start = $dbw->selectField( 'recentchanges', 'MIN(rc_id)', false, __METHOD__ ); + if ( !$start ) { + $this->output( "Nothing to do.\n" ); + return true; + } + $end = $dbw->selectField( 'recentchanges', 'MAX(rc_id)', false, __METHOD__ ); + $end += $this->mBatchSize - 1; + $blockStart = $start; + $blockEnd = $start + $this->mBatchSize - 1; + + $updatedValues = $this->buildUpdateCondition( $dbw ); + + while ( $blockEnd <= $end ) { + $cond = "rc_id BETWEEN $blockStart AND $blockEnd"; + + $dbw->update( + 'recentchanges', + array( $updatedValues ), + array( + "rc_source = ''", + "rc_id BETWEEN $blockStart AND $blockEnd" + ), + __METHOD__ + ); + + $this->output( "." ); + wfWaitForSlaves(); + + $blockStart += $this->mBatchSize; + $blockEnd += $this->mBatchSize; + } + + $this->output( "\nDone.\n" ); + } + + protected function getUpdateKey() { + return __CLASS__; + } + + protected function buildUpdateCondition( DatabaseBase $dbw ) { + $rcNew = $dbw->addQuotes( RC_NEW ); + $rcSrcNew = $dbw->addQuotes( RecentChange::SRC_NEW ); + $rcEdit = $dbw->addQuotes( RC_EDIT ); + $rcSrcEdit = $dbw->addQuotes( RecentChange::SRC_EDIT ); + $rcLog = $dbw->addQuotes( RC_LOG ); + $rcSrcLog = $dbw->addQuotes( RecentChange::SRC_LOG ); + $rcExternal = $dbw->addQuotes( RC_EXTERNAL ); + $rcSrcExternal = $dbw->addQuotes( RecentChange::SRC_EXTERNAL ); + + return "rc_source = CASE + WHEN rc_type = $rcNew THEN $rcSrcNew + WHEN rc_type = $rcEdit THEN $rcSrcEdit + WHEN rc_type = $rcLog THEN $rcSrcLog + WHEN rc_type = $rcExternal THEN $rcSrcExternal + ELSE '' + END"; + } +} + +$maintClass = "PopulateRecentChangesSource"; +require_once RUN_MAINTENANCE_IF_MAIN; diff --git a/maintenance/postgres/tables.sql b/maintenance/postgres/tables.sql index bc2428e4da..d0d1e92de8 100644 --- a/maintenance/postgres/tables.sql +++ b/maintenance/postgres/tables.sql @@ -411,6 +411,7 @@ CREATE TABLE recentchanges ( rc_this_oldid INTEGER NOT NULL, rc_last_oldid INTEGER NOT NULL, rc_type SMALLINT NOT NULL DEFAULT 0, + rc_source TEXT NOT NULL, rc_patrolled SMALLINT NOT NULL DEFAULT 0, rc_ip CIDR, rc_old_len INTEGER, diff --git a/maintenance/rebuildrecentchanges.php b/maintenance/rebuildrecentchanges.php index 18348258b0..315176c12c 100644 --- a/maintenance/rebuildrecentchanges.php +++ b/maintenance/rebuildrecentchanges.php @@ -83,6 +83,7 @@ class RebuildRecentchanges extends Maintenance { 'rc_this_oldid' => 'rev_id', 'rc_last_oldid' => 0, // is this ok? 'rc_type' => $dbw->conditional( 'page_is_new != 0', RC_NEW, RC_EDIT ), + 'rc_source' => $dbw->conditional( 'page_is_new != 0', $dbw->addQuotes( RecentChange::SRC_NEW ), $dbw->addQuotes( RecentChange::SRC_EDIT ) ), 'rc_deleted' => 'rev_deleted' ), array( 'rev_timestamp > ' . $dbw->addQuotes( $dbw->timestamp( $cutoff ) ), diff --git a/maintenance/tables.sql b/maintenance/tables.sql index de92ef53e9..53068eacbd 100644 --- a/maintenance/tables.sql +++ b/maintenance/tables.sql @@ -1062,6 +1062,10 @@ CREATE TABLE /*_*/recentchanges ( -- The type of change entry (RC_EDIT,RC_NEW,RC_LOG,RC_EXTERNAL) rc_type tinyint unsigned NOT NULL default 0, + -- The source of the change entry (replaces rc_type) + -- default of '' is temporary, needed for initial migration + rc_source varchar(16) binary not null default '', + -- If the Recent Changes Patrol option is enabled, -- users may mark edits as having been reviewed to -- remove a warning flag on the RC list. -- 2.20.1