source: trunk/daemon/daemon.c @ 10783

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

(trunk) #2983: add command-line utilities for creating .torrent files, for editing passkeys, for adding/removing trackers, etc.

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