mirror of
https://github.com/WordPress/WordPress.git
synced 2024-09-11 23:28:18 +02:00
Dynamic (non-explicitly declared) properties are deprecated as of PHP 8.2 and are expected to become a fatal error in PHP 9.0. There are a number of ways to mitigate this: * If it is an accidental typo for a declared property: fix the typo. * For known properties: declare them on the class. * For unknown properties: add the magic `__get()`, `__set()`, et al. methods to the class or let the class extend `stdClass` which has highly optimized versions of these magic methods built in. * For unknown ''use'' of dynamic properties, the `#[AllowDynamicProperties]` attribute can be added to the class. The attribute will automatically be inherited by child classes. Trac ticket #56034 is open to investigate and handle the third and fourth type of situations, however it has become clear this will need more time and will not be ready in time for WP 6.1. To reduce “noise” in the meantime, both in the error logs of WP users moving onto PHP 8.2, in the test run logs of WP itself, in test runs of plugins and themes, as well as to prevent duplicate tickets from being opened for the same issue, this commit adds the `#[AllowDynamicProperties]` attribute to all “parent” classes in WP. The logic used for this commit is as follows: * If a class already has the attribute: no action needed. * If a class does not `extend`: add the attribute. * If a class does `extend`: - If it extends `stdClass`: no action needed (as `stdClass` supports dynamic properties). - If it extends a PHP native class: add the attribute. - If it extends a class from one of WP's external dependencies: add the attribute. * In all other cases: no action — the attribute should not be needed as child classes inherit from the parent. Whether or not a class contains magic methods has not been taken into account, as a review of the currently existing magic methods has shown that those are generally not sturdy enough and often even set dynamic properties (which they should not). See the [https://www.youtube.com/watch?v=vDZWepDQQVE live stream from August 16, 2022] for more details. This commit only affects classes in the `src` directory of WordPress core. * Tests should not get this attribute, but should be fixed to not use dynamic properties instead. Patches for this are already being committed under ticket #56033. * While a number bundled themes (2014, 2019, 2020, 2021) contain classes, they are not a part of this commit and may be updated separately. Reference: [https://wiki.php.net/rfc/deprecate_dynamic_properties PHP RFC: Deprecate dynamic properties]. Follow-up to [53922]. Props jrf, hellofromTonya, markjaquith, peterwilsoncc, costdev, knutsp, aristath. See #56513, #56034. Built from https://develop.svn.wordpress.org/trunk@54133 git-svn-id: http://core.svn.wordpress.org/trunk@53692 1a063a9b-81f0-0310-95a4-ce76da25c4cd
278 lines
7.2 KiB
PHP
278 lines
7.2 KiB
PHP
<?php
|
|
/**
|
|
* HTTP API: WP_Http_Cookie class
|
|
*
|
|
* @package WordPress
|
|
* @subpackage HTTP
|
|
* @since 4.4.0
|
|
*/
|
|
|
|
/**
|
|
* Core class used to encapsulate a single cookie object for internal use.
|
|
*
|
|
* Returned cookies are represented using this class, and when cookies are set, if they are not
|
|
* already a WP_Http_Cookie() object, then they are turned into one.
|
|
*
|
|
* @todo The WordPress convention is to use underscores instead of camelCase for function and method
|
|
* names. Need to switch to use underscores instead for the methods.
|
|
*
|
|
* @since 2.8.0
|
|
*/
|
|
#[AllowDynamicProperties]
|
|
class WP_Http_Cookie {
|
|
|
|
/**
|
|
* Cookie name.
|
|
*
|
|
* @since 2.8.0
|
|
*
|
|
* @var string
|
|
*/
|
|
public $name;
|
|
|
|
/**
|
|
* Cookie value.
|
|
*
|
|
* @since 2.8.0
|
|
*
|
|
* @var string
|
|
*/
|
|
public $value;
|
|
|
|
/**
|
|
* When the cookie expires. Unix timestamp or formatted date.
|
|
*
|
|
* @since 2.8.0
|
|
*
|
|
* @var string|int|null
|
|
*/
|
|
public $expires;
|
|
|
|
/**
|
|
* Cookie URL path.
|
|
*
|
|
* @since 2.8.0
|
|
*
|
|
* @var string
|
|
*/
|
|
public $path;
|
|
|
|
/**
|
|
* Cookie Domain.
|
|
*
|
|
* @since 2.8.0
|
|
*
|
|
* @var string
|
|
*/
|
|
public $domain;
|
|
|
|
/**
|
|
* Cookie port or comma-separated list of ports.
|
|
*
|
|
* @since 2.8.0
|
|
*
|
|
* @var int|string
|
|
*/
|
|
public $port;
|
|
|
|
/**
|
|
* host-only flag.
|
|
*
|
|
* @since 5.2.0
|
|
*
|
|
* @var bool
|
|
*/
|
|
public $host_only;
|
|
|
|
/**
|
|
* Sets up this cookie object.
|
|
*
|
|
* The parameter $data should be either an associative array containing the indices names below
|
|
* or a header string detailing it.
|
|
*
|
|
* @since 2.8.0
|
|
* @since 5.2.0 Added `host_only` to the `$data` parameter.
|
|
*
|
|
* @param string|array $data {
|
|
* Raw cookie data as header string or data array.
|
|
*
|
|
* @type string $name Cookie name.
|
|
* @type mixed $value Value. Should NOT already be urlencoded.
|
|
* @type string|int|null $expires Optional. Unix timestamp or formatted date. Default null.
|
|
* @type string $path Optional. Path. Default '/'.
|
|
* @type string $domain Optional. Domain. Default host of parsed $requested_url.
|
|
* @type int|string $port Optional. Port or comma-separated list of ports. Default null.
|
|
* @type bool $host_only Optional. host-only storage flag. Default true.
|
|
* }
|
|
* @param string $requested_url The URL which the cookie was set on, used for default $domain
|
|
* and $port values.
|
|
*/
|
|
public function __construct( $data, $requested_url = '' ) {
|
|
if ( $requested_url ) {
|
|
$parsed_url = parse_url( $requested_url );
|
|
}
|
|
if ( isset( $parsed_url['host'] ) ) {
|
|
$this->domain = $parsed_url['host'];
|
|
}
|
|
$this->path = isset( $parsed_url['path'] ) ? $parsed_url['path'] : '/';
|
|
if ( '/' !== substr( $this->path, -1 ) ) {
|
|
$this->path = dirname( $this->path ) . '/';
|
|
}
|
|
|
|
if ( is_string( $data ) ) {
|
|
// Assume it's a header string direct from a previous request.
|
|
$pairs = explode( ';', $data );
|
|
|
|
// Special handling for first pair; name=value. Also be careful of "=" in value.
|
|
$name = trim( substr( $pairs[0], 0, strpos( $pairs[0], '=' ) ) );
|
|
$value = substr( $pairs[0], strpos( $pairs[0], '=' ) + 1 );
|
|
$this->name = $name;
|
|
$this->value = urldecode( $value );
|
|
|
|
// Removes name=value from items.
|
|
array_shift( $pairs );
|
|
|
|
// Set everything else as a property.
|
|
foreach ( $pairs as $pair ) {
|
|
$pair = rtrim( $pair );
|
|
|
|
// Handle the cookie ending in ; which results in a empty final pair.
|
|
if ( empty( $pair ) ) {
|
|
continue;
|
|
}
|
|
|
|
list( $key, $val ) = strpos( $pair, '=' ) ? explode( '=', $pair ) : array( $pair, '' );
|
|
$key = strtolower( trim( $key ) );
|
|
if ( 'expires' === $key ) {
|
|
$val = strtotime( $val );
|
|
}
|
|
$this->$key = $val;
|
|
}
|
|
} else {
|
|
if ( ! isset( $data['name'] ) ) {
|
|
return;
|
|
}
|
|
|
|
// Set properties based directly on parameters.
|
|
foreach ( array( 'name', 'value', 'path', 'domain', 'port', 'host_only' ) as $field ) {
|
|
if ( isset( $data[ $field ] ) ) {
|
|
$this->$field = $data[ $field ];
|
|
}
|
|
}
|
|
|
|
if ( isset( $data['expires'] ) ) {
|
|
$this->expires = is_int( $data['expires'] ) ? $data['expires'] : strtotime( $data['expires'] );
|
|
} else {
|
|
$this->expires = null;
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Confirms that it's OK to send this cookie to the URL checked against.
|
|
*
|
|
* Decision is based on RFC 2109/2965, so look there for details on validity.
|
|
*
|
|
* @since 2.8.0
|
|
*
|
|
* @param string $url URL you intend to send this cookie to
|
|
* @return bool true if allowed, false otherwise.
|
|
*/
|
|
public function test( $url ) {
|
|
if ( is_null( $this->name ) ) {
|
|
return false;
|
|
}
|
|
|
|
// Expires - if expired then nothing else matters.
|
|
if ( isset( $this->expires ) && time() > $this->expires ) {
|
|
return false;
|
|
}
|
|
|
|
// Get details on the URL we're thinking about sending to.
|
|
$url = parse_url( $url );
|
|
$url['port'] = isset( $url['port'] ) ? $url['port'] : ( 'https' === $url['scheme'] ? 443 : 80 );
|
|
$url['path'] = isset( $url['path'] ) ? $url['path'] : '/';
|
|
|
|
// Values to use for comparison against the URL.
|
|
$path = isset( $this->path ) ? $this->path : '/';
|
|
$port = isset( $this->port ) ? $this->port : null;
|
|
$domain = isset( $this->domain ) ? strtolower( $this->domain ) : strtolower( $url['host'] );
|
|
if ( false === stripos( $domain, '.' ) ) {
|
|
$domain .= '.local';
|
|
}
|
|
|
|
// Host - very basic check that the request URL ends with the domain restriction (minus leading dot).
|
|
$domain = ( '.' === substr( $domain, 0, 1 ) ) ? substr( $domain, 1 ) : $domain;
|
|
if ( substr( $url['host'], -strlen( $domain ) ) !== $domain ) {
|
|
return false;
|
|
}
|
|
|
|
// Port - supports "port-lists" in the format: "80,8000,8080".
|
|
if ( ! empty( $port ) && ! in_array( $url['port'], array_map( 'intval', explode( ',', $port ) ), true ) ) {
|
|
return false;
|
|
}
|
|
|
|
// Path - request path must start with path restriction.
|
|
if ( substr( $url['path'], 0, strlen( $path ) ) !== $path ) {
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Convert cookie name and value back to header string.
|
|
*
|
|
* @since 2.8.0
|
|
*
|
|
* @return string Header encoded cookie name and value.
|
|
*/
|
|
public function getHeaderValue() { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid
|
|
if ( ! isset( $this->name ) || ! isset( $this->value ) ) {
|
|
return '';
|
|
}
|
|
|
|
/**
|
|
* Filters the header-encoded cookie value.
|
|
*
|
|
* @since 3.4.0
|
|
*
|
|
* @param string $value The cookie value.
|
|
* @param string $name The cookie name.
|
|
*/
|
|
return $this->name . '=' . apply_filters( 'wp_http_cookie_value', $this->value, $this->name );
|
|
}
|
|
|
|
/**
|
|
* Retrieve cookie header for usage in the rest of the WordPress HTTP API.
|
|
*
|
|
* @since 2.8.0
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getFullHeader() { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid
|
|
return 'Cookie: ' . $this->getHeaderValue();
|
|
}
|
|
|
|
/**
|
|
* Retrieves cookie attributes.
|
|
*
|
|
* @since 4.6.0
|
|
*
|
|
* @return array {
|
|
* List of attributes.
|
|
*
|
|
* @type string|int|null $expires When the cookie expires. Unix timestamp or formatted date.
|
|
* @type string $path Cookie URL path.
|
|
* @type string $domain Cookie domain.
|
|
* }
|
|
*/
|
|
public function get_attributes() {
|
|
return array(
|
|
'expires' => $this->expires,
|
|
'path' => $this->path,
|
|
'domain' => $this->domain,
|
|
);
|
|
}
|
|
}
|