LogPage.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Logging;
 
use MediaWiki\Context\RequestContext;
use MediaWiki\Language\Language;
use MediaWiki\MainConfigNames;
use MediaWiki\MediaWikiServices;
use MediaWiki\Message\Message;
use MediaWiki\Skin\Skin;
use MediaWiki\SpecialPage\SpecialPage;
use MediaWiki\Title\Title;
use MediaWiki\User\User;
use MediaWiki\User\UserIdentity;
 
class LogPage {
    public const DELETED_ACTION = 1;
    public const DELETED_COMMENT = 2;
    public const DELETED_USER = 4;
    public const DELETED_RESTRICTED = 8;
 
    // Convenience fields
    public const SUPPRESSED_USER = self::DELETED_USER | self::DELETED_RESTRICTED;
    public const SUPPRESSED_ACTION = self::DELETED_ACTION | self::DELETED_RESTRICTED;
 
    public $updateRecentChanges;
 
    public $sendToUDP;
 
    private $ircActionText;
 
    private $actionText;
 
    private $type;
 
    private $action;
 
    private $comment;
 
    private $params;
 
    private $performer;
 
    private $target;
 
    public function __construct( $type, $rc = true, $udp = 'skipUDP' ) {
        $this->type = $type;
        $this->updateRecentChanges = $rc;
        $this->sendToUDP = ( $udp == 'UDP' );
    }
 
    protected function saveContent() {
        $services = MediaWikiServices::getInstance();
        $logRestrictions = $services->getMainConfig()->get( MainConfigNames::LogRestrictions );
        $recentChangeStore = $services->getRecentChangeStore();
        $recentChangeRCFeedNotifier = $services->getRecentChangeRCFeedNotifier();
        $dbw = $services->getConnectionProvider()->getPrimaryDatabase();
 
        $now = wfTimestampNow();
        $actorId = $services->getActorNormalization()
            ->acquireActorId( $this->performer, $dbw );
        $data = [
            'log_type' => $this->type,
            'log_action' => $this->action,
            'log_timestamp' => $dbw->timestamp( $now ),
            'log_actor' => $actorId,
            'log_namespace' => $this->target->getNamespace(),
            'log_title' => $this->target->getDBkey(),
            'log_page' => $this->target->getArticleID(),
            'log_params' => $this->params
        ];
        $data += $services->getCommentStore()->insert(
            $dbw,
            'log_comment',
            $this->comment
        );
        $dbw->newInsertQueryBuilder()
            ->insertInto( 'logging' )
            ->row( $data )
            ->caller( __METHOD__ )->execute();
        $newId = $dbw->insertId();
 
        // Don't add private logs to RC or send them to UDP
        if ( isset( $logRestrictions[$this->type] ) && $logRestrictions[$this->type] != '*' ) {
            return $newId;
        }
 
        if ( $this->updateRecentChanges ) {
            $titleObj = SpecialPage::getTitleFor( 'Log', $this->type );
 
            $recentChange = $recentChangeStore->createLogRecentChange(
                $now, $titleObj, $this->performer, $this->getRcComment(), '',
                $this->type, $this->action, $this->target, $this->comment,
                $this->params, $newId, $this->getRcCommentIRC()
            );
            $recentChangeStore->insertRecentChange( $recentChange );
        } elseif ( $this->sendToUDP ) {
            // Notify external application via UDP.
            // We send this to IRC but do not want to add it the RC table.
            $titleObj = SpecialPage::getTitleFor( 'Log', $this->type );
            $recentChange = $recentChangeStore->createLogRecentChange(
                $now, $titleObj, $this->performer, $this->getRcComment(), '',
                $this->type, $this->action, $this->target, $this->comment,
                $this->params, $newId, $this->getRcCommentIRC()
            );
            $recentChangeRCFeedNotifier->notifyRCFeeds( $recentChange );
        }
 
        return $newId;
    }
 
    public function getRcComment() {
        $rcComment = $this->actionText;
 
        if ( $this->comment != '' ) {
            if ( $rcComment == '' ) {
                $rcComment = $this->comment;
            } else {
                $rcComment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() .
                    $this->comment;
            }
        }
 
        return $rcComment;
    }
 
    public function getRcCommentIRC() {
        $rcComment = $this->ircActionText;
 
        if ( $this->comment != '' ) {
            if ( $rcComment == '' ) {
                $rcComment = $this->comment;
            } else {
                $rcComment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() .
                    $this->comment;
            }
        }
 
        return $rcComment;
    }
 
    public function getComment() {
        return $this->comment;
    }
 
    public static function validTypes() {
        $logTypes = MediaWikiServices::getInstance()->getMainConfig()->get( MainConfigNames::LogTypes );
 
        return $logTypes;
    }
 
    public static function isLogType( $type ) {
        return in_array( $type, self::validTypes() );
    }
 
