From c8e0ec3f4b9c5b7378f00ab4de162d22a741afbf Mon Sep 17 00:00:00 2001 From: mlitn Date: Mon, 2 Jul 2012 15:31:06 +0200 Subject: [PATCH] Introduce a new hook that allows extensions to add to My Contributions Meanwhile also: - refactored reallyDoQuery in Pager.php, to make outside intervention possible - extend reallyDoQuery in SpecialContributions.php, adding in the hook and composing the final results array based on the combined results of all queries added through the hook Change-Id: Ifd63cdf1950f914a3fba1757a905385aca311eda --- RELEASE-NOTES-1.20 | 1 + docs/hooks.txt | 7 + includes/Pager.php | 20 +- includes/specials/SpecialContributions.php | 281 +++++++++++++-------- 4 files changed, 205 insertions(+), 104 deletions(-) diff --git a/RELEASE-NOTES-1.20 b/RELEASE-NOTES-1.20 index 755d703515..c1a25e1db1 100644 --- a/RELEASE-NOTES-1.20 +++ b/RELEASE-NOTES-1.20 @@ -82,6 +82,7 @@ upgrade PHP if you have not done so prior to upgrading MediaWiki. tags with class "mw-watched". Instead, each line now has a class "mw-changeslist-line-watched" or "mw-changeslist-line-not-watched", and the title itself is surrounded by tags with class "mw-title". +* Added ContribsPager::reallyDoQuery hook allowing extensions to data to MyContribs === Bug fixes in 1.20 === * (bug 30245) Use the correct way to construct a log page title. diff --git a/docs/hooks.txt b/docs/hooks.txt index 7df2c39d7e..9dec097489 100644 --- a/docs/hooks.txt +++ b/docs/hooks.txt @@ -703,6 +703,13 @@ $user: user (object) whose email is being confirmed &$pager: Pager object for contributions &$queryInfo: The query for the contribs Pager +'ContribsPager::reallyDoQuery': Called before really executing the query for My Contributions +&$data: an array of results of all contribs queries +$pager: The ContribsPager object hooked into +$offset: Index offset, inclusive +$limit: Exact query limit +$descending: Query direction, false for ascending, true for descending + 'ContributionsLineEnding': Called before a contributions HTML line is finished $page: SpecialPage object for contributions &$ret: the HTML line diff --git a/includes/Pager.php b/includes/Pager.php index bcd6d14cff..9d1f9fcb7e 100644 --- a/includes/Pager.php +++ b/includes/Pager.php @@ -194,6 +194,7 @@ abstract class IndexPager extends ContextSource implements Pager { $queryLimit, $descending ); + $this->extractResultInfo( $this->mOffset, $queryLimit, $this->mResult ); $this->mQueryDone = true; @@ -303,7 +304,21 @@ abstract class IndexPager extends ContextSource implements Pager { * @param $descending Boolean: query direction, false for ascending, true for descending * @return ResultWrapper */ - function reallyDoQuery( $offset, $limit, $descending ) { + public function reallyDoQuery( $offset, $limit, $descending ) { + list( $tables, $fields, $conds, $fname, $options, $join_conds ) = $this->buildQueryInfo( $offset, $limit, $descending ); + $result = $this->mDb->select( $tables, $fields, $conds, $fname, $options, $join_conds ); + return new ResultWrapper( $this->mDb, $result ); + } + + /** + * Build variables to use by the database wrapper. + * + * @param $offset String: index offset, inclusive + * @param $limit Integer: exact query limit + * @param $descending Boolean: query direction, false for ascending, true for descending + * @return array + */ + protected function buildQueryInfo( $offset, $limit, $descending ) { $fname = __METHOD__ . ' (' . $this->getSqlComment() . ')'; $info = $this->getQueryInfo(); $tables = $info['tables']; @@ -327,8 +342,7 @@ abstract class IndexPager extends ContextSource implements Pager { $conds[] = $this->mIndexField . $operator . $this->mDb->addQuotes( $offset ); } $options['LIMIT'] = intval( $limit ); - $res = $this->mDb->select( $tables, $fields, $conds, $fname, $options, $join_conds ); - return new ResultWrapper( $this->mDb, $res ); + return array( $tables, $fields, $conds, $fname, $options, $join_conds ); } /** diff --git a/includes/specials/SpecialContributions.php b/includes/specials/SpecialContributions.php index 50192ac922..7823a8956b 100644 --- a/includes/specials/SpecialContributions.php +++ b/includes/specials/SpecialContributions.php @@ -594,6 +594,66 @@ class ContribsPager extends ReverseChronologicalPager { return $query; } + /** + * This method basically executes the exact same code as the parent class, though with + * a hook added, to allow extentions to add additional queries. + * + * @param $offset String: index offset, inclusive + * @param $limit Integer: exact query limit + * @param $descending Boolean: query direction, false for ascending, true for descending + * @return ResultWrapper + */ + function reallyDoQuery( $offset, $limit, $descending ) { + list( $tables, $fields, $conds, $fname, $options, $join_conds ) = $this->buildQueryInfo( $offset, $limit, $descending ); + $pager = $this; + + /* + * This hook will allow extensions to add in additional queries, so they can get their data + * in My Contributions as well. Extensions should append their results to the $data array. + * + * Extension queries have to implement the navbar requirement as well. They should + * - have a column aliased as $pager->getIndexField() + * - have LIMIT set + * - have a WHERE-clause that compares the $pager->getIndexField()-equivalent column to the offset + * - have the ORDER BY specified based upon the details provided by the navbar + * + * See includes/Pager.php buildQueryInfo() method on how to build LIMIT, WHERE & ORDER BY + * + * &$data: an array of results of all contribs queries + * $pager: the ContribsPager object hooked into + * $offset: see phpdoc above + * $limit: see phpdoc above + * $descending: see phpdoc above + */ + $data = array( $this->mDb->select( $tables, $fields, $conds, $fname, $options, $join_conds ) ); + wfRunHooks( 'ContribsPager::reallyDoQuery', array( &$data, $pager, $offset, $limit, $descending ) ); + + $result = array(); + + // loop all results and collect them in an array + foreach ( $data as $j => $query ) { + foreach ( $query as $i => $row ) { + // use index column as key, allowing us to easily sort in PHP + $result[$row->{$this->getIndexField()} . "-$i"] = $row; + } + } + + // sort results + if ( $descending ) { + ksort( $result ); + } else { + krsort( $result ); + } + + // enforce limit + $result = array_slice( $result, 0, $limit ); + + // get rid of array keys + $result = array_values( $result ); + + return new FakeResultWrapper( $result ); + } + function getQueryInfo() { list( $tables, $index, $userCond, $join_cond ) = $this->getUserCond(); @@ -702,7 +762,7 @@ class ContribsPager extends ReverseChronologicalPager { $this->mResult->rewind(); $revIds = array(); foreach ( $this->mResult as $row ) { - if( $row->rev_parent_id ) { + if( isset( $row->rev_parent_id ) && $row->rev_parent_id ) { $revIds[] = $row->rev_parent_id; } } @@ -714,11 +774,13 @@ class ContribsPager extends ReverseChronologicalPager { $batch = new LinkBatch(); # Give some pointers to make (last) links foreach ( $this->mResult as $row ) { - if ( $this->contribs === 'newbie' ) { // multiple users - $batch->add( NS_USER, $row->user_name ); - $batch->add( NS_USER_TALK, $row->user_name ); + if ( isset( $row->rev_id ) ) { + if ( $this->contribs === 'newbie' ) { // multiple users + $batch->add( NS_USER, $row->user_name ); + $batch->add( NS_USER_TALK, $row->user_name ); + } + $batch->add( $row->page_namespace, $row->page_title ); } - $batch->add( $row->page_namespace, $row->page_title ); } $batch->execute(); $this->mResult->seek( 0 ); @@ -753,123 +815,140 @@ class ContribsPager extends ReverseChronologicalPager { function formatRow( $row ) { wfProfileIn( __METHOD__ ); - $rev = new Revision( $row ); + $ret = ''; $classes = array(); - $page = Title::newFromRow( $row ); - $link = Linker::link( - $page, - htmlspecialchars( $page->getPrefixedText() ), - array(), - $page->isRedirect() ? array( 'redirect' => 'no' ) : array() - ); - # Mark current revisions - $topmarktext = ''; - if ( $row->rev_id == $row->page_latest ) { - $topmarktext .= '' . $this->messages['uctop'] . ''; - # Add rollback link - if ( !$row->page_is_new && $page->quickUserCan( 'rollback' ) - && $page->quickUserCan( 'edit' ) ) - { - $this->preventClickjacking(); - $topmarktext .= ' ' . Linker::generateRollback( $rev ); - } - } - $user = $this->getUser(); - # Is there a visible previous revision? - if ( $rev->userCan( Revision::DELETED_TEXT, $user ) && $rev->getParentId() !== 0 ) { - $difftext = Linker::linkKnown( + /* + * There may be more than just revision rows. To make sure that we'll only be processing + * revisions here, let's _try_ to build a revision out of our row (without displaying + * notices though) and then trying to grab data from the built object. If we succeed, + * we're definitely dealing with revision data and we may proceed, if not, we'll leave it + * to extensions to subscribe to the hook to parse the row. + */ + wfSuppressWarnings(); + $rev = new Revision( $row ); + $validRevision = $rev->getParentId() !== null; + wfRestoreWarnings(); + + if ( $validRevision ) { + $classes = array(); + + $page = Title::newFromRow( $row ); + $link = Linker::link( $page, - $this->messages['diff'], + htmlspecialchars( $page->getPrefixedText() ), array(), - array( - 'diff' => 'prev', - 'oldid' => $row->rev_id - ) + $page->isRedirect() ? array( 'redirect' => 'no' ) : array() ); - } else { - $difftext = $this->messages['diff']; - } - $histlink = Linker::linkKnown( - $page, - $this->messages['hist'], - array(), - array( 'action' => 'history' ) - ); - - if ( $row->rev_parent_id === null ) { - // For some reason rev_parent_id isn't populated for this row. - // Its rumoured this is true on wikipedia for some revisions (bug 34922). - // Next best thing is to have the total number of bytes. - $chardiff = ' . . ' . Linker::formatRevisionSize( $row->rev_len ) . ' . . '; - } else { - $parentLen = isset( $this->mParentLens[$row->rev_parent_id] ) ? $this->mParentLens[$row->rev_parent_id] : 0; - $chardiff = ' . . ' . ChangesList::showCharacterDifference( - $parentLen, $row->rev_len ) . ' . . '; - } - - $lang = $this->getLanguage(); - $comment = $lang->getDirMark() . Linker::revComment( $rev, false, true ); - $date = $lang->userTimeAndDate( $row->rev_timestamp, $user ); - if ( $rev->userCan( Revision::DELETED_TEXT, $user ) ) { - $d = Linker::linkKnown( + # Mark current revisions + $topmarktext = ''; + if ( $row->rev_id == $row->page_latest ) { + $topmarktext .= '' . $this->messages['uctop'] . ''; + # Add rollback link + if ( !$row->page_is_new && $page->quickUserCan( 'rollback' ) + && $page->quickUserCan( 'edit' ) ) + { + $this->preventClickjacking(); + $topmarktext .= ' ' . Linker::generateRollback( $rev ); + } + } + $user = $this->getUser(); + # Is there a visible previous revision? + if ( $rev->userCan( Revision::DELETED_TEXT, $user ) && $rev->getParentId() !== 0 ) { + $difftext = Linker::linkKnown( + $page, + $this->messages['diff'], + array(), + array( + 'diff' => 'prev', + 'oldid' => $row->rev_id + ) + ); + } else { + $difftext = $this->messages['diff']; + } + $histlink = Linker::linkKnown( $page, - htmlspecialchars( $date ), + $this->messages['hist'], array(), - array( 'oldid' => intval( $row->rev_id ) ) + array( 'action' => 'history' ) ); - } else { - $d = htmlspecialchars( $date ); - } - if ( $rev->isDeleted( Revision::DELETED_TEXT ) ) { - $d = '' . $d . ''; - } - # Show user names for /newbies as there may be different users. - # Note that we already excluded rows with hidden user names. - if ( $this->contribs == 'newbie' ) { - $userlink = ' . . ' . Linker::userLink( $rev->getUser(), $rev->getUserText() ); - $userlink .= ' ' . $this->msg( 'parentheses' )->rawParams( - Linker::userTalkLink( $rev->getUser(), $rev->getUserText() ) )->escaped() . ' '; - } else { - $userlink = ''; - } + if ( $row->rev_parent_id === null ) { + // For some reason rev_parent_id isn't populated for this row. + // Its rumoured this is true on wikipedia for some revisions (bug 34922). + // Next best thing is to have the total number of bytes. + $chardiff = ' . . ' . Linker::formatRevisionSize( $row->rev_len ) . ' . . '; + } else { + $parentLen = isset( $this->mParentLens[$row->rev_parent_id] ) ? $this->mParentLens[$row->rev_parent_id] : 0; + $chardiff = ' . . ' . ChangesList::showCharacterDifference( + $parentLen, $row->rev_len ) . ' . . '; + } - if ( $rev->getParentId() === 0 ) { - $nflag = ChangesList::flag( 'newpage' ); - } else { - $nflag = ''; - } + $lang = $this->getLanguage(); + $comment = $lang->getDirMark() . Linker::revComment( $rev, false, true ); + $date = $lang->userTimeAndDate( $row->rev_timestamp, $user ); + if ( $rev->userCan( Revision::DELETED_TEXT, $user ) ) { + $d = Linker::linkKnown( + $page, + htmlspecialchars( $date ), + array(), + array( 'oldid' => intval( $row->rev_id ) ) + ); + } else { + $d = htmlspecialchars( $date ); + } + if ( $rev->isDeleted( Revision::DELETED_TEXT ) ) { + $d = '' . $d . ''; + } - if ( $rev->isMinor() ) { - $mflag = ChangesList::flag( 'minor' ); - } else { - $mflag = ''; - } + # Show user names for /newbies as there may be different users. + # Note that we already excluded rows with hidden user names. + if ( $this->contribs == 'newbie' ) { + $userlink = ' . . ' . Linker::userLink( $rev->getUser(), $rev->getUserText() ); + $userlink .= ' ' . $this->msg( 'parentheses' )->rawParams( + Linker::userTalkLink( $rev->getUser(), $rev->getUserText() ) )->escaped() . ' '; + } else { + $userlink = ''; + } - $del = Linker::getRevDeleteLink( $user, $rev, $page ); - if ( $del !== '' ) { - $del .= ' '; - } + if ( $rev->getParentId() === 0 ) { + $nflag = ChangesList::flag( 'newpage' ); + } else { + $nflag = ''; + } - $diffHistLinks = $this->msg( 'parentheses' )->rawParams( $difftext . $this->messages['pipe-separator'] . $histlink )->escaped(); - $ret = "{$del}{$d} {$diffHistLinks}{$chardiff}{$nflag}{$mflag} {$link}{$userlink} {$comment} {$topmarktext}"; + if ( $rev->isMinor() ) { + $mflag = ChangesList::flag( 'minor' ); + } else { + $mflag = ''; + } - # Denote if username is redacted for this edit - if ( $rev->isDeleted( Revision::DELETED_USER ) ) { - $ret .= " " . $this->msg( 'rev-deleted-user-contribs' )->escaped() . ""; - } + $del = Linker::getRevDeleteLink( $user, $rev, $page ); + if ( $del !== '' ) { + $del .= ' '; + } + + $diffHistLinks = $this->msg( 'parentheses' )->rawParams( $difftext . $this->messages['pipe-separator'] . $histlink )->escaped(); + $ret = "{$del}{$d} {$diffHistLinks}{$chardiff}{$nflag}{$mflag} {$link}{$userlink} {$comment} {$topmarktext}"; - # Tags, if any. - list( $tagSummary, $newClasses ) = ChangeTags::formatSummaryRow( $row->ts_tags, 'contributions' ); - $classes = array_merge( $classes, $newClasses ); - $ret .= " $tagSummary"; + # Denote if username is redacted for this edit + if ( $rev->isDeleted( Revision::DELETED_USER ) ) { + $ret .= " " . $this->msg( 'rev-deleted-user-contribs' )->escaped() . ""; + } + + # Tags, if any. + list( $tagSummary, $newClasses ) = ChangeTags::formatSummaryRow( $row->ts_tags, 'contributions' ); + $classes = array_merge( $classes, $newClasses ); + $ret .= " $tagSummary"; + } // Let extensions add data wfRunHooks( 'ContributionsLineEnding', array( $this, &$ret, $row, &$classes ) ); $classes = implode( ' ', $classes ); $ret = "
  • $ret
    • \n"; + wfProfileOut( __METHOD__ ); return $ret; } -- 2.20.1