local_filesys.hpp

Go to the documentation of this file.

#ifndef LIBFILEZILLA_LOCAL_FILESYS_HEADER
#define LIBFILEZILLA_LOCAL_FILESYS_HEADER
 
#include "fsresult.hpp"
#include "libfilezilla.hpp"
#include "time.hpp"
#include "file.hpp"
 
#ifdef FZ_WINDOWS
#include "glue/windows.hpp"
#else
#include <dirent.h>
#endif

namespace fz {

class FZ_PUBLIC_SYMBOL local_filesys final
{
public:
    local_filesys() = default;
    ~local_filesys();
 
    local_filesys(local_filesys const&) = delete;
    local_filesys& operator=(local_filesys const&) = delete;
 
    local_filesys(local_filesys &&) noexcept;
    local_filesys& operator=(local_filesys &&) noexcept;

    enum type {
        unknown = -1,
        file,
        dir,
        link
    };

    static char const path_separator;

    static inline bool is_separator(wchar_t c) {
#ifdef FZ_WINDOWS
        return c == '/' || c == '\\';
#else
        return c == '/';
#endif
    }

    static type get_file_type(native_string const& path, bool follow_links = false);

    static type get_file_info(native_string const& path, bool& is_link, int64_t* size, datetime* modification_time, int* mode, bool follow_links = true);

    static result get_file_info(native_string const& path, bool& is_link, type& type, int64_t* size, datetime* modification_time, int* mode, bool follow_links = true);

    static int64_t get_size(native_string const& path, bool *is_link = nullptr);

    result begin_find_files(native_string path, bool dirs_only = false, bool query_symlink_targets = true);

    result begin_find_files(file::file_t fd, bool dirs_only = false, bool query_symlink_targets = true);

    bool get_next_file(native_string& name);

    bool get_next_file(native_string& name, bool &is_link, type & t, int64_t* size, datetime* modification_time, int* mode);

    void end_find_files();
 
    static datetime get_modification_time(native_string const& path);
    static result set_modification_time(native_string const& path, const datetime& t);

    static result get_modification_time(file::file_t fd, datetime& t);

    static result set_modification_time(file::file_t fd, datetime const& t);

    static native_string get_link_target(native_string const& path);

    static native_string get_final_link_target(native_string const& path);

    file::file_t fd();
 
private:
#ifdef FZ_WINDOWS
    bool FZ_PRIVATE_SYMBOL check_buffer();
    std::vector<unsigned char> buffer_;
    unsigned char* cur_{};
    HANDLE dir_{INVALID_HANDLE_VALUE};
#else
    DIR* dir_{};
#endif
 
    // State for directory enumeration
    bool dirs_only_{};
    bool query_symlink_targets_{true};
};
 
enum class mkdir_permissions
{
    normal,

    cur_user,

    cur_user_and_admins
};

result FZ_PUBLIC_SYMBOL mkdir(native_string const& absolute_path, bool recurse, mkdir_permissions permissions = mkdir_permissions::normal, native_string * last_created = nullptr);

result FZ_PUBLIC_SYMBOL remove_dir(native_string const& absolute_path, bool missing_dir_is_error);

enum class rename_flags : unsigned int {
    none = 0,

    allow_copy = 0x1,

    no_replace = 0x2
};
 
inline bool operator&(rename_flags lhs, rename_flags rhs) {
    return (static_cast<unsigned int>(lhs) & static_cast<unsigned int>(rhs)) != 0;
}
 
inline rename_flags operator|(rename_flags lhs, rename_flags rhs) {
    return static_cast<rename_flags>(static_cast<unsigned int>(lhs) | static_cast<unsigned int>(rhs));
}
 
inline rename_flags& operator|=(rename_flags & lhs, rename_flags rhs) {
    lhs = lhs | rhs;
    return lhs;
}

result FZ_PUBLIC_SYMBOL rename_file(native_string const& source, native_string const& dest, rename_flags flags);

result FZ_PUBLIC_SYMBOL rename_file(native_string const& source, native_string const& dest, bool allow_copy = true);
 
}
 
#endif