SpecialContributions.php

Go to the documentation of this file.

<?php
use MediaWiki\MediaWikiServices;
use MediaWiki\Widget\DateInputWidget;

class SpecialContributions extends IncludableSpecialPage {
    protected $opts;

    public function __construct() {
        parent::__construct( 'Contributions' );
    }

    public function execute( $par ) {
        $this->setHeaders();
        $this->outputHeader();
        $out = $this->getOutput();
        // Modules required for viewing the list of contributions (also when included on other pages)
        $out->addModuleStyles( [
            'mediawiki.special',
            'mediawiki.special.changeslist',
        ] );
        $this->addHelpLink( 'Help:User contributions' );

        $this->opts = [];
        $request = $this->getRequest();

        $target = $par ?? $request->getVal( 'target' );

        if ( $request->getVal( 'contribs' ) == 'newbie' || $par === 'newbies' ) {
            $target = 'newbies';
            $this->opts['contribs'] = 'newbie';
        } else {
            $this->opts['contribs'] = 'user';
        }

        $this->opts['deletedOnly'] = $request->getBool( 'deletedOnly' );

        if ( !strlen( $target ) ) {
            if ( !$this->including() ) {
                $out->addHTML( $this->getForm() );
            }

            return;
        }

        $user = $this->getUser();

        $this->opts['limit'] = $request->getInt( 'limit', $user->getOption( 'rclimit' ) );
        $this->opts['target'] = $target;
        $this->opts['topOnly'] = $request->getBool( 'topOnly' );
        $this->opts['newOnly'] = $request->getBool( 'newOnly' );
        $this->opts['hideMinor'] = $request->getBool( 'hideMinor' );

        $id = 0;
        if ( $this->opts['contribs'] === 'newbie' ) {
            $userObj = User::newFromName( $target ); // hysterical raisins
            $out->addSubtitle( $this->msg( 'sp-contributions-newbies-sub' ) );
            $out->setHTMLTitle( $this->msg(
                'pagetitle',
                $this->msg( 'sp-contributions-newbies-title' )->plain()
            )->inContentLanguage() );
        } elseif ( ExternalUserNames::isExternal( $target ) ) {
            $userObj = User::newFromName( $target, false );
            if ( !$userObj ) {
                $out->addHTML( $this->getForm() );
                return;
            }

            $out->addSubtitle( $this->contributionsSub( $userObj ) );
            $out->setHTMLTitle( $this->msg(
                'pagetitle',
                $this->msg( 'contributions-title', $target )->plain()
            )->inContentLanguage() );
        } else {
            $nt = Title::makeTitleSafe( NS_USER, $target );
            if ( !$nt ) {
                $out->addHTML( $this->getForm() );
                return;
            }
            $userObj = User::newFromName( $nt->getText(), false );
            if ( !$userObj ) {
                $out->addHTML( $this->getForm() );
                return;
            }
            $id = $userObj->getId();

            $target = $nt->getText();
            $out->addSubtitle( $this->contributionsSub( $userObj ) );
            $out->setHTMLTitle( $this->msg(
                'pagetitle',
                $this->msg( 'contributions-title', $target )->plain()
            )->inContentLanguage() );

            # For IP ranges, we want the contributionsSub, but not the skin-dependent
            # links under 'Tools', which may include irrelevant links like 'Logs'.
            if ( !IP::isValidRange( $target ) ) {
                $this->getSkin()->setRelevantUser( $userObj );
            }
        }

        $ns = $request->getVal( 'namespace', null );
        if ( $ns !== null && $ns !== '' ) {
            $this->opts['namespace'] = intval( $ns );
        } else {
            $this->opts['namespace'] = '';
        }

        $this->opts['associated'] = $request->getBool( 'associated' );
        $this->opts['nsInvert'] = (bool)$request->getVal( 'nsInvert' );
        $this->opts['tagfilter'] = (string)$request->getVal( 'tagfilter' );

        // Allows reverts to have the bot flag in recent changes. It is just here to
        // be passed in the form at the top of the page
        if ( $user->isAllowed( 'markbotedits' ) && $request->getBool( 'bot' ) ) {
            $this->opts['bot'] = '1';
        }

        $skip = $request->getText( 'offset' ) || $request->getText( 'dir' ) == 'prev';
        # Offset overrides year/month selection
        if ( !$skip ) {
            $this->opts['year'] = $request->getVal( 'year' );
            $this->opts['month'] = $request->getVal( 'month' );

            $this->opts['start'] = $request->getVal( 'start' );
            $this->opts['end'] = $request->getVal( 'end' );
        }
        $this->opts = ContribsPager::processDateFilter( $this->opts );

        $feedType = $request->getVal( 'feed' );

        $feedParams = [
            'action' => 'feedcontributions',
            'user' => $target,
        ];
        if ( $this->opts['topOnly'] ) {
            $feedParams['toponly'] = true;
        }
        if ( $this->opts['newOnly'] ) {
            $feedParams['newonly'] = true;
        }
        if ( $this->opts['hideMinor'] ) {
            $feedParams['hideminor'] = true;
        }
        if ( $this->opts['deletedOnly'] ) {
            $feedParams['deletedonly'] = true;
        }
        if ( $this->opts['tagfilter'] !== '' ) {
            $feedParams['tagfilter'] = $this->opts['tagfilter'];
        }
        if ( $this->opts['namespace'] !== '' ) {
            $feedParams['namespace'] = $this->opts['namespace'];
        }
        // Don't use year and month for the feed URL, but pass them on if
        // we redirect to API (if $feedType is specified)
        if ( $feedType && $this->opts['year'] !== null ) {
            $feedParams['year'] = $this->opts['year'];
        }
        if ( $feedType && $this->opts['month'] !== null ) {
            $feedParams['month'] = $this->opts['month'];
        }

        if ( $feedType ) {
            // Maintain some level of backwards compatibility
            // If people request feeds using the old parameters, redirect to API
            $feedParams['feedformat'] = $feedType;
            $url = wfAppendQuery( wfScript( 'api' ), $feedParams );

            $out->redirect( $url, '301' );

            return;
        }

        // Add RSS/atom links
        $this->addFeedLinks( $feedParams );

        if ( Hooks::run( 'SpecialContributionsBeforeMainOutput', [ $id, $userObj, $this ] ) ) {
            if ( !$this->including() ) {
                $out->addHTML( $this->getForm() );
            }
            $pager = new ContribsPager( $this->getContext(), [
                'target' => $target,
                'contribs' => $this->opts['contribs'],
                'namespace' => $this->opts['namespace'],
                'tagfilter' => $this->opts['tagfilter'],
                'start' => $this->opts['start'],
                'end' => $this->opts['end'],
                'deletedOnly' => $this->opts['deletedOnly'],
                'topOnly' => $this->opts['topOnly'],
                'newOnly' => $this->opts['newOnly'],
                'hideMinor' => $this->opts['hideMinor'],
                'nsInvert' => $this->opts['nsInvert'],
                'associated' => $this->opts['associated'],
            ] );

            if ( IP::isValidRange( $target ) && !$pager->isQueryableRange( $target ) ) {
                // Valid range, but outside CIDR limit.
                $limits = $this->getConfig()->get( 'RangeContributionsCIDRLimit' );
                $limit = $limits[ IP::isIPv4( $target ) ? 'IPv4' : 'IPv6' ];
                $out->addWikiMsg( 'sp-contributions-outofrange', $limit );
            } elseif ( !$pager->getNumRows() ) {
                $out->addWikiMsg( 'nocontribs', $target );
            } else {
                # Show a message about replica DB lag, if applicable
                $lb = MediaWikiServices::getInstance()->getDBLoadBalancer();
                $lag = $lb->safeGetLag( $pager->getDatabase() );
                if ( $lag > 0 ) {
                    $out->showLagWarning( $lag );
                }

                $output = $pager->getBody();
                if ( !$this->including() ) {
                    $output = '<p>' . $pager->getNavigationBar() . '</p>' .
                        $output .
                        '<p>' . $pager->getNavigationBar() . '</p>';
                }
                $out->addHTML( $output );
            }

            $out->preventClickjacking( $pager->getPreventClickjacking() );

            # Show the appropriate "footer" message - WHOIS tools, etc.
            if ( $this->opts['contribs'] == 'newbie' ) {
                $message = 'sp-contributions-footer-newbies';
            } elseif ( IP::isValidRange( $target ) ) {
                $message = 'sp-contributions-footer-anon-range';
            } elseif ( IP::isIPAddress( $target ) ) {
                $message = 'sp-contributions-footer-anon';
            } elseif ( $userObj->isAnon() ) {
                // No message for non-existing users
                $message = '';
            } else {
                $message = 'sp-contributions-footer';
            }

            if ( $message ) {
                if ( !$this->including() ) {
                    if ( !$this->msg( $message, $target )->isDisabled() ) {
                        $out->wrapWikiMsg(
                            "<div class='mw-contributions-footer'>\n$1\n</div>",
                            [ $message, $target ] );
                    }
                }
            }
        }
    }

