summaryrefslogtreecommitdiffstats
path: root/firmware/target/hosted/filesystem-app.c
blob: 7d59a174dc4e85096d2c8395b772a686021423cd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
/***************************************************************************
 *             __________               __   ___.
 *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
 *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
 *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
 *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
 *                     \/            \/     \/    \/            \/
 * $Id$
 *
 * Copyright (C) 2010 Thomas Martitz
 * Copyright (C) 2020 Solomon Peachy
 *
 * 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.
 *
 ****************************************************************************/
#define RB_FILESYSTEM_OS
#include <stdio.h> /* snprintf */
#include <stdlib.h>
#include <stdarg.h>
#include <time.h>
#include <errno.h>
#include <string.h>
#include <limits.h>
#include "config.h"
#include "system.h"
#include "file.h"
#include "dir.h"
#include "file_internal.h"
#include "pathfuncs.h"
#include "string-extra.h"
#include "rbpaths.h"
#include "logf.h"

/* PIVOT_ROOT adds a fixed prefix to all paths */
#if defined(BOOTLOADER) || defined(CHECKWPS) || defined(SIMULATOR) || defined(__PCTOOL__)
/* We don't want to use pivot root on these! */
#undef PIVOT_ROOT
#endif

#if defined(DBTOOL)
#define PIVOT_ROOT "."
#endif

#if defined(__PCTOOL__)
/* We don't want this for tools */
#undef HAVE_SPECIAL_DIRS
#endif

#if defined(HAVE_MULTIDRIVE) || defined(HAVE_SPECIAL_DIRS)
#if (CONFIG_PLATFORM & PLATFORM_ANDROID)
static const char rbhome[] = "/sdcard";
#elif (CONFIG_PLATFORM & (PLATFORM_SDL|PLATFORM_MAEMO|PLATFORM_PANDORA)) \
        && !defined(__PCTOOL__)
static const char *rbhome;
#elif defined(PIVOT_ROOT)
static const char rbhome[] = PIVOT_ROOT;
#else
/* Anything else? */
static const char rbhome[] = HOME_DIR;
#endif
#endif

#ifdef HAVE_MULTIDRIVE
/* This is to compare any opened directories with the home directory so that
   the special drive links may be returned for it only */
static int rbhome_fildes = -1;

/* A special link is created under e.g. HOME_DIR/<microSD1>, e.g. to access
 * external storage in a convenient location, much similar to the mount
 * point on our native targets. Here they are treated as symlink (one which
 * doesn't actually exist in the filesystem and therefore we have to override
 * readlink() */
static const char *handle_special_links(const char* link, unsigned flags,
                                char *buf, const size_t bufsize)
{
    (void) flags;
    char vol_string[VOL_MAX_LEN + 1];
    int len;

    for (int i = 1; i < NUM_VOLUMES; i++)
    {
        len = get_volume_name(i, vol_string);
        /* link might be passed with or without HOME_DIR expanded. To handle
         * both perform substring matching (VOL_NAMES is unique enough) */
        const char *begin = strstr(link, vol_string);
        if (begin)
        {
            /* begin now points to the start of vol_string within link,
             * we want to copy the remainder of the paths, prefixed by
             * the actual mount point (the remainder might be "") */
            snprintf(buf, bufsize, MULTIDRIVE_DIR"%s", begin + len);
            return buf;
        }
    }

    return link;
}

/* we keep an open descriptor of the home directory to detect when it has been
   opened by opendir() so that its "symlinks" may be enumerated */
void cleanup_rbhome(void)
{
    os_close(rbhome_fildes);
    rbhome_fildes = -1;
}
void startup_rbhome(void)
{
    /* if this fails then alternate volumes will not work, but this function
       cannot return that fact */
    rbhome_fildes = os_opendirfd(rbhome);
    if (rbhome_fildes >= 0)
        atexit(cleanup_rbhome);
}

#endif /* HAVE_MULTIDRIVE */

