RecentChange.php

Go to the documentation of this file.

<?php
use MediaWiki\ChangeTags\Taggable;
use MediaWiki\MediaWikiServices;
use MediaWiki\Page\PageIdentity;
use MediaWiki\Page\PageReference;
use MediaWiki\Page\PageReferenceValue;
use MediaWiki\Permissions\Authority;
use MediaWiki\Permissions\PermissionStatus;
use MediaWiki\Storage\EditResult;
use MediaWiki\User\UserIdentity;
use MediaWiki\User\UserIdentityValue;
use Wikimedia\Assert\Assert;
use Wikimedia\IPUtils;
 
class RecentChange implements Taggable {
    use DeprecationHelper;
 
    // Constants for the rc_source field.  Extensions may also have
    // their own source constants.
    public const SRC_EDIT = 'mw.edit';
    public const SRC_NEW = 'mw.new';
    public const SRC_LOG = 'mw.log';
    public const SRC_EXTERNAL = 'mw.external'; // obsolete
    public const SRC_CATEGORIZE = 'mw.categorize';
 
    public const PRC_UNPATROLLED = 0;
    public const PRC_PATROLLED = 1;
    public const PRC_AUTOPATROLLED = 2;
 
    public const SEND_NONE = true;
 
    public const SEND_FEED = false;
 
    public $mAttribs = [];
    public $mExtra = [];
 
    private $mPage = null;
 
    private $mPerformer = null;
 
    public $numberofWatchingusers = 0; # Dummy to prevent error message in SpecialRecentChangesLinked
    public $notificationtimestamp;
 
    public $watchlistExpiry;
 
    public $counter = -1;
 
    private $tags = [];
 
    private $editResult = null;
 
    private const CHANGE_TYPES = [
        'edit' => RC_EDIT,
        'new' => RC_NEW,
        'log' => RC_LOG,
        'external' => RC_EXTERNAL,
        'categorize' => RC_CATEGORIZE,
    ];
 
    # Factory methods
 
    public static function newFromRow( $row ) {
        $rc = new RecentChange;
        $rc->loadFromRow( $row );
 
        return $rc;
    }
 
    public static function parseToRCType( $type ) {
        if ( is_array( $type ) ) {
            $retval = [];
            foreach ( $type as $t ) {
                $retval[] = self::parseToRCType( $t );
            }
 
            return $retval;
        }
 
        if ( !array_key_exists( $type, self::CHANGE_TYPES ) ) {
            throw new MWException( "Unknown type '$type'" );
        }
        return self::CHANGE_TYPES[$type];
    }
 
    public static function parseFromRCType( $rcType ) {
        return array_search( $rcType, self::CHANGE_TYPES, true ) ?: "$rcType";
    }
 
    public static function getChangeTypes() {
        return array_keys( self::CHANGE_TYPES );
    }
 
    public static function newFromId( $rcid ) {
        return self::newFromConds( [ 'rc_id' => $rcid ], __METHOD__ );
    }
 
    public static function newFromConds(
        $conds,
        $fname = __METHOD__,
        $dbType = DB_REPLICA
    ) {
        $db = wfGetDB( $dbType );
        $rcQuery = self::getQueryInfo();
        $row = $db->selectRow(
            $rcQuery['tables'], $rcQuery['fields'], $conds, $fname, [], $rcQuery['joins']
        );
        if ( $row !== false ) {
            return self::newFromRow( $row );
        } else {
            return null;
        }
    }
 
    public static function getQueryInfo() {
        $commentQuery = CommentStore::getStore()->getJoin( 'rc_comment' );
        return [
            'tables' => [
                'recentchanges',
                'recentchanges_actor' => 'actor'
            ] + $commentQuery['tables'],
            'fields' => [
                'rc_id',
                'rc_timestamp',
                'rc_namespace',
                'rc_title',
                'rc_minor',
                'rc_bot',
                'rc_new',
                'rc_cur_id',
                'rc_this_oldid',
                'rc_last_oldid',
                'rc_type',
                'rc_source',
                'rc_patrolled',
                'rc_ip',
                'rc_old_len',
                'rc_new_len',
                'rc_deleted',
                'rc_logid',
                'rc_log_type',
                'rc_log_action',
                'rc_params',
                'rc_actor',
                'rc_user' => 'recentchanges_actor.actor_user',
                'rc_user_text' => 'recentchanges_actor.actor_name',
            ] + $commentQuery['fields'],
            'joins' => [
                'recentchanges_actor' => [ 'JOIN', 'actor_id=rc_actor' ]
            ] + $commentQuery['joins'],
        ];
    }
 
