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( [
45 'mediawiki.interface.helpers.styles',
47 'mediawiki.special.changeslist',
49 $this->addHelpLink( 'Help:User contributions' );
52 $request = $this->getRequest();
54 $target = $par ??
$request->getVal( 'target' );
56 if ( $request->getVal( 'contribs' ) == 'newbie' ||
$par === 'newbies' ) {
58 $this->opts
['contribs'] = 'newbie';
60 $this->opts
['contribs'] = 'user';
63 $this->opts
['deletedOnly'] = $request->getBool( 'deletedOnly' );
65 if ( !strlen( $target ) ) {
66 if ( !$this->including() ) {
67 $out->addHTML( $this->getForm() );
73 $user = $this->getUser();
75 $this->opts
['limit'] = $request->getInt( 'limit', $user->getOption( 'rclimit' ) );
76 $this->opts
['target'] = $target;
77 $this->opts
['topOnly'] = $request->getBool( 'topOnly' );
78 $this->opts
['newOnly'] = $request->getBool( 'newOnly' );
79 $this->opts
['hideMinor'] = $request->getBool( 'hideMinor' );
82 if ( $this->opts
['contribs'] === 'newbie' ) {
83 $userObj = User
::newFromName( $target ); // hysterical raisins
84 $out->addSubtitle( $this->msg( 'sp-contributions-newbies-sub' ) );
85 $out->setHTMLTitle( $this->msg(
87 $this->msg( 'sp-contributions-newbies-title' )->plain()
88 )->inContentLanguage() );
89 } elseif ( ExternalUserNames
::isExternal( $target ) ) {
90 $userObj = User
::newFromName( $target, false );
92 $out->addHTML( $this->getForm() );
96 $out->addSubtitle( $this->contributionsSub( $userObj ) );
97 $out->setHTMLTitle( $this->msg(
99 $this->msg( 'contributions-title', $target )->plain()
100 )->inContentLanguage() );
102 $nt = Title
::makeTitleSafe( NS_USER
, $target );
104 $out->addHTML( $this->getForm() );
107 $userObj = User
::newFromName( $nt->getText(), false );
109 $out->addHTML( $this->getForm() );
112 $id = $userObj->getId();
114 $target = $nt->getText();
115 $out->addSubtitle( $this->contributionsSub( $userObj ) );
116 $out->setHTMLTitle( $this->msg(
118 $this->msg( 'contributions-title', $target )->plain()
119 )->inContentLanguage() );
121 # For IP ranges, we want the contributionsSub, but not the skin-dependent
122 # links under 'Tools', which may include irrelevant links like 'Logs'.
123 if ( !IP
::isValidRange( $target ) ) {
124 $this->getSkin()->setRelevantUser( $userObj );
128 $ns = $request->getVal( 'namespace', null );
129 if ( $ns !== null && $ns !== '' ) {
130 $this->opts
['namespace'] = intval( $ns );
132 $this->opts
['namespace'] = '';
135 $this->opts
['associated'] = $request->getBool( 'associated' );
136 $this->opts
['nsInvert'] = (bool)$request->getVal( 'nsInvert' );
137 $this->opts
['tagfilter'] = (string)$request->getVal( 'tagfilter' );
139 // Allows reverts to have the bot flag in recent changes. It is just here to
140 // be passed in the form at the top of the page
141 if ( $user->isAllowed( 'markbotedits' ) && $request->getBool( 'bot' ) ) {
142 $this->opts
['bot'] = '1';
145 $skip = $request->getText( 'offset' ) ||
$request->getText( 'dir' ) == 'prev';
146 # Offset overrides year/month selection
148 $this->opts
['year'] = $request->getVal( 'year' );
149 $this->opts
['month'] = $request->getVal( 'month' );
151 $this->opts
['start'] = $request->getVal( 'start' );
152 $this->opts
['end'] = $request->getVal( 'end' );
154 $this->opts
= ContribsPager
::processDateFilter( $this->opts
);
156 if ( $this->opts
['namespace'] < NS_MAIN
) {
157 $this->getOutput()->wrapWikiMsg(
158 "<div class=\"mw-negative-namespace-not-supported error\">\n\$1\n</div>",
159 [ 'negative-namespace-not-supported' ]
161 $out->addHTML( $this->getForm() );
165 $feedType = $request->getVal( 'feed' );
168 'action' => 'feedcontributions',
171 if ( $this->opts
['topOnly'] ) {
172 $feedParams['toponly'] = true;
174 if ( $this->opts
['newOnly'] ) {
175 $feedParams['newonly'] = true;
177 if ( $this->opts
['hideMinor'] ) {
178 $feedParams['hideminor'] = true;
180 if ( $this->opts
['deletedOnly'] ) {
181 $feedParams['deletedonly'] = true;
183 if ( $this->opts
['tagfilter'] !== '' ) {
184 $feedParams['tagfilter'] = $this->opts
['tagfilter'];
186 if ( $this->opts
['namespace'] !== '' ) {
187 $feedParams['namespace'] = $this->opts
['namespace'];
189 // Don't use year and month for the feed URL, but pass them on if
190 // we redirect to API (if $feedType is specified)
191 if ( $feedType && $this->opts
['year'] !== null ) {
192 $feedParams['year'] = $this->opts
['year'];
194 if ( $feedType && $this->opts
['month'] !== null ) {
195 $feedParams['month'] = $this->opts
['month'];
199 // Maintain some level of backwards compatibility
200 // If people request feeds using the old parameters, redirect to API
201 $feedParams['feedformat'] = $feedType;
202 $url = wfAppendQuery( wfScript( 'api' ), $feedParams );
204 $out->redirect( $url, '301' );
209 // Add RSS/atom links
210 $this->addFeedLinks( $feedParams );
212 if ( Hooks
::run( 'SpecialContributionsBeforeMainOutput', [ $id, $userObj, $this ] ) ) {
213 if ( !$this->including() ) {
214 $out->addHTML( $this->getForm() );
216 $pager = new ContribsPager( $this->getContext(), [
218 'contribs' => $this->opts
['contribs'],
219 'namespace' => $this->opts
['namespace'],
220 'tagfilter' => $this->opts
['tagfilter'],
221 'start' => $this->opts
['start'],
222 'end' => $this->opts
['end'],
223 'deletedOnly' => $this->opts
['deletedOnly'],
224 'topOnly' => $this->opts
['topOnly'],
225 'newOnly' => $this->opts
['newOnly'],
226 'hideMinor' => $this->opts
['hideMinor'],
227 'nsInvert' => $this->opts
['nsInvert'],
228 'associated' => $this->opts
['associated'],
231 if ( IP
::isValidRange( $target ) && !$pager->isQueryableRange( $target ) ) {
232 // Valid range, but outside CIDR limit.
233 $limits = $this->getConfig()->get( 'RangeContributionsCIDRLimit' );
234 $limit = $limits[ IP
::isIPv4( $target ) ?
'IPv4' : 'IPv6' ];
235 $out->addWikiMsg( 'sp-contributions-outofrange', $limit );
236 } elseif ( !$pager->getNumRows() ) {
237 $out->addWikiMsg( 'nocontribs', $target );
239 # Show a message about replica DB lag, if applicable
240 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
241 $lag = $lb->safeGetLag( $pager->getDatabase() );
243 $out->showLagWarning( $lag );
246 $output = $pager->getBody();
247 if ( !$this->including() ) {
248 $output = '<p>' . $pager->getNavigationBar() . '</p>' .
250 '<p>' . $pager->getNavigationBar() . '</p>';
252 $out->addHTML( $output );
255 $out->preventClickjacking( $pager->getPreventClickjacking() );
257 # Show the appropriate "footer" message - WHOIS tools, etc.
258 if ( $this->opts
['contribs'] == 'newbie' ) {
259 $message = 'sp-contributions-footer-newbies';
260 } elseif ( IP
::isValidRange( $target ) ) {
261 $message = 'sp-contributions-footer-anon-range';
262 } elseif ( IP
::isIPAddress( $target ) ) {
263 $message = 'sp-contributions-footer-anon';
264 } elseif ( $userObj->isAnon() ) {
265 // No message for non-existing users
268 $message = 'sp-contributions-footer';
272 if ( !$this->including() ) {
273 if ( !$this->msg( $message, $target )->isDisabled() ) {
275 "<div class='mw-contributions-footer'>\n$1\n</div>",
276 [ $message, $target ] );
284 * Generates the subheading with links
285 * @param User $userObj User object for the target
286 * @return string Appropriately-escaped HTML to be output literally
287 * @todo FIXME: Almost the same as getSubTitle in SpecialDeletedContributions.php.
290 protected function contributionsSub( $userObj ) {
291 if ( $userObj->isAnon() ) {
292 // Show a warning message that the user being searched for doesn't exists.
293 // User::isIP returns true for IP address and usemod IPs like '123.123.123.xxx',
294 // but returns false for IP ranges. We don't want to suggest either of these are
295 // valid usernames which we would with the 'contributions-userdoesnotexist' message.
296 if ( !User
::isIP( $userObj->getName() ) && !$userObj->isIPRange() ) {
297 $this->getOutput()->wrapWikiMsg(
298 "<div class=\"mw-userpage-userdoesnotexist error\">\n\$1\n</div>",
300 'contributions-userdoesnotexist',
301 wfEscapeWikiText( $userObj->getName() ),
304 if ( !$this->including() ) {
305 $this->getOutput()->setStatusCode( 404 );
308 $user = htmlspecialchars( $userObj->getName() );
310 $user = $this->getLinkRenderer()->makeLink( $userObj->getUserPage(), $userObj->getName() );
312 $nt = $userObj->getUserPage();
313 $talk = $userObj->getTalkPage();
316 $tools = self
::getUserLinks( $this, $userObj );
317 $links = $this->getLanguage()->pipeList( $tools );
319 // Show a note if the user is blocked and display the last block log entry.
320 // Do not expose the autoblocks, since that may lead to a leak of accounts' IPs,
321 // and also this will display a totally irrelevant log entry as a current block.
322 if ( !$this->including() ) {
323 // For IP ranges you must give Block::newFromTarget the CIDR string and not a user object.
324 if ( $userObj->isIPRange() ) {
325 $block = Block
::newFromTarget( $userObj->getName(), $userObj->getName() );
327 $block = Block
::newFromTarget( $userObj, $userObj );
330 if ( !is_null( $block ) && $block->getType() != Block
::TYPE_AUTO
) {
331 if ( $block->getType() == Block
::TYPE_RANGE
) {
332 $nt = MWNamespace
::getCanonicalName( NS_USER
) . ':' . $block->getTarget();
335 $out = $this->getOutput(); // showLogExtract() wants first parameter by reference
336 LogEventsList
::showLogExtract(
343 'showIfEmpty' => false,
346 'sp-contributions-blocked-notice-anon' :
347 'sp-contributions-blocked-notice',
348 $userObj->getName() # Support GENDER in 'sp-contributions-blocked-notice'
350 'offset' => '' # don't use WebRequest parameter offset
357 return $this->msg( 'contribsub2' )->rawParams( $user, $links )->params( $userObj->getName() );
361 * Links to different places.
363 * @note This function is also called in DeletedContributionsPage
364 * @param SpecialPage $sp SpecialPage instance, for context
365 * @param User $target Target user object
368 public static function getUserLinks( SpecialPage
$sp, User
$target ) {
369 $id = $target->getId();
370 $username = $target->getName();
371 $userpage = $target->getUserPage();
372 $talkpage = $target->getTalkPage();
374 $linkRenderer = $sp->getLinkRenderer();
376 # No talk pages for IP ranges.
377 if ( !IP
::isValidRange( $username ) ) {
378 $tools['user-talk'] = $linkRenderer->makeLink(
380 $sp->msg( 'sp-contributions-talk' )->text()
384 if ( ( $id !== null ) ||
( $id === null && IP
::isIPAddress( $username ) ) ) {
385 if ( $sp->getUser()->isAllowed( 'block' ) ) { # Block / Change block / Unblock links
386 if ( $target->isBlocked() && $target->getBlock()->getType() != Block
::TYPE_AUTO
) {
387 $tools['block'] = $linkRenderer->makeKnownLink( # Change block link
388 SpecialPage
::getTitleFor( 'Block', $username ),
389 $sp->msg( 'change-blocklink' )->text()
391 $tools['unblock'] = $linkRenderer->makeKnownLink( # Unblock link
392 SpecialPage
::getTitleFor( 'Unblock', $username ),
393 $sp->msg( 'unblocklink' )->text()
395 } else { # User is not blocked
396 $tools['block'] = $linkRenderer->makeKnownLink( # Block link
397 SpecialPage
::getTitleFor( 'Block', $username ),
398 $sp->msg( 'blocklink' )->text()
404 $tools['log-block'] = $linkRenderer->makeKnownLink(
405 SpecialPage
::getTitleFor( 'Log', 'block' ),
406 $sp->msg( 'sp-contributions-blocklog' )->text(),
408 [ 'page' => $userpage->getPrefixedText() ]
411 # Suppression log link (T61120)
412 if ( $sp->getUser()->isAllowed( 'suppressionlog' ) ) {
413 $tools['log-suppression'] = $linkRenderer->makeKnownLink(
414 SpecialPage
::getTitleFor( 'Log', 'suppress' ),
415 $sp->msg( 'sp-contributions-suppresslog', $username )->text(),
417 [ 'offender' => $username ]
422 # Don't show some links for IP ranges
423 if ( !IP
::isValidRange( $username ) ) {
425 $tools['uploads'] = $linkRenderer->makeKnownLink(
426 SpecialPage
::getTitleFor( 'Listfiles', $username ),
427 $sp->msg( 'sp-contributions-uploads' )->text()
431 $tools['logs'] = $linkRenderer->makeKnownLink(
432 SpecialPage
::getTitleFor( 'Log', $username ),
433 $sp->msg( 'sp-contributions-logs' )->text()
436 # Add link to deleted user contributions for priviledged users
437 if ( $sp->getUser()->isAllowed( 'deletedhistory' ) ) {
438 $tools['deletedcontribs'] = $linkRenderer->makeKnownLink(
439 SpecialPage
::getTitleFor( 'DeletedContributions', $username ),
440 $sp->msg( 'sp-contributions-deleted', $username )->text()
445 # Add a link to change user rights for privileged users
446 $userrightsPage = new UserrightsPage();
447 $userrightsPage->setContext( $sp->getContext() );
448 if ( $userrightsPage->userCanChangeRights( $target ) ) {
449 $tools['userrights'] = $linkRenderer->makeKnownLink(
450 SpecialPage
::getTitleFor( 'Userrights', $username ),
451 $sp->msg( 'sp-contributions-userrights', $username )->text()
455 Hooks
::run( 'ContributionsToolLinks', [ $id, $userpage, &$tools, $sp ] );
461 * Generates the namespace selector form with hidden attributes.
462 * @return string HTML fragment
464 protected function getForm() {
465 $this->opts
['title'] = $this->getPageTitle()->getPrefixedText();
466 if ( !isset( $this->opts
['target'] ) ) {
467 $this->opts
['target'] = '';
469 $this->opts
['target'] = str_replace( '_', ' ', $this->opts
['target'] );
472 if ( !isset( $this->opts
['namespace'] ) ) {
473 $this->opts
['namespace'] = '';
476 if ( !isset( $this->opts
['nsInvert'] ) ) {
477 $this->opts
['nsInvert'] = '';
480 if ( !isset( $this->opts
['associated'] ) ) {
481 $this->opts
['associated'] = false;
484 if ( !isset( $this->opts
['contribs'] ) ) {
485 $this->opts
['contribs'] = 'user';
488 if ( !isset( $this->opts
['start'] ) ) {
489 $this->opts
['start'] = '';
492 if ( !isset( $this->opts
['end'] ) ) {
493 $this->opts
['end'] = '';
496 if ( $this->opts
['contribs'] == 'newbie' ) {
497 $this->opts
['target'] = '';
500 if ( !isset( $this->opts
['tagfilter'] ) ) {
501 $this->opts
['tagfilter'] = '';
504 if ( !isset( $this->opts
['topOnly'] ) ) {
505 $this->opts
['topOnly'] = false;
508 if ( !isset( $this->opts
['newOnly'] ) ) {
509 $this->opts
['newOnly'] = false;
512 if ( !isset( $this->opts
['hideMinor'] ) ) {
513 $this->opts
['hideMinor'] = false;
516 // Modules required only for the form
517 $this->getOutput()->addModules( [
518 'mediawiki.userSuggest',
519 'mediawiki.special.contributions',
521 $this->getOutput()->addModuleStyles( 'mediawiki.widgets.DateInputWidget.styles' );
522 $this->getOutput()->enableOOUI();
524 $form = Html
::openElement(
528 'action' => wfScript(),
529 'class' => 'mw-contributions-form'
533 # Add hidden params for tracking except for parameters in $skipParameters
551 foreach ( $this->opts
as $name => $value ) {
552 if ( in_array( $name, $skipParameters ) ) {
555 $form .= "\t" . Html
::hidden( $name, $value ) . "\n";
558 $tagFilter = ChangeTags
::buildTagFilterSelector(
559 $this->opts
['tagfilter'], false, $this->getContext() );
562 $filterSelection = Html
::rawElement(
565 implode( "\u{00A0}", $tagFilter )
568 $filterSelection = Html
::rawElement( 'div', [], '' );
571 $labelNewbies = Xml
::radioLabel(
572 $this->msg( 'sp-contributions-newbies' )->text(),
576 $this->opts
['contribs'] == 'newbie',
577 [ 'class' => 'mw-input' ]
579 $labelUsername = Xml
::radioLabel(
580 $this->msg( 'sp-contributions-username' )->text(),
584 $this->opts
['contribs'] == 'user',
585 [ 'class' => 'mw-input' ]
587 $input = Html
::input(
589 $this->opts
['target'],
595 'mw-ui-input-inline',
596 'mw-autocomplete-user', // used by mediawiki.userSuggest
599 // Only autofocus if target hasn't been specified or in non-newbies mode
600 ( $this->opts
['contribs'] === 'newbie' ||
$this->opts
['target'] )
601 ?
[] : [ 'autofocus' => true ]
605 $targetSelection = Html
::rawElement(
608 $labelNewbies . '<br>' . $labelUsername . ' ' . $input . ' '
611 $namespaceSelection = Xml
::tags(
615 $this->msg( 'namespace' )->text(),
619 Html
::namespaceSelector(
620 [ 'selected' => $this->opts
['namespace'], 'all' => '', 'in-user-lang' => true ],
622 'name' => 'namespace',
624 'class' => 'namespaceselector',
629 [ 'class' => 'mw-input-with-label' ],
631 $this->msg( 'invert' )->text(),
634 $this->opts
['nsInvert'],
636 'title' => $this->msg( 'tooltip-invert' )->text(),
637 'class' => 'mw-input'
641 Html
::rawElement( 'span', [ 'class' => 'mw-input-with-label' ],
643 $this->msg( 'namespace_association' )->text(),
646 $this->opts
['associated'],
648 'title' => $this->msg( 'tooltip-namespace_association' )->text(),
649 'class' => 'mw-input'
657 if ( $this->getUser()->isAllowed( 'deletedhistory' ) ) {
658 $filters[] = Html
::rawElement(
660 [ 'class' => 'mw-input-with-label' ],
662 $this->msg( 'history-show-deleted' )->text(),
664 'mw-show-deleted-only',
665 $this->opts
['deletedOnly'],
666 [ 'class' => 'mw-input' ]
671 $filters[] = Html
::rawElement(
673 [ 'class' => 'mw-input-with-label' ],
675 $this->msg( 'sp-contributions-toponly' )->text(),
678 $this->opts
['topOnly'],
679 [ 'class' => 'mw-input' ]
682 $filters[] = Html
::rawElement(
684 [ 'class' => 'mw-input-with-label' ],
686 $this->msg( 'sp-contributions-newonly' )->text(),
689 $this->opts
['newOnly'],
690 [ 'class' => 'mw-input' ]
693 $filters[] = Html
::rawElement(
695 [ 'class' => 'mw-input-with-label' ],
697 $this->msg( 'sp-contributions-hideminor' )->text(),
699 'mw-hide-minor-edits',
700 $this->opts
['hideMinor'],
701 [ 'class' => 'mw-input' ]
706 'SpecialContributions::getForm::filters',
710 $extraOptions = Html
::rawElement(
713 implode( '', $filters )
716 $dateRangeSelection = Html
::rawElement(
719 Xml
::label( $this->msg( 'date-range-from' )->text(), 'mw-date-start' ) . ' ' .
720 new DateInputWidget( [
722 'id' => 'mw-date-start',
724 'value' => $this->opts
['start'],
725 'longDisplayFormat' => true,
727 Xml
::label( $this->msg( 'date-range-to' )->text(), 'mw-date-end' ) . ' ' .
728 new DateInputWidget( [
730 'id' => 'mw-date-end',
732 'value' => $this->opts
['end'],
733 'longDisplayFormat' => true,
737 $submit = Xml
::tags( 'div', [],
739 $this->msg( 'sp-contributions-submit' )->text(),
740 [ 'class' => 'mw-submit' ], [ 'mw-ui-progressive' ]
744 $form .= Xml
::fieldset(
745 $this->msg( 'sp-contributions-search' )->text(),
747 $namespaceSelection .
750 $dateRangeSelection .
752 [ 'class' => 'mw-contributions-table' ]
755 $explain = $this->msg( 'sp-contributions-explain' );
756 if ( !$explain->isBlank() ) {
757 $form .= Html
::rawElement(
758 'p', [ 'id' => 'mw-sp-contributions-explain' ], $explain->parse()
762 $form .= Xml
::closeElement( 'form' );
768 * Return an array of subpages beginning with $search that this special page will accept.
770 * @param string $search Prefix to search for
771 * @param int $limit Maximum number of results to return (usually 10)
772 * @param int $offset Number of results to skip (usually 0)
773 * @return string[] Matching subpages
775 public function prefixSearchSubpages( $search, $limit, $offset ) {
776 $user = User
::newFromName( $search );
778 // No prefix suggestion for invalid user
781 // Autocomplete subpage as user list - public to allow caching
782 return UserNamePrefixSearch
::search( 'public', $search, $limit, $offset );
785 protected function getGroupName() {