CategoryMembershipChange.php

Go to the documentation of this file.

<?php
 
use MediaWiki\MediaWikiServices;
use MediaWiki\Revision\RevisionRecord;
use MediaWiki\Revision\RevisionStore;
use MediaWiki\User\UserIdentity;
 
class CategoryMembershipChange {
 
    private const CATEGORY_ADDITION = 1;
    private const CATEGORY_REMOVAL = -1;
 
    private $timestamp;
 
    private $pageTitle;
 
    private $revision;
 
    private $numTemplateLinks = 0;
 
    private $newForCategorizationCallback = null;
 
    private $backlinkCache;
 
    public function __construct(
        Title $pageTitle, BacklinkCache $backlinkCache, RevisionRecord $revision = null
    ) {
        $this->pageTitle = $pageTitle;
        $this->revision = $revision;
        if ( $revision === null ) {
            $this->timestamp = wfTimestampNow();
        } else {
            $this->timestamp = $revision->getTimestamp();
        }
        $this->newForCategorizationCallback = [ RecentChange::class, 'newForCategorization' ];
        $this->backlinkCache = $backlinkCache;
    }
 
    public function overrideNewForCategorizationCallback( callable $callback ) {
        if ( !defined( 'MW_PHPUNIT_TEST' ) ) {
            throw new MWException( 'Cannot override newForCategorization callback in operation.' );
        }
        $this->newForCategorizationCallback = $callback;
    }
 
    public function checkTemplateLinks() {
        $this->numTemplateLinks = $this->backlinkCache->getNumLinks( 'templatelinks' );
    }
 
    public function triggerCategoryAddedNotification( Title $categoryTitle ) {
        $this->createRecentChangesEntry( $categoryTitle, self::CATEGORY_ADDITION );
    }
 
    public function triggerCategoryRemovedNotification( Title $categoryTitle ) {
        $this->createRecentChangesEntry( $categoryTitle, self::CATEGORY_REMOVAL );
    }
 
    private function createRecentChangesEntry( Title $categoryTitle, $type ) {
        $this->notifyCategorization(
            $this->timestamp,
            $categoryTitle,
            $this->getUser(),
            $this->getChangeMessageText(
                $type,
                $this->pageTitle->getPrefixedText(),
                $this->numTemplateLinks
            ),
            $this->pageTitle,
            $this->getPreviousRevisionTimestamp(),
            $this->revision,
            $type === self::CATEGORY_ADDITION
        );
    }
 
    private function notifyCategorization(
        $timestamp,
        Title $categoryTitle,
        ?UserIdentity $user,
        $comment,
        Title $pageTitle,
        $lastTimestamp,
        $revision,
        $added
    ) {
        $deleted = $revision ? $revision->getVisibility() & RevisionRecord::SUPPRESSED_USER : 0;
        $newRevId = $revision ? $revision->getId() : 0;
 
        $bot = 1;
        $lastRevId = 0;
        $ip = '';
 
        # If no revision is given, the change was probably triggered by parser functions
        if ( $revision !== null ) {
            $revisionStore = MediaWikiServices::getInstance()->getRevisionStore();
 
            $correspondingRc = $revisionStore->getRecentChange( $this->revision );
            if ( $correspondingRc === null ) {
                $correspondingRc = $revisionStore->getRecentChange(
                    $this->revision,
                    RevisionStore::READ_LATEST
                );
            }
            if ( $correspondingRc !== null ) {
                $bot = $correspondingRc->getAttribute( 'rc_bot' ) ?: 0;
                $ip = $correspondingRc->getAttribute( 'rc_ip' ) ?: '';
                $lastRevId = $correspondingRc->getAttribute( 'rc_last_oldid' ) ?: 0;
            }
        }
 
        $rc = ( $this->newForCategorizationCallback )(
            $timestamp,
            $categoryTitle,
            $user,
            $comment,
            $pageTitle,
            $lastRevId,
            $newRevId,
            $lastTimestamp,
            $bot,
            $ip,
            $deleted,
            $added
        );
        $rc->save();
    }
 
    private function getUser(): ?UserIdentity {
        if ( $this->revision ) {
            $user = $this->revision->getUser( RevisionRecord::RAW );
            if ( $user ) {
                return $user;
            }
        }
 
        $username = wfMessage( 'autochange-username' )->inContentLanguage()->text();
 
        // TODO: use User::newSystemUser
        $user = User::newFromName( $username );
        # User::newFromName() can return false on a badly configured wiki.
        if ( $user && !$user->isRegistered() ) {
            $user->addToDatabase();
        }
 
        return $user ?: null;
    }
 
    private function getChangeMessageText( $type, $prefixedText, $numTemplateLinks ) {
        $array = [
            self::CATEGORY_ADDITION => 'recentchanges-page-added-to-category',
            self::CATEGORY_REMOVAL => 'recentchanges-page-removed-from-category',
        ];
 
        $msgKey = $array[$type];
 
        if ( intval( $numTemplateLinks ) > 0 ) {
            $msgKey .= '-bundled';
        }
 
        return wfMessage( $msgKey, $prefixedText )->inContentLanguage()->text();
    }
 
    private function getPreviousRevisionTimestamp() {
        $rl = MediaWikiServices::getInstance()->getRevisionLookup();
        $latestRev = $rl->getRevisionByTitle( $this->pageTitle );
        if ( $latestRev ) {
            $previousRev = $rl->getPreviousRevision( $latestRev );
            if ( $previousRev ) {
                return $previousRev->getTimestamp();
            }
        }
        return null;
    }
 
}