arb_file.cxx

Go to the documentation of this file.

// =============================================================== //
//                                                                 //
//   File      : arb_file.cxx                                      //
//   Purpose   : Basic file operations                             //
//                                                                 //
//   Coded by Ralf Westram (coder@reallysoft.de) in October 2011   //
//   Institute of Microbiology (Technical University Munich)       //
//   http://www.arb-home.de/                                       //
//                                                                 //
// =============================================================== //

#include "arb_file.h"
#include "arb_string.h"
#include "arb_msg.h"

#include <unistd.h>
#include <utime.h>
#include <sys/stat.h>
#include <fcntl.h>

#include <cstdio>
#include <cerrno>

// AISC_MKPT_PROMOTE:#ifndef ARB_CORE_H
// AISC_MKPT_PROMOTE:#include "arb_core.h"
// AISC_MKPT_PROMOTE:#endif

long GB_size_of_file(const char *path) {
    struct stat stt;
    if (!path || stat(path, &stt)) return -1;
    return stt.st_size;
}

long GB_size_of_FILE(FILE *in) {
    int         fi = fileno(in);
    struct stat st;
    if (fstat(fi, &st)) {
        GB_export_error("GB_size_of_FILE: sorry file is not readable");
        return -1;
    }
    return st.st_size;
}

unsigned long GB_time_of_file(const char *path) {
    struct stat stt;
    if (!path || stat(path, &stt)) return 0; // return epoch for missing files
    return stt.st_mtime;
}

GB_ERROR GB_set_time_of_file(const char *path, unsigned long new_time) {
    utimbuf ut;

    ut.actime  = new_time;
    ut.modtime = new_time;

    int res = utime(path, &ut);
    return res ? GB_IO_error("setting timestamp of", path) : NULp;
}

long GB_mode_of_file(const char *path) {
    if (path) {
        struct stat stt;
        if (stat(path, &stt) == 0) return stt.st_mode;
    }
    return -1;
}

long GB_mode_of_link(const char *path) {
    if (path) {
        struct stat stt;
        if (lstat(path, &stt) == 0) return stt.st_mode;
    }
    return -1;
}

bool GB_is_regularfile(const char *path) {
    // Warning : returns true for symbolic links to files (use GB_is_link() to test)
    if (!path) return false;
    struct stat stt;
    return stat(path, &stt) == 0 && S_ISREG(stt.st_mode);
}

bool GB_is_link(const char *path) {
    if (!path) return false;
    struct stat stt;
    return lstat(path, &stt) == 0 && S_ISLNK(stt.st_mode);
}

bool GB_is_fifo(const char *path) {
    if (!path) return false;
    struct stat stt;
    return stat(path, &stt) == 0 && S_ISFIFO(stt.st_mode);
}

bool GB_is_fifo(FILE *fp) {
    if (!fp) return false;
    struct stat stt;
    return fstat(fileno(fp), &stt) == 0 && S_ISFIFO(stt.st_mode);
}

bool GB_is_executablefile(const char *path) {
    struct stat stt;
    bool        executable = false;

    if (stat(path, &stt) == 0) {
        uid_t my_userid = geteuid(); // effective user id
        if (stt.st_uid == my_userid) { // I am the owner of the file
            executable = !!(stt.st_mode&S_IXUSR); // owner execution permission
        }
        else {
            gid_t my_groupid = getegid(); // effective group id
            if (stt.st_gid == my_groupid) { // I am member of the file's group
                executable = !!(stt.st_mode&S_IXGRP); // group execution permission
            }
            else {
                executable = !!(stt.st_mode&S_IXOTH); // others execution permission
            }
        }
    }

    return executable;
}

bool GB_is_privatefile(const char *path, bool read_private) {
    // return true, if nobody but user has write permission
    // if 'read_private' is true, only return true if nobody but user has read permission
    //
    // Note: Always returns true for missing files!
    //
    // GB_is_privatefile is mainly used to assert that files generated in /tmp have secure permissions

    struct stat stt;
    bool        isprivate = true;

    if (stat(path, &stt) == 0) {
        if (read_private) {
            isprivate = (stt.st_mode & (S_IWGRP|S_IWOTH|S_IRGRP|S_IROTH)) == 0;
        }
        else {
            isprivate = (stt.st_mode & (S_IWGRP|S_IWOTH)) == 0;
        }
    }
    return isprivate;
}

