LogEntry.php

Go to the documentation of this file.

<?php
use MediaWiki\ChangeTags\Taggable;
use MediaWiki\Linker\LinkTarget;
use MediaWiki\User\UserIdentity;
use Wikimedia\Rdbms\IDatabase;
use Wikimedia\Assert\Assert;
 
interface LogEntry {
 
    public function getType();
 
    public function getSubtype();
 
    public function getFullType();
 
    public function getParameters();
 
    public function getPerformer();
 
    public function getTarget();
 
    public function getTimestamp();
 
    public function getComment();
 
    public function getDeleted();
 
    public function isDeleted( $field );
}
 
abstract class LogEntryBase implements LogEntry {
 
    public function getFullType() {
        return $this->getType() . '/' . $this->getSubtype();
    }
 
    public function isDeleted( $field ) {
        return ( $this->getDeleted() & $field ) === $field;
    }
 
    public function isLegacy() {
        return false;
    }
 
    public static function makeParamBlob( $params ) {
        return serialize( (array)$params );
    }
 
    public static function extractParams( $blob ) {
        return unserialize( $blob );
    }
}
 
class DatabaseLogEntry extends LogEntryBase {
 
    public static function getSelectQueryData() {
        $commentQuery = CommentStore::getStore()->getJoin( 'log_comment' );
        $actorQuery = ActorMigration::newMigration()->getJoin( 'log_user' );
 
        $tables = array_merge(
            [ 'logging' ], $commentQuery['tables'], $actorQuery['tables'], [ 'user' ]
        );
        $fields = [
            'log_id', 'log_type', 'log_action', 'log_timestamp',
            'log_namespace', 'log_title', // unused log_page
            'log_params', 'log_deleted',
            'user_id', 'user_name', 'user_editcount',
        ] + $commentQuery['fields'] + $actorQuery['fields'];
 
        $joins = [
            // IPs don't have an entry in user table
            'user' => [ 'LEFT JOIN', 'user_id=' . $actorQuery['fields']['log_user'] ],
        ] + $commentQuery['joins'] + $actorQuery['joins'];
 
        return [
            'tables' => $tables,
            'fields' => $fields,
            'conds' => [],
            'options' => [],
            'join_conds' => $joins,
        ];
    }
 
    public static function newFromRow( $row ) {
        $row = (object)$row;
        if ( isset( $row->rc_logid ) ) {
            return new RCDatabaseLogEntry( $row );
        } else {
            return new self( $row );
        }
    }
 
    public static function newFromId( $id, IDatabase $db ) {
        $queryInfo = self::getSelectQueryData();
        $queryInfo['conds'] += [ 'log_id' => $id ];
        $row = $db->selectRow(
            $queryInfo['tables'],
            $queryInfo['fields'],
            $queryInfo['conds'],
            __METHOD__,
            $queryInfo['options'],
            $queryInfo['join_conds']
        );
        if ( !$row ) {
            return null;
        }
        return self::newFromRow( $row );
    }
 
    protected $row;
 
    protected $performer;
 
    protected $params;
 
    protected $revId = null;
 
    protected $legacy;
 
    protected function __construct( $row ) {
        $this->row = $row;
    }
 
    public function getId() {
        return (int)$this->row->log_id;
    }
 
    protected function getRawParameters() {
        return $this->row->log_params;
    }
 
    public function isLegacy() {
        // This extracts the property
        $this->getParameters();
        return $this->legacy;
    }
 
    public function getType() {
        return $this->row->log_type;
    }
 
    public function getSubtype() {
        return $this->row->log_action;
    }
 
    public function getParameters() {
        if ( !isset( $this->params ) ) {
            $blob = $this->getRawParameters();
            Wikimedia\suppressWarnings();
            $params = LogEntryBase::extractParams( $blob );
            Wikimedia\restoreWarnings();
            if ( $params !== false ) {
                $this->params = $params;
                $this->legacy = false;
            } else {
                $this->params = LogPage::extractParams( $blob );
                $this->legacy = true;
            }
 
            if ( isset( $this->params['associated_rev_id'] ) ) {
                $this->revId = $this->params['associated_rev_id'];
                unset( $this->params['associated_rev_id'] );
            }
        }
 
        return $this->params;
    }
 
