/* * This file Copyright (C) Mnemosyne LLC * * This file is licensed by the GPL version 2. Works owned by the * Transmission project are granted a special exemption to clause 2 (b) * so that the bulk of its code can remain under the MIT license. * This exemption does not extend to derived works not owned by * the Transmission project. * * $Id$ */ #include #include "transmission.h" #include "completion.h" #include "log.h" #include "metainfo.h" /* tr_metainfoGetBasename () */ #include "peer-mgr.h" /* pex */ #include "platform.h" /* tr_getResumeDir () */ #include "resume.h" #include "session.h" #include "torrent.h" #include "utils.h" /* tr_buildPath */ #include "variant.h" enum { MAX_REMEMBERED_PEERS = 200 }; static char* getResumeFilename (const tr_torrent * tor) { char * base = tr_metainfoGetBasename (tr_torrentInfo (tor)); char * filename = tr_strdup_printf ("%s" TR_PATH_DELIMITER_STR "%s.resume", tr_getResumeDir (tor->session), base); tr_free (base); return filename; } /*** **** ***/ static void savePeers (tr_variant * dict, const tr_torrent * tor) { int count; tr_pex * pex; count = tr_peerMgrGetPeers ((tr_torrent*) tor, &pex, TR_AF_INET, TR_PEERS_INTERESTING, MAX_REMEMBERED_PEERS); if (count > 0) tr_variantDictAddRaw (dict, TR_KEY_peers2, pex, sizeof (tr_pex) * count); tr_free (pex); count = tr_peerMgrGetPeers ((tr_torrent*) tor, &pex, TR_AF_INET6, TR_PEERS_INTERESTING, MAX_REMEMBERED_PEERS); if (count > 0) tr_variantDictAddRaw (dict, TR_KEY_peers2_6, pex, sizeof (tr_pex) * count); tr_free (pex); } static int addPeers (tr_torrent * tor, const uint8_t * buf, int buflen) { int i; int numAdded = 0; const int count = buflen / sizeof (tr_pex); for (i=0; ifileCount; list = tr_variantDictAddList (dict, TR_KEY_dnd, n); for (i=0; ifiles[i].dnd ? 1 : 0); } static uint64_t loadDND (tr_variant * dict, tr_torrent * tor) { uint64_t ret = 0; tr_variant * list = NULL; const tr_file_index_t n = tor->info.fileCount; if (tr_variantDictFindList (dict, TR_KEY_dnd, &list) && (tr_variantListSize (list) == n)) { int64_t tmp; tr_file_index_t * dl = tr_new (tr_file_index_t, n); tr_file_index_t * dnd = tr_new (tr_file_index_t, n); tr_file_index_t i, dlCount = 0, dndCount = 0; for (i=0; ifileCount; list = tr_variantDictAddList (dict, TR_KEY_priority, n); for (i=0; ifiles[i].priority); } static uint64_t loadFilePriorities (tr_variant * dict, tr_torrent * tor) { tr_variant * list; uint64_t ret = 0; const tr_file_index_t n = tor->info.fileCount; if (tr_variantDictFindList (dict, TR_KEY_priority, &list) && (tr_variantListSize (list) == n)) { int64_t priority; tr_file_index_t i; for (i=0; iinfo.name); tor->info.name = tr_strdup (name); } } return ret; } /*** **** ***/ static void saveFilenames (tr_variant * dict, const tr_torrent * tor) { tr_file_index_t i; bool any_renamed; const tr_file_index_t n = tor->info.fileCount; const tr_file * files = tor->info.files; any_renamed = false; for (i=0; !any_renamed && iinfo.files; for (i=0; iinfo.fileCount && ifileCount); for (fi=0; fifileCount; ++fi) { const tr_piece * p; const tr_piece * pend; time_t oldest_nonzero = now; time_t newest = 0; bool has_zero = false; const time_t mtime = tr_torrentGetFileMTime (tor, fi); const tr_file * f = &inf->files[fi]; /* get the oldest and newest nonzero timestamps for pieces in this file */ for (p=&inf->pieces[f->firstPiece], pend=&inf->pieces[f->lastPiece]; p!=pend; ++p) { if (!p->timeChecked) has_zero = true; else if (oldest_nonzero > p->timeChecked) oldest_nonzero = p->timeChecked; if (newest < p->timeChecked) newest = p->timeChecked; } /* If some of a file's pieces have been checked more recently than the file's mtime, and some less recently, then that file will have a list containing timestamps for each piece. However, the most common use case is that the file doesn't change after it's downloaded. To reduce overhead in the .resume file, only a single timestamp is saved for the file if *all* or *none* of the pieces were tested more recently than the file's mtime. */ if (!has_zero && (mtime <= oldest_nonzero)) /* all checked */ { tr_variantListAddInt (l, oldest_nonzero); } else if (newest < mtime) /* none checked */ { tr_variantListAddInt (l, newest); } else /* some are checked, some aren't... so list piece by piece */ { const int offset = oldest_nonzero - 1; tr_variant * ll = tr_variantListAddList (l, 2 + f->lastPiece - f->firstPiece); tr_variantListAddInt (ll, offset); for (p=&inf->pieces[f->firstPiece], pend=&inf->pieces[f->lastPiece]+1; p!=pend; ++p) tr_variantListAddInt (ll, p->timeChecked ? p->timeChecked - offset : 0); } } /* add the progress */ if (tor->completeness == TR_SEED) tr_variantDictAddStr (prog, TR_KEY_have, "all"); /* add the blocks bitfield */ bitfieldToBenc (&tor->completion.blockBitfield, tr_variantDictAdd (prog, TR_KEY_blocks)); } static uint64_t loadProgress (tr_variant * dict, tr_torrent * tor) { size_t i, n; uint64_t ret = 0; tr_variant * prog; const tr_info * inf = tr_torrentInfo (tor); for (i=0, n=inf->pieceCount; ipieces[i].timeChecked = 0; if (tr_variantDictFindDict (dict, TR_KEY_progress, &prog)) { const char * err; const char * str; const uint8_t * raw; size_t rawlen; tr_variant * l; tr_variant * b; struct tr_bitfield blocks = TR_BITFIELD_INIT; if (tr_variantDictFindList (prog, TR_KEY_time_checked, &l)) { /* per-piece timestamps were added in 2.20. If some of a file's pieces have been checked more recently than the file's mtime, and some lest recently, then that file will have a list containing timestamps for each piece. However, the most common use case is that the file doesn't change after it's downloaded. To reduce overhead in the .resume file, only a single timestamp is saved for the file if *all* or *none* of the pieces were tested more recently than the file's mtime. */ tr_file_index_t fi; for (fi=0; fifileCount; ++fi) { tr_variant * b = tr_variantListChild (l, fi); const tr_file * f = &inf->files[fi]; tr_piece * p = &inf->pieces[f->firstPiece]; const tr_piece * pend = &inf->pieces[f->lastPiece]+1; if (tr_variantIsInt (b)) { int64_t t; tr_variantGetInt (b, &t); for (; p!=pend; ++p) p->timeChecked = (time_t)t; } else if (tr_variantIsList (b)) { int i = 0; int64_t offset = 0; const int pieces = f->lastPiece + 1 - f->firstPiece; tr_variantGetInt (tr_variantListChild (b, 0), &offset); for (i=0; ipieces[f->firstPiece+i].timeChecked = (time_t)(t ? t + offset : 0); } } } } else if (tr_variantDictFindList (prog, TR_KEY_mtimes, &l)) { tr_file_index_t fi; /* Before 2.20, we stored the files' mtimes in the .resume file. When loading the .resume file, a torrent's file would be flagged as untested if its stored mtime didn't match its real mtime. */ for (fi=0; fifileCount; ++fi) { int64_t t; if (tr_variantGetInt (tr_variantListChild (l, fi), &t)) { const tr_file * f = &inf->files[fi]; tr_piece * p = &inf->pieces[f->firstPiece]; const tr_piece * pend = &inf->pieces[f->lastPiece]; const time_t mtime = tr_torrentGetFileMTime (tor, fi); const time_t timeChecked = mtime==t ? mtime : 0; for (; p!=pend; ++p) p->timeChecked = timeChecked; } } } err = NULL; tr_bitfieldConstruct (&blocks, tor->blockCount); if ((b = tr_variantDictFind (prog, TR_KEY_blocks))) { size_t buflen; const uint8_t * buf; if (!tr_variantGetRaw (b, &buf, &buflen)) err = "Invalid value for \"blocks\""; else if ((buflen == 3) && !memcmp (buf, "all", 3)) tr_bitfieldSetHasAll (&blocks); else if ((buflen == 4) && !memcmp (buf, "none", 4)) tr_bitfieldSetHasNone (&blocks); else tr_bitfieldSetRaw (&blocks, buf, buflen, true); } else if (tr_variantDictFindStr (prog, TR_KEY_have, &str, NULL)) { if (!strcmp (str, "all")) tr_bitfieldSetHasAll (&blocks); else err = "Invalid value for HAVE"; } else if (tr_variantDictFindRaw (prog, TR_KEY_bitfield, &raw, &rawlen)) { tr_bitfieldSetRaw (&blocks, raw, rawlen, true); } else err = "Couldn't find 'pieces' or 'have' or 'bitfield'"; if (err != NULL) tr_logAddTorDbg (tor, "Torrent needs to be verified - %s", err); else tr_cpBlockInit (&tor->completion, &blocks); tr_bitfieldDestruct (&blocks); ret = TR_FR_PROGRESS; } return ret; } /*** **** ***/ void tr_torrentSaveResume (tr_torrent * tor) { int err; tr_variant top; char * filename; if (!tr_isTorrent (tor)) return; tr_variantInitDict (&top, 50); /* arbitrary "big enough" number */ tr_variantDictAddInt (&top, TR_KEY_seeding_time_seconds, tor->secondsSeeding); tr_variantDictAddInt (&top, TR_KEY_downloading_time_seconds, tor->secondsDownloading); tr_variantDictAddInt (&top, TR_KEY_activity_date, tor->activityDate); tr_variantDictAddInt (&top, TR_KEY_added_date, tor->addedDate); tr_variantDictAddInt (&top, TR_KEY_corrupt, tor->corruptPrev + tor->corruptCur); tr_variantDictAddInt (&top, TR_KEY_done_date, tor->doneDate); tr_variantDictAddStr (&top, TR_KEY_destination, tor->downloadDir); if (tor->incompleteDir != NULL) tr_variantDictAddStr (&top, TR_KEY_incomplete_dir, tor->incompleteDir); tr_variantDictAddInt (&top, TR_KEY_downloaded, tor->downloadedPrev + tor->downloadedCur); tr_variantDictAddInt (&top, TR_KEY_uploaded, tor->uploadedPrev + tor->uploadedCur); tr_variantDictAddInt (&top, TR_KEY_max_peers, tor->maxConnectedPeers); tr_variantDictAddInt (&top, TR_KEY_bandwidth_priority, tr_torrentGetPriority (tor)); tr_variantDictAddBool (&top, TR_KEY_paused, !tor->isRunning); savePeers (&top, tor); if (tr_torrentHasMetadata (tor)) { saveFilePriorities (&top, tor); saveDND (&top, tor); saveProgress (&top, tor); } saveSpeedLimits (&top, tor); saveRatioLimits (&top, tor); saveIdleLimits (&top, tor); saveFilenames (&top, tor); saveName (&top, tor); filename = getResumeFilename (tor); if ((err = tr_variantToFile (&top, TR_VARIANT_FMT_BENC, filename))) tr_torrentSetLocalError (tor, "Unable to save resume file: %s", tr_strerror (err)); tr_free (filename); tr_variantFree (&top); } static uint64_t loadFromFile (tr_torrent * tor, uint64_t fieldsToLoad) { size_t len; int64_t i; const char * str; char * filename; tr_variant top; bool boolVal; uint64_t fieldsLoaded = 0; const bool wasDirty = tor->isDirty; assert (tr_isTorrent (tor)); filename = getResumeFilename (tor); if (tr_variantFromFile (&top, TR_VARIANT_FMT_BENC, filename)) { tr_logAddTorDbg (tor, "Couldn't read \"%s\"", filename); tr_free (filename); return fieldsLoaded; } tr_logAddTorDbg (tor, "Read resume file \"%s\"", filename); if ((fieldsToLoad & TR_FR_CORRUPT) && tr_variantDictFindInt (&top, TR_KEY_corrupt, &i)) { tor->corruptPrev = i; fieldsLoaded |= TR_FR_CORRUPT; } if ((fieldsToLoad & (TR_FR_PROGRESS | TR_FR_DOWNLOAD_DIR)) && (tr_variantDictFindStr (&top, TR_KEY_destination, &str, &len)) && (str && *str)) { const bool is_current_dir = tor->currentDir == tor->downloadDir; tr_free (tor->downloadDir); tor->downloadDir = tr_strndup (str, len); if (is_current_dir) tor->currentDir = tor->downloadDir; fieldsLoaded |= TR_FR_DOWNLOAD_DIR; } if ((fieldsToLoad & (TR_FR_PROGRESS | TR_FR_INCOMPLETE_DIR)) && (tr_variantDictFindStr (&top, TR_KEY_incomplete_dir, &str, &len)) && (str && *str)) { const bool is_current_dir = tor->currentDir == tor->incompleteDir; tr_free (tor->incompleteDir); tor->incompleteDir = tr_strndup (str, len); if (is_current_dir) tor->currentDir = tor->incompleteDir; fieldsLoaded |= TR_FR_INCOMPLETE_DIR; } if ((fieldsToLoad & TR_FR_DOWNLOADED) && tr_variantDictFindInt (&top, TR_KEY_downloaded, &i)) { tor->downloadedPrev = i; fieldsLoaded |= TR_FR_DOWNLOADED; } if ((fieldsToLoad & TR_FR_UPLOADED) && tr_variantDictFindInt (&top, TR_KEY_uploaded, &i)) { tor->uploadedPrev = i; fieldsLoaded |= TR_FR_UPLOADED; } if ((fieldsToLoad & TR_FR_MAX_PEERS) && tr_variantDictFindInt (&top, TR_KEY_max_peers, &i)) { tor->maxConnectedPeers = i; fieldsLoaded |= TR_FR_MAX_PEERS; } if ((fieldsToLoad & TR_FR_RUN) && tr_variantDictFindBool (&top, TR_KEY_paused, &boolVal)) { tor->isRunning = !boolVal && !tor->isQueued; fieldsLoaded |= TR_FR_RUN; } if ((fieldsToLoad & TR_FR_ADDED_DATE) && tr_variantDictFindInt (&top, TR_KEY_added_date, &i)) { tor->addedDate = i; fieldsLoaded |= TR_FR_ADDED_DATE; } if ((fieldsToLoad & TR_FR_DONE_DATE) && tr_variantDictFindInt (&top, TR_KEY_done_date, &i)) { tor->doneDate = i; fieldsLoaded |= TR_FR_DONE_DATE; } if ((fieldsToLoad & TR_FR_ACTIVITY_DATE) && tr_variantDictFindInt (&top, TR_KEY_activity_date, &i)) { tr_torrentSetActivityDate (tor, i); fieldsLoaded |= TR_FR_ACTIVITY_DATE; } if ((fieldsToLoad & TR_FR_TIME_SEEDING) && tr_variantDictFindInt (&top, TR_KEY_seeding_time_seconds, &i)) { tor->secondsSeeding = i; fieldsLoaded |= TR_FR_TIME_SEEDING; } if ((fieldsToLoad & TR_FR_TIME_DOWNLOADING) && tr_variantDictFindInt (&top, TR_KEY_downloading_time_seconds, &i)) { tor->secondsDownloading = i; fieldsLoaded |= TR_FR_TIME_DOWNLOADING; } if ((fieldsToLoad & TR_FR_BANDWIDTH_PRIORITY) && tr_variantDictFindInt (&top, TR_KEY_bandwidth_priority, &i) && tr_isPriority (i)) { tr_torrentSetPriority (tor, i); fieldsLoaded |= TR_FR_BANDWIDTH_PRIORITY; } if (fieldsToLoad & TR_FR_PEERS) fieldsLoaded |= loadPeers (&top, tor); if (fieldsToLoad & TR_FR_FILE_PRIORITIES) fieldsLoaded |= loadFilePriorities (&top, tor); if (fieldsToLoad & TR_FR_PROGRESS) fieldsLoaded |= loadProgress (&top, tor); if (fieldsToLoad & TR_FR_DND) fieldsLoaded |= loadDND (&top, tor); if (fieldsToLoad & TR_FR_SPEEDLIMIT) fieldsLoaded |= loadSpeedLimits (&top, tor); if (fieldsToLoad & TR_FR_RATIOLIMIT) fieldsLoaded |= loadRatioLimits (&top, tor); if (fieldsToLoad & TR_FR_IDLELIMIT) fieldsLoaded |= loadIdleLimits (&top, tor); if (fieldsToLoad & TR_FR_FILENAMES) fieldsLoaded |= loadFilenames (&top, tor); if (fieldsToLoad & TR_FR_NAME) fieldsLoaded |= loadName (&top, tor); /* loading the resume file triggers of a lot of changes, * but none of them needs to trigger a re-saving of the * same resume information... */ tor->isDirty = wasDirty; tr_variantFree (&top); tr_free (filename); return fieldsLoaded; } static uint64_t setFromCtor (tr_torrent * tor, uint64_t fields, const tr_ctor * ctor, int mode) { uint64_t ret = 0; if (fields & TR_FR_RUN) { bool isPaused; if (!tr_ctorGetPaused (ctor, mode, &isPaused)) { tor->isRunning = !isPaused; ret |= TR_FR_RUN; } } if (fields & TR_FR_MAX_PEERS) if (!tr_ctorGetPeerLimit (ctor, mode, &tor->maxConnectedPeers)) ret |= TR_FR_MAX_PEERS; if (fields & TR_FR_DOWNLOAD_DIR) { const char * path; if (!tr_ctorGetDownloadDir (ctor, mode, &path) && path && *path) { ret |= TR_FR_DOWNLOAD_DIR; tr_free (tor->downloadDir); tor->downloadDir = tr_strdup (path); } } return ret; } static uint64_t useManditoryFields (tr_torrent * tor, uint64_t fields, const tr_ctor * ctor) { return setFromCtor (tor, fields, ctor, TR_FORCE); } static uint64_t useFallbackFields (tr_torrent * tor, uint64_t fields, const tr_ctor * ctor) { return setFromCtor (tor, fields, ctor, TR_FALLBACK); } uint64_t tr_torrentLoadResume (tr_torrent * tor, uint64_t fieldsToLoad, const tr_ctor * ctor) { uint64_t ret = 0; assert (tr_isTorrent (tor)); ret |= useManditoryFields (tor, fieldsToLoad, ctor); fieldsToLoad &= ~ret; ret |= loadFromFile (tor, fieldsToLoad); fieldsToLoad &= ~ret; ret |= useFallbackFields (tor, fieldsToLoad, ctor); return ret; } void tr_torrentRemoveResume (const tr_torrent * tor) { char * filename = getResumeFilename (tor); tr_remove (filename); tr_free (filename); }