RevisionDelete.php

Go to the documentation of this file.

<?php
class RevDel_RevisionList extends RevDel_List {
        var $currentRevId;

        public function getType() {
                return 'revision';
        }

        public static function getRelationType() {
                return 'rev_id';
        }

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

                if ( $live->numRows() >= count( $ids ) ) {
                        // All requested revisions are live, keeps things simple!
                        return $live;
                }

                // Check if any requested revisions are available fully deleted.
                $archived = $db->select( array( 'archive' ), '*',
                        array(
                                'ar_rev_id' => $ids
                        ),
                        __METHOD__,
                        array( 'ORDER BY' => 'ar_rev_id DESC' )
                );

                if ( $archived->numRows() == 0 ) {
                        return $live;
                } elseif ( $live->numRows() == 0 ) {
                        return $archived;
                } else {
                        // Combine the two! Whee
                        $rows = array();
                        foreach ( $live as $row ) {
                                $rows[$row->rev_id] = $row;
                        }
                        foreach ( $archived as $row ) {
                                $rows[$row->ar_rev_id] = $row;
                        }
                        krsort( $rows );
                        return new FakeResultWrapper( array_values( $rows ) );
                }
        }

        public function newItem( $row ) {
                if ( isset( $row->rev_id ) ) {
                        return new RevDel_RevisionItem( $this, $row );
                } elseif ( isset( $row->ar_rev_id ) ) {
                        return new RevDel_ArchivedRevisionItem( $this, $row );
                } else {
                        // This shouldn't happen. :)
                        throw new MWException( 'Invalid row type in RevDel_RevisionList' );
                }
        }

        public function getCurrent() {
                if ( is_null( $this->currentRevId ) ) {
                        $dbw = wfGetDB( DB_MASTER );
                        $this->currentRevId = $dbw->selectField(
                                'page', 'page_latest', $this->title->pageCond(), __METHOD__ );
                }
                return $this->currentRevId;
        }

        public function getSuppressBit() {
                return Revision::DELETED_RESTRICTED;
        }

        public function doPreCommitUpdates() {
                $this->title->invalidateCache();
                return Status::newGood();
        }

        public function doPostCommitUpdates() {
                $this->title->purgeSquid();
                // Extensions that require referencing previous revisions may need this
                wfRunHooks( 'ArticleRevisionVisibilitySet', array( &$this->title ) );
                return Status::newGood();
        }
}

class RevDel_RevisionItem extends RevDel_Item {
        var $revision;

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

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

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

        public function getBits() {
                return $this->revision->getVisibility();
        }

        public function setBits( $bits ) {
                $dbw = wfGetDB( DB_MASTER );
                // Update revision table
                $dbw->update( 'revision',
                        array( 'rev_deleted' => $bits ),
                        array(
                                'rev_id' => $this->revision->getId(),
                                'rev_page' => $this->revision->getPage(),
                                'rev_deleted' => $this->getBits()
                        ),
                        __METHOD__
                );
                if ( !$dbw->affectedRows() ) {
                        // Concurrent fail!
                        return false;
                }
                // Update recentchanges table
                $dbw->update( 'recentchanges',
                        array(
                                'rc_deleted' => $bits,
                                'rc_patrolled' => 1
                        ),
                        array(
                                'rc_this_oldid' => $this->revision->getId(), // condition
                                // non-unique timestamp index
                                'rc_timestamp' => $dbw->timestamp( $this->revision->getTimestamp() ),
                        ),
                        __METHOD__
                );
                return true;
        }

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

        public function isHideCurrentOp( $newBits ) {
                return ( $newBits & Revision::DELETED_TEXT )
                        && $this->list->getCurrent() == $this->getId();
        }

        protected function getRevisionLink() {
                $date = htmlspecialchars( $this->list->getLanguage()->userTimeAndDate(
                        $this->revision->getTimestamp(), $this->list->getUser() ) );

                if ( $this->isDeleted() && !$this->canViewContent() ) {
                        return $date;
                }
                return Linker::linkKnown(
                        $this->list->title,
                        $date,
                        array(),
                        array(
                                'oldid' => $this->revision->getId(),
                                'unhide' => 1
                        )
                );
        }

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

