- persistent handles for curl_share and curl_multi
[m6w6/ext-http] / http_request_datashare_api.c
1 /*
2 +--------------------------------------------------------------------+
3 | PECL :: http |
4 +--------------------------------------------------------------------+
5 | Redistribution and use in source and binary forms, with or without |
6 | modification, are permitted provided that the conditions mentioned |
7 | in the accompanying LICENSE file are met. |
8 +--------------------------------------------------------------------+
9 | Copyright (c) 2004-2006, Michael Wallner <mike@php.net> |
10 +--------------------------------------------------------------------+
11 */
12
13 /* $Id$ */
14
15 #define HTTP_WANT_CURL
16 #include "php_http.h"
17
18 #if defined(ZEND_ENGINE_2) && defined(HTTP_HAVE_CURL)
19
20 #include "php_http_api.h"
21 #include "php_http_request_datashare_api.h"
22 #include "php_http_request_api.h"
23 #include "php_http_request_object.h"
24 #ifdef HTTP_HAVE_PERSISTENT_HANDLES
25 # include "php_http_persistent_handle_api.h"
26 #endif
27
28 #ifndef HAVE_CURL_SHARE_STRERROR
29 # define curl_share_strerror(dummy) "unknown error"
30 #endif
31 #ifndef HAVE_CURL_EASY_STRERROR
32 # define curl_easy_strerror(dummy) "unknown error"
33 #endif
34
35 #ifdef HTTP_HAVE_PERSISTENT_HANDLES
36 # define HTTP_CURL_SHARE_CTOR(ch) (SUCCESS == http_persistent_handle_acquire("http_request_datashare", &(ch)))
37 # define HTTP_CURL_SHARE_DTOR(chp) http_persistent_handle_release("http_request_datashare", (chp))
38 #else
39 # define HTTP_CURL_SHARE_CTOR(ch) ((ch) = curl_share_init())
40 # define HTTP_CURL_SHARE_DTOR(chp) curl_share_cleanup(*(chp)); *(chp) = NULL
41 #endif
42
43 static HashTable http_request_datashare_options;
44 static http_request_datashare http_request_datashare_global;
45 static int http_request_datashare_compare_handles(void *h1, void *h2);
46 static void http_request_datashare_destroy_handles(void *el);
47 #ifdef ZTS
48 static void http_request_datashare_lock_func(CURL *handle, curl_lock_data data, curl_lock_access locktype, void *userptr);
49 static void http_request_datashare_unlock_func(CURL *handle, curl_lock_data data, void *userptr);
50 #endif
51
52 http_request_datashare *_http_request_datashare_global_get(void)
53 {
54 return &http_request_datashare_global;
55 }
56
57 PHP_MINIT_FUNCTION(http_request_datashare)
58 {
59 curl_lock_data val;
60
61 #ifdef HTTP_HAVE_PERSISTENT_HANDLES
62 if (SUCCESS != http_persistent_handle_provide("http_request_datashare", curl_share_init, (http_persistent_handle_dtor) curl_share_cleanup)) {
63 return FAILURE;
64 }
65 #endif
66
67 if (!http_request_datashare_init_ex(&http_request_datashare_global, 1)) {
68 return FAILURE;
69 }
70
71 zend_hash_init(&http_request_datashare_options, 4, NULL, NULL, 1);
72 #define ADD_DATASHARE_OPT(name, opt) \
73 val = opt; \
74 zend_hash_add(&http_request_datashare_options, name, sizeof(name), &val, sizeof(curl_lock_data), NULL)
75 ADD_DATASHARE_OPT("cookie", CURL_LOCK_DATA_COOKIE);
76 ADD_DATASHARE_OPT("dns", CURL_LOCK_DATA_DNS);
77 ADD_DATASHARE_OPT("ssl", CURL_LOCK_DATA_SSL_SESSION);
78 ADD_DATASHARE_OPT("connect", CURL_LOCK_DATA_CONNECT);
79
80 return SUCCESS;
81 }
82
83 PHP_MSHUTDOWN_FUNCTION(http_request_datashare)
84 {
85 http_request_datashare_dtor(&http_request_datashare_global);
86 zend_hash_destroy(&http_request_datashare_options);
87
88 return SUCCESS;
89 }
90
91 PHP_RINIT_FUNCTION(http_request_datashare)
92 {
93 zend_llist_init(&HTTP_G->request.datashare.handles, sizeof(zval *), http_request_datashare_destroy_handles, 0);
94
95 return SUCCESS;
96 }
97
98 PHP_RSHUTDOWN_FUNCTION(http_request_datashare)
99 {
100 zend_llist_destroy(&HTTP_G->request.datashare.handles);
101
102 return SUCCESS;
103 }
104
105 PHP_HTTP_API http_request_datashare *_http_request_datashare_init_ex(http_request_datashare *share, zend_bool persistent TSRMLS_DC)
106 {
107 zend_bool free_share;
108
109 if ((free_share = !share)) {
110 share = pemalloc(sizeof(http_request_datashare), persistent);
111 }
112 memset(share, 0, sizeof(http_request_datashare));
113
114 if (!HTTP_CURL_SHARE_CTOR(share->ch)) {
115 if (free_share) {
116 pefree(share, persistent);
117 }
118 return NULL;
119 }
120
121 if (!(share->persistent = persistent)) {
122 share->handles = emalloc(sizeof(zend_llist));
123 zend_llist_init(share->handles, sizeof(zval *), ZVAL_PTR_DTOR, 0);
124 #ifdef ZTS
125 } else {
126 int i;
127
128 share->locks = pecalloc(CURL_LOCK_DATA_LAST, sizeof(http_request_datashare_lock), 1);
129 for (i = 0; i < CURL_LOCK_DATA_LAST; ++i) {
130 share->locks[i].mx = tsrm_mutex_alloc();
131 }
132 curl_share_setopt(share->ch, CURLSHOPT_LOCKFUNC, http_request_datashare_lock_func);
133 curl_share_setopt(share->ch, CURLSHOPT_UNLOCKFUNC, http_request_datashare_unlock_func);
134 curl_share_setopt(share->ch, CURLSHOPT_USERDATA, share);
135 #endif
136 }
137
138 return share;
139 }
140
141 PHP_HTTP_API STATUS _http_request_datashare_attach(http_request_datashare *share, zval *request TSRMLS_DC)
142 {
143 CURLcode rc;
144 getObjectEx(http_request_object, obj, request);
145
146 if (obj->share) {
147 if (obj->share == share) {
148 return SUCCESS;
149 } else if (SUCCESS != http_request_datashare_detach(obj->share, request)) {
150 return FAILURE;
151 }
152 }
153
154 HTTP_CHECK_CURL_INIT(obj->request->ch, http_curl_init_ex(obj->request->ch, obj->request), return FAILURE);
155 if (CURLE_OK != (rc = curl_easy_setopt(obj->request->ch, CURLOPT_SHARE, share->ch))) {
156 http_error_ex(HE_WARNING, HTTP_E_REQUEST, "Could not attach HttpRequest object(#%d) to the HttpRequestDataShare: %s", Z_OBJ_HANDLE_P(request), curl_easy_strerror(rc));
157 return FAILURE;
158 }
159
160 obj->share = share;
161 ZVAL_ADDREF(request);
162 zend_llist_add_element(HTTP_RSHARE_HANDLES(share), (void *) &request);
163
164 return SUCCESS;
165 }
166
167 PHP_HTTP_API STATUS _http_request_datashare_detach(http_request_datashare *share, zval *request TSRMLS_DC)
168 {
169 CURLcode rc;
170 getObjectEx(http_request_object, obj, request);
171
172 if (!obj->share) {
173 http_error_ex(HE_WARNING, HTTP_E_REQUEST, "HttpRequest object(#%d) is not attached to any HttpRequestDataShare", Z_OBJ_HANDLE_P(request));
174 } else if (obj->share != share) {
175 http_error_ex(HE_WARNING, HTTP_E_REQUEST, "HttpRequest object(#%d) is not attached to this HttpRequestDataShare", Z_OBJ_HANDLE_P(request));
176 } else if (CURLE_OK != (rc = curl_easy_setopt(obj->request->ch, CURLOPT_SHARE, NULL))) {
177 http_error_ex(HE_WARNING, HTTP_E_REQUEST, "Could not detach HttpRequest object(#%d) from the HttpRequestDataShare: %s", Z_OBJ_HANDLE_P(request), curl_share_strerror(rc));
178 } else {
179 obj->share = NULL;
180 zend_llist_del_element(HTTP_RSHARE_HANDLES(share), request, http_request_datashare_compare_handles);
181 return SUCCESS;
182 }
183 return FAILURE;
184 }
185
186 PHP_HTTP_API void _http_request_datashare_detach_all(http_request_datashare *share TSRMLS_DC)
187 {
188 zval **r;
189
190 while ((r = zend_llist_get_first(HTTP_RSHARE_HANDLES(share)))) {
191 http_request_datashare_detach(share, *r);
192 }
193 }
194
195 PHP_HTTP_API void _http_request_datashare_dtor(http_request_datashare *share TSRMLS_DC)
196 {
197 if (!share->persistent) {
198 zend_llist_destroy(share->handles);
199 efree(share->handles);
200 }
201 HTTP_CURL_SHARE_DTOR(&share->ch);
202 #ifdef ZTS
203 if (share->persistent) {
204 int i;
205
206 for (i = 0; i < CURL_LOCK_DATA_LAST; ++i) {
207 tsrm_mutex_free(share->locks[i].mx);
208 }
209 pefree(share->locks, 1);
210 }
211 #endif
212 }
213
214 PHP_HTTP_API void _http_request_datashare_free(http_request_datashare **share TSRMLS_DC)
215 {
216 http_request_datashare_dtor(*share);
217 pefree(*share, (*share)->persistent);
218 *share = NULL;
219 }
220
221 PHP_HTTP_API STATUS _http_request_datashare_set(http_request_datashare *share, const char *option, size_t option_len, zend_bool enable TSRMLS_DC)
222 {
223 curl_lock_data *opt;
224 CURLSHcode rc;
225
226 if (SUCCESS == zend_hash_find(&http_request_datashare_options, (char *) option, option_len + 1, (void *) &opt)) {
227 if (CURLSHE_OK == (rc = curl_share_setopt(share->ch, enable ? CURLSHOPT_SHARE : CURLSHOPT_UNSHARE, *opt))) {
228 return SUCCESS;
229 }
230 http_error_ex(HE_WARNING, HTTP_E_REQUEST, "Could not %s sharing of %s data: %s", enable ? "enable" : "disable", option, curl_share_strerror(rc));
231 }
232 return FAILURE;
233 }
234
235 static int http_request_datashare_compare_handles(void *h1, void *h2)
236 {
237 return (Z_OBJ_HANDLE_PP((zval **) h1) == Z_OBJ_HANDLE_P((zval *) h2));
238 }
239
240 static void http_request_datashare_destroy_handles(void *el)
241 {
242 zval **r = (zval **) el;
243 TSRMLS_FETCH();
244
245 { /* gcc 2.95 needs these braces */
246 getObjectEx(http_request_object, obj, *r);
247
248 curl_easy_setopt(obj->request->ch, CURLOPT_SHARE, NULL);
249 zval_ptr_dtor(r);
250 }
251 }
252
253 #ifdef ZTS
254 static void http_request_datashare_lock_func(CURL *handle, curl_lock_data data, curl_lock_access locktype, void *userptr)
255 {
256 http_request_datashare *share = (http_request_datashare *) userptr;
257
258 /* TSRM can't distinguish shared/exclusive locks */
259 tsrm_mutex_lock(share->locks[data].mx);
260 share->locks[data].ch = handle;
261 }
262
263 static void http_request_datashare_unlock_func(CURL *handle, curl_lock_data data, void *userptr)
264 {
265 http_request_datashare *share = (http_request_datashare *) userptr;
266
267 if (share->locks[data].ch == handle) {
268 tsrm_mutex_unlock(share->locks[data].mx);
269 }
270 }
271 #endif
272
273 #endif /* ZEND_ENGINE_2 && HTTP_HAVE_CURL */
274
275
276 /*
277 * Local variables:
278 * tab-width: 4
279 * c-basic-offset: 4
280 * End:
281 * vim600: noet sw=4 ts=4 fdm=marker
282 * vim<600: noet sw=4 ts=4
283 */
284