RevisionDeleter:
[lhc/web/wiklou.git] / includes / LogPage.php
1 <?php
2 /**
3 * Contain log classes
4 *
5 * Copyright © 2002, 2004 Brion Vibber <brion@pobox.com>
6 * http://www.mediawiki.org/
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21 * http://www.gnu.org/copyleft/gpl.html
22 *
23 * @file
24 */
25
26 /**
27 * Class to simplify the use of log pages.
28 * The logs are now kept in a table which is easier to manage and trim
29 * than ever-growing wiki pages.
30 *
31 */
32 class LogPage {
33 const DELETED_ACTION = 1;
34 const DELETED_COMMENT = 2;
35 const DELETED_USER = 4;
36 const DELETED_RESTRICTED = 8;
37 // Convenience fields
38 const SUPPRESSED_USER = 12;
39 const SUPPRESSED_ACTION = 9;
40 /* @access private */
41 var $type, $action, $comment, $params;
42
43 /**
44 * @var User
45 */
46 var $doer;
47
48 /**
49 * @var Title
50 */
51 var $target;
52
53 /* @acess public */
54 var $updateRecentChanges, $sendToUDP;
55
56 /**
57 * Constructor
58 *
59 * @param $type String: one of '', 'block', 'protect', 'rights', 'delete',
60 * 'upload', 'move'
61 * @param $rc Boolean: whether to update recent changes as well as the logging table
62 * @param $udp String: pass 'UDP' to send to the UDP feed if NOT sent to RC
63 */
64 public function __construct( $type, $rc = true, $udp = 'skipUDP' ) {
65 $this->type = $type;
66 $this->updateRecentChanges = $rc;
67 $this->sendToUDP = ( $udp == 'UDP' );
68 }
69
70 /**
71 * @return bool|int|null
72 */
73 protected function saveContent() {
74 global $wgLogRestrictions;
75
76 $dbw = wfGetDB( DB_MASTER );
77 $log_id = $dbw->nextSequenceValue( 'logging_log_id_seq' );
78
79 $this->timestamp = $now = wfTimestampNow();
80 $data = array(
81 'log_id' => $log_id,
82 'log_type' => $this->type,
83 'log_action' => $this->action,
84 'log_timestamp' => $dbw->timestamp( $now ),
85 'log_user' => $this->doer->getId(),
86 'log_user_text' => $this->doer->getName(),
87 'log_namespace' => $this->target->getNamespace(),
88 'log_title' => $this->target->getDBkey(),
89 'log_page' => $this->target->getArticleId(),
90 'log_comment' => $this->comment,
91 'log_params' => $this->params
92 );
93 $dbw->insert( 'logging', $data, __METHOD__ );
94 $newId = !is_null( $log_id ) ? $log_id : $dbw->insertId();
95
96 # And update recentchanges
97 if( $this->updateRecentChanges ) {
98 $titleObj = SpecialPage::getTitleFor( 'Log', $this->type );
99
100 RecentChange::notifyLog(
101 $now, $titleObj, $this->doer, $this->getRcComment(), '',
102 $this->type, $this->action, $this->target, $this->comment,
103 $this->params, $newId
104 );
105 } elseif( $this->sendToUDP ) {
106 # Don't send private logs to UDP
107 if( isset( $wgLogRestrictions[$this->type] ) && $wgLogRestrictions[$this->type] != '*' ) {
108 return true;
109 }
110
111 # Notify external application via UDP.
112 # We send this to IRC but do not want to add it the RC table.
113 $titleObj = SpecialPage::getTitleFor( 'Log', $this->type );
114 $rc = RecentChange::newLogEntry(
115 $now, $titleObj, $this->doer, $this->getRcComment(), '',
116 $this->type, $this->action, $this->target, $this->comment,
117 $this->params, $newId
118 );
119 $rc->notifyRC2UDP();
120 }
121 return $newId;
122 }
123
124 /**
125 * Get the RC comment from the last addEntry() call
126 *
127 * @return string
128 */
129 public function getRcComment() {
130 $rcComment = $this->actionText;
131
132 if( $this->comment != '' ) {
133 if ( $rcComment == '' ) {
134 $rcComment = $this->comment;
135 } else {
136 $rcComment .= wfMsgForContent( 'colon-separator' ) . $this->comment;
137 }
138 }
139
140 return $rcComment;
141 }
142
143 /**
144 * Get the comment from the last addEntry() call
145 */
146 public function getComment() {
147 return $this->comment;
148 }
149
150 /**
151 * Get the list of valid log types
152 *
153 * @return Array of strings
154 */
155 public static function validTypes() {
156 global $wgLogTypes;
157 return $wgLogTypes;
158 }
159
160 /**
161 * Is $type a valid log type
162 *
163 * @param $type String: log type to check
164 * @return Boolean
165 */
166 public static function isLogType( $type ) {
167 return in_array( $type, LogPage::validTypes() );
168 }
169
170 /**
171 * Get the name for the given log type
172 *
173 * @param $type String: logtype
174 * @return String: log name
175 * @deprecated in 1.19, warnings in 1.21. Use getName()
176 */
177 public static function logName( $type ) {
178 global $wgLogNames;
179
180 if( isset( $wgLogNames[$type] ) ) {
181 return str_replace( '_', ' ', wfMsg( $wgLogNames[$type] ) );
182 } else {
183 // Bogus log types? Perhaps an extension was removed.
184 return $type;
185 }
186 }
187
188 /**
189 * Get the log header for the given log type
190 *
191 * @todo handle missing log types
192 * @param $type String: logtype
193 * @return String: headertext of this logtype
194 * @deprecated in 1.19, warnings in 1.21. Use getDescription()
195 */
196 public static function logHeader( $type ) {
197 global $wgLogHeaders;
198 return wfMsgExt( $wgLogHeaders[$type], array( 'parseinline' ) );
199 }
200
201 /**
202 * Generate text for a log entry
203 *
204 * @param $type String: log type
205 * @param $action String: log action
206 * @param $title Mixed: Title object or null
207 * @param $skin Mixed: Skin object or null. If null, we want to use the wiki
208 * content language, since that will go to the IRC feed.
209 * @param $params Array: parameters
210 * @param $filterWikilinks Boolean: whether to filter wiki links
211 * @return HTML string
212 */
213 public static function actionText( $type, $action, $title = null, $skin = null,
214 $params = array(), $filterWikilinks = false )
215 {
216 global $wgLang, $wgContLang, $wgLogActions;
217
218 if ( is_null( $skin ) ) {
219 $langObj = $wgContLang;
220 $langObjOrNull = null;
221 } else {
222 $langObj = $wgLang;
223 $langObjOrNull = $wgLang;
224 }
225
226 $key = "$type/$action";
227
228 # Defer patrol log to PatrolLog class
229 if( $key == 'patrol/patrol' ) {
230 return PatrolLog::makeActionText( $title, $params, $langObjOrNull );
231 }
232
233 if( isset( $wgLogActions[$key] ) ) {
234 if( is_null( $title ) ) {
235 $rv = wfMsgExt( $wgLogActions[$key], array( 'parsemag', 'escape', 'language' => $langObj ) );
236 } else {
237 $titleLink = self::getTitleLink( $type, $langObjOrNull, $title, $params );
238
239 if( preg_match( '/^rights\/(rights|autopromote)/', $key ) ) {
240 $rightsnone = wfMsgExt( 'rightsnone', array( 'parsemag', 'language' => $langObj ) );
241
242 if( $skin ) {
243 foreach ( $params as &$param ) {
244 $groupArray = array_map( 'trim', explode( ',', $param ) );
245 $groupArray = array_map( array( 'User', 'getGroupMember' ), $groupArray );
246 $param = $wgLang->listToText( $groupArray );
247 }
248 }
249
250 if( !isset( $params[0] ) || trim( $params[0] ) == '' ) {
251 $params[0] = $rightsnone;
252 }
253
254 if( !isset( $params[1] ) || trim( $params[1] ) == '' ) {
255 $params[1] = $rightsnone;
256 }
257 }
258
259 if( count( $params ) == 0 ) {
260 $rv = wfMsgExt( $wgLogActions[$key], array( 'parsemag', 'escape', 'replaceafter', 'language' => $langObj ), $titleLink );
261 } else {
262 $details = '';
263 array_unshift( $params, $titleLink );
264
265 // User suppression
266 if ( preg_match( '/^(block|suppress)\/(block|reblock)$/', $key ) ) {
267 if ( $skin ) {
268 $params[1] = '<span class="blockExpiry" dir="ltr" title="' . htmlspecialchars( $params[1] ). '">' .
269 $wgLang->translateBlockExpiry( $params[1] ) . '</span>';
270 } else {
271 $params[1] = $wgContLang->translateBlockExpiry( $params[1] );
272 }
273
274 $params[2] = isset( $params[2] ) ?
275 self::formatBlockFlags( $params[2], $langObj ) : '';
276 // Page protections
277 } elseif ( $type == 'protect' && count($params) == 3 ) {
278 // Restrictions and expiries
279 if( $skin ) {
280 $details .= $wgLang->getDirMark() . htmlspecialchars( " {$params[1]}" );
281 } else {
282 $details .= " {$params[1]}";
283 }
284
285 // Cascading flag...
286 if( $params[2] ) {
287 $details .= ' [' . wfMsgExt( 'protect-summary-cascade', array( 'parsemag', 'language' => $langObj ) ) . ']';
288 }
289 }
290
291 $rv = wfMsgExt( $wgLogActions[$key], array( 'parsemag', 'escape', 'replaceafter', 'language' => $langObj ), $params ) . $details;
292 }
293 }
294 } else {
295 global $wgLogActionsHandlers;
296
297 if( isset( $wgLogActionsHandlers[$key] ) ) {
298 $args = func_get_args();
299 $rv = call_user_func_array( $wgLogActionsHandlers[$key], $args );
300 } else {
301 wfDebug( "LogPage::actionText - unknown action $key\n" );
302 $rv = "$action";
303 }
304 }
305
306 // For the perplexed, this feature was added in r7855 by Erik.
307 // The feature was added because we liked adding [[$1]] in our log entries
308 // but the log entries are parsed as Wikitext on RecentChanges but as HTML
309 // on Special:Log. The hack is essentially that [[$1]] represented a link
310 // to the title in question. The first parameter to the HTML version (Special:Log)
311 // is that link in HTML form, and so this just gets rid of the ugly [[]].
312 // However, this is a horrible hack and it doesn't work like you expect if, say,
313 // you want to link to something OTHER than the title of the log entry.
314 // The real problem, which Erik was trying to fix (and it sort-of works now) is
315 // that the same messages are being treated as both wikitext *and* HTML.
316 if( $filterWikilinks ) {
317 $rv = str_replace( '[[', '', $rv );
318 $rv = str_replace( ']]', '', $rv );
319 }
320
321 return $rv;
322 }
323
324 /**
325 * TODO document
326 * @param $type String
327 * @param $lang Language or null
328 * @param $title Title
329 * @param $params Array
330 * @return String
331 */
332 protected static function getTitleLink( $type, $lang, $title, &$params ) {
333 global $wgContLang, $wgUserrightsInterwikiDelimiter;
334
335 if( !$lang ) {
336 return $title->getPrefixedText();
337 }
338
339 switch( $type ) {
340 case 'move':
341 $titleLink = Linker::link(
342 $title,
343 htmlspecialchars( $title->getPrefixedText() ),
344 array(),
345 array( 'redirect' => 'no' )
346 );
347
348 $targetTitle = Title::newFromText( $params[0] );
349
350 if ( !$targetTitle ) {
351 # Workaround for broken database
352 $params[0] = htmlspecialchars( $params[0] );
353 } else {
354 $params[0] = Linker::link(
355 $targetTitle,
356 htmlspecialchars( $params[0] )
357 );
358 }
359 break;
360 case 'block':
361 if( substr( $title->getText(), 0, 1 ) == '#' ) {
362 $titleLink = $title->getText();
363 } else {
364 // @todo Store the user identifier in the parameters
365 // to make this faster for future log entries
366 $id = User::idFromName( $title->getText() );
367 $titleLink = Linker::userLink( $id, $title->getText() )
368 . Linker::userToolLinks( $id, $title->getText(), false, Linker::TOOL_LINKS_NOBLOCK );
369 }
370 break;
371 case 'rights':
372 $text = $wgContLang->ucfirst( $title->getText() );
373 $parts = explode( $wgUserrightsInterwikiDelimiter, $text, 2 );
374
375 if ( count( $parts ) == 2 ) {
376 $titleLink = WikiMap::foreignUserLink( $parts[1], $parts[0],
377 htmlspecialchars( $title->getPrefixedText() ) );
378
379 if ( $titleLink !== false ) {
380 break;
381 }
382 }
383 $titleLink = Linker::link( Title::makeTitle( NS_USER, $text ) );
384 break;
385 case 'merge':
386 $titleLink = Linker::link(
387 $title,
388 $title->getPrefixedText(),
389 array(),
390 array( 'redirect' => 'no' )
391 );
392 $params[0] = Linker::link(
393 Title::newFromText( $params[0] ),
394 htmlspecialchars( $params[0] )
395 );
396 $params[1] = $lang->timeanddate( $params[1] );
397 break;
398 default:
399 if( $title->getNamespace() == NS_SPECIAL ) {
400 list( $name, $par ) = SpecialPageFactory::resolveAlias( $title->getDBkey() );
401
402 # Use the language name for log titles, rather than Log/X
403 if( $name == 'Log' ) {
404 $titleLink = '(' . Linker::link( $title, LogPage::logName( $par ) ) . ')';
405 } else {
406 $titleLink = Linker::link( $title );
407 }
408 } else {
409 $titleLink = Linker::link( $title );
410 }
411 }
412
413 return $titleLink;
414 }
415
416 /**
417 * Add a log entry
418 *
419 * @param $action String: one of '', 'block', 'protect', 'rights', 'delete', 'upload', 'move', 'move_redir'
420 * @param $target Title object
421 * @param $comment String: description associated
422 * @param $params Array: parameters passed later to wfMsg.* functions
423 * @param $doer User object: the user doing the action
424 *
425 * @return bool|int|null
426 */
427 public function addEntry( $action, $target, $comment, $params = array(), $doer = null ) {
428 global $wgContLang;
429
430 if ( !is_array( $params ) ) {
431 $params = array( $params );
432 }
433
434 if ( $comment === null ) {
435 $comment = '';
436 }
437
438 # Truncate for whole multibyte characters.
439 $comment = $wgContLang->truncate( $comment, 255 );
440
441 $this->action = $action;
442 $this->target = $target;
443 $this->comment = $comment;
444 $this->params = LogPage::makeParamBlob( $params );
445
446 if ( $doer === null ) {
447 global $wgUser;
448 $doer = $wgUser;
449 } elseif ( !is_object( $doer ) ) {
450 $doer = User::newFromId( $doer );
451 }
452
453 $this->doer = $doer;
454
455 $this->actionText = LogPage::actionText( $this->type, $action, $target, null, $params );
456
457 return $this->saveContent();
458 }
459
460 /**
461 * Add relations to log_search table
462 *
463 * @param $field String
464 * @param $values Array
465 * @param $logid Integer
466 * @return Boolean
467 */
468 public function addRelations( $field, $values, $logid ) {
469 if( !strlen( $field ) || empty( $values ) ) {
470 return false; // nothing
471 }
472
473 $data = array();
474
475 foreach( $values as $value ) {
476 $data[] = array(
477 'ls_field' => $field,
478 'ls_value' => $value,
479 'ls_log_id' => $logid
480 );
481 }
482
483 $dbw = wfGetDB( DB_MASTER );
484 $dbw->insert( 'log_search', $data, __METHOD__, 'IGNORE' );
485
486 return true;
487 }
488
489 /**
490 * Create a blob from a parameter array
491 *
492 * @param $params Array
493 * @return String
494 */
495 public static function makeParamBlob( $params ) {
496 return implode( "\n", $params );
497 }
498
499 /**
500 * Extract a parameter array from a blob
501 *
502 * @param $blob String
503 * @return Array
504 */
505 public static function extractParams( $blob ) {
506 if ( $blob === '' ) {
507 return array();
508 } else {
509 return explode( "\n", $blob );
510 }
511 }
512
513 /**
514 * Convert a comma-delimited list of block log flags
515 * into a more readable (and translated) form
516 *
517 * @param $flags Flags to format
518 * @param $lang Language object to use
519 * @return String
520 */
521 public static function formatBlockFlags( $flags, $lang ) {
522 $flags = explode( ',', trim( $flags ) );
523
524 if( count( $flags ) > 0 ) {
525 for( $i = 0; $i < count( $flags ); $i++ ) {
526 $flags[$i] = self::formatBlockFlag( $flags[$i], $lang );
527 }
528 return '(' . $lang->commaList( $flags ) . ')';
529 } else {
530 return '';
531 }
532 }
533
534 /**
535 * Translate a block log flag if possible
536 *
537 * @param $flag int Flag to translate
538 * @param $lang Language object to use
539 * @return String
540 */
541 public static function formatBlockFlag( $flag, $lang ) {
542 static $messages = array();
543
544 if( !isset( $messages[$flag] ) ) {
545 $messages[$flag] = htmlspecialchars( $flag ); // Fallback
546
547 // For grepping. The following core messages can be used here:
548 // * block-log-flags-angry-autoblock
549 // * block-log-flags-anononly
550 // * block-log-flags-hiddenname
551 // * block-log-flags-noautoblock
552 // * block-log-flags-nocreate
553 // * block-log-flags-noemail
554 // * block-log-flags-nousertalk
555 $msg = wfMessage( 'block-log-flags-' . $flag )->inLanguage( $lang );
556
557 if ( $msg->exists() ) {
558 $messages[$flag] = $msg->escaped();
559 }
560 }
561
562 return $messages[$flag];
563 }
564
565
566 /**
567 * Name of the log.
568 * @return Message
569 * @since 1.19
570 */
571 public function getName() {
572 global $wgLogNames;
573
574 // BC
575 if ( isset( $wgLogNames[$this->type] ) ) {
576 $key = $wgLogNames[$this->type];
577 } else {
578 $key = 'log-name-' . $this->type;
579 }
580
581 return wfMessage( $key );
582 }
583
584 /**
585 * Description of this log type.
586 * @return Message
587 * @since 1.19
588 */
589 public function getDescription() {
590 global $wgLogHeaders;
591 // BC
592 if ( isset( $wgLogHeaders[$this->type] ) ) {
593 $key = $wgLogHeaders[$this->type];
594 } else {
595 $key = 'log-description-' . $this->type;
596 }
597 return wfMessage( $key );
598 }
599
600 /**
601 * Returns the right needed to read this log type.
602 * @return string
603 * @since 1.19
604 */
605 public function getRestriction() {
606 global $wgLogRestrictions;
607 if ( isset( $wgLogRestrictions[$this->type] ) ) {
608 $restriction = $wgLogRestrictions[$this->type];
609 } else {
610 // '' always returns true with $user->isAllowed()
611 $restriction = '';
612 }
613 return $restriction;
614 }
615
616 /**
617 * Tells if this log is not viewable by all.
618 * @return bool
619 * @since 1.19
620 */
621 public function isRestricted() {
622 $restriction = $this->getRestriction();
623 return $restriction !== '' && $restriction !== '*';
624 }
625
626 }