        public function getHTML() {
                $difflink = $this->list->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>";
        }
}

class RevDel_ArchiveList extends RevDel_RevisionList {
        public function getType() {
                return 'archive';
        }

        public static function getRelationType() {
                return 'ar_timestamp';
        }

        public function doQuery( $db ) {
                $timestamps = array();
                foreach ( $this->ids as $id ) {
                        $timestamps[] = $db->timestamp( $id );
                }
                return $db->select( 'archive', '*',
                                array(
                                        'ar_namespace' => $this->title->getNamespace(),
                                        'ar_title'     => $this->title->getDBkey(),
                                        'ar_timestamp' => $timestamps
                                ),
                                __METHOD__,
                                array( 'ORDER BY' => 'ar_timestamp DESC' )
                        );
        }

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

        public function doPreCommitUpdates() {
                return Status::newGood();
        }

        public function doPostCommitUpdates() {
                return Status::newGood();
        }
}

class RevDel_ArchiveItem extends RevDel_RevisionItem {
        public function __construct( $list, $row ) {
                RevDel_Item::__construct( $list, $row );
                $this->revision = Revision::newFromArchiveRow( $row,
                        array( 'page' => $this->list->title->getArticleID() ) );
        }

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

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

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

        public function getAuthorNameField() {
                return 'ar_user_text';
        }

        public function getId() {
                # Convert DB timestamp to MW timestamp
                return $this->revision->getTimestamp();
        }

        public function setBits( $bits ) {
                $dbw = wfGetDB( DB_MASTER );
                $dbw->update( 'archive',
                        array( 'ar_deleted' => $bits ),
                        array(
                                'ar_namespace'  => $this->list->title->getNamespace(),
                                'ar_title'      => $this->list->title->getDBkey(),
                                // use timestamp for index
                                'ar_timestamp'  => $this->row->ar_timestamp,
                                'ar_rev_id'     => $this->row->ar_rev_id,
                                'ar_deleted'    => $this->getBits()
                        ),
                        __METHOD__ );
                return (bool)$dbw->affectedRows();
        }

        protected function getRevisionLink() {
                $date = htmlspecialchars( $this->list->getLanguage()->userTimeAndDate(
                        $this->revision->getTimestamp(), $this->list->getUser() ) );

                if ( $this->isDeleted() && !$this->canViewContent() ) {
                        return $date;
                }

                return Linker::link(
                        SpecialPage::getTitleFor( 'Undelete' ),
                        $date,
                        array(),
                        array(
                                'target' => $this->list->title->getPrefixedText(),
                                'timestamp' => $this->revision->getTimestamp()
                        )
                );
        }

        protected function getDiffLink() {
                if ( $this->isDeleted() && !$this->canViewContent() ) {
                        return $this->list->msg( 'diff' )->escaped();
                }

                return Linker::link(
                        SpecialPage::getTitleFor( 'Undelete' ),
                        $this->list->msg( 'diff' )->escaped(),
                        array(),
                        array(
                                'target' => $this->list->title->getPrefixedText(),
                                'diff' => 'prev',
                                'timestamp' => $this->revision->getTimestamp()
                        )
                );
        }
}


class RevDel_ArchivedRevisionItem extends RevDel_ArchiveItem {
        public function __construct( $list, $row ) {
                RevDel_Item::__construct( $list, $row );

                $this->revision = Revision::newFromArchiveRow( $row,
                        array( 'page' => $this->list->title->getArticleID() ) );
        }

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

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

        public function setBits( $bits ) {
                $dbw = wfGetDB( DB_MASTER );
                $dbw->update( 'archive',
                        array( 'ar_deleted' => $bits ),
                        array( 'ar_rev_id' => $this->row->ar_rev_id,
                                'ar_deleted' => $this->getBits()
                        ),
                        __METHOD__ );
                return (bool)$dbw->affectedRows();
        }
}