    public static function actionText( $type, $action, $title = null, $skin = null,
        $params = [], $filterWikilinks = false
    ) {
        $config = MediaWikiServices::getInstance()->getMainConfig();
        $key = "$type/$action";
 
        $logActions = $config->get( MainConfigNames::LogActions );
 
        if ( isset( $logActions[$key] ) ) {
            $message = $logActions[$key];
        } else {
            wfDebug( "LogPage::actionText - unknown action $key" );
            $message = "log-unknown-action";
            $params = [ $key ];
        }
 
        if ( $skin === null ) {
            $langObj = MediaWikiServices::getInstance()->getContentLanguage();
            $langObjOrNull = null;
        } else {
            $langObj = $langObjOrNull = $skin->getLanguage();
        }
        if ( $title === null ) {
            $rv = wfMessage( $message )->inLanguage( $langObj )->escaped();
        } else {
            $titleLink = self::getTitleLink( $title, $langObjOrNull );
 
            if ( count( $params ) == 0 ) {
                $rv = wfMessage( $message )->rawParams( $titleLink )
                    ->inLanguage( $langObj )->escaped();
            } else {
                array_unshift( $params, $titleLink );
 
                $rv = wfMessage( $message )->rawParams( $params )
                        ->inLanguage( $langObj )->escaped();
            }
        }
 
        // For the perplexed, this feature was added in r7855 by Erik.
        // The feature was added because we liked adding [[$1]] in our log entries
        // but the log entries are parsed as Wikitext on RecentChanges but as HTML
        // on Special:Log. The hack is essentially that [[$1]] represented a link
        // to the title in question. The first parameter to the HTML version (Special:Log)
        // is that link in HTML form, and so this just gets rid of the ugly [[]].
        // However, this is a horrible hack and it doesn't work like you expect if, say,
        // you want to link to something OTHER than the title of the log entry.
        // The real problem, which Erik was trying to fix (and it sort-of works now) is
        // that the same messages are being treated as both wikitext *and* HTML.
        if ( $filterWikilinks ) {
            $rv = str_replace( '[[', '', $rv );
            $rv = str_replace( ']]', '', $rv );
        }
 
        return $rv;
    }
 
    private static function getTitleLink( Title $title, ?Language $lang ): string {
        if ( !$lang ) {
            return $title->getPrefixedText();
        }
 
        $services = MediaWikiServices::getInstance();
        $linkRenderer = $services->getLinkRenderer();
 
        if ( $title->isSpecialPage() ) {
            [ $name, $par ] = $services->getSpecialPageFactory()->resolveAlias( $title->getDBkey() );
 
            if ( $name === 'Log' ) {
                $logPage = new LogPage( $par ?? '' );
                return wfMessage( 'parentheses' )
                    ->rawParams( $linkRenderer->makeLink( $title, $logPage->getName()->text() ) )
                    ->inLanguage( $lang )
                    ->escaped();
            }
        }
 
        return $linkRenderer->makeLink( $title );
    }
 
    public function addEntry( $action, $target, $comment, $params, $performer ) {
        // FIXME $params is only documented to accept an array
        if ( !is_array( $params ) ) {
            $params = [ $params ];
        }
 
        # Trim spaces on user supplied text
        $comment = trim( $comment ?? '' );
 
        $this->action = $action;
        $this->target = $target;
        $this->comment = $comment;
        $this->params = self::makeParamBlob( $params );
 
        if ( !is_object( $performer ) ) {
            $performer = User::newFromId( $performer );
        }
 
        $this->performer = $performer;
 
        $logEntry = new ManualLogEntry( $this->type, $action );
        $logEntry->setTarget( $target );
        $logEntry->setPerformer( $performer );
        $logEntry->setParameters( $params );
        // All log entries using the LogPage to insert into the logging table
        // are using the old logging system and therefore the legacy flag is
        // needed to say the LogFormatter the parameters have numeric keys
        $logEntry->setLegacy( true );
 
        $formatter = MediaWikiServices::getInstance()->getLogFormatterFactory()->newFromEntry( $logEntry );
        $context = RequestContext::newExtraneousContext( $target );
        $formatter->setContext( $context );
 
        $this->actionText = $formatter->getPlainActionText();
        $this->ircActionText = $formatter->getIRCActionText();
 
        return $this->saveContent();
    }
 
    public static function makeParamBlob( $params ) {
        return implode( "\n", $params );
    }
 
    public static function extractParams( $blob ) {
        if ( $blob === '' ) {
            return [];
        } else {
            return explode( "\n", $blob );
        }
    }
 
    public function getName() {
        $logNames = MediaWikiServices::getInstance()->getMainConfig()->get( MainConfigNames::LogNames );
 
        // BC
        $key = $logNames[$this->type] ?? 'log-name-' . $this->type;
 
        return wfMessage( $key );
    }
 
    public function getDescription() {
        $logHeaders = MediaWikiServices::getInstance()->getMainConfig()->get( MainConfigNames::LogHeaders );
        // BC
        $key = $logHeaders[$this->type] ?? 'log-description-' . $this->type;
 
        return wfMessage( $key );
    }
 
    public function getRestriction() {
        $logRestrictions = MediaWikiServices::getInstance()->getMainConfig()->get( MainConfigNames::LogRestrictions );
        // The empty string fallback will
        // always return true in permission check
        return $logRestrictions[$this->type] ?? '';
    }
 
    public function isRestricted() {
        $restriction = $this->getRestriction();
 
        return $restriction !== '' && $restriction !== '*';
    }
}
 
class_alias( LogPage::class, 'LogPage' );