history_sqlite.h

Go to the documentation of this file.

#ifndef CVMFS_HISTORY_SQLITE_H_
#define CVMFS_HISTORY_SQLITE_H_

#include <stdint.h>
#include <time.h>

#include <string>
#include <vector>

#include "crypto/hash.h"
#include "history.h"
#include "history_sql.h"

namespace history {

class SqliteHistory : public History {
 protected:
  static const std::string kPreviousRevisionKey;

 public:
  virtual ~SqliteHistory() { }

  static SqliteHistory* Open(const std::string &file_name);

  static SqliteHistory* OpenWritable(const std::string &file_name);

  static SqliteHistory* Create(const std::string &file_name,
                               const std::string &fqrn);

  bool IsWritable() const;
  unsigned GetNumberOfTags() const;

  bool BeginTransaction()  const;

  bool CommitTransaction() const;

  virtual bool Vacuum() { return database_->Vacuum(); }

  bool SetPreviousRevision(const shash::Any &history_hash);
  shash::Any previous_revision() const;

  bool Insert(const Tag &tag);
  bool Remove(const std::string &name);
  bool Exists(const std::string &name) const;
  bool GetByName(const std::string &name, Tag *tag) const;
  bool GetByDate(const time_t timestamp, Tag *tag) const;
  bool List(std::vector<Tag> *tags) const;

  virtual bool GetBranchHead(const std::string &branch_name, Tag *tag) const;
  virtual bool ExistsBranch(const std::string &branch_name) const;
  virtual bool InsertBranch(const Branch &branch);
  virtual bool PruneBranches();
  virtual bool ListBranches(std::vector<Branch> *branches) const;

  bool ListRecycleBin(std::vector<shash::Any> *hashes) const;
  bool EmptyRecycleBin();

  bool Rollback(const Tag &updated_target_tag);

  bool ListTagsAffectedByRollback(const std::string  &target_tag_name,
                                  std::vector<Tag>   *tags) const;

  bool GetHashes(std::vector<shash::Any> *hashes) const;

  // database file management controls
  void TakeDatabaseFileOwnership();
  void DropDatabaseFileOwnership();
  bool OwnsDatabaseFile() const {
    return database_.IsValid() && database_->OwnsFile();
  }
  std::string filename() const { return database_->filename(); }

 protected:
  static SqliteHistory* Open(const std::string &file_name,
                             const bool read_write);
  bool OpenDatabase(const std::string &file_name, const bool read_write);
  bool CreateDatabase(const std::string &file_name, const std::string &fqrn);
  void PrepareQueries();

 private:
  template <class SqlListingT>
  bool RunListing(std::vector<Tag> *list, SqlListingT *sql) const;

 private:
  UniquePtr<HistoryDatabase>        database_;

  UniquePtr<SqlInsertTag>           insert_tag_;
  UniquePtr<SqlRemoveTag>           remove_tag_;
  UniquePtr<SqlFindTag>             find_tag_;
  UniquePtr<SqlFindTagByDate>       find_tag_by_date_;
  UniquePtr<SqlCountTags>           count_tags_;
  UniquePtr<SqlListTags>            list_tags_;
  UniquePtr<SqlGetHashes>           get_hashes_;
  UniquePtr<SqlRollbackTag>         rollback_tag_;
  UniquePtr<SqlListRollbackTags>    list_rollback_tags_;
  UniquePtr<SqlListBranches>        list_branches_;
  UniquePtr<SqlInsertBranch>        insert_branch_;
  UniquePtr<SqlFindBranchHead>      find_branch_head_;
  UniquePtr<SqlRecycleBinList>      recycle_list_;
  UniquePtr<SqlRecycleBinFlush>     recycle_empty_;
};

}  // namespace history

#endif  // CVMFS_HISTORY_SQLITE_H_