includes/logging/LogEntry.php

   1 <?php
   2 /**
   3  * Contain classes for dealing with individual log entries
   4  *
   5  * This is how I see the log system history:
   6  * - appending to plain wiki pages
   7  * - formatting log entries based on database fields
   8  * - user is now part of the action message
   9  *
  10  * @file
  11  * @author Niklas Laxström
  12  * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License 2.0 or later
  13  * @since 1.19
  14  */
  15
  16 /**
  17  * Interface for log entries. Every log entry has these methods.
  18  * @since 1.19
  19  */
  20 interface LogEntry {
  21
  22         /**
  23          * The main log type.
  24          * @return string
  25          */
  26         public function getType();
  27
  28         /**
  29          * The log subtype.
  30          * @return string
  31          */
  32         public function getSubtype();
  33
  34         /**
  35          * The full logtype in format maintype/subtype.
  36          * @return string
  37          */
  38         public function getFullType();
  39
  40         /**
  41          * Get the extra parameters stored for this message.
  42          * @return array
  43          */
  44         public function getParameters();
  45
  46         /**
  47          * Get the user for performed this action.
  48          * @return User
  49          */
  50         public function getPerformer();
  51
  52         /**
  53          * Get the target page of this action.
  54          * @return Title
  55          */
  56         public function getTarget();
  57
  58         /**
  59          * Get the timestamp when the action was executed.
  60          * @return string
  61          */
  62         public function getTimestamp();
  63
  64         /**
  65          * Get the user provided comment.
  66          * @return string
  67          */
  68         public function getComment();
  69
  70         /**
  71          * Get the access restriction.
  72          * @return string
  73          */
  74         public function getDeleted();
  75
  76         /**
  77          * @param $field Integer: one of LogPage::DELETED_* bitfield constants
  78          * @return Boolean
  79          */
  80         public function isDeleted( $field );
  81 }
  82
  83 /**
  84  * Extends the LogEntryInterface with some basic functionality
  85  * @since 1.19
  86  */
  87 abstract class LogEntryBase implements LogEntry {
  88
  89         public function getFullType() {
  90                 return $this->getType() . '/' . $this->getSubtype();
  91         }
  92
  93         public function isDeleted( $field ) {
  94                 return ( $this->getDeleted() & $field ) === $field;
  95         }
  96
  97         /**
  98          * Whether the parameters for this log are stored in new or
  99          * old format.
 100          */
 101         public function isLegacy() {
 102                 return false;
 103         }
 104
 105 }
 106
 107 /**
 108  * This class wraps around database result row.
 109  * @since 1.19
 110  */
 111 class DatabaseLogEntry extends LogEntryBase {
 112         // Static->
 113
 114         /**
 115          * Returns array of information that is needed for querying
 116          * log entries. Array contains the following keys:
 117          * tables, fields, conds, options and join_conds
 118          * @return array
 119          */
 120         public static function getSelectQueryData() {
 121                 $tables = array( 'logging', 'user' );
 122                 $fields = array(
 123                         'log_id', 'log_type', 'log_action', 'log_timestamp',
 124                         'log_user', 'log_user_text',
 125                         'log_namespace', 'log_title', // unused log_page
 126                         'log_comment', 'log_params', 'log_deleted',
 127                         'user_id', 'user_name', 'user_editcount',
 128                 );
 129
 130                 $conds = array();
 131
 132                 $joins = array(
 133                         // IP's don't have an entry in user table
 134                         'user' => array( 'LEFT JOIN', 'log_user=user_id' ),
 135                 );
 136
 137                 return array(
 138                         'tables' => $tables,
 139                         'fields' => $fields,
 140                         'conds'  => array(),
 141                         'options' => array(),
 142                         'join_conds' => $joins,
 143                 );
 144         }
 145
 146         /**
 147          * Constructs new LogEntry from database result row.
 148          * Supports rows from both logging and recentchanges table.
 149          * @param $row
 150          * @return DatabaseLogEntry
 151          */
 152         public static function newFromRow( $row ) {
 153                 if ( is_array( $row ) && isset( $row['rc_logid'] ) ) {
 154                         return new RCDatabaseLogEntry( (object) $row );
 155                 } else {
 156                         return new self( $row );
 157                 }
 158         }
 159
 160         // Non-static->
 161
 162         /// Database result row.
 163         protected $row;
 164
 165         protected function __construct( $row ) {
 166                 $this->row = $row;
 167         }
 168
 169         /**
 170          * Returns the unique database id.
 171          * @return int
 172          */
 173         public function getId() {
 174                 return (int)$this->row->log_id;
 175         }
 176
 177         /**
 178          * Returns whatever is stored in the database field.
 179          * @return string
 180          */
 181         protected function getRawParameters() {
 182                 return $this->row->log_params;
 183         }
 184
 185         // LogEntryBase->
 186
 187         public function isLegacy() {
 188                 // This does the check
 189                 $this->getParameters();
 190                 return $this->legacy;
 191         }
 192
 193         // LogEntry->
 194
 195         public function getType() {
 196                 return $this->row->log_type;
 197         }
 198
 199         public function getSubtype() {
 200                 return $this->row->log_action;
 201         }
 202
 203         public function getParameters() {
 204                 if ( !isset( $this->params ) ) {
 205                         $blob = $this->getRawParameters();
 206                         wfSuppressWarnings();
 207                         $params = unserialize( $blob );
 208                         wfRestoreWarnings();
 209                         if ( $params !== false ) {
 210                                 $this->params = $params;
 211                                 $this->legacy = false;
 212                         } else {
 213                                 $this->params = $blob === '' ? array() : explode( "\n", $blob );
 214                                 $this->legacy = true;
 215                         }
 216                 }
 217                 return $this->params;
 218         }
 219
 220         public function getPerformer() {
 221                 $userId = (int) $this->row->log_user;
 222                 if ( $userId !== 0 ) {
 223                         return User::newFromRow( $this->row );
 224                 } else {
 225                         $userText = $this->row->log_user_text;
 226                         return User::newFromName( $userText, false );
 227                 }
 228         }
 229
 230         public function getTarget() {
 231                 $namespace = $this->row->log_namespace;
 232                 $page = $this->row->log_title;
 233                 $title = Title::makeTitle( $namespace, $page );
 234                 return $title;
 235         }
 236
 237         public function getTimestamp() {
 238                 return wfTimestamp( TS_MW, $this->row->log_timestamp );
 239         }
 240
 241         public function getComment() {
 242                 return $this->row->log_comment;
 243         }
 244
 245         public function getDeleted() {
 246                 return $this->row->log_deleted;
 247         }
 248
 249 }
 250
 251 class RCDatabaseLogEntry extends DatabaseLogEntry {
 252
 253         public function getId() {
 254                 return $this->row->rc_logid;
 255         }
 256
 257         protected function getRawParameters() {
 258                 return $this->row->rc_params;
 259         }
 260
 261         // LogEntry->
 262
 263         public function getType() {
 264                 return $this->row->rc_log_type;
 265         }
 266
 267         public function getSubtype() {
 268                 return $this->row->rc_log_action;
 269         }
 270
 271         public function getPerformer() {
 272                 $userId = (int) $this->row->rc_user;
 273                 if ( $userId !== 0 ) {
 274                         return User::newFromId( $userId );
 275                 } else {
 276                         $userText = $this->row->rc_user_text;
 277                         // Might be an IP, don't validate the username
 278                         return User::newFromName( $userText, false );
 279                 }
 280         }
 281
 282         public function getTarget() {
 283                 $namespace = $this->row->rc_namespace;
 284                 $page = $this->row->rc_title;
 285                 $title = Title::makeTitle( $namespace, $page );
 286                 return $title;
 287         }
 288
 289         public function getTimestamp() {
 290                 return wfTimestamp( TS_MW, $this->row->rc_timestamp );
 291         }
 292
 293         public function getComment() {
 294                 return $this->row->rc_comment;
 295         }
 296
 297         public function getDeleted() {
 298                 return $this->row->rc_deleted;
 299         }
 300
 301 }
 302
 303 /**
 304  * Class for creating log entries manually, for
 305  * example to inject them into the database.
 306  * @since 1.19
 307  */
 308 class ManualLogEntry extends LogEntryBase {
 309         protected $type; ///!< @var string
 310         protected $subtype; ///!< @var string
 311         protected $parameters = array(); ///!< @var array
 312         protected $performer; ///!< @var User
 313         protected $target; ///!< @var Title
 314         protected $timestamp; ///!< @var string
 315         protected $comment = ''; ///!< @var string
 316         protected $deleted; ///!< @var int
 317
 318         public function __construct( $type, $subtype ) {
 319                 $this->type = $type;
 320                 $this->subtype = $subtype;
 321         }
 322
 323         /**
 324          * Set extra log parameters.
 325          * You can pass params to the log action message
 326          * by prefixing the keys with a number and colon.
 327          * The numbering should start with number 4, the
 328          * first three parameters are hardcoded for every
 329          * message. Example:
 330          * $entry->setParameters(
 331          *   '4:color' => 'blue',
 332          *   'animal' => 'dog'
 333          * );
 334          * @param $parameters Associative array
 335          */
 336         public function setParameters( $parameters ) {
 337                 $this->parameters = $parameters;
 338         }
 339
 340         public function setPerformer( User $performer ) {
 341                 $this->performer = $performer;
 342         }
 343
 344         public function setTarget( Title $target ) {
 345                 $this->target = $target;
 346         }
 347
 348         public function setTimestamp( $timestamp ) {
 349                 $this->timestamp = $timestamp;
 350         }
 351
 352         public function setComment( $comment ) {
 353                 $this->comment = $comment;
 354         }
 355
 356         public function setDeleted( $deleted ) {
 357                 $this->deleted = $deleted;
 358         }
 359
 360         /**
 361          * Inserts the entry into the logging table.
 362          * @return int If of the log entry
 363          */
 364         public function insert() {
 365                 global $wgLogRestrictions;
 366
 367                 $dbw = wfGetDB( DB_MASTER );
 368                 $id = $dbw->nextSequenceValue( 'logging_log_id_seq' );
 369
 370                 if ( $this->timestamp === null ) {
 371                         $this->timestamp = wfTimestampNow();
 372                 }
 373
 374                 $data = array(
 375                         'log_id' => $id,
 376                         'log_type' => $this->getType(),
 377                         'log_action' => $this->getSubtype(),
 378                         'log_timestamp' => $dbw->timestamp( $this->getTimestamp() ),
 379                         'log_user' => $this->getPerformer()->getId(),
 380                         'log_user_text' => $this->getPerformer()->getName(),
 381                         'log_namespace' => $this->getTarget()->getNamespace(),
 382                         'log_title' => $this->getTarget()->getDBkey(),
 383                         'log_page' => $this->getTarget()->getArticleId(),
 384                         'log_comment' => $this->getComment(),
 385                         'log_params' => serialize( (array) $this->getParameters() ),
 386                 );
 387                 $dbw->insert( 'logging', $data, __METHOD__ );
 388                 $this->id = !is_null( $id ) ? $id : $dbw->insertId();
 389                 return $this->id;
 390         }
 391
 392         /**
 393          * Publishes the log entry.
 394          * @param $newId int id of the log entry.
 395          * @param $to string: rcandudp (default), rc, udp
 396          */
 397         public function publish( $newId, $to = 'rcandudp' ) {
 398                 $log = new LogPage( $this->getType() );
 399                 if ( $log->isRestricted() ) {
 400                         return;
 401                 }
 402
 403                 $formatter = LogFormatter::newFromEntry( $this );
 404                 $context = RequestContext::newExtraneousContext( $this->getTarget() );
 405                 $formatter->setContext( $context );
 406
 407                 $logpage = SpecialPage::getTitleFor( 'Log', $this->getType() );
 408                 $user = $this->getPerformer();
 409                 $rc = RecentChange::newLogEntry(
 410                         $this->getTimestamp(),
 411                         $logpage,
 412                         $user,
 413                         $formatter->getPlainActionText(), // Used for IRC feeds
 414                         $user->isAnon() ? $user->getName() : '',
 415                         $this->getType(),
 416                         $this->getSubtype(),
 417                         $this->getTarget(),
 418                         $this->getComment(),
 419                         serialize( (array) $this->getParameters() ),
 420                         $newId
 421                 );
 422
 423                 if ( $to === 'rc' || $to === 'rcandudp' ) {
 424                         $rc->save();
 425                 }
 426
 427                 if ( $to === 'udp' || $to === 'rcandudp' ) {
 428                         $rc->notifyRC2UDP();
 429                 }
 430         }
 431
 432         // LogEntry->
 433
 434         public function getType() {
 435                 return $this->type;
 436         }
 437
 438         public function getSubtype() {
 439                 return $this->subtype;
 440         }
 441
 442         public function getParameters() {
 443                 return $this->parameters;
 444         }
 445
 446         public function getPerformer() {
 447                 return $this->performer;
 448         }
 449
 450         public function getTarget() {
 451                 return $this->target;
 452         }
 453
 454         public function getTimestamp() {
 455                 $ts = $this->timestamp !== null ? $this->timestamp : wfTimestampNow();
 456                 return wfTimestamp( TS_MW, $ts );
 457         }
 458
 459         public function getComment() {
 460                 return $this->comment;
 461         }
 462
 463         public function getDeleted() {
 464                 return (int) $this->deleted;
 465         }
 466
 467 }