MediaWiki  1.29.1
Go to the documentation of this file.
1 <?php
26  private $ipAddresses = [ '', '::/0' ];
32  protected function __construct( array $restrictions = null ) {
33  if ( $restrictions !== null ) {
34  $this->loadFromArray( $restrictions );
35  }
36  }
41  public static function newDefault() {
42  return new self();
43  }
50  public static function newFromArray( array $restrictions ) {
51  return new self( $restrictions );
52  }
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  }
67  private function loadFromArray( array $restrictions ) {
68  static $validKeys = [ 'IPAddresses' ];
69  static $neededKeys = [ 'IPAddresses' ];
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  }
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  }
100  public function toArray() {
101  return [
102  'IPAddresses' => $this->ipAddresses,
103  ];
104  }
111  public function toJson( $pretty = false ) {
112  return FormatJson::encode( $this->toArray(), $pretty, FormatJson::ALL_OK );
113  }
115  public function __toString() {
116  return $this->toJson();
117  }
124  public function check( WebRequest $request ) {
125  $ok = [
126  'ip' => $this->checkIP( $request->getIP() ),
127  ];
129  $status->setResult( $ok === array_filter( $ok ), $ok );
130  return $status;
131  }
138  public function checkIP( $ip ) {
139  foreach ( $this->ipAddresses as $range ) {
140  if ( \IP::isInRange( $ip, $range ) ) {
141  return true;
142  }
143  }
145  return false;
146  }
147 }
A class to check request restrictions expressed as a JSON object.
Definition: MWRestrictions.php:24
loadFromArray(array $restrictions)
Definition: MWRestrictions.php:67
Definition: MWRestrictions.php:115
error also a ContextSource you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2612
check(WebRequest $request)
Test against the passed WebRequest.
Definition: MWRestrictions.php:124
Definition: MWRestrictions.php:26
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
Definition: hooks.txt:1049
const ALL_OK
Skip escaping as many characters as reasonably possible.
Definition: FormatJson.php:55
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
checkIP( $ip)
Test an IP address.
Definition: MWRestrictions.php:138
static decode( $value, $assoc=false)
Decodes a JSON string.
Definition: FormatJson.php:187
static encode( $value, $pretty=false, $escaping=0)
Returns the JSON representation of a value.
Definition: FormatJson.php:127
toJson( $pretty=false)
Return the restrictions as a JSON string.
Definition: MWRestrictions.php:111
__construct(array $restrictions=null)
Definition: MWRestrictions.php:32
static isInRange( $addr, $range)
Determine if a given IPv4/IPv6 address is in a given CIDR network.
Definition: IP.php:638
static newDefault()
Definition: MWRestrictions.php:41
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:76
The WebRequest class encapsulates getting at data passed in the URL or via a POSTed form stripping il...
Definition: WebRequest.php:38
Work out the IP address based on various globals For trusted proxies, use the XFF client IP (first of...
Definition: WebRequest.php:1194
Return the restrictions as an array.
Definition: MWRestrictions.php:100
static newFromJson( $json)
Definition: MWRestrictions.php:59
static newFromArray(array $restrictions)
Definition: MWRestrictions.php:50
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
Definition: testCompression.php:65
static isIPAddress( $ip)
Determine if a string is as valid IP address or network (CIDR prefix).
Definition: IP.php:79
the array() calling protocol came about after MediaWiki 1.4rc1.