    public function __construct() {
        $this->deprecatePublicPropertyFallback(
            'mTitle',
            '1.37',
            function () {
                return Title::castFromPageReference( $this->mPage );
            },
            function ( ?Title $title ) {
                $this->mPage = $title;
            }
        );
    }
 
    # Accessors
 
    public function setAttribs( $attribs ) {
        $this->mAttribs = $attribs;
    }
 
    public function setExtra( $extra ) {
        $this->mExtra = $extra;
    }
 
    public function getTitle() {
        $this->mPage = Title::castFromPageReference( $this->getPage() );
        return $this->mPage ?: Title::makeTitle( NS_SPECIAL, 'BadTitle' );
    }
 
    public function getPage(): ?PageReference {
        if ( !$this->mPage ) {
            // NOTE: As per the 1.36 release, we always provide rc_title,
            //       even in cases where it doesn't really make sense.
            //       In the future, rc_title may be nullable, or we may use
            //       empty strings in entries that do not refer to a page.
            if ( ( $this->mAttribs['rc_title'] ?? '' ) === '' ) {
                return null;
            }
 
            // XXX: We could use rc_cur_id to create a PageIdentityValue,
            //      at least if it's not a special page.
            //      However, newForCategorization() puts the ID of the categorized page into
            //      rc_cur_id, but the title of the category page into rc_title.
            $this->mPage = new PageReferenceValue(
                (int)$this->mAttribs['rc_namespace'],
                $this->mAttribs['rc_title'],
                PageReference::LOCAL
            );
        }
 
        return $this->mPage;
    }
 
    public function getPerformer(): User {
        wfDeprecated( __METHOD__, '1.36' );
        if ( !$this->mPerformer instanceof User ) {
            $this->mPerformer = User::newFromIdentity( $this->getPerformerIdentity() );
        }
 
        return $this->mPerformer;
    }
 
    public function getPerformerIdentity(): UserIdentity {
        if ( !$this->mPerformer ) {
            $this->mPerformer = $this->getUserIdentityFromAnyId(
                $this->mAttribs['rc_user'] ?? null,
                $this->mAttribs['rc_user_text'] ?? null,
                $this->mAttribs['rc_actor'] ?? null
            );
        }
 
        return $this->mPerformer;
    }
 