inline bool mode_is_user_writeable(long mode) { return mode>0 && (mode & S_IWUSR); }

bool GB_is_writeablefile(const char *filename) { // for user
    bool writable = false;
    if (GB_is_regularfile(filename)) {
        writable = mode_is_user_writeable(GB_mode_of_file(filename));
        if (writable && GB_is_link(filename)) {
            char *target = GB_follow_unix_link(filename);
            writable     = GB_is_writeablefile(target);
            free(target);
        }
    }
    return writable;
}

static bool GB_is_readable(const char *file_or_dir) {
    if (file_or_dir) {
        FILE *in = fopen(file_or_dir, "r");
        if (in) {
            fclose(in);
            return true;
        }
    }
    return false;
}

bool GB_is_readablefile(const char *filename) {
    return !GB_is_directory(filename) && GB_is_readable(filename);
}

bool GB_is_directory(const char *path) {
    // Warning : returns true for symbolic links to directories (use GB_is_link())
    struct stat stt;
    return path && stat(path, &stt) == 0 && S_ISDIR(stt.st_mode);
}

long GB_getuid_of_file(const char *path) {
    struct stat stt;
    if (stat(path, &stt)) return -1;
    return stt.st_uid;
}

int GB_unlink(const char *path) {
    if (unlink(path) != 0) {
        if (errno == ENOENT) {
            return 1;
        }
        GB_export_error(GB_IO_error("removing", path));
        return -1;
    }
    return 0;
}

void GB_unlink_or_warn(const char *path, GB_ERROR *error) {
    /* Unlinks 'path'
     *
     * In case of a real unlink failure:
     * - if 'error' is given -> set error if not already set
     * - otherwise only warn
     */

    if (GB_unlink(path)<0) {
        GB_ERROR unlink_error = GB_await_error();
        if (error && !*error) *error = unlink_error;
        else GB_warning(unlink_error);
    }
}

GB_ERROR GB_symlink(const char *target, const char *link) {
    GB_ERROR error = NULp;
    if (symlink(target, link)<0) {
        char *what = GBS_global_string_copy("creating symlink (to file '%s')", target);
        error      = GB_IO_error(what, link);
        free(what);
    }
    return error;
}

GB_ERROR GB_set_mode_of_file(const char *path, long mode) {
    /*
      Patch from Alan McCulloch:

      get user, group,other read, write and execute
      permissions and if these are the same in the
      existing and requested modes of the file ,
      don't chmod (gets around "Cannot set mode" errors
      which will happen if user does not own file)

      This assumes that the requested permission change is not
      outside the mask S_IRWXU | S_IRWXG | S_IRWXO - if it is, then
      the requested change will not be made
    */

    int permissions_mask = S_IRWXU | S_IRWXG | S_IRWXO ;
    struct stat sb;


    if (stat(path, &sb) == -1) {
        return GBS_global_string("Cannot get existing mode of '%s'", path);
    }

    if (((int)sb.st_mode & permissions_mask) == ((int)mode & permissions_mask)) {
        return NULp;
    }

    if (chmod(path, (int)mode)) return GB_IO_error("changing mode of", path);
    return NULp;
}

char *GB_follow_unix_link(const char *path) {   // returns the real path of a file
    char buffer[1000];
    char *path2;
    char *pos;
    char *res;
    int len = readlink(path, buffer, 999);
    if (len<0) return NULp;
    buffer[len] = 0;
    if (path[0] == '/') return ARB_strdup(buffer);

    path2 = ARB_strdup(path);
    pos = strrchr(path2, '/');
    if (!pos) {
        free(path2);
        return ARB_strdup(buffer);
    }
    *pos = 0;
    res  = GBS_global_string_copy("%s/%s", path2, buffer);
    free(path2);
    return res;
}

