source: trunk/libtransmission/transmission.h @ 9591

Last change on this file since 9591 was 9591, checked in by charles, 12 years ago

(trunk libT) #2096 "magnet links" -- add a callback for clients to know when a magnet torrent's metainfo is finished downloading.

  • Property svn:keywords set to Date Rev Author Id
File size: 60.2 KB
Line 
1/******************************************************************************
2 * $Id: transmission.h 9591 2009-11-26 17:58:44Z charles $
3 *
4 * Copyright (c) 2005-2008 Transmission authors and contributors
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the "Software"),
8 * to deal in the Software without restriction, including without limitation
9 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 * and/or sell copies of the Software, and to permit persons to whom the
11 * Software is furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 * DEALINGS IN THE SOFTWARE.
23 *****************************************************************************/
24
25/*
26 * This file defines the public API for the libtransmission library.
27 *
28 * Other headers with a public API are bencode.h and utils.h.
29 * Most of the remaining headers in libtransmission are private.
30 */
31#ifndef TR_TRANSMISSION_H
32#define TR_TRANSMISSION_H 1
33
34#ifdef __cplusplus
35extern "C" {
36#endif
37
38/***
39****
40****  Basic Types
41****
42***/
43
44#include <inttypes.h> /* uintN_t */
45#include <time.h> /* time_t */
46
47#ifndef PRId64
48 #define PRId64 "lld"
49#endif
50#ifndef PRIu64
51 #define PRIu64 "llu"
52#endif
53#ifndef PRIu32
54 #define PRIu32 "lu"
55#endif
56
57#if defined(WIN32) && defined(_MSC_VER)
58 #define TR_INLINE __inline
59#else
60 #define TR_INLINE inline
61#endif
62
63#define SHA_DIGEST_LENGTH 20
64#define TR_INET6_ADDRSTRLEN 46
65
66typedef uint32_t tr_file_index_t;
67typedef uint32_t tr_piece_index_t;
68typedef uint64_t tr_block_index_t;
69typedef uint16_t tr_port;
70typedef uint8_t tr_bool;
71
72typedef struct tr_ctor tr_ctor;
73typedef struct tr_info tr_info;
74typedef struct tr_torrent tr_torrent;
75typedef struct tr_session tr_session;
76
77struct tr_benc;
78
79typedef int8_t tr_priority_t;
80
81#define TR_RPC_SESSION_ID_HEADER "X-Transmission-Session-Id"
82
83typedef enum
84{
85    TR_PREALLOCATE_NONE   = 0,
86    TR_PREALLOCATE_SPARSE = 1,
87    TR_PREALLOCATE_FULL   = 2
88}
89tr_preallocation_mode;
90
91typedef enum
92{
93    TR_PROXY_HTTP,
94    TR_PROXY_SOCKS4,
95    TR_PROXY_SOCKS5
96}
97tr_proxy_type;
98
99typedef enum
100{
101    TR_CLEAR_PREFERRED,
102    TR_ENCRYPTION_PREFERRED,
103    TR_ENCRYPTION_REQUIRED
104}
105tr_encryption_mode;
106
107
108/***
109****
110****  Startup & Shutdown
111****
112***/
113
114/**
115 * @addtogroup tr_session Session
116 *
117 * A libtransmission session is created by calling tr_sessionInit().
118 * libtransmission creates a thread for itself so that it can operate
119 * independently of the caller's event loop.  The session will continue
120 * until tr_sessionClose() is called.
121 *
122 * @{
123 */
124
125/**
126 * @brief returns Transmission's default configuration file directory.
127 *
128 * The default configuration directory is determined this way:
129 * -# If the TRANSMISSION_HOME environment variable is set, its value is used.
130 * -# On Darwin, "${HOME}/Library/Application Support/${appname}" is used.
131 * -# On Windows, "${CSIDL_APPDATA}/${appname}" is used.
132 * -# If XDG_CONFIG_HOME is set, "${XDG_CONFIG_HOME}/${appname}" is used.
133 * -# ${HOME}/.config/${appname}" is used as a last resort.
134 */
135const char* tr_getDefaultConfigDir( const char * appname );
136
137/**
138 * @brief returns Transmisson's default download directory.
139 *
140 * The default download directory is determined this way:
141 * -# If the HOME environment variable is set, "${HOME}/Downloads" is used.
142 * -# On Windows, "${CSIDL_MYDOCUMENTS}/Downloads" is used.
143 * -# Otherwise, getpwuid(getuid())->pw_dir + "/Downloads" is used.
144 */
145const char* tr_getDefaultDownloadDir( void );
146
147
148#define TR_DEFAULT_BIND_ADDRESS_IPV4       "0.0.0.0"
149#define TR_DEFAULT_BIND_ADDRESS_IPV6            "::"
150#define TR_DEFAULT_OPEN_FILE_LIMIT_STR          "32"
151#define TR_DEFAULT_RPC_WHITELIST         "127.0.0.1"
152#define TR_DEFAULT_RPC_PORT_STR               "9091"
153#define TR_DEFAULT_PEER_PORT_STR             "51413"
154#define TR_DEFAULT_PEER_SOCKET_TOS_STR           "0"
155#define TR_DEFAULT_PEER_LIMIT_GLOBAL_STR       "240"
156#define TR_DEFAULT_PEER_LIMIT_TORRENT_STR       "60"
157
158#define TR_PREFS_KEY_ALT_SPEED_ENABLED          "alt-speed-enabled"
159#define TR_PREFS_KEY_ALT_SPEED_UP               "alt-speed-up"
160#define TR_PREFS_KEY_ALT_SPEED_DOWN             "alt-speed-down"
161#define TR_PREFS_KEY_ALT_SPEED_TIME_BEGIN       "alt-speed-time-begin"
162#define TR_PREFS_KEY_ALT_SPEED_TIME_ENABLED     "alt-speed-time-enabled"
163#define TR_PREFS_KEY_ALT_SPEED_TIME_END         "alt-speed-time-end"
164#define TR_PREFS_KEY_ALT_SPEED_TIME_DAY         "alt-speed-time-day"
165#define TR_PREFS_KEY_BIND_ADDRESS_IPV4          "bind-address-ipv4"
166#define TR_PREFS_KEY_BIND_ADDRESS_IPV6          "bind-address-ipv6"
167#define TR_PREFS_KEY_BLOCKLIST_ENABLED          "blocklist-enabled"
168#define TR_PREFS_KEY_DHT_ENABLED                "dht-enabled"
169#define TR_PREFS_KEY_DOWNLOAD_DIR               "download-dir"
170#define TR_PREFS_KEY_ENCRYPTION                 "encryption"
171#define TR_PREFS_KEY_INCOMPLETE_DIR             "incomplete-dir"
172#define TR_PREFS_KEY_INCOMPLETE_DIR_ENABLED     "incomplete-dir-enabled"
173#define TR_PREFS_KEY_LAZY_BITFIELD              "lazy-bitfield-enabled"
174#define TR_PREFS_KEY_MSGLEVEL                   "message-level"
175#define TR_PREFS_KEY_OPEN_FILE_LIMIT            "open-file-limit"
176#define TR_PREFS_KEY_PEER_LIMIT_GLOBAL          "peer-limit-global"
177#define TR_PREFS_KEY_PEER_LIMIT_TORRENT         "peer-limit-per-torrent"
178#define TR_PREFS_KEY_PEER_PORT                  "peer-port"
179#define TR_PREFS_KEY_PEER_PORT_RANDOM_ON_START  "peer-port-random-on-start"
180#define TR_PREFS_KEY_PEER_PORT_RANDOM_LOW       "peer-port-random-low"
181#define TR_PREFS_KEY_PEER_PORT_RANDOM_HIGH      "peer-port-random-high"
182#define TR_PREFS_KEY_PEER_SOCKET_TOS            "peer-socket-tos"
183#define TR_PREFS_KEY_PEX_ENABLED                "pex-enabled"
184#define TR_PREFS_KEY_PORT_FORWARDING            "port-forwarding-enabled"
185#define TR_PREFS_KEY_PROXY_AUTH_ENABLED         "proxy-auth-enabled"
186#define TR_PREFS_KEY_PREALLOCATION              "preallocation"
187#define TR_PREFS_KEY_PROXY_ENABLED              "proxy-enabled"
188#define TR_PREFS_KEY_PROXY_PASSWORD             "proxy-auth-password"
189#define TR_PREFS_KEY_PROXY_PORT                 "proxy-port"
190#define TR_PREFS_KEY_PROXY                      "proxy"
191#define TR_PREFS_KEY_PROXY_TYPE                 "proxy-type"
192#define TR_PREFS_KEY_PROXY_USERNAME             "proxy-auth-username"
193#define TR_PREFS_KEY_RATIO                      "ratio-limit"
194#define TR_PREFS_KEY_RATIO_ENABLED              "ratio-limit-enabled"
195#define TR_PREFS_KEY_RENAME_PARTIAL_FILES       "rename-partial-files"
196#define TR_PREFS_KEY_RPC_AUTH_REQUIRED          "rpc-authentication-required"
197#define TR_PREFS_KEY_RPC_BIND_ADDRESS           "rpc-bind-address"
198#define TR_PREFS_KEY_RPC_ENABLED                "rpc-enabled"
199#define TR_PREFS_KEY_RPC_PASSWORD               "rpc-password"
200#define TR_PREFS_KEY_RPC_PORT                   "rpc-port"
201#define TR_PREFS_KEY_RPC_USERNAME               "rpc-username"
202#define TR_PREFS_KEY_RPC_WHITELIST_ENABLED      "rpc-whitelist-enabled"
203#define TR_PREFS_KEY_RPC_WHITELIST              "rpc-whitelist"
204#define TR_PREFS_KEY_DSPEED                     "speed-limit-down"
205#define TR_PREFS_KEY_DSPEED_ENABLED             "speed-limit-down-enabled"
206#define TR_PREFS_KEY_USPEED_ENABLED             "speed-limit-up-enabled"
207#define TR_PREFS_KEY_USPEED                     "speed-limit-up"
208#define TR_PREFS_KEY_UMASK                      "umask"
209#define TR_PREFS_KEY_UPLOAD_SLOTS_PER_TORRENT   "upload-slots-per-torrent"
210
211
212/**
213 * Add libtransmission's default settings to the benc dictionary.
214 *
215 * Example:
216 * @code
217 *     tr_benc settings;
218 *     int64_t i;
219 *
220 *     tr_bencInitDict( &settings, 0 );
221 *     tr_sessionGetDefaultSettings( &settings );
222 *     if( tr_bencDictFindInt( &settings, TR_PREFS_KEY_PEER_PORT, &i ) )
223 *         fprintf( stderr, "the default peer port is %d\n", (int)i );
224 *     tr_bencFree( &settings );
225 * @endcode
226 *
227 * @param initme pointer to a tr_benc dictionary
228 * @see tr_sessionLoadSettings()
229 * @see tr_sessionInit()
230 * @see tr_getDefaultConfigDir()
231 */
232void tr_sessionGetDefaultSettings( const char * configDir, struct tr_benc * dictionary );
233
234/**
235 * Add the session's current configuration settings to the benc dictionary.
236 *
237 * FIXME: this probably belongs in libtransmissionapp
238 *
239 * @param session
240 * @param dictionary
241 * @see tr_sessionGetDefaultSettings()
242 */
243void tr_sessionGetSettings( tr_session *, struct tr_benc * dictionary );
244
245/**
246 * Load settings from the configuration directory's settings.json file,
247 * using libtransmission's default settings as fallbacks for missing keys.
248 *
249 * FIXME: this belongs in libtransmissionapp
250 *
251 * @param dictionary pointer to an uninitialized tr_benc
252 * @param configDir the configuration directory to find settings.json
253 * @param appName if configDir is empty, appName is used to find the default dir.
254 * @see tr_sessionGetDefaultSettings()
255 * @see tr_sessionInit()
256 * @see tr_sessionSaveSettings()
257 */
258void tr_sessionLoadSettings( struct tr_benc  * dictionary,
259                             const char      * configDir,
260                             const char      * appName );
261
262/**
263 * Add the session's configuration settings to the benc dictionary
264 * and save it to the configuration directory's settings.json file.
265 *
266 * FIXME: this belongs in libtransmissionapp
267 *
268 * @param session
269 * @param dictionary
270 * @see tr_sessionLoadSettings()
271 */
272void tr_sessionSaveSettings( tr_session           * session,
273                             const char           * configDir,
274                             const struct tr_benc * dictonary );
275
276/**
277 * @brief Initialize a libtransmission session.
278 *
279 * For example, this will instantiate a session with all the default values:
280 * @code
281 *     tr_benc settings;
282 *     tr_session * session;
283 *     const char * configDir;
284 *
285 *     tr_bencInitDict( &settings, 0 );
286 *     tr_sessionGetDefaultSettings( &settings );
287 *     configDir = tr_getDefaultConfigDir( "Transmission" );
288 *     session = tr_sessionInit( "mac", configDir, true, &settings );
289 *
290 *     tr_bencFree( &settings );
291 * @endcode
292 *
293 * @param tag "gtk", "macosx", "daemon", etc... this is only for pre-1.30 resume files
294 * @param configDir where Transmission will look for resume files, blocklists, etc.
295 * @param messageQueueingEnabled if false, messages will be dumped to stderr
296 * @param settings libtransmission settings
297 * @see tr_sessionGetDefaultSettings()
298 * @see tr_sessionLoadSettings()
299 * @see tr_getDefaultConfigDir()
300 */
301tr_session * tr_sessionInit( const char     * tag,
302                             const char     * configDir,
303                             tr_bool          messageQueueingEnabled,
304                             struct tr_benc * settings );
305
306void tr_sessionSet( tr_session      * session,
307                    struct tr_benc  * settings );
308
309/** @brief End a libtransmission session
310    @see tr_sessionInit() */
311void tr_sessionClose( tr_session * );
312
313/**
314 * @brief Return the session's configuration directory.
315 *
316 * This is where transmission stores its .torrent files, .resume files,
317 * blocklists, etc.  It's set in tr_transmissionInit() and is immutable
318 * during the session.
319 */
320const char * tr_sessionGetConfigDir( const tr_session * );
321
322/**
323 * @brief Set the per-session default download folder for new torrents.
324 * @see tr_sessionInit()
325 * @see tr_sessionGetDownloadDir()
326 * @see tr_ctorSetDownloadDir()
327 */
328void tr_sessionSetDownloadDir( tr_session * session, const char * downloadDir );
329
330/**
331 * @brief Get the default download folder for new torrents.
332 *
333 * This is set by tr_sessionInit() or tr_sessionSetDownloadDir(),
334 * and can be overridden on a per-torrent basis by tr_ctorSetDownloadDir().
335 */
336const char * tr_sessionGetDownloadDir( const tr_session * session );
337
338/**
339 * @brief Set the per-session incomplete download folder.
340 *
341 * When you add a new torrent and the session's incomplete directory is enabled,
342 * the new torrent will start downloading into that directory, and then be moved
343 * to tr_torrent.downloadDir when the torrent is finished downloading.
344 *
345 * Torrents are not moved as a result of changing the session's incomplete dir --
346 * it's applied to new torrents, not existing ones.
347 *
348 * tr_torrentSetLocation() overrules the incomplete dir: when a user specifies
349 * a new location, that becomes the torrent's new downloadDir and the torrent
350 * is moved there immediately regardless of whether or not it's complete.
351 *
352 * @see tr_sessionInit()
353 * @see tr_sessionGetIncompleteDir()
354 * @see tr_sessionSetIncompleteDirEnabled()
355 * @see tr_sessionGetIncompleteDirEnabled()
356 */
357void tr_sessionSetIncompleteDir( tr_session * session, const char * dir );
358
359const char* tr_sessionGetIncompleteDir( const tr_session * session );
360
361void tr_sessionSetIncompleteDirEnabled( tr_session * session, tr_bool );
362
363tr_bool tr_sessionIsIncompleteDirEnabled( const tr_session * session );
364
365
366/**
367 * @brief When enabled, newly-created files will have ".part" appended
368 *        to their filename until the file is fully downloaded
369 *
370 * This is not retroactive -- toggling this will not rename existing files.
371 * It only applies to new files created by Transmission after this API call.
372 *
373 * @see tr_sessionIsIncompleteFileNamingEnabled()
374 */
375void tr_sessionSetIncompleteFileNamingEnabled( tr_session * session, tr_bool );
376
377tr_bool tr_sessionIsIncompleteFileNamingEnabled( const tr_session * session );
378
379/**
380 * @brief Set whether or not RPC calls are allowed in this session.
381 *
382 * @details If true, libtransmission will open a server socket to listen
383 * for incoming http RPC requests as described in docs/rpc-spec.txt.
384 *
385 * This is intially set by tr_sessionInit() and can be
386 * queried by tr_sessionIsRPCEnabled().
387 */
388void tr_sessionSetRPCEnabled( tr_session  * session,
389                              tr_bool       isEnabled );
390
391/** @brief Get whether or not RPC calls are allowed in this session.
392    @see tr_sessionInit()
393    @see tr_sessionSetRPCEnabled() */
394tr_bool tr_sessionIsRPCEnabled( const tr_session * session );
395
396/** @brief Specify which port to listen for RPC requests on.
397    @see tr_sessionInit()
398    @see tr_sessionGetRPCPort */
399void tr_sessionSetRPCPort( tr_session  * session,
400                           tr_port       port );
401
402/** @brief Get which port to listen for RPC requests on.
403    @see tr_sessionInit()
404    @see tr_sessionSetRPCPort */
405tr_port tr_sessionGetRPCPort( const tr_session * session );
406
407/**
408 * @brief Specify a whitelist for remote RPC access
409 *
410 * The whitelist is a comma-separated list of dotted-quad IP addresses
411 * to be allowed.  Wildmat notation is supported, meaning that
412 * '?' is interpreted as a single-character wildcard and
413 * '*' is interprted as a multi-character wildcard.
414 */
415void   tr_sessionSetRPCWhitelist( tr_session * session,
416                                  const char * whitelist );
417
418/** @brief get the Access Control List for allowing/denying RPC requests.
419    @return a comma-separated string of whitelist domains.
420    @see tr_sessionInit
421    @see tr_sessionSetRPCWhitelist */
422const char* tr_sessionGetRPCWhitelist( const tr_session * );
423
424void  tr_sessionSetRPCWhitelistEnabled( tr_session * session,
425                                        tr_bool      isEnabled );
426
427tr_bool tr_sessionGetRPCWhitelistEnabled( const tr_session * session );
428
429void  tr_sessionSetRPCPassword( tr_session * session,
430                                const char * password );
431
432void  tr_sessionSetRPCUsername( tr_session * session,
433                                const char * username );
434
435/** @brief get the password used to restrict RPC requests.
436    @return the password string.
437    @see tr_sessionInit()
438    @see tr_sessionSetRPCPassword() */
439const char* tr_sessionGetRPCPassword( const tr_session * session );
440
441const char* tr_sessionGetRPCUsername( const tr_session * session  );
442
443void  tr_sessionSetRPCPasswordEnabled( tr_session * session,
444                                       tr_bool      isEnabled );
445
446tr_bool tr_sessionIsRPCPasswordEnabled( const tr_session * session );
447
448const char* tr_sessionGetRPCBindAddress( const tr_session * session );
449
450
451typedef enum
452{
453    TR_RPC_TORRENT_ADDED,
454    TR_RPC_TORRENT_STARTED,
455    TR_RPC_TORRENT_STOPPED,
456    TR_RPC_TORRENT_REMOVING,
457    TR_RPC_TORRENT_CHANGED, /* catch-all for the "torrent-set" rpc method */
458    TR_RPC_TORRENT_MOVED,
459    TR_RPC_SESSION_CHANGED
460}
461tr_rpc_callback_type;
462
463typedef enum
464{
465    /* no special handling is needed by the caller */
466    TR_RPC_OK            = 0,
467
468    /* indicates to the caller that the client will take care of
469     * removing the torrent itself.  For example the client may
470     * need to keep the torrent alive long enough to cleanly close
471     * some resources in another thread. */
472    TR_RPC_NOREMOVE   = ( 1 << 1 )
473}
474tr_rpc_callback_status;
475
476typedef tr_rpc_callback_status (*tr_rpc_func)(tr_session          * session,
477                                              tr_rpc_callback_type  type,
478                                              struct tr_torrent   * tor_or_null,
479                                              void                * user_data );
480
481/**
482 * Register to be notified whenever something is changed via RPC,
483 * such as a torrent being added, removed, started, stopped, etc.
484 *
485 * func is invoked FROM LIBTRANSMISSION'S THREAD!
486 * This means func must be fast (to avoid blocking peers),
487 * shouldn't call libtransmission functions (to avoid deadlock),
488 * and shouldn't modify client-level memory without using a mutex!
489 */
490void tr_sessionSetRPCCallback( tr_session   * session,
491                               tr_rpc_func    func,
492                               void         * user_data );
493
494/**
495***
496**/
497
498tr_bool       tr_sessionIsProxyEnabled( const tr_session * );
499
500tr_bool       tr_sessionIsProxyAuthEnabled( const tr_session * );
501
502const char*   tr_sessionGetProxy( const tr_session * );
503
504tr_port       tr_sessionGetProxyPort( const tr_session * );
505
506tr_proxy_type tr_sessionGetProxyType( const tr_session * );
507
508const char*   tr_sessionGetProxyUsername( const tr_session * );
509
510const char*   tr_sessionGetProxyPassword( const tr_session * );
511
512void          tr_sessionSetProxyEnabled( tr_session * session,
513                                         tr_bool      isEnabled );
514
515void          tr_sessionSetProxyAuthEnabled( tr_session * session,
516                                             tr_bool      isEnabled );
517
518void          tr_sessionSetProxy( tr_session * session,
519                                  const char * proxy );
520
521void          tr_sessionSetProxyPort( tr_session * session,
522                                      tr_port      port );
523
524void          tr_sessionSetProxyType( tr_session    * session,
525                                      tr_proxy_type   proxy_type );
526
527void          tr_sessionSetProxyUsername( tr_session * session,
528                                          const char * username );
529
530void          tr_sessionSetProxyPassword( tr_session * session,
531                                          const char * password );
532
533/**
534***
535**/
536
537typedef struct tr_session_stats
538{
539    float       ratio;        /* TR_RATIO_INF, TR_RATIO_NA, or total up/down */
540    uint64_t    uploadedBytes; /* total up */
541    uint64_t    downloadedBytes; /* total down */
542    uint64_t    filesAdded;   /* number of files added */
543    uint64_t    sessionCount; /* program started N times */
544    uint64_t    secondsActive; /* how long Transmisson's been running */
545}
546tr_session_stats;
547
548/* stats from the current session. */
549void               tr_sessionGetStats( const tr_session * session,
550                                       tr_session_stats * setme );
551
552/* stats from the current and past sessions. */
553void               tr_sessionGetCumulativeStats( const tr_session * session,
554                                                 tr_session_stats * setme );
555
556void               tr_sessionClearStats( tr_session * session );
557
558/**
559 * Set whether or not torrents are allowed to do peer exchanges.
560 * PEX is always disabled in private torrents regardless of this.
561 * In public torrents, PEX is enabled by default.
562 */
563void               tr_sessionSetPexEnabled( tr_session  * session,
564                                            tr_bool       isEnabled );
565
566tr_bool            tr_sessionIsPexEnabled( const tr_session * session );
567
568tr_bool            tr_sessionIsDHTEnabled( const tr_session * session );
569
570void               tr_sessionSetDHTEnabled( tr_session * session, tr_bool );
571
572void               tr_sessionSetLazyBitfieldEnabled( tr_session * session,
573                                                     tr_bool       enabled );
574
575tr_bool            tr_sessionIsLazyBitfieldEnabled( const tr_session * session );
576
577tr_encryption_mode tr_sessionGetEncryption( tr_session * session );
578
579void               tr_sessionSetEncryption( tr_session          * session,
580                                            tr_encryption_mode    mode );
581
582
583/***********************************************************************
584** Incoming Peer Connections Port
585*/
586
587void  tr_sessionSetPortForwardingEnabled( tr_session  * session,
588                                          tr_bool       enabled );
589
590tr_bool tr_sessionIsPortForwardingEnabled( const tr_session  * session );
591
592void  tr_sessionSetPeerPort( tr_session  * session,
593                             tr_port       port);
594
595tr_port tr_sessionGetPeerPort( const tr_session * session );
596
597tr_port tr_sessionSetPeerPortRandom( tr_session  * session );
598
599void  tr_sessionSetPeerPortRandomOnStart( tr_session * session,
600                                          tr_bool random );
601
602tr_bool  tr_sessionGetPeerPortRandomOnStart( tr_session * session );
603
604typedef enum
605{
606    TR_PORT_ERROR,
607    TR_PORT_UNMAPPED,
608    TR_PORT_UNMAPPING,
609    TR_PORT_MAPPING,
610    TR_PORT_MAPPED
611}
612tr_port_forwarding;
613
614tr_port_forwarding tr_sessionGetPortForwarding( const tr_session * session );
615
616int tr_sessionCountTorrents( const tr_session * session );
617
618typedef enum
619{
620    TR_CLIENT_TO_PEER = 0, TR_UP = 0,
621    TR_PEER_TO_CLIENT = 1, TR_DOWN = 1
622}
623tr_direction;
624
625/***
626****
627***/
628
629/***
630****  Primary session speed limits
631***/
632
633void     tr_sessionSetSpeedLimit      ( tr_session *, tr_direction, int KB_s );
634int      tr_sessionGetSpeedLimit      ( const tr_session *, tr_direction );
635
636void     tr_sessionLimitSpeed         ( tr_session *, tr_direction, tr_bool );
637tr_bool  tr_sessionIsSpeedLimited     ( const tr_session *, tr_direction );
638
639
640/***
641****  Alternative speed limits that are used during scheduled times
642***/
643
644void     tr_sessionSetAltSpeed        ( tr_session *, tr_direction, int KB_s );
645int      tr_sessionGetAltSpeed        ( const tr_session *, tr_direction );
646
647void     tr_sessionUseAltSpeed        ( tr_session *, tr_bool );
648tr_bool  tr_sessionUsesAltSpeed       ( const tr_session * );
649
650void     tr_sessionUseAltSpeedTime    ( tr_session *, tr_bool );
651tr_bool  tr_sessionUsesAltSpeedTime   ( const tr_session * );
652
653void     tr_sessionSetAltSpeedBegin   ( tr_session *, int minsSinceMidnight );
654int      tr_sessionGetAltSpeedBegin   ( const tr_session * );
655
656void     tr_sessionSetAltSpeedEnd     ( tr_session *, int minsSinceMidnight );
657int      tr_sessionGetAltSpeedEnd     ( const tr_session * );
658
659typedef enum
660{
661    TR_SCHED_SUN      = (1<<0),
662    TR_SCHED_MON      = (1<<1),
663    TR_SCHED_TUES     = (1<<2),
664    TR_SCHED_WED      = (1<<3),
665    TR_SCHED_THURS    = (1<<4),
666    TR_SCHED_FRI      = (1<<5),
667    TR_SCHED_SAT      = (1<<6),
668    TR_SCHED_WEEKDAY  = (TR_SCHED_MON|TR_SCHED_TUES|TR_SCHED_WED|TR_SCHED_THURS|TR_SCHED_FRI),
669    TR_SCHED_WEEKEND  = (TR_SCHED_SUN|TR_SCHED_SAT),
670    TR_SCHED_ALL      = (TR_SCHED_WEEKDAY|TR_SCHED_WEEKEND)
671}
672tr_sched_day;
673
674void     tr_sessionSetAltSpeedDay     ( tr_session *, tr_sched_day day );
675tr_sched_day tr_sessionGetAltSpeedDay ( const tr_session * );
676
677typedef void ( tr_altSpeedFunc )      ( tr_session *, tr_bool active, tr_bool userDriven, void * );
678void     tr_sessionClearAltSpeedFunc  ( tr_session * );
679void     tr_sessionSetAltSpeedFunc    ( tr_session *, tr_altSpeedFunc *, void * );
680
681
682tr_bool      tr_sessionGetActiveSpeedLimit( const tr_session  * session,
683                                            tr_direction        dir,
684                                            int               * setme );
685
686
687/***
688****
689***/
690
691double     tr_sessionGetRawSpeed      ( const tr_session *, tr_direction );
692double     tr_sessionGetPieceSpeed    ( const tr_session *, tr_direction );
693
694
695void       tr_sessionSetRatioLimited  ( tr_session *, tr_bool isLimited );
696tr_bool    tr_sessionIsRatioLimited   ( const tr_session * );
697
698void       tr_sessionSetRatioLimit    ( tr_session *, double desiredRatio );
699double     tr_sessionGetRatioLimit    ( const tr_session * );
700
701void       tr_sessionSetPeerLimit( tr_session *, uint16_t maxGlobalPeers );
702uint16_t   tr_sessionGetPeerLimit( const tr_session * );
703
704void       tr_sessionSetPeerLimitPerTorrent( tr_session *, uint16_t maxGlobalPeers );
705uint16_t   tr_sessionGetPeerLimitPerTorrent( const tr_session * );
706
707tr_priority_t   tr_torrentGetPriority( const tr_torrent * );
708void            tr_torrentSetPriority( tr_torrent *, tr_priority_t );
709
710
711/**
712 *  Load all the torrents in tr_getTorrentDir().
713 *  This can be used at startup to kickstart all the torrents
714 *  from the previous session.
715 */
716tr_torrent ** tr_sessionLoadTorrents( tr_session  * session,
717                                      tr_ctor     * ctor,
718                                      int         * setmeCount );
719
720int tr_sessionGetActiveTorrentCount( tr_session * session );
721
722/** @} */
723
724/**
725***
726**/
727
728
729/***********************************************************************
730** Message Logging
731*/
732
733enum
734{
735    TR_MSG_ERR = 1,
736    TR_MSG_INF = 2,
737    TR_MSG_DBG = 3
738};
739void tr_setMessageLevel( int );
740
741int  tr_getMessageLevel( void );
742
743typedef struct tr_msg_list
744{
745    /* TR_MSG_ERR, TR_MSG_INF, or TR_MSG_DBG */
746    uint8_t level;
747
748    /* The line number in the source file where this message originated */
749    int line;
750
751    /* Time the message was generated */
752    time_t when;
753
754    /* The torrent associated with this message,
755     * or a module name such as "Port Forwarding" for non-torrent messages,
756     * or NULL. */
757    char *  name;
758
759    /* The message */
760    char *  message;
761
762    /* The source file where this message originated */
763    const char * file;
764
765    /* linked list of messages */
766    struct tr_msg_list * next;
767}
768tr_msg_list;
769
770void          tr_setMessageQueuing( tr_bool isEnabled );
771
772tr_bool       tr_getMessageQueuing( void );
773
774tr_msg_list * tr_getQueuedMessages( void );
775
776void          tr_freeMessageList( tr_msg_list * freeme );
777
778/** @addtogroup Blocklists
779    @{ */
780
781/**
782 * Specify a range of IPs for Transmission to block.
783 *
784 * filename must be an uncompressed ascii file,
785 * using the same format as the bluetack level1 file.
786 *
787 * libtransmission does not keep a handle to `filename'
788 * after this call returns, so the caller is free to
789 * keep or delete `filename' as it wishes.
790 * libtransmission makes its own copy of the file
791 * massaged into a format easier to search.
792 *
793 * The caller only needs to invoke this when the blocklist
794 * has changed.
795 *
796 * Passing NULL for a filename will clear the blocklist.
797 */
798int     tr_blocklistSetContent   ( tr_session       * session,
799                                   const char       * filename );
800
801int     tr_blocklistGetRuleCount ( const tr_session * session );
802
803tr_bool tr_blocklistExists       ( const tr_session * session );
804
805tr_bool tr_blocklistIsEnabled    ( const tr_session * session );
806
807void    tr_blocklistSetEnabled   ( tr_session       * session,
808                                   tr_bool            isEnabled );
809
810
811/** @} */
812
813
814/** @addtogroup tr_ctor Torrent Constructors
815    @{
816
817    Instantiating a tr_torrent had gotten more complicated as features were
818    added.  At one point there were four functions to check metainfo and five
819    to create tr_torrent.
820
821    To remedy this, a Torrent Constructor (struct tr_ctor) has been introduced:
822    - Simplifies the API to two functions: tr_torrentParse() and tr_torrentNew()
823    - You can set the fields you want; the system sets defaults for the rest.
824    - You can specify whether or not your fields should supercede resume's.
825    - We can add new features to tr_ctor without breaking tr_torrentNew()'s API.
826
827    All the tr_ctor{Get,Set}*() functions with a return value return
828    an error number, or zero if no error occurred.
829
830    You must call one of the SetMetainfo() functions before creating
831    a torrent with a tr_ctor.  The other functions are optional.
832
833    You can reuse a single tr_ctor to create a batch of torrents --
834    just call one of the SetMetainfo() functions between each
835    tr_torrentNew() call.
836
837    Every call to tr_ctorSetMetainfo*() frees the previous metainfo.
838 */
839
840typedef enum
841{
842    TR_FALLBACK, /* indicates the ctor value should be used only
843                    in case of missing resume settings */
844
845    TR_FORCE, /* indicates the ctor value should be used
846                 regardless of what's in the resume settings */
847}
848tr_ctorMode;
849
850struct tr_benc;
851
852/* it's okay to use NULL here if you're only parsing the torrent.
853 * @see tr_torrentParse() */
854tr_ctor*    tr_ctorNew( const tr_session * session_or_NULL );
855
856void        tr_ctorFree( tr_ctor * ctor );
857
858void        tr_ctorSetDeleteSource( tr_ctor * ctor,
859                                    tr_bool   doDelete );
860
861int         tr_ctorSetMagnet( tr_ctor * ctor,
862                              const char * url );
863
864int         tr_ctorSetMetainfo( tr_ctor *       ctor,
865                                const uint8_t * metainfo,
866                                size_t          len );
867
868int         tr_ctorSetMetainfoFromFile( tr_ctor *    ctor,
869                                        const char * filename );
870
871int         tr_ctorSetMetainfoFromHash( tr_ctor *    ctor,
872                                        const char * hashString );
873
874/** Set the maximum number of peers this torrent can connect to.
875    (Default: 50) */
876void        tr_ctorSetPeerLimit( tr_ctor *   ctor,
877                                 tr_ctorMode mode,
878                                 uint16_t    peerLimit  );
879
880/** Set the download folder for the torrent being added with this ctor.
881    @see tr_ctorSetDownloadDir()
882    @see tr_sessionInit() */
883void        tr_ctorSetDownloadDir( tr_ctor *    ctor,
884                                   tr_ctorMode  mode,
885                                   const char * directory );
886
887/**
888 * @brief Set the incompleteDir for this torrent.
889 *
890 * This is not a supported API call.
891 * It only exists so the mac client can migrate
892 * its older incompleteDir settings, and that's
893 * the only place where it should be used.
894 */
895void tr_ctorSetIncompleteDir( tr_ctor * ctor, const char * directory );
896 
897/** Set whether or not the torrent begins downloading/seeding when created.
898    (Default: not paused) */
899void        tr_ctorSetPaused( tr_ctor      * ctor,
900                              tr_ctorMode    mode,
901                              tr_bool        isPaused );
902
903void        tr_ctorSetFilePriorities( tr_ctor                * ctor,
904                                      const tr_file_index_t  * files,
905                                      tr_file_index_t          fileCount,
906                                      tr_priority_t            priority );
907
908void        tr_ctorSetFilesWanted( tr_ctor                * ctor,
909                                   const tr_file_index_t  * fileIndices,
910                                   tr_file_index_t          fileCount,
911                                   tr_bool                  wanted );
912
913
914int         tr_ctorGetPeerLimit( const tr_ctor * ctor,
915                                 tr_ctorMode     mode,
916                                 uint16_t *      setmeCount );
917
918int         tr_ctorGetPaused( const tr_ctor * ctor,
919                              tr_ctorMode     mode,
920                              tr_bool       * setmeIsPaused );
921
922int         tr_ctorGetDownloadDir( const tr_ctor  * ctor,
923                                   tr_ctorMode      mode,
924                                   const char    ** setmeDownloadDir );
925
926int         tr_ctorGetIncompleteDir( const tr_ctor  * ctor,
927                                     const char    ** setmeIncompleteDir );
928
929int         tr_ctorGetMetainfo( const tr_ctor         * ctor,
930                                const struct tr_benc ** setme );
931
932int         tr_ctorGetDeleteSource( const tr_ctor  * ctor,
933                                    tr_bool        * setmeDoDelete );
934
935tr_session* tr_ctorGetSession( const tr_ctor * ctor );
936
937/* returns NULL if tr_ctorSetMetainfoFromFile() wasn't used */
938const char* tr_ctorGetSourceFile( const tr_ctor * ctor );
939
940typedef enum
941{
942    TR_PARSE_OK,
943    TR_PARSE_ERR,
944    TR_PARSE_DUPLICATE
945}
946tr_parse_result;
947
948/**
949 * @brief Parses the specified metainfo
950 *
951 * @return TR_PARSE_ERR if parsing failed;
952 *         TR_PARSE_OK if parsing succeeded and it's not a duplicate;
953 *         TR_PARSE_DUPLICATE if parsing succeeded but it's a duplicate.
954 *
955 * @param setme_info If parsing is successful and setme_info is non-NULL,
956 *                   the parsed metainfo is stored there and sould be freed
957 *                   by calling tr_metainfoFree() when no longer needed.
958 *
959 * Notes:
960 *
961 * 1. tr_torrentParse() won't be able to check for duplicates -- and therefore
962 *    won't return TR_PARSE_DUPLICATE -- unless ctor's "download-dir" and
963 *    session variable is set.
964 *
965 * 2. setme_info->torrent's value can't be set unless ctor's session variable
966 *    is set.
967 */
968tr_parse_result  tr_torrentParse( const tr_ctor  * ctor,
969                                  tr_info        * setme_info_or_NULL );
970
971/** @brief free a metainfo
972    @see tr_torrentParse */
973void tr_metainfoFree( tr_info * inf );
974
975
976/** Instantiate a single torrent.
977    @return 0 on success,
978            TR_EINVALID if the torrent couldn't be parsed, or
979            TR_EDUPLICATE if there's already a matching torrent object. */
980tr_torrent * tr_torrentNew( const tr_ctor   * ctor,
981                            int             * setmeError );
982
983/** @} */
984
985/***********************************************************************
986 ***
987 ***  TORRENTS
988 **/
989
990/** @addtogroup tr_torrent Torrents
991    @{ */
992
993/** @brief Frees memory allocated by tr_torrentNew().
994           Running torrents are stopped first.  */
995void tr_torrentFree( tr_torrent * torrent );
996
997/** @brief Removes our .torrent and .resume files for
998           this torrent, then calls tr_torrentFree(). */
999void tr_torrentRemove( tr_torrent * torrent );
1000
1001/** @brief Start a torrent */
1002void tr_torrentStart( tr_torrent * torrent );
1003
1004/** @brief Stop (pause) a torrent */
1005void tr_torrentStop( tr_torrent * torrent );
1006
1007typedef int tr_fileFunc( const char * filename );
1008
1009enum
1010{
1011    TR_LOC_MOVING,
1012    TR_LOC_DONE,
1013    TR_LOC_ERROR
1014};
1015
1016/** @brief Tell transmsision where to find this torrent's local data */
1017void tr_torrentSetLocation( tr_torrent  * torrent,
1018                            const char  * location,
1019                            tr_bool       move_from_previous_location,
1020                            double      * setme_progress,
1021                            int         * setme_state );
1022
1023/**
1024 * @brief Deletes the torrent's local data.
1025 * @param torrent
1026 * @param fileFunc Pass in "unlink" to destroy the files or, on platforms with
1027 *                 recycle bins, pass in a function that uses it instead.
1028 *                 tr_torrentDeleteLocalData() ignores fileFunc's return value.
1029 */
1030void tr_torrentDeleteLocalData( tr_torrent * torrent,  tr_fileFunc fileFunc );
1031
1032uint64_t tr_torrentGetBytesLeftToAllocate( const tr_torrent * torrent );
1033
1034/**
1035 * @brief Returns this torrent's unique ID.
1036 *
1037 * IDs are good as simple lookup keys, but are not persistent
1038 * between sessions.  If you need that, use tr_info.hash or
1039 * tr_info.hashString.
1040 */
1041int tr_torrentId( const tr_torrent * torrent );
1042
1043tr_torrent* tr_torrentFindFromId( tr_session * session, int id );
1044
1045tr_torrent* tr_torrentFindFromHash( tr_session * session, const uint8_t * hash );
1046
1047
1048
1049/**
1050 * @brief find the location of a torrent's file by looking with and without
1051 *        the ".part" suffix, looking in downloadDir and incompleteDir, etc.
1052 * @return a newly-allocated string (that must be tr_freed() by the caller when done)
1053 *         that gives the location of this file on disk, or NULL if no file exists yet.
1054 * @param tor the torrent whose file we're looking for
1055 * @param fileNum the fileIndex, in [0...tr_info.fileCount)
1056 */
1057char* tr_torrentFindFile( const tr_torrent * tor, tr_file_index_t fileNo );
1058
1059
1060/***
1061****  Torrent speed limits
1062****
1063***/
1064
1065void     tr_torrentSetSpeedLimit      ( tr_torrent *, tr_direction, int KB_s );
1066int      tr_torrentGetSpeedLimit      ( const tr_torrent *, tr_direction );
1067
1068void     tr_torrentUseSpeedLimit      ( tr_torrent *, tr_direction, tr_bool );
1069tr_bool  tr_torrentUsesSpeedLimit     ( const tr_torrent *, tr_direction );
1070
1071void     tr_torrentUseSessionLimits   ( tr_torrent *, tr_bool );
1072tr_bool  tr_torrentUsesSessionLimits  ( const tr_torrent * );
1073
1074
1075/****
1076*****  Ratio Limits
1077****/
1078
1079typedef enum
1080{
1081    TR_RATIOLIMIT_GLOBAL    = 0, /* follow the global settings */
1082    TR_RATIOLIMIT_SINGLE    = 1, /* override the global settings, seeding until a certain ratio */
1083    TR_RATIOLIMIT_UNLIMITED = 2  /* override the global settings, seeding regardless of ratio */
1084}
1085tr_ratiolimit;
1086
1087void          tr_torrentSetRatioMode( tr_torrent         * tor,
1088                                      tr_ratiolimit        mode );
1089
1090tr_ratiolimit tr_torrentGetRatioMode( const tr_torrent   * tor );
1091
1092void          tr_torrentSetRatioLimit( tr_torrent        * tor,
1093                                       double              ratio );
1094
1095double        tr_torrentGetRatioLimit( const tr_torrent  * tor );
1096
1097
1098tr_bool       tr_torrentGetSeedRatio( const tr_torrent *, double * ratio );
1099
1100/****
1101*****  Peer Limits
1102****/
1103
1104void          tr_torrentSetPeerLimit( tr_torrent * tor,
1105                                      uint16_t     peerLimit );
1106
1107uint16_t      tr_torrentGetPeerLimit( const tr_torrent * tor );
1108
1109/****
1110*****  File Priorities
1111****/
1112
1113enum
1114{
1115    TR_PRI_LOW    = -1,
1116    TR_PRI_NORMAL =  0, /* since NORMAL is 0, memset initializes nicely */
1117    TR_PRI_HIGH   =  1
1118};
1119
1120/**
1121 * @brief Set a batch of files to a particular priority.
1122 *
1123 * @param priority must be one of TR_PRI_NORMAL, _HIGH, or _LOW
1124 */
1125void tr_torrentSetFilePriorities( tr_torrent       * torrent,
1126                                  tr_file_index_t  * files,
1127                                  tr_file_index_t    fileCount,
1128                                  tr_priority_t      priority );
1129
1130/**
1131 * @brief Get this torrent's file priorities.
1132 *
1133 * @return A malloc()ed array of tor->info.fileCount items,
1134 *         each holding a TR_PRI_NORMAL, TR_PRI_HIGH, or TR_PRI_LOW.
1135 *         It's the caller's responsibility to free() this.
1136 */
1137tr_priority_t*  tr_torrentGetFilePriorities( const tr_torrent * torrent );
1138
1139/**
1140 * @brief Single-file form of tr_torrentGetFilePriorities.
1141 * @return TR_PRI_NORMAL, TR_PRI_HIGH, or TR_PRI_LOW.
1142 */
1143tr_priority_t   tr_torrentGetFilePriority( const tr_torrent  * torrent,
1144                                           tr_file_index_t     file );
1145
1146/**
1147 * @brief See if a file's `download' flag is set.
1148 * @return true if the file's `download' flag is set.
1149 */
1150int tr_torrentGetFileDL( const tr_torrent  * torrent,
1151                         tr_file_index_t     file );
1152
1153/** @brief Set a batch of files to be downloaded or not. */
1154void tr_torrentSetFileDLs( tr_torrent       * torrent,
1155                           tr_file_index_t  * files,
1156                           tr_file_index_t    fileCount,
1157                           tr_bool            do_download );
1158
1159
1160const tr_info * tr_torrentInfo( const tr_torrent * torrent );
1161
1162/* Raw function to change the torrent's downloadDir field.
1163   This should only be used by libtransmission or to bootstrap
1164   a newly-instantiated tr_torrent object. */
1165void tr_torrentSetDownloadDir( tr_torrent  * torrent, const char * path );
1166
1167const char * tr_torrentGetDownloadDir( const tr_torrent * torrent );
1168
1169/**
1170 * This returns the the root directory of where the torrent is.
1171 *
1172 * This will usually be the downloadDir.  However if the torrent
1173 * has an incompleteDir enabled and hasn't finished downloading
1174 * yet, that will be returned instead.
1175 */
1176const char * tr_torrentGetCurrentDir( const tr_torrent * tor );
1177
1178/**
1179***
1180**/
1181
1182/** @brief a part of tr_info that represents a single tracker */
1183typedef struct tr_tracker_info
1184{
1185    int     tier;
1186    char *  announce;
1187    char *  scrape;
1188}
1189tr_tracker_info;
1190
1191
1192typedef enum
1193{
1194  TR_ANNOUNCE_LIST_OK,
1195  TR_ANNOUNCE_LIST_HAS_DUPLICATES,
1196  TR_ANNOUNCE_LIST_HAS_BAD
1197}
1198tr_announce_list_err;
1199
1200/**
1201 * @brief Modify a torrent's tracker list.
1202 *
1203 * This updates both the `torrent' object's tracker list
1204 * and the metainfo file in tr_sessionGetConfigDir()'s torrent subdirectory.
1205 *
1206 * @param torrent The torrent whose tracker list is to be modified
1207 * @param trackers An array of trackers, sorted by tier from first to last.
1208 *                 NOTE: only the `tier' and `announce' fields are used.
1209 *                 libtransmission derives `scrape' from `announce'.
1210 * @param trackerCount size of the `trackers' array
1211 */
1212tr_announce_list_err
1213tr_torrentSetAnnounceList( tr_torrent             * torrent,
1214                           const tr_tracker_info  * trackers,
1215                           int                      trackerCount );
1216
1217
1218/**
1219***
1220**/
1221
1222typedef enum
1223{
1224    TR_LEECH,           /* doesn't have all the desired pieces */
1225    TR_SEED,            /* has the entire torrent */
1226    TR_PARTIAL_SEED     /* has the desired pieces, but not the entire torrent */
1227}
1228tr_completeness;
1229
1230typedef void ( tr_torrent_completeness_func )( tr_torrent       * torrent,
1231                                               tr_completeness    completeness,
1232                                               void             * user_data );
1233
1234typedef void ( tr_torrent_ratio_limit_hit_func )( tr_torrent   * torrent,
1235                                                  void         * user_data );
1236
1237/**
1238 * Register to be notified whenever a torrent's "completeness"
1239 * changes.  This will be called, for example, when a torrent
1240 * finishes downloading and changes from TR_LEECH to
1241 * either TR_SEED or TR_PARTIAL_SEED.
1242 *
1243 * func is invoked FROM LIBTRANSMISSION'S THREAD!
1244 * This means func must be fast (to avoid blocking peers),
1245 * shouldn't call libtransmission functions (to avoid deadlock),
1246 * and shouldn't modify client-level memory without using a mutex!
1247 *
1248 * @see tr_completeness
1249 */
1250void tr_torrentSetCompletenessCallback(
1251         tr_torrent                    * torrent,
1252         tr_torrent_completeness_func    func,
1253         void                          * user_data );
1254
1255void tr_torrentClearCompletenessCallback( tr_torrent * torrent );
1256
1257
1258
1259typedef void ( tr_torrent_metadata_func )( tr_torrent  * torrent,
1260                                           void        * user_data );
1261/**
1262 * Register to be notified whenever a torrent changes from
1263 * having incomplete metadata to having complete metadata.
1264 * This happens when a magnet link finishes downloading
1265 * metadata from its peers.
1266 */
1267void tr_torrentSetMetadataCallback (
1268         tr_torrent                * tor,
1269         tr_torrent_metadata_func     func,
1270         void                      * user_data );
1271
1272/**
1273 * Register to be notified whenever a torrent's ratio limit
1274 * has been hit. This will be called when the torrent's
1275 * ul/dl ratio has met or exceeded the designated ratio limit.
1276 *
1277 * Has the same restrictions as tr_torrentSetCompletenessCallback
1278 */
1279void tr_torrentSetRatioLimitHitCallback(
1280     tr_torrent                     * torrent,
1281     tr_torrent_ratio_limit_hit_func  func,
1282     void                           * user_data );
1283
1284void tr_torrentClearRatioLimitHitCallback( tr_torrent * torrent );
1285
1286
1287/**
1288 * MANUAL ANNOUNCE
1289 *
1290 * Trackers usually set an announce interval of 15 or 30 minutes.
1291 * Users can send one-time announce requests that override this
1292 * interval by calling tr_torrentManualUpdate().
1293 *
1294 * The wait interval for tr_torrentManualUpdate() is much smaller.
1295 * You can test whether or not a manual update is possible
1296 * (for example, to desensitize the button) by calling
1297 * tr_torrentCanManualUpdate().
1298 */
1299
1300void tr_torrentManualUpdate( tr_torrent * torrent );
1301
1302tr_bool tr_torrentCanManualUpdate( const tr_torrent * torrent );
1303
1304/***
1305****  tr_peer_stat
1306***/
1307
1308typedef struct tr_peer_stat
1309{
1310    tr_bool      isEncrypted;
1311    tr_bool      isDownloadingFrom;
1312    tr_bool      isUploadingTo;
1313    tr_bool      isSeed;
1314
1315    tr_bool      peerIsChoked;
1316    tr_bool      peerIsInterested;
1317    tr_bool      clientIsChoked;
1318    tr_bool      clientIsInterested;
1319    tr_bool      isIncoming;
1320
1321    uint8_t      from;
1322    tr_port      port;
1323
1324    char         addr[TR_INET6_ADDRSTRLEN];
1325    char         client[80];
1326    char         flagStr[32];
1327
1328    float        progress;
1329    float        rateToPeer;
1330    float        rateToClient;
1331}
1332tr_peer_stat;
1333
1334tr_peer_stat * tr_torrentPeers( const tr_torrent * torrent,
1335                                int *              peerCount );
1336
1337void           tr_torrentPeersFree( tr_peer_stat * peerStats,
1338                                    int            peerCount );
1339
1340/***
1341****  tr_tracker_stat
1342***/
1343
1344typedef enum
1345{
1346    /* we won't (announce,scrape) this torrent to this tracker because
1347     * the torrent is stopped, or because of an error, or whatever */
1348    TR_TRACKER_INACTIVE,
1349
1350    /* we will (announce,scrape) this torrent to this tracker, and are
1351     * waiting for enough time to pass to satisfy the tracker's interval */
1352    TR_TRACKER_WAITING,
1353
1354    /* it's time to (announce,scrape) this torrent, and we're waiting on a
1355     * a free slot to open up in the announce manager */
1356    TR_TRACKER_QUEUED,
1357
1358    /* we're (announcing,scraping) this torrent right now */
1359    TR_TRACKER_ACTIVE
1360}
1361tr_tracker_state;
1362
1363typedef struct
1364{
1365    /* how many downloads this tracker knows of (-1 means it does not know) */
1366    int downloadCount;
1367
1368    /* whether or not we've ever sent this tracker an announcement */
1369    tr_bool hasAnnounced;
1370
1371    /* whether or not we've ever scraped to this tracker */
1372    tr_bool hasScraped;
1373
1374    /* ex: http://www.legaltorrents.com:7070 */
1375    char host[1024];
1376
1377    /* the full announce URL */
1378    char announce[1024];
1379
1380    /* Transmission uses one tracker per tier,
1381     * and the others are kept as backups */
1382    tr_bool isBackup;
1383
1384    /* is the tracker announcing, waiting, queued, etc */
1385    tr_tracker_state announceState;
1386
1387    /* is the tracker scraping, waiting, queued, etc */
1388    tr_tracker_state scrapeState;
1389
1390    /* number of peers the tracker told us about last time.
1391     * if "lastAnnounceSucceeded" is false, this field is undefined */
1392    int lastAnnouncePeerCount;
1393
1394    /* human-readable string with the result of the last announce.
1395       if "hasAnnounced" is false, this field is undefined */ 
1396    char lastAnnounceResult[128];
1397
1398    /* when the last announce was sent to the tracker.
1399     * if "hasAnnounced" is false, this field is undefined */
1400    time_t lastAnnounceStartTime;
1401   
1402    /* whether or not the last announce was a success.
1403       if "hasAnnounced" is false, this field is undefined */ 
1404    tr_bool lastAnnounceSucceeded;
1405
1406    /* when the last announce was completed.
1407       if "hasAnnounced" is false, this field is undefined */
1408    time_t lastAnnounceTime;
1409
1410    /* human-readable string with the result of the last scrape.
1411     * if "hasScraped" is false, this field is undefined */
1412    char lastScrapeResult[128];
1413
1414    /* when the last scrape was sent to the tracker.
1415     * if "hasScraped" is false, this field is undefined */
1416    time_t lastScrapeStartTime;
1417
1418    /* whether or not the last scrape was a success.
1419       if "hasAnnounced" is false, this field is undefined */ 
1420    tr_bool lastScrapeSucceeded;
1421
1422    /* when the last scrape was completed.
1423       if "hasScraped" is false, this field is undefined */
1424    time_t lastScrapeTime;
1425
1426    /* number of leechers this tracker knows of (-1 means it does not know) */
1427    int leecherCount;
1428
1429    /* when the next periodic announce message will be sent out.
1430       if announceState isn't TR_TRACKER_WAITING, this field is undefined */
1431    time_t nextAnnounceTime;
1432
1433    /* when the next periodic scrape message will be sent out.
1434       if scrapeState isn't TR_TRACKER_WAITING, this field is undefined */
1435    time_t nextScrapeTime;
1436
1437    /* number of seeders this tracker knows of (-1 means it does not know) */
1438    int seederCount;
1439
1440    /* which tier this tracker is in */
1441    int tier;
1442}
1443tr_tracker_stat;
1444
1445tr_tracker_stat * tr_torrentTrackers( const tr_torrent * torrent,
1446                                      int              * setmeTrackerCount );
1447
1448void tr_torrentTrackersFree( tr_tracker_stat * trackerStats,
1449                             int               trackerCount );
1450
1451
1452   
1453
1454/**
1455 * @brief get the download speeds for each of this torrent's webseed sources.
1456 *
1457 * @return an array of tor->info.webseedCount floats giving download speeds.
1458 *         Each speed in the array corresponds to the webseed at the same
1459 *         array index in tor->info.webseeds.
1460 *         To differentiate "idle" and "stalled" status, idle webseeds will
1461 *         return -1 instead of 0 KiB/s.
1462 *         NOTE: always free this array with tr_free() when you're done with it.
1463 */
1464float*         tr_torrentWebSpeeds( const tr_torrent * torrent );
1465
1466typedef struct tr_file_stat
1467{
1468    uint64_t    bytesCompleted;
1469    float       progress;
1470}
1471tr_file_stat;
1472
1473tr_file_stat * tr_torrentFiles( const tr_torrent  * torrent,
1474                                tr_file_index_t   * fileCount );
1475
1476void tr_torrentFilesFree( tr_file_stat     * files,
1477                          tr_file_index_t    fileCount );
1478
1479
1480/***********************************************************************
1481 * tr_torrentAvailability
1482 ***********************************************************************
1483 * Use this to draw an advanced progress bar which is 'size' pixels
1484 * wide. Fills 'tab' which you must have allocated: each byte is set
1485 * to either -1 if we have the piece, otherwise it is set to the number
1486 * of connected peers who have the piece.
1487 **********************************************************************/
1488void tr_torrentAvailability( const tr_torrent  * torrent,
1489                             int8_t            * tab,
1490                             int                  size );
1491
1492void tr_torrentAmountFinished( const tr_torrent  * torrent,
1493                               float *             tab,
1494                               int                 size );
1495
1496void tr_torrentVerify( tr_torrent * torrent );
1497
1498/***********************************************************************
1499 * tr_info
1500 **********************************************************************/
1501
1502/** @brief a part of tr_info that represents a single file of the torrent's content */
1503typedef struct tr_file
1504{
1505    uint64_t            length;    /* Length of the file, in bytes */
1506    char *              name;      /* Path to the file */
1507    int8_t              priority;  /* TR_PRI_HIGH, _NORMAL, or _LOW */
1508    int8_t              dnd;       /* nonzero if the file shouldn't be
1509                                     downloaded */
1510    tr_piece_index_t    firstPiece; /* We need pieces [firstPiece... */
1511    tr_piece_index_t    lastPiece; /* ...lastPiece] to dl this file */
1512    uint64_t            offset;    /* file begins at the torrent's nth byte */
1513}
1514tr_file;
1515
1516/** @brief a part of tr_info that represents a single piece of the torrent's content */
1517typedef struct tr_piece
1518{
1519    uint8_t    hash[SHA_DIGEST_LENGTH]; /* pieces hash */
1520    int8_t     priority;               /* TR_PRI_HIGH, _NORMAL, or _LOW */
1521    int8_t     dnd;                    /* nonzero if the piece shouldn't be
1522                                         downloaded */
1523}
1524tr_piece;
1525
1526/** @brief information about a torrent that comes from its metainfo file */
1527struct tr_info
1528{
1529    /* total size of the torrent, in bytes */
1530    uint64_t           totalSize;
1531
1532    /* the torrent's name */
1533    char             * name;
1534
1535    /* Path to torrent Transmission's internal copy of the .torrent file. */
1536    char             * torrent;
1537
1538    char            ** webseeds;
1539
1540    char             * comment;
1541    char             * creator;
1542    tr_file          * files;
1543    tr_piece         * pieces;
1544
1545    /* these trackers are sorted by tier */
1546    tr_tracker_info  * trackers;
1547
1548    /* Torrent info */
1549    time_t             dateCreated;
1550
1551    int                trackerCount;
1552    int                webseedCount;
1553    tr_file_index_t    fileCount;
1554    uint32_t           pieceSize;
1555    tr_piece_index_t   pieceCount;
1556
1557    /* General info */
1558    uint8_t            hash[SHA_DIGEST_LENGTH];
1559    char               hashString[2 * SHA_DIGEST_LENGTH + 1];
1560
1561    /* hash, escaped as per rfc2396 for tracker announces */
1562    char               hashEscaped[3 * SHA_DIGEST_LENGTH + 1];
1563
1564    /* Flags */
1565    tr_bool            isPrivate;
1566    tr_bool            isMultifile;
1567};
1568
1569static TR_INLINE tr_bool tr_torrentHasMetadata( const tr_torrent * tor )
1570{
1571    return tr_torrentInfo( tor )->fileCount > 0;
1572}
1573
1574/**
1575 * What the torrent is doing right now.
1576 *
1577 * Note: these values will become a straight enum at some point in the future.
1578 * Do not rely on their current `bitfield' implementation
1579 */
1580typedef enum
1581{
1582    TR_STATUS_CHECK_WAIT   = ( 1 << 0 ), /* Waiting in queue to check files */
1583    TR_STATUS_CHECK        = ( 1 << 1 ), /* Checking files */
1584    TR_STATUS_DOWNLOAD     = ( 1 << 2 ), /* Downloading */
1585    TR_STATUS_SEED         = ( 1 << 3 ), /* Seeding */
1586    TR_STATUS_STOPPED      = ( 1 << 4 )  /* Torrent is stopped */
1587}
1588tr_torrent_activity;
1589
1590tr_torrent_activity tr_torrentGetActivity( tr_torrent * );
1591
1592enum
1593{
1594    TR_PEER_FROM_INCOMING  = 0,  /* connections made to the listening port */
1595    TR_PEER_FROM_TRACKER   = 1,  /* peers received from a tracker */
1596    TR_PEER_FROM_DHT       = 2,  /* peers learnt from the DHT */
1597    TR_PEER_FROM_RESUME    = 3,  /* peers read from the .resume file */
1598    TR_PEER_FROM_PEX       = 4,  /* peers discovered via PEX */
1599    TR_PEER_FROM_LTEP      = 5,  /* peer address provided in an LTEP handshake */
1600    TR_PEER_FROM__MAX
1601};
1602
1603typedef enum
1604{
1605    /* everything's fine */
1606    TR_STAT_OK               = 0,
1607
1608    /* when we anounced to the tracker, we got a warning in the response */
1609    TR_STAT_TRACKER_WARNING  = 1,
1610
1611    /* when we anounced to the tracker, we got an error in the response */
1612    TR_STAT_TRACKER_ERROR    = 2,
1613
1614    /* local trouble, such as disk full or permissions error */
1615    TR_STAT_LOCAL_ERROR      = 3
1616}
1617tr_stat_errtype;
1618
1619/**
1620 * The current status of a torrent.
1621 * @see tr_torrentStat()
1622 */
1623typedef struct tr_stat
1624{
1625    /** The torrent's unique Id.
1626        @see tr_torrentId() */
1627    int    id;
1628
1629    /** What is this torrent doing right now? */
1630    tr_torrent_activity activity;
1631
1632    /** Defines what kind of text is in errorString.
1633        @see errorString */
1634    tr_stat_errtype error;
1635
1636    /** A warning or error message regarding the torrent.
1637        @see error */
1638    char errorString[128];
1639
1640    /** When tr_stat.status is TR_STATUS_CHECK or TR_STATUS_CHECK_WAIT,
1641        this is the percentage of how much of the files has been
1642        verified.  When it gets to 1, the verify process is done.
1643        Range is [0..1]
1644        @see tr_stat.status */
1645    float    recheckProgress;
1646
1647    /** How much has been downloaded of the entire torrent.
1648        Range is [0..1] */
1649    float    percentComplete;
1650
1651    /** How much of the metadata the torrent has.
1652        For torrents added from a .torrent this will always be 1.
1653        For magnet links, this number will from from 0 to 1 as the metadata is downloaded.
1654        Range is [0..1] */
1655    float    metadataPercentComplete;
1656
1657    /** How much has been downloaded of the files the user wants.  This differs
1658        from percentComplete if the user wants only some of the torrent's files.
1659        Range is [0..1]
1660        @see tr_stat.leftUntilDone */
1661    float    percentDone;
1662
1663    /** The percentage of the actual ratio to the seed ratio.  This will be
1664        equal to 1 if the ratio is reached or the torrent is set to seed forever.
1665        Range is [0..1] */ 
1666    float    percentRatio; 
1667
1668    /** Speed all data being sent for this torrent. (KiB/s)
1669        This includes piece data, protocol messages, and TCP overhead */
1670    double rawUploadSpeed;
1671
1672    /** Speed all data being received for this torrent. (KiB/s)
1673        This includes piece data, protocol messages, and TCP overhead */
1674    double rawDownloadSpeed;
1675
1676    /** Speed all piece being sent for this torrent. (KiB/s)
1677        This ONLY counts piece data. */
1678    double pieceUploadSpeed;
1679
1680    /** Speed all piece being received for this torrent. (KiB/s)
1681        This ONLY counts piece data. */
1682    double pieceDownloadSpeed;
1683
1684#define TR_ETA_NOT_AVAIL -1
1685#define TR_ETA_UNKNOWN -2
1686    /** If downloading, estimated number of seconds left until the torrent is done.
1687        If seeding, estimated number of seconds left until seed ratio is reached. */
1688    int    eta;
1689
1690    /** Number of peers that the tracker says this torrent has */
1691    int    peersKnown;
1692
1693    /** Number of peers that we're connected to */
1694    int    peersConnected;
1695
1696    /** How many peers we found out about from the tracker, or from pex,
1697        or from incoming connections, or from our resume file. */
1698    int    peersFrom[TR_PEER_FROM__MAX];
1699
1700    /** Number of peers that are sending data to us. */
1701    int    peersSendingToUs;
1702
1703    /** Number of peers that we're sending data to */
1704    int    peersGettingFromUs;
1705
1706    /** Number of webseeds that are sending data to us. */
1707    int    webseedsSendingToUs;
1708
1709    /** Byte count of all the piece data we'll have downloaded when we're done,
1710        whether or not we have it yet.  This may be less than tr_info.totalSize
1711        if only some of the torrent's files are wanted.
1712        [0...tr_info.totalSize] */
1713    uint64_t    sizeWhenDone;
1714
1715    /** Byte count of how much data is left to be downloaded until we've got
1716        all the pieces that we want.  [0...tr_info.sizeWhenDone] */
1717    uint64_t    leftUntilDone;
1718
1719    /** Byte count of all the piece data we want and don't have yet,
1720        but that a connected peer does have. [0...leftUntilDone] */
1721    uint64_t    desiredAvailable;
1722
1723    /** Byte count of all the corrupt data you've ever downloaded for
1724        this torrent.  If you're on a poisoned torrent, this number can
1725        grow very large. */
1726    uint64_t    corruptEver;
1727
1728    /** Byte count of all data you've ever uploaded for this torrent. */
1729    uint64_t    uploadedEver;
1730
1731    /** Byte count of all the non-corrupt data you've ever downloaded
1732        for this torrent.  If you deleted the files and downloaded a second
1733        time, this will be 2*totalSize.. */
1734    uint64_t    downloadedEver;
1735
1736    /** Byte count of all the checksum-verified data we have for this torrent.
1737      */
1738    uint64_t    haveValid;
1739
1740    /** Byte count of all the partial piece data we have for this torrent.
1741        As pieces become complete, this value may decrease as portions of it
1742        are moved to `corrupt' or `haveValid'. */
1743    uint64_t    haveUnchecked;
1744
1745    /** time when one or more of the torrent's trackers will
1746        allow you to manually ask for more peers,
1747        or 0 if you can't */
1748    time_t manualAnnounceTime;
1749
1750#define TR_RATIO_NA  -1
1751#define TR_RATIO_INF -2
1752    /** TR_RATIO_INF, TR_RATIO_NA, or a regular ratio */
1753    float    ratio;
1754
1755    /** When the torrent was first added. */
1756    time_t    addedDate;
1757
1758    /** When the torrent finished downloading. */
1759    time_t    doneDate;
1760
1761    /** When the torrent was last started. */
1762    time_t    startDate;
1763
1764    /** The last time we uploaded or downloaded piece data on this torrent. */
1765    time_t    activityDate;
1766}
1767tr_stat;
1768
1769/** Return a pointer to an tr_stat structure with updated information
1770    on the torrent.  This is typically called by the GUI clients every
1771    second or so to get a new snapshot of the torrent's status. */
1772const tr_stat * tr_torrentStat( tr_torrent * torrent );
1773
1774/** Like tr_torrentStat(), but only recalculates the statistics if it's
1775    been longer than a second since they were last calculated.  This can
1776    reduce the CPU load if you're calling tr_torrentStat() frequently. */
1777const tr_stat * tr_torrentStatCached( tr_torrent * torrent );
1778
1779/** @deprecated */
1780void tr_torrentSetAddedDate( tr_torrent * torrent,
1781                             time_t       addedDate );
1782
1783/** @deprecated */
1784void tr_torrentSetActivityDate( tr_torrent * torrent,
1785                                time_t       activityDate );
1786
1787/** @deprecated */
1788void tr_torrentSetDoneDate( tr_torrent * torrent, time_t doneDate );
1789
1790/** @} */
1791
1792/** @brief Sanity checker to test that the direction is TR_UP or TR_DOWN */
1793static TR_INLINE tr_bool tr_isDirection( tr_direction d ) { return d==TR_UP || d==TR_DOWN; }
1794
1795/** @brief Sanity checker to test that a bool is TRUE or FALSE */
1796static TR_INLINE tr_bool tr_isBool( tr_bool b ) { return b==1 || b==0; }
1797
1798#ifdef __cplusplus
1799}
1800#endif
1801
1802#endif
Note: See TracBrowser for help on using the repository browser.