    public function save( $send = self::SEND_FEED ) {
        $mainConfig = MediaWikiServices::getInstance()->getMainConfig();
        $putIPinRC = $mainConfig->get( 'PutIPinRC' );
        $useEnotif = $mainConfig->get( 'UseEnotif' );
        $showUpdatedMarker = $mainConfig->get( 'ShowUpdatedMarker' );
        $dbw = wfGetDB( DB_PRIMARY );
        if ( !is_array( $this->mExtra ) ) {
            $this->mExtra = [];
        }
 
        if ( !$putIPinRC ) {
            $this->mAttribs['rc_ip'] = '';
        }
 
        # Strict mode fixups (not-NULL fields)
        foreach ( [ 'minor', 'bot', 'new', 'patrolled', 'deleted' ] as $field ) {
            $this->mAttribs["rc_$field"] = (int)$this->mAttribs["rc_$field"];
        }
        # ...more fixups (NULL fields)
        foreach ( [ 'old_len', 'new_len' ] as $field ) {
            $this->mAttribs["rc_$field"] = isset( $this->mAttribs["rc_$field"] )
                ? (int)$this->mAttribs["rc_$field"]
                : null;
        }
 
        # If our database is strict about IP addresses, use NULL instead of an empty string
        $strictIPs = $dbw->getType() === 'postgres'; // legacy
        if ( $strictIPs && $this->mAttribs['rc_ip'] == '' ) {
            unset( $this->mAttribs['rc_ip'] );
        }
 
        $row = $this->mAttribs;
 
        # Trim spaces on user supplied text
        $row['rc_comment'] = trim( $row['rc_comment'] );
 
        # Fixup database timestamps
        $row['rc_timestamp'] = $dbw->timestamp( $row['rc_timestamp'] );
 
        # # If we are using foreign keys, an entry of 0 for the page_id will fail, so use NULL
        if ( $row['rc_cur_id'] == 0 ) {
            unset( $row['rc_cur_id'] );
        }
 
        # Convert mAttribs['rc_comment'] for CommentStore
        $comment = $row['rc_comment'];
        unset( $row['rc_comment'], $row['rc_comment_text'], $row['rc_comment_data'] );
        $row += CommentStore::getStore()->insert( $dbw, 'rc_comment', $comment );
 
        # Normalize UserIdentity to actor ID
        $user = $this->getPerformerIdentity();
        $actorStore = MediaWikiServices::getInstance()->getActorStore();
        $row['rc_actor'] = $actorStore->acquireActorId( $user, $dbw );
        unset( $row['rc_user'], $row['rc_user_text'] );
 
        # Don't reuse an existing rc_id for the new row, if one happens to be
        # set for some reason.
        unset( $row['rc_id'] );
 
        # Insert new row
        $dbw->insert( 'recentchanges', $row, __METHOD__ );
 
        # Set the ID
        $this->mAttribs['rc_id'] = $dbw->insertId();
 
        # Notify extensions
        Hooks::runner()->onRecentChange_save( $this );
 
        // Apply revert tags (if needed)
        if ( $this->editResult !== null && count( $this->editResult->getRevertTags() ) ) {
            ChangeTags::addTags(
                $this->editResult->getRevertTags(),
                $this->mAttribs['rc_id'],
                $this->mAttribs['rc_this_oldid'],
                $this->mAttribs['rc_logid'],
                FormatJson::encode( $this->editResult ),
                $this
            );
        }
 
        if ( count( $this->tags ) ) {
            // $this->tags may contain revert tags we already applied above, they will
            // just be ignored.
            ChangeTags::addTags(
                $this->tags,
                $this->mAttribs['rc_id'],
                $this->mAttribs['rc_this_oldid'],
                $this->mAttribs['rc_logid'],
                null,
                $this
            );
        }
 
        if ( $send === self::SEND_FEED ) {
            // Emit the change to external applications via RCFeeds.
            $this->notifyRCFeeds();
        }
 
        # E-mail notifications
        if ( $useEnotif || $showUpdatedMarker ) {
            $userFactory = MediaWikiServices::getInstance()->getUserFactory();
            $editor = $userFactory->newFromUserIdentity( $this->getPerformerIdentity() );
            $page = $this->getPage();
            $title = Title::castFromPageReference( $page );
 
            // Never send an RC notification email about categorization changes
            if (
                $title &&
                Hooks::runner()->onAbortEmailNotification( $editor, $title, $this ) &&
                $this->mAttribs['rc_type'] != RC_CATEGORIZE
            ) {
                // @FIXME: This would be better as an extension hook
                // Send emails or email jobs once this row is safely committed
                $dbw->onTransactionCommitOrIdle(
                    function () use ( $editor, $title ) {
                        $enotif = new EmailNotification();
                        $enotif->notifyOnPageChange(
                            $editor,
                            $title,
                            $this->mAttribs['rc_timestamp'],
                            $this->mAttribs['rc_comment'],
                            $this->mAttribs['rc_minor'],
                            $this->mAttribs['rc_last_oldid'],
                            $this->mExtra['pageStatus']
                        );
                    },
                    __METHOD__
                );
            }
        }
 
        $jobs = [];
        // Flush old entries from the `recentchanges` table
        if ( mt_rand( 0, 9 ) == 0 ) {
            $jobs[] = RecentChangesUpdateJob::newPurgeJob();
        }
        // Update the cached list of active users
        if ( $this->mAttribs['rc_user'] > 0 ) {
            $jobs[] = RecentChangesUpdateJob::newCacheUpdateJob();
        }
        JobQueueGroup::singleton()->lazyPush( $jobs );
    }
 
    public function notifyRCFeeds( array $feeds = null ) {
        $rcFeeds = MediaWikiServices::getInstance()->getMainConfig()->get( 'RCFeeds' );
        if ( $feeds === null ) {
            $feeds = $rcFeeds;
        }
 
        $performer = $this->getPerformerIdentity();
 
        foreach ( $feeds as $params ) {
            $params += [
                'omit_bots' => false,
                'omit_anon' => false,
                'omit_user' => false,
                'omit_minor' => false,
                'omit_patrolled' => false,
            ];
 
            if (
                ( $params['omit_bots'] && $this->mAttribs['rc_bot'] ) ||
                ( $params['omit_anon'] && !$performer->isRegistered() ) ||
                ( $params['omit_user'] && $performer->isRegistered() ) ||
                ( $params['omit_minor'] && $this->mAttribs['rc_minor'] ) ||
                ( $params['omit_patrolled'] && $this->mAttribs['rc_patrolled'] ) ||
                $this->mAttribs['rc_type'] == RC_EXTERNAL
            ) {
                continue;
            }
 
            $actionComment = $this->mExtra['actionCommentIRC'] ?? null;
 
            $feed = RCFeed::factory( $params );
            $feed->notify( $this, $actionComment );
        }
    }
 
