sync_union.h

Go to the documentation of this file.

#ifndef CVMFS_SYNC_UNION_H_
#define CVMFS_SYNC_UNION_H_

#include <set>
#include <string>

#include "sync_item.h"
#include "util/shared_ptr.h"

namespace publish {

class AbstractSyncMediator;
class SyncMediator;

enum UnionFsType {
  kUnionFsUnknown,
  kUnionFsAufs,
  kUnionFsOverlay,
  kUnionFsTarball,
};

class SyncUnion {
 public:
  SyncUnion(AbstractSyncMediator *mediator, const std::string &rdonly_path,
            const std::string &union_path, const std::string &scratch_path);
  virtual ~SyncUnion() {}

  virtual bool Initialize();

  virtual void Traverse() = 0;

  virtual void PostUpload() { }

  SharedPtr<SyncItem> CreateSyncItem(const std::string &relative_parent_path,
                                     const std::string &filename,
                                     const SyncItemType entry_type) const;

  inline std::string rdonly_path() const { return rdonly_path_; }
  inline std::string union_path() const { return union_path_; }
  inline std::string scratch_path() const { return scratch_path_; }

  virtual std::string UnwindWhiteoutFilename(
      SharedPtr<SyncItem> entry) const = 0;

  virtual bool IsOpaqueDirectory(SharedPtr<SyncItem> directory) const = 0;

  virtual bool IsWhiteoutEntry(SharedPtr<SyncItem> entry) const = 0;

  virtual bool IgnoreFilePredicate(const std::string &parent_dir,
                                   const std::string &filename);

  bool IsInitialized() const { return initialized_; }
  virtual bool SupportsHardlinks() const { return false; }

 protected:
  std::string rdonly_path_;
  std::string scratch_path_;
  std::string union_path_;

  AbstractSyncMediator *mediator_;

  virtual void PreprocessSyncItem(SharedPtr<SyncItem> entry) const;

  virtual void ProcessRegularFile(const std::string &parent_dir,
                                  const std::string &filename);

  virtual bool ProcessDirectory(const std::string &parent_dir,
                                const std::string &dir_name);
  virtual bool ProcessDirectory(SharedPtr<SyncItem> entry);
  virtual bool ProcessUnmaterializedDirectory(SharedPtr<SyncItem> entry);

  virtual void ProcessSymlink(const std::string &parent_dir,
                              const std::string &link_name);

  virtual void EnterDirectory(const std::string &parent_dir,
                              const std::string &dir_name);

  virtual void LeaveDirectory(const std::string &parent_dir,
                              const std::string &dir_name);

  void ProcessCharacterDevice(const std::string &parent_dir,
                              const std::string &filename);

  void ProcessBlockDevice(const std::string &parent_dir,
                          const std::string &filename);

  void ProcessFifo(const std::string &parent_dir, const std::string &filename);

  void ProcessSocket(const std::string &parent_dir,
                     const std::string &filename);

  void ProcessFile(SharedPtr<SyncItem> entry);

 private:
  bool initialized_;
};  // class SyncUnion

}  // namespace publish

#endif  // CVMFS_SYNC_UNION_H_