2016-08-25 14:18:39 -04:00
|
|
|
<?php
|
|
|
|
/**
|
|
|
|
* Feed API: WP_SimplePie_File class
|
|
|
|
*
|
|
|
|
* @package WordPress
|
|
|
|
* @subpackage Feed
|
|
|
|
* @since 4.7.0
|
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Core class for fetching remote files and reading local files with SimplePie.
|
|
|
|
*
|
Feed: Merge multiple header values to avoid fatal error.
When SimplePie parses HTTP headers, it combines multiple values for the same header into a comma-separated string. `WP_SimplePie_File` overrides the parsing, but was leaving them as an array instead.
That lead to a fatal error in PHP 8, because other parts of the codebase ended up passing an array to a function that expected a string.
Props david.binda, litemotiv, inc2734, NicolasKulka, hellofromTonya, mbabker, skithund, SergeyBiryukov, desrosj, timothyblynjacobs.
Fixes #51056. See #51956.
Built from https://develop.svn.wordpress.org/trunk@49803
git-svn-id: http://core.svn.wordpress.org/trunk@49526 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-12-15 19:51:05 -05:00
|
|
|
* This uses Core's HTTP API to make requests, which gives plugins the ability
|
|
|
|
* to hook into the process.
|
|
|
|
*
|
2016-08-25 14:18:39 -04:00
|
|
|
* @since 2.8.0
|
|
|
|
*
|
|
|
|
* @see SimplePie_File
|
|
|
|
*/
|
Code Modernization: Add `AllowDynamicProperties` attribute to all (parent) classes.
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
2022-09-12 11:47:14 -04:00
|
|
|
#[AllowDynamicProperties]
|
2016-08-25 14:18:39 -04:00
|
|
|
class WP_SimplePie_File extends SimplePie_File {
|
|
|
|
|
Code Modernization: Explicitly declare WP-specific property in `WP_SimplePie_File`.
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.
In this case, the `$timeout` property falls in the “known property” category.
Note: In contrast to the other properties being set in the constructor, this property is not declared on the parent class, so not inherited.
Reference: [https://wiki.php.net/rfc/deprecate_dynamic_properties PHP RFC: Deprecate dynamic properties].
Follow-up to [10687], [53557], [53558], [53850], [53851], [53852], [53853], [53854], [53856], [53916], [53935], [53936], [53937], [53938], [53942], [53945], [53948], [53949], [53952].
Props jrf, antonvlasenko, costdev.
See #56033.
Built from https://develop.svn.wordpress.org/trunk@53953
git-svn-id: http://core.svn.wordpress.org/trunk@53512 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-08-29 09:19:12 -04:00
|
|
|
/**
|
|
|
|
* Timeout.
|
|
|
|
*
|
|
|
|
* @var int How long the connection should stay open in seconds.
|
|
|
|
*/
|
|
|
|
public $timeout = 10;
|
|
|
|
|
2016-08-25 14:18:39 -04:00
|
|
|
/**
|
|
|
|
* Constructor.
|
|
|
|
*
|
|
|
|
* @since 2.8.0
|
|
|
|
* @since 3.2.0 Updated to use a PHP5 constructor.
|
2021-05-15 13:38:05 -04:00
|
|
|
* @since 5.6.1 Multiple headers are concatenated into a comma-separated string,
|
|
|
|
* rather than remaining an array.
|
2016-08-25 14:18:39 -04:00
|
|
|
*
|
|
|
|
* @param string $url Remote file URL.
|
2020-10-10 16:02:05 -04:00
|
|
|
* @param int $timeout Optional. How long the connection should stay open in seconds.
|
2016-08-25 14:18:39 -04:00
|
|
|
* Default 10.
|
2020-10-10 16:02:05 -04:00
|
|
|
* @param int $redirects Optional. The number of allowed redirects. Default 5.
|
2016-08-25 14:18:39 -04:00
|
|
|
* @param string|array $headers Optional. Array or string of headers to send with the request.
|
|
|
|
* Default null.
|
|
|
|
* @param string $useragent Optional. User-agent value sent. Default null.
|
2020-10-10 16:02:05 -04:00
|
|
|
* @param bool $force_fsockopen Optional. Whether to force opening internet or unix domain socket
|
2016-08-25 14:18:39 -04:00
|
|
|
* connection or not. Default false.
|
|
|
|
*/
|
2017-11-30 18:11:00 -05:00
|
|
|
public function __construct( $url, $timeout = 10, $redirects = 5, $headers = null, $useragent = null, $force_fsockopen = false ) {
|
|
|
|
$this->url = $url;
|
|
|
|
$this->timeout = $timeout;
|
2016-08-25 14:18:39 -04:00
|
|
|
$this->redirects = $redirects;
|
2017-11-30 18:11:00 -05:00
|
|
|
$this->headers = $headers;
|
2016-08-25 14:18:39 -04:00
|
|
|
$this->useragent = $useragent;
|
|
|
|
|
|
|
|
$this->method = SIMPLEPIE_FILE_SOURCE_REMOTE;
|
|
|
|
|
2017-11-30 18:11:00 -05:00
|
|
|
if ( preg_match( '/^http(s)?:\/\//i', $url ) ) {
|
2016-08-25 14:18:39 -04:00
|
|
|
$args = array(
|
2017-11-30 18:11:00 -05:00
|
|
|
'timeout' => $this->timeout,
|
2016-08-25 14:18:39 -04:00
|
|
|
'redirection' => $this->redirects,
|
|
|
|
);
|
|
|
|
|
2017-11-30 18:11:00 -05:00
|
|
|
if ( ! empty( $this->headers ) ) {
|
2016-08-25 14:18:39 -04:00
|
|
|
$args['headers'] = $this->headers;
|
2017-11-30 18:11:00 -05:00
|
|
|
}
|
2016-08-25 14:18:39 -04:00
|
|
|
|
2020-01-28 19:45:18 -05:00
|
|
|
if ( SIMPLEPIE_USERAGENT != $this->useragent ) { // Use default WP user agent unless custom has been specified.
|
2016-08-25 14:18:39 -04:00
|
|
|
$args['user-agent'] = $this->useragent;
|
2017-11-30 18:11:00 -05:00
|
|
|
}
|
2016-08-25 14:18:39 -04:00
|
|
|
|
2017-11-30 18:11:00 -05:00
|
|
|
$res = wp_safe_remote_request( $url, $args );
|
2016-08-25 14:18:39 -04:00
|
|
|
|
2017-11-30 18:11:00 -05:00
|
|
|
if ( is_wp_error( $res ) ) {
|
|
|
|
$this->error = 'WP HTTP Error: ' . $res->get_error_message();
|
2016-08-25 14:18:39 -04:00
|
|
|
$this->success = false;
|
Feed: Merge multiple header values to avoid fatal error.
When SimplePie parses HTTP headers, it combines multiple values for the same header into a comma-separated string. `WP_SimplePie_File` overrides the parsing, but was leaving them as an array instead.
That lead to a fatal error in PHP 8, because other parts of the codebase ended up passing an array to a function that expected a string.
Props david.binda, litemotiv, inc2734, NicolasKulka, hellofromTonya, mbabker, skithund, SergeyBiryukov, desrosj, timothyblynjacobs.
Fixes #51056. See #51956.
Built from https://develop.svn.wordpress.org/trunk@49803
git-svn-id: http://core.svn.wordpress.org/trunk@49526 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-12-15 19:51:05 -05:00
|
|
|
|
2016-08-25 14:18:39 -04:00
|
|
|
} else {
|
Feed: Merge multiple header values to avoid fatal error.
When SimplePie parses HTTP headers, it combines multiple values for the same header into a comma-separated string. `WP_SimplePie_File` overrides the parsing, but was leaving them as an array instead.
That lead to a fatal error in PHP 8, because other parts of the codebase ended up passing an array to a function that expected a string.
Props david.binda, litemotiv, inc2734, NicolasKulka, hellofromTonya, mbabker, skithund, SergeyBiryukov, desrosj, timothyblynjacobs.
Fixes #51056. See #51956.
Built from https://develop.svn.wordpress.org/trunk@49803
git-svn-id: http://core.svn.wordpress.org/trunk@49526 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-12-15 19:51:05 -05:00
|
|
|
$this->headers = wp_remote_retrieve_headers( $res );
|
|
|
|
|
|
|
|
/*
|
2021-05-15 13:38:05 -04:00
|
|
|
* SimplePie expects multiple headers to be stored as a comma-separated string,
|
|
|
|
* but `wp_remote_retrieve_headers()` returns them as an array, so they need
|
|
|
|
* to be converted.
|
Feed: Merge multiple header values to avoid fatal error.
When SimplePie parses HTTP headers, it combines multiple values for the same header into a comma-separated string. `WP_SimplePie_File` overrides the parsing, but was leaving them as an array instead.
That lead to a fatal error in PHP 8, because other parts of the codebase ended up passing an array to a function that expected a string.
Props david.binda, litemotiv, inc2734, NicolasKulka, hellofromTonya, mbabker, skithund, SergeyBiryukov, desrosj, timothyblynjacobs.
Fixes #51056. See #51956.
Built from https://develop.svn.wordpress.org/trunk@49803
git-svn-id: http://core.svn.wordpress.org/trunk@49526 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-12-15 19:51:05 -05:00
|
|
|
*
|
2021-05-15 13:38:05 -04:00
|
|
|
* The only exception to that is the `content-type` header, which should ignore
|
|
|
|
* any previous values and only use the last one.
|
Feed: Merge multiple header values to avoid fatal error.
When SimplePie parses HTTP headers, it combines multiple values for the same header into a comma-separated string. `WP_SimplePie_File` overrides the parsing, but was leaving them as an array instead.
That lead to a fatal error in PHP 8, because other parts of the codebase ended up passing an array to a function that expected a string.
Props david.binda, litemotiv, inc2734, NicolasKulka, hellofromTonya, mbabker, skithund, SergeyBiryukov, desrosj, timothyblynjacobs.
Fixes #51056. See #51956.
Built from https://develop.svn.wordpress.org/trunk@49803
git-svn-id: http://core.svn.wordpress.org/trunk@49526 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-12-15 19:51:05 -05:00
|
|
|
*
|
|
|
|
* @see SimplePie_HTTP_Parser::new_line().
|
|
|
|
*/
|
|
|
|
foreach ( $this->headers as $name => $value ) {
|
|
|
|
if ( ! is_array( $value ) ) {
|
|
|
|
continue;
|
|
|
|
}
|
|
|
|
|
|
|
|
if ( 'content-type' === $name ) {
|
|
|
|
$this->headers[ $name ] = array_pop( $value );
|
|
|
|
} else {
|
2020-12-16 09:05:07 -05:00
|
|
|
$this->headers[ $name ] = implode( ', ', $value );
|
Feed: Merge multiple header values to avoid fatal error.
When SimplePie parses HTTP headers, it combines multiple values for the same header into a comma-separated string. `WP_SimplePie_File` overrides the parsing, but was leaving them as an array instead.
That lead to a fatal error in PHP 8, because other parts of the codebase ended up passing an array to a function that expected a string.
Props david.binda, litemotiv, inc2734, NicolasKulka, hellofromTonya, mbabker, skithund, SergeyBiryukov, desrosj, timothyblynjacobs.
Fixes #51056. See #51956.
Built from https://develop.svn.wordpress.org/trunk@49803
git-svn-id: http://core.svn.wordpress.org/trunk@49526 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-12-15 19:51:05 -05:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-11-30 18:11:00 -05:00
|
|
|
$this->body = wp_remote_retrieve_body( $res );
|
2016-08-25 14:18:39 -04:00
|
|
|
$this->status_code = wp_remote_retrieve_response_code( $res );
|
|
|
|
}
|
|
|
|
} else {
|
2017-11-30 18:11:00 -05:00
|
|
|
$this->error = '';
|
2016-08-25 14:18:39 -04:00
|
|
|
$this->success = false;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|