    public static function getEngine( $uri, $params = [] ) {
        // TODO: Merge into RCFeed::factory().
        $rcEngines = MediaWikiServices::getInstance()->getMainConfig()->get( 'RCEngines' );
        $scheme = parse_url( $uri, PHP_URL_SCHEME );
        if ( !$scheme ) {
            throw new MWException( "Invalid RCFeed uri: '$uri'" );
        }
        if ( !isset( $rcEngines[$scheme] ) ) {
            throw new MWException( "Unknown RCFeedEngine scheme: '$scheme'" );
        }
        if ( defined( 'MW_PHPUNIT_TEST' ) && is_object( $rcEngines[$scheme] ) ) {
            return $rcEngines[$scheme];
        }
        // TODO For non test a object could be here?
        return new $rcEngines[$scheme]( $params );
    }
 
    public function doMarkPatrolled( Authority $performer, $auto = false, $tags = null ) {
        $mainConfig = MediaWikiServices::getInstance()->getMainConfig();
        $useRCPatrol = $mainConfig->get( 'UseRCPatrol' );
        $useNPPatrol = $mainConfig->get( 'UseNPPatrol' );
        $useFilePatrol = $mainConfig->get( 'UseFilePatrol' );
        // Fix up $tags so that the MarkPatrolled hook below always gets an array
        if ( $tags === null ) {
            $tags = [];
        } elseif ( is_string( $tags ) ) {
            $tags = [ $tags ];
        }
 
        $status = PermissionStatus::newEmpty();
        // If recentchanges patrol is disabled, only new pages or new file versions
        // can be patrolled, provided the appropriate config variable is set
        if ( !$useRCPatrol && ( !$useNPPatrol || $this->getAttribute( 'rc_type' ) != RC_NEW ) &&
            ( !$useFilePatrol || !( $this->getAttribute( 'rc_type' ) == RC_LOG &&
            $this->getAttribute( 'rc_log_type' ) == 'upload' ) ) ) {
            $status->fatal( 'rcpatroldisabled' );
        }
        // Automatic patrol needs "autopatrol", ordinary patrol needs "patrol"
        $performer->authorizeWrite( $auto ? 'autopatrol' : 'patrol', $this->getTitle(), $status );
        $user = MediaWikiServices::getInstance()->getUserFactory()->newFromAuthority( $performer );
        if ( !Hooks::runner()->onMarkPatrolled(
            $this->getAttribute( 'rc_id' ), $user, false, $auto, $tags )
        ) {
            $status->fatal( 'hookaborted' );
        }
        // Users without the 'autopatrol' right can't patrol their own revisions
        if ( $performer->getUser()->getName() === $this->getAttribute( 'rc_user_text' ) &&
            !$performer->isAllowed( 'autopatrol' )
        ) {
            $status->fatal( 'markedaspatrollederror-noautopatrol' );
        }
        if ( !$status->isGood() ) {
            return $status->toLegacyErrorArray();
        }
        // If the change was patrolled already, do nothing
        if ( $this->getAttribute( 'rc_patrolled' ) ) {
            return [];
        }
        // Actually set the 'patrolled' flag in RC
        $this->reallyMarkPatrolled();
        // Log this patrol event
        PatrolLog::record( $this, $auto, $performer->getUser(), $tags );
 
        Hooks::runner()->onMarkPatrolledComplete(
            $this->getAttribute( 'rc_id' ), $user, false, $auto );
 
        return [];
    }
 
    public function reallyMarkPatrolled() {
        $dbw = wfGetDB( DB_PRIMARY );
        $dbw->update(
            'recentchanges',
            [
                'rc_patrolled' => self::PRC_PATROLLED
            ],
            [
                'rc_id' => $this->getAttribute( 'rc_id' )
            ],
            __METHOD__
        );
        // Invalidate the page cache after the page has been patrolled
        // to make sure that the Patrol link isn't visible any longer!
        $this->getTitle()->invalidateCache();
 
        // Enqueue a reverted tag update (in case the edit was a revert)
        $revisionId = $this->getAttribute( 'rc_this_oldid' );
        if ( $revisionId ) {
            $revertedTagUpdateManager =
                MediaWikiServices::getInstance()->getRevertedTagUpdateManager();
            $revertedTagUpdateManager->approveRevertedTagForRevision( $revisionId );
        }
 
        return $dbw->affectedRows();
    }
 