class RevDel_FileList extends RevDel_List {
        public function getType() {
                return 'oldimage';
        }

        public static function getRelationType() {
                return 'oi_archive_name';
        }

        var $storeBatch, $deleteBatch, $cleanupBatch;

        public function doQuery( $db ) {
                $archiveNames = array();
                foreach( $this->ids as $timestamp ) {
                        $archiveNames[] = $timestamp . '!' . $this->title->getDBkey();
                }
                return $db->select(
                        'oldimage',
                        OldLocalFile::selectFields(),
                        array(
                                'oi_name'         => $this->title->getDBkey(),
                                'oi_archive_name' => $archiveNames
                        ),
                        __METHOD__,
                        array( 'ORDER BY' => 'oi_timestamp DESC' )
                );
        }

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

        public function clearFileOps() {
                $this->deleteBatch = array();
                $this->storeBatch = array();
                $this->cleanupBatch = array();
        }

        public function doPreCommitUpdates() {
                $status = Status::newGood();
                $repo = RepoGroup::singleton()->getLocalRepo();
                if ( $this->storeBatch ) {
                        $status->merge( $repo->storeBatch( $this->storeBatch, FileRepo::OVERWRITE_SAME ) );
                }
                if ( !$status->isOK() ) {
                        return $status;
                }
                if ( $this->deleteBatch ) {
                        $status->merge( $repo->deleteBatch( $this->deleteBatch ) );
                }
                if ( !$status->isOK() ) {
                        // Running cleanupDeletedBatch() after a failed storeBatch() with the DB already
                        // modified (but destined for rollback) causes data loss
                        return $status;
                }
                if ( $this->cleanupBatch ) {
                        $status->merge( $repo->cleanupDeletedBatch( $this->cleanupBatch ) );
                }
                return $status;
        }

        public function doPostCommitUpdates() {
                $file = wfLocalFile( $this->title );
                $file->purgeCache();
                $file->purgeDescription();
                return Status::newGood();
        }

        public function getSuppressBit() {
                return File::DELETED_RESTRICTED;
        }
}

class RevDel_FileItem extends RevDel_Item {

        var $file;

        public function __construct( $list, $row ) {
                parent::__construct( $list, $row );
                $this->file = RepoGroup::singleton()->getLocalRepo()->newFileFromRow( $row );
        }

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

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

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

        public function getAuthorNameField() {
                return 'oi_user_text';
        }

        public function getId() {
                $parts = explode( '!', $this->row->oi_archive_name );
                return $parts[0];
        }

        public function canView() {
                return $this->file->userCan( File::DELETED_RESTRICTED, $this->list->getUser() );
        }

        public function canViewContent() {
                return $this->file->userCan( File::DELETED_FILE, $this->list->getUser() );
        }

        public function getBits() {
                return $this->file->getVisibility();
        }

        public function setBits( $bits ) {
                # Queue the file op
                # @todo FIXME: Move to LocalFile.php
                if ( $this->isDeleted() ) {
                        if ( $bits & File::DELETED_FILE ) {
                                # Still deleted
                        } else {
                                # Newly undeleted
                                $key = $this->file->getStorageKey();
                                $srcRel = $this->file->repo->getDeletedHashPath( $key ) . $key;
                                $this->list->storeBatch[] = array(
                                        $this->file->repo->getVirtualUrl( 'deleted' ) . '/' . $srcRel,
                                        'public',
                                        $this->file->getRel()
                                );
                                $this->list->cleanupBatch[] = $key;
                        }
                } elseif ( $bits & File::DELETED_FILE ) {
                        # Newly deleted
                        $key = $this->file->getStorageKey();
                        $dstRel = $this->file->repo->getDeletedHashPath( $key ) . $key;
                        $this->list->deleteBatch[] = array( $this->file->getRel(), $dstRel );
                }

                # Do the database operations
                $dbw = wfGetDB( DB_MASTER );
                $dbw->update( 'oldimage',
                        array( 'oi_deleted' => $bits ),
                        array(
                                'oi_name' => $this->row->oi_name,
                                'oi_timestamp' => $this->row->oi_timestamp,
                                'oi_deleted' => $this->getBits()
                        ),
                        __METHOD__
                );
                return (bool)$dbw->affectedRows();
        }

