cdf.h revision 192350
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 * Info from: http://sc.openoffice.org/compdocfileformat.pdf 28 */ 29 30#ifndef _H_CDF_ 31#define _H_CDF_ 32 33typedef int32_t cdf_secid_t; 34 35#define CDF_LOOP_LIMIT 10000 36 37#define CDF_SECID_NULL 0 38#define CDF_SECID_FREE -1 39#define CDF_SECID_END_OF_CHAIN -2 40#define CDF_SECID_SECTOR_ALLOCATION_TABLE -3 41#define CDF_SECID_MASTER_SECTOR_ALLOCATION_TABLE -4 42 43typedef struct { 44 uint64_t h_magic; 45#define CDF_MAGIC 0xE11AB1A1E011CFD0LL 46 uint64_t h_uuid[2]; 47 uint16_t h_revision; 48 uint16_t h_version; 49 uint16_t h_byte_order; 50 uint16_t h_sec_size_p2; 51 uint16_t h_short_sec_size_p2; 52 uint8_t h_unused0[10]; 53 uint32_t h_num_sectors_in_sat; 54 uint32_t h_secid_first_directory; 55 uint8_t h_unused1[4]; 56 uint32_t h_min_size_standard_stream; 57 cdf_secid_t h_secid_first_sector_in_short_sat; 58 uint32_t h_num_sectors_in_short_sat; 59 cdf_secid_t h_secid_first_sector_in_master_sat; 60 uint32_t h_num_sectors_in_master_sat; 61 cdf_secid_t h_master_sat[436/4]; 62} cdf_header_t; 63 64#define CDF_SEC_SIZE(h) (1 << (h)->h_sec_size_p2) 65#define CDF_SEC_POS(h, secid) (CDF_SEC_SIZE(h) + (secid) * CDF_SEC_SIZE(h)) 66#define CDF_SHORT_SEC_SIZE(h) (1 << (h)->h_short_sec_size_p2) 67#define CDF_SHORT_SEC_POS(h, secid) ((secid) * CDF_SHORT_SEC_SIZE(h)) 68 69typedef int32_t cdf_dirid_t; 70#define CDF_DIRID_NULL -1 71 72typedef int64_t cdf_timestamp_t; 73#define CDF_BASE_YEAR 1601 74#define CDF_TIME_PREC 10000000 75 76typedef struct { 77 uint16_t d_name[32]; 78 uint16_t d_namelen; 79 uint8_t d_type; 80#define CDF_DIR_TYPE_EMPTY 0 81#define CDF_DIR_TYPE_USER_STORAGE 1 82#define CDF_DIR_TYPE_USER_STREAM 2 83#define CDF_DIR_TYPE_LOCKBYTES 3 84#define CDF_DIR_TYPE_PROPERTY 4 85#define CDF_DIR_TYPE_ROOT_STORAGE 5 86 uint8_t d_color; 87#define CDF_DIR_COLOR_READ 0 88#define CDF_DIR_COLOR_BLACK 1 89 cdf_dirid_t d_left_child; 90 cdf_dirid_t d_right_child; 91 cdf_dirid_t d_storage; 92 uint64_t d_storage_uuid[2]; 93 uint32_t d_flags; 94 cdf_timestamp_t d_created; 95 cdf_timestamp_t d_modified; 96 cdf_secid_t d_stream_first_sector; 97 uint32_t d_size; 98 uint32_t d_unused0; 99} cdf_directory_t; 100 101#define CDF_DIRECTORY_SIZE 128 102 103typedef struct { 104 cdf_secid_t *sat_tab; 105 size_t sat_len; 106} cdf_sat_t; 107 108typedef struct { 109 cdf_directory_t *dir_tab; 110 size_t dir_len; 111} cdf_dir_t; 112 113typedef struct { 114 void *sst_tab; 115 size_t sst_len; 116 size_t sst_dirlen; 117} cdf_stream_t; 118 119typedef struct { 120 uint32_t cl_dword; 121 uint16_t cl_word[2]; 122 uint8_t cl_two[2]; 123 uint8_t cl_six[6]; 124} cdf_classid_t; 125 126typedef struct { 127 uint16_t si_byte_order; 128 uint16_t si_zero; 129 uint16_t si_os_version; 130 uint16_t si_os; 131 cdf_classid_t si_class; 132 uint32_t si_count; 133} cdf_summary_info_header_t; 134 135#define CDF_SECTION_DECLARATION_OFFSET 0x1c 136 137typedef struct { 138 cdf_classid_t sd_class; 139 uint32_t sd_offset; 140} cdf_section_declaration_t; 141 142typedef struct { 143 uint32_t sh_len; 144 uint32_t sh_properties; 145} cdf_section_header_t; 146 147typedef struct { 148 uint32_t pi_id; 149 uint32_t pi_type; 150 union { 151 uint16_t _pi_u16; 152 int16_t _pi_s16; 153 uint32_t _pi_u32; 154 int32_t _pi_s32; 155 uint64_t _pi_u64; 156 int64_t _pi_s64; 157 cdf_timestamp_t _pi_tp; 158 struct { 159 uint32_t s_len; 160 const char *s_buf; 161 } _pi_str; 162 } pi_val; 163#define pi_u64 pi_val._pi_u64 164#define pi_s64 pi_val._pi_s64 165#define pi_u32 pi_val._pi_u32 166#define pi_s32 pi_val._pi_s32 167#define pi_u16 pi_val._pi_u16 168#define pi_s16 pi_val._pi_s16 169#define pi_tp pi_val._pi_tp 170#define pi_str pi_val._pi_str 171} cdf_property_info_t; 172 173#define CDF_ROUND(val, by) (((val) + (by) - 1) & ~((by) - 1)) 174 175/* Variant type definitions */ 176#define CDF_EMPTY 0x00000000 177#define CDF_NULL 0x00000001 178#define CDF_SIGNED16 0x00000002 179#define CDF_SIGNED32 0x00000003 180#define CDF_FLOAT 0x00000004 181#define CDF_DOUBLE 0x00000005 182#define CDF_CY 0x00000006 183#define CDF_DATE 0x00000007 184#define CDF_BSTR 0x00000008 185#define CDF_DISPATCH 0x00000009 186#define CDF_ERROR 0x0000000a 187#define CDF_BOOL 0x0000000b 188#define CDF_VARIANT 0x0000000c 189#define CDF_UNKNOWN 0x0000000d 190#define CDF_DECIMAL 0x0000000e 191#define CDF_SIGNED8 0x00000010 192#define CDF_UNSIGNED8 0x00000011 193#define CDF_UNSIGNED16 0x00000012 194#define CDF_UNSIGNED32 0x00000013 195#define CDF_SIGNED64 0x00000014 196#define CDF_UNSIGNED64 0x00000015 197#define CDF_INT 0x00000016 198#define CDF_UINT 0x00000017 199#define CDF_VOID 0x00000018 200#define CDF_HRESULT 0x00000019 201#define CDF_PTR 0x0000001a 202#define CDF_SAFEARRAY 0x0000001b 203#define CDF_CARRAY 0x0000001c 204#define CDF_USERDEFINED 0x0000001d 205#define CDF_LENGTH32_STRING 0x0000001e 206#define CDF_LENGTH32_WSTRING 0x0000001f 207#define CDF_FILETIME 0x00000040 208#define CDF_BLOB 0x00000041 209#define CDF_STREAM 0x00000042 210#define CDF_STORAGE 0x00000043 211#define CDF_STREAMED_OBJECT 0x00000044 212#define CDF_STORED_OBJECT 0x00000045 213#define CDF_BLOB_OBJECT 0x00000046 214#define CDF_CLIPBOARD 0x00000047 215#define CDF_CLSID 0x00000048 216#define CDF_VECTOR 0x00001000 217#define CDF_ARRAY 0x00002000 218#define CDF_BYREF 0x00004000 219#define CDF_RESERVED 0x00008000 220#define CDF_ILLEGAL 0x0000ffff 221#define CDF_ILLEGALMASKED 0x00000fff 222#define CDF_TYPEMASK 0x00000fff 223 224#define CDF_PROPERTY_CODE_PAGE 0x00000001 225#define CDF_PROPERTY_TITLE 0x00000002 226#define CDF_PROPERTY_SUBJECT 0x00000003 227#define CDF_PROPERTY_AUTHOR 0x00000004 228#define CDF_PROPERTY_KEYWORDS 0x00000005 229#define CDF_PROPERTY_COMMENTS 0x00000006 230#define CDF_PROPERTY_TEMPLATE 0x00000007 231#define CDF_PROPERTY_LAST_SAVED_BY 0x00000008 232#define CDF_PROPERTY_REVISION_NUMBER 0x00000009 233#define CDF_PROPERTY_TOTAL_EDITING_TIME 0x0000000a 234#define CDF_PROPERTY_LAST_PRINTED 0X0000000b 235#define CDF_PROPERTY_CREATE_TIME 0x0000000c 236#define CDF_PROPERTY_LAST_SAVED_TIME 0x0000000d 237#define CDF_PROPERTY_NUMBER_OF_PAGES 0x0000000e 238#define CDF_PROPERTY_NUMBER_OF_WORDS 0x0000000f 239#define CDF_PROPERTY_NUMBER_OF_CHARACTERS 0x00000010 240#define CDF_PROPERTY_THUMBNAIL 0x00000011 241#define CDF_PROPERTY_NAME_OF_APPLICATION 0x00000012 242#define CDF_PROPERTY_SECURITY 0x00000013 243#define CDF_PROPERTY_LOCALE_ID 0x80000000 244 245typedef struct { 246 int i_fd; 247 const unsigned char *i_buf; 248 size_t i_len; 249} cdf_info_t; 250 251struct timespec; 252int cdf_timestamp_to_timespec(struct timespec *, cdf_timestamp_t); 253int cdf_timespec_to_timestamp(cdf_timestamp_t *, const struct timespec *); 254int cdf_read_header(const cdf_info_t *, cdf_header_t *); 255void cdf_swap_header(cdf_header_t *); 256void cdf_unpack_header(cdf_header_t *, char *); 257void cdf_swap_dir(cdf_directory_t *); 258void cdf_unpack_dir(cdf_directory_t *, char *); 259void cdf_swap_class(cdf_classid_t *); 260ssize_t cdf_read_sector(const cdf_info_t *, void *, size_t, size_t, 261 const cdf_header_t *, cdf_secid_t); 262ssize_t cdf_read_short_sector(const cdf_stream_t *, void *, size_t, size_t, 263 const cdf_header_t *, cdf_secid_t); 264int cdf_read_sat(const cdf_info_t *, cdf_header_t *, cdf_sat_t *); 265size_t cdf_count_chain(const cdf_sat_t *, cdf_secid_t, size_t); 266int cdf_read_long_sector_chain(const cdf_info_t *, const cdf_header_t *, 267 const cdf_sat_t *, cdf_secid_t, size_t, cdf_stream_t *); 268int cdf_read_short_sector_chain(const cdf_header_t *, const cdf_sat_t *, 269 const cdf_stream_t *, cdf_secid_t, size_t, cdf_stream_t *); 270int cdf_read_sector_chain(const cdf_info_t *, const cdf_header_t *, 271 const cdf_sat_t *, const cdf_sat_t *, const cdf_stream_t *, cdf_secid_t, 272 size_t, cdf_stream_t *); 273int cdf_read_dir(const cdf_info_t *, const cdf_header_t *, const cdf_sat_t *, 274 cdf_dir_t *); 275int cdf_read_ssat(const cdf_info_t *, const cdf_header_t *, const cdf_sat_t *, 276 cdf_sat_t *); 277int cdf_read_short_stream(const cdf_info_t *, const cdf_header_t *, 278 const cdf_sat_t *, const cdf_dir_t *, cdf_stream_t *); 279int cdf_read_property_info(const cdf_stream_t *, uint32_t, 280 cdf_property_info_t **, size_t *, size_t *); 281int cdf_read_summary_info(const cdf_info_t *, const cdf_header_t *, 282 const cdf_sat_t *, const cdf_sat_t *, const cdf_stream_t *, 283 const cdf_dir_t *, cdf_stream_t *); 284int cdf_unpack_summary_info(const cdf_stream_t *, cdf_summary_info_header_t *, 285 cdf_property_info_t **, size_t *); 286int cdf_print_classid(char *, size_t, const cdf_classid_t *); 287int cdf_print_property_name(char *, size_t, uint32_t); 288int cdf_print_elapsed_time(char *, size_t, cdf_timestamp_t); 289uint16_t cdf_tole2(uint16_t); 290uint32_t cdf_tole4(uint32_t); 291uint64_t cdf_tole8(uint64_t); 292 293#ifdef CDF_DEBUG 294void cdf_dump_header(const cdf_header_t *); 295void cdf_dump_sat(const char *, const cdf_sat_t *, size_t); 296void cdf_dump(void *, size_t); 297void cdf_dump_stream(const cdf_header_t *, const cdf_stream_t *); 298void cdf_dump_dir(const cdf_info_t *, const cdf_header_t *, const cdf_sat_t *, 299 const cdf_sat_t *, const cdf_stream_t *, const cdf_dir_t *); 300void cdf_dump_property_info(const cdf_property_info_t *, size_t); 301void cdf_dump_summary_info(const cdf_header_t *, const cdf_stream_t *); 302#endif 303 304 305#endif /* _H_CDF_ */ 306