doc/www/doxygen/html/cod_8cc-source.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
   3 <title>Barry: cod.cc Source File</title>
   4 <link href="doxygen.css" rel="stylesheet" type="text/css">
   5 <link href="tabs.css" rel="stylesheet" type="text/css">
   6 </head><body>
   7 <!-- Generated by Doxygen 1.5.6 -->
   8 <div class="navigation" id="top">
   9   <div class="tabs">
  10     <ul>
  11       <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
  12       <li><a href="modules.html"><span>Modules</span></a></li>
  13       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  14       <li><a href="classes.html"><span>Classes</span></a></li>
  15       <li class="current"><a href="files.html"><span>Files</span></a></li>
  16       <li><a href="dirs.html"><span>Directories</span></a></li>
  17     </ul>
  18   </div>
  19   <div class="navpath"><a class="el" href="dir_edc0f428e3eefcfdce9c25befd901c57.html">src</a>
  20   </div>
  21 </div>
  22 <div class="contents">
  23 <h1>cod.cc</h1><a href="cod_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>
  24 <a name="l00002"></a>00002 <span class="comment"></span><span class="comment">/// \file       cod.cc</span>
  25 <a name="l00003"></a>00003 <span class="comment"></span><span class="comment">///             COD file API</span>
  26 <a name="l00004"></a>00004 <span class="comment"></span><span class="comment">///</span>
  27 <a name="l00005"></a>00005 <span class="comment"></span>
  28 <a name="l00006"></a>00006 <span class="comment">/*</span>
  29 <a name="l00007"></a>00007 <span class="comment">    Copyright (C) 2009-2011, Net Direct Inc. (http://www.netdirect.ca/)</span>
  30 <a name="l00008"></a>00008 <span class="comment">    Copyright (C) 2008-2009, Nicolas VIVIEN</span>
  31 <a name="l00009"></a>00009 <span class="comment">    Copyright (C) 2009, Josh Kropf</span>
  32 <a name="l00010"></a>00010 <span class="comment"></span>
  33 <a name="l00011"></a>00011 <span class="comment">    This program is free software; you can redistribute it and/or modify</span>
  34 <a name="l00012"></a>00012 <span class="comment">    it under the terms of the GNU General Public License as published by</span>
  35 <a name="l00013"></a>00013 <span class="comment">    the Free Software Foundation; either version 2 of the License, or</span>
  36 <a name="l00014"></a>00014 <span class="comment">    (at your option) any later version.</span>
  37 <a name="l00015"></a>00015 <span class="comment"></span>
  38 <a name="l00016"></a>00016 <span class="comment">    This program is distributed in the hope that it will be useful,</span>
  39 <a name="l00017"></a>00017 <span class="comment">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
  40 <a name="l00018"></a>00018 <span class="comment">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</span>
  41 <a name="l00019"></a>00019 <span class="comment"></span>
  42 <a name="l00020"></a>00020 <span class="comment">    See the GNU General Public License in the COPYING file at the</span>
  43 <a name="l00021"></a>00021 <span class="comment">    root directory of this project for more details.</span>
  44 <a name="l00022"></a>00022 <span class="comment">*/</span>
  45 <a name="l00023"></a>00023
  46 <a name="l00024"></a>00024 <span class="preprocessor">#include "<a class="code" href="cod_8h.html" title="COD file API.">cod.h</a>"</span>
  47 <a name="l00025"></a>00025 <span class="preprocessor">#include "<a class="code" href="cod-internal_8h.html" title="COD structure.">cod-internal.h</a>"</span>
  48 <a name="l00026"></a>00026 <span class="preprocessor">#include "<a class="code" href="error_8h.html" title="Common exception classes for the Barry library.">error.h</a>"</span>
  49 <a name="l00027"></a>00027 <span class="preprocessor">#include "<a class="code" href="endian_8h.html" title="Endian conversion macros.">endian.h</a>"</span>
  50 <a name="l00028"></a>00028 <span class="preprocessor">#include &lt;config.h&gt;</span>
  51 <a name="l00029"></a>00029 <span class="preprocessor">#include &lt;sys/types.h&gt;</span>
  52 <a name="l00030"></a>00030 <span class="preprocessor">#include &lt;sys/stat.h&gt;</span>
  53 <a name="l00031"></a>00031 <span class="preprocessor">#include &lt;unistd.h&gt;</span>
  54 <a name="l00032"></a>00032 <span class="preprocessor">#include &lt;string&gt;</span>
  55 <a name="l00033"></a>00033 <span class="preprocessor">#include &lt;string.h&gt;</span>
  56 <a name="l00034"></a>00034
  57 <a name="l00035"></a>00035 <span class="preprocessor">#ifdef HAVE_ZLIB</span>
  58 <a name="l00036"></a>00036 <span class="preprocessor"></span><span class="preprocessor"> #include &lt;zlib.h&gt;</span>
  59 <a name="l00037"></a>00037 <span class="preprocessor">#endif</span>
  60 <a name="l00038"></a>00038 <span class="preprocessor"></span>
  61 <a name="l00039"></a>00039 <span class="keyword">using namespace </span>std;
  62 <a name="l00040"></a>00040
  63 <a name="l00041"></a>00041 <span class="keyword">namespace </span>Barry {
  64 <a name="l00042"></a>00042
  65 <a name="l00043"></a>00043
  66 <a name="l00044"></a><a class="code" href="namespaceBarry.html#07808b7a4cabe1399d5432eb1ee1eabf">00044</a> <span class="keywordtype">size_t</span> <a class="code" href="namespaceBarry.html#07808b7a4cabe1399d5432eb1ee1eabf" title="Seeks the input stream to the next packed sibling .cod file and returns the packed...">SeekNextCod</a>(std::istream &amp;input)
  67 <a name="l00045"></a>00045 {
  68 <a name="l00046"></a>00046         <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> codtype_simple[] = CODFILE_TYPE_SIMPLE;
  69 <a name="l00047"></a>00047         <span class="keywordtype">char</span> codtype_pkzip[] = CODFILE_TYPE_PKZIP;
  70 <a name="l00048"></a>00048         <span class="keywordtype">char</span> local_file_sig[] = PKZIP_LOCAL_FILE_SIG;
  71 <a name="l00049"></a>00049         <span class="keywordtype">char</span> directory_sig[] = PKZIP_DIRECTORY_SIG;
  72 <a name="l00050"></a>00050
  73 <a name="l00051"></a>00051         <span class="keywordtype">char</span> signature[4];
  74 <a name="l00052"></a>00052
  75 <a name="l00053"></a>00053         <span class="comment">// finished reading stream containing single cod file</span>
  76 <a name="l00054"></a>00054         input.peek();
  77 <a name="l00055"></a>00055         <span class="keywordflow">if</span>( input.eof() ) {
  78 <a name="l00056"></a>00056                 <span class="keywordflow">return</span> 0;
  79 <a name="l00057"></a>00057         }
  80 <a name="l00058"></a>00058
  81 <a name="l00059"></a>00059         <span class="keywordflow">if</span>( input.read(signature, <span class="keyword">sizeof</span>(signature)).eof() ) {
  82 <a name="l00060"></a>00060                 <span class="keywordflow">throw</span> <a class="code" href="classBarry_1_1Error.html" title="The base class for any future derived exceptions.">Error</a>(<span class="stringliteral">"SeekNextCod: EOF while reading file signature"</span>);
  83 <a name="l00061"></a>00061         }
  84 <a name="l00062"></a>00062
  85 <a name="l00063"></a>00063         <span class="keywordflow">if</span>( memcmp(signature, codtype_pkzip, <span class="keyword">sizeof</span>(codtype_pkzip)) == 0 ) {
  86 <a name="l00064"></a>00064
  87 <a name="l00065"></a>00065                 <span class="keywordflow">if</span>( memcmp(signature, local_file_sig, <span class="keyword">sizeof</span>(signature)) == 0 ) {
  88 <a name="l00066"></a>00066                         pkzip_local_header_t header;
  89 <a name="l00067"></a>00067
  90 <a name="l00068"></a>00068                         <span class="keywordflow">if</span>( input.read((<span class="keywordtype">char</span> *)&amp;header, <span class="keyword">sizeof</span>(pkzip_local_header_t)).eof() ) {
  91 <a name="l00069"></a>00069                                 <span class="keywordflow">throw</span> <a class="code" href="classBarry_1_1Error.html" title="The base class for any future derived exceptions.">Error</a>(<span class="stringliteral">"SeekNextCod: EOF while reading PKZIP header"</span>);
  92 <a name="l00070"></a>00070                         }
  93 <a name="l00071"></a>00071
  94 <a name="l00072"></a>00072                         <span class="comment">// skip cod file name and extra field, we don't need them</span>
  95 <a name="l00073"></a>00073                         <span class="keywordtype">size_t</span> skip_len = header.file_name_length + header.extra_field_length;
  96 <a name="l00074"></a>00074                         <span class="keywordflow">if</span>( input.ignore(skip_len).eof() ) {
  97 <a name="l00075"></a>00075                                 <span class="keywordflow">throw</span> <a class="code" href="classBarry_1_1Error.html" title="The base class for any future derived exceptions.">Error</a>(<span class="stringliteral">"SeekNextCod: EOF while skipping unused fields"</span>);
  98 <a name="l00076"></a>00076                         }
  99 <a name="l00077"></a>00077
 100 <a name="l00078"></a>00078                         <span class="keywordflow">return</span> btohl(header.compressed_size);
 101 <a name="l00079"></a>00079                 }
 102 <a name="l00080"></a>00080                 <span class="keywordflow">else</span> <span class="keywordflow">if</span>( memcmp(signature, directory_sig, <span class="keyword">sizeof</span>(signature)) == 0 ) {
 103 <a name="l00081"></a>00081                         <span class="comment">// done reading when central directory is reached</span>
 104 <a name="l00082"></a>00082                         <span class="keywordflow">return</span> 0;
 105 <a name="l00083"></a>00083                 }
 106 <a name="l00084"></a>00084         }
 107 <a name="l00085"></a>00085         <span class="keywordflow">else</span> <span class="keywordflow">if</span>( memcmp(signature, codtype_simple, <span class="keyword">sizeof</span>(codtype_simple)) == 0 ) {
 108 <a name="l00086"></a>00086                 <span class="comment">// find and return size of cod file</span>
 109 <a name="l00087"></a>00087                 <span class="keywordflow">if</span>( input.seekg(0, ios::end).fail() ) {
 110 <a name="l00088"></a>00088                         <span class="keywordflow">throw</span> <a class="code" href="classBarry_1_1Error.html" title="The base class for any future derived exceptions.">Error</a>(<span class="stringliteral">"SeekNextCod: seek to end failed"</span>);
 111 <a name="l00089"></a>00089                 }
 112 <a name="l00090"></a>00090
 113 <a name="l00091"></a>00091                 uint32_t size = input.tellg();
 114 <a name="l00092"></a>00092
 115 <a name="l00093"></a>00093                 <span class="keywordflow">if</span>( input.seekg(0, ios::beg).fail() ) {
 116 <a name="l00094"></a>00094                         <span class="keywordflow">throw</span> <a class="code" href="classBarry_1_1Error.html" title="The base class for any future derived exceptions.">Error</a>(<span class="stringliteral">"SeekNextCod: seek to start failed"</span>);
 117 <a name="l00095"></a>00095                 }
 118 <a name="l00096"></a>00096
 119 <a name="l00097"></a>00097                 <span class="keywordflow">return</span> size;
 120 <a name="l00098"></a>00098         }
 121 <a name="l00099"></a>00099         <span class="keywordflow">else</span> {
 122 <a name="l00100"></a>00100                 <span class="keywordflow">throw</span> <a class="code" href="classBarry_1_1Error.html" title="The base class for any future derived exceptions.">Error</a>(<span class="stringliteral">"SeekNextCod: unknown COD file signature"</span>);
 123 <a name="l00101"></a>00101         }
 124 <a name="l00102"></a>00102
 125 <a name="l00103"></a>00103         <span class="keywordflow">return</span> 0;
 126 <a name="l00104"></a>00104 }
 127 <a name="l00105"></a>00105
 128 <a name="l00106"></a>00106
 129 <a name="l00107"></a>00107 CodFileBuilder::CodFileBuilder(<span class="keyword">const</span> std::string &amp;module_name, <span class="keywordtype">size_t</span> module_count)
 130 <a name="l00108"></a>00108         : m_module_name(module_name)
 131 <a name="l00109"></a>00109         , m_module_count(module_count)
 132 <a name="l00110"></a>00110         , m_current_module(0)
 133 <a name="l00111"></a>00111 {
 134 <a name="l00112"></a>00112 }
 135 <a name="l00113"></a>00113
 136 <a name="l00114"></a>00114 CodFileBuilder::~CodFileBuilder()
 137 <a name="l00115"></a>00115 {
 138 <a name="l00116"></a>00116 }
 139 <a name="l00117"></a>00117
 140 <a name="l00118"></a><a class="code" href="classBarry_1_1CodFileBuilder.html#22fd9fb2aaed92b0b6ae427a9b90e9ad">00118</a> <span class="keywordtype">void</span> <a class="code" href="classBarry_1_1CodFileBuilder.html#22fd9fb2aaed92b0b6ae427a9b90e9ad" title="Writes packed .cod file header to the output stream, and appends an entry to the...">CodFileBuilder::WriteNextHeader</a>(std::ostream &amp;output, <span class="keyword">const</span> uint8_t* module_buffer, uint32_t module_size)
 141 <a name="l00119"></a>00119 {
 142 <a name="l00120"></a>00120         <span class="comment">// ignored for single module .cod files (simple .cod file)</span>
 143 <a name="l00121"></a>00121         <span class="keywordflow">if</span>( m_module_count == 1 ) {
 144 <a name="l00122"></a>00122                 <span class="keywordflow">return</span>;
 145 <a name="l00123"></a>00123         }
 146 <a name="l00124"></a>00124
 147 <a name="l00125"></a>00125         <span class="comment">// 32bit CRC of module in file header and directory entry</span>
 148 <a name="l00126"></a>00126         <span class="comment">// using zero for CRC will result in warnings when inflating .cod file</span>
 149 <a name="l00127"></a>00127         uint32_t crc = 0;
 150 <a name="l00128"></a>00128
 151 <a name="l00129"></a>00129 <span class="preprocessor">#ifdef HAVE_ZLIB</span>
 152 <a name="l00130"></a>00130 <span class="preprocessor"></span>        crc = crc32(0, NULL, module_size);
 153 <a name="l00131"></a>00131         crc = crc32(crc, module_buffer, module_size);
 154 <a name="l00132"></a>00132 <span class="preprocessor">#endif</span>
 155 <a name="l00133"></a>00133 <span class="preprocessor"></span>
 156 <a name="l00134"></a>00134         <span class="comment">// .cod file name for siblings have hyphenated index number, name-1.cod</span>
 157 <a name="l00135"></a>00135         std::ostringstream file_name(m_module_name, ios::app);
 158 <a name="l00136"></a>00136         <span class="keywordflow">if</span>( m_current_module == 0 )
 159 <a name="l00137"></a>00137                 file_name &lt;&lt; <span class="stringliteral">".cod"</span>;
 160 <a name="l00138"></a>00138         <span class="keywordflow">else</span>
 161 <a name="l00139"></a>00139                 file_name &lt;&lt; <span class="stringliteral">"-"</span> &lt;&lt; m_current_module &lt;&lt; <span class="stringliteral">".cod"</span>;
 162 <a name="l00140"></a>00140
 163 <a name="l00141"></a>00141         <span class="comment">// current stream pointer is relative offset to start of file entry</span>
 164 <a name="l00142"></a>00142         uint32_t entry_offset = output.tellp();
 165 <a name="l00143"></a>00143
 166 <a name="l00144"></a>00144         <span class="comment">// structures for the local file entry and central directory entry</span>
 167 <a name="l00145"></a>00145         pkzip_local_header_t header;
 168 <a name="l00146"></a>00146         pkzip_directory_t entry;
 169 <a name="l00147"></a>00147
 170 <a name="l00148"></a>00148         <span class="comment">// zero both structs, most fields are zero</span>
 171 <a name="l00149"></a>00149         memset(&amp;header, 0, <span class="keyword">sizeof</span>(pkzip_local_header_t));
 172 <a name="l00150"></a>00150         memset(&amp;entry, 0, <span class="keyword">sizeof</span>(pkzip_directory_t));
 173 <a name="l00151"></a>00151
 174 <a name="l00152"></a>00152         <span class="keywordtype">char</span> header_sig[] = PKZIP_LOCAL_FILE_SIG;
 175 <a name="l00153"></a>00153         output.write(header_sig, <span class="keyword">sizeof</span>(header_sig));
 176 <a name="l00154"></a>00154
 177 <a name="l00155"></a>00155         <span class="comment">// version is always 0x00A0 = 'Windows NTFS'</span>
 178 <a name="l00156"></a>00156         header.version_needed = htobs(10);
 179 <a name="l00157"></a>00157
 180 <a name="l00158"></a>00158         <span class="comment">// time and date fields seem to randomly have invalid or fixed values</span>
 181 <a name="l00159"></a>00159         <span class="comment">// just leave them as zero</span>
 182 <a name="l00160"></a>00160         <span class="comment">//header.last_mod_time</span>
 183 <a name="l00161"></a>00161         <span class="comment">//header.last_mod_date</span>
 184 <a name="l00162"></a>00162
 185 <a name="l00163"></a>00163         header.crc_32 = htobl(crc);
 186 <a name="l00164"></a>00164         header.compressed_size = htobl(module_size);
 187 <a name="l00165"></a>00165         header.uncompressed_size = htobl(module_size);
 188 <a name="l00166"></a>00166         header.file_name_length = htobs(file_name.str().length());
 189 <a name="l00167"></a>00167
 190 <a name="l00168"></a>00168         <span class="comment">// the very first cod sibling to be written has an extra field</span>
 191 <a name="l00169"></a>00169         <span class="comment">// length equal to 4, with all zeros in the field itself</span>
 192 <a name="l00170"></a>00170         <span class="comment">// all subsequent siblings have a zero length extra field</span>
 193 <a name="l00171"></a>00171         <span class="comment">//header.extra_field_length = htobs(4);</span>
 194 <a name="l00172"></a>00172
 195 <a name="l00173"></a>00173         output.write((<span class="keywordtype">char</span> *)&amp;header, <span class="keyword">sizeof</span>(pkzip_local_header_t));
 196 <a name="l00174"></a>00174         output &lt;&lt; file_name.str();
 197 <a name="l00175"></a>00175
 198 <a name="l00176"></a>00176         <span class="keywordtype">char</span> footer_sig[] = PKZIP_DIRECTORY_SIG;
 199 <a name="l00177"></a>00177
 200 <a name="l00178"></a>00178         <span class="comment">// version is always 0x00A0 = 'Windows NTFS'</span>
 201 <a name="l00179"></a>00179         entry.version_madeby = htobs(10);
 202 <a name="l00180"></a>00180         entry.version_needed = htobs(10);
 203 <a name="l00181"></a>00181
 204 <a name="l00182"></a>00182         entry.crc_32 = htobl(crc);
 205 <a name="l00183"></a>00183         entry.compressed_size = htobl(module_size);
 206 <a name="l00184"></a>00184         entry.uncompressed_size = htobl(module_size);
 207 <a name="l00185"></a>00185         entry.file_name_length = htobs(file_name.str().length());
 208 <a name="l00186"></a>00186         entry.relative_offset = htobl(entry_offset);
 209 <a name="l00187"></a>00187
 210 <a name="l00188"></a>00188         m_directory.write(footer_sig, <span class="keyword">sizeof</span>(footer_sig));
 211 <a name="l00189"></a>00189         m_directory.write((<span class="keywordtype">char</span>*)&amp;entry, <span class="keyword">sizeof</span>(pkzip_directory_t));
 212 <a name="l00190"></a>00190         m_directory &lt;&lt; file_name.str();
 213 <a name="l00191"></a>00191
 214 <a name="l00192"></a>00192         m_current_module ++;
 215 <a name="l00193"></a>00193 }
 216 <a name="l00194"></a>00194
 217 <a name="l00195"></a><a class="code" href="classBarry_1_1CodFileBuilder.html#5897a4fe8ef826ddf58e045d5b3513ec">00195</a> <span class="keywordtype">void</span> <a class="code" href="classBarry_1_1CodFileBuilder.html#5897a4fe8ef826ddf58e045d5b3513ec" title="Write the central directory and central directory ending indicator to the output...">CodFileBuilder::WriteFooter</a>(std::ostream &amp;output)
 218 <a name="l00196"></a>00196 {
 219 <a name="l00197"></a>00197         <span class="comment">// ignored for single module .cod files (simple .cod file)</span>
 220 <a name="l00198"></a>00198         <span class="keywordflow">if</span>( m_module_count == 1 ) {
 221 <a name="l00199"></a>00199                 <span class="keywordflow">return</span>;
 222 <a name="l00200"></a>00200         }
 223 <a name="l00201"></a>00201
 224 <a name="l00202"></a>00202         pkzip_end_directory_t end;
 225 <a name="l00203"></a>00203         memset(&amp;end, 0, <span class="keyword">sizeof</span>(pkzip_end_directory_t));
 226 <a name="l00204"></a>00204
 227 <a name="l00205"></a>00205         end.this_disk_entry_count = htobs(m_current_module);
 228 <a name="l00206"></a>00206         end.total_entry_count = htobs(m_current_module);
 229 <a name="l00207"></a>00207         end.directory_length = htobl(m_directory.str().length());
 230 <a name="l00208"></a>00208
 231 <a name="l00209"></a>00209         <span class="comment">// current stream pointer is relative offset to start of directory</span>
 232 <a name="l00210"></a>00210         end.directory_offset = output.tellp();
 233 <a name="l00211"></a>00211
 234 <a name="l00212"></a>00212         <span class="keywordtype">char</span> sig[] = PKZIP_END_DIRECTORY_SIG;
 235 <a name="l00213"></a>00213
 236 <a name="l00214"></a>00214         output.write(m_directory.str().data(), m_directory.str().length());
 237 <a name="l00215"></a>00215         output.write(sig, <span class="keyword">sizeof</span>(sig));
 238 <a name="l00216"></a>00216         output.write((<span class="keywordtype">char</span> *)&amp;end, <span class="keyword">sizeof</span>(pkzip_end_directory_t));
 239 <a name="l00217"></a>00217 }
 240 <a name="l00218"></a>00218
 241 <a name="l00219"></a>00219
 242 <a name="l00220"></a>00220 } <span class="comment">// namespace Barry</span>
 243 <a name="l00221"></a>00221
 244 </pre></div></div>
 245 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Feb 10 16:13:58 2011 for Barry by&nbsp;
 246 <a href="http://www.doxygen.org/index.html">
 247 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
 248 </body>
 249 </html>