diff options
Diffstat (limited to 'includes/changes')
| -rw-r--r-- | includes/changes/ChangesList.php | 552 | ||||
| -rw-r--r-- | includes/changes/EnhancedChangesList.php | 662 | ||||
| -rw-r--r-- | includes/changes/OldChangesList.php | 130 | ||||
| -rw-r--r-- | includes/changes/RCCacheEntry.php | 35 | ||||
| -rw-r--r-- | includes/changes/RecentChange.php | 846 |
5 files changed, 2225 insertions, 0 deletions
diff --git a/includes/changes/ChangesList.php b/includes/changes/ChangesList.php new file mode 100644 index 00000000..bf800c46 --- /dev/null +++ b/includes/changes/ChangesList.php @@ -0,0 +1,552 @@ +<?php +/** + * Base class for all changes lists. + * + * The class is used for formatting recent changes, related changes and watchlist. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * http://www.gnu.org/copyleft/gpl.html + * + * @file + */ + +class ChangesList extends ContextSource { + + /** + * @var Skin + */ + public $skin; + + protected $watchlist = false; + + protected $message; + + /** + * Changeslist constructor + * + * @param $obj Skin or IContextSource + */ + public function __construct( $obj ) { + if ( $obj instanceof IContextSource ) { + $this->setContext( $obj ); + $this->skin = $obj->getSkin(); + } else { + $this->setContext( $obj->getContext() ); + $this->skin = $obj; + } + $this->preCacheMessages(); + } + + /** + * Fetch an appropriate changes list class for the main context + * This first argument used to be an User object. + * + * @deprecated in 1.18; use newFromContext() instead + * @param string|User $unused Unused + * @return ChangesList|EnhancedChangesList|OldChangesList derivative + */ + public static function newFromUser( $unused ) { + wfDeprecated( __METHOD__, '1.18' ); + return self::newFromContext( RequestContext::getMain() ); + } + + /** + * Fetch an appropriate changes list class for the specified context + * Some users might want to use an enhanced list format, for instance + * + * @param $context IContextSource to use + * @return ChangesList|EnhancedChangesList|OldChangesList derivative + */ + public static function newFromContext( IContextSource $context ) { + $user = $context->getUser(); + $sk = $context->getSkin(); + $list = null; + if ( wfRunHooks( 'FetchChangesList', array( $user, &$sk, &$list ) ) ) { + $new = $context->getRequest()->getBool( 'enhanced', $user->getOption( 'usenewrc' ) ); + return $new ? new EnhancedChangesList( $context ) : new OldChangesList( $context ); + } else { + return $list; + } + } + + /** + * Sets the list to use a "<li class='watchlist-(namespace)-(page)'>" tag + * @param $value Boolean + */ + public function setWatchlistDivs( $value = true ) { + $this->watchlist = $value; + } + + /** + * As we use the same small set of messages in various methods and that + * they are called often, we call them once and save them in $this->message + */ + private function preCacheMessages() { + if ( !isset( $this->message ) ) { + foreach ( array( + 'cur', 'diff', 'hist', 'enhancedrc-history', 'last', 'blocklink', 'history', + 'semicolon-separator', 'pipe-separator' ) as $msg + ) { + $this->message[$msg] = $this->msg( $msg )->escaped(); + } + } + } + + /** + * Returns the appropriate flags for new page, minor change and patrolling + * @param array $flags Associative array of 'flag' => Bool + * @param string $nothing to use for empty space + * @return String + */ + public function recentChangesFlags( $flags, $nothing = ' ' ) { + global $wgRecentChangesFlags; + $f = ''; + foreach ( array_keys( $wgRecentChangesFlags ) as $flag ) { + $f .= isset( $flags[$flag] ) && $flags[$flag] + ? self::flag( $flag ) + : $nothing; + } + return $f; + } + + /** + * Provide the "<abbr>" element appropriate to a given abbreviated flag, + * namely the flag indicating a new page, a minor edit, a bot edit, or an + * unpatrolled edit. By default in English it will contain "N", "m", "b", + * "!" respectively, plus it will have an appropriate title and class. + * + * @param string $flag One key of $wgRecentChangesFlags + * @return String: Raw HTML + */ + public static function flag( $flag ) { + static $flagInfos = null; + if ( is_null( $flagInfos ) ) { + global $wgRecentChangesFlags; + $flagInfos = array(); + foreach ( $wgRecentChangesFlags as $key => $value ) { + $flagInfos[$key]['letter'] = wfMessage( $value['letter'] )->escaped(); + $flagInfos[$key]['title'] = wfMessage( $value['title'] )->escaped(); + // Allow customized class name, fall back to flag name + $flagInfos[$key]['class'] = Sanitizer::escapeClass( + isset( $value['class'] ) ? $value['class'] : $key ); + } + } + + // Inconsistent naming, bleh, kepted for b/c + $map = array( + 'minoredit' => 'minor', + 'botedit' => 'bot', + ); + if ( isset( $map[$flag] ) ) { + $flag = $map[$flag]; + } + + return "<abbr class='" . $flagInfos[$flag]['class'] . "' title='" . $flagInfos[$flag]['title'] . "'>" . + $flagInfos[$flag]['letter'] . + '</abbr>'; + } + + /** + * Returns text for the start of the tabular part of RC + * @return String + */ + public function beginRecentChangesList() { + $this->rc_cache = array(); + $this->rcMoveIndex = 0; + $this->rcCacheIndex = 0; + $this->lastdate = ''; + $this->rclistOpen = false; + $this->getOutput()->addModuleStyles( 'mediawiki.special.changeslist' ); + return ''; + } + + /** + * Show formatted char difference + * @param $old Integer: bytes + * @param $new Integer: bytes + * @param $context IContextSource context to use + * @return String + */ + public static function showCharacterDifference( $old, $new, IContextSource $context = null ) { + global $wgRCChangedSizeThreshold, $wgMiserMode; + + if ( !$context ) { + $context = RequestContext::getMain(); + } + + $new = (int)$new; + $old = (int)$old; + $szdiff = $new - $old; + + $lang = $context->getLanguage(); + $code = $lang->getCode(); + static $fastCharDiff = array(); + if ( !isset( $fastCharDiff[$code] ) ) { + $fastCharDiff[$code] = $wgMiserMode || $context->msg( 'rc-change-size' )->plain() === '$1'; + } + + $formattedSize = $lang->formatNum( $szdiff ); + + if ( !$fastCharDiff[$code] ) { + $formattedSize = $context->msg( 'rc-change-size', $formattedSize )->text(); + } + + if ( abs( $szdiff ) > abs( $wgRCChangedSizeThreshold ) ) { + $tag = 'strong'; + } else { + $tag = 'span'; + } + + if ( $szdiff === 0 ) { + $formattedSizeClass = 'mw-plusminus-null'; + } + if ( $szdiff > 0 ) { + $formattedSize = '+' . $formattedSize; + $formattedSizeClass = 'mw-plusminus-pos'; + } + if ( $szdiff < 0 ) { + $formattedSizeClass = 'mw-plusminus-neg'; + } + + $formattedTotalSize = $context->msg( 'rc-change-size-new' )->numParams( $new )->text(); + + return Html::element( $tag, + array( 'dir' => 'ltr', 'class' => $formattedSizeClass, 'title' => $formattedTotalSize ), + $context->msg( 'parentheses', $formattedSize )->plain() ) . $lang->getDirMark(); + } + + /** + * Format the character difference of one or several changes. + * + * @param $old RecentChange + * @param $new RecentChange last change to use, if not provided, $old will be used + * @return string HTML fragment + */ + public function formatCharacterDifference( RecentChange $old, RecentChange $new = null ) { + $oldlen = $old->mAttribs['rc_old_len']; + + if ( $new ) { + $newlen = $new->mAttribs['rc_new_len']; + } else { + $newlen = $old->mAttribs['rc_new_len']; + } + + if ( $oldlen === null || $newlen === null ) { + return ''; + } + + return self::showCharacterDifference( $oldlen, $newlen, $this->getContext() ); + } + + /** + * Returns text for the end of RC + * @return String + */ + public function endRecentChangesList() { + if ( $this->rclistOpen ) { + return "</ul>\n"; + } else { + return ''; + } + } + + /** + * @param string $s HTML to update + * @param $rc_timestamp mixed + */ + public function insertDateHeader( &$s, $rc_timestamp ) { + # Make date header if necessary + $date = $this->getLanguage()->userDate( $rc_timestamp, $this->getUser() ); + if ( $date != $this->lastdate ) { + if ( $this->lastdate != '' ) { + $s .= "</ul>\n"; + } + $s .= Xml::element( 'h4', null, $date ) . "\n<ul class=\"special\">"; + $this->lastdate = $date; + $this->rclistOpen = true; + } + } + + /** + * @param string $s HTML to update + * @param $title Title + * @param $logtype string + */ + public function insertLog( &$s, $title, $logtype ) { + $page = new LogPage( $logtype ); + $logname = $page->getName()->escaped(); + $s .= $this->msg( 'parentheses' )->rawParams( Linker::linkKnown( $title, $logname ) )->escaped(); + } + + /** + * @param string $s HTML to update + * @param $rc RecentChange + * @param $unpatrolled + */ + public function insertDiffHist( &$s, &$rc, $unpatrolled ) { + # Diff link + if ( $rc->mAttribs['rc_type'] == RC_NEW || $rc->mAttribs['rc_type'] == RC_LOG ) { + $diffLink = $this->message['diff']; + } elseif ( !self::userCan( $rc, Revision::DELETED_TEXT, $this->getUser() ) ) { + $diffLink = $this->message['diff']; + } else { + $query = array( + 'curid' => $rc->mAttribs['rc_cur_id'], + 'diff' => $rc->mAttribs['rc_this_oldid'], + 'oldid' => $rc->mAttribs['rc_last_oldid'] + ); + + $diffLink = Linker::linkKnown( + $rc->getTitle(), + $this->message['diff'], + array( 'tabindex' => $rc->counter ), + $query + ); + } + $diffhist = $diffLink . $this->message['pipe-separator']; + # History link + $diffhist .= Linker::linkKnown( + $rc->getTitle(), + $this->message['hist'], + array(), + array( + 'curid' => $rc->mAttribs['rc_cur_id'], + 'action' => 'history' + ) + ); + $s .= $this->msg( 'parentheses' )->rawParams( $diffhist )->escaped() . ' <span class="mw-changeslist-separator">. .</span> '; + } + + /** + * @param string $s HTML to update + * @param $rc RecentChange + * @param $unpatrolled + * @param $watched + */ + public function insertArticleLink( &$s, &$rc, $unpatrolled, $watched ) { + $params = array(); + + $articlelink = Linker::linkKnown( + $rc->getTitle(), + null, + array( 'class' => 'mw-changeslist-title' ), + $params + ); + if ( $this->isDeleted( $rc, Revision::DELETED_TEXT ) ) { + $articlelink = '<span class="history-deleted">' . $articlelink . '</span>'; + } + # To allow for boldening pages watched by this user + $articlelink = "<span class=\"mw-title\">{$articlelink}</span>"; + # RTL/LTR marker + $articlelink .= $this->getLanguage()->getDirMark(); + + wfRunHooks( 'ChangesListInsertArticleLink', + array( &$this, &$articlelink, &$s, &$rc, $unpatrolled, $watched ) ); + + $s .= " $articlelink"; + } + + /** + * Get the timestamp from $rc formatted with current user's settings + * and a separator + * + * @param $rc RecentChange + * @return string HTML fragment + */ + public function getTimestamp( $rc ) { + return $this->message['semicolon-separator'] . '<span class="mw-changeslist-date">' . + $this->getLanguage()->userTime( $rc->mAttribs['rc_timestamp'], $this->getUser() ) . '</span> <span class="mw-changeslist-separator">. .</span> '; + } + + /** + * Insert time timestamp string from $rc into $s + * + * @param string $s HTML to update + * @param $rc RecentChange + */ + public function insertTimestamp( &$s, $rc ) { + $s .= $this->getTimestamp( $rc ); + } + + /** + * Insert links to user page, user talk page and eventually a blocking link + * + * @param &$s String HTML to update + * @param &$rc RecentChange + */ + public function insertUserRelatedLinks( &$s, &$rc ) { + if ( $this->isDeleted( $rc, Revision::DELETED_USER ) ) { + $s .= ' <span class="history-deleted">' . $this->msg( 'rev-deleted-user' )->escaped() . '</span>'; + } else { + $s .= $this->getLanguage()->getDirMark() . Linker::userLink( $rc->mAttribs['rc_user'], + $rc->mAttribs['rc_user_text'] ); + $s .= Linker::userToolLinks( $rc->mAttribs['rc_user'], $rc->mAttribs['rc_user_text'] ); + } + } + + /** + * Insert a formatted action + * + * @param $rc RecentChange + * @return string + */ + public function insertLogEntry( $rc ) { + $formatter = LogFormatter::newFromRow( $rc->mAttribs ); + $formatter->setContext( $this->getContext() ); + $formatter->setShowUserToolLinks( true ); + $mark = $this->getLanguage()->getDirMark(); + return $formatter->getActionText() . " $mark" . $formatter->getComment(); + } + + /** + * Insert a formatted comment + * @param $rc RecentChange + * @return string + */ + public function insertComment( $rc ) { + if ( $rc->mAttribs['rc_type'] != RC_MOVE && $rc->mAttribs['rc_type'] != RC_MOVE_OVER_REDIRECT ) { + if ( $this->isDeleted( $rc, Revision::DELETED_COMMENT ) ) { + return ' <span class="history-deleted">' . $this->msg( 'rev-deleted-comment' )->escaped() . '</span>'; + } else { + return Linker::commentBlock( $rc->mAttribs['rc_comment'], $rc->getTitle() ); + } + } + return ''; + } + + /** + * Check whether to enable recent changes patrol features + * + * @deprecated since 1.22 + * @return Boolean + */ + public static function usePatrol() { + global $wgUser; + + wfDeprecated( __METHOD__, '1.22' ); + + return $wgUser->useRCPatrol(); + } + + /** + * Returns the string which indicates the number of watching users + * @return string + */ + protected function numberofWatchingusers( $count ) { + static $cache = array(); + if ( $count > 0 ) { + if ( !isset( $cache[$count] ) ) { + $cache[$count] = $this->msg( 'number_of_watching_users_RCview' )->numParams( $count )->escaped(); + } + return $cache[$count]; + } else { + return ''; + } + } + + /** + * Determine if said field of a revision is hidden + * @param $rc RCCacheEntry + * @param $field Integer: one of DELETED_* bitfield constants + * @return Boolean + */ + public static function isDeleted( $rc, $field ) { + return ( $rc->mAttribs['rc_deleted'] & $field ) == $field; + } + + /** + * Determine if the current user is allowed to view a particular + * field of this revision, if it's marked as deleted. + * @param $rc RCCacheEntry + * @param $field Integer + * @param $user User object to check, or null to use $wgUser + * @return Boolean + */ + public static function userCan( $rc, $field, User $user = null ) { + if ( $rc->mAttribs['rc_type'] == RC_LOG ) { + return LogEventsList::userCanBitfield( $rc->mAttribs['rc_deleted'], $field, $user ); + } else { + return Revision::userCanBitfield( $rc->mAttribs['rc_deleted'], $field, $user ); + } + } + + /** + * @param $link string + * @param $watched bool + * @return string + */ + protected function maybeWatchedLink( $link, $watched = false ) { + if ( $watched ) { + return '<strong class="mw-watched">' . $link . '</strong>'; + } else { + return '<span class="mw-rc-unwatched">' . $link . '</span>'; + } + } + + /** Inserts a rollback link + * + * @param $s string + * @param $rc RecentChange + */ + public function insertRollback( &$s, &$rc ) { + if ( $rc->mAttribs['rc_type'] == RC_EDIT && $rc->mAttribs['rc_this_oldid'] && $rc->mAttribs['rc_cur_id'] ) { + $page = $rc->getTitle(); + /** Check for rollback and edit permissions, disallow special pages, and only + * show a link on the top-most revision */ + if ( $this->getUser()->isAllowed( 'rollback' ) && $rc->mAttribs['page_latest'] == $rc->mAttribs['rc_this_oldid'] ) + { + $rev = new Revision( array( + 'title' => $page, + 'id' => $rc->mAttribs['rc_this_oldid'], + 'user' => $rc->mAttribs['rc_user'], + 'user_text' => $rc->mAttribs['rc_user_text'], + 'deleted' => $rc->mAttribs['rc_deleted'] + ) ); + $s .= ' ' . Linker::generateRollback( $rev, $this->getContext() ); + } + } + } + + /** + * @param $s string + * @param $rc RecentChange + * @param $classes + */ + public function insertTags( &$s, &$rc, &$classes ) { + if ( empty( $rc->mAttribs['ts_tags'] ) ) { + return; + } + + list( $tagSummary, $newClasses ) = ChangeTags::formatSummaryRow( $rc->mAttribs['ts_tags'], 'changeslist' ); + $classes = array_merge( $classes, $newClasses ); + $s .= ' ' . $tagSummary; + } + + public function insertExtra( &$s, &$rc, &$classes ) { + // Empty, used for subclasses to add anything special. + } + + protected function showAsUnpatrolled( RecentChange $rc ) { + $unpatrolled = false; + if ( !$rc->mAttribs['rc_patrolled'] ) { + if ( $this->getUser()->useRCPatrol() ) { + $unpatrolled = true; + } elseif ( $this->getUser()->useNPPatrol() && $rc->mAttribs['rc_type'] == RC_NEW ) { + $unpatrolled = true; + } + } + return $unpatrolled; + } +} diff --git a/includes/changes/EnhancedChangesList.php b/includes/changes/EnhancedChangesList.php new file mode 100644 index 00000000..433adb37 --- /dev/null +++ b/includes/changes/EnhancedChangesList.php @@ -0,0 +1,662 @@ +<?php +/** + * Generates a list of changes using an Enhanced system (uses javascript). + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * http://www.gnu.org/copyleft/gpl.html + * + * @file + */ + +class EnhancedChangesList extends ChangesList { + + protected $rc_cache; + + /** + * Add the JavaScript file for enhanced changeslist + * @return String + */ + public function beginRecentChangesList() { + $this->rc_cache = array(); + $this->rcMoveIndex = 0; + $this->rcCacheIndex = 0; + $this->lastdate = ''; + $this->rclistOpen = false; + $this->getOutput()->addModuleStyles( array( + 'mediawiki.special.changeslist', + 'mediawiki.special.changeslist.enhanced', + ) ); + $this->getOutput()->addModules( array( + 'jquery.makeCollapsible', + 'mediawiki.icon', + ) ); + return ''; + } + /** + * Format a line for enhanced recentchange (aka with javascript and block of lines). + * + * @param $baseRC RecentChange + * @param $watched bool + * + * @return string + */ + public function recentChangesLine( &$baseRC, $watched = false ) { + wfProfileIn( __METHOD__ ); + + # Create a specialised object + $rc = RCCacheEntry::newFromParent( $baseRC ); + + $curIdEq = array( 'curid' => $rc->mAttribs['rc_cur_id'] ); + + # If it's a new day, add the headline and flush the cache + $date = $this->getLanguage()->userDate( $rc->mAttribs['rc_timestamp'], $this->getUser() ); + $ret = ''; + if ( $date != $this->lastdate ) { + # Process current cache + $ret = $this->recentChangesBlock(); + $this->rc_cache = array(); + $ret .= Xml::element( 'h4', null, $date ) . "\n"; + $this->lastdate = $date; + } + + # Should patrol-related stuff be shown? + $rc->unpatrolled = $this->showAsUnpatrolled( $rc ); + + $showdifflinks = true; + # Make article link + $type = $rc->mAttribs['rc_type']; + $logType = $rc->mAttribs['rc_log_type']; + // Page moves, very old style, not supported anymore + if ( $type == RC_MOVE || $type == RC_MOVE_OVER_REDIRECT ) { + // New unpatrolled pages + } elseif ( $rc->unpatrolled && $type == RC_NEW ) { + $clink = Linker::linkKnown( $rc->getTitle() ); + // Log entries + } elseif ( $type == RC_LOG ) { + if ( $logType ) { + $logtitle = SpecialPage::getTitleFor( 'Log', $logType ); + $logpage = new LogPage( $logType ); + $logname = $logpage->getName()->escaped(); + $clink = $this->msg( 'parentheses' )->rawParams( Linker::linkKnown( $logtitle, $logname ) )->escaped(); + } else { + $clink = Linker::link( $rc->getTitle() ); + } + $watched = false; + // Log entries (old format) and special pages + } elseif ( $rc->mAttribs['rc_namespace'] == NS_SPECIAL ) { + wfDebug( "Unexpected special page in recentchanges\n" ); + $clink = ''; + // Edits + } else { + $clink = Linker::linkKnown( $rc->getTitle() ); + } + + # Don't show unusable diff links + if ( !ChangesList::userCan( $rc, Revision::DELETED_TEXT, $this->getUser() ) ) { + $showdifflinks = false; + } + + $time = $this->getLanguage()->userTime( $rc->mAttribs['rc_timestamp'], $this->getUser() ); + $rc->watched = $watched; + $rc->link = $clink; + $rc->timestamp = $time; + $rc->numberofWatchingusers = $baseRC->numberofWatchingusers; + + # Make "cur" and "diff" links. Do not use link(), it is too slow if + # called too many times (50% of CPU time on RecentChanges!). + $thisOldid = $rc->mAttribs['rc_this_oldid']; + $lastOldid = $rc->mAttribs['rc_last_oldid']; + + $querycur = $curIdEq + array( 'diff' => '0', 'oldid' => $thisOldid ); + $querydiff = $curIdEq + array( 'diff' => $thisOldid, 'oldid' => $lastOldid ); + + if ( !$showdifflinks ) { + $curLink = $this->message['cur']; + $diffLink = $this->message['diff']; + } elseif ( in_array( $type, array( RC_NEW, RC_LOG, RC_MOVE, RC_MOVE_OVER_REDIRECT ) ) ) { + if ( $type != RC_NEW ) { + $curLink = $this->message['cur']; + } else { + $curUrl = htmlspecialchars( $rc->getTitle()->getLinkURL( $querycur ) ); + $curLink = "<a href=\"$curUrl\" tabindex=\"{$baseRC->counter}\">{$this->message['cur']}</a>"; + } + $diffLink = $this->message['diff']; + } else { + $diffUrl = htmlspecialchars( $rc->getTitle()->getLinkURL( $querydiff ) ); + $curUrl = htmlspecialchars( $rc->getTitle()->getLinkURL( $querycur ) ); + $diffLink = "<a href=\"$diffUrl\" tabindex=\"{$baseRC->counter}\">{$this->message['diff']}</a>"; + $curLink = "<a href=\"$curUrl\" tabindex=\"{$baseRC->counter}\">{$this->message['cur']}</a>"; + } + + # Make "last" link + if ( !$showdifflinks || !$lastOldid ) { + $lastLink = $this->message['last']; + } elseif ( in_array( $type, array( RC_LOG, RC_MOVE, RC_MOVE_OVER_REDIRECT ) ) ) { + $lastLink = $this->message['last']; + } else { + $lastLink = Linker::linkKnown( $rc->getTitle(), $this->message['last'], + array(), $curIdEq + array( 'diff' => $thisOldid, 'oldid' => $lastOldid ) ); + } + + # Make user links + if ( $this->isDeleted( $rc, Revision::DELETED_USER ) ) { + $rc->userlink = ' <span class="history-deleted">' . $this->msg( 'rev-deleted-user' )->escaped() . '</span>'; + } else { + $rc->userlink = Linker::userLink( $rc->mAttribs['rc_user'], $rc->mAttribs['rc_user_text'] ); + $rc->usertalklink = Linker::userToolLinks( $rc->mAttribs['rc_user'], $rc->mAttribs['rc_user_text'] ); + } + + $rc->lastlink = $lastLink; + $rc->curlink = $curLink; + $rc->difflink = $diffLink; + + # Put accumulated information into the cache, for later display + # Page moves go on their own line + $title = $rc->getTitle(); + $secureName = $title->getPrefixedDBkey(); + if ( $type == RC_MOVE || $type == RC_MOVE_OVER_REDIRECT ) { + # Use an @ character to prevent collision with page names + $this->rc_cache['@@' . ( $this->rcMoveIndex++ )] = array( $rc ); + } else { + # Logs are grouped by type + if ( $type == RC_LOG ) { + $secureName = SpecialPage::getTitleFor( 'Log', $logType )->getPrefixedDBkey(); + } + if ( !isset( $this->rc_cache[$secureName] ) ) { + $this->rc_cache[$secureName] = array(); + } + + array_push( $this->rc_cache[$secureName], $rc ); + } + + wfProfileOut( __METHOD__ ); + + return $ret; + } + + /** + * Enhanced RC group + * @return string + */ + protected function recentChangesBlockGroup( $block ) { + global $wgRCShowChangedSize; + + wfProfileIn( __METHOD__ ); + + # Add the namespace and title of the block as part of the class + $classes = array( 'mw-collapsible', 'mw-collapsed', 'mw-enhanced-rc' ); + if ( $block[0]->mAttribs['rc_log_type'] ) { + # Log entry + $classes[] = Sanitizer::escapeClass( 'mw-changeslist-log-' + . $block[0]->mAttribs['rc_log_type'] . '-' . $block[0]->mAttribs['rc_title'] ); + } else { + $classes[] = Sanitizer::escapeClass( 'mw-changeslist-ns' + . $block[0]->mAttribs['rc_namespace'] . '-' . $block[0]->mAttribs['rc_title'] ); + } + $classes[] = $block[0]->watched && $block[0]->mAttribs['rc_timestamp'] >= $block[0]->watched + ? 'mw-changeslist-line-watched' : 'mw-changeslist-line-not-watched'; + $r = Html::openElement( 'table', array( 'class' => $classes ) ) . + Html::openElement( 'tr' ); + + # Collate list of users + $userlinks = array(); + # Other properties + $unpatrolled = false; + $isnew = false; + $allBots = true; + $allMinors = true; + $curId = $currentRevision = 0; + # Some catalyst variables... + $namehidden = true; + $allLogs = true; + foreach ( $block as $rcObj ) { + $oldid = $rcObj->mAttribs['rc_last_oldid']; + if ( $rcObj->mAttribs['rc_type'] == RC_NEW ) { + $isnew = true; + } + // If all log actions to this page were hidden, then don't + // give the name of the affected page for this block! + if ( !$this->isDeleted( $rcObj, LogPage::DELETED_ACTION ) ) { + $namehidden = false; + } + $u = $rcObj->userlink; + if ( !isset( $userlinks[$u] ) ) { + $userlinks[$u] = 0; + } + if ( $rcObj->unpatrolled ) { + $unpatrolled = true; + } + if ( $rcObj->mAttribs['rc_type'] != RC_LOG ) { + $allLogs = false; + } + # Get the latest entry with a page_id and oldid + # since logs may not have these. + if ( !$curId && $rcObj->mAttribs['rc_cur_id'] ) { + $curId = $rcObj->mAttribs['rc_cur_id']; + } + if ( !$currentRevision && $rcObj->mAttribs['rc_this_oldid'] ) { + $currentRevision = $rcObj->mAttribs['rc_this_oldid']; + } + + if ( !$rcObj->mAttribs['rc_bot'] ) { + $allBots = false; + } + if ( !$rcObj->mAttribs['rc_minor'] ) { + $allMinors = false; + } + + $userlinks[$u]++; + } + + # Sort the list and convert to text + krsort( $userlinks ); + asort( $userlinks ); + $users = array(); + foreach ( $userlinks as $userlink => $count ) { + $text = $userlink; + $text .= $this->getLanguage()->getDirMark(); + if ( $count > 1 ) { + $text .= ' ' . $this->msg( 'parentheses' )->rawParams( $this->getLanguage()->formatNum( $count ) . '×' )->escaped(); + } + array_push( $users, $text ); + } + + $users = ' <span class="changedby">' + . $this->msg( 'brackets' )->rawParams( + implode( $this->message['semicolon-separator'], $users ) + )->escaped() . '</span>'; + + $tl = '<span class="mw-collapsible-toggle mw-collapsible-arrow mw-enhancedchanges-arrow mw-enhancedchanges-arrow-space"></span>'; + $r .= "<td>$tl</td>"; + + # Main line + $r .= '<td class="mw-enhanced-rc">' . $this->recentChangesFlags( array( + 'newpage' => $isnew, # show, when one have this flag + 'minor' => $allMinors, # show only, when all have this flag + 'unpatrolled' => $unpatrolled, # show, when one have this flag + 'bot' => $allBots, # show only, when all have this flag + ) ); + + # Timestamp + $r .= ' ' . $block[0]->timestamp . ' </td><td>'; + + # Article link + if ( $namehidden ) { + $r .= ' <span class="history-deleted">' . $this->msg( 'rev-deleted-event' )->escaped() . '</span>'; + } elseif ( $allLogs ) { + $r .= $this->maybeWatchedLink( $block[0]->link, $block[0]->watched ); + } else { + $this->insertArticleLink( $r, $block[0], $block[0]->unpatrolled, $block[0]->watched ); + } + + $r .= $this->getLanguage()->getDirMark(); + + $queryParams['curid'] = $curId; + + # Changes message + static $nchanges = array(); + static $sinceLastVisitMsg = array(); + + $n = count( $block ); + if ( !isset( $nchanges[$n] ) ) { + $nchanges[$n] = $this->msg( 'nchanges' )->numParams( $n )->escaped(); + } + + $sinceLast = 0; + $unvisitedOldid = null; + foreach ( $block as $rcObj ) { + // Same logic as below inside main foreach + if ( $rcObj->watched && $rcObj->mAttribs['rc_timestamp'] >= $rcObj->watched ) { + $sinceLast++; + $unvisitedOldid = $rcObj->mAttribs['rc_last_oldid']; + } + } + if ( !isset( $sinceLastVisitMsg[$sinceLast] ) ) { + $sinceLastVisitMsg[$sinceLast] = + $this->msg( 'enhancedrc-since-last-visit' )->numParams( $sinceLast )->escaped(); + } + + # Total change link + $r .= ' '; + $logtext = ''; + if ( !$allLogs ) { + if ( !ChangesList::userCan( $rcObj, Revision::DELETED_TEXT, $this->getUser() ) ) { + $logtext .= $nchanges[$n]; + } elseif ( $isnew ) { + $logtext .= $nchanges[$n]; + } else { + $logtext .= Linker::link( + $block[0]->getTitle(), + $nchanges[$n], + array(), + $queryParams + array( + 'diff' => $currentRevision, + 'oldid' => $oldid, + ), + array( 'known', 'noclasses' ) + ); + if ( $sinceLast > 0 && $sinceLast < $n ) { + $logtext .= $this->message['pipe-separator'] . Linker::link( + $block[0]->getTitle(), + $sinceLastVisitMsg[$sinceLast], + array(), + $queryParams + array( + 'diff' => $currentRevision, + 'oldid' => $unvisitedOldid, + ), + array( 'known', 'noclasses' ) + ); + } + } + } + + # History + if ( $allLogs ) { + // don't show history link for logs + } elseif ( $namehidden || !$block[0]->getTitle()->exists() ) { + $logtext .= $this->message['pipe-separator'] . $this->message['enhancedrc-history']; + } else { + $params = $queryParams; + $params['action'] = 'history'; + + $logtext .= $this->message['pipe-separator'] . + Linker::linkKnown( + $block[0]->getTitle(), + $this->message['enhancedrc-history'], + array(), + $params + ); + } + + if ( $logtext !== '' ) { + $r .= $this->msg( 'parentheses' )->rawParams( $logtext )->escaped(); + } + + $r .= ' <span class="mw-changeslist-separator">. .</span> '; + + # Character difference (does not apply if only log items) + if ( $wgRCShowChangedSize && !$allLogs ) { + $last = 0; + $first = count( $block ) - 1; + # Some events (like logs) have an "empty" size, so we need to skip those... + while ( $last < $first && $block[$last]->mAttribs['rc_new_len'] === null ) { + $last++; + } + while ( $first > $last && $block[$first]->mAttribs['rc_old_len'] === null ) { + $first--; + } + # Get net change + $chardiff = $this->formatCharacterDifference( $block[$first], $block[$last] ); + + if ( $chardiff == '' ) { + $r .= ' '; + } else { + $r .= ' ' . $chardiff . ' <span class="mw-changeslist-separator">. .</span> '; + } + } + + $r .= $users; + $r .= $this->numberofWatchingusers( $block[0]->numberofWatchingusers ); + + # Sub-entries + foreach ( $block as $rcObj ) { + # Classes to apply -- TODO implement + $classes = array(); + $type = $rcObj->mAttribs['rc_type']; + + $trClass = $rcObj->watched && $rcObj->mAttribs['rc_timestamp'] >= $rcObj->watched + ? ' class="mw-enhanced-watched"' : ''; + + $r .= '<tr' . $trClass . '><td></td><td class="mw-enhanced-rc">'; + $r .= $this->recentChangesFlags( array( + 'newpage' => $type == RC_NEW, + 'minor' => $rcObj->mAttribs['rc_minor'], + 'unpatrolled' => $rcObj->unpatrolled, + 'bot' => $rcObj->mAttribs['rc_bot'], + ) ); + $r .= ' </td><td class="mw-enhanced-rc-nested"><span class="mw-enhanced-rc-time">'; + + $params = $queryParams; + + if ( $rcObj->mAttribs['rc_this_oldid'] != 0 ) { + $params['oldid'] = $rcObj->mAttribs['rc_this_oldid']; + } + + # Log timestamp + if ( $type == RC_LOG ) { + $link = $rcObj->timestamp; + # Revision link + } elseif ( !ChangesList::userCan( $rcObj, Revision::DELETED_TEXT, $this->getUser() ) ) { + $link = '<span class="history-deleted">' . $rcObj->timestamp . '</span> '; + } else { + + $link = Linker::linkKnown( + $rcObj->getTitle(), + $rcObj->timestamp, + array(), + $params + ); + if ( $this->isDeleted( $rcObj, Revision::DELETED_TEXT ) ) { + $link = '<span class="history-deleted">' . $link . '</span> '; + } + } + $r .= $link . '</span>'; + + if ( !$type == RC_LOG || $type == RC_NEW ) { + $r .= ' ' . $this->msg( 'parentheses' )->rawParams( $rcObj->curlink . $this->message['pipe-separator'] . $rcObj->lastlink )->escaped(); + } + $r .= ' <span class="mw-changeslist-separator">. .</span> '; + + # Character diff + if ( $wgRCShowChangedSize ) { + $cd = $this->formatCharacterDifference( $rcObj ); + if ( $cd !== '' ) { + $r .= $cd . ' <span class="mw-changeslist-separator">. .</span> '; + } + } + + if ( $rcObj->mAttribs['rc_type'] == RC_LOG ) { + $r .= $this->insertLogEntry( $rcObj ); + } else { + # User links + $r .= $rcObj->userlink; + $r .= $rcObj->usertalklink; + $r .= $this->insertComment( $rcObj ); + } + + # Rollback + $this->insertRollback( $r, $rcObj ); + # Tags + $this->insertTags( $r, $rcObj, $classes ); + + $r .= "</td></tr>\n"; + } + $r .= "</table>\n"; + + $this->rcCacheIndex++; + + wfProfileOut( __METHOD__ ); + + return $r; + } + + /** + * Generate HTML for an arrow or placeholder graphic + * @param string $dir one of '', 'd', 'l', 'r' + * @param string $alt text + * @param string $title text + * @return String: HTML "<img>" tag + */ + protected function arrow( $dir, $alt = '', $title = '' ) { + global $wgStylePath; + $encUrl = htmlspecialchars( $wgStylePath . '/common/images/Arr_' . $dir . '.png' ); + $encAlt = htmlspecialchars( $alt ); + $encTitle = htmlspecialchars( $title ); + return "<img src=\"$encUrl\" width=\"12\" height=\"12\" alt=\"$encAlt\" title=\"$encTitle\" />"; + } + + /** + * Generate HTML for a right- or left-facing arrow, + * depending on language direction. + * @return String: HTML "<img>" tag + */ + protected function sideArrow() { + $dir = $this->getLanguage()->isRTL() ? 'l' : 'r'; + return $this->arrow( $dir, '+', $this->msg( 'rc-enhanced-expand' )->text() ); + } + + /** + * Generate HTML for a down-facing arrow + * depending on language direction. + * @return String: HTML "<img>" tag + */ + protected function downArrow() { + return $this->arrow( 'd', '-', $this->msg( 'rc-enhanced-hide' )->text() ); + } + + /** + * Generate HTML for a spacer image + * @return String: HTML "<img>" tag + */ + protected function spacerArrow() { + return $this->arrow( '', codepointToUtf8( 0xa0 ) ); // non-breaking space + } + + /** + * Enhanced RC ungrouped line. + * + * @param $rcObj RecentChange + * @return String: a HTML formatted line (generated using $r) + */ + protected function recentChangesBlockLine( $rcObj ) { + global $wgRCShowChangedSize; + + wfProfileIn( __METHOD__ ); + $query['curid'] = $rcObj->mAttribs['rc_cur_id']; + + $type = $rcObj->mAttribs['rc_type']; + $logType = $rcObj->mAttribs['rc_log_type']; + $classes = array( 'mw-enhanced-rc' ); + if ( $logType ) { + # Log entry + $classes[] = Sanitizer::escapeClass( 'mw-changeslist-log-' + . $logType . '-' . $rcObj->mAttribs['rc_title'] ); + } else { + $classes[] = Sanitizer::escapeClass( 'mw-changeslist-ns' . + $rcObj->mAttribs['rc_namespace'] . '-' . $rcObj->mAttribs['rc_title'] ); + } + $classes[] = $rcObj->watched && $rcObj->mAttribs['rc_timestamp'] >= $rcObj->watched + ? 'mw-changeslist-line-watched' : 'mw-changeslist-line-not-watched'; + $r = Html::openElement( 'table', array( 'class' => $classes ) ) . + Html::openElement( 'tr' ); + + $r .= '<td class="mw-enhanced-rc"><span class="mw-enhancedchanges-arrow-space"></span>'; + # Flag and Timestamp + if ( $type == RC_MOVE || $type == RC_MOVE_OVER_REDIRECT ) { + $r .= $this->recentChangesFlags( array() ); // no flags, but need the placeholders + } else { + $r .= $this->recentChangesFlags( array( + 'newpage' => $type == RC_NEW, + 'minor' => $rcObj->mAttribs['rc_minor'], + 'unpatrolled' => $rcObj->unpatrolled, + 'bot' => $rcObj->mAttribs['rc_bot'], + ) ); + } + $r .= ' ' . $rcObj->timestamp . ' </td><td>'; + # Article or log link + if ( $logType ) { + $logPage = new LogPage( $logType ); + $logTitle = SpecialPage::getTitleFor( 'Log', $logType ); + $logName = $logPage->getName()->escaped(); + $r .= $this->msg( 'parentheses' )->rawParams( Linker::linkKnown( $logTitle, $logName ) )->escaped(); + } else { + $this->insertArticleLink( $r, $rcObj, $rcObj->unpatrolled, $rcObj->watched ); + } + # Diff and hist links + if ( $type != RC_LOG ) { + $query['action'] = 'history'; + $r .= ' ' . $this->msg( 'parentheses' )->rawParams( $rcObj->difflink . $this->message['pipe-separator'] . Linker::linkKnown( + $rcObj->getTitle(), + $this->message['hist'], + array(), + $query + ) )->escaped(); + } + $r .= ' <span class="mw-changeslist-separator">. .</span> '; + # Character diff + if ( $wgRCShowChangedSize ) { + $cd = $this->formatCharacterDifference( $rcObj ); + if ( $cd !== '' ) { + $r .= $cd . ' <span class="mw-changeslist-separator">. .</span> '; + } + } + + if ( $type == RC_LOG ) { + $r .= $this->insertLogEntry( $rcObj ); + } else { + $r .= ' ' . $rcObj->userlink . $rcObj->usertalklink; + $r .= $this->insertComment( $rcObj ); + $this->insertRollback( $r, $rcObj ); + } + + # Tags + $this->insertTags( $r, $rcObj, $classes ); + # Show how many people are watching this if enabled + $r .= $this->numberofWatchingusers( $rcObj->numberofWatchingusers ); + + $r .= "</td></tr></table>\n"; + + wfProfileOut( __METHOD__ ); + + return $r; + } + + /** + * If enhanced RC is in use, this function takes the previously cached + * RC lines, arranges them, and outputs the HTML + * + * @return string + */ + protected function recentChangesBlock() { + if ( count ( $this->rc_cache ) == 0 ) { + return ''; + } + + wfProfileIn( __METHOD__ ); + + $blockOut = ''; + foreach ( $this->rc_cache as $block ) { + if ( count( $block ) < 2 ) { + $blockOut .= $this->recentChangesBlockLine( array_shift( $block ) ); + } else { + $blockOut .= $this->recentChangesBlockGroup( $block ); + } + } + + wfProfileOut( __METHOD__ ); + + return '<div>' . $blockOut . '</div>'; + } + + /** + * Returns text for the end of RC + * If enhanced RC is in use, returns pretty much all the text + * @return string + */ + public function endRecentChangesList() { + return $this->recentChangesBlock() . parent::endRecentChangesList(); + } + +} diff --git a/includes/changes/OldChangesList.php b/includes/changes/OldChangesList.php new file mode 100644 index 00000000..a7fe9342 --- /dev/null +++ b/includes/changes/OldChangesList.php @@ -0,0 +1,130 @@ +<?php +/** + * Generate a list of changes using the good old system (no javascript). + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * http://www.gnu.org/copyleft/gpl.html + * + * @file + */ +class OldChangesList extends ChangesList { + + /** + * Format a line using the old system (aka without any javascript). + * + * @param $rc RecentChange, passed by reference + * @param bool $watched (default false) + * @param int $linenumber (default null) + * + * @return string|bool + */ + public function recentChangesLine( &$rc, $watched = false, $linenumber = null ) { + global $wgRCShowChangedSize; + wfProfileIn( __METHOD__ ); + + # Should patrol-related stuff be shown? + $unpatrolled = $this->showAsUnpatrolled( $rc ); + + $dateheader = ''; // $s now contains only <li>...</li>, for hooks' convenience. + $this->insertDateHeader( $dateheader, $rc->mAttribs['rc_timestamp'] ); + + $s = ''; + $classes = array(); + // use mw-line-even/mw-line-odd class only if linenumber is given (feature from bug 14468) + if ( $linenumber ) { + if ( $linenumber & 1 ) { + $classes[] = 'mw-line-odd'; + } else { + $classes[] = 'mw-line-even'; + } + } + + // Indicate watched status on the line to allow for more + // comprehensive styling. + $classes[] = $watched && $rc->mAttribs['rc_timestamp'] >= $watched + ? 'mw-changeslist-line-watched' : 'mw-changeslist-line-not-watched'; + + // Moved pages (very very old, not supported anymore) + if ( $rc->mAttribs['rc_type'] == RC_MOVE || $rc->mAttribs['rc_type'] == RC_MOVE_OVER_REDIRECT ) { + // Log entries + } elseif ( $rc->mAttribs['rc_log_type'] ) { + $logtitle = SpecialPage::getTitleFor( 'Log', $rc->mAttribs['rc_log_type'] ); + $this->insertLog( $s, $logtitle, $rc->mAttribs['rc_log_type'] ); + // Log entries (old format) or log targets, and special pages + } elseif ( $rc->mAttribs['rc_namespace'] == NS_SPECIAL ) { + list( $name, $subpage ) = SpecialPageFactory::resolveAlias( $rc->mAttribs['rc_title'] ); + if ( $name == 'Log' ) { + $this->insertLog( $s, $rc->getTitle(), $subpage ); + } + // Regular entries + } else { + $this->insertDiffHist( $s, $rc, $unpatrolled ); + # M, N, b and ! (minor, new, bot and unpatrolled) + $s .= $this->recentChangesFlags( + array( + 'newpage' => $rc->mAttribs['rc_type'] == RC_NEW, + 'minor' => $rc->mAttribs['rc_minor'], + 'unpatrolled' => $unpatrolled, + 'bot' => $rc->mAttribs['rc_bot'] + ), + '' + ); + $this->insertArticleLink( $s, $rc, $unpatrolled, $watched ); + } + # Edit/log timestamp + $this->insertTimestamp( $s, $rc ); + # Bytes added or removed + if ( $wgRCShowChangedSize ) { + $cd = $this->formatCharacterDifference( $rc ); + if ( $cd !== '' ) { + $s .= $cd . ' <span class="mw-changeslist-separator">. .</span> '; + } + } + + if ( $rc->mAttribs['rc_type'] == RC_LOG ) { + $s .= $this->insertLogEntry( $rc ); + } else { + # User tool links + $this->insertUserRelatedLinks( $s, $rc ); + # LTR/RTL direction mark + $s .= $this->getLanguage()->getDirMark(); + $s .= $this->insertComment( $rc ); + } + + # Tags + $this->insertTags( $s, $rc, $classes ); + # Rollback + $this->insertRollback( $s, $rc ); + # For subclasses + $this->insertExtra( $s, $rc, $classes ); + + # How many users watch this page + if ( $rc->numberofWatchingusers > 0 ) { + $s .= ' ' . $this->numberofWatchingusers( $rc->numberofWatchingusers ); + } + + if ( $this->watchlist ) { + $classes[] = Sanitizer::escapeClass( 'watchlist-' . $rc->mAttribs['rc_namespace'] . '-' . $rc->mAttribs['rc_title'] ); + } + + if ( !wfRunHooks( 'OldChangesListRecentChangesLine', array( &$this, &$s, $rc, &$classes ) ) ) { + wfProfileOut( __METHOD__ ); + return false; + } + + wfProfileOut( __METHOD__ ); + return "$dateheader<li class=\"" . implode( ' ', $classes ) . "\">" . $s . "</li>\n"; + } +} diff --git a/includes/changes/RCCacheEntry.php b/includes/changes/RCCacheEntry.php new file mode 100644 index 00000000..9aef3d30 --- /dev/null +++ b/includes/changes/RCCacheEntry.php @@ -0,0 +1,35 @@ +<?php +/** + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * http://www.gnu.org/copyleft/gpl.html + * + * @file + */ +class RCCacheEntry extends RecentChange { + var $secureName, $link; + var $curlink, $difflink, $lastlink, $usertalklink, $versionlink; + var $userlink, $timestamp, $watched; + + /** + * @param $rc RecentChange + * @return RCCacheEntry + */ + static function newFromParent( $rc ) { + $rc2 = new RCCacheEntry; + $rc2->mAttribs = $rc->mAttribs; + $rc2->mExtra = $rc->mExtra; + return $rc2; + } +} diff --git a/includes/changes/RecentChange.php b/includes/changes/RecentChange.php new file mode 100644 index 00000000..980bd0a0 --- /dev/null +++ b/includes/changes/RecentChange.php @@ -0,0 +1,846 @@ +<?php +/** + * Utility class for creating and accessing recent change entries. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * http://www.gnu.org/copyleft/gpl.html + * + * @file + */ + +/** + * Utility class for creating new RC entries + * + * mAttribs: + * rc_id id of the row in the recentchanges table + * rc_timestamp time the entry was made + * rc_cur_time timestamp on the cur row + * rc_namespace namespace # + * rc_title non-prefixed db key + * rc_type is new entry, used to determine whether updating is necessary + * rc_minor is minor + * rc_cur_id page_id of associated page entry + * rc_user user id who made the entry + * rc_user_text user name who made the entry + * rc_comment edit summary + * rc_this_oldid rev_id associated with this entry (or zero) + * rc_last_oldid rev_id associated with the entry before this one (or zero) + * rc_bot is bot, hidden + * rc_ip IP address of the user in dotted quad notation + * rc_new obsolete, use rc_type==RC_NEW + * rc_patrolled boolean whether or not someone has marked this edit as patrolled + * rc_old_len integer byte length of the text before the edit + * rc_new_len the same after the edit + * rc_deleted partial deletion + * rc_logid the log_id value for this log entry (or zero) + * rc_log_type the log type (or null) + * rc_log_action the log action (or null) + * rc_params log params + * + * mExtra: + * prefixedDBkey prefixed db key, used by external app via msg queue + * lastTimestamp timestamp of previous entry, used in WHERE clause during update + * lang the interwiki prefix, automatically set in save() + * oldSize text size before the change + * newSize text size after the change + * pageStatus status of the page: created, deleted, moved, restored, changed + * + * temporary: not stored in the database + * notificationtimestamp + * numberofWatchingusers + * + * @todo document functions and variables + */ +class RecentChange { + var $mAttribs = array(), $mExtra = array(); + + /** + * @var Title + */ + var $mTitle = false; + + /** + * @var User + */ + private $mPerformer = false; + + /** + * @var Title + */ + var $mMovedToTitle = false; + var $numberofWatchingusers = 0; # Dummy to prevent error message in SpecialRecentchangeslinked + var $notificationtimestamp; + + # Factory methods + + /** + * @param $row + * @return RecentChange + */ + public static function newFromRow( $row ) { + $rc = new RecentChange; + $rc->loadFromRow( $row ); + return $rc; + } + + /** + * @deprecated in 1.22 + * @param $row + * @return RecentChange + */ + public static function newFromCurRow( $row ) { + wfDeprecated( __METHOD__, '1.22' ); + $rc = new RecentChange; + $rc->loadFromCurRow( $row ); + $rc->notificationtimestamp = false; + $rc->numberofWatchingusers = false; + return $rc; + } + + /** + * Obtain the recent change with a given rc_id value + * + * @param int $rcid rc_id value to retrieve + * @return RecentChange + */ + public static function newFromId( $rcid ) { + return self::newFromConds( array( 'rc_id' => $rcid ), __METHOD__ ); + } + + /** + * Find the first recent change matching some specific conditions + * + * @param array $conds of conditions + * @param $fname Mixed: override the method name in profiling/logs + * @param $options Array Query options + * @return RecentChange + */ + public static function newFromConds( $conds, $fname = __METHOD__, $options = array() ) { + $dbr = wfGetDB( DB_SLAVE ); + $row = $dbr->selectRow( 'recentchanges', self::selectFields(), $conds, $fname, $options ); + if ( $row !== false ) { + return self::newFromRow( $row ); + } else { + return null; + } + } + + /** + * Return the list of recentchanges fields that should be selected to create + * a new recentchanges object. + * @return array + */ + public static function selectFields() { + return array( + 'rc_id', + 'rc_timestamp', + 'rc_cur_time', + 'rc_user', + 'rc_user_text', + 'rc_namespace', + 'rc_title', + 'rc_comment', + 'rc_minor', + 'rc_bot', + 'rc_new', + 'rc_cur_id', + 'rc_this_oldid', + 'rc_last_oldid', + 'rc_type', + 'rc_patrolled', + 'rc_ip', + 'rc_old_len', + 'rc_new_len', + 'rc_deleted', + 'rc_logid', + 'rc_log_type', + 'rc_log_action', + 'rc_params', + ); + } + + # Accessors + + /** + * @param $attribs array + */ + public function setAttribs( $attribs ) { + $this->mAttribs = $attribs; + } + + /** + * @param $extra array + */ + public function setExtra( $extra ) { + $this->mExtra = $extra; + } + + /** + * + * @return Title + */ + public function &getTitle() { + if ( $this->mTitle === false ) { + $this->mTitle = Title::makeTitle( $this->mAttribs['rc_namespace'], $this->mAttribs['rc_title'] ); + } + return $this->mTitle; + } + + /** + * Get the User object of the person who performed this change. + * + * @return User + */ + public function getPerformer() { + if ( $this->mPerformer === false ) { + if ( $this->mAttribs['rc_user'] ) { + $this->mPerformer = User::newFromID( $this->mAttribs['rc_user'] ); + } else { + $this->mPerformer = User::newFromName( $this->mAttribs['rc_user_text'], false ); + } + } + return $this->mPerformer; + } + + /** + * Writes the data in this object to the database + * @param $noudp bool + */ + public function save( $noudp = false ) { + global $wgLocalInterwiki, $wgPutIPinRC, $wgUseEnotif, $wgShowUpdatedMarker, $wgContLang; + + $dbw = wfGetDB( DB_MASTER ); + if ( !is_array( $this->mExtra ) ) { + $this->mExtra = array(); + } + $this->mExtra['lang'] = $wgLocalInterwiki; + + if ( !$wgPutIPinRC ) { + $this->mAttribs['rc_ip'] = ''; + } + + # If our database is strict about IP addresses, use NULL instead of an empty string + if ( $dbw->strictIPs() and $this->mAttribs['rc_ip'] == '' ) { + unset( $this->mAttribs['rc_ip'] ); + } + + # Trim spaces on user supplied text + $this->mAttribs['rc_comment'] = trim( $this->mAttribs['rc_comment'] ); + + # Make sure summary is truncated (whole multibyte characters) + $this->mAttribs['rc_comment'] = $wgContLang->truncate( $this->mAttribs['rc_comment'], 255 ); + + # Fixup database timestamps + $this->mAttribs['rc_timestamp'] = $dbw->timestamp( $this->mAttribs['rc_timestamp'] ); + $this->mAttribs['rc_cur_time'] = $dbw->timestamp( $this->mAttribs['rc_cur_time'] ); + $this->mAttribs['rc_id'] = $dbw->nextSequenceValue( 'recentchanges_rc_id_seq' ); + + ## If we are using foreign keys, an entry of 0 for the page_id will fail, so use NULL + if ( $dbw->cascadingDeletes() and $this->mAttribs['rc_cur_id'] == 0 ) { + unset( $this->mAttribs['rc_cur_id'] ); + } + + # Insert new row + $dbw->insert( 'recentchanges', $this->mAttribs, __METHOD__ ); + + # Set the ID + $this->mAttribs['rc_id'] = $dbw->insertId(); + + # Notify extensions + wfRunHooks( 'RecentChange_save', array( &$this ) ); + + # Notify external application via UDP + if ( !$noudp ) { + $this->notifyRCFeeds(); + } + + # E-mail notifications + if ( $wgUseEnotif || $wgShowUpdatedMarker ) { + $editor = $this->getPerformer(); + $title = $this->getTitle(); + + if ( wfRunHooks( 'AbortEmailNotification', array( $editor, $title ) ) ) { + # @todo FIXME: This would be better as an extension hook + $enotif = new EmailNotification(); + $enotif->notifyOnPageChange( $editor, $title, + $this->mAttribs['rc_timestamp'], + $this->mAttribs['rc_comment'], + $this->mAttribs['rc_minor'], + $this->mAttribs['rc_last_oldid'], + $this->mExtra['pageStatus'] ); + } + } + } + + /** + * @deprecated since 1.22, use notifyRCFeeds instead. + */ + public function notifyRC2UDP() { + wfDeprecated( __METHOD__, '1.22' ); + $this->notifyRCFeeds(); + } + + /** + * Send some text to UDP. + * @deprecated since 1.22 + */ + public static function sendToUDP( $line, $address = '', $prefix = '', $port = '' ) { + global $wgRC2UDPAddress, $wgRC2UDPInterwikiPrefix, $wgRC2UDPPort, $wgRC2UDPPrefix; + + wfDeprecated( __METHOD__, '1.22' ); + + # Assume default for standard RC case + $address = $address ? $address : $wgRC2UDPAddress; + $prefix = $prefix ? $prefix : $wgRC2UDPPrefix; + $port = $port ? $port : $wgRC2UDPPort; + + $engine = new UDPRCFeedEngine(); + $feed = array( + 'uri' => "udp://$address:$port/$prefix", + 'formatter' => 'IRCColourfulRCFeedFormatter', + 'add_interwiki_prefix' => $wgRC2UDPInterwikiPrefix, + ); + + return $engine->send( $feed, $line ); + } + + /** + * Notify all the feeds about the change. + */ + public function notifyRCFeeds() { + global $wgRCFeeds; + + foreach ( $wgRCFeeds as $feed ) { + $engine = self::getEngine( $feed['uri'] ); + + if ( isset( $this->mExtra['actionCommentIRC'] ) ) { + $actionComment = $this->mExtra['actionCommentIRC']; + } else { + $actionComment = null; + } + + $omitBots = isset( $feed['omit_bots'] ) ? $feed['omit_bots'] : false; + + if ( + ( $omitBots && $this->mAttribs['rc_bot'] ) || + $this->mAttribs['rc_type'] == RC_EXTERNAL + ) { + continue; + } + + $formatter = new $feed['formatter'](); + $line = $formatter->getLine( $feed, $this, $actionComment ); + + $engine->send( $feed, $line ); + } + } + + /** + * Gets the stream engine object for a given URI from $wgRCEngines + * + * @param $uri string URI to get the engine object for + * @return object The engine object + */ + private static function getEngine( $uri ) { + global $wgRCEngines; + + $scheme = parse_url( $uri, PHP_URL_SCHEME ); + if ( !$scheme ) { + throw new MWException( __FUNCTION__ . ": Invalid stream logger URI: '$uri'" ); + } + + if ( !isset( $wgRCEngines[$scheme] ) ) { + throw new MWException( __FUNCTION__ . ": Unknown stream logger URI scheme: $scheme" ); + } + + return new $wgRCEngines[$scheme]; + } + + /** + * @deprecated since 1.22, moved to IRCColourfulRCFeedFormatter + */ + public static function cleanupForIRC( $text ) { + wfDeprecated( __METHOD__, '1.22' ); + return IRCColourfulRCFeedFormatter::cleanupForIRC( $text ); + } + + /** + * Mark a given change as patrolled + * + * @param $change Mixed: RecentChange or corresponding rc_id + * @param $auto Boolean: for automatic patrol + * @return Array See doMarkPatrolled(), or null if $change is not an existing rc_id + */ + public static function markPatrolled( $change, $auto = false ) { + global $wgUser; + + $change = $change instanceof RecentChange + ? $change + : RecentChange::newFromId( $change ); + + if ( !$change instanceof RecentChange ) { + return null; + } + return $change->doMarkPatrolled( $wgUser, $auto ); + } + + /** + * Mark this RecentChange as patrolled + * + * NOTE: Can also return 'rcpatroldisabled', 'hookaborted' and 'markedaspatrollederror-noautopatrol' as errors + * @param $user User object doing the action + * @param $auto Boolean: for automatic patrol + * @return array of permissions errors, see Title::getUserPermissionsErrors() + */ + public function doMarkPatrolled( User $user, $auto = false ) { + global $wgUseRCPatrol, $wgUseNPPatrol; + $errors = array(); + // If recentchanges patrol is disabled, only new pages + // can be patrolled + if ( !$wgUseRCPatrol && ( !$wgUseNPPatrol || $this->getAttribute( 'rc_type' ) != RC_NEW ) ) { + $errors[] = array( 'rcpatroldisabled' ); + } + // Automatic patrol needs "autopatrol", ordinary patrol needs "patrol" + $right = $auto ? 'autopatrol' : 'patrol'; + $errors = array_merge( $errors, $this->getTitle()->getUserPermissionsErrors( $right, $user ) ); + if ( !wfRunHooks( 'MarkPatrolled', array( $this->getAttribute( 'rc_id' ), &$user, false ) ) ) { + $errors[] = array( 'hookaborted' ); + } + // Users without the 'autopatrol' right can't patrol their + // own revisions + if ( $user->getName() == $this->getAttribute( 'rc_user_text' ) && !$user->isAllowed( 'autopatrol' ) ) { + $errors[] = array( 'markedaspatrollederror-noautopatrol' ); + } + if ( $errors ) { + return $errors; + } + // If the change was patrolled already, do nothing + if ( $this->getAttribute( 'rc_patrolled' ) ) { + return array(); + } + // Actually set the 'patrolled' flag in RC + $this->reallyMarkPatrolled(); + // Log this patrol event + PatrolLog::record( $this, $auto, $user ); + wfRunHooks( 'MarkPatrolledComplete', array( $this->getAttribute( 'rc_id' ), &$user, false ) ); + return array(); + } + + /** + * Mark this RecentChange patrolled, without error checking + * @return Integer: number of affected rows + */ + public function reallyMarkPatrolled() { + $dbw = wfGetDB( DB_MASTER ); + $dbw->update( + 'recentchanges', + array( + 'rc_patrolled' => 1 + ), + array( + 'rc_id' => $this->getAttribute( 'rc_id' ) + ), + __METHOD__ + ); + // Invalidate the page cache after the page has been patrolled + // to make sure that the Patrol link isn't visible any longer! + $this->getTitle()->invalidateCache(); + return $dbw->affectedRows(); + } + + /** + * Makes an entry in the database corresponding to an edit + * + * @param $timestamp + * @param $title Title + * @param $minor + * @param $user User + * @param $comment + * @param $oldId + * @param $lastTimestamp + * @param $bot + * @param $ip string + * @param $oldSize int + * @param $newSize int + * @param $newId int + * @param $patrol int + * @return RecentChange + */ + public static function notifyEdit( $timestamp, &$title, $minor, &$user, $comment, $oldId, + $lastTimestamp, $bot, $ip = '', $oldSize = 0, $newSize = 0, $newId = 0, $patrol = 0 ) { + $rc = new RecentChange; + $rc->mTitle = $title; + $rc->mPerformer = $user; + $rc->mAttribs = array( + 'rc_timestamp' => $timestamp, + 'rc_cur_time' => $timestamp, + 'rc_namespace' => $title->getNamespace(), + 'rc_title' => $title->getDBkey(), + 'rc_type' => RC_EDIT, + 'rc_minor' => $minor ? 1 : 0, + 'rc_cur_id' => $title->getArticleID(), + 'rc_user' => $user->getId(), + 'rc_user_text' => $user->getName(), + 'rc_comment' => $comment, + 'rc_this_oldid' => $newId, + 'rc_last_oldid' => $oldId, + 'rc_bot' => $bot ? 1 : 0, + 'rc_ip' => self::checkIPAddress( $ip ), + 'rc_patrolled' => intval( $patrol ), + 'rc_new' => 0, # obsolete + 'rc_old_len' => $oldSize, + 'rc_new_len' => $newSize, + 'rc_deleted' => 0, + 'rc_logid' => 0, + 'rc_log_type' => null, + 'rc_log_action' => '', + 'rc_params' => '' + ); + + $rc->mExtra = array( + 'prefixedDBkey' => $title->getPrefixedDBkey(), + 'lastTimestamp' => $lastTimestamp, + 'oldSize' => $oldSize, + 'newSize' => $newSize, + 'pageStatus' => 'changed' + ); + $rc->save(); + return $rc; + } + + /** + * Makes an entry in the database corresponding to page creation + * Note: the title object must be loaded with the new id using resetArticleID() + * @todo Document parameters and return + * + * @param $timestamp + * @param $title Title + * @param $minor + * @param $user User + * @param $comment + * @param $bot + * @param $ip string + * @param $size int + * @param $newId int + * @param $patrol int + * @return RecentChange + */ + public static function notifyNew( $timestamp, &$title, $minor, &$user, $comment, $bot, + $ip = '', $size = 0, $newId = 0, $patrol = 0 ) { + $rc = new RecentChange; + $rc->mTitle = $title; + $rc->mPerformer = $user; + $rc->mAttribs = array( + 'rc_timestamp' => $timestamp, + 'rc_cur_time' => $timestamp, + 'rc_namespace' => $title->getNamespace(), + 'rc_title' => $title->getDBkey(), + 'rc_type' => RC_NEW, + 'rc_minor' => $minor ? 1 : 0, + 'rc_cur_id' => $title->getArticleID(), + 'rc_user' => $user->getId(), + 'rc_user_text' => $user->getName(), + 'rc_comment' => $comment, + 'rc_this_oldid' => $newId, + 'rc_last_oldid' => 0, + 'rc_bot' => $bot ? 1 : 0, + 'rc_ip' => self::checkIPAddress( $ip ), + 'rc_patrolled' => intval( $patrol ), + 'rc_new' => 1, # obsolete + 'rc_old_len' => 0, + 'rc_new_len' => $size, + 'rc_deleted' => 0, + 'rc_logid' => 0, + 'rc_log_type' => null, + 'rc_log_action' => '', + 'rc_params' => '' + ); + + $rc->mExtra = array( + 'prefixedDBkey' => $title->getPrefixedDBkey(), + 'lastTimestamp' => 0, + 'oldSize' => 0, + 'newSize' => $size, + 'pageStatus' => 'created' + ); + $rc->save(); + return $rc; + } + + /** + * @param $timestamp + * @param $title + * @param $user + * @param $actionComment + * @param $ip string + * @param $type + * @param $action + * @param $target + * @param $logComment + * @param $params + * @param $newId int + * @param $actionCommentIRC string + * @return bool + */ + public static function notifyLog( $timestamp, &$title, &$user, $actionComment, $ip, $type, + $action, $target, $logComment, $params, $newId = 0, $actionCommentIRC = '' ) + { + global $wgLogRestrictions; + # Don't add private logs to RC! + if ( isset( $wgLogRestrictions[$type] ) && $wgLogRestrictions[$type] != '*' ) { + return false; + } + $rc = self::newLogEntry( $timestamp, $title, $user, $actionComment, $ip, $type, $action, + $target, $logComment, $params, $newId, $actionCommentIRC ); + $rc->save(); + return true; + } + + /** + * @param $timestamp + * @param $title Title + * @param $user User + * @param $actionComment + * @param $ip string + * @param $type + * @param $action + * @param $target Title + * @param $logComment + * @param $params + * @param $newId int + * @param $actionCommentIRC string + * @return RecentChange + */ + public static function newLogEntry( $timestamp, &$title, &$user, $actionComment, $ip, + $type, $action, $target, $logComment, $params, $newId = 0, $actionCommentIRC = '' ) { + global $wgRequest; + + ## Get pageStatus for email notification + switch ( $type . '-' . $action ) { + case 'delete-delete': + $pageStatus = 'deleted'; + break; + case 'move-move': + case 'move-move_redir': + $pageStatus = 'moved'; + break; + case 'delete-restore': + $pageStatus = 'restored'; + break; + case 'upload-upload': + $pageStatus = 'created'; + break; + case 'upload-overwrite': + default: + $pageStatus = 'changed'; + break; + } + + $rc = new RecentChange; + $rc->mTitle = $target; + $rc->mPerformer = $user; + $rc->mAttribs = array( + 'rc_timestamp' => $timestamp, + 'rc_cur_time' => $timestamp, + 'rc_namespace' => $target->getNamespace(), + 'rc_title' => $target->getDBkey(), + 'rc_type' => RC_LOG, + 'rc_minor' => 0, + 'rc_cur_id' => $target->getArticleID(), + 'rc_user' => $user->getId(), + 'rc_user_text' => $user->getName(), + 'rc_comment' => $logComment, + 'rc_this_oldid' => 0, + 'rc_last_oldid' => 0, + 'rc_bot' => $user->isAllowed( 'bot' ) ? $wgRequest->getBool( 'bot', true ) : 0, + 'rc_ip' => self::checkIPAddress( $ip ), + 'rc_patrolled' => 1, + 'rc_new' => 0, # obsolete + 'rc_old_len' => null, + 'rc_new_len' => null, + 'rc_deleted' => 0, + 'rc_logid' => $newId, + 'rc_log_type' => $type, + 'rc_log_action' => $action, + 'rc_params' => $params + ); + + $rc->mExtra = array( + 'prefixedDBkey' => $title->getPrefixedDBkey(), + 'lastTimestamp' => 0, + 'actionComment' => $actionComment, // the comment appended to the action, passed from LogPage + 'pageStatus' => $pageStatus, + 'actionCommentIRC' => $actionCommentIRC + ); + return $rc; + } + + /** + * Initialises the members of this object from a mysql row object + * + * @param $row + */ + public function loadFromRow( $row ) { + $this->mAttribs = get_object_vars( $row ); + $this->mAttribs['rc_timestamp'] = wfTimestamp( TS_MW, $this->mAttribs['rc_timestamp'] ); + $this->mAttribs['rc_deleted'] = $row->rc_deleted; // MUST be set + } + + /** + * Makes a pseudo-RC entry from a cur row + * + * @deprected in 1.22 + * @param $row + */ + public function loadFromCurRow( $row ) { + wfDeprecated( __METHOD__, '1.22' ); + $this->mAttribs = array( + 'rc_timestamp' => wfTimestamp( TS_MW, $row->rev_timestamp ), + 'rc_cur_time' => $row->rev_timestamp, + 'rc_user' => $row->rev_user, + 'rc_user_text' => $row->rev_user_text, + 'rc_namespace' => $row->page_namespace, + 'rc_title' => $row->page_title, + 'rc_comment' => $row->rev_comment, + 'rc_minor' => $row->rev_minor_edit ? 1 : 0, + 'rc_type' => $row->page_is_new ? RC_NEW : RC_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, + 'rc_bot' => 0, + 'rc_ip' => '', + 'rc_id' => $row->rc_id, + 'rc_patrolled' => $row->rc_patrolled, + 'rc_new' => $row->page_is_new, # obsolete + 'rc_old_len' => $row->rc_old_len, + 'rc_new_len' => $row->rc_new_len, + 'rc_params' => isset( $row->rc_params ) ? $row->rc_params : '', + 'rc_log_type' => isset( $row->rc_log_type ) ? $row->rc_log_type : null, + 'rc_log_action' => isset( $row->rc_log_action ) ? $row->rc_log_action : null, + 'rc_logid' => isset( $row->rc_logid ) ? $row->rc_logid : 0, + 'rc_deleted' => $row->rc_deleted // MUST be set + ); + } + + /** + * Get an attribute value + * + * @param string $name Attribute name + * @return mixed + */ + public function getAttribute( $name ) { + return isset( $this->mAttribs[$name] ) ? $this->mAttribs[$name] : null; + } + + /** + * @return array + */ + public function getAttributes() { + return $this->mAttribs; + } + + /** + * Gets the end part of the diff URL associated with this object + * Blank if no diff link should be displayed + * @param $forceCur + * @return string + */ + public function diffLinkTrail( $forceCur ) { + if ( $this->mAttribs['rc_type'] == RC_EDIT ) { + $trail = "curid=" . (int)( $this->mAttribs['rc_cur_id'] ) . + "&oldid=" . (int)( $this->mAttribs['rc_last_oldid'] ); + if ( $forceCur ) { + $trail .= '&diff=0'; + } else { + $trail .= '&diff=' . (int)( $this->mAttribs['rc_this_oldid'] ); + } + } else { + $trail = ''; + } + return $trail; + } + + /** + * Returns the change size (HTML). + * The lengths can be given optionally. + * @param $old int + * @param $new int + * @return string + */ + public function getCharacterDifference( $old = 0, $new = 0 ) { + if ( $old === 0 ) { + $old = $this->mAttribs['rc_old_len']; + } + if ( $new === 0 ) { + $new = $this->mAttribs['rc_new_len']; + } + if ( $old === null || $new === null ) { + return ''; + } + return ChangesList::showCharacterDifference( $old, $new ); + } + + /** + * Purge expired changes from the recentchanges table + * @since 1.22 + */ + public static function purgeExpiredChanges() { + if ( wfReadOnly() ) { + return; + } + + $method = __METHOD__; + $dbw = wfGetDB( DB_MASTER ); + $dbw->onTransactionIdle( function() use ( $dbw, $method ) { + global $wgRCMaxAge; + + $cutoff = $dbw->timestamp( time() - $wgRCMaxAge ); + $dbw->delete( + 'recentchanges', + array( 'rc_timestamp < ' . $dbw->addQuotes( $cutoff ) ), + $method + ); + } ); + } + + private static function checkIPAddress( $ip ) { + global $wgRequest; + if ( $ip ) { + if ( !IP::isIPAddress( $ip ) ) { + throw new MWException( "Attempt to write \"" . $ip . "\" as an IP address into recent changes" ); + } + } else { + $ip = $wgRequest->getIP(); + if ( !$ip ) { + $ip = ''; + } + } + return $ip; + } + + /** + * Check whether the given timestamp is new enough to have a RC row with a given tolerance + * as the recentchanges table might not be cleared out regularly (so older entries might exist) + * or rows which will be deleted soon shouldn't be included. + * + * @param $timestamp mixed MWTimestamp compatible timestamp + * @param $tolerance integer Tolerance in seconds + * @return bool + */ + public static function isInRCLifespan( $timestamp, $tolerance = 0 ) { + global $wgRCMaxAge; + return wfTimestamp( TS_UNIX, $timestamp ) > time() - $tolerance - $wgRCMaxAge; + } +} |