source: trunk/libtransmission/platform.c @ 7658

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

(trunk) update the GPL code's copyright dates

  • Property svn:keywords set to Date Rev Author Id
File size: 17.1 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 7658 2009-01-10 23:09:07Z 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 500  /* 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_MYDOCUMENTS, 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 * s = NULL;
450
451    if( s == NULL )
452        s = tr_buildPath( getHomeDir( ), "Downloads", NULL );
453
454    return s;
455}
456
457/***
458****
459***/
460
461static int
462isClutchDir( const char * path )
463{
464    struct stat sb;
465    char * tmp = tr_buildPath( path, "javascript", "transmission.js", NULL );
466    const int ret = !stat( tmp, &sb );
467    tr_inf( _( "Searching for web interface file \"%s\"" ), tmp );
468    tr_free( tmp );
469    return ret;
470   
471}
472
473const char *
474tr_getClutchDir( const tr_session * session UNUSED )
475{
476    static char * s = NULL;
477
478    if( !s )
479    {
480        if( ( s = getenv( "CLUTCH_HOME" ) ) )
481        {
482            s = tr_strdup( s );
483        }
484        else if( ( s = getenv( "TRANSMISSION_WEB_HOME" ) ) )
485        {
486            s = tr_strdup( s );
487        }
488        else
489        {
490
491#ifdef SYS_DARWIN
492
493            CFURLRef appURL = CFBundleCopyBundleURL( CFBundleGetMainBundle( ) );
494            CFStringRef appRef = CFURLCopyFileSystemPath( appURL,
495                                                         kCFURLPOSIXPathStyle );
496            const char * appString = CFStringGetCStringPtr( appRef,
497                                         CFStringGetFastestEncoding( appRef ) );
498            CFRelease( appURL );
499            CFRelease( appRef );
500
501            s = tr_buildPath( appString, "Contents", "Resources", "web", NULL );
502
503#elif defined( WIN32 )
504
505            /* SHGetFolderPath explicitly requires MAX_PATH length */
506            char dir[MAX_PATH];
507           
508            /* Generally, Web interface should be stored in a Web subdir of
509             * calling executable dir. */
510
511            if( s == NULL ) { 
512                /* First, we should check personal AppData/Transmission/Web */
513                SHGetFolderPath( NULL, CSIDL_COMMON_APPDATA, NULL, 0, dir );
514                s = tr_buildPath( dir, "Transmission", "Web", NULL );
515                if( !isClutchDir( s ) ) {
516                    tr_free( s );
517                    s = NULL;
518                }
519            }
520
521            if( s == NULL ) {
522                /* check personal AppData */
523                SHGetFolderPath( NULL, CSIDL_APPDATA, NULL, 0, dir );
524                s = tr_buildPath( dir, "Transmission", "Web", NULL );
525                if( !isClutchDir( s ) ) {
526                    tr_free( s );
527                    s = NULL;
528                }
529            }
530
531            if( s == NULL) {
532                /* check calling module place */
533                GetModuleFileName( GetModuleHandle( NULL ), dir, sizeof( dir ) );
534                s = tr_buildPath( dirname( dir ), "Web", NULL );
535                if( !isClutchDir( s ) ) {
536                    tr_free( s );
537                    s = NULL;
538                }
539            }
540
541#else /* everyone else, follow the XDG spec */
542
543            tr_list *candidates = NULL, *l;
544            const char * tmp;
545
546            /* XDG_DATA_HOME should be the first in the list of candidates */
547            tmp = getenv( "XDG_DATA_HOME" );
548            if( tmp && *tmp )
549                tr_list_append( &candidates, tr_strdup( tmp ) );
550            else {
551                char * dhome = tr_buildPath( getHomeDir( ), ".local", "share", NULL );
552                tr_list_append( &candidates, dhome );
553            }
554
555            /* XDG_DATA_DIRS are the backup directories */
556            {
557                const char * pkg = PACKAGE_DATA_DIR;
558                const char * xdg = getenv( "XDG_DATA_DIRS" );
559                const char * fallback = "/usr/local/share:/usr/share";
560                char * buf = tr_strdup_printf( "%s:%s:%s", (pkg?pkg:""), (xdg?xdg:""), fallback );
561                tmp = buf;
562                while( tmp && *tmp ) {
563                    const char * end = strchr( tmp, ':' );
564                    if( end ) {
565                        if( ( end - tmp ) > 1 )
566                            tr_list_append( &candidates, tr_strndup( tmp, end - tmp ) );
567                        tmp = end + 1;
568                    } else if( tmp && *tmp ) {
569                        tr_list_append( &candidates, tr_strdup( tmp ) );
570                        break;
571                    }
572                }
573                tr_free( buf );
574            }
575
576            /* walk through the candidates & look for a match */
577            for( l=candidates; l; l=l->next ) {
578                char * path = tr_buildPath( l->data, "transmission", "web", NULL );
579                const int found = isClutchDir( path );
580                if( found ) {
581                    s = path;
582                    break;
583                }
584                tr_free( path );
585            }
586
587            tr_list_free( &candidates, tr_free );
588
589#endif
590
591        }
592    }
593
594    return s;
595}
596
597/***
598****
599***/
600
601tr_lockfile_state_t
602tr_lockfile( const char * filename )
603{
604    tr_lockfile_state_t ret;
605
606#ifdef WIN32
607
608    HANDLE              file = CreateFile(
609        filename,
610        GENERIC_READ | GENERIC_WRITE,
611        FILE_SHARE_READ |
612        FILE_SHARE_WRITE,
613        NULL,
614        OPEN_ALWAYS,
615        FILE_ATTRIBUTE_NORMAL,
616        NULL );
617    if( file == INVALID_HANDLE_VALUE )
618        ret = TR_LOCKFILE_EOPEN;
619    else if( !LockFile( file, 0, 0, 1, 1 ) )
620        ret = TR_LOCKFILE_ELOCK;
621    else
622        ret = TR_LOCKFILE_SUCCESS;
623
624#else
625
626    int fd = open( filename, O_RDWR | O_CREAT, 0666 );
627    if( fd < 0 )
628        ret = TR_LOCKFILE_EOPEN;
629    else
630    {
631        struct flock lk;
632        memset( &lk, 0,  sizeof( lk ) );
633        lk.l_start = 0;
634        lk.l_len = 0;
635        lk.l_type = F_WRLCK;
636        lk.l_whence = SEEK_SET;
637        if( -1 == fcntl( fd, F_SETLK, &lk ) )
638            ret = TR_LOCKFILE_ELOCK;
639        else
640            ret = TR_LOCKFILE_SUCCESS;
641    }
642
643#endif
644
645    return ret;
646}
647
648#ifdef WIN32
649
650/* The following mmap functions are by Joerg Walter, and were taken from
651 * his paper at: http://www.genesys-e.de/jwalter/mix4win.htm
652 */
653
654#if defined(_MSC_VER)
655__declspec( align( 4 ) ) static LONG volatile g_sl;
656#else
657static LONG volatile g_sl __attribute__ ( ( aligned ( 4 ) ) );
658#endif
659
660/* Wait for spin lock */
661static int
662slwait( LONG volatile *sl )
663{
664    while( InterlockedCompareExchange ( sl, 1, 0 ) != 0 )
665        Sleep ( 0 );
666
667    return 0;
668}
669
670/* Release spin lock */
671static int
672slrelease( LONG volatile *sl )
673{
674    InterlockedExchange ( sl, 0 );
675    return 0;
676}
677
678/* getpagesize for windows */
679static long
680getpagesize( void )
681{
682    static long g_pagesize = 0;
683
684    if( !g_pagesize )
685    {
686        SYSTEM_INFO system_info;
687        GetSystemInfo ( &system_info );
688        g_pagesize = system_info.dwPageSize;
689    }
690    return g_pagesize;
691}
692
693static long
694getregionsize( void )
695{
696    static long g_regionsize = 0;
697
698    if( !g_regionsize )
699    {
700        SYSTEM_INFO system_info;
701        GetSystemInfo ( &system_info );
702        g_regionsize = system_info.dwAllocationGranularity;
703    }
704    return g_regionsize;
705}
706
707void *
708mmap( void *ptr,
709      long  size,
710      long  prot,
711      long  type,
712      long  handle,
713      long  arg )
714{
715    static long g_pagesize;
716    static long g_regionsize;
717
718    /* Wait for spin lock */
719    slwait ( &g_sl );
720    /* First time initialization */
721    if( !g_pagesize )
722        g_pagesize = getpagesize ( );
723    if( !g_regionsize )
724        g_regionsize = getregionsize ( );
725    /* Allocate this */
726    ptr = VirtualAlloc ( ptr, size,
727                         MEM_RESERVE | MEM_COMMIT | MEM_TOP_DOWN,
728                         PAGE_READWRITE );
729    if( !ptr )
730    {
731        ptr = (void *) -1;
732        goto mmap_exit;
733    }
734mmap_exit:
735    /* Release spin lock */
736    slrelease ( &g_sl );
737    return ptr;
738}
739
740long
741munmap( void *ptr,
742        long  size )
743{
744    static long g_pagesize;
745    static long g_regionsize;
746    int         rc = -1;
747
748    /* Wait for spin lock */
749    slwait ( &g_sl );
750    /* First time initialization */
751    if( !g_pagesize )
752        g_pagesize = getpagesize ( );
753    if( !g_regionsize )
754        g_regionsize = getregionsize ( );
755    /* Free this */
756    if( !VirtualFree ( ptr, 0,
757                       MEM_RELEASE ) )
758        goto munmap_exit;
759    rc = 0;
760munmap_exit:
761    /* Release spin lock */
762    slrelease ( &g_sl );
763    return rc;
764}
765
766#endif
767
Note: See TracBrowser for help on using the repository browser.