    public static function notifyEdit(
        $timestamp, $page, $minor, $user, $comment, $oldId, $lastTimestamp,
        $bot, $ip = '', $oldSize = 0, $newSize = 0, $newId = 0, $patrol = 0,
        $tags = [], EditResult $editResult = null
    ) {
        Assert::parameter( $page->exists(), '$page', 'must represent an existing page' );
 
        $rc = new RecentChange;
        $rc->mPage = $page;
        $rc->mPerformer = $user;
        $rc->mAttribs = [
            'rc_timestamp' => $timestamp,
            'rc_namespace' => $page->getNamespace(),
            'rc_title' => $page->getDBkey(),
            'rc_type' => RC_EDIT,
            'rc_source' => self::SRC_EDIT,
            'rc_minor' => $minor ? 1 : 0,
            'rc_cur_id' => $page->getId(),
            'rc_user' => $user->getId(),
            'rc_user_text' => $user->getName(),
            'rc_comment' => &$comment,
            'rc_comment_text' => &$comment,
            'rc_comment_data' => null,
            'rc_this_oldid' => (int)$newId,
            'rc_last_oldid' => $oldId,
            'rc_bot' => $bot ? 1 : 0,
            'rc_ip' => self::checkIPAddress( $ip ),
            'rc_patrolled' => intval( $patrol ),
            'rc_new' => 0, # obsolete
            'rc_old_len' => $oldSize,
            'rc_new_len' => $newSize,
            'rc_deleted' => 0,
            'rc_logid' => 0,
            'rc_log_type' => null,
            'rc_log_action' => '',
            'rc_params' => ''
        ];
 
        // TODO: deprecate the 'prefixedDBkey' entry, let callers do the formatting.
        $formatter = MediaWikiServices::getInstance()->getTitleFormatter();
 
        $rc->mExtra = [
            'prefixedDBkey' => $formatter->getPrefixedDBkey( $page ),
            'lastTimestamp' => $lastTimestamp,
            'oldSize' => $oldSize,
            'newSize' => $newSize,
            'pageStatus' => 'changed'
        ];
 
        DeferredUpdates::addCallableUpdate(
            static function () use ( $rc, $tags, $editResult ) {
                $rc->addTags( $tags );
                $rc->setEditResult( $editResult );
                $rc->save();
            },
            DeferredUpdates::POSTSEND,
            wfGetDB( DB_PRIMARY )
        );
 
        return $rc;
    }
 
    public static function notifyNew(
        $timestamp,
        $page, $minor, $user, $comment, $bot,
        $ip = '', $size = 0, $newId = 0, $patrol = 0, $tags = []
    ) {
        Assert::parameter( $page->exists(), '$page', 'must represent an existing page' );
 
        $rc = new RecentChange;
        $rc->mPage = $page;
        $rc->mPerformer = $user;
        $rc->mAttribs = [
            'rc_timestamp' => $timestamp,
            'rc_namespace' => $page->getNamespace(),
            'rc_title' => $page->getDBkey(),
            'rc_type' => RC_NEW,
            'rc_source' => self::SRC_NEW,
            'rc_minor' => $minor ? 1 : 0,
            'rc_cur_id' => $page->getId(),
            'rc_user' => $user->getId(),
            'rc_user_text' => $user->getName(),
            'rc_comment' => &$comment,
            'rc_comment_text' => &$comment,
            'rc_comment_data' => null,
            'rc_this_oldid' => (int)$newId,
            'rc_last_oldid' => 0,
            'rc_bot' => $bot ? 1 : 0,
            'rc_ip' => self::checkIPAddress( $ip ),
            'rc_patrolled' => intval( $patrol ),
            'rc_new' => 1, # obsolete
            'rc_old_len' => 0,
            'rc_new_len' => $size,
            'rc_deleted' => 0,
            'rc_logid' => 0,
            'rc_log_type' => null,
            'rc_log_action' => '',
            'rc_params' => ''
        ];
 
        // TODO: deprecate the 'prefixedDBkey' entry, let callers do the formatting.
        $formatter = MediaWikiServices::getInstance()->getTitleFormatter();
 
        $rc->mExtra = [
            'prefixedDBkey' => $formatter->getPrefixedDBkey( $page ),
            'lastTimestamp' => 0,
            'oldSize' => 0,
            'newSize' => $size,
            'pageStatus' => 'created'
        ];
 
        DeferredUpdates::addCallableUpdate(
            static function () use ( $rc, $tags ) {
                $rc->addTags( $tags );
                $rc->save();
            },
            DeferredUpdates::POSTSEND,
            wfGetDB( DB_PRIMARY )
        );
 
        return $rc;
    }
 
