mergerfs/src/fs.hpp

/*
  The MIT License (MIT)

  Copyright (c) 2014 Antonio SJ Musumeci <trapexit@spawn.link>

  Permission is hereby granted, free of charge, to any person obtaining a copy
  of this software and associated documentation files (the "Software"), to deal
  in the Software without restriction, including without limitation the rights
  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  copies of the Software, and to permit persons to whom the Software is
  furnished to do so, subject to the following conditions:

  The above copyright notice and this permission notice shall be included in
  all copies or substantial portions of the Software.

  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  THE SOFTWARE.
*/

#ifndef __FS_HPP__
#define __FS_HPP__

#include <string>
#include <vector>
#include <map>

namespace fs
{
  using std::string;
  using std::vector;
  using std::map;

  struct Path
  {
    Path() {}
    Path(const string b,
         const string f)
      : base(b),
        full(f)
    {}

    string base;
    string full;
  };

  typedef fs::Path (*SearchFunc)(const vector<string>&,const string);
  typedef void     (*VecSearchFunc)(const vector<string>&,const string,vector<Path>&);

  string dirname(const string path);
  string basename(const string path);

  bool dir_is_empty(const string path);

  string make_path(const string base,
                   const string suffix);

  bool path_exists(vector<string>::const_iterator  begin,
                   vector<string>::const_iterator  end,
                   const string                    fusepath);
  bool path_exists(const vector<string>           &srcmounts,
                   const string                    fusepath);

  Path find_first(vector<string>::const_iterator  begin,
                  vector<string>::const_iterator  end,
                  const string                    fusepath);
  Path find_first(const vector<string>           &paths,
                  const string                    fusepath);
  void find_first(const vector<string> &paths,
                  const string          fusepath,
                  vector<Path>         &rv);

  Path find_first_with_permission(vector<string>::const_iterator  begin,
                                  vector<string>::const_iterator  end,
                                  const string                    fusepath);
  Path find_first_with_permission(const vector<string>           &paths,
                                  const string                    fusepath);
  void find_first_with_permission(const vector<string> &paths,
                                  const string          fusepath,
                                  vector<Path>         &rv);

  Path find_newest(vector<string>::const_iterator  begin,
                   vector<string>::const_iterator  end,
                   const string                    fusepath);
  Path find_newest(const vector<string>           &paths,
                   const string                    fusepath);
  void find_newest(const vector<string> &paths,
                   const string          fusepath,
                   vector<Path>         &rv);

  void find_all(const vector<string> &paths,
                const string          fusepath,
                vector<Path>         &rv);

  Path find_mfs(vector<string>::const_iterator  iter,
                vector<string>::const_iterator  enditer,
                const string                    fusepath);
  Path find_mfs(const vector<string>           &paths,
                const string                    fusepath);

  Path find_mfs_existing(vector<string>::const_iterator  iter,
                         vector<string>::const_iterator  enditer,
                         const string                    fusepath);
  Path find_mfs_existing(const vector<string>           &paths,
                         const string                    fusepath);

  Path find_random(vector<string>::const_iterator  iter,
                   vector<string>::const_iterator  enditer,
                   const string                    fusepath);
  Path find_random(const vector<string>           &paths,
                   const string                    fusepath);



  int clonepath(const string srcfrom,
                const string srcto,
                const string relative);

  int listxattr(const string    path,
                vector<char>   &attrs);
  int listxattr(const string    path,
                string         &attrs);
  int listxattr(const string    path,
                vector<string> &attrs);

  int getxattr(const string  path,
               const string  attr,
               vector<char> &value);
  int getxattr(const string  path,
               const string  attr,
               string       &value);

  int getxattrs(const string        path,
                map<string,string> &attrs);

  int setxattr(const string path,
               const string key,
               const string value,
               const int    flags);
  int setxattr(const int    fd,
               const string key,
               const string value,
               const int    flags);

  int setxattrs(const string              path,
                const map<string,string> &attrs);

  int copyxattrs(const string from,
                 const string to);

  int copyattr(const string from,
               const string to);
};

#endif // __FS_HPP__