Always create a property set for secondary buffers.
[wine] / dlls / cabinet / cabextract.c
1 /*
2  * cabextract.c
3  *
4  * Copyright 2000-2002 Stuart Caie
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  *
20  * Principal author: Stuart Caie <kyzer@4u.net>
21  *
22  * Based on specification documents from Microsoft Corporation
23  * Quantum decompression researched and implemented by Matthew Russoto
24  * Huffman code adapted from unlzx by Dave Tritscher.
25  * InfoZip team's INFLATE implementation adapted to MSZIP by Dirk Stoecker.
26  * Major LZX fixes by Jae Jung.
27  */
28  
29 #include "config.h"
30
31 #include <stdarg.h>
32 #include <stdio.h>
33 #include <stdlib.h>
34
35 #include "windef.h"
36 #include "winbase.h"
37 #include "winerror.h"
38
39 #include "cabinet.h"
40
41 #include "wine/debug.h"
42
43 WINE_DEFAULT_DEBUG_CHANNEL(cabinet);
44
45 THOSE_ZIP_CONSTS;
46
47 /* all the file IO is abstracted into these routines:
48  * cabinet_(open|close|read|seek|skip|getoffset)
49  * file_(open|close|write)
50  */
51
52 /* try to open a cabinet file, returns success */
53 BOOL cabinet_open(struct cabinet *cab)
54 {
55   const char *name = cab->filename;
56   HANDLE fh;
57
58   TRACE("(cab == ^%p)\n", cab);
59
60   if ((fh = CreateFileA( name, GENERIC_READ, FILE_SHARE_READ,
61               NULL, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL )) == INVALID_HANDLE_VALUE) {
62     ERR("Couldn't open %s\n", debugstr_a(name));
63     return FALSE;
64   }
65
66   /* seek to end of file and get the length */
67   if ((cab->filelen = SetFilePointer(fh, 0, NULL, FILE_END)) == INVALID_SET_FILE_POINTER) {
68     if (GetLastError() != NO_ERROR) {
69       ERR("Seek END failed: %s\n", debugstr_a(name));
70       CloseHandle(fh);
71       return FALSE;
72     }
73   }
74
75   /* return to the start of the file */
76   if (SetFilePointer(fh, 0, NULL, FILE_BEGIN) == INVALID_SET_FILE_POINTER) {
77     ERR("Seek BEGIN failed: %s\n", debugstr_a(name));
78     CloseHandle(fh);
79     return FALSE;
80   }
81
82   cab->fh = fh;
83   return TRUE;
84 }
85
86 /*******************************************************************
87  * cabinet_close (internal)
88  *
89  * close the file handle in a struct cabinet.
90  */
91 void cabinet_close(struct cabinet *cab) {
92   TRACE("(cab == ^%p)\n", cab);
93   if (cab->fh) CloseHandle(cab->fh);
94   cab->fh = 0;
95 }
96
97 /*******************************************************
98  * ensure_filepath2 (internal)
99  */
100 BOOL ensure_filepath2(char *path) {
101   BOOL ret = TRUE;
102   int len;
103   char *new_path;
104
105   new_path = HeapAlloc(GetProcessHeap(), 0, (strlen(path) + 1));
106   strcpy(new_path, path);
107
108   while((len = strlen(new_path)) && new_path[len - 1] == '\\')
109     new_path[len - 1] = 0;
110
111   TRACE("About to try to create directory %s\n", debugstr_a(new_path));
112   while(!CreateDirectoryA(new_path, NULL)) {
113     char *slash;
114     DWORD last_error = GetLastError();
115
116     if(last_error == ERROR_ALREADY_EXISTS)
117       break;
118
119     if(last_error != ERROR_PATH_NOT_FOUND) {
120       ret = FALSE;
121       break;
122     }
123
124     if(!(slash = strrchr(new_path, '\\'))) {
125       ret = FALSE;
126       break;
127     }
128
129     len = slash - new_path;
130     new_path[len] = 0;
131     if(! ensure_filepath2(new_path)) {
132       ret = FALSE;
133       break;
134     }
135     new_path[len] = '\\';
136     TRACE("New path in next iteration: %s\n", debugstr_a(new_path));
137   }
138
139   HeapFree(GetProcessHeap(), 0, new_path);
140   return ret;
141 }
142
143
144 /**********************************************************************
145  * ensure_filepath (internal)
146  *
147  * ensure_filepath("a\b\c\d.txt") ensures a, a\b and a\b\c exist as dirs
148  */
149 BOOL ensure_filepath(char *path) {
150   char new_path[MAX_PATH];
151   int len, i, lastslashpos = -1;
152
153   TRACE("(path == %s)\n", debugstr_a(path));
154
155   strcpy(new_path, path); 
156   /* remove trailing slashes (shouldn't need to but wth...) */
157   while ((len = strlen(new_path)) && new_path[len - 1] == '\\')
158     new_path[len - 1] = 0;
159   /* find the position of the last '\\' */
160   for (i=0; i<MAX_PATH; i++) {
161     if (new_path[i] == 0) break; 
162     if (new_path[i] == '\\')
163       lastslashpos = i;
164   }
165   if (lastslashpos > 0) {
166     new_path[lastslashpos] = 0;
167     /* may be trailing slashes but ensure_filepath2 will chop them */
168     return ensure_filepath2(new_path);
169   } else
170     return TRUE; /* ? */
171 }
172
173 /*******************************************************************
174  * file_open (internal)
175  *
176  * opens a file for output, returns success
177  */
178 BOOL file_open(struct cab_file *fi, BOOL lower, LPCSTR dir)
179 {
180   char c, *d, *name;
181   BOOL ok = FALSE;
182   const char *s;
183
184   TRACE("(fi == ^%p, lower == %s, dir == %s)\n", fi, lower ? "TRUE" : "FALSE", debugstr_a(dir));
185
186   if (!(name = malloc(strlen(fi->filename) + (dir ? strlen(dir) : 0) + 2))) {
187     ERR("out of memory!\n");
188     return FALSE;
189   }
190   
191   /* start with blank name */
192   *name = 0;
193
194   /* add output directory if needed */
195   if (dir) {
196     strcpy(name, dir);
197     strcat(name, "\\");
198   }
199
200   /* remove leading slashes */
201   s = (char *) fi->filename;
202   while (*s == '\\') s++;
203
204   /* copy from fi->filename to new name.
205    * lowercases characters if needed.
206    */
207   d = &name[strlen(name)];
208   do {
209     c = *s++;
210     *d++ = (lower ? tolower((unsigned char) c) : c);
211   } while (c);
212
213   /* create directories if needed, attempt to write file */
214   if (ensure_filepath(name)) {
215     fi->fh = CreateFileA(name, GENERIC_WRITE, 0, NULL,
216                          CREATE_ALWAYS, FILE_ATTRIBUTE_NORMAL, 0);
217     if (fi->fh != INVALID_HANDLE_VALUE)
218       ok = TRUE;
219     else {
220       ERR("CreateFileA returned INVALID_HANDLE_VALUE\n");
221       fi->fh = 0;
222     }
223   } else 
224     ERR("Couldn't ensure filepath for %s\n", debugstr_a(name));
225
226   if (!ok) {
227     ERR("Couldn't open file %s for writing\n", debugstr_a(name));
228   }
229
230   /* as full filename is no longer needed, free it */
231   free(name);
232
233   return ok;
234 }
235
236 /********************************************************
237  * close_file (internal)
238  *
239  * closes a completed file
240  */
241 void file_close(struct cab_file *fi)
242 {
243   TRACE("(fi == ^%p)\n", fi);
244
245   if (fi->fh) {
246     CloseHandle(fi->fh);
247   }
248   fi->fh = 0;
249 }
250
251 /******************************************************************
252  * file_write (internal)
253  *
254  * writes from buf to a file specified as a cab_file struct.
255  * returns success/failure
256  */
257 BOOL file_write(struct cab_file *fi, cab_UBYTE *buf, cab_off_t length)
258 {
259   DWORD bytes_written;
260
261   TRACE("(fi == ^%p, buf == ^%p, length == %u)\n", fi, buf, length);
262
263   if ((!WriteFile( fi->fh, (LPCVOID) buf, length, &bytes_written, FALSE) ||
264       (bytes_written != length))) {
265     ERR("Error writing file: %s\n", debugstr_a(fi->filename));
266     return FALSE;
267   }
268   return TRUE;
269 }
270
271
272 /*******************************************************************
273  * cabinet_skip (internal)
274  *
275  * advance the file pointer associated with the cab structure
276  * by distance bytes
277  */
278 void cabinet_skip(struct cabinet *cab, cab_off_t distance)
279 {
280   TRACE("(cab == ^%p, distance == %u)\n", cab, distance);
281   if (SetFilePointer(cab->fh, distance, NULL, FILE_CURRENT) == INVALID_SET_FILE_POINTER) {
282     if (distance != INVALID_SET_FILE_POINTER)
283       ERR("%s\n", debugstr_a(cab->filename));
284   }
285 }
286
287 /*******************************************************************
288  * cabinet_seek (internal)
289  *
290  * seek to the specified absolute offset in a cab
291  */
292 void cabinet_seek(struct cabinet *cab, cab_off_t offset) {
293   TRACE("(cab == ^%p, offset == %u)\n", cab, offset);
294   if (SetFilePointer(cab->fh, offset, NULL, FILE_BEGIN) != offset)
295     ERR("%s seek failure\n", debugstr_a(cab->filename));
296 }
297
298 /*******************************************************************
299  * cabinet_getoffset (internal)
300  *
301  * returns the file pointer position of a cab
302  */
303 cab_off_t cabinet_getoffset(struct cabinet *cab) 
304 {
305   return SetFilePointer(cab->fh, 0, NULL, FILE_CURRENT);
306 }
307
308 /*******************************************************************
309  * cabinet_read (internal)
310  *
311  * read data from a cabinet, returns success
312  */
313 BOOL cabinet_read(struct cabinet *cab, cab_UBYTE *buf, cab_off_t length)
314 {
315   DWORD bytes_read;
316   cab_off_t avail = cab->filelen - cabinet_getoffset(cab);
317
318   TRACE("(cab == ^%p, buf == ^%p, length == %u)\n", cab, buf, length);
319
320   if (length > avail) {
321     WARN("%s: WARNING; cabinet is truncated\n", debugstr_a(cab->filename));
322     length = avail;
323   }
324
325   if (! ReadFile( cab->fh, (LPVOID) buf, length, &bytes_read, NULL )) {
326     ERR("%s read error\n", debugstr_a(cab->filename));
327     return FALSE;
328   } else if (bytes_read != length) {
329     ERR("%s read size mismatch\n", debugstr_a(cab->filename));
330     return FALSE;
331   }
332
333   return TRUE;
334 }
335
336 /**********************************************************************
337  * cabinet_read_string (internal)
338  *
339  * allocate and read an aribitrarily long string from the cabinet
340  */
341 char *cabinet_read_string(struct cabinet *cab)
342 {
343   cab_off_t len=256, base = cabinet_getoffset(cab), maxlen = cab->filelen - base;
344   BOOL ok = FALSE;
345   unsigned int i;
346   cab_UBYTE *buf = NULL;
347
348   TRACE("(cab == ^%p)\n", cab);
349
350   do {
351     if (len > maxlen) len = maxlen;
352     if (!(buf = realloc(buf, (size_t) len))) break;
353     if (!cabinet_read(cab, buf, (size_t) len)) break;
354
355     /* search for a null terminator in what we've just read */
356     for (i=0; i < len; i++) {
357       if (!buf[i]) {ok=TRUE; break;}
358     }
359
360     if (!ok) {
361       if (len == maxlen) {
362         ERR("%s: WARNING; cabinet is truncated\n", debugstr_a(cab->filename));
363         break;
364       }
365       len += 256;
366       cabinet_seek(cab, base);
367     }
368   } while (!ok);
369
370   if (!ok) {
371     if (buf)
372       free(buf);
373     else
374       ERR("out of memory!\n");
375     return NULL;
376   }
377
378   /* otherwise, set the stream to just after the string and return */
379   cabinet_seek(cab, base + ((cab_off_t) strlen((char *) buf)) + 1);
380
381   return (char *) buf;
382 }
383
384 /******************************************************************
385  * cabinet_read_entries (internal)
386  *
387  * reads the header and all folder and file entries in this cabinet
388  */
389 BOOL cabinet_read_entries(struct cabinet *cab)
390 {
391   int num_folders, num_files, header_resv, folder_resv = 0, i;
392   struct cab_folder *fol, *linkfol = NULL;
393   struct cab_file *file, *linkfile = NULL;
394   cab_off_t base_offset;
395   cab_UBYTE buf[64];
396
397   TRACE("(cab == ^%p)\n", cab);
398
399   /* read in the CFHEADER */
400   base_offset = cabinet_getoffset(cab);
401   if (!cabinet_read(cab, buf, cfhead_SIZEOF)) {
402     return FALSE;
403   }
404   
405   /* check basic MSCF signature */
406   if (EndGetI32(buf+cfhead_Signature) != 0x4643534d) {
407     ERR("%s: not a Microsoft cabinet file\n", debugstr_a(cab->filename));
408     return FALSE;
409   }
410
411   /* get the number of folders */
412   num_folders = EndGetI16(buf+cfhead_NumFolders);
413   if (num_folders == 0) {
414     ERR("%s: no folders in cabinet\n", debugstr_a(cab->filename));
415     return FALSE;
416   }
417
418   /* get the number of files */
419   num_files = EndGetI16(buf+cfhead_NumFiles);
420   if (num_files == 0) {
421     ERR("%s: no files in cabinet\n", debugstr_a(cab->filename));
422     return FALSE;
423   }
424
425   /* just check the header revision */
426   if ((buf[cfhead_MajorVersion] > 1) ||
427       (buf[cfhead_MajorVersion] == 1 && buf[cfhead_MinorVersion] > 3))
428   {
429     WARN("%s: WARNING; cabinet format version > 1.3\n", debugstr_a(cab->filename));
430   }
431
432   /* read the reserved-sizes part of header, if present */
433   cab->flags = EndGetI16(buf+cfhead_Flags);
434   if (cab->flags & cfheadRESERVE_PRESENT) {
435     if (!cabinet_read(cab, buf, cfheadext_SIZEOF)) return FALSE;
436     header_resv     = EndGetI16(buf+cfheadext_HeaderReserved);
437     folder_resv     = buf[cfheadext_FolderReserved];
438     cab->block_resv = buf[cfheadext_DataReserved];
439
440     if (header_resv > 60000) {
441       WARN("%s: WARNING; header reserved space > 60000\n", debugstr_a(cab->filename));
442     }
443
444     /* skip the reserved header */
445     if (header_resv) 
446       if (SetFilePointer(cab->fh, (cab_off_t) header_resv, NULL, FILE_CURRENT) == INVALID_SET_FILE_POINTER)
447         ERR("seek failure: %s\n", debugstr_a(cab->filename));
448   }
449
450   if (cab->flags & cfheadPREV_CABINET) {
451     cab->prevname = cabinet_read_string(cab);
452     if (!cab->prevname) return FALSE;
453     cab->previnfo = cabinet_read_string(cab);
454   }
455
456   if (cab->flags & cfheadNEXT_CABINET) {
457     cab->nextname = cabinet_read_string(cab);
458     if (!cab->nextname) return FALSE;
459     cab->nextinfo = cabinet_read_string(cab);
460   }
461
462   /* read folders */
463   for (i = 0; i < num_folders; i++) {
464     if (!cabinet_read(cab, buf, cffold_SIZEOF)) return FALSE;
465     if (folder_resv) cabinet_skip(cab, folder_resv);
466
467     fol = (struct cab_folder *) calloc(1, sizeof(struct cab_folder));
468     if (!fol) {
469       ERR("out of memory!\n");
470       return FALSE;
471     }
472
473     fol->cab[0]     = cab;
474     fol->offset[0]  = base_offset + (cab_off_t) EndGetI32(buf+cffold_DataOffset);
475     fol->num_blocks = EndGetI16(buf+cffold_NumBlocks);
476     fol->comp_type  = EndGetI16(buf+cffold_CompType);
477
478     if (!linkfol) 
479       cab->folders = fol; 
480     else 
481       linkfol->next = fol;
482
483     linkfol = fol;
484   }
485
486   /* read files */
487   for (i = 0; i < num_files; i++) {
488     if (!cabinet_read(cab, buf, cffile_SIZEOF))
489       return FALSE;
490
491     file = (struct cab_file *) calloc(1, sizeof(struct cab_file));
492     if (!file) { 
493       ERR("out of memory!\n"); 
494       return FALSE;
495     }
496       
497     file->length   = EndGetI32(buf+cffile_UncompressedSize);
498     file->offset   = EndGetI32(buf+cffile_FolderOffset);
499     file->index    = EndGetI16(buf+cffile_FolderIndex);
500     file->time     = EndGetI16(buf+cffile_Time);
501     file->date     = EndGetI16(buf+cffile_Date);
502     file->attribs  = EndGetI16(buf+cffile_Attribs);
503     file->filename = cabinet_read_string(cab);
504
505     if (!file->filename) {
506       free(file);
507       return FALSE;
508     }
509
510     if (!linkfile) 
511       cab->files = file;
512     else 
513       linkfile->next = file;
514
515     linkfile = file;
516   }
517   return TRUE;
518 }
519
520 /***********************************************************
521  * load_cab_offset (internal)
522  *
523  * validates and reads file entries from a cabinet at offset [offset] in
524  * file [name]. Returns a cabinet structure if successful, or NULL
525  * otherwise.
526  */
527 struct cabinet *load_cab_offset(LPCSTR name, cab_off_t offset)
528 {
529   struct cabinet *cab = (struct cabinet *) calloc(1, sizeof(struct cabinet));
530   int ok;
531
532   TRACE("(name == %s, offset == %u)\n", debugstr_a(name), offset);
533
534   if (!cab) return NULL;
535
536   cab->filename = name;
537   if ((ok = cabinet_open(cab))) {
538     cabinet_seek(cab, offset);
539     ok = cabinet_read_entries(cab);
540     cabinet_close(cab);
541   }
542
543   if (ok) return cab;
544   free(cab);
545   return NULL;
546 }
547
548 /* MSZIP decruncher */
549
550 /* Dirk Stoecker wrote the ZIP decoder, based on the InfoZip deflate code */
551
552 /********************************************************
553  * Ziphuft_free (internal)
554  */
555 void Ziphuft_free(struct Ziphuft *t)
556 {
557   register struct Ziphuft *p, *q;
558
559   /* Go through linked list, freeing from the allocated (t[-1]) address. */
560   p = t;
561   while (p != (struct Ziphuft *)NULL)
562   {
563     q = (--p)->v.t;
564     free(p);
565     p = q;
566   } 
567 }
568
569 /*********************************************************
570  * Ziphuft_build (internal)
571  */
572 cab_LONG Ziphuft_build(cab_ULONG *b, cab_ULONG n, cab_ULONG s, cab_UWORD *d, cab_UWORD *e,
573 struct Ziphuft **t, cab_LONG *m, cab_decomp_state *decomp_state)
574 {
575   cab_ULONG a;                          /* counter for codes of length k */
576   cab_ULONG el;                         /* length of EOB code (value 256) */
577   cab_ULONG f;                          /* i repeats in table every f entries */
578   cab_LONG g;                           /* maximum code length */
579   cab_LONG h;                           /* table level */
580   register cab_ULONG i;                 /* counter, current code */
581   register cab_ULONG j;                 /* counter */
582   register cab_LONG k;                  /* number of bits in current code */
583   cab_LONG *l;                          /* stack of bits per table */
584   register cab_ULONG *p;                /* pointer into ZIP(c)[],ZIP(b)[],ZIP(v)[] */
585   register struct Ziphuft *q;           /* points to current table */
586   struct Ziphuft r;                     /* table entry for structure assignment */
587   register cab_LONG w;                  /* bits before this table == (l * h) */
588   cab_ULONG *xp;                        /* pointer into x */
589   cab_LONG y;                           /* number of dummy codes added */
590   cab_ULONG z;                          /* number of entries in current table */
591
592   l = ZIP(lx)+1;
593
594   /* Generate counts for each bit length */
595   el = n > 256 ? b[256] : ZIPBMAX; /* set length of EOB code, if any */
596
597   for(i = 0; i < ZIPBMAX+1; ++i)
598     ZIP(c)[i] = 0;
599   p = b;  i = n;
600   do
601   {
602     ZIP(c)[*p]++; p++;               /* assume all entries <= ZIPBMAX */
603   } while (--i);
604   if (ZIP(c)[0] == n)                /* null input--all zero length codes */
605   {
606     *t = (struct Ziphuft *)NULL;
607     *m = 0;
608     return 0;
609   }
610
611   /* Find minimum and maximum length, bound *m by those */
612   for (j = 1; j <= ZIPBMAX; j++)
613     if (ZIP(c)[j])
614       break;
615   k = j;                        /* minimum code length */
616   if ((cab_ULONG)*m < j)
617     *m = j;
618   for (i = ZIPBMAX; i; i--)
619     if (ZIP(c)[i])
620       break;
621   g = i;                        /* maximum code length */
622   if ((cab_ULONG)*m > i)
623     *m = i;
624
625   /* Adjust last length count to fill out codes, if needed */
626   for (y = 1 << j; j < i; j++, y <<= 1)
627     if ((y -= ZIP(c)[j]) < 0)
628       return 2;                 /* bad input: more codes than bits */
629   if ((y -= ZIP(c)[i]) < 0)
630     return 2;
631   ZIP(c)[i] += y;
632
633   /* Generate starting offsets LONGo the value table for each length */
634   ZIP(x)[1] = j = 0;
635   p = ZIP(c) + 1;  xp = ZIP(x) + 2;
636   while (--i)
637   {                 /* note that i == g from above */
638     *xp++ = (j += *p++);
639   }
640
641   /* Make a table of values in order of bit lengths */
642   p = b;  i = 0;
643   do{
644     if ((j = *p++) != 0)
645       ZIP(v)[ZIP(x)[j]++] = i;
646   } while (++i < n);
647
648
649   /* Generate the Huffman codes and for each, make the table entries */
650   ZIP(x)[0] = i = 0;                 /* first Huffman code is zero */
651   p = ZIP(v);                        /* grab values in bit order */
652   h = -1;                       /* no tables yet--level -1 */
653   w = l[-1] = 0;                /* no bits decoded yet */
654   ZIP(u)[0] = (struct Ziphuft *)NULL;   /* just to keep compilers happy */
655   q = (struct Ziphuft *)NULL;      /* ditto */
656   z = 0;                        /* ditto */
657
658   /* go through the bit lengths (k already is bits in shortest code) */
659   for (; k <= g; k++)
660   {
661     a = ZIP(c)[k];
662     while (a--)
663     {
664       /* here i is the Huffman code of length k bits for value *p */
665       /* make tables up to required level */
666       while (k > w + l[h])
667       {
668         w += l[h++];            /* add bits already decoded */
669
670         /* compute minimum size table less than or equal to *m bits */
671         z = (z = g - w) > (cab_ULONG)*m ? *m : z;        /* upper limit */
672         if ((f = 1 << (j = k - w)) > a + 1)     /* try a k-w bit table */
673         {                       /* too few codes for k-w bit table */
674           f -= a + 1;           /* deduct codes from patterns left */
675           xp = ZIP(c) + k;
676           while (++j < z)       /* try smaller tables up to z bits */
677           {
678             if ((f <<= 1) <= *++xp)
679               break;            /* enough codes to use up j bits */
680             f -= *xp;           /* else deduct codes from patterns */
681           }
682         }
683         if ((cab_ULONG)w + j > el && (cab_ULONG)w < el)
684           j = el - w;           /* make EOB code end at table */
685         z = 1 << j;             /* table entries for j-bit table */
686         l[h] = j;               /* set table size in stack */
687
688         /* allocate and link in new table */
689         if (!(q = (struct Ziphuft *) malloc((z + 1)*sizeof(struct Ziphuft))))
690         {
691           if(h)
692             Ziphuft_free(ZIP(u)[0]);
693           return 3;             /* not enough memory */
694         }
695         *t = q + 1;             /* link to list for Ziphuft_free() */
696         *(t = &(q->v.t)) = (struct Ziphuft *)NULL;
697         ZIP(u)[h] = ++q;             /* table starts after link */
698
699         /* connect to last table, if there is one */
700         if (h)
701         {
702           ZIP(x)[h] = i;              /* save pattern for backing up */
703           r.b = (cab_UBYTE)l[h-1];    /* bits to dump before this table */
704           r.e = (cab_UBYTE)(16 + j);  /* bits in this table */
705           r.v.t = q;                  /* pointer to this table */
706           j = (i & ((1 << w) - 1)) >> (w - l[h-1]);
707           ZIP(u)[h-1][j] = r;        /* connect to last table */
708         }
709       }
710
711       /* set up table entry in r */
712       r.b = (cab_UBYTE)(k - w);
713       if (p >= ZIP(v) + n)
714         r.e = 99;               /* out of values--invalid code */
715       else if (*p < s)
716       {
717         r.e = (cab_UBYTE)(*p < 256 ? 16 : 15);    /* 256 is end-of-block code */
718         r.v.n = *p++;           /* simple code is just the value */
719       }
720       else
721       {
722         r.e = (cab_UBYTE)e[*p - s];   /* non-simple--look up in lists */
723         r.v.n = d[*p++ - s];
724       }
725
726       /* fill code-like entries with r */
727       f = 1 << (k - w);
728       for (j = i >> w; j < z; j += f)
729         q[j] = r;
730
731       /* backwards increment the k-bit code i */
732       for (j = 1 << (k - 1); i & j; j >>= 1)
733         i ^= j;
734       i ^= j;
735
736       /* backup over finished tables */
737       while ((i & ((1 << w) - 1)) != ZIP(x)[h])
738         w -= l[--h];            /* don't need to update q */
739
740       free(q);
741     }
742   }
743
744   /* return actual size of base table */
745   *m = l[0];
746
747   /* Return true (1) if we were given an incomplete table */
748   return y != 0 && g != 1;
749 }
750
751 /*********************************************************
752  * Zipinflate_codes (internal)
753  */
754 cab_LONG Zipinflate_codes(struct Ziphuft *tl, struct Ziphuft *td,
755   cab_LONG bl, cab_LONG bd, cab_decomp_state *decomp_state)
756 {
757   register cab_ULONG e;  /* table entry flag/number of extra bits */
758   cab_ULONG n, d;        /* length and index for copy */
759   cab_ULONG w;           /* current window position */
760   struct Ziphuft *t;     /* pointer to table entry */
761   cab_ULONG ml, md;      /* masks for bl and bd bits */
762   register cab_ULONG b;  /* bit buffer */
763   register cab_ULONG k;  /* number of bits in bit buffer */
764
765   /* make local copies of globals */
766   b = ZIP(bb);                       /* initialize bit buffer */
767   k = ZIP(bk);
768   w = ZIP(window_posn);                       /* initialize window position */
769
770   /* inflate the coded data */
771   ml = Zipmask[bl];             /* precompute masks for speed */
772   md = Zipmask[bd];
773
774   for(;;)
775   {
776     ZIPNEEDBITS((cab_ULONG)bl)
777     if((e = (t = tl + ((cab_ULONG)b & ml))->e) > 16)
778       do
779       {
780         if (e == 99)
781           return 1;
782         ZIPDUMPBITS(t->b)
783         e -= 16;
784         ZIPNEEDBITS(e)
785       } while ((e = (t = t->v.t + ((cab_ULONG)b & Zipmask[e]))->e) > 16);
786     ZIPDUMPBITS(t->b)
787     if (e == 16)                /* then it's a literal */
788       CAB(outbuf)[w++] = (cab_UBYTE)t->v.n;
789     else                        /* it's an EOB or a length */
790     {
791       /* exit if end of block */
792       if(e == 15)
793         break;
794
795       /* get length of block to copy */
796       ZIPNEEDBITS(e)
797       n = t->v.n + ((cab_ULONG)b & Zipmask[e]);
798       ZIPDUMPBITS(e);
799
800       /* decode distance of block to copy */
801       ZIPNEEDBITS((cab_ULONG)bd)
802       if ((e = (t = td + ((cab_ULONG)b & md))->e) > 16)
803         do {
804           if (e == 99)
805             return 1;
806           ZIPDUMPBITS(t->b)
807           e -= 16;
808           ZIPNEEDBITS(e)
809         } while ((e = (t = t->v.t + ((cab_ULONG)b & Zipmask[e]))->e) > 16);
810       ZIPDUMPBITS(t->b)
811       ZIPNEEDBITS(e)
812       d = w - t->v.n - ((cab_ULONG)b & Zipmask[e]);
813       ZIPDUMPBITS(e)
814       do
815       {
816         n -= (e = (e = ZIPWSIZE - ((d &= ZIPWSIZE-1) > w ? d : w)) > n ?n:e);
817         do
818         {
819           CAB(outbuf)[w++] = CAB(outbuf)[d++];
820         } while (--e);
821       } while (n);
822     }
823   }
824
825   /* restore the globals from the locals */
826   ZIP(window_posn) = w;              /* restore global window pointer */
827   ZIP(bb) = b;                       /* restore global bit buffer */
828   ZIP(bk) = k;
829
830   /* done */
831   return 0;
832 }
833
834 /***********************************************************
835  * Zipinflate_stored (internal)
836  */
837 cab_LONG Zipinflate_stored(cab_decomp_state *decomp_state)
838 /* "decompress" an inflated type 0 (stored) block. */
839 {
840   cab_ULONG n;           /* number of bytes in block */
841   cab_ULONG w;           /* current window position */
842   register cab_ULONG b;  /* bit buffer */
843   register cab_ULONG k;  /* number of bits in bit buffer */
844
845   /* make local copies of globals */
846   b = ZIP(bb);                       /* initialize bit buffer */
847   k = ZIP(bk);
848   w = ZIP(window_posn);              /* initialize window position */
849
850   /* go to byte boundary */
851   n = k & 7;
852   ZIPDUMPBITS(n);
853
854   /* get the length and its complement */
855   ZIPNEEDBITS(16)
856   n = ((cab_ULONG)b & 0xffff);
857   ZIPDUMPBITS(16)
858   ZIPNEEDBITS(16)
859   if (n != (cab_ULONG)((~b) & 0xffff))
860     return 1;                   /* error in compressed data */
861   ZIPDUMPBITS(16)
862
863   /* read and output the compressed data */
864   while(n--)
865   {
866     ZIPNEEDBITS(8)
867     CAB(outbuf)[w++] = (cab_UBYTE)b;
868     ZIPDUMPBITS(8)
869   }
870
871   /* restore the globals from the locals */
872   ZIP(window_posn) = w;              /* restore global window pointer */
873   ZIP(bb) = b;                       /* restore global bit buffer */
874   ZIP(bk) = k;
875   return 0;
876 }
877
878 /******************************************************
879  * Zipinflate_fixed (internal)
880  */
881 cab_LONG Zipinflate_fixed(cab_decomp_state *decomp_state)
882 {
883   struct Ziphuft *fixed_tl;
884   struct Ziphuft *fixed_td;
885   cab_LONG fixed_bl, fixed_bd;
886   cab_LONG i;                /* temporary variable */
887   cab_ULONG *l;
888
889   l = ZIP(ll);
890
891   /* literal table */
892   for(i = 0; i < 144; i++)
893     l[i] = 8;
894   for(; i < 256; i++)
895     l[i] = 9;
896   for(; i < 280; i++)
897     l[i] = 7;
898   for(; i < 288; i++)          /* make a complete, but wrong code set */
899     l[i] = 8;
900   fixed_bl = 7;
901   if((i = Ziphuft_build(l, 288, 257, (cab_UWORD *) Zipcplens,
902   (cab_UWORD *) Zipcplext, &fixed_tl, &fixed_bl, decomp_state)))
903     return i;
904
905   /* distance table */
906   for(i = 0; i < 30; i++)      /* make an incomplete code set */
907     l[i] = 5;
908   fixed_bd = 5;
909   if((i = Ziphuft_build(l, 30, 0, (cab_UWORD *) Zipcpdist, (cab_UWORD *) Zipcpdext,
910   &fixed_td, &fixed_bd, decomp_state)) > 1)
911   {
912     Ziphuft_free(fixed_tl);
913     return i;
914   }
915
916   /* decompress until an end-of-block code */
917   i = Zipinflate_codes(fixed_tl, fixed_td, fixed_bl, fixed_bd, decomp_state);
918
919   Ziphuft_free(fixed_td);
920   Ziphuft_free(fixed_tl);
921   return i;
922 }
923
924 /**************************************************************
925  * Zipinflate_dynamic (internal)
926  */
927 cab_LONG Zipinflate_dynamic(cab_decomp_state *decomp_state)
928  /* decompress an inflated type 2 (dynamic Huffman codes) block. */
929 {
930   cab_LONG i;           /* temporary variables */
931   cab_ULONG j;
932   cab_ULONG *ll;
933   cab_ULONG l;                  /* last length */
934   cab_ULONG m;                  /* mask for bit lengths table */
935   cab_ULONG n;                  /* number of lengths to get */
936   struct Ziphuft *tl;           /* literal/length code table */
937   struct Ziphuft *td;           /* distance code table */
938   cab_LONG bl;                  /* lookup bits for tl */
939   cab_LONG bd;                  /* lookup bits for td */
940   cab_ULONG nb;                 /* number of bit length codes */
941   cab_ULONG nl;                 /* number of literal/length codes */
942   cab_ULONG nd;                 /* number of distance codes */
943   register cab_ULONG b;         /* bit buffer */
944   register cab_ULONG k;         /* number of bits in bit buffer */
945
946   /* make local bit buffer */
947   b = ZIP(bb);
948   k = ZIP(bk);
949   ll = ZIP(ll);
950
951   /* read in table lengths */
952   ZIPNEEDBITS(5)
953   nl = 257 + ((cab_ULONG)b & 0x1f);      /* number of literal/length codes */
954   ZIPDUMPBITS(5)
955   ZIPNEEDBITS(5)
956   nd = 1 + ((cab_ULONG)b & 0x1f);        /* number of distance codes */
957   ZIPDUMPBITS(5)
958   ZIPNEEDBITS(4)
959   nb = 4 + ((cab_ULONG)b & 0xf);         /* number of bit length codes */
960   ZIPDUMPBITS(4)
961   if(nl > 288 || nd > 32)
962     return 1;                   /* bad lengths */
963
964   /* read in bit-length-code lengths */
965   for(j = 0; j < nb; j++)
966   {
967     ZIPNEEDBITS(3)
968     ll[Zipborder[j]] = (cab_ULONG)b & 7;
969     ZIPDUMPBITS(3)
970   }
971   for(; j < 19; j++)
972     ll[Zipborder[j]] = 0;
973
974   /* build decoding table for trees--single level, 7 bit lookup */
975   bl = 7;
976   if((i = Ziphuft_build(ll, 19, 19, NULL, NULL, &tl, &bl, decomp_state)) != 0)
977   {
978     if(i == 1)
979       Ziphuft_free(tl);
980     return i;                   /* incomplete code set */
981   }
982
983   /* read in literal and distance code lengths */
984   n = nl + nd;
985   m = Zipmask[bl];
986   i = l = 0;
987   while((cab_ULONG)i < n)
988   {
989     ZIPNEEDBITS((cab_ULONG)bl)
990     j = (td = tl + ((cab_ULONG)b & m))->b;
991     ZIPDUMPBITS(j)
992     j = td->v.n;
993     if (j < 16)                 /* length of code in bits (0..15) */
994       ll[i++] = l = j;          /* save last length in l */
995     else if (j == 16)           /* repeat last length 3 to 6 times */
996     {
997       ZIPNEEDBITS(2)
998       j = 3 + ((cab_ULONG)b & 3);
999       ZIPDUMPBITS(2)
1000       if((cab_ULONG)i + j > n)
1001         return 1;
1002       while (j--)
1003         ll[i++] = l;
1004     }
1005     else if (j == 17)           /* 3 to 10 zero length codes */
1006     {
1007       ZIPNEEDBITS(3)
1008       j = 3 + ((cab_ULONG)b & 7);
1009       ZIPDUMPBITS(3)
1010       if ((cab_ULONG)i + j > n)
1011         return 1;
1012       while (j--)
1013         ll[i++] = 0;
1014       l = 0;
1015     }
1016     else                        /* j == 18: 11 to 138 zero length codes */
1017     {
1018       ZIPNEEDBITS(7)
1019       j = 11 + ((cab_ULONG)b & 0x7f);
1020       ZIPDUMPBITS(7)
1021       if ((cab_ULONG)i + j > n)
1022         return 1;
1023       while (j--)
1024         ll[i++] = 0;
1025       l = 0;
1026     }
1027   }
1028
1029   /* free decoding table for trees */
1030   Ziphuft_free(tl);
1031
1032   /* restore the global bit buffer */
1033   ZIP(bb) = b;
1034   ZIP(bk) = k;
1035
1036   /* build the decoding tables for literal/length and distance codes */
1037   bl = ZIPLBITS;
1038   if((i = Ziphuft_build(ll, nl, 257, (cab_UWORD *) Zipcplens, (cab_UWORD *) Zipcplext,
1039                         &tl, &bl, decomp_state)) != 0)
1040   {
1041     if(i == 1)
1042       Ziphuft_free(tl);
1043     return i;                   /* incomplete code set */
1044   }
1045   bd = ZIPDBITS;
1046   Ziphuft_build(ll + nl, nd, 0, (cab_UWORD *) Zipcpdist, (cab_UWORD *) Zipcpdext,
1047                 &td, &bd, decomp_state);
1048
1049   /* decompress until an end-of-block code */
1050   if(Zipinflate_codes(tl, td, bl, bd, decomp_state))
1051     return 1;
1052
1053   /* free the decoding tables, return */
1054   Ziphuft_free(tl);
1055   Ziphuft_free(td);
1056   return 0;
1057 }
1058
1059 /*****************************************************
1060  * Zipinflate_block (internal)
1061  */
1062 cab_LONG Zipinflate_block(cab_LONG *e, cab_decomp_state *decomp_state) /* e == last block flag */
1063 { /* decompress an inflated block */
1064   cab_ULONG t;                  /* block type */
1065   register cab_ULONG b;     /* bit buffer */
1066   register cab_ULONG k;     /* number of bits in bit buffer */
1067
1068   /* make local bit buffer */
1069   b = ZIP(bb);
1070   k = ZIP(bk);
1071
1072   /* read in last block bit */
1073   ZIPNEEDBITS(1)
1074   *e = (cab_LONG)b & 1;
1075   ZIPDUMPBITS(1)
1076
1077   /* read in block type */
1078   ZIPNEEDBITS(2)
1079   t = (cab_ULONG)b & 3;
1080   ZIPDUMPBITS(2)
1081
1082   /* restore the global bit buffer */
1083   ZIP(bb) = b;
1084   ZIP(bk) = k;
1085
1086   /* inflate that block type */
1087   if(t == 2)
1088     return Zipinflate_dynamic(decomp_state);
1089   if(t == 0)
1090     return Zipinflate_stored(decomp_state);
1091   if(t == 1)
1092     return Zipinflate_fixed(decomp_state);
1093   /* bad block type */
1094   return 2;
1095 }
1096
1097 /****************************************************
1098  * ZIPdecompress (internal)
1099  */
1100 int ZIPdecompress(int inlen, int outlen, cab_decomp_state *decomp_state)
1101 {
1102   cab_LONG e;               /* last block flag */
1103
1104   TRACE("(inlen == %d, outlen == %d)\n", inlen, outlen);
1105
1106   ZIP(inpos) = CAB(inbuf);
1107   ZIP(bb) = ZIP(bk) = ZIP(window_posn) = 0;
1108   if(outlen > ZIPWSIZE)
1109     return DECR_DATAFORMAT;
1110
1111   /* CK = Chris Kirmse, official Microsoft purloiner */
1112   if(ZIP(inpos)[0] != 0x43 || ZIP(inpos)[1] != 0x4B)
1113     return DECR_ILLEGALDATA;
1114   ZIP(inpos) += 2;
1115
1116   do
1117   {
1118     if(Zipinflate_block(&e, decomp_state))
1119       return DECR_ILLEGALDATA;
1120   } while(!e);
1121
1122   /* return success */
1123   return DECR_OK;
1124 }
1125
1126 /* Quantum decruncher */
1127
1128 /* This decruncher was researched and implemented by Matthew Russoto. */
1129 /* It has since been tidied up by Stuart Caie */
1130
1131 /******************************************************************
1132  * QTMinitmodel (internal)
1133  *
1134  * Initialise a model which decodes symbols from [s] to [s]+[n]-1
1135  */
1136 void QTMinitmodel(struct QTMmodel *m, struct QTMmodelsym *sym, int n, int s) {
1137   int i;
1138   m->shiftsleft = 4;
1139   m->entries    = n;
1140   m->syms       = sym;
1141   memset(m->tabloc, 0xFF, sizeof(m->tabloc)); /* clear out look-up table */
1142   for (i = 0; i < n; i++) {
1143     m->tabloc[i+s]     = i;   /* set up a look-up entry for symbol */
1144     m->syms[i].sym     = i+s; /* actual symbol */
1145     m->syms[i].cumfreq = n-i; /* current frequency of that symbol */
1146   }
1147   m->syms[n].cumfreq = 0;
1148 }
1149
1150 /******************************************************************
1151  * QTMinit (internal)
1152  */
1153 int QTMinit(int window, int level, cab_decomp_state *decomp_state) {
1154   unsigned int wndsize = 1 << window;
1155   int msz = window * 2, i;
1156   cab_ULONG j;
1157
1158   /* QTM supports window sizes of 2^10 (1Kb) through 2^21 (2Mb) */
1159   /* if a previously allocated window is big enough, keep it    */
1160   if (window < 10 || window > 21) return DECR_DATAFORMAT;
1161   if (QTM(actual_size) < wndsize) {
1162     if (QTM(window)) free(QTM(window));
1163     QTM(window) = NULL;
1164   }
1165   if (!QTM(window)) {
1166     if (!(QTM(window) = malloc(wndsize))) return DECR_NOMEMORY;
1167     QTM(actual_size) = wndsize;
1168   }
1169   QTM(window_size) = wndsize;
1170   QTM(window_posn) = 0;
1171
1172   /* initialise static slot/extrabits tables */
1173   for (i = 0, j = 0; i < 27; i++) {
1174     CAB(q_length_extra)[i] = (i == 26) ? 0 : (i < 2 ? 0 : i - 2) >> 2;
1175     CAB(q_length_base)[i] = j; j += 1 << ((i == 26) ? 5 : CAB(q_length_extra)[i]);
1176   }
1177   for (i = 0, j = 0; i < 42; i++) {
1178     CAB(q_extra_bits)[i] = (i < 2 ? 0 : i-2) >> 1;
1179     CAB(q_position_base)[i] = j; j += 1 << CAB(q_extra_bits)[i];
1180   }
1181
1182   /* initialise arithmetic coding models */
1183
1184   QTMinitmodel(&QTM(model7), &QTM(m7sym)[0], 7, 0);
1185
1186   QTMinitmodel(&QTM(model00), &QTM(m00sym)[0], 0x40, 0x00);
1187   QTMinitmodel(&QTM(model40), &QTM(m40sym)[0], 0x40, 0x40);
1188   QTMinitmodel(&QTM(model80), &QTM(m80sym)[0], 0x40, 0x80);
1189   QTMinitmodel(&QTM(modelC0), &QTM(mC0sym)[0], 0x40, 0xC0);
1190
1191   /* model 4 depends on table size, ranges from 20 to 24  */
1192   QTMinitmodel(&QTM(model4), &QTM(m4sym)[0], (msz < 24) ? msz : 24, 0);
1193   /* model 5 depends on table size, ranges from 20 to 36  */
1194   QTMinitmodel(&QTM(model5), &QTM(m5sym)[0], (msz < 36) ? msz : 36, 0);
1195   /* model 6pos depends on table size, ranges from 20 to 42 */
1196   QTMinitmodel(&QTM(model6pos), &QTM(m6psym)[0], msz, 0);
1197   QTMinitmodel(&QTM(model6len), &QTM(m6lsym)[0], 27, 0);
1198
1199   return DECR_OK;
1200 }
1201
1202 /****************************************************************
1203  * QTMupdatemodel (internal)
1204  */
1205 void QTMupdatemodel(struct QTMmodel *model, int sym) {
1206   struct QTMmodelsym temp;
1207   int i, j;
1208
1209   for (i = 0; i < sym; i++) model->syms[i].cumfreq += 8;
1210
1211   if (model->syms[0].cumfreq > 3800) {
1212     if (--model->shiftsleft) {
1213       for (i = model->entries - 1; i >= 0; i--) {
1214         /* -1, not -2; the 0 entry saves this */
1215         model->syms[i].cumfreq >>= 1;
1216         if (model->syms[i].cumfreq <= model->syms[i+1].cumfreq) {
1217           model->syms[i].cumfreq = model->syms[i+1].cumfreq + 1;
1218         }
1219       }
1220     }
1221     else {
1222       model->shiftsleft = 50;
1223       for (i = 0; i < model->entries ; i++) {
1224         /* no -1, want to include the 0 entry */
1225         /* this converts cumfreqs into frequencies, then shifts right */
1226         model->syms[i].cumfreq -= model->syms[i+1].cumfreq;
1227         model->syms[i].cumfreq++; /* avoid losing things entirely */
1228         model->syms[i].cumfreq >>= 1;
1229       }
1230
1231       /* now sort by frequencies, decreasing order -- this must be an
1232        * inplace selection sort, or a sort with the same (in)stability
1233        * characteristics
1234        */
1235       for (i = 0; i < model->entries - 1; i++) {
1236         for (j = i + 1; j < model->entries; j++) {
1237           if (model->syms[i].cumfreq < model->syms[j].cumfreq) {
1238             temp = model->syms[i];
1239             model->syms[i] = model->syms[j];
1240             model->syms[j] = temp;
1241           }
1242         }
1243       }
1244     
1245       /* then convert frequencies back to cumfreq */
1246       for (i = model->entries - 1; i >= 0; i--) {
1247         model->syms[i].cumfreq += model->syms[i+1].cumfreq;
1248       }
1249       /* then update the other part of the table */
1250       for (i = 0; i < model->entries; i++) {
1251         model->tabloc[model->syms[i].sym] = i;
1252       }
1253     }
1254   }
1255 }
1256
1257 /*******************************************************************
1258  * QTMdecompress (internal)
1259  */
1260 int QTMdecompress(int inlen, int outlen, cab_decomp_state *decomp_state)
1261 {
1262   cab_UBYTE *inpos  = CAB(inbuf);
1263   cab_UBYTE *window = QTM(window);
1264   cab_UBYTE *runsrc, *rundest;
1265
1266   cab_ULONG window_posn = QTM(window_posn);
1267   cab_ULONG window_size = QTM(window_size);
1268
1269   /* used by bitstream macros */
1270   register int bitsleft, bitrun, bitsneed;
1271   register cab_ULONG bitbuf;
1272
1273   /* used by GET_SYMBOL */
1274   cab_ULONG range;
1275   cab_UWORD symf;
1276   int i;
1277
1278   int extra, togo = outlen, match_length = 0, copy_length;
1279   cab_UBYTE selector, sym;
1280   cab_ULONG match_offset = 0;
1281
1282   cab_UWORD H = 0xFFFF, L = 0, C;
1283
1284   TRACE("(inlen == %d, outlen == %d)\n", inlen, outlen);
1285
1286   /* read initial value of C */
1287   Q_INIT_BITSTREAM;
1288   Q_READ_BITS(C, 16);
1289
1290   /* apply 2^x-1 mask */
1291   window_posn &= window_size - 1;
1292   /* runs can't straddle the window wraparound */
1293   if ((window_posn + togo) > window_size) {
1294     TRACE("straddled run\n");
1295     return DECR_DATAFORMAT;
1296   }
1297
1298   while (togo > 0) {
1299     GET_SYMBOL(model7, selector);
1300     switch (selector) {
1301     case 0:
1302       GET_SYMBOL(model00, sym); window[window_posn++] = sym; togo--;
1303       break;
1304     case 1:
1305       GET_SYMBOL(model40, sym); window[window_posn++] = sym; togo--;
1306       break;
1307     case 2:
1308       GET_SYMBOL(model80, sym); window[window_posn++] = sym; togo--;
1309       break;
1310     case 3:
1311       GET_SYMBOL(modelC0, sym); window[window_posn++] = sym; togo--;
1312       break;
1313
1314     case 4:
1315       /* selector 4 = fixed length of 3 */
1316       GET_SYMBOL(model4, sym);
1317       Q_READ_BITS(extra, CAB(q_extra_bits)[sym]);
1318       match_offset = CAB(q_position_base)[sym] + extra + 1;
1319       match_length = 3;
1320       break;
1321
1322     case 5:
1323       /* selector 5 = fixed length of 4 */
1324       GET_SYMBOL(model5, sym);
1325       Q_READ_BITS(extra, CAB(q_extra_bits)[sym]);
1326       match_offset = CAB(q_position_base)[sym] + extra + 1;
1327       match_length = 4;
1328       break;
1329
1330     case 6:
1331       /* selector 6 = variable length */
1332       GET_SYMBOL(model6len, sym);
1333       Q_READ_BITS(extra, CAB(q_length_extra)[sym]);
1334       match_length = CAB(q_length_base)[sym] + extra + 5;
1335       GET_SYMBOL(model6pos, sym);
1336       Q_READ_BITS(extra, CAB(q_extra_bits)[sym]);
1337       match_offset = CAB(q_position_base)[sym] + extra + 1;
1338       break;
1339
1340     default:
1341       TRACE("Selector is bogus\n");
1342       return DECR_ILLEGALDATA;
1343     }
1344
1345     /* if this is a match */
1346     if (selector >= 4) {
1347       rundest = window + window_posn;
1348       togo -= match_length;
1349
1350       /* copy any wrapped around source data */
1351       if (window_posn >= match_offset) {
1352         /* no wrap */
1353         runsrc = rundest - match_offset;
1354       } else {
1355         runsrc = rundest + (window_size - match_offset);
1356         copy_length = match_offset - window_posn;
1357         if (copy_length < match_length) {
1358           match_length -= copy_length;
1359           window_posn += copy_length;
1360           while (copy_length-- > 0) *rundest++ = *runsrc++;
1361           runsrc = window;
1362         }
1363       }
1364       window_posn += match_length;
1365
1366       /* copy match data - no worries about destination wraps */
1367       while (match_length-- > 0) *rundest++ = *runsrc++;
1368     }
1369   } /* while (togo > 0) */
1370
1371   if (togo != 0) {
1372     TRACE("Frame overflow, this_run = %d\n", togo);
1373     return DECR_ILLEGALDATA;
1374   }
1375
1376   memcpy(CAB(outbuf), window + ((!window_posn) ? window_size : window_posn) -
1377     outlen, outlen);
1378
1379   QTM(window_posn) = window_posn;
1380   return DECR_OK;
1381 }
1382
1383 /* LZX decruncher */
1384
1385 /* Microsoft's LZX document and their implementation of the
1386  * com.ms.util.cab Java package do not concur.
1387  *
1388  * In the LZX document, there is a table showing the correlation between
1389  * window size and the number of position slots. It states that the 1MB
1390  * window = 40 slots and the 2MB window = 42 slots. In the implementation,
1391  * 1MB = 42 slots, 2MB = 50 slots. The actual calculation is 'find the
1392  * first slot whose position base is equal to or more than the required
1393  * window size'. This would explain why other tables in the document refer
1394  * to 50 slots rather than 42.
1395  *
1396  * The constant NUM_PRIMARY_LENGTHS used in the decompression pseudocode
1397  * is not defined in the specification.
1398  *
1399  * The LZX document does not state the uncompressed block has an
1400  * uncompressed length field. Where does this length field come from, so
1401  * we can know how large the block is? The implementation has it as the 24
1402  * bits following after the 3 blocktype bits, before the alignment
1403  * padding.
1404  *
1405  * The LZX document states that aligned offset blocks have their aligned
1406  * offset huffman tree AFTER the main and length trees. The implementation
1407  * suggests that the aligned offset tree is BEFORE the main and length
1408  * trees.
1409  *
1410  * The LZX document decoding algorithm states that, in an aligned offset
1411  * block, if an extra_bits value is 1, 2 or 3, then that number of bits
1412  * should be read and the result added to the match offset. This is
1413  * correct for 1 and 2, but not 3, where just a huffman symbol (using the
1414  * aligned tree) should be read.
1415  *
1416  * Regarding the E8 preprocessing, the LZX document states 'No translation
1417  * may be performed on the last 6 bytes of the input block'. This is
1418  * correct.  However, the pseudocode provided checks for the *E8 leader*
1419  * up to the last 6 bytes. If the leader appears between -10 and -7 bytes
1420  * from the end, this would cause the next four bytes to be modified, at
1421  * least one of which would be in the last 6 bytes, which is not allowed
1422  * according to the spec.
1423  *
1424  * The specification states that the huffman trees must always contain at
1425  * least one element. However, many CAB files contain blocks where the
1426  * length tree is completely empty (because there are no matches), and
1427  * this is expected to succeed.
1428  */
1429
1430
1431 /* LZX uses what it calls 'position slots' to represent match offsets.
1432  * What this means is that a small 'position slot' number and a small
1433  * offset from that slot are encoded instead of one large offset for
1434  * every match.
1435  * - lzx_position_base is an index to the position slot bases
1436  * - lzx_extra_bits states how many bits of offset-from-base data is needed.
1437  */
1438
1439 /************************************************************
1440  * LZXinit (internal)
1441  */
1442 int LZXinit(int window, cab_decomp_state *decomp_state) {
1443   cab_ULONG wndsize = 1 << window;
1444   int i, j, posn_slots;
1445
1446   /* LZX supports window sizes of 2^15 (32Kb) through 2^21 (2Mb) */
1447   /* if a previously allocated window is big enough, keep it     */
1448   if (window < 15 || window > 21) return DECR_DATAFORMAT;
1449   if (LZX(actual_size) < wndsize) {
1450     if (LZX(window)) free(LZX(window));
1451     LZX(window) = NULL;
1452   }
1453   if (!LZX(window)) {
1454     if (!(LZX(window) = malloc(wndsize))) return DECR_NOMEMORY;
1455     LZX(actual_size) = wndsize;
1456   }
1457   LZX(window_size) = wndsize;
1458
1459   /* initialise static tables */
1460   for (i=0, j=0; i <= 50; i += 2) {
1461     CAB(extra_bits)[i] = CAB(extra_bits)[i+1] = j; /* 0,0,0,0,1,1,2,2,3,3... */
1462     if ((i != 0) && (j < 17)) j++; /* 0,0,1,2,3,4...15,16,17,17,17,17... */
1463   }
1464   for (i=0, j=0; i <= 50; i++) {
1465     CAB(lzx_position_base)[i] = j; /* 0,1,2,3,4,6,8,12,16,24,32,... */
1466     j += 1 << CAB(extra_bits)[i]; /* 1,1,1,1,2,2,4,4,8,8,16,16,32,32,... */
1467   }
1468
1469   /* calculate required position slots */
1470        if (window == 20) posn_slots = 42;
1471   else if (window == 21) posn_slots = 50;
1472   else posn_slots = window << 1;
1473
1474   /*posn_slots=i=0; while (i < wndsize) i += 1 << CAB(extra_bits)[posn_slots++]; */
1475
1476   LZX(R0)  =  LZX(R1)  = LZX(R2) = 1;
1477   LZX(main_elements)   = LZX_NUM_CHARS + (posn_slots << 3);
1478   LZX(header_read)     = 0;
1479   LZX(frames_read)     = 0;
1480   LZX(block_remaining) = 0;
1481   LZX(block_type)      = LZX_BLOCKTYPE_INVALID;
1482   LZX(intel_curpos)    = 0;
1483   LZX(intel_started)   = 0;
1484   LZX(window_posn)     = 0;
1485
1486   /* initialise tables to 0 (because deltas will be applied to them) */
1487   for (i = 0; i < LZX_MAINTREE_MAXSYMBOLS; i++) LZX(MAINTREE_len)[i] = 0;
1488   for (i = 0; i < LZX_LENGTH_MAXSYMBOLS; i++)   LZX(LENGTH_len)[i]   = 0;
1489
1490   return DECR_OK;
1491 }
1492
1493 /*************************************************************************
1494  * make_decode_table (internal)
1495  *
1496  * This function was coded by David Tritscher. It builds a fast huffman
1497  * decoding table out of just a canonical huffman code lengths table.
1498  *
1499  * PARAMS
1500  *   nsyms:  total number of symbols in this huffman tree.
1501  *   nbits:  any symbols with a code length of nbits or less can be decoded
1502  *           in one lookup of the table.
1503  *   length: A table to get code lengths from [0 to syms-1]
1504  *   table:  The table to fill up with decoded symbols and pointers.
1505  *
1506  * RETURNS
1507  *   OK:    0
1508  *   error: 1
1509  */
1510 int make_decode_table(cab_ULONG nsyms, cab_ULONG nbits, cab_UBYTE *length, cab_UWORD *table) {
1511   register cab_UWORD sym;
1512   register cab_ULONG leaf;
1513   register cab_UBYTE bit_num = 1;
1514   cab_ULONG fill;
1515   cab_ULONG pos         = 0; /* the current position in the decode table */
1516   cab_ULONG table_mask  = 1 << nbits;
1517   cab_ULONG bit_mask    = table_mask >> 1; /* don't do 0 length codes */
1518   cab_ULONG next_symbol = bit_mask; /* base of allocation for long codes */
1519
1520   /* fill entries for codes short enough for a direct mapping */
1521   while (bit_num <= nbits) {
1522     for (sym = 0; sym < nsyms; sym++) {
1523       if (length[sym] == bit_num) {
1524         leaf = pos;
1525
1526         if((pos += bit_mask) > table_mask) return 1; /* table overrun */
1527
1528         /* fill all possible lookups of this symbol with the symbol itself */
1529         fill = bit_mask;
1530         while (fill-- > 0) table[leaf++] = sym;
1531       }
1532     }
1533     bit_mask >>= 1;
1534     bit_num++;
1535   }
1536
1537   /* if there are any codes longer than nbits */
1538   if (pos != table_mask) {
1539     /* clear the remainder of the table */
1540     for (sym = pos; sym < table_mask; sym++) table[sym] = 0;
1541
1542     /* give ourselves room for codes to grow by up to 16 more bits */
1543     pos <<= 16;
1544     table_mask <<= 16;
1545     bit_mask = 1 << 15;
1546
1547     while (bit_num <= 16) {
1548       for (sym = 0; sym < nsyms; sym++) {
1549         if (length[sym] == bit_num) {
1550           leaf = pos >> 16;
1551           for (fill = 0; fill < bit_num - nbits; fill++) {
1552             /* if this path hasn't been taken yet, 'allocate' two entries */
1553             if (table[leaf] == 0) {
1554               table[(next_symbol << 1)] = 0;
1555               table[(next_symbol << 1) + 1] = 0;
1556               table[leaf] = next_symbol++;
1557             }
1558             /* follow the path and select either left or right for next bit */
1559             leaf = table[leaf] << 1;
1560             if ((pos >> (15-fill)) & 1) leaf++;
1561           }
1562           table[leaf] = sym;
1563
1564           if ((pos += bit_mask) > table_mask) return 1; /* table overflow */
1565         }
1566       }
1567       bit_mask >>= 1;
1568       bit_num++;
1569     }
1570   }
1571
1572   /* full table? */
1573   if (pos == table_mask) return 0;
1574
1575   /* either erroneous table, or all elements are 0 - let's find out. */
1576   for (sym = 0; sym < nsyms; sym++) if (length[sym]) return 1;
1577   return 0;
1578 }
1579
1580 /************************************************************
1581  * lzx_read_lens (internal)
1582  */
1583 int lzx_read_lens(cab_UBYTE *lens, cab_ULONG first, cab_ULONG last, struct lzx_bits *lb,
1584                   cab_decomp_state *decomp_state) {
1585   cab_ULONG i,j, x,y;
1586   int z;
1587
1588   register cab_ULONG bitbuf = lb->bb;
1589   register int bitsleft = lb->bl;
1590   cab_UBYTE *inpos = lb->ip;
1591   cab_UWORD *hufftbl;
1592   
1593   for (x = 0; x < 20; x++) {
1594     READ_BITS(y, 4);
1595     LENTABLE(PRETREE)[x] = y;
1596   }
1597   BUILD_TABLE(PRETREE);
1598
1599   for (x = first; x < last; ) {
1600     READ_HUFFSYM(PRETREE, z);
1601     if (z == 17) {
1602       READ_BITS(y, 4); y += 4;
1603       while (y--) lens[x++] = 0;
1604     }
1605     else if (z == 18) {
1606       READ_BITS(y, 5); y += 20;
1607       while (y--) lens[x++] = 0;
1608     }
1609     else if (z == 19) {
1610       READ_BITS(y, 1); y += 4;
1611       READ_HUFFSYM(PRETREE, z);
1612       z = lens[x] - z; if (z < 0) z += 17;
1613       while (y--) lens[x++] = z;
1614     }
1615     else {
1616       z = lens[x] - z; if (z < 0) z += 17;
1617       lens[x++] = z;
1618     }
1619   }
1620
1621   lb->bb = bitbuf;
1622   lb->bl = bitsleft;
1623   lb->ip = inpos;
1624   return 0;
1625 }
1626
1627 /*******************************************************
1628  * LZXdecompress (internal)
1629  */
1630 int LZXdecompress(int inlen, int outlen, cab_decomp_state *decomp_state) {
1631   cab_UBYTE *inpos  = CAB(inbuf);
1632   cab_UBYTE *endinp = inpos + inlen;
1633   cab_UBYTE *window = LZX(window);
1634   cab_UBYTE *runsrc, *rundest;
1635   cab_UWORD *hufftbl; /* used in READ_HUFFSYM macro as chosen decoding table */
1636
1637   cab_ULONG window_posn = LZX(window_posn);
1638   cab_ULONG window_size = LZX(window_size);
1639   cab_ULONG R0 = LZX(R0);
1640   cab_ULONG R1 = LZX(R1);
1641   cab_ULONG R2 = LZX(R2);
1642
1643   register cab_ULONG bitbuf;
1644   register int bitsleft;
1645   cab_ULONG match_offset, i,j,k; /* ijk used in READ_HUFFSYM macro */
1646   struct lzx_bits lb; /* used in READ_LENGTHS macro */
1647
1648   int togo = outlen, this_run, main_element, aligned_bits;
1649   int match_length, copy_length, length_footer, extra, verbatim_bits;
1650
1651   TRACE("(inlen == %d, outlen == %d)\n", inlen, outlen);
1652
1653   INIT_BITSTREAM;
1654
1655   /* read header if necessary */
1656   if (!LZX(header_read)) {
1657     i = j = 0;
1658     READ_BITS(k, 1); if (k) { READ_BITS(i,16); READ_BITS(j,16); }
1659     LZX(intel_filesize) = (i << 16) | j; /* or 0 if not encoded */
1660     LZX(header_read) = 1;
1661   }
1662
1663   /* main decoding loop */
1664   while (togo > 0) {
1665     /* last block finished, new block expected */
1666     if (LZX(block_remaining) == 0) {
1667       if (LZX(block_type) == LZX_BLOCKTYPE_UNCOMPRESSED) {
1668         if (LZX(block_length) & 1) inpos++; /* realign bitstream to word */
1669         INIT_BITSTREAM;
1670       }
1671
1672       READ_BITS(LZX(block_type), 3);
1673       READ_BITS(i, 16);
1674       READ_BITS(j, 8);
1675       LZX(block_remaining) = LZX(block_length) = (i << 8) | j;
1676
1677       switch (LZX(block_type)) {
1678       case LZX_BLOCKTYPE_ALIGNED:
1679         for (i = 0; i < 8; i++) { READ_BITS(j, 3); LENTABLE(ALIGNED)[i] = j; }
1680         BUILD_TABLE(ALIGNED);
1681         /* rest of aligned header is same as verbatim */
1682
1683       case LZX_BLOCKTYPE_VERBATIM:
1684         READ_LENGTHS(MAINTREE, 0, 256, lzx_read_lens);
1685         READ_LENGTHS(MAINTREE, 256, LZX(main_elements), lzx_read_lens);
1686         BUILD_TABLE(MAINTREE);
1687         if (LENTABLE(MAINTREE)[0xE8] != 0) LZX(intel_started) = 1;
1688
1689         READ_LENGTHS(LENGTH, 0, LZX_NUM_SECONDARY_LENGTHS, lzx_read_lens);
1690         BUILD_TABLE(LENGTH);
1691         break;
1692
1693       case LZX_BLOCKTYPE_UNCOMPRESSED:
1694         LZX(intel_started) = 1; /* because we can't assume otherwise */
1695         ENSURE_BITS(16); /* get up to 16 pad bits into the buffer */
1696         if (bitsleft > 16) inpos -= 2; /* and align the bitstream! */
1697         R0 = inpos[0]|(inpos[1]<<8)|(inpos[2]<<16)|(inpos[3]<<24);inpos+=4;
1698         R1 = inpos[0]|(inpos[1]<<8)|(inpos[2]<<16)|(inpos[3]<<24);inpos+=4;
1699         R2 = inpos[0]|(inpos[1]<<8)|(inpos[2]<<16)|(inpos[3]<<24);inpos+=4;
1700         break;
1701
1702       default:
1703         return DECR_ILLEGALDATA;
1704       }
1705     }
1706
1707     /* buffer exhaustion check */
1708     if (inpos > endinp) {
1709       /* it's possible to have a file where the next run is less than
1710        * 16 bits in size. In this case, the READ_HUFFSYM() macro used
1711        * in building the tables will exhaust the buffer, so we should
1712        * allow for this, but not allow those accidentally read bits to
1713        * be used (so we check that there are at least 16 bits
1714        * remaining - in this boundary case they aren't really part of
1715        * the compressed data)
1716        */
1717       if (inpos > (endinp+2) || bitsleft < 16) return DECR_ILLEGALDATA;
1718     }
1719
1720     while ((this_run = LZX(block_remaining)) > 0 && togo > 0) {
1721       if (this_run > togo) this_run = togo;
1722       togo -= this_run;
1723       LZX(block_remaining) -= this_run;
1724
1725       /* apply 2^x-1 mask */
1726       window_posn &= window_size - 1;
1727       /* runs can't straddle the window wraparound */
1728       if ((window_posn + this_run) > window_size)
1729         return DECR_DATAFORMAT;
1730
1731       switch (LZX(block_type)) {
1732
1733       case LZX_BLOCKTYPE_VERBATIM:
1734         while (this_run > 0) {
1735           READ_HUFFSYM(MAINTREE, main_element);
1736
1737           if (main_element < LZX_NUM_CHARS) {
1738             /* literal: 0 to LZX_NUM_CHARS-1 */
1739             window[window_posn++] = main_element;
1740             this_run--;
1741           }
1742           else {
1743             /* match: LZX_NUM_CHARS + ((slot<<3) | length_header (3 bits)) */
1744             main_element -= LZX_NUM_CHARS;
1745   
1746             match_length = main_element & LZX_NUM_PRIMARY_LENGTHS;
1747             if (match_length == LZX_NUM_PRIMARY_LENGTHS) {
1748               READ_HUFFSYM(LENGTH, length_footer);
1749               match_length += length_footer;
1750             }
1751             match_length += LZX_MIN_MATCH;
1752   
1753             match_offset = main_element >> 3;
1754   
1755             if (match_offset > 2) {
1756               /* not repeated offset */
1757               if (match_offset != 3) {
1758                 extra = CAB(extra_bits)[match_offset];
1759                 READ_BITS(verbatim_bits, extra);
1760                 match_offset = CAB(lzx_position_base)[match_offset] 
1761                                - 2 + verbatim_bits;
1762               }
1763               else {
1764                 match_offset = 1;
1765               }
1766   
1767               /* update repeated offset LRU queue */
1768               R2 = R1; R1 = R0; R0 = match_offset;
1769             }
1770             else if (match_offset == 0) {
1771               match_offset = R0;
1772             }
1773             else if (match_offset == 1) {
1774               match_offset = R1;
1775               R1 = R0; R0 = match_offset;
1776             }
1777             else /* match_offset == 2 */ {
1778               match_offset = R2;
1779               R2 = R0; R0 = match_offset;
1780             }
1781
1782             rundest = window + window_posn;
1783             this_run -= match_length;
1784
1785             /* copy any wrapped around source data */
1786             if (window_posn >= match_offset) {
1787               /* no wrap */
1788               runsrc = rundest - match_offset;
1789             } else {
1790               runsrc = rundest + (window_size - match_offset);
1791               copy_length = match_offset - window_posn;
1792               if (copy_length < match_length) {
1793                 match_length -= copy_length;
1794                 window_posn += copy_length;
1795                 while (copy_length-- > 0) *rundest++ = *runsrc++;
1796                 runsrc = window;
1797               }
1798             }
1799             window_posn += match_length;
1800
1801             /* copy match data - no worries about destination wraps */
1802             while (match_length-- > 0) *rundest++ = *runsrc++;
1803           }
1804         }
1805         break;
1806
1807       case LZX_BLOCKTYPE_ALIGNED:
1808         while (this_run > 0) {
1809           READ_HUFFSYM(MAINTREE, main_element);
1810   
1811           if (main_element < LZX_NUM_CHARS) {
1812             /* literal: 0 to LZX_NUM_CHARS-1 */
1813             window[window_posn++] = main_element;
1814             this_run--;
1815           }
1816           else {
1817             /* match: LZX_NUM_CHARS + ((slot<<3) | length_header (3 bits)) */
1818             main_element -= LZX_NUM_CHARS;
1819   
1820             match_length = main_element & LZX_NUM_PRIMARY_LENGTHS;
1821             if (match_length == LZX_NUM_PRIMARY_LENGTHS) {
1822               READ_HUFFSYM(LENGTH, length_footer);
1823               match_length += length_footer;
1824             }
1825             match_length += LZX_MIN_MATCH;
1826   
1827             match_offset = main_element >> 3;
1828   
1829             if (match_offset > 2) {
1830               /* not repeated offset */
1831               extra = CAB(extra_bits)[match_offset];
1832               match_offset = CAB(lzx_position_base)[match_offset] - 2;
1833               if (extra > 3) {
1834                 /* verbatim and aligned bits */
1835                 extra -= 3;
1836                 READ_BITS(verbatim_bits, extra);
1837                 match_offset += (verbatim_bits << 3);
1838                 READ_HUFFSYM(ALIGNED, aligned_bits);
1839                 match_offset += aligned_bits;
1840               }
1841               else if (extra == 3) {
1842                 /* aligned bits only */
1843                 READ_HUFFSYM(ALIGNED, aligned_bits);
1844                 match_offset += aligned_bits;
1845               }
1846               else if (extra > 0) { /* extra==1, extra==2 */
1847                 /* verbatim bits only */
1848                 READ_BITS(verbatim_bits, extra);
1849                 match_offset += verbatim_bits;
1850               }
1851               else /* extra == 0 */ {
1852                 /* ??? */
1853                 match_offset = 1;
1854               }
1855   
1856               /* update repeated offset LRU queue */
1857               R2 = R1; R1 = R0; R0 = match_offset;
1858             }
1859             else if (match_offset == 0) {
1860               match_offset = R0;
1861             }
1862             else if (match_offset == 1) {
1863               match_offset = R1;
1864               R1 = R0; R0 = match_offset;
1865             }
1866             else /* match_offset == 2 */ {
1867               match_offset = R2;
1868               R2 = R0; R0 = match_offset;
1869             }
1870
1871             rundest = window + window_posn;
1872             this_run -= match_length;
1873
1874             /* copy any wrapped around source data */
1875             if (window_posn >= match_offset) {
1876               /* no wrap */
1877               runsrc = rundest - match_offset;
1878             } else {
1879               runsrc = rundest + (window_size - match_offset);
1880               copy_length = match_offset - window_posn;
1881               if (copy_length < match_length) {
1882                 match_length -= copy_length;
1883                 window_posn += copy_length;
1884                 while (copy_length-- > 0) *rundest++ = *runsrc++;
1885                 runsrc = window;
1886               }
1887             }
1888             window_posn += match_length;
1889
1890             /* copy match data - no worries about destination wraps */
1891             while (match_length-- > 0) *rundest++ = *runsrc++;
1892           }
1893         }
1894         break;
1895
1896       case LZX_BLOCKTYPE_UNCOMPRESSED:
1897         if ((inpos + this_run) > endinp) return DECR_ILLEGALDATA;
1898         memcpy(window + window_posn, inpos, (size_t) this_run);
1899         inpos += this_run; window_posn += this_run;
1900         break;
1901
1902       default:
1903         return DECR_ILLEGALDATA; /* might as well */
1904       }
1905
1906     }
1907   }
1908
1909   if (togo != 0) return DECR_ILLEGALDATA;
1910   memcpy(CAB(outbuf), window + ((!window_posn) ? window_size : window_posn) -
1911     outlen, (size_t) outlen);
1912
1913   LZX(window_posn) = window_posn;
1914   LZX(R0) = R0;
1915   LZX(R1) = R1;
1916   LZX(R2) = R2;
1917
1918   /* intel E8 decoding */
1919   if ((LZX(frames_read)++ < 32768) && LZX(intel_filesize) != 0) {
1920     if (outlen <= 6 || !LZX(intel_started)) {
1921       LZX(intel_curpos) += outlen;
1922     }
1923     else {
1924       cab_UBYTE *data    = CAB(outbuf);
1925       cab_UBYTE *dataend = data + outlen - 10;
1926       cab_LONG curpos    = LZX(intel_curpos);
1927       cab_LONG filesize  = LZX(intel_filesize);
1928       cab_LONG abs_off, rel_off;
1929
1930       LZX(intel_curpos) = curpos + outlen;
1931
1932       while (data < dataend) {
1933         if (*data++ != 0xE8) { curpos++; continue; }
1934         abs_off = data[0] | (data[1]<<8) | (data[2]<<16) | (data[3]<<24);
1935         if ((abs_off >= -curpos) && (abs_off < filesize)) {
1936           rel_off = (abs_off >= 0) ? abs_off - curpos : abs_off + filesize;
1937           data[0] = (cab_UBYTE) rel_off;
1938           data[1] = (cab_UBYTE) (rel_off >> 8);
1939           data[2] = (cab_UBYTE) (rel_off >> 16);
1940           data[3] = (cab_UBYTE) (rel_off >> 24);
1941         }
1942         data += 4;
1943         curpos += 5;
1944       }
1945     }
1946   }
1947   return DECR_OK;
1948 }
1949
1950 /*********************************************************
1951  * find_cabs_in_file (internal)
1952  */
1953 struct cabinet *find_cabs_in_file(LPCSTR name, cab_UBYTE search_buf[])
1954 {
1955   struct cabinet *cab, *cab2, *firstcab = NULL, *linkcab = NULL;
1956   cab_UBYTE *pstart = &search_buf[0], *pend, *p;
1957   cab_off_t offset, caboff, cablen = 0, foffset = 0, filelen, length;
1958   int state = 0, found = 0, ok = 0;
1959
1960   TRACE("(name == %s)\n", debugstr_a(name));
1961
1962   /* open the file and search for cabinet headers */
1963   if ((cab = (struct cabinet *) calloc(1, sizeof(struct cabinet)))) {
1964     cab->filename = name;
1965     if (cabinet_open(cab)) {
1966       filelen = cab->filelen;
1967       for (offset = 0; (offset < filelen); offset += length) {
1968         /* search length is either the full length of the search buffer,
1969          * or the amount of data remaining to the end of the file,
1970          * whichever is less.
1971          */
1972         length = filelen - offset;
1973         if (length > CAB_SEARCH_SIZE) length = CAB_SEARCH_SIZE;
1974
1975         /* fill the search buffer with data from disk */
1976         if (!cabinet_read(cab, search_buf, length)) break;
1977
1978         /* read through the entire buffer. */
1979         p = pstart;
1980         pend = &search_buf[length];
1981         while (p < pend) {
1982           switch (state) {
1983           /* starting state */
1984           case 0:
1985             /* we spend most of our time in this while loop, looking for
1986              * a leading 'M' of the 'MSCF' signature
1987              */
1988             while (*p++ != 0x4D && p < pend);
1989             if (p < pend) state = 1; /* if we found tht 'M', advance state */
1990             break;
1991
1992           /* verify that the next 3 bytes are 'S', 'C' and 'F' */
1993           case 1: state = (*p++ == 0x53) ? 2 : 0; break;
1994           case 2: state = (*p++ == 0x43) ? 3 : 0; break;
1995           case 3: state = (*p++ == 0x46) ? 4 : 0; break;
1996
1997           /* we don't care about bytes 4-7 */
1998           /* bytes 8-11 are the overall length of the cabinet */
1999           case 8:  cablen  = *p++;       state++; break;
2000           case 9:  cablen |= *p++ << 8;  state++; break;
2001           case 10: cablen |= *p++ << 16; state++; break;
2002           case 11: cablen |= *p++ << 24; state++; break;
2003
2004           /* we don't care about bytes 12-15 */
2005           /* bytes 16-19 are the offset within the cabinet of the filedata */
2006           case 16: foffset  = *p++;       state++; break;
2007           case 17: foffset |= *p++ << 8;  state++; break;
2008           case 18: foffset |= *p++ << 16; state++; break;
2009           case 19: foffset |= *p++ << 24;
2010             /* now we have received 20 bytes of potential cab header. */
2011             /* work out the offset in the file of this potential cabinet */
2012             caboff = offset + (p-pstart) - 20;
2013
2014             /* check that the files offset is less than the alleged length
2015              * of the cabinet, and that the offset + the alleged length are
2016              * 'roughly' within the end of overall file length
2017              */
2018             if ((foffset < cablen) &&
2019                 ((caboff + foffset) < (filelen + 32)) &&
2020                 ((caboff + cablen) < (filelen + 32)) )
2021             {
2022               /* found a potential result - try loading it */
2023               found++;
2024               cab2 =  load_cab_offset(name, caboff);
2025               if (cab2) {
2026                 /* success */
2027                 ok++;
2028
2029                 /* cause the search to restart after this cab's data. */
2030                 offset = caboff + cablen;
2031                 if (offset < cab->filelen) cabinet_seek(cab, offset);
2032                 length = 0;
2033                 p = pend;
2034
2035                 /* link the cab into the list */
2036                 if (linkcab == NULL) firstcab = cab2;
2037                 else linkcab->next = cab2;
2038                 linkcab = cab2;
2039               }
2040             }
2041             state = 0;
2042             break;
2043           default:
2044             p++, state++; break;
2045           }
2046         }
2047       }
2048       cabinet_close(cab);
2049     }
2050     free(cab);
2051   }
2052
2053   /* if there were cabinets that were found but are not ok, point this out */
2054   if (found > ok) {
2055     WARN("%s: found %d bad cabinets\n", debugstr_a(name), found-ok);
2056   }
2057
2058   /* if no cabinets were found, let the user know */
2059   if (!firstcab) {
2060     WARN("%s: not a Microsoft cabinet file.\n", debugstr_a(name));
2061   }
2062   return firstcab;
2063 }
2064
2065 /***********************************************************************
2066  * find_cabinet_file (internal)
2067  *
2068  * tries to find *cabname, from the directory path of origcab, correcting the
2069  * case of *cabname if necessary, If found, writes back to *cabname.
2070  */
2071 void find_cabinet_file(char **cabname, LPCSTR origcab) {
2072
2073   char *tail, *cab, *name, *nextpart, nametmp[MAX_PATH], *filepart;
2074   int found = 0;
2075
2076   TRACE("(*cabname == ^%p, origcab == %s)\n", cabname ? *cabname : NULL, debugstr_a(origcab));
2077
2078   /* ensure we have a cabinet name at all */
2079   if (!(name = *cabname)) {
2080     WARN("no cabinet name at all\n");
2081   }
2082
2083   /* find if there's a directory path in the origcab */
2084   tail = origcab ? max(strrchr(origcab, '/'), strrchr(origcab, '\\')) : NULL;
2085
2086   if ((cab = (char *) malloc(MAX_PATH))) {
2087     /* add the directory path from the original cabinet name */
2088     if (tail) {
2089       memcpy(cab, origcab, tail - origcab);
2090       cab[tail - origcab] = '\0';
2091     } else {
2092       /* default directory path of '.' */
2093       cab[0] = '.';
2094       cab[1] = '\0';
2095     }
2096
2097     do {
2098       TRACE("trying cab == %s\n", debugstr_a(cab));
2099
2100       /* we don't want null cabinet filenames */
2101       if (name[0] == '\0') {
2102         WARN("null cab name\n");
2103         break;
2104       }
2105
2106       /* if there is a directory component in the cabinet name,
2107        * look for that alone first
2108        */
2109       nextpart = strchr(name, '\\');
2110       if (nextpart) *nextpart = '\0';
2111
2112       found = SearchPathA(cab, name, NULL, MAX_PATH, nametmp, &filepart);
2113
2114       /* if the component was not found, look for it in the current dir */
2115       if (!found) {
2116         found = SearchPathA(".", name, NULL, MAX_PATH, nametmp, &filepart);
2117       }
2118       
2119       if (found) 
2120         TRACE("found: %s\n", debugstr_a(nametmp));
2121       else
2122         TRACE("not found.\n");
2123
2124       /* restore the real name and skip to the next directory component
2125        * or actual cabinet name
2126        */
2127       if (nextpart) *nextpart = '\\', name = &nextpart[1];
2128
2129       /* while there is another directory component, and while we
2130        * successfully found the current component
2131        */
2132     } while (nextpart && found);
2133
2134     /* if we found the cabinet, change the next cabinet's name.
2135      * otherwise, pretend nothing happened
2136      */
2137     if (found) {
2138       free((void *) *cabname);
2139       *cabname = cab;
2140       strncpy(cab, nametmp, found+1);
2141       TRACE("result: %s\n", debugstr_a(cab));
2142     } else {
2143       free((void *) cab);
2144       TRACE("result: nothing\n");
2145     }
2146   }
2147 }
2148
2149 /************************************************************************
2150  * process_files (internal)
2151  *
2152  * this does the tricky job of running through every file in the cabinet,
2153  * including spanning cabinets, and working out which file is in which
2154  * folder in which cabinet. It also throws out the duplicate file entries
2155  * that appear in spanning cabinets. There is memory leakage here because
2156  * those entries are not freed. See the XAD CAB client (function CAB_GetInfo
2157  * in CAB.c) for an implementation of this that correctly frees the discarded
2158  * file entries.
2159  */
2160 struct cab_file *process_files(struct cabinet *basecab) {
2161   struct cabinet *cab;
2162   struct cab_file *outfi = NULL, *linkfi = NULL, *nextfi, *fi, *cfi;
2163   struct cab_folder *fol, *firstfol, *lastfol = NULL, *predfol;
2164   int i, mergeok;
2165
2166   FIXME("(basecab == ^%p): Memory leak.\n", basecab);
2167
2168   for (cab = basecab; cab; cab = cab->nextcab) {
2169     /* firstfol = first folder in this cabinet */
2170     /* lastfol  = last folder in this cabinet */
2171     /* predfol  = last folder in previous cabinet (or NULL if first cabinet) */
2172     predfol = lastfol;
2173     firstfol = cab->folders;
2174     for (lastfol = firstfol; lastfol->next;) lastfol = lastfol->next;
2175     mergeok = 1;
2176
2177     for (fi = cab->files; fi; fi = nextfi) {
2178       i = fi->index;
2179       nextfi = fi->next;
2180
2181       if (i < cffileCONTINUED_FROM_PREV) {
2182         for (fol = firstfol; fol && i--; ) fol = fol->next;
2183         fi->folder = fol; /* NULL if an invalid folder index */
2184       }
2185       else {
2186         /* folder merging */
2187         if (i == cffileCONTINUED_TO_NEXT
2188         ||  i == cffileCONTINUED_PREV_AND_NEXT) {
2189           if (cab->nextcab && !lastfol->contfile) lastfol->contfile = fi;
2190         }
2191
2192         if (i == cffileCONTINUED_FROM_PREV
2193         ||  i == cffileCONTINUED_PREV_AND_NEXT) {
2194           /* these files are to be continued in yet another
2195            * cabinet, don't merge them in just yet */
2196           if (i == cffileCONTINUED_PREV_AND_NEXT) mergeok = 0;
2197
2198           /* only merge once per cabinet */
2199           if (predfol) {
2200             if ((cfi = predfol->contfile)
2201             && (cfi->offset == fi->offset)
2202             && (cfi->length == fi->length)
2203             && (strcmp(cfi->filename, fi->filename) == 0)
2204             && (predfol->comp_type == firstfol->comp_type)) {
2205               /* increase the number of splits */
2206               if ((i = ++(predfol->num_splits)) > CAB_SPLITMAX) {
2207                 mergeok = 0;
2208                 ERR("%s: internal error: CAB_SPLITMAX exceeded. please report this to wine-devel@winehq.org)\n",
2209                     debugstr_a(basecab->filename));
2210               }
2211               else {
2212                 /* copy information across from the merged folder */
2213                 predfol->offset[i] = firstfol->offset[0];
2214                 predfol->cab[i]    = firstfol->cab[0];
2215                 predfol->next      = firstfol->next;
2216                 predfol->contfile  = firstfol->contfile;
2217
2218                 if (firstfol == lastfol) lastfol = predfol;
2219                 firstfol = predfol;
2220                 predfol = NULL; /* don't merge again within this cabinet */
2221               }
2222             }
2223             else {
2224               /* if the folders won't merge, don't add their files */
2225               mergeok = 0;
2226             }
2227           }
2228
2229           if (mergeok) fi->folder = firstfol;
2230         }
2231       }
2232
2233       if (fi->folder) {
2234         if (linkfi) linkfi->next = fi; else outfi = fi;
2235         linkfi = fi;
2236       }
2237     } /* for (fi= .. */
2238   } /* for (cab= ...*/
2239
2240   return outfi;
2241 }
2242
2243 /****************************************************************
2244  * convertUTF (internal)
2245  *
2246  * translate UTF -> ASCII
2247  *
2248  * UTF translates two-byte unicode characters into 1, 2 or 3 bytes.
2249  * %000000000xxxxxxx -> %0xxxxxxx
2250  * %00000xxxxxyyyyyy -> %110xxxxx %10yyyyyy
2251  * %xxxxyyyyyyzzzzzz -> %1110xxxx %10yyyyyy %10zzzzzz
2252  *
2253  * Therefore, the inverse is as follows:
2254  * First char:
2255  *  0x00 - 0x7F = one byte char
2256  *  0x80 - 0xBF = invalid
2257  *  0xC0 - 0xDF = 2 byte char (next char only 0x80-0xBF is valid)
2258  *  0xE0 - 0xEF = 3 byte char (next 2 chars only 0x80-0xBF is valid)
2259  *  0xF0 - 0xFF = invalid
2260  * 
2261  * FIXME: use a winapi to do this
2262  */
2263 int convertUTF(cab_UBYTE *in) {
2264   cab_UBYTE c, *out = in, *end = in + strlen((char *) in) + 1;
2265   cab_ULONG x;
2266
2267   do {
2268     /* read unicode character */
2269     if ((c = *in++) < 0x80) x = c;
2270     else {
2271       if (c < 0xC0) return 0;
2272       else if (c < 0xE0) {
2273         x = (c & 0x1F) << 6;
2274         if ((c = *in++) < 0x80 || c > 0xBF) return 0; else x |= (c & 0x3F);
2275       }
2276       else if (c < 0xF0) {
2277         x = (c & 0xF) << 12;
2278         if ((c = *in++) < 0x80 || c > 0xBF) return 0; else x |= (c & 0x3F)<<6;
2279         if ((c = *in++) < 0x80 || c > 0xBF) return 0; else x |= (c & 0x3F);
2280       }
2281       else return 0;
2282     }
2283
2284     /* terrible unicode -> ASCII conversion */
2285     if (x > 127) x = '_';
2286
2287     if (in > end) return 0; /* just in case */
2288   } while ((*out++ = (cab_UBYTE) x));
2289   return 1;
2290 }
2291
2292 /****************************************************
2293  * NONEdecompress (internal)
2294  */
2295 int NONEdecompress(int inlen, int outlen, cab_decomp_state *decomp_state)
2296 {
2297   if (inlen != outlen) return DECR_ILLEGALDATA;
2298   memcpy(CAB(outbuf), CAB(inbuf), (size_t) inlen);
2299   return DECR_OK;
2300 }
2301
2302 /**************************************************
2303  * checksum (internal)
2304  */
2305 cab_ULONG checksum(cab_UBYTE *data, cab_UWORD bytes, cab_ULONG csum) {
2306   int len;
2307   cab_ULONG ul = 0;
2308
2309   for (len = bytes >> 2; len--; data += 4) {
2310     csum ^= ((data[0]) | (data[1]<<8) | (data[2]<<16) | (data[3]<<24));
2311   }
2312
2313   switch (bytes & 3) {
2314   case 3: ul |= *data++ << 16;
2315   case 2: ul |= *data++ <<  8;
2316   case 1: ul |= *data;
2317   }
2318   csum ^= ul;
2319
2320   return csum;
2321 }
2322
2323 /**********************************************************
2324  * decompress (internal)
2325  */
2326 int decompress(struct cab_file *fi, int savemode, int fix, cab_decomp_state *decomp_state)
2327 {
2328   cab_ULONG bytes = savemode ? fi->length : fi->offset - CAB(offset);
2329   struct cabinet *cab = CAB(current)->cab[CAB(split)];
2330   cab_UBYTE buf[cfdata_SIZEOF], *data;
2331   cab_UWORD inlen, len, outlen, cando;
2332   cab_ULONG cksum;
2333   cab_LONG err;
2334
2335   TRACE("(fi == ^%p, savemode == %d, fix == %d)\n", fi, savemode, fix);
2336
2337   while (bytes > 0) {
2338     /* cando = the max number of bytes we can do */
2339     cando = CAB(outlen);
2340     if (cando > bytes) cando = bytes;
2341
2342     /* if cando != 0 */
2343     if (cando && savemode)
2344       file_write(fi, CAB(outpos), cando);
2345
2346     CAB(outpos) += cando;
2347     CAB(outlen) -= cando;
2348     bytes -= cando; if (!bytes) break;
2349
2350     /* we only get here if we emptied the output buffer */
2351
2352     /* read data header + data */
2353     inlen = outlen = 0;
2354     while (outlen == 0) {
2355       /* read the block header, skip the reserved part */
2356       if (!cabinet_read(cab, buf, cfdata_SIZEOF)) return DECR_INPUT;
2357       cabinet_skip(cab, cab->block_resv);
2358
2359       /* we shouldn't get blocks over CAB_INPUTMAX in size */
2360       data = CAB(inbuf) + inlen;
2361       len = EndGetI16(buf+cfdata_CompressedSize);
2362       inlen += len;
2363       if (inlen > CAB_INPUTMAX) return DECR_INPUT;
2364       if (!cabinet_read(cab, data, len)) return DECR_INPUT;
2365
2366       /* clear two bytes after read-in data */
2367       data[len+1] = data[len+2] = 0;
2368
2369       /* perform checksum test on the block (if one is stored) */
2370       cksum = EndGetI32(buf+cfdata_CheckSum);
2371       if (cksum && cksum != checksum(buf+4, 4, checksum(data, len, 0))) {
2372         /* checksum is wrong */
2373         if (fix && ((fi->folder->comp_type & cffoldCOMPTYPE_MASK)
2374                     == cffoldCOMPTYPE_MSZIP))
2375         {
2376           WARN("%s: checksum failed\n", debugstr_a(fi->filename)); 
2377         }
2378         else {
2379           return DECR_CHECKSUM;
2380         }
2381       }
2382
2383       /* outlen=0 means this block was part of a split block */
2384       outlen = EndGetI16(buf+cfdata_UncompressedSize);
2385       if (outlen == 0) {
2386         cabinet_close(cab);
2387         cab = CAB(current)->cab[++CAB(split)];
2388         if (!cabinet_open(cab)) return DECR_INPUT;
2389         cabinet_seek(cab, CAB(current)->offset[CAB(split)]);
2390       }
2391     }
2392
2393     /* decompress block */
2394     if ((err = CAB(decompress)(inlen, outlen, decomp_state))) {
2395       if (fix && ((fi->folder->comp_type & cffoldCOMPTYPE_MASK)
2396                   == cffoldCOMPTYPE_MSZIP))
2397       {
2398         ERR("%s: failed decrunching block\n", debugstr_a(fi->filename)); 
2399       }
2400       else {
2401         return err;
2402       }
2403     }
2404     CAB(outlen) = outlen;
2405     CAB(outpos) = CAB(outbuf);
2406   }
2407
2408   return DECR_OK;
2409 }
2410
2411 /****************************************************************
2412  * extract_file (internal)
2413  *
2414  * workhorse to extract a particular file from a cab
2415  */
2416 void extract_file(struct cab_file *fi, int lower, int fix, LPCSTR dir, cab_decomp_state *decomp_state)
2417 {
2418   struct cab_folder *fol = fi->folder, *oldfol = CAB(current);
2419   cab_LONG err = DECR_OK;
2420
2421   TRACE("(fi == ^%p, lower == %d, fix == %d, dir == %s)\n", fi, lower, fix, debugstr_a(dir));
2422
2423   /* is a change of folder needed? do we need to reset the current folder? */
2424   if (fol != oldfol || fi->offset < CAB(offset)) {
2425     cab_UWORD comptype = fol->comp_type;
2426     int ct1 = comptype & cffoldCOMPTYPE_MASK;
2427     int ct2 = oldfol ? (oldfol->comp_type & cffoldCOMPTYPE_MASK) : 0;
2428
2429     /* if the archiver has changed, call the old archiver's free() function */
2430     if (ct1 != ct2) {
2431       switch (ct2) {
2432       case cffoldCOMPTYPE_LZX:
2433         if (LZX(window)) {
2434           free(LZX(window));
2435           LZX(window) = NULL;
2436         }
2437         break;
2438       case cffoldCOMPTYPE_QUANTUM:
2439         if (QTM(window)) {
2440           free(QTM(window));
2441           QTM(window) = NULL;
2442         }
2443         break;
2444       }
2445     }
2446
2447     switch (ct1) {
2448     case cffoldCOMPTYPE_NONE:
2449       CAB(decompress) = NONEdecompress;
2450       break;
2451
2452     case cffoldCOMPTYPE_MSZIP:
2453       CAB(decompress) = ZIPdecompress;
2454       break;
2455
2456     case cffoldCOMPTYPE_QUANTUM:
2457       CAB(decompress) = QTMdecompress;
2458       err = QTMinit((comptype >> 8) & 0x1f, (comptype >> 4) & 0xF, decomp_state);
2459       break;
2460
2461     case cffoldCOMPTYPE_LZX:
2462       CAB(decompress) = LZXdecompress;
2463       err = LZXinit((comptype >> 8) & 0x1f, decomp_state);
2464       break;
2465
2466     default:
2467       err = DECR_DATAFORMAT;
2468     }
2469     if (err) goto exit_handler;
2470
2471     /* initialisation OK, set current folder and reset offset */
2472     if (oldfol) cabinet_close(oldfol->cab[CAB(split)]);
2473     if (!cabinet_open(fol->cab[0])) goto exit_handler;
2474     cabinet_seek(fol->cab[0], fol->offset[0]);
2475     CAB(current) = fol;
2476     CAB(offset) = 0;
2477     CAB(outlen) = 0; /* discard existing block */
2478     CAB(split)  = 0;
2479   }
2480
2481   if (fi->offset > CAB(offset)) {
2482     /* decode bytes and send them to /dev/null */
2483     if ((err = decompress(fi, 0, fix, decomp_state))) goto exit_handler;
2484     CAB(offset) = fi->offset;
2485   }
2486   
2487   if (!file_open(fi, lower, dir)) return;
2488   err = decompress(fi, 1, fix, decomp_state);
2489   if (err) CAB(current) = NULL; else CAB(offset) += fi->length;
2490   file_close(fi);
2491
2492 exit_handler:
2493   if (err) {
2494     const char *errmsg;
2495     const char *cabname;
2496     switch (err) {
2497     case DECR_NOMEMORY:
2498       errmsg = "out of memory!\n"; break;
2499     case DECR_ILLEGALDATA:
2500       errmsg = "%s: illegal or corrupt data\n"; break;
2501     case DECR_DATAFORMAT:
2502       errmsg = "%s: unsupported data format\n"; break;
2503     case DECR_CHECKSUM:
2504       errmsg = "%s: checksum error\n"; break;
2505     case DECR_INPUT:
2506       errmsg = "%s: input error\n"; break;
2507     case DECR_OUTPUT:
2508       errmsg = "%s: output error\n"; break;
2509     default:
2510       errmsg = "%s: unknown error (BUG)\n";
2511     }
2512
2513     if (CAB(current)) {
2514       cabname = (CAB(current)->cab[CAB(split)]->filename);
2515     }
2516     else {
2517       cabname = (fi->folder->cab[0]->filename);
2518     }
2519
2520     ERR(errmsg, cabname);
2521   }
2522 }
2523
2524 /*********************************************************
2525  * print_fileinfo (internal)
2526  */
2527 void print_fileinfo(struct cab_file *fi) {
2528   int d = fi->date, t = fi->time;
2529   char *fname = NULL;
2530
2531   if (fi->attribs & cffile_A_NAME_IS_UTF) {
2532     fname = malloc(strlen(fi->filename) + 1);
2533     if (fname) {
2534       strcpy(fname, fi->filename);
2535       convertUTF((cab_UBYTE *) fname);
2536     }
2537   }
2538
2539   TRACE("%9u | %02d.%02d.%04d %02d:%02d:%02d | %s\n",
2540     fi->length, 
2541     d & 0x1f, (d>>5) & 0xf, (d>>9) + 1980,
2542     t >> 11, (t>>5) & 0x3f, (t << 1) & 0x3e,
2543     fname ? fname : fi->filename
2544   );
2545
2546   if (fname) free(fname);
2547 }
2548
2549 /****************************************************************************
2550  * process_cabinet (internal) 
2551  *
2552  * called to simply "extract" a cabinet file.  Will find every cabinet file
2553  * in that file, search for every chained cabinet attached to those cabinets,
2554  * and will either extract the cabinets, or ? (call a callback?)
2555  *
2556  * PARAMS
2557  *   cabname [I] name of the cabinet file to extract
2558  *   dir     [I] directory to extract to
2559  *   fix     [I] attempt to process broken cabinets
2560  *   lower   [I] ? (lower case something or other?)
2561  *   dest    [O] 
2562  *
2563  * RETURNS
2564  *   Success: TRUE
2565  *   Failure: FALSE
2566  */
2567 BOOL process_cabinet(LPCSTR cabname, LPCSTR dir, BOOL fix, BOOL lower, EXTRACTdest *dest)
2568 {
2569   struct cabinet *basecab, *cab, *cab1, *cab2;
2570   struct cab_file *filelist, *fi;
2571   struct ExtractFileList **destlistptr = &(dest->filelist);
2572
2573   /* The first result of a search will be returned, and
2574    * the remaining results will be chained to it via the cab->next structure
2575    * member.
2576    */
2577   cab_UBYTE search_buf[CAB_SEARCH_SIZE];
2578
2579   cab_decomp_state decomp_state_local;
2580   cab_decomp_state *decomp_state = &decomp_state_local;
2581
2582   /* has the list-mode header been seen before? */
2583   int viewhdr = 0;
2584
2585   ZeroMemory(decomp_state, sizeof(cab_decomp_state));
2586
2587   TRACE("Extract %s\n", debugstr_a(cabname));
2588
2589   /* load the file requested */
2590   basecab = find_cabs_in_file(cabname, search_buf);
2591   if (!basecab) return FALSE;
2592
2593   /* iterate over all cabinets found in that file */
2594   for (cab = basecab; cab; cab=cab->next) {
2595
2596     /* bi-directionally load any spanning cabinets -- backwards */
2597     for (cab1 = cab; cab1->flags & cfheadPREV_CABINET; cab1 = cab1->prevcab) {
2598       TRACE("%s: extends backwards to %s (%s)\n", debugstr_a(cabname),
2599             debugstr_a(cab1->prevname), debugstr_a(cab1->previnfo));
2600       find_cabinet_file(&(cab1->prevname), cabname);
2601       if (!(cab1->prevcab = load_cab_offset(cab1->prevname, 0))) {
2602         ERR("%s: can't read previous cabinet %s\n", debugstr_a(cabname), debugstr_a(cab1->prevname));
2603         break;
2604       }
2605       cab1->prevcab->nextcab = cab1;
2606     }
2607
2608     /* bi-directionally load any spanning cabinets -- forwards */
2609     for (cab2 = cab; cab2->flags & cfheadNEXT_CABINET; cab2 = cab2->nextcab) {
2610       TRACE("%s: extends to %s (%s)\n", debugstr_a(cabname),
2611             debugstr_a(cab2->nextname), debugstr_a(cab2->nextinfo));
2612       find_cabinet_file(&(cab2->nextname), cabname);
2613       if (!(cab2->nextcab = load_cab_offset(cab2->nextname, 0))) {
2614         ERR("%s: can't read next cabinet %s\n", debugstr_a(cabname), debugstr_a(cab2->nextname));
2615         break;
2616       }
2617       cab2->nextcab->prevcab = cab2;
2618     }
2619
2620     filelist = process_files(cab1);
2621     CAB(current) = NULL;
2622
2623     if (!viewhdr) {
2624       TRACE("File size | Date       Time     | Name\n");
2625       TRACE("----------+---------------------+-------------\n");
2626       viewhdr = 1;
2627     }
2628     for (fi = filelist; fi; fi = fi->next) {
2629         print_fileinfo(fi);
2630         dest->filecount++;
2631     }
2632     TRACE("Beginning Extraction...\n");
2633     for (fi = filelist; fi; fi = fi->next) {
2634         TRACE("  extracting: %s\n", debugstr_a(fi->filename));
2635         extract_file(fi, lower, fix, dir, decomp_state);
2636         sprintf(dest->lastfile, "%s%s%s",
2637                 strlen(dest->directory) ? dest->directory : "",
2638                 strlen(dest->directory) ? "\\": "",
2639                 fi->filename);
2640         *destlistptr = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY,
2641                                 sizeof(struct ExtractFileList));
2642         if(*destlistptr) {
2643            (*destlistptr)->unknown = TRUE; /* FIXME: were do we get the value? */
2644            (*destlistptr)->filename = HeapAlloc(GetProcessHeap(), 0, (
2645                                                 strlen(fi->filename)+1));
2646            if((*destlistptr)->filename) 
2647                 lstrcpyA((*destlistptr)->filename, fi->filename);
2648            destlistptr = &((*destlistptr)->next);
2649         }
2650     }
2651   }
2652
2653   TRACE("Finished processing cabinet.\n");
2654
2655   return TRUE;
2656 }