Class: Curl::Easy

Inherits:
Object
  • Object
show all
Defined in:
ext/easy.c

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args) ⇒ Object 



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'ext/easy.c', line 152

static VALUE rb_curl_easy_initialize(int argc, VALUE *argv, VALUE self) {
  VALUE url;
  rb_curl_easy *rb_ch;

  rb_scan_args(argc, argv, "01", &url);

  Data_Get_Struct(self, rb_curl_easy, rb_ch);

  rb_ch->ch = curl_easy_init();
  if (!rb_ch->ch) {
    rb_raise(rb_eRuntimeError, "Failed to initialize easy handle");
  }

  rb_ch->self = self;

  if (url != Qnil)
    curl_easy_setopt(rb_ch->ch, CURLOPT_URL, StringValueCStr(url));

  return self;
}

Class Method Details

.strerror(errornum) ⇒ Object 



7
8
9
10
11
12
13
 
# File 'ext/easy.c', line 7

static VALUE rb_curl_easy_strerror(VALUE self, VALUE errornum) {
  const char *error_str;

  error_str = curl_easy_strerror(NUM2LONG(errornum));

  return rb_str_new2(error_str);
}

Instance Method Details

#cleanup ⇒ Object 



510
511
512
513
514
515
516
517
 
# File 'ext/easy.c', line 510

static VALUE rb_curl_easy_cleanup(VALUE self) {
  rb_curl_easy *rb_ch;

  Data_Get_Struct(self, rb_curl_easy, rb_ch);
  curl_easy_cleanup(rb_ch->ch);

  return Qnil;
}

#getinfo(info) ⇒ Object 



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'ext/easy.c', line 173