GB_ERROR GB_move_file(const char *oldpath, const char *newpath) {
    // Warning: unconditionally overwrites existing destination (even if write-protected!)
    // Use GB_safe_rename_file() to avoid overwrites.

    long old_mod               = GB_mode_of_file(newpath); // keep filemode for existing files
    if (old_mod == -1) old_mod = GB_mode_of_file(oldpath);

    GB_ERROR error = NULp;
    if (rename(oldpath, newpath) != 0) {
        error = GB_IO_error("renaming", GBS_global_string("%s' into '%s", oldpath, newpath)); // Note: GB_IO_error quotes it's 2nd arg
    }
    else {
        error = GB_set_mode_of_file(newpath, old_mod);
    }

    return error;
}

GB_ERROR GB_copy_file(const char *srcpath, const char *dstpath) {
    GB_ERROR error = NULp;

    int src              = open(srcpath, O_RDONLY, 0);
    if (src == -1) error = GB_IO_error("reading", srcpath);
    else {
        int dst              = open(dstpath, O_WRONLY | O_CREAT | O_TRUNC, 0644);
        if (dst == -1) error = GB_IO_error("writing", dstpath);
        else {
            char buf[BUFSIZ]; // defined by stdio

            while (!error) {
                ssize_t got          = read(src, buf, BUFSIZ);
                if (got == -1) error = GB_IO_error("reading", srcpath);
                else {
                    ssize_t wrote          = write(dst, buf, got);
                    if (wrote == -1) error = GB_IO_error("writing", dstpath);
                    else {
                        arb_assert(wrote == got);
                        if (!wrote) break; // done
                    }
                }
            }
            close(dst);
        }
        close(src);
    }
    return error;
}

GB_ERROR GB_safe_rename_file(const char *oldpath, const char *newpath) { // replacement for GB_rename_file
    GB_ERROR error = NULp;
    if (GB_is_regularfile(newpath)) {
        error = "file already exists";
    }
    else {
        error = GB_move_file(oldpath, newpath);
    }
    return error;
}
GB_ERROR GB_safe_copy_file(const char *oldpath, const char *newpath) { // non-overwriting copy
    GB_ERROR error = NULp;
    if (GB_is_regularfile(newpath)) {
        error = "file already exists";
    }
    else {
        error = GB_copy_file(oldpath, newpath);
    }
    return error;
}

// --------------------------------------------------------------------------------

#ifdef UNIT_TESTS
#ifndef TEST_UNIT_H
#include <test_unit.h>
#endif

