5 * Copyright © 2002, 2004 Brion Vibber <brion@pobox.com>
6 * http://www.mediawiki.org/
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.
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.
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
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.
33 const DELETED_ACTION
= 1;
34 const DELETED_COMMENT
= 2;
35 const DELETED_USER
= 4;
36 const DELETED_RESTRICTED
= 8;
38 const SUPPRESSED_USER
= 12;
39 const SUPPRESSED_ACTION
= 9;
41 var $type, $action, $comment, $params;
54 var $updateRecentChanges, $sendToUDP;
59 * @param $type String: one of '', 'block', 'protect', 'rights', 'delete',
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
64 public function __construct( $type, $rc = true, $udp = 'skipUDP' ) {
66 $this->updateRecentChanges
= $rc;
67 $this->sendToUDP
= ( $udp == 'UDP' );
71 * @return bool|int|null
73 protected function saveContent() {
74 global $wgLogRestrictions;
76 $dbw = wfGetDB( DB_MASTER
);
77 $log_id = $dbw->nextSequenceValue( 'logging_log_id_seq' );
79 $this->timestamp
= $now = wfTimestampNow();
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
93 $dbw->insert( 'logging', $data, __METHOD__
);
94 $newId = !is_null( $log_id ) ?
$log_id : $dbw->insertId();
96 # And update recentchanges
97 if( $this->updateRecentChanges
) {
98 $titleObj = SpecialPage
::getTitleFor( 'Log', $this->type
);
100 RecentChange
::notifyLog(
101 $now, $titleObj, $this->doer
, $this->getRcComment(), '',
102 $this->type
, $this->action
, $this->target
, $this->comment
,
103 $this->params
, $newId
105 } elseif( $this->sendToUDP
) {
106 # Don't send private logs to UDP
107 if( isset( $wgLogRestrictions[$this->type
] ) && $wgLogRestrictions[$this->type
] != '*' ) {
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
125 * Get the RC comment from the last addEntry() call
129 public function getRcComment() {
130 $rcComment = $this->actionText
;
132 if( $this->comment
!= '' ) {
133 if ( $rcComment == '' ) {
134 $rcComment = $this->comment
;
136 $rcComment .= wfMsgForContent( 'colon-separator' ) . $this->comment
;
144 * Get the comment from the last addEntry() call
146 public function getComment() {
147 return $this->comment
;
151 * Get the list of valid log types
153 * @return Array of strings
155 public static function validTypes() {
161 * Is $type a valid log type
163 * @param $type String: log type to check
166 public static function isLogType( $type ) {
167 return in_array( $type, LogPage
::validTypes() );
171 * Get the name for the given log type
173 * @param $type String: logtype
174 * @return String: log name
175 * @deprecated in 1.19, warnings in 1.21. Use getName()
177 public static function logName( $type ) {
180 if( isset( $wgLogNames[$type] ) ) {
181 return str_replace( '_', ' ', wfMsg( $wgLogNames[$type] ) );
183 // Bogus log types? Perhaps an extension was removed.
189 * Get the log header for the given log type
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()
196 public static function logHeader( $type ) {
197 global $wgLogHeaders;
198 return wfMsgExt( $wgLogHeaders[$type], array( 'parseinline' ) );
202 * Generate text for a log entry
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
213 public static function actionText( $type, $action, $title = null, $skin = null,
214 $params = array(), $filterWikilinks = false )
216 global $wgLang, $wgContLang, $wgLogActions;
218 if ( is_null( $skin ) ) {
219 $langObj = $wgContLang;
220 $langObjOrNull = null;
223 $langObjOrNull = $wgLang;
226 $key = "$type/$action";
228 # Defer patrol log to PatrolLog class
229 if( $key == 'patrol/patrol' ) {
230 return PatrolLog
::makeActionText( $title, $params, $langObjOrNull );
233 if( isset( $wgLogActions[$key] ) ) {
234 if( is_null( $title ) ) {
235 $rv = wfMsgExt( $wgLogActions[$key], array( 'parsemag', 'escape', 'language' => $langObj ) );
237 $titleLink = self
::getTitleLink( $type, $langObjOrNull, $title, $params );
239 if( preg_match( '/^rights\/(rights|autopromote)/', $key ) ) {
240 $rightsnone = wfMsgExt( 'rightsnone', array( 'parsemag', 'language' => $langObj ) );
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 );
250 if( !isset( $params[0] ) ||
trim( $params[0] ) == '' ) {
251 $params[0] = $rightsnone;
254 if( !isset( $params[1] ) ||
trim( $params[1] ) == '' ) {
255 $params[1] = $rightsnone;
259 if( count( $params ) == 0 ) {
260 $rv = wfMsgExt( $wgLogActions[$key], array( 'parsemag', 'escape', 'replaceafter', 'language' => $langObj ), $titleLink );
263 array_unshift( $params, $titleLink );
266 if ( preg_match( '/^(block|suppress)\/(block|reblock)$/', $key ) ) {
268 $params[1] = '<span class="blockExpiry" dir="ltr" title="' . htmlspecialchars( $params[1] ). '">' .
269 $wgLang->translateBlockExpiry( $params[1] ) . '</span>';
271 $params[1] = $wgContLang->translateBlockExpiry( $params[1] );
274 $params[2] = isset( $params[2] ) ?
275 self
::formatBlockFlags( $params[2], $langObj ) : '';
277 } elseif ( $type == 'protect' && count($params) == 3 ) {
278 // Restrictions and expiries
280 $details .= $wgLang->getDirMark() . htmlspecialchars( " {$params[1]}" );
282 $details .= " {$params[1]}";
287 $details .= ' [' . wfMsgExt( 'protect-summary-cascade', array( 'parsemag', 'language' => $langObj ) ) . ']';
290 } elseif ( $type == 'move' && count( $params ) == 3 ) {
292 $details .= ' [' . wfMsgExt( 'move-redirect-suppressed', array( 'parsemag', 'language' => $langObj ) ) . ']';
295 } elseif ( preg_match( '/^(delete|suppress)\/revision$/', $key ) && count( $params ) == 5 ) {
296 $count = substr_count( $params[2], ',' ) +
1; // revisions
297 $ofield = intval( substr( $params[3], 7 ) ); // <ofield=x>
298 $nfield = intval( substr( $params[4], 7 ) ); // <nfield=x>
299 $details .= ': ' . RevisionDeleter
::getLogMessage( $count, $nfield, $ofield, $langObj, false );
301 } elseif ( preg_match( '/^(delete|suppress)\/event$/', $key ) && count( $params ) == 4 ) {
302 $count = substr_count( $params[1], ',' ) +
1; // log items
303 $ofield = intval( substr( $params[2], 7 ) ); // <ofield=x>
304 $nfield = intval( substr( $params[3], 7 ) ); // <nfield=x>
305 $details .= ': ' . RevisionDeleter
::getLogMessage( $count, $nfield, $ofield, $langObj, true );
308 $rv = wfMsgExt( $wgLogActions[$key], array( 'parsemag', 'escape', 'replaceafter', 'language' => $langObj ), $params ) . $details;
312 global $wgLogActionsHandlers;
314 if( isset( $wgLogActionsHandlers[$key] ) ) {
315 $args = func_get_args();
316 $rv = call_user_func_array( $wgLogActionsHandlers[$key], $args );
318 wfDebug( "LogPage::actionText - unknown action $key\n" );
323 // For the perplexed, this feature was added in r7855 by Erik.
324 // The feature was added because we liked adding [[$1]] in our log entries
325 // but the log entries are parsed as Wikitext on RecentChanges but as HTML
326 // on Special:Log. The hack is essentially that [[$1]] represented a link
327 // to the title in question. The first parameter to the HTML version (Special:Log)
328 // is that link in HTML form, and so this just gets rid of the ugly [[]].
329 // However, this is a horrible hack and it doesn't work like you expect if, say,
330 // you want to link to something OTHER than the title of the log entry.
331 // The real problem, which Erik was trying to fix (and it sort-of works now) is
332 // that the same messages are being treated as both wikitext *and* HTML.
333 if( $filterWikilinks ) {
334 $rv = str_replace( '[[', '', $rv );
335 $rv = str_replace( ']]', '', $rv );
343 * @param $type String
344 * @param $lang Language or null
345 * @param $title Title
346 * @param $params Array
349 protected static function getTitleLink( $type, $lang, $title, &$params ) {
350 global $wgContLang, $wgUserrightsInterwikiDelimiter;
353 return $title->getPrefixedText();
358 $titleLink = Linker
::link(
360 htmlspecialchars( $title->getPrefixedText() ),
362 array( 'redirect' => 'no' )
365 $targetTitle = Title
::newFromText( $params[0] );
367 if ( !$targetTitle ) {
368 # Workaround for broken database
369 $params[0] = htmlspecialchars( $params[0] );
371 $params[0] = Linker
::link(
373 htmlspecialchars( $params[0] )
378 if( substr( $title->getText(), 0, 1 ) == '#' ) {
379 $titleLink = $title->getText();
381 // @todo Store the user identifier in the parameters
382 // to make this faster for future log entries
383 $id = User
::idFromName( $title->getText() );
384 $titleLink = Linker
::userLink( $id, $title->getText() )
385 . Linker
::userToolLinks( $id, $title->getText(), false, Linker
::TOOL_LINKS_NOBLOCK
);
389 $text = $wgContLang->ucfirst( $title->getText() );
390 $parts = explode( $wgUserrightsInterwikiDelimiter, $text, 2 );
392 if ( count( $parts ) == 2 ) {
393 $titleLink = WikiMap
::foreignUserLink( $parts[1], $parts[0],
394 htmlspecialchars( $title->getPrefixedText() ) );
396 if ( $titleLink !== false ) {
400 $titleLink = Linker
::link( Title
::makeTitle( NS_USER
, $text ) );
403 $titleLink = Linker
::link(
405 $title->getPrefixedText(),
407 array( 'redirect' => 'no' )
409 $params[0] = Linker
::link(
410 Title
::newFromText( $params[0] ),
411 htmlspecialchars( $params[0] )
413 $params[1] = $lang->timeanddate( $params[1] );
416 if( $title->getNamespace() == NS_SPECIAL
) {
417 list( $name, $par ) = SpecialPageFactory
::resolveAlias( $title->getDBkey() );
419 # Use the language name for log titles, rather than Log/X
420 if( $name == 'Log' ) {
421 $titleLink = '(' . Linker
::link( $title, LogPage
::logName( $par ) ) . ')';
423 $titleLink = Linker
::link( $title );
426 $titleLink = Linker
::link( $title );
436 * @param $action String: one of '', 'block', 'protect', 'rights', 'delete', 'upload', 'move', 'move_redir'
437 * @param $target Title object
438 * @param $comment String: description associated
439 * @param $params Array: parameters passed later to wfMsg.* functions
440 * @param $doer User object: the user doing the action
442 * @return bool|int|null
444 public function addEntry( $action, $target, $comment, $params = array(), $doer = null ) {
447 if ( !is_array( $params ) ) {
448 $params = array( $params );
451 if ( $comment === null ) {
455 # Truncate for whole multibyte characters.
456 $comment = $wgContLang->truncate( $comment, 255 );
458 $this->action
= $action;
459 $this->target
= $target;
460 $this->comment
= $comment;
461 $this->params
= LogPage
::makeParamBlob( $params );
463 if ( $doer === null ) {
466 } elseif ( !is_object( $doer ) ) {
467 $doer = User
::newFromId( $doer );
472 $this->actionText
= LogPage
::actionText( $this->type
, $action, $target, null, $params );
474 return $this->saveContent();
478 * Add relations to log_search table
480 * @param $field String
481 * @param $values Array
482 * @param $logid Integer
485 public function addRelations( $field, $values, $logid ) {
486 if( !strlen( $field ) ||
empty( $values ) ) {
487 return false; // nothing
492 foreach( $values as $value ) {
494 'ls_field' => $field,
495 'ls_value' => $value,
496 'ls_log_id' => $logid
500 $dbw = wfGetDB( DB_MASTER
);
501 $dbw->insert( 'log_search', $data, __METHOD__
, 'IGNORE' );
507 * Create a blob from a parameter array
509 * @param $params Array
512 public static function makeParamBlob( $params ) {
513 return implode( "\n", $params );
517 * Extract a parameter array from a blob
519 * @param $blob String
522 public static function extractParams( $blob ) {
523 if ( $blob === '' ) {
526 return explode( "\n", $blob );
531 * Convert a comma-delimited list of block log flags
532 * into a more readable (and translated) form
534 * @param $flags Flags to format
535 * @param $lang Language object to use
538 public static function formatBlockFlags( $flags, $lang ) {
539 $flags = explode( ',', trim( $flags ) );
541 if( count( $flags ) > 0 ) {
542 for( $i = 0; $i < count( $flags ); $i++
) {
543 $flags[$i] = self
::formatBlockFlag( $flags[$i], $lang );
545 return '(' . $lang->commaList( $flags ) . ')';
552 * Translate a block log flag if possible
554 * @param $flag int Flag to translate
555 * @param $lang Language object to use
558 public static function formatBlockFlag( $flag, $lang ) {
559 static $messages = array();
561 if( !isset( $messages[$flag] ) ) {
562 $messages[$flag] = htmlspecialchars( $flag ); // Fallback
564 // For grepping. The following core messages can be used here:
565 // * block-log-flags-angry-autoblock
566 // * block-log-flags-anononly
567 // * block-log-flags-hiddenname
568 // * block-log-flags-noautoblock
569 // * block-log-flags-nocreate
570 // * block-log-flags-noemail
571 // * block-log-flags-nousertalk
572 $msg = wfMessage( 'block-log-flags-' . $flag )->inLanguage( $lang );
574 if ( $msg->exists() ) {
575 $messages[$flag] = $msg->escaped();
579 return $messages[$flag];
588 public function getName() {
592 if ( isset( $wgLogNames[$this->type
] ) ) {
593 $key = $wgLogNames[$this->type
];
595 $key = 'log-name-' . $this->type
;
598 return wfMessage( $key );
602 * Description of this log type.
606 public function getDescription() {
607 global $wgLogHeaders;
609 if ( isset( $wgLogHeaders[$this->type
] ) ) {
610 $key = $wgLogHeaders[$this->type
];
612 $key = 'log-description-' . $this->type
;
614 return wfMessage( $key );
618 * Returns the right needed to read this log type.
622 public function getRestriction() {
623 global $wgLogRestrictions;
624 if ( isset( $wgLogRestrictions[$this->type
] ) ) {
625 $restriction = $wgLogRestrictions[$this->type
];
627 // '' always returns true with $user->isAllowed()
634 * Tells if this log is not viewable by all.
638 public function isRestricted() {
639 $restriction = $this->getRestriction();
640 return $restriction !== '' && $restriction !== '*';