Code Coverage
 
Classes and Traits
Functions and Methods
Lines
Total
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
10 / 10
CRAP
100.00% covered (success)
100.00%
36 / 36
MWRestrictions
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
10 / 10
17
100.00% covered (success)
100.00%
36 / 36
 __construct
100.00% covered (success)
100.00%
1 / 1
2
100.00% covered (success)
100.00%
3 / 3
 newDefault
100.00% covered (success)
100.00%
1 / 1
1
100.00% covered (success)
100.00%
1 / 1
 newFromArray
100.00% covered (success)
100.00%
1 / 1
1
100.00% covered (success)
100.00%
1 / 1
 newFromJson
100.00% covered (success)
100.00%
1 / 1
2
100.00% covered (success)
100.00%
4 / 4
 loadFromArray
100.00% covered (success)
100.00%
1 / 1
6
100.00% covered (success)
100.00%
18 / 18
 toArray
100.00% covered (success)
100.00%
1 / 1
1
100.00% covered (success)
100.00%
1 / 1
 toJson
100.00% covered (success)
100.00%
1 / 1
1
100.00% covered (success)
100.00%
1 / 1
 __toString
100.00% covered (success)
100.00%
1 / 1
1
100.00% covered (success)
100.00%
1 / 1
 check
100.00% covered (success)
100.00%
1 / 1
1
100.00% covered (success)
100.00%
4 / 4
 checkIP
100.00% covered (success)
100.00%
1 / 1
1
100.00% covered (success)
100.00%
2 / 2
<?php
/**
 * A class to check request restrictions expressed as a JSON object
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 * http://www.gnu.org/copyleft/gpl.html
 */
use Wikimedia\IPSet;
use Wikimedia\IPUtils;
/**
 * A class to check request restrictions expressed as a JSON object
 */
class MWRestrictions {
    private $ipAddresses = [ '0.0.0.0/0', '::/0' ];
    /**
     * @param array|null $restrictions
     * @throws InvalidArgumentException
     */
    protected function __construct( array $restrictions = null ) {
        if ( $restrictions !== null ) {
            $this->loadFromArray( $restrictions );
        }
    }
    /**
     * @return MWRestrictions
     */
    public static function newDefault() {
        return new self();
    }
    /**
     * @param array $restrictions
     * @return MWRestrictions
     * @throws InvalidArgumentException
     */
    public static function newFromArray( array $restrictions ) {
        return new self( $restrictions );
    }
    /**
     * @param string $json JSON representation of the restrictions
     * @return MWRestrictions
     * @throws InvalidArgumentException
     */
    public static function newFromJson( $json ) {
        $restrictions = FormatJson::decode( $json, true );
        if ( !is_array( $restrictions ) ) {
            throw new InvalidArgumentException( 'Invalid restrictions JSON' );
        }
        return new self( $restrictions );
    }
    private function loadFromArray( array $restrictions ) {
        static $validKeys = [ 'IPAddresses' ];
        static $neededKeys = [ 'IPAddresses' ];
        $keys = array_keys( $restrictions );
        $invalidKeys = array_diff( $keys, $validKeys );
        if ( $invalidKeys ) {
            throw new InvalidArgumentException(
                'Array contains invalid keys: ' . implode( ', ', $invalidKeys )
            );
        }
        $missingKeys = array_diff( $neededKeys, $keys );
        if ( $missingKeys ) {
            throw new InvalidArgumentException(
                'Array is missing required keys: ' . implode( ', ', $missingKeys )
            );
        }
        if ( !is_array( $restrictions['IPAddresses'] ) ) {
            throw new InvalidArgumentException( 'IPAddresses is not an array' );
        }
        foreach ( $restrictions['IPAddresses'] as $ip ) {
            if ( !IPUtils::isIPAddress( $ip ) ) {
                throw new InvalidArgumentException( "Invalid IP address: $ip" );
            }
        }
        $this->ipAddresses = $restrictions['IPAddresses'];
    }
    /**
     * Return the restrictions as an array
     * @return array
     */
    public function toArray() {
        return [
            'IPAddresses' => $this->ipAddresses,
        ];
    }
    /**
     * Return the restrictions as a JSON string
     * @param bool|string $pretty Pretty-print the JSON output, see FormatJson::encode
     * @return string
     */
    public function toJson( $pretty = false ) {
        return FormatJson::encode( $this->toArray(), $pretty, FormatJson::ALL_OK );
    }
    public function __toString() {
        return $this->toJson();
    }
    /**
     * Test against the passed WebRequest
     * @param WebRequest $request
     * @return Status
     */
    public function check( WebRequest $request ) {
        $ok = [
            'ip' => $this->checkIP( $request->getIP() ),
        ];
        $status = Status::newGood();
        $status->setResult( $ok === array_filter( $ok ), $ok );
        return $status;
    }
    /**
     * Test if an IP address is allowed by the restrictions
     * @param string $ip
     * @return bool
     */
    public function checkIP( $ip ) {
        $set = new IPSet( $this->ipAddresses );
        return $set->match( $ip );
    }
}