xref: /php-src/ext/curl/curl_private.h (revision ba748e7b)
1 /*
2    +----------------------------------------------------------------------+
3    | Copyright (c) The PHP Group                                          |
4    +----------------------------------------------------------------------+
5    | This source file is subject to version 3.01 of the PHP license,      |
6    | that is bundled with this package in the file LICENSE, and is        |
7    | available through the world-wide-web at the following url:           |
8    | https://www.php.net/license/3_01.txt                                 |
9    | If you did not receive a copy of the PHP license and are unable to   |
10    | obtain it through the world-wide-web, please send a note to          |
11    | license@php.net so we can mail you a copy immediately.               |
12    +----------------------------------------------------------------------+
13    | Author: Sterling Hughes <sterling@php.net>                           |
14    |         Wez Furlong <wez@thebrainroom.com>                           |
15    +----------------------------------------------------------------------+
16 */
17 
18 #ifndef _PHP_CURL_PRIVATE_H
19 #define _PHP_CURL_PRIVATE_H
20 
21 #include "php_curl.h"
22 
23 #define PHP_CURL_DEBUG 0
24 
25 #include "php_version.h"
26 #define PHP_CURL_VERSION PHP_VERSION
27 
28 #include <curl/curl.h>
29 #include <curl/multi.h>
30 
31 #define CURLOPT_RETURNTRANSFER 19913
32 #define CURLOPT_BINARYTRANSFER 19914 /* For Backward compatibility */
33 #define PHP_CURL_STDOUT 0
34 #define PHP_CURL_FILE   1
35 #define PHP_CURL_USER   2
36 #define PHP_CURL_DIRECT 3
37 #define PHP_CURL_RETURN 4
38 #define PHP_CURL_IGNORE 7
39 
40 #define SAVE_CURL_ERROR(__handle, __err) \
41     do { (__handle)->err.no = (int) __err; } while (0)
42 
43 PHP_MINIT_FUNCTION(curl);
44 PHP_MSHUTDOWN_FUNCTION(curl);
45 PHP_MINFO_FUNCTION(curl);
46 
47 typedef struct {
48 	zend_fcall_info_cache fcc;
49 	FILE                 *fp;
50 	smart_str             buf;
51 	int                   method;
52 	zval					stream;
53 } php_curl_write;
54 
55 typedef struct {
56 	zend_fcall_info_cache fcc;
57 	FILE                 *fp;
58 	zend_resource        *res;
59 	int                   method;
60 	zval                  stream;
61 } php_curl_read;
62 
63 typedef struct {
64 	php_curl_write    *write;
65 	php_curl_write    *write_header;
66 	php_curl_read     *read;
67 	zval               std_err;
68 	zend_fcall_info_cache progress;
69 	zend_fcall_info_cache xferinfo;
70 	zend_fcall_info_cache fnmatch;
71 	zend_fcall_info_cache debug;
72 #if LIBCURL_VERSION_NUM >= 0x075000 /* Available since 7.80.0 */
73 	zend_fcall_info_cache prereq;
74 #endif
75 #if LIBCURL_VERSION_NUM >= 0x075400 /* Available since 7.84.0 */
76 	zend_fcall_info_cache sshhostkey;
77 #endif
78 } php_curl_handlers;
79 
80 struct _php_curl_error  {
81 	char str[CURL_ERROR_SIZE + 1];
82 	int  no;
83 };
84 
85 struct _php_curl_send_headers {
86 	zend_string *str;
87 };
88 
89 struct _php_curl_free {
90 	zend_llist post;
91 	zend_llist stream;
92 	HashTable *slist;
93 };
94 
95 typedef struct {
96 	CURL                         *cp;
97 	php_curl_handlers             handlers;
98 	struct _php_curl_free        *to_free;
99 	struct _php_curl_send_headers header;
100 	struct _php_curl_error        err;
101 	bool                     in_callback;
102 	uint32_t*                     clone;
103 	zval                          postfields;
104 	/* For CURLOPT_PRIVATE */
105 	zval private_data;
106 	/* CurlShareHandle object set using CURLOPT_SHARE. */
107 	struct _php_curlsh *share;
108 	zend_object                   std;
109 } php_curl;
110 
111 #define CURLOPT_SAFE_UPLOAD -1
112 
113 typedef struct {
114 	zend_fcall_info_cache server_push;
115 } php_curlm_handlers;
116 
117 typedef struct {
118 	CURLM      *multi;
119 	zend_llist  easyh;
120 	php_curlm_handlers handlers;
121 	struct {
122 		int no;
123 	} err;
124 	zend_object std;
125 } php_curlm;
126 
127 typedef struct _php_curlsh {
128 	CURLSH                   *share;
129 	struct {
130 		int no;
131 	} err;
132 	zend_object std;
133 } php_curlsh;
134 
135 php_curl *init_curl_handle_into_zval(zval *curl);
136 void init_curl_handle(php_curl *ch);
137 void _php_curl_cleanup_handle(php_curl *);
138 void _php_curl_multi_cleanup_list(void *data);
139 void _php_curl_verify_handlers(php_curl *ch, bool reporterror);
140 void _php_setup_easy_copy_handlers(php_curl *ch, php_curl *source);
141 
curl_from_obj(zend_object * obj)142 static inline php_curl *curl_from_obj(zend_object *obj) {
143 	return (php_curl *)((char *)(obj) - XtOffsetOf(php_curl, std));
144 }
145 
146 #define Z_CURL_P(zv) curl_from_obj(Z_OBJ_P(zv))
147 
curl_share_from_obj(zend_object * obj)148 static inline php_curlsh *curl_share_from_obj(zend_object *obj) {
149 	return (php_curlsh *)((char *)(obj) - XtOffsetOf(php_curlsh, std));
150 }
151 
152 #define Z_CURL_SHARE_P(zv) curl_share_from_obj(Z_OBJ_P(zv))
153 
154 void curl_multi_register_handlers(void);
155 void curl_share_register_handlers(void);
156 void curlfile_register_class(void);
157 zend_result curl_cast_object(zend_object *obj, zval *result, int type);
158 
159 #endif  /* _PHP_CURL_PRIVATE_H */
160