Skip to content

Commit 386f8eb

Browse files
devnexendevnexen
committed
CURL extension update proposal.
Allowing using CURLOPT_XFERINFOFUNCTION while deprecating CURLOPT_PROGRESSFUNCTION, available since the 7.32 release.
1 parent cdf7240 commit 386f8eb

File tree

4 files changed

+158
-6
lines changed

4 files changed

+158
-6
lines changed

‎ext/curl/curl_private.h

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,9 +73,10 @@ typedef struct {
7373
php_curl_read *read;
7474
zval std_err;
7575
php_curl_callback *progress;
76-
#if LIBCURL_VERSION_NUM >= 0x071500 /* Available since 7.21.0 */
77-
php_curl_callback *fnmatch;
76+
#if LIBCURL_VERSION_NUM >= 0x072000
77+
php_curl_callback *xferinfo;
7878
#endif
79+
php_curl_callback *fnmatch;
7980
} php_curl_handlers;
8081

8182
struct _php_curl_error {

‎ext/curl/interface.c

Lines changed: 101 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -456,6 +456,9 @@ PHP_MINIT_FUNCTION(curl)
456456
REGISTER_CURL_CONSTANT(CURLOPT_VERBOSE);
457457
REGISTER_CURL_CONSTANT(CURLOPT_WRITEFUNCTION);
458458
REGISTER_CURL_CONSTANT(CURLOPT_WRITEHEADER);
459+
#if LIBCURL_VERSION_NUM >= 0x072000
460+
REGISTER_CURL_CONSTANT(CURLOPT_XFERINFOFUNCTION);
461+
#endif
459462

460463
/* */
461464
REGISTER_CURL_CONSTANT(CURLE_ABORTED_BY_CALLBACK);
@@ -1287,11 +1290,15 @@ static HashTable *curl_get_gc(zend_object *object, zval **table, int *n)
12871290
zend_get_gc_buffer_add_zval(gc_buffer, &curl->handlers.progress->func_name);
12881291
}
12891292

1290-
#if LIBCURL_VERSION_NUM >= 0x071500
1293+
#if LIBCURL_VERSION_NUM >= 0x072000
1294+
if (curl->handlers.xferinfo) {
1295+
zend_get_gc_buffer_add_zval(gc_buffer, &curl->handlers.xferinfo->func_name);
1296+
}
1297+
#endif
1298+
12911299
if (curl->handlers.fnmatch) {
12921300
zend_get_gc_buffer_add_zval(gc_buffer, &curl->handlers.fnmatch->func_name);
12931301
}
1294-
#endif
12951302

12961303
zend_get_gc_buffer_add_zval(gc_buffer, &curl->handlers.std_err);
12971304
zend_get_gc_buffer_add_zval(gc_buffer, &curl->private_data);
@@ -1496,6 +1503,56 @@ static size_t curl_progress(void *clientp, double dltotal, double dlnow, double
14961503
}
14971504
/* }}} */
14981505