    protected function contributionsSub( $userObj ) {
        if ( $userObj->isAnon() ) {
            // Show a warning message that the user being searched for doesn't exists.
            // User::isIP returns true for IP address and usemod IPs like '123.123.123.xxx',
            // but returns false for IP ranges. We don't want to suggest either of these are
            // valid usernames which we would with the 'contributions-userdoesnotexist' message.
            if ( !User::isIP( $userObj->getName() ) && !$userObj->isIPRange() ) {
                $this->getOutput()->wrapWikiMsg(
                    "<div class=\"mw-userpage-userdoesnotexist error\">\n\$1\n</div>",
                    [
                        'contributions-userdoesnotexist',
                        wfEscapeWikiText( $userObj->getName() ),
                    ]
                );
                if ( !$this->including() ) {
                    $this->getOutput()->setStatusCode( 404 );
                }
            }
            $user = htmlspecialchars( $userObj->getName() );
        } else {
            $user = $this->getLinkRenderer()->makeLink( $userObj->getUserPage(), $userObj->getName() );
        }
        $nt = $userObj->getUserPage();
        $talk = $userObj->getTalkPage();
        $links = '';
        if ( $talk ) {
            $tools = self::getUserLinks( $this, $userObj );
            $links = $this->getLanguage()->pipeList( $tools );

            // Show a note if the user is blocked and display the last block log entry.
            // Do not expose the autoblocks, since that may lead to a leak of accounts' IPs,
            // and also this will display a totally irrelevant log entry as a current block.
            if ( !$this->including() ) {
                // For IP ranges you must give Block::newFromTarget the CIDR string and not a user object.
                if ( $userObj->isIPRange() ) {
                    $block = Block::newFromTarget( $userObj->getName(), $userObj->getName() );
                } else {
                    $block = Block::newFromTarget( $userObj, $userObj );
                }

                if ( !is_null( $block ) && $block->getType() != Block::TYPE_AUTO ) {
                    if ( $block->getType() == Block::TYPE_RANGE ) {
                        $nt = MWNamespace::getCanonicalName( NS_USER ) . ':' . $block->getTarget();
                    }

                    $out = $this->getOutput(); // showLogExtract() wants first parameter by reference
                    LogEventsList::showLogExtract(
                        $out,
                        'block',
                        $nt,
                        '',
                        [
                            'lim' => 1,
                            'showIfEmpty' => false,
                            'msgKey' => [
                                $userObj->isAnon() ?
                                    'sp-contributions-blocked-notice-anon' :
                                    'sp-contributions-blocked-notice',
                                $userObj->getName() # Support GENDER in 'sp-contributions-blocked-notice'
                            ],
                            'offset' => '' # don't use WebRequest parameter offset
                        ]
                    );
                }
            }
        }

        return $this->msg( 'contribsub2' )->rawParams( $user, $links )->params( $userObj->getName() );
    }