    public function getAssociatedRevId() {
        // This extracts the property
        $this->getParameters();
        return $this->revId;
    }
 
    public function getPerformer() {
        if ( !$this->performer ) {
            $actorId = isset( $this->row->log_actor ) ? (int)$this->row->log_actor : 0;
            $userId = (int)$this->row->log_user;
            if ( $userId !== 0 || $actorId !== 0 ) {
                // logged-in users
                if ( isset( $this->row->user_name ) ) {
                    $this->performer = User::newFromRow( $this->row );
                } elseif ( $actorId !== 0 ) {
                    $this->performer = User::newFromActorId( $actorId );
                } else {
                    $this->performer = User::newFromId( $userId );
                }
            } else {
                // IP users
                $userText = $this->row->log_user_text;
                $this->performer = User::newFromName( $userText, false );
            }
        }
 
        return $this->performer;
    }
 
    public function getTarget() {
        $namespace = $this->row->log_namespace;
        $page = $this->row->log_title;
        $title = Title::makeTitle( $namespace, $page );
 
        return $title;
    }
 
    public function getTimestamp() {
        return wfTimestamp( TS_MW, $this->row->log_timestamp );
    }
 
    public function getComment() {
        return CommentStore::getStore()->getComment( 'log_comment', $this->row )->text;
    }
 
    public function getDeleted() {
        return $this->row->log_deleted;
    }
}
 
class RCDatabaseLogEntry extends DatabaseLogEntry {
 
    public function getId() {
        return $this->row->rc_logid;
    }
 
    protected function getRawParameters() {
        return $this->row->rc_params;
    }
 
    public function getAssociatedRevId() {
        return $this->row->rc_this_oldid;
    }
 
    public function getType() {
        return $this->row->rc_log_type;
    }
 
    public function getSubtype() {
        return $this->row->rc_log_action;
    }
 
    public function getPerformer() {
        if ( !$this->performer ) {
            $actorId = isset( $this->row->rc_actor ) ? (int)$this->row->rc_actor : 0;
            $userId = (int)$this->row->rc_user;
            if ( $actorId !== 0 ) {
                $this->performer = User::newFromActorId( $actorId );
            } elseif ( $userId !== 0 ) {
                $this->performer = User::newFromId( $userId );
            } else {
                $userText = $this->row->rc_user_text;
                // Might be an IP, don't validate the username
                $this->performer = User::newFromName( $userText, false );
            }
        }
 
        return $this->performer;
    }
 
    public function getTarget() {
        $namespace = $this->row->rc_namespace;
        $page = $this->row->rc_title;
        $title = Title::makeTitle( $namespace, $page );
 
        return $title;
    }
 
    public function getTimestamp() {
        return wfTimestamp( TS_MW, $this->row->rc_timestamp );
    }
 
    public function getComment() {
        return CommentStore::getStore()
            // Legacy because the row may have used RecentChange::selectFields()
            ->getCommentLegacy( wfGetDB( DB_REPLICA ), 'rc_comment', $this->row )->text;
    }
 
    public function getDeleted() {
        return $this->row->rc_deleted;
    }
}
 
class ManualLogEntry extends LogEntryBase implements Taggable {
    protected $type;
 
    protected $subtype;
 
    protected $parameters = [];
 
    protected $relations = [];
 
    protected $performer;
 
    protected $target;
 
    protected $timestamp;
 
    protected $comment = '';
 
    protected $revId = 0;
 
    protected $tags = [];
 
    protected $deleted;
 
    protected $id;
 
    protected $isPatrollable = false;
 
    protected $legacy = false;
 
    public function __construct( $type, $subtype ) {
        $this->type = $type;
        $this->subtype = $subtype;
    }
 
    public function setParameters( $parameters ) {
        $this->parameters = $parameters;
    }
 
    public function setRelations( array $relations ) {
        $this->relations = $relations;
    }
 
    public function setPerformer( UserIdentity $performer ) {
        $this->performer = User::newFromIdentity( $performer );
    }
 
