includes/WebResponse.php

   1 <?php
   2 /**
   3  * Classes used to send headers and cookies back to the user
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  */
  22
  23 /**
  24  * Allow programs to request this object from WebRequest::response()
  25  * and handle all outputting (or lack of outputting) via it.
  26  * @ingroup HTTP
  27  */
  28 class WebResponse {
  29
  30         /** @var array Used to record set cookies, because PHP's setcookie() will
  31          * happily send an identical Set-Cookie to the client.
  32          */
  33         protected static $setCookies = array();
  34
  35         /**
  36          * Output an HTTP header, wrapper for PHP's header()
  37          * @param string $string Header to output
  38          * @param bool $replace Replace current similar header
  39          * @param null|int $http_response_code Forces the HTTP response code to the specified value.
  40          */
  41         public function header( $string, $replace = true, $http_response_code = null ) {
  42                 header( $string, $replace, $http_response_code );
  43         }
  44
  45         /**
  46          * Get a response header
  47          * @param string $key The name of the header to get (case insensitive).
  48          * @return string|null The header value (if set); null otherwise.
  49          * @since 1.25
  50          */
  51         public function getHeader( $key ) {
  52                 foreach ( headers_list() as $header ) {
  53                         list( $name, $val ) = explode( ':', $header, 2 );
  54                         if ( !strcasecmp( $name, $key ) ) {
  55                                 return trim( $val );
  56                         }
  57                 }
  58                 return null;
  59         }
  60
  61         /**
  62          * Output an HTTP status code header
  63          * @since 1.26
  64          * @param int $code Status code
  65          */
  66         public function statusHeader( $code ) {
  67                 HttpStatus::header( $code );
  68         }
  69
  70         /**
  71          * Test if headers have been sent
  72          * @since 1.27
  73          * @return bool
  74          */
  75         public function headersSent() {
  76                 return headers_sent();
  77         }
  78
  79         /**
  80          * Set the browser cookie
  81          * @param string $name The name of the cookie.
  82          * @param string $value The value to be stored in the cookie.
  83          * @param int|null $expire Unix timestamp (in seconds) when the cookie should expire.
  84          *        0 (the default) causes it to expire $wgCookieExpiration seconds from now.
  85          *        null causes it to be a session cookie.
  86          * @param array $options Assoc of additional cookie options:
  87          *     prefix: string, name prefix ($wgCookiePrefix)
  88          *     domain: string, cookie domain ($wgCookieDomain)
  89          *     path: string, cookie path ($wgCookiePath)
  90          *     secure: bool, secure attribute ($wgCookieSecure)
  91          *     httpOnly: bool, httpOnly attribute ($wgCookieHttpOnly)
  92          *     raw: bool, if true uses PHP's setrawcookie() instead of setcookie()
  93          *   For backwards compatibility, if $options is not an array then it and
  94          *   the following two parameters will be interpreted as values for
  95          *   'prefix', 'domain', and 'secure'
  96          * @since 1.22 Replaced $prefix, $domain, and $forceSecure with $options
  97          */
  98         public function setCookie( $name, $value, $expire = 0, $options = array() ) {
  99                 global $wgCookiePath, $wgCookiePrefix, $wgCookieDomain;
 100                 global $wgCookieSecure, $wgCookieExpiration, $wgCookieHttpOnly;
 101
 102                 if ( !is_array( $options ) ) {
 103                         // Backwards compatibility
 104                         $options = array( 'prefix' => $options );
 105                         if ( func_num_args() >= 5 ) {
 106                                 $options['domain'] = func_get_arg( 4 );
 107                         }
 108                         if ( func_num_args() >= 6 ) {
 109                                 $options['secure'] = func_get_arg( 5 );
 110                         }
 111                 }
 112                 $options = array_filter( $options, function ( $a ) {
 113                         return $a !== null;
 114                 } ) + array(
 115                         'prefix' => $wgCookiePrefix,
 116                         'domain' => $wgCookieDomain,
 117                         'path' => $wgCookiePath,
 118                         'secure' => $wgCookieSecure,
 119                         'httpOnly' => $wgCookieHttpOnly,
 120                         'raw' => false,
 121                 );
 122
 123                 if ( $expire === null ) {
 124                         $expire = 0; // Session cookie
 125                 } elseif ( $expire == 0 && $wgCookieExpiration != 0 ) {
 126                         $expire = time() + $wgCookieExpiration;
 127                 }
 128
 129                 $func = $options['raw'] ? 'setrawcookie' : 'setcookie';
 130
 131                 if ( Hooks::run( 'WebResponseSetCookie', array( &$name, &$value, &$expire, $options ) ) ) {
 132                         $cookie = $options['prefix'] . $name;
 133                         $data = array(
 134                                 'name' => (string)$cookie,
 135                                 'value' => (string)$value,
 136                                 'expire' => (int)$expire,
 137                                 'path' => (string)$options['path'],
 138                                 'domain' => (string)$options['domain'],
 139                                 'secure' => (bool)$options['secure'],
 140                                 'httpOnly' => (bool)$options['httpOnly'],
 141                         );
 142
 143                         // Per RFC 6265, key is name + domain + path
 144                         $key = "{$data['name']}\n{$data['domain']}\n{$data['path']}";
 145
 146                         // If this cookie name was in the request, fake an entry in
 147                         // self::$setCookies for it so the deleting check works right.
 148                         if ( isset( $_COOKIE[$cookie] ) && !array_key_exists( $key, self::$setCookies ) ) {
 149                                 self::$setCookies[$key] = array();
 150                         }
 151
 152                         // PHP deletes if value is the empty string; also, a past expiry is deleting
 153                         $deleting = ( $data['value'] === '' || $data['expire'] > 0 && $data['expire'] <= time() );
 154
 155                         if ( $deleting && !isset( self::$setCookies[$key] ) ) { // isset( null ) is false
 156                                 wfDebugLog( 'cookie', 'already deleted ' . $func . ': "' . implode( '", "', $data ) . '"' );
 157                         } elseif ( !$deleting && isset( self::$setCookies[$key] ) &&
 158                                 self::$setCookies[$key] === array( $func, $data )
 159                         ) {
 160                                 wfDebugLog( 'cookie', 'already set ' . $func . ': "' . implode( '", "', $data ) . '"' );
 161                         } else {
 162                                 wfDebugLog( 'cookie', $func . ': "' . implode( '", "', $data ) . '"' );
 163                                 if ( call_user_func_array( $func, array_values( $data ) ) ) {
 164                                         self::$setCookies[$key] = $deleting ? null : array( $func, $data );
 165                                 }
 166                         }
 167                 }
 168         }
 169
 170         /**
 171          * Unset a browser cookie.
 172          * This sets the cookie with an empty value and an expiry set to a time in the past,
 173          * which will cause the browser to remove any cookie with the given name, domain and
 174          * path from its cookie store. Options other than these (and prefix) have no effect.
 175          * @param string $name Cookie name
 176          * @param array $options Cookie options, see {@link setCookie()}
 177          * @since 1.27
 178          */
 179         public function clearCookie( $name, $options = array() ) {
 180                 $this->setCookie( $name, '', time() - 31536000 /* 1 year */, $options );
 181         }
 182 }
 183
 184 /**
 185  * @ingroup HTTP
 186  */
 187 class FauxResponse extends WebResponse {
 188         private $headers;
 189         private $cookies = array();
 190         private $code;
 191
 192         /**
 193          * Stores a HTTP header
 194          * @param string $string Header to output
 195          * @param bool $replace Replace current similar header
 196          * @param null|int $http_response_code Forces the HTTP response code to the specified value.
 197          */
 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
 217         /**
 218          * @since 1.26
 219          * @param int $code Status code
 220          */
 221         public function statusHeader( $code ) {
 222                 $this->code = intval( $code );
 223         }
 224
 225         public function headersSent() {
 226                 return false;
 227         }
 228
 229         /**
 230          * @param string $key The name of the header to get (case insensitive).
 231          * @return string|null The header value (if set); null otherwise.
 232          */
 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
 242         /**
 243          * Get the HTTP response code, null if not set
 244          *
 245          * @return int|null
 246          */
 247         public function getStatusCode() {
 248                 return $this->code;
 249         }
 250
 251         /**
 252          * @param string $name The name of the cookie.
 253          * @param string $value The value to be stored in the cookie.
 254          * @param int|null $expire Ignored in this faux subclass.
 255          * @param array $options Ignored in this faux subclass.
 256          */
 257         public function setCookie( $name, $value, $expire = 0, $options = array() ) {
 258                 global $wgCookiePath, $wgCookiePrefix, $wgCookieDomain;
 259                 global $wgCookieSecure, $wgCookieExpiration, $wgCookieHttpOnly;
 260
 261                 if ( !is_array( $options ) ) {
 262                         // Backwards compatibility
 263                         $options = array( 'prefix' => $options );
 264                         if ( func_num_args() >= 5 ) {
 265                                 $options['domain'] = func_get_arg( 4 );
 266                         }
 267                         if ( func_num_args() >= 6 ) {
 268                                 $options['secure'] = func_get_arg( 5 );
 269                         }
 270                 }
 271                 $options = array_filter( $options, function ( $a ) {
 272                         return $a !== null;
 273                 } ) + array(
 274                         'prefix' => $wgCookiePrefix,
 275                         'domain' => $wgCookieDomain,
 276                         'path' => $wgCookiePath,
 277                         'secure' => $wgCookieSecure,
 278                         'httpOnly' => $wgCookieHttpOnly,
 279                         'raw' => false,
 280                 );
 281
 282                 if ( $expire === null ) {
 283                         $expire = 0; // Session cookie
 284                 } elseif ( $expire == 0 && $wgCookieExpiration != 0 ) {
 285                         $expire = time() + $wgCookieExpiration;
 286                 }
 287
 288                 $this->cookies[$options['prefix'] . $name] = array(
 289                         'value' => (string)$value,
 290                         'expire' => (int)$expire,
 291                         'path' => (string)$options['path'],
 292                         'domain' => (string)$options['domain'],
 293                         'secure' => (bool)$options['secure'],
 294                         'httpOnly' => (bool)$options['httpOnly'],
 295                         'raw' => (bool)$options['raw'],
 296                 );
 297         }
 298
 299         /**
 300          * @param string $name
 301          * @return string|null
 302          */
 303         public function getCookie( $name ) {
 304                 if ( isset( $this->cookies[$name] ) ) {
 305                         return $this->cookies[$name]['value'];
 306                 }
 307                 return null;
 308         }
 309
 310         /**
 311          * @param string $name
 312          * @return array|null
 313          */
 314         public function getCookieData( $name ) {
 315                 if ( isset( $this->cookies[$name] ) ) {
 316                         return $this->cookies[$name];
 317                 }
 318                 return null;
 319         }
 320
 321         /**
 322          * @return array
 323          */
 324         public function getCookies() {
 325                 return $this->cookies;
 326         }
 327 }