transmission/libtransmission/platform.c

732 lines
17 KiB
C
Raw Normal View History

/*
* This file Copyright (C) 2008 Charles Kerr <charles@rebelbase.com>
2006-07-16 19:39:23 +00:00
*
* This file is licensed by the GPL version 2. Works owned by the
* Transmission project are granted a special exemption to clause 2(b)
* so that the bulk of its code can remain under the MIT license.
* This exemption does not extend to derived works not owned by
* the Transmission project.
2006-07-16 19:39:23 +00:00
*
* $Id$
*/
2006-07-16 19:39:23 +00:00
#ifdef __BEOS__
2007-08-03 16:28:32 +00:00
#include <signal.h>
2006-07-16 19:39:23 +00:00
#include <fs_info.h>
#include <FindDirectory.h>
#include <kernel/OS.h>
#define BEOS_MAX_THREADS 256
2007-08-01 00:40:49 +00:00
#elif defined(WIN32)
#include <windows.h>
#include <shlobj.h> /* for CSIDL_APPDATA, CSIDL_PROFILE */
#else
#ifdef SYS_DARWIN
#include <CoreFoundation/CoreFoundation.h>
#endif
#define _XOPEN_SOURCE 500 /* needed for recursive locks. */
#ifndef __USE_UNIX98
#define __USE_UNIX98 /* some older Linuxes need it spelt out for them */
#endif
#include <pthread.h>
2006-07-16 19:39:23 +00:00
#endif
#include <assert.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
2008-07-11 04:11:22 +00:00
#include <sys/stat.h>
2006-07-16 19:39:23 +00:00
#include <sys/types.h>
#include <dirent.h>
#include <fcntl.h>
#include <unistd.h> /* getuid getpid close */
2006-07-16 19:39:23 +00:00
#include "transmission.h"
#include "list.h"
#include "platform.h"
#include "utils.h"
/***
**** THREADS
***/
#ifdef __BEOS__
typedef thread_id tr_thread_id;
#elif defined(WIN32)
typedef DWORD tr_thread_id;
#else
typedef pthread_t tr_thread_id;
#endif
static tr_thread_id
tr_getCurrentThread( void )
{
#ifdef __BEOS__
return find_thread( NULL );
#elif defined(WIN32)
return GetCurrentThreadId();
#else
return pthread_self( );
#endif
}
static int
tr_areThreadsEqual( tr_thread_id a, tr_thread_id b )
{
#ifdef __BEOS__
return a == b;
#elif defined(WIN32)
return a == b;
#else
return pthread_equal( a, b );
#endif
}
struct tr_thread
{
void (* func ) ( void * );
void * arg;
2008-02-28 16:40:31 +00:00
tr_thread_id thread;
#ifdef WIN32
HANDLE thread_handle;
#endif
};
int
tr_amInThread ( const tr_thread * t )
{
return tr_areThreadsEqual( tr_getCurrentThread(), t->thread );
}
#ifdef WIN32
#define ThreadFuncReturnType unsigned WINAPI
#else
#define ThreadFuncReturnType void
#endif
static ThreadFuncReturnType
ThreadFunc( void * _t )
{
tr_thread * t = _t;
#ifdef __BEOS__
/* This is required because on BeOS, SIGINT is sent to each thread,
which kills them not nicely */
signal( SIGINT, SIG_IGN );
#endif
t->func( t->arg );
#ifdef WIN32
_endthreadex( 0 );
return 0;
#endif
}
tr_thread *
tr_threadNew( void (*func)(void *), void * arg )
{
tr_thread * t = tr_new0( tr_thread, 1 );
t->func = func;
t->arg = arg;
#ifdef __BEOS__
t->thread = spawn_thread( (void*)ThreadFunc, "beos thread", B_NORMAL_PRIORITY, t );
resume_thread( t->thread );
#elif defined(WIN32)
{
unsigned int id;
t->thread_handle = (HANDLE) _beginthreadex( NULL, 0, &ThreadFunc, t, 0, &id );
t->thread = (DWORD) id;
}
#else
pthread_create( &t->thread, NULL, (void * (*) (void *)) ThreadFunc, t );
#endif
return t;
}
/***
**** LOCKS
***/
struct tr_lock
{
int depth;
#ifdef __BEOS__
sem_id lock;
thread_id lockThread;
#elif defined(WIN32)
CRITICAL_SECTION lock;
DWORD lockThread;
#else
pthread_mutex_t lock;
pthread_t lockThread;
#endif
};
tr_lock*
tr_lockNew( void )
{
tr_lock * l = tr_new0( tr_lock, 1 );
#ifdef __BEOS__
l->lock = create_sem( 1, "" );
#elif defined(WIN32)
InitializeCriticalSection( &l->lock ); /* supports recursion */
#else
pthread_mutexattr_t attr;
pthread_mutexattr_init( &attr );
pthread_mutexattr_settype( &attr, PTHREAD_MUTEX_RECURSIVE );
pthread_mutex_init( &l->lock, &attr );
#endif
return l;
}
void
tr_lockFree( tr_lock * l )
{
#ifdef __BEOS__
delete_sem( l->lock );
#elif defined(WIN32)
DeleteCriticalSection( &l->lock );
#else
pthread_mutex_destroy( &l->lock );
#endif
tr_free( l );
}
void
tr_lockLock( tr_lock * l )
{
#ifdef __BEOS__
acquire_sem( l->lock );
#elif defined(WIN32)
EnterCriticalSection( &l->lock );
#else
pthread_mutex_lock( &l->lock );
#endif
assert( l->depth >= 0 );
if( l->depth )
assert( tr_areThreadsEqual( l->lockThread, tr_getCurrentThread() ) );
2007-12-02 18:20:37 +00:00
l->lockThread = tr_getCurrentThread( );
++l->depth;
}
int
tr_lockHave( const tr_lock * l )
{
return ( l->depth > 0 )
&& ( tr_areThreadsEqual( l->lockThread, tr_getCurrentThread() ) );
}
void
tr_lockUnlock( tr_lock * l )
{
assert( l->depth > 0 );
assert( tr_areThreadsEqual( l->lockThread, tr_getCurrentThread() ));
2007-12-02 18:20:37 +00:00
--l->depth;
assert( l->depth >= 0 );
#ifdef __BEOS__
release_sem( l->lock );
#elif defined(WIN32)
LeaveCriticalSection( &l->lock );
#else
pthread_mutex_unlock( &l->lock );
#endif
}
/***
**** PATHS
***/
2006-07-16 19:39:23 +00:00
#if !defined(WIN32) && !defined(__BEOS__) && !defined(__AMIGAOS4__)
#include <pwd.h>
#endif
static const char *
getHomeDir( void )
{
static char * home = NULL;
if( !home )
{
home = tr_strdup( getenv( "HOME" ) );
if( !home )
{
#ifdef WIN32
SHGetFolderPath( NULL, CSIDL_PROFILE, NULL, 0, home );
#elif defined(__BEOS__) || defined(__AMIGAOS4__)
home = tr_strdup( "" );
#else
struct passwd * pw = getpwuid( getuid() );
if( pw )
home = tr_strdup( pw->pw_dir );
endpwent( );
#endif
2006-07-16 19:39:23 +00:00
}
if( !home )
home = tr_strdup( "" );
2006-07-16 19:39:23 +00:00
}
return home;
2006-07-16 19:39:23 +00:00
}
static const char *
getOldConfigDir( void )
2006-07-16 19:39:23 +00:00
{
static char * path = NULL;
2006-07-16 19:39:23 +00:00
if( !path )
{
char buf[MAX_PATH_LENGTH];
#ifdef __BEOS__
find_directory( B_USER_SETTINGS_DIRECTORY,
dev_for_path("/boot"), true,
buf, sizeof( buf ) );
strcat( buf, "/Transmission" );
2006-07-16 19:39:23 +00:00
#elif defined( SYS_DARWIN )
tr_buildPath ( buf, sizeof( buf ), getHomeDir( ),
"Library", "Application Support",
"Transmission", NULL );
2006-07-23 19:39:02 +00:00
#elif defined(__AMIGAOS4__)
2008-05-18 16:44:30 +00:00
tr_strlcpy( buf, "PROGDIR:.transmission", sizeof( buf ) );
#elif defined(WIN32)
char appdata[MAX_PATH_LENGTH];
SHGetFolderPath( NULL, CSIDL_APPDATA, NULL, 0, appdata );
tr_buildPath( buf, sizeof(buf),
appdata, "Transmission", NULL );
2006-07-16 19:39:23 +00:00
#else
tr_buildPath ( buf, sizeof(buf),
getHomeDir( ), ".transmission", NULL );
2006-07-16 19:39:23 +00:00
#endif
path = tr_strdup( buf );
}
2006-07-16 19:39:23 +00:00
return path;
}
2006-07-16 19:39:23 +00:00
static const char *
getOldTorrentsDir( void )
{
static char * path = NULL;
if( !path )
{
char buf[MAX_PATH_LENGTH];
const char * p = getOldConfigDir();
#if defined(__BEOS__) || defined(WIN32) || defined(SYS_DARWIN)
tr_buildPath( buf, sizeof( buf ), p, "Torrents", NULL );
#else
tr_buildPath( buf, sizeof( buf ), p, "torrents", NULL );
2006-07-16 19:39:23 +00:00
#endif
path = tr_strdup( buf );
}
2006-07-16 19:39:23 +00:00
return path;
}
static const char *
getOldCacheDir( void )
2006-07-16 19:39:23 +00:00
{
static char * path = NULL;
2006-07-16 19:39:23 +00:00
if( !path )
{
char buf[MAX_PATH_LENGTH];
#if defined(__BEOS__) || defined(WIN32)
const char * p = getOldConfigDir( );
tr_buildPath( buf, sizeof( buf ), p, "Cache", NULL );
2006-07-16 19:39:23 +00:00
#elif defined( SYS_DARWIN )
tr_buildPath( buf, sizeof( buf ), getHomeDir(),
"Library", "Caches", "Transmission", NULL );
2006-07-16 19:39:23 +00:00
#else
const char * p = getOldConfigDir( );
tr_buildPath( buf, sizeof( buf ), p, "cache", NULL );
2006-07-16 19:39:23 +00:00
#endif
path = tr_strdup( buf );
}
2006-07-16 19:39:23 +00:00
return path;
}
static void
moveFiles( const char * oldDir, const char * newDir )
{
if( oldDir && newDir && strcmp( oldDir, newDir ) )
{
DIR * dirh = opendir( oldDir );
if( dirh )
{
int count = 0;
struct dirent * dirp;
while(( dirp = readdir( dirh )))
{
if( strcmp( dirp->d_name, "." ) && strcmp( dirp->d_name, ".." ) )
{
char o[MAX_PATH_LENGTH];
char n[MAX_PATH_LENGTH];
tr_buildPath( o, sizeof(o), oldDir, dirp->d_name, NULL );
tr_buildPath( n, sizeof(n), newDir, dirp->d_name, NULL );
rename( o, n );
++count;
}
}
if( count )
tr_inf( _( "Migrated %1$d files from \"%2$s\" to \"%3$s\"" ),
count, oldDir, newDir );
closedir( dirh );
}
}
}
static void
migrateFiles( const tr_handle * handle )
{
static int migrated = FALSE;
if( !migrated )
{
const char * oldDir;
const char * newDir;
migrated = TRUE;
oldDir = getOldTorrentsDir( );
newDir = tr_getTorrentDir( handle );
moveFiles( oldDir, newDir );
oldDir = getOldCacheDir( );
newDir = tr_getResumeDir( handle );
moveFiles( oldDir, newDir );
}
}
#ifdef SYS_DARWIN
#define RESUME_SUBDIR "Resume"
#define TORRENT_SUBDIR "Torrents"
#else
#define RESUME_SUBDIR "resume"
#define TORRENT_SUBDIR "torrents"
#endif
void
tr_setConfigDir( tr_handle * handle, const char * configDir )
{
char buf[MAX_PATH_LENGTH];
handle->configDir = tr_strdup( configDir );
tr_buildPath( buf, sizeof( buf ), configDir, RESUME_SUBDIR, NULL );
tr_mkdirp( buf, 0777 );
handle->resumeDir = tr_strdup( buf );
tr_buildPath( buf, sizeof( buf ), configDir, TORRENT_SUBDIR, NULL );
tr_mkdirp( buf, 0777 );
handle->torrentDir = tr_strdup( buf );
2006-07-16 19:39:23 +00:00
migrateFiles( handle );
}
2006-07-16 19:39:23 +00:00
const char *
2008-05-18 16:44:30 +00:00
tr_sessionGetConfigDir( const tr_handle * handle )
{
return handle->configDir;
2006-07-16 19:39:23 +00:00
}
const char *
tr_getTorrentDir( const tr_handle * handle )
2006-07-16 19:39:23 +00:00
{
return handle->torrentDir;
}
2006-07-16 19:39:23 +00:00
const char *
tr_getResumeDir( const tr_handle * handle )
{
return handle->resumeDir;
}
const char*
tr_getDefaultConfigDir( void )
{
static char * s = NULL;
2006-07-16 19:39:23 +00:00
if( !s )
{
char path[MAX_PATH_LENGTH];
if(( s = getenv( "TRANSMISSION_HOME" )))
{
tr_strlcpy( path, s, sizeof( path ) );
}
else
{
#ifdef SYS_DARWIN
tr_buildPath( path, sizeof( path ),
getHomeDir( ), "Library", "Application Support",
"Transmission", NULL );
#elif defined(WIN32)
char appdata[MAX_PATH_LENGTH];
SHGetFolderPath( NULL, CSIDL_APPDATA, NULL, 0, appdata );
tr_buildPath( path, sizeof( path ),
appdata, "Transmission", NULL );
2006-07-16 19:39:23 +00:00
#else
if(( s = getenv( "XDG_CONFIG_HOME" )))
tr_buildPath( path, sizeof( path ),
s, "transmission", NULL );
else
tr_buildPath( path, sizeof( path ),
getHomeDir(), ".config", "transmission", NULL );
2006-07-16 19:39:23 +00:00
#endif
}
2006-07-16 19:39:23 +00:00
s = tr_strdup( path );
}
return s;
2006-07-16 19:39:23 +00:00
}
/***
****
***/
static int
isClutchDir( const char * path )
{
struct stat sb;
char tmp[MAX_PATH_LENGTH];
tr_buildPath( tmp, sizeof( tmp ), path, "javascript", "transmission.js", NULL );
tr_inf( _( "Searching for web interface file \"%s\"" ), tmp );
return !stat( tmp, &sb );
}
const char *
tr_getClutchDir( const tr_session * session UNUSED )
{
static char * s = NULL;
if( !s )
{
char path[MAX_PATH_LENGTH] = { '\0' };
if(( s = getenv( "CLUTCH_HOME" )))
{
tr_strlcpy( path, s, sizeof( path ) );
}
else if(( s = getenv( "TRANSMISSION_WEB_HOME" )))
{
tr_strlcpy( path, s, sizeof( path ) );
}
else
{
#ifdef SYS_DARWIN
CFURLRef appURL = CFBundleCopyBundleURL( CFBundleGetMainBundle() );
CFStringRef appRef = CFURLCopyFileSystemPath( appURL, kCFURLPOSIXPathStyle );
const char * appString = CFStringGetCStringPtr( appRef, CFStringGetFastestEncoding( appRef ) );
CFRelease( appURL );
CFRelease( appRef );
tr_buildPath( path, sizeof( path ), appString, "Contents", "Resources", "web", NULL );
#elif defined(WIN32)
2008-07-11 04:19:23 +00:00
#warning hey win32 people is this good or is there a better implementation of the next four lines
char appdata[MAX_PATH_LENGTH];
SHGetFolderPath( NULL, CSIDL_APPDATA, NULL, 0, appdata );
tr_buildPath( path, sizeof( path ),
appdata, "Transmission", NULL );
#else
tr_list *candidates=NULL, *l;
/* XDG_DATA_HOME should be the first in the list of candidates */
s = getenv( "XDG_DATA_HOME" );
if( s && *s )
tr_list_append( &candidates, tr_strdup( s ) );
else {
char tmp[MAX_PATH_LENGTH];
tr_buildPath( tmp, sizeof( tmp ), getHomeDir(), ".local", "share", NULL );
tr_list_append( &candidates, tr_strdup( tmp ) );
}
/* XDG_DATA_DIRS are the backup directories */
s = getenv( "XDG_DATA_DIRS" );
if( !s || !*s )
s = PACKAGE_DATA_DIR ":/usr/local/share/:/usr/share/";
while( s && *s ) {
char * end = strchr( s, ':' );
if( end ) {
tr_list_append( &candidates, tr_strndup( s, end-s ) );
s = end + 1;
} else {
tr_list_append( &candidates, tr_strdup( s ) );
break;
}
}
for( l=candidates; l; l=l->next ) {
tr_buildPath( path, sizeof( path ), l->data, "transmission", "web", NULL );
if( isClutchDir( path ) )
break;
*path = '\0';
}
tr_list_free( &candidates, tr_free );
#endif
}
if( !*path )
{
tr_strlcpy( path, "/dev/null", sizeof( path ) );
tr_err( _( "Couldn't find the web interface's files! To customize this, set the CLUTCH_HOME environmental variable to the folder where index.html is located." ) );
}
s = tr_strdup( path );
}
return s;
}
/***
****
***/
tr_lockfile_state_t
tr_lockfile( const char * filename )
{
tr_lockfile_state_t ret;
#ifdef WIN32
HANDLE file = CreateFile( filename,
GENERIC_READ|GENERIC_WRITE,
FILE_SHARE_READ|FILE_SHARE_WRITE,
NULL,
OPEN_ALWAYS,
FILE_ATTRIBUTE_NORMAL,
NULL );
if( file == INVALID_HANDLE_VALUE )
ret = TR_LOCKFILE_EOPEN;
else if( !LockFile( file, 0, 0, 1, 1 ) )
ret = TR_LOCKFILE_ELOCK;
else
ret = TR_LOCKFILE_SUCCESS;
#else
int fd = open( filename, O_RDWR | O_CREAT, 0666 );
if( fd < 0 )
ret = TR_LOCKFILE_EOPEN;
else {
struct flock lk;
memset( &lk, 0, sizeof( lk ) );
lk.l_start = 0;
lk.l_len = 0;
lk.l_type = F_WRLCK;
lk.l_whence = SEEK_SET;
if( -1 == fcntl( fd, F_SETLK, &lk ) )
ret = TR_LOCKFILE_ELOCK;
else
ret = TR_LOCKFILE_SUCCESS;
}
#endif
return ret;
}
2008-09-05 14:31:52 +00:00
#ifdef WIN32
/* The following mmap functions are by Joerg Walter, and were taken from
* his paper at: http://www.genesys-e.de/jwalter/mix4win.htm
*/
static LONG volatile g_sl __attribute__ ((aligned (4)));
2008-09-05 14:31:52 +00:00
/* Wait for spin lock */
static int slwait (LONG volatile *sl) {
while (InterlockedCompareExchange (sl, 1, 0) != 0)
2008-09-05 14:31:52 +00:00
Sleep (0);
return 0;
}
/* Release spin lock */
static int slrelease (LONG *sl) {
2008-09-05 14:31:52 +00:00
InterlockedExchange (sl, 0);
return 0;
}
/* getpagesize for windows */
static long getpagesize (void) {
static long g_pagesize = 0;
if (! g_pagesize) {
SYSTEM_INFO system_info;
GetSystemInfo (&system_info);
g_pagesize = system_info.dwPageSize;
}
return g_pagesize;
}
static long getregionsize (void) {
static long g_regionsize = 0;
if (! g_regionsize) {
SYSTEM_INFO system_info;
GetSystemInfo (&system_info);
g_regionsize = system_info.dwAllocationGranularity;
}
return g_regionsize;
}
2008-09-05 14:31:52 +00:00
void *mmap (void *ptr, long size, long prot, long type, long handle, long arg) {
static long g_pagesize;
static long g_regionsize;
/* Wait for spin lock */
slwait (&g_sl);
/* First time initialization */
if (! g_pagesize)
g_pagesize = getpagesize ();
if (! g_regionsize)
g_regionsize = getregionsize ();
/* Allocate this */
ptr = VirtualAlloc (ptr, size,
MEM_RESERVE | MEM_COMMIT | MEM_TOP_DOWN, PAGE_READWRITE);
if (! ptr) {
ptr = (void *) -1;
2008-09-05 14:31:52 +00:00
goto mmap_exit;
}
mmap_exit:
/* Release spin lock */
slrelease (&g_sl);
return ptr;
}
long munmap (void *ptr, long size) {
static long g_pagesize;
static long g_regionsize;
int rc = -1;
2008-09-05 14:31:52 +00:00
/* Wait for spin lock */
slwait (&g_sl);
/* First time initialization */
if (! g_pagesize)
g_pagesize = getpagesize ();
if (! g_regionsize)
g_regionsize = getregionsize ();
/* Free this */
if (! VirtualFree (ptr, 0,
MEM_RELEASE))
goto munmap_exit;
rc = 0;
munmap_exit:
/* Release spin lock */
slrelease (&g_sl);
return rc;
}
#endif