1506+
#if LIBCURL_VERSION_NUM >= 0x072000
1507+
/* {{{ curl_xferinfo */
1508+
static size_t curl_xferinfo(void *clientp, curl_off_t dltotal, curl_off_t dlnow, curl_off_t ultotal, curl_off_t ulnow)
1509+
{
1510+
php_curl *ch = (php_curl *)clientp;
1511+
php_curl_callback *t = ch->handlers.xferinfo;
1512+
size_t rval = 0;
1513+
1514+
#if PHP_CURL_DEBUG
1515+
fprintf(stderr, "curl_xferinfo() called\n");
1516+
fprintf(stderr, "clientp = %x, dltotal = %ld, dlnow = %ld, ultotal = %ld, ulnow = %ld\n", clientp, dltotal, dlnow, ultotal, ulnow);
1517+
#endif
1518+
1519+
zval argv[5];
1520+
zval retval;
1521+
zend_result error;
1522+
zend_fcall_info fci;
1523+
1524+
GC_ADDREF(&ch->std);
1525+
ZVAL_OBJ(&argv[0], &ch->std);
1526+
ZVAL_LONG(&argv[1], dltotal);
1527+
ZVAL_LONG(&argv[2], dlnow);
1528+
ZVAL_LONG(&argv[3], ultotal);
1529+
ZVAL_LONG(&argv[4], ulnow);
1530+
1531+
fci.size = sizeof(fci);
1532+
ZVAL_COPY_VALUE(&fci.function_name, &t->func_name);
1533+
fci.object = NULL;
1534+
fci.retval = &retval;
1535+
fci.param_count = 5;
1536+
fci.params = argv;
1537+
fci.named_params = NULL;
1538+
1539+
ch->in_callback = 1;
1540+
error = zend_call_function(&fci, &t->fci_cache);
1541+
ch->in_callback = 0;
1542+
if (error == FAILURE) {
1543+
php_error_docref(NULL, E_WARNING, "Cannot call the CURLOPT_XFERINFOFUNCTION");
1544+
} else if (!Z_ISUNDEF(retval)) {
1545+
_php_curl_verify_handlers(ch, /* reporterror */ true);
1546+
if (0 != zval_get_long(&retval)) {
1547+
rval = 1;
1548+
}
1549+
}
1550+
zval_ptr_dtor(&argv[0]);
1551+
return rval;
1552+
}
1553+
/* }}} */
1554+
#endif
1555+
14991556
/* {{{ curl_read */
15001557
static size_t curl_read(char *data, size_t size, size_t nmemb, void *ctx)
15011558
{
@@ -1753,6 +1810,9 @@ void init_curl_handle(php_curl *ch)
17531810
ch->handlers.write_header = ecalloc(1, sizeof(php_curl_write));
17541811
ch->handlers.read = ecalloc(1, sizeof(php_curl_read));
17551812
ch->handlers.progress = NULL;
1813+
#if LIBCURL_VERSION_NUM >= 0x072000
1814+
ch->handlers.xferinfo = NULL;
1815+
#endif
17561816
ch->handlers.fnmatch = NULL;
17571817
ch->clone = emalloc(sizeof(uint32_t));
17581818
*ch->clone = 1;
@@ -1925,6 +1985,16 @@ void _php_setup_easy_copy_handlers(php_curl *ch, php_curl *source)
19251985
curl_easy_setopt(ch->cp, CURLOPT_PROGRESSDATA, (void *) ch);
19261986
}
19271987

