mergerfs/src/fs_clonepath.cpp

/*
  Copyright (c) 2016, Antonio SJ Musumeci <trapexit@spawn.link>

  Permission to use, copy, modify, and/or distribute this software for any
  purpose with or without fee is hereby granted, provided that the above
  copyright notice and this permission notice appear in all copies.

  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/

#include "errno.h"
#include "fs_attr.hpp"
#include "fs_clonepath.hpp"
#include "fs_lchown.hpp"
#include "fs_lstat.hpp"
#include "fs_lutimens.hpp"
#include "fs_mkdir.hpp"
#include "fs_path.hpp"
#include "fs_xattr.hpp"
#include "ugid.hpp"

#include "ghc/filesystem.hpp"

#include <string>

using std::string;

namespace gfs = ghc::filesystem;

namespace l
{
  static
  bool
  ignorable_error(const int err_)
  {
    switch(err_)
      {
      case -ENOTTY:
      case -ENOTSUP:
#if ENOTSUP != EOPNOTSUPP
      case -EOPNOTSUPP:
#endif
        return true;
      }

    return false;
  }
}

/*
  Attempts to clone a path.
  The directories which already exist are left alone.
  The new directories have metadata set to match the original if
  possible. Optionally ignore errors on metadata copies.
*/
int
fs::clonepath(const string &fromsrc_,
              const string &tosrc_,
              const char   *relative_,
              const bool    return_metadata_errors_)
{
  int         rv;
  struct stat st;
  string      topath;
  string      frompath;
  string      dirname;

  if((relative_ == NULL) || (relative_[0] == '\0'))
    return 0;

  dirname = fs::path::dirname(relative_);
  if(dirname != "/")
    {
      rv = fs::clonepath(fromsrc_,tosrc_,dirname,return_metadata_errors_);
      if(rv == -1)
        return -1;
    }

  frompath = fs::path::make(fromsrc_,relative_);
  rv = fs::lstat(frompath,&st);
  if(rv == -1)
    return -1;
  else if(!S_ISDIR(st.st_mode))
    return (errno=ENOTDIR,-1);

  topath = fs::path::make(tosrc_,relative_);
  rv = fs::mkdir(topath,st.st_mode);
  if(rv == -1)
    {
      if(errno == EEXIST)
        return 0;
      else
        return -1;
    }

  // it may not support it... it's fine...
  rv = fs::attr::copy(frompath,topath);
  if(return_metadata_errors_ && (rv == -1) && !l::ignorable_error(errno))
    return -1;

  // it may not support it... it's fine...
  rv = fs::xattr::copy(frompath,topath);
  if(return_metadata_errors_ && (rv == -1) && !l::ignorable_error(errno))
    return -1;

  rv = fs::lchown_check_on_error(topath,st);
  if(return_metadata_errors_ && (rv == -1))
    return -1;

  rv = fs::lutimens(topath,st);
  if(return_metadata_errors_ && (rv == -1))
    return -1;

  return 0;
}

int
fs::clonepath(const gfs::path &fromsrc_,
              const gfs::path &tosrc_,
              const gfs::path &relative_)
{
  int         rv;
  struct stat st;
  gfs::path   topath;
  gfs::path   frompath;

  if(relative_.empty())
    return 0;

  if(!relative_.parent_path().empty())
    {
      rv = fs::clonepath(fromsrc_,tosrc_,relative_.parent_path());
      if(rv < 0)
        return rv;
    }

  frompath = fromsrc_ / relative_;
  rv = fs::lstat(frompath,&st);
  if(rv < 0)
    return rv;
  else if(!S_ISDIR(st.st_mode))
    return -ENOTDIR;

  topath = tosrc_ / relative_;
  rv = fs::mkdir(topath,st.st_mode);
  if(rv == -EEXIST)
    return 0;
  else if(rv < 0)
    return rv;

  // it may not support it... it's fine...
  fs::attr::copy(frompath,topath);
  fs::xattr::copy(frompath,topath);
  fs::lchown_check_on_error(topath,st);
  fs::lutimens(topath,st);

  return 0;
}

int
fs::clonepath(const string &from_,
              const string &to_,
              const string &relative_,
              const bool    return_metadata_errors_)
{
  return fs::clonepath(from_,
                       to_,
                       relative_.c_str(),
                       return_metadata_errors_);
}

int
fs::clonepath_as_root(const string &from_,
                      const string &to_,
                      const char   *relative_,
                      const bool    return_metadata_errors_)
{
  if((relative_ == NULL) || (relative_[0] == '\0'))
    return 0;
  if(from_ == to_)
    return 0;

  {
    const ugid::SetRootGuard ugidGuard;

    return fs::clonepath(from_,to_,relative_,return_metadata_errors_);
  }
}

int
fs::clonepath_as_root(const string &from_,
                      const string &to_,
                      const string &relative_,
                      const bool    return_metadata_errors_)
{
  return fs::clonepath_as_root(from_,to_,relative_.c_str(),return_metadata_errors_);
}

int
fs::clonepath_as_root(const gfs::path &from_,
                      const gfs::path &to_,
                      const gfs::path &relative_)
{
  const ugid::SetRootGuard ugidGuard;

  return fs::clonepath(from_,to_,relative_);
}