tools: MimeDump<> can have all static members
[barry.git] / src / restore.h
blob9b856acc9b397cc20b4735e9f25a74dadd7a78d4
1 ///
2 /// \file restore.h
3 /// Builder class for restoring from Barry Backup files
4 ///
6 /*
7 Copyright (C) 2010, Net Direct Inc. (http://www.netdirect.ca/)
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
18 See the GNU General Public License in the COPYING file at the
19 root directory of this project for more details.
22 #ifndef __BARRYBACKUP_RESTORE_H__
23 #define __BARRYBACKUP_RESTORE_H__
25 #include "dll.h"
26 #include "builder.h"
27 #include "configfile.h"
28 #include <string>
29 #include <vector>
30 #include <memory>
32 // forward declarations
33 namespace reuse {
34 class TarFile;
37 namespace Barry {
40 // Restore
42 /// Barry Backup Restore builder class. This class is suitable
43 /// to be used as a builder object anywhere a builder object is
44 /// accepted. It reads from a Barry Backup tar.gz backup file,
45 /// and builds records in a staged manner.
46 ///
47 /// If a backup file contains more than one database (for example
48 /// both Address Book and Calendar), then it will build one database
49 /// first, return false on Retrieve(), and then build the next.
50 /// If Retrieve() returns false, but EndOfFile() also returns false,
51 /// then more databases are available.
52 ///
53 /// The idea is that you can call Desktop::SaveDatabase() multiple
54 /// times with this same Restore object, for all the databases in
55 /// the backup file.
56 ///
57 /// It is safe to call Retrieve() multiple times, so when first
58 /// starting a restore:
59 /// - call the constructor
60 /// - call AddDB() with any filters
61 /// - then call Retrieve(), which will grab the first record,
62 /// and make GetDBName() valid.
63 ///
64 class BXEXPORT Restore : public Barry::Builder
66 public:
67 typedef Barry::ConfigFile::DBListType DBListType;
69 private:
70 DBListType m_dbList;
72 std::auto_ptr<reuse::TarFile> m_tar;
74 bool m_default_all_db;
75 bool m_end_of_tar;
76 bool m_tar_record_loaded;
77 uint8_t m_rec_type;
78 uint32_t m_unique_id;
79 std::string m_current_dbname;
80 Barry::Data m_record_data;
81 std::string m_tar_id_text;
83 protected:
84 static bool SplitTarPath(const std::string &tarpath,
85 std::string &dbname, std::string &dbid_text,
86 uint8_t &dbrectype, uint32_t &dbid);
88 bool IsSelected(const std::string &dbName) const;
89 bool Retrieve(Data &record_data);
92 public:
93 explicit Restore(const std::string &tarpath,
94 bool default_all_db = true);
95 ~Restore();
97 /// Add database names to the read filter.
98 ///
99 /// If default_all_db is true and you don't call this function,
100 /// all databases are read.
101 /// If default_all_db is false and you don't call this function,
102 /// no databases are read.
103 /// Regardless of default_all_db, if you call this function one
104 /// or more times, only the specified databases are read.
105 void AddDB(const std::string &dbName);
107 // Skip the current DB, in case of error, or preference
108 void SkipCurrentDB();
110 /// Loads the given file, and counts all records according
111 /// to the current read filter. Does not use the main
112 /// Restore file, but opens the file separately.
113 /// It is safe to call this function as often as needed.
114 unsigned int GetRecordTotal(const std::string &tarpath) const;
116 // Barry::Builder overrides
117 bool BuildRecord(Barry::DBData &data, size_t &offset,
118 const Barry::IConverter *ic);
119 bool FetchRecord(Barry::DBData &data, const Barry::IConverter *ic);
120 bool EndOfFile() const;
123 } // namespace Barry
125 #endif