BrokenRedirectConstraint.php

Go to the documentation of this file.

<?php
namespace MediaWiki\EditPage\Constraint;
 
use MediaWiki\Content\Content;
use MediaWiki\Linker\LinkTarget;
use StatusValue;
use Wikimedia\Message\MessageValue;
 
class BrokenRedirectConstraint implements IEditConstraint {
 
    private bool $allowBrokenRedirects;
    private Content $newContent;
    private Content $originalContent;
    private LinkTarget $title;
    private string $submitButtonLabel;
    private string $result;
 
    public function __construct(
        bool $allowBrokenRedirects,
        Content $newContent,
        Content $originalContent,
        LinkTarget $title,
        string $submitButtonLabel
    ) {
        $this->allowBrokenRedirects = $allowBrokenRedirects;
        $this->newContent = $newContent;
        $this->originalContent = $originalContent;
        $this->title = $title;
        $this->submitButtonLabel = $submitButtonLabel;
    }
 
    public function checkConstraint(): string {
        if ( !$this->allowBrokenRedirects ) {
            $newRedirectTarget = $this->newContent->getRedirectTarget();
 
            if ( $newRedirectTarget !== null && !$newRedirectTarget->isKnown() &&
                !$newRedirectTarget->equals( $this->title ) ) {
                $currentTarget = $this->originalContent->getRedirectTarget();
 
                // fail if there was no previous content or the previous content contained
                // a redirect to a known page
                if ( !$currentTarget || $currentTarget->isKnown() ) {
                    $this->result = self::CONSTRAINT_FAILED;
 
                    return self::CONSTRAINT_FAILED;
                }
            }
 
        }
        $this->result = self::CONSTRAINT_PASSED;
 
        return self::CONSTRAINT_PASSED;
    }
 
    public function getLegacyStatus(): StatusValue {
        $statusValue = StatusValue::newGood();
 
        if ( $this->result === self::CONSTRAINT_FAILED ) {
            $statusValue->fatal( MessageValue::new( 'edit-constraint-brokenredirect',
                [ MessageValue::new( $this->submitButtonLabel ) ] ) );
            $statusValue->value = self::AS_BROKEN_REDIRECT;
        }
 
        return $statusValue;
    }
 
}