3 /// Builder class for restoring from Barry Backup files
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__
27 #include "configfile.h"
32 // forward declarations
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.
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.
53 /// The idea is that you can call Desktop::SaveDatabase() multiple
54 /// times with this same Restore object, for all the databases in
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.
64 class BXEXPORT Restore
: public Barry::Builder
67 typedef Barry::ConfigFile::DBListType DBListType
;
72 std::string m_tarpath
;
73 std::auto_ptr
<reuse::TarFile
> m_tar
;
75 bool m_default_all_db
;
77 bool m_tar_record_loaded
;
80 std::string m_current_dbname
;
81 Barry::Data m_record_data
;
82 std::string m_tar_id_text
;
85 static bool SplitTarPath(const std::string
&tarpath
,
86 std::string
&dbname
, std::string
&dbid_text
,
87 uint8_t &dbrectype
, uint32_t &dbid
);
89 bool IsSelected(const std::string
&dbName
) const;
90 bool Retrieve(Data
&record_data
);
94 /// If default_all_db is true, and none of the Add*() functions
95 /// are called (meaning that Restore has an empty database list),
96 /// then all records are restored. If false in this situation,
97 /// nothing is restored.
99 /// If any of the Add*() functions are called, then the database
100 /// list takes precedence, and default_all_db has no effect.
102 explicit Restore(const std::string
&tarpath
,
103 bool default_all_db
= true);
106 /// Add database name to the read filter.
107 void AddDB(const std::string
&dbName
);
109 // Skip the current DB, in case of error, or preference
110 void SkipCurrentDB();
112 /// Loads the given file, and counts all records according
113 /// to the current read filter. Does not use the main
114 /// Restore file, but opens the file separately.
115 /// It is safe to call this function as often as needed.
116 unsigned int GetRecordTotal() const;
118 /// Static version of above call
119 static unsigned int GetRecordTotal(const std::string
&tarpath
,
120 const DBListType
&dbList
, bool default_all_db
);
122 // Barry::Builder overrides
123 bool BuildRecord(Barry::DBData
&data
, size_t &offset
,
124 const Barry::IConverter
*ic
);
125 bool FetchRecord(Barry::DBData
&data
, const Barry::IConverter
*ic
);
126 bool EndOfFile() const;