void TEST_basic_file_checks() {
    const char *someDir  = "general";
    const char *someFile = "general/text.input";
    const char *noFile   = "general/nosuch.input";

    TEST_EXPECT_DIFFERENT(GB_mode_of_file(someFile), -1);
    TEST_EXPECT_DIFFERENT(GB_mode_of_file(someDir), -1);
    TEST_EXPECT_EQUAL(GB_mode_of_file(noFile), -1);
    TEST_EXPECT_EQUAL(GB_mode_of_file(NULp), -1);

    {
        const char *linkToFile  = "fileLink";
        const char *linkToDir   = "dirLink";
        const char *linkNowhere = "brokenLink";

        TEST_EXPECT_DIFFERENT(GB_unlink(linkToFile), -1);
        TEST_EXPECT_DIFFERENT(GB_unlink(linkNowhere), -1);
        TEST_EXPECT_DIFFERENT(GB_unlink(linkToDir), -1);

        TEST_EXPECT_NO_ERROR(GB_symlink(someFile, linkToFile));
        TEST_EXPECT_NO_ERROR(GB_symlink(someDir, linkToDir));
        TEST_EXPECT_NO_ERROR(GB_symlink(noFile, linkNowhere));

        TEST_EXPECT(GB_is_link(linkToFile));
        TEST_EXPECT(GB_is_link(linkToDir));
        TEST_EXPECT(GB_is_link(linkNowhere));
        TEST_REJECT(GB_is_link(someFile));
        TEST_REJECT(GB_is_link(noFile));
        TEST_REJECT(GB_is_link(someDir));
        TEST_REJECT(GB_is_link(NULp));

        TEST_EXPECT(GB_is_regularfile(linkToFile));
        TEST_REJECT(GB_is_regularfile(linkToDir));
        TEST_REJECT(GB_is_regularfile(linkNowhere));
        TEST_EXPECT(GB_is_regularfile(someFile));
        TEST_REJECT(GB_is_regularfile(someDir));
        TEST_REJECT(GB_is_regularfile(noFile));
        TEST_REJECT(GB_is_regularfile(NULp));

        TEST_REJECT(GB_is_directory(linkToFile));
        TEST_EXPECT(GB_is_directory(linkToDir));
        TEST_REJECT(GB_is_directory(linkNowhere));
        TEST_REJECT(GB_is_directory(someFile));
        TEST_REJECT(GB_is_directory(noFile));
        TEST_EXPECT(GB_is_directory(someDir));
        TEST_REJECT(GB_is_directory(NULp));

        TEST_EXPECT(GB_is_readablefile(linkToFile));
        TEST_REJECT(GB_is_readablefile(linkToDir));
        TEST_REJECT(GB_is_readablefile(linkNowhere));
        TEST_EXPECT(GB_is_readablefile(someFile));
        TEST_REJECT(GB_is_readablefile(noFile));
        TEST_REJECT(GB_is_readablefile(someDir));
        TEST_REJECT(GB_is_readablefile(NULp));

        TEST_EXPECT(GB_is_readable(linkToDir));
        TEST_EXPECT(GB_is_readable(someDir));

        TEST_EXPECT_DIFFERENT(GB_mode_of_link(linkToFile), GB_mode_of_file(someFile));
        TEST_EXPECT_DIFFERENT(GB_mode_of_link(linkToDir), GB_mode_of_file(someDir));
        TEST_EXPECT_DIFFERENT(GB_mode_of_link(linkNowhere), -1);
        TEST_EXPECT_EQUAL(GB_mode_of_link(NULp), -1);

        TEST_EXPECT_DIFFERENT(GB_unlink(linkToFile), -1);
        TEST_EXPECT_DIFFERENT(GB_unlink(linkToDir), -1);
        TEST_EXPECT_DIFFERENT(GB_unlink(linkNowhere), -1);
    }
}

#define MODE_MASK 0xFFC0
#define TEST_EXPECT_MODE_EQUAL(got,expd) TEST_EXPECT_EQUAL((got)&MODE_MASK, (expd)&MODE_MASK)

