Standardised file description headers; first path
[lhc/web/wiklou.git] / includes / specials / SpecialDeletedContributions.php
1 <?php
2 /**
3 * Implements Special:DeletedContributions
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 * Implements Special:DeletedContributions to display archived revisions
26 * @ingroup SpecialPage
27 */
28
29 class DeletedContribsPager extends IndexPager {
30 public $mDefaultDirection = true;
31 var $messages, $target;
32 var $namespace = '', $mDb;
33
34 function __construct( $target, $namespace = false ) {
35 parent::__construct();
36 $msgs = array( 'deletionlog', 'undeleteviewlink', 'diff' );
37 foreach( $msgs as $msg ) {
38 $this->messages[$msg] = wfMsgExt( $msg, array( 'escapenoentities') );
39 }
40 $this->target = $target;
41 $this->namespace = $namespace;
42 $this->mDb = wfGetDB( DB_SLAVE, 'contributions' );
43 }
44
45 function getDefaultQuery() {
46 $query = parent::getDefaultQuery();
47 $query['target'] = $this->target;
48 return $query;
49 }
50
51 function getQueryInfo() {
52 global $wgUser;
53 list( $index, $userCond ) = $this->getUserCond();
54 $conds = array_merge( $userCond, $this->getNamespaceCond() );
55 // Paranoia: avoid brute force searches (bug 17792)
56 if( !$wgUser->isAllowed( 'deletedhistory' ) ) {
57 $conds[] = $this->mDb->bitAnd('ar_deleted',Revision::DELETED_USER) . ' = 0';
58 } else if( !$wgUser->isAllowed( 'suppressrevision' ) ) {
59 $conds[] = $this->mDb->bitAnd('ar_deleted',Revision::SUPPRESSED_USER) .
60 ' != ' . Revision::SUPPRESSED_USER;
61 }
62 return array(
63 'tables' => array( 'archive' ),
64 'fields' => array(
65 'ar_rev_id', 'ar_namespace', 'ar_title', 'ar_timestamp', 'ar_comment', 'ar_minor_edit',
66 'ar_user', 'ar_user_text', 'ar_deleted'
67 ),
68 'conds' => $conds,
69 'options' => array( 'USE INDEX' => $index )
70 );
71 }
72
73 function getUserCond() {
74 $condition = array();
75
76 $condition['ar_user_text'] = $this->target;
77 $index = 'usertext_timestamp';
78
79 return array( $index, $condition );
80 }
81
82 function getIndexField() {
83 return 'ar_timestamp';
84 }
85
86 function getStartBody() {
87 return "<ul>\n";
88 }
89
90 function getEndBody() {
91 return "</ul>\n";
92 }
93
94 function getNavigationBar() {
95 global $wgLang;
96
97 if ( isset( $this->mNavigationBar ) ) {
98 return $this->mNavigationBar;
99 }
100 $fmtLimit = $wgLang->formatNum( $this->mLimit );
101 $linkTexts = array(
102 'prev' => wfMsgExt( 'pager-newer-n', array( 'escape', 'parsemag' ), $fmtLimit ),
103 'next' => wfMsgExt( 'pager-older-n', array( 'escape', 'parsemag' ), $fmtLimit ),
104 'first' => wfMsgHtml( 'histlast' ),
105 'last' => wfMsgHtml( 'histfirst' )
106 );
107
108 $pagingLinks = $this->getPagingLinks( $linkTexts );
109 $limitLinks = $this->getLimitLinks();
110 $limits = $wgLang->pipeList( $limitLinks );
111
112 $this->mNavigationBar = "(" . $wgLang->pipeList( array( $pagingLinks['first'], $pagingLinks['last'] ) ) . ") " .
113 wfMsgExt( 'viewprevnext', array( 'parsemag', 'escape', 'replaceafter' ), $pagingLinks['prev'], $pagingLinks['next'], $limits );
114 return $this->mNavigationBar;
115 }
116
117 function getNamespaceCond() {
118 if ( $this->namespace !== '' ) {
119 return array( 'ar_namespace' => (int)$this->namespace );
120 } else {
121 return array();
122 }
123 }
124
125 /**
126 * Generates each row in the contributions list.
127 *
128 * Contributions which are marked "top" are currently on top of the history.
129 * For these contributions, a [rollback] link is shown for users with sysop
130 * privileges. The rollback link restores the most recent version that was not
131 * written by the target user.
132 *
133 * @todo This would probably look a lot nicer in a table.
134 */
135 function formatRow( $row ) {
136 global $wgUser, $wgLang;
137 wfProfileIn( __METHOD__ );
138
139 $sk = $this->getSkin();
140
141 $rev = new Revision( array(
142 'id' => $row->ar_rev_id,
143 'comment' => $row->ar_comment,
144 'user' => $row->ar_user,
145 'user_text' => $row->ar_user_text,
146 'timestamp' => $row->ar_timestamp,
147 'minor_edit' => $row->ar_minor_edit,
148 'deleted' => $row->ar_deleted,
149 ) );
150
151 $page = Title::makeTitle( $row->ar_namespace, $row->ar_title );
152
153 $undelete = SpecialPage::getTitleFor( 'Undelete' );
154
155 $logs = SpecialPage::getTitleFor( 'Log' );
156 $dellog = $sk->linkKnown(
157 $logs,
158 $this->messages['deletionlog'],
159 array(),
160 array(
161 'type' => 'delete',
162 'page' => $page->getPrefixedText()
163 )
164 );
165
166 $reviewlink = $sk->linkKnown(
167 SpecialPage::getTitleFor( 'Undelete', $page->getPrefixedDBkey() ),
168 $this->messages['undeleteviewlink']
169 );
170
171 if( $wgUser->isAllowed('deletedtext') ) {
172 $last = $sk->linkKnown(
173 $undelete,
174 $this->messages['diff'],
175 array(),
176 array(
177 'target' => $page->getPrefixedText(),
178 'timestamp' => $rev->getTimestamp(),
179 'diff' => 'prev'
180 )
181 );
182 } else {
183 $last = $this->messages['diff'];
184 }
185
186 $comment = $sk->revComment( $rev );
187 $date = htmlspecialchars( $wgLang->timeanddate( $rev->getTimestamp(), true ) );
188
189 if( !$wgUser->isAllowed('undelete') || !$rev->userCan(Revision::DELETED_TEXT) ) {
190 $link = $date; // unusable link
191 } else {
192 $link = $sk->linkKnown(
193 $undelete,
194 $date,
195 array(),
196 array(
197 'target' => $page->getPrefixedText(),
198 'timestamp' => $rev->getTimestamp()
199 )
200 );
201 }
202 // Style deleted items
203 if( $rev->isDeleted( Revision::DELETED_TEXT ) ) {
204 $link = '<span class="history-deleted">' . $link . '</span>';
205 }
206
207 $pagelink = $sk->link( $page );
208
209 if( $rev->isMinor() ) {
210 $mflag = ChangesList::flag( 'minor' );
211 } else {
212 $mflag = '';
213 }
214
215 // Revision delete link
216 $canHide = $wgUser->isAllowed( 'deleterevision' );
217 if( $canHide || ($rev->getVisibility() && $wgUser->isAllowed('deletedhistory')) ) {
218 if( !$rev->userCan( Revision::DELETED_RESTRICTED ) ) {
219 $del = $this->mSkin->revDeleteLinkDisabled( $canHide ); // revision was hidden from sysops
220 } else {
221 $query = array(
222 'type' => 'archive',
223 'target' => $page->getPrefixedDbkey(),
224 'ids' => $rev->getTimestamp() );
225 $del = $this->mSkin->revDeleteLink( $query,
226 $rev->isDeleted( Revision::DELETED_RESTRICTED ), $canHide ) . ' ';
227 }
228 } else {
229 $del = '';
230 }
231
232 $tools = Html::rawElement(
233 'span',
234 array( 'class' => 'mw-deletedcontribs-tools' ),
235 wfMsg( 'parentheses', $wgLang->pipeList( array( $last, $dellog, $reviewlink ) ) )
236 );
237
238 $ret = "{$del}{$link} {$tools} . . {$mflag} {$pagelink} {$comment}";
239
240 # Denote if username is redacted for this edit
241 if( $rev->isDeleted( Revision::DELETED_USER ) ) {
242 $ret .= " <strong>" . wfMsgHtml('rev-deleted-user-contribs') . "</strong>";
243 }
244
245 $ret = Html::rawElement( 'li', array(), $ret ) . "\n";
246
247 wfProfileOut( __METHOD__ );
248 return $ret;
249 }
250
251 /**
252 * Get the Database object in use
253 *
254 * @return Database
255 */
256 public function getDatabase() {
257 return $this->mDb;
258 }
259 }
260
261 class DeletedContributionsPage extends SpecialPage {
262 function __construct() {
263 parent::__construct( 'DeletedContributions', 'deletedhistory',
264 /*listed*/ true, /*function*/ false, /*file*/ false );
265 }
266
267 /**
268 * Special page "deleted user contributions".
269 * Shows a list of the deleted contributions of a user.
270 *
271 * @return none
272 * @param $par String: (optional) user name of the user for which to show the contributions
273 */
274 function execute( $par ) {
275 global $wgUser;
276 $this->setHeaders();
277
278 if ( !$this->userCanExecute( $wgUser ) ) {
279 $this->displayRestrictionError();
280 return;
281 }
282
283 global $wgOut, $wgRequest;
284
285 $wgOut->setPageTitle( wfMsgExt( 'deletedcontributions-title', array( 'parsemag' ) ) );
286
287 $options = array();
288
289 if ( isset( $par ) ) {
290 $target = $par;
291 } else {
292 $target = $wgRequest->getVal( 'target' );
293 }
294
295 if ( !strlen( $target ) ) {
296 $wgOut->addHTML( $this->getForm( '' ) );
297 return;
298 }
299
300 $options['limit'] = $wgRequest->getInt( 'limit', 50 );
301 $options['target'] = $target;
302
303 $nt = Title::makeTitleSafe( NS_USER, $target );
304 if ( !$nt ) {
305 $wgOut->addHTML( $this->getForm( '' ) );
306 return;
307 }
308 $id = User::idFromName( $nt->getText() );
309
310 $target = $nt->getText();
311 $wgOut->setSubtitle( $this->getSubTitle( $nt, $id ) );
312
313 if ( ( $ns = $wgRequest->getVal( 'namespace', null ) ) !== null && $ns !== '' ) {
314 $options['namespace'] = intval( $ns );
315 } else {
316 $options['namespace'] = '';
317 }
318
319 $wgOut->addHTML( $this->getForm( $options ) );
320
321 $pager = new DeletedContribsPager( $target, $options['namespace'] );
322 if ( !$pager->getNumRows() ) {
323 $wgOut->addWikiMsg( 'nocontribs' );
324 return;
325 }
326
327 # Show a message about slave lag, if applicable
328 if( ( $lag = $pager->getDatabase()->getLag() ) > 0 )
329 $wgOut->showLagWarning( $lag );
330
331 $wgOut->addHTML(
332 '<p>' . $pager->getNavigationBar() . '</p>' .
333 $pager->getBody() .
334 '<p>' . $pager->getNavigationBar() . '</p>' );
335
336 # If there were contributions, and it was a valid user or IP, show
337 # the appropriate "footer" message - WHOIS tools, etc.
338 if( $target != 'newbies' ) {
339 $message = IP::isIPAddress( $target )
340 ? 'sp-contributions-footer-anon'
341 : 'sp-contributions-footer';
342
343
344 $text = wfMsgNoTrans( $message, $target );
345 if( !wfEmptyMsg( $message, $text ) && $text != '-' ) {
346 $wgOut->wrapWikiMsg( "<div class='mw-contributions-footer'>\n$1\n</div>", array( $message, $target ) );
347 }
348 }
349 }
350
351 /**
352 * Generates the subheading with links
353 * @param $nt Title object for the target
354 * @param $id Integer: User ID for the target
355 * @return String: appropriately-escaped HTML to be output literally
356 * @todo Fixme: almost the same as contributionsSub in SpecialContributions.php. Could be combined.
357 */
358 function getSubTitle( $nt, $id ) {
359 global $wgSysopUserBans, $wgLang, $wgUser, $wgOut;
360
361 $sk = $wgUser->getSkin();
362
363 if ( $id === null ) {
364 $user = htmlspecialchars( $nt->getText() );
365 } else {
366 $user = $sk->link( $nt, htmlspecialchars( $nt->getText() ) );
367 }
368 $userObj = User::newFromName( $nt->getText(), /* check for username validity not needed */ false );
369 $talk = $nt->getTalkPage();
370 if( $talk ) {
371 # Talk page link
372 $tools[] = $sk->link( $talk, wfMsgHtml( 'sp-contributions-talk' ) );
373 if( ( $id !== null && $wgSysopUserBans ) || ( $id === null && IP::isIPAddress( $nt->getText() ) ) ) {
374 if( $wgUser->isAllowed( 'block' ) ) { # Block / Change block / Unblock links
375 if ( $userObj->isBlocked() ) {
376 $tools[] = $sk->linkKnown( # Change block link
377 SpecialPage::getTitleFor( 'Blockip', $nt->getDBkey() ),
378 wfMsgHtml( 'change-blocklink' )
379 );
380 $tools[] = $sk->linkKnown( # Unblock link
381 SpecialPage::getTitleFor( 'BlockList' ),
382 wfMsgHtml( 'unblocklink' ),
383 array(),
384 array(
385 'action' => 'unblock',
386 'ip' => $nt->getDBkey()
387 )
388 );
389 }
390 else { # User is not blocked
391 $tools[] = $sk->linkKnown( # Block link
392 SpecialPage::getTitleFor( 'Blockip', $nt->getDBkey() ),
393 wfMsgHtml( 'blocklink' )
394 );
395 }
396 }
397 # Block log link
398 $tools[] = $sk->linkKnown(
399 SpecialPage::getTitleFor( 'Log' ),
400 wfMsgHtml( 'sp-contributions-blocklog' ),
401 array(),
402 array(
403 'type' => 'block',
404 'page' => $nt->getPrefixedText()
405 )
406 );
407 }
408 # Other logs link
409 $tools[] = $sk->linkKnown(
410 SpecialPage::getTitleFor( 'Log' ),
411 wfMsgHtml( 'sp-contributions-logs' ),
412 array(),
413 array( 'user' => $nt->getText() )
414 );
415 # Link to contributions
416 $tools[] = $sk->linkKnown(
417 SpecialPage::getTitleFor( 'Contributions', $nt->getDBkey() ),
418 wfMsgHtml( 'sp-deletedcontributions-contribs' )
419 );
420
421 # Add a link to change user rights for privileged users
422 $userrightsPage = new UserrightsPage();
423 if( $id !== null && $userrightsPage->userCanChangeRights( User::newFromId( $id ) ) ) {
424 $tools[] = $sk->linkKnown(
425 SpecialPage::getTitleFor( 'Userrights', $nt->getDBkey() ),
426 wfMsgHtml( 'sp-contributions-userrights' )
427 );
428 }
429
430 wfRunHooks( 'ContributionsToolLinks', array( $id, $nt, &$tools ) );
431
432 $links = $wgLang->pipeList( $tools );
433
434 // Show a note if the user is blocked and display the last block log entry.
435 if ( $userObj->isBlocked() ) {
436 LogEventsList::showLogExtract(
437 $wgOut,
438 'block',
439 $nt->getPrefixedText(),
440 '',
441 array(
442 'lim' => 1,
443 'showIfEmpty' => false,
444 'msgKey' => array(
445 'sp-contributions-blocked-notice',
446 $nt->getText() # Support GENDER in 'sp-contributions-blocked-notice'
447 ),
448 'offset' => '' # don't use $wgRequest parameter offset
449 )
450 );
451 }
452 }
453
454 // Old message 'contribsub' had one parameter, but that doesn't work for
455 // languages that want to put the "for" bit right after $user but before
456 // $links. If 'contribsub' is around, use it for reverse compatibility,
457 // otherwise use 'contribsub2'.
458 if( wfEmptyMsg( 'contribsub', wfMsg( 'contribsub' ) ) ) {
459 return wfMsgHtml( 'contribsub2', $user, $links );
460 } else {
461 return wfMsgHtml( 'contribsub', "$user ($links)" );
462 }
463 }
464
465 /**
466 * Generates the namespace selector form with hidden attributes.
467 * @param $options Array: the options to be included.
468 */
469 function getForm( $options ) {
470 global $wgScript;
471
472 $options['title'] = SpecialPage::getTitleFor( 'DeletedContributions' )->getPrefixedText();
473 if ( !isset( $options['target'] ) ) {
474 $options['target'] = '';
475 } else {
476 $options['target'] = str_replace( '_' , ' ' , $options['target'] );
477 }
478
479 if ( !isset( $options['namespace'] ) ) {
480 $options['namespace'] = '';
481 }
482
483 if ( !isset( $options['contribs'] ) ) {
484 $options['contribs'] = 'user';
485 }
486
487 if ( $options['contribs'] == 'newbie' ) {
488 $options['target'] = '';
489 }
490
491 $f = Xml::openElement( 'form', array( 'method' => 'get', 'action' => $wgScript ) );
492
493 foreach ( $options as $name => $value ) {
494 if ( in_array( $name, array( 'namespace', 'target', 'contribs' ) ) ) {
495 continue;
496 }
497 $f .= "\t" . Xml::hidden( $name, $value ) . "\n";
498 }
499
500 $f .= Xml::openElement( 'fieldset' ) .
501 Xml::element( 'legend', array(), wfMsg( 'sp-contributions-search' ) ) .
502 Xml::tags( 'label', array( 'for' => 'target' ), wfMsgExt( 'sp-contributions-username', 'parseinline' ) ) . ' ' .
503 Html::input( 'target', $options['target'], 'text', array(
504 'size' => '20',
505 'required' => ''
506 ) + ( $options['target'] ? array() : array( 'autofocus' ) ) ) . ' '.
507 Xml::label( wfMsg( 'namespace' ), 'namespace' ) . ' ' .
508 Xml::namespaceSelector( $options['namespace'], '' ) . ' ' .
509 Xml::submitButton( wfMsg( 'sp-contributions-submit' ) ) .
510 Xml::closeElement( 'fieldset' ) .
511 Xml::closeElement( 'form' );
512 return $f;
513 }
514 }