Merge "Add 2 FIXMEs about confusingly named functions"
[lhc/web/wiklou.git] / includes / specials / SpecialContributions.php
1 <?php
2 /**
3 * Implements Special:Contributions
4 *
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.
9 *
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.
14 *
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
19 *
20 * @file
21 * @ingroup SpecialPage
22 */
23
24 /**
25 * Special:Contributions, show user contributions in a paged list
26 *
27 * @ingroup SpecialPage
28 */
29 class SpecialContributions extends IncludableSpecialPage {
30 protected $opts;
31
32 public function __construct() {
33 parent::__construct( 'Contributions' );
34 }
35
36 public function execute( $par ) {
37 $this->setHeaders();
38 $this->outputHeader();
39 $out = $this->getOutput();
40 $out->addModuleStyles( 'mediawiki.special' );
41 $this->addHelpLink( 'Help:User contributions' );
42
43 $this->opts = array();
44 $request = $this->getRequest();
45
46 if ( $par !== null ) {
47 $target = $par;
48 } else {
49 $target = $request->getVal( 'target' );
50 }
51
52 if ( $request->getVal( 'contribs' ) == 'newbie' || $par === 'newbies' ) {
53 $target = 'newbies';
54 $this->opts['contribs'] = 'newbie';
55 } else {
56 $this->opts['contribs'] = 'user';
57 }
58
59 $this->opts['deletedOnly'] = $request->getBool( 'deletedOnly' );
60
61 if ( !strlen( $target ) ) {
62 if ( !$this->including() ) {
63 $out->addHTML( $this->getForm() );
64 }
65
66 return;
67 }
68
69 $user = $this->getUser();
70
71 $this->opts['limit'] = $request->getInt( 'limit', $user->getOption( 'rclimit' ) );
72 $this->opts['target'] = $target;
73 $this->opts['topOnly'] = $request->getBool( 'topOnly' );
74 $this->opts['newOnly'] = $request->getBool( 'newOnly' );
75
76 $nt = Title::makeTitleSafe( NS_USER, $target );
77 if ( !$nt ) {
78 $out->addHTML( $this->getForm() );
79
80 return;
81 }
82 $userObj = User::newFromName( $nt->getText(), false );
83 if ( !$userObj ) {
84 $out->addHTML( $this->getForm() );
85
86 return;
87 }
88 $id = $userObj->getID();
89
90 if ( $this->opts['contribs'] != 'newbie' ) {
91 $target = $nt->getText();
92 $out->addSubtitle( $this->contributionsSub( $userObj ) );
93 $out->setHTMLTitle( $this->msg(
94 'pagetitle',
95 $this->msg( 'contributions-title', $target )->plain()
96 )->inContentLanguage() );
97 $this->getSkin()->setRelevantUser( $userObj );
98 } else {
99 $out->addSubtitle( $this->msg( 'sp-contributions-newbies-sub' ) );
100 $out->setHTMLTitle( $this->msg(
101 'pagetitle',
102 $this->msg( 'sp-contributions-newbies-title' )->plain()
103 )->inContentLanguage() );
104 }
105
106 $ns = $request->getVal( 'namespace', null );
107 if ( $ns !== null && $ns !== '' ) {
108 $this->opts['namespace'] = intval( $ns );
109 } else {
110 $this->opts['namespace'] = '';
111 }
112
113 $this->opts['associated'] = $request->getBool( 'associated' );
114 $this->opts['nsInvert'] = (bool)$request->getVal( 'nsInvert' );
115 $this->opts['tagfilter'] = (string)$request->getVal( 'tagfilter' );
116
117 // Allows reverts to have the bot flag in recent changes. It is just here to
118 // be passed in the form at the top of the page
119 if ( $user->isAllowed( 'markbotedits' ) && $request->getBool( 'bot' ) ) {
120 $this->opts['bot'] = '1';
121 }
122
123 $skip = $request->getText( 'offset' ) || $request->getText( 'dir' ) == 'prev';
124 # Offset overrides year/month selection
125 if ( $skip ) {
126 $this->opts['year'] = '';
127 $this->opts['month'] = '';
128 } else {
129 $this->opts['year'] = $request->getIntOrNull( 'year' );
130 $this->opts['month'] = $request->getIntOrNull( 'month' );
131 }
132
133 $feedType = $request->getVal( 'feed' );
134
135 $feedParams = array(
136 'action' => 'feedcontributions',
137 'user' => $target,
138 );
139 if ( $this->opts['topOnly'] ) {
140 $feedParams['toponly'] = true;
141 }
142 if ( $this->opts['newOnly'] ) {
143 $feedParams['newonly'] = true;
144 }
145 if ( $this->opts['deletedOnly'] ) {
146 $feedParams['deletedonly'] = true;
147 }
148 if ( $this->opts['tagfilter'] !== '' ) {
149 $feedParams['tagfilter'] = $this->opts['tagfilter'];
150 }
151 if ( $this->opts['namespace'] !== '' ) {
152 $feedParams['namespace'] = $this->opts['namespace'];
153 }
154 // Don't use year and month for the feed URL, but pass them on if
155 // we redirect to API (if $feedType is specified)
156 if ( $feedType && $this->opts['year'] !== null ) {
157 $feedParams['year'] = $this->opts['year'];
158 }
159 if ( $feedType && $this->opts['month'] !== null ) {
160 $feedParams['month'] = $this->opts['month'];
161 }
162
163 if ( $feedType ) {
164 // Maintain some level of backwards compatibility
165 // If people request feeds using the old parameters, redirect to API
166 $feedParams['feedformat'] = $feedType;
167 $url = wfAppendQuery( wfScript( 'api' ), $feedParams );
168
169 $out->redirect( $url, '301' );
170
171 return;
172 }
173
174 // Add RSS/atom links
175 $this->addFeedLinks( $feedParams );
176
177 if ( Hooks::run( 'SpecialContributionsBeforeMainOutput', array( $id, $userObj, $this ) ) ) {
178 if ( !$this->including() ) {
179 $out->addHTML( $this->getForm() );
180 }
181 $pager = new ContribsPager( $this->getContext(), array(
182 'target' => $target,
183 'contribs' => $this->opts['contribs'],
184 'namespace' => $this->opts['namespace'],
185 'tagfilter' => $this->opts['tagfilter'],
186 'year' => $this->opts['year'],
187 'month' => $this->opts['month'],
188 'deletedOnly' => $this->opts['deletedOnly'],
189 'topOnly' => $this->opts['topOnly'],
190 'newOnly' => $this->opts['newOnly'],
191 'nsInvert' => $this->opts['nsInvert'],
192 'associated' => $this->opts['associated'],
193 ) );
194
195 if ( !$pager->getNumRows() ) {
196 $out->addWikiMsg( 'nocontribs', $target );
197 } else {
198 # Show a message about slave lag, if applicable
199 $lag = wfGetLB()->safeGetLag( $pager->getDatabase() );
200 if ( $lag > 0 ) {
201 $out->showLagWarning( $lag );
202 }
203
204 $output = $pager->getBody();
205 if ( !$this->including() ) {
206 $output = '<p>' . $pager->getNavigationBar() . '</p>' .
207 $output .
208 '<p>' . $pager->getNavigationBar() . '</p>';
209 }
210 $out->addHTML( $output );
211 }
212 $out->preventClickjacking( $pager->getPreventClickjacking() );
213
214 # Show the appropriate "footer" message - WHOIS tools, etc.
215 if ( $this->opts['contribs'] == 'newbie' ) {
216 $message = 'sp-contributions-footer-newbies';
217 } elseif ( IP::isIPAddress( $target ) ) {
218 $message = 'sp-contributions-footer-anon';
219 } elseif ( $userObj->isAnon() ) {
220 // No message for non-existing users
221 $message = '';
222 } else {
223 $message = 'sp-contributions-footer';
224 }
225
226 if ( $message ) {
227 if ( !$this->including() ) {
228 if ( !$this->msg( $message, $target )->isDisabled() ) {
229 $out->wrapWikiMsg(
230 "<div class='mw-contributions-footer'>\n$1\n</div>",
231 array( $message, $target ) );
232 }
233 }
234 }
235 }
236 }
237
238 /**
239 * Generates the subheading with links
240 * @param User $userObj User object for the target
241 * @return string Appropriately-escaped HTML to be output literally
242 * @todo FIXME: Almost the same as getSubTitle in SpecialDeletedContributions.php.
243 * Could be combined.
244 */
245 protected function contributionsSub( $userObj ) {
246 if ( $userObj->isAnon() ) {
247 // Show a warning message that the user being searched for doesn't exists
248 if ( !User::isIP( $userObj->getName() ) ) {
249 $this->getOutput()->wrapWikiMsg(
250 "<div class=\"mw-userpage-userdoesnotexist error\">\n\$1\n</div>",
251 array(
252 'contributions-userdoesnotexist',
253 wfEscapeWikiText( $userObj->getName() ),
254 )
255 );
256 if ( !$this->including() ) {
257 $this->getOutput()->setStatusCode( 404 );
258 }
259 }
260 $user = htmlspecialchars( $userObj->getName() );
261 } else {
262 $user = Linker::link( $userObj->getUserPage(), htmlspecialchars( $userObj->getName() ) );
263 }
264 $nt = $userObj->getUserPage();
265 $talk = $userObj->getTalkPage();
266 $links = '';
267 if ( $talk ) {
268 $tools = $this->getUserLinks( $nt, $talk, $userObj );
269 $links = $this->getLanguage()->pipeList( $tools );
270
271 // Show a note if the user is blocked and display the last block log entry.
272 // Do not expose the autoblocks, since that may lead to a leak of accounts' IPs,
273 // and also this will display a totally irrelevant log entry as a current block.
274 if ( !$this->including() ) {
275 $block = Block::newFromTarget( $userObj, $userObj );
276 if ( !is_null( $block ) && $block->getType() != Block::TYPE_AUTO ) {
277 if ( $block->getType() == Block::TYPE_RANGE ) {
278 $nt = MWNamespace::getCanonicalName( NS_USER ) . ':' . $block->getTarget();
279 }
280
281 $out = $this->getOutput(); // showLogExtract() wants first parameter by reference
282 LogEventsList::showLogExtract(
283 $out,
284 'block',
285 $nt,
286 '',
287 array(
288 'lim' => 1,
289 'showIfEmpty' => false,
290 'msgKey' => array(
291 $userObj->isAnon() ?
292 'sp-contributions-blocked-notice-anon' :
293 'sp-contributions-blocked-notice',
294 $userObj->getName() # Support GENDER in 'sp-contributions-blocked-notice'
295 ),
296 'offset' => '' # don't use WebRequest parameter offset
297 )
298 );
299 }
300 }
301 }
302
303 return $this->msg( 'contribsub2' )->rawParams( $user, $links )->params( $userObj->getName() );
304 }
305
306 /**
307 * Links to different places.
308 * @param Title $userpage Target user page
309 * @param Title $talkpage Talk page
310 * @param User $target Target user object
311 * @return array
312 */
313 public function getUserLinks( Title $userpage, Title $talkpage, User $target ) {
314
315 $id = $target->getId();
316 $username = $target->getName();
317
318 $tools[] = Linker::link( $talkpage, $this->msg( 'sp-contributions-talk' )->escaped() );
319
320 if ( ( $id !== null ) || ( $id === null && IP::isIPAddress( $username ) ) ) {
321 if ( $this->getUser()->isAllowed( 'block' ) ) { # Block / Change block / Unblock links
322 if ( $target->isBlocked() && $target->getBlock()->getType() != Block::TYPE_AUTO ) {
323 $tools[] = Linker::linkKnown( # Change block link
324 SpecialPage::getTitleFor( 'Block', $username ),
325 $this->msg( 'change-blocklink' )->escaped()
326 );
327 $tools[] = Linker::linkKnown( # Unblock link
328 SpecialPage::getTitleFor( 'Unblock', $username ),
329 $this->msg( 'unblocklink' )->escaped()
330 );
331 } else { # User is not blocked
332 $tools[] = Linker::linkKnown( # Block link
333 SpecialPage::getTitleFor( 'Block', $username ),
334 $this->msg( 'blocklink' )->escaped()
335 );
336 }
337 }
338
339 # Block log link
340 $tools[] = Linker::linkKnown(
341 SpecialPage::getTitleFor( 'Log', 'block' ),
342 $this->msg( 'sp-contributions-blocklog' )->escaped(),
343 array(),
344 array( 'page' => $userpage->getPrefixedText() )
345 );
346
347 # Suppression log link (bug 59120)
348 if ( $this->getUser()->isAllowed( 'suppressionlog' ) ) {
349 $tools[] = Linker::linkKnown(
350 SpecialPage::getTitleFor( 'Log', 'suppress' ),
351 $this->msg( 'sp-contributions-suppresslog' )->escaped(),
352 array(),
353 array( 'offender' => $username )
354 );
355 }
356 }
357 # Uploads
358 $tools[] = Linker::linkKnown(
359 SpecialPage::getTitleFor( 'Listfiles', $username ),
360 $this->msg( 'sp-contributions-uploads' )->escaped()
361 );
362
363 # Other logs link
364 $tools[] = Linker::linkKnown(
365 SpecialPage::getTitleFor( 'Log', $username ),
366 $this->msg( 'sp-contributions-logs' )->escaped()
367 );
368
369 # Add link to deleted user contributions for priviledged users
370 if ( $this->getUser()->isAllowed( 'deletedhistory' ) ) {
371 $tools[] = Linker::linkKnown(
372 SpecialPage::getTitleFor( 'DeletedContributions', $username ),
373 $this->msg( 'sp-contributions-deleted' )->escaped()
374 );
375 }
376
377 # Add a link to change user rights for privileged users
378 $userrightsPage = new UserrightsPage();
379 $userrightsPage->setContext( $this->getContext() );
380 if ( $userrightsPage->userCanChangeRights( $target ) ) {
381 $tools[] = Linker::linkKnown(
382 SpecialPage::getTitleFor( 'Userrights', $username ),
383 $this->msg( 'sp-contributions-userrights' )->escaped()
384 );
385 }
386
387 Hooks::run( 'ContributionsToolLinks', array( $id, $userpage, &$tools ) );
388
389 return $tools;
390 }
391
392 /**
393 * Generates the namespace selector form with hidden attributes.
394 * @return string HTML fragment
395 */
396 protected function getForm() {
397 $this->opts['title'] = $this->getPageTitle()->getPrefixedText();
398 if ( !isset( $this->opts['target'] ) ) {
399 $this->opts['target'] = '';
400 } else {
401 $this->opts['target'] = str_replace( '_', ' ', $this->opts['target'] );
402 }
403
404 if ( !isset( $this->opts['namespace'] ) ) {
405 $this->opts['namespace'] = '';
406 }
407
408 if ( !isset( $this->opts['nsInvert'] ) ) {
409 $this->opts['nsInvert'] = '';
410 }
411
412 if ( !isset( $this->opts['associated'] ) ) {
413 $this->opts['associated'] = false;
414 }
415
416 if ( !isset( $this->opts['contribs'] ) ) {
417 $this->opts['contribs'] = 'user';
418 }
419
420 if ( !isset( $this->opts['year'] ) ) {
421 $this->opts['year'] = '';
422 }
423
424 if ( !isset( $this->opts['month'] ) ) {
425 $this->opts['month'] = '';
426 }
427
428 if ( $this->opts['contribs'] == 'newbie' ) {
429 $this->opts['target'] = '';
430 }
431
432 if ( !isset( $this->opts['tagfilter'] ) ) {
433 $this->opts['tagfilter'] = '';
434 }
435
436 if ( !isset( $this->opts['topOnly'] ) ) {
437 $this->opts['topOnly'] = false;
438 }
439
440 if ( !isset( $this->opts['newOnly'] ) ) {
441 $this->opts['newOnly'] = false;
442 }
443
444 $form = Html::openElement(
445 'form',
446 array(
447 'method' => 'get',
448 'action' => wfScript(),
449 'class' => 'mw-contributions-form'
450 )
451 );
452
453 # Add hidden params for tracking except for parameters in $skipParameters
454 $skipParameters = array(
455 'namespace',
456 'nsInvert',
457 'deletedOnly',
458 'target',
459 'contribs',
460 'year',
461 'month',
462 'topOnly',
463 'newOnly',
464 'associated',
465 'tagfilter'
466 );
467
468 foreach ( $this->opts as $name => $value ) {
469 if ( in_array( $name, $skipParameters ) ) {
470 continue;
471 }
472 $form .= "\t" . Html::hidden( $name, $value ) . "\n";
473 }
474
475 $tagFilter = ChangeTags::buildTagFilterSelector( $this->opts['tagfilter'] );
476
477 if ( $tagFilter ) {
478 $filterSelection = Html::rawElement(
479 'td',
480 array(),
481 implode( '&#160;', $tagFilter )
482 );
483 } else {
484 $filterSelection = Html::rawElement( 'td', array( 'colspan' => 2 ), '' );
485 }
486
487 $this->getOutput()->addModules( 'mediawiki.userSuggest' );
488
489 $labelNewbies = Xml::radioLabel(
490 $this->msg( 'sp-contributions-newbies' )->text(),
491 'contribs',
492 'newbie',
493 'newbie',
494 $this->opts['contribs'] == 'newbie',
495 array( 'class' => 'mw-input' )
496 );
497 $labelUsername = Xml::radioLabel(
498 $this->msg( 'sp-contributions-username' )->text(),
499 'contribs',
500 'user',
501 'user',
502 $this->opts['contribs'] == 'user',
503 array( 'class' => 'mw-input' )
504 );
505 $input = Html::input(
506 'target',
507 $this->opts['target'],
508 'text',
509 array(
510 'size' => '40',
511 'required' => '',
512 'class' => array(
513 'mw-input',
514 'mw-ui-input-inline',
515 'mw-autocomplete-user', // used by mediawiki.userSuggest
516 ),
517 ) + (
518 // Only autofocus if target hasn't been specified or in non-newbies mode
519 ( $this->opts['contribs'] === 'newbie' || $this->opts['target'] )
520 ? array() : array( 'autofocus' => true )
521 )
522 );
523
524 $targetSelection = Html::rawElement(
525 'td',
526 array( 'colspan' => 2 ),
527 $labelNewbies . '<br />' . $labelUsername . ' ' . $input . ' '
528 );
529
530 $namespaceSelection = Xml::tags(
531 'td',
532 array(),
533 Xml::label(
534 $this->msg( 'namespace' )->text(),
535 'namespace',
536 ''
537 ) .
538 Html::namespaceSelector(
539 array( 'selected' => $this->opts['namespace'], 'all' => '' ),
540 array(
541 'name' => 'namespace',
542 'id' => 'namespace',
543 'class' => 'namespaceselector',
544 )
545 ) . '&#160;' .
546 Html::rawElement(
547 'span',
548 array( 'class' => 'mw-input-with-label' ),
549 Xml::checkLabel(
550 $this->msg( 'invert' )->text(),
551 'nsInvert',
552 'nsInvert',
553 $this->opts['nsInvert'],
554 array(
555 'title' => $this->msg( 'tooltip-invert' )->text(),
556 'class' => 'mw-input'
557 )
558 ) . '&#160;'
559 ) .
560 Html::rawElement( 'span', array( 'class' => 'mw-input-with-label' ),
561 Xml::checkLabel(
562 $this->msg( 'namespace_association' )->text(),
563 'associated',
564 'associated',
565 $this->opts['associated'],
566 array(
567 'title' => $this->msg( 'tooltip-namespace_association' )->text(),
568 'class' => 'mw-input'
569 )
570 ) . '&#160;'
571 )
572 );
573
574 $filters = array();
575
576 if ( $this->getUser()->isAllowed( 'deletedhistory' ) ) {
577 $filters[] = Html::rawElement(
578 'span',
579 array( 'class' => 'mw-input-with-label' ),
580 Xml::checkLabel(
581 $this->msg( 'history-show-deleted' )->text(),
582 'deletedOnly',
583 'mw-show-deleted-only',
584 $this->opts['deletedOnly'],
585 array( 'class' => 'mw-input' )
586 )
587 );
588 }
589
590 $filters[] = Html::rawElement(
591 'span',
592 array( 'class' => 'mw-input-with-label' ),
593 Xml::checkLabel(
594 $this->msg( 'sp-contributions-toponly' )->text(),
595 'topOnly',
596 'mw-show-top-only',
597 $this->opts['topOnly'],
598 array( 'class' => 'mw-input' )
599 )
600 );
601 $filters[] = Html::rawElement(
602 'span',
603 array( 'class' => 'mw-input-with-label' ),
604 Xml::checkLabel(
605 $this->msg( 'sp-contributions-newonly' )->text(),
606 'newOnly',
607 'mw-show-new-only',
608 $this->opts['newOnly'],
609 array( 'class' => 'mw-input' )
610 )
611 );
612
613 Hooks::run(
614 'SpecialContributions::getForm::filters',
615 array( $this, &$filters )
616 );
617
618 $extraOptions = Html::rawElement(
619 'td',
620 array( 'colspan' => 2 ),
621 implode( '', $filters )
622 );
623
624 $dateSelectionAndSubmit = Xml::tags( 'td', array( 'colspan' => 2 ),
625 Xml::dateMenu(
626 $this->opts['year'] === '' ? MWTimestamp::getInstance()->format( 'Y' ) : $this->opts['year'],
627 $this->opts['month']
628 ) . ' ' .
629 Html::submitButton(
630 $this->msg( 'sp-contributions-submit' )->text(),
631 array( 'class' => 'mw-submit' ), array( 'mw-ui-progressive' )
632 )
633 );
634
635 $form .= Xml::fieldset( $this->msg( 'sp-contributions-search' )->text() );
636 $form .= Html::rawElement( 'table', array( 'class' => 'mw-contributions-table' ), "\n" .
637 Html::rawElement( 'tr', array(), $targetSelection ) . "\n" .
638 Html::rawElement( 'tr', array(), $namespaceSelection ) . "\n" .
639 Html::rawElement( 'tr', array(), $filterSelection ) . "\n" .
640 Html::rawElement( 'tr', array(), $extraOptions ) . "\n" .
641 Html::rawElement( 'tr', array(), $dateSelectionAndSubmit ) . "\n"
642 );
643
644 $explain = $this->msg( 'sp-contributions-explain' );
645 if ( !$explain->isBlank() ) {
646 $form .= "<p id='mw-sp-contributions-explain'>{$explain->parse()}</p>";
647 }
648
649 $form .= Xml::closeElement( 'fieldset' ) . Xml::closeElement( 'form' );
650
651 return $form;
652 }
653
654 /**
655 * Return an array of subpages beginning with $search that this special page will accept.
656 *
657 * @param string $search Prefix to search for
658 * @param int $limit Maximum number of results to return (usually 10)
659 * @param int $offset Number of results to skip (usually 0)
660 * @return string[] Matching subpages
661 */
662 public function prefixSearchSubpages( $search, $limit, $offset ) {
663 $user = User::newFromName( $search );
664 if ( !$user ) {
665 // No prefix suggestion for invalid user
666 return array();
667 }
668 // Autocomplete subpage as user list - public to allow caching
669 return UserNamePrefixSearch::search( 'public', $search, $limit, $offset );
670 }
671
672 protected function getGroupName() {
673 return 'users';
674 }
675 }
676
677 /**
678 * Pager for Special:Contributions
679 * @ingroup SpecialPage Pager
680 */
681 class ContribsPager extends ReverseChronologicalPager {
682 public $mDefaultDirection = IndexPager::DIR_DESCENDING;
683 public $messages;
684 public $target;
685 public $namespace = '';
686 public $mDb;
687 public $preventClickjacking = false;
688
689 /** @var IDatabase */
690 public $mDbSecondary;
691
692 /**
693 * @var array
694 */
695 protected $mParentLens;
696
697 function __construct( IContextSource $context, array $options ) {
698 parent::__construct( $context );
699
700 $msgs = array(
701 'diff',
702 'hist',
703 'pipe-separator',
704 'uctop'
705 );
706
707 foreach ( $msgs as $msg ) {
708 $this->messages[$msg] = $this->msg( $msg )->escaped();
709 }
710
711 $this->target = isset( $options['target'] ) ? $options['target'] : '';
712 $this->contribs = isset( $options['contribs'] ) ? $options['contribs'] : 'users';
713 $this->namespace = isset( $options['namespace'] ) ? $options['namespace'] : '';
714 $this->tagFilter = isset( $options['tagfilter'] ) ? $options['tagfilter'] : false;
715 $this->nsInvert = isset( $options['nsInvert'] ) ? $options['nsInvert'] : false;
716 $this->associated = isset( $options['associated'] ) ? $options['associated'] : false;
717
718 $this->deletedOnly = !empty( $options['deletedOnly'] );
719 $this->topOnly = !empty( $options['topOnly'] );
720 $this->newOnly = !empty( $options['newOnly'] );
721
722 $year = isset( $options['year'] ) ? $options['year'] : false;
723 $month = isset( $options['month'] ) ? $options['month'] : false;
724 $this->getDateCond( $year, $month );
725
726 // Most of this code will use the 'contributions' group DB, which can map to slaves
727 // with extra user based indexes or partioning by user. The additional metadata
728 // queries should use a regular slave since the lookup pattern is not all by user.
729 $this->mDbSecondary = wfGetDB( DB_SLAVE ); // any random slave
730 $this->mDb = wfGetDB( DB_SLAVE, 'contributions' );
731 }
732
733 function getDefaultQuery() {
734 $query = parent::getDefaultQuery();
735 $query['target'] = $this->target;
736
737 return $query;
738 }
739
740 /**
741 * This method basically executes the exact same code as the parent class, though with
742 * a hook added, to allow extensions to add additional queries.
743 *
744 * @param string $offset Index offset, inclusive
745 * @param int $limit Exact query limit
746 * @param bool $descending Query direction, false for ascending, true for descending
747 * @return ResultWrapper
748 */
749 function reallyDoQuery( $offset, $limit, $descending ) {
750 list( $tables, $fields, $conds, $fname, $options, $join_conds ) = $this->buildQueryInfo(
751 $offset,
752 $limit,
753 $descending
754 );
755
756 /*
757 * This hook will allow extensions to add in additional queries, so they can get their data
758 * in My Contributions as well. Extensions should append their results to the $data array.
759 *
760 * Extension queries have to implement the navbar requirement as well. They should
761 * - have a column aliased as $pager->getIndexField()
762 * - have LIMIT set
763 * - have a WHERE-clause that compares the $pager->getIndexField()-equivalent column to the offset
764 * - have the ORDER BY specified based upon the details provided by the navbar
765 *
766 * See includes/Pager.php buildQueryInfo() method on how to build LIMIT, WHERE & ORDER BY
767 *
768 * &$data: an array of results of all contribs queries
769 * $pager: the ContribsPager object hooked into
770 * $offset: see phpdoc above
771 * $limit: see phpdoc above
772 * $descending: see phpdoc above
773 */
774 $data = array( $this->mDb->select(
775 $tables, $fields, $conds, $fname, $options, $join_conds
776 ) );
777 Hooks::run(
778 'ContribsPager::reallyDoQuery',
779 array( &$data, $this, $offset, $limit, $descending )
780 );
781
782 $result = array();
783
784 // loop all results and collect them in an array
785 foreach ( $data as $query ) {
786 foreach ( $query as $i => $row ) {
787 // use index column as key, allowing us to easily sort in PHP
788 $result[$row->{$this->getIndexField()} . "-$i"] = $row;
789 }
790 }
791
792 // sort results
793 if ( $descending ) {
794 ksort( $result );
795 } else {
796 krsort( $result );
797 }
798
799 // enforce limit
800 $result = array_slice( $result, 0, $limit );
801
802 // get rid of array keys
803 $result = array_values( $result );
804
805 return new FakeResultWrapper( $result );
806 }
807
808 function getQueryInfo() {
809 list( $tables, $index, $userCond, $join_cond ) = $this->getUserCond();
810
811 $user = $this->getUser();
812 $conds = array_merge( $userCond, $this->getNamespaceCond() );
813
814 // Paranoia: avoid brute force searches (bug 17342)
815 if ( !$user->isAllowed( 'deletedhistory' ) ) {
816 $conds[] = $this->mDb->bitAnd( 'rev_deleted', Revision::DELETED_USER ) . ' = 0';
817 } elseif ( !$user->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
818 $conds[] = $this->mDb->bitAnd( 'rev_deleted', Revision::SUPPRESSED_USER ) .
819 ' != ' . Revision::SUPPRESSED_USER;
820 }
821
822 # Don't include orphaned revisions
823 $join_cond['page'] = Revision::pageJoinCond();
824 # Get the current user name for accounts
825 $join_cond['user'] = Revision::userJoinCond();
826
827 $options = array();
828 if ( $index ) {
829 $options['USE INDEX'] = array( 'revision' => $index );
830 }
831
832 $queryInfo = array(
833 'tables' => $tables,
834 'fields' => array_merge(
835 Revision::selectFields(),
836 Revision::selectUserFields(),
837 array( 'page_namespace', 'page_title', 'page_is_new',
838 'page_latest', 'page_is_redirect', 'page_len' )
839 ),
840 'conds' => $conds,
841 'options' => $options,
842 'join_conds' => $join_cond
843 );
844
845 ChangeTags::modifyDisplayQuery(
846 $queryInfo['tables'],
847 $queryInfo['fields'],
848 $queryInfo['conds'],
849 $queryInfo['join_conds'],
850 $queryInfo['options'],
851 $this->tagFilter
852 );
853
854 Hooks::run( 'ContribsPager::getQueryInfo', array( &$this, &$queryInfo ) );
855
856 return $queryInfo;
857 }
858
859 function getUserCond() {
860 $condition = array();
861 $join_conds = array();
862 $tables = array( 'revision', 'page', 'user' );
863 $index = false;
864 if ( $this->contribs == 'newbie' ) {
865 $max = $this->mDb->selectField( 'user', 'max(user_id)', false, __METHOD__ );
866 $condition[] = 'rev_user >' . (int)( $max - $max / 100 );
867 # ignore local groups with the bot right
868 # @todo FIXME: Global groups may have 'bot' rights
869 $groupsWithBotPermission = User::getGroupsWithPermission( 'bot' );
870 if ( count( $groupsWithBotPermission ) ) {
871 $tables[] = 'user_groups';
872 $condition[] = 'ug_group IS NULL';
873 $join_conds['user_groups'] = array(
874 'LEFT JOIN', array(
875 'ug_user = rev_user',
876 'ug_group' => $groupsWithBotPermission
877 )
878 );
879 }
880 } else {
881 $uid = User::idFromName( $this->target );
882 if ( $uid ) {
883 $condition['rev_user'] = $uid;
884 $index = 'user_timestamp';
885 } else {
886 $condition['rev_user_text'] = $this->target;
887 $index = 'usertext_timestamp';
888 }
889 }
890
891 if ( $this->deletedOnly ) {
892 $condition[] = 'rev_deleted != 0';
893 }
894
895 if ( $this->topOnly ) {
896 $condition[] = 'rev_id = page_latest';
897 }
898
899 if ( $this->newOnly ) {
900 $condition[] = 'rev_parent_id = 0';
901 }
902
903 return array( $tables, $index, $condition, $join_conds );
904 }
905
906 function getNamespaceCond() {
907 if ( $this->namespace !== '' ) {
908 $selectedNS = $this->mDb->addQuotes( $this->namespace );
909 $eq_op = $this->nsInvert ? '!=' : '=';
910 $bool_op = $this->nsInvert ? 'AND' : 'OR';
911
912 if ( !$this->associated ) {
913 return array( "page_namespace $eq_op $selectedNS" );
914 }
915
916 $associatedNS = $this->mDb->addQuotes(
917 MWNamespace::getAssociated( $this->namespace )
918 );
919
920 return array(
921 "page_namespace $eq_op $selectedNS " .
922 $bool_op .
923 " page_namespace $eq_op $associatedNS"
924 );
925 }
926
927 return array();
928 }
929
930 function getIndexField() {
931 return 'rev_timestamp';
932 }
933
934 function doBatchLookups() {
935 # Do a link batch query
936 $this->mResult->seek( 0 );
937 $revIds = array();
938 $batch = new LinkBatch();
939 # Give some pointers to make (last) links
940 foreach ( $this->mResult as $row ) {
941 if ( isset( $row->rev_parent_id ) && $row->rev_parent_id ) {
942 $revIds[] = $row->rev_parent_id;
943 }
944 if ( isset( $row->rev_id ) ) {
945 if ( $this->contribs === 'newbie' ) { // multiple users
946 $batch->add( NS_USER, $row->user_name );
947 $batch->add( NS_USER_TALK, $row->user_name );
948 }
949 $batch->add( $row->page_namespace, $row->page_title );
950 }
951 }
952 $this->mParentLens = Revision::getParentLengths( $this->mDbSecondary, $revIds );
953 $batch->execute();
954 $this->mResult->seek( 0 );
955 }
956
957 /**
958 * @return string
959 */
960 function getStartBody() {
961 return "<ul class=\"mw-contributions-list\">\n";
962 }
963
964 /**
965 * @return string
966 */
967 function getEndBody() {
968 return "</ul>\n";
969 }
970
971 /**
972 * Generates each row in the contributions list.
973 *
974 * Contributions which are marked "top" are currently on top of the history.
975 * For these contributions, a [rollback] link is shown for users with roll-
976 * back privileges. The rollback link restores the most recent version that
977 * was not written by the target user.
978 *
979 * @todo This would probably look a lot nicer in a table.
980 * @param object $row
981 * @return string
982 */
983 function formatRow( $row ) {
984
985 $ret = '';
986 $classes = array();
987
988 /*
989 * There may be more than just revision rows. To make sure that we'll only be processing
990 * revisions here, let's _try_ to build a revision out of our row (without displaying
991 * notices though) and then trying to grab data from the built object. If we succeed,
992 * we're definitely dealing with revision data and we may proceed, if not, we'll leave it
993 * to extensions to subscribe to the hook to parse the row.
994 */
995 MediaWiki\suppressWarnings();
996 try {
997 $rev = new Revision( $row );
998 $validRevision = (bool)$rev->getId();
999 } catch ( Exception $e ) {
1000 $validRevision = false;
1001 }
1002 MediaWiki\restoreWarnings();
1003
1004 if ( $validRevision ) {
1005 $classes = array();
1006
1007 $page = Title::newFromRow( $row );
1008 $link = Linker::link(
1009 $page,
1010 htmlspecialchars( $page->getPrefixedText() ),
1011 array( 'class' => 'mw-contributions-title' ),
1012 $page->isRedirect() ? array( 'redirect' => 'no' ) : array()
1013 );
1014 # Mark current revisions
1015 $topmarktext = '';
1016 $user = $this->getUser();
1017 if ( $row->rev_id == $row->page_latest ) {
1018 $topmarktext .= '<span class="mw-uctop">' . $this->messages['uctop'] . '</span>';
1019 # Add rollback link
1020 if ( !$row->page_is_new && $page->quickUserCan( 'rollback', $user )
1021 && $page->quickUserCan( 'edit', $user )
1022 ) {
1023 $this->preventClickjacking();
1024 $topmarktext .= ' ' . Linker::generateRollback( $rev, $this->getContext() );
1025 }
1026 }
1027 # Is there a visible previous revision?
1028 if ( $rev->userCan( Revision::DELETED_TEXT, $user ) && $rev->getParentId() !== 0 ) {
1029 $difftext = Linker::linkKnown(
1030 $page,
1031 $this->messages['diff'],
1032 array(),
1033 array(
1034 'diff' => 'prev',
1035 'oldid' => $row->rev_id
1036 )
1037 );
1038 } else {
1039 $difftext = $this->messages['diff'];
1040 }
1041 $histlink = Linker::linkKnown(
1042 $page,
1043 $this->messages['hist'],
1044 array(),
1045 array( 'action' => 'history' )
1046 );
1047
1048 if ( $row->rev_parent_id === null ) {
1049 // For some reason rev_parent_id isn't populated for this row.
1050 // Its rumoured this is true on wikipedia for some revisions (bug 34922).
1051 // Next best thing is to have the total number of bytes.
1052 $chardiff = ' <span class="mw-changeslist-separator">. .</span> ';
1053 $chardiff .= Linker::formatRevisionSize( $row->rev_len );
1054 $chardiff .= ' <span class="mw-changeslist-separator">. .</span> ';
1055 } else {
1056 $parentLen = 0;
1057 if ( isset( $this->mParentLens[$row->rev_parent_id] ) ) {
1058 $parentLen = $this->mParentLens[$row->rev_parent_id];
1059 }
1060
1061 $chardiff = ' <span class="mw-changeslist-separator">. .</span> ';
1062 $chardiff .= ChangesList::showCharacterDifference(
1063 $parentLen,
1064 $row->rev_len,
1065 $this->getContext()
1066 );
1067 $chardiff .= ' <span class="mw-changeslist-separator">. .</span> ';
1068 }
1069
1070 $lang = $this->getLanguage();
1071 $comment = $lang->getDirMark() . Linker::revComment( $rev, false, true );
1072 $date = $lang->userTimeAndDate( $row->rev_timestamp, $user );
1073 if ( $rev->userCan( Revision::DELETED_TEXT, $user ) ) {
1074 $d = Linker::linkKnown(
1075 $page,
1076 htmlspecialchars( $date ),
1077 array( 'class' => 'mw-changeslist-date' ),
1078 array( 'oldid' => intval( $row->rev_id ) )
1079 );
1080 } else {
1081 $d = htmlspecialchars( $date );
1082 }
1083 if ( $rev->isDeleted( Revision::DELETED_TEXT ) ) {
1084 $d = '<span class="history-deleted">' . $d . '</span>';
1085 }
1086
1087 # Show user names for /newbies as there may be different users.
1088 # Note that we already excluded rows with hidden user names.
1089 if ( $this->contribs == 'newbie' ) {
1090 $userlink = ' . . ' . $lang->getDirMark()
1091 . Linker::userLink( $rev->getUser(), $rev->getUserText() );
1092 $userlink .= ' ' . $this->msg( 'parentheses' )->rawParams(
1093 Linker::userTalkLink( $rev->getUser(), $rev->getUserText() ) )->escaped() . ' ';
1094 } else {
1095 $userlink = '';
1096 }
1097
1098 if ( $rev->getParentId() === 0 ) {
1099 $nflag = ChangesList::flag( 'newpage' );
1100 } else {
1101 $nflag = '';
1102 }
1103
1104 if ( $rev->isMinor() ) {
1105 $mflag = ChangesList::flag( 'minor' );
1106 } else {
1107 $mflag = '';
1108 }
1109
1110 $del = Linker::getRevDeleteLink( $user, $rev, $page );
1111 if ( $del !== '' ) {
1112 $del .= ' ';
1113 }
1114
1115 $diffHistLinks = $this->msg( 'parentheses' )
1116 ->rawParams( $difftext . $this->messages['pipe-separator'] . $histlink )
1117 ->escaped();
1118 $ret = "{$del}{$d} {$diffHistLinks}{$chardiff}{$nflag}{$mflag} ";
1119 $ret .= "{$link}{$userlink} {$comment} {$topmarktext}";
1120
1121 # Denote if username is redacted for this edit
1122 if ( $rev->isDeleted( Revision::DELETED_USER ) ) {
1123 $ret .= " <strong>" .
1124 $this->msg( 'rev-deleted-user-contribs' )->escaped() .
1125 "</strong>";
1126 }
1127
1128 # Tags, if any.
1129 list( $tagSummary, $newClasses ) = ChangeTags::formatSummaryRow(
1130 $row->ts_tags,
1131 'contributions',
1132 $this->getContext()
1133 );
1134 $classes = array_merge( $classes, $newClasses );
1135 $ret .= " $tagSummary";
1136 }
1137
1138 // Let extensions add data
1139 Hooks::run( 'ContributionsLineEnding', array( $this, &$ret, $row, &$classes ) );
1140
1141 if ( $classes === array() && $ret === '' ) {
1142 wfDebug( "Dropping Special:Contribution row that could not be formatted\n" );
1143 $ret = "<!-- Could not format Special:Contribution row. -->\n";
1144 } else {
1145 $ret = Html::rawElement( 'li', array( 'class' => $classes ), $ret ) . "\n";
1146 }
1147
1148 return $ret;
1149 }
1150
1151 /**
1152 * Overwrite Pager function and return a helpful comment
1153 * @return string
1154 */
1155 function getSqlComment() {
1156 if ( $this->namespace || $this->deletedOnly ) {
1157 // potentially slow, see CR r58153
1158 return 'contributions page filtered for namespace or RevisionDeleted edits';
1159 } else {
1160 return 'contributions page unfiltered';
1161 }
1162 }
1163
1164 protected function preventClickjacking() {
1165 $this->preventClickjacking = true;
1166 }
1167
1168 /**
1169 * @return bool
1170 */
1171 public function getPreventClickjacking() {
1172 return $this->preventClickjacking;
1173 }
1174 }