CategoryMembershipChange.php

Go to the documentation of this file.

<?php
use Wikimedia\Assert\Assert;

class CategoryMembershipChange {

    const CATEGORY_ADDITION = 1;
    const CATEGORY_REMOVAL = -1;

    private $timestamp;

    private $pageTitle;

    private $revision;

    private $numTemplateLinks = 0;

    private $newForCategorizationCallback = null;

    public function __construct( Title $pageTitle, Revision $revision = null ) {
        $this->pageTitle = $pageTitle;
        if ( $revision === null ) {
            $this->timestamp = wfTimestampNow();
        } else {
            $this->timestamp = $revision->getTimestamp();
        }
        $this->revision = $revision;
        $this->newForCategorizationCallback = [ 'RecentChange', 'newForCategorization' ];
    }

    public function overrideNewForCategorizationCallback( $callback ) {
        if ( !defined( 'MW_PHPUNIT_TEST' ) ) {
            throw new MWException( 'Cannot override newForCategorization callback in operation.' );
        }
        Assert::parameterType( 'callable', $callback, '$callback' );
        $this->newForCategorizationCallback = $callback;
    }

    public function checkTemplateLinks() {
        $this->numTemplateLinks = $this->pageTitle->getBacklinkCache()->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,
                [ 'prefixedText' => $this->pageTitle->getPrefixedText() ],
                $this->numTemplateLinks
            ),
            $this->pageTitle,
            $this->getPreviousRevisionTimestamp(),
            $this->revision
        );
    }

    private function notifyCategorization(
        $timestamp,
        Title $categoryTitle,
        User $user = null,
        $comment,
        Title $pageTitle,
        $lastTimestamp,
        $revision
    ) {
        $deleted = $revision ? $revision->getVisibility() & Revision::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 ) {
            $correspondingRc = $this->revision->getRecentChange();
            if ( $correspondingRc === null ) {
                $correspondingRc = $this->revision->getRecentChange( Revision::READ_LATEST );
            }
            if ( $correspondingRc !== null ) {
                $bot = $correspondingRc->getAttribute( 'rc_bot' ) ?: 0;
                $ip = $correspondingRc->getAttribute( 'rc_ip' ) ?: '';
                $lastRevId = $correspondingRc->getAttribute( 'rc_last_oldid' ) ?: 0;
            }
        }

        $rc = call_user_func_array(
            $this->newForCategorizationCallback,
            [
                $timestamp,
                $categoryTitle,
                $user,
                $comment,
                $pageTitle,
                $lastRevId,
                $newRevId,
                $lastTimestamp,
                $bot,
                $ip,
                $deleted
            ]
        );
        $rc->save();
    }

    private function getUser() {
        if ( $this->revision ) {
            $userId = $this->revision->getUser( Revision::RAW );
            if ( $userId === 0 ) {
                return User::newFromName( $this->revision->getUserText( Revision::RAW ), false );
            } else {
                return User::newFromId( $userId );
            }
        }

        $username = wfMessage( 'autochange-username' )->inContentLanguage()->text();
        $user = User::newFromName( $username );
        # User::newFromName() can return false on a badly configured wiki.
        if ( $user && !$user->isLoggedIn() ) {
            $user->addToDatabase();
        }

        return $user;
    }

    private function getChangeMessageText( $type, array $params, $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, $params )->inContentLanguage()->text();
    }

    private function getPreviousRevisionTimestamp() {
        $previousRev = Revision::newFromId(
                $this->pageTitle->getPreviousRevisionID( $this->pageTitle->getLatestRevID() )
            );

        return $previousRev ? $previousRev->getTimestamp() : null;
    }

}