source: trunk/libtransmission/torrent-magnet.c @ 13631

Last change on this file since 13631 was 13631, checked in by jordan, 9 years ago

(trunk, libT) #5165: fix r13625 oops

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