<!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: r_cstore.cc 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>r_cstore.cc</h1><a href="r__cstore_8cc.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 r_cstore.cc</span>
<a name="l00003"></a>00003 <span class="comment"></span><span class="comment">/// Blackberry database record parser class for</span>
<a name="l00004"></a>00004 <span class="comment"></span><span class="comment">/// Content Store records.</span>
<a name="l00005"></a>00005 <span class="comment"></span><span class="comment">///</span>
<a name="l00006"></a>00006 <span class="comment"></span>
<a name="l00007"></a>00007 <span class="comment">/*</span>
<a name="l00008"></a>00008 <span class="comment"> Copyright (C) 2010-2011, Net Direct Inc. (http://www.netdirect.ca/)</span>
<a name="l00009"></a>00009 <span class="comment"></span>
<a name="l00010"></a>00010 <span class="comment"> This program is free software; you can redistribute it and/or modify</span>
<a name="l00011"></a>00011 <span class="comment"> it under the terms of the GNU General Public License as published by</span>
<a name="l00012"></a>00012 <span class="comment"> the Free Software Foundation; either version 2 of the License, or</span>
<a name="l00013"></a>00013 <span class="comment"> (at your option) any later version.</span>
<a name="l00014"></a>00014 <span class="comment"></span>
<a name="l00015"></a>00015 <span class="comment"> This program is distributed in the hope that it will be useful,</span>
<a name="l00016"></a>00016 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00017"></a>00017 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</span>
<a name="l00018"></a>00018 <span class="comment"></span>
<a name="l00019"></a>00019 <span class="comment"> See the GNU General Public License in the COPYING file at the</span>
<a name="l00020"></a>00020 <span class="comment"> root directory of this project for more details.</span>
<a name="l00021"></a>00021 <span class="comment">*/</span>
<a name="l00022"></a>00022
<a name="l00023"></a>00023 <span class="preprocessor">#include "<a class="code" href="r__cstore_8h.html" title="Blackberry database record parser class for Content Store records.">r_cstore.h</a>"</span>
<a name="l00024"></a>00024 <span class="preprocessor">#include "<a class="code" href="record-internal_8h.html" title="Support functions, types, and templates for the general record parsing classes in...">record-internal.h</a>"</span>
<a name="l00025"></a>00025 <span class="preprocessor">#include "<a class="code" href="data_8h.html" title="Class to deal with pre-saved data files.">data.h</a>"</span>
<a name="l00026"></a>00026
<a name="l00027"></a>00027 <span class="preprocessor">#include <iostream></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include <sstream></span>
<a name="l00029"></a>00029 <span class="preprocessor">#include <iomanip></span>
<a name="l00030"></a>00030
<a name="l00031"></a>00031 <span class="preprocessor">#define __DEBUG_MODE__</span>
<a name="l00032"></a>00032 <span class="preprocessor"></span><span class="preprocessor">#include "debug.h"</span>
<a name="l00033"></a>00033
<a name="l00034"></a>00034 <span class="keyword">using namespace </span>std;
<a name="l00035"></a>00035 <span class="keyword">using namespace </span>Barry::Protocol;
<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">///////////////////////////////////////////////////////////////////////////////</span>
<a name="l00041"></a>00041 <span class="comment"></span><span class="comment">// ContentStore class</span>
<a name="l00042"></a>00042
<a name="l00043"></a>00043 <span class="comment">// ContentStore field codes</span>
<a name="l00044"></a>00044 <span class="preprocessor">#define CSFC_FILENAME 0x01 // may not always be a complete file,but</span>
<a name="l00045"></a>00045 <span class="preprocessor"></span> <span class="comment">// a folder name as well</span>
<a name="l00046"></a>00046 <span class="preprocessor">#define CSFC_FOLDER_FLAG 0x05</span>
<a name="l00047"></a>00047 <span class="preprocessor"></span><span class="preprocessor">#define CSFC_FILE_DESCRIPTOR 0x06</span>
<a name="l00048"></a>00048 <span class="preprocessor"></span><span class="preprocessor">#define CSFC_FILE_CONTENT 0x07</span>
<a name="l00049"></a>00049 <span class="preprocessor"></span>
<a name="l00050"></a>00050
<a name="l00051"></a>00051 <span class="preprocessor">#define MAX_CONTENT_BLOCK_SIZE 0xfffe</span>
<a name="l00052"></a>00052 <span class="preprocessor"></span>
<a name="l00053"></a>00053 ContentStore::ContentStore()
<a name="l00054"></a>00054 {
<a name="l00055"></a>00055 Clear();
<a name="l00056"></a>00056 }
<a name="l00057"></a>00057
<a name="l00058"></a>00058 ContentStore::~ContentStore()
<a name="l00059"></a>00059 {
<a name="l00060"></a>00060 }
<a name="l00061"></a>00061
<a name="l00062"></a>00062 <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>* ContentStore::ParseField(<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *begin,
<a name="l00063"></a>00063 <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *end,
<a name="l00064"></a>00064 <span class="keyword">const</span> IConverter *ic)
<a name="l00065"></a>00065 {
<a name="l00066"></a>00066 <span class="keyword">const</span> CommonField *field = (<span class="keyword">const</span> CommonField *) begin;
<a name="l00067"></a>00067
<a name="l00068"></a>00068 <span class="comment">// advance and check size</span>
<a name="l00069"></a>00069 begin += COMMON_FIELD_HEADER_SIZE + btohs(field->size);
<a name="l00070"></a>00070 <span class="keywordflow">if</span>( begin > end ) <span class="comment">// if begin==end, we are ok</span>
<a name="l00071"></a>00071 <span class="keywordflow">return</span> begin;
<a name="l00072"></a>00072
<a name="l00073"></a>00073 <span class="keywordflow">if</span>( !btohs(field->size) ) <span class="comment">// if field has no size, something's up</span>
<a name="l00074"></a>00074 <span class="keywordflow">return</span> begin;
<a name="l00075"></a>00075
<a name="l00076"></a>00076 <span class="keywordflow">switch</span>( field->type )
<a name="l00077"></a>00077 {
<a name="l00078"></a>00078 <span class="keywordflow">case</span> CSFC_FILENAME:
<a name="l00079"></a>00079 Filename = ParseFieldString(field);
<a name="l00080"></a>00080 <span class="keywordflow">return</span> begin;
<a name="l00081"></a>00081
<a name="l00082"></a>00082 <span class="keywordflow">case</span> CSFC_FOLDER_FLAG:
<a name="l00083"></a>00083 FolderFlag = <span class="keyword">false</span>;
<a name="l00084"></a>00084 {
<a name="l00085"></a>00085 <span class="comment">// the CSFC_FOLDER_FLAG field seems to always</span>
<a name="l00086"></a>00086 <span class="comment">// contain the string "folder".. so check for it</span>
<a name="l00087"></a>00087 <span class="keywordtype">string</span> s = ParseFieldString(field);
<a name="l00088"></a>00088 <span class="keywordflow">if</span>( s == <span class="stringliteral">"folder"</span> ) {
<a name="l00089"></a>00089 FolderFlag = <span class="keyword">true</span>;
<a name="l00090"></a>00090 }
<a name="l00091"></a>00091 }
<a name="l00092"></a>00092 <span class="keywordflow">return</span> begin;
<a name="l00093"></a>00093
<a name="l00094"></a>00094 <span class="keywordflow">case</span> CSFC_FILE_CONTENT:
<a name="l00095"></a>00095 <span class="keywordflow">if</span>( FileSize ) {
<a name="l00096"></a>00096 <span class="comment">// size already received, append data to FileContent</span>
<a name="l00097"></a>00097 FileContent.append((<span class="keyword">const</span> <span class="keywordtype">char</span>*)field->u.raw,
<a name="l00098"></a>00098 btohs(field->size));
<a name="l00099"></a>00099 }
<a name="l00100"></a>00100 <span class="keywordflow">else</span> {
<a name="l00101"></a>00101 FileSize = btohll(field->u.uint64);
<a name="l00102"></a>00102 }
<a name="l00103"></a>00103 <span class="keywordflow">return</span> begin;
<a name="l00104"></a>00104
<a name="l00105"></a>00105 <span class="keywordflow">case</span> CSFC_FILE_DESCRIPTOR:
<a name="l00106"></a>00106 <span class="comment">// need to parse this further, but until then, just</span>
<a name="l00107"></a>00107 <span class="comment">// store it as a chunk of data</span>
<a name="l00108"></a>00108 FileDescriptor.assign((<span class="keyword">const</span> <span class="keywordtype">char</span>*)field->u.raw,
<a name="l00109"></a>00109 btohs(field->size));
<a name="l00110"></a>00110 <span class="keywordflow">return</span> begin;
<a name="l00111"></a>00111 }
<a name="l00112"></a>00112
<a name="l00113"></a>00113 <span class="comment">// if still not handled, add to the Unknowns list</span>
<a name="l00114"></a>00114 UnknownField uf;
<a name="l00115"></a>00115 uf.type = field->type;
<a name="l00116"></a>00116 uf.data.assign((<span class="keyword">const</span> <span class="keywordtype">char</span>*)field->u.raw, btohs(field->size));
<a name="l00117"></a>00117 Unknowns.push_back(uf);
<a name="l00118"></a>00118
<a name="l00119"></a>00119 <span class="comment">// return new pointer for next field</span>
<a name="l00120"></a>00120 <span class="keywordflow">return</span> begin;
<a name="l00121"></a>00121 }
<a name="l00122"></a>00122
<a name="l00123"></a>00123 <span class="keywordtype">void</span> ContentStore::ParseHeader(<span class="keyword">const</span> Data &data, <span class="keywordtype">size_t</span> &offset)
<a name="l00124"></a>00124 {
<a name="l00125"></a>00125 <span class="comment">// no header to parse</span>
<a name="l00126"></a>00126 }
<a name="l00127"></a>00127
<a name="l00128"></a>00128 <span class="keywordtype">void</span> ContentStore::ParseFields(<span class="keyword">const</span> Data &data, <span class="keywordtype">size_t</span> &offset, <span class="keyword">const</span> IConverter *ic)
<a name="l00129"></a>00129 {
<a name="l00130"></a>00130 <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *finish = ParseCommonFields(*<span class="keyword">this</span>,
<a name="l00131"></a>00131 data.GetData() + offset, data.GetData() + data.GetSize(), ic);
<a name="l00132"></a>00132 offset += finish - (data.GetData() + offset);
<a name="l00133"></a>00133 }
<a name="l00134"></a>00134
<a name="l00135"></a>00135 <span class="keywordtype">void</span> ContentStore::BuildHeader(Data &data, <span class="keywordtype">size_t</span> &offset)<span class="keyword"> const</span>
<a name="l00136"></a>00136 <span class="keyword"></span>{
<a name="l00137"></a>00137 }
<a name="l00138"></a>00138
<a name="l00139"></a>00139 <span class="keywordtype">void</span> ContentStore::BuildFields(Data &data, <span class="keywordtype">size_t</span> &offset, <span class="keyword">const</span> IConverter *ic)<span class="keyword"> const</span>
<a name="l00140"></a>00140 <span class="keyword"></span>{
<a name="l00141"></a>00141 data.Zap();
<a name="l00142"></a>00142
<a name="l00143"></a>00143 <span class="keywordflow">if</span>( !Filename.size() )
<a name="l00144"></a>00144 <span class="keywordflow">throw</span> BadData(<span class="stringliteral">"Content Store must have a name."</span>);
<a name="l00145"></a>00145
<a name="l00146"></a>00146 <span class="keywordflow">if</span>( !FolderFlag && !FileContent.size() )
<a name="l00147"></a>00147 <span class="keywordflow">throw</span> BadData(<span class="stringliteral">"Content Store item without any data."</span>);
<a name="l00148"></a>00148
<a name="l00149"></a>00149 <span class="comment">// Filename</span>
<a name="l00150"></a>00150 BuildField(data, offset, CSFC_FILENAME, Filename);
<a name="l00151"></a>00151
<a name="l00152"></a>00152 <span class="comment">// Folder?</span>
<a name="l00153"></a>00153 <span class="keywordflow">if</span>( FolderFlag ) {
<a name="l00154"></a>00154 BuildField(data, offset, CSFC_FOLDER_FLAG, <span class="keywordtype">string</span>(<span class="stringliteral">"folder"</span>));
<a name="l00155"></a>00155 }
<a name="l00156"></a>00156 <span class="keywordflow">else</span> {
<a name="l00157"></a>00157 <span class="comment">// write file descriptor first</span>
<a name="l00158"></a>00158 BuildField(data, offset, CSFC_FILE_DESCRIPTOR,
<a name="l00159"></a>00159 FileDescriptor.data(), FileDescriptor.size());
<a name="l00160"></a>00160
<a name="l00161"></a>00161 <span class="comment">// a normal file... the file content is given:</span>
<a name="l00162"></a>00162 <span class="comment">// 64 bit size</span>
<a name="l00163"></a>00163 <span class="comment">// content in blocks of 0xfffe bytes until done</span>
<a name="l00164"></a>00164 <span class="comment">// all with the same ID</span>
<a name="l00165"></a>00165
<a name="l00166"></a>00166 <span class="comment">// force the size to actual, and write it first</span>
<a name="l00167"></a>00167 uint64_t RealSize = FileContent.size();
<a name="l00168"></a>00168 BuildField(data, offset, CSFC_FILE_CONTENT, RealSize);
<a name="l00169"></a>00169
<a name="l00170"></a>00170 <span class="comment">// write data in blocks of 0xfffe bytes</span>
<a name="l00171"></a>00171 <span class="keywordflow">for</span>( <span class="keywordtype">size_t</span> foff = 0; foff < FileContent.size(); ) {
<a name="l00172"></a>00172 <span class="keywordtype">size_t</span> blocksize = FileContent.size() - foff;
<a name="l00173"></a>00173 <span class="keywordflow">if</span>( blocksize > MAX_CONTENT_BLOCK_SIZE )
<a name="l00174"></a>00174 blocksize = MAX_CONTENT_BLOCK_SIZE;
<a name="l00175"></a>00175 BuildField(data, offset, CSFC_FILE_CONTENT,
<a name="l00176"></a>00176 FileContent.data() + foff, blocksize);
<a name="l00177"></a>00177
<a name="l00178"></a>00178 <span class="comment">// advance</span>
<a name="l00179"></a>00179 foff += blocksize;
<a name="l00180"></a>00180 }
<a name="l00181"></a>00181 }
<a name="l00182"></a>00182
<a name="l00183"></a>00183 <span class="comment">// and finally save unknowns</span>
<a name="l00184"></a>00184 UnknownsType::const_iterator
<a name="l00185"></a>00185 ub = Unknowns.begin(), ue = Unknowns.end();
<a name="l00186"></a>00186 <span class="keywordflow">for</span>( ; ub != ue; ub++ ) {
<a name="l00187"></a>00187 BuildField(data, offset, *ub);
<a name="l00188"></a>00188 }
<a name="l00189"></a>00189
<a name="l00190"></a>00190 data.ReleaseBuffer(offset);
<a name="l00191"></a>00191 }
<a name="l00192"></a>00192
<a name="l00193"></a>00193 <span class="keywordtype">void</span> ContentStore::Clear()
<a name="l00194"></a>00194 {
<a name="l00195"></a>00195 RecType = GetDefaultRecType();
<a name="l00196"></a>00196 RecordId = 0;
<a name="l00197"></a>00197
<a name="l00198"></a>00198 Filename.clear();
<a name="l00199"></a>00199 FolderFlag = <span class="keyword">false</span>;
<a name="l00200"></a>00200 FileContent.clear();
<a name="l00201"></a>00201 FileDescriptor.clear();
<a name="l00202"></a>00202
<a name="l00203"></a>00203 Unknowns.clear();
<a name="l00204"></a>00204
<a name="l00205"></a>00205 <span class="comment">// internal variables</span>
<a name="l00206"></a>00206 FileSize = 0;
<a name="l00207"></a>00207 }
<a name="l00208"></a>00208
<a name="l00209"></a>00209 std::string ContentStore::GetDescription()<span class="keyword"> const</span>
<a name="l00210"></a>00210 <span class="keyword"></span>{
<a name="l00211"></a>00211 <span class="keywordflow">return</span> Filename;
<a name="l00212"></a>00212 }
<a name="l00213"></a>00213
<a name="l00214"></a>00214 <span class="keywordtype">void</span> ContentStore::Dump(std::ostream &os)<span class="keyword"> const</span>
<a name="l00215"></a>00215 <span class="keyword"></span>{
<a name="l00216"></a>00216 ios::fmtflags oldflags = os.setf(ios::left);
<a name="l00217"></a>00217 <span class="keywordtype">char</span> fill = os.fill(<span class="charliteral">' '</span>);
<a name="l00218"></a>00218
<a name="l00219"></a>00219 os << <span class="stringliteral">"ContentStore: 0x"</span> << hex << RecordId
<a name="l00220"></a>00220 << <span class="stringliteral">" ("</span> << (<span class="keywordtype">unsigned</span> int)RecType << <span class="stringliteral">")\n"</span>;
<a name="l00221"></a>00221
<a name="l00222"></a>00222 os << <span class="stringliteral">" Filename: "</span> << Filename << endl;
<a name="l00223"></a>00223 os << <span class="stringliteral">" Folder: "</span> << (FolderFlag ? <span class="stringliteral">"yes"</span> : <span class="stringliteral">"no"</span>) << endl;
<a name="l00224"></a>00224 os << <span class="stringliteral">" BB Size: "</span> << dec << FileSize << endl;
<a name="l00225"></a>00225 os << <span class="stringliteral">" Actual Size: "</span> << FileContent.size() << endl;
<a name="l00226"></a>00226 os << <span class="stringliteral">" Descriptor:\n"</span>
<a name="l00227"></a>00227 << Data(FileDescriptor.data(), FileDescriptor.size()) << endl;
<a name="l00228"></a>00228 os << <span class="stringliteral">" Content:\n"</span>
<a name="l00229"></a>00229 << Data(FileContent.data(), FileContent.size()) << endl;
<a name="l00230"></a>00230
<a name="l00231"></a>00231 <span class="comment">// and finally print unknowns</span>
<a name="l00232"></a>00232 os << Unknowns;
<a name="l00233"></a>00233
<a name="l00234"></a>00234 <span class="comment">// cleanup the stream</span>
<a name="l00235"></a>00235 os.flags(oldflags);
<a name="l00236"></a>00236 os.fill(fill);
<a name="l00237"></a>00237 }
<a name="l00238"></a>00238
<a name="l00239"></a>00239 <span class="keywordtype">bool</span> ContentStore::operator<(<span class="keyword">const</span> ContentStore &other)<span class="keyword"> const</span>
<a name="l00240"></a>00240 <span class="keyword"></span>{
<a name="l00241"></a>00241 <span class="keywordflow">return</span> RecordId < other.RecordId;
<a name="l00242"></a>00242 }
<a name="l00243"></a>00243
<a name="l00244"></a>00244 } <span class="comment">// namespace Barry</span>
<a name="l00245"></a>00245
</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>
