Deprecate most obsolete cURL constants #5094
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Over the years, libcurl has obsoleted several constants, and while these are still defined in latest libcurl versions, they might be removed anytime, and libcurl built with `CURL_NO_OLDIES` defined might not define these constants at all. Therefore we deprecate most of these obsolete constants, introduce constants which can be used to replace the deprecated ones (unless these have already been available). To no longer depend on the obsolete constants, we use the values of their replacements where possible, and use hard-coded numbers otherwise. We exempt `CURLOPT_FILE`, `CURLOPT_INFILE` and `CURLOPT_WRITEHEADER` for now, since deprecating these would be a more severe BC break, especially since only `CURLOPT_READDATA` is already available in ext/curl, but not `CURLOPT_WRITEDATA` and `CURLOPT_HEADERDATA`.
nikic
reviewed
Jan 19, 2020
| @@ -511,73 +511,73 @@ PHP_MINIT_FUNCTION(curl) | |||
|
|
|||
| /* */ | |||
| REGISTER_CURL_CONSTANT(CURLE_ABORTED_BY_CALLBACK); | |||
| REGISTER_CURL_CONSTANT(CURLE_BAD_CALLING_ORDER); | |||
| REGISTER_LONG_CONSTANT("CURLE_BAD_CALLING_ORDER", 44, CONST_PERSISTENT | CONST_DEPRECATED); | |||
There was a problem hiding this comment.
Where do these hardcoded values come from?
Assuming that these can never actually be returned by curl (anymore), it might make sense to map them to something that is definitely not going to be used, such as -1 or a large number. These specific constants look fragile.
|
Just bumped into this PR, here are some other constants that can be found in master and have since been deprecated prior to the current minimum curl version of master (7.29.0). I've noted down the replacements I saw in curl docs, I couldn't find anything (not even a docs page) about the ones that do not have a replacement noted. All these replacements seem to be defined in the source, though some are most likely missing from the documentation. Leaving them noted here just in case it might come handy in your effort. |
|
Closing for time reasons for now. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Over the years, libcurl has obsoleted several constants, and while
these are still defined in latest libcurl versions, they might be
removed anytime, and libcurl built with
CURL_NO_OLDIESdefined mightnot define these constants at all. Therefore we deprecate most of
these obsolete constants, introduce constants which can be used to
replace the deprecated ones (unless these have already been available).
To no longer depend on the obsolete constants, we use the values of
their replacements where possible, and use hard-coded numbers
otherwise.
We exempt
CURLOPT_FILE,CURLOPT_INFILEandCURLOPT_WRITEHEADERfor now, since deprecating these would be a more severe BC break,
especially since only
CURLOPT_READDATAis already available inext/curl, but not
CURLOPT_WRITEDATAandCURLOPT_HEADERDATA.TODO:
CURLOPT_DNS_USE_GLOBAL_CACHE(see ext/curl: No-opCURLOPT_DNS_USE_GLOBAL_CACHEconstant #15127)