void paths_init(void)
{
#ifdef HAVE_SPECIAL_DIRS
    /* make sure $HOME/.config/rockbox.org exists, it's needed for config.cfg */
#if (CONFIG_PLATFORM & PLATFORM_ANDROID)
    os_mkdir("/sdcard/rockbox" __MKDIR_MODE_ARG);
    os_mkdir("/sdcard/rockbox/rocks.data" __MKDIR_MODE_ARG);
    os_mkdir("/sdcard/rockbox/eqs" __MKDIR_MODE_ARG);
#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);
    os_mkdir(config_dir __MKDIR_MODE_ARG);
    snprintf(config_dir, sizeof(config_dir), "%s/.config/rockbox.org", home);
    os_mkdir(config_dir __MKDIR_MODE_ARG);
    /* Plugin data directory */
    snprintf(config_dir, sizeof(config_dir), "%s/.config/rockbox.org/rocks.data", home);
    os_mkdir(config_dir __MKDIR_MODE_ARG);
#endif
#endif /* HAVE_SPECIAL_DIRS */
#ifdef HAVE_MULTIDRIVE
    startup_rbhome();
#endif
}

#ifdef HAVE_SPECIAL_DIRS
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;
    while (*pos == PATH_SEPCH) pos++;

#if (CONFIG_PLATFORM & PLATFORM_ANDROID)
    if (path_append(buf, "/sdcard/rockbox", pos, bufsize) >= bufsize)
        return NULL;
#else
    if (path_append(buf, rbhome, ".config/rockbox.org", bufsize) >= bufsize ||
        path_append(buf, PA_SEP_SOFT, pos, bufsize) >= bufsize)
        return NULL;
#endif

    /* always return the replacement buffer (pointing to $HOME) if
     * write access is needed */
    if (flags & NEED_WRITE)
        ret = buf;
    else if (os_file_exists(buf))
        ret = buf;

    if (ret != buf) /* not found in $HOME, try ROCKBOX_BASE_DIR, !NEED_WRITE only */
    {
        if (path_append(buf, ROCKBOX_SHARE_PATH, pos, bufsize) >= bufsize)
            return NULL;

        if (os_file_exists(buf))
            ret = buf;
    }

    return ret;
}

#endif

const char * handle_special_dirs(const char *dir, unsigned flags,
                                 char *buf, const size_t bufsize)
{
    (void) flags; (void) buf; (void) bufsize;
#ifdef HAVE_SPECIAL_DIRS
#define HOME_DIR_LEN (sizeof(HOME_DIR)-1)
    /* This replaces HOME_DIR (ie '<HOME'>') with runtime rbhome */
    if (!strncmp(HOME_DIR, dir, HOME_DIR_LEN))
    {
        const char *p = dir + HOME_DIR_LEN;
        while (*p == PATH_SEPCH) p++; /* strip leading slashes */
        path_append(buf, rbhome, p, bufsize);
        dir = buf;
    }
    else if (!strncmp(ROCKBOX_DIR, dir, ROCKBOX_DIR_LEN))
        dir = _get_user_file_path(dir, flags, buf, bufsize);
#endif
#ifdef HAVE_MULTIDRIVE
#define MULTIDRIVE_DIR_LEN (sizeof(MULTIDRIVE_DIR)-1)

    dir = handle_special_links(dir, flags, buf, bufsize);
#endif
#ifdef PIVOT_ROOT
#define PIVOT_ROOT_LEN (sizeof(PIVOT_ROOT)-1)
    /* Prepend root prefix to find actual path */
    if (strncmp(PIVOT_ROOT, dir, PIVOT_ROOT_LEN)
#if defined(MULTIDRIVE_DIR) && defined(MULTIDRIVE_DIR_LEN)
	/* Unless it's a MULTIDRIVE dir, in which case use as-is */
	&& strncmp(MULTIDRIVE_DIR, dir, MULTIDRIVE_DIR_LEN)
#endif
       )
    {
        while (*dir == PATH_SEPCH) dir++; /* strip leading slashes */
        path_append(buf, PIVOT_ROOT, dir, bufsize);
        dir = buf;
    }
#endif
    return dir;
}

