replace *a lot* of file related calls by their GLib counterparts. This is necessary...
[obnox/wireshark/wip.git] / epan / filesystem.c
1 /* filesystem.c
2  * Filesystem utility routines
3  *
4  * $Id$
5  *
6  * Ethereal - Network traffic analyzer
7  * By Gerald Combs <gerald@ethereal.com>
8  * Copyright 1998 Gerald Combs
9  *
10  * This program is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU General Public License
12  * as published by the Free Software Foundation; either version 2
13  * of the License, or (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
23  */
24
25 #ifdef HAVE_CONFIG_H
26 # include "config.h"
27 #endif
28
29 #include <stdio.h>
30 #include <stdlib.h>
31 #include <string.h>
32 #include <errno.h>
33
34 #include <glib.h>
35
36 #ifdef HAVE_UNISTD_H
37 #include <unistd.h>
38 #endif
39
40 #ifdef HAVE_WINDOWS_H
41 #include <windows.h>
42 #endif
43
44 #ifndef _WIN32
45 #include <pwd.h>
46 #endif
47
48 #include "filesystem.h"
49 #include "file_util.h"
50
51 /*
52  * Given a pathname, return a pointer to the last pathname separator
53  * character in the pathname, or NULL if the pathname contains no
54  * separators.
55  */
56 static char *
57 find_last_pathname_separator(const char *path)
58 {
59         char *separator;
60
61 #ifdef _WIN32
62         char c;
63
64         /*
65          * We have to scan for '\' or '/'.
66          * Get to the end of the string.
67          */
68         separator = strchr(path, '\0');         /* points to ending '\0' */
69         while (separator > path) {
70                 c = *--separator;
71                 if (c == '\\' || c == '/')
72                         return separator;       /* found it */
73         }
74
75         /*
76          * OK, we didn't find any, so no directories - but there might
77          * be a drive letter....
78          */
79         return strchr(path, ':');
80 #else
81         separator = strrchr(path, '/');
82 #endif
83         return separator;
84 }
85
86 /*
87  * Given a pathname, return the last component.
88  */
89 const char *
90 get_basename(const char *path)
91 {
92         const char *filename;
93
94         g_assert(path != NULL);
95         filename = find_last_pathname_separator(path);
96         if (filename == NULL) {
97                 /*
98                  * There're no directories, drive letters, etc. in the
99                  * name; the pathname *is* the file name.
100                  */
101                 filename = path;
102         } else {
103                 /*
104                  * Skip past the pathname or drive letter separator.
105                  */
106                 filename++;
107         }
108         return filename;
109 }
110
111 /*
112  * Given a pathname, return a string containing everything but the
113  * last component.  NOTE: this overwrites the pathname handed into
114  * it....
115  */
116 char *
117 get_dirname(char *path)
118 {
119         char *separator;
120
121         g_assert(path != NULL);
122         separator = find_last_pathname_separator(path);
123         if (separator == NULL) {
124                 /*
125                  * There're no directories, drive letters, etc. in the
126                  * name; there is no directory path to return.
127                  */
128                 return NULL;
129         }
130
131         /*
132          * Get rid of the last pathname separator and the final file
133          * name following it.
134          */
135         *separator = '\0';
136
137         /*
138          * "path" now contains the pathname of the directory containing
139          * the file/directory to which it referred.
140          */
141         return path;
142 }
143
144 /*
145  * Given a pathname, return:
146  *
147  *      the errno, if an attempt to "stat()" the file fails;
148  *
149  *      EISDIR, if the attempt succeeded and the file turned out
150  *      to be a directory;
151  *
152  *      0, if the attempt succeeded and the file turned out not
153  *      to be a directory.
154  */
155
156 /*
157  * Visual C++ on Win32 systems doesn't define these.  (Old UNIX systems don't
158  * define them either.)
159  *
160  * Visual C++ on Win32 systems doesn't define S_IFIFO, it defines _S_IFIFO.
161  */
162 #ifndef S_ISREG
163 #define S_ISREG(mode)   (((mode) & S_IFMT) == S_IFREG)
164 #endif
165 #ifndef S_IFIFO
166 #define S_IFIFO _S_IFIFO
167 #endif
168 #ifndef S_ISFIFO
169 #define S_ISFIFO(mode)  (((mode) & S_IFMT) == S_IFIFO)
170 #endif
171 #ifndef S_ISDIR
172 #define S_ISDIR(mode)   (((mode) & S_IFMT) == S_IFDIR)
173 #endif
174
175 int
176 test_for_directory(const char *path)
177 {
178         struct stat statb;
179
180         if (eth_stat(path, &statb) < 0)
181                 return errno;
182
183         if (S_ISDIR(statb.st_mode))
184                 return EISDIR;
185         else
186                 return 0;
187 }
188
189 int
190 test_for_fifo(const char *path)
191 {
192         struct stat statb;
193
194         if (eth_stat(path, &statb) < 0)
195                 return errno;
196
197         if (S_ISFIFO(statb.st_mode))
198                 return ESPIPE;
199         else
200                 return 0;
201 }
202
203 /*
204  * Get the directory in which Ethereal's global configuration and data
205  * files are stored.
206  *
207  * XXX - if we ever make libethereal a real library, used by multiple
208  * applications (more than just Tethereal and versions of Ethereal with
209  * various UIs), should the configuration files belong to the library
210  * (and be shared by all those applications) or to the applications?
211  *
212  * If they belong to the library, that could be done on UNIX by the
213  * configure script, but it's trickier on Windows, as you can't just
214  * use the pathname of the executable.
215  *
216  * If they belong to the application, that could be done on Windows
217  * by using the pathname of the executable, but we'd have to have it
218  * passed in as an argument, in some call, on UNIX.
219  *
220  * Note that some of those configuration files might be used by code in
221  * libethereal, some of them might be used by dissectors (would they
222  * belong to libethereal, the application, or a separate library?),
223  * and some of them might be used by other code (the Ethereal preferences
224  * file includes resolver preferences that control the behavior of code
225  * in libethereal, dissector preferences, and UI preferences, for
226  * example).
227  */
228 const char *
229 get_datafile_dir(void)
230 {
231 #ifdef _WIN32
232         char prog_pathname[_MAX_PATH+2];
233         char *dir_end;
234         size_t datafile_dir_len;
235         static char *datafile_dir;
236
237         /*
238          * Have we already gotten the pathname?
239          * If so, just return it.
240          */
241         if (datafile_dir != NULL)
242                 return datafile_dir;
243
244         /*
245          * No, we haven't.
246          * Start out by assuming it's the default installation directory.
247          */
248         datafile_dir = "C:\\Program Files\\Ethereal\\";
249
250         /*
251          * Now we attempt to get the full pathname of the currently running
252          * program, under the assumption that we're running an installed
253          * version of the program.  If we fail, we don't change "datafile_dir",
254          * and thus end up using the default.
255          *
256          * XXX - does NSIS put the installation directory into
257          * "\HKEY_LOCAL_MACHINE\SOFTWARE\Ethereal\InstallDir"?
258          * If so, perhaps we should read that from the registry,
259          * instead.
260          */
261         if (GetModuleFileName(NULL, prog_pathname, sizeof prog_pathname) != 0) {
262                 /*
263                  * If the program is an installed version, the full pathname
264                  * includes the pathname of the directory in which it was
265                  * installed; get that directory's pathname, and construct
266                  * from it the pathname of the directory in which the
267                  * plugins were installed.
268                  *
269                  * First, find the last "\\" in the directory, as that
270                  * marks the end of the directory pathname.
271                  *
272                  * XXX - Can the pathname be something such as
273                  * "C:ethereal.exe"?  Or is it always a full pathname
274                  * beginning with "\\" after the drive letter?
275                  */
276                 dir_end = strrchr(prog_pathname, '\\');
277                 if (dir_end != NULL) {
278                         /*
279                          * Found it - now figure out how long the datafile
280                          * directory pathname will be.
281                          */
282                         datafile_dir_len = (dir_end - prog_pathname);
283
284                         /*
285                          * Allocate a buffer for the plugin directory
286                          * pathname, and construct it.
287                          */
288                         datafile_dir = g_malloc(datafile_dir_len + 1);
289                         strncpy(datafile_dir, prog_pathname, datafile_dir_len);
290                         datafile_dir[datafile_dir_len] = '\0';
291                 }
292         }
293         return datafile_dir;
294 #else
295         /*
296          * Just use DATAFILE_DIR, as that's what the configure script
297          * set it to be.
298          */
299         return DATAFILE_DIR;
300 #endif
301 }
302
303 /*
304  * Get the directory in which files that, at least on UNIX, are
305  * system files (such as "/etc/ethers") are stored; on Windows,
306  * there's no "/etc" directory, so we get them from the Ethereal
307  * global configuration and data file directory.
308  */
309 const char *
310 get_systemfile_dir(void)
311 {
312 #ifdef _WIN32
313         return get_datafile_dir();
314 #else
315         return "/etc";
316 #endif
317 }
318
319 /*
320  * Name of directory, under the user's home directory, in which
321  * personal configuration files are stored.
322  */
323 #ifdef _WIN32
324 #define PF_DIR "Ethereal"
325 #else
326 /*
327  * XXX - should this be ".libepan"? For backwards-compatibility, I'll keep
328  * it ".ethereal" for now.
329  */
330 #define PF_DIR ".ethereal"
331 #endif
332
333 /*
334  * Get the directory in which personal configuration files reside;
335  * in UNIX-compatible systems, it's ".ethereal", under the user's home
336  * directory, and on Windows systems, it's "Ethereal", under %APPDATA%
337  * or, if %APPDATA% isn't set, it's "%USERPROFILE%\Application Data"
338  * (which is what %APPDATA% normally is on Windows 2000).
339  */
340 static const char *
341 get_persconffile_dir(void)
342 {
343 #ifdef _WIN32
344         char *appdatadir;
345         char *userprofiledir;
346 #else
347         const char *homedir;
348         struct passwd *pwd;
349 #endif
350         static char *pf_dir = NULL;
351
352         /* Return the cached value, if available */
353         if (pf_dir != NULL)
354                 return pf_dir;
355
356 #ifdef _WIN32
357         /*
358          * Use %APPDATA% or %USERPROFILE%, so that configuration files are
359          * stored in the user profile, rather than in the home directory.
360          * The Windows convention is to store configuration information
361          * in the user profile, and doing so means you can use
362          * Ethereal even if the home directory is an inaccessible
363          * network drive.
364          */
365         appdatadir = getenv("APPDATA");
366         if (appdatadir != NULL) {
367                 /*
368                  * Concatenate %APPDATA% with "\Ethereal".
369                  */
370                 pf_dir = g_strdup_printf("%s" G_DIR_SEPARATOR_S "%s", 
371                         appdatadir, PF_DIR);
372         } else {
373                 /*
374                  * OK, %APPDATA% wasn't set, so use
375                  * %USERPROFILE%\Application Data.
376                  */
377                 userprofiledir = getenv("USERPROFILE");
378                 if (userprofiledir != NULL) {
379                         pf_dir = g_strdup_printf(
380                             "%s" G_DIR_SEPARATOR_S "Application Data" G_DIR_SEPARATOR_S "%s",
381                             userprofiledir, PF_DIR);
382                 } else {
383                         /*
384                          * Give up and use "C:".
385                          */
386                         pf_dir = g_strdup_printf("C:" G_DIR_SEPARATOR_S "%s", PF_DIR);
387                 }
388         }
389 #else
390         /*
391          * If $HOME is set, use that.
392          */
393         homedir = getenv("HOME");
394         if (homedir == NULL) {
395                 /*
396                  * Get their home directory from the password file.
397                  * If we can't even find a password file entry for them,
398                  * use "/tmp".
399                  */
400                 pwd = getpwuid(getuid());
401                 if (pwd != NULL) {
402                         /*
403                          * This is cached, so we don't need to worry
404                          * about allocating multiple ones of them.
405                          */
406                         homedir = g_strdup(pwd->pw_dir);
407                 } else
408                         homedir = "/tmp";
409         }
410         pf_dir = g_strdup_printf("%s" G_DIR_SEPARATOR_S "%s", homedir, PF_DIR);
411 #endif
412
413         return pf_dir;
414 }
415
416 /*
417  * Create the directory that holds personal configuration files, if
418  * necessary.  If we attempted to create it, and failed, return -1 and
419  * set "*pf_dir_path_return" to the pathname of the directory we failed
420  * to create (it's g_mallocated, so our caller should free it); otherwise,
421  * return 0.
422  */
423 int
424 create_persconffile_dir(char **pf_dir_path_return)
425 {
426         const char *pf_dir_path;
427 #ifdef _WIN32
428         char *pf_dir_path_copy, *pf_dir_parent_path;
429         size_t pf_dir_parent_path_len;
430 #endif
431         struct stat s_buf;
432         int ret;
433
434         pf_dir_path = get_persconffile_dir();
435         if (eth_stat(pf_dir_path, &s_buf) != 0 && errno == ENOENT) {
436 #ifdef _WIN32
437                 /*
438                  * Does the parent directory of that directory
439                  * exist?  %APPDATA% may not exist even though
440                  * %USERPROFILE% does.
441                  *
442                  * We check for the existence of the directory
443                  * by first checking whether the parent directory
444                  * is just a drive letter and, if it's not, by
445                  * doing a "stat()" on it.  If it's a drive letter,
446                  * or if the "stat()" succeeds, we assume it exists.
447                  */
448                 pf_dir_path_copy = g_strdup(pf_dir_path);
449                 pf_dir_parent_path = get_dirname(pf_dir_path_copy);
450                 pf_dir_parent_path_len = strlen(pf_dir_parent_path);
451                 if (pf_dir_parent_path_len > 0
452                     && pf_dir_parent_path[pf_dir_parent_path_len - 1] != ':'
453                     && eth_stat(pf_dir_parent_path, &s_buf) != 0) {
454                         /*
455                          * No, it doesn't exist - make it first.
456                          */
457                         ret = eth_mkdir(pf_dir_parent_path, 0755);
458                         if (ret == -1) {
459                                 *pf_dir_path_return = pf_dir_parent_path;
460                                 return -1;
461                         }
462                 }
463                 g_free(pf_dir_path_copy);
464                 ret = eth_mkdir(pf_dir_path, 0755);
465 #else
466                 ret = eth_mkdir(pf_dir_path, 0755);
467 #endif
468         } else {
469                 /*
470                  * Something with that pathname exists; if it's not
471                  * a directory, we'll get an error if we try to put
472                  * something in it, so we don't fail here, we wait
473                  * for that attempt fo fail.
474                  */
475                 ret = 0;
476         }
477         if (ret == -1)
478                 *pf_dir_path_return = g_strdup(pf_dir_path);
479         return ret;
480 }
481
482 #ifdef _WIN32
483 /*
484  * Returns the user's home directory on Win32.
485  */
486 static const char *
487 get_home_dir(void)
488 {
489         static const char *home = NULL;
490         char *homedrive, *homepath;
491         char *homestring;
492         char *lastsep;
493
494         /* Return the cached value, if available */
495         if (home)
496                 return home;
497
498         /*
499          * XXX - should we use USERPROFILE anywhere in this process?
500          * Is there a chance that it might be set but one or more of
501          * HOMEDRIVE or HOMEPATH isn't set?
502          */
503         homedrive = getenv("HOMEDRIVE");
504         if (homedrive != NULL) {
505                 homepath = getenv("HOMEPATH");
506                 if (homepath != NULL) {
507                         /*
508                          * This is cached, so we don't need to worry about
509                          * allocating multiple ones of them.
510                          */
511                         homestring =
512                             g_malloc(strlen(homedrive) + strlen(homepath) + 1);
513                         strcpy(homestring, homedrive);
514                         strcat(homestring, homepath);
515
516                         /*
517                          * Trim off any trailing slash or backslash.
518                          */
519                         lastsep = find_last_pathname_separator(homestring);
520                         if (lastsep != NULL && *(lastsep + 1) == '\0') {
521                                 /*
522                                  * Last separator is the last character
523                                  * in the string.  Nuke it.
524                                  */
525                                 *lastsep = '\0';
526                         }
527                         home = homestring;
528                 } else
529                         home = homedrive;
530         } else {
531                 /*
532                  * Give up and use C:.
533                  */
534                 home = "C:";
535         }
536
537         return home;
538 }
539 #endif
540
541 /*
542  * Construct the path name of a personal configuration file, given the
543  * file name.
544  *
545  * On Win32, if "for_writing" is FALSE, we check whether the file exists
546  * and, if not, construct a path name relative to the ".ethereal"
547  * subdirectory of the user's home directory, and check whether that
548  * exists; if it does, we return that, so that configuration files
549  * from earlier versions can be read.
550  */
551 char *
552 get_persconffile_path(const char *filename, gboolean for_writing
553 #ifndef _WIN32
554         _U_
555 #endif
556 )
557 {
558         char *path;
559 #ifdef _WIN32
560         struct stat s_buf;
561         char *old_path;
562 #endif
563
564         path = g_strdup_printf("%s" G_DIR_SEPARATOR_S "%s", get_persconffile_dir(),
565             filename);
566 #ifdef _WIN32
567         if (!for_writing) {
568                 if (eth_stat(path, &s_buf) != 0 && errno == ENOENT) {
569                         /*
570                          * OK, it's not in the personal configuration file
571                          * directory; is it in the ".ethereal" subdirectory
572                          * of their home directory?
573                          */
574                         old_path = g_strdup_printf(
575                             "%s" G_DIR_SEPARATOR_S ".ethereal" G_DIR_SEPARATOR_S "%s",
576                             get_home_dir(), filename);
577                         if (eth_stat(old_path, &s_buf) == 0) {
578                                 /*
579                                  * OK, it exists; return it instead.
580                                  */
581                                 g_free(path);
582                                 path = old_path;
583                         }
584                 }
585         }
586 #endif
587
588         return path;
589 }
590
591 /*
592  * Construct the path name of a global configuration file, given the
593  * file name.
594  */
595 char *
596 get_datafile_path(const char *filename)
597 {
598
599         return g_strdup_printf("%s" G_DIR_SEPARATOR_S "%s", get_datafile_dir(),
600             filename);
601 }
602
603 /* Delete a file */
604 gboolean
605 deletefile(const char *path)
606 {
607         return eth_unlink(path) == 0;
608 }
609
610 /*
611  * Construct and return the path name of a file in the
612  * appropriate temporary file directory.
613  */
614 char *get_tempfile_path(const char *filename)
615 {
616
617         return g_strdup_printf("%s" G_DIR_SEPARATOR_S "%s", g_get_tmp_dir(), filename);
618 }
619
620 /*
621  * Return an error message for UNIX-style errno indications on open or
622  * create operations.
623  */
624 const char *
625 file_open_error_message(int err, gboolean for_writing)
626 {
627         const char *errmsg;
628         static char errmsg_errno[1024+1];
629
630         switch (err) {
631
632         case ENOENT:
633                 if (for_writing)
634                         errmsg = "The path to the file \"%s\" doesn't exist.";
635                 else
636                         errmsg = "The file \"%s\" doesn't exist.";
637                 break;
638
639         case EACCES:
640                 if (for_writing)
641                         errmsg = "You don't have permission to create or write to the file \"%s\".";
642                 else
643                         errmsg = "You don't have permission to read the file \"%s\".";
644                 break;
645
646         case EISDIR:
647                 errmsg = "\"%s\" is a directory (folder), not a file.";
648                 break;
649
650         case ENOSPC:
651                 errmsg = "The file \"%s\" could not be created because there is no space left on the file system.";
652                 break;
653
654 #ifdef EDQUOT
655         case EDQUOT:
656                 errmsg = "The file \"%s\" could not be created because you are too close to, or over, your disk quota.";
657                 break;
658 #endif
659
660         default:
661                 g_snprintf(errmsg_errno, sizeof(errmsg_errno),
662                                 "The file \"%%s\" could not be %s: %s.",
663                                 for_writing ? "created" : "opened",
664                                 strerror(err));
665                 errmsg = errmsg_errno;
666                 break;
667         }
668         return errmsg;
669 }
670
671 /*
672  * Return an error message for UNIX-style errno indications on write
673  * operations.
674  */
675 const char *
676 file_write_error_message(int err)
677 {
678         const char *errmsg;
679         static char errmsg_errno[1024+1];
680
681         switch (err) {
682
683         case ENOSPC:
684                 errmsg = "The file \"%s\" could not be saved because there is no space left on the file system.";
685                 break;
686
687 #ifdef EDQUOT
688         case EDQUOT:
689                 errmsg = "The file \"%s\" could not be saved because you are too close to, or over, your disk quota.";
690                 break;
691 #endif
692
693         default:
694                 g_snprintf(errmsg_errno, sizeof(errmsg_errno),
695                     "An error occurred while writing to the file \"%%s\": %s.",
696                     strerror(err));
697                 errmsg = errmsg_errno;
698                 break;
699         }
700         return errmsg;
701 }
702
703
704 gboolean
705 file_exists(const char *fname)
706 {
707   struct stat   file_stat;
708
709
710   /*
711    * This is a bit tricky on win32. The st_ino field is documented as:
712    * "The inode, and therefore st_ino, has no meaning in the FAT, ..."
713    * but it *is* set to zero if stat() returns without an error,
714    * so this is working, but maybe not quite the way expected. ULFL
715    */
716    file_stat.st_ino = 1;   /* this will make things work if an error occured */
717    eth_stat(fname, &file_stat);
718    if (file_stat.st_ino == 0) {
719        return TRUE;
720    } else {
721        return FALSE;
722    }
723
724 }
725
726
727 gboolean
728 files_identical(const char *fname1, const char *fname2)
729 {
730     /* Two different implementations, because:
731      * - _fullpath is not available on unix 
732      * - the stat inode will not work as expected on Win32, so two different implementations.
733      *
734      * XXX - will _fullpath work with UNC?
735      */
736 #ifdef _WIN32
737     char full1[MAX_PATH], full2[MAX_PATH];
738
739
740     if( _fullpath( full1, fname1, MAX_PATH ) == NULL ) {
741         return FALSE;
742     }
743
744     if( _fullpath( full2, fname2, MAX_PATH ) == NULL ) {
745         return FALSE;
746     }
747     
748     if(strcmp(full1, full2) == 0) {
749         return TRUE;
750     } else {
751         return FALSE;
752     }
753 #else
754   struct stat   infile, outfile;
755
756   /*
757    * Check that the from file is not the same as to file
758    * We do it here so we catch all cases ...
759    * Unfortunately, the file requester gives us an absolute file
760    * name and the read file name may be relative (if supplied on
761    * the command line). From Joerg Mayer.
762    *
763    * This is a bit tricky on win32. The st_ino field is documented as:
764    * "The inode, and therefore st_ino, has no meaning in the FAT, ..."
765    * but it *is* set to zero if stat() returns without an error,
766    * so this is not working, as it only checks if both files existing. ULFL
767    */
768    infile.st_ino = 1;   /* These prevent us from getting equality         */
769    outfile.st_ino = 2;  /* If one or other of the files is not accessible */
770    eth_stat(fname1, &infile);
771    eth_stat(fname2, &outfile);
772    if (infile.st_ino == outfile.st_ino) {
773        return TRUE;
774    } else {
775        return FALSE;
776    }
777
778 #endif
779 }
780