xref: /php-src/ext/curl/curl_private.h (revision edb9f65f)
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 	zval                  func_name;
49 	zend_fcall_info_cache fci_cache;
50 	FILE                 *fp;
51 	smart_str             buf;
52 	int                   method;
53 	zval					stream;
54 } php_curl_write;
55 
56 typedef struct {
57 	zval                  func_name;
58 	zend_fcall_info_cache fci_cache;
59 	FILE                 *fp;
60 	zend_resource        *res;
61 	int                   method;
62 	zval                  stream;
63 } php_curl_read;
64 
65 typedef struct {
66 	zval                  func_name;
67 	zend_fcall_info_cache fci_cache;
68 } php_curl_callback;
69 
70 typedef struct {
71 	php_curl_write    *write;
72 	php_curl_write    *write_header;
73 	php_curl_read     *read;
74 	zval               std_err;
75 	php_curl_callback *progress;
76 	php_curl_callback  *xferinfo;
77 	php_curl_callback  *fnmatch;
78 #if LIBCURL_VERSION_NUM >= 0x075400 /* Available since 7.84.0 */
79 	php_curl_callback  *sshhostkey;
80 #endif
81 } php_curl_handlers;
82 
83 struct _php_curl_error  {
84 	char str[CURL_ERROR_SIZE + 1];
85 	int  no;
86 };
87 
88 struct _php_curl_send_headers {
89 	zend_string *str;
90 };
91 
92 struct _php_curl_free {
93 	zend_llist post;
94 	zend_llist stream;
95 	HashTable *slist;
96 };
97 
98 typedef struct {
99 	CURL                         *cp;
100 	php_curl_handlers             handlers;
101 	struct _php_curl_free        *to_free;
102 	struct _php_curl_send_headers header;
103 	struct _php_curl_error        err;
104 	bool                     in_callback;
105 	uint32_t*                     clone;
106 	zval                          postfields;
107 	/* For CURLOPT_PRIVATE */
108 	zval private_data;
109 	/* CurlShareHandle object set using CURLOPT_SHARE. */
110 	struct _php_curlsh *share;
111 	zend_object                   std;
112 } php_curl;
113 
114 #define CURLOPT_SAFE_UPLOAD -1
115 
116 typedef struct {
117 	php_curl_callback	*server_push;
118 } php_curlm_handlers;
119 
120 typedef struct {
121 	CURLM      *multi;
122 	zend_llist  easyh;
123 	php_curlm_handlers handlers;
124 	struct {
125 		int no;
126 	} err;
127 	zend_object std;
128 } php_curlm;
129 
130 typedef struct _php_curlsh {
131 	CURLSH                   *share;
132 	struct {
133 		int no;
134 	} err;
135 	zend_object std;
136 } php_curlsh;
137 
138 php_curl *init_curl_handle_into_zval(zval *curl);
139 void init_curl_handle(php_curl *ch);
140 void _php_curl_cleanup_handle(php_curl *);
141 void _php_curl_multi_cleanup_list(void *data);
142 void _php_curl_verify_handlers(php_curl *ch, bool reporterror);
143 void _php_setup_easy_copy_handlers(php_curl *ch, php_curl *source);
144 
curl_from_obj(zend_object * obj)145 static inline php_curl *curl_from_obj(zend_object *obj) {
146 	return (php_curl *)((char *)(obj) - XtOffsetOf(php_curl, std));
147 }
148 
149 #define Z_CURL_P(zv) curl_from_obj(Z_OBJ_P(zv))
150 
curl_share_from_obj(zend_object * obj)151 static inline php_curlsh *curl_share_from_obj(zend_object *obj) {
152 	return (php_curlsh *)((char *)(obj) - XtOffsetOf(php_curlsh, std));
153 }
154 
155 #define Z_CURL_SHARE_P(zv) curl_share_from_obj(Z_OBJ_P(zv))
156 
157 void curl_multi_register_handlers(void);
158 void curl_share_register_handlers(void);
159 void curlfile_register_class(void);
160 zend_result curl_cast_object(zend_object *obj, zval *result, int type);
161 
162 #endif  /* _PHP_CURL_PRIVATE_H */
163