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
176 public static function logName( $type ) {
179 if( isset( $wgLogNames[$type] ) ) {
180 return str_replace( '_', ' ', wfMsg( $wgLogNames[$type] ) );
182 // Bogus log types? Perhaps an extension was removed.
188 * Get the log header for the given log type
190 * @todo handle missing log types
191 * @param $type String: logtype
192 * @return String: headertext of this logtype
194 public static function logHeader( $type ) {
195 global $wgLogHeaders;
196 return wfMsgExt( $wgLogHeaders[$type], array( 'parseinline' ) );
200 * Generate text for a log entry
202 * @param $type String: log type
203 * @param $action String: log action
204 * @param $title Mixed: Title object or null
205 * @param $skin Mixed: Skin object or null. If null, we want to use the wiki
206 * content language, since that will go to the IRC feed.
207 * @param $params Array: parameters
208 * @param $filterWikilinks Boolean: whether to filter wiki links
209 * @return HTML string
211 public static function actionText( $type, $action, $title = null, $skin = null,
212 $params = array(), $filterWikilinks = false )
214 global $wgLang, $wgContLang, $wgLogActions;
216 if ( is_null( $skin ) ) {
217 $langObj = $wgContLang;
218 $langObjOrNull = null;
221 $langObjOrNull = $wgLang;
224 $key = "$type/$action";
226 # Defer patrol log to PatrolLog class
227 if( $key == 'patrol/patrol' ) {
228 return PatrolLog
::makeActionText( $title, $params, $langObjOrNull );
231 if( isset( $wgLogActions[$key] ) ) {
232 if( is_null( $title ) ) {
233 $rv = wfMsgExt( $wgLogActions[$key], array( 'parsemag', 'escape', 'language' => $langObj ) );
235 $titleLink = self
::getTitleLink( $type, $langObjOrNull, $title, $params );
237 if( preg_match( '/^rights\/(rights|autopromote)/', $key ) ) {
238 $rightsnone = wfMsgExt( 'rightsnone', array( 'parsemag', 'language' => $langObj ) );
241 foreach ( $params as &$param ) {
242 $groupArray = array_map( 'trim', explode( ',', $param ) );
243 $groupArray = array_map( array( 'User', 'getGroupMember' ), $groupArray );
244 $param = $wgLang->listToText( $groupArray );
248 if( !isset( $params[0] ) ||
trim( $params[0] ) == '' ) {
249 $params[0] = $rightsnone;
252 if( !isset( $params[1] ) ||
trim( $params[1] ) == '' ) {
253 $params[1] = $rightsnone;
257 if( count( $params ) == 0 ) {
258 $rv = wfMsgExt( $wgLogActions[$key], array( 'parsemag', 'escape', 'replaceafter', 'language' => $langObj ), $titleLink );
261 array_unshift( $params, $titleLink );
264 if ( preg_match( '/^(block|suppress)\/(block|reblock)$/', $key ) ) {
266 $params[1] = '<span class="blockExpiry" dir="ltr" title="' . htmlspecialchars( $params[1] ). '">' .
267 $wgLang->translateBlockExpiry( $params[1] ) . '</span>';
269 $params[1] = $wgContLang->translateBlockExpiry( $params[1] );
272 $params[2] = isset( $params[2] ) ?
273 self
::formatBlockFlags( $params[2], $langObj ) : '';
275 } elseif ( $type == 'protect' && count($params) == 3 ) {
276 // Restrictions and expiries
278 $details .= $wgLang->getDirMark() . htmlspecialchars( " {$params[1]}" );
280 $details .= " {$params[1]}";
285 $details .= ' [' . wfMsgExt( 'protect-summary-cascade', array( 'parsemag', 'language' => $langObj ) ) . ']';
288 } elseif ( $type == 'move' && count( $params ) == 3 ) {
290 $details .= ' [' . wfMsgExt( 'move-redirect-suppressed', array( 'parsemag', 'language' => $langObj ) ) . ']';
293 } elseif ( preg_match( '/^(delete|suppress)\/revision$/', $key ) && count( $params ) == 5 ) {
294 $count = substr_count( $params[2], ',' ) +
1; // revisions
295 $ofield = intval( substr( $params[3], 7 ) ); // <ofield=x>
296 $nfield = intval( substr( $params[4], 7 ) ); // <nfield=x>
297 $details .= ': ' . RevisionDeleter
::getLogMessage( $count, $nfield, $ofield, $langObj, false );
299 } elseif ( preg_match( '/^(delete|suppress)\/event$/', $key ) && count( $params ) == 4 ) {
300 $count = substr_count( $params[1], ',' ) +
1; // log items
301 $ofield = intval( substr( $params[2], 7 ) ); // <ofield=x>
302 $nfield = intval( substr( $params[3], 7 ) ); // <nfield=x>
303 $details .= ': ' . RevisionDeleter
::getLogMessage( $count, $nfield, $ofield, $langObj, true );
306 $rv = wfMsgExt( $wgLogActions[$key], array( 'parsemag', 'escape', 'replaceafter', 'language' => $langObj ), $params ) . $details;
310 global $wgLogActionsHandlers;
312 if( isset( $wgLogActionsHandlers[$key] ) ) {
313 $args = func_get_args();
314 $rv = call_user_func_array( $wgLogActionsHandlers[$key], $args );
316 wfDebug( "LogPage::actionText - unknown action $key\n" );
321 // For the perplexed, this feature was added in r7855 by Erik.
322 // The feature was added because we liked adding [[$1]] in our log entries
323 // but the log entries are parsed as Wikitext on RecentChanges but as HTML
324 // on Special:Log. The hack is essentially that [[$1]] represented a link
325 // to the title in question. The first parameter to the HTML version (Special:Log)
326 // is that link in HTML form, and so this just gets rid of the ugly [[]].
327 // However, this is a horrible hack and it doesn't work like you expect if, say,
328 // you want to link to something OTHER than the title of the log entry.
329 // The real problem, which Erik was trying to fix (and it sort-of works now) is
330 // that the same messages are being treated as both wikitext *and* HTML.
331 if( $filterWikilinks ) {
332 $rv = str_replace( '[[', '', $rv );
333 $rv = str_replace( ']]', '', $rv );
341 * @param $type String
342 * @param $lang Language or null
343 * @param $title Title
344 * @param $params Array
347 protected static function getTitleLink( $type, $lang, $title, &$params ) {
348 global $wgContLang, $wgUserrightsInterwikiDelimiter;
351 return $title->getPrefixedText();
356 $titleLink = Linker
::link(
358 htmlspecialchars( $title->getPrefixedText() ),
360 array( 'redirect' => 'no' )
363 $targetTitle = Title
::newFromText( $params[0] );
365 if ( !$targetTitle ) {
366 # Workaround for broken database
367 $params[0] = htmlspecialchars( $params[0] );
369 $params[0] = Linker
::link(
371 htmlspecialchars( $params[0] )
376 if( substr( $title->getText(), 0, 1 ) == '#' ) {
377 $titleLink = $title->getText();
379 // @todo Store the user identifier in the parameters
380 // to make this faster for future log entries
381 $id = User
::idFromName( $title->getText() );
382 $titleLink = Linker
::userLink( $id, $title->getText() )
383 . Linker
::userToolLinks( $id, $title->getText(), false, Linker
::TOOL_LINKS_NOBLOCK
);
387 $text = $wgContLang->ucfirst( $title->getText() );
388 $parts = explode( $wgUserrightsInterwikiDelimiter, $text, 2 );
390 if ( count( $parts ) == 2 ) {
391 $titleLink = WikiMap
::foreignUserLink( $parts[1], $parts[0],
392 htmlspecialchars( $title->getPrefixedText() ) );
394 if ( $titleLink !== false ) {
398 $titleLink = Linker
::link( Title
::makeTitle( NS_USER
, $text ) );
401 $titleLink = Linker
::link(
403 $title->getPrefixedText(),
405 array( 'redirect' => 'no' )
407 $params[0] = Linker
::link(
408 Title
::newFromText( $params[0] ),
409 htmlspecialchars( $params[0] )
411 $params[1] = $lang->timeanddate( $params[1] );
414 if( $title->getNamespace() == NS_SPECIAL
) {
415 list( $name, $par ) = SpecialPageFactory
::resolveAlias( $title->getDBkey() );
417 # Use the language name for log titles, rather than Log/X
418 if( $name == 'Log' ) {
419 $titleLink = '(' . Linker
::link( $title, LogPage
::logName( $par ) ) . ')';
421 $titleLink = Linker
::link( $title );
424 $titleLink = Linker
::link( $title );
434 * @param $action String: one of '', 'block', 'protect', 'rights', 'delete', 'upload', 'move', 'move_redir'
435 * @param $target Title object
436 * @param $comment String: description associated
437 * @param $params Array: parameters passed later to wfMsg.* functions
438 * @param $doer User object: the user doing the action
440 * @return bool|int|null
442 public function addEntry( $action, $target, $comment, $params = array(), $doer = null ) {
445 if ( !is_array( $params ) ) {
446 $params = array( $params );
449 if ( $comment === null ) {
453 # Truncate for whole multibyte characters.
454 $comment = $wgContLang->truncate( $comment, 255 );
456 $this->action
= $action;
457 $this->target
= $target;
458 $this->comment
= $comment;
459 $this->params
= LogPage
::makeParamBlob( $params );
461 if ( $doer === null ) {
464 } elseif ( !is_object( $doer ) ) {
465 $doer = User
::newFromId( $doer );
470 $this->actionText
= LogPage
::actionText( $this->type
, $action, $target, null, $params );
472 return $this->saveContent();
476 * Add relations to log_search table
478 * @param $field String
479 * @param $values Array
480 * @param $logid Integer
483 public function addRelations( $field, $values, $logid ) {
484 if( !strlen( $field ) ||
empty( $values ) ) {
485 return false; // nothing
490 foreach( $values as $value ) {
492 'ls_field' => $field,
493 'ls_value' => $value,
494 'ls_log_id' => $logid
498 $dbw = wfGetDB( DB_MASTER
);
499 $dbw->insert( 'log_search', $data, __METHOD__
, 'IGNORE' );
505 * Create a blob from a parameter array
507 * @param $params Array
510 public static function makeParamBlob( $params ) {
511 return implode( "\n", $params );
515 * Extract a parameter array from a blob
517 * @param $blob String
520 public static function extractParams( $blob ) {
521 if ( $blob === '' ) {
524 return explode( "\n", $blob );
529 * Convert a comma-delimited list of block log flags
530 * into a more readable (and translated) form
532 * @param $flags Flags to format
533 * @param $lang Language object to use
536 public static function formatBlockFlags( $flags, $lang ) {
537 $flags = explode( ',', trim( $flags ) );
539 if( count( $flags ) > 0 ) {
540 for( $i = 0; $i < count( $flags ); $i++
) {
541 $flags[$i] = self
::formatBlockFlag( $flags[$i], $lang );
543 return '(' . $lang->commaList( $flags ) . ')';
550 * Translate a block log flag if possible
552 * @param $flag int Flag to translate
553 * @param $lang Language object to use
556 public static function formatBlockFlag( $flag, $lang ) {
557 static $messages = array();
559 if( !isset( $messages[$flag] ) ) {
560 $messages[$flag] = htmlspecialchars( $flag ); // Fallback
562 // For grepping. The following core messages can be used here:
563 // * block-log-flags-angry-autoblock
564 // * block-log-flags-anononly
565 // * block-log-flags-hiddenname
566 // * block-log-flags-noautoblock
567 // * block-log-flags-nocreate
568 // * block-log-flags-noemail
569 // * block-log-flags-nousertalk
570 $msg = wfMessage( 'block-log-flags-' . $flag )->inLanguage( $lang );
572 if ( $msg->exists() ) {
573 $messages[$flag] = $msg->escaped();
577 return $messages[$flag];
582 * Aliases for backwards compatibility with 1.6
584 define( 'MW_LOG_DELETED_ACTION', LogPage
::DELETED_ACTION
);
585 define( 'MW_LOG_DELETED_USER', LogPage
::DELETED_USER
);
586 define( 'MW_LOG_DELETED_COMMENT', LogPage
::DELETED_COMMENT
);
587 define( 'MW_LOG_DELETED_RESTRICTED', LogPage
::DELETED_RESTRICTED
);