source: trunk/libtransmission/web.c @ 13868

Last change on this file since 13868 was 13868, checked in by jordan, 8 years ago

make all the log functions/structs/enums use a single 'tr_log' namespace, such as tr_logGetQueue, tr_logAddInfo, tr_logIsLevelActive

  • Property svn:keywords set to Date Rev Author Id
File size: 16.6 KB
Line 
1/*
2 * This file Copyright (C) Mnemosyne LLC
3 *
4 * This file is licensed by the GPL version 2. Works owned by the
5 * Transmission project are granted a special exemption to clause 2 (b)
6 * so that the bulk of its code can remain under the MIT license.
7 * This exemption does not extend to derived works not owned by
8 * the Transmission project.
9 *
10 * $Id: web.c 13868 2013-01-25 23:34:20Z jordan $
11 */
12
13#include <string.h> /* strlen (), strstr () */
14#include <stdlib.h> /* getenv () */
15
16#ifdef WIN32
17  #include <ws2tcpip.h>
18#else
19  #include <sys/select.h>
20#endif
21
22#include <curl/curl.h>
23
24#include <event2/buffer.h>
25
26#include "transmission.h"
27#include "log.h"
28#include "net.h" /* tr_address */
29#include "platform.h" /* mutex */
30#include "session.h"
31#include "trevent.h" /* tr_runInEventThread () */
32#include "utils.h"
33#include "version.h" /* User-Agent */
34#include "web.h"
35
36#if LIBCURL_VERSION_NUM >= 0x070F06 /* CURLOPT_SOCKOPT* was added in 7.15.6 */
37 #define USE_LIBCURL_SOCKOPT
38#endif
39
40enum
41{
42  THREADFUNC_MAX_SLEEP_MSEC = 1000,
43};
44
45#if 0
46#define dbgmsg(...) \
47  do { \
48    fprintf (stderr, __VA_ARGS__); \
49    fprintf (stderr, "\n"); \
50  } while (0)
51#else
52#define dbgmsg(...) \
53  do { \
54    if (tr_logGetDeepEnabled ()) \
55      tr_logAddDeep (__FILE__, __LINE__, "web", __VA_ARGS__); \
56  } while (0)
57#endif
58
59/***
60****
61***/
62
63struct tr_web_task
64{
65  long code;
66  long timeout_secs;
67  bool did_connect;
68  bool did_timeout;
69  struct evbuffer * response;
70  struct evbuffer * freebuf;
71  char * url;
72  char * range;
73  char * cookies;
74  tr_session * session;
75  tr_web_done_func * done_func;
76  void * done_func_user_data;
77  CURL * curl_easy;
78  struct tr_web_task * next;
79};
80
81static void
82task_free (struct tr_web_task * task)
83{
84  if (task->freebuf)
85    evbuffer_free (task->freebuf);
86  tr_free (task->cookies);
87  tr_free (task->range);
88  tr_free (task->url);
89  tr_free (task);
90}
91
92/***
93****
94***/
95
96struct tr_web
97{
98  bool curl_verbose;
99  bool curl_ssl_verify;
100  const char * curl_ca_bundle;
101  int close_mode;
102  struct tr_web_task * tasks;
103  tr_lock * taskLock;
104  char * cookie_filename;
105};
106
107/***
108****
109***/
110
111static size_t
112writeFunc (void * ptr, size_t size, size_t nmemb, void * vtask)
113{
114  const size_t byteCount = size * nmemb;
115  struct tr_web_task * task = vtask;
116  evbuffer_add (task->response, ptr, byteCount);
117  dbgmsg ("wrote %zu bytes to task %p's buffer", byteCount, task);
118  return byteCount;
119}
120
121#ifdef USE_LIBCURL_SOCKOPT
122static int
123sockoptfunction (void * vtask, curl_socket_t fd, curlsocktype purpose UNUSED)
124{
125  struct tr_web_task * task = vtask;
126  const bool isScrape = strstr (task->url, "scrape") != NULL;
127  const bool isAnnounce = strstr (task->url, "announce") != NULL;
128
129  /* announce and scrape requests have tiny payloads. */
130  if (isScrape || isAnnounce)
131    {
132      const int sndbuf = 1024;
133      const int rcvbuf = isScrape ? 2048 : 3072;
134      setsockopt (fd, SOL_SOCKET, SO_SNDBUF, &sndbuf, sizeof (sndbuf));
135      setsockopt (fd, SOL_SOCKET, SO_RCVBUF, &rcvbuf, sizeof (rcvbuf));
136    }
137
138  /* return nonzero if this function encountered an error */
139  return 0;
140}
141#endif
142
143static long
144getTimeoutFromURL (const struct tr_web_task * task)
145{
146  long timeout;
147  const tr_session * session = task->session;
148
149  if (!session || session->isClosed) timeout = 20L;
150  else if (strstr (task->url, "scrape") != NULL) timeout = 30L;
151  else if (strstr (task->url, "announce") != NULL) timeout = 90L;
152  else timeout = 240L;
153
154  return timeout;
155}
156
157static CURL *
158createEasy (tr_session * s, struct tr_web * web, struct tr_web_task * task)
159{
160  bool is_default_value;
161  const tr_address * addr;
162  CURL * e = task->curl_easy = curl_easy_init ();
163
164  task->timeout_secs = getTimeoutFromURL (task);
165
166  curl_easy_setopt (e, CURLOPT_AUTOREFERER, 1L);
167  curl_easy_setopt (e, CURLOPT_COOKIEFILE, web->cookie_filename);
168  curl_easy_setopt (e, CURLOPT_ENCODING, "gzip;q=1.0, deflate, identity");
169  curl_easy_setopt (e, CURLOPT_FOLLOWLOCATION, 1L);
170  curl_easy_setopt (e, CURLOPT_MAXREDIRS, -1L);
171  curl_easy_setopt (e, CURLOPT_NOSIGNAL, 1L);
172  curl_easy_setopt (e, CURLOPT_PRIVATE, task);
173#ifdef USE_LIBCURL_SOCKOPT
174  curl_easy_setopt (e, CURLOPT_SOCKOPTFUNCTION, sockoptfunction);
175  curl_easy_setopt (e, CURLOPT_SOCKOPTDATA, task);
176#endif
177  if (web->curl_ssl_verify)
178    {
179      curl_easy_setopt (e, CURLOPT_CAINFO, web->curl_ca_bundle);
180    }
181  else
182    {
183      curl_easy_setopt (e, CURLOPT_SSL_VERIFYHOST, 0L);
184      curl_easy_setopt (e, CURLOPT_SSL_VERIFYPEER, 0L);
185    }
186  curl_easy_setopt (e, CURLOPT_TIMEOUT, task->timeout_secs);
187  curl_easy_setopt (e, CURLOPT_URL, task->url);
188  curl_easy_setopt (e, CURLOPT_USERAGENT, TR_NAME "/" SHORT_VERSION_STRING);
189  curl_easy_setopt (e, CURLOPT_VERBOSE, (long)(web->curl_verbose?1:0));
190  curl_easy_setopt (e, CURLOPT_WRITEDATA, task);
191  curl_easy_setopt (e, CURLOPT_WRITEFUNCTION, writeFunc);
192
193  if (((addr = tr_sessionGetPublicAddress (s, TR_AF_INET, &is_default_value))) && !is_default_value)
194    curl_easy_setopt (e, CURLOPT_INTERFACE, tr_address_to_string (addr));
195  else if (((addr = tr_sessionGetPublicAddress (s, TR_AF_INET6, &is_default_value))) && !is_default_value)
196    curl_easy_setopt (e, CURLOPT_INTERFACE, tr_address_to_string (addr));
197
198  if (task->cookies != NULL)
199    curl_easy_setopt (e, CURLOPT_COOKIE, task->cookies);
200
201  if (task->range != NULL)
202    {
203      curl_easy_setopt (e, CURLOPT_RANGE, task->range);
204      /* don't bother asking the server to compress webseed fragments */
205      curl_easy_setopt (e, CURLOPT_ENCODING, "identity");
206    }
207
208  return e;
209}
210
211/***
212****
213***/
214
215static void
216task_finish_func (void * vtask)
217{
218  struct tr_web_task * task = vtask;
219  dbgmsg ("finished web task %p; got %ld", task, task->code);
220
221  if (task->done_func != NULL)
222    task->done_func (task->session,
223                     task->did_connect,
224                     task->did_timeout,
225                     task->code,
226                     evbuffer_pullup (task->response, -1),
227                     evbuffer_get_length (task->response),
228                     task->done_func_user_data);
229
230  task_free (task);
231}
232
233/****
234*****
235****/
236
237struct tr_web_task *
238tr_webRun (tr_session         * session,
239           const char         * url,
240           const char         * range,
241           const char         * cookies,
242           tr_web_done_func     done_func,
243           void               * done_func_user_data)
244{
245  return tr_webRunWithBuffer (session, url, range, cookies,
246                              done_func, done_func_user_data,
247                              NULL);
248}
249
250struct tr_web_task *
251tr_webRunWithBuffer (tr_session         * session,
252                     const char         * url,
253                     const char         * range,
254                     const char         * cookies,
255                     tr_web_done_func     done_func,
256                     void               * done_func_user_data,
257                     struct evbuffer    * buffer)
258{
259  struct tr_web * web = session->web;
260
261  if (web != NULL)
262    {
263      struct tr_web_task * task = tr_new0 (struct tr_web_task, 1);
264
265      task->session = session;
266      task->url = tr_strdup (url);
267      task->range = tr_strdup (range);
268      task->cookies = tr_strdup (cookies);
269      task->done_func = done_func;
270      task->done_func_user_data = done_func_user_data;
271      task->response = buffer ? buffer : evbuffer_new ();
272      task->freebuf = buffer ? NULL : task->response;
273
274      tr_lockLock (web->taskLock);
275      task->next = web->tasks;
276      web->tasks = task;
277      tr_lockUnlock (web->taskLock);
278      return task;
279    }
280
281  return NULL;
282}
283
284/**
285 * Portability wrapper for select ().
286 *
287 * http://msdn.microsoft.com/en-us/library/ms740141%28VS.85%29.aspx
288 * On win32, any two of the parameters, readfds, writefds, or exceptfds,
289 * can be given as null. At least one must be non-null, and any non-null
290 * descriptor set must contain at least one handle to a socket.
291 */
292static void
293tr_select (int nfds,
294           fd_set * r_fd_set, fd_set * w_fd_set, fd_set * c_fd_set,
295           struct timeval  * t)
296{
297#ifdef WIN32
298  if (!r_fd_set->fd_count && !w_fd_set->fd_count && !c_fd_set->fd_count)
299    {
300      const long int msec = t->tv_sec*1000 + t->tv_usec/1000;
301      tr_wait_msec (msec);
302    }
303  else if (select (0, r_fd_set->fd_count ? r_fd_set : NULL,
304                      w_fd_set->fd_count ? w_fd_set : NULL,
305                      c_fd_set->fd_count ? c_fd_set : NULL, t) < 0)
306    {
307      char errstr[512];
308      const int e = EVUTIL_SOCKET_ERROR ();
309      tr_net_strerror (errstr, sizeof (errstr), e);
310      dbgmsg ("Error: select (%d) %s", e, errstr);
311    }
312#else
313  select (nfds, r_fd_set, w_fd_set, c_fd_set, t);
314#endif
315}
316
317static void
318tr_webThreadFunc (void * vsession)
319{
320  CURLM * multi;
321  struct tr_web * web;
322  int taskCount = 0;
323  struct tr_web_task * task;
324  tr_session * session = vsession;
325
326  /* try to enable ssl for https support; but if that fails,
327   * try a plain vanilla init */
328  if (curl_global_init (CURL_GLOBAL_SSL))
329    curl_global_init (0);
330
331  web = tr_new0 (struct tr_web, 1);
332  web->close_mode = ~0;
333  web->taskLock = tr_lockNew ();
334  web->tasks = NULL;
335  web->curl_verbose = getenv ("TR_CURL_VERBOSE") != NULL;
336  web->curl_ssl_verify = getenv ("TR_CURL_SSL_VERIFY") != NULL;
337  web->curl_ca_bundle = getenv ("CURL_CA_BUNDLE");
338  if (web->curl_ssl_verify)
339    {
340      tr_logAddNamedInfo ("web", "will verify tracker certs using envvar CURL_CA_BUNDLE: %s",
341               web->curl_ca_bundle == NULL ? "none" : web->curl_ca_bundle);
342      tr_logAddNamedInfo ("web", "NB: this only works if you built against libcurl with openssl or gnutls, NOT nss");
343      tr_logAddNamedInfo ("web", "NB: invalid certs will show up as 'Could not connect to tracker' like many other errors");
344    }
345  web->cookie_filename = tr_buildPath (session->configDir, "cookies.txt", NULL);
346
347  multi = curl_multi_init ();
348  session->web = web;
349
350  for (;;)
351    {
352      long msec;
353      int unused;
354      CURLMsg * msg;
355      CURLMcode mcode;
356
357      if (web->close_mode == TR_WEB_CLOSE_NOW)
358        break;
359      if ((web->close_mode == TR_WEB_CLOSE_WHEN_IDLE) && (web->tasks == NULL))
360        break;
361
362      /* add tasks from the queue */
363      tr_lockLock (web->taskLock);
364      while (web->tasks != NULL)
365        {
366          /* pop the task */
367          task = web->tasks;
368          web->tasks = task->next;
369          task->next = NULL;
370
371          dbgmsg ("adding task to curl: [%s]", task->url);
372          curl_multi_add_handle (multi, createEasy (session, web, task));
373          /*fprintf (stderr, "adding a task.. taskCount is now %d\n", taskCount);*/
374          ++taskCount;
375        }
376      tr_lockUnlock (web->taskLock);
377
378      /* maybe wait a little while before calling curl_multi_perform () */
379      msec = 0;
380      curl_multi_timeout (multi, &msec);
381      if (msec < 0)
382        msec = THREADFUNC_MAX_SLEEP_MSEC;
383      if (session->isClosed)
384        msec = 100; /* on shutdown, call perform () more frequently */
385      if (msec > 0)
386        {
387          int usec;
388          int max_fd;
389          struct timeval t;
390          fd_set r_fd_set, w_fd_set, c_fd_set;
391
392          max_fd = 0;
393          FD_ZERO (&r_fd_set);
394          FD_ZERO (&w_fd_set);
395          FD_ZERO (&c_fd_set);
396          curl_multi_fdset (multi, &r_fd_set, &w_fd_set, &c_fd_set, &max_fd);
397
398          if (msec > THREADFUNC_MAX_SLEEP_MSEC)
399            msec = THREADFUNC_MAX_SLEEP_MSEC;
400
401          usec = msec * 1000;
402          t.tv_sec =  usec / 1000000;
403          t.tv_usec = usec % 1000000;
404          tr_select (max_fd+1, &r_fd_set, &w_fd_set, &c_fd_set, &t);
405        }
406
407      /* call curl_multi_perform () */
408      do
409        mcode = curl_multi_perform (multi, &unused);
410      while (mcode == CURLM_CALL_MULTI_PERFORM);
411
412      /* pump completed tasks from the multi */
413      while ((msg = curl_multi_info_read (multi, &unused)))
414        {
415          if ((msg->msg == CURLMSG_DONE) && (msg->easy_handle != NULL))
416            {
417              double total_time;
418              struct tr_web_task * task;
419              long req_bytes_sent;
420              CURL * e = msg->easy_handle;
421              curl_easy_getinfo (e, CURLINFO_PRIVATE, (void*)&task);
422              curl_easy_getinfo (e, CURLINFO_RESPONSE_CODE, &task->code);
423              curl_easy_getinfo (e, CURLINFO_REQUEST_SIZE, &req_bytes_sent);
424              curl_easy_getinfo (e, CURLINFO_TOTAL_TIME, &total_time);
425              task->did_connect = task->code>0 || req_bytes_sent>0;
426              task->did_timeout = !task->code && (total_time >= task->timeout_secs);
427              curl_multi_remove_handle (multi, e);
428              curl_easy_cleanup (e);
429              tr_runInEventThread (task->session, task_finish_func, task);
430              --taskCount;
431            }
432        }
433    }
434
435  /* Discard any remaining tasks.
436   * This is rare, but can happen on shutdown with unresponsive trackers. */
437  while (web->tasks != NULL)
438    {
439      task = web->tasks;
440      web->tasks = task->next;
441      dbgmsg ("Discarding task \"%s\"", task->url);
442      task_free (task);
443    }
444
445  /* cleanup */
446  curl_multi_cleanup (multi);
447  tr_lockFree (web->taskLock);
448  tr_free (web->cookie_filename);
449  tr_free (web);
450  session->web = NULL;
451}
452
453void
454tr_webInit (tr_session * session)
455{
456  tr_threadNew (tr_webThreadFunc, session);
457}
458
459void
460tr_webClose (tr_session * session, tr_web_close_mode close_mode)
461{
462  if (session->web != NULL)
463    {
464      session->web->close_mode = close_mode;
465
466      if (close_mode == TR_WEB_CLOSE_NOW)
467        while (session->web != NULL)
468          tr_wait_msec (100);
469    }
470}
471
472void
473tr_webGetTaskInfo (struct tr_web_task * task, tr_web_task_info info, void * dst)
474{
475  curl_easy_getinfo (task->curl_easy, (CURLINFO) info, dst);
476}
477
478/*****
479******
480******
481*****/
482
483const char *
484tr_webGetResponseStr (long code)
485{
486  switch (code)
487    {
488      case   0: return "No Response";
489      case 101: return "Switching Protocols";
490      case 200: return "OK";
491      case 201: return "Created";
492      case 202: return "Accepted";
493      case 203: return "Non-Authoritative Information";
494      case 204: return "No Content";
495      case 205: return "Reset Content";
496      case 206: return "Partial Content";
497      case 300: return "Multiple Choices";
498      case 301: return "Moved Permanently";
499      case 302: return "Found";
500      case 303: return "See Other";
501      case 304: return "Not Modified";
502      case 305: return "Use Proxy";
503      case 306: return " (Unused)";
504      case 307: return "Temporary Redirect";
505      case 400: return "Bad Request";
506      case 401: return "Unauthorized";
507      case 402: return "Payment Required";
508      case 403: return "Forbidden";
509      case 404: return "Not Found";
510      case 405: return "Method Not Allowed";
511      case 406: return "Not Acceptable";
512      case 407: return "Proxy Authentication Required";
513      case 408: return "Request Timeout";
514      case 409: return "Conflict";
515      case 410: return "Gone";
516      case 411: return "Length Required";
517      case 412: return "Precondition Failed";
518      case 413: return "Request Entity Too Large";
519      case 414: return "Request-URI Too Long";
520      case 415: return "Unsupported Media Type";
521      case 416: return "Requested Range Not Satisfiable";
522      case 417: return "Expectation Failed";
523      case 500: return "Internal Server Error";
524      case 501: return "Not Implemented";
525      case 502: return "Bad Gateway";
526      case 503: return "Service Unavailable";
527      case 504: return "Gateway Timeout";
528      case 505: return "HTTP Version Not Supported";
529      default:  return "Unknown Error";
530    }
531}
532
533void
534tr_http_escape (struct evbuffer  * out,
535                const char       * str,
536                int                len,
537                bool               escape_slashes)
538{
539  const char * end;
540
541  if ((len < 0) && (str != NULL))
542    len = strlen (str);
543
544  for (end=str+len; str && str!=end; ++str)
545    {
546      if ((*str == ',') || (*str == '-')
547                        || (*str == '.')
548                        || (('0' <= *str) && (*str <= '9'))
549                        || (('A' <= *str) && (*str <= 'Z'))
550                        || (('a' <= *str) && (*str <= 'z'))
551                        || ((*str == '/') && (!escape_slashes)))
552        evbuffer_add_printf (out, "%c", *str);
553      else
554        evbuffer_add_printf (out, "%%%02X", (unsigned)(*str&0xFF));
555    }
556}
557
558char *
559tr_http_unescape (const char * str, int len)
560{
561  char * tmp = curl_unescape (str, len);
562  char * ret = tr_strdup (tmp);
563  curl_free (tmp);
564  return ret;
565}
566
567static int
568is_rfc2396_alnum (uint8_t ch)
569{
570  return ('0' <= ch && ch <= '9')
571      || ('A' <= ch && ch <= 'Z')
572      || ('a' <= ch && ch <= 'z')
573      || ch == '.'
574      || ch == '-'
575      || ch == '_'
576      || ch == '~';
577}
578
579void
580tr_http_escape_sha1 (char * out, const uint8_t * sha1_digest)
581{
582  const uint8_t * in = sha1_digest;
583  const uint8_t * end = in + SHA_DIGEST_LENGTH;
584
585  while (in != end)
586    if (is_rfc2396_alnum (*in))
587      *out++ = (char) *in++;
588    else
589      out += tr_snprintf (out, 4, "%%%02x", (unsigned int)*in++);
590
591  *out = '\0';
592}
Note: See TracBrowser for help on using the repository browser.