Update docs/hooks.txt for ShowSearchHitTitle

[mediawiki.git] / includes / specials / pagers / DeletedContribsPager.php

<?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
 * @ingroup Pager
 */

/**
 * @ingroup Pager
 */
use MediaWiki\MediaWikiServices;

class DeletedContribsPager extends IndexPager {

        public $mDefaultDirection = IndexPager::DIR_DESCENDING;
        public $messages;
        public $target;
        public $namespace = '';
        public $mDb;

        /**
         * @var string Navigation bar with paging links.
         */
        protected $mNavigationBar;

        function __construct( IContextSource $context, $target, $namespace = false ) {
                parent::__construct( $context );
                $msgs = [ 'deletionlog', 'undeleteviewlink', 'diff' ];
                foreach ( $msgs as $msg ) {
                        $this->messages[$msg] = $this->msg( $msg )->text();
                }
                $this->target = $target;
                $this->namespace = $namespace;
                $this->mDb = wfGetDB( DB_REPLICA, 'contributions' );
        }

        function getDefaultQuery() {
                $query = parent::getDefaultQuery();
                $query['target'] = $this->target;

                return $query;
        }

        function getQueryInfo() {
                list( $index, $userCond ) = $this->getUserCond();
                $conds = array_merge( $userCond, $this->getNamespaceCond() );
                $user = $this->getUser();
                // Paranoia: avoid brute force searches (bug 17792)
                if ( !$user->isAllowed( 'deletedhistory' ) ) {
                        $conds[] = $this->mDb->bitAnd( 'ar_deleted', Revision::DELETED_USER ) . ' = 0';
                } elseif ( !$user->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
                        $conds[] = $this->mDb->bitAnd( 'ar_deleted', Revision::SUPPRESSED_USER ) .
                                ' != ' . Revision::SUPPRESSED_USER;
                }

                return [
                        'tables' => [ 'archive' ],
                        'fields' => [
                                'ar_rev_id', 'ar_namespace', 'ar_title', 'ar_timestamp', 'ar_comment',
                                'ar_minor_edit', 'ar_user', 'ar_user_text', 'ar_deleted'
                        ],
                        'conds' => $conds,
                        'options' => [ 'USE INDEX' => $index ]
                ];
        }

        /**
         * This method basically executes the exact same code as the parent class, though with
         * a hook added, to allow extensions to add additional queries.
         *
         * @param string $offset Index offset, inclusive
         * @param int $limit Exact query limit
         * @param bool $descending Query direction, false for ascending, true for descending
         * @return ResultWrapper
         */
        function reallyDoQuery( $offset, $limit, $descending ) {
                $data = [ parent::reallyDoQuery( $offset, $limit, $descending ) ];

                // This hook will allow extensions to add in additional queries, nearly
                // identical to ContribsPager::reallyDoQuery.
                Hooks::run(
                        'DeletedContribsPager::reallyDoQuery',
                        [ &$data, $this, $offset, $limit, $descending ]
                );

                $result = [];

                // loop all results and collect them in an array
                foreach ( $data as $query ) {
                        foreach ( $query as $i => $row ) {
                                // use index column as key, allowing us to easily sort in PHP
                                $result[$row->{$this->getIndexField()} . "-$i"] = $row;
                        }
                }

                // sort results
                if ( $descending ) {
                        ksort( $result );
                } else {
                        krsort( $result );
                }

                // enforce limit
                $result = array_slice( $result, 0, $limit );

                // get rid of array keys
                $result = array_values( $result );

                return new FakeResultWrapper( $result );
        }

        function getUserCond() {
                $condition = [];

                $condition['ar_user_text'] = $this->target;
                $index = 'usertext_timestamp';

                return [ $index, $condition ];
        }

        function getIndexField() {
                return 'ar_timestamp';
        }

        function getStartBody() {
                return "<ul>\n";
        }

        function getEndBody() {
                return "</ul>\n";
        }

        function getNavigationBar() {
                if ( isset( $this->mNavigationBar ) ) {
                        return $this->mNavigationBar;
                }

                $linkTexts = [
                        'prev' => $this->msg( 'pager-newer-n' )->numParams( $this->mLimit )->escaped(),
                        'next' => $this->msg( 'pager-older-n' )->numParams( $this->mLimit )->escaped(),
                        'first' => $this->msg( 'histlast' )->escaped(),
                        'last' => $this->msg( 'histfirst' )->escaped()
                ];

                $pagingLinks = $this->getPagingLinks( $linkTexts );
                $limitLinks = $this->getLimitLinks();
                $lang = $this->getLanguage();
                $limits = $lang->pipeList( $limitLinks );

                $firstLast = $lang->pipeList( [ $pagingLinks['first'], $pagingLinks['last'] ] );
                $firstLast = $this->msg( 'parentheses' )->rawParams( $firstLast )->escaped();
                $prevNext = $this->msg( 'viewprevnext' )
                        ->rawParams(
                                $pagingLinks['prev'],
                                $pagingLinks['next'],
                                $limits
                        )->escaped();
                $separator = $this->msg( 'word-separator' )->escaped();
                $this->mNavigationBar = $firstLast . $separator . $prevNext;

                return $this->mNavigationBar;
        }

        function getNamespaceCond() {
                if ( $this->namespace !== '' ) {
                        return [ 'ar_namespace' => (int)$this->namespace ];
                } else {
                        return [];
                }
        }

