fs.h

Go to the documentation of this file.

/*
BSD 3-Clause License
 
Copyright (c) 2022, Stable Cloud Computing, Inc.
 
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
 
1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.
 
2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.
 
3. Neither the name of the copyright holder nor the names of its
   contributors may be used to endorse or promote products derived from
   this software without specific prior written permission.
 
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef _SCC_UTIL_FS_H
#define _SCC_UTIL_FS_H
 
#include <string>
#include <map>
#include <functional>
#include <ostream>
#include <system_error>
 
namespace scc::util
{
 
enum class FileType
{
    unknown=    0,  
    reg=        1,  
    dir=        2,  
    link=       4,  
    sock=       8,  
    block=      16, 
    chr=        32, 
    fifo=       64  
};
 
struct FileStat
{
    FileType    type;           
    unsigned    mode;           
    int         uid;            
    int         gid;            
    uint64_t    size;           
    uint64_t    alloc_size;     
    uint64_t    access_time;    
    uint64_t    mod_time;       
    uint64_t    change_time;    
    uint64_t    inode;          
    uint16_t    num_links;      
 
    FileStat() : type(FileType::unknown), mode(0), uid(0), gid(0), size(0), alloc_size(0),
        access_time(0), mod_time(0), change_time(0) {}
};
 
bool default_scan_filter(const std::string&, FileType);
 
class Filesystem
{
    static void remove_file(const std::string&, std::system_error*);
    static void remove_dir(const std::string&, std::system_error*);
    static void remove_all(const std::string&, const FileType&, std::system_error*);
 
    Filesystem() {}
public:
    
    static std::map<std::string, FileType> scan_dir(const std::string&,
        std::function<bool(const std::string&, FileType)> = default_scan_filter, std::system_error* = nullptr);
 
    static FileType file_type(const std::string&, std::system_error* = nullptr);
    
    static FileStat file_stat(const std::string&, std::system_error* = nullptr);
    
    static void set_mode(const std::string&, unsigned, std::system_error* = nullptr);
    
    static void set_times(const std::string&, uint64_t, uint64_t, std::system_error* = nullptr);
    
    static void set_ids(const std::string&, int, int, std::system_error* = nullptr);
    
    static void set_size(const std::string&, off_t, std::system_error* = nullptr);
 
    static std::map<off_t, off_t> sparse_map(const std::string&, std::system_error* = nullptr);
 
    static void remove(const std::string&, std::system_error* = nullptr);
 
    static void rename(const std::string&, const std::string&, std::system_error* = nullptr);
 
    static void remove_all(const std::string& fn, std::system_error* err = nullptr)
    {
        auto ty = file_type(fn, err);
        if (ty == FileType::unknown) return;
        remove_all(fn, ty, err);
    }
    
    static void create_dir(const std::string&, std::system_error* = nullptr);
    
    static void create_reg(const std::string&, std::system_error* = nullptr);
    
    static std::string create_tmp_reg(const std::string&, std::system_error* = nullptr);
 
    static void create_symlink(const std::string&, const std::string&, std::system_error* = nullptr);
    
    static void create_link(const std::string&, const std::string&, std::system_error* = nullptr);
    
    static void create_fifo(const std::string&, std::system_error* = nullptr);
    
    static void change_dir(const std::string&, std::system_error* = nullptr);
    
    static std::string get_current_dir(std::system_error* = nullptr);
 
    static std::string read_symlink(const std::string&, std::system_error* = nullptr);
 
    static std::string norm_path(const std::string&, const std::string&) noexcept;
 
    static std::string norm_path(const std::string& path) noexcept
    {
        return norm_path("", path);
    }
};
 
void PrintTo(const FileStat&, std::ostream*);
void PrintTo(const FileType&, std::ostream*);
}
 
std::ostream& operator<<(std::ostream&, scc::util::FileStat);
std::ostream& operator<<(std::ostream&, scc::util::FileType);
#endif