    public static function getUserLinks( SpecialPage $sp, User $target ) {
        $id = $target->getId();
        $username = $target->getName();
        $userpage = $target->getUserPage();
        $talkpage = $target->getTalkPage();

        $linkRenderer = $sp->getLinkRenderer();

        # No talk pages for IP ranges.
        if ( !IP::isValidRange( $username ) ) {
            $tools['user-talk'] = $linkRenderer->makeLink(
                $talkpage,
                $sp->msg( 'sp-contributions-talk' )->text()
            );
        }

        if ( ( $id !== null ) || ( $id === null && IP::isIPAddress( $username ) ) ) {
            if ( $sp->getUser()->isAllowed( 'block' ) ) { # Block / Change block / Unblock links
                if ( $target->isBlocked() && $target->getBlock()->getType() != Block::TYPE_AUTO ) {
                    $tools['block'] = $linkRenderer->makeKnownLink( # Change block link
                        SpecialPage::getTitleFor( 'Block', $username ),
                        $sp->msg( 'change-blocklink' )->text()
                    );
                    $tools['unblock'] = $linkRenderer->makeKnownLink( # Unblock link
                        SpecialPage::getTitleFor( 'Unblock', $username ),
                        $sp->msg( 'unblocklink' )->text()
                    );
                } else { # User is not blocked
                    $tools['block'] = $linkRenderer->makeKnownLink( # Block link
                        SpecialPage::getTitleFor( 'Block', $username ),
                        $sp->msg( 'blocklink' )->text()
                    );
                }
            }

            # Block log link
            $tools['log-block'] = $linkRenderer->makeKnownLink(
                SpecialPage::getTitleFor( 'Log', 'block' ),
                $sp->msg( 'sp-contributions-blocklog' )->text(),
                [],
                [ 'page' => $userpage->getPrefixedText() ]
            );

            # Suppression log link (T61120)
            if ( $sp->getUser()->isAllowed( 'suppressionlog' ) ) {
                $tools['log-suppression'] = $linkRenderer->makeKnownLink(
                    SpecialPage::getTitleFor( 'Log', 'suppress' ),
                    $sp->msg( 'sp-contributions-suppresslog', $username )->text(),
                    [],
                    [ 'offender' => $username ]
                );
            }
        }

        # Don't show some links for IP ranges
        if ( !IP::isValidRange( $username ) ) {
            # Uploads
            $tools['uploads'] = $linkRenderer->makeKnownLink(
                SpecialPage::getTitleFor( 'Listfiles', $username ),
                $sp->msg( 'sp-contributions-uploads' )->text()
            );

            # Other logs link
            $tools['logs'] = $linkRenderer->makeKnownLink(
                SpecialPage::getTitleFor( 'Log', $username ),
                $sp->msg( 'sp-contributions-logs' )->text()
            );

            # Add link to deleted user contributions for priviledged users
            if ( $sp->getUser()->isAllowed( 'deletedhistory' ) ) {
                $tools['deletedcontribs'] = $linkRenderer->makeKnownLink(
                    SpecialPage::getTitleFor( 'DeletedContributions', $username ),
                    $sp->msg( 'sp-contributions-deleted', $username )->text()
                );
            }
        }

        # Add a link to change user rights for privileged users
        $userrightsPage = new UserrightsPage();
        $userrightsPage->setContext( $sp->getContext() );
        if ( $userrightsPage->userCanChangeRights( $target ) ) {
            $tools['userrights'] = $linkRenderer->makeKnownLink(
                SpecialPage::getTitleFor( 'Userrights', $username ),
                $sp->msg( 'sp-contributions-userrights', $username )->text()
            );
        }

        Hooks::run( 'ContributionsToolLinks', [ $id, $userpage, &$tools, $sp ] );

        return $tools;
    }

