source: trunk/libtransmission/platform.c @ 8163

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

(trunk libT) tr_getDefaultDownloadDir(): always honor $XDG_CONFIG_HOME/user-dirs.dirs if it exists.

  • Property svn:keywords set to Date Rev Author Id
File size: 18.9 KB
Line 
1/*
2 * This file Copyright (C) 2008-2009 Charles Kerr <charles@transmissionbt.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: platform.c 8163 2009-04-06 16:10:37Z charles $
11 */
12
13#ifdef WIN32
14 #include <windows.h>
15 #include <shlobj.h> /* for CSIDL_APPDATA, CSIDL_MYDOCUMENTS */
16#else
17 #ifdef SYS_DARWIN
18  #include <CoreFoundation/CoreFoundation.h>
19 #endif
20
21 #define _XOPEN_SOURCE 600  /* needed for recursive locks. */
22 #ifndef __USE_UNIX98
23  #define __USE_UNIX98 /* some older Linuxes need it spelt out for them */
24 #endif
25 #include <pthread.h>
26#endif
27
28#include <assert.h>
29#include <stdio.h>
30#include <stdlib.h>
31#include <string.h>
32
33#include <sys/stat.h>
34#include <sys/types.h>
35#ifdef WIN32
36#include <libgen.h>
37#endif
38#include <dirent.h>
39#include <fcntl.h>
40#include <unistd.h> /* getuid getpid close */
41
42#include "transmission.h"
43#include "session.h"
44#include "list.h"
45#include "platform.h"
46#include "utils.h"
47
48/***
49****  THREADS
50***/
51
52#ifdef WIN32
53typedef DWORD tr_thread_id;
54#else
55typedef pthread_t tr_thread_id;
56#endif
57
58static tr_thread_id
59tr_getCurrentThread( void )
60{
61#ifdef WIN32
62    return GetCurrentThreadId( );
63#else
64    return pthread_self( );
65#endif
66}
67
68static int
69tr_areThreadsEqual( tr_thread_id a,
70                    tr_thread_id b )
71{
72#ifdef WIN32
73    return a == b;
74#else
75    return pthread_equal( a, b );
76#endif
77}
78
79struct tr_thread
80{
81    void            ( * func )( void * );
82    void *          arg;
83    tr_thread_id    thread;
84#ifdef WIN32
85    HANDLE          thread_handle;
86#endif
87};
88
89int
90tr_amInThread( const tr_thread * t )
91{
92    return tr_areThreadsEqual( tr_getCurrentThread( ), t->thread );
93}
94
95#ifdef WIN32
96 #define ThreadFuncReturnType unsigned WINAPI
97#else
98 #define ThreadFuncReturnType void
99#endif
100
101static ThreadFuncReturnType
102ThreadFunc( void * _t )
103{
104    tr_thread * t = _t;
105
106    t->func( t->arg );
107
108#ifdef WIN32
109    _endthreadex( 0 );
110    return 0;
111#endif
112}
113
114tr_thread *
115tr_threadNew( void   ( *func )(void *),
116              void * arg )
117{
118    tr_thread * t = tr_new0( tr_thread, 1 );
119
120    t->func = func;
121    t->arg  = arg;
122
123#ifdef WIN32
124    {
125        unsigned int id;
126        t->thread_handle =
127            (HANDLE) _beginthreadex( NULL, 0, &ThreadFunc, t, 0,
128                                     &id );
129        t->thread = (DWORD) id;
130    }
131#else
132    pthread_create( &t->thread, NULL, ( void * ( * )(
133                                           void * ) )ThreadFunc, t );
134#endif
135
136    return t;
137}
138
139/***
140****  LOCKS
141***/
142
143struct tr_lock
144{
145    int                 depth;
146#ifdef WIN32
147    CRITICAL_SECTION    lock;
148    DWORD               lockThread;
149#else
150    pthread_mutex_t     lock;
151    pthread_t           lockThread;
152#endif
153};
154
155tr_lock*
156tr_lockNew( void )
157{
158    tr_lock *           l = tr_new0( tr_lock, 1 );
159
160#ifdef WIN32
161    InitializeCriticalSection( &l->lock ); /* supports recursion */
162#else
163    pthread_mutexattr_t attr;
164    pthread_mutexattr_init( &attr );
165    pthread_mutexattr_settype( &attr, PTHREAD_MUTEX_RECURSIVE );
166    pthread_mutex_init( &l->lock, &attr );
167#endif
168
169    return l;
170}
171
172void
173tr_lockFree( tr_lock * l )
174{
175#ifdef WIN32
176    DeleteCriticalSection( &l->lock );
177#else
178    pthread_mutex_destroy( &l->lock );
179#endif
180    tr_free( l );
181}
182
183void
184tr_lockLock( tr_lock * l )
185{
186#ifdef WIN32
187    EnterCriticalSection( &l->lock );
188#else
189    pthread_mutex_lock( &l->lock );
190#endif
191    assert( l->depth >= 0 );
192    if( l->depth )
193        assert( tr_areThreadsEqual( l->lockThread, tr_getCurrentThread( ) ) );
194    l->lockThread = tr_getCurrentThread( );
195    ++l->depth;
196}
197
198int
199tr_lockHave( const tr_lock * l )
200{
201    return ( l->depth > 0 )
202           && ( tr_areThreadsEqual( l->lockThread, tr_getCurrentThread( ) ) );
203}
204
205void
206tr_lockUnlock( tr_lock * l )
207{
208    assert( l->depth > 0 );
209    assert( tr_areThreadsEqual( l->lockThread, tr_getCurrentThread( ) ) );
210
211    --l->depth;
212    assert( l->depth >= 0 );
213#ifdef WIN32
214    LeaveCriticalSection( &l->lock );
215#else
216    pthread_mutex_unlock( &l->lock );
217#endif
218}
219
220/***
221****  PATHS
222***/
223
224#ifndef WIN32
225 #include <pwd.h>
226#endif
227
228static const char *
229getHomeDir( void )
230{
231    static char * home = NULL;
232
233    if( !home )
234    {
235        home = tr_strdup( getenv( "HOME" ) );
236
237        if( !home )
238        {
239#ifdef WIN32
240            char appdata[MAX_PATH]; /* SHGetFolderPath() requires MAX_PATH */
241            *appdata = '\0';
242            SHGetFolderPath( NULL, CSIDL_PERSONAL, NULL, 0, appdata );
243            home = tr_strdup( appdata );
244#else
245            struct passwd * pw = getpwuid( getuid( ) );
246            if( pw )
247                home = tr_strdup( pw->pw_dir );
248            endpwent( );
249#endif
250        }
251
252        if( !home )
253            home = tr_strdup( "" );
254    }
255
256    return home;
257}
258
259static const char *
260getOldConfigDir( void )
261{
262    static char * path = NULL;
263
264    if( !path )
265    {
266#ifdef SYS_DARWIN
267        path = tr_buildPath( getHomeDir( ), "Library",
268                              "Application Support",
269                              "Transmission", NULL );
270#elif defined( WIN32 )
271        char appdata[MAX_PATH]; /* SHGetFolderPath() requires MAX_PATH */
272        SHGetFolderPath( NULL, CSIDL_APPDATA, NULL, 0, appdata );
273        path = tr_buildPath( appdata, "Transmission", NULL );
274#else
275        path = tr_buildPath( getHomeDir( ), ".transmission", NULL );
276#endif
277    }
278
279    return path;
280}
281
282#if defined(SYS_DARWIN) || defined(WIN32)
283 #define RESUME_SUBDIR  "Resume"
284 #define TORRENT_SUBDIR "Torrents"
285#else
286 #define RESUME_SUBDIR  "resume"
287 #define TORRENT_SUBDIR "torrents"
288#endif
289
290static const char *
291getOldTorrentsDir( void )
292{
293    static char * path = NULL;
294
295    if( !path )
296        path = tr_buildPath( getOldConfigDir( ), TORRENT_SUBDIR, NULL );
297
298    return path;
299}
300
301static const char *
302getOldCacheDir( void )
303{
304    static char * path = NULL;
305
306    if( !path )
307    {
308#if defined( WIN32 )
309        path = tr_buildPath( getOldConfigDir( ), "Cache", NULL );
310#elif defined( SYS_DARWIN )
311        path = tr_buildPath( getHomeDir( ), "Library", "Caches", "Transmission", NULL );
312#else
313        path = tr_buildPath( getOldConfigDir( ), "cache", NULL );
314#endif
315    }
316
317    return path;
318}
319
320static void
321moveFiles( const char * oldDir,
322           const char * newDir )
323{
324    if( oldDir && newDir && strcmp( oldDir, newDir ) )
325    {
326        DIR * dirh = opendir( oldDir );
327        if( dirh )
328        {
329            int             count = 0;
330            struct dirent * dirp;
331            while( ( dirp = readdir( dirh ) ) )
332            {
333                if( strcmp( dirp->d_name,
334                            "." ) && strcmp( dirp->d_name, ".." ) )
335                {
336                    char * o = tr_buildPath( oldDir, dirp->d_name, NULL );
337                    char * n = tr_buildPath( newDir, dirp->d_name, NULL );
338                    rename( o, n );
339                    ++count;
340                    tr_free( n );
341                    tr_free( o );
342                }
343            }
344
345            if( count )
346                tr_inf( _( "Migrated %1$d files from \"%2$s\" to \"%3$s\"" ),
347                        count, oldDir, newDir );
348            closedir( dirh );
349        }
350    }
351}
352
353static void
354migrateFiles( const tr_session * session )
355{
356    static int migrated = FALSE;
357
358    if( !migrated )
359    {
360        const char * oldDir;
361        const char * newDir;
362        migrated = TRUE;
363
364        oldDir = getOldTorrentsDir( );
365        newDir = tr_getTorrentDir( session );
366        moveFiles( oldDir, newDir );
367
368        oldDir = getOldCacheDir( );
369        newDir = tr_getResumeDir( session );
370        moveFiles( oldDir, newDir );
371    }
372}
373
374void
375tr_setConfigDir( tr_session * session,
376                 const char * configDir )
377{
378    char * path;
379
380    session->configDir = tr_strdup( configDir );
381
382    path = tr_buildPath( configDir, RESUME_SUBDIR, NULL );
383    tr_mkdirp( path, 0777 );
384    session->resumeDir = path;
385
386    path = tr_buildPath( configDir, TORRENT_SUBDIR, NULL );
387    tr_mkdirp( path, 0777 );
388    session->torrentDir = path;
389
390    migrateFiles( session );
391}
392
393const char *
394tr_sessionGetConfigDir( const tr_session * session )
395{
396    return session->configDir;
397}
398
399const char *
400tr_getTorrentDir( const tr_session * session )
401{
402    return session->torrentDir;
403}
404
405const char *
406tr_getResumeDir( const tr_session * session )
407{
408    return session->resumeDir;
409}
410
411const char*
412tr_getDefaultConfigDir( const char * appname )
413{
414    static char * s = NULL;
415
416    if( !appname || !*appname )
417        appname = "Transmission";
418
419    if( !s )
420    {
421        if( ( s = getenv( "TRANSMISSION_HOME" ) ) )
422        {
423            s = tr_strdup( s );
424        }
425        else
426        {
427#ifdef SYS_DARWIN
428            s = tr_buildPath( getHomeDir( ), "Library", "Application Support",
429                              appname, NULL );
430#elif defined( WIN32 )
431            char appdata[MAX_PATH]; /* SHGetFolderPath() requires MAX_PATH */
432            SHGetFolderPath( NULL, CSIDL_APPDATA, NULL, 0, appdata );
433            s = tr_buildPath( appdata, appname, NULL );
434#else
435            if( ( s = getenv( "XDG_CONFIG_HOME" ) ) )
436                s = tr_buildPath( s, appname, NULL );
437            else
438                s = tr_buildPath( getHomeDir( ), ".config", appname, NULL );
439#endif
440        }
441    }
442
443    return s;
444}
445
446const char*
447tr_getDefaultDownloadDir( void )
448{
449    static char * user_dir = NULL;
450
451    if( user_dir == NULL )
452    {
453        const char * config_home;
454        char * config_file;
455        char * content;
456        size_t content_len;
457
458        /* figure out where to look for user-dirs.dirs */
459        config_home = getenv( "XDG_CONFIG_HOME" );
460        if( config_home && *config_home )
461            config_file = tr_buildPath( config_home, "user-dirs.dirs", NULL );
462        else
463            config_file = tr_buildPath( getHomeDir( ), ".config", "user-dirs.dirs", NULL );
464
465        /* read in user-dirs.dirs and look for the download dir entry */
466        content = (char *) tr_loadFile( config_file, &content_len );
467        if( content && content_len>0 )
468        {
469            const char * key = "XDG_DOWNLOAD_DIR=\"";
470            char * line = strstr( content, key );
471            if( line != NULL )
472            {
473                char * value = line + strlen( key );
474                char * end = strchr( value, '"' );
475
476                if( end )
477                {
478                    *end = '\0';
479
480                    if( !memcmp( value, "$HOME/", 6 ) )
481                        user_dir = tr_buildPath( getHomeDir( ), value+6, NULL );
482                    else
483                        user_dir = tr_strdup( value );
484                }
485            }
486        }
487
488        if( user_dir == NULL )
489            user_dir = tr_buildPath( getHomeDir( ), "Downloads", NULL );
490
491        tr_free( content );
492        tr_free( config_file );
493    }
494
495    return user_dir;
496}
497
498/***
499****
500***/
501
502static int
503isClutchDir( const char * path )
504{
505    struct stat sb;
506    char * tmp = tr_buildPath( path, "javascript", "transmission.js", NULL );
507    const int ret = !stat( tmp, &sb );
508    tr_inf( _( "Searching for web interface file \"%s\"" ), tmp );
509    tr_free( tmp );
510    return ret;
511   
512}
513
514const char *
515tr_getClutchDir( const tr_session * session UNUSED )
516{
517    static char * s = NULL;
518
519    if( !s )
520    {
521        if( ( s = getenv( "CLUTCH_HOME" ) ) )
522        {
523            s = tr_strdup( s );
524        }
525        else if( ( s = getenv( "TRANSMISSION_WEB_HOME" ) ) )
526        {
527            s = tr_strdup( s );
528        }
529        else
530        {
531
532#ifdef SYS_DARWIN /* on Mac, look in the app package first, then the Application Support folder (for daemon, etc) */
533
534            CFURLRef appURL = CFBundleCopyBundleURL( CFBundleGetMainBundle( ) );
535            CFStringRef appRef = CFURLCopyFileSystemPath( appURL,
536                                                         kCFURLPOSIXPathStyle );
537            const char * appString = CFStringGetCStringPtr( appRef,
538                                         CFStringGetFastestEncoding( appRef ) );
539            CFRelease( appURL );
540            CFRelease( appRef );
541
542            s = tr_buildPath( appString, "Contents", "Resources", "web", NULL );
543           
544            if( !isClutchDir( s ) ) {
545                tr_free( s );
546               
547                /* Fallback to the Application Support folder */
548                s = tr_buildPath( tr_sessionGetConfigDir( session ), "web", NULL );
549                if( !isClutchDir( s ) ) {
550                    tr_free( s );
551                    s = NULL;
552                }
553            }
554
555#elif defined( WIN32 )
556
557            /* SHGetFolderPath explicitly requires MAX_PATH length */
558            char dir[MAX_PATH];
559           
560            /* Generally, Web interface should be stored in a Web subdir of
561             * calling executable dir. */
562
563            if( s == NULL ) { 
564                /* First, we should check personal AppData/Transmission/Web */
565                SHGetFolderPath( NULL, CSIDL_COMMON_APPDATA, NULL, 0, dir );
566                s = tr_buildPath( dir, "Transmission", "Web", NULL );
567                if( !isClutchDir( s ) ) {
568                    tr_free( s );
569                    s = NULL;
570                }
571            }
572
573            if( s == NULL ) {
574                /* check personal AppData */
575                SHGetFolderPath( NULL, CSIDL_APPDATA, NULL, 0, dir );
576                s = tr_buildPath( dir, "Transmission", "Web", NULL );
577                if( !isClutchDir( s ) ) {
578                    tr_free( s );
579                    s = NULL;
580                }
581            }
582
583            if( s == NULL) {
584                /* check calling module place */
585                GetModuleFileName( GetModuleHandle( NULL ), dir, sizeof( dir ) );
586                s = tr_buildPath( dirname( dir ), "Web", NULL );
587                if( !isClutchDir( s ) ) {
588                    tr_free( s );
589                    s = NULL;
590                }
591            }
592
593#else /* everyone else, follow the XDG spec */
594
595            tr_list *candidates = NULL, *l;
596            const char * tmp;
597
598            /* XDG_DATA_HOME should be the first in the list of candidates */
599            tmp = getenv( "XDG_DATA_HOME" );
600            if( tmp && *tmp )
601                tr_list_append( &candidates, tr_strdup( tmp ) );
602            else {
603                char * dhome = tr_buildPath( getHomeDir( ), ".local", "share", NULL );
604                tr_list_append( &candidates, dhome );
605            }
606
607            /* XDG_DATA_DIRS are the backup directories */
608            {
609                const char * pkg = PACKAGE_DATA_DIR;
610                const char * xdg = getenv( "XDG_DATA_DIRS" );
611                const char * fallback = "/usr/local/share:/usr/share";
612                char * buf = tr_strdup_printf( "%s:%s:%s", (pkg?pkg:""), (xdg?xdg:""), fallback );
613                tmp = buf;
614                while( tmp && *tmp ) {
615                    const char * end = strchr( tmp, ':' );
616                    if( end ) {
617                        if( ( end - tmp ) > 1 )
618                            tr_list_append( &candidates, tr_strndup( tmp, end - tmp ) );
619                        tmp = end + 1;
620                    } else if( tmp && *tmp ) {
621                        tr_list_append( &candidates, tr_strdup( tmp ) );
622                        break;
623                    }
624                }
625                tr_free( buf );
626            }
627
628            /* walk through the candidates & look for a match */
629            for( l=candidates; l; l=l->next ) {
630                char * path = tr_buildPath( l->data, "transmission", "web", NULL );
631                const int found = isClutchDir( path );
632                if( found ) {
633                    s = path;
634                    break;
635                }
636                tr_free( path );
637            }
638
639            tr_list_free( &candidates, tr_free );
640
641#endif
642
643        }
644    }
645
646    return s;
647}
648
649/***
650****
651***/
652
653tr_lockfile_state_t
654tr_lockfile( const char * filename )
655{
656    tr_lockfile_state_t ret;
657
658#ifdef WIN32
659
660    HANDLE              file = CreateFile(
661        filename,
662        GENERIC_READ | GENERIC_WRITE,
663        FILE_SHARE_READ |
664        FILE_SHARE_WRITE,
665        NULL,
666        OPEN_ALWAYS,
667        FILE_ATTRIBUTE_NORMAL,
668        NULL );
669    if( file == INVALID_HANDLE_VALUE )
670        ret = TR_LOCKFILE_EOPEN;
671    else if( !LockFile( file, 0, 0, 1, 1 ) )
672        ret = TR_LOCKFILE_ELOCK;
673    else
674        ret = TR_LOCKFILE_SUCCESS;
675
676#else
677
678    int fd = open( filename, O_RDWR | O_CREAT, 0666 );
679    if( fd < 0 )
680        ret = TR_LOCKFILE_EOPEN;
681    else
682    {
683        struct flock lk;
684        memset( &lk, 0,  sizeof( lk ) );
685        lk.l_start = 0;
686        lk.l_len = 0;
687        lk.l_type = F_WRLCK;
688        lk.l_whence = SEEK_SET;
689        if( -1 == fcntl( fd, F_SETLK, &lk ) )
690            ret = TR_LOCKFILE_ELOCK;
691        else
692            ret = TR_LOCKFILE_SUCCESS;
693    }
694
695#endif
696
697    return ret;
698}
699
700#ifdef WIN32
701
702/* The following mmap functions are by Joerg Walter, and were taken from
703 * his paper at: http://www.genesys-e.de/jwalter/mix4win.htm
704 */
705
706#if defined(_MSC_VER)
707__declspec( align( 4 ) ) static LONG volatile g_sl;
708#else
709static LONG volatile g_sl __attribute__ ( ( aligned ( 4 ) ) );
710#endif
711
712/* Wait for spin lock */
713static int
714slwait( LONG volatile *sl )
715{
716    while( InterlockedCompareExchange ( sl, 1, 0 ) != 0 )
717        Sleep ( 0 );
718
719    return 0;
720}
721
722/* Release spin lock */
723static int
724slrelease( LONG volatile *sl )
725{
726    InterlockedExchange ( sl, 0 );
727    return 0;
728}
729
730/* getpagesize for windows */
731static long
732getpagesize( void )
733{
734    static long g_pagesize = 0;
735
736    if( !g_pagesize )
737    {
738        SYSTEM_INFO system_info;
739        GetSystemInfo ( &system_info );
740        g_pagesize = system_info.dwPageSize;
741    }
742    return g_pagesize;
743}
744
745static long
746getregionsize( void )
747{
748    static long g_regionsize = 0;
749
750    if( !g_regionsize )
751    {
752        SYSTEM_INFO system_info;
753        GetSystemInfo ( &system_info );
754        g_regionsize = system_info.dwAllocationGranularity;
755    }
756    return g_regionsize;
757}
758
759void *
760mmap( void *ptr,
761      long  size,
762      long  prot,
763      long  type,
764      long  handle,
765      long  arg )
766{
767    static long g_pagesize;
768    static long g_regionsize;
769
770    /* Wait for spin lock */
771    slwait ( &g_sl );
772    /* First time initialization */
773    if( !g_pagesize )
774        g_pagesize = getpagesize ( );
775    if( !g_regionsize )
776        g_regionsize = getregionsize ( );
777    /* Allocate this */
778    ptr = VirtualAlloc ( ptr, size,
779                         MEM_RESERVE | MEM_COMMIT | MEM_TOP_DOWN,
780                         PAGE_READWRITE );
781    if( !ptr )
782    {
783        ptr = (void *) -1;
784        goto mmap_exit;
785    }
786mmap_exit:
787    /* Release spin lock */
788    slrelease ( &g_sl );
789    return ptr;
790}
791
792long
793munmap( void *ptr,
794        long  size )
795{
796    static long g_pagesize;
797    static long g_regionsize;
798    int         rc = -1;
799
800    /* Wait for spin lock */
801    slwait ( &g_sl );
802    /* First time initialization */
803    if( !g_pagesize )
804        g_pagesize = getpagesize ( );
805    if( !g_regionsize )
806        g_regionsize = getregionsize ( );
807    /* Free this */
808    if( !VirtualFree ( ptr, 0,
809                       MEM_RELEASE ) )
810        goto munmap_exit;
811    rc = 0;
812munmap_exit:
813    /* Release spin lock */
814    slrelease ( &g_sl );
815    return rc;
816}
817
818#endif
819
Note: See TracBrowser for help on using the repository browser.