<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* HTTP API: WP_Http_Cookie class

[2] Fix | Delete

*

[3] Fix | Delete

* @package WordPress

[4] Fix | Delete

* @subpackage HTTP

[5] Fix | Delete

* @since 4.4.0

[6] Fix | Delete

*/

[7] Fix | Delete

[8] Fix | Delete

/**

[9] Fix | Delete

* Core class used to encapsulate a single cookie object for internal use.

[10] Fix | Delete

*

[11] Fix | Delete

* Returned cookies are represented using this class, and when cookies are set, if they are not

[12] Fix | Delete

* already a WP_Http_Cookie() object, then they are turned into one.

[13] Fix | Delete

*

[14] Fix | Delete

* @todo The WordPress convention is to use underscores instead of camelCase for function and method

[15] Fix | Delete

* names. Need to switch to use underscores instead for the methods.

[16] Fix | Delete

*

[17] Fix | Delete

* @since 2.8.0

[18] Fix | Delete

*/

[19] Fix | Delete

#[AllowDynamicProperties]

[20] Fix | Delete

class WP_Http_Cookie {

[21] Fix | Delete

[22] Fix | Delete

/**

[23] Fix | Delete

* Cookie name.

[24] Fix | Delete

*

[25] Fix | Delete

* @since 2.8.0

[26] Fix | Delete

*

[27] Fix | Delete

* @var string

[28] Fix | Delete

*/

[29] Fix | Delete

public $name;

[30] Fix | Delete

[31] Fix | Delete

/**

[32] Fix | Delete

* Cookie value.

[33] Fix | Delete

*

[34] Fix | Delete

* @since 2.8.0

[35] Fix | Delete

*

[36] Fix | Delete

* @var string

[37] Fix | Delete

*/

[38] Fix | Delete

public $value;

[39] Fix | Delete

[40] Fix | Delete

/**

[41] Fix | Delete

* When the cookie expires. Unix timestamp or formatted date.

[42] Fix | Delete

*

[43] Fix | Delete

* @since 2.8.0

[44] Fix | Delete

*

[45] Fix | Delete

* @var string|int|null

[46] Fix | Delete

*/

[47] Fix | Delete

public $expires;

[48] Fix | Delete

[49] Fix | Delete

/**

[50] Fix | Delete

* Cookie URL path.

[51] Fix | Delete

*

[52] Fix | Delete

* @since 2.8.0

[53] Fix | Delete

*

[54] Fix | Delete

* @var string

[55] Fix | Delete

*/

[56] Fix | Delete

public $path;

[57] Fix | Delete

[58] Fix | Delete

/**

[59] Fix | Delete

* Cookie Domain.

[60] Fix | Delete

*

[61] Fix | Delete

* @since 2.8.0

[62] Fix | Delete

*

[63] Fix | Delete

* @var string

[64] Fix | Delete

*/

[65] Fix | Delete

public $domain;

[66] Fix | Delete

[67] Fix | Delete

/**

[68] Fix | Delete

* Cookie port or comma-separated list of ports.

[69] Fix | Delete

*

[70] Fix | Delete

* @since 2.8.0

[71] Fix | Delete

*

[72] Fix | Delete

* @var int|string

[73] Fix | Delete

*/

[74] Fix | Delete

public $port;

[75] Fix | Delete

[76] Fix | Delete

/**

[77] Fix | Delete

* host-only flag.

[78] Fix | Delete

*

[79] Fix | Delete

* @since 5.2.0

[80] Fix | Delete

*

[81] Fix | Delete

* @var bool

[82] Fix | Delete

*/

[83] Fix | Delete

public $host_only;

[84] Fix | Delete

[85] Fix | Delete

/**

[86] Fix | Delete

* Sets up this cookie object.

[87] Fix | Delete

*

[88] Fix | Delete

* The parameter $data should be either an associative array containing the indices names below

[89] Fix | Delete

* or a header string detailing it.

[90] Fix | Delete

*

[91] Fix | Delete

* @since 2.8.0

[92] Fix | Delete

* @since 5.2.0 Added `host_only` to the `$data` parameter.

[93] Fix | Delete

*

[94] Fix | Delete

* @param string|array $data {

[95] Fix | Delete

* Raw cookie data as header string or data array.

[96] Fix | Delete

*

[97] Fix | Delete

* @type string $name Cookie name.

[98] Fix | Delete

* @type mixed $value Value. Should NOT already be urlencoded.

[99] Fix | Delete

* @type string|int|null $expires Optional. Unix timestamp or formatted date. Default null.

[100] Fix | Delete

* @type string $path Optional. Path. Default '/'.

[101] Fix | Delete

* @type string $domain Optional. Domain. Default host of parsed $requested_url.

[102] Fix | Delete

* @type int|string $port Optional. Port or comma-separated list of ports. Default null.

[103] Fix | Delete

* @type bool $host_only Optional. host-only storage flag. Default true.

[104] Fix | Delete

* }

[105] Fix | Delete

* @param string $requested_url The URL which the cookie was set on, used for default $domain

[106] Fix | Delete

* and $port values.

[107] Fix | Delete

*/

[108] Fix | Delete

public function __construct( $data, $requested_url = '' ) {

[109] Fix | Delete

if ( $requested_url ) {

[110] Fix | Delete

$parsed_url = parse_url( $requested_url );

[111] Fix | Delete

}

[112] Fix | Delete

if ( isset( $parsed_url['host'] ) ) {

[113] Fix | Delete

$this->domain = $parsed_url['host'];

[114] Fix | Delete

}

[115] Fix | Delete

$this->path = isset( $parsed_url['path'] ) ? $parsed_url['path'] : '/';

[116] Fix | Delete

if ( ! str_ends_with( $this->path, '/' ) ) {

[117] Fix | Delete

$this->path = dirname( $this->path ) . '/';

[118] Fix | Delete

}

[119] Fix | Delete

[120] Fix | Delete

if ( is_string( $data ) ) {

[121] Fix | Delete

// Assume it's a header string direct from a previous request.

[122] Fix | Delete

$pairs = explode( ';', $data );

[123] Fix | Delete

[124] Fix | Delete

// Special handling for first pair; name=value. Also be careful of "=" in value.

[125] Fix | Delete

$name = trim( substr( $pairs[0], 0, strpos( $pairs[0], '=' ) ) );

[126] Fix | Delete

$value = substr( $pairs[0], strpos( $pairs[0], '=' ) + 1 );

[127] Fix | Delete

$this->name = $name;

[128] Fix | Delete

$this->value = urldecode( $value );

[129] Fix | Delete

[130] Fix | Delete

// Removes name=value from items.

[131] Fix | Delete

array_shift( $pairs );

[132] Fix | Delete

[133] Fix | Delete

// Set everything else as a property.

[134] Fix | Delete

foreach ( $pairs as $pair ) {

[135] Fix | Delete

$pair = rtrim( $pair );

[136] Fix | Delete

[137] Fix | Delete

// Handle the cookie ending in ; which results in an empty final pair.

[138] Fix | Delete

if ( empty( $pair ) ) {

[139] Fix | Delete

continue;

[140] Fix | Delete

}

[141] Fix | Delete

[142] Fix | Delete

list( $key, $val ) = strpos( $pair, '=' ) ? explode( '=', $pair ) : array( $pair, '' );

[143] Fix | Delete

$key = strtolower( trim( $key ) );

[144] Fix | Delete

if ( 'expires' === $key ) {

[145] Fix | Delete

$val = strtotime( $val );

[146] Fix | Delete

}

[147] Fix | Delete

$this->$key = $val;

[148] Fix | Delete

}

[149] Fix | Delete

} else {

[150] Fix | Delete

if ( ! isset( $data['name'] ) ) {

[151] Fix | Delete

return;

[152] Fix | Delete

}

[153] Fix | Delete

[154] Fix | Delete

// Set properties based directly on parameters.

[155] Fix | Delete

foreach ( array( 'name', 'value', 'path', 'domain', 'port', 'host_only' ) as $field ) {

[156] Fix | Delete

if ( isset( $data[ $field ] ) ) {

[157] Fix | Delete

$this->$field = $data[ $field ];

[158] Fix | Delete

}

[159] Fix | Delete

}

[160] Fix | Delete

[161] Fix | Delete

if ( isset( $data['expires'] ) ) {

[162] Fix | Delete

$this->expires = is_int( $data['expires'] ) ? $data['expires'] : strtotime( $data['expires'] );

[163] Fix | Delete

} else {

[164] Fix | Delete

$this->expires = null;

[165] Fix | Delete

}

[166] Fix | Delete

}

[167] Fix | Delete

}

[168] Fix | Delete

[169] Fix | Delete

/**

[170] Fix | Delete

* Confirms that it's OK to send this cookie to the URL checked against.

[171] Fix | Delete

*

[172] Fix | Delete

* Decision is based on RFC 2109/2965, so look there for details on validity.

[173] Fix | Delete

*

[174] Fix | Delete

* @since 2.8.0

[175] Fix | Delete

*

[176] Fix | Delete

* @param string $url URL you intend to send this cookie to

[177] Fix | Delete

* @return bool true if allowed, false otherwise.

[178] Fix | Delete

*/

[179] Fix | Delete

public function test( $url ) {

[180] Fix | Delete

if ( is_null( $this->name ) ) {

[181] Fix | Delete

return false;

[182] Fix | Delete

}

[183] Fix | Delete

[184] Fix | Delete

// Expires - if expired then nothing else matters.

[185] Fix | Delete

if ( isset( $this->expires ) && time() > $this->expires ) {

[186] Fix | Delete

return false;

[187] Fix | Delete

}

[188] Fix | Delete

[189] Fix | Delete

// Get details on the URL we're thinking about sending to.

[190] Fix | Delete

$url = parse_url( $url );

[191] Fix | Delete

$url['port'] = isset( $url['port'] ) ? $url['port'] : ( 'https' === $url['scheme'] ? 443 : 80 );

[192] Fix | Delete

$url['path'] = isset( $url['path'] ) ? $url['path'] : '/';

[193] Fix | Delete

[194] Fix | Delete

// Values to use for comparison against the URL.

[195] Fix | Delete

$path = isset( $this->path ) ? $this->path : '/';

[196] Fix | Delete

$port = isset( $this->port ) ? $this->port : null;

[197] Fix | Delete

$domain = isset( $this->domain ) ? strtolower( $this->domain ) : strtolower( $url['host'] );

[198] Fix | Delete

if ( false === stripos( $domain, '.' ) ) {

[199] Fix | Delete

$domain .= '.local';

[200] Fix | Delete

}

[201] Fix | Delete

[202] Fix | Delete

// Host - very basic check that the request URL ends with the domain restriction (minus leading dot).

[203] Fix | Delete

$domain = ( str_starts_with( $domain, '.' ) ) ? substr( $domain, 1 ) : $domain;

[204] Fix | Delete

if ( ! str_ends_with( $url['host'], $domain ) ) {

[205] Fix | Delete

return false;

[206] Fix | Delete

}

[207] Fix | Delete

[208] Fix | Delete

// Port - supports "port-lists" in the format: "80,8000,8080".

[209] Fix | Delete

if ( ! empty( $port ) && ! in_array( $url['port'], array_map( 'intval', explode( ',', $port ) ), true ) ) {

[210] Fix | Delete

return false;

[211] Fix | Delete

}

[212] Fix | Delete

[213] Fix | Delete

// Path - request path must start with path restriction.

[214] Fix | Delete

if ( ! str_starts_with( $url['path'], $path ) ) {

[215] Fix | Delete

return false;

[216] Fix | Delete

}

[217] Fix | Delete

[218] Fix | Delete

return true;

[219] Fix | Delete

}

[220] Fix | Delete

[221] Fix | Delete

/**

[222] Fix | Delete

* Convert cookie name and value back to header string.

[223] Fix | Delete

*

[224] Fix | Delete

* @since 2.8.0

[225] Fix | Delete

*

[226] Fix | Delete

* @return string Header encoded cookie name and value.

[227] Fix | Delete

*/

[228] Fix | Delete

public function getHeaderValue() { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid

[229] Fix | Delete

if ( ! isset( $this->name ) || ! isset( $this->value ) ) {

[230] Fix | Delete

return '';

[231] Fix | Delete

}

[232] Fix | Delete

[233] Fix | Delete

/**

[234] Fix | Delete

* Filters the header-encoded cookie value.

[235] Fix | Delete

*

[236] Fix | Delete

* @since 3.4.0

[237] Fix | Delete

*

[238] Fix | Delete

* @param string $value The cookie value.

[239] Fix | Delete

* @param string $name The cookie name.

[240] Fix | Delete

*/

[241] Fix | Delete

return $this->name . '=' . apply_filters( 'wp_http_cookie_value', $this->value, $this->name );

[242] Fix | Delete

}

[243] Fix | Delete

[244] Fix | Delete

/**

[245] Fix | Delete

* Retrieve cookie header for usage in the rest of the WordPress HTTP API.

[246] Fix | Delete

*

[247] Fix | Delete

* @since 2.8.0

[248] Fix | Delete

*

[249] Fix | Delete

* @return string

[250] Fix | Delete

*/

[251] Fix | Delete

public function getFullHeader() { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid

[252] Fix | Delete

return 'Cookie: ' . $this->getHeaderValue();

[253] Fix | Delete

}

[254] Fix | Delete

[255] Fix | Delete

/**

[256] Fix | Delete

* Retrieves cookie attributes.

[257] Fix | Delete

*

[258] Fix | Delete

* @since 4.6.0

[259] Fix | Delete

*

[260] Fix | Delete

* @return array {

[261] Fix | Delete

* List of attributes.

[262] Fix | Delete

*

[263] Fix | Delete

* @type string|int|null $expires When the cookie expires. Unix timestamp or formatted date.

[264] Fix | Delete

* @type string $path Cookie URL path.

[265] Fix | Delete

* @type string $domain Cookie domain.

[266] Fix | Delete

* }

[267] Fix | Delete

*/

[268] Fix | Delete

public function get_attributes() {

[269] Fix | Delete

return array(

[270] Fix | Delete

'expires' => $this->expires,

[271] Fix | Delete

'path' => $this->path,

[272] Fix | Delete

'domain' => $this->domain,

[273] Fix | Delete

);

[274] Fix | Delete

}

[275] Fix | Delete

}

[276] Fix | Delete

[277] Fix | Delete