4 * Copyright 2002 Greg Turner
5 * Copyright 2005 Gerold Jens Wucherpfennig
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
22 #ifndef __WINE_CABINET_H
23 #define __WINE_CABINET_H
25 #include <wine/config.h>
29 #define WIN32_NO_STATUS
31 #define COM_NO_WINDOWS_H
37 #include <wine/debug.h>
38 WINE_DEFAULT_DEBUG_CHANNEL(cabinet
);
40 /* from msvcrt/sys/stat.h */
41 #define _S_IWRITE 0x0080
42 #define _S_IREAD 0x0100
44 /* from msvcrt/fcntl.h */
48 #define _O_ACCMODE (_O_RDONLY|_O_WRONLY|_O_RDWR)
49 #define _O_APPEND 0x0008
50 #define _O_RANDOM 0x0010
51 #define _O_SEQUENTIAL 0x0020
52 #define _O_TEMPORARY 0x0040
53 #define _O_NOINHERIT 0x0080
54 #define _O_CREAT 0x0100
55 #define _O_TRUNC 0x0200
56 #define _O_EXCL 0x0400
57 #define _O_SHORT_LIVED 0x1000
58 #define _O_TEXT 0x4000
59 #define _O_BINARY 0x8000
61 #define CAB_SPLITMAX (10)
63 #define CAB_SEARCH_SIZE (32*1024)
65 typedef unsigned char cab_UBYTE
; /* 8 bits */
66 typedef UINT16 cab_UWORD
; /* 16 bits */
67 typedef UINT32 cab_ULONG
; /* 32 bits */
68 typedef INT32 cab_LONG
; /* 32 bits */
70 typedef UINT32 cab_off_t
;
72 /* number of bits in a ULONG */
73 #define CAB_ULONG_BITS (sizeof(cab_ULONG) * 8) /* CHAR_BIT */
75 /* structure offsets */
76 #define cfhead_Signature (0x00)
77 #define cfhead_CabinetSize (0x08)
78 #define cfhead_FileOffset (0x10)
79 #define cfhead_MinorVersion (0x18)
80 #define cfhead_MajorVersion (0x19)
81 #define cfhead_NumFolders (0x1A)
82 #define cfhead_NumFiles (0x1C)
83 #define cfhead_Flags (0x1E)
84 #define cfhead_SetID (0x20)
85 #define cfhead_CabinetIndex (0x22)
86 #define cfhead_SIZEOF (0x24)
87 #define cfheadext_HeaderReserved (0x00)
88 #define cfheadext_FolderReserved (0x02)
89 #define cfheadext_DataReserved (0x03)
90 #define cfheadext_SIZEOF (0x04)
91 #define cffold_DataOffset (0x00)
92 #define cffold_NumBlocks (0x04)
93 #define cffold_CompType (0x06)
94 #define cffold_SIZEOF (0x08)
95 #define cffile_UncompressedSize (0x00)
96 #define cffile_FolderOffset (0x04)
97 #define cffile_FolderIndex (0x08)
98 #define cffile_Date (0x0A)
99 #define cffile_Time (0x0C)
100 #define cffile_Attribs (0x0E)
101 #define cffile_SIZEOF (0x10)
102 #define cfdata_CheckSum (0x00)
103 #define cfdata_CompressedSize (0x04)
104 #define cfdata_UncompressedSize (0x06)
105 #define cfdata_SIZEOF (0x08)
108 #define cffoldCOMPTYPE_MASK (0x000f)
109 #define cffoldCOMPTYPE_NONE (0x0000)
110 #define cffoldCOMPTYPE_MSZIP (0x0001)
111 #define cffoldCOMPTYPE_QUANTUM (0x0002)
112 #define cffoldCOMPTYPE_LZX (0x0003)
113 #define cfheadPREV_CABINET (0x0001)
114 #define cfheadNEXT_CABINET (0x0002)
115 #define cfheadRESERVE_PRESENT (0x0004)
116 #define cffileCONTINUED_FROM_PREV (0xFFFD)
117 #define cffileCONTINUED_TO_NEXT (0xFFFE)
118 #define cffileCONTINUED_PREV_AND_NEXT (0xFFFF)
119 #define cffile_A_RDONLY (0x01)
120 #define cffile_A_HIDDEN (0x02)
121 #define cffile_A_SYSTEM (0x04)
122 #define cffile_A_ARCH (0x20)
123 #define cffile_A_EXEC (0x40)
124 #define cffile_A_NAME_IS_UTF (0x80)
126 /****************************************************************************/
127 /* our archiver information / state */
130 #define ZIPWSIZE 0x8000 /* window size */
131 #define ZIPLBITS 9 /* bits in base literal/length lookup table */
132 #define ZIPDBITS 6 /* bits in base distance lookup table */
133 #define ZIPBMAX 16 /* maximum bit length of any code */
134 #define ZIPN_MAX 288 /* maximum number of codes in any set */
137 cab_UBYTE e
; /* number of extra bits or operation */
138 cab_UBYTE b
; /* number of bits in this code or subcode */
140 cab_UWORD n
; /* literal, length base, or distance base */
141 struct Ziphuft
*t
; /* pointer to next level of table */
146 cab_ULONG window_posn
; /* current offset within the window */
147 cab_ULONG bb
; /* bit buffer */
148 cab_ULONG bk
; /* bits in bit buffer */
149 cab_ULONG ll
[288+32]; /* literal/length and distance code lengths */
150 cab_ULONG c
[ZIPBMAX
+1]; /* bit length count table */
151 cab_LONG lx
[ZIPBMAX
+1]; /* memory for l[-1..ZIPBMAX-1] */
152 struct Ziphuft
*u
[ZIPBMAX
]; /* table stack */
153 cab_ULONG v
[ZIPN_MAX
]; /* values in order of bit length */
154 cab_ULONG x
[ZIPBMAX
+1]; /* bit offsets, then code stack */
161 cab_UWORD sym
, cumfreq
;
165 int shiftsleft
, entries
;
166 struct QTMmodelsym
*syms
;
167 cab_UWORD tabloc
[256];
171 cab_UBYTE
*window
; /* the actual decoding window */
172 cab_ULONG window_size
; /* window size (1Kb through 2Mb) */
173 cab_ULONG actual_size
; /* window size when it was first allocated */
174 cab_ULONG window_posn
; /* current offset within the window */
176 struct QTMmodel model7
;
177 struct QTMmodelsym m7sym
[7+1];
179 struct QTMmodel model4
, model5
, model6pos
, model6len
;
180 struct QTMmodelsym m4sym
[0x18 + 1];
181 struct QTMmodelsym m5sym
[0x24 + 1];
182 struct QTMmodelsym m6psym
[0x2a + 1], m6lsym
[0x1b + 1];
184 struct QTMmodel model00
, model40
, model80
, modelC0
;
185 struct QTMmodelsym m00sym
[0x40 + 1], m40sym
[0x40 + 1];
186 struct QTMmodelsym m80sym
[0x40 + 1], mC0sym
[0x40 + 1];
191 /* some constants defined by the LZX specification */
192 #define LZX_MIN_MATCH (2)
193 #define LZX_MAX_MATCH (257)
194 #define LZX_NUM_CHARS (256)
195 #define LZX_BLOCKTYPE_INVALID (0) /* also blocktypes 4-7 invalid */
196 #define LZX_BLOCKTYPE_VERBATIM (1)
197 #define LZX_BLOCKTYPE_ALIGNED (2)
198 #define LZX_BLOCKTYPE_UNCOMPRESSED (3)
199 #define LZX_PRETREE_NUM_ELEMENTS (20)
200 #define LZX_ALIGNED_NUM_ELEMENTS (8) /* aligned offset tree #elements */
201 #define LZX_NUM_PRIMARY_LENGTHS (7) /* this one missing from spec! */
202 #define LZX_NUM_SECONDARY_LENGTHS (249) /* length tree #elements */
204 /* LZX huffman defines: tweak tablebits as desired */
205 #define LZX_PRETREE_MAXSYMBOLS (LZX_PRETREE_NUM_ELEMENTS)
206 #define LZX_PRETREE_TABLEBITS (6)
207 #define LZX_MAINTREE_MAXSYMBOLS (LZX_NUM_CHARS + 50*8)
208 #define LZX_MAINTREE_TABLEBITS (12)
209 #define LZX_LENGTH_MAXSYMBOLS (LZX_NUM_SECONDARY_LENGTHS+1)
210 #define LZX_LENGTH_TABLEBITS (12)
211 #define LZX_ALIGNED_MAXSYMBOLS (LZX_ALIGNED_NUM_ELEMENTS)
212 #define LZX_ALIGNED_TABLEBITS (7)
214 #define LZX_LENTABLE_SAFETY (64) /* we allow length table decoding overruns */
216 #define LZX_DECLARE_TABLE(tbl) \
217 cab_UWORD tbl##_table[(1<<LZX_##tbl##_TABLEBITS) + (LZX_##tbl##_MAXSYMBOLS<<1)];\
218 cab_UBYTE tbl##_len [LZX_##tbl##_MAXSYMBOLS + LZX_LENTABLE_SAFETY]
221 cab_UBYTE
*window
; /* the actual decoding window */
222 cab_ULONG window_size
; /* window size (32Kb through 2Mb) */
223 cab_ULONG actual_size
; /* window size when it was first allocated */
224 cab_ULONG window_posn
; /* current offset within the window */
225 cab_ULONG R0
, R1
, R2
; /* for the LRU offset system */
226 cab_UWORD main_elements
; /* number of main tree elements */
227 int header_read
; /* have we started decoding at all yet? */
228 cab_UWORD block_type
; /* type of this block */
229 cab_ULONG block_length
; /* uncompressed length of this block */
230 cab_ULONG block_remaining
; /* uncompressed bytes still left to decode */
231 cab_ULONG frames_read
; /* the number of CFDATA blocks processed */
232 cab_LONG intel_filesize
; /* magic header value used for transform */
233 cab_LONG intel_curpos
; /* current offset in transform space */
234 int intel_started
; /* have we seen any translatable data yet? */
236 LZX_DECLARE_TABLE(PRETREE
);
237 LZX_DECLARE_TABLE(MAINTREE
);
238 LZX_DECLARE_TABLE(LENGTH
);
239 LZX_DECLARE_TABLE(ALIGNED
);
248 /* CAB data blocks are <= 32768 bytes in uncompressed form. Uncompressed
249 * blocks have zero growth. MSZIP guarantees that it won't grow above
250 * uncompressed size by more than 12 bytes. LZX guarantees it won't grow
251 * more than 6144 bytes.
253 #define CAB_BLOCKMAX (32768)
254 #define CAB_INPUTMAX (CAB_BLOCKMAX+6144)
257 struct cab_file
*next
; /* next file in sequence */
258 struct cab_folder
*folder
; /* folder that contains this file */
259 LPCSTR filename
; /* output name of file */
260 HANDLE fh
; /* open file handle or NULL */
261 cab_ULONG length
; /* uncompressed length of file */
262 cab_ULONG offset
; /* uncompressed offset in folder */
263 cab_UWORD index
; /* magic index number of folder */
264 cab_UWORD time
, date
, attribs
; /* MS-DOS time/date/attributes */
269 struct cab_folder
*next
;
270 struct cabinet
*cab
[CAB_SPLITMAX
]; /* cabinet(s) this folder spans */
271 cab_off_t offset
[CAB_SPLITMAX
]; /* offset to data blocks */
272 cab_UWORD comp_type
; /* compression format/window size */
273 cab_ULONG comp_size
; /* compressed size of folder */
274 cab_UBYTE num_splits
; /* number of split blocks + 1 */
275 cab_UWORD num_blocks
; /* total number of blocks */
276 struct cab_file
*contfile
; /* the first split file */
280 struct cabinet
*next
; /* for making a list of cabinets */
281 LPCSTR filename
; /* input name of cabinet */
282 HANDLE
*fh
; /* open file handle or NULL */
283 cab_off_t filelen
; /* length of cabinet file */
284 cab_off_t blocks_off
; /* offset to data blocks in file */
285 struct cabinet
*prevcab
, *nextcab
; /* multipart cabinet chains */
286 char *prevname
, *nextname
; /* and their filenames */
287 char *previnfo
, *nextinfo
; /* and their visible names */
288 struct cab_folder
*folders
; /* first folder in this cabinet */
289 struct cab_file
*files
; /* first file in this cabinet */
290 cab_UBYTE block_resv
; /* reserved space in datablocks */
291 cab_UBYTE flags
; /* header flags */
294 typedef struct cds_forward
{
295 struct cab_folder
*current
; /* current folder we're extracting from */
296 cab_ULONG offset
; /* uncompressed offset within folder */
297 cab_UBYTE
*outpos
; /* (high level) start of data to use up */
298 cab_UWORD outlen
; /* (high level) amount of data to use up */
299 cab_UWORD split
; /* at which split in current folder? */
300 int (*decompress
)(int, int, struct cds_forward
*); /* chosen compress fn */
301 cab_UBYTE inbuf
[CAB_INPUTMAX
+2]; /* +2 for lzx bitbuffer overflows! */
302 cab_UBYTE outbuf
[CAB_BLOCKMAX
];
303 cab_UBYTE q_length_base
[27], q_length_extra
[27], q_extra_bits
[42];
304 cab_ULONG q_position_base
[42];
305 cab_ULONG lzx_position_base
[51];
306 cab_UBYTE extra_bits
[51];
315 * the rest of these are somewhat kludgy macros which are shared between fdi.c
319 /* Bitstream reading macros (Quantum / normal byte order)
321 * Q_INIT_BITSTREAM should be used first to set up the system
322 * Q_READ_BITS(var,n) takes N bits from the buffer and puts them in var.
323 * unlike LZX, this can loop several times to get the
324 * requisite number of bits.
325 * Q_FILL_BUFFER adds more data to the bit buffer, if there is room
326 * for another 16 bits.
327 * Q_PEEK_BITS(n) extracts (without removing) N bits from the bit
329 * Q_REMOVE_BITS(n) removes N bits from the bit buffer
331 * These bit access routines work by using the area beyond the MSB and the
332 * LSB as a free source of zeroes. This avoids having to mask any bits.
333 * So we have to know the bit width of the bitbuffer variable. This is
334 * defined as ULONG_BITS.
336 * ULONG_BITS should be at least 16 bits. Unlike LZX's Huffman decoding,
337 * Quantum's arithmetic decoding only needs 1 bit at a time, it doesn't
338 * need an assured number. Retrieving larger bitstrings can be done with
339 * multiple reads and fills of the bitbuffer. The code should work fine
340 * for machines where ULONG >= 32 bits.
342 * Also note that Quantum reads bytes in normal order; LZX is in
343 * little-endian order.
346 #define Q_INIT_BITSTREAM do { bitsleft = 0; bitbuf = 0; } while (0)
348 #define Q_FILL_BUFFER do { \
349 if (bitsleft <= (CAB_ULONG_BITS - 16)) { \
350 bitbuf |= ((inpos[0]<<8)|inpos[1]) << (CAB_ULONG_BITS-16 - bitsleft); \
351 bitsleft += 16; inpos += 2; \
355 #define Q_PEEK_BITS(n) (bitbuf >> (CAB_ULONG_BITS - (n)))
356 #define Q_REMOVE_BITS(n) ((bitbuf <<= (n)), (bitsleft -= (n)))
358 #define Q_READ_BITS(v,n) do { \
360 for (bitsneed = (n); bitsneed; bitsneed -= bitrun) { \
362 bitrun = (bitsneed > bitsleft) ? bitsleft : bitsneed; \
363 (v) = ((v) << bitrun) | Q_PEEK_BITS(bitrun); \
364 Q_REMOVE_BITS(bitrun); \
368 #define Q_MENTRIES(model) (QTM(model).entries)
369 #define Q_MSYM(model,symidx) (QTM(model).syms[(symidx)].sym)
370 #define Q_MSYMFREQ(model,symidx) (QTM(model).syms[(symidx)].cumfreq)
372 /* GET_SYMBOL(model, var) fetches the next symbol from the stated model
373 * and puts it in var. it may need to read the bitstream to do this.
375 #define GET_SYMBOL(m, var) do { \
376 range = ((H - L) & 0xFFFF) + 1; \
377 symf = ((((C - L + 1) * Q_MSYMFREQ(m,0)) - 1) / range) & 0xFFFF; \
379 for (i=1; i < Q_MENTRIES(m); i++) { \
380 if (Q_MSYMFREQ(m,i) <= symf) break; \
382 (var) = Q_MSYM(m,i-1); \
384 range = (H - L) + 1; \
385 H = L + ((Q_MSYMFREQ(m,i-1) * range) / Q_MSYMFREQ(m,0)) - 1; \
386 L = L + ((Q_MSYMFREQ(m,i) * range) / Q_MSYMFREQ(m,0)); \
388 if ((L & 0x8000) != (H & 0x8000)) { \
389 if ((L & 0x4000) && !(H & 0x4000)) { \
390 /* underflow case */ \
391 C ^= 0x4000; L &= 0x3FFF; H |= 0x4000; \
395 L <<= 1; H = (H << 1) | 1; \
397 C = (C << 1) | Q_PEEK_BITS(1); \
401 QTMupdatemodel(&(QTM(m)), i); \
404 /* Bitstream reading macros (LZX / intel little-endian byte order)
406 * INIT_BITSTREAM should be used first to set up the system
407 * READ_BITS(var,n) takes N bits from the buffer and puts them in var
409 * ENSURE_BITS(n) ensures there are at least N bits in the bit buffer.
410 * it can guarantee up to 17 bits (i.e. it can read in
411 * 16 new bits when there is down to 1 bit in the buffer,
412 * and it can read 32 bits when there are 0 bits in the
414 * PEEK_BITS(n) extracts (without removing) N bits from the bit buffer
415 * REMOVE_BITS(n) removes N bits from the bit buffer
417 * These bit access routines work by using the area beyond the MSB and the
418 * LSB as a free source of zeroes. This avoids having to mask any bits.
419 * So we have to know the bit width of the bitbuffer variable.
422 #define INIT_BITSTREAM do { bitsleft = 0; bitbuf = 0; } while (0)
424 /* Quantum reads bytes in normal order; LZX is little-endian order */
425 #define ENSURE_BITS(n) \
426 while (bitsleft < (n)) { \
427 bitbuf |= ((inpos[1]<<8)|inpos[0]) << (CAB_ULONG_BITS-16 - bitsleft); \
428 bitsleft += 16; inpos+=2; \
431 #define PEEK_BITS(n) (bitbuf >> (CAB_ULONG_BITS - (n)))
432 #define REMOVE_BITS(n) ((bitbuf <<= (n)), (bitsleft -= (n)))
434 #define READ_BITS(v,n) do { \
437 (v) = PEEK_BITS(n); \
447 #define TABLEBITS(tbl) (LZX_##tbl##_TABLEBITS)
448 #define MAXSYMBOLS(tbl) (LZX_##tbl##_MAXSYMBOLS)
449 #define SYMTABLE(tbl) (LZX(tbl##_table))
450 #define LENTABLE(tbl) (LZX(tbl##_len))
452 /* BUILD_TABLE(tablename) builds a huffman lookup table from code lengths.
453 * In reality, it just calls make_decode_table() with the appropriate
454 * values - they're all fixed by some #defines anyway, so there's no point
455 * writing each call out in full by hand.
457 #define BUILD_TABLE(tbl) \
458 if (make_decode_table( \
459 MAXSYMBOLS(tbl), TABLEBITS(tbl), LENTABLE(tbl), SYMTABLE(tbl) \
460 )) { return DECR_ILLEGALDATA; }
462 /* READ_HUFFSYM(tablename, var) decodes one huffman symbol from the
463 * bitstream using the stated table and puts it in var.
465 #define READ_HUFFSYM(tbl,var) do { \
467 hufftbl = SYMTABLE(tbl); \
468 if ((i = hufftbl[PEEK_BITS(TABLEBITS(tbl))]) >= MAXSYMBOLS(tbl)) { \
469 j = 1 << (CAB_ULONG_BITS - TABLEBITS(tbl)); \
471 j >>= 1; i <<= 1; i |= (bitbuf & j) ? 1 : 0; \
472 if (!j) { return DECR_ILLEGALDATA; } \
473 } while ((i = hufftbl[i]) >= MAXSYMBOLS(tbl)); \
475 j = LENTABLE(tbl)[(var) = i]; \
479 /* READ_LENGTHS(tablename, first, last) reads in code lengths for symbols
480 * first to last in the given table. The code lengths are stored in their
481 * own special LZX way.
483 #define READ_LENGTHS(tbl,first,last,fn) do { \
484 lb.bb = bitbuf; lb.bl = bitsleft; lb.ip = inpos; \
485 if (fn(LENTABLE(tbl),(first),(last),&lb,decomp_state)) { \
486 return DECR_ILLEGALDATA; \
488 bitbuf = lb.bb; bitsleft = lb.bl; inpos = lb.ip; \
491 /* Tables for deflate from PKZIP's appnote.txt. */
493 #define THOSE_ZIP_CONSTS \
494 static const cab_UBYTE Zipborder[] = /* Order of the bit length code lengths */ \
495 { 16, 17, 18, 0, 8, 7, 9, 6, 10, 5, 11, 4, 12, 3, 13, 2, 14, 1, 15}; \
496 static const cab_UWORD Zipcplens[] = /* Copy lengths for literal codes 257..285 */ \
497 { 3, 4, 5, 6, 7, 8, 9, 10, 11, 13, 15, 17, 19, 23, 27, 31, 35, 43, 51, \
498 59, 67, 83, 99, 115, 131, 163, 195, 227, 258, 0, 0}; \
499 static const cab_UWORD Zipcplext[] = /* Extra bits for literal codes 257..285 */ \
500 { 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 2, 2, 2, 2, 3, 3, 3, 3, 4, 4, 4, \
501 4, 5, 5, 5, 5, 0, 99, 99}; /* 99==invalid */ \
502 static const cab_UWORD Zipcpdist[] = /* Copy offsets for distance codes 0..29 */ \
503 { 1, 2, 3, 4, 5, 7, 9, 13, 17, 25, 33, 49, 65, 97, 129, 193, 257, 385, \
504 513, 769, 1025, 1537, 2049, 3073, 4097, 6145, 8193, 12289, 16385, 24577}; \
505 static const cab_UWORD Zipcpdext[] = /* Extra bits for distance codes */ \
506 { 0, 0, 0, 0, 1, 1, 2, 2, 3, 3, 4, 4, 5, 5, 6, 6, 7, 7, 8, 8, 9, 9, 10, \
507 10, 11, 11, 12, 12, 13, 13}; \
508 /* And'ing with Zipmask[n] masks the lower n bits */ \
509 static const cab_UWORD Zipmask[17] = { \
510 0x0000, 0x0001, 0x0003, 0x0007, 0x000f, 0x001f, 0x003f, 0x007f, 0x00ff, \
511 0x01ff, 0x03ff, 0x07ff, 0x0fff, 0x1fff, 0x3fff, 0x7fff, 0xffff \
514 /* SESSION Operation */
515 #define EXTRACT_FILLFILELIST 0x00000001
516 #define EXTRACT_EXTRACTFILES 0x00000002
520 struct FILELIST
*next
;
527 struct FILELIST
*FileList
;
530 CHAR Destination
[MAX_PATH
];
531 CHAR CurrentFile
[MAX_PATH
];
532 CHAR Reserved
[MAX_PATH
];
533 struct FILELIST
*FilterList
;
536 #endif /* __WINE_CABINET_H */