source: trunk/daemon/daemon.c @ 10132

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

(trunk daemon) #2875 "add incomplete-dir, dht, and seedratio options to daemon" -- committed to trunk for 1.90

  • Property svn:keywords set to Date Rev Author Id
File size: 16.1 KB
Line 
1/*
2 * This file Copyright (C) 2008-2010 Mnemosyne LLC
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 10132 2010-02-07 19:20:00Z charles $
11 */
12
13#include <errno.h>
14#include <stdio.h> /* printf */
15#include <stdlib.h> /* exit, atoi */
16#include <string.h> /* strcmp */
17
18#include <sys/types.h> /* umask*/
19#include <sys/stat.h> /* umask*/
20
21#include <fcntl.h> /* open */
22#include <signal.h>
23#ifdef HAVE_SYSLOG
24#include <syslog.h>
25#endif
26#include <unistd.h> /* daemon */
27
28#include <event.h>
29
30#include <libtransmission/transmission.h>
31#include <libtransmission/bencode.h>
32#include <libtransmission/tr-getopt.h>
33#include <libtransmission/utils.h>
34#include <libtransmission/version.h>
35
36#include "watch.h"
37
38#define MY_NAME "transmission-daemon"
39
40#define PREF_KEY_DIR_WATCH          "watch-dir"
41#define PREF_KEY_DIR_WATCH_ENABLED  "watch-dir-enabled"
42
43static tr_bool paused = FALSE;
44static tr_bool closing = FALSE;
45static tr_session * mySession = NULL;
46
47/***
48****  Config File
49***/
50
51static const char *
52getUsage( void )
53{
54    return "Transmission " LONG_VERSION_STRING
55           "  http://www.transmissionbt.com/\n"
56           "A fast and easy BitTorrent client\n"
57           "\n"
58           MY_NAME " is a headless Transmission session\n"
59           "that can be controlled via transmission-remote or Clutch.\n"
60           "\n"
61           "Usage: " MY_NAME " [options]";
62}
63
64static const struct tr_option options[] =
65{
66    { 'a', "allowed", "Allowed IP addresses.  (Default: " TR_DEFAULT_RPC_WHITELIST ")", "a", 1, "<list>" },
67    { 'b', "blocklist", "Enable peer blocklists", "b", 0, NULL },
68    { 'B', "no-blocklist", "Disable peer blocklists", "B", 0, NULL },
69    { 'c', "watch-dir", "Directory to watch for new .torrent files", "c", 1, "<directory>" },
70    { 'C', "no-watch-dir", "Disable the watch-dir", "C", 0, NULL },
71    { 941, "incomplete-dir", "Where to store new torrents until they're complete", NULL, 1, "<directory>" },
72    { 942, "no-incomplete-dir", "Don't store incomplete torrents in a different location", NULL, 0, NULL },
73    { 'd', "dump-settings", "Dump the settings and exit", "d", 0, NULL },
74    { 'f', "foreground", "Run in the foreground instead of daemonizing", "f", 0, NULL },
75    { 'g', "config-dir", "Where to look for configuration files", "g", 1, "<path>" },
76    { 'p', "port", "RPC port (Default: " TR_DEFAULT_RPC_PORT_STR ")", "p", 1, "<port>" },
77    { 't', "auth", "Require authentication", "t", 0, NULL },
78    { 'T', "no-auth", "Don't require authentication", "T", 0, NULL },
79    { 'u', "username", "Set username for authentication", "u", 1, "<username>" },
80    { 'v', "password", "Set password for authentication", "v", 1, "<password>" },
81    { 'V', "version", "Show version number and exit", "V", 0, NULL },
82    { 'w', "download-dir", "Where to save downloaded data", "w", 1, "<path>" },
83    { 800, "paused", "Pause all torrents on startup", NULL, 0, NULL },
84    { 'o', "dht", "Enable distributed hash tables (DHT)", "o", 0, NULL },
85    { 'O', "no-dht", "Disable distributed hash tables (DHT)", "O", 0, NULL },
86    { 'P', "peerport", "Port for incoming peers (Default: " TR_DEFAULT_PEER_PORT_STR ")", "P", 1, "<port>" },
87    { 'm', "portmap", "Enable portmapping via NAT-PMP or UPnP", "m", 0, NULL },
88    { 'M', "no-portmap", "Disable portmapping", "M", 0, NULL },
89    { 'L', "peerlimit-global", "Maximum overall number of peers (Default: " TR_DEFAULT_PEER_LIMIT_GLOBAL_STR ")", "L", 1, "<limit>" },
90    { 'l', "peerlimit-torrent", "Maximum number of peers per torrent (Default: " TR_DEFAULT_PEER_LIMIT_TORRENT_STR ")", "l", 1, "<limit>" },
91    { 910, "encryption-required",  "Encrypt all peer connections", "er", 0, NULL },
92    { 911, "encryption-preferred", "Prefer encrypted peer connections", "ep", 0, NULL },
93    { 912, "encryption-tolerated", "Prefer unencrypted peer connections", "et", 0, NULL },
94    { 'i', "bind-address-ipv4", "Where to listen for peer connections", "i", 1, "<ipv4 address>" },
95    { 'I', "bind-address-ipv6", "Where to listen for peer connections", "I", 1, "<ipv6 address>" },
96    { 'r', "rpc-bind-address", "Where to listen for RPC connections", "r", 1, "<ipv4 address>" },
97    { 953, "global-seedratio", "All torrents, unless overridden by a per-torrent setting, should seed until a specific ratio", "gsr", 1, "ratio" },
98    { 954, "no-global-seedratio", "All torrents, unless overridden by a per-torrent setting, should seed regardless of ratio", "GSR", 0, NULL },
99    { 0, NULL, NULL, NULL, 0, NULL }
100};
101
102static void
103showUsage( void )
104{
105    tr_getopt_usage( MY_NAME, getUsage( ), options );
106    exit( 0 );
107}
108
109static void
110gotsig( int sig )
111{
112    switch( sig )
113    {
114        case SIGHUP:
115        {
116            tr_benc settings;
117            const char * configDir = tr_sessionGetConfigDir( mySession );
118            tr_inf( "Reloading settings from \"%s\"", configDir );
119            tr_bencInitDict( &settings, 0 );
120            tr_sessionLoadSettings( &settings, configDir, MY_NAME );
121            tr_sessionSet( mySession, &settings );
122            tr_bencFree( &settings );
123            tr_sessionReloadBlocklists( mySession );
124            break;
125        }
126
127        default:
128            closing = TRUE;
129            break;
130    }
131}
132
133#if defined(WIN32)
134 #define USE_NO_DAEMON
135#elif !defined(HAVE_DAEMON) || defined(__UCLIBC__)
136 #define USE_TR_DAEMON
137#else
138 #define USE_OS_DAEMON
139#endif
140
141static int
142tr_daemon( int nochdir, int noclose )
143{
144#if defined(USE_OS_DAEMON)
145    return daemon( nochdir, noclose );
146#elif defined(USE_TR_DAEMON)
147    pid_t pid = fork( );
148    if( pid < 0 )
149        return -1;
150    else if( pid > 0 )
151        _exit( 0 );
152    else {
153        pid = setsid( );
154        if( pid < 0 )
155            return -1;
156
157        pid = fork( );
158        if( pid < 0 )
159            return -1;
160        else if( pid > 0 )
161            _exit( 0 );
162        else {
163
164            if( !nochdir )
165                if( chdir( "/" ) < 0 )
166                    return -1;
167
168            umask( (mode_t)0 );
169
170            if( !noclose ) {
171                /* send stdin, stdout, and stderr to /dev/null */
172                int i;
173                int fd = open( "/dev/null", O_RDWR, 0 );
174                for( i=0; i<3; ++i ) {
175                    if( close( i ) )
176                        return -1;
177                    dup2( fd, i );
178                }
179                close( fd );
180            }
181
182            return 0;
183        }
184    }
185#else /* USE_NO_DAEMON */
186    return 0;
187#endif
188}
189
190static const char*
191getConfigDir( int argc, const char ** argv )
192{
193    int c;
194    const char * configDir = NULL;
195    const char * optarg;
196    const int ind = tr_optind;
197
198    while(( c = tr_getopt( getUsage( ), argc, argv, options, &optarg ))) {
199        if( c == 'g' ) {
200            configDir = optarg;
201            break;
202        }
203    }
204
205    tr_optind = ind;
206
207    if( configDir == NULL )
208        configDir = tr_getDefaultConfigDir( MY_NAME );
209
210    return configDir;
211}
212
213static void
214onFileAdded( tr_session * session, const char * dir, const char * file )
215{
216    if( strstr( file, ".torrent" ) != NULL )
217    {
218        char * filename = tr_buildPath( dir, file, NULL );
219        tr_ctor * ctor = tr_ctorNew( session );
220
221        int err = tr_ctorSetMetainfoFromFile( ctor, filename );
222        if( !err )
223            tr_torrentNew( ctor, &err );
224
225        tr_ctorFree( ctor );
226        tr_free( filename );
227    }
228}
229
230static void
231pumpLogMessages( tr_bool foreground )
232{
233    const tr_msg_list * l;
234    tr_msg_list * list = tr_getQueuedMessages( );
235
236    for( l=list; l!=NULL; l=l->next )
237    {
238#ifdef HAVE_SYSLOG
239        if( foreground )
240        {
241            char timestr[64];
242            tr_getLogTimeStr( timestr, sizeof( timestr ) );
243            if( l->name )
244                fprintf( stderr, "[%s] %s %s (%s:%d)\n", timestr, l->name, l->message, l->file, l->line );
245            else
246                fprintf( stderr, "[%s] %s (%s:%d)\n", timestr, l->message, l->file, l->line );
247        }
248        else /* daemon... write to syslog */
249        {
250            int priority;
251
252            /* figure out the syslog priority */
253            switch( l->level ) {
254                case TR_MSG_ERR: priority = LOG_ERR; break;
255                case TR_MSG_DBG: priority = LOG_DEBUG; break;
256                default: priority = LOG_INFO; break;
257            }
258
259            if( l->name )
260                syslog( priority, "%s %s (%s:%d)", l->name, l->message, l->file, l->line );
261            else
262                syslog( priority, "%s (%s:%d)", l->message, l->file, l->line );
263        }
264#else
265        {
266            char timestr[64];
267            tr_getLogTimeStr( timestr, sizeof( timestr ) );
268            if( l->name )
269                fprintf( stderr, "[%s] %s %s (%s:%d)\n", timestr, l->name, l->message, l->file, l->line );
270            else
271                fprintf( stderr, "[%s] %s (%s:%d)\n", timestr, l->message, l->file, l->line );
272        }
273#endif
274    }
275
276    tr_freeMessageList( list );
277}
278
279int
280main( int argc, char ** argv )
281{
282    int c;
283    const char * optarg;
284    tr_benc settings;
285    tr_bool boolVal;
286    tr_bool loaded;
287    tr_bool foreground = FALSE;
288    tr_bool dumpSettings = FALSE;
289    const char * configDir = NULL;
290    dtr_watchdir * watchdir = NULL;
291
292    signal( SIGINT, gotsig );
293    signal( SIGTERM, gotsig );
294#ifndef WIN32
295    signal( SIGHUP, gotsig );
296#endif
297
298    /* load settings from defaults + config file */
299    tr_bencInitDict( &settings, 0 );
300    configDir = getConfigDir( argc, (const char**)argv );
301    loaded = tr_sessionLoadSettings( &settings, configDir, MY_NAME );
302    tr_bencDictAddBool( &settings, TR_PREFS_KEY_RPC_ENABLED, TRUE );
303
304    /* overwrite settings from the comamndline */
305    tr_optind = 1;
306    while(( c = tr_getopt( getUsage(), argc, (const char**)argv, options, &optarg ))) {
307        switch( c ) {
308            case 'a': tr_bencDictAddStr( &settings, TR_PREFS_KEY_RPC_WHITELIST, optarg );
309                      tr_bencDictAddBool( &settings, TR_PREFS_KEY_RPC_WHITELIST_ENABLED, TRUE );
310                      break;
311            case 'b': tr_bencDictAddBool( &settings, TR_PREFS_KEY_BLOCKLIST_ENABLED, TRUE );
312                      break;
313            case 'B': tr_bencDictAddBool( &settings, TR_PREFS_KEY_BLOCKLIST_ENABLED, FALSE );
314                      break;
315            case 'c': tr_bencDictAddStr( &settings, PREF_KEY_DIR_WATCH, optarg );
316                      tr_bencDictAddBool( &settings, PREF_KEY_DIR_WATCH_ENABLED, TRUE );
317                      break;
318            case 'C': tr_bencDictAddBool( &settings, PREF_KEY_DIR_WATCH_ENABLED, FALSE );
319                      break;
320            case 941:
321                      tr_bencDictAddStr( &settings, TR_PREFS_KEY_INCOMPLETE_DIR, optarg );
322                      tr_bencDictAddBool( &settings, TR_PREFS_KEY_INCOMPLETE_DIR_ENABLED, TRUE );
323                      break;
324            case 942:
325                      tr_bencDictAddBool( &settings, TR_PREFS_KEY_INCOMPLETE_DIR_ENABLED, FALSE );
326                      break;
327            case 'd': dumpSettings = TRUE;
328                      break;
329            case 'f': foreground = TRUE;
330                      break;
331            case 'g': /* handled above */
332                      break;
333            case 'V': /* version */
334                      fprintf(stderr, "Transmission %s\n", LONG_VERSION_STRING);
335                      exit( 0 );
336            case 'o':
337                      tr_bencDictAddBool( &settings, TR_PREFS_KEY_DHT_ENABLED, TRUE );
338                      break;
339            case 'O':
340                      tr_bencDictAddBool( &settings, TR_PREFS_KEY_DHT_ENABLED, FALSE );
341                      break;
342            case 'p': tr_bencDictAddInt( &settings, TR_PREFS_KEY_RPC_PORT, atoi( optarg ) );
343                      break;
344            case 't': tr_bencDictAddBool( &settings, TR_PREFS_KEY_RPC_AUTH_REQUIRED, TRUE );
345                      break;
346            case 'T': tr_bencDictAddBool( &settings, TR_PREFS_KEY_RPC_AUTH_REQUIRED, FALSE );
347                      break;
348            case 'u': tr_bencDictAddStr( &settings, TR_PREFS_KEY_RPC_USERNAME, optarg );
349                      break;
350            case 'v': tr_bencDictAddStr( &settings, TR_PREFS_KEY_RPC_PASSWORD, optarg );
351                      break;
352            case 'w': tr_bencDictAddStr( &settings, TR_PREFS_KEY_DOWNLOAD_DIR, optarg );
353                      break;
354            case 'P': tr_bencDictAddInt( &settings, TR_PREFS_KEY_PEER_PORT, atoi( optarg ) );
355                      break;
356            case 'm': tr_bencDictAddBool( &settings, TR_PREFS_KEY_PORT_FORWARDING, TRUE );
357                      break;
358            case 'M': tr_bencDictAddBool( &settings, TR_PREFS_KEY_PORT_FORWARDING, FALSE );
359                      break;
360            case 'L': tr_bencDictAddInt( &settings, TR_PREFS_KEY_PEER_LIMIT_GLOBAL, atoi( optarg ) );
361                      break;
362            case 'l': tr_bencDictAddInt( &settings, TR_PREFS_KEY_PEER_LIMIT_TORRENT, atoi( optarg ) );
363                      break;
364            case 800: paused = TRUE;
365                      break;
366            case 910: tr_bencDictAddInt( &settings, TR_PREFS_KEY_ENCRYPTION, TR_ENCRYPTION_REQUIRED );
367                      break;
368            case 911: tr_bencDictAddInt( &settings, TR_PREFS_KEY_ENCRYPTION, TR_ENCRYPTION_PREFERRED );
369                      break;
370            case 912: tr_bencDictAddInt( &settings, TR_PREFS_KEY_ENCRYPTION, TR_CLEAR_PREFERRED );
371                      break;
372            case 'i':
373                      tr_bencDictAddStr( &settings, TR_PREFS_KEY_BIND_ADDRESS_IPV4, optarg );
374                      break;
375            case 'I':
376                      tr_bencDictAddStr( &settings, TR_PREFS_KEY_BIND_ADDRESS_IPV6, optarg );
377                      break;
378            case 'r':
379                      tr_bencDictAddStr( &settings, TR_PREFS_KEY_RPC_BIND_ADDRESS, optarg );
380                      break;
381            case 953:
382                      tr_bencDictAddReal( &settings, TR_PREFS_KEY_RATIO, atof(optarg) );
383                      tr_bencDictAddBool( &settings, TR_PREFS_KEY_RATIO_ENABLED, TRUE );
384                      break;
385            case 954:
386                      tr_bencDictAddBool( &settings, TR_PREFS_KEY_RATIO_ENABLED, FALSE );
387                      break;
388            default:  showUsage( );
389                      break;
390        }
391    }
392
393    if( dumpSettings )
394    {
395        char * str = tr_bencToStr( &settings, TR_FMT_JSON, NULL );
396        fprintf( stderr, "%s", str );
397        tr_free( str );
398        return 0;
399    }
400
401    if( !foreground && tr_daemon( TRUE, FALSE ) < 0 )
402    {
403        fprintf( stderr, "failed to daemonize: %s\n", strerror( errno ) );
404        exit( 1 );
405    }
406
407    /* start the session */
408    mySession = tr_sessionInit( "daemon", configDir, TRUE, &settings );
409
410    if( loaded )
411        tr_ninf( NULL, "Using settings from \"%s\"", configDir );
412    else
413        tr_nerr( NULL, "Couldn't find settings in \"%s\"; using defaults", configDir );
414
415    tr_sessionSaveSettings( mySession, configDir, &settings );
416
417    if( tr_bencDictFindBool( &settings, TR_PREFS_KEY_RPC_AUTH_REQUIRED, &boolVal ) && boolVal )
418        tr_ninf( MY_NAME, "requiring authentication" );
419
420    /* maybe add a watchdir */
421    {
422        const char * dir;
423
424        if( tr_bencDictFindBool( &settings, PREF_KEY_DIR_WATCH_ENABLED, &boolVal )
425            && boolVal
426            && tr_bencDictFindStr( &settings, PREF_KEY_DIR_WATCH, &dir )
427            && dir
428            && *dir )
429        {
430            tr_inf( "Watching \"%s\" for new .torrent files", dir );
431            watchdir = dtr_watchdir_new( mySession, dir, onFileAdded );
432        }
433    }
434
435    /* load the torrents */
436    {
437        tr_torrent ** torrents;
438        tr_ctor * ctor = tr_ctorNew( mySession );
439        if( paused )
440            tr_ctorSetPaused( ctor, TR_FORCE, TRUE );
441        torrents = tr_sessionLoadTorrents( mySession, ctor, NULL );
442        tr_free( torrents );
443        tr_ctorFree( ctor );
444    }
445
446#ifdef HAVE_SYSLOG
447    if( !foreground )
448        openlog( MY_NAME, LOG_CONS, LOG_DAEMON );
449#endif
450
451    while( !closing ) {
452        tr_wait_msec( 1000 ); /* sleep one second */
453        dtr_watchdir_update( watchdir );
454        pumpLogMessages( foreground );
455    }
456
457    closelog( );
458
459    /* shutdown */
460#if HAVE_SYSLOG
461    if( !foreground )
462        syslog( LOG_INFO, "%s", "Closing session" );
463#endif
464    printf( "Closing transmission session..." );
465    tr_sessionSaveSettings( mySession, configDir, &settings );
466    dtr_watchdir_free( watchdir );
467    tr_sessionClose( mySession );
468    printf( " done.\n" );
469
470    /* cleanup */
471    tr_bencFree( &settings );
472    return 0;
473}
Note: See TracBrowser for help on using the repository browser.