cdf.h 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353
  1. /*-
  2. * Copyright (c) 2008 Christos Zoulas
  3. * All rights reserved.
  4. *
  5. * Redistribution and use in source and binary forms, with or without
  6. * modification, are permitted provided that the following conditions
  7. * are met:
  8. * 1. Redistributions of source code must retain the above copyright
  9. * notice, this list of conditions and the following disclaimer.
  10. * 2. Redistributions in binary form must reproduce the above copyright
  11. * notice, this list of conditions and the following disclaimer in the
  12. * documentation and/or other materials provided with the distribution.
  13. *
  14. * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  15. * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  16. * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17. * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  18. * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  19. * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  20. * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  21. * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  22. * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  23. * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  24. * POSSIBILITY OF SUCH DAMAGE.
  25. */
  26. /*
  27. * Parse Composite Document Files, the format used in Microsoft Office
  28. * document files before they switched to zipped XML.
  29. * Info from: http://sc.openoffice.org/compdocfileformat.pdf
  30. *
  31. * N.B. This is the "Composite Document File" format, and not the
  32. * "Compound Document Format", nor the "Channel Definition Format".
  33. */
  34. #ifndef _H_CDF_
  35. #define _H_CDF_
  36. #ifdef WIN32
  37. #include <winsock2.h>
  38. #define timespec timeval
  39. #define tv_nsec tv_usec
  40. #endif
  41. #ifdef __DJGPP__
  42. #define timespec timeval
  43. #define tv_nsec tv_usec
  44. #endif
  45. typedef int32_t cdf_secid_t;
  46. #define CDF_LOOP_LIMIT 10000
  47. #define CDF_ELEMENT_LIMIT 100000
  48. #define CDF_SECID_NULL 0
  49. #define CDF_SECID_FREE -1
  50. #define CDF_SECID_END_OF_CHAIN -2
  51. #define CDF_SECID_SECTOR_ALLOCATION_TABLE -3
  52. #define CDF_SECID_MASTER_SECTOR_ALLOCATION_TABLE -4
  53. typedef struct {
  54. uint64_t h_magic;
  55. #define CDF_MAGIC 0xE11AB1A1E011CFD0LL
  56. uint64_t h_uuid[2];
  57. uint16_t h_revision;
  58. uint16_t h_version;
  59. uint16_t h_byte_order;
  60. uint16_t h_sec_size_p2;
  61. uint16_t h_short_sec_size_p2;
  62. uint8_t h_unused0[10];
  63. uint32_t h_num_sectors_in_sat;
  64. uint32_t h_secid_first_directory;
  65. uint8_t h_unused1[4];
  66. uint32_t h_min_size_standard_stream;
  67. cdf_secid_t h_secid_first_sector_in_short_sat;
  68. uint32_t h_num_sectors_in_short_sat;
  69. cdf_secid_t h_secid_first_sector_in_master_sat;
  70. uint32_t h_num_sectors_in_master_sat;
  71. cdf_secid_t h_master_sat[436/4];
  72. } cdf_header_t;
  73. #define CDF_SEC_SIZE(h) CAST(size_t, 1 << (h)->h_sec_size_p2)
  74. #define CDF_SEC_POS(h, secid) (CDF_SEC_SIZE(h) + (secid) * CDF_SEC_SIZE(h))
  75. #define CDF_SHORT_SEC_SIZE(h) CAST(size_t, 1 << (h)->h_short_sec_size_p2)
  76. #define CDF_SHORT_SEC_POS(h, secid) ((secid) * CDF_SHORT_SEC_SIZE(h))
  77. typedef int32_t cdf_dirid_t;
  78. #define CDF_DIRID_NULL -1
  79. typedef int64_t cdf_timestamp_t;
  80. #define CDF_BASE_YEAR 1601
  81. #define CDF_TIME_PREC 10000000
  82. typedef struct {
  83. uint16_t d_name[32];
  84. uint16_t d_namelen;
  85. uint8_t d_type;
  86. #define CDF_DIR_TYPE_EMPTY 0
  87. #define CDF_DIR_TYPE_USER_STORAGE 1
  88. #define CDF_DIR_TYPE_USER_STREAM 2
  89. #define CDF_DIR_TYPE_LOCKBYTES 3
  90. #define CDF_DIR_TYPE_PROPERTY 4
  91. #define CDF_DIR_TYPE_ROOT_STORAGE 5
  92. uint8_t d_color;
  93. #define CDF_DIR_COLOR_READ 0
  94. #define CDF_DIR_COLOR_BLACK 1
  95. cdf_dirid_t d_left_child;
  96. cdf_dirid_t d_right_child;
  97. cdf_dirid_t d_storage;
  98. uint64_t d_storage_uuid[2];
  99. uint32_t d_flags;
  100. cdf_timestamp_t d_created;
  101. cdf_timestamp_t d_modified;
  102. cdf_secid_t d_stream_first_sector;
  103. uint32_t d_size;
  104. uint32_t d_unused0;
  105. } cdf_directory_t;
  106. #define CDF_DIRECTORY_SIZE 128
  107. typedef struct {
  108. cdf_secid_t *sat_tab;
  109. size_t sat_len;
  110. } cdf_sat_t;
  111. typedef struct {
  112. cdf_directory_t *dir_tab;
  113. size_t dir_len;
  114. } cdf_dir_t;
  115. typedef struct {
  116. void *sst_tab;
  117. size_t sst_len; /* Number of sectors */
  118. size_t sst_dirlen; /* Directory sector size */
  119. size_t sst_ss; /* Sector size */
  120. } cdf_stream_t;
  121. typedef struct {
  122. uint32_t cl_dword;
  123. uint16_t cl_word[2];
  124. uint8_t cl_two[2];
  125. uint8_t cl_six[6];
  126. } cdf_classid_t;
  127. typedef struct {
  128. uint16_t si_byte_order;
  129. uint16_t si_zero;
  130. uint16_t si_os_version;
  131. uint16_t si_os;
  132. cdf_classid_t si_class;
  133. uint32_t si_count;
  134. } cdf_summary_info_header_t;
  135. #define CDF_SECTION_DECLARATION_OFFSET 0x1c
  136. typedef struct {
  137. cdf_classid_t sd_class;
  138. uint32_t sd_offset;
  139. } cdf_section_declaration_t;
  140. typedef struct {
  141. uint32_t sh_len;
  142. uint32_t sh_properties;
  143. } cdf_section_header_t;
  144. typedef struct {
  145. uint32_t pi_id;
  146. uint32_t pi_type;
  147. union {
  148. uint16_t _pi_u16;
  149. int16_t _pi_s16;
  150. uint32_t _pi_u32;
  151. int32_t _pi_s32;
  152. uint64_t _pi_u64;
  153. int64_t _pi_s64;
  154. cdf_timestamp_t _pi_tp;
  155. float _pi_f;
  156. double _pi_d;
  157. struct {
  158. uint32_t s_len;
  159. const char *s_buf;
  160. } _pi_str;
  161. } pi_val;
  162. #define pi_u64 pi_val._pi_u64
  163. #define pi_s64 pi_val._pi_s64
  164. #define pi_u32 pi_val._pi_u32
  165. #define pi_s32 pi_val._pi_s32
  166. #define pi_u16 pi_val._pi_u16
  167. #define pi_s16 pi_val._pi_s16
  168. #define pi_f pi_val._pi_f
  169. #define pi_d pi_val._pi_d
  170. #define pi_tp pi_val._pi_tp
  171. #define pi_str pi_val._pi_str
  172. } cdf_property_info_t;
  173. #define CDF_ROUND(val, by) (((val) + (by) - 1) & ~((by) - 1))
  174. /* Variant type definitions */
  175. #define CDF_EMPTY 0x00000000
  176. #define CDF_NULL 0x00000001
  177. #define CDF_SIGNED16 0x00000002
  178. #define CDF_SIGNED32 0x00000003
  179. #define CDF_FLOAT 0x00000004
  180. #define CDF_DOUBLE 0x00000005
  181. #define CDF_CY 0x00000006
  182. #define CDF_DATE 0x00000007
  183. #define CDF_BSTR 0x00000008
  184. #define CDF_DISPATCH 0x00000009
  185. #define CDF_ERROR 0x0000000a
  186. #define CDF_BOOL 0x0000000b
  187. #define CDF_VARIANT 0x0000000c
  188. #define CDF_UNKNOWN 0x0000000d
  189. #define CDF_DECIMAL 0x0000000e
  190. #define CDF_SIGNED8 0x00000010
  191. #define CDF_UNSIGNED8 0x00000011
  192. #define CDF_UNSIGNED16 0x00000012
  193. #define CDF_UNSIGNED32 0x00000013
  194. #define CDF_SIGNED64 0x00000014
  195. #define CDF_UNSIGNED64 0x00000015
  196. #define CDF_INT 0x00000016
  197. #define CDF_UINT 0x00000017
  198. #define CDF_VOID 0x00000018
  199. #define CDF_HRESULT 0x00000019
  200. #define CDF_PTR 0x0000001a
  201. #define CDF_SAFEARRAY 0x0000001b
  202. #define CDF_CARRAY 0x0000001c
  203. #define CDF_USERDEFINED 0x0000001d
  204. #define CDF_LENGTH32_STRING 0x0000001e
  205. #define CDF_LENGTH32_WSTRING 0x0000001f
  206. #define CDF_FILETIME 0x00000040
  207. #define CDF_BLOB 0x00000041
  208. #define CDF_STREAM 0x00000042
  209. #define CDF_STORAGE 0x00000043
  210. #define CDF_STREAMED_OBJECT 0x00000044
  211. #define CDF_STORED_OBJECT 0x00000045
  212. #define CDF_BLOB_OBJECT 0x00000046
  213. #define CDF_CLIPBOARD 0x00000047
  214. #define CDF_CLSID 0x00000048
  215. #define CDF_VECTOR 0x00001000
  216. #define CDF_ARRAY 0x00002000
  217. #define CDF_BYREF 0x00004000
  218. #define CDF_RESERVED 0x00008000
  219. #define CDF_ILLEGAL 0x0000ffff
  220. #define CDF_ILLEGALMASKED 0x00000fff
  221. #define CDF_TYPEMASK 0x00000fff
  222. #define CDF_PROPERTY_CODE_PAGE 0x00000001
  223. #define CDF_PROPERTY_TITLE 0x00000002
  224. #define CDF_PROPERTY_SUBJECT 0x00000003
  225. #define CDF_PROPERTY_AUTHOR 0x00000004
  226. #define CDF_PROPERTY_KEYWORDS 0x00000005
  227. #define CDF_PROPERTY_COMMENTS 0x00000006
  228. #define CDF_PROPERTY_TEMPLATE 0x00000007
  229. #define CDF_PROPERTY_LAST_SAVED_BY 0x00000008
  230. #define CDF_PROPERTY_REVISION_NUMBER 0x00000009
  231. #define CDF_PROPERTY_TOTAL_EDITING_TIME 0x0000000a
  232. #define CDF_PROPERTY_LAST_PRINTED 0X0000000b
  233. #define CDF_PROPERTY_CREATE_TIME 0x0000000c
  234. #define CDF_PROPERTY_LAST_SAVED_TIME 0x0000000d
  235. #define CDF_PROPERTY_NUMBER_OF_PAGES 0x0000000e
  236. #define CDF_PROPERTY_NUMBER_OF_WORDS 0x0000000f
  237. #define CDF_PROPERTY_NUMBER_OF_CHARACTERS 0x00000010
  238. #define CDF_PROPERTY_THUMBNAIL 0x00000011
  239. #define CDF_PROPERTY_NAME_OF_APPLICATION 0x00000012
  240. #define CDF_PROPERTY_SECURITY 0x00000013
  241. #define CDF_PROPERTY_LOCALE_ID 0x80000000
  242. typedef struct {
  243. int i_fd;
  244. const unsigned char *i_buf;
  245. size_t i_len;
  246. } cdf_info_t;
  247. typedef struct {
  248. uint16_t ce_namlen;
  249. uint32_t ce_num;
  250. uint64_t ce_timestamp;
  251. uint16_t ce_name[256];
  252. } cdf_catalog_entry_t;
  253. typedef struct {
  254. size_t cat_num;
  255. cdf_catalog_entry_t cat_e[1];
  256. } cdf_catalog_t;
  257. struct timespec;
  258. int cdf_timestamp_to_timespec(struct timespec *, cdf_timestamp_t);
  259. int cdf_timespec_to_timestamp(cdf_timestamp_t *, const struct timespec *);
  260. int cdf_read_header(const cdf_info_t *, cdf_header_t *);
  261. void cdf_swap_header(cdf_header_t *);
  262. void cdf_unpack_header(cdf_header_t *, char *);
  263. void cdf_swap_dir(cdf_directory_t *);
  264. void cdf_unpack_dir(cdf_directory_t *, char *);
  265. void cdf_swap_class(cdf_classid_t *);
  266. ssize_t cdf_read_sector(const cdf_info_t *, void *, size_t, size_t,
  267. const cdf_header_t *, cdf_secid_t);
  268. ssize_t cdf_read_short_sector(const cdf_stream_t *, void *, size_t, size_t,
  269. const cdf_header_t *, cdf_secid_t);
  270. int cdf_read_sat(const cdf_info_t *, cdf_header_t *, cdf_sat_t *);
  271. size_t cdf_count_chain(const cdf_sat_t *, cdf_secid_t, size_t);
  272. int cdf_read_long_sector_chain(const cdf_info_t *, const cdf_header_t *,
  273. const cdf_sat_t *, cdf_secid_t, size_t, cdf_stream_t *);
  274. int cdf_read_short_sector_chain(const cdf_header_t *, const cdf_sat_t *,
  275. const cdf_stream_t *, cdf_secid_t, size_t, cdf_stream_t *);
  276. int cdf_read_sector_chain(const cdf_info_t *, const cdf_header_t *,
  277. const cdf_sat_t *, const cdf_sat_t *, const cdf_stream_t *, cdf_secid_t,
  278. size_t, cdf_stream_t *);
  279. int cdf_read_dir(const cdf_info_t *, const cdf_header_t *, const cdf_sat_t *,
  280. cdf_dir_t *);
  281. int cdf_read_ssat(const cdf_info_t *, const cdf_header_t *, const cdf_sat_t *,
  282. cdf_sat_t *);
  283. int cdf_read_short_stream(const cdf_info_t *, const cdf_header_t *,
  284. const cdf_sat_t *, const cdf_dir_t *, cdf_stream_t *,
  285. const cdf_directory_t **);
  286. int cdf_read_property_info(const cdf_stream_t *, const cdf_header_t *, uint32_t,
  287. cdf_property_info_t **, size_t *, size_t *);
  288. int cdf_read_user_stream(const cdf_info_t *, const cdf_header_t *,
  289. const cdf_sat_t *, const cdf_sat_t *, const cdf_stream_t *,
  290. const cdf_dir_t *, const char *, cdf_stream_t *);
  291. int cdf_find_stream(const cdf_dir_t *, const char *, int);
  292. int cdf_zero_stream(cdf_stream_t *);
  293. int cdf_read_doc_summary_info(const cdf_info_t *, const cdf_header_t *,
  294. const cdf_sat_t *, const cdf_sat_t *, const cdf_stream_t *,
  295. const cdf_dir_t *, cdf_stream_t *);
  296. int cdf_read_summary_info(const cdf_info_t *, const cdf_header_t *,
  297. const cdf_sat_t *, const cdf_sat_t *, const cdf_stream_t *,
  298. const cdf_dir_t *, cdf_stream_t *);
  299. int cdf_unpack_summary_info(const cdf_stream_t *, const cdf_header_t *,
  300. cdf_summary_info_header_t *, cdf_property_info_t **, size_t *);
  301. int cdf_unpack_catalog(const cdf_header_t *, const cdf_stream_t *,
  302. cdf_catalog_t **);
  303. int cdf_print_classid(char *, size_t, const cdf_classid_t *);
  304. int cdf_print_property_name(char *, size_t, uint32_t);
  305. int cdf_print_elapsed_time(char *, size_t, cdf_timestamp_t);
  306. uint16_t cdf_tole2(uint16_t);
  307. uint32_t cdf_tole4(uint32_t);
  308. uint64_t cdf_tole8(uint64_t);
  309. char *cdf_ctime(const time_t *, char *);
  310. char *cdf_u16tos8(char *, size_t, const uint16_t *);
  311. #ifdef CDF_DEBUG
  312. void cdf_dump_header(const cdf_header_t *);
  313. void cdf_dump_sat(const char *, const cdf_sat_t *, size_t);
  314. void cdf_dump(const void *, size_t);
  315. void cdf_dump_stream(const cdf_stream_t *);
  316. void cdf_dump_dir(const cdf_info_t *, const cdf_header_t *, const cdf_sat_t *,
  317. const cdf_sat_t *, const cdf_stream_t *, const cdf_dir_t *);
  318. void cdf_dump_property_info(const cdf_property_info_t *, size_t);
  319. void cdf_dump_summary_info(const cdf_header_t *, const cdf_stream_t *);
  320. void cdf_dump_catalog(const cdf_header_t *, const cdf_stream_t *);
  321. #endif
  322. #endif /* _H_CDF_ */