1531659d25
* added integration tests. We probably don't want automated tests to make external requests but these make manual testing more convenient. Documented some oddities discovered by testing. * made ::$status, ::proxySetup() and ::getHeaderList() protected; they were not referenced in any gerrit-hosted extension and they provide no useful functionality to external callers. Similarly, marked ::read() and ::errorHandler() as internal (these are used as callbacks so can't be protected) * removed inheritance abuse in ::execute() * documented ::execute() as returning a StatusValue (but keep returning a Status for now) * changed setCookie argument defaults to ones that make sense * replaced MWException * moved unit tests to the correct location * fixed some code style issues Change-Id: I5852fc75badc5d475ae30ec2c9376bde7024bd95
107 lines
2.8 KiB
PHP
107 lines
2.8 KiB
PHP
<?php
|
|
/**
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
* @ingroup HTTP
|
|
*/
|
|
|
|
/**
|
|
* Cookie jar to use with MWHttpRequest. Does not handle cookie unsetting.
|
|
*/
|
|
class CookieJar {
|
|
/** @var Cookie[] */
|
|
private $cookie = [];
|
|
|
|
/**
|
|
* Set a cookie in the cookie jar. Make sure only one cookie per-name exists.
|
|
* @see Cookie::set()
|
|
* @param string $name
|
|
* @param string $value
|
|
* @param array $attr
|
|
*/
|
|
public function setCookie( $name, $value, $attr ) {
|
|
/* cookies: case insensitive, so this should work.
|
|
* We'll still send the cookies back in the same case we got them, though.
|
|
*/
|
|
$index = strtoupper( $name );
|
|
|
|
if ( isset( $this->cookie[$index] ) ) {
|
|
$this->cookie[$index]->set( $value, $attr );
|
|
} else {
|
|
$this->cookie[$index] = new Cookie( $name, $value, $attr );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @see Cookie::serializeToHttpRequest
|
|
* @param string $path
|
|
* @param string $domain
|
|
* @return string
|
|
*/
|
|
public function serializeToHttpRequest( $path, $domain ) {
|
|
$cookies = [];
|
|
|
|
foreach ( $this->cookie as $c ) {
|
|
$serialized = $c->serializeToHttpRequest( $path, $domain );
|
|
|
|
if ( $serialized ) {
|
|
$cookies[] = $serialized;
|
|
}
|
|
}
|
|
|
|
return implode( '; ', $cookies );
|
|
}
|
|
|
|
/**
|
|
* Parse the content of an Set-Cookie HTTP Response header.
|
|
*
|
|
* @param string $cookie
|
|
* @param string $domain Cookie's domain
|
|
* @return null
|
|
*/
|
|
public function parseCookieResponseHeader( $cookie, $domain ) {
|
|
$len = strlen( 'Set-Cookie:' );
|
|
|
|
if ( substr_compare( 'Set-Cookie:', $cookie, 0, $len, true ) === 0 ) {
|
|
$cookie = substr( $cookie, $len );
|
|
}
|
|
|
|
$bit = array_map( 'trim', explode( ';', $cookie ) );
|
|
|
|
if ( count( $bit ) >= 1 ) {
|
|
list( $name, $value ) = explode( '=', array_shift( $bit ), 2 );
|
|
$attr = [];
|
|
|
|
foreach ( $bit as $piece ) {
|
|
$parts = explode( '=', $piece );
|
|
if ( count( $parts ) > 1 ) {
|
|
$attr[strtolower( $parts[0] )] = $parts[1];
|
|
} else {
|
|
$attr[strtolower( $parts[0] )] = true;
|
|
}
|
|
}
|
|
|
|
if ( !isset( $attr['domain'] ) ) {
|
|
$attr['domain'] = $domain;
|
|
} elseif ( !Cookie::validateCookieDomain( $attr['domain'], $domain ) ) {
|
|
return null;
|
|
}
|
|
|
|
$this->setCookie( $name, $value, $attr );
|
|
}
|
|
}
|
|
}
|