source: trunk/libtransmission/torrent-magnet.c

Last change on this file was 14718, checked in by mikedld, 5 years ago

Explicitly compare result of str(n)cmp/memcmp to signify that it's not boolean

  • Property svn:keywords set to Date Rev Author Id
File size: 11.3 KB
Line 
1/*
2 * This file Copyright (C) 2012-2014 Mnemosyne LLC
3 *
4 * It may be used under the GNU GPL versions 2 or 3
5 * or any future license endorsed by Mnemosyne LLC.
6 *
7 * $Id: torrent-magnet.c 14718 2016-03-13 22:11:01Z mikedld $
8 */
9
10#include <assert.h>
11#include <string.h> /* memcpy (), memset (), memcmp () */
12
13#include <event2/buffer.h>
14
15#include "transmission.h"
16#include "crypto-utils.h" /* tr_sha1 () */
17#include "file.h"
18#include "log.h"
19#include "magnet.h"
20#include "metainfo.h"
21#include "resume.h"
22#include "torrent.h"
23#include "torrent-magnet.h"
24#include "utils.h"
25#include "variant.h"
26#include "web.h"
27
28#define dbgmsg(tor, ...) \
29  do \
30    { \
31      if (tr_logGetDeepEnabled ()) \
32        tr_logAddDeep (__FILE__, __LINE__, tr_torrentName (tor), __VA_ARGS__); \
33    } \
34  while (0)
35
36/***
37****
38***/
39
40enum
41{
42  /* don't ask for the same metadata piece more than this often */
43  MIN_REPEAT_INTERVAL_SECS = 3
44};
45
46struct metadata_node
47{
48  time_t requestedAt;
49  int piece;
50};
51
52struct tr_incomplete_metadata
53{
54  uint8_t * metadata;
55  int metadata_size;
56  int pieceCount;
57
58  /** sorted from least to most recently requested */
59  struct metadata_node * piecesNeeded;
60  int piecesNeededCount;
61};
62
63static void
64incompleteMetadataFree (struct tr_incomplete_metadata * m)
65{
66  tr_free (m->metadata);
67  tr_free (m->piecesNeeded);
68  tr_free (m);
69}
70
71bool
72tr_torrentSetMetadataSizeHint (tr_torrent * tor, int64_t size)
73{
74  if (tr_torrentHasMetadata (tor))
75    return false;
76
77  if (tor->incompleteMetadata != NULL)
78    return false;
79
80  const int n = (size <= 0 || size > INT_MAX) ? -1 :
81                size / METADATA_PIECE_SIZE + (size % METADATA_PIECE_SIZE != 0 ? 1 : 0);
82
83  dbgmsg (tor, "metadata is %" PRId64 " bytes in %d pieces", size, n);
84
85  if (n <= 0)
86    return false;
87
88  struct tr_incomplete_metadata * m = tr_new (struct tr_incomplete_metadata, 1);
89  if (m == NULL)
90    return false;
91
92  m->pieceCount = n;
93  m->metadata = tr_new (uint8_t, size);
94  m->metadata_size = size;
95  m->piecesNeededCount = n;
96  m->piecesNeeded = tr_new (struct metadata_node, n);
97
98  if (m->metadata == NULL || m->piecesNeeded == NULL)
99    {
100      incompleteMetadataFree (m);
101      return false;
102    }
103
104  for (int i = 0; i < n; ++i)
105    {
106      m->piecesNeeded[i].piece = i;
107      m->piecesNeeded[i].requestedAt = 0;
108    }
109
110  tor->incompleteMetadata = m;
111  return true;
112}
113
114static size_t
115findInfoDictOffset (const tr_torrent * tor)
116{
117  size_t fileLen;
118  uint8_t * fileContents;
119  size_t offset = 0;
120
121  /* load the file, and find the info dict's offset inside the file */
122  if ((fileContents = tr_loadFile (tor->info.torrent, &fileLen, NULL)))
123    {
124      tr_variant top;
125
126      if (!tr_variantFromBenc (&top, fileContents, fileLen))
127        {
128          tr_variant * infoDict;
129
130          if (tr_variantDictFindDict (&top, TR_KEY_info, &infoDict))
131            {
132              size_t infoLen;
133              char * infoContents = tr_variantToStr (infoDict, TR_VARIANT_FMT_BENC, &infoLen);
134              const uint8_t * i = (const uint8_t*) tr_memmem ((char*)fileContents, fileLen, infoContents, infoLen);
135              offset = i != NULL ? i - fileContents : 0;
136              tr_free (infoContents);
137            }
138
139          tr_variantFree (&top);
140        }
141
142      tr_free (fileContents);
143    }
144
145  return offset;
146}
147
148static void
149ensureInfoDictOffsetIsCached (tr_torrent * tor)
150{
151  assert (tr_torrentHasMetadata (tor));
152
153  if (!tor->infoDictOffsetIsCached)
154    {
155      tor->infoDictOffset = findInfoDictOffset (tor);
156      tor->infoDictOffsetIsCached = true;
157    }
158}
159
160void*
161tr_torrentGetMetadataPiece (tr_torrent * tor, int piece, size_t * len)
162{
163  char * ret = NULL;
164
165  assert (tr_isTorrent (tor));
166  assert (piece >= 0);
167  assert (len != NULL);
168
169  if (tr_torrentHasMetadata (tor))
170    {
171      tr_sys_file_t fd;
172
173      ensureInfoDictOffsetIsCached (tor);
174
175      assert (tor->infoDictLength > 0);
176
177      fd = tr_sys_file_open (tor->info.torrent, TR_SYS_FILE_READ, 0, NULL);
178      if (fd != TR_BAD_SYS_FILE)
179        {
180          const size_t o = piece * METADATA_PIECE_SIZE;
181
182          if (tr_sys_file_seek (fd, tor->infoDictOffset + o, TR_SEEK_SET, NULL, NULL))
183            {
184              const size_t l = o + METADATA_PIECE_SIZE <= tor->infoDictLength
185                             ? METADATA_PIECE_SIZE
186                             : tor->infoDictLength - o;
187
188              if (0<l && l<=METADATA_PIECE_SIZE)
189                {
190                  char * buf = tr_new (char, l);
191                  uint64_t n;
192                  if (tr_sys_file_read (fd, buf, l, &n, NULL) && n == l)
193                    {
194                      *len = l;
195                      ret = buf;
196                      buf = NULL;
197                    }
198
199                  tr_free (buf);
200                }
201            }
202
203          tr_sys_file_close (fd, NULL);
204        }
205    }
206
207  assert (ret == NULL || *len > 0);
208
209  return ret;
210}
211
212void
213tr_torrentSetMetadataPiece (tr_torrent  * tor, int piece, const void  * data, int len)
214{
215  int i;
216  struct tr_incomplete_metadata * m;
217  const int offset = piece * METADATA_PIECE_SIZE;
218
219  assert (tr_isTorrent (tor));
220  assert (data != NULL);
221  assert (len >= 0);
222
223  dbgmsg (tor, "got metadata piece %d of %d bytes", piece, len);
224
225  /* are we set up to download metadata? */
226  m = tor->incompleteMetadata;
227  if (m == NULL)
228    return;
229
230  /* does this data pass the smell test? */
231  if (piece < 0 || piece >= m->pieceCount)
232    return;
233  if (piece < m->pieceCount - 1 ? len != METADATA_PIECE_SIZE : len > METADATA_PIECE_SIZE)
234    return;
235
236  assert (offset <= m->metadata_size);
237
238  if (len == 0 || len > m->metadata_size - offset)
239    return;
240
241  /* do we need this piece? */
242  for (i=0; i<m->piecesNeededCount; ++i)
243    if (m->piecesNeeded[i].piece == piece)
244      break;
245  if (i==m->piecesNeededCount)
246    return;
247
248  memcpy (m->metadata + offset, data, len);
249
250  tr_removeElementFromArray (m->piecesNeeded, i,
251                             sizeof (struct metadata_node),
252                             m->piecesNeededCount--);
253
254  dbgmsg (tor, "saving metainfo piece %d... %d remain", piece, m->piecesNeededCount);
255
256  /* are we done? */
257  if (m->piecesNeededCount == 0)
258    {
259      bool success = false;
260      bool checksumPassed = false;
261      bool metainfoParsed = false;
262      uint8_t sha1[SHA_DIGEST_LENGTH];
263
264      /* we've got a complete set of metainfo... see if it passes the checksum test */
265      dbgmsg (tor, "metainfo piece %d was the last one", piece);
266      tr_sha1 (sha1, m->metadata, m->metadata_size, NULL);
267      if ((checksumPassed = memcmp (sha1, tor->info.hash, SHA_DIGEST_LENGTH) == 0))
268        {
269          /* checksum passed; now try to parse it as benc */
270          tr_variant infoDict;
271          const int err = tr_variantFromBenc (&infoDict, m->metadata, m->metadata_size);
272          dbgmsg (tor, "err is %d", err);
273          if ((metainfoParsed = !err))
274            {
275              /* yay we have bencoded metainfo... merge it into our .torrent file */
276              tr_variant newMetainfo;
277              char * path = tr_strdup (tor->info.torrent);
278
279              if (tr_variantFromFile (&newMetainfo, TR_VARIANT_FMT_BENC, path, NULL))
280                {
281                  bool hasInfo;
282                  tr_info info;
283                  size_t infoDictLength;
284
285                  /* remove any old .torrent and .resume files */
286                  tr_sys_path_remove (path, NULL);
287                  tr_torrentRemoveResume (tor);
288
289                  dbgmsg (tor, "Saving completed metadata to \"%s\"", path);
290                  tr_variantMergeDicts (tr_variantDictAddDict (&newMetainfo, TR_KEY_info, 0), &infoDict);
291
292                  memset (&info, 0, sizeof (tr_info));
293                  success = tr_metainfoParse (tor->session, &newMetainfo, &info, &hasInfo, &infoDictLength);
294
295                  if (success && !tr_getBlockSize (info.pieceSize))
296                    {
297                      tr_torrentSetLocalError (tor, "%s", _("Magnet torrent's metadata is not usable"));
298                      success = false;
299                    }
300
301                  if (success)
302                    {
303                      /* keep the new info */
304                      tor->info = info;
305                      tor->infoDictLength = infoDictLength;
306
307                      /* save the new .torrent file */
308                      tr_variantToFile (&newMetainfo, TR_VARIANT_FMT_BENC, tor->info.torrent);
309                      tr_sessionSetTorrentFile (tor->session, tor->info.hashString, tor->info.torrent);
310                      tr_torrentGotNewInfoDict (tor);
311                      tr_torrentSetDirty (tor);
312                    }
313
314                  tr_variantFree (&newMetainfo);
315                }
316
317              tr_variantFree (&infoDict);
318              tr_free (path);
319            }
320        }
321
322      if (success)
323        {
324          incompleteMetadataFree (tor->incompleteMetadata);
325          tor->incompleteMetadata = NULL;
326          tor->isStopping = true;
327          tor->magnetVerify = true;
328          tor->startAfterVerify = true;
329        }
330        else /* drat. */
331        {
332          const int n = m->pieceCount;
333          for (i=0; i<n; ++i)
334            {
335              m->piecesNeeded[i].piece = i;
336              m->piecesNeeded[i].requestedAt = 0;
337            }
338          m->piecesNeededCount = n;
339          dbgmsg (tor, "metadata error; trying again. %d pieces left", n);
340
341          tr_logAddError ("magnet status: checksum passed %d, metainfo parsed %d",
342                  (int)checksumPassed, (int)metainfoParsed);
343        }
344    }
345}
346
347bool
348tr_torrentGetNextMetadataRequest (tr_torrent * tor, time_t now, int * setme_piece)
349{
350  bool have_request = false;
351  struct tr_incomplete_metadata * m;
352
353  assert (tr_isTorrent (tor));
354
355  m = tor->incompleteMetadata;
356
357  if ((m != NULL) && (m->piecesNeededCount > 0)
358                  && (m->piecesNeeded[0].requestedAt + MIN_REPEAT_INTERVAL_SECS < now))
359    {
360      int i;
361      const int piece = m->piecesNeeded[0].piece;
362
363      tr_removeElementFromArray (m->piecesNeeded, 0,
364                                 sizeof (struct metadata_node),
365                                 m->piecesNeededCount--);
366
367      i = m->piecesNeededCount++;
368      m->piecesNeeded[i].piece = piece;
369      m->piecesNeeded[i].requestedAt = now;
370
371      dbgmsg (tor, "next piece to request: %d", piece);
372      *setme_piece = piece;
373      have_request = true;
374    }
375
376  return have_request;
377}
378
379double
380tr_torrentGetMetadataPercent (const tr_torrent * tor)
381{
382  double ret;
383
384  if (tr_torrentHasMetadata (tor))
385    {
386      ret = 1.0;
387    }
388  else
389    {
390      const struct tr_incomplete_metadata * m = tor->incompleteMetadata;
391
392      if (!m || !m->pieceCount)
393        ret = 0.0;
394      else
395        ret = (m->pieceCount - m->piecesNeededCount) / (double)m->pieceCount;
396    }
397
398  return ret;
399}
400
401/* FIXME: this should be renamed tr_metainfoGetMagnetLink() and moved to metainfo.c for consistency */
402char *
403tr_torrentInfoGetMagnetLink (const tr_info * inf)
404{
405  unsigned int i;
406  const char * name;
407  struct evbuffer * s = evbuffer_new ();
408
409  evbuffer_add_printf (s, "magnet:?xt=urn:btih:%s", inf->hashString);
410
411  name = inf->name;
412  if (name && *name)
413    {
414      evbuffer_add_printf (s, "%s", "&dn=");
415      tr_http_escape (s, name, TR_BAD_SIZE, true);
416    }
417
418  for (i=0; i<inf->trackerCount; ++i)
419    {
420      evbuffer_add_printf (s, "%s", "&tr=");
421      tr_http_escape (s, inf->trackers[i].announce, TR_BAD_SIZE, true);
422    }
423
424  for (i=0; i<inf->webseedCount; i++)
425    {
426      evbuffer_add_printf (s, "%s", "&ws=");
427      tr_http_escape (s, inf->webseeds[i], TR_BAD_SIZE, true);
428    }
429
430  return evbuffer_free_to_str (s, NULL);
431}
Note: See TracBrowser for help on using the repository browser.