/* * 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$ */ #ifndef __TRANSMISSION__ #error only libtransmission should #include this header. #endif #ifndef TR_TORRENT_H #define TR_TORRENT_H 1 #include "bandwidth.h" /* tr_bandwidth */ #include "completion.h" /* tr_completion */ #include "session.h" /* tr_sessionLock (), tr_sessionUnlock () */ #include "utils.h" /* TR_GNUC_PRINTF */ struct tr_torrent_tiers; struct tr_magnet_info; /** *** Package-visible ctor API **/ void tr_torrentFree (tr_torrent * tor); void tr_ctorSetSave (tr_ctor * ctor, bool saveMetadataInOurTorrentsDir); int tr_ctorGetSave (const tr_ctor * ctor); void tr_ctorInitTorrentPriorities (const tr_ctor * ctor, tr_torrent * tor); void tr_ctorInitTorrentWanted (const tr_ctor * ctor, tr_torrent * tor); /** *** **/ /* just like tr_torrentSetFileDLs but doesn't trigger a fastresume save */ void tr_torrentInitFileDLs (tr_torrent * tor, const tr_file_index_t * files, tr_file_index_t fileCount, bool do_download); void tr_torrentRecheckCompleteness (tr_torrent *); void tr_torrentSetHasPiece (tr_torrent * tor, tr_piece_index_t pieceIndex, bool has); void tr_torrentChangeMyPort (tr_torrent * session); tr_torrent* tr_torrentFindFromHashString (tr_session * session, const char * hashString); tr_torrent* tr_torrentFindFromObfuscatedHash (tr_session * session, const uint8_t * hash); bool tr_torrentIsPieceTransferAllowed (const tr_torrent * torrent, tr_direction direction); #define tr_block(a, b) _tr_block (tor, a, b) tr_block_index_t _tr_block (const tr_torrent * tor, tr_piece_index_t index, uint32_t offset); bool tr_torrentReqIsValid (const tr_torrent * tor, tr_piece_index_t index, uint32_t offset, uint32_t length); uint64_t tr_pieceOffset (const tr_torrent * tor, tr_piece_index_t index, uint32_t offset, uint32_t length); void tr_torrentGetBlockLocation (const tr_torrent * tor, tr_block_index_t block, tr_piece_index_t * piece, uint32_t * offset, uint32_t * length); void tr_torGetFileBlockRange (const tr_torrent * tor, const tr_file_index_t file, tr_block_index_t * first, tr_block_index_t * last); void tr_torGetPieceBlockRange (const tr_torrent * tor, const tr_piece_index_t piece, tr_block_index_t * first, tr_block_index_t * last); void tr_torrentInitFilePriority (tr_torrent * tor, tr_file_index_t fileIndex, tr_priority_t priority); void tr_torrentSetPieceChecked (tr_torrent * tor, tr_piece_index_t piece); void tr_torrentSetChecked (tr_torrent * tor, time_t when); void tr_torrentCheckSeedLimit (tr_torrent * tor); /** save a torrent's .resume file if it's changed since the last time it was saved */ void tr_torrentSave (tr_torrent * tor); void tr_torrentSetLocalError (tr_torrent * tor, const char * fmt, ...) TR_GNUC_PRINTF (2, 3); typedef enum { TR_VERIFY_NONE, TR_VERIFY_WAIT, TR_VERIFY_NOW } tr_verify_state; void tr_torrentSetVerifyState (tr_torrent * tor, tr_verify_state state); tr_torrent_activity tr_torrentGetActivity (const tr_torrent * tor); struct tr_incomplete_metadata; /** @brief Torrent object */ struct tr_torrent { tr_session * session; tr_info info; int magicNumber; tr_stat_errtype error; char errorString[128]; char errorTracker[128]; uint8_t obfuscatedHash[SHA_DIGEST_LENGTH]; /* Used when the torrent has been created with a magnet link * and we're in the process of downloading the metainfo from * other peers */ struct tr_incomplete_metadata * incompleteMetadata; /* If the initiator of the connection receives a handshake in which the * peer_id does not match the expected peerid, then the initiator is * expected to drop the connection. Note that the initiator presumably * received the peer information from the tracker, which includes the * peer_id that was registered by the peer. The peer_id from the tracker * and in the handshake are expected to match. */ unsigned char peer_id[PEER_ID_LEN+1]; time_t peer_id_creation_time; /* Where the files will be when it's complete */ char * downloadDir; /* Where the files are when the torrent is incomplete */ char * incompleteDir; /* Length, in bytes, of the "info" dict in the .torrent file. */ int infoDictLength; /* Offset, in bytes, of the beginning of the "info" dict in the .torrent file. * * Used by the torrent-magnet code for serving metainfo to peers. * This field is lazy-generated and might not be initialized yet. */ int infoDictOffset; /* Where the files are now. * This pointer will be equal to downloadDir or incompleteDir */ const char * currentDir; /* How many bytes we ask for per request */ uint32_t blockSize; tr_block_index_t blockCount; uint32_t lastBlockSize; uint32_t lastPieceSize; uint16_t blockCountInPiece; uint16_t blockCountInLastPiece; struct tr_completion completion; tr_completeness completeness; struct tr_torrent_tiers * tiers; time_t dhtAnnounceAt; time_t dhtAnnounce6At; bool dhtAnnounceInProgress; bool dhtAnnounce6InProgress; time_t lpdAnnounceAt; uint64_t downloadedCur; uint64_t downloadedPrev; uint64_t uploadedCur; uint64_t uploadedPrev; uint64_t corruptCur; uint64_t corruptPrev; uint64_t etaDLSpeedCalculatedAt; unsigned int etaDLSpeed_Bps; uint64_t etaULSpeedCalculatedAt; unsigned int etaULSpeed_Bps; time_t addedDate; time_t activityDate; time_t doneDate; time_t startDate; time_t anyDate; int secondsDownloading; int secondsSeeding; int queuePosition; tr_torrent_metadata_func metadata_func; void * metadata_func_user_data; tr_torrent_completeness_func completeness_func; void * completeness_func_user_data; tr_torrent_ratio_limit_hit_func ratio_limit_hit_func; void * ratio_limit_hit_func_user_data; tr_torrent_idle_limit_hit_func idle_limit_hit_func; void * idle_limit_hit_func_user_data; void * queue_started_user_data; void (* queue_started_callback)(tr_torrent *, void * queue_started_user_data); bool isRunning; bool isStopping; bool isDeleting; bool startAfterVerify; bool isDirty; bool isQueued; bool infoDictOffsetIsCached; uint16_t maxConnectedPeers; tr_verify_state verifyState; time_t lastStatTime; tr_stat stats; tr_torrent * next; int uniqueId; struct tr_bandwidth bandwidth; struct tr_swarm * swarm; float desiredRatio; tr_ratiolimit ratioLimitMode; uint16_t idleLimitMinutes; tr_idlelimit idleLimitMode; bool finishedSeedingByIdle; }; static inline tr_torrent* tr_torrentNext (tr_session * session, tr_torrent * current) { return current ? current->next : session->torrentList; } /* what piece index is this block in? */ static inline tr_piece_index_t tr_torBlockPiece (const tr_torrent * tor, const tr_block_index_t block) { return block / tor->blockCountInPiece; } /* how many bytes are in this piece? */ static inline uint32_t tr_torPieceCountBytes (const tr_torrent * tor, const tr_piece_index_t piece) { return piece + 1 == tor->info.pieceCount ? tor->lastPieceSize : tor->info.pieceSize; } /* how many bytes are in this block? */ static inline uint32_t tr_torBlockCountBytes (const tr_torrent * tor, const tr_block_index_t block) { return block + 1 == tor->blockCount ? tor->lastBlockSize : tor->blockSize; } static inline void tr_torrentLock (const tr_torrent * tor) { tr_sessionLock (tor->session); } static inline bool tr_torrentIsLocked (const tr_torrent * tor) { return tr_sessionIsLocked (tor->session); } static inline void tr_torrentUnlock (const tr_torrent * tor) { tr_sessionUnlock (tor->session); } static inline bool tr_torrentExists (const tr_session * session, const uint8_t * torrentHash) { return tr_torrentFindFromHash ((tr_session*)session, torrentHash) != NULL; } static inline tr_completeness tr_torrentGetCompleteness (const tr_torrent * tor) { return tor->completeness; } static inline bool tr_torrentIsSeed (const tr_torrent * tor) { return tr_torrentGetCompleteness(tor) != TR_LEECH; } static inline bool tr_torrentIsPrivate (const tr_torrent * tor) { return (tor != NULL) && tor->info.isPrivate; } static inline bool tr_torrentAllowsPex (const tr_torrent * tor) { return (tor != NULL) && (tor->session->isPexEnabled) && (!tr_torrentIsPrivate (tor)); } static inline bool tr_torrentAllowsDHT (const tr_torrent * tor) { return (tor != NULL) && (tr_sessionAllowsDHT (tor->session)) && (!tr_torrentIsPrivate (tor)); } static inline bool tr_torrentAllowsLPD (const tr_torrent * tor) { return (tor != NULL) && (tr_sessionAllowsLPD (tor->session)) && (!tr_torrentIsPrivate (tor)); } /*** **** ***/ enum { TORRENT_MAGIC_NUMBER = 95549 }; static inline bool tr_isTorrent (const tr_torrent * tor) { return (tor != NULL) && (tor->magicNumber == TORRENT_MAGIC_NUMBER) && (tr_isSession (tor->session)); } /* set a flag indicating that the torrent's .resume file * needs to be saved when the torrent is closed */ static inline void tr_torrentSetDirty (tr_torrent * tor) { assert (tr_isTorrent (tor)); tor->isDirty = true; } uint32_t tr_getBlockSize (uint32_t pieceSize); /** * Tell the tr_torrent that it's gotten a block */ void tr_torrentGotBlock (tr_torrent * tor, tr_block_index_t blockIndex); /** * @brief Like tr_torrentFindFile (), but splits the filename into base and subpath; * * If the file is found, "tr_buildPath (base, subpath, NULL)" * will generate the complete filename. * * @return true if the file is found, false otherwise. * * @param base if the torrent is found, this will be either * tor->downloadDir or tor->incompleteDir * @param subpath on success, this pointer is assigned a newly-allocated * string holding the second half of the filename. */ bool tr_torrentFindFile2 (const tr_torrent *, tr_file_index_t fileNo, const char ** base, char ** subpath, time_t * mtime); /* Returns a newly-allocated version of the tr_file.name string * that's been modified to denote that it's not a complete file yet. * In the current implementation this is done by appending ".part" * a la Firefox. */ char* tr_torrentBuildPartial (const tr_torrent *, tr_file_index_t fileNo); /* for when the info dict has been fundamentally changed wrt files, * piece size, etc. such as in BEP 9 where peers exchange metadata */ void tr_torrentGotNewInfoDict (tr_torrent * tor); void tr_torrentSetSpeedLimit_Bps (tr_torrent *, tr_direction, unsigned int Bps); unsigned int tr_torrentGetSpeedLimit_Bps (const tr_torrent *, tr_direction); /** * @return true if this piece needs to be tested */ bool tr_torrentPieceNeedsCheck (const tr_torrent * tor, tr_piece_index_t pieceIndex); /** * @brief Test a piece against its info dict checksum * @return true if the piece's passes the checksum test */ bool tr_torrentCheckPiece (tr_torrent * tor, tr_piece_index_t pieceIndex); time_t tr_torrentGetFileMTime (const tr_torrent * tor, tr_file_index_t i); uint64_t tr_torrentGetCurrentSizeOnDisk (const tr_torrent * tor); bool tr_torrentIsStalled (const tr_torrent * tor); const unsigned char * tr_torrentGetPeerId (tr_torrent * tor); static inline uint64_t tr_torrentGetLeftUntilDone (const tr_torrent * tor) { return tr_cpLeftUntilDone (&tor->completion); } static inline bool tr_torrentHasAll (const tr_torrent * tor) { return tr_cpHasAll (&tor->completion); } static inline bool tr_torrentHasNone (const tr_torrent * tor) { return tr_cpHasNone (&tor->completion); } static inline bool tr_torrentPieceIsComplete (const tr_torrent * tor, tr_piece_index_t i) { return tr_cpPieceIsComplete (&tor->completion, i); } static inline bool tr_torrentBlockIsComplete (const tr_torrent * tor, tr_block_index_t i) { return tr_cpBlockIsComplete (&tor->completion, i); } static inline size_t tr_torrentMissingBlocksInPiece (const tr_torrent * tor, tr_piece_index_t i) { return tr_cpMissingBlocksInPiece (&tor->completion, i); } static inline size_t tr_torrentMissingBytesInPiece (const tr_torrent * tor, tr_piece_index_t i) { return tr_cpMissingBytesInPiece (&tor->completion, i); } static inline void * tr_torrentCreatePieceBitfield (const tr_torrent * tor, size_t * byte_count) { return tr_cpCreatePieceBitfield (&tor->completion, byte_count); } static inline uint64_t tr_torrentHaveTotal (const tr_torrent * tor) { return tr_cpHaveTotal (&tor->completion); } static inline bool tr_torrentIsQueued (const tr_torrent * tor) { return tor->isQueued; } static inline tr_direction tr_torrentGetQueueDirection (const tr_torrent * tor) { return tr_torrentIsSeed (tor) ? TR_UP : TR_DOWN; } #endif