New Hook rc/watchlist hook ChangesListBegin

An extension hooking into recent changes may need to load additional
data that did not fit into the recentchanges table.  This hook gives
revisions an opportunity to see the full result prior to rendering
and batch load where approprite rather than loading piecemeal during
the render process.

Change-Id: I28d4e41437e485e518f2a23b6da00cdc430a8c23

diff --git a/RELEASE-NOTES-1.23 b/RELEASE-NOTES-1.23
index 340aa50..4e00d40 100644 (file)
--- a/RELEASE-NOTES-1.23
+++ b/RELEASE-NOTES-1.23
@@ -130,6 +130,8 @@ production.
 * Added BaseTemplateAfterPortlet hook to allow injecting html after portlets in skins.
 * Support has been added for a JSON based localisation file format. The
   installer has been updated to use it.
+* Add new hooks OldChangesListBegin and EnhancedChangesListBegin hooks to allow
+  extensions a chance to batch process the result set prior to rendering.
 
 === Bug fixes in 1.23 ===
 * (bug 41759) The "updated since last visit" markers (on history pages, recent

diff --git a/docs/hooks.txt b/docs/hooks.txt
index e4037e6..122a89b 100644 (file)
--- a/docs/hooks.txt
+++ b/docs/hooks.txt
@@ -1112,6 +1112,11 @@ $editToken: The user's edit token.
 &$hookErr: Out-param for the error. Passed as the parameters to
   OutputPage::showErrorPage.
 
+'EnhancedChangesListBegin': to receive the full list of rows to be rendered
+in the enhanced changes list before rendering begings.
+$changesList: EnhancedChangesList object
+$rows: ResultWrapper containing all rows to be rendered
+
 'ExemptFromAccountCreationThrottle': Exemption from the account creation
 throttle.
 $ip: The ip address of the user
@@ -1742,6 +1747,11 @@ displayed.
 &$transform: whether or not to expand variables and templates
   in the message (bool)
 
+'OldChangesListBegin': to receive the full list of rows to be rendered
+in the enhanced changes list before rendering begings.
+$changesList: OldChangesList object
+$rows: array containing all rows to be rendered
+
 'OldChangesListRecentChangesLine': Customize entire recent changes line, or
 return false to omit the line from RecentChanges and Watchlist special pages.
 &$changeslist: The OldChangesList instance.

diff --git a/includes/changes/ChangesList.php b/includes/changes/ChangesList.php
index ca9efc3..5116901 100644 (file)
--- a/includes/changes/ChangesList.php
+++ b/includes/changes/ChangesList.php
@@ -160,9 +160,10 @@ class ChangesList extends ContextSource {
 
        /**
         * Returns text for the start of the tabular part of RC
+        * @param ResultWrapper|array $rows
         * @return string
         */
-       public function beginRecentChangesList() {
+       public function beginRecentChangesList( $rows ) {
                $this->rc_cache = array();
                $this->rcMoveIndex = 0;
                $this->rcCacheIndex = 0;

diff --git a/includes/changes/EnhancedChangesList.php b/includes/changes/EnhancedChangesList.php
index feb6d7b..de8bf72 100644 (file)
--- a/includes/changes/EnhancedChangesList.php
+++ b/includes/changes/EnhancedChangesList.php
@@ -59,9 +59,11 @@ class EnhancedChangesList extends ChangesList {
 
        /**
         * Add the JavaScript file for enhanced changeslist
+        *
+        * @param ResultWrapper $res
         * @return string
         */
-       public function beginRecentChangesList() {
+       public function beginRecentChangesList( $res ) {
                $this->rc_cache = array();
                $this->rcMoveIndex = 0;
                $this->rcCacheIndex = 0;
@@ -76,6 +78,8 @@ class EnhancedChangesList extends ChangesList {
                        'mediawiki.icon',
                ) );
 
+               wfRunHooks( 'EnhancedChangesListBegin', array( $this, $res ) );
+
                return '<div class="mw-changeslist">';
        }
 

diff --git a/includes/changes/OldChangesList.php b/includes/changes/OldChangesList.php
index 458f21a..d88e99a 100644 (file)
--- a/includes/changes/OldChangesList.php
+++ b/includes/changes/OldChangesList.php
@@ -130,4 +130,15 @@ class OldChangesList extends ChangesList {
 
                return "$dateheader<li class=\"" . implode( ' ', $classes ) . "\">" . $s . "</li>\n";
        }
+
+       /**
+        * Returns text for the start of the tabular part of RC
+        *
+        * @param ResultWrapper $res
+        * @return string
+        */
+       public function beginRecentChangesList( $res ) {
+               wfRunHooks( 'OldChangesListBegin', array( $this, $res ) );
+               return parent::beginRecentChangesList( $res );
+       }
 }

diff --git a/includes/specials/SpecialRecentchanges.php b/includes/specials/SpecialRecentchanges.php
index 720d0a8..885e4cf 100644 (file)
--- a/includes/specials/SpecialRecentchanges.php
+++ b/includes/specials/SpecialRecentchanges.php
@@ -295,7 +295,7 @@ class SpecialRecentChanges extends ChangesListSpecialPage {
                $counter = 1;
                $list = ChangesList::newFromContext( $this->getContext() );
 
-               $rclistOutput = $list->beginRecentChangesList();
+               $rclistOutput = $list->beginRecentChangesList( $rows );
                foreach ( $rows as $obj ) {
                        if ( $limit == 0 ) {
                                break;

diff --git a/includes/specials/SpecialWatchlist.php b/includes/specials/SpecialWatchlist.php
index 4c3f17b..7c3002d 100644 (file)
--- a/includes/specials/SpecialWatchlist.php
+++ b/includes/specials/SpecialWatchlist.php
@@ -317,7 +317,8 @@ class SpecialWatchlist extends ChangesListSpecialPage {
                $list = ChangesList::newFromContext( $this->getContext() );
                $list->setWatchlistDivs();
 
-               $s = $list->beginRecentChangesList();
+               $s = $list->beginRecentChangesList( $rows );
+               $dbr->dataSeek( $rows, 0 );
                $counter = 1;
                foreach ( $rows as $obj ) {
                        # Make RC entry