MediaWiki  master
FauxRequest.php
Go to the documentation of this file.
1 <?php
27 
33 class FauxRequest extends WebRequest {
34  private $wasPosted = false;
35  private $requestUrl;
36  protected $cookies = [];
37 
47  public function __construct( $data = [], $wasPosted = false,
48  $session = null, $protocol = 'http'
49  ) {
50  $this->requestTime = microtime( true );
51 
52  if ( is_array( $data ) ) {
53  $this->data = $data;
54  } else {
55  throw new MWException( "FauxRequest() got bogus data" );
56  }
57  $this->wasPosted = $wasPosted;
58  if ( $session instanceof MediaWiki\Session\Session ) {
59  $this->sessionId = $session->getSessionId();
60  } elseif ( is_array( $session ) ) {
61  $mwsession = SessionManager::singleton()->getEmptySession( $this );
62  $this->sessionId = $mwsession->getSessionId();
63  foreach ( $session as $key => $value ) {
64  $mwsession->set( $key, $value );
65  }
66  } elseif ( $session !== null ) {
67  throw new MWException( "FauxRequest() got bogus session" );
68  }
69  $this->protocol = $protocol;
70  }
71 
75  protected function initHeaders() {
76  // Nothing to init
77  }
78 
84  public function getText( $name, $default = '' ) {
85  # Override; don't recode since we're using internal data
86  return (string)$this->getVal( $name, $default );
87  }
88 
92  public function getValues() {
93  return $this->data;
94  }
95 
99  public function getQueryValues() {
100  if ( $this->wasPosted ) {
101  return [];
102  } else {
103  return $this->data;
104  }
105  }
106 
107  public function getMethod() {
108  return $this->wasPosted ? 'POST' : 'GET';
109  }
110 
114  public function wasPosted() {
115  return $this->wasPosted;
116  }
117 
118  public function getCookie( $key, $prefix = null, $default = null ) {
119  if ( $prefix === null ) {
120  global $wgCookiePrefix;
121  $prefix = $wgCookiePrefix;
122  }
123  $name = $prefix . $key;
124  return $this->cookies[$name] ?? $default;
125  }
126 
133  public function setCookie( $key, $value, $prefix = null ) {
134  $this->setCookies( [ $key => $value ], $prefix );
135  }
136 
142  public function setCookies( $cookies, $prefix = null ) {
143  if ( $prefix === null ) {
144  global $wgCookiePrefix;
145  $prefix = $wgCookiePrefix;
146  }
147  foreach ( $cookies as $key => $value ) {
148  $name = $prefix . $key;
149  $this->cookies[$name] = $value;
150  }
151  }
152 
157  public function setRequestURL( $url ) {
158  $this->requestUrl = $url;
159  }
160 
166  public function getRequestURL() {
167  if ( $this->requestUrl === null ) {
168  throw new MWException( 'Request URL not set' );
169  }
170  return $this->requestUrl;
171  }
172 
173  public function getProtocol() {
174  return $this->protocol;
175  }
176 
181  public function setHeader( $name, $val ) {
182  $this->setHeaders( [ $name => $val ] );
183  }
184 
189  public function setHeaders( $headers ) {
190  foreach ( $headers as $name => $val ) {
191  $name = strtoupper( $name );
192  $this->headers[$name] = $val;
193  }
194  }
195 
199  public function getSessionArray() {
200  if ( $this->sessionId !== null ) {
201  return iterator_to_array( $this->getSession() );
202  }
203  return null;
204  }
205 
210  public function getRawQueryString() {
211  return '';
212  }
213 
218  public function getRawPostString() {
219  return '';
220  }
221 
226  public function getRawInput() {
227  return '';
228  }
229 
235  public function checkUrlExtension( $extWhitelist = [] ) {
236  return true;
237  }
238 
243  protected function getRawIP() {
244  return '127.0.0.1';
245  }
246 }
and how to run hooks for an and one after Each event has a preferably in CamelCase For ArticleDelete hook A clump of code and data that should be run when an event happens This can be either a function and a chunk of data
Definition: hooks.txt:6
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
getVal( $name, $default=null)
Fetch a scalar from the input or return $default if it&#39;s not set.
Definition: WebRequest.php:438
$wgCookiePrefix
Cookies generated by MediaWiki have names starting with this prefix.
setHeaders( $headers)
getRawInput()
FauxRequests shouldn&#39;t depend on raw request data (but that could be implemented here) ...
getRawPostString()
FauxRequests shouldn&#39;t depend on raw request data (but that could be implemented here) ...
string $protocol
Cached URL protocol.
Definition: WebRequest.php:78
$value
getSession()
Return the session for this request.
Definition: WebRequest.php:740
getRawQueryString()
FauxRequests shouldn&#39;t depend on raw request data (but that could be implemented here) ...
A helper class for throttling authentication attempts.
getText( $name, $default='')
Definition: FauxRequest.php:84
setHeader( $name, $val)
setRequestURL( $url)
getCookie( $key, $prefix=null, $default=null)
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
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
setCookie( $key, $value, $prefix=null)
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
setCookies( $cookies, $prefix=null)
__construct( $data=[], $wasPosted=false, $session=null, $protocol='http')
Definition: FauxRequest.php:47
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
initHeaders()
Initialise the header list.
Definition: FauxRequest.php:75
checkUrlExtension( $extWhitelist=[])