static VALUE rb_curl_easy_getinfo(VALUE self, VALUE info) {
  CURLcode c_err_code;
  rb_curl_easy *rb_ch;
  VALUE info_val = Qnil, ret_val = rb_ary_new();
  long information = NUM2LONG(info);

  char *s_var;
  long l_var;
  double d_var;
  struct curl_slist *curl_list_var = NULL;
  struct curl_certinfo *curl_certinfo_chain = NULL;

  Data_Get_Struct(self, rb_curl_easy, rb_ch);

  switch (information) {
    /* pointer to a char pointer */
#if LIBCURL_VERSION_NUM >= 0x071202 /* Curl::Info constants (Available since 7.18.2) */
    case CURLINFO_REDIRECT_URL:
#endif
#if LIBCURL_VERSION_NUM >= 0x071300 /* Curl::Info constants (Available since 7.19.0) */
    case CURLINFO_PRIMARY_IP:
#endif
    case CURLINFO_CONTENT_TYPE:
#if LIBCURL_VERSION_NUM >= 0x071500 /* Curl::Info constants (Available since 7.21.0) */
    case CURLINFO_LOCAL_IP:
#endif
#if LIBCURL_VERSION_NUM >= 0x073400 /* Curl::Info constants (Available since 7.52.0) */
    case CURLINFO_SCHEME:
#endif
    case CURLINFO_EFFECTIVE_URL:
      c_err_code = curl_easy_getinfo(rb_ch->ch, information, &s_var);
      if (c_err_code == CURLE_OK)
        info_val = rb_str_new2(s_var);
      break;
    /* pointer to a long */
#if LIBCURL_VERSION_NUM >= 0x071500 /* Curl::Info constants (Available since 7.21.0) */
    case CURLINFO_LOCAL_PORT:
    case CURLINFO_PRIMARY_PORT:
#endif
#if LIBCURL_VERSION_NUM >= 0x073200 /* Curl::Info constants (Available since 7.50.0) */
    case CURLINFO_HTTP_VERSION:
#endif
#if LIBCURL_VERSION_NUM >= 0x073400 /* Curl::Info constants (Available since 7.52.0) */
    case CURLINFO_PROTOCOL:
    case CURLINFO_PROXY_SSL_VERIFYRESULT:
#endif
    case CURLINFO_RESPONSE_CODE:
    case CURLINFO_HTTP_CONNECTCODE:
    case CURLINFO_FILETIME:
    case CURLINFO_REDIRECT_COUNT:
    case CURLINFO_HEADER_SIZE:
    case CURLINFO_REQUEST_SIZE:
    case CURLINFO_SSL_VERIFYRESULT:
    case CURLINFO_HTTPAUTH_AVAIL:
    case CURLINFO_PROXYAUTH_AVAIL:
    case CURLINFO_OS_ERRNO:
    case CURLINFO_NUM_CONNECTS:
    case CURLINFO_LASTSOCKET:
      c_err_code = curl_easy_getinfo(rb_ch->ch, information, &l_var);
      if (c_err_code == CURLE_OK)
        info_val = INT2FIX(l_var);
      break;
    /* pointer to a double */
    case CURLINFO_TOTAL_TIME:
    case CURLINFO_NAMELOOKUP_TIME:
    case CURLINFO_CONNECT_TIME:
    case CURLINFO_PRETRANSFER_TIME:
    case CURLINFO_STARTTRANSFER_TIME:
    case CURLINFO_REDIRECT_TIME:
    case CURLINFO_SIZE_UPLOAD:
    case CURLINFO_SIZE_DOWNLOAD:
    case CURLINFO_SPEED_UPLOAD:
    case CURLINFO_SPEED_DOWNLOAD:
    case CURLINFO_CONTENT_LENGTH_DOWNLOAD:
    case CURLINFO_CONTENT_LENGTH_UPLOAD:
      c_err_code = curl_easy_getinfo(rb_ch->ch, information, &d_var);
      if (c_err_code == CURLE_OK)
        info_val = DBL2NUM(d_var);
      break;
    /*  pointer to a 'struct curl_certinfo *' */
#if LIBCURL_VERSION_NUM >= 0x071301 /* Curl::Info constants (Available since 7.19.1) */
    case CURLINFO_CERTINFO:
      c_err_code = curl_easy_getinfo(rb_ch->ch, information, &curl_certinfo_chain);
      if (c_err_code == CURLE_OK)
        info_val = rb_curl_create_certinfo(curl_certinfo_chain);
      break;
#endif
    /* address of a 'struct curl_slist *' */
    case CURLINFO_SSL_ENGINES:
    case CURLINFO_COOKIELIST:
      c_err_code = curl_easy_getinfo(rb_ch->ch, information, &curl_list_var);
      if (c_err_code == CURLE_OK) {
        info_val = curl_slist_to_rb_array(curl_list_var);
        curl_slist_free_all(curl_list_var);
      }
      break;
    default:
      rb_raise(rb_eTypeError, "Unsupported information.");
  }
  rb_ary_push(ret_val, info_val);
  rb_ary_push(ret_val, LONG2NUM(c_err_code));

  return ret_val;
}

#perform ⇒ Object 



500
501
502
503
504
505
506
507
508
 
# File 'ext/easy.c', line 500

static VALUE rb_curl_easy_perform(VALUE self) {
  CURLcode c_err_code;
  rb_curl_easy *rb_ch;

  Data_Get_Struct(self, rb_curl_easy, rb_ch);
  c_err_code = curl_easy_perform(rb_ch->ch);

  return LONG2NUM(c_err_code);
}

#reset ⇒ Object 



519
520
521
522
523
524
525
526
527
 
# File 'ext/easy.c', line 519

static VALUE rb_curl_easy_reset(VALUE self) {
  rb_curl_easy *rb_ch;
  
  Data_Get_Struct(self, rb_curl_easy, rb_ch);
  curl_easy_reset(rb_ch->ch);
  rb_curl_zero_state(rb_ch);

  return Qnil;
}

#setopt(opt, val) ⇒ Object 



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
 
# File 'ext/easy.c', line 279

