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.
34 var $type, $action, $comment, $params, $target;
36 var $updateRecentChanges;
41 * @param string $type One of '', 'block', 'protect', 'rights', 'delete',
43 * @param bool $rc Whether to update recent changes as well as the logging table
45 function __construct( $type, $rc = true ) {
47 $this->updateRecentChanges
= $rc;
50 function saveContent() {
51 if( wfReadOnly() ) return false;
54 $fname = 'LogPage::saveContent';
56 $dbw = wfGetDB( DB_MASTER
);
57 $uid = $wgUser->getID();
58 $log_id = $dbw->nextSequenceValue( 'log_log_id_seq' );
60 $this->timestamp
= $now = wfTimestampNow();
62 'log_type' => $this->type
,
63 'log_action' => $this->action
,
64 'log_timestamp' => $dbw->timestamp( $now ),
66 'log_namespace' => $this->target
->getNamespace(),
67 'log_title' => $this->target
->getDBkey(),
68 'log_comment' => $this->comment
,
69 'log_params' => $this->params
72 # log_id doesn't exist on Wikimedia servers yet, and it's a tricky
73 # schema update to do. Hack it for now to ignore the field on MySQL.
74 if ( !is_null( $log_id ) ) {
75 $data['log_id'] = $log_id;
77 $dbw->insert( 'logging', $data, $fname );
79 # And update recentchanges
80 if ( $this->updateRecentChanges
) {
81 $titleObj = SpecialPage
::getTitleFor( 'Log', $this->type
);
82 $rcComment = $this->getRcComment();
83 RecentChange
::notifyLog( $now, $titleObj, $wgUser, $rcComment, '',
84 $this->type
, $this->action
, $this->target
, $this->comment
, $this->params
);
89 public function getRcComment() {
90 $rcComment = $this->actionText
;
91 if( '' != $this->comment
) {
93 $rcComment = $this->comment
;
95 $rcComment .= ': ' . $this->comment
;
103 public static function validTypes() {
111 public static function isLogType( $type ) {
112 return in_array( $type, LogPage
::validTypes() );
118 public static function logName( $type ) {
119 global $wgLogNames, $wgMessageCache;
121 if( isset( $wgLogNames[$type] ) ) {
122 $wgMessageCache->loadAllMessages();
123 return str_replace( '_', ' ', wfMsg( $wgLogNames[$type] ) );
125 // Bogus log types? Perhaps an extension was removed.
131 * @todo handle missing log types
134 static function logHeader( $type ) {
135 global $wgLogHeaders;
136 return wfMsg( $wgLogHeaders[$type] );
142 static function actionText( $type, $action, $title = NULL, $skin = NULL, $params = array(), $filterWikilinks=false ) {
143 global $wgLang, $wgContLang, $wgLogActions;
145 $key = "$type/$action";
147 if( $key == 'patrol/patrol' )
148 return PatrolLog
::makeActionText( $title, $params, $skin );
150 if( isset( $wgLogActions[$key] ) ) {
151 if( is_null( $title ) ) {
152 $rv=wfMsg( $wgLogActions[$key] );
158 $titleLink = $skin->makeLinkObj( $title, $title->getPrefixedText(), 'redirect=no' );
159 $params[0] = $skin->makeLinkObj( Title
::newFromText( $params[0] ), htmlspecialchars( $params[0] ) );
162 if( substr( $title->getText(), 0, 1 ) == '#' ) {
163 $titleLink = $title->getText();
165 // TODO: Store the user identifier in the parameters
166 // to make this faster for future log entries
167 $id = User
::idFromName( $title->getText() );
168 $titleLink = $skin->userLink( $id, $title->getText() )
169 . $skin->userToolLinks( $id, $title->getText(), false, Linker
::TOOL_LINKS_NOBLOCK
);
173 $text = $wgContLang->ucfirst( $title->getText() );
174 $titleLink = $skin->makeLinkObj( Title
::makeTitle( NS_USER
, $text ) );
177 $titleLink = $skin->makeLinkObj( $title, $title->getPrefixedText(), 'redirect=no' );
178 $params[0] = $skin->makeLinkObj( Title
::newFromText( $params[0] ), htmlspecialchars( $params[0] ) );
179 $params[1] = $wgLang->timeanddate( $params[1] );
182 $titleLink = $skin->makeLinkObj( $title );
186 $titleLink = $title->getPrefixedText();
188 if( $key == 'rights/rights' ) {
190 $rightsnone = wfMsg( 'rightsnone' );
192 $rightsnone = wfMsgForContent( 'rightsnone' );
194 if( !isset( $params[0] ) ||
trim( $params[0] ) == '' )
195 $params[0] = $rightsnone;
196 if( !isset( $params[1] ) ||
trim( $params[1] ) == '' )
197 $params[1] = $rightsnone;
199 if( count( $params ) == 0 ) {
201 $rv = wfMsg( $wgLogActions[$key], $titleLink );
203 $rv = wfMsgForContent( $wgLogActions[$key], $titleLink );
206 array_unshift( $params, $titleLink );
207 if ( $key == 'block/block' ) {
209 $params[1] = '<span title="' . htmlspecialchars( $params[1] ). '">' . $wgLang->translateBlockExpiry( $params[1] ) . '</span>';
211 $params[1] = $wgContLang->translateBlockExpiry( $params[1] );
213 $params[2] = isset( $params[2] )
214 ? self
::formatBlockFlags( $params[2] )
217 $rv = wfMsgReal( $wgLogActions[$key], $params, true, !$skin );
221 wfDebug( "LogPage::actionText - unknown action $key\n" );
224 if( $filterWikilinks ) {
225 $rv = str_replace( "[[", "", $rv );
226 $rv = str_replace( "]]", "", $rv );
233 * @param string $action one of '', 'block', 'protect', 'rights', 'delete', 'upload', 'move', 'move_redir'
234 * @param object &$target A title object.
235 * @param string $comment Description associated
236 * @param array $params Parameters passed later to wfMsg.* functions
238 function addEntry( $action, $target, $comment, $params = array() ) {
239 if ( !is_array( $params ) ) {
240 $params = array( $params );
243 $this->action
= $action;
244 $this->target
= $target;
245 $this->comment
= $comment;
246 $this->params
= LogPage
::makeParamBlob( $params );
248 $this->actionText
= LogPage
::actionText( $this->type
, $action, $target, NULL, $params );
250 return $this->saveContent();
254 * Create a blob from a parameter array
257 static function makeParamBlob( $params ) {
258 return implode( "\n", $params );
262 * Extract a parameter array from a blob
265 static function extractParams( $blob ) {
266 if ( $blob === '' ) {
269 return explode( "\n", $blob );
274 * Convert a comma-delimited list of block log flags
275 * into a more readable (and translated) form
277 * @param $flags Flags to format
280 public static function formatBlockFlags( $flags ) {
281 $flags = explode( ',', trim( $flags ) );
282 if( count( $flags ) > 0 ) {
283 for( $i = 0; $i < count( $flags ); $i++
)
284 $flags[$i] = self
::formatBlockFlag( $flags[$i] );
285 return '(' . implode( ', ', $flags ) . ')';
292 * Translate a block log flag if possible
294 * @param $flag Flag to translate
297 public static function formatBlockFlag( $flag ) {
298 static $messages = array();
299 if( !isset( $messages[$flag] ) ) {
300 $k = 'block-log-flags-' . $flag;
302 $messages[$flag] = htmlspecialchars( wfEmptyMsg( $k, $msg ) ?
$flag : $msg );
304 return $messages[$flag];