<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Barry: restore.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="classes.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="dir_3e14c0bb4416cf979afc3165665fc916.html">src</a>
</div>
</div>
<div class="contents">
<h1>restore.h</h1><a href="restore_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">///</span>
<a name="l00002"></a>00002 <span class="comment"></span><span class="comment">/// \file restore.h</span>
<a name="l00003"></a>00003 <span class="comment"></span><span class="comment">/// Builder class for restoring from Barry Backup files</span>
<a name="l00004"></a>00004 <span class="comment"></span><span class="comment">///</span>
<a name="l00005"></a>00005 <span class="comment"></span>
<a name="l00006"></a>00006 <span class="comment">/*</span>
<a name="l00007"></a>00007 <span class="comment"> Copyright (C) 2010-2011, Net Direct Inc. (http://www.netdirect.ca/)</span>
<a name="l00008"></a>00008 <span class="comment"></span>
<a name="l00009"></a>00009 <span class="comment"> This program is free software; you can redistribute it and/or modify</span>
<a name="l00010"></a>00010 <span class="comment"> it under the terms of the GNU General Public License as published by</span>
<a name="l00011"></a>00011 <span class="comment"> the Free Software Foundation; either version 2 of the License, or</span>
<a name="l00012"></a>00012 <span class="comment"> (at your option) any later version.</span>
<a name="l00013"></a>00013 <span class="comment"></span>
<a name="l00014"></a>00014 <span class="comment"> This program is distributed in the hope that it will be useful,</span>
<a name="l00015"></a>00015 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00016"></a>00016 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</span>
<a name="l00017"></a>00017 <span class="comment"></span>
<a name="l00018"></a>00018 <span class="comment"> See the GNU General Public License in the COPYING file at the</span>
<a name="l00019"></a>00019 <span class="comment"> root directory of this project for more details.</span>
<a name="l00020"></a>00020 <span class="comment">*/</span>
<a name="l00021"></a>00021
<a name="l00022"></a>00022 <span class="preprocessor">#ifndef __BARRYBACKUP_RESTORE_H__</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define __BARRYBACKUP_RESTORE_H__</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include "<a class="code" href="dll_8h.html" title="Macros for handling DLL/library API visibility.">dll.h</a>"</span>
<a name="l00026"></a>00026 <span class="preprocessor">#include "<a class="code" href="builder_8h.html" title="Virtual protocol packet builder wrapper.">builder.h</a>"</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include "<a class="code" href="configfile_8h.html" title="Barry configuraion class, for one device PIN.">configfile.h</a>"</span>
<a name="l00028"></a>00028 <span class="preprocessor">#include <string></span>
<a name="l00029"></a>00029 <span class="preprocessor">#include <vector></span>
<a name="l00030"></a>00030 <span class="preprocessor">#include <memory></span>
<a name="l00031"></a>00031
<a name="l00032"></a>00032 <span class="comment">// forward declarations</span>
<a name="l00033"></a>00033 <span class="keyword">namespace </span>reuse {
<a name="l00034"></a>00034 <span class="keyword">class </span>TarFile;
<a name="l00035"></a>00035 }
<a name="l00036"></a>00036
<a name="l00037"></a>00037 <span class="keyword">namespace </span>Barry {
<a name="l00038"></a>00038
<a name="l00039"></a>00039 <span class="comment">//</span>
<a name="l00040"></a>00040 <span class="comment">// Restore</span>
<a name="l00041"></a>00041 <span class="comment">//</span><span class="comment"></span>
<a name="l00042"></a>00042 <span class="comment">/// Barry Backup Restore builder class. This class is suitable</span>
<a name="l00043"></a>00043 <span class="comment">/// to be used as a builder object anywhere a builder object is</span>
<a name="l00044"></a>00044 <span class="comment">/// accepted. It reads from a Barry Backup tar.gz backup file,</span>
<a name="l00045"></a>00045 <span class="comment">/// and builds records in a staged manner.</span>
<a name="l00046"></a>00046 <span class="comment">///</span>
<a name="l00047"></a>00047 <span class="comment">/// If a backup file contains more than one database (for example</span>
<a name="l00048"></a>00048 <span class="comment">/// both Address Book and Calendar), then it will build one database</span>
<a name="l00049"></a>00049 <span class="comment">/// first, return false on Retrieve(), and then build the next.</span>
<a name="l00050"></a>00050 <span class="comment">/// If Retrieve() returns false, but EndOfFile() also returns false,</span>
<a name="l00051"></a>00051 <span class="comment">/// then more databases are available.</span>
<a name="l00052"></a>00052 <span class="comment">///</span>
<a name="l00053"></a>00053 <span class="comment">/// The idea is that you can call Desktop::SaveDatabase() multiple</span>
<a name="l00054"></a>00054 <span class="comment">/// times with this same Restore object, for all the databases in</span>
<a name="l00055"></a>00055 <span class="comment">/// the backup file.</span>
<a name="l00056"></a>00056 <span class="comment">///</span>
<a name="l00057"></a>00057 <span class="comment">/// It is safe to call Retrieve() multiple times, so when first</span>
<a name="l00058"></a>00058 <span class="comment">/// starting a restore:</span>
<a name="l00059"></a>00059 <span class="comment">/// - call the constructor</span>
<a name="l00060"></a>00060 <span class="comment">/// - call AddDB() with any filters</span>
<a name="l00061"></a>00061 <span class="comment">/// - then call Retrieve(), which will grab the first record,</span>
<a name="l00062"></a>00062 <span class="comment">/// and make GetDBName() valid.</span>
<a name="l00063"></a>00063 <span class="comment">///</span>
<a name="l00064"></a><a class="code" href="classBarry_1_1Restore.html">00064</a> <span class="comment"></span><span class="keyword">class </span>BXEXPORT <a class="code" href="classBarry_1_1Restore.html" title="Barry Backup Restore builder class.">Restore</a> : <span class="keyword">public</span> Barry::<a class="code" href="classBarry_1_1Builder.html" title="Base class for the builder functor hierarchy.">Builder</a>
<a name="l00065"></a>00065 {
<a name="l00066"></a>00066 <span class="keyword">public</span>:
<a name="l00067"></a>00067 <span class="keyword">typedef</span> Barry::ConfigFile::DBListType DBListType;
<a name="l00068"></a>00068
<a name="l00069"></a>00069 <span class="keyword">private</span>:
<a name="l00070"></a>00070 <span class="keyword">enum</span> RetrievalState
<a name="l00071"></a>00071 {
<a name="l00072"></a>00072 RS_EMPTY, <span class="comment">// no record loaded</span>
<a name="l00073"></a>00073 RS_UNKNOWN, <span class="comment">// record data loaded, but not yet checked</span>
<a name="l00074"></a>00074 <span class="comment">// whether this is part of current database</span>
<a name="l00075"></a>00075 RS_NEXT, <span class="comment">// record loaded, part of current database</span>
<a name="l00076"></a>00076 RS_DBEND, <span class="comment">// next record loaded, but end-of-database</span>
<a name="l00077"></a>00077 <span class="comment">// not yet processed by Builder API</span>
<a name="l00078"></a>00078 RS_EOF <span class="comment">// no recrd loaded, end of tar file</span>
<a name="l00079"></a>00079 };
<a name="l00080"></a>00080
<a name="l00081"></a>00081 DBListType m_dbList;
<a name="l00082"></a>00082
<a name="l00083"></a>00083 std::string m_tarpath;
<a name="l00084"></a>00084 std::auto_ptr<reuse::TarFile> m_tar;
<a name="l00085"></a>00085
<a name="l00086"></a>00086 <span class="keywordtype">bool</span> m_default_all_db;
<a name="l00087"></a>00087 RetrievalState m_tar_record_state;
<a name="l00088"></a>00088 uint8_t m_rec_type;
<a name="l00089"></a>00089 uint32_t m_unique_id;
<a name="l00090"></a>00090 std::string m_current_dbname;
<a name="l00091"></a>00091 Barry::Data m_record_data;
<a name="l00092"></a>00092 std::string m_tar_id_text;
<a name="l00093"></a>00093
<a name="l00094"></a>00094 <span class="keyword">protected</span>:
<a name="l00095"></a>00095 <span class="keyword">static</span> <span class="keywordtype">bool</span> SplitTarPath(<span class="keyword">const</span> std::string &tarpath,
<a name="l00096"></a>00096 std::string &dbname, std::string &dbid_text,
<a name="l00097"></a>00097 uint8_t &dbrectype, uint32_t &dbid);
<a name="l00098"></a>00098
<a name="l00099"></a>00099 <span class="keywordtype">bool</span> IsSelected(<span class="keyword">const</span> std::string &dbName) <span class="keyword">const</span>;
<a name="l00100"></a>00100 RetrievalState Retrieve(Data &record_data);
<a name="l00101"></a>00101
<a name="l00102"></a>00102
<a name="l00103"></a>00103 <span class="keyword">public</span>:<span class="comment"></span>
<a name="l00104"></a>00104 <span class="comment"> /// If default_all_db is true, and none of the Add*() functions</span>
<a name="l00105"></a>00105 <span class="comment"> /// are called (meaning that Restore has an empty database list),</span>
<a name="l00106"></a>00106 <span class="comment"> /// then all records are restored. If false in this situation,</span>
<a name="l00107"></a>00107 <span class="comment"> /// nothing is restored.</span>
<a name="l00108"></a>00108 <span class="comment"> ///</span>
<a name="l00109"></a>00109 <span class="comment"> /// If any of the Add*() functions are called, then the database</span>
<a name="l00110"></a>00110 <span class="comment"> /// list takes precedence, and default_all_db has no effect.</span>
<a name="l00111"></a>00111 <span class="comment"> ///</span>
<a name="l00112"></a>00112 <span class="comment"></span> <span class="keyword">explicit</span> <a class="code" href="classBarry_1_1Restore.html" title="Barry Backup Restore builder class.">Restore</a>(<span class="keyword">const</span> std::string &tarpath,
<a name="l00113"></a>00113 <span class="keywordtype">bool</span> default_all_db = <span class="keyword">true</span>);
<a name="l00114"></a>00114 ~<a class="code" href="classBarry_1_1Restore.html" title="Barry Backup Restore builder class.">Restore</a>();
<a name="l00115"></a>00115 <span class="comment"></span>
<a name="l00116"></a>00116 <span class="comment"> /// Add database name to the read filter.</span>
<a name="l00117"></a>00117 <span class="comment"></span> <span class="keywordtype">void</span> AddDB(<span class="keyword">const</span> std::string &dbName);
<a name="l00118"></a>00118 <span class="comment"></span>
<a name="l00119"></a>00119 <span class="comment"> /// Add all database names in dblist to the read filter</span>
<a name="l00120"></a>00120 <span class="comment"> /// This function is additive.</span>
<a name="l00121"></a>00121 <span class="comment"></span> <span class="keywordtype">void</span> Add(<span class="keyword">const</span> DBListType &dbList);
<a name="l00122"></a>00122
<a name="l00123"></a>00123 <span class="comment">// Skip the current DB, in case of error, or preference</span>
<a name="l00124"></a>00124 <span class="keywordtype">void</span> SkipCurrentDB();
<a name="l00125"></a>00125 <span class="comment"></span>
<a name="l00126"></a>00126 <span class="comment"> /// Loads the given file, and counts all records according</span>
<a name="l00127"></a>00127 <span class="comment"> /// to the current read filter. Does not use the main</span>
<a name="l00128"></a>00128 <span class="comment"> /// Restore file, but opens the file separately.</span>
<a name="l00129"></a>00129 <span class="comment"> /// It is safe to call this function as often as needed.</span>
<a name="l00130"></a>00130 <span class="comment"></span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> GetRecordTotal() <span class="keyword">const</span>;
<a name="l00131"></a>00131 <span class="comment"></span>
<a name="l00132"></a>00132 <span class="comment"> /// Static version of above call</span>
<a name="l00133"></a>00133 <span class="comment"></span> <span class="keyword">static</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> GetRecordTotal(<span class="keyword">const</span> std::string &tarpath,
<a name="l00134"></a>00134 <span class="keyword">const</span> DBListType &dbList, <span class="keywordtype">bool</span> default_all_db);
<a name="l00135"></a>00135 <span class="comment"></span>
<a name="l00136"></a>00136 <span class="comment"> /// If this function returns true, it fills data with the</span>
<a name="l00137"></a>00137 <span class="comment"> /// meta data that the next call to BuildRecord() will retrieve.</span>
<a name="l00138"></a>00138 <span class="comment"> /// This is useful for applications that need to setup a manual</span>
<a name="l00139"></a>00139 <span class="comment"> /// call to Desktop::SaveDatabase().</span>
<a name="l00140"></a>00140 <span class="comment"></span> <span class="keywordtype">bool</span> GetNextMeta(<a class="code" href="classBarry_1_1DBData.html" title="Database record data class.">DBData</a> &data);
<a name="l00141"></a>00141
<a name="l00142"></a>00142 <span class="comment">// Barry::Builder overrides</span>
<a name="l00143"></a>00143 <span class="keywordtype">bool</span> BuildRecord(<a class="code" href="classBarry_1_1DBData.html" title="Database record data class.">Barry::DBData</a> &data, <span class="keywordtype">size_t</span> &offset,
<a name="l00144"></a>00144 <span class="keyword">const</span> <a class="code" href="classBarry_1_1IConverter.html" title="Main charset conversion class, primarily focused on converting between the Blackberry...">Barry::IConverter</a> *ic);
<a name="l00145"></a>00145 <span class="keywordtype">bool</span> FetchRecord(<a class="code" href="classBarry_1_1DBData.html" title="Database record data class.">Barry::DBData</a> &data, <span class="keyword">const</span> <a class="code" href="classBarry_1_1IConverter.html" title="Main charset conversion class, primarily focused on converting between the Blackberry...">Barry::IConverter</a> *ic);
<a name="l00146"></a>00146 <span class="keywordtype">bool</span> EndOfFile() <span class="keyword">const</span>;
<a name="l00147"></a>00147 };
<a name="l00148"></a>00148
<a name="l00149"></a>00149 } <span class="comment">// namespace Barry</span>
<a name="l00150"></a>00150
<a name="l00151"></a>00151 <span class="preprocessor">#endif</span>
<a name="l00152"></a>00152 <span class="preprocessor"></span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Mar 1 17:50:16 2011 for Barry by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>