static VALUE rb_curl_easy_setopt(VALUE self, VALUE opt, VALUE val) {
  CURLcode c_err_code;
  rb_curl_easy *rb_ch;
  long option = NUM2LONG(opt);

  Data_Get_Struct(self, rb_curl_easy, rb_ch);

  switch (option) {
    case CURLOPT_TIMEOUT:
    case CURLOPT_FOLLOWLOCATION:
    case CURLOPT_MAXREDIRS:
    case CURLOPT_POST:
    case CURLOPT_PUT:
    case CURLOPT_HTTPGET:
    case CURLOPT_UPLOAD:
    case CURLOPT_VERBOSE:
#if LIBCURL_VERSION_NUM >= 0x070b02 /* Available since 7.11.2 */
    case CURLOPT_TCP_NODELAY:
#endif
#if LIBCURL_VERSION_NUM >= 0x070e01 /* Available since 7.14.1 */
    case CURLOPT_IGNORE_CONTENT_LENGTH:
#endif
#if LIBCURL_VERSION_NUM >= 0x070f02 /* Available since 7.15.2 */
    case CURLOPT_CONNECT_ONLY:
    case CURLOPT_LOCALPORT:
#endif
#if LIBCURL_VERSION_NUM >= 0x071000 /* Available since 7.16.0 */
    case CURLOPT_SSL_SESSIONID_CACHE:
#endif
#if LIBCURL_VERSION_NUM >= 0x071002 /* Available since 7.16.2 */
    case CURLOPT_CONNECTTIMEOUT_MS:
    case CURLOPT_HTTP_CONTENT_DECODING:
    case CURLOPT_HTTP_TRANSFER_DECODING:
    case CURLOPT_TIMEOUT_MS:
#endif
#if LIBCURL_VERSION_NUM >= 0x071300 /* Available since 7.19.0 */
    case CURLOPT_ADDRESS_SCOPE:
#endif
#if LIBCURL_VERSION_NUM >= 0x071301 /* Available since 7.19.1 */
    case CURLOPT_CERTINFO:
    case CURLOPT_POSTREDIR:
#endif
#if LIBCURL_VERSION_NUM >= 0x071600 /* Available since 7.22.0 */
    case CURLOPT_GSSAPI_DELEGATION:
#endif
#if LIBCURL_VERSION_NUM >= 0x072a00 /* Available since 7.42.0 */
    case CURLOPT_PATH_AS_IS:
#endif
#if LIBCURL_VERSION_NUM >= 0x072b00 /* Available since 7.43.0 */
    case CURLOPT_PIPEWAIT:
#endif
#if LIBCURL_VERSION_NUM >= 0x070a06 /* Available since 7.10.6 */
    case CURLOPT_HTTPAUTH:
#endif
#if LIBCURL_VERSION_NUM >= 0x070a07 /* Available since 7.10.7 */
    case CURLOPT_PROXYAUTH:
#endif
#if LIBCURL_VERSION_NUM >= 0x070a08 /* Available since 7.10.8 */
    case CURLOPT_IPRESOLVE:
    case CURLOPT_MAXFILESIZE:
#endif
    case CURLOPT_AUTOREFERER:
    case CURLOPT_BUFFERSIZE:
    case CURLOPT_CONNECTTIMEOUT:
    case CURLOPT_COOKIESESSION:
    case CURLOPT_CRLF:
    case CURLOPT_DNS_CACHE_TIMEOUT:
    case CURLOPT_DNS_USE_GLOBAL_CACHE:
    case CURLOPT_FAILONERROR:
    case CURLOPT_FILETIME:
    case CURLOPT_FORBID_REUSE:
    case CURLOPT_FRESH_CONNECT:
    case CURLOPT_HEADER:
    case CURLOPT_HTTPPROXYTUNNEL:
    case CURLOPT_HTTP_VERSION:
    case CURLOPT_INFILESIZE:
    case CURLOPT_LOW_SPEED_LIMIT:
    case CURLOPT_LOW_SPEED_TIME:
    case CURLOPT_MAXCONNECTS:
    case CURLOPT_NETRC:
    case CURLOPT_NOBODY:
    case CURLOPT_NOPROGRESS:
    case CURLOPT_NOSIGNAL:
    case CURLOPT_PORT:
    case CURLOPT_PROXYPORT:
    case CURLOPT_PROXYTYPE:
    case CURLOPT_RESUME_FROM:
    case CURLOPT_SSLENGINE_DEFAULT:
    case CURLOPT_SSLVERSION:
    case CURLOPT_SSL_VERIFYHOST:
    case CURLOPT_SSL_VERIFYPEER:
    case CURLOPT_TIMECONDITION:
    case CURLOPT_TIMEVALUE:
    case CURLOPT_UNRESTRICTED_AUTH:
#if LIBCURL_VERSION_NUM >= 0x071304 /* Available since 7.19.4 */
    case CURLOPT_PROTOCOLS:
    case CURLOPT_REDIR_PROTOCOLS:
    case CURLOPT_SOCKS5_GSSAPI_NEC:
#endif
      c_err_code = curl_easy_setopt(rb_ch->ch, option, NUM2LONG(val));
      break;
    case CURLOPT_URL:
#if LIBCURL_VERSION_NUM >= 0x071301 /* Available since 7.19.1 */
    case CURLOPT_PASSWORD:
    case CURLOPT_USERNAME:
#endif
#if LIBCURL_VERSION_NUM >= 0x071304 /* Available since 7.19.4 */
    case CURLOPT_SOCKS5_GSSAPI_SERVICE:
#endif
    case CURLOPT_CAINFO:
    case CURLOPT_SSLCERTTYPE:
    case CURLOPT_SSLKEYTYPE:
      c_err_code = curl_easy_setopt(rb_ch->ch, option, StringValueCStr(val));
      break;
    case CURLOPT_POSTFIELDS:
    case CURLOPT_USERAGENT:
    case CURLOPT_USERPWD:
#if LIBCURL_VERSION_NUM >= 0x070b00 /* Available since 7.11.0 */
    case CURLOPT_NETRC_FILE:
#endif
#if LIBCURL_VERSION_NUM >= 0x070e01 /* Available since 7.14.1 */
    case CURLOPT_COOKIELIST:
#endif
#if LIBCURL_VERSION_NUM >= 0x071004 /* Available since 7.16.4 */
    case CURLOPT_KRBLEVEL:
#endif
#if LIBCURL_VERSION_NUM >= 0x071300 /* Available since 7.19.0 */
    case CURLOPT_CRLFILE:
    case CURLOPT_ISSUERCERT:
    case CURLOPT_KEYPASSWD:
#endif
#if LIBCURL_VERSION_NUM >= 0x071304 /* Available since 7.19.4 */
    case CURLOPT_NOPROXY:
#endif
#if LIBCURL_VERSION_NUM >= 0x071504 /* Available since 7.21.4 */
    case CURLOPT_TLSAUTH_PASSWORD:
    case CURLOPT_TLSAUTH_TYPE:
#endif
    case CURLOPT_TLSAUTH_USERNAME:
#if LIBCURL_VERSION_NUM >= 0x072800 /* Available since 7.40.0 */
    case CURLOPT_UNIX_SOCKET_PATH:
#endif
    case CURLOPT_CAPATH:
    case CURLOPT_COOKIE:
    case CURLOPT_COOKIEFILE:
    case CURLOPT_COOKIEJAR:
    case CURLOPT_CUSTOMREQUEST:
    case CURLOPT_EGDSOCKET:
    case CURLOPT_ENCODING:
    case CURLOPT_INTERFACE:
    case CURLOPT_PROXY:
    case CURLOPT_PROXYUSERPWD:
    case CURLOPT_RANDOM_FILE:
    case CURLOPT_RANGE:
    case CURLOPT_REFERER:
    case CURLOPT_SSLCERT:
    case CURLOPT_SSLENGINE:
    case CURLOPT_SSLKEY:
    case CURLOPT_SSL_CIPHER_LIST:
      c_err_code = curl_easy_setopt(rb_ch->ch, option, NIL_P(val) ? NULL : StringValueCStr(val));
      break;
    case CURLOPT_WRITEFUNCTION:
      rb_ch->write_function = NIL_P(val) ? NULL : rb_normalized_str(val);
      curl_easy_setopt(rb_ch->ch, CURLOPT_WRITEDATA, rb_ch);
      c_err_code = curl_easy_setopt(rb_ch->ch, CURLOPT_WRITEFUNCTION, rb_curl_write);
      break;
    case CURLOPT_WRITEDATA:
      rb_ch->write_data = val;
      c_err_code = curl_easy_setopt(rb_ch->ch, CURLOPT_WRITEDATA, rb_ch);
      break;
    case CURLOPT_HEADERFUNCTION:
      rb_ch->write_header_function = NIL_P(val) ? NULL : rb_normalized_str(val);
      curl_easy_setopt(rb_ch->ch, CURLOPT_HEADERDATA, rb_ch);
      c_err_code = curl_easy_setopt(rb_ch->ch, CURLOPT_HEADERFUNCTION, rb_curl_write_header);
      break;
    case CURLOPT_HEADERDATA:
      rb_ch->write_header_data = val;
      c_err_code = curl_easy_setopt(rb_ch->ch, CURLOPT_HEADERDATA, rb_ch);
      break;
    case CURLOPT_READFUNCTION:
      rb_ch->read_function = NIL_P(val) ? NULL : rb_normalized_str(val);
      curl_easy_setopt(rb_ch->ch, CURLOPT_READDATA, rb_ch);
      c_err_code = curl_easy_setopt(rb_ch->ch, CURLOPT_READFUNCTION, rb_curl_read);
      break;
    case CURLOPT_READDATA:
      rb_ch->read_data = val;
      c_err_code = curl_easy_setopt(rb_ch->ch, CURLOPT_READDATA, rb_ch);
      break;
#if LIBCURL_VERSION_NUM >= 0x070f02 /* Available since 7.15.2 */
    case CURLOPT_MAX_RECV_SPEED_LARGE:
    case CURLOPT_MAX_SEND_SPEED_LARGE:
      c_err_code = curl_easy_setopt(rb_ch->ch, option, (curl_off_t) NUM2LL(val));
      break;
#endif
    case CURLOPT_HTTP200ALIASES:
      rb_ch->curl_http200aliases_slist = rb_array_to_curl_slist(val, rb_ch->curl_http200aliases_slist);
      c_err_code = curl_easy_setopt(rb_ch->ch, CURLOPT_HTTP200ALIASES, rb_ch->curl_http200aliases_slist);
      break;
    case CURLOPT_HTTPHEADER:
      rb_ch->curl_httpheader_slist = rb_array_to_curl_slist(val, rb_ch->curl_httpheader_slist);
      c_err_code = curl_easy_setopt(rb_ch->ch, CURLOPT_HTTPHEADER, rb_ch->curl_httpheader_slist);
      break;
#if LIBCURL_VERSION_NUM >= 0x071503 /* Available since 7.21.3 */
    case CURLOPT_RESOLVE:
      rb_ch->curl_hosts_slist = rb_array_to_curl_slist(val, rb_ch->curl_hosts_slist);
      c_err_code = curl_easy_setopt(rb_ch->ch, CURLOPT_RESOLVE, rb_ch->curl_hosts_slist);
      break;
#endif
#if LIBCURL_VERSION_NUM >= 0x072500 /* Available since 7.37.0 */
    case CURLOPT_PROXYHEADER:
      rb_ch->curl_headers_slist = rb_array_to_curl_slist(val, rb_ch->curl_headers_slist);
      c_err_code = curl_easy_setopt(rb_ch->ch, CURLOPT_PROXYHEADER, rb_ch->curl_headers_slist);
      break;
#endif
    default:
      rb_raise(rb_eTypeError, "Unsupported option.");
  }

  return LONG2NUM(c_err_code);
}