ManualLogEntry.php

Go to the documentation of this file.

<?php
use MediaWiki\ChangeTags\Taggable;
use MediaWiki\Linker\LinkTarget;
use MediaWiki\User\UserIdentity;
use Wikimedia\Assert\Assert;
use Wikimedia\IPUtils;
use Wikimedia\Rdbms\IDatabase;
 
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 = (string)$comment;
    }
 
    public function setAssociatedRevId( $revId ) {
        $this->revId = $revId;
    }
 
    public function setTags( $tags ) {
        if ( $this->tags ) {
            wfDebug( 'Overwriting existing ManualLogEntry tags' );
        }
        $this->tags = [];
        $this->addTags( $tags );
    }
 
    public function addTags( $tags ) {
        if ( $tags === null ) {
            return;
        }
 
        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 ) {
        $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;
 
        // 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 ( IPUtils::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::runner()->onManualLogEntryBeforePublish( $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;
    }
}