    protected function getForm() {
        $this->opts['title'] = $this->getPageTitle()->getPrefixedText();
        if ( !isset( $this->opts['target'] ) ) {
            $this->opts['target'] = '';
        } else {
            $this->opts['target'] = str_replace( '_', ' ', $this->opts['target'] );
        }

        if ( !isset( $this->opts['namespace'] ) ) {
            $this->opts['namespace'] = '';
        }

        if ( !isset( $this->opts['nsInvert'] ) ) {
            $this->opts['nsInvert'] = '';
        }

        if ( !isset( $this->opts['associated'] ) ) {
            $this->opts['associated'] = false;
        }

        if ( !isset( $this->opts['contribs'] ) ) {
            $this->opts['contribs'] = 'user';
        }

        if ( !isset( $this->opts['start'] ) ) {
            $this->opts['start'] = '';
        }

        if ( !isset( $this->opts['end'] ) ) {
            $this->opts['end'] = '';
        }

        if ( $this->opts['contribs'] == 'newbie' ) {
            $this->opts['target'] = '';
        }

        if ( !isset( $this->opts['tagfilter'] ) ) {
            $this->opts['tagfilter'] = '';
        }

        if ( !isset( $this->opts['topOnly'] ) ) {
            $this->opts['topOnly'] = false;
        }

        if ( !isset( $this->opts['newOnly'] ) ) {
            $this->opts['newOnly'] = false;
        }

        if ( !isset( $this->opts['hideMinor'] ) ) {
            $this->opts['hideMinor'] = false;
        }

        // Modules required only for the form
        $this->getOutput()->addModules( [
            'mediawiki.userSuggest',
            'mediawiki.special.contributions',
        ] );
        $this->getOutput()->addModuleStyles( 'mediawiki.widgets.DateInputWidget.styles' );
        $this->getOutput()->enableOOUI();

        $form = Html::openElement(
            'form',
            [
                'method' => 'get',
                'action' => wfScript(),
                'class' => 'mw-contributions-form'
            ]
        );

        # Add hidden params for tracking except for parameters in $skipParameters
        $skipParameters = [
            'namespace',
            'nsInvert',
            'deletedOnly',
            'target',
            'contribs',
            'year',
            'month',
            'start',
            'end',
            'topOnly',
            'newOnly',
            'hideMinor',
            'associated',
            'tagfilter'
        ];

        foreach ( $this->opts as $name => $value ) {
            if ( in_array( $name, $skipParameters ) ) {
                continue;
            }
            $form .= "\t" . Html::hidden( $name, $value ) . "\n";
        }

        $tagFilter = ChangeTags::buildTagFilterSelector(
            $this->opts['tagfilter'], false, $this->getContext() );

        if ( $tagFilter ) {
            $filterSelection = Html::rawElement(
                'div',
                [],
                implode( "\u{00A0}", $tagFilter )
            );
        } else {
            $filterSelection = Html::rawElement( 'div', [], '' );
        }

        $labelNewbies = Xml::radioLabel(
            $this->msg( 'sp-contributions-newbies' )->text(),
            'contribs',
            'newbie',
            'newbie',
            $this->opts['contribs'] == 'newbie',
            [ 'class' => 'mw-input' ]
        );
        $labelUsername = Xml::radioLabel(
            $this->msg( 'sp-contributions-username' )->text(),
            'contribs',
            'user',
            'user',
            $this->opts['contribs'] == 'user',
            [ 'class' => 'mw-input' ]
        );
        $input = Html::input(
            'target',
            $this->opts['target'],
            'text',
            [
                'size' => '40',
                'class' => [
                    'mw-input',
                    'mw-ui-input-inline',
                    'mw-autocomplete-user', // used by mediawiki.userSuggest
                ],
            ] + (
                // Only autofocus if target hasn't been specified or in non-newbies mode
                ( $this->opts['contribs'] === 'newbie' || $this->opts['target'] )
                    ? [] : [ 'autofocus' => true ]
                )
        );

        $targetSelection = Html::rawElement(
            'div',
            [],
            $labelNewbies . '<br>' . $labelUsername . ' ' . $input . ' '
        );

        $namespaceSelection = Xml::tags(
            'div',
            [],
            Xml::label(
                $this->msg( 'namespace' )->text(),
                'namespace',
                ''
            ) . "\u{00A0}" .
            Html::namespaceSelector(
                [ 'selected' => $this->opts['namespace'], 'all' => '' ],
                [
                    'name' => 'namespace',
                    'id' => 'namespace',
                    'class' => 'namespaceselector',
                ]
            ) . "\u{00A0}" .
                Html::rawElement(
                    'span',
                    [ 'class' => 'mw-input-with-label' ],
                    Xml::checkLabel(
                        $this->msg( 'invert' )->text(),
                        'nsInvert',
                        'nsInvert',
                        $this->opts['nsInvert'],
                        [
                            'title' => $this->msg( 'tooltip-invert' )->text(),
                            'class' => 'mw-input'
                        ]
                    ) . "\u{00A0}"
                ) .
                Html::rawElement( 'span', [ 'class' => 'mw-input-with-label' ],
                    Xml::checkLabel(
                        $this->msg( 'namespace_association' )->text(),
                        'associated',
                        'associated',
                        $this->opts['associated'],
                        [
                            'title' => $this->msg( 'tooltip-namespace_association' )->text(),
                            'class' => 'mw-input'
                        ]
                    ) . "\u{00A0}"
                )
        );

        $filters = [];

        if ( $this->getUser()->isAllowed( 'deletedhistory' ) ) {
            $filters[] = Html::rawElement(
                'span',
                [ 'class' => 'mw-input-with-label' ],
                Xml::checkLabel(
                    $this->msg( 'history-show-deleted' )->text(),
                    'deletedOnly',
                    'mw-show-deleted-only',
                    $this->opts['deletedOnly'],
                    [ 'class' => 'mw-input' ]
                )
            );
        }

        $filters[] = Html::rawElement(
            'span',
            [ 'class' => 'mw-input-with-label' ],
            Xml::checkLabel(
                $this->msg( 'sp-contributions-toponly' )->text(),
                'topOnly',
                'mw-show-top-only',
                $this->opts['topOnly'],
                [ 'class' => 'mw-input' ]
            )
        );
        $filters[] = Html::rawElement(
            'span',
            [ 'class' => 'mw-input-with-label' ],
            Xml::checkLabel(
                $this->msg( 'sp-contributions-newonly' )->text(),
                'newOnly',
                'mw-show-new-only',
                $this->opts['newOnly'],
                [ 'class' => 'mw-input' ]
            )
        );
        $filters[] = Html::rawElement(
            'span',
            [ 'class' => 'mw-input-with-label' ],
            Xml::checkLabel(
                $this->msg( 'sp-contributions-hideminor' )->text(),
                'hideMinor',
                'mw-hide-minor-edits',
                $this->opts['hideMinor'],
                [ 'class' => 'mw-input' ]
            )
        );

        Hooks::run(
            'SpecialContributions::getForm::filters',
            [ $this, &$filters ]
        );

        $extraOptions = Html::rawElement(
            'div',
            [],
            implode( '', $filters )
        );

        $dateRangeSelection = Html::rawElement(
            'div',
            [],
            Xml::label( $this->msg( 'date-range-from' )->text(), 'mw-date-start' ) . ' ' .
            new DateInputWidget( [
                'infusable' => true,
                'id' => 'mw-date-start',
                'name' => 'start',
                'value' => $this->opts['start'],
                'longDisplayFormat' => true,
            ] ) . '<br>' .
            Xml::label( $this->msg( 'date-range-to' )->text(), 'mw-date-end' ) . ' ' .
            new DateInputWidget( [
                'infusable' => true,
                'id' => 'mw-date-end',
                'name' => 'end',
                'value' => $this->opts['end'],
                'longDisplayFormat' => true,
            ] )
        );

        $submit = Xml::tags( 'div', [],
            Html::submitButton(
                $this->msg( 'sp-contributions-submit' )->text(),
                [ 'class' => 'mw-submit' ], [ 'mw-ui-progressive' ]
            )
        );

        $form .= Xml::fieldset(
            $this->msg( 'sp-contributions-search' )->text(),
            $targetSelection .
            $namespaceSelection .
            $filterSelection .
            $extraOptions .
            $dateRangeSelection .
            $submit,
            [ 'class' => 'mw-contributions-table' ]
        );

        $explain = $this->msg( 'sp-contributions-explain' );
        if ( !$explain->isBlank() ) {
            $form .= "<p id='mw-sp-contributions-explain'>{$explain->parse()}</p>";
        }

        $form .= Xml::closeElement( 'form' );

        return $form;
    }

    public function prefixSearchSubpages( $search, $limit, $offset ) {
        $user = User::newFromName( $search );
        if ( !$user ) {
            // No prefix suggestion for invalid user
            return [];
        }
        // Autocomplete subpage as user list - public to allow caching
        return UserNamePrefixSearch::search( 'public', $search, $limit, $offset );
    }

    protected function getGroupName() {
        return 'users';
    }
}