rockbox/firmware/common/rbpaths.c
Thomas Martitz 20b662a946 rbpaths: Add new special dir HOME_DIR for RaaA.
HOME_DIR is intended for not-so-advanced files which shall be user
visible, and thus not in /.rockbox. Therefore HOME_DIR is translated
to $HOME on RaaA, /sdcard on android, the internal memory on ypr0
and "/" on native targets.

ROCKBOX_DIR ("/.rockbox") already existed as special and is translated
to whatever the real rockbox dir is on the target (e.g. /sdcard/rockbox
on android), but it's not suitable for some files we generate
(e.g. battery-bench.txt).

git-svn-id: svn://svn.rockbox.org/rockbox/trunk@31430 a1c6a512-1295-4272-9138-f99709370657
2011-12-25 20:11:18 +00:00

266 lines
7.2 KiB
C

/***************************************************************************
* __________ __ ___.
* Open \______ \ ____ ____ | | _\_ |__ _______ ___
* Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
* Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
* Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
* \/ \/ \/ \/ \/
* $Id$
*
* Copyright (C) 2010 Thomas Martitz
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
* KIND, either express or implied.
*
****************************************************************************/
#include <stdio.h> /* snprintf */
#include <stdlib.h>
#include <stdarg.h>
#include "config.h"
#include "rbpaths.h"
#include "file.h" /* MAX_PATH */
#include "logf.h"
#include "gcc_extensions.h"
#include "string-extra.h"
#include "filefuncs.h"
#undef open
#undef creat
#undef remove
#undef rename
#undef opendir
#undef mkdir
#undef rmdir
#if (CONFIG_PLATFORM & PLATFORM_ANDROID)
#include "dir-target.h"
#define opendir opendir_android
#define mkdir mkdir_android
#define rmdir rmdir_android
static const char rbhome[] = "/sdcard";
#elif defined(SAMSUNG_YPR0)
#include "dir-target.h"
#define opendir opendir_ypr0
#define mkdir mkdir_ypr0
#define rmdir rmdir_ypr0
#elif (CONFIG_PLATFORM & (PLATFORM_SDL|PLATFORM_MAEMO|PLATFORM_PANDORA))
#define open sim_open
#define remove sim_remove
#define rename sim_rename
#define opendir sim_opendir
#define mkdir sim_mkdir
#define rmdir sim_rmdir
extern int sim_open(const char* name, int o, ...);
extern int sim_remove(const char* name);
extern int sim_rename(const char* old, const char* new);
extern DIR* sim_opendir(const char* name);
extern int sim_mkdir(const char* name);
extern int sim_rmdir(const char* name);
const char *rbhome;
#endif
#if !defined(SAMSUNG_YPR0)
/* flags for get_user_file_path() */
/* whether you need write access to that file/dir, especially true
* for runtime generated files (config.cfg) */
#define NEED_WRITE (1<<0)
/* file or directory? */
#define IS_FILE (1<<1)
void paths_init(void)
{
/* make sure $HOME/.config/rockbox.org exists, it's needed for config.cfg */
#if (CONFIG_PLATFORM & PLATFORM_ANDROID)
mkdir("/sdcard/rockbox");
mkdir("/sdcard/rockbox/rocks.data");
#else
char config_dir[MAX_PATH];
const char *home = getenv("RBROOT");
if (!home)
{
home = getenv("HOME");
}
if (!home)
{
logf("HOME environment var not set. Can't write config");
return;
}
rbhome = home;
snprintf(config_dir, sizeof(config_dir), "%s/.config", home);
mkdir(config_dir);
snprintf(config_dir, sizeof(config_dir), "%s/.config/rockbox.org", home);
mkdir(config_dir);
/* Plugin data directory */
snprintf(config_dir, sizeof(config_dir), "%s/.config/rockbox.org/rocks.data", home);
mkdir(config_dir);
#endif
}
static bool try_path(const char* filename, unsigned flags)
{
if (flags & IS_FILE)
{
if (file_exists(filename))
return true;
}
else
{
if (dir_exists(filename))
return true;
}
return false;
}
static const char* _get_user_file_path(const char *path,
unsigned flags,
char* buf,
const size_t bufsize)
{
const char *ret = path;
const char *pos = path;
/* replace ROCKBOX_DIR in path with $HOME/.config/rockbox.org */
pos += ROCKBOX_DIR_LEN;
if (*pos == '/') pos += 1;
#if (CONFIG_PLATFORM & PLATFORM_ANDROID)
if (snprintf(buf, bufsize, "/sdcard/rockbox/%s", pos)
#else
if (snprintf(buf, bufsize, "%s/.config/rockbox.org/%s", rbhome, pos)
#endif
>= (int)bufsize)
return NULL;
/* always return the replacement buffer (pointing to $HOME) if
* write access is needed */
if (flags & NEED_WRITE)
ret = buf;
else if (try_path(buf, flags))
ret = buf;
if (ret != buf) /* not found in $HOME, try ROCKBOX_BASE_DIR, !NEED_WRITE only */
{
if (snprintf(buf, bufsize, ROCKBOX_SHARE_PATH "/%s", pos) >= (int)bufsize)
return NULL;
if (try_path(buf, flags))
ret = buf;
}
return ret;
}
static const char* handle_special_dirs(const char* dir, unsigned flags,
char *buf, const size_t bufsize)
{
if (!strncmp(HOME_DIR, dir, HOME_DIR_LEN))
{
const char *p = dir + HOME_DIR_LEN;
while (*p == '/') p++;
snprintf(buf, bufsize, "%s/%s", rbhome, p);
return buf;
}
else if (!strncmp(ROCKBOX_DIR, dir, ROCKBOX_DIR_LEN))
return _get_user_file_path(dir, flags, buf, bufsize);
return dir;
}
int app_open(const char *name, int o, ...)
{
char realpath[MAX_PATH];
va_list ap;
int fd;
int flags = IS_FILE;
if (o & (O_CREAT|O_RDWR|O_TRUNC|O_WRONLY))
flags |= NEED_WRITE;
name = handle_special_dirs(name, flags, realpath, sizeof(realpath));
va_start(ap, o);
fd = open(name, o, va_arg(ap, unsigned int));
va_end(ap);
return fd;
}
int app_creat(const char* name, mode_t mode)
{
return app_open(name, O_CREAT|O_WRONLY|O_TRUNC, mode);
}
int app_remove(const char *name)
{
char realpath[MAX_PATH];
const char *fname = handle_special_dirs(name, NEED_WRITE, realpath, sizeof(realpath));
return remove(fname);
}
int app_rename(const char *old, const char *new)
{
char realpath_old[MAX_PATH], realpath_new[MAX_PATH];
const char *final_old, *final_new;
final_old = handle_special_dirs(old, NEED_WRITE, realpath_old, sizeof(realpath_old));
final_new = handle_special_dirs(new, NEED_WRITE, realpath_new, sizeof(realpath_new));
return rename(final_old, final_new);
}
DIR *app_opendir(const char *name)
{
char realpath[MAX_PATH];
const char *fname = handle_special_dirs(name, 0, realpath, sizeof(realpath));
return opendir(fname);
}
int app_mkdir(const char* name)
{
char realpath[MAX_PATH];
const char *fname = handle_special_dirs(name, NEED_WRITE, realpath, sizeof(realpath));
return mkdir(fname);
}
int app_rmdir(const char* name)
{
char realpath[MAX_PATH];
const char *fname = handle_special_dirs(name, NEED_WRITE, realpath, sizeof(realpath));
return rmdir(fname);
}
#else
int app_open(const char *name, int o, ...)
{
if (o & O_CREAT)
{
int ret;
va_list ap;
va_start(ap, o);
ret = open(name, o, va_arg(ap, mode_t));
va_end(ap);
return ret;
}
return open(name, o);
}
int app_creat(const char* name, mode_t mode) { return creat(name, mode); }
int app_remove(const char *name) { return remove(name); }
int app_rename(const char *old, const char *new) { return rename(old,new); }
DIR *app_opendir(const char *name) { return opendir(name); }
int app_mkdir(const char* name) { return mkdir(name); }
int app_rmdir(const char* name) { return rmdir(name); }
#endif