Releases: WordPress/Requests
Version 1.8.0
IMPORTANT NOTES
Last release supporting PHP 5.2 - 5.5
Release 1.8.0 will be the last release with compatibility for PHP 5.2 - 5.5. With the next release (v2.0.0), the minimum PHP version will be bumped to 5.6.
Last release supporting PEAR distribution
Release 1.8.0 will be the last release to be distributed via PEAR. From release 2.0.0 onwards, consumers of this library will have to switch to Composer to receive updates.
Overview of changes
-
[SECURITY FIX] Disable deserialization in
FilteredIteratorA
Deserialization of Untrusted Dataweakness was found in theFilteredIteratorclass.This security vulnerability was first reported to the WordPress project. The security fix applied to WordPress has been ported back into the library.
GitHub security advisory: Insecure Deserialization of untrusted data
CVE: CVE-2021-29476 - Deserialization of Untrusted Data
Related WordPress CVE: https://cve.mitre.org/cgi-bin/cvename.cgi?name=2020-28032
(props [@dd32][gh-dd32], [@desrosj][gh-desrosj], [@jrfnl][gh-jrfnl], [@peterwilsoncc][gh-peterwilsoncc], [@SergeyBiryukov][gh-SergeyBiryukov], [@whyisjake][gh-whyisjake], [@xknown][gh-xknown], [#421][gh-421], [#422][gh-422])
-
Repository moved to
WordPress\RequestsThe
Requestslibrary has been moved to the WordPress GitHub organization and can now be found underhttps://github.com/WordPress/Requests.All links in code and documentation were updated accordingly.
Note: the Composer package name remains unchanged (
rmccue/requests), as well as the documentation site (requests.ryanmccue.info).(props [@dd32][gh-dd32], [@JustinyAhin][gh-JustinyAhin], [@jrfnl][gh-jrfnl], [@rmccue][gh-rmccue], [#440][gh-440], [#441][gh-441], [#448][gh-448])
-
Manage
"Expect"header withcURLtransportBy default,
cURLadds aExpect: 100-Continueheader to certain requests. This can add as much as a second delay to requests done usingcURL. This is discussed on the cURL mailing list.To prevent this,
Requestsnow adds an empty"Expect"header to requests that are smaller than 1 MB and use HTTP/1.1.(props [@carlalexander][gh-carlalexander], [@schlessera][gh-schlessera], [@TimothyBJacobs][gh-TimothyBJacobs], [#453][gh-453], [#454][gh-454], [#469][gh-469])
-
Update bundled certificates as of 2021-02-12
The bundled certificates were updated. A small subset of expired certificates are still included for legacy reasons (and support).
(props [@ozh][gh-ozh], [@patmead][gh-patmead], [@schlessera][gh-schlessera], [@todeveni][gh-todeveni], [#385][gh-385], [#398][gh-398], [#451][gh-451])
-
Add required
Content-*headers for emptyPOSTrequestsSends the
Content-LengthandContent-Typeheaders even for emptyPOSTrequests, as the length is expected as per RFC2616 Section 14.13:Content-Length header "SHOULD" be included. In practice, it is not used for GET nor HEAD requests, but is expected for POST requests.(props [@dd32][gh-dd32], [@gstrauss][gh-gstrauss], [@jrfnl][gh-jrfnl], [@soulseekah][gh-soulseekah], #248, #249, #318, [#368][gh-368])
-
Ignore locale when creating the HTTP version string from a float
The previous behavior allowed for the locale to mess up the float to string conversion resulting in a
GET / HTTP/1,1instead ofGET / HTTP/1.1request.(props [@tonebender][gh-tonebender], [@Zegnat][gh-Zegnat], #335, #339)
-
Make
verify => falsework withfsockopenThis allows the
fsockopentransport now to ignore SSL failures when requested.(props [@soulseekah][gh-soulseekah], #310, #311)
-
Only include port number in the
Hostheader if it differs from the defaultThe code was not violating the RFC per se, but also not following standard practice of leaving the port off when it is the default port for the scheme, which could lead to connectivity issues.
-
Fix PHP cross-version compatibility
Important fixes have been made to improve cross-version compatibility of the code across all supported PHP versions.
- Use documented order for
implode()arguments. - Harden type handling when no domain was passed.
- Explicitly cast
$urlproperty tostringinRequests::parse_response(). - Initialize
$bodyproperty to an empty string inRequests::parse_response(). - Ensure the stream handle is valid before trying to close it.
- Ensure the
$callbackin theFilteredIteratoris callable before calling it.
(props [@aaronjorbin][gh-aaronjorbin], [@jrfnl][gh-jrfnl], #346, [#370][gh-370], [#425][gh-425], [#426][gh-426], [#456][gh-456], [#457][gh-457])
- Use documented order for
-
Improve testing
Lots of improvements were made to render the tests more reliable and increase the coverage.
And to top it all off, all tests are now run against all supported PHP versions, including PHP 8.0.
(props [@datagutten][gh-datagutten], [@jrfnl][gh-jrfnl], [@schlessera][gh-schlessera], #345, #351, [#355][gh-355], [#366][gh-366], [#412][gh-412], [#414][gh-414], [#445][gh-445], [#458][gh-458], [#464][gh-464])
-
Improve code quality and style
A whole swoop of changes has been made to harden the code and make it more consistent.
The code style has been made consistent across both code and tests and is now enforced via a custom PHPCS rule set.
The WordPress Coding Standards were chosen as the basis for the code style checks as most contributors to this library originate from the WordPress community and will be familiar with this code style.
Main differences from the WordPress Coding Standards based on discussions and an analysis of the code styles already in use:
- No whitespace on the inside of parentheses.
- No Yoda conditions.
A more detailed overview of the decisions that went into the final code style rules can be found at [#434][gh-434].
(props [@jrfnl][gh-jrfnl], [@KasperFranz][gh-KasperFranz], [@ozh][gh-ozh], [@schlessera][gh-schlessera], [@TysonAndre][gh-TysonAndre], #263, #296, #328, [#358][gh-358], [#359][gh-359], [#360][gh-360], [#361][gh-361], [#362][gh-362], [#363][gh-363], [#364][gh-364], [#386][gh-386], [#396][gh-396], [#399][gh-399], [#400][gh-400], [#401][gh-401], [#402][gh-402], [#403][gh-403], [#404][gh-404], [#405][gh-405], [#406][gh-406], [#408][gh-408], [#409][gh-409], [#410][gh-410], [#411][gh-411], [#413][gh-413], [#415][gh-415], [#416][gh-416], [#417][gh-417], [#423][gh-423], [#424][gh-424], [#434][gh-434])
-
Replace Travis CI with GitHub Actions (partial)
The entire CI setup is gradually being moved from Travis CI to GitHub Actions.
At this point, GitHub Actions takes over the CI from PHP 5.5 onwards, leaving Travis CI as a fallback for lower PHP versions.
This move will be completed after the planned minimum version bump to PHP 5.6+ with the next release, at which point we will get rid of all the remaining Travis CI integrations.
(props [@dd32][gh-dd32], [@desrosj][gh-desrosj], [@jrfnl][gh-jrfnl], [@ntwb][gh-ntwb], [@ozh][gh-ozh], [@schlessera][gh-schlessera], [@TimothyBJacobs][gh-TimothyBJacobs], [@TysonAndre][gh-TysonAndre], #280, #298, #302, #303, #352, #353, #354, [#356][gh-356], [#388][gh-388], [#397][gh-397], [#428][gh-428], [#436][gh-436], [#439][gh-439], [#461][gh-461], [#467][gh-467])
-
Update and improve documentation
- Use clearer and more inclusive language.
- Update the GitHub Pages site.
- Update content and various tweaks to the markdown.
- Fix code blocks in
README.mdfile. - Add pagination to documentation pages.
(props [@desrosj][gh-desrosj], [@jrfnl][gh-jrfnl], [@JustinyAhin][gh-JustinyAhin], [@tnorthcutt][gh-tnorthcutt], #334, [#367][gh-367], [#387][gh-387], [#443][gh-443], [#462][gh-462], [#465][gh-465], [#468][gh-468], [#471][gh-471] )
...
Version 1.7
-
Add support for HHVM and PHP 7
Requests is now tested against both HHVM and PHP 7, and they are supported as
first-party platforms. -
Transfer & connect timeouts, in seconds & milliseconds
cURL is unable to handle timeouts under a second in DNS lookups, so we round
those up to ensure 1-999ms isn't counted as an instant failure. -
Rework cookie handling to be more thorough.
Cookies are now restricted to the same-origin by default, expiration is checked.
(props @catharsisjelly, @rmccue, #120, #124, #130, #132, #156)
-
Improve testing
Tests are now run locally to speed them up, as well as further general
improvements to the quality of the testing suite. There are now also
comprehensive proxy tests to ensure coverage there.(props @rmccue, #75, #107, #170, #177, #181, #183, #185, #196, #202, #203)
-
Support custom HTTP methods
Previously, custom HTTP methods were only supported on sockets; they are now
supported across all transports. -
Add byte limit option
-
Support a Requests_Proxy_HTTP() instance for the proxy setting.
-
Add progress hook
-
Add a before_redirect hook to alter redirects
-
Pass cURL info to after_request
Version 1.6.1
- Fix compatibility with HHVM - Using HHVM with Requests would
previously cause either exceptions with SSL or segfaults with the cURL
handler. Props Ozh for his work here.
Version 1.6
- Add multiple request support - Send multiple HTTP requests with both
fsockopen and cURL, transparently falling back to synchronous when
not supported. - Add proxy support - HTTP proxies are now natively supported via a
high-level API. Major props to Ozh for his fantastic work
on this. - Verify host name for SSL requests - Requests is now the first and only
standalone HTTP library to fully verify SSL hostnames even with socket
connections. Thanks to Michael Adams, Dion Hulse, Jon Cave, and Pádraic Brady
for reviewing the crucial code behind this. - Add cookie support - Adds built-in support for cookies (built entirely
as a high-level API) - Add sessions - To compliment cookies, sessions
can be created with a base URL and default options, plus a shared cookie jar. - Add PUT, DELETE, and PATCH request support
- Add Composer support - You can now install Requests via the
rmccue/requestspackage on Composer
Version v1.5.0
Release 1.5.0, our initial version!