source: trunk/libtransmission/platform.c @ 6992

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

(rpc) fix r6861 regression: if libt can't find the Clutch files, give a helpful 404 message for end-users and binary packagers about how to use CLUTCH_HOME and PACKAGE_DATA_DIR.

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