    public static function notifyLog( $timestamp,
        $logPage, $user, $actionComment, $ip, $type,
        $action, $target, $logComment, $params, $newId = 0, $actionCommentIRC = ''
    ) {
        $logRestrictions = MediaWikiServices::getInstance()->getMainConfig()->get( 'LogRestrictions' );
 
        # Don't add private logs to RC!
        if ( isset( $logRestrictions[$type] ) && $logRestrictions[$type] != '*' ) {
            return false;
        }
        $rc = self::newLogEntry( $timestamp,
            $logPage, $user, $actionComment, $ip, $type, $action,
            $target, $logComment, $params, $newId, $actionCommentIRC );
        $rc->save();
 
        return true;
    }
 
    public static function newLogEntry( $timestamp,
        $logPage, $user, $actionComment, $ip,
        $type, $action, $target, $logComment, $params, $newId = 0, $actionCommentIRC = '',
        $revId = 0, $isPatrollable = false ) {
        global $wgRequest;
        $permissionManager = MediaWikiServices::getInstance()->getPermissionManager();
 
        # # Get pageStatus for email notification
        switch ( $type . '-' . $action ) {
            case 'delete-delete':
            case 'delete-delete_redir':
            case 'delete-delete_redir2':
                $pageStatus = 'deleted';
                break;
            case 'move-move':
            case 'move-move_redir':
                $pageStatus = 'moved';
                break;
            case 'delete-restore':
                $pageStatus = 'restored';
                break;
            case 'upload-upload':
                $pageStatus = 'created';
                break;
            case 'upload-overwrite':
            default:
                $pageStatus = 'changed';
                break;
        }
 
        // Allow unpatrolled status for patrollable log entries
        $canAutopatrol = $permissionManager->userHasRight( $user, 'autopatrol' );
        $markPatrolled = $isPatrollable ? $canAutopatrol : true;
 
        if ( $target instanceof PageIdentity && $target->canExist() ) {
            $pageId = $target->getId();
        } else {
            $pageId = 0;
        }
 
        $rc = new RecentChange;
        $rc->mPage = $target;
        $rc->mPerformer = $user;
        $rc->mAttribs = [
            'rc_timestamp' => $timestamp,
            'rc_namespace' => $target->getNamespace(),
            'rc_title' => $target->getDBkey(),
            'rc_type' => RC_LOG,
            'rc_source' => self::SRC_LOG,
            'rc_minor' => 0,
            'rc_cur_id' => $pageId,
            'rc_user' => $user->getId(),
            'rc_user_text' => $user->getName(),
            'rc_comment' => &$logComment,
            'rc_comment_text' => &$logComment,
            'rc_comment_data' => null,
            'rc_this_oldid' => (int)$revId,
            'rc_last_oldid' => 0,
            'rc_bot' => $permissionManager->userHasRight( $user, 'bot' ) ?
                (int)$wgRequest->getBool( 'bot', true ) : 0,
            'rc_ip' => self::checkIPAddress( $ip ),
            'rc_patrolled' => $markPatrolled ? self::PRC_AUTOPATROLLED : self::PRC_UNPATROLLED,
            'rc_new' => 0, # obsolete
            'rc_old_len' => null,
            'rc_new_len' => null,
            'rc_deleted' => 0,
            'rc_logid' => $newId,
            'rc_log_type' => $type,
            'rc_log_action' => $action,
            'rc_params' => $params
        ];
 
        // TODO: deprecate the 'prefixedDBkey' entry, let callers do the formatting.
        $formatter = MediaWikiServices::getInstance()->getTitleFormatter();
 
        $rc->mExtra = [
            // XXX: This does not correspond to rc_namespace/rc_title/rc_cur_id.
            //      Is that intentional? For all other kinds of RC entries, prefixedDBkey
            //      matches rc_namespace/rc_title. Do we even need $logPage?
            'prefixedDBkey' => $formatter->getPrefixedDBkey( $logPage ),
            'lastTimestamp' => 0,
            'actionComment' => $actionComment, // the comment appended to the action, passed from LogPage
            'pageStatus' => $pageStatus,
            'actionCommentIRC' => $actionCommentIRC
        ];
 
        return $rc;
    }
 
