3 # Copyright (C) 2002, 2004 Brion Vibber <brion@pobox.com>
4 # http://www.mediawiki.org/
6 # This program is free software; you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 2 of the License, or
9 # (at your option) any later version.
11 # This program is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 # GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License along
17 # with this program; if not, write to the Free Software Foundation, Inc.,
18 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19 # 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 var $type, $action, $comment, $params, $target, $doer;
40 var $updateRecentChanges, $sendToUDP;
45 * @param string $type One of '', 'block', 'protect', 'rights', 'delete',
47 * @param bool $rc Whether to update recent changes as well as the logging table
48 * @param bool $udp Whether to send to the UDP feed if NOT sent to RC
50 public function __construct( $type, $rc = true, $udp = 'skipUDP' ) {
52 $this->updateRecentChanges
= $rc;
53 $this->sendToUDP
= ($udp == 'UDP');
56 protected function saveContent() {
57 global $wgLogRestrictions;
59 $dbw = wfGetDB( DB_MASTER
);
60 $log_id = $dbw->nextSequenceValue( 'log_log_id_seq' );
62 $this->timestamp
= $now = wfTimestampNow();
65 'log_type' => $this->type
,
66 'log_action' => $this->action
,
67 'log_timestamp' => $dbw->timestamp( $now ),
68 'log_user' => $this->doer
->getId(),
69 'log_namespace' => $this->target
->getNamespace(),
70 'log_title' => $this->target
->getDBkey(),
71 'log_comment' => $this->comment
,
72 'log_params' => $this->params
74 $dbw->insert( 'logging', $data, __METHOD__
);
75 $newId = !is_null($log_id) ?
$log_id : $dbw->insertId();
77 # And update recentchanges
78 if( $this->updateRecentChanges
) {
79 $titleObj = SpecialPage
::getTitleFor( 'Log', $this->type
);
80 RecentChange
::notifyLog( $now, $titleObj, $this->doer
, $this->getRcComment(), '', $this->type
,
81 $this->action
, $this->target
, $this->comment
, $this->params
, $newId );
82 } else if( $this->sendToUDP
) {
83 # Don't send private logs to UDP
84 if( isset($wgLogRestrictions[$this->type
]) && $wgLogRestrictions[$this->type
] !='*' ) {
87 # Notify external application via UDP.
88 # We send this to IRC but do not want to add it the RC table.
89 $titleObj = SpecialPage
::getTitleFor( 'Log', $this->type
);
90 $rc = RecentChange
::newLogEntry( $now, $titleObj, $this->doer
, $this->getRcComment(), '',
91 $this->type
, $this->action
, $this->target
, $this->comment
, $this->params
, $newId );
98 * Get the RC comment from the last addEntry() call
100 public function getRcComment() {
101 $rcComment = $this->actionText
;
102 if( '' != $this->comment
) {
103 if ($rcComment == '')
104 $rcComment = $this->comment
;
106 $rcComment .= wfMsgForContent( 'colon-separator' ) . $this->comment
;
112 * Get the comment from the last addEntry() call
114 public function getComment() {
115 return $this->comment
;
121 public static function validTypes() {
129 public static function isLogType( $type ) {
130 return in_array( $type, LogPage
::validTypes() );
136 public static function logName( $type ) {
137 global $wgLogNames, $wgMessageCache;
139 if( isset( $wgLogNames[$type] ) ) {
140 $wgMessageCache->loadAllMessages();
141 return str_replace( '_', ' ', wfMsg( $wgLogNames[$type] ) );
143 // Bogus log types? Perhaps an extension was removed.
149 * @todo handle missing log types
150 * @param string $type logtype
151 * @return string Headertext of this logtype
153 public static function logHeader( $type ) {
154 global $wgLogHeaders, $wgMessageCache;
155 $wgMessageCache->loadAllMessages();
156 return wfMsgExt($wgLogHeaders[$type],array('parseinline'));
161 * @return HTML string
163 public static function actionText( $type, $action, $title = NULL, $skin = NULL,
164 $params = array(), $filterWikilinks = false )
166 global $wgLang, $wgContLang, $wgLogActions, $wgMessageCache;
168 $wgMessageCache->loadAllMessages();
169 $key = "$type/$action";
170 # Defer patrol log to PatrolLog class
171 if( $key == 'patrol/patrol' ) {
172 return PatrolLog
::makeActionText( $title, $params, $skin );
174 if( isset( $wgLogActions[$key] ) ) {
175 if( is_null( $title ) ) {
176 $rv = wfMsg( $wgLogActions[$key] );
178 $titleLink = self
::getTitleLink( $type, $skin, $title, $params );
179 if( $key == 'rights/rights' ) {
181 $rightsnone = wfMsg( 'rightsnone' );
182 foreach ( $params as &$param ) {
183 $groupArray = array_map( 'trim', explode( ',', $param ) );
184 $groupArray = array_map( array( 'User', 'getGroupName' ), $groupArray );
185 $param = $wgLang->listToText( $groupArray );
188 $rightsnone = wfMsgForContent( 'rightsnone' );
190 if( !isset( $params[0] ) ||
trim( $params[0] ) == '' )
191 $params[0] = $rightsnone;
192 if( !isset( $params[1] ) ||
trim( $params[1] ) == '' )
193 $params[1] = $rightsnone;
195 if( count( $params ) == 0 ) {
197 $rv = wfMsg( $wgLogActions[$key], $titleLink );
199 $rv = wfMsgForContent( $wgLogActions[$key], $titleLink );
203 array_unshift( $params, $titleLink );
205 if ( preg_match( '/^(block|suppress)\/(block|reblock)$/', $key ) ) {
207 $params[1] = '<span title="' . htmlspecialchars( $params[1] ). '">' .
208 $wgLang->translateBlockExpiry( $params[1] ) . '</span>';
210 $params[1] = $wgContLang->translateBlockExpiry( $params[1] );
212 $params[2] = isset( $params[2] ) ?
213 self
::formatBlockFlags( $params[2], is_null( $skin ) ) : '';
215 } else if ( $type == 'protect' && count($params) == 3 ) {
216 $details .= " {$params[1]}"; // restrictions and expiries
219 $details .= ' ['.wfMsg('protect-summary-cascade').']';
221 $details .= ' ['.wfMsgForContent('protect-summary-cascade').']';
225 } else if ( $type == 'move' && count( $params ) == 3 ) {
228 $details .= ' [' . wfMsg( 'move-redirect-suppressed' ) . ']';
230 $details .= ' [' . wfMsgForContent( 'move-redirect-suppressed' ) . ']';
234 } else if ( preg_match( '/^(delete|suppress)\/revision$/', $key ) && count( $params ) == 5 ) {
235 $count = substr_count( $params[2], ',' ) +
1; // revisions
236 $ofield = intval( substr( $params[3], 7 ) ); // <ofield=x>
237 $nfield = intval( substr( $params[4], 7 ) ); // <nfield=x>
238 $details .= ': '.RevisionDeleter
::getLogMessage( $count, $nfield, $ofield, false );
240 } else if ( preg_match( '/^(delete|suppress)\/event$/', $key ) && count( $params ) == 4 ) {
241 $count = substr_count( $params[1], ',' ) +
1; // log items
242 $ofield = intval( substr( $params[2], 7 ) ); // <ofield=x>
243 $nfield = intval( substr( $params[3], 7 ) ); // <nfield=x>
244 $details .= ': '.RevisionDeleter
::getLogMessage( $count, $nfield, $ofield, true );
246 $rv = wfMsgReal( $wgLogActions[$key], $params, true, !$skin ) . $details;
250 global $wgLogActionsHandlers;
251 if( isset( $wgLogActionsHandlers[$key] ) ) {
252 $args = func_get_args();
253 $rv = call_user_func_array( $wgLogActionsHandlers[$key], $args );
255 wfDebug( "LogPage::actionText - unknown action $key\n" );
260 // For the perplexed, this feature was added in r7855 by Erik.
261 // The feature was added because we liked adding [[$1]] in our log entries
262 // but the log entries are parsed as Wikitext on RecentChanges but as HTML
263 // on Special:Log. The hack is essentially that [[$1]] represented a link
264 // to the title in question. The first parameter to the HTML version (Special:Log)
265 // is that link in HTML form, and so this just gets rid of the ugly [[]].
266 // However, this is a horrible hack and it doesn't work like you expect if, say,
267 // you want to link to something OTHER than the title of the log entry.
268 // The real problem, which Erik was trying to fix (and it sort-of works now) is
269 // that the same messages are being treated as both wikitext *and* HTML.
270 if( $filterWikilinks ) {
271 $rv = str_replace( "[[", "", $rv );
272 $rv = str_replace( "]]", "", $rv );
277 protected static function getTitleLink( $type, $skin, $title, &$params ) {
278 global $wgLang, $wgContLang;
280 return $title->getPrefixedText();
284 $titleLink = $skin->makeLinkObj( $title,
285 htmlspecialchars( $title->getPrefixedText() ), 'redirect=no' );
286 $targetTitle = Title
::newFromText( $params[0] );
287 if ( !$targetTitle ) {
288 # Workaround for broken database
289 $params[0] = htmlspecialchars( $params[0] );
291 $params[0] = $skin->makeLinkObj( $targetTitle, htmlspecialchars( $params[0] ) );
295 if( substr( $title->getText(), 0, 1 ) == '#' ) {
296 $titleLink = $title->getText();
298 // TODO: Store the user identifier in the parameters
299 // to make this faster for future log entries
300 $id = User
::idFromName( $title->getText() );
301 $titleLink = $skin->userLink( $id, $title->getText() )
302 . $skin->userToolLinks( $id, $title->getText(), false, Linker
::TOOL_LINKS_NOBLOCK
);
306 $text = $wgContLang->ucfirst( $title->getText() );
307 $titleLink = $skin->makeLinkObj( Title
::makeTitle( NS_USER
, $text ) );
310 $titleLink = $skin->makeLinkObj( $title, $title->getPrefixedText(), 'redirect=no' );
311 $params[0] = $skin->makeLinkObj( Title
::newFromText( $params[0] ), htmlspecialchars( $params[0] ) );
312 $params[1] = $wgLang->timeanddate( $params[1] );
315 if( $title->getNamespace() == NS_SPECIAL
) {
316 list( $name, $par ) = SpecialPage
::resolveAliasWithSubpage( $title->getDBKey() );
317 # Use the language name for log titles, rather than Log/X
318 if( $name == 'Log' ) {
319 $titleLink = '('.$skin->makeLinkObj( $title, LogPage
::logName( $par ) ).')';
321 $titleLink = $skin->makeLinkObj( $title );
324 $titleLink = $skin->makeLinkObj( $title );
332 * @param string $action one of '', 'block', 'protect', 'rights', 'delete', 'upload', 'move', 'move_redir'
333 * @param object &$target A title object.
334 * @param string $comment Description associated
335 * @param array $params Parameters passed later to wfMsg.* functions
336 * @param User $doer The user doing the action
338 public function addEntry( $action, $target, $comment, $params = array(), $doer = null ) {
339 if ( !is_array( $params ) ) {
340 $params = array( $params );
343 $this->action
= $action;
344 $this->target
= $target;
345 $this->comment
= $comment;
346 $this->params
= LogPage
::makeParamBlob( $params );
348 if ($doer === null) {
351 } elseif (!is_object( $doer ) ) {
352 $doer = User
::newFromId( $doer );
357 $this->actionText
= LogPage
::actionText( $this->type
, $action, $target, NULL, $params );
359 return $this->saveContent();
363 * Create a blob from a parameter array
366 public static function makeParamBlob( $params ) {
367 return implode( "\n", $params );
371 * Extract a parameter array from a blob
374 public static function extractParams( $blob ) {
375 if ( $blob === '' ) {
378 return explode( "\n", $blob );
383 * Convert a comma-delimited list of block log flags
384 * into a more readable (and translated) form
386 * @param $flags Flags to format
387 * @param $forContent Whether to localize the message depending of the user
391 public static function formatBlockFlags( $flags, $forContent = false ) {
394 $flags = explode( ',', trim( $flags ) );
395 if( count( $flags ) > 0 ) {
396 for( $i = 0; $i < count( $flags ); $i++
)
397 $flags[$i] = self
::formatBlockFlag( $flags[$i], $forContent );
398 return '(' . $wgLang->commaList( $flags ) . ')';
405 * Translate a block log flag if possible
407 * @param $flag Flag to translate
408 * @param $forContent Whether to localize the message depending of the user
412 public static function formatBlockFlag( $flag, $forContent = false ) {
413 static $messages = array();
414 if( !isset( $messages[$flag] ) ) {
415 $k = 'block-log-flags-' . $flag;
417 $msg = wfMsgForContent( $k );
420 $messages[$flag] = htmlspecialchars( wfEmptyMsg( $k, $msg ) ?
$flag : $msg );
422 return $messages[$flag];
427 * Aliases for backwards compatibility with 1.6
429 define( 'MW_LOG_DELETED_ACTION', LogPage
::DELETED_ACTION
);
430 define( 'MW_LOG_DELETED_USER', LogPage
::DELETED_USER
);
431 define( 'MW_LOG_DELETED_COMMENT', LogPage
::DELETED_COMMENT
);
432 define( 'MW_LOG_DELETED_RESTRICTED', LogPage
::DELETED_RESTRICTED
);