1988+
#if LIBCURL_VERSION_NUM >= 0x072000
1989+
if (source->handlers.xferinfo) {
1990+
ch->handlers.xferinfo = ecalloc(1, sizeof(php_curl_callback));
1991+
if (!Z_ISUNDEF(source->handlers.xferinfo->func_name)) {
1992+
ZVAL_COPY(&ch->handlers.xferinfo->func_name, &source->handlers.xferinfo->func_name);
1993+
}
1994+
curl_easy_setopt(ch->cp, CURLOPT_XFERINFODATA, (void *) ch);
1995+
}
1996+
#endif
1997+
19281998
if (source->handlers.fnmatch) {
19291999
ch->handlers.fnmatch = ecalloc(1, sizeof(php_curl_callback));
19302000
if (!Z_ISUNDEF(source->handlers.fnmatch->func_name)) {
@@ -2884,6 +2954,20 @@ static zend_result _php_curl_setopt(php_curl *ch, zend_long option, zval *zvalue
28842954
ch->handlers.write->method = PHP_CURL_USER;
28852955
break;
28862956

2957+
#if LIBCURL_VERSION_NUM >= 0x072000
2958+
case CURLOPT_XFERINFOFUNCTION:
2959+
curl_easy_setopt(ch->cp, CURLOPT_XFERINFOFUNCTION, curl_xferinfo);
2960+
curl_easy_setopt(ch->cp, CURLOPT_XFERINFODATA, ch);
2961+
if (ch->handlers.xferinfo == NULL) {
2962+
ch->handlers.xferinfo = ecalloc(1, sizeof(php_curl_callback));
2963+
} else if (!Z_ISUNDEF(ch->handlers.xferinfo->func_name)) {
2964+
zval_ptr_dtor(&ch->handlers.xferinfo->func_name);
2965+
ch->handlers.xferinfo->fci_cache = empty_fcall_info_cache;
2966+
}
2967+
ZVAL_COPY(&ch->handlers.xferinfo->func_name, zvalue);
2968+
break;
2969+
#endif
2970+
28872971
/* Curl off_t options */
28882972
case CURLOPT_MAX_RECV_SPEED_LARGE:
28892973
case CURLOPT_MAX_SEND_SPEED_LARGE:
@@ -3521,6 +3605,13 @@ static void curl_free_obj(zend_object *object)
35213605
efree(ch->handlers.progress);
35223606
}
35233607

3608+
#if LIBCURL_VERSION_NUM >= 0x072000
3609+
if (ch->handlers.xferinfo) {
3610+
zval_ptr_dtor(&ch->handlers.xferinfo->func_name);
3611+
efree(ch->handlers.xferinfo);
3612+
}
3613+
#endif
3614+
35243615
if (ch->handlers.fnmatch) {
35253616
zval_ptr_dtor(&ch->handlers.fnmatch->func_name);
35263617
efree(ch->handlers.fnmatch);
@@ -3593,12 +3684,19 @@ static void _php_curl_reset_handlers(php_curl *ch)
35933684
ch->handlers.progress = NULL;
35943685
}
35953686

3687+
#if LIBCURL_VERSION_NUM >= 0x072000
3688+
if (ch->handlers.xferinfo) {
3689+
zval_ptr_dtor(&ch->handlers.xferinfo->func_name);
3690+
efree(ch->handlers.xferinfo);
3691+
ch->handlers.xferinfo = NULL;
3692+
}
3693+
#endif
3694+
35963695
if (ch->handlers.fnmatch) {
35973696
zval_ptr_dtor(&ch->handlers.fnmatch->func_name);
35983697
efree(ch->handlers.fnmatch);
35993698
ch->handlers.fnmatch = NULL;
36003699
}
3601-
36023700
}
36033701
/* }}} */
36043702

‎ext/curl/sync-constants.php

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@
1515
const MIN_SUPPORTED_CURL_VERSION = '7.29.0';
1616

1717
const IGNORED_CONSTANTS = [
18-
'CURLOPT_PROGRESSDATA'
18+
'CURLOPT_PROGRESSDATA',
19+
'CURLOPT_XFERINFODATA'
1920
];
2021

2122
const CONSTANTS_REGEX_PATTERN = '~^CURL(?:OPT|_VERSION)_[A-Z0-9_]+$~';

‎ext/curl/tests/curl_copy_handle_xferinfo.phpt

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
--TEST--
2+
Test curl_copy_handle() with CURLOPT_XFERINFOFUNCTION
3+
--EXTENSIONS--
4+
curl
5+
--FILE--
6+
<?php
7+
include 'server.inc';
8+
$host = curl_cli_server_start();
9+
10+
$url = "{$host}/get.inc";
11+
$ch = curl_init($url);
12+
13+
curl_setopt($ch, CURLOPT_NOPROGRESS, 0);
14+
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
15+
curl_setopt($ch, CURLOPT_XFERINFOFUNCTION, function() { echo "Download progress!\n"; });
16+
$ch2 = curl_copy_handle($ch);
17+
echo curl_exec($ch), PHP_EOL;
18+
unset($ch);
19+
echo curl_exec($ch2);
20+
21+
?>
22+
--EXPECT--
23+
Download progress!
24+
Download progress!
25+
Download progress!
26+
Download progress!
27+
Download progress!
28+
Download progress!
29+
Download progress!
30+
Download progress!
31+
Download progress!
32+
Download progress!
33+
Download progress!
34+
Download progress!
35+
Download progress!
36+
Hello World!
37+
Hello World!
38+
Download progress!
39+
Download progress!
40+
Download progress!
41+
Download progress!
42+
Download progress!
43+
Download progress!
44+
Download progress!
45+
Download progress!
46+
Download progress!
47+
Download progress!
48+
Download progress!
49+
Download progress!
50+
Download progress!
51+
Hello World!
52+
Hello World!

0 commit comments

Comments
 (0)