RevisionList.php

Go to the documentation of this file.

<?php
abstract class RevisionListBase extends ContextSource {
        var $title;

        var $ids, $res, $current;

        function __construct( IContextSource $context, Title $title ) {
                $this->setContext( $context );
                $this->title = $title;
        }

        function filterByIds( array $ids ) {
                $this->ids = $ids;
        }

        public function getType() {
                return null;
        }

        protected function initCurrent() {
                $row = $this->res->current();
                if ( $row ) {
                        $this->current = $this->newItem( $row );
                } else {
                        $this->current = false;
                }
        }

        public function reset() {
                if ( !$this->res ) {
                        $this->res = $this->doQuery( wfGetDB( DB_SLAVE ) );
                } else {
                        $this->res->rewind();
                }
                $this->initCurrent();
                return $this->current;
        }

        public function current() {
                return $this->current;
        }

        public function next() {
                $this->res->next();
                $this->initCurrent();
                return $this->current;
        }

        public function length() {
                if( !$this->res ) {
                        return 0;
                } else {
                        return $this->res->numRows();
                }
        }

        abstract public function doQuery( $db );

        abstract public function newItem( $row );
}

abstract class RevisionItemBase {
        var $list;

        var $row;

        public function __construct( $list, $row ) {
                $this->list = $list;
                $this->row = $row;
        }

        public function getIdField() {
                return null;
        }

        public function getTimestampField() {
                return false;
        }

        public function getAuthorIdField() {
                return false;
        }

        public function getAuthorNameField() {
                return false;
        }

        public function getId() {
                $field = $this->getIdField();
                return $this->row->$field;
        }

        public function formatDate() {
                return $this->list->getLanguage()->userDate( $this->getTimestamp(),
                        $this->list->getUser() );
        }

        public function formatTime() {
                return $this->list->getLanguage()->userTime( $this->getTimestamp(),
                        $this->list->getUser() );
        }

        public function getTimestamp() {
                $field = $this->getTimestampField();
                return wfTimestamp( TS_MW, $this->row->$field );
        }

        public function getAuthorId() {
                $field = $this->getAuthorIdField();
                return intval( $this->row->$field );
        }

        public function getAuthorName() {
                $field = $this->getAuthorNameField();
                return strval( $this->row->$field );
        }

        abstract public function canView();

        abstract public function canViewContent();

        abstract public function getHTML();
}

class RevisionList extends RevisionListBase {
        public function getType() {
                return 'revision';
        }

        public function doQuery( $db ) {
                $conds = array( 'rev_page' => $this->title->getArticleID() );
                if ( $this->ids !== null ) {
                        $conds['rev_id'] = array_map( 'intval', $this->ids );
                }
                return $db->select(
                        array( 'revision', 'page', 'user' ),
                        array_merge( Revision::selectFields(), Revision::selectUserFields() ),
                        $conds,
                        __METHOD__,
                        array( 'ORDER BY' => 'rev_id DESC' ),
                        array(
                                'page' => Revision::pageJoinCond(),
                                'user' => Revision::userJoinCond() )
                );
        }

        public function newItem( $row ) {
                return new RevisionItem( $this, $row );
        }
}

class RevisionItem extends RevisionItemBase {
        var $revision, $context;

        public function __construct( $list, $row ) {
                parent::__construct( $list, $row );
                $this->revision = new Revision( $row );
                $this->context = $list->getContext();
        }

        public function getIdField() {
                return 'rev_id';
        }

        public function getTimestampField() {
                return 'rev_timestamp';
        }

        public function getAuthorIdField() {
                return 'rev_user';
        }

        public function getAuthorNameField() {
                return 'user_name'; // see Revision::selectUserFields()
        }

        public function canView() {
                return $this->revision->userCan( Revision::DELETED_RESTRICTED, $this->context->getUser() );
        }

        public function canViewContent() {
                return $this->revision->userCan( Revision::DELETED_TEXT, $this->context->getUser() );
        }

        public function isDeleted() {
                return $this->revision->isDeleted( Revision::DELETED_TEXT );
        }

        protected function getRevisionLink() {
                $date = $this->list->getLanguage()->timeanddate( $this->revision->getTimestamp(), true );
                if ( $this->isDeleted() && !$this->canViewContent() ) {
                        return $date;
                }
                return Linker::link(
                        $this->list->title,
                        $date,
                        array(),
                        array(
                                'oldid' => $this->revision->getId(),
                                'unhide' => 1
                        )
                );
        }

        protected function getDiffLink() {
                if ( $this->isDeleted() && !$this->canViewContent() ) {
                        return $this->context->msg( 'diff' )->escaped();
                } else {
                        return
                                Linker::link(
                                        $this->list->title,
                                        $this->context->msg( 'diff' )->escaped(),
                                        array(),
                                        array(
                                                'diff' => $this->revision->getId(),
                                                'oldid' => 'prev',
                                                'unhide' => 1
                                        ),
                                        array(
                                                'known',
                                                'noclasses'
                                        )
                                );
                }
        }

        public function getHTML() {
                $difflink = $this->context->msg( 'parentheses' )
                        ->rawParams( $this->getDiffLink() )->escaped();
                $revlink = $this->getRevisionLink();
                $userlink = Linker::revUserLink( $this->revision );
                $comment = Linker::revComment( $this->revision );
                if ( $this->isDeleted() ) {
                        $revlink = "<span class=\"history-deleted\">$revlink</span>";
                }
                return "<li>$difflink $revlink $userlink $comment</li>";
        }
}