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  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License along
  21  * with this program; if not, write to the Free Software Foundation, Inc.,
  22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  23  * http://www.gnu.org/copyleft/gpl.html
  24  *
  25  * @file
  26  * @author Niklas Laxström
  27  * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License 2.0 or later
  28  * @since 1.19
  29  */
  30
  31 use Wikimedia\Rdbms\IDatabase;
  32
  33 /**
  34  * Interface for log entries. Every log entry has these methods.
  35  *
  36  * @since 1.19
  37  */
  38 interface LogEntry {
  39
  40         /**
  41          * The main log type.
  42          *
  43          * @return string
  44          */
  45         public function getType();
  46
  47         /**
  48          * The log subtype.
  49          *
  50          * @return string
  51          */
  52         public function getSubtype();
  53
  54         /**
  55          * The full logtype in format maintype/subtype.
  56          *
  57          * @return string
  58          */
  59         public function getFullType();
  60
  61         /**
  62          * Get the extra parameters stored for this message.
  63          *
  64          * @return array
  65          */
  66         public function getParameters();
  67
  68         /**
  69          * Get the user for performed this action.
  70          *
  71          * @return User
  72          */
  73         public function getPerformer();
  74
  75         /**
  76          * Get the target page of this action.
  77          *
  78          * @return Title
  79          */
  80         public function getTarget();
  81
  82         /**
  83          * Get the timestamp when the action was executed.
  84          *
  85          * @return string
  86          */
  87         public function getTimestamp();
  88
  89         /**
  90          * Get the user provided comment.
  91          *
  92          * @return string
  93          */
  94         public function getComment();
  95
  96         /**
  97          * Get the access restriction.
  98          *
  99          * @return string
 100          */
 101         public function getDeleted();
 102
 103         /**
 104          * @param int $field One of LogPage::DELETED_* bitfield constants
 105          * @return bool
 106          */
 107         public function isDeleted( $field );
 108 }
 109
 110 /**
 111  * Extends the LogEntryInterface with some basic functionality
 112  *
 113  * @since 1.19
 114  */
 115 abstract class LogEntryBase implements LogEntry {
 116
 117         public function getFullType() {
 118                 return $this->getType() . '/' . $this->getSubtype();
 119         }
 120
 121         public function isDeleted( $field ) {
 122                 return ( $this->getDeleted() & $field ) === $field;
 123         }
 124
 125         /**
 126          * Whether the parameters for this log are stored in new or
 127          * old format.
 128          *
 129          * @return bool
 130          */
 131         public function isLegacy() {
 132                 return false;
 133         }
 134
 135         /**
 136          * Create a blob from a parameter array
 137          *
 138          * @since 1.26
 139          * @param array $params
 140          * @return string
 141          */
 142         public static function makeParamBlob( $params ) {
 143                 return serialize( (array)$params );
 144         }
 145
 146         /**
 147          * Extract a parameter array from a blob
 148          *
 149          * @since 1.26
 150          * @param string $blob
 151          * @return array
 152          */
 153         public static function extractParams( $blob ) {
 154                 return unserialize( $blob );
 155         }
 156 }
 157
 158 /**
 159  * This class wraps around database result row.
 160  *
 161  * @since 1.19
 162  */
 163 class DatabaseLogEntry extends LogEntryBase {
 164
 165         /**
 166          * Returns array of information that is needed for querying
 167          * log entries. Array contains the following keys:
 168          * tables, fields, conds, options and join_conds
 169          *
 170          * @return array
 171          */
 172         public static function getSelectQueryData() {
 173                 $tables = [ 'logging', 'user' ];
 174                 $fields = [
 175                         'log_id', 'log_type', 'log_action', 'log_timestamp',
 176                         'log_user', 'log_user_text',
 177                         'log_namespace', 'log_title', // unused log_page
 178                         'log_comment', 'log_params', 'log_deleted',
 179                         'user_id', 'user_name', 'user_editcount',
 180                 ];
 181
 182                 $joins = [
 183                         // IPs don't have an entry in user table
 184                         'user' => [ 'LEFT JOIN', 'log_user=user_id' ],
 185                 ];
 186
 187                 return [
 188                         'tables' => $tables,
 189                         'fields' => $fields,
 190                         'conds' => [],
 191                         'options' => [],
 192                         'join_conds' => $joins,
 193                 ];
 194         }
 195
 196         /**
 197          * Constructs new LogEntry from database result row.
 198          * Supports rows from both logging and recentchanges table.
 199          *
 200          * @param stdClass|array $row
 201          * @return DatabaseLogEntry
 202          */
 203         public static function newFromRow( $row ) {
 204                 $row = (object)$row;
 205                 if ( isset( $row->rc_logid ) ) {
 206                         return new RCDatabaseLogEntry( $row );
 207                 } else {
 208                         return new self( $row );
 209                 }
 210         }
 211
 212         /** @var stdClass Database result row. */
 213         protected $row;
 214
 215         /** @var User */
 216         protected $performer;
 217
 218         /** @var array Parameters for log entry */
 219         protected $params;
 220
 221         /** @var int A rev id associated to the log entry */
 222         protected $revId = null;
 223
 224         /** @var bool Whether the parameters for this log entry are stored in new or old format. */
 225         protected $legacy;
 226
 227         protected function __construct( $row ) {
 228                 $this->row = $row;
 229         }
 230
 231         /**
 232          * Returns the unique database id.
 233          *
 234          * @return int
 235          */
 236         public function getId() {
 237                 return (int)$this->row->log_id;
 238         }
 239
 240         /**
 241          * Returns whatever is stored in the database field.
 242          *
 243          * @return string
 244          */
 245         protected function getRawParameters() {
 246                 return $this->row->log_params;
 247         }
 248
 249         public function isLegacy() {
 250                 // This extracts the property
 251                 $this->getParameters();
 252                 return $this->legacy;
 253         }
 254
 255         public function getType() {
 256                 return $this->row->log_type;
 257         }
 258
 259         public function getSubtype() {
 260                 return $this->row->log_action;
 261         }
 262
 263         public function getParameters() {
 264                 if ( !isset( $this->params ) ) {
 265                         $blob = $this->getRawParameters();
 266                         MediaWiki\suppressWarnings();
 267                         $params = LogEntryBase::extractParams( $blob );
 268                         MediaWiki\restoreWarnings();
 269                         if ( $params !== false ) {
 270                                 $this->params = $params;
 271                                 $this->legacy = false;
 272                         } else {
 273                                 $this->params = LogPage::extractParams( $blob );
 274                                 $this->legacy = true;
 275                         }
 276
 277                         if ( isset( $this->params['associated_rev_id'] ) ) {
 278                                 $this->revId = $this->params['associated_rev_id'];
 279                                 unset( $this->params['associated_rev_id'] );
 280                         }
 281                 }
 282
 283                 return $this->params;
 284         }
 285
 286         public function getAssociatedRevId() {
 287                 // This extracts the property
 288                 $this->getParameters();
 289                 return $this->revId;
 290         }
 291
 292         public function getPerformer() {
 293                 if ( !$this->performer ) {
 294                         $userId = (int)$this->row->log_user;
 295                         if ( $userId !== 0 ) {
 296                                 // logged-in users
 297                                 if ( isset( $this->row->user_name ) ) {
 298                                         $this->performer = User::newFromRow( $this->row );
 299                                 } else {
 300                                         $this->performer = User::newFromId( $userId );
 301                                 }
 302                         } else {
 303                                 // IP users
 304                                 $userText = $this->row->log_user_text;
 305                                 $this->performer = User::newFromName( $userText, false );
 306                         }
 307                 }
 308
 309                 return $this->performer;
 310         }
 311
 312         public function getTarget() {
 313                 $namespace = $this->row->log_namespace;
 314                 $page = $this->row->log_title;
 315                 $title = Title::makeTitle( $namespace, $page );
 316
 317                 return $title;
 318         }
 319
 320         public function getTimestamp() {
 321                 return wfTimestamp( TS_MW, $this->row->log_timestamp );
 322         }
 323
 324         public function getComment() {
 325                 return $this->row->log_comment;
 326         }
 327
 328         public function getDeleted() {
 329                 return $this->row->log_deleted;
 330         }
 331 }
 332
 333 class RCDatabaseLogEntry extends DatabaseLogEntry {
 334
 335         public function getId() {
 336                 return $this->row->rc_logid;
 337         }
 338
 339         protected function getRawParameters() {
 340                 return $this->row->rc_params;
 341         }
 342
 343         public function getAssociatedRevId() {
 344                 return $this->row->rc_this_oldid;
 345         }
 346
 347         public function getType() {
 348                 return $this->row->rc_log_type;
 349         }
 350
 351         public function getSubtype() {
 352                 return $this->row->rc_log_action;
 353         }
 354
 355         public function getPerformer() {
 356                 if ( !$this->performer ) {
 357                         $userId = (int)$this->row->rc_user;
 358                         if ( $userId !== 0 ) {
 359                                 $this->performer = User::newFromId( $userId );
 360                         } else {
 361                                 $userText = $this->row->rc_user_text;
 362                                 // Might be an IP, don't validate the username
 363                                 $this->performer = User::newFromName( $userText, false );
 364                         }
 365                 }
 366
 367                 return $this->performer;
 368         }
 369
 370         public function getTarget() {
 371                 $namespace = $this->row->rc_namespace;
 372                 $page = $this->row->rc_title;
 373                 $title = Title::makeTitle( $namespace, $page );
 374
 375                 return $title;
 376         }
 377
 378         public function getTimestamp() {
 379                 return wfTimestamp( TS_MW, $this->row->rc_timestamp );
 380         }
 381
 382         public function getComment() {
 383                 return $this->row->rc_comment;
 384         }
 385
 386         public function getDeleted() {
 387                 return $this->row->rc_deleted;
 388         }
 389 }
 390
 391 /**
 392  * Class for creating log entries manually, to inject them into the database.
 393  *
 394  * @since 1.19
 395  */
 396 class ManualLogEntry extends LogEntryBase {
 397         /** @var string Type of log entry */
 398         protected $type;
 399
 400         /** @var string Sub type of log entry */
 401         protected $subtype;
 402
 403         /** @var array Parameters for log entry */
 404         protected $parameters = [];
 405
 406         /** @var array */
 407         protected $relations = [];
 408
 409         /** @var User Performer of the action for the log entry */
 410         protected $performer;
 411
 412         /** @var Title Target title for the log entry */
 413         protected $target;
 414
 415         /** @var string Timestamp of creation of the log entry */
 416         protected $timestamp;
 417
 418         /** @var string Comment for the log entry */
 419         protected $comment = '';
 420
 421         /** @var int A rev id associated to the log entry */
 422         protected $revId = 0;
 423
 424         /** @var array Change tags add to the log entry */
 425         protected $tags = null;
 426
 427         /** @var int Deletion state of the log entry */
 428         protected $deleted;
 429
 430         /** @var int ID of the log entry */
 431         protected $id;
 432
 433         /** @var bool Can this log entry be patrolled? */
 434         protected $isPatrollable = false;
 435
 436         /** @var bool Whether this is a legacy log entry */
 437         protected $legacy = false;
 438
 439         /**
 440          * @since 1.19
 441          * @param string $type
 442          * @param string $subtype
 443          */
 444         public function __construct( $type, $subtype ) {
 445                 $this->type = $type;
 446                 $this->subtype = $subtype;
 447         }
 448
 449         /**
 450          * Set extra log parameters.
 451          *
 452          * You can pass params to the log action message by prefixing the keys with
 453          * a number and optional type, using colons to separate the fields. The
 454          * numbering should start with number 4, the first three parameters are
 455          * hardcoded for every message.
 456          *
 457          * If you want to store stuff that should not be available in messages, don't
 458          * prefix the array key with a number and don't use the colons.
 459          *
 460          * Example:
 461          *   $entry->setParameters(
 462          *     '4::color' => 'blue',
 463          *     '5:number:count' => 3000,
 464          *     'animal' => 'dog'
 465          *   );
 466          *
 467          * @since 1.19
 468          * @param array $parameters Associative array
 469          */
 470         public function setParameters( $parameters ) {
 471                 $this->parameters = $parameters;
 472         }
 473
 474         /**
 475          * Declare arbitrary tag/value relations to this log entry.
 476          * These can be used to filter log entries later on.
 477          *
 478          * @param array $relations Map of (tag => (list of values|value))
 479          * @since 1.22
 480          */
 481         public function setRelations( array $relations ) {
 482                 $this->relations = $relations;
 483         }
 484
 485         /**
 486          * Set the user that performed the action being logged.
 487          *
 488          * @since 1.19
 489          * @param User $performer
 490          */
 491         public function setPerformer( User $performer ) {
 492                 $this->performer = $performer;
 493         }
 494
 495         /**
 496          * Set the title of the object changed.
 497          *
 498          * @since 1.19
 499          * @param Title $target
 500          */
 501         public function setTarget( Title $target ) {
 502                 $this->target = $target;
 503         }
 504
 505         /**
 506          * Set the timestamp of when the logged action took place.
 507          *
 508          * @since 1.19
 509          * @param string $timestamp
 510          */
 511         public function setTimestamp( $timestamp ) {
 512                 $this->timestamp = $timestamp;
 513         }
 514
 515         /**
 516          * Set a comment associated with the action being logged.
 517          *
 518          * @since 1.19
 519          * @param string $comment
 520          */
 521         public function setComment( $comment ) {
 522                 $this->comment = $comment;
 523         }
 524
 525         /**
 526          * Set an associated revision id.
 527          *
 528          * For example, the ID of the revision that was inserted to mark a page move
 529          * or protection, file upload, etc.
 530          *
 531          * @since 1.27
 532          * @param int $revId
 533          */
 534         public function setAssociatedRevId( $revId ) {
 535                 $this->revId = $revId;
 536         }
 537
 538         /**
 539          * Set change tags for the log entry.
 540          *
 541          * @since 1.27
 542          * @param string|string[] $tags
 543          */
 544         public function setTags( $tags ) {
 545                 if ( is_string( $tags ) ) {
 546                         $tags = [ $tags ];
 547                 }
 548                 $this->tags = $tags;
 549         }
 550
 551         /**
 552          * Set whether this log entry should be made patrollable
 553          * This shouldn't depend on config, only on whether there is full support
 554          * in the software for patrolling this log entry.
 555          * False by default
 556          *
 557          * @since 1.27
 558          * @param bool $patrollable
 559          */
 560         public function setIsPatrollable( $patrollable ) {
 561                 $this->isPatrollable = (bool)$patrollable;
 562         }
 563
 564         /**
 565          * Set the 'legacy' flag
 566          *
 567          * @since 1.25
 568          * @param bool $legacy
 569          */
 570         public function setLegacy( $legacy ) {
 571                 $this->legacy = $legacy;
 572         }
 573
 574         /**
 575          * Set the 'deleted' flag.
 576          *
 577          * @since 1.19
 578          * @param int $deleted One of LogPage::DELETED_* bitfield constants
 579          */
 580         public function setDeleted( $deleted ) {
 581                 $this->deleted = $deleted;
 582         }
 583
 584         /**
 585          * Insert the entry into the `logging` table.
 586          *
 587          * @param IDatabase $dbw
 588          * @return int ID of the log entry
 589          * @throws MWException
 590          */
 591         public function insert( IDatabase $dbw = null ) {
 592                 global $wgContLang;
 593
 594                 $dbw = $dbw ?: wfGetDB( DB_MASTER );
 595                 $id = $dbw->nextSequenceValue( 'logging_log_id_seq' );
 596
 597                 if ( $this->timestamp === null ) {
 598                         $this->timestamp = wfTimestampNow();
 599                 }
 600
 601                 // Trim spaces on user supplied text
 602                 $comment = trim( $this->getComment() );
 603
 604                 // Truncate for whole multibyte characters.
 605                 $comment = $wgContLang->truncate( $comment, 255 );
 606
 607                 $params = $this->getParameters();
 608                 $relations = $this->relations;
 609
 610                 // Additional fields for which there's no space in the database table schema
 611                 $revId = $this->getAssociatedRevId();
 612                 if ( $revId ) {
 613                         $params['associated_rev_id'] = $revId;
 614                         $relations['associated_rev_id'] = $revId;
 615                 }
 616
 617                 $data = [
 618                         'log_id' => $id,
 619                         'log_type' => $this->getType(),
 620                         'log_action' => $this->getSubtype(),
 621                         'log_timestamp' => $dbw->timestamp( $this->getTimestamp() ),
 622                         'log_user' => $this->getPerformer()->getId(),
 623                         'log_user_text' => $this->getPerformer()->getName(),
 624                         'log_namespace' => $this->getTarget()->getNamespace(),
 625                         'log_title' => $this->getTarget()->getDBkey(),
 626                         'log_page' => $this->getTarget()->getArticleID(),
 627                         'log_comment' => $comment,
 628                         'log_params' => LogEntryBase::makeParamBlob( $params ),
 629                 ];
 630                 if ( isset( $this->deleted ) ) {
 631                         $data['log_deleted'] = $this->deleted;
 632                 }
 633
 634                 $dbw->insert( 'logging', $data, __METHOD__ );
 635                 $this->id = $dbw->insertId();
 636
 637                 $rows = [];
 638                 foreach ( $relations as $tag => $values ) {
 639                         if ( !strlen( $tag ) ) {
 640                                 throw new MWException( "Got empty log search tag." );
 641                         }
 642
 643                         if ( !is_array( $values ) ) {
 644                                 $values = [ $values ];
 645                         }
 646
 647                         foreach ( $values as $value ) {
 648                                 $rows[] = [
 649                                         'ls_field' => $tag,
 650                                         'ls_value' => $value,
 651                                         'ls_log_id' => $this->id
 652                                 ];
 653                         }
 654                 }
 655                 if ( count( $rows ) ) {
 656                         $dbw->insert( 'log_search', $rows, __METHOD__, 'IGNORE' );
 657                 }
 658
 659                 return $this->id;
 660         }
 661
 662         /**
 663          * Get a RecentChanges object for the log entry
 664          *
 665          * @param int $newId
 666          * @return RecentChange
 667          * @since 1.23
 668          */
 669         public function getRecentChange( $newId = 0 ) {
 670                 $formatter = LogFormatter::newFromEntry( $this );
 671                 $context = RequestContext::newExtraneousContext( $this->getTarget() );
 672                 $formatter->setContext( $context );
 673
 674                 $logpage = SpecialPage::getTitleFor( 'Log', $this->getType() );
 675                 $user = $this->getPerformer();
 676                 $ip = "";
 677                 if ( $user->isAnon() ) {
 678                         // "MediaWiki default" and friends may have
 679                         // no IP address in their name
 680                         if ( IP::isIPAddress( $user->getName() ) ) {
 681                                 $ip = $user->getName();
 682                         }
 683                 }
 684
 685                 return RecentChange::newLogEntry(
 686                         $this->getTimestamp(),
 687                         $logpage,
 688                         $user,
 689                         $formatter->getPlainActionText(),
 690                         $ip,
 691                         $this->getType(),
 692                         $this->getSubtype(),
 693                         $this->getTarget(),
 694                         $this->getComment(),
 695                         LogEntryBase::makeParamBlob( $this->getParameters() ),
 696                         $newId,
 697                         $formatter->getIRCActionComment(), // Used for IRC feeds
 698                         $this->getAssociatedRevId(), // Used for e.g. moves and uploads
 699                         $this->getIsPatrollable()
 700                 );
 701         }
 702
 703         /**
 704          * Publish the log entry.
 705          *
 706          * @param int $newId Id of the log entry.
 707          * @param string $to One of: rcandudp (default), rc, udp
 708          */
 709         public function publish( $newId, $to = 'rcandudp' ) {
 710                 DeferredUpdates::addCallableUpdate(
 711                         function () use ( $newId, $to ) {
 712                                 $log = new LogPage( $this->getType() );
 713                                 if ( !$log->isRestricted() ) {
 714                                         $rc = $this->getRecentChange( $newId );
 715
 716                                         if ( $to === 'rc' || $to === 'rcandudp' ) {
 717                                                 // save RC, passing tags so they are applied there
 718                                                 $tags = $this->getTags();
 719                                                 if ( is_null( $tags ) ) {
 720                                                         $tags = [];
 721                                                 }
 722                                                 $rc->addTags( $tags );
 723                                                 $rc->save( 'pleasedontudp' );
 724                                         }
 725
 726                                         if ( $to === 'udp' || $to === 'rcandudp' ) {
 727                                                 $rc->notifyRCFeeds();
 728                                         }
 729
 730                                         // Log the autopatrol if the log entry is patrollable
 731                                         if ( $this->getIsPatrollable() &&
 732                                                 $rc->getAttribute( 'rc_patrolled' ) === 1
 733                                         ) {
 734                                                 PatrolLog::record( $rc, true, $this->getPerformer() );
 735                                         }
 736                                 }
 737                         },
 738                         DeferredUpdates::POSTSEND,
 739                         wfGetDB( DB_MASTER )
 740                 );
 741         }
 742
 743         public function getType() {
 744                 return $this->type;
 745         }
 746
 747         public function getSubtype() {
 748                 return $this->subtype;
 749         }
 750
 751         public function getParameters() {
 752                 return $this->parameters;
 753         }
 754
 755         /**
 756          * @return User
 757          */
 758         public function getPerformer() {
 759                 return $this->performer;
 760         }
 761
 762         /**
 763          * @return Title
 764          */
 765         public function getTarget() {
 766                 return $this->target;
 767         }
 768
 769         public function getTimestamp() {
 770                 $ts = $this->timestamp !== null ? $this->timestamp : wfTimestampNow();
 771
 772                 return wfTimestamp( TS_MW, $ts );
 773         }
 774
 775         public function getComment() {
 776                 return $this->comment;
 777         }
 778
 779         /**
 780          * @since 1.27
 781          * @return int
 782          */
 783         public function getAssociatedRevId() {
 784                 return $this->revId;
 785         }
 786
 787         /**
 788          * @since 1.27
 789          * @return array
 790          */
 791         public function getTags() {
 792                 return $this->tags;
 793         }
 794
 795         /**
 796          * Whether this log entry is patrollable
 797          *
 798          * @since 1.27
 799          * @return bool
 800          */
 801         public function getIsPatrollable() {
 802                 return $this->isPatrollable;
 803         }
 804
 805         /**
 806          * @since 1.25
 807          * @return bool
 808          */
 809         public function isLegacy() {
 810                 return $this->legacy;
 811         }
 812
 813         public function getDeleted() {
 814                 return (int)$this->deleted;
 815         }
 816 }