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;
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
49 function __construct( $type, $rc = true ) {
51 $this->updateRecentChanges
= $rc;
54 protected function saveContent() {
55 global $wgUser, $wgLogRestrictions;
56 $fname = 'LogPage::saveContent';
58 $dbw = wfGetDB( DB_MASTER
);
59 $log_id = $dbw->nextSequenceValue( 'log_log_id_seq' );
61 $this->timestamp
= $now = wfTimestampNow();
64 'log_type' => $this->type
,
65 'log_action' => $this->action
,
66 'log_timestamp' => $dbw->timestamp( $now ),
67 'log_user' => $this->doer
->getId(),
68 'log_namespace' => $this->target
->getNamespace(),
69 'log_title' => $this->target
->getDBkey(),
70 'log_comment' => $this->comment
,
71 'log_params' => $this->params
73 $dbw->insert( 'logging', $data, $fname );
74 $newId = !is_null($log_id) ?
$log_id : $dbw->insertId();
76 if( !($dbw->affectedRows() > 0) ) {
77 wfDebugLog( "logging", "LogPage::saveContent failed to insert row - Error {$dbw->lastErrno()}: {$dbw->lastError()}" );
79 # And update recentchanges
80 if( $this->updateRecentChanges
) {
81 # Don't add private logs to RC!
82 if( !isset($wgLogRestrictions[$this->type
]) ||
$wgLogRestrictions[$this->type
]=='*' ) {
83 $titleObj = SpecialPage
::getTitleFor( 'Log', $this->type
);
84 $rcComment = $this->getRcComment();
85 RecentChange
::notifyLog( $now, $titleObj, $this->doer
, $rcComment, '',
86 $this->type
, $this->action
, $this->target
, $this->comment
, $this->params
, $newId );
93 * Get the RC comment from the last addEntry() call
95 public function getRcComment() {
96 $rcComment = $this->actionText
;
97 if( '' != $this->comment
) {
99 $rcComment = $this->comment
;
101 $rcComment .= ': ' . $this->comment
;
107 * Get the comment from the last addEntry() call
109 public function getComment() {
110 return $this->comment
;
116 public static function validTypes() {
124 public static function isLogType( $type ) {
125 return in_array( $type, LogPage
::validTypes() );
131 public static function logName( $type ) {
132 global $wgLogNames, $wgMessageCache;
134 if( isset( $wgLogNames[$type] ) ) {
135 $wgMessageCache->loadAllMessages();
136 return str_replace( '_', ' ', wfMsg( $wgLogNames[$type] ) );
138 // Bogus log types? Perhaps an extension was removed.
144 * @todo handle missing log types
145 * @param string $type logtype
146 * @return string Headertext of this logtype
148 static function logHeader( $type ) {
149 global $wgLogHeaders, $wgMessageCache;
150 $wgMessageCache->loadAllMessages();
151 return wfMsgExt($wgLogHeaders[$type],array('parseinline'));
156 * @return HTML string
158 static function actionText( $type, $action, $title=NULL, $skin=NULL, $params=array(), $filterWikilinks=false ) {
159 global $wgLang, $wgContLang, $wgLogActions, $wgMessageCache;
161 $wgMessageCache->loadAllMessages();
162 $key = "$type/$action";
163 # Defer patrol log to PatrolLog class
164 if( $key == 'patrol/patrol' ) {
165 return PatrolLog
::makeActionText( $title, $params, $skin );
167 if( isset( $wgLogActions[$key] ) ) {
168 if( is_null( $title ) ) {
169 $rv = wfMsg( $wgLogActions[$key] );
171 $titleLink = self
::getTitleLink( $type, $skin, $title, $params );
172 if( $key == 'rights/rights' ) {
174 $rightsnone = wfMsg( 'rightsnone' );
175 foreach ( $params as &$param ) {
176 $groupArray = array_map( 'trim', explode( ',', $param ) );
177 $groupArray = array_map( array( 'User', 'getGroupName' ), $groupArray );
178 $param = $wgLang->listToText( $groupArray );
181 $rightsnone = wfMsgForContent( 'rightsnone' );
183 if( !isset( $params[0] ) ||
trim( $params[0] ) == '' )
184 $params[0] = $rightsnone;
185 if( !isset( $params[1] ) ||
trim( $params[1] ) == '' )
186 $params[1] = $rightsnone;
188 if( count( $params ) == 0 ) {
190 $rv = wfMsg( $wgLogActions[$key], $titleLink );
192 $rv = wfMsgForContent( $wgLogActions[$key], $titleLink );
196 array_unshift( $params, $titleLink );
197 if ( $key == 'block/block' ||
$key == 'suppress/block' ) {
199 $params[1] = '<span title="' . htmlspecialchars( $params[1] ). '">' .
200 $wgLang->translateBlockExpiry( $params[1] ) . '</span>';
202 $params[1] = $wgContLang->translateBlockExpiry( $params[1] );
204 $params[2] = isset( $params[2] ) ?
205 self
::formatBlockFlags( $params[2], is_null( $skin ) ) : '';
206 } else if ( $type == 'protect' && count($params) == 3 ) {
207 $details .= "{$params[1]}"; // restrictions and expiries
209 $details .= ' ['.wfMsg('protect-summary-cascade').']';
211 # If this is going to be displayed, make it somewhat consistent with page history
212 # and older log entries where everything is treated as a comment
213 if (!is_null($skin)) {
214 $details = $skin->commentBlock($details);
217 $rv = wfMsgReal( $wgLogActions[$key], $params, true, !$skin ) . $details;
221 global $wgLogActionsHandlers;
222 if( isset( $wgLogActionsHandlers[$key] ) ) {
223 $args = func_get_args();
224 $rv = call_user_func_array( $wgLogActionsHandlers[$key], $args );
226 wfDebug( "LogPage::actionText - unknown action $key\n" );
230 if( $filterWikilinks ) {
231 $rv = str_replace( "[[", "", $rv );
232 $rv = str_replace( "]]", "", $rv );
237 protected static function getTitleLink( $type, $skin, $title, &$params ) {
238 global $wgLang, $wgContLang;
240 return $title->getPrefixedText();
244 $titleLink = $skin->makeLinkObj( $title,
245 htmlspecialchars( $title->getPrefixedText() ), 'redirect=no' );
246 $targetTitle = Title
::newFromText( $params[0] );
247 if ( !$targetTitle ) {
248 # Workaround for broken database
249 $params[0] = htmlspecialchars( $params[0] );
251 $params[0] = $skin->makeLinkObj( $targetTitle, htmlspecialchars( $params[0] ) );
255 if( substr( $title->getText(), 0, 1 ) == '#' ) {
256 $titleLink = $title->getText();
258 // TODO: Store the user identifier in the parameters
259 // to make this faster for future log entries
260 $id = User
::idFromName( $title->getText() );
261 $titleLink = $skin->userLink( $id, $title->getText() )
262 . $skin->userToolLinks( $id, $title->getText(), false, Linker
::TOOL_LINKS_NOBLOCK
);
266 $text = $wgContLang->ucfirst( $title->getText() );
267 $titleLink = $skin->makeLinkObj( Title
::makeTitle( NS_USER
, $text ) );
270 $titleLink = $skin->makeLinkObj( $title, $title->getPrefixedText(), 'redirect=no' );
271 $params[0] = $skin->makeLinkObj( Title
::newFromText( $params[0] ), htmlspecialchars( $params[0] ) );
272 $params[1] = $wgLang->timeanddate( $params[1] );
275 if( $title->getNamespace() == NS_SPECIAL
) {
276 list( $name, $par ) = SpecialPage
::resolveAliasWithSubpage( $title->getDBKey() );
277 # Use the language name for log titles, rather than Log/X
278 if( $name == 'Log' ) {
279 $titleLink = '('.$skin->makeLinkObj( $title, LogPage
::logName( $par ) ).')';
281 $titleLink = $skin->makeLinkObj( $title );
284 $titleLink = $skin->makeLinkObj( $title );
292 * @param string $action one of '', 'block', 'protect', 'rights', 'delete', 'upload', 'move', 'move_redir'
293 * @param object &$target A title object.
294 * @param string $comment Description associated
295 * @param array $params Parameters passed later to wfMsg.* functions
296 * @param User $doer The user doing the action
298 function addEntry( $action, $target, $comment, $params = array(), $doer = null ) {
299 if ( !is_array( $params ) ) {
300 $params = array( $params );
303 $this->action
= $action;
304 $this->target
= $target;
305 $this->comment
= $comment;
306 $this->params
= LogPage
::makeParamBlob( $params );
308 if ($doer === null) {
311 } elseif (!is_object( $doer ) ) {
312 $doer = User
::newFromId( $doer );
317 $this->actionText
= LogPage
::actionText( $this->type
, $action, $target, NULL, $params );
319 return $this->saveContent();
323 * Create a blob from a parameter array
326 static function makeParamBlob( $params ) {
327 return implode( "\n", $params );
331 * Extract a parameter array from a blob
334 static function extractParams( $blob ) {
335 if ( $blob === '' ) {
338 return explode( "\n", $blob );
343 * Convert a comma-delimited list of block log flags
344 * into a more readable (and translated) form
346 * @param $flags Flags to format
347 * @param $forContent Whether to localize the message depending of the user
351 public static function formatBlockFlags( $flags, $forContent = false ) {
352 $flags = explode( ',', trim( $flags ) );
353 if( count( $flags ) > 0 ) {
354 for( $i = 0; $i < count( $flags ); $i++
)
355 $flags[$i] = self
::formatBlockFlag( $flags[$i], $forContent );
356 return '(' . implode( ', ', $flags ) . ')';
363 * Translate a block log flag if possible
365 * @param $flag Flag to translate
366 * @param $forContent Whether to localize the message depending of the user
370 public static function formatBlockFlag( $flag, $forContent = false ) {
371 static $messages = array();
372 if( !isset( $messages[$flag] ) ) {
373 $k = 'block-log-flags-' . $flag;
375 $msg = wfMsgForContent( $k );
378 $messages[$flag] = htmlspecialchars( wfEmptyMsg( $k, $msg ) ?
$flag : $msg );
380 return $messages[$flag];
385 * Aliases for backwards compatibility with 1.6
387 define( 'MW_LOG_DELETED_ACTION', LogPage
::DELETED_ACTION
);
388 define( 'MW_LOG_DELETED_USER', LogPage
::DELETED_USER
);
389 define( 'MW_LOG_DELETED_COMMENT', LogPage
::DELETED_COMMENT
);
390 define( 'MW_LOG_DELETED_RESTRICTED', LogPage
::DELETED_RESTRICTED
);