    public function setTarget( LinkTarget $target ) {
        $this->target = Title::newFromLinkTarget( $target );
    }
 
    public function setTimestamp( $timestamp ) {
        $this->timestamp = $timestamp;
    }
 
    public function setComment( $comment ) {
        $this->comment = $comment;
    }
 
    public function setAssociatedRevId( $revId ) {
        $this->revId = $revId;
    }
 
    public function setTags( $tags ) {
        if ( $this->tags ) {
            wfDebug( 'Overwriting existing ManualLogEntry tags' );
        }
        $this->tags = [];
        if ( $tags !== null ) {
            $this->addTags( $tags );
        }
    }
 
    public function addTags( $tags ) {
        if ( is_string( $tags ) ) {
            $tags = [ $tags ];
        }
        Assert::parameterElementType( 'string', $tags, 'tags' );
        $this->tags = array_unique( array_merge( $this->tags, $tags ) );
    }
 
    public function setIsPatrollable( $patrollable ) {
        $this->isPatrollable = (bool)$patrollable;
    }
 
    public function setLegacy( $legacy ) {
        $this->legacy = $legacy;
    }
 
    public function setDeleted( $deleted ) {
        $this->deleted = $deleted;
    }
 
    public function insert( IDatabase $dbw = null ) {
        global $wgActorTableSchemaMigrationStage;
 
        $dbw = $dbw ?: wfGetDB( DB_MASTER );
 
        if ( $this->timestamp === null ) {
            $this->timestamp = wfTimestampNow();
        }
 
        // Trim spaces on user supplied text
        $comment = trim( $this->getComment() );
 
        $params = $this->getParameters();
        $relations = $this->relations;
 
        // Ensure actor relations are set
        if ( ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW ) &&
            empty( $relations['target_author_actor'] )
        ) {
            $actorIds = [];
            if ( !empty( $relations['target_author_id'] ) ) {
                foreach ( $relations['target_author_id'] as $id ) {
                    $actorIds[] = User::newFromId( $id )->getActorId( $dbw );
                }
            }
            if ( !empty( $relations['target_author_ip'] ) ) {
                foreach ( $relations['target_author_ip'] as $ip ) {
                    $actorIds[] = User::newFromName( $ip, false )->getActorId( $dbw );
                }
            }
            if ( $actorIds ) {
                $relations['target_author_actor'] = $actorIds;
                $params['authorActors'] = $actorIds;
            }
        }
        if ( !( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_OLD ) ) {
            unset( $relations['target_author_id'], $relations['target_author_ip'] );
            unset( $params['authorIds'], $params['authorIPs'] );
        }
 
        // Additional fields for which there's no space in the database table schema
        $revId = $this->getAssociatedRevId();
        if ( $revId ) {
            $params['associated_rev_id'] = $revId;
            $relations['associated_rev_id'] = $revId;
        }
 
        $data = [
            'log_type' => $this->getType(),
            'log_action' => $this->getSubtype(),
            'log_timestamp' => $dbw->timestamp( $this->getTimestamp() ),
            'log_namespace' => $this->getTarget()->getNamespace(),
            'log_title' => $this->getTarget()->getDBkey(),
            'log_page' => $this->getTarget()->getArticleID(),
            'log_params' => LogEntryBase::makeParamBlob( $params ),
        ];
        if ( isset( $this->deleted ) ) {
            $data['log_deleted'] = $this->deleted;
        }
        $data += CommentStore::getStore()->insert( $dbw, 'log_comment', $comment );
        $data += ActorMigration::newMigration()
            ->getInsertValues( $dbw, 'log_user', $this->getPerformer() );
 
        $dbw->insert( 'logging', $data, __METHOD__ );
        $this->id = $dbw->insertId();
 
        $rows = [];
        foreach ( $relations as $tag => $values ) {
            if ( !strlen( $tag ) ) {
                throw new MWException( "Got empty log search tag." );
            }
 
            if ( !is_array( $values ) ) {
                $values = [ $values ];
            }
 
            foreach ( $values as $value ) {
                $rows[] = [
                    'ls_field' => $tag,
                    'ls_value' => $value,
                    'ls_log_id' => $this->id
                ];
            }
        }
        if ( count( $rows ) ) {
            $dbw->insert( 'log_search', $rows, __METHOD__, 'IGNORE' );
        }
 
