Add missing options for curl_setopt() function

[mt-omarov]

Update KPHP curl_setopt() function

This PR extends the options of the curl_setopt() function:

• primitive options of the curl_setopt() function up to the current version of php
• support for non-standard CURLOPT_*FUNCTIONs options, as well as stream descriptor options

Requirements

libcurl version 8.4.0

Support for callable options

PHP supports wrappers for custom functions for parameters: CURLOPT_WRITEFUNCTION, CURLOPT_HEADERFUNCTION, CURLOPT_READFUNCTION, CURLOPT_PROGRESSFUNCTION, CURLOPT_XFERINFOFUNCTION.

Problem

To be able to pass callable objects to runtime and not override the logic of accepting mixed arguments, the curl_setopt() function must be overloaded.
However, overloading with a callable argument is not so simple: compiler optimizations prevent lambda expressions from being called from the runtime. The generated lambda expression code contains only the functionality that is explicitly called in the php code. Lambda expressions passed to curl_setopt() are called inside the runtime, so the compiler simply does not create methods to call the generated lambda objects => it will not be possible to call them in the runtime.

Solution

The key change for the overload operation is the rearrangement of the optimization step EarlyOptimizationF in compiler.cpp.

Next, to redirect the function call, use:

• Definition of new functions in kphp_internal.txt
• Rules for redirecting functions in early_opt.rules
• The logic of calling functions in curl.h and curl.cpp.

Logic

The lambda expressions that the user passes to curl_setopt() are stored in an object of the EasyContext class. Wrapper functions are defined in the runtime for each of the CURLOPT_*FUNCTIONs options:

• curl_write
• curl_write_header
• curl_progress
• curl_read
• curl_xferinfo

Support for stream options

Added support for options: CURLOPT_FILE, CURLOPT_INFILE, CURLOPT_WRITEHEADER.
These options redirect the output of information in the CURLOPT_*FUNCTIONs to the installed stream descriptors.
It was necessary to add:

• a field in the structure of each handler of a callable object for storing the stream descriptor and the mode of operation of the curl function;
• a function for setting stream object to the handler.

Support for missing primitive options

• added bitmasks for CURLOPT_PROTOCOLS;
• added bitmasks for CURLOPT_SSH_AUTH_TYPES;
• added bitmasks for CURLAUTH options;
• added bitmasks for SSL options:
  unsupported flags are not allowed to be transmitted: CURLSSLOPT_NO_REVOKE, CURLSSLOPT_REVOKE_BEST_EFFORT, CURLSSLOPT_AUTO_CLIENT_CERT

The full list of added options is located in the curl-options.md

Tests

• Updated tests in 2_curl_setopt.php:
  removed tests with bad options., the new version of libcurl throws an error instead of a warning.

• Added simple tests for missing options, which should work on both libcurl version 7.60.0 and the new version: 13_curl_setopt_new.php.

• Added simple tests for stream options: 14_curl_setopt_streams.php.

• Added simple tests for options with additional dependencies: 15_curl_setopt_problems.php.

• Added simple tests that require a new version of libcurl: 16_curl_setopt_only_new_curl.php.

• Added simple tests for callable options: 17_curl_setopt_callables.php.

• Added auxiliary tests with raising the local server to check the stream and callable options: the tests are located on an additional branch of the pull request (14_curl_setopt_streams-server.php, 17_curl_setopt_callables-server.php).

[astrophysik]

Is this pr ready for review?

[mt-omarov]

Is this pr ready for review?

not yet

[Danil42Russia]

Is this pr ready for review?

not yet

Convert it to Draft please

[mt-omarov]

The logic of overloading a function depending on the value of an option

This construction allows the compiler to redirect the call to the curl_setopt function to the specified one if the value of the option parameter is 21000.

Syntax:

• (op_func_call {"<name of the original function>"} first_arg_name second_arg_name:(op_int_const {"<value>"}) third_arg_name)
• (op_func_call {"<name of the new function>"} args)

The construction above redirects the function call <name of the original function> to <name of the new function> if the parameter <second_arg_name> is equal to the value <value>

[mt-omarov]

Logic for storing user-defined functions for callable options of curl_setopt()

In the EasyContext class was added fields, which store callable objects and additional information about the mode of operation of functions that are passed to libcurl.

Arguments information:

• callable: a field for user-defined function
• method: defines the mode of operation of the final function
• stream: pointer to the stream descriptor (if any)

Methods:

• KPHP_CURL_STDOUT: the standard output of information for curl_write() and curl_write_header();
• KPHP_CURL_RETURN: a special mode of operation for curl_write(), in which information is returned from the function;
• KPHP_CURL_USER: the mode of operation in which a user-defined function is called (from callable field)
• KPHP_CURL_IGNORE: a special mode of operation for curl_write_header(), in which a length of the information is returned from the function;
• KPHP_CURL_DIRECT: the standard output of information for curl_read();
• KPHP_CURL_FILE: the mode of operation for curl_write() and curl_write_header() for writing information to a stream descriptor from the stream field

[mt-omarov]

The process of installing the user's callable objects when calling curl_setopt()

After successful redirection by the compiler of the curl_setopt() function to the function from kphp_internal.txt the callable object is saved to the appropriate handler. In this case, the mode of operation of the corresponding curl function (method field) is set to the value KPHP_CURL_USER.