Added DebugBreak.
[wine] / dlls / version / install.c
1 /* 
2  * Implementation of VERSION.DLL - File Installer routines
3  * 
4  * Copyright 1996,1997 Marcus Meissner
5  * Copyright 1997 David Cuthbert
6  */
7
8 #include <stdlib.h>
9 #include <string.h>
10
11 #include "windef.h"
12 #include "winver.h"
13 #include "wine/winestring.h"
14 #include "winerror.h"
15 #include "heap.h"
16 #include "lzexpand.h"
17 #include "xmalloc.h"
18 #include "debugtools.h"
19
20 DEFAULT_DEBUG_CHANNEL(ver)
21
22
23 /******************************************************************************
24  *
25  *   void  ver_dstring(
26  *      char const * prologue,
27  *      char const * teststring,
28  *      char const * epilogue )
29  *
30  *   This function will print via dprintf[_]ver to stddeb the prologue string,
31  *   followed by the address of teststring and the string it contains if
32  *   teststring is non-null or "(null)" otherwise, and then the epilogue
33  *   string followed by a new line.
34  *
35  *   Revision history
36  *      30-May-1997 Dave Cuthbert (dacut@ece.cmu.edu)
37  *         Original implementation as dprintf[_]ver_string
38  *      05-Jul-1997 Dave Cuthbert (dacut@ece.cmu.edu)
39  *         Fixed problem that caused bug with tools/make_debug -- renaming
40  *         this function should fix the problem.
41  *      15-Feb-1998 Dimitrie Paun (dimi@cs.toronto.edu)
42  *         Modified it to make it print the message using only one
43  *         dprintf[_]ver call.
44  *
45  *****************************************************************************/
46
47 static void  ver_dstring(
48     char const * prologue,
49     char const * teststring,
50     char const * epilogue )
51 {
52     TRACE("%s %p (\"%s\") %s\n", prologue,
53                 (void const *) teststring,
54                 teststring ? teststring : "(null)",
55                 epilogue);
56 }
57
58 /******************************************************************************
59  *
60  *   int  testFileExistence(
61  *      char const * path,
62  *      char const * file )
63  *
64  *   Tests whether a given path/file combination exists.  If the file does
65  *   not exist, the return value is zero.  If it does exist, the return
66  *   value is non-zero.
67  *
68  *   Revision history
69  *      30-May-1997 Dave Cuthbert (dacut@ece.cmu.edu)
70  *         Original implementation
71  *
72  *****************************************************************************/
73
74 static int  testFileExistence(
75    char const * path,
76    char const * file )
77 {
78     char  filename[1024];
79     int  filenamelen;
80     OFSTRUCT  fileinfo;
81     int  retval;
82
83     fileinfo.cBytes = sizeof(OFSTRUCT);
84
85     strcpy(filename, path);
86     filenamelen = strlen(filename);
87
88     /* Add a trailing \ if necessary */
89     if(filenamelen) {
90         if(filename[filenamelen - 1] != '\\')
91             strcat(filename, "\\");
92     }
93     else /* specify the current directory */
94         strcpy(filename, ".\\");
95
96     /* Create the full pathname */
97     strcat(filename, file);
98
99     if(OpenFile(filename, &fileinfo, OF_EXIST) == HFILE_ERROR)
100         retval = 0;
101     else
102         retval = 1;
103
104     return  retval;
105 }
106
107 /******************************************************************************
108  *
109  *   int  testFileExclusiveExistence(
110  *      char const * path,
111  *      char const * file )
112  *
113  *   Tests whether a given path/file combination exists and ensures that no
114  *   other programs have handles to the given file.  If the file does not
115  *   exist or is open, the return value is zero.  If it does exist, the
116  *   return value is non-zero.
117  *
118  *   Revision history
119  *      30-May-1997 Dave Cuthbert (dacut@ece.cmu.edu)
120  *         Original implementation
121  *
122  *****************************************************************************/
123
124 static int  testFileExclusiveExistence(
125    char const * path,
126    char const * file )
127 {
128     char  filename[1024];
129     int  filenamelen;
130     OFSTRUCT  fileinfo;
131     int  retval;
132
133     fileinfo.cBytes = sizeof(OFSTRUCT);
134
135     strcpy(filename, path);
136     filenamelen = strlen(filename);
137
138     /* Add a trailing \ if necessary */
139     if(filenamelen) {
140         if(filename[filenamelen - 1] != '\\')
141             strcat(filename, "\\");
142     }
143     else /* specify the current directory */
144         strcpy(filename, ".\\");
145
146     /* Create the full pathname */
147     strcat(filename, file);
148
149     if(OpenFile(filename, &fileinfo, OF_EXIST | OF_SHARE_EXCLUSIVE) ==
150        HFILE_ERROR)
151         retval = 0;
152     else
153         retval = 1;
154
155     return retval;
156 }
157
158 /*****************************************************************************
159  *
160  *   VerFindFile() [VER.8]
161  *   Determines where to install a file based on whether it locates another
162  *   version of the file in the system.  The values VerFindFile returns are
163  *   used in a subsequent call to the VerInstallFile function.
164  *
165  *   Revision history:
166  *      30-May-1997   Dave Cuthbert (dacut@ece.cmu.edu)
167  *         Reimplementation of VerFindFile from original stub.
168  *
169  ****************************************************************************/
170
171 /* VerFindFile32A                                               [VERSION.5] */
172 DWORD WINAPI VerFindFileA(
173     UINT flags,
174     LPCSTR lpszFilename,
175     LPCSTR lpszWinDir,
176     LPCSTR lpszAppDir,
177     LPSTR lpszCurDir,
178     UINT *lpuCurDirLen,
179     LPSTR lpszDestDir,
180     UINT *lpuDestDirLen )
181 {
182     DWORD  retval;
183     char  curDir[256];
184     char  destDir[256];
185     unsigned int  curDirSizeReq;
186     unsigned int  destDirSizeReq;
187
188     retval = 0;
189
190     /* Print out debugging information */
191     TRACE("called with parameters:\n"
192                  "\tflags = %x", flags);
193     if(flags & VFFF_ISSHAREDFILE)
194         TRACE(" (VFFF_ISSHAREDFILE)\n");
195     else
196         TRACE("\n");
197
198     ver_dstring("\tlpszFilename = ", lpszFilename, "");
199     ver_dstring("\tlpszWinDir = ", lpszWinDir, "");
200     ver_dstring("\tlpszAppDir = ", lpszAppDir, "");
201
202     TRACE("\tlpszCurDir = %p\n", lpszCurDir);
203     if(lpuCurDirLen)
204         TRACE("\tlpuCurDirLen = %p (%u)\n",
205                     lpuCurDirLen, *lpuCurDirLen);
206     else
207         TRACE("\tlpuCurDirLen = (null)\n");
208
209     TRACE("\tlpszDestDir = %p\n", lpszDestDir);
210     if(lpuDestDirLen)
211         TRACE("\tlpuDestDirLen = %p (%u)\n",
212                     lpuDestDirLen, *lpuDestDirLen);
213
214     /* Figure out where the file should go; shared files default to the
215        system directory */
216
217     strcpy(curDir, "");
218     strcpy(destDir, "");
219
220     if(flags & VFFF_ISSHAREDFILE) {
221         GetSystemDirectoryA(destDir, 256);
222
223         /* Were we given a filename?  If so, try to find the file. */
224         if(lpszFilename) {
225             if(testFileExistence(destDir, lpszFilename)) {
226                 strcpy(curDir, destDir);
227
228                 if(!testFileExclusiveExistence(destDir, lpszFilename))
229                     retval |= VFF_FILEINUSE;
230             }
231             else if(lpszAppDir && testFileExistence(lpszAppDir,
232                                                     lpszFilename)) {
233                 strcpy(curDir, lpszAppDir);
234                 retval |= VFF_CURNEDEST;
235
236                 if(!testFileExclusiveExistence(lpszAppDir, lpszFilename))
237                     retval |= VFF_FILEINUSE;
238             }
239         }
240     }
241     else if(!(flags & VFFF_ISSHAREDFILE)) { /* not a shared file */
242         if(lpszAppDir) {
243             char  systemDir[256];
244             GetSystemDirectoryA(systemDir, 256);
245
246             strcpy(destDir, lpszAppDir);
247
248             if(lpszFilename) {
249                 if(testFileExistence(lpszAppDir, lpszFilename)) {
250                     strcpy(curDir, lpszAppDir);
251
252                     if(!testFileExclusiveExistence(lpszAppDir, lpszFilename))
253                         retval |= VFF_FILEINUSE;
254                 }
255                 else if(testFileExistence(systemDir, lpszFilename)) {
256                     strcpy(curDir, systemDir);
257                     retval |= VFF_CURNEDEST;
258
259                     if(!testFileExclusiveExistence(systemDir, lpszFilename))
260                         retval |= VFF_FILEINUSE;
261                 }
262             }
263         }
264     }
265
266     curDirSizeReq = strlen(curDir) + 1;
267     destDirSizeReq = strlen(destDir) + 1;
268
269
270
271     /* Make sure that the pointers to the size of the buffers are
272        valid; if not, do NOTHING with that buffer.  If that pointer
273        is valid, then make sure that the buffer pointer is valid, too! */
274
275     if(lpuDestDirLen && lpszDestDir) {
276         if(*lpuDestDirLen < destDirSizeReq) {
277             retval |= VFF_BUFFTOOSMALL;
278             if (*lpuDestDirLen) {
279             strncpy(lpszDestDir, destDir, *lpuDestDirLen - 1);
280             lpszDestDir[*lpuDestDirLen - 1] = '\0';
281         }
282         }
283         else
284             strcpy(lpszDestDir, destDir);
285
286         *lpuDestDirLen = destDirSizeReq;
287     }
288     
289     if(lpuCurDirLen && lpszCurDir) {
290         if(*lpuCurDirLen < curDirSizeReq) {
291             retval |= VFF_BUFFTOOSMALL;
292             if (*lpuCurDirLen) {
293             strncpy(lpszCurDir, curDir, *lpuCurDirLen - 1);
294             lpszCurDir[*lpuCurDirLen - 1] = '\0';
295             }
296         }
297         else
298             strcpy(lpszCurDir, curDir);
299
300         *lpuCurDirLen = curDirSizeReq;
301     }
302
303     TRACE("ret = %lu (%s%s%s)\n", retval,
304                  (retval & VFF_CURNEDEST) ? "VFF_CURNEDEST " : "",
305                  (retval & VFF_FILEINUSE) ? "VFF_FILEINUSE " : "",
306                  (retval & VFF_BUFFTOOSMALL) ? "VFF_BUFFTOOSMALL " : "");
307
308     ver_dstring("\t(Exit) lpszCurDir = ", lpszCurDir, "");
309     if(lpuCurDirLen)
310         TRACE("\t(Exit) lpuCurDirLen = %p (%u)\n",
311                     lpuCurDirLen, *lpuCurDirLen);
312     else
313         TRACE("\t(Exit) lpuCurDirLen = (null)\n");
314
315     ver_dstring("\t(Exit) lpszDestDir = ", lpszDestDir, "");
316     if(lpuDestDirLen)
317         TRACE("\t(Exit) lpuDestDirLen = %p (%u)\n",
318                     lpuDestDirLen, *lpuDestDirLen);
319
320     return retval;
321 }
322
323 /* VerFindFile32W                                               [VERSION.6] */
324 DWORD WINAPI VerFindFileW(
325         UINT flags,LPCWSTR filename,LPCWSTR windir,LPCWSTR appdir,
326         LPWSTR curdir,UINT *pcurdirlen,LPWSTR destdir,UINT *pdestdirlen )
327 {
328     UINT curdirlen, destdirlen;
329     LPSTR wfn,wwd,wad,wdd,wcd;
330     DWORD ret;
331
332     wfn = HEAP_strdupWtoA( GetProcessHeap(), 0, filename );
333     wwd = HEAP_strdupWtoA( GetProcessHeap(), 0, windir );
334     wad = HEAP_strdupWtoA( GetProcessHeap(), 0, appdir );
335     wcd = HeapAlloc( GetProcessHeap(), 0, *pcurdirlen );
336     wdd = HeapAlloc( GetProcessHeap(), 0, *pdestdirlen );
337     ret = VerFindFileA(flags,wfn,wwd,wad,wcd,&curdirlen,wdd,&destdirlen);
338     lstrcpynAtoW(curdir,wcd,*pcurdirlen);
339     lstrcpynAtoW(destdir,wdd,*pdestdirlen);
340     *pcurdirlen = strlen(wcd);
341     *pdestdirlen = strlen(wdd);
342     HeapFree( GetProcessHeap(), 0, wfn );
343     HeapFree( GetProcessHeap(), 0, wwd );
344     HeapFree( GetProcessHeap(), 0, wad );
345     HeapFree( GetProcessHeap(), 0, wcd );
346     HeapFree( GetProcessHeap(), 0, wdd );
347     return ret;
348 }
349
350 static LPBYTE
351 _fetch_versioninfo(LPSTR fn,VS_FIXEDFILEINFO **vffi) {
352     DWORD       alloclen;
353     LPBYTE      buf;
354     DWORD       ret;
355
356     alloclen = 1000;
357     buf= xmalloc(alloclen);
358     while (1) {
359         ret = GetFileVersionInfoA(fn,0,alloclen,buf);
360         if (!ret) {
361             free(buf);
362             return 0;
363         }
364         if (alloclen<*(WORD*)buf) {
365             free(buf);
366             alloclen = *(WORD*)buf;
367             buf = xmalloc(alloclen);
368         } else {
369             *vffi = (VS_FIXEDFILEINFO*)(buf+0x14);
370             if ((*vffi)->dwSignature == 0x004f0049) /* hack to detect unicode */
371                 *vffi = (VS_FIXEDFILEINFO*)(buf+0x28);
372             if ((*vffi)->dwSignature != VS_FFI_SIGNATURE)
373                 WARN("Bad VS_FIXEDFILEINFO signature 0x%08lx\n",(*vffi)->dwSignature);
374             return buf;
375         }
376     }
377 }
378
379 static DWORD
380 _error2vif(DWORD error) {
381     switch (error) {
382     case ERROR_ACCESS_DENIED:
383         return VIF_ACCESSVIOLATION;
384     case ERROR_SHARING_VIOLATION:
385         return VIF_SHARINGVIOLATION;
386     default:
387         return 0;
388     }
389 }
390
391
392 /******************************************************************************
393  * VerInstallFile32A [VERSION.7]
394  */
395 DWORD WINAPI VerInstallFileA(
396         UINT flags,LPCSTR srcfilename,LPCSTR destfilename,LPCSTR srcdir,
397         LPCSTR destdir,LPCSTR curdir,LPSTR tmpfile,UINT *tmpfilelen )
398 {
399     LPCSTR pdest;
400     char        destfn[260],tmpfn[260],srcfn[260];
401     HFILE       hfsrc,hfdst;
402     DWORD       attr,ret,xret,tmplast;
403     LPBYTE      buf1,buf2;
404     OFSTRUCT    ofs;
405
406     TRACE("(%x,%s,%s,%s,%s,%s,%p,%d)\n",
407             flags,srcfilename,destfilename,srcdir,destdir,curdir,tmpfile,*tmpfilelen
408     );
409     xret = 0;
410     sprintf(srcfn,"%s\\%s",srcdir,srcfilename);
411     if (!destdir || !*destdir) pdest = srcdir;
412     else pdest = destdir;
413     sprintf(destfn,"%s\\%s",pdest,destfilename);
414     hfsrc=LZOpenFileA(srcfn,&ofs,OF_READ);
415     if (hfsrc==HFILE_ERROR)
416         return VIF_CANNOTREADSRC;
417     sprintf(tmpfn,"%s\\%s",pdest,destfilename);
418     tmplast=strlen(pdest)+1;
419     attr = GetFileAttributesA(tmpfn);
420     if (attr!=-1) {
421         if (attr & FILE_ATTRIBUTE_READONLY) {
422             LZClose(hfsrc);
423             return VIF_WRITEPROT;
424         }
425         /* FIXME: check if file currently in use and return VIF_FILEINUSE */
426     }
427     attr = -1;
428     if (flags & VIFF_FORCEINSTALL) {
429         if (tmpfile[0]) {
430             sprintf(tmpfn,"%s\\%s",pdest,tmpfile);
431             tmplast = strlen(pdest)+1;
432             attr = GetFileAttributesA(tmpfn);
433             /* if it exists, it has been copied by the call before.
434              * we jump over the copy part... 
435              */
436         }
437     }
438     if (attr == -1) {
439         char    *s;
440
441         GetTempFileNameA(pdest,"ver",0,tmpfn); /* should not fail ... */
442         s=strrchr(tmpfn,'\\');
443         if (s)
444             tmplast = s-tmpfn;
445         else
446             tmplast = 0;
447         hfdst = OpenFile(tmpfn,&ofs,OF_CREATE);
448         if (hfdst == HFILE_ERROR) {
449             LZClose(hfsrc);
450             return VIF_CANNOTCREATE; /* | translated dos error */
451         }
452         ret = LZCopy(hfsrc,hfdst);
453         _lclose(hfdst);
454         if (((long) ret) < 0) {
455             /* translate LZ errors into VIF_xxx */
456             switch (ret) {
457             case LZERROR_BADINHANDLE:
458             case LZERROR_READ:
459             case LZERROR_BADVALUE:
460             case LZERROR_UNKNOWNALG:
461                 ret = VIF_CANNOTREADSRC;
462                 break;
463             case LZERROR_BADOUTHANDLE:
464             case LZERROR_WRITE:
465                 ret = VIF_OUTOFMEMORY; /* FIXME: correct? */
466                 break;
467             case LZERROR_GLOBALLOC:
468             case LZERROR_GLOBLOCK:
469                 ret = VIF_OUTOFSPACE;
470                 break;
471             default: /* unknown error, should not happen */
472                 ret = 0;
473                 break;
474             }
475             if (ret) {
476                 LZClose(hfsrc);
477                 return ret;
478             }
479         }
480     }
481     xret = 0;
482     if (!(flags & VIFF_FORCEINSTALL)) {
483         VS_FIXEDFILEINFO *destvffi,*tmpvffi;
484         buf1 = _fetch_versioninfo(destfn,&destvffi);
485         if (buf1) {
486             buf2 = _fetch_versioninfo(tmpfn,&tmpvffi);
487             if (buf2) {
488                 char    *tbuf1,*tbuf2;
489                 UINT    len1,len2;
490
491                 len1=len2=40;
492
493                 /* compare file versions */
494                 if ((destvffi->dwFileVersionMS > tmpvffi->dwFileVersionMS)||
495                     ((destvffi->dwFileVersionMS==tmpvffi->dwFileVersionMS)&&
496                      (destvffi->dwFileVersionLS > tmpvffi->dwFileVersionLS)
497                     )
498                 )
499                     xret |= VIF_MISMATCH|VIF_SRCOLD;
500                 /* compare filetypes and filesubtypes */
501                 if ((destvffi->dwFileType!=tmpvffi->dwFileType) ||
502                     (destvffi->dwFileSubtype!=tmpvffi->dwFileSubtype)
503                 )
504                     xret |= VIF_MISMATCH|VIF_DIFFTYPE;
505                 if (VerQueryValueA(buf1,"\\VarFileInfo\\Translation",(LPVOID*)&tbuf1,&len1) &&
506                     VerQueryValueA(buf2,"\\VarFileInfo\\Translation",(LPVOID*)&tbuf2,&len2)
507                 ) {
508                     /* irgendwas mit tbuf1 und tbuf2 machen 
509                      * generiert DIFFLANG|MISMATCH
510                      */
511                 }
512                 free(buf2);
513             } else
514                 xret=VIF_MISMATCH|VIF_SRCOLD;
515             free(buf1);
516         }
517     }
518     if (xret) {
519         if (*tmpfilelen<strlen(tmpfn+tmplast)) {
520             xret|=VIF_BUFFTOOSMALL;
521             DeleteFileA(tmpfn);
522         } else {
523             strcpy(tmpfile,tmpfn+tmplast);
524             *tmpfilelen = strlen(tmpfn+tmplast)+1;
525             xret|=VIF_TEMPFILE;
526         }
527     } else {
528         if (-1!=GetFileAttributesA(destfn))
529             if (!DeleteFileA(destfn)) {
530                 xret|=_error2vif(GetLastError())|VIF_CANNOTDELETE;
531                 DeleteFileA(tmpfn);
532                 LZClose(hfsrc);
533                 return xret;
534             }
535         if ((!(flags & VIFF_DONTDELETEOLD))     && 
536             curdir                              && 
537             *curdir                             &&
538             lstrcmpiA(curdir,pdest)
539         ) {
540             char curfn[260];
541
542             sprintf(curfn,"%s\\%s",curdir,destfilename);
543             if (-1!=GetFileAttributesA(curfn)) {
544                 /* FIXME: check if in use ... if it is, VIF_CANNOTDELETECUR */
545                 if (!DeleteFileA(curfn))
546                     xret|=_error2vif(GetLastError())|VIF_CANNOTDELETECUR;
547             }
548         }
549         if (!MoveFileA(tmpfn,destfn)) {
550             xret|=_error2vif(GetLastError())|VIF_CANNOTRENAME;
551             DeleteFileA(tmpfn);
552         }
553     }
554     LZClose(hfsrc);
555     return xret;
556 }
557
558
559 /* VerInstallFile32W                            [VERSION.8] */
560 DWORD WINAPI VerInstallFileW(
561         UINT flags,LPCWSTR srcfilename,LPCWSTR destfilename,LPCWSTR srcdir,
562         LPCWSTR destdir,LPCWSTR curdir,LPWSTR tmpfile,UINT *tmpfilelen )
563 {
564     LPSTR wsrcf,wsrcd,wdestf,wdestd,wtmpf,wcurd;
565     DWORD ret;
566
567     wsrcf  = HEAP_strdupWtoA( GetProcessHeap(), 0, srcfilename );
568     wsrcd  = HEAP_strdupWtoA( GetProcessHeap(), 0, srcdir );
569     wdestf = HEAP_strdupWtoA( GetProcessHeap(), 0, destfilename );
570     wdestd = HEAP_strdupWtoA( GetProcessHeap(), 0, destdir );
571     wtmpf  = HEAP_strdupWtoA( GetProcessHeap(), 0, tmpfile );
572     wcurd  = HEAP_strdupWtoA( GetProcessHeap(), 0, curdir );
573     ret = VerInstallFileA(flags,wsrcf,wdestf,wsrcd,wdestd,wcurd,wtmpf,tmpfilelen);
574     if (!ret)
575         lstrcpynAtoW(tmpfile,wtmpf,*tmpfilelen);
576     HeapFree( GetProcessHeap(), 0, wsrcf );
577     HeapFree( GetProcessHeap(), 0, wsrcd );
578     HeapFree( GetProcessHeap(), 0, wdestf );
579     HeapFree( GetProcessHeap(), 0, wdestd );
580     HeapFree( GetProcessHeap(), 0, wtmpf );
581     if (wcurd) 
582         HeapFree( GetProcessHeap(), 0, wcurd );
583     return ret;
584 }
585