kernel32/tests: Fix a few typos.
[wine] / dlls / kernel32 / lzexpand.c
1 /*
2  * LZ Decompression functions
3  *
4  * Copyright 1996 Marcus Meissner
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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
19  *
20  * NOTES
21  *
22  * The LZ (Lempel Ziv) decompression was used in win16 installation programs.
23  * It is a simple tabledriven decompression engine, the algorithm is not
24  * documented as far as I know. WINE does not contain a compressor for
25  * this format.
26  *
27  * The implementation is complete and there have been no reports of failures
28  * for some time.
29  *
30  * TODO:
31  *
32  *   o Check whether the return values are correct
33  *
34  */
35
36 #include "config.h"
37
38 #include <string.h>
39 #include <ctype.h>
40 #include <sys/types.h>
41 #include <stdarg.h>
42 #include <stdio.h>
43 #ifdef HAVE_UNISTD_H
44 # include <unistd.h>
45 #endif
46
47 #include "windef.h"
48 #include "winbase.h"
49 #include "lzexpand.h"
50
51 #include "wine/unicode.h"
52 #include "wine/debug.h"
53
54 WINE_DEFAULT_DEBUG_CHANNEL(file);
55
56 /* The readahead length of the decompressor. Reading single bytes
57  * using _lread() would be SLOW.
58  */
59 #define GETLEN  2048
60
61 #define LZ_MAGIC_LEN    8
62 #define LZ_HEADER_LEN   14
63
64 /* Format of first 14 byte of LZ compressed file */
65 struct lzfileheader {
66         BYTE    magic[LZ_MAGIC_LEN];
67         BYTE    compressiontype;
68         CHAR    lastchar;
69         DWORD   reallength;
70 };
71 static const BYTE LZMagic[LZ_MAGIC_LEN]={'S','Z','D','D',0x88,0xf0,0x27,0x33};
72
73 #define LZ_TABLE_SIZE    0x1000
74
75 struct lzstate {
76         HFILE   realfd;         /* the real filedescriptor */
77         CHAR    lastchar;       /* the last char of the filename */
78
79         DWORD   reallength;     /* the decompressed length of the file */
80         DWORD   realcurrent;    /* the position the decompressor currently is */
81         DWORD   realwanted;     /* the position the user wants to read from */
82
83         BYTE    table[LZ_TABLE_SIZE];   /* the rotating LZ table */
84         UINT    curtabent;      /* CURrent TABle ENTry */
85
86         BYTE    stringlen;      /* length and position of current string */
87         DWORD   stringpos;      /* from stringtable */
88
89
90         WORD    bytetype;       /* bitmask within blocks */
91
92         BYTE    *get;           /* GETLEN bytes */
93         DWORD   getcur;         /* current read */
94         DWORD   getlen;         /* length last got */
95 };
96
97 #define MAX_LZSTATES 16
98 static struct lzstate *lzstates[MAX_LZSTATES];
99
100 #define LZ_MIN_HANDLE  0x400
101 #define IS_LZ_HANDLE(h) (((h) >= LZ_MIN_HANDLE) && ((h) < LZ_MIN_HANDLE+MAX_LZSTATES))
102 #define GET_LZ_STATE(h) (IS_LZ_HANDLE(h) ? lzstates[(h)-LZ_MIN_HANDLE] : NULL)
103
104 /* reads one compressed byte, including buffering */
105 #define GET(lzs,b)      _lzget(lzs,&b)
106 #define GET_FLUSH(lzs)  lzs->getcur=lzs->getlen;
107
108 static int
109 _lzget(struct lzstate *lzs,BYTE *b) {
110         if (lzs->getcur<lzs->getlen) {
111                 *b              = lzs->get[lzs->getcur++];
112                 return          1;
113         } else {
114                 int ret = _lread(lzs->realfd,lzs->get,GETLEN);
115                 if (ret==HFILE_ERROR)
116                         return HFILE_ERROR;
117                 if (ret==0)
118                         return 0;
119                 lzs->getlen     = ret;
120                 lzs->getcur     = 1;
121                 *b              = *(lzs->get);
122                 return 1;
123         }
124 }
125 /* internal function, reads lzheader
126  * returns BADINHANDLE for non filedescriptors
127  * return 0 for file not compressed using LZ
128  * return UNKNOWNALG for unknown algorithm
129  * returns lzfileheader in *head
130  */
131 static INT read_header(HFILE fd,struct lzfileheader *head)
132 {
133         BYTE    buf[LZ_HEADER_LEN];
134
135         if (_llseek(fd,0,SEEK_SET)==-1)
136                 return LZERROR_BADINHANDLE;
137
138         /* We can't directly read the lzfileheader struct due to
139          * structure element alignment
140          */
141         if (_lread(fd,buf,LZ_HEADER_LEN)<LZ_HEADER_LEN)
142                 return 0;
143         memcpy(head->magic,buf,LZ_MAGIC_LEN);
144         memcpy(&(head->compressiontype),buf+LZ_MAGIC_LEN,1);
145         memcpy(&(head->lastchar),buf+LZ_MAGIC_LEN+1,1);
146
147         /* FIXME: consider endianess on non-intel architectures */
148         memcpy(&(head->reallength),buf+LZ_MAGIC_LEN+2,4);
149
150         if (memcmp(head->magic,LZMagic,LZ_MAGIC_LEN))
151                 return 0;
152         if (head->compressiontype!='A')
153                 return LZERROR_UNKNOWNALG;
154         return 1;
155 }
156
157
158 /***********************************************************************
159  *           LZStart   (KERNEL32.@)
160  */
161 INT WINAPI LZStart(void)
162 {
163     TRACE("(void)\n");
164     return 1;
165 }
166
167
168 /***********************************************************************
169  *           LZInit   (KERNEL32.@)
170  *
171  * initializes internal decompression buffers, returns lzfiledescriptor.
172  * (return value the same as hfSrc, if hfSrc is not compressed)
173  * on failure, returns error code <0
174  * lzfiledescriptors range from 0x400 to 0x410 (only 16 open files per process)
175  *
176  * since _llseek uses the same types as libc.lseek, we just use the macros of
177  *  libc
178  */
179 HFILE WINAPI LZInit( HFILE hfSrc )
180 {
181
182         struct  lzfileheader    head;
183         struct  lzstate         *lzs;
184         DWORD   ret;
185         int i;
186
187         TRACE("(%d)\n",hfSrc);
188         ret=read_header(hfSrc,&head);
189         if (ret<=0) {
190                 _llseek(hfSrc,0,SEEK_SET);
191                 return ret?ret:hfSrc;
192         }
193         for (i = 0; i < MAX_LZSTATES; i++) if (!lzstates[i]) break;
194         if (i == MAX_LZSTATES) return LZERROR_GLOBALLOC;
195         lzstates[i] = lzs = HeapAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(*lzs) );
196         if(lzs == NULL) return LZERROR_GLOBALLOC;
197
198         lzs->realfd     = hfSrc;
199         lzs->lastchar   = head.lastchar;
200         lzs->reallength = head.reallength;
201
202         lzs->get        = HeapAlloc( GetProcessHeap(), 0, GETLEN );
203         lzs->getlen     = 0;
204         lzs->getcur     = 0;
205
206         if(lzs->get == NULL) {
207                 HeapFree(GetProcessHeap(), 0, lzs);
208                 lzstates[i] = NULL;
209                 return LZERROR_GLOBALLOC;
210         }
211
212         /* Yes, preinitialize with spaces */
213         memset(lzs->table,' ',LZ_TABLE_SIZE);
214         /* Yes, start 16 byte from the END of the table */
215         lzs->curtabent  = 0xff0;
216         return LZ_MIN_HANDLE + i;
217 }
218
219
220 /***********************************************************************
221  *           LZDone   (KERNEL32.@)
222  */
223 void WINAPI LZDone(void)
224 {
225     TRACE("(void)\n");
226 }
227
228
229 /***********************************************************************
230  *           GetExpandedNameA   (KERNEL32.@)
231  *
232  * gets the full filename of the compressed file 'in' by opening it
233  * and reading the header
234  *
235  * "file." is being translated to "file"
236  * "file.bl_" (with lastchar 'a') is being translated to "file.bla"
237  * "FILE.BL_" (with lastchar 'a') is being translated to "FILE.BLA"
238  */
239
240 INT WINAPI GetExpandedNameA( LPSTR in, LPSTR out )
241 {
242         struct lzfileheader     head;
243         HFILE           fd;
244         OFSTRUCT        ofs;
245         INT             fnislowercased,ret,len;
246         LPSTR           s,t;
247
248         TRACE("(%s)\n",in);
249         fd=OpenFile(in,&ofs,OF_READ);
250         if (fd==HFILE_ERROR)
251                 return (INT)(INT16)LZERROR_BADINHANDLE;
252         strcpy(out,in);
253         ret=read_header(fd,&head);
254         if (ret<=0) {
255                 /* not a LZ compressed file, so the expanded name is the same
256                  * as the input name */
257                 _lclose(fd);
258                 return 1;
259         }
260
261
262         /* look for directory prefix and skip it. */
263         s=out;
264         while (NULL!=(t=strpbrk(s,"/\\:")))
265                 s=t+1;
266
267         /* now mangle the basename */
268         if (!*s) {
269                 /* FIXME: hmm. shouldn't happen? */
270                 WARN("Specified a directory or what? (%s)\n",in);
271                 _lclose(fd);
272                 return 1;
273         }
274         /* see if we should use lowercase or uppercase on the last char */
275         fnislowercased=1;
276         t=s+strlen(s)-1;
277         while (t>=out) {
278                 if (!isalpha(*t)) {
279                         t--;
280                         continue;
281                 }
282                 fnislowercased=islower(*t);
283                 break;
284         }
285         if (isalpha(head.lastchar)) {
286                 if (fnislowercased)
287                         head.lastchar=tolower(head.lastchar);
288                 else
289                         head.lastchar=toupper(head.lastchar);
290         }
291
292         /* now look where to replace the last character */
293         if (NULL!=(t=strchr(s,'.'))) {
294                 if (t[1]=='\0') {
295                         t[0]='\0';
296                 } else {
297                         len=strlen(t)-1;
298                         if (t[len]=='_')
299                                 t[len]=head.lastchar;
300                 }
301         } /* else no modification necessary */
302         _lclose(fd);
303         return 1;
304 }
305
306
307 /***********************************************************************
308  *           GetExpandedNameW   (KERNEL32.@)
309  */
310 INT WINAPI GetExpandedNameW( LPWSTR in, LPWSTR out )
311 {
312     INT ret;
313     DWORD len = WideCharToMultiByte( CP_ACP, 0, in, -1, NULL, 0, NULL, NULL );
314     char *xin = HeapAlloc( GetProcessHeap(), 0, len );
315     char *xout = HeapAlloc( GetProcessHeap(), 0, len+3 );
316     WideCharToMultiByte( CP_ACP, 0, in, -1, xin, len, NULL, NULL );
317     if ((ret = GetExpandedNameA( xin, xout )) > 0)
318         MultiByteToWideChar( CP_ACP, 0, xout, -1, out, strlenW(in)+4 );
319     HeapFree( GetProcessHeap(), 0, xin );
320     HeapFree( GetProcessHeap(), 0, xout );
321     return ret;
322 }
323
324
325 /***********************************************************************
326  *           LZRead   (KERNEL32.@)
327  */
328 INT WINAPI LZRead( HFILE fd, LPSTR vbuf, INT toread )
329 {
330         int     howmuch;
331         BYTE    b,*buf;
332         struct  lzstate *lzs;
333
334         buf=(LPBYTE)vbuf;
335         TRACE("(%d,%p,%d)\n",fd,buf,toread);
336         howmuch=toread;
337         if (!(lzs = GET_LZ_STATE(fd))) return _lread(fd,buf,toread);
338
339 /* The decompressor itself is in a define, cause we need it twice
340  * in this function. (the decompressed byte will be in b)
341  */
342 #define DECOMPRESS_ONE_BYTE                                             \
343                 if (lzs->stringlen) {                                   \
344                         b               = lzs->table[lzs->stringpos];   \
345                         lzs->stringpos  = (lzs->stringpos+1)&0xFFF;     \
346                         lzs->stringlen--;                               \
347                 } else {                                                \
348                         if (!(lzs->bytetype&0x100)) {                   \
349                                 if (1!=GET(lzs,b))                      \
350                                         return toread-howmuch;          \
351                                 lzs->bytetype = b|0xFF00;               \
352                         }                                               \
353                         if (lzs->bytetype & 1) {                        \
354                                 if (1!=GET(lzs,b))                      \
355                                         return toread-howmuch;          \
356                         } else {                                        \
357                                 BYTE    b1,b2;                          \
358                                                                         \
359                                 if (1!=GET(lzs,b1))                     \
360                                         return toread-howmuch;          \
361                                 if (1!=GET(lzs,b2))                     \
362                                         return toread-howmuch;          \
363                                 /* Format:                              \
364                                  * b1 b2                                \
365                                  * AB CD                                \
366                                  * where CAB is the stringoffset in the table\
367                                  * and D+3 is the len of the string     \
368                                  */                                     \
369                                 lzs->stringpos  = b1|((b2&0xf0)<<4);    \
370                                 lzs->stringlen  = (b2&0xf)+2;           \
371                                 /* 3, but we use a  byte already below ... */\
372                                 b               = lzs->table[lzs->stringpos];\
373                                 lzs->stringpos  = (lzs->stringpos+1)&0xFFF;\
374                         }                                               \
375                         lzs->bytetype>>=1;                              \
376                 }                                                       \
377                 /* store b in table */                                  \
378                 lzs->table[lzs->curtabent++]= b;                        \
379                 lzs->curtabent  &= 0xFFF;                               \
380                 lzs->realcurrent++;
381
382         /* if someone has seeked, we have to bring the decompressor
383          * to that position
384          */
385         if (lzs->realcurrent!=lzs->realwanted) {
386                 /* if the wanted position is before the current position
387                  * I see no easy way to unroll ... We have to restart at
388                  * the beginning. *sigh*
389                  */
390                 if (lzs->realcurrent>lzs->realwanted) {
391                         /* flush decompressor state */
392                         _llseek(lzs->realfd,LZ_HEADER_LEN,SEEK_SET);
393                         GET_FLUSH(lzs);
394                         lzs->realcurrent= 0;
395                         lzs->bytetype   = 0;
396                         lzs->stringlen  = 0;
397                         memset(lzs->table,' ',LZ_TABLE_SIZE);
398                         lzs->curtabent  = 0xFF0;
399                 }
400                 while (lzs->realcurrent<lzs->realwanted) {
401                         DECOMPRESS_ONE_BYTE;
402                 }
403         }
404
405         while (howmuch) {
406                 DECOMPRESS_ONE_BYTE;
407                 lzs->realwanted++;
408                 *buf++          = b;
409                 howmuch--;
410         }
411         return  toread;
412 #undef DECOMPRESS_ONE_BYTE
413 }
414
415
416 /***********************************************************************
417  *           LZSeek   (KERNEL32.@)
418  */
419 LONG WINAPI LZSeek( HFILE fd, LONG off, INT type )
420 {
421         struct  lzstate *lzs;
422         LONG    newwanted;
423
424         TRACE("(%d,%d,%d)\n",fd,off,type);
425         /* not compressed? just use normal _llseek() */
426         if (!(lzs = GET_LZ_STATE(fd))) return _llseek(fd,off,type);
427         newwanted = lzs->realwanted;
428         switch (type) {
429         case 1: /* SEEK_CUR */
430                 newwanted      += off;
431                 break;
432         case 2: /* SEEK_END */
433                 newwanted       = lzs->reallength-off;
434                 break;
435         default:/* SEEK_SET */
436                 newwanted       = off;
437                 break;
438         }
439         if (newwanted>lzs->reallength)
440                 return LZERROR_BADVALUE;
441         if (newwanted<0)
442                 return LZERROR_BADVALUE;
443         lzs->realwanted = newwanted;
444         return newwanted;
445 }
446
447
448 /***********************************************************************
449  *           LZCopy   (KERNEL32.@)
450  *
451  * Copies everything from src to dest
452  * if src is a LZ compressed file, it will be uncompressed.
453  * will return the number of bytes written to dest or errors.
454  */
455 LONG WINAPI LZCopy( HFILE src, HFILE dest )
456 {
457         int     usedlzinit = 0, ret, wret;
458         LONG    len;
459         HFILE   oldsrc = src, srcfd;
460         FILETIME filetime;
461         struct  lzstate *lzs;
462 #define BUFLEN  1000
463         CHAR    buf[BUFLEN];
464         /* we need that weird typedef, for i can't seem to get function pointer
465          * casts right. (Or they probably just do not like WINAPI in general)
466          */
467         typedef UINT    (WINAPI *_readfun)(HFILE,LPVOID,UINT);
468
469         _readfun        xread;
470
471         TRACE("(%d,%d)\n",src,dest);
472         if (!IS_LZ_HANDLE(src)) {
473                 src = LZInit(src);
474                 if ((INT)src <= 0) return 0;
475                 if (src != oldsrc) usedlzinit=1;
476         }
477
478         /* not compressed? just copy */
479         if (!IS_LZ_HANDLE(src))
480                 xread=_lread;
481         else
482                 xread=(_readfun)LZRead;
483         len=0;
484         while (1) {
485                 ret=xread(src,buf,BUFLEN);
486                 if (ret<=0) {
487                         if (ret==0)
488                                 break;
489                         if (ret==-1)
490                                 return LZERROR_READ;
491                         return ret;
492                 }
493                 len    += ret;
494                 wret    = _lwrite(dest,buf,ret);
495                 if (wret!=ret)
496                         return LZERROR_WRITE;
497         }
498
499         /* Maintain the timestamp of source file to destination file */
500         srcfd = (!(lzs = GET_LZ_STATE(src))) ? src : lzs->realfd;
501         GetFileTime( LongToHandle(srcfd), NULL, NULL, &filetime );
502         SetFileTime( LongToHandle(dest), NULL, NULL, &filetime );
503
504         /* close handle */
505         if (usedlzinit)
506                 LZClose(src);
507         return len;
508 #undef BUFLEN
509 }
510
511 /* reverses GetExpandedPathname */
512 static LPSTR LZEXPAND_MangleName( LPCSTR fn )
513 {
514     char *p;
515     char *mfn = HeapAlloc( GetProcessHeap(), 0, strlen(fn) + 3 ); /* "._" and \0 */
516     if(mfn == NULL) return NULL;
517     strcpy( mfn, fn );
518     if (!(p = strrchr( mfn, '\\' ))) p = mfn;
519     if ((p = strchr( p, '.' )))
520     {
521         p++;
522         if (strlen(p) < 3) strcat( p, "_" );  /* append '_' */
523         else p[strlen(p)-1] = '_';  /* replace last character */
524     }
525     else strcat( mfn, "._" );   /* append "._" */
526     return mfn;
527 }
528
529
530 /***********************************************************************
531  *           LZOpenFileA   (KERNEL32.@)
532  *
533  * Opens a file. If not compressed, open it as a normal file.
534  */
535 HFILE WINAPI LZOpenFileA( LPSTR fn, LPOFSTRUCT ofs, WORD mode )
536 {
537         HFILE   fd,cfd;
538
539         TRACE("(%s,%p,%d)\n",fn,ofs,mode);
540         /* 0x70 represents all OF_SHARE_* flags, ignore them for the check */
541         fd=OpenFile(fn,ofs,mode);
542         if (fd==HFILE_ERROR)
543         {
544             LPSTR mfn = LZEXPAND_MangleName(fn);
545             fd = OpenFile(mfn,ofs,mode);
546             HeapFree( GetProcessHeap(), 0, mfn );
547         }
548         if ((mode&~0x70)!=OF_READ)
549                 return fd;
550         if (fd==HFILE_ERROR)
551                 return HFILE_ERROR;
552         cfd=LZInit(fd);
553         if ((INT)cfd <= 0) return fd;
554         return cfd;
555 }
556
557
558 /***********************************************************************
559  *           LZOpenFileW   (KERNEL32.@)
560  */
561 HFILE WINAPI LZOpenFileW( LPWSTR fn, LPOFSTRUCT ofs, WORD mode )
562 {
563     HFILE ret;
564     DWORD len = WideCharToMultiByte( CP_ACP, 0, fn, -1, NULL, 0, NULL, NULL );
565     LPSTR xfn = HeapAlloc( GetProcessHeap(), 0, len );
566     WideCharToMultiByte( CP_ACP, 0, fn, -1, xfn, len, NULL, NULL );
567     ret = LZOpenFileA(xfn,ofs,mode);
568     HeapFree( GetProcessHeap(), 0, xfn );
569     return ret;
570 }
571
572
573 /***********************************************************************
574  *           LZClose   (KERNEL32.@)
575  */
576 void WINAPI LZClose( HFILE fd )
577 {
578         struct lzstate *lzs;
579
580         TRACE("(%d)\n",fd);
581         if (!(lzs = GET_LZ_STATE(fd))) _lclose(fd);
582         else
583         {
584             HeapFree( GetProcessHeap(), 0, lzs->get );
585             CloseHandle( LongToHandle(lzs->realfd) );
586             lzstates[fd - LZ_MIN_HANDLE] = NULL;
587             HeapFree( GetProcessHeap(), 0, lzs );
588         }
589 }