Show curl option name in error message

[Sjord]

Retrieve the option name by using curl_easy_option_by_id or by walking zend_constants, depending on whether the curl version used has curl_easy_option_by_id.

Showing the option name is especially useful when using curl_setopt_array. A user may specify many options, and this change makes it clear which option is wrong exactly.

Related to #10097, #22705.

[Sjord]

@GrahamCampbell What do you think about this fallback in case curl_easy_option_by_id is not available?

[Sjord]

php_curl_option_get_name currently does not work correctly for values that have multiple names:

• CURLOPT_FTP_RESPONSE_TIMEOUT = CURLOPT_SERVER_RESPONSE_TIMEOUT
• CURLOPT_ENCODING = CURLOPT_ACCEPT_ENCODING
• CURLOPT_MAIL_RCPT_ALLLOWFAILS = CURLOPT_MAIL_RCPT_ALLOWFAILS

I think this is currently OK and can probably be fixed in the future.

I am also wondering if it makes sense to loop through zend_constants as a fallback when curl_easy_option_by_id returns null, but I can't think of a situation where that would result in anything.

[GrahamCampbell]

I think there’s a concrete case for the second fallback you mentioned. libcurl can be built with --disable-get-easy-options, where curl_easy_option_by_id() is still exported but always returns NULL. These errors would then say CURLOPT_UNKNOWN_OPTION, even though PHP’s constant table has the name.

Should the Zend scan run whenever the libcurl lookup returns NULL?

#if LIBCURL_VERSION_NUM >= 0x074900
	const struct curl_easyoption *opt = curl_easy_option_by_id(option);
	if (EXPECTED(opt != NULL)) {
		return opt->name;
	}
#endif

/* existing Zend constant scan */

[GrahamCampbell]

Should this get a short Curl entry in NEWS? It changes user-visible validation messages, and the recent error-message clean-ups in other extensions have been recorded there. Perhaps:

- Curl:
  . Improved cURL option validation errors to include the option name.
    (Sjoerd Langkemper)

[GrahamCampbell]

We change the CURLOPT_WRITEHEADER and CURLOPT_STDERR messages separately too, but this test only reaches CURLOPT_FILE. Should it loop over all three using the same read-only stream, so each option name is pinned?

foreach ([
    CURLOPT_FILE,
    CURLOPT_WRITEHEADER,
    CURLOPT_STDERR,
] as $option) {
    try {
        curl_setopt($ch, $option, $fp);
    } catch (ValueError $exception) {
        echo $exception->getMessage(), "\n";
    }
}