int app_open(const char *path, int oflag, ...)
{
    int flags = IS_FILE;
    if (oflag & O_ACCMODE)
        flags |= NEED_WRITE;

    char realpath[MAX_PATH];
    const char *fpath = handle_special_dirs(path, flags, realpath,
                                            sizeof (realpath));
    if (!fpath)
        FILE_ERROR_RETURN(ENAMETOOLONG, -1);

    oflag |= O_CLOEXEC;
    return os_open(fpath, oflag __OPEN_MODE_ARG);
}

int app_creat(const char *path, mode_t mode)
{
    return app_open(path, O_CREAT|O_WRONLY|O_TRUNC, mode);
}

int app_remove(const char *path)
{
    char realpath[MAX_PATH];
    const char *fpath = handle_special_dirs(path, NEED_WRITE, realpath,
                                            sizeof (realpath));
    if (!fpath)
        FILE_ERROR_RETURN(ENAMETOOLONG, -1);

    return os_remove(fpath);
}

int app_rename(const char *old, const char *new)
{
    char realpath_old[MAX_PATH], realpath_new[MAX_PATH];
    const char *fold = handle_special_dirs(old, NEED_WRITE, realpath_old,
                                           sizeof (realpath_old));
    const char *fnew = handle_special_dirs(new, NEED_WRITE, realpath_new,
                                           sizeof (realpath_new));
    if (!fold || !fnew)
        FILE_ERROR_RETURN(ENAMETOOLONG, -1);

    return os_rename(fold, fnew);
}

#ifdef HAVE_SDL_THREADS
ssize_t app_read(int fd, void *buf, size_t nbyte)
{
    return os_read(fd, buf, nbyte);
}

ssize_t app_write(int fd, const void *buf, size_t nbyte)
{
    return os_write(fd, buf, nbyte);
}
#endif /* HAVE_SDL_THREADS */

int app_relate(const char *path1, const char *path2)
{
    char realpath_1[MAX_PATH], realpath_2[MAX_PATH];
    const char *fpath1 = handle_special_dirs(path1, 0, realpath_1,
                                             sizeof (realpath_1));
    const char *fpath2 = handle_special_dirs(path2, 0, realpath_2,
                                             sizeof (realpath_2));

    if (!fpath1 || !fpath2)
        FILE_ERROR_RETURN(ENAMETOOLONG, -1);

    return os_relate(fpath1, fpath2);
}

bool app_file_exists(const char *path)
{
    char realpath[MAX_PATH];
    const char *fpath = handle_special_dirs(path, NEED_WRITE, realpath,
                                            sizeof (realpath));
    if (!fpath)
        FILE_ERROR_RETURN(ENAMETOOLONG, false);

    return os_file_exists(fpath);
}

/* need to wrap around DIR* because we need to save the parent's directory
 * path in order to determine dirinfo for volumes or convert the path to UTF-8;
 * also is required to implement get_dir_info() */
struct __dir
{
    OS_DIR_T *osdirp;
#ifdef HAVE_MULTIDRIVE
    int volumes_returned;
#endif
    int osfd;
    bool osfd_is_opened;
#if defined(OS_DIRENT_CONVERT) || defined (HAVE_MULTIDRIVE)
    #define USE_DIRENTP
    struct dirent *direntp;
    size_t d_name_size;
#endif
    char path[];
};

static void __dir_free(struct __dir *this)
{
    if (!this)
        return;

#ifdef USE_DIRENTP
    free(this->direntp);
#endif

    if (this->osfd_is_opened)
        os_close(this->osfd);

    free(this);
}

