<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>Barry: r_folder.cc Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.6.2-20100208 --> <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="annotated.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="tabs"> <ul> <li><a href="files.html"><span>File List</span></a></li> </ul> </div> <div class="navpath"><a class="el" href="dir_65781e9408669bb8d7d9c025fdb5fe86.html">src</a> </div> </div> <div class="contents"> <h1>r_folder.cc</h1><a href="r__folder_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_folder.cc</span> <a name="l00003"></a>00003 <span class="comment"></span><span class="comment">/// Record parsing class for the folders database.</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) 2005-2010, Net Direct Inc. (http://www.netdirect.ca/)</span> <a name="l00008"></a>00008 <span class="comment"> Copyright (C) 2007, Brian Edginton</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__folder_8h.html" title="Record parsing class for the Folder database.">r_folder.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="protostructs_8h.html" title="USB Blackberry bulk protocol API.">protostructs.h</a>"</span> <a name="l00026"></a>00026 <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="l00027"></a>00027 <span class="preprocessor">#include "<a class="code" href="time_8h.html" title="Time related conversion routines.">time.h</a>"</span> <a name="l00028"></a>00028 <span class="preprocessor">#include "debug.h"</span> <a name="l00029"></a>00029 <span class="preprocessor">#include "<a class="code" href="iconv_8h.html" title="iconv wrapper class, and pluggable interface for records">iconv.h</a>"</span> <a name="l00030"></a>00030 <span class="preprocessor">#include <ostream></span> <a name="l00031"></a>00031 <span class="preprocessor">#include <iomanip></span> <a name="l00032"></a>00032 <a name="l00033"></a>00033 <span class="keyword">using namespace </span>std; <a name="l00034"></a>00034 <span class="keyword">using namespace </span>Barry::Protocol; <a name="l00035"></a>00035 <a name="l00036"></a>00036 <span class="keyword">namespace </span>Barry { <a name="l00037"></a>00037 <a name="l00038"></a>00038 <span class="comment"></span> <a name="l00039"></a>00039 <span class="comment">///////////////////////////////////////////////////////////////////////////////</span> <a name="l00040"></a>00040 <span class="comment"></span><span class="comment">// Folder Class, static members</span> <a name="l00041"></a>00041 <a name="l00042"></a>00042 <span class="comment">//</span> <a name="l00043"></a>00043 <span class="comment">// Note! These functions currently only pass the same values through.</span> <a name="l00044"></a>00044 <span class="comment">// In actuality, these are technically two different values:</span> <a name="l00045"></a>00045 <span class="comment">// one on the raw protocol side, and the other part of the</span> <a name="l00046"></a>00046 <span class="comment">// guaranteed Barry API. If the Blackberry ever changes the</span> <a name="l00047"></a>00047 <span class="comment">// meanings for these codes, do the translation here.</span> <a name="l00048"></a>00048 <span class="comment">//</span> <a name="l00049"></a>00049 <a name="l00050"></a>00050 Folder::FolderType Folder::TypeProto2Rec(uint8_t t) <a name="l00051"></a>00051 { <a name="l00052"></a>00052 <span class="keywordflow">return</span> (FolderType)t; <a name="l00053"></a>00053 } <a name="l00054"></a>00054 <a name="l00055"></a>00055 uint8_t Folder::TypeRec2Proto(FolderType t) <a name="l00056"></a>00056 { <a name="l00057"></a>00057 <span class="keywordflow">return</span> t; <a name="l00058"></a>00058 } <a name="l00059"></a>00059 <a name="l00060"></a>00060 <a name="l00061"></a>00061 <span class="comment"></span> <a name="l00062"></a>00062 <span class="comment">///////////////////////////////////////////////////////////////////////////////</span> <a name="l00063"></a>00063 <span class="comment"></span><span class="comment">// Folder Class</span> <a name="l00064"></a>00064 <a name="l00065"></a>00065 <span class="comment">// Folder Field Codes</span> <a name="l00066"></a>00066 <a name="l00067"></a>00067 <span class="preprocessor">#define FFC_NUMBER 0x0a</span> <a name="l00068"></a>00068 <span class="preprocessor"></span><span class="preprocessor">#define FFC_LEVEL 0x0b</span> <a name="l00069"></a>00069 <span class="preprocessor"></span><span class="preprocessor">#define FFC_NAME 0x0c</span> <a name="l00070"></a>00070 <span class="preprocessor"></span><span class="preprocessor">#define FFC_ADDRESS1 0x0d</span> <a name="l00071"></a>00071 <span class="preprocessor"></span><span class="preprocessor">#define FFC_ADDRESS2 0x0e</span> <a name="l00072"></a>00072 <span class="preprocessor"></span><span class="preprocessor">#define FFC_TYPE 0x0f</span> <a name="l00073"></a>00073 <span class="preprocessor"></span><span class="preprocessor">#define FFC_END 0xffff</span> <a name="l00074"></a>00074 <span class="preprocessor"></span> <a name="l00075"></a>00075 <span class="preprocessor">#define INVALID -1</span> <a name="l00076"></a>00076 <span class="preprocessor"></span> <a name="l00077"></a>00077 <span class="preprocessor">#define SEPARATOR 0x2f</span> <a name="l00078"></a>00078 <span class="preprocessor"></span><span class="preprocessor">#define ROOT_SEPARATOR 0x3a</span> <a name="l00079"></a>00079 <span class="preprocessor"></span> <a name="l00080"></a>00080 <span class="keyword">static</span> FieldLink<Folder> FolderFieldLinks[] = { <a name="l00081"></a>00081 { FFC_NAME, <span class="stringliteral">"FolderName"</span>, 0, 0, &Folder::Name, 0, 0, 0, 0, <span class="keyword">true</span> }, <a name="l00082"></a>00082 { FFC_END, <span class="stringliteral">"End of List"</span>, 0, 0, 0, 0, 0, 0, 0, <span class="keyword">false</span> }, <a name="l00083"></a>00083 }; <a name="l00084"></a>00084 <a name="l00085"></a>00085 Folder::Folder() <a name="l00086"></a>00086 { <a name="l00087"></a>00087 Clear(); <a name="l00088"></a>00088 } <a name="l00089"></a>00089 <a name="l00090"></a>00090 <a name="l00091"></a>00091 Folder::~Folder() <a name="l00092"></a>00092 { <a name="l00093"></a>00093 } <a name="l00094"></a>00094 <a name="l00095"></a>00095 <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>* Folder::ParseField(<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *begin, <a name="l00096"></a>00096 <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *end, <a name="l00097"></a>00097 <span class="keyword">const</span> IConverter *ic) <a name="l00098"></a>00098 { <a name="l00099"></a>00099 <span class="keyword">const</span> <a class="code" href="structBarry_1_1Protocol_1_1CommonField.html">CommonField</a> *field = (<span class="keyword">const</span> <a class="code" href="structBarry_1_1Protocol_1_1CommonField.html">CommonField</a> *) begin; <a name="l00100"></a>00100 <a name="l00101"></a>00101 <span class="comment">// advance and check size</span> <a name="l00102"></a>00102 begin += COMMON_FIELD_HEADER_SIZE + btohs(field->size); <a name="l00103"></a>00103 <span class="keywordflow">if</span>( begin > end ) <span class="comment">// if begin==end, we are ok</span> <a name="l00104"></a>00104 <span class="keywordflow">return</span> begin; <a name="l00105"></a>00105 <a name="l00106"></a>00106 <span class="keywordflow">if</span>( !btohs(field->size) ) <span class="comment">// if field has no size, something's up</span> <a name="l00107"></a>00107 <span class="keywordflow">return</span> begin; <a name="l00108"></a>00108 <a name="l00109"></a>00109 <span class="comment">// cycle through the type table</span> <a name="l00110"></a>00110 <span class="keywordflow">for</span>( FieldLink<Folder> *b = FolderFieldLinks; <a name="l00111"></a>00111 b->type != FFC_END; <a name="l00112"></a>00112 b++ ) <a name="l00113"></a>00113 { <a name="l00114"></a>00114 <span class="keywordflow">if</span>( b->type == field->type ) { <a name="l00115"></a>00115 <span class="keywordflow">if</span>( b->strMember ) { <a name="l00116"></a>00116 std::string &s = this->*(b->strMember); <a name="l00117"></a>00117 s = ParseFieldString(field); <a name="l00118"></a>00118 <span class="keywordflow">if</span>( b->iconvNeeded && ic ) <a name="l00119"></a>00119 s = ic->FromBB(s); <a name="l00120"></a>00120 <span class="keywordflow">return</span> begin; <span class="comment">// done!</span> <a name="l00121"></a>00121 } <a name="l00122"></a>00122 <span class="keywordflow">else</span> <span class="keywordflow">if</span>( b->timeMember && btohs(field->size) == 4 ) { <a name="l00123"></a>00123 time_t &t = this->*(b->timeMember); <a name="l00124"></a>00124 t = min2time(field->u.min1900); <a name="l00125"></a>00125 <span class="keywordflow">return</span> begin; <a name="l00126"></a>00126 } <a name="l00127"></a>00127 } <a name="l00128"></a>00128 } <a name="l00129"></a>00129 <span class="comment">// handle special cases</span> <a name="l00130"></a>00130 <span class="keywordflow">switch</span>( field->type ) <a name="l00131"></a>00131 { <a name="l00132"></a>00132 <span class="keywordflow">case</span> FFC_TYPE: <a name="l00133"></a>00133 Type = TypeProto2Rec(field->u.raw[0]); <a name="l00134"></a>00134 <span class="keywordflow">return</span> begin; <a name="l00135"></a>00135 <span class="keywordflow">case</span> FFC_NUMBER: <a name="l00136"></a>00136 Number = field->u.raw[0]; <span class="comment">// two's complement</span> <a name="l00137"></a>00137 <span class="keywordflow">return</span> begin; <a name="l00138"></a>00138 <span class="keywordflow">case</span> FFC_LEVEL: <a name="l00139"></a>00139 Level = field->u.raw[0]; <a name="l00140"></a>00140 <span class="keywordflow">return</span> begin; <a name="l00141"></a>00141 } <a name="l00142"></a>00142 <a name="l00143"></a>00143 <span class="comment">// if still not handled, add to the Unknowns list</span> <a name="l00144"></a>00144 UnknownField uf; <a name="l00145"></a>00145 uf.type = field->type; <a name="l00146"></a>00146 uf.data.assign((<span class="keyword">const</span> <span class="keywordtype">char</span>*)field->u.raw, btohs(field->size)); <a name="l00147"></a>00147 Unknowns.push_back(uf); <a name="l00148"></a>00148 <a name="l00149"></a>00149 <span class="comment">// return new pointer for next field</span> <a name="l00150"></a>00150 <span class="keywordflow">return</span> begin; <a name="l00151"></a>00151 } <a name="l00152"></a>00152 <a name="l00153"></a>00153 <span class="keywordtype">void</span> Folder::ParseHeader(<span class="keyword">const</span> Data &data, <span class="keywordtype">size_t</span> &offset) <a name="l00154"></a>00154 { <a name="l00155"></a>00155 <span class="comment">// no header in Folder records</span> <a name="l00156"></a>00156 } <a name="l00157"></a>00157 <a name="l00158"></a>00158 <span class="keywordtype">void</span> Folder::ParseFields(<span class="keyword">const</span> Data &data, <span class="keywordtype">size_t</span> &offset, <span class="keyword">const</span> IConverter *ic) <a name="l00159"></a>00159 { <a name="l00160"></a>00160 <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *finish = ParseCommonFields(*<span class="keyword">this</span>, <a name="l00161"></a>00161 data.GetData() + offset, data.GetData() + data.GetSize(), ic); <a name="l00162"></a>00162 offset += finish - (data.GetData() + offset); <a name="l00163"></a>00163 } <a name="l00164"></a>00164 <a name="l00165"></a>00165 <span class="keywordtype">void</span> Folder::Clear() <a name="l00166"></a>00166 { <a name="l00167"></a>00167 Name.clear(); <a name="l00168"></a>00168 Unknowns.clear(); <a name="l00169"></a>00169 Type = FolderSubtree; <a name="l00170"></a>00170 } <a name="l00171"></a>00171 <a name="l00172"></a>00172 <span class="keywordtype">void</span> Folder::Dump(std::ostream &os)<span class="keyword"> const</span> <a name="l00173"></a>00173 <span class="keyword"></span>{ <a name="l00174"></a>00174 <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *FolderTypeString[] = { <span class="stringliteral">"Subtree"</span>, <span class="stringliteral">"Deleted"</span>, <span class="stringliteral">"Inbox"</span>, <span class="stringliteral">"Outbox"</span>, <span class="stringliteral">"Sent"</span>, <span class="stringliteral">"Other"</span>}; <a name="l00175"></a>00175 <span class="comment">// static const char *FolderStatusString[] = { "Orphan", "Unfiled", "Filed" };</span> <a name="l00176"></a>00176 <a name="l00177"></a>00177 os << <span class="stringliteral">"Folder Records\n\n"</span>; <a name="l00178"></a>00178 os << <span class="stringliteral">"Folder Name: "</span> << Name << <span class="stringliteral">"\n"</span>; <a name="l00179"></a>00179 os << <span class="stringliteral">"Folder Type: "</span>; <a name="l00180"></a>00180 <span class="keywordflow">if</span>( Type < FolderDraft ) <a name="l00181"></a>00181 os << FolderTypeString[Type] << <span class="stringliteral">"\n"</span>; <a name="l00182"></a>00182 <span class="keywordflow">else</span> <span class="keywordflow">if</span>( Type == FolderDraft ) <a name="l00183"></a>00183 os << <span class="stringliteral">"Draft\n"</span>; <a name="l00184"></a>00184 <span class="keywordflow">else</span> <a name="l00185"></a>00185 os << <span class="stringliteral">"Unknown ("</span> << std::hex << Type << <span class="stringliteral">")\n"</span>; <a name="l00186"></a>00186 os << <span class="stringliteral">"Folder Number: "</span> << std::dec << Number << <span class="stringliteral">"\n"</span>; <a name="l00187"></a>00187 os << <span class="stringliteral">"Folder Level: "</span> << std::dec << Level << <span class="stringliteral">"\n"</span>; <a name="l00188"></a>00188 os << <span class="stringliteral">"\n"</span>; <a name="l00189"></a>00189 os << Unknowns; <a name="l00190"></a>00190 os << <span class="stringliteral">"\n\n"</span>; <a name="l00191"></a>00191 } <a name="l00192"></a>00192 <a name="l00193"></a>00193 } <span class="comment">// namespace Barry</span> <a name="l00194"></a>00194 </pre></div></div> <hr class="footer"/><address style="text-align: right;"><small>Generated by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2-20100208 </small></address> </body> </html>