        public function isDeleted() {
                return $this->file->isDeleted( File::DELETED_FILE );
        }

        protected function getLink() {
                $date = htmlspecialchars( $this->list->getLanguage()->userTimeAndDate(
                        $this->file->getTimestamp(), $this->list->getUser() ) );

                if ( !$this->isDeleted() ) {
                        # Regular files...
                        return Html::rawElement( 'a', array( 'href' => $this->file->getUrl() ), $date );
                }

                # Hidden files...
                if ( !$this->canViewContent() ) {
                        $link = $date;
                } else {
                        $link = Linker::link(
                                SpecialPage::getTitleFor( 'Revisiondelete' ),
                                $date,
                                array(),
                                array(
                                        'target' => $this->list->title->getPrefixedText(),
                                        'file'   => $this->file->getArchiveName(),
                                        'token'  => $this->list->getUser()->getEditToken(
                                                $this->file->getArchiveName() )
                                )
                        );
                }
                return '<span class="history-deleted">' . $link . '</span>';
        }
        protected function getUserTools() {
                if( $this->file->userCan( Revision::DELETED_USER, $this->list->getUser() ) ) {
                        $link = Linker::userLink( $this->file->user, $this->file->user_text ) .
                                Linker::userToolLinks( $this->file->user, $this->file->user_text );
                } else {
                        $link = $this->list->msg( 'rev-deleted-user' )->escaped();
                }
                if( $this->file->isDeleted( Revision::DELETED_USER ) ) {
                        return '<span class="history-deleted">' . $link . '</span>';
                }
                return $link;
        }

        protected function getComment() {
                if( $this->file->userCan( File::DELETED_COMMENT, $this->list->getUser() ) ) {
                        $block = Linker::commentBlock( $this->file->description );
                } else {
                        $block = ' ' . $this->list->msg( 'rev-deleted-comment' )->escaped();
                }
                if( $this->file->isDeleted( File::DELETED_COMMENT ) ) {
                        return "<span class=\"history-deleted\">$block</span>";
                }
                return $block;
        }

        public function getHTML() {
                $data =
                        $this->list->msg( 'widthheight' )->numParams(
                                $this->file->getWidth(), $this->file->getHeight() )->text() .
                        ' (' . $this->list->msg( 'nbytes' )->numParams( $this->file->getSize() )->text() . ')';

                return '<li>' . $this->getLink() . ' ' . $this->getUserTools() . ' ' .
                        $data . ' ' . $this->getComment(). '</li>';
        }
}

class RevDel_ArchivedFileList extends RevDel_FileList {
        public function getType() {
                return 'filearchive';
        }

        public static function getRelationType() {
                return 'fa_id';
        }

        public function doQuery( $db ) {
                $ids = array_map( 'intval', $this->ids );
                return $db->select(
                        'filearchive',
                        ArchivedFile::selectFields(),
                        array(
                                'fa_name' => $this->title->getDBkey(),
                                'fa_id'   => $ids
                        ),
                        __METHOD__,
                        array( 'ORDER BY' => 'fa_id DESC' )
                );
        }

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

class RevDel_ArchivedFileItem extends RevDel_FileItem {
        public function __construct( $list, $row ) {
                RevDel_Item::__construct( $list, $row );
                $this->file = ArchivedFile::newFromRow( $row );
        }

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

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

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

        public function getAuthorNameField() {
                return 'fa_user_text';
        }

        public function getId() {
                return $this->row->fa_id;
        }

        public function setBits( $bits ) {
                $dbw = wfGetDB( DB_MASTER );
                $dbw->update( 'filearchive',
                        array( 'fa_deleted' => $bits ),
                        array(
                                'fa_id' => $this->row->fa_id,
                                'fa_deleted' => $this->getBits(),
                        ),
                        __METHOD__
                );
                return (bool)$dbw->affectedRows();
        }

