includes/LogPage.php

   1 <?php
   2 #
   3 # Copyright (C) 2002, 2004 Brion Vibber <brion@pobox.com>
   4 # http://www.mediawiki.org/
   5 #
   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.
  10 #
  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.
  15 #
  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
  20
  21 /**
  22  * Contain log classes
  23  * @file
  24  */
  25
  26 /**
  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.
  30  *
  31  */
  32 class LogPage {
  33         const DELETED_ACTION = 1;
  34         const DELETED_COMMENT = 2;
  35         const DELETED_USER = 4;
  36     const DELETED_RESTRICTED = 8;
  37         /* @access private */
  38         var $type, $action, $comment, $params, $target, $doer;
  39         /* @acess public */
  40         var $updateRecentChanges;
  41
  42         /**
  43           * Constructor
  44           *
  45           * @param string $type One of '', 'block', 'protect', 'rights', 'delete',
  46           *               'upload', 'move'
  47           * @param bool $rc Whether to update recent changes as well as the logging table
  48           */
  49         function __construct( $type, $rc = true ) {
  50                 $this->type = $type;
  51                 $this->updateRecentChanges = $rc;
  52         }
  53
  54         protected function saveContent() {
  55                 global $wgUser, $wgLogRestrictions;
  56                 $fname = 'LogPage::saveContent';
  57
  58                 $dbw = wfGetDB( DB_MASTER );
  59                 $log_id = $dbw->nextSequenceValue( 'log_log_id_seq' );
  60
  61                 $this->timestamp = $now = wfTimestampNow();
  62                 $data = array(
  63                         'log_id' => $log_id,
  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
  72                 );
  73                 $dbw->insert( 'logging', $data, $fname );
  74                 $newId = !is_null($log_id) ? $log_id : $dbw->insertId();
  75
  76                 if( !($dbw->affectedRows() > 0) ) {
  77                         wfDebugLog( "logging", "LogPage::saveContent failed to insert row - Error {$dbw->lastErrno()}: {$dbw->lastError()}" );
  78                 }
  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 );
  87                         }
  88                 }
  89                 return true;
  90         }
  91
  92         public function getRcComment() {
  93                 $rcComment = $this->actionText;
  94                 if( '' != $this->comment ) {
  95                         if ($rcComment == '')
  96                                 $rcComment = $this->comment;
  97                         else
  98                                 $rcComment .= ': ' . $this->comment;
  99                 }
 100                 return $rcComment;
 101         }
 102
 103         /**
 104          * @static
 105          */
 106         public static function validTypes() {
 107                 global $wgLogTypes;
 108                 return $wgLogTypes;
 109         }
 110
 111         /**
 112          * @static
 113          */
 114         public static function isLogType( $type ) {
 115                 return in_array( $type, LogPage::validTypes() );
 116         }
 117
 118         /**
 119          * @static
 120          */
 121         public static function logName( $type ) {
 122                 global $wgLogNames, $wgMessageCache;
 123
 124                 if( isset( $wgLogNames[$type] ) ) {
 125                         $wgMessageCache->loadAllMessages();
 126                         return str_replace( '_', ' ', wfMsg( $wgLogNames[$type] ) );
 127                 } else {
 128                         // Bogus log types? Perhaps an extension was removed.
 129                         return $type;
 130                 }
 131         }
 132
 133         /**
 134          * @todo handle missing log types
 135          * @param string $type logtype
 136          * @return string Headertext of this logtype
 137          */
 138         static function logHeader( $type ) {
 139                 global $wgLogHeaders;
 140                 return wfMsgExt($wgLogHeaders[$type],array('parseinline'));
 141         }
 142
 143         /**
 144          * @static
 145          * @return HTML string
 146          */
 147         static function actionText( $type, $action, $title = NULL, $skin = NULL, $params = array(), $filterWikilinks=false ) {
 148                 global $wgLang, $wgContLang, $wgLogActions;
 149
 150                 $key = "$type/$action";
 151
 152                 if( $key == 'patrol/patrol' )
 153                         return PatrolLog::makeActionText( $title, $params, $skin );
 154
 155                 if( isset( $wgLogActions[$key] ) ) {
 156                         if( is_null( $title ) ) {
 157                                 $rv=wfMsg( $wgLogActions[$key] );
 158                         } else {
 159                                 if( $skin ) {
 160
 161                                         switch( $type ) {
 162                                                 case 'move':
 163                                                         $titleLink = $skin->makeLinkObj( $title, htmlspecialchars( $title->getPrefixedText() ), 'redirect=no' );
 164                                                         $params[0] = $skin->makeLinkObj( Title::newFromText( $params[0] ), htmlspecialchars( $params[0] ) );
 165                                                         break;
 166                                                 case 'block':
 167                                                         if( substr( $title->getText(), 0, 1 ) == '#' ) {
 168                                                                 $titleLink = $title->getText();
 169                                                         } else {
 170                                                                 // TODO: Store the user identifier in the parameters
 171                                                                 // to make this faster for future log entries
 172                                                                 $id = User::idFromName( $title->getText() );
 173                                                                 $titleLink = $skin->userLink( $id, $title->getText() )
 174                                                                         . $skin->userToolLinks( $id, $title->getText(), false, Linker::TOOL_LINKS_NOBLOCK );
 175                                                         }
 176                                                         break;
 177                                                 case 'rights':
 178                                                         $text = $wgContLang->ucfirst( $title->getText() );
 179                                                         $titleLink = $skin->makeLinkObj( Title::makeTitle( NS_USER, $text ) );
 180                                                         break;
 181                                                 case 'merge':
 182                                                         $titleLink = $skin->makeLinkObj( $title, $title->getPrefixedText(), 'redirect=no' );
 183                                                         $params[0] = $skin->makeLinkObj( Title::newFromText( $params[0] ), htmlspecialchars( $params[0] ) );
 184                                                         $params[1] = $wgLang->timeanddate( $params[1] );
 185                                                         break;
 186                                                 default:
 187                                                         $titleLink = $skin->makeLinkObj( $title );
 188                                         }
 189
 190                                 } else {
 191                                         $titleLink = $title->getPrefixedText();
 192                                 }
 193                                 if( $key == 'rights/rights' ) {
 194                                         if ($skin) {
 195                                                 $rightsnone = wfMsg( 'rightsnone' );
 196                                         } else {
 197                                                 $rightsnone = wfMsgForContent( 'rightsnone' );
 198                                         }
 199                                         if( !isset( $params[0] ) || trim( $params[0] ) == '' )
 200                                                 $params[0] = $rightsnone;
 201                                         if( !isset( $params[1] ) || trim( $params[1] ) == '' )
 202                                                 $params[1] = $rightsnone;
 203                                 }
 204                                 if( count( $params ) == 0 ) {
 205                                         if ( $skin ) {
 206                                                 $rv = wfMsg( $wgLogActions[$key], $titleLink );
 207                                         } else {
 208                                                 $rv = wfMsgForContent( $wgLogActions[$key], $titleLink );
 209                                         }
 210                                 } else {
 211                                         array_unshift( $params, $titleLink );
 212                                         if ( $key == 'block/block' || $key == 'suppress/block' ) {
 213                                                 if ( $skin ) {
 214                                                         $params[1] = '<span title="' . htmlspecialchars( $params[1] ). '">' . $wgLang->translateBlockExpiry( $params[1] ) . '</span>';
 215                                                 } else {
 216                                                         $params[1] = $wgContLang->translateBlockExpiry( $params[1] );
 217                                                 }
 218                                                 $params[2] = isset( $params[2] )
 219                                                                                 ? self::formatBlockFlags( $params[2], is_null( $skin ) )
 220                                                                                 : '';
 221                                         }
 222                                         $rv = wfMsgReal( $wgLogActions[$key], $params, true, !$skin );
 223                                 }
 224                         }
 225                 } else {
 226                         global $wgLogActionsHandlers;
 227                         if( isset( $wgLogActionsHandlers[$key] ) ) {
 228                                 $args = func_get_args();
 229                                 $rv = call_user_func_array( $wgLogActionsHandlers[$key], $args );
 230                         } else {
 231                                 wfDebug( "LogPage::actionText - unknown action $key\n" );
 232                                 $rv = "$action";
 233                         }
 234                 }
 235                 if( $filterWikilinks ) {
 236                         $rv = str_replace( "[[", "", $rv );
 237                         $rv = str_replace( "]]", "", $rv );
 238                 }
 239                 return $rv;
 240         }
 241
 242         /**
 243          * Add a log entry
 244          * @param string $action one of '', 'block', 'protect', 'rights', 'delete', 'upload', 'move', 'move_redir'
 245          * @param object &$target A title object.
 246          * @param string $comment Description associated
 247          * @param array $params Parameters passed later to wfMsg.* functions
 248          * @param User $doer The user doing the action
 249          */
 250         function addEntry( $action, $target, $comment, $params = array(), $doer = null ) {
 251                 if ( !is_array( $params ) ) {
 252                         $params = array( $params );
 253                 }
 254
 255                 $this->action = $action;
 256                 $this->target = $target;
 257                 $this->comment = $comment;
 258                 $this->params = LogPage::makeParamBlob( $params );
 259
 260                 if ($doer === null) {
 261                         global $wgUser;
 262                         $doer = $wgUser;
 263                 } elseif (!is_object( $doer ) ) {
 264                         $doer = User::newFromId( $doer );
 265                 }
 266
 267                 $this->doer = $doer;
 268
 269                 $this->actionText = LogPage::actionText( $this->type, $action, $target, NULL, $params );
 270
 271                 return $this->saveContent();
 272         }
 273
 274         /**
 275          * Create a blob from a parameter array
 276          * @static
 277          */
 278         static function makeParamBlob( $params ) {
 279                 return implode( "\n", $params );
 280         }
 281
 282         /**
 283          * Extract a parameter array from a blob
 284          * @static
 285          */
 286         static function extractParams( $blob ) {
 287                 if ( $blob === '' ) {
 288                         return array();
 289                 } else {
 290                         return explode( "\n", $blob );
 291                 }
 292         }
 293
 294         /**
 295          * Convert a comma-delimited list of block log flags
 296          * into a more readable (and translated) form
 297          *
 298          * @param $flags Flags to format
 299          * @param $forContent Whether to localize the message depending of the user
 300          *                    language
 301          * @return string
 302          */
 303         public static function formatBlockFlags( $flags, $forContent = false ) {
 304                 $flags = explode( ',', trim( $flags ) );
 305                 if( count( $flags ) > 0 ) {
 306                         for( $i = 0; $i < count( $flags ); $i++ )
 307                                 $flags[$i] = self::formatBlockFlag( $flags[$i], $forContent );
 308                         return '(' . implode( ', ', $flags ) . ')';
 309                 } else {
 310                         return '';
 311                 }
 312         }
 313
 314         /**
 315          * Translate a block log flag if possible
 316          *
 317          * @param $flag Flag to translate
 318          * @param $forContent Whether to localize the message depending of the user
 319          *                    language
 320          * @return string
 321          */
 322         public static function formatBlockFlag( $flag, $forContent = false ) {
 323                 static $messages = array();
 324                 if( !isset( $messages[$flag] ) ) {
 325                         $k = 'block-log-flags-' . $flag;
 326                         if( $forContent )
 327                                 $msg = wfMsgForContent( $k );
 328                         else
 329                                 $msg = wfMsg( $k );
 330                         $messages[$flag] = htmlspecialchars( wfEmptyMsg( $k, $msg ) ? $flag : $msg );
 331                 }
 332                 return $messages[$flag];
 333         }
 334 }
 335
 336 /**
 337  * Aliases for backwards compatibility with 1.6
 338  */
 339 define( 'MW_LOG_DELETED_ACTION', LogPage::DELETED_ACTION );
 340 define( 'MW_LOG_DELETED_USER', LogPage::DELETED_USER );
 341 define( 'MW_LOG_DELETED_COMMENT', LogPage::DELETED_COMMENT );
 342 define( 'MW_LOG_DELETED_RESTRICTED', LogPage::DELETED_RESTRICTED );