/****************************************************************************** * $Id$ * * Copyright (c) 2005-2007 Transmission authors and contributors * * Permission is hereby granted, free of charge, to any person obtaining a * copy of this software and associated documentation files (the "Software"), * to deal in the Software without restriction, including without limitation * the rights to use, copy, modify, merge, publish, distribute, sublicense, * and/or sell copies of the Software, and to permit persons to whom the * Software is furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER * DEALINGS IN THE SOFTWARE. *****************************************************************************/ #ifndef TR_TRANSMISSION_H #define TR_TRANSMISSION_H 1 #ifdef __cplusplus extern "C" { #endif #include "version.h" #include #ifndef PRId64 # define PRId64 "lld" #endif #ifndef PRIu64 # define PRIu64 "llu" #endif #include #define SHA_DIGEST_LENGTH 20 #ifdef __BEOS__ # include # define MAX_PATH_LENGTH B_FILE_NAME_LENGTH #else # define MAX_PATH_LENGTH 1024 #endif #ifndef INET_ADDRSTRLEN #define INET_ADDRSTRLEN 16 #endif #if defined(__MINGW__) #define TR_PATH_DELIMITER '\\' #define TR_PATH_DELIMITER_STR "\\" #else #define TR_PATH_DELIMITER '/' #define TR_PATH_DELIMITER_STR "/" #endif #define TR_DEFAULT_PORT 9090 #define TR_PEER_FROM__MAX 4 #define TR_PEER_FROM_INCOMING 0 /* connections made to the listening port */ #define TR_PEER_FROM_TRACKER 1 /* peers received from a tracker */ #define TR_PEER_FROM_CACHE 2 /* peers read from the peer cache */ #define TR_PEER_FROM_PEX 3 /* peers discovered via PEX */ /*********************************************************************** * Error codes **********************************************************************/ /* General errors */ #define TR_OK 0x00000000 #define TR_ERROR 0x81000000 #define TR_ERROR_ASSERT 0x82000000 /* I/O errors */ #define TR_ERROR_IO_MASK 0x000000FF #define TR_ERROR_IO_PARENT ((1<<31) | (1<<0)) #define TR_ERROR_IO_PERMISSIONS ((1<<31) | (1<<1)) #define TR_ERROR_IO_SPACE ((1<<31) | (1<<2)) #define TR_ERROR_IO_FILE_TOO_BIG ((1<<31) | (1<<3)) #define TR_ERROR_IO_OPEN_FILES ((1<<31) | (1<<4)) #define TR_ERROR_IO_DUP_DOWNLOAD ((1<<31) | (1<<5)) #define TR_ERROR_IO_OTHER ((1<<31) | (1<<6)) /* Misc */ #define TR_ERROR_TC_MASK 0x00000F00 #define TR_ERROR_TC_ERROR 0x80000100 #define TR_ERROR_TC_WARNING 0x80000200 #define TR_ERROR_ISSET( num, code ) ( (code) == ( (code) & (num) ) ) /*********************************************************************** * tr_init *********************************************************************** * Initializes a libtransmission instance. Returns a obscure handle to * be passed to all functions below. The tag argument is a short string * unique to the program invoking tr_init(), it is currently used as * part of saved torrent files' names to prevent one frontend from * deleting a torrent used by another. The following tags are used: * beos cli daemon gtk macosx **********************************************************************/ typedef struct tr_handle_s tr_handle_t; tr_handle_t * tr_init( const char * tag ); typedef struct tr_tracker_info_s tr_tracker_info_t; /*********************************************************************** * tr_setMessageLevel *********************************************************************** * Set the level of messages to be output or queued **********************************************************************/ #define TR_MSG_ERR 1 #define TR_MSG_INF 2 #define TR_MSG_DBG 3 void tr_setMessageLevel( int ); int tr_getMessageLevel( void ); /*********************************************************************** * tr_setMessageQueuing *********************************************************************** * Enable or disable message queuing **********************************************************************/ typedef struct tr_msg_list_s tr_msg_list_t; void tr_setMessageQueuing( int ); /*********************************************************************** * tr_getQueuedMessages *********************************************************************** * Return a list of queued messages **********************************************************************/ tr_msg_list_t * tr_getQueuedMessages( void ); void tr_freeMessageList( tr_msg_list_t * list ); /*********************************************************************** * tr_getPrefsDirectory *********************************************************************** * Returns the full path to a directory which can be used to store * preferences. The string belongs to libtransmission, do not free it. **********************************************************************/ const char * tr_getPrefsDirectory( void ); /*********************************************************************** * tr_setBindPort *********************************************************************** * Sets the port to listen for incoming peer connections. * This can be safely called even with active torrents. **********************************************************************/ void tr_setBindPort( tr_handle_t *, int ); /*********************************************************************** * tr_natTraversalEnable * tr_natTraversalDisable *********************************************************************** * Enable or disable NAT traversal using NAT-PMP or UPnP IGD. **********************************************************************/ void tr_natTraversalEnable( tr_handle_t *, int enable ); /*********************************************************************** * tr_handleStatus *********************************************************************** * Returns some status info for the given handle. **********************************************************************/ typedef struct tr_handle_status_s tr_handle_status_t; tr_handle_status_t * tr_handleStatus( tr_handle_t * ); /*********************************************************************** * tr_setGlobalUploadLimit *********************************************************************** * Sets the total upload rate limit in KB/s **********************************************************************/ void tr_setGlobalUploadLimit( tr_handle_t *, int ); /*********************************************************************** * tr_setGlobalDownloadLimit *********************************************************************** * Sets the total download rate limit in KB/s **********************************************************************/ void tr_setGlobalDownloadLimit( tr_handle_t *, int ); /*********************************************************************** * tr_torrentCount *********************************************************************** * Returns the count of open torrents **********************************************************************/ int tr_torrentCount( tr_handle_t * h ); /*********************************************************************** * tr_torrentIterate *********************************************************************** * Iterates on open torrents **********************************************************************/ typedef struct tr_torrent_s tr_torrent_t; typedef void (*tr_callback_t) ( tr_torrent_t *, void * ); void tr_torrentIterate( tr_handle_t *, tr_callback_t, void * ); void tr_setUseCustomLimit( tr_torrent_t * tor, int limit ); void tr_setUploadLimit( tr_torrent_t * tor, int limit ); void tr_setDownloadLimit( tr_torrent_t * tor, int limit ); /*********************************************************************** * Torrent Priorities **********************************************************************/ enum { TR_PRI_LOW = -1, TR_PRI_NORMAL = 0, /* since NORMAL is 0, memset initializes nicely */ TR_PRI_HIGH = 1 }; typedef int8_t tr_priority_t; /* set a batch of files to a particular priority. */ void tr_torrentSetFilePriorities( tr_torrent_t * tor, int * files, int fileCount, tr_priority_t priority ); /* single-file form of tr_torrentPrioritizeFiles. * priority must be one of TR_PRI_NORMAL, _HIGH, or _LOW */ void tr_torrentSetFilePriority( tr_torrent_t *, int file, tr_priority_t priority ); /* returns a malloc()ed array of tor->info.fileCount items, * each holding a value of TR_PRI_NORMAL, _HIGH, or _LOW. free the array when done. */ tr_priority_t* tr_torrentGetFilePriorities( const tr_torrent_t * ); /* single-file form of tr_torrentGetFilePriorities. * returns one of TR_PRI_NORMAL, _HIGH, or _LOW. */ tr_priority_t tr_torrentGetFilePriority( const tr_torrent_t *, int file ); /* returns true if the file's `download' flag is set */ int tr_torrentGetFileDL( const tr_torrent_t *, int file ); /* set a batch of files to be downloaded or not. */ void tr_torrentSetFileDLs ( tr_torrent_t * tor, int * files, int fileCount, int do_download ); /* single-file form of tr_torrentSetFileDLs */ void tr_torrentSetFileDL( tr_torrent_t *, int file, int do_download ); typedef enum { TR_CP_INCOMPLETE, /* doesn't have all the desired pieces */ TR_CP_DONE, /* has all the pieces but the DND ones */ TR_CP_COMPLETE /* has every piece */ } cp_status_t; cp_status_t tr_torrentGetFileStatus( const tr_torrent_t * tor, int fileIndex ); /*********************************************************************** * tr_torrentRates *********************************************************************** * Gets the total download and upload rates **********************************************************************/ void tr_torrentRates( tr_handle_t *, float *, float * ); /*********************************************************************** * tr_close *********************************************************************** * Frees memory allocated by tr_init. **********************************************************************/ void tr_close( tr_handle_t * ); /*********************************************************************** * tr_torrentInit *********************************************************************** * Opens and parses torrent file at 'path'. If the file exists and is * a valid torrent file, returns an handle and adds it to the list of * torrents (but doesn't start it). Returns NULL and sets *error * otherwise. If hash is not NULL and the torrent is already loaded * then it's 20-byte hash will be copied in. If the TR_FLAG_SAVE flag * is passed then a copy of the torrent file will be saved. **********************************************************************/ #define TR_EINVALID 1 #define TR_EUNSUPPORTED 2 #define TR_EDUPLICATE 3 #define TR_EOTHER 666 tr_torrent_t * tr_torrentInit( tr_handle_t * handle, const char * metainfo_filename, const char * destination, int flags, int * setme_error ); typedef struct tr_info_s tr_info_t; /** * Parses the specified metainfo file. * * Returns TR_OK if it parsed and can be added to Transmission. * Returns TR_INVALID if it couldn't be parsed. * Returns TR_EDUPLICATE if it parsed but can't be added. * * "destination" can be NULL if you don't need to know whether * or not the torrent can be added. * " "setme_info" can be NULL if you don't need the information. * If the metainfo can be parsed and setme_info is non-NULL, * it will be filled with the metadata's info. You'll need to * call tr_metainfoFree( setme_info ) when done with it. */ int tr_torrentParse( const tr_handle_t * handle, const char * metainfo_filename, const char * destination, tr_info_t * setme_info ); /** * Parses the cached metainfo file that matches the given hash string. * See tr_torrentParse() for a description of the arguments */ int tr_torrentParseHash( const tr_handle_t * h, const char * hashStr, const char * destination, tr_info_t * setme_info ); /*********************************************************************** * tr_torrentInitData *********************************************************************** * Like tr_torrentInit, except the actual torrent data is passed in * instead of the filename. **********************************************************************/ tr_torrent_t * tr_torrentInitData( tr_handle_t *, const uint8_t * data, size_t size, const char * destination, int flags, int * error ); /*********************************************************************** * tr_torrentInitSaved *********************************************************************** * Opens and parses a torrent file as with tr_torrentInit, only taking * the hash string of a saved torrent file instead of a filename. There * are currently no valid flags for this function. **********************************************************************/ tr_torrent_t * tr_torrentInitSaved( tr_handle_t *, const char * hashStr, const char * destination, int flags, int * error ); /*********************************************************************** * tr_torrentDisablePex *********************************************************************** * Disable or enable peer exchange for this torrent. Peer exchange is * enabled by default, except for private torrents where pex is * disabled and cannot be enabled. **********************************************************************/ void tr_torrentDisablePex( tr_torrent_t *, int disable ); /*********************************************************************** * tr_torrentScrape *********************************************************************** * Return torrent metainfo. **********************************************************************/ const tr_info_t * tr_torrentInfo( const tr_torrent_t * ); /*********************************************************************** * tr_torrentScrape *********************************************************************** * Asks the tracker for the count of seeders and leechers. Returns 0 * and fills 's' and 'l' if successful. Otherwise returns 1 if the * tracker doesn't support the scrape protocol, is unreachable or * replied with some error. tr_torrentScrape may block up to 20 seconds * before returning. **********************************************************************/ int tr_torrentScrape( tr_torrent_t *, int * s, int * l, int * d ); void tr_torrentSetFolder( tr_torrent_t *, const char * ); const char * tr_torrentGetFolder( const tr_torrent_t * ); /*********************************************************************** * tr_torrentStart *********************************************************************** * Starts downloading. The download is launched in a seperate thread, * therefore tr_torrentStart returns immediately. **********************************************************************/ void tr_torrentStart( tr_torrent_t * ); /*********************************************************************** * tr_torrentStop *********************************************************************** * Stops downloading and notices the tracker that we are leaving. The * thread keeps running while doing so. * The thread will eventually be joined, either: * - by tr_torrentStat when the tracker has been successfully noticed, * - by tr_torrentStat if the tracker could not be noticed within 60s, * - by tr_torrentClose if you choose to remove the torrent without * waiting any further. **********************************************************************/ void tr_torrentStop( tr_torrent_t * ); /*********************************************************************** * tr_getComplete, tr_getIncomplete and tr_getPartial *********************************************************************** * The first call after a torrent changed state returns 1. Returns 0 * in other cases. **********************************************************************/ int tr_getIncomplete( tr_torrent_t * tor ); int tr_getDone( tr_torrent_t * tor ); int tr_getComplete( tr_torrent_t * tor ); /*********************************************************************** * tr_manualUpdate *********************************************************************** * Reannounce to tracker regardless of wait interval **********************************************************************/ void tr_manualUpdate( tr_torrent_t * ); /*********************************************************************** * tr_torrentStat *********************************************************************** * Returns a pointer to an tr_stat_t structure with updated information * on the torrent. The structure belongs to libtransmission (do not * free it) and is guaranteed to be unchanged until the next call to * tr_torrentStat. * The interface should call this function every second or so in order * to update itself. **********************************************************************/ typedef struct tr_stat_s tr_stat_t; tr_stat_t * tr_torrentStat( tr_torrent_t * ); /*********************************************************************** * tr_torrentPeers ***********************************************************************/ typedef struct tr_peer_stat_s tr_peer_stat_t; tr_peer_stat_t * tr_torrentPeers( const tr_torrent_t *, int * peerCount ); void tr_torrentPeersFree( tr_peer_stat_t *, int peerCount ); /*********************************************************************** * tr_torrentAvailability *********************************************************************** * Use this to draw an advanced progress bar which is 'size' pixels * wide. Fills 'tab' which you must have allocated: each byte is set * to either -1 if we have the piece, otherwise it is set to the number * of connected peers who have the piece. **********************************************************************/ void tr_torrentAvailability( const tr_torrent_t *, int8_t * tab, int size ); void tr_torrentAmountFinished( const tr_torrent_t * tor, float * tab, int size ); /*********************************************************************** * tr_torrentCompletion *********************************************************************** * Returns the completion progress for each file in the torrent as an * array of floats the same size and order as in tr_info_t. Free the * array when done. **********************************************************************/ float * tr_torrentCompletion( const tr_torrent_t * ); float tr_torrentFileCompletion( const tr_torrent_t *, int fileIndex ); uint64_t tr_torrentFileBytesCompleted( const tr_torrent_t *, int fileIndex ); /*********************************************************************** * tr_torrentRemoveSaved *********************************************************************** * Removes the saved copy of a torrent file for torrents which the * TR_FLAG_SAVE flag is set. **********************************************************************/ void tr_torrentRemoveSaved( tr_torrent_t * ); void tr_torrentRecheck( tr_torrent_t * ); /*********************************************************************** * tr_torrentClose *********************************************************************** * Frees memory allocated by tr_torrentInit. If the torrent was running, * it is stopped first. **********************************************************************/ void tr_torrentClose( tr_torrent_t * ); /*********************************************************************** * tr_info_s **********************************************************************/ typedef struct tr_file_s { uint64_t length; /* Length of the file, in bytes */ char name[MAX_PATH_LENGTH]; /* Path to the file */ int8_t priority; /* TR_PRI_HIGH, _NORMAL, or _LOW */ int8_t dnd; /* nonzero if the file shouldn't be downloaded */ int firstPiece; /* We need pieces [firstPiece... */ int lastPiece; /* ...lastPiece] to dl this file */ uint64_t offset; /* file begins at the torrent's nth byte */ } tr_file_t; typedef struct tr_piece_s { uint8_t hash[SHA_DIGEST_LENGTH]; /* pieces hash */ int8_t priority; /* TR_PRI_HIGH, _NORMAL, or _LOW */ int8_t dnd; /* nonzero if the piece shouldn't be downloaded */ } tr_piece_t; struct tr_info_s { /* Path to torrent */ char torrent[MAX_PATH_LENGTH]; /* General info */ uint8_t hash[SHA_DIGEST_LENGTH]; char hashString[2*SHA_DIGEST_LENGTH+1]; char name[MAX_PATH_LENGTH]; /* Flags */ #define TR_FLAG_SAVE 0x01 /* save a copy of the torrent file */ #define TR_FLAG_PRIVATE 0x02 /* do not share information for this torrent */ #define TR_FLAG_PAUSED 0x04 /* don't start the torrent when adding it */ int flags; /* Tracker info */ struct { tr_tracker_info_t * list; int count; } * trackerList; int trackerTiers; /* Torrent info */ char comment[MAX_PATH_LENGTH]; char creator[MAX_PATH_LENGTH]; int dateCreated; /* Pieces info */ int pieceSize; int pieceCount; uint64_t totalSize; tr_piece_t * pieces; /* Files info */ int multifile; int fileCount; tr_file_t * files; }; typedef enum { TR_STATUS_CHECK_WAIT = (1<<0), /* Waiting in queue to check files */ TR_STATUS_CHECK = (1<<1), /* Checking files */ TR_STATUS_DOWNLOAD = (1<<2), /* Downloading */ TR_STATUS_DONE = (1<<3), /* not at 100% so can't tell the tracker we're a seeder, but due to DND files there's nothing we want right now */ TR_STATUS_SEED = (1<<4), /* Seeding */ TR_STATUS_STOPPING = (1<<5), /* Stopping -- closing connections, etc. */ TR_STATUS_STOPPED = (1<<6) /* Torrent is stopped */ } torrent_status_t; #define TR_STATUS_ACTIVE \ (TR_STATUS_CHECK_WAIT|TR_STATUS_CHECK|TR_STATUS_DOWNLOAD|TR_STATUS_DONE|TR_STATUS_SEED) #define TR_STATUS_INACTIVE \ (TR_STATUS_STOPPING|TR_STATUS_STOPPED) /*********************************************************************** * tr_stat_s **********************************************************************/ struct tr_stat_s { torrent_status_t status; cp_status_t cpStatus; int error; char errorString[128]; int cannotConnect; const tr_tracker_info_t * tracker; float percentComplete; float percentDone; float rateDownload; float rateUpload; int eta; int peersTotal; int peersFrom[TR_PEER_FROM__MAX]; int peersUploading; int peersDownloading; int seeders; int leechers; int completedFromTracker; uint64_t left; uint64_t downloaded; uint64_t downloadedValid; uint64_t uploaded; float swarmspeed; #define TR_RATIO_NA -1 float ratio; uint64_t startDate; uint64_t activityDate; }; struct tr_peer_stat_s { char addr[INET_ADDRSTRLEN]; const char * client; int isConnected; int from; float progress; int port; int isDownloading; int isUploading; float downloadFromRate; float uploadToRate; }; struct tr_msg_list_s { int level; time_t when; char * message; struct tr_msg_list_s * next; }; struct tr_tracker_info_s { char * address; int port; char * announce; char * scrape; }; struct tr_handle_status_s { #define TR_NAT_TRAVERSAL_MAPPING 1 #define TR_NAT_TRAVERSAL_MAPPED 2 #define TR_NAT_TRAVERSAL_NOTFOUND 3 #define TR_NAT_TRAVERSAL_ERROR 4 #define TR_NAT_TRAVERSAL_UNMAPPING 5 #define TR_NAT_TRAVERSAL_DISABLED 6 #define TR_NAT_TRAVERSAL_IS_DISABLED( st ) \ ( TR_NAT_TRAVERSAL_DISABLED == (st) || TR_NAT_TRAVERSAL_UNMAPPING == (st) ) int natTraversalStatus; int publicPort; }; #ifdef __TRANSMISSION__ # include "internal.h" #endif #ifdef __cplusplus } #endif #endif