        protected function getLink() {
                $date = htmlspecialchars( $this->list->getLanguage()->userTimeAndDate(
                        $this->file->getTimestamp(), $this->list->getUser() ) );

                # Hidden files...
                if( !$this->canViewContent() ) {
                        $link = $date;
                } else {
                        $undelete = SpecialPage::getTitleFor( 'Undelete' );
                        $key = $this->file->getKey();
                        $link = Linker::link( $undelete, $date, array(),
                                array(
                                        'target' => $this->list->title->getPrefixedText(),
                                        'file' => $key,
                                        'token' => $this->list->getUser()->getEditToken( $key )
                                )
                        );
                }
                if( $this->isDeleted() ) {
                        $link = '<span class="history-deleted">' . $link . '</span>';
                }
                return $link;
        }
}

class RevDel_LogList extends RevDel_List {
        public function getType() {
                return 'logging';
        }

        public static function getRelationType() {
                return 'log_id';
        }

        public function doQuery( $db ) {
                $ids = array_map( 'intval', $this->ids );
                return $db->select( 'logging', '*',
                        array( 'log_id' => $ids ),
                        __METHOD__,
                        array( 'ORDER BY' => 'log_id DESC' )
                );
        }

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

        public function getSuppressBit() {
                return Revision::DELETED_RESTRICTED;
        }

        public function getLogAction() {
                return 'event';
        }

        public function getLogParams( $params ) {
                return array(
                        implode( ',', $params['ids'] ),
                        "ofield={$params['oldBits']}",
                        "nfield={$params['newBits']}"
                );
        }
}

class RevDel_LogItem extends RevDel_Item {
        public function getIdField() {
                return 'log_id';
        }

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

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

        public function getAuthorNameField() {
                return 'log_user_text';
        }

        public function canView() {
                return LogEventsList::userCan( $this->row, Revision::DELETED_RESTRICTED, $this->list->getUser() );
        }

        public function canViewContent() {
                return true; // none
        }

        public function getBits() {
                return $this->row->log_deleted;
        }

        public function setBits( $bits ) {
                $dbw = wfGetDB( DB_MASTER );
                $dbw->update( 'recentchanges',
                        array(
                                'rc_deleted' => $bits,
                                'rc_patrolled' => 1
                        ),
                        array(
                                'rc_logid' => $this->row->log_id,
                                'rc_timestamp' => $this->row->log_timestamp // index
                        ),
                        __METHOD__
                );
                $dbw->update( 'logging',
                        array( 'log_deleted' => $bits ),
                        array(
                                'log_id' => $this->row->log_id,
                                'log_deleted' => $this->getBits()
                        ),
                        __METHOD__
                );
                return (bool)$dbw->affectedRows();
        }

        public function getHTML() {
                $date = htmlspecialchars( $this->list->getLanguage()->userTimeAndDate(
                        $this->row->log_timestamp, $this->list->getUser() ) );
                $title = Title::makeTitle( $this->row->log_namespace, $this->row->log_title );
                $formatter = LogFormatter::newFromRow( $this->row );
                $formatter->setContext( $this->list->getContext() );
                $formatter->setAudience( LogFormatter::FOR_THIS_USER );

                // Log link for this page
                $loglink = Linker::link(
                        SpecialPage::getTitleFor( 'Log' ),
                        $this->list->msg( 'log' )->escaped(),
                        array(),
                        array( 'page' => $title->getPrefixedText() )
                );
                $loglink = $this->list->msg( 'parentheses' )->rawParams( $loglink )->escaped();
                // User links and action text
                $action = $formatter->getActionText();
                // Comment
                $comment = $this->list->getLanguage()->getDirMark() . Linker::commentBlock( $this->row->log_comment );
                if( LogEventsList::isDeleted( $this->row, LogPage::DELETED_COMMENT ) ) {
                        $comment = '<span class="history-deleted">' . $comment . '</span>';
                }

                return "<li>$loglink $date $action $comment</li>";
        }
}