        return $this->id;
    }
 
    public function getRecentChange( $newId = 0 ) {
        $formatter = LogFormatter::newFromEntry( $this );
        $context = RequestContext::newExtraneousContext( $this->getTarget() );
        $formatter->setContext( $context );
 
        $logpage = SpecialPage::getTitleFor( 'Log', $this->getType() );
        $user = $this->getPerformer();
        $ip = "";
        if ( $user->isAnon() ) {
            // "MediaWiki default" and friends may have
            // no IP address in their name
            if ( IP::isIPAddress( $user->getName() ) ) {
                $ip = $user->getName();
            }
        }
 
        return RecentChange::newLogEntry(
            $this->getTimestamp(),
            $logpage,
            $user,
            $formatter->getPlainActionText(),
            $ip,
            $this->getType(),
            $this->getSubtype(),
            $this->getTarget(),
            $this->getComment(),
            LogEntryBase::makeParamBlob( $this->getParameters() ),
            $newId,
            $formatter->getIRCActionComment(), // Used for IRC feeds
            $this->getAssociatedRevId(), // Used for e.g. moves and uploads
            $this->getIsPatrollable()
        );
    }
 
    public function publish( $newId, $to = 'rcandudp' ) {
        $canAddTags = true;
        // FIXME: this code should be removed once all callers properly call publish()
        if ( $to === 'udp' && !$newId && !$this->getAssociatedRevId() ) {
            \MediaWiki\Logger\LoggerFactory::getInstance( 'logging' )->warning(
                'newId and/or revId must be set when calling ManualLogEntry::publish()',
                [
                    'newId' => $newId,
                    'to' => $to,
                    'revId' => $this->getAssociatedRevId(),
                    // pass a new exception to register the stack trace
                    'exception' => new RuntimeException()
                ]
            );
            $canAddTags = false;
        }
 
        DeferredUpdates::addCallableUpdate(
            function () use ( $newId, $to, $canAddTags ) {
                $log = new LogPage( $this->getType() );
                if ( !$log->isRestricted() ) {
                    Hooks::runWithoutAbort( 'ManualLogEntryBeforePublish', [ $this ] );
                    $rc = $this->getRecentChange( $newId );
 
                    if ( $to === 'rc' || $to === 'rcandudp' ) {
                        // save RC, passing tags so they are applied there
                        $rc->addTags( $this->getTags() );
                        $rc->save( $rc::SEND_NONE );
                    } else {
                        $tags = $this->getTags();
                        if ( $tags && $canAddTags ) {
                            $revId = $this->getAssociatedRevId();
                            ChangeTags::addTags(
                                $tags,
                                null,
                                $revId > 0 ? $revId : null,
                                $newId > 0 ? $newId : null
                            );
                        }
                    }
 
                    if ( $to === 'udp' || $to === 'rcandudp' ) {
                        $rc->notifyRCFeeds();
                    }
                }
            },
            DeferredUpdates::POSTSEND,
            wfGetDB( DB_MASTER )
        );
    }
 
    public function getType() {
        return $this->type;
    }
 
    public function getSubtype() {
        return $this->subtype;
    }
 
    public function getParameters() {
        return $this->parameters;
    }
 
    public function getPerformer() {
        return $this->performer;
    }
 
    public function getTarget() {
        return $this->target;
    }
 
    public function getTimestamp() {
        $ts = $this->timestamp ?? wfTimestampNow();
 
        return wfTimestamp( TS_MW, $ts );
    }
 
    public function getComment() {
        return $this->comment;
    }
 
    public function getAssociatedRevId() {
        return $this->revId;
    }
 
    public function getTags() {
        return $this->tags;
    }
 
    public function getIsPatrollable() {
        return $this->isPatrollable;
    }
 
    public function isLegacy() {
        return $this->legacy;
    }
 
    public function getDeleted() {
        return (int)$this->deleted;
    }
}