        /**
         * Generates each row in the contributions list.
         *
         * @todo This would probably look a lot nicer in a table.
         * @param stdClass $row
         * @return string
         */
        function formatRow( $row ) {
                $ret = '';
                $classes = [];

                /*
                 * There may be more than just revision rows. To make sure that we'll only be processing
                 * revisions here, let's _try_ to build a revision out of our row (without displaying
                 * notices though) and then trying to grab data from the built object. If we succeed,
                 * we're definitely dealing with revision data and we may proceed, if not, we'll leave it
                 * to extensions to subscribe to the hook to parse the row.
                 */
                MediaWiki\suppressWarnings();
                try {
                        $rev = Revision::newFromArchiveRow( $row );
                        $validRevision = (bool)$rev->getId();
                } catch ( Exception $e ) {
                        $validRevision = false;
                }
                MediaWiki\restoreWarnings();

                if ( $validRevision ) {
                        $ret = $this->formatRevisionRow( $row );
                }

                // Let extensions add data
                Hooks::run( 'DeletedContributionsLineEnding', [ $this, &$ret, $row, &$classes ] );

                if ( $classes === [] && $ret === '' ) {
                        wfDebug( "Dropping Special:DeletedContribution row that could not be formatted\n" );
                        $ret = "<!-- Could not format Special:DeletedContribution row. -->\n";
                } else {
                        $ret = Html::rawElement( 'li', [ 'class' => $classes ], $ret ) . "\n";
                }

                return $ret;
        }

        /**
         * Generates each row in the contributions list for archive entries.
         *
         * Contributions which are marked "top" are currently on top of the history.
         * For these contributions, a [rollback] link is shown for users with sysop
         * privileges. The rollback link restores the most recent version that was not
         * written by the target user.
         *
         * @todo This would probably look a lot nicer in a table.
         * @param stdClass $row
         * @return string
         */
        function formatRevisionRow( $row ) {
                $page = Title::makeTitle( $row->ar_namespace, $row->ar_title );

                $linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();

                $rev = new Revision( [
                        'title' => $page,
                        'id' => $row->ar_rev_id,
                        'comment' => $row->ar_comment,
                        'user' => $row->ar_user,
                        'user_text' => $row->ar_user_text,
                        'timestamp' => $row->ar_timestamp,
                        'minor_edit' => $row->ar_minor_edit,
                        'deleted' => $row->ar_deleted,
                ] );

                $undelete = SpecialPage::getTitleFor( 'Undelete' );

                $logs = SpecialPage::getTitleFor( 'Log' );
                $dellog = $linkRenderer->makeKnownLink(
                        $logs,
                        $this->messages['deletionlog'],
                        [],
                        [
                                'type' => 'delete',
                                'page' => $page->getPrefixedText()
                        ]
                );

                $reviewlink = $linkRenderer->makeKnownLink(
                        SpecialPage::getTitleFor( 'Undelete', $page->getPrefixedDBkey() ),
                        $this->messages['undeleteviewlink']
                );

                $user = $this->getUser();

                if ( $user->isAllowed( 'deletedtext' ) ) {
                        $last = $linkRenderer->makeKnownLink(
                                $undelete,
                                $this->messages['diff'],
                                [],
                                [
                                        'target' => $page->getPrefixedText(),
                                        'timestamp' => $rev->getTimestamp(),
                                        'diff' => 'prev'
                                ]
                        );
                } else {
                        $last = htmlspecialchars( $this->messages['diff'] );
                }

                $comment = Linker::revComment( $rev );
                $date = $this->getLanguage()->userTimeAndDate( $rev->getTimestamp(), $user );

                if ( !$user->isAllowed( 'undelete' ) || !$rev->userCan( Revision::DELETED_TEXT, $user ) ) {
                        $link = htmlspecialchars( $date ); // unusable link
                } else {
                        $link = $linkRenderer->makeKnownLink(
                                $undelete,
                                $date,
                                [ 'class' => 'mw-changeslist-date' ],
                                [
                                        'target' => $page->getPrefixedText(),
                                        'timestamp' => $rev->getTimestamp()
                                ]
                        );
                }
                // Style deleted items
                if ( $rev->isDeleted( Revision::DELETED_TEXT ) ) {
                        $link = '<span class="history-deleted">' . $link . '</span>';
                }

                $pagelink = $linkRenderer->makeLink(
                        $page,
                        null,
                        [ 'class' => 'mw-changeslist-title' ]
                );

                if ( $rev->isMinor() ) {
                        $mflag = ChangesList::flag( 'minor' );
                } else {
                        $mflag = '';
                }

                // Revision delete link
                $del = Linker::getRevDeleteLink( $user, $rev, $page );
                if ( $del ) {
                        $del .= ' ';
                }

                $tools = Html::rawElement(
                        'span',
                        [ 'class' => 'mw-deletedcontribs-tools' ],
                        $this->msg( 'parentheses' )->rawParams( $this->getLanguage()->pipeList(
                                [ $last, $dellog, $reviewlink ] ) )->escaped()
                );

                $separator = '<span class="mw-changeslist-separator">. .</span>';
                $ret = "{$del}{$link} {$tools} {$separator} {$mflag} {$pagelink} {$comment}";

                # Denote if username is redacted for this edit
                if ( $rev->isDeleted( Revision::DELETED_USER ) ) {
                        $ret .= " <strong>" . $this->msg( 'rev-deleted-user-contribs' )->escaped() . "</strong>";
                }

                return $ret;
        }

        /**
         * Get the Database object in use
         *
         * @return IDatabase
         */
        public function getDatabase() {
                return $this->mDb;
        }
}