    public static function newForCategorization(
        $timestamp,
        PageIdentity $categoryTitle,
        ?UserIdentity $user,
        $comment,
        PageIdentity $pageTitle,
        $oldRevId,
        $newRevId,
        $lastTimestamp,
        $bot,
        $ip = '',
        $deleted = 0,
        $added = null
    ) {
        // Done in a backwards compatible way.
        $categoryWikiPage = MediaWikiServices::getInstance()->getWikiPageFactory()
            ->newFromTitle( $categoryTitle );
 
        '@phan-var WikiCategoryPage $categoryWikiPage';
        $params = [
            'hidden-cat' => $categoryWikiPage->isHidden()
        ];
        if ( $added !== null ) {
            $params['added'] = $added;
        }
 
        if ( !$user ) {
            // XXX: when and why do we need this?
            $user = MediaWikiServices::getInstance()->getActorStore()->getUnknownActor();
        }
 
        $rc = new RecentChange;
        $rc->mPage = $categoryTitle;
        $rc->mPerformer = $user;
        $rc->mAttribs = [
            'rc_timestamp' => MWTimestamp::convert( TS_MW, $timestamp ),
            'rc_namespace' => $categoryTitle->getNamespace(),
            'rc_title' => $categoryTitle->getDBkey(),
            'rc_type' => RC_CATEGORIZE,
            'rc_source' => self::SRC_CATEGORIZE,
            'rc_minor' => 0,
            // XXX: rc_cur_id does not correspond to rc_namespace/rc_title.
            //      They refer to different pages. Is that intentional?
            'rc_cur_id' => $pageTitle->getId(),
            'rc_user' => $user->getId(),
            'rc_user_text' => $user->getName(),
            'rc_comment' => &$comment,
            'rc_comment_text' => &$comment,
            'rc_comment_data' => null,
            'rc_this_oldid' => (int)$newRevId,
            'rc_last_oldid' => $oldRevId,
            'rc_bot' => $bot ? 1 : 0,
            'rc_ip' => self::checkIPAddress( $ip ),
            'rc_patrolled' => self::PRC_AUTOPATROLLED, // Always patrolled, just like log entries
            'rc_new' => 0, # obsolete
            'rc_old_len' => null,
            'rc_new_len' => null,
            'rc_deleted' => $deleted,
            'rc_logid' => 0,
            'rc_log_type' => null,
            'rc_log_action' => '',
            'rc_params' => serialize( $params )
        ];
 
        // TODO: deprecate the 'prefixedDBkey' entry, let callers do the formatting.
        $formatter = MediaWikiServices::getInstance()->getTitleFormatter();
 
        $rc->mExtra = [
            'prefixedDBkey' => $formatter->getPrefixedDBkey( $categoryTitle ),
            'lastTimestamp' => $lastTimestamp,
            'oldSize' => 0,
            'newSize' => 0,
            'pageStatus' => 'changed'
        ];
 
        return $rc;
    }
 
    public function getParam( $name ) {
        $params = $this->parseParams();
        return $params[$name] ?? null;
    }
 
    public function loadFromRow( $row ) {
        $this->mAttribs = get_object_vars( $row );
        $this->mAttribs['rc_timestamp'] = wfTimestamp( TS_MW, $this->mAttribs['rc_timestamp'] );
        // rc_deleted MUST be set
        $this->mAttribs['rc_deleted'] = $row->rc_deleted;
 
        if ( isset( $this->mAttribs['rc_ip'] ) ) {
            // Clean up CIDRs for Postgres per T164898. ("127.0.0.1" casts to "127.0.0.1/32")
            $n = strpos( $this->mAttribs['rc_ip'], '/' );
            if ( $n !== false ) {
                $this->mAttribs['rc_ip'] = substr( $this->mAttribs['rc_ip'], 0, $n );
            }
        }
 
        $comment = CommentStore::getStore()
            // Legacy because $row may have come from self::selectFields()
            ->getCommentLegacy( wfGetDB( DB_REPLICA ), 'rc_comment', $row, true )
            ->text;
        $this->mAttribs['rc_comment'] = &$comment;
        $this->mAttribs['rc_comment_text'] = &$comment;
        $this->mAttribs['rc_comment_data'] = null;
 
        $this->mPerformer = $this->getUserIdentityFromAnyId(
            $row->rc_user ?? null,
            $row->rc_user_text ?? null,
            $row->rc_actor ?? null
        );
        $this->mAttribs['rc_user'] = $this->mPerformer->getId();
        $this->mAttribs['rc_user_text'] = $this->mPerformer->getName();
 
        // Watchlist expiry.
        if ( isset( $row->we_expiry ) && $row->we_expiry ) {
            $this->watchlistExpiry = wfTimestamp( TS_MW, $row->we_expiry );
        }
    }
 
