MediaWiki  1.28.0
WebResponse.php
Go to the documentation of this file.
1 <?php
28 class WebResponse {
29 
33  protected static $setCookies = [];
34 
41  public function header( $string, $replace = true, $http_response_code = null ) {
42  if ( $http_response_code ) {
43  header( $string, $replace, $http_response_code );
44  } else {
45  header( $string, $replace );
46  }
47  }
48 
55  public function getHeader( $key ) {
56  foreach ( headers_list() as $header ) {
57  list( $name, $val ) = explode( ':', $header, 2 );
58  if ( !strcasecmp( $name, $key ) ) {
59  return trim( $val );
60  }
61  }
62  return null;
63  }
64 
70  public function statusHeader( $code ) {
72  }
73 
79  public function headersSent() {
80  return headers_sent();
81  }
82 
98  public function setCookie( $name, $value, $expire = 0, $options = [] ) {
99  global $wgCookiePath, $wgCookiePrefix, $wgCookieDomain;
100  global $wgCookieSecure, $wgCookieExpiration, $wgCookieHttpOnly;
101 
102  $options = array_filter( $options, function ( $a ) {
103  return $a !== null;
104  } ) + [
105  'prefix' => $wgCookiePrefix,
106  'domain' => $wgCookieDomain,
107  'path' => $wgCookiePath,
108  'secure' => $wgCookieSecure,
109  'httpOnly' => $wgCookieHttpOnly,
110  'raw' => false,
111  ];
112 
113  if ( $expire === null ) {
114  $expire = 0; // Session cookie
115  } elseif ( $expire == 0 && $wgCookieExpiration != 0 ) {
116  $expire = time() + $wgCookieExpiration;
117  }
118 
119  $func = $options['raw'] ? 'setrawcookie' : 'setcookie';
120 
121  if ( Hooks::run( 'WebResponseSetCookie', [ &$name, &$value, &$expire, &$options ] ) ) {
122  $cookie = $options['prefix'] . $name;
123  $data = [
124  'name' => (string)$cookie,
125  'value' => (string)$value,
126  'expire' => (int)$expire,
127  'path' => (string)$options['path'],
128  'domain' => (string)$options['domain'],
129  'secure' => (bool)$options['secure'],
130  'httpOnly' => (bool)$options['httpOnly'],
131  ];
132 
133  // Per RFC 6265, key is name + domain + path
134  $key = "{$data['name']}\n{$data['domain']}\n{$data['path']}";
135 
136  // If this cookie name was in the request, fake an entry in
137  // self::$setCookies for it so the deleting check works right.
138  if ( isset( $_COOKIE[$cookie] ) && !array_key_exists( $key, self::$setCookies ) ) {
139  self::$setCookies[$key] = [];
140  }
141 
142  // PHP deletes if value is the empty string; also, a past expiry is deleting
143  $deleting = ( $data['value'] === '' || $data['expire'] > 0 && $data['expire'] <= time() );
144 
145  if ( $deleting && !isset( self::$setCookies[$key] ) ) { // isset( null ) is false
146  wfDebugLog( 'cookie', 'already deleted ' . $func . ': "' . implode( '", "', $data ) . '"' );
147  } elseif ( !$deleting && isset( self::$setCookies[$key] ) &&
148  self::$setCookies[$key] === [ $func, $data ]
149  ) {
150  wfDebugLog( 'cookie', 'already set ' . $func . ': "' . implode( '", "', $data ) . '"' );
151  } else {
152  wfDebugLog( 'cookie', $func . ': "' . implode( '", "', $data ) . '"' );
153  if ( call_user_func_array( $func, array_values( $data ) ) ) {
154  self::$setCookies[$key] = $deleting ? null : [ $func, $data ];
155  }
156  }
157  }
158  }
159 
169  public function clearCookie( $name, $options = [] ) {
170  $this->setCookie( $name, '', time() - 31536000 /* 1 year */, $options );
171  }
172 
179  public function hasCookies() {
180  return (bool)self::$setCookies;
181  }
182 }
183 
187 class FauxResponse extends WebResponse {
188  private $headers;
189  private $cookies = [];
190  private $code;
191 
198  public function header( $string, $replace = true, $http_response_code = null ) {
199  if ( substr( $string, 0, 5 ) == 'HTTP/' ) {
200  $parts = explode( ' ', $string, 3 );
201  $this->code = intval( $parts[1] );
202  } else {
203  list( $key, $val ) = array_map( 'trim', explode( ":", $string, 2 ) );
204 
205  $key = strtoupper( $key );
206 
207  if ( $replace || !isset( $this->headers[$key] ) ) {
208  $this->headers[$key] = $val;
209  }
210  }
211 
212  if ( $http_response_code !== null ) {
213  $this->code = intval( $http_response_code );
214  }
215  }
216 
221  public function statusHeader( $code ) {
222  $this->code = intval( $code );
223  }
224 
225  public function headersSent() {
226  return false;
227  }
228 
233  public function getHeader( $key ) {
234  $key = strtoupper( $key );
235 
236  if ( isset( $this->headers[$key] ) ) {
237  return $this->headers[$key];
238  }
239  return null;
240  }
241 
247  public function getStatusCode() {
248  return $this->code;
249  }
250 
257  public function setCookie( $name, $value, $expire = 0, $options = [] ) {
258  global $wgCookiePath, $wgCookiePrefix, $wgCookieDomain;
259  global $wgCookieSecure, $wgCookieExpiration, $wgCookieHttpOnly;
260 
261  $options = array_filter( $options, function ( $a ) {
262  return $a !== null;
263  } ) + [
264  'prefix' => $wgCookiePrefix,
265  'domain' => $wgCookieDomain,
266  'path' => $wgCookiePath,
267  'secure' => $wgCookieSecure,
268  'httpOnly' => $wgCookieHttpOnly,
269  'raw' => false,
270  ];
271 
272  if ( $expire === null ) {
273  $expire = 0; // Session cookie
274  } elseif ( $expire == 0 && $wgCookieExpiration != 0 ) {
275  $expire = time() + $wgCookieExpiration;
276  }
277 
278  $this->cookies[$options['prefix'] . $name] = [
279  'value' => (string)$value,
280  'expire' => (int)$expire,
281  'path' => (string)$options['path'],
282  'domain' => (string)$options['domain'],
283  'secure' => (bool)$options['secure'],
284  'httpOnly' => (bool)$options['httpOnly'],
285  'raw' => (bool)$options['raw'],
286  ];
287  }
288 
293  public function getCookie( $name ) {
294  if ( isset( $this->cookies[$name] ) ) {
295  return $this->cookies[$name]['value'];
296  }
297  return null;
298  }
299 
304  public function getCookieData( $name ) {
305  if ( isset( $this->cookies[$name] ) ) {
306  return $this->cookies[$name];
307  }
308  return null;
309  }
310 
314  public function getCookies() {
315  return $this->cookies;
316  }
317 }
getHeader($key)
Get a response header.
Definition: WebResponse.php:55
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
header($string, $replace=true, $http_response_code=null)
Output an HTTP header, wrapper for PHP's header()
Definition: WebResponse.php:41
statusHeader($code)
hasCookies()
Checks whether this request is performing cookie operations.
setCookie($name, $value, $expire=0, $options=[])
Set the browser cookie.
Definition: WebResponse.php:98
static header($code)
Output an HTTP status code header.
Definition: HttpStatus.php:96
This code would result in ircNotify being run twice when an article is and once for brion Hooks can return three possible true was required This is the default since MediaWiki *some string
Definition: hooks.txt:177
$value
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
wfDebugLog($logGroup, $text, $dest= 'all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not...
setCookie($name, $value, $expire=0, $options=[])
getStatusCode()
Get the HTTP response code, null if not set.
statusHeader($code)
Output an HTTP status code header.
Definition: WebResponse.php:70
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add headers
Definition: design.txt:12
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist 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 and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context $options
Definition: hooks.txt:1046
getCookie($name)
headersSent()
Test if headers have been sent.
Definition: WebResponse.php:79
static run($event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:131
header($string, $replace=true, $http_response_code=null)
Stores a HTTP header.
$header
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
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable & $code
Definition: hooks.txt:802
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
if($wgLocalInterwiki) if($wgSharedPrefix===false) if($wgSharedSchema===false) if(!$wgCookiePrefix) $wgCookiePrefix
Definition: Setup.php:324
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 or an object and a method hook function The function part of a third party developers and local administrators to define code that will be run at certain points in the mainline code
Definition: hooks.txt:23
Allow programs to request this object from WebRequest::response() and handle all outputting (or lack ...
Definition: WebResponse.php:28
clearCookie($name, $options=[])
Unset a browser cookie.
it sets a lot of them automatically from cookies
Definition: design.txt:93
static array $setCookies
Used to record set cookies, because PHP's setcookie() will happily send an identical Set-Cookie to th...
Definition: WebResponse.php:33
getCookieData($name)
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:300