HTMLRestrictionsField.php

Go to the documentation of this file.

<?php
 
use Wikimedia\IPUtils;
 
class HTMLRestrictionsField extends HTMLTextAreaField {
    protected const DEFAULT_ROWS = 5;
 
    /*
     * @stable to call
     */
    public function __construct( array $params ) {
        parent::__construct( $params );
        if ( !$this->mLabel ) {
            $this->mLabel = $this->msg( 'restrictionsfield-label' )->parse();
        }
    }
 
    public function getHelpText() {
        $helpText = parent::getHelpText();
        if ( $helpText === null ) {
            $helpText = $this->msg( 'restrictionsfield-help' )->parse();
        }
        return $helpText;
    }
 
    public function loadDataFromRequest( $request ) {
        if ( !$request->getCheck( $this->mName ) ) {
            return $this->getDefault();
        }
 
        $value = rtrim( $request->getText( $this->mName ), "\r\n" );
        $ips = $value === '' ? [] : explode( "\n", $value );
        try {
            return MWRestrictions::newFromArray( [ 'IPAddresses' => $ips ] );
        } catch ( InvalidArgumentException $e ) {
            return $value;
        }
    }
 
    public function getDefault() {
        $default = parent::getDefault();
        if ( $default === null ) {
            $default = MWRestrictions::newDefault();
        }
        return $default;
    }
 
    public function validate( $value, $alldata ) {
        if ( $this->isHidden( $alldata ) ) {
            return true;
        }
 
        if (
            isset( $this->mParams['required'] ) && $this->mParams['required'] !== false
            && $value instanceof MWRestrictions && !$value->toArray()['IPAddresses']
        ) {
            return $this->msg( 'htmlform-required' );
        }
 
        if ( is_string( $value ) ) {
            // MWRestrictions::newFromArray failed; one of the IP ranges must be invalid
            $status = Status::newGood();
            foreach ( explode( "\n", $value ) as $range ) {
                if ( !IPUtils::isIPAddress( $range ) ) {
                    $status->fatal( 'restrictionsfield-badip', $range );
                }
            }
            if ( $status->isOK() ) {
                $status->fatal( 'unknown-error' );
            }
            return $status->getMessage();
        }
 
        if ( isset( $this->mValidationCallback ) ) {
            return call_user_func( $this->mValidationCallback, $value, $alldata, $this->mParent );
        }
 
        return true;
    }
 
    public function getInputHTML( $value ) {
        if ( $value instanceof MWRestrictions ) {
            $value = implode( "\n", $value->toArray()['IPAddresses'] );
        }
        return parent::getInputHTML( $value );
    }
 
    public function getInputOOUI( $value ) {
        if ( $value instanceof MWRestrictions ) {
            $value = implode( "\n", $value->toArray()['IPAddresses'] );
        }
        return parent::getInputOOUI( $value );
    }
}