source: trunk/daemon/daemon.c @ 6299

Last change on this file since 6299 was 6299, checked in by charles, 14 years ago

sync the man pages with the cli/daemon/remote changes

  • Property svn:keywords set to Date Rev Author Id
File size: 13.1 KB
Line 
1/*
2 * This file Copyright (C) 2008 Charles Kerr <charles@rebelbase.com>
3 *
4 * This file is licensed by the GPL version 2.  Works owned by the
5 * Transmission project are granted a special exemption to clause 2(b)
6 * so that the bulk of its code can remain under the MIT license.
7 * This exemption does not extend to derived works not owned by
8 * the Transmission project.
9 *
10 * $Id: daemon.c 6299 2008-07-08 17:44:33Z charles $
11 */
12
13#include <assert.h>
14#include <errno.h>
15#include <stdio.h> /* printf */
16#include <stdlib.h> /* exit, atoi */
17#include <string.h> /* strcmp */
18
19#include <fcntl.h> /* open */
20#include <signal.h>
21#include <unistd.h> /* daemon, getcwd */
22
23#include <libtransmission/transmission.h>
24#include <libtransmission/bencode.h>
25#include <libtransmission/rpc.h>
26#include <libtransmission/tr-getopt.h>
27#include <libtransmission/utils.h>
28#include <libtransmission/version.h>
29
30#define MY_NAME "transmission-daemon"
31
32static int closing = FALSE;
33static tr_handle * mySession;
34static char myConfigFilename[MAX_PATH_LENGTH];
35
36#define KEY_BLOCKLIST        "blocklist-enabled"
37#define KEY_DOWNLOAD_DIR     "download-dir"
38#define KEY_ENCRYPTION       "encryption"
39#define KEY_PEER_LIMIT       "max-peers-global"
40#define KEY_PEER_PORT        "peer-port"
41#define KEY_PORT_FORWARDING  "port-forwarding-enabled"
42#define KEY_PEX_ENABLED      "pex-enabled"
43#define KEY_AUTH_REQUIRED    "rpc-authentication-required"
44#define KEY_USERNAME         "rpc-username"
45#define KEY_PASSWORD         "rpc-password"
46#define KEY_ACL              "rpc-access-control-list"
47#define KEY_RPC_PORT         "rpc-port"
48#define KEY_DSPEED           "download-limit"
49#define KEY_DSPEED_ENABLED   "download-limit-enabled"
50#define KEY_USPEED           "upload-limit"
51#define KEY_USPEED_ENABLED   "upload-limit-enabled"
52
53#define CONFIG_FILE          "settings.json"
54
55/***
56****  Config File
57***/
58
59static void
60replaceInt( tr_benc * dict, const char * key, int64_t value )
61{
62    tr_bencDictRemove( dict, key );
63    tr_bencDictAddInt( dict, key, value );
64}
65static void
66replaceStr( tr_benc * dict, const char * key, const char* value )
67{
68    tr_bencDictRemove( dict, key );
69    tr_bencDictAddStr( dict, key, value );
70}
71static void
72saveState( tr_session * s )
73{
74    tr_benc d;
75    if( tr_bencLoadJSONFile( myConfigFilename, &d ) )
76        tr_bencInitDict( &d, 16 );
77   
78    replaceInt( &d, KEY_BLOCKLIST,       tr_blocklistIsEnabled( s ) );
79    replaceStr( &d, KEY_DOWNLOAD_DIR,    tr_sessionGetDownloadDir( s ) );
80    replaceInt( &d, KEY_PEER_LIMIT,      tr_sessionGetPeerLimit( s ) );
81    replaceInt( &d, KEY_PEER_PORT,       tr_sessionGetPeerPort( s ) );
82    replaceInt( &d, KEY_PORT_FORWARDING, tr_sessionIsPortForwardingEnabled( s ) );
83    replaceInt( &d, KEY_PEX_ENABLED,     tr_sessionIsPexEnabled( s ) );
84    replaceStr( &d, KEY_USERNAME,        tr_sessionGetRPCUsername( s ) );
85    replaceStr( &d, KEY_PASSWORD,        tr_sessionGetRPCPassword( s ) );
86    replaceStr( &d, KEY_ACL,             tr_sessionGetRPCACL( s ) );
87    replaceInt( &d, KEY_RPC_PORT,        tr_sessionGetRPCPort( s ) );
88    replaceInt( &d, KEY_AUTH_REQUIRED,   tr_sessionIsRPCPasswordEnabled( s ) );
89    replaceInt( &d, KEY_DSPEED,          tr_sessionGetSpeedLimit( s, TR_DOWN ) );
90    replaceInt( &d, KEY_DSPEED_ENABLED,  tr_sessionIsSpeedLimitEnabled( s, TR_DOWN ) );
91    replaceInt( &d, KEY_USPEED,          tr_sessionGetSpeedLimit( s, TR_UP ) );
92    replaceInt( &d, KEY_USPEED_ENABLED,  tr_sessionIsSpeedLimitEnabled( s, TR_UP ) );
93    replaceInt( &d, KEY_ENCRYPTION,      tr_sessionGetEncryption( s ) );
94
95    tr_bencSaveJSONFile( myConfigFilename, &d );
96    tr_bencFree( &d );
97    tr_ninf( MY_NAME, "saved \"%s\"", myConfigFilename );
98}
99
100static void
101getConfigInt( tr_benc     * dict,
102              const char  * key,
103              int         * setme,
104              int           defaultVal )
105{
106    if( *setme < 0 ) {
107        int64_t i;
108        if( tr_bencDictFindInt( dict, key, &i ) )
109            *setme = i;
110        else
111            *setme = defaultVal;
112    }
113}
114
115static void
116getConfigStr( tr_benc      * dict,
117              const char   * key,
118              const char  ** setme,
119              const char   * defaultVal )
120{
121    if( !*setme ) {
122        const char * s;
123        if( tr_bencDictFindStr( dict, key, &s ) )
124            *setme = s;
125        else
126            *setme = defaultVal;
127    }
128}
129
130/**
131 * @param port      port number, or -1 if not set in the command line
132 * @param auth      TRUE, FALSE, or -1 if not set on the command line
133 * @param blocklist TRUE, FALSE, or -1 if not set on the command line
134 */
135static void
136session_init( const char * configDir, const char * downloadDir,
137              int rpcPort, const char * acl,
138              int authRequired, const char * username, const char * password,
139              int blocklistEnabled )
140{
141    char mycwd[MAX_PATH_LENGTH];
142    tr_benc state, *dict = NULL;
143    int peerPort=-1, peers=-1;
144    int pexEnabled = -1;
145    int fwdEnabled = -1;
146    int upLimit=-1, upLimited=-1, downLimit=-1, downLimited=-1;
147    int encryption = -1;
148    tr_ctor * ctor;
149    tr_torrent ** torrents;
150
151    if( !tr_bencLoadJSONFile( myConfigFilename, &state ) )
152        dict = &state;
153
154    /***
155    ****  Decide on which values to pass into tr_sessionInitFull().
156    ****  The command-line arguments are given precedence and
157    ****  the state file from the previous session is used as a fallback.
158    ****  If neither of those can be found, the TR_DEFAULT fields are used .
159    ***/
160
161    getcwd( mycwd, sizeof( mycwd ) );
162    getConfigStr( dict, KEY_DOWNLOAD_DIR,    &downloadDir,       mycwd );
163    getConfigInt( dict, KEY_PEX_ENABLED,     &pexEnabled,        TR_DEFAULT_PEX_ENABLED );
164    getConfigInt( dict, KEY_PORT_FORWARDING, &fwdEnabled,        TR_DEFAULT_PORT_FORWARDING_ENABLED );
165    getConfigInt( dict, KEY_PEER_PORT,       &peerPort,          TR_DEFAULT_PORT );
166    getConfigInt( dict, KEY_DSPEED,          &downLimit,         100 );
167    getConfigInt( dict, KEY_DSPEED_ENABLED,  &downLimited,       FALSE );
168    getConfigInt( dict, KEY_USPEED,          &upLimit,           100 );
169    getConfigInt( dict, KEY_USPEED_ENABLED,  &upLimited,         FALSE );
170    getConfigInt( dict, KEY_PEER_LIMIT,      &peers,             TR_DEFAULT_GLOBAL_PEER_LIMIT );
171    getConfigInt( dict, KEY_BLOCKLIST,       &blocklistEnabled,  TR_DEFAULT_BLOCKLIST_ENABLED );
172    getConfigInt( dict, KEY_RPC_PORT,        &rpcPort,           TR_DEFAULT_RPC_PORT );
173    getConfigStr( dict, KEY_ACL,             &acl,               TR_DEFAULT_RPC_ACL );
174    getConfigInt( dict, KEY_AUTH_REQUIRED,   &authRequired,      FALSE );
175    getConfigStr( dict, KEY_USERNAME,        &username,          NULL );
176    getConfigStr( dict, KEY_PASSWORD,        &password,          NULL );
177    getConfigInt( dict, KEY_ENCRYPTION,      &encryption,        TR_ENCRYPTION_PREFERRED );
178
179    /***
180    ****
181    ***/
182
183    /* start the session */
184    mySession = tr_sessionInitFull( configDir, "daemon", downloadDir,
185                                    pexEnabled, fwdEnabled, peerPort,
186                                    encryption,
187                                    upLimited, upLimit,
188                                    downLimited, downLimit,
189                                    peers,
190                                    TR_MSG_INF, 0,
191                                    blocklistEnabled,
192                                    TR_DEFAULT_PEER_SOCKET_TOS,
193                                    TRUE, rpcPort, acl, authRequired, username, password,
194                                    TR_DEFAULT_PROXY_ENABLED,
195                                    TR_DEFAULT_PROXY,
196                                    TR_DEFAULT_PROXY_TYPE,
197                                    TR_DEFAULT_PROXY_AUTH_ENABLED,
198                                    TR_DEFAULT_PROXY_USERNAME,
199                                    TR_DEFAULT_PROXY_PASSWORD );
200
201
202    if( authRequired )
203        tr_ninf( MY_NAME, "requiring authentication" );
204
205    /* load the torrents */
206    ctor = tr_ctorNew( mySession );
207    torrents = tr_sessionLoadTorrents( mySession, ctor, NULL );
208    tr_free( torrents );
209    tr_ctorFree( ctor );
210
211    if( dict )
212        tr_bencFree( &state );
213}
214
215static const char *
216getUsage( void )
217{
218    return "Transmission "LONG_VERSION_STRING"  http://www.transmissionbt.com/\n"
219           "A fast and easy BitTorrent client\n"
220           "\n"
221           MY_NAME" is a headless Transmission session\n"
222           "that can be controlled via transmission-remote or Clutch.\n"
223           "\n"
224           "Usage: "MY_NAME" [options]";
225}
226
227const struct tr_option options[] = {
228    { 'a', "acl",       "Access Control List.  (Default: "TR_DEFAULT_RPC_ACL")", "a", 1, "<list>" },
229    { 'b', "blocklist", "Enable peer blocklists",             "b", 0, NULL },
230    { 'B', "no-blocklist", "Disable peer blocklists",         "B", 0, NULL },
231    { 'f', "foreground", "Run in the foreground instead of daemonizing", "f", 0, NULL },
232    { 'g', "config-dir",   "Where to look for configuration files", "g", 1, "<path>" },
233    { 'p', "port",         "Port to listen for incoming peers (Default: "TR_DEFAULT_PORT_STR")", "p", 1, "<port>" },
234    { 't', "auth",         "Requre authentication",           "t", 0, NULL },
235    { 'T', "no-auth",      "Don't require authentication",    "T", 0, NULL },
236    { 'u', "username",     "Set username for authentication", "u", 1, "<username>" },
237    { 'v', "password",     "Set password for authentication", "v", 1, "<password>" },
238    { 'w', "download-dir", "Where to save downloaded data",   "w", 1, "<path>" },
239    { 0, NULL, NULL, NULL, 0, NULL }
240};
241
242static void
243showUsage( void )
244{
245    tr_getopt_usage( MY_NAME, getUsage(), options );
246    exit( 0 );
247}
248
249static void
250readargs( int argc, const char ** argv,
251          int * nofork, const char ** configDir, const char ** downloadDir,
252          int * rpcPort, const char ** acl,
253          int * authRequired, const char ** username, const char ** password,
254          int * blocklistEnabled )
255{
256    int c;
257    const char * optarg;
258    while(( c = tr_getopt( getUsage(), argc, argv, options, &optarg )))
259    {
260        switch( c )
261        {
262            case 'a': *acl = optarg; break;
263            case 'b': *blocklistEnabled = 1; break;
264            case 'B': *blocklistEnabled = 0; break;
265            case 'f': *nofork = 1; break;
266            case 'g': *configDir = optarg; break;
267            case 'p': *rpcPort = atoi( optarg ); break;
268            case 't': *authRequired = TRUE; break;
269            case 'T': *authRequired = FALSE; break;
270            case 'u': *username = optarg; break; 
271            case 'v': *password = optarg; break; 
272            case 'w': *downloadDir = optarg; break;
273            default: showUsage( ); break;
274        }
275    }
276}
277
278static void
279gotsig( int sig UNUSED )
280{
281    closing = TRUE;
282}
283
284#if !defined(HAVE_DAEMON)
285static int
286daemon( int nochdir, int noclose )
287{
288    switch( fork( ) ) {
289        case 0:
290            break;
291        case -1:
292            tr_nerr( MY_NAME, "Error daemonizing (fork)! %d - %s", errno, strerror(errno) );
293            return -1;
294        default:
295            _exit(0);
296    }
297
298    if( setsid() < 0 ) {
299        tr_nerr( MY_NAME, "Error daemonizing (setsid)! %d - %s", errno, strerror(errno) );
300        return -1;
301    }
302
303    switch( fork( ) ) {
304        case 0:
305            break;
306        case -1:
307            tr_nerr( MY_NAME, "Error daemonizing (fork2)! %d - %s", errno, strerror(errno) );
308            return -1;
309        default:
310            _exit(0);
311    }
312
313    if( !nochdir && 0 > chdir( "/" ) ) {
314        tr_nerr( MY_NAME, "Error daemonizing (chdir)! %d - %s", errno, strerror(errno) );
315        return -1;
316    }
317
318    if( !noclose ) {
319        int fd;
320        if((( fd = open("/dev/null", O_RDONLY))) != 0 ) {
321            dup2( fd,  0 );
322            close( fd );
323        }
324        if((( fd = open("/dev/null", O_WRONLY))) != 1 ) {
325            dup2( fd, 1 );
326            close( fd );
327        }
328        if((( fd = open("/dev/null", O_WRONLY))) != 2 ) {
329            dup2( fd, 2 );
330            close( fd );
331        }
332    }
333
334    return 0;
335}
336#endif
337
338int
339main( int argc, char ** argv )
340{
341    int nofork = 0;
342    int rpcPort = -1;
343    int authRequired = -1;
344    int blocklistEnabled = -1;
345    const char * configDir = NULL;
346    const char * downloadDir = NULL;
347    const char * acl = NULL;
348    const char * username = NULL;
349    const char * password = NULL;
350
351    signal( SIGINT, gotsig );
352    signal( SIGQUIT, gotsig );
353    signal( SIGTERM, gotsig );
354    signal( SIGPIPE, SIG_IGN );
355    signal( SIGHUP, SIG_IGN );
356
357    readargs( argc, (const char**)argv, &nofork, &configDir, &downloadDir,
358              &rpcPort, &acl, &authRequired, &username, &password,
359              &blocklistEnabled );
360    if( configDir == NULL )
361        configDir = tr_strdup_printf( "%s-daemon", tr_getDefaultConfigDir() );
362    tr_buildPath( myConfigFilename, sizeof( myConfigFilename ),
363                  configDir, CONFIG_FILE, NULL );
364
365    if( !nofork ) {
366        if( 0 > daemon( 1, 0 ) ) {
367            fprintf( stderr, "failed to daemonize: %s\n", strerror( errno ) );
368            exit( 1 );
369        }
370    }
371
372    session_init( configDir, downloadDir,
373                  rpcPort, acl, authRequired, username, password,
374                  blocklistEnabled );
375
376    while( !closing )
377        sleep( 1 );
378
379    saveState( mySession );
380    printf( "Closing transmission session..." );
381    tr_sessionClose( mySession );
382    printf( " done.\n" );
383
384    return 0;
385}
Note: See TracBrowser for help on using the repository browser.