DIR * app_opendir(const char *dirname)
{
    int rc;
    char realpath[MAX_PATH];
    const char *fname = handle_special_dirs(dirname, 0, realpath,
                                            sizeof (realpath));
    if (!fname)
        FILE_ERROR_RETURN(ENAMETOOLONG, NULL);

    size_t name_len = path_strip_trailing_separators(fname, &fname);
    struct __dir *this = calloc(1, sizeof (*this) + name_len + 1);
    if (!this)
        FILE_ERROR(ENOMEM, RC);

#ifdef USE_DIRENTP
    /* allocate what we're really going to return to callers, making certain
       it has at least the d_name size we want */
    this->d_name_size = MAX(MAX_PATH, sizeof (this->direntp->d_name));
    this->direntp = calloc(1, offsetof(typeof (*this->direntp), d_name) +
                                 this->d_name_size);
    if (!this->direntp)
        FILE_ERROR(ENOMEM, RC);

    /* only the d_name field will be valid but that is all that anyone may
       truely count on portably existing */
#endif /* USE_DIRENTP */

    strmemcpy(this->path, fname, name_len);

    rc = os_opendir_and_fd(this->path, &this->osdirp, &this->osfd);
    if (rc < 0)
        FILE_ERROR(ERRNO, RC);

    this->osfd_is_opened = rc > 0;

#ifdef HAVE_MULTIDRIVE
    this->volumes_returned = INT_MAX; /* assume NOT $HOME */
    if (rbhome_fildes >= 0 && os_fsamefile(rbhome_fildes, this->osfd) > 0)
        this->volumes_returned = 0; /* there's no place like $HOME */
#endif /* HAVE_MULTIDRIVE */

    return (DIR *)this;
file_error:
    __dir_free(this);
    return NULL;
}

int app_closedir(DIR *dirp)
{
    struct __dir *this = (struct __dir *)dirp;
    if (!this)
        FILE_ERROR_RETURN(EBADF, -1);

    OS_DIR_T *osdirp = this->osdirp;
    __dir_free(this);

    return os_closedir(osdirp);
}

struct dirent * app_readdir(DIR *dirp)
{
    struct __dir *this = (struct __dir *)dirp;
    if (!this)
        FILE_ERROR_RETURN(EBADF, NULL);

#ifdef HAVE_MULTIDRIVE
    if (this->volumes_returned < NUM_VOLUMES)
    {
        while (++this->volumes_returned < NUM_VOLUMES)
        {
            if (!volume_present(this->volumes_returned))
                continue;

            get_volume_name(this->volumes_returned, this->direntp->d_name);
            return this->direntp;
        }
    }
    /* do normal directory reads */
#endif /* HAVE_MULTIDRIVE */

    OS_DIRENT_T *osdirent = os_readdir(this->osdirp);

#ifdef OS_DIRENT_CONVERT
    if (strlcpy_from_os(this->direntp->d_name, osdirent->d_name,
                        this->d_name_size) >= this->d_name_size)
    {
        this->direntp->d_name[0] = '\0';
        errno = EOVERFLOW;
        return NULL;
    }

    osdirent = (OS_DIRENT_T *)this->direntp;
#endif /* OS_DIRENT_CONVERT */

    return (struct dirent *)osdirent;
}

int app_mkdir(const char *path)
{
    char realpath[MAX_PATH];
    const char *fname = handle_special_dirs(path, NEED_WRITE, realpath,
                                            sizeof (realpath));
    if (!fname)
        FILE_ERROR_RETURN(ENAMETOOLONG, -1);

    return os_mkdir(fname __MKDIR_MODE_ARG);
}

int app_rmdir(const char *path)
{
    char realpath[MAX_PATH];
    const char *fname = handle_special_dirs(path, NEED_WRITE, realpath,
                                            sizeof (realpath));
    if (!fname)
        FILE_ERROR_RETURN(ENAMETOOLONG, -1);

    return os_rmdir(fname);
}