    public function getAttribute( $name ) {
        if ( $name === 'rc_comment' ) {
            // @phan-suppress-next-line SecurityCheck-DoubleEscaped
            return CommentStore::getStore()
                ->getComment( 'rc_comment', $this->mAttribs, true )->text;
        }
 
        if ( $name === 'rc_user' || $name === 'rc_user_text' || $name === 'rc_actor' ) {
            $user = $this->getPerformerIdentity();
 
            if ( $name === 'rc_user' ) {
                return $user->getId();
            }
            if ( $name === 'rc_user_text' ) {
                return $user->getName();
            }
            if ( $name === 'rc_actor' ) {
                // NOTE: rc_actor exists in the database, but application logic should not use it.
                wfDeprecatedMsg( 'Accessing deprecated field rc_actor', '1.36' );
                $actorStore = MediaWikiServices::getInstance()->getActorStore();
                $db = wfGetDB( DB_REPLICA );
                return $actorStore->findActorId( $user, $db );
            }
        }
 
        return $this->mAttribs[$name] ?? null;
    }
 
    public function getAttributes() {
        return $this->mAttribs;
    }
 
    public function diffLinkTrail( $forceCur ) {
        if ( $this->mAttribs['rc_type'] == RC_EDIT ) {
            $trail = "curid=" . (int)( $this->mAttribs['rc_cur_id'] ) .
                "&oldid=" . (int)( $this->mAttribs['rc_last_oldid'] );
            if ( $forceCur ) {
                $trail .= '&diff=0';
            } else {
                $trail .= '&diff=' . (int)( $this->mAttribs['rc_this_oldid'] );
            }
        } else {
            $trail = '';
        }
 
        return $trail;
    }
 
    public function getCharacterDifference( $old = 0, $new = 0 ) {
        if ( $old === 0 ) {
            $old = $this->mAttribs['rc_old_len'];
        }
        if ( $new === 0 ) {
            $new = $this->mAttribs['rc_new_len'];
        }
        if ( $old === null || $new === null ) {
            return '';
        }
 
        return ChangesList::showCharacterDifference( $old, $new );
    }
 
    private static function checkIPAddress( $ip ) {
        global $wgRequest;
        if ( $ip ) {
            if ( !IPUtils::isIPAddress( $ip ) ) {
                throw new MWException( "Attempt to write \"" . $ip .
                    "\" as an IP address into recent changes" );
            }
        } else {
            $ip = $wgRequest->getIP();
            if ( !$ip ) {
                $ip = '';
            }
        }
 
        return $ip;
    }
 
    public static function isInRCLifespan( $timestamp, $tolerance = 0 ) {
        $rcMaxAge = MediaWikiServices::getInstance()->getMainConfig()->get( 'RCMaxAge' );
 
        return (int)wfTimestamp( TS_UNIX, $timestamp ) > time() - $tolerance - $rcMaxAge;
    }
 
    public function parseParams() {
        $rcParams = $this->getAttribute( 'rc_params' );
 
        Wikimedia\suppressWarnings();
        $unserializedParams = unserialize( $rcParams );
        Wikimedia\restoreWarnings();
 
        return $unserializedParams;
    }
 
    public function addTags( $tags ) {
        if ( is_string( $tags ) ) {
            $this->tags[] = $tags;
        } else {
            $this->tags = array_merge( $tags, $this->tags );
        }
    }
 
    public function setEditResult( ?EditResult $editResult ) {
        $this->editResult = $editResult;
    }
 
    private function getUserIdentityFromAnyId(
        $userId,
        $userName,
        $actorId = null
    ): UserIdentity {
        // XXX: Is this logic needed elsewhere? Should it be reusable?
 
        $userId = isset( $userId ) ? (int)$userId : null;
        $actorId = isset( $actorId ) ? (int)$actorId : 0;
 
        $actorStore = MediaWikiServices::getInstance()->getActorStore();
        if ( $userName && $actorId ) {
            // Likely the fields are coming from a join on actor table,
            // so can definitely build a UserIdentityValue.
            return $actorStore->newActorFromRowFields( $userId, $userName, $actorId );
        }
        if ( $userId !== null ) {
            if ( $userName !== null ) {
                // NOTE: For IPs and external users, $userId will be 0.
                $user = new UserIdentityValue( $userId, $userName );
            } else {
                $user = $actorStore->getUserIdentityByUserId( $userId );
 
                if ( !$user ) {
                    throw new RuntimeException( "User not found by ID: $userId" );
                }
            }
        } elseif ( $actorId > 0 ) {
            $db = wfGetDB( DB_REPLICA );
            $user = $actorStore->getActorById( $actorId, $db );
 
            if ( !$user ) {
                throw new RuntimeException( "User not found by actor ID: $actorId" );
            }
        } elseif ( $userName !== null ) {
            $user = $actorStore->getUserIdentityByName( $userName );
 
            if ( !$user ) {
                throw new RuntimeException( "User not found by name: $userName" );
            }
        } else {
            throw new RuntimeException( 'At least one of user ID, actor ID or user name must be given' );
        }
 
        return $user;
    }
}