source: trunk/daemon/daemon.c @ 10635

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

(trunk) #3060 "Local Peer Discovery" -- in the code, rename LDS as LPD for Local Peer Discovery

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