ChangesList.php

Go to the documentation of this file.

<?php
class ChangesList extends ContextSource {
    public $skin;

    protected $watchlist = false;
    protected $lastdate;
    protected $message;
    protected $rc_cache;
    protected $rcCacheIndex;
    protected $rclistOpen;
    protected $rcMoveIndex;

    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();
    }

    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;
        }
    }

    public function setWatchlistDivs( $value = true ) {
        $this->watchlist = $value;
    }

    public function isWatchlist() {
        return (bool)$this->watchlist;
    }

    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();
            }
        }
    }

    public function recentChangesFlags( $flags, $nothing = '&#160;' ) {
        global $wgRecentChangesFlags;
        $f = '';
        foreach ( array_keys( $wgRecentChangesFlags ) as $flag ) {
            $f .= isset( $flags[$flag] ) && $flags[$flag]
                ? self::flag( $flag )
                : $nothing;
        }

        return $f;
    }

    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>';
    }

    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 '<div class="mw-changeslist">';
    }

    public function initChangesListRows( $rows ) {
        wfRunHooks( 'ChangesListInitRows', array( $this, $rows ) );
    }

    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';
        } elseif ( $szdiff > 0 ) {
            $formattedSize = '+' . $formattedSize;
            $formattedSizeClass = 'mw-plusminus-pos';
        } else {
            $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();
    }

    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() );
    }

    public function endRecentChangesList() {
        $out = $this->rclistOpen ? "</ul>\n" : '';
        $out .= '</div>';

        return $out;
    }

    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;
        }
    }

    public function insertLog( &$s, $title, $logtype ) {
        $page = new LogPage( $logtype );
        $logname = $page->getName()->escaped();
        $s .= $this->msg( 'parentheses' )->rawParams( Linker::linkKnown( $title, $logname ) )->escaped();
    }

    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'
            )
        );
        // @todo FIXME: Hard coded ". .". Is there a message for this? Should there be?
        $s .= $this->msg( 'parentheses' )->rawParams( $diffhist )->escaped() .
            ' <span class="mw-changeslist-separator">. .</span> ';
    }

    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";
    }

    public function getTimestamp( $rc ) {
        // @todo FIXME: Hard coded ". .". Is there a message for this? Should there be?
        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> ';
    }

    public function insertTimestamp( &$s, $rc ) {
        $s .= $this->getTimestamp( $rc );
    }

    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'] );
        }
    }

    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();
    }

    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 '';
    }

    public static function usePatrol() {
        global $wgUser;

        wfDeprecated( __METHOD__, '1.22' );

        return $wgUser->useRCPatrol();
    }

    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 '';
        }
    }

    public static function isDeleted( $rc, $field ) {
        return ( $rc->mAttribs['rc_deleted'] & $field ) == $field;
    }

    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 );
        }
    }

    protected function maybeWatchedLink( $link, $watched = false ) {
        if ( $watched ) {
            return '<strong class="mw-watched">' . $link . '</strong>';
        } else {
            return '<span class="mw-rc-unwatched">' . $link . '</span>';
        }
    }

    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();
            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() );
            }
        }
    }

    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 ) {
        return self::isUnpatrolled( $rc, $this->getUser() );
    }

    public static function isUnpatrolled( $rc, User $user ) {
        if ( $rc instanceof RecentChange ) {
            $isPatrolled = $rc->mAttribs['rc_patrolled'];
            $rcType = $rc->mAttribs['rc_type'];
        } else {
            $isPatrolled = $rc->rc_patrolled;
            $rcType = $rc->rc_type;
        }

        if ( !$isPatrolled ) {
            if ( $user->useRCPatrol() ) {
                return true;
            }
            if ( $user->useNPPatrol() && $rcType == RC_NEW ) {
                return true;
            }
        }

        return false;
    }
}