int app_samedir(DIR *dirp1, DIR *dirp2)
{
    struct __dir *this1 = (struct __dir *)dirp1;
    struct __dir *this2 = (struct __dir *)dirp2;

    if (!this1 || !this2)
    {
        errno = EBADF;
        return -1;
    }

    return os_fsamefile(this1->osfd, this2->osfd);
}

bool app_dir_exists(const char *dirname)
{
    char realpath[MAX_PATH];
    const char *fname = handle_special_dirs(dirname, 0, realpath,
                                            sizeof (realpath));
    if (!fname)
        FILE_ERROR_RETURN(ENAMETOOLONG, false);

    OS_DIR_T *osdirp = os_opendir(fname);
    if (!osdirp)
        return false;

    os_closedir(osdirp);
    return true;
}

struct dirinfo dir_get_info(DIR *dirp, struct dirent *entry)
{
    struct __dir *this = (struct __dir *)dirp;
    struct dirinfo ret = { .attribute = 0,
                           .mtime = 0 };

    if (!this)
        FILE_ERROR_RETURN(EBADF, ret);

    if (!entry || entry->d_name[0] == '\0')
        FILE_ERROR_RETURN(ENOENT, ret);

    char path[MAX_PATH];

#ifdef HAVE_MULTIDRIVE
    if (this->volumes_returned < NUM_VOLUMES)
    {
        /* last thing read was a "symlink" */
        ret.attribute = ATTR_LINK;
        strcpy(path, MULTIDRIVE_DIR);
    }
    else
#endif
    if (path_append(path, this->path, entry->d_name, sizeof (path))
            >= sizeof (path))
    {
        FILE_ERROR_RETURN(ENAMETOOLONG, ret);
    }

    struct stat s;
    if (os_lstat(path, &s) < 0)
        FILE_ERROR_RETURN(ERRNO, ret);

    int err = 0;
    if (S_ISLNK(s.st_mode))
    {
        ret.attribute |= ATTR_LINK;
        err = os_stat(path, &s);
    }

    if (err < 0)
        FILE_ERROR_RETURN(ERRNO, ret);

    if (S_ISDIR(s.st_mode))
        ret.attribute |= ATTR_DIRECTORY;

    ret.size = s.st_size;

    struct tm tm;
    if (!localtime_r(&s.st_mtime, &tm))
        FILE_ERROR_RETURN(ERRNO, ret);

    ret.mtime = mktime(&tm);
    return ret;
}

/* On MD we create a virtual symlink for the external drive,
 * for this we need to override readlink(). */
ssize_t app_readlink(const char *path, char *buf, size_t bufsiz)
{
    char _buf[MAX_PATH];
    path = handle_special_dirs(path, 0, _buf, sizeof(_buf));
#ifdef HAVE_MULTIDRIVE
    /* if path == _buf then we can be sure handle_special_dir() did something
     * and path is not an ordinary directory */
    if (path == _buf && !strncmp(path, MULTIDRIVE_DIR, sizeof(MULTIDRIVE_DIR)-1))
    {
        /* copying NUL is not required as per readlink specification */
        ssize_t len = strlen(path);
        memcpy(buf, path, len);
        return len;
    }
#endif
    /* does not append NUL !! */
    return os_readlink(path, buf, bufsiz);
    (void) path; (void) buf; (void) bufsiz;
}

int os_volume_path(IF_MV(int volume, ) char *buffer, size_t bufsize)
{
#if defined(HAVE_MULTIVOLUME) && !(CONFIG_PLATFORM & PLATFORM_HOSTED)
    char volname[VOL_MAX_LEN + 1];
    get_volume_name(volume, volname);
#else
    IF_MV((void)volume;)
    const char *volname = "/";
#endif

    if (!handle_special_dirs(volname, NEED_WRITE, buffer, bufsize))
    {
        errno = ENAMETOOLONG;
        return -1;
    }

    return 0;
}

const char* app_root_realpath(void)
{
    return PATH_ROOTSTR;
}