source: trunk/daemon/daemon.c @ 10162

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

(trunk daemon) #2890 "Add option to specify logfile in transmission-daemon" -- implemented for 1.90

  • Property svn:keywords set to Date Rev Author Id
File size: 16.3 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 10162 2010-02-11 01:37:59Z 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    { 'e', "logfile", "Dump the log messages to this filename", "e", 1, "<filename>" },
75    { 'f', "foreground", "Run in the foreground instead of daemonizing", "f", 0, NULL },
76    { 'g', "config-dir", "Where to look for configuration files", "g", 1, "<path>" },
77    { 'p', "port", "RPC port (Default: " TR_DEFAULT_RPC_PORT_STR ")", "p", 1, "<port>" },
78    { 't', "auth", "Require authentication", "t", 0, NULL },
79    { 'T', "no-auth", "Don't require authentication", "T", 0, NULL },
80    { 'u', "username", "Set username for authentication", "u", 1, "<username>" },
81    { 'v', "password", "Set password for authentication", "v", 1, "<password>" },
82    { 'V', "version", "Show version number and exit", "V", 0, NULL },
83    { 'w', "download-dir", "Where to save downloaded data", "w", 1, "<path>" },
84    { 800, "paused", "Pause all torrents on startup", NULL, 0, NULL },
85    { 'o', "dht", "Enable distributed hash tables (DHT)", "o", 0, NULL },
86    { 'O', "no-dht", "Disable distributed hash tables (DHT)", "O", 0, NULL },
87    { 'P', "peerport", "Port for incoming peers (Default: " TR_DEFAULT_PEER_PORT_STR ")", "P", 1, "<port>" },
88    { 'm', "portmap", "Enable portmapping via NAT-PMP or UPnP", "m", 0, NULL },
89    { 'M', "no-portmap", "Disable portmapping", "M", 0, NULL },
90    { 'L', "peerlimit-global", "Maximum overall number of peers (Default: " TR_DEFAULT_PEER_LIMIT_GLOBAL_STR ")", "L", 1, "<limit>" },
91    { 'l', "peerlimit-torrent", "Maximum number of peers per torrent (Default: " TR_DEFAULT_PEER_LIMIT_TORRENT_STR ")", "l", 1, "<limit>" },
92    { 910, "encryption-required",  "Encrypt all peer connections", "er", 0, NULL },
93    { 911, "encryption-preferred", "Prefer encrypted peer connections", "ep", 0, NULL },
94    { 912, "encryption-tolerated", "Prefer unencrypted peer connections", "et", 0, NULL },
95    { 'i', "bind-address-ipv4", "Where to listen for peer connections", "i", 1, "<ipv4 address>" },
96    { 'I', "bind-address-ipv6", "Where to listen for peer connections", "I", 1, "<ipv6 address>" },
97    { 'r', "rpc-bind-address", "Where to listen for RPC connections", "r", 1, "<ipv4 address>" },
98    { 953, "global-seedratio", "All torrents, unless overridden by a per-torrent setting, should seed until a specific ratio", "gsr", 1, "ratio" },
99    { 954, "no-global-seedratio", "All torrents, unless overridden by a per-torrent setting, should seed regardless of ratio", "GSR", 0, NULL },
100    { 0, NULL, NULL, NULL, 0, NULL }
101};
102
103static void
104showUsage( void )
105{
106    tr_getopt_usage( MY_NAME, getUsage( ), options );
107    exit( 0 );
108}
109
110static void
111gotsig( int sig )
112{
113    switch( sig )
114    {
115        case SIGHUP:
116        {
117            tr_benc settings;
118            const char * configDir = tr_sessionGetConfigDir( mySession );
119            tr_inf( "Reloading settings from \"%s\"", configDir );
120            tr_bencInitDict( &settings, 0 );
121            tr_sessionLoadSettings( &settings, configDir, MY_NAME );
122            tr_sessionSet( mySession, &settings );
123            tr_bencFree( &settings );
124            tr_sessionReloadBlocklists( mySession );
125            break;
126        }
127
128        default:
129            closing = TRUE;
130            break;
131    }
132}
133
134#if defined(WIN32)
135 #define USE_NO_DAEMON
136#elif !defined(HAVE_DAEMON) || defined(__UCLIBC__)
137 #define USE_TR_DAEMON
138#else
139 #define USE_OS_DAEMON
140#endif
141
142static int
143tr_daemon( int nochdir, int noclose )
144{
145#if defined(USE_OS_DAEMON)
146    return daemon( nochdir, noclose );
147#elif defined(USE_TR_DAEMON)
148    pid_t pid = fork( );
149    if( pid < 0 )
150        return -1;
151    else if( pid > 0 )
152        _exit( 0 );
153    else {
154        pid = setsid( );
155        if( pid < 0 )
156            return -1;
157
158        pid = fork( );
159        if( pid < 0 )
160            return -1;
161        else if( pid > 0 )
162            _exit( 0 );
163        else {
164
165            if( !nochdir )
166                if( chdir( "/" ) < 0 )
167                    return -1;
168
169            umask( (mode_t)0 );
170
171            if( !noclose ) {
172                /* send stdin, stdout, and stderr to /dev/null */
173                int i;
174                int fd = open( "/dev/null", O_RDWR, 0 );
175                for( i=0; i<3; ++i ) {
176                    if( close( i ) )
177                        return -1;
178                    dup2( fd, i );
179                }
180                close( fd );
181            }
182
183            return 0;
184        }
185    }
186#else /* USE_NO_DAEMON */
187    return 0;
188#endif
189}
190
191static const char*
192getConfigDir( int argc, const char ** argv )
193{
194    int c;
195    const char * configDir = NULL;
196    const char * optarg;
197    const int ind = tr_optind;
198
199    while(( c = tr_getopt( getUsage( ), argc, argv, options, &optarg ))) {
200        if( c == 'g' ) {
201            configDir = optarg;
202            break;
203        }
204    }
205
206    tr_optind = ind;
207
208    if( configDir == NULL )
209        configDir = tr_getDefaultConfigDir( MY_NAME );
210
211    return configDir;
212}
213
214static void
215onFileAdded( tr_session * session, const char * dir, const char * file )
216{
217    if( strstr( file, ".torrent" ) != NULL )
218    {
219        char * filename = tr_buildPath( dir, file, NULL );
220        tr_ctor * ctor = tr_ctorNew( session );
221
222        int err = tr_ctorSetMetainfoFromFile( ctor, filename );
223        if( !err )
224            tr_torrentNew( ctor, &err );
225
226        tr_ctorFree( ctor );
227        tr_free( filename );
228    }
229}
230
231static void
232printMessage( FILE * logfile, int level, const char * name, const char * message, const char * file, int line )
233{
234    if( logfile != NULL )
235    {
236        char timestr[64];
237        tr_getLogTimeStr( timestr, sizeof( timestr ) );
238        if( name )
239            fprintf( logfile, "[%s] %s %s (%s:%d)\n", timestr, name, message, file, line );
240        else
241            fprintf( logfile, "[%s] %s (%s:%d)\n", timestr, message, file, line );
242    }
243#ifdef HAVE_SYSLOG
244    else /* daemon... write to syslog */
245    {
246        int priority;
247
248        /* figure out the syslog priority */
249        switch( level ) {
250            case TR_MSG_ERR: priority = LOG_ERR; break;
251            case TR_MSG_DBG: priority = LOG_DEBUG; break;
252            default: priority = LOG_INFO; break;
253        }
254
255        if( name )
256            syslog( priority, "%s %s (%s:%d)", name, message, file, line );
257        else
258            syslog( priority, "%s (%s:%d)", message, file, line );
259    }
260#endif
261}
262
263static void
264pumpLogMessages( FILE * logfile )
265{
266    const tr_msg_list * l;
267    tr_msg_list * list = tr_getQueuedMessages( );
268
269    for( l=list; l!=NULL; l=l->next )
270        printMessage( logfile, l->level, l->name, l->message, l->file, l->line );
271
272    tr_freeMessageList( list );
273}
274
275int
276main( int argc, char ** argv )
277{
278    int c;
279    const char * optarg;
280    tr_benc settings;
281    tr_bool boolVal;
282    tr_bool loaded;
283    tr_bool foreground = FALSE;
284    tr_bool dumpSettings = FALSE;
285    const char * configDir = NULL;
286    dtr_watchdir * watchdir = NULL;
287    FILE * logfile = NULL;
288
289    signal( SIGINT, gotsig );
290    signal( SIGTERM, gotsig );
291#ifndef WIN32
292    signal( SIGHUP, gotsig );
293#endif
294
295    /* load settings from defaults + config file */
296    tr_bencInitDict( &settings, 0 );
297    configDir = getConfigDir( argc, (const char**)argv );
298    loaded = tr_sessionLoadSettings( &settings, configDir, MY_NAME );
299
300    /* overwrite settings from the comamndline */
301    tr_optind = 1;
302    while(( c = tr_getopt( getUsage(), argc, (const char**)argv, options, &optarg ))) {
303        switch( c ) {
304            case 'a': tr_bencDictAddStr( &settings, TR_PREFS_KEY_RPC_WHITELIST, optarg );
305                      tr_bencDictAddBool( &settings, TR_PREFS_KEY_RPC_WHITELIST_ENABLED, TRUE );
306                      break;
307            case 'b': tr_bencDictAddBool( &settings, TR_PREFS_KEY_BLOCKLIST_ENABLED, TRUE );
308                      break;
309            case 'B': tr_bencDictAddBool( &settings, TR_PREFS_KEY_BLOCKLIST_ENABLED, FALSE );
310                      break;
311            case 'c': tr_bencDictAddStr( &settings, PREF_KEY_DIR_WATCH, optarg );
312                      tr_bencDictAddBool( &settings, PREF_KEY_DIR_WATCH_ENABLED, TRUE );
313                      break;
314            case 'C': tr_bencDictAddBool( &settings, PREF_KEY_DIR_WATCH_ENABLED, FALSE );
315                      break;
316            case 941:
317                      tr_bencDictAddStr( &settings, TR_PREFS_KEY_INCOMPLETE_DIR, optarg );
318                      tr_bencDictAddBool( &settings, TR_PREFS_KEY_INCOMPLETE_DIR_ENABLED, TRUE );
319                      break;
320            case 942:
321                      tr_bencDictAddBool( &settings, TR_PREFS_KEY_INCOMPLETE_DIR_ENABLED, FALSE );
322                      break;
323            case 'd': dumpSettings = TRUE;
324                      break;
325            case 'e': logfile = fopen( optarg, "a+" );
326                      if( logfile == NULL )
327                          fprintf( stderr, "Couldn't open \"%s\": %s\n", optarg, tr_strerror( errno ) );
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( foreground && !logfile )
394        logfile = stderr;
395
396    if( !loaded )
397    {
398        printMessage( logfile, TR_MSG_ERR, MY_NAME, "Error loading config file -- exiting.", __FILE__, __LINE__ );
399        return -1;
400    }
401
402    if( dumpSettings )
403    {
404        char * str = tr_bencToStr( &settings, TR_FMT_JSON, NULL );
405        fprintf( stderr, "%s", str );
406        tr_free( str );
407        return 0;
408    }
409
410    if( !foreground && tr_daemon( TRUE, FALSE ) < 0 )
411    {
412        char buf[256];
413        tr_snprintf( buf, sizeof( buf ), "Failed to dameonize: %s", tr_strerror( errno ) );
414        printMessage( logfile, TR_MSG_ERR, MY_NAME, buf, __FILE__, __LINE__ );
415        exit( 1 );
416    }
417
418    /* start the session */
419    mySession = tr_sessionInit( "daemon", configDir, TRUE, &settings );
420    tr_ninf( NULL, "Using settings from \"%s\"", configDir );
421    tr_sessionSaveSettings( mySession, configDir, &settings );
422
423    if( tr_bencDictFindBool( &settings, TR_PREFS_KEY_RPC_AUTH_REQUIRED, &boolVal ) && boolVal )
424        tr_ninf( MY_NAME, "requiring authentication" );
425
426    /* maybe add a watchdir */
427    {
428        const char * dir;
429
430        if( tr_bencDictFindBool( &settings, PREF_KEY_DIR_WATCH_ENABLED, &boolVal )
431            && boolVal
432            && tr_bencDictFindStr( &settings, PREF_KEY_DIR_WATCH, &dir )
433            && dir
434            && *dir )
435        {
436            tr_inf( "Watching \"%s\" for new .torrent files", dir );
437            watchdir = dtr_watchdir_new( mySession, dir, onFileAdded );
438        }
439    }
440
441    /* load the torrents */
442    {
443        tr_torrent ** torrents;
444        tr_ctor * ctor = tr_ctorNew( mySession );
445        if( paused )
446            tr_ctorSetPaused( ctor, TR_FORCE, TRUE );
447        torrents = tr_sessionLoadTorrents( mySession, ctor, NULL );
448        tr_free( torrents );
449        tr_ctorFree( ctor );
450    }
451
452#ifdef HAVE_SYSLOG
453    if( !foreground )
454        openlog( MY_NAME, LOG_CONS, LOG_DAEMON );
455#endif
456
457    while( !closing ) {
458        tr_wait_msec( 1000 ); /* sleep one second */
459        dtr_watchdir_update( watchdir );
460        pumpLogMessages( logfile );
461    }
462
463    closelog( );
464
465    /* shutdown */
466#if HAVE_SYSLOG
467    if( !foreground )
468        syslog( LOG_INFO, "%s", "Closing session" );
469#endif
470    printf( "Closing transmission session..." );
471    tr_sessionSaveSettings( mySession, configDir, &settings );
472    dtr_watchdir_free( watchdir );
473    tr_sessionClose( mySession );
474    printf( " done.\n" );
475
476    /* cleanup */
477    tr_bencFree( &settings );
478    return 0;
479}
Note: See TracBrowser for help on using the repository browser.