urlmon: Added TYMED_FILE support to CopyStgMedium.
[wine] / dlls / dbghelp / path.c
1 /*
2  * File path.c - managing path in debugging environments
3  *
4  * Copyright (C) 2004, Eric Pouech
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
21 #include "config.h"
22 #include <stdlib.h>
23 #include <stdio.h>
24 #include <string.h>
25
26 #include "dbghelp_private.h"
27 #include "winnls.h"
28 #include "winternl.h"
29 #include "wine/debug.h"
30
31 WINE_DEFAULT_DEBUG_CHANNEL(dbghelp);
32
33 static inline BOOL is_sep(char ch) {return ch == '/' || ch == '\\';}
34 static inline BOOL is_sepW(WCHAR ch) {return ch == '/' || ch == '\\';}
35
36 static inline const char* file_name(const char* str)
37 {
38     const char*       p;
39
40     for (p = str + strlen(str) - 1; p >= str && !is_sep(*p); p--);
41     return p + 1;
42 }
43
44 static inline const WCHAR* file_nameW(const WCHAR* str)
45 {
46     const WCHAR*      p;
47
48     for (p = str + strlenW(str) - 1; p >= str && !is_sepW(*p); p--);
49     return p + 1;
50 }
51
52 /******************************************************************
53  *              FindDebugInfoFile (DBGHELP.@)
54  *
55  */
56 HANDLE WINAPI FindDebugInfoFile(PCSTR FileName, PCSTR SymbolPath, PSTR DebugFilePath)
57 {
58     HANDLE      h;
59
60     h = CreateFileA(FileName, GENERIC_READ, FILE_SHARE_READ, NULL,
61                     OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL);
62     if (h == INVALID_HANDLE_VALUE)
63     {
64         if (!SearchPathA(SymbolPath, file_name(FileName), NULL, MAX_PATH, DebugFilePath, NULL))
65             return NULL;
66         h = CreateFileA(DebugFilePath, GENERIC_READ, FILE_SHARE_READ, NULL,
67                         OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL);
68     }
69     return (h == INVALID_HANDLE_VALUE) ? NULL : h;
70 }
71  
72 /******************************************************************
73  *              FindDebugInfoFileEx (DBGHELP.@)
74  *
75  */
76 HANDLE WINAPI FindDebugInfoFileEx(PCSTR FileName, PCSTR SymbolPath,
77                                   PSTR DebugFilePath, 
78                                   PFIND_DEBUG_FILE_CALLBACK Callback,
79                                   PVOID CallerData)
80 {
81     FIXME("(%s %s %p %p %p): stub\n", 
82           debugstr_a(FileName), debugstr_a(SymbolPath), debugstr_a(DebugFilePath), Callback, CallerData);
83     return NULL;
84 }
85
86 /******************************************************************
87  *              FindExecutableImageExW (DBGHELP.@)
88  *
89  */
90 HANDLE WINAPI FindExecutableImageExW(PCWSTR FileName, PCWSTR SymbolPath, PWSTR ImageFilePath,
91                                      PFIND_EXE_FILE_CALLBACKW Callback, PVOID user)
92 {
93     HANDLE h;
94
95     if (Callback) FIXME("Unsupported callback yet\n");
96     if (!SearchPathW(SymbolPath, FileName, NULL, MAX_PATH, ImageFilePath, NULL))
97         return NULL;
98     h = CreateFileW(ImageFilePath, GENERIC_READ, FILE_SHARE_READ, NULL,
99                     OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL);
100     return (h == INVALID_HANDLE_VALUE) ? NULL : h;
101 }
102
103 /******************************************************************
104  *              FindExecutableImageEx (DBGHELP.@)
105  *
106  */
107 HANDLE WINAPI FindExecutableImageEx(PCSTR FileName, PCSTR SymbolPath, PSTR ImageFilePath,
108                                     PFIND_EXE_FILE_CALLBACK Callback, PVOID user)
109 {
110     HANDLE h;
111
112     if (Callback) FIXME("Unsupported callback yet\n");
113     if (!SearchPathA(SymbolPath, FileName, NULL, MAX_PATH, ImageFilePath, NULL))
114         return NULL;
115     h = CreateFileA(ImageFilePath, GENERIC_READ, FILE_SHARE_READ, NULL,
116                     OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL);
117     return (h == INVALID_HANDLE_VALUE) ? NULL : h;
118 }
119
120 /******************************************************************
121  *              FindExecutableImage (DBGHELP.@)
122  *
123  */
124 HANDLE WINAPI FindExecutableImage(PCSTR FileName, PCSTR SymbolPath, PSTR ImageFilePath)
125 {
126     return FindExecutableImageEx(FileName, SymbolPath, ImageFilePath, NULL, NULL);
127 }
128
129 /***********************************************************************
130  *           MakeSureDirectoryPathExists (DBGHELP.@)
131  */
132 BOOL WINAPI MakeSureDirectoryPathExists(PCSTR DirPath)
133 {
134     char path[MAX_PATH];
135     const char *p = DirPath;
136     int  n;
137
138     if (p[0] && p[1] == ':') p += 2;
139     while (*p == '\\') p++; /* skip drive root */
140     while ((p = strchr(p, '\\')) != NULL)
141     {
142        n = p - DirPath + 1;
143        memcpy(path, DirPath, n);
144        path[n] = '\0';
145        if( !CreateDirectoryA(path, NULL)            &&
146            (GetLastError() != ERROR_ALREADY_EXISTS))
147            return FALSE;
148        p++;
149     }
150     if (GetLastError() == ERROR_ALREADY_EXISTS)
151        SetLastError(ERROR_SUCCESS);
152
153     return TRUE;
154 }
155
156 /******************************************************************
157  *              SymMatchFileNameW (DBGHELP.@)
158  *
159  */
160 BOOL WINAPI SymMatchFileNameW(PCWSTR file, PCWSTR match,
161                               PWSTR* filestop, PWSTR* matchstop)
162 {
163     PCWSTR fptr;
164     PCWSTR mptr;
165
166     TRACE("(%s %s %p %p)\n",
167           debugstr_w(file), debugstr_w(match), filestop, matchstop);
168
169     fptr = file + strlenW(file) - 1;
170     mptr = match + strlenW(match) - 1;
171
172     while (fptr >= file && mptr >= match)
173     {
174         if (toupperW(*fptr) != toupperW(*mptr) && !(is_sepW(*fptr) && is_sepW(*mptr)))
175             break;
176         fptr--; mptr--;
177     }
178     if (filestop) *filestop = (PWSTR)fptr;
179     if (matchstop) *matchstop = (PWSTR)mptr;
180
181     return mptr == match - 1;
182 }
183
184 /******************************************************************
185  *              SymMatchFileName (DBGHELP.@)
186  *
187  */
188 BOOL WINAPI SymMatchFileName(PCSTR file, PCSTR match,
189                              PSTR* filestop, PSTR* matchstop)
190 {
191     PCSTR fptr;
192     PCSTR mptr;
193
194     TRACE("(%s %s %p %p)\n", debugstr_a(file), debugstr_a(match), filestop, matchstop);
195
196     fptr = file + strlen(file) - 1;
197     mptr = match + strlen(match) - 1;
198
199     while (fptr >= file && mptr >= match)
200     {
201         if (toupper(*fptr) != toupper(*mptr) && !(is_sep(*fptr) && is_sep(*mptr)))
202             break;
203         fptr--; mptr--;
204     }
205     if (filestop) *filestop = (PSTR)fptr;
206     if (matchstop) *matchstop = (PSTR)mptr;
207
208     return mptr == match - 1;
209 }
210
211 static BOOL do_searchW(PCWSTR file, PWSTR buffer, BOOL recurse,
212                        PENUMDIRTREE_CALLBACKW cb, PVOID user)
213 {
214     HANDLE              h;
215     WIN32_FIND_DATAW    fd;
216     unsigned            pos;
217     BOOL                found = FALSE;
218     static const WCHAR  S_AllW[] = {'*','.','*','\0'};
219     static const WCHAR  S_DotW[] = {'.','\0'};
220     static const WCHAR  S_DotDotW[] = {'.','.','\0'};
221
222     pos = strlenW(buffer);
223     if (buffer[pos - 1] != '\\') buffer[pos++] = '\\';
224     strcpyW(buffer + pos, S_AllW);
225     if ((h = FindFirstFileW(buffer, &fd)) == INVALID_HANDLE_VALUE)
226         return FALSE;
227     /* doc doesn't specify how the tree is enumerated...
228      * doing a depth first based on, but may be wrong
229      */
230     do
231     {
232         if (!strcmpW(fd.cFileName, S_DotW) || !strcmpW(fd.cFileName, S_DotDotW)) continue;
233
234         strcpyW(buffer + pos, fd.cFileName);
235         if (recurse && (fd.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY))
236             found = do_searchW(file, buffer, TRUE, cb, user);
237         else if (SymMatchFileNameW(buffer, (WCHAR*)file, NULL, NULL))
238         {
239             if (!cb || cb(buffer, user)) found = TRUE;
240         }
241     } while (!found && FindNextFileW(h, &fd));
242     if (!found) buffer[--pos] = '\0';
243     FindClose(h);
244
245     return found;
246 }
247
248 /***********************************************************************
249  *           SearchTreeForFileW (DBGHELP.@)
250  */
251 BOOL WINAPI SearchTreeForFileW(PCWSTR root, PCWSTR file, PWSTR buffer)
252 {
253     TRACE("(%s, %s, %p)\n",
254           debugstr_w(root), debugstr_w(file), buffer);
255     strcpyW(buffer, root);
256     return do_searchW(file, buffer, TRUE, NULL, NULL);
257 }
258
259 /***********************************************************************
260  *           SearchTreeForFile (DBGHELP.@)
261  */
262 BOOL WINAPI SearchTreeForFile(PCSTR root, PCSTR file, PSTR buffer)
263 {
264     WCHAR       rootW[MAX_PATH];
265     WCHAR       fileW[MAX_PATH];
266     WCHAR       bufferW[MAX_PATH];
267     BOOL        ret;
268
269     MultiByteToWideChar(CP_ACP, 0, root, -1, rootW, MAX_PATH);
270     MultiByteToWideChar(CP_ACP, 0, file, -1, fileW, MAX_PATH);
271     ret = SearchTreeForFileW(rootW, fileW, bufferW);
272     if (ret)
273         WideCharToMultiByte(CP_ACP, 0, bufferW, -1, buffer, MAX_PATH, NULL, NULL);
274     return ret;
275 }
276
277 /******************************************************************
278  *              EnumDirTreeW (DBGHELP.@)
279  *
280  *
281  */
282 BOOL WINAPI EnumDirTreeW(HANDLE hProcess, PCWSTR root, PCWSTR file,
283                         PWSTR buffer, PENUMDIRTREE_CALLBACKW cb, PVOID user)
284 {
285     TRACE("(%p %s %s %p %p %p)\n",
286           hProcess, debugstr_w(root), debugstr_w(file), buffer, cb, user);
287
288     strcpyW(buffer, root);
289     return do_searchW(file, buffer, TRUE, cb, user);
290 }
291
292 /******************************************************************
293  *              EnumDirTree (DBGHELP.@)
294  *
295  *
296  */
297 struct enum_dir_treeWA
298 {
299     PENUMDIRTREE_CALLBACK       cb;
300     void*                       user;
301     char                        name[MAX_PATH];
302 };
303
304 static BOOL CALLBACK enum_dir_treeWA(PCWSTR name, PVOID user)
305 {
306     struct enum_dir_treeWA*     edt = user;
307
308     WideCharToMultiByte(CP_ACP, 0, name, -1, edt->name, MAX_PATH, NULL, NULL);
309     return edt->cb(edt->name, edt->user);
310 }
311
312 BOOL WINAPI EnumDirTree(HANDLE hProcess, PCSTR root, PCSTR file,
313                         PSTR buffer, PENUMDIRTREE_CALLBACK cb, PVOID user)
314 {
315     WCHAR                       rootW[MAX_PATH];
316     WCHAR                       fileW[MAX_PATH];
317     WCHAR                       bufferW[MAX_PATH];
318     struct enum_dir_treeWA      edt;
319     BOOL                        ret;
320
321     edt.cb = cb;
322     edt.user = user;
323     MultiByteToWideChar(CP_ACP, 0, root, -1, rootW, MAX_PATH);
324     MultiByteToWideChar(CP_ACP, 0, file, -1, fileW, MAX_PATH);
325     if ((ret = EnumDirTreeW(hProcess, rootW, fileW, bufferW, enum_dir_treeWA, &edt)))
326         WideCharToMultiByte(CP_ACP, 0, bufferW, -1, buffer, MAX_PATH, NULL, NULL);
327     return ret;
328 }
329
330 struct sffip
331 {
332     enum module_type            kind;
333     /* pe:  id  -> DWORD:timestamp
334      *      two -> size of image (from PE header)
335      * pdb: id  -> PDB signature
336      *            I think either DWORD:timestamp or GUID:guid depending on PDB version
337      *      two -> PDB age ???
338      * elf: id  -> DWORD:CRC 32 of ELF image (Wine only)
339      */
340     PVOID                       id;
341     DWORD                       two;
342     DWORD                       three;
343     DWORD                       flags;
344     PFINDFILEINPATHCALLBACKW    cb;
345     void*                       user;
346 };
347
348 /* checks that buffer (as found by matching the name) matches the info
349  * (information is based on file type)
350  * returns TRUE when file is found, FALSE to continue searching
351  * (NB this is the opposite convention of SymFindFileInPathProc)
352  */
353 static BOOL CALLBACK sffip_cb(PCWSTR buffer, PVOID user)
354 {
355     struct sffip*       s = (struct sffip*)user;
356     DWORD               size, checksum;
357
358     /* FIXME: should check that id/two/three match the file pointed
359      * by buffer
360      */
361     switch (s->kind)
362     {
363     case DMT_PE:
364         {
365             HANDLE  hFile, hMap;
366             void*   mapping;
367             DWORD   timestamp;
368
369             timestamp = ~(DWORD_PTR)s->id;
370             size = ~s->two;
371             hFile = CreateFileW(buffer, GENERIC_READ, FILE_SHARE_READ, NULL,
372                                 OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL);
373             if (hFile == INVALID_HANDLE_VALUE) return FALSE;
374             if ((hMap = CreateFileMappingW(hFile, NULL, PAGE_READONLY, 0, 0, NULL)) != NULL)
375             {
376                 if ((mapping = MapViewOfFile(hMap, FILE_MAP_READ, 0, 0, 0)) != NULL)
377                 {
378                     IMAGE_NT_HEADERS*   nth = RtlImageNtHeader(mapping);
379                     timestamp = nth->FileHeader.TimeDateStamp;
380                     size = nth->OptionalHeader.SizeOfImage;
381                     UnmapViewOfFile(mapping);
382                 }
383                 CloseHandle(hMap);
384             }
385             CloseHandle(hFile);
386             if (timestamp != (DWORD_PTR)s->id || size != s->two)
387             {
388                 WARN("Found %s, but wrong size or timestamp\n", debugstr_w(buffer));
389                 return FALSE;
390             }
391         }
392         break;
393     case DMT_ELF:
394         if (elf_fetch_file_info(buffer, 0, &size, &checksum))
395         {
396             if (checksum != (DWORD_PTR)s->id)
397             {
398                 WARN("Found %s, but wrong checksums: %08x %08lx\n",
399                      debugstr_w(buffer), checksum, (DWORD_PTR)s->id);
400                 return FALSE;
401             }
402         }
403         else
404         {
405             WARN("Couldn't read %s\n", debugstr_w(buffer));
406             return FALSE;
407         }
408         break;
409     case DMT_PDB:
410         {
411             struct pdb_lookup   pdb_lookup;
412             char                fn[MAX_PATH];
413
414             WideCharToMultiByte(CP_ACP, 0, buffer, -1, fn, MAX_PATH, NULL, NULL);
415             pdb_lookup.filename = fn;
416
417             if (!pdb_fetch_file_info(&pdb_lookup)) return FALSE;
418             switch (pdb_lookup.kind)
419             {
420             case PDB_JG:
421                 if (s->flags & SSRVOPT_GUIDPTR)
422                 {
423                     WARN("Found %s, but wrong PDB version\n", debugstr_w(buffer));
424                     return FALSE;
425                 }
426                 if (pdb_lookup.u.jg.timestamp != (DWORD_PTR)s->id)
427                 {
428                     WARN("Found %s, but wrong signature: %08x %08lx\n",
429                          debugstr_w(buffer), pdb_lookup.u.jg.timestamp, (DWORD_PTR)s->id);
430                     return FALSE;
431                 }
432                 break;
433             case PDB_DS:
434                 if (!(s->flags & SSRVOPT_GUIDPTR))
435                 {
436                     WARN("Found %s, but wrong PDB version\n", debugstr_w(buffer));
437                     return FALSE;
438                 }
439                 if (memcmp(&pdb_lookup.u.ds.guid, (GUID*)s->id, sizeof(GUID)))
440                 {
441                     WARN("Found %s, but wrong GUID: %s %s\n",
442                          debugstr_w(buffer), debugstr_guid(&pdb_lookup.u.ds.guid),
443                          debugstr_guid((GUID*)s->id));
444                     return FALSE;
445                 }
446                 break;
447             }
448             if (pdb_lookup.age != s->two)
449             {
450                 WARN("Found %s, but wrong age: %08x %08x\n",
451                      debugstr_w(buffer), pdb_lookup.age, s->two);
452                 return FALSE;
453             }
454         }
455         break;
456     default:
457         FIXME("What the heck??\n");
458         return FALSE;
459     }
460     /* yes, EnumDirTree/do_search and SymFindFileInPath callbacks use the opposite
461      * convention to stop/continue enumeration. sigh.
462      */
463     return !(s->cb)((WCHAR*)buffer, s->user);
464 }
465
466 /******************************************************************
467  *              SymFindFileInPathW (DBGHELP.@)
468  *
469  */
470 BOOL WINAPI SymFindFileInPathW(HANDLE hProcess, PCWSTR searchPath, PCWSTR full_path,
471                                PVOID id, DWORD two, DWORD three, DWORD flags,
472                                PWSTR buffer, PFINDFILEINPATHCALLBACKW cb,
473                                PVOID user)
474 {
475     struct sffip        s;
476     struct process*     pcs = process_find_by_handle(hProcess);
477     WCHAR               tmp[MAX_PATH];
478     WCHAR*              ptr;
479     const WCHAR*        filename;
480
481     TRACE("(hProcess = %p, searchPath = %s, full_path = %s, id = %p, two = 0x%08x, three = 0x%08x, flags = 0x%08x, buffer = %p, cb = %p, user = %p)\n",
482           hProcess, debugstr_w(searchPath), debugstr_w(full_path),
483           id, two, three, flags, buffer, cb, user);
484
485     if (!pcs) return FALSE;
486     if (!searchPath) searchPath = pcs->search_path;
487
488     s.id = id;
489     s.two = two;
490     s.three = three;
491     s.flags = flags;
492     s.cb = cb;
493     s.user = user;
494
495     filename = file_nameW(full_path);
496     s.kind = module_get_type_by_name(filename);
497
498     /* first check full path to file */
499     if (sffip_cb(full_path, &s))
500     {
501         strcpyW(buffer, full_path);
502         return TRUE;
503     }
504
505     while (searchPath)
506     {
507         ptr = strchrW(searchPath, ';');
508         if (ptr)
509         {
510             memcpy(tmp, searchPath, (ptr - searchPath) * sizeof(WCHAR));
511             tmp[ptr - searchPath] = 0;
512             searchPath = ptr + 1;
513         }
514         else
515         {
516             strcpyW(tmp, searchPath);
517             searchPath = NULL;
518         }
519         if (do_searchW(filename, tmp, FALSE, sffip_cb, &s))
520         {
521             strcpyW(buffer, tmp);
522             return TRUE;
523         }
524     }
525     return FALSE;
526 }
527
528 /******************************************************************
529  *              SymFindFileInPath (DBGHELP.@)
530  *
531  */
532 BOOL WINAPI SymFindFileInPath(HANDLE hProcess, PCSTR searchPath, PCSTR full_path,
533                               PVOID id, DWORD two, DWORD three, DWORD flags,
534                               PSTR buffer, PFINDFILEINPATHCALLBACK cb,
535                               PVOID user)
536 {
537     WCHAR                       searchPathW[MAX_PATH];
538     WCHAR                       full_pathW[MAX_PATH];
539     WCHAR                       bufferW[MAX_PATH];
540     struct enum_dir_treeWA      edt;
541     BOOL                        ret;
542
543     /* a PFINDFILEINPATHCALLBACK and a PENUMDIRTREE_CALLBACK have actually the
544      * same signature & semantics, hence we can reuse the EnumDirTree W->A
545      * conversion helper
546      */
547     edt.cb = cb;
548     edt.user = user;
549     if (searchPath)
550         MultiByteToWideChar(CP_ACP, 0, searchPath, -1, searchPathW, MAX_PATH);
551     MultiByteToWideChar(CP_ACP, 0, full_path, -1, full_pathW, MAX_PATH);
552     if ((ret =  SymFindFileInPathW(hProcess, searchPath ? searchPathW : NULL, full_pathW,
553                                    id, two, three, flags,
554                                    bufferW, enum_dir_treeWA, &edt)))
555         WideCharToMultiByte(CP_ACP, 0, bufferW, -1, buffer, MAX_PATH, NULL, NULL);
556     return ret;
557 }