MediaWiki  master
MWRestrictions.php
Go to the documentation of this file.
1 <?php
25 
26  private $ipAddresses = [ '0.0.0.0/0', '::/0' ];
27 
32  protected function __construct( array $restrictions = null ) {
33  if ( $restrictions !== null ) {
34  $this->loadFromArray( $restrictions );
35  }
36  }
37 
41  public static function newDefault() {
42  return new self();
43  }
44 
50  public static function newFromArray( array $restrictions ) {
51  return new self( $restrictions );
52  }
53 
59  public static function newFromJson( $json ) {
60  $restrictions = FormatJson::decode( $json, true );
61  if ( !is_array( $restrictions ) ) {
62  throw new InvalidArgumentException( 'Invalid restrictions JSON' );
63  }
64  return new self( $restrictions );
65  }
66 
67  private function loadFromArray( array $restrictions ) {
68  static $validKeys = [ 'IPAddresses' ];
69  static $neededKeys = [ 'IPAddresses' ];
70 
71  $keys = array_keys( $restrictions );
72  $invalidKeys = array_diff( $keys, $validKeys );
73  if ( $invalidKeys ) {
74  throw new InvalidArgumentException(
75  'Array contains invalid keys: ' . implode( ', ', $invalidKeys )
76  );
77  }
78  $missingKeys = array_diff( $neededKeys, $keys );
79  if ( $missingKeys ) {
80  throw new InvalidArgumentException(
81  'Array is missing required keys: ' . implode( ', ', $missingKeys )
82  );
83  }
84 
85  if ( !is_array( $restrictions['IPAddresses'] ) ) {
86  throw new InvalidArgumentException( 'IPAddresses is not an array' );
87  }
88  foreach ( $restrictions['IPAddresses'] as $ip ) {
89  if ( !\IP::isIPAddress( $ip ) ) {
90  throw new InvalidArgumentException( "Invalid IP address: $ip" );
91  }
92  }
93  $this->ipAddresses = $restrictions['IPAddresses'];
94  }
95 
100  public function toArray() {
101  return [
102  'IPAddresses' => $this->ipAddresses,
103  ];
104  }
105 
111  public function toJson( $pretty = false ) {
112  return FormatJson::encode( $this->toArray(), $pretty, FormatJson::ALL_OK );
113  }
114 
115  public function __toString() {
116  return $this->toJson();
117  }
118 
124  public function check( WebRequest $request ) {
125  $ok = [
126  'ip' => $this->checkIP( $request->getIP() ),
127  ];
128  $status = Status::newGood();
129  $status->setResult( $ok === array_filter( $ok ), $ok );
130  return $status;
131  }
132 
138  public function checkIP( $ip ) {
139  foreach ( $this->ipAddresses as $range ) {
140  if ( \IP::isInRange( $ip, $range ) ) {
141  return true;
142  }
143  }
144 
145  return false;
146  }
147 }
static isIPAddress( $ip)
Determine if a string is as valid IP address or network (CIDR prefix).
Definition: IP.php:77
check(WebRequest $request)
Test against the passed WebRequest.
getIP()
Work out the IP address based on various globals For trusted proxies, use the XFF client IP (first of...
const ALL_OK
Skip escaping as many characters as reasonably possible.
Definition: FormatJson.php:55
static encode( $value, $pretty=false, $escaping=0)
Returns the JSON representation of a value.
Definition: FormatJson.php:115
static newFromArray(array $restrictions)
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
static decode( $value, $assoc=false)
Decodes a JSON string.
Definition: FormatJson.php:174
loadFromArray(array $restrictions)
__construct(array $restrictions=null)
A class to check request restrictions expressed as a JSON object.
static isInRange( $addr, $range)
Determine if a given IPv4/IPv6 address is in a given CIDR network.
Definition: IP.php:637
checkIP( $ip)
Test an IP address.
static newFromJson( $json)
toJson( $pretty=false)
Return the restrictions as a JSON string.
toArray()
Return the restrictions as an array.
static newDefault()