void TEST_basic_file_ops() {
    const char *smallerFile = "general/mac.input";
    const char *biggerFile  = "general/dos.input";
    const char *f1          = "general/tmp1.input";
    const char *f2          = "general/tmp2.input";
    const char *noFile      = "general/nosuch.input";

    long small = GB_size_of_file(smallerFile);
    long big   = GB_size_of_file(biggerFile);

    long mode = GB_mode_of_file(smallerFile);

    TEST_EXPECT_DIFFERENT(GB_unlink(f1), -1); // delete destination files (probably present if test failed b4)
    TEST_EXPECT_DIFFERENT(GB_unlink(f2), -1);

    TEST_REJECT(GB_is_regularfile(f1));
    TEST_REJECT(GB_is_regularfile(f2));

    TEST_EXPECT_NO_ERROR(GB_copy_file(smallerFile, f1));
    TEST_EXPECT_EQUAL(GB_size_of_file(f1), small);
    TEST_EXPECT_MODE_EQUAL(GB_mode_of_file(f1), mode);

    TEST_EXPECT_NO_ERROR(GB_copy_file(biggerFile, f2));
    TEST_EXPECT_EQUAL(GB_size_of_file(f2), big);
    TEST_EXPECT_ERROR_CONTAINS(GB_safe_rename_file(f1, f2), "already exists"); // rename does not overwrite
    TEST_EXPECT_EQUAL(GB_size_of_file(f1), small);
    TEST_EXPECT_EQUAL(GB_size_of_file(f2), big);

    TEST_EXPECT_NO_ERROR(GB_move_file(f1, f2));
    TEST_EXPECT_EQUAL(GB_size_of_file(f1), -1);
    TEST_EXPECT_EQUAL(GB_size_of_file(f2), small);
    TEST_EXPECT_MODE_EQUAL(GB_mode_of_file(f2), mode);

    // ------------------------
    //      test failures:

    // attempt to copy non-existing file
    TEST_EXPECT_ERROR_CONTAINS(GB_copy_file(noFile, f1), "No such file");
    TEST_EXPECT_ERROR_CONTAINS(GB_copy_file(noFile, f2), "No such file");
    TEST_REJECT(GB_is_regularfile(f1));
    TEST_EXPECT(GB_is_regularfile(f2));

    TEST_EXPECT_ERROR_CONTAINS(GB_safe_copy_file(smallerFile, f2), "already exists"); // safe-copy does not overwrite

    // attempt to copy/move over write-protected dest-file
    long mode_wprot = mode & ~(S_IWUSR | S_IWGRP | S_IWOTH);
    TEST_EXPECT_NO_ERROR(GB_set_mode_of_file(f2, mode_wprot)); // remove write-permission

    TEST_EXPECT_ERROR_CONTAINS(GB_copy_file(smallerFile, f2), "Permission denied");

    TEST_EXPECT_NO_ERROR(GB_copy_file(smallerFile, f1));
    TEST_EXPECT_NO_ERROR(GB_move_file(f1, f2)); // overwrites existing file (even if write-protected)
    TEST_EXPECT_EQUAL(GB_size_of_file(f1), -1);
    TEST_EXPECT_EQUAL(GB_size_of_file(f2), small);
    TEST_EXPECT_MODE_EQUAL(GB_mode_of_file(f2), mode_wprot); // and keeps mode of destination

    // attempt to copy/move unreadable source-file
    long mode_unread = mode & ~(S_IRUSR | S_IRGRP | S_IROTH);
    TEST_EXPECT_NO_ERROR(GB_set_mode_of_file(f2, mode_unread)); // remove read-permission

    TEST_EXPECT_ERROR_CONTAINS(GB_copy_file(f2, f1), "Permission denied");
    TEST_EXPECT_EQUAL(GB_size_of_file(f1), -1);
    TEST_EXPECT_EQUAL(GB_size_of_file(f2), small);

    TEST_EXPECT_NO_ERROR(GB_move_file(f2, f1)); // overwrite with unreadable file
    TEST_EXPECT_EQUAL(GB_size_of_file(f1), small);
    TEST_EXPECT_EQUAL(GB_size_of_file(f2), -1);
    TEST_EXPECT_MODE_EQUAL(GB_mode_of_file(f1), mode_unread); // and keeps mode of destination

    TEST_EXPECT_NO_ERROR(GB_set_mode_of_file(f1, mode)); // restore mode

    // attempt to move non-existing file
    TEST_EXPECT_ERROR_CONTAINS(GB_move_file(f2, f1), "No such file");
    TEST_EXPECT_EQUAL(GB_size_of_file(f1), small);
    TEST_EXPECT_EQUAL(GB_size_of_file(f2), -1);

    TEST_EXPECT_DIFFERENT(GB_unlink(f1), -1);

    // --------------------
    //      test bugs:

    TEST_EXPECT_NO_ERROR(GB_copy_file(biggerFile, f1));
    TEST_EXPECT_EQUAL(GB_size_of_file(f1), big);
    TEST_EXPECT_NO_ERROR(GB_copy_file(smallerFile, f1)); // overwrite bigger with smaller file
    TEST_EXPECT_EQUAL(GB_size_of_file(f1), small);       // truncates correctly

    TEST_EXPECT_DIFFERENT(GB_unlink(f1), -1);

    // check cleaned-up
    TEST_REJECT(GB_is_regularfile(f1));
    TEST_REJECT(GB_is_regularfile(f2));
    TEST_REJECT(GB_is_regularfile(noFile));
}
TEST_PUBLISH(TEST_basic_file_ops);

#endif // UNIT_TESTS

// --------------------------------------------------------------------------------