3 * Implements Special:Contributions
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
21 * @ingroup SpecialPage
24 use MediaWiki\MediaWikiServices
;
25 use MediaWiki\Widget\DateInputWidget
;
28 * Special:Contributions, show user contributions in a paged list
30 * @ingroup SpecialPage
32 class SpecialContributions
extends IncludableSpecialPage
{
35 public function __construct() {
36 parent
::__construct( 'Contributions' );
39 public function execute( $par ) {
41 $this->outputHeader();
42 $out = $this->getOutput();
43 // Modules required for viewing the list of contributions (also when included on other pages)
44 $out->addModuleStyles( [
46 'mediawiki.special.changeslist',
48 $this->addHelpLink( 'Help:User contributions' );
51 $request = $this->getRequest();
53 if ( $par !== null ) {
56 $target = $request->getVal( 'target' );
59 if ( $request->getVal( 'contribs' ) == 'newbie' ||
$par === 'newbies' ) {
61 $this->opts
['contribs'] = 'newbie';
63 $this->opts
['contribs'] = 'user';
66 $this->opts
['deletedOnly'] = $request->getBool( 'deletedOnly' );
68 if ( !strlen( $target ) ) {
69 if ( !$this->including() ) {
70 $out->addHTML( $this->getForm() );
76 $user = $this->getUser();
78 $this->opts
['limit'] = $request->getInt( 'limit', $user->getOption( 'rclimit' ) );
79 $this->opts
['target'] = $target;
80 $this->opts
['topOnly'] = $request->getBool( 'topOnly' );
81 $this->opts
['newOnly'] = $request->getBool( 'newOnly' );
82 $this->opts
['hideMinor'] = $request->getBool( 'hideMinor' );
85 if ( $this->opts
['contribs'] === 'newbie' ) {
86 $userObj = User
::newFromName( $target ); // hysterical raisins
87 $out->addSubtitle( $this->msg( 'sp-contributions-newbies-sub' ) );
88 $out->setHTMLTitle( $this->msg(
90 $this->msg( 'sp-contributions-newbies-title' )->plain()
91 )->inContentLanguage() );
92 } elseif ( ExternalUserNames
::isExternal( $target ) ) {
93 $userObj = User
::newFromName( $target, false );
95 $out->addHTML( $this->getForm() );
99 $out->addSubtitle( $this->contributionsSub( $userObj ) );
100 $out->setHTMLTitle( $this->msg(
102 $this->msg( 'contributions-title', $target )->plain()
103 )->inContentLanguage() );
105 $nt = Title
::makeTitleSafe( NS_USER
, $target );
107 $out->addHTML( $this->getForm() );
110 $userObj = User
::newFromName( $nt->getText(), false );
112 $out->addHTML( $this->getForm() );
115 $id = $userObj->getId();
117 $target = $nt->getText();
118 $out->addSubtitle( $this->contributionsSub( $userObj ) );
119 $out->setHTMLTitle( $this->msg(
121 $this->msg( 'contributions-title', $target )->plain()
122 )->inContentLanguage() );
124 # For IP ranges, we want the contributionsSub, but not the skin-dependent
125 # links under 'Tools', which may include irrelevant links like 'Logs'.
126 if ( !IP
::isValidRange( $target ) ) {
127 $this->getSkin()->setRelevantUser( $userObj );
131 $ns = $request->getVal( 'namespace', null );
132 if ( $ns !== null && $ns !== '' ) {
133 $this->opts
['namespace'] = intval( $ns );
135 $this->opts
['namespace'] = '';
138 $this->opts
['associated'] = $request->getBool( 'associated' );
139 $this->opts
['nsInvert'] = (bool)$request->getVal( 'nsInvert' );
140 $this->opts
['tagfilter'] = (string)$request->getVal( 'tagfilter' );
142 // Allows reverts to have the bot flag in recent changes. It is just here to
143 // be passed in the form at the top of the page
144 if ( $user->isAllowed( 'markbotedits' ) && $request->getBool( 'bot' ) ) {
145 $this->opts
['bot'] = '1';
148 $skip = $request->getText( 'offset' ) ||
$request->getText( 'dir' ) == 'prev';
149 # Offset overrides year/month selection
151 $this->opts
['year'] = $request->getVal( 'year' );
152 $this->opts
['month'] = $request->getVal( 'month' );
154 $this->opts
['start'] = $request->getVal( 'start' );
155 $this->opts
['end'] = $request->getVal( 'end' );
157 $this->opts
= ContribsPager
::processDateFilter( $this->opts
);
159 $feedType = $request->getVal( 'feed' );
162 'action' => 'feedcontributions',
165 if ( $this->opts
['topOnly'] ) {
166 $feedParams['toponly'] = true;
168 if ( $this->opts
['newOnly'] ) {
169 $feedParams['newonly'] = true;
171 if ( $this->opts
['hideMinor'] ) {
172 $feedParams['hideminor'] = true;
174 if ( $this->opts
['deletedOnly'] ) {
175 $feedParams['deletedonly'] = true;
177 if ( $this->opts
['tagfilter'] !== '' ) {
178 $feedParams['tagfilter'] = $this->opts
['tagfilter'];
180 if ( $this->opts
['namespace'] !== '' ) {
181 $feedParams['namespace'] = $this->opts
['namespace'];
183 // Don't use year and month for the feed URL, but pass them on if
184 // we redirect to API (if $feedType is specified)
185 if ( $feedType && $this->opts
['year'] !== null ) {
186 $feedParams['year'] = $this->opts
['year'];
188 if ( $feedType && $this->opts
['month'] !== null ) {
189 $feedParams['month'] = $this->opts
['month'];
193 // Maintain some level of backwards compatibility
194 // If people request feeds using the old parameters, redirect to API
195 $feedParams['feedformat'] = $feedType;
196 $url = wfAppendQuery( wfScript( 'api' ), $feedParams );
198 $out->redirect( $url, '301' );
203 // Add RSS/atom links
204 $this->addFeedLinks( $feedParams );
206 if ( Hooks
::run( 'SpecialContributionsBeforeMainOutput', [ $id, $userObj, $this ] ) ) {
207 if ( !$this->including() ) {
208 $out->addHTML( $this->getForm() );
210 $pager = new ContribsPager( $this->getContext(), [
212 'contribs' => $this->opts
['contribs'],
213 'namespace' => $this->opts
['namespace'],
214 'tagfilter' => $this->opts
['tagfilter'],
215 'start' => $this->opts
['start'],
216 'end' => $this->opts
['end'],
217 'deletedOnly' => $this->opts
['deletedOnly'],
218 'topOnly' => $this->opts
['topOnly'],
219 'newOnly' => $this->opts
['newOnly'],
220 'hideMinor' => $this->opts
['hideMinor'],
221 'nsInvert' => $this->opts
['nsInvert'],
222 'associated' => $this->opts
['associated'],
225 if ( IP
::isValidRange( $target ) && !$pager->isQueryableRange( $target ) ) {
226 // Valid range, but outside CIDR limit.
227 $limits = $this->getConfig()->get( 'RangeContributionsCIDRLimit' );
228 $limit = $limits[ IP
::isIPv4( $target ) ?
'IPv4' : 'IPv6' ];
229 $out->addWikiMsg( 'sp-contributions-outofrange', $limit );
230 } elseif ( !$pager->getNumRows() ) {
231 $out->addWikiMsg( 'nocontribs', $target );
233 # Show a message about replica DB lag, if applicable
234 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
235 $lag = $lb->safeGetLag( $pager->getDatabase() );
237 $out->showLagWarning( $lag );
240 $output = $pager->getBody();
241 if ( !$this->including() ) {
242 $output = '<p>' . $pager->getNavigationBar() . '</p>' .
244 '<p>' . $pager->getNavigationBar() . '</p>';
246 $out->addHTML( $output );
249 $out->preventClickjacking( $pager->getPreventClickjacking() );
251 # Show the appropriate "footer" message - WHOIS tools, etc.
252 if ( $this->opts
['contribs'] == 'newbie' ) {
253 $message = 'sp-contributions-footer-newbies';
254 } elseif ( IP
::isValidRange( $target ) ) {
255 $message = 'sp-contributions-footer-anon-range';
256 } elseif ( IP
::isIPAddress( $target ) ) {
257 $message = 'sp-contributions-footer-anon';
258 } elseif ( $userObj->isAnon() ) {
259 // No message for non-existing users
262 $message = 'sp-contributions-footer';
266 if ( !$this->including() ) {
267 if ( !$this->msg( $message, $target )->isDisabled() ) {
269 "<div class='mw-contributions-footer'>\n$1\n</div>",
270 [ $message, $target ] );
278 * Generates the subheading with links
279 * @param User $userObj User object for the target
280 * @return string Appropriately-escaped HTML to be output literally
281 * @todo FIXME: Almost the same as getSubTitle in SpecialDeletedContributions.php.
284 protected function contributionsSub( $userObj ) {
285 if ( $userObj->isAnon() ) {
286 // Show a warning message that the user being searched for doesn't exists.
287 // User::isIP returns true for IP address and usemod IPs like '123.123.123.xxx',
288 // but returns false for IP ranges. We don't want to suggest either of these are
289 // valid usernames which we would with the 'contributions-userdoesnotexist' message.
290 if ( !User
::isIP( $userObj->getName() ) && !$userObj->isIPRange() ) {
291 $this->getOutput()->wrapWikiMsg(
292 "<div class=\"mw-userpage-userdoesnotexist error\">\n\$1\n</div>",
294 'contributions-userdoesnotexist',
295 wfEscapeWikiText( $userObj->getName() ),
298 if ( !$this->including() ) {
299 $this->getOutput()->setStatusCode( 404 );
302 $user = htmlspecialchars( $userObj->getName() );
304 $user = $this->getLinkRenderer()->makeLink( $userObj->getUserPage(), $userObj->getName() );
306 $nt = $userObj->getUserPage();
307 $talk = $userObj->getTalkPage();
310 $tools = self
::getUserLinks( $this, $userObj );
311 $links = $this->getLanguage()->pipeList( $tools );
313 // Show a note if the user is blocked and display the last block log entry.
314 // Do not expose the autoblocks, since that may lead to a leak of accounts' IPs,
315 // and also this will display a totally irrelevant log entry as a current block.
316 if ( !$this->including() ) {
317 // For IP ranges you must give Block::newFromTarget the CIDR string and not a user object.
318 if ( $userObj->isIPRange() ) {
319 $block = Block
::newFromTarget( $userObj->getName(), $userObj->getName() );
321 $block = Block
::newFromTarget( $userObj, $userObj );
324 if ( !is_null( $block ) && $block->getType() != Block
::TYPE_AUTO
) {
325 if ( $block->getType() == Block
::TYPE_RANGE
) {
326 $nt = MWNamespace
::getCanonicalName( NS_USER
) . ':' . $block->getTarget();
329 $out = $this->getOutput(); // showLogExtract() wants first parameter by reference
330 LogEventsList
::showLogExtract(
337 'showIfEmpty' => false,
340 'sp-contributions-blocked-notice-anon' :
341 'sp-contributions-blocked-notice',
342 $userObj->getName() # Support GENDER in 'sp-contributions-blocked-notice'
344 'offset' => '' # don't use WebRequest parameter offset
351 return $this->msg( 'contribsub2' )->rawParams( $user, $links )->params( $userObj->getName() );
355 * Links to different places.
357 * @note This function is also called in DeletedContributionsPage
358 * @param SpecialPage $sp SpecialPage instance, for context
359 * @param User $target Target user object
362 public static function getUserLinks( SpecialPage
$sp, User
$target ) {
363 $id = $target->getId();
364 $username = $target->getName();
365 $userpage = $target->getUserPage();
366 $talkpage = $target->getTalkPage();
368 $linkRenderer = $sp->getLinkRenderer();
370 # No talk pages for IP ranges.
371 if ( !IP
::isValidRange( $username ) ) {
372 $tools['user-talk'] = $linkRenderer->makeLink(
374 $sp->msg( 'sp-contributions-talk' )->text()
378 if ( ( $id !== null ) ||
( $id === null && IP
::isIPAddress( $username ) ) ) {
379 if ( $sp->getUser()->isAllowed( 'block' ) ) { # Block / Change block / Unblock links
380 if ( $target->isBlocked() && $target->getBlock()->getType() != Block
::TYPE_AUTO
) {
381 $tools['block'] = $linkRenderer->makeKnownLink( # Change block link
382 SpecialPage
::getTitleFor( 'Block', $username ),
383 $sp->msg( 'change-blocklink' )->text()
385 $tools['unblock'] = $linkRenderer->makeKnownLink( # Unblock link
386 SpecialPage
::getTitleFor( 'Unblock', $username ),
387 $sp->msg( 'unblocklink' )->text()
389 } else { # User is not blocked
390 $tools['block'] = $linkRenderer->makeKnownLink( # Block link
391 SpecialPage
::getTitleFor( 'Block', $username ),
392 $sp->msg( 'blocklink' )->text()
398 $tools['log-block'] = $linkRenderer->makeKnownLink(
399 SpecialPage
::getTitleFor( 'Log', 'block' ),
400 $sp->msg( 'sp-contributions-blocklog' )->text(),
402 [ 'page' => $userpage->getPrefixedText() ]
405 # Suppression log link (T61120)
406 if ( $sp->getUser()->isAllowed( 'suppressionlog' ) ) {
407 $tools['log-suppression'] = $linkRenderer->makeKnownLink(
408 SpecialPage
::getTitleFor( 'Log', 'suppress' ),
409 $sp->msg( 'sp-contributions-suppresslog', $username )->text(),
411 [ 'offender' => $username ]
416 # Don't show some links for IP ranges
417 if ( !IP
::isValidRange( $username ) ) {
419 $tools['uploads'] = $linkRenderer->makeKnownLink(
420 SpecialPage
::getTitleFor( 'Listfiles', $username ),
421 $sp->msg( 'sp-contributions-uploads' )->text()
425 $tools['logs'] = $linkRenderer->makeKnownLink(
426 SpecialPage
::getTitleFor( 'Log', $username ),
427 $sp->msg( 'sp-contributions-logs' )->text()
430 # Add link to deleted user contributions for priviledged users
431 if ( $sp->getUser()->isAllowed( 'deletedhistory' ) ) {
432 $tools['deletedcontribs'] = $linkRenderer->makeKnownLink(
433 SpecialPage
::getTitleFor( 'DeletedContributions', $username ),
434 $sp->msg( 'sp-contributions-deleted', $username )->text()
439 # Add a link to change user rights for privileged users
440 $userrightsPage = new UserrightsPage();
441 $userrightsPage->setContext( $sp->getContext() );
442 if ( $userrightsPage->userCanChangeRights( $target ) ) {
443 $tools['userrights'] = $linkRenderer->makeKnownLink(
444 SpecialPage
::getTitleFor( 'Userrights', $username ),
445 $sp->msg( 'sp-contributions-userrights', $username )->text()
449 Hooks
::run( 'ContributionsToolLinks', [ $id, $userpage, &$tools, $sp ] );
455 * Generates the namespace selector form with hidden attributes.
456 * @return string HTML fragment
458 protected function getForm() {
459 $this->opts
['title'] = $this->getPageTitle()->getPrefixedText();
460 if ( !isset( $this->opts
['target'] ) ) {
461 $this->opts
['target'] = '';
463 $this->opts
['target'] = str_replace( '_', ' ', $this->opts
['target'] );
466 if ( !isset( $this->opts
['namespace'] ) ) {
467 $this->opts
['namespace'] = '';
470 if ( !isset( $this->opts
['nsInvert'] ) ) {
471 $this->opts
['nsInvert'] = '';
474 if ( !isset( $this->opts
['associated'] ) ) {
475 $this->opts
['associated'] = false;
478 if ( !isset( $this->opts
['contribs'] ) ) {
479 $this->opts
['contribs'] = 'user';
482 if ( !isset( $this->opts
['start'] ) ) {
483 $this->opts
['start'] = '';
486 if ( !isset( $this->opts
['end'] ) ) {
487 $this->opts
['end'] = '';
490 if ( $this->opts
['contribs'] == 'newbie' ) {
491 $this->opts
['target'] = '';
494 if ( !isset( $this->opts
['tagfilter'] ) ) {
495 $this->opts
['tagfilter'] = '';
498 if ( !isset( $this->opts
['topOnly'] ) ) {
499 $this->opts
['topOnly'] = false;
502 if ( !isset( $this->opts
['newOnly'] ) ) {
503 $this->opts
['newOnly'] = false;
506 if ( !isset( $this->opts
['hideMinor'] ) ) {
507 $this->opts
['hideMinor'] = false;
510 // Modules required only for the form
511 $this->getOutput()->addModules( [
512 'mediawiki.userSuggest',
513 'mediawiki.special.contributions',
515 $this->getOutput()->addModuleStyles( 'mediawiki.widgets.DateInputWidget.styles' );
516 $this->getOutput()->enableOOUI();
518 $form = Html
::openElement(
522 'action' => wfScript(),
523 'class' => 'mw-contributions-form'
527 # Add hidden params for tracking except for parameters in $skipParameters
545 foreach ( $this->opts
as $name => $value ) {
546 if ( in_array( $name, $skipParameters ) ) {
549 $form .= "\t" . Html
::hidden( $name, $value ) . "\n";
552 $tagFilter = ChangeTags
::buildTagFilterSelector(
553 $this->opts
['tagfilter'], false, $this->getContext() );
556 $filterSelection = Html
::rawElement(
559 implode( "\u{00A0}", $tagFilter )
562 $filterSelection = Html
::rawElement( 'div', [], '' );
565 $labelNewbies = Xml
::radioLabel(
566 $this->msg( 'sp-contributions-newbies' )->text(),
570 $this->opts
['contribs'] == 'newbie',
571 [ 'class' => 'mw-input' ]
573 $labelUsername = Xml
::radioLabel(
574 $this->msg( 'sp-contributions-username' )->text(),
578 $this->opts
['contribs'] == 'user',
579 [ 'class' => 'mw-input' ]
581 $input = Html
::input(
583 $this->opts
['target'],
589 'mw-ui-input-inline',
590 'mw-autocomplete-user', // used by mediawiki.userSuggest
593 // Only autofocus if target hasn't been specified or in non-newbies mode
594 ( $this->opts
['contribs'] === 'newbie' ||
$this->opts
['target'] )
595 ?
[] : [ 'autofocus' => true ]
599 $targetSelection = Html
::rawElement(
602 $labelNewbies . '<br>' . $labelUsername . ' ' . $input . ' '
605 $namespaceSelection = Xml
::tags(
609 $this->msg( 'namespace' )->text(),
613 Html
::namespaceSelector(
614 [ 'selected' => $this->opts
['namespace'], 'all' => '' ],
616 'name' => 'namespace',
618 'class' => 'namespaceselector',
623 [ 'class' => 'mw-input-with-label' ],
625 $this->msg( 'invert' )->text(),
628 $this->opts
['nsInvert'],
630 'title' => $this->msg( 'tooltip-invert' )->text(),
631 'class' => 'mw-input'
635 Html
::rawElement( 'span', [ 'class' => 'mw-input-with-label' ],
637 $this->msg( 'namespace_association' )->text(),
640 $this->opts
['associated'],
642 'title' => $this->msg( 'tooltip-namespace_association' )->text(),
643 'class' => 'mw-input'
651 if ( $this->getUser()->isAllowed( 'deletedhistory' ) ) {
652 $filters[] = Html
::rawElement(
654 [ 'class' => 'mw-input-with-label' ],
656 $this->msg( 'history-show-deleted' )->text(),
658 'mw-show-deleted-only',
659 $this->opts
['deletedOnly'],
660 [ 'class' => 'mw-input' ]
665 $filters[] = Html
::rawElement(
667 [ 'class' => 'mw-input-with-label' ],
669 $this->msg( 'sp-contributions-toponly' )->text(),
672 $this->opts
['topOnly'],
673 [ 'class' => 'mw-input' ]
676 $filters[] = Html
::rawElement(
678 [ 'class' => 'mw-input-with-label' ],
680 $this->msg( 'sp-contributions-newonly' )->text(),
683 $this->opts
['newOnly'],
684 [ 'class' => 'mw-input' ]
687 $filters[] = Html
::rawElement(
689 [ 'class' => 'mw-input-with-label' ],
691 $this->msg( 'sp-contributions-hideminor' )->text(),
693 'mw-hide-minor-edits',
694 $this->opts
['hideMinor'],
695 [ 'class' => 'mw-input' ]
700 'SpecialContributions::getForm::filters',
704 $extraOptions = Html
::rawElement(
707 implode( '', $filters )
710 $dateRangeSelection = Html
::rawElement(
713 Xml
::label( wfMessage( 'date-range-from' )->text(), 'mw-date-start' ) . ' ' .
714 new DateInputWidget( [
716 'id' => 'mw-date-start',
718 'value' => $this->opts
['start'],
719 'longDisplayFormat' => true,
721 Xml
::label( wfMessage( 'date-range-to' )->text(), 'mw-date-end' ) . ' ' .
722 new DateInputWidget( [
724 'id' => 'mw-date-end',
726 'value' => $this->opts
['end'],
727 'longDisplayFormat' => true,
731 $submit = Xml
::tags( 'div', [],
733 $this->msg( 'sp-contributions-submit' )->text(),
734 [ 'class' => 'mw-submit' ], [ 'mw-ui-progressive' ]
738 $form .= Xml
::fieldset(
739 $this->msg( 'sp-contributions-search' )->text(),
741 $namespaceSelection .
744 $dateRangeSelection .
746 [ 'class' => 'mw-contributions-table' ]
749 $explain = $this->msg( 'sp-contributions-explain' );
750 if ( !$explain->isBlank() ) {
751 $form .= "<p id='mw-sp-contributions-explain'>{$explain->parse()}</p>";
754 $form .= Xml
::closeElement( 'form' );
760 * Return an array of subpages beginning with $search that this special page will accept.
762 * @param string $search Prefix to search for
763 * @param int $limit Maximum number of results to return (usually 10)
764 * @param int $offset Number of results to skip (usually 0)
765 * @return string[] Matching subpages
767 public function prefixSearchSubpages( $search, $limit, $offset ) {
768 $user = User
::newFromName( $search );
770 // No prefix suggestion for invalid user
773 // Autocomplete subpage as user list - public to allow caching
774 return UserNamePrefixSearch
::search( 'public', $search, $limit, $offset );
777 protected function getGroupName() {