2 * Filesystem utility routines
6 * Wireshark - Network traffic analyzer
7 * By Gerald Combs <gerald@wireshark.org>
8 * Copyright 1998 Gerald Combs
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.
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.
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.
40 #ifdef HAVE_SYS_STAT_H
47 #include "epan/strutil.h"
52 #include "filesystem.h"
53 #include <wiretap/file_util.h>
56 * Given a pathname, return a pointer to the last pathname separator
57 * character in the pathname, or NULL if the pathname contains no
61 find_last_pathname_separator(const char *path)
69 * We have to scan for '\' or '/'.
70 * Get to the end of the string.
72 separator = strchr(path, '\0'); /* points to ending '\0' */
73 while (separator > path) {
75 if (c == '\\' || c == '/')
76 return separator; /* found it */
80 * OK, we didn't find any, so no directories - but there might
81 * be a drive letter....
83 return strchr(path, ':');
85 separator = strrchr(path, '/');
91 * Given a pathname, return the last component.
94 get_basename(const char *path)
98 g_assert(path != NULL);
99 filename = find_last_pathname_separator(path);
100 if (filename == NULL) {
102 * There're no directories, drive letters, etc. in the
103 * name; the pathname *is* the file name.
108 * Skip past the pathname or drive letter separator.
116 * Given a pathname, return a string containing everything but the
117 * last component. NOTE: this overwrites the pathname handed into
121 get_dirname(char *path)
125 g_assert(path != NULL);
126 separator = find_last_pathname_separator(path);
127 if (separator == NULL) {
129 * There're no directories, drive letters, etc. in the
130 * name; there is no directory path to return.
136 * Get rid of the last pathname separator and the final file
142 * "path" now contains the pathname of the directory containing
143 * the file/directory to which it referred.
149 * Given a pathname, return:
151 * the errno, if an attempt to "stat()" the file fails;
153 * EISDIR, if the attempt succeeded and the file turned out
156 * 0, if the attempt succeeded and the file turned out not
161 * Visual C++ on Win32 systems doesn't define these. (Old UNIX systems don't
162 * define them either.)
164 * Visual C++ on Win32 systems doesn't define S_IFIFO, it defines _S_IFIFO.
167 #define S_ISREG(mode) (((mode) & S_IFMT) == S_IFREG)
170 #define S_IFIFO _S_IFIFO
173 #define S_ISFIFO(mode) (((mode) & S_IFMT) == S_IFIFO)
176 #define S_ISDIR(mode) (((mode) & S_IFMT) == S_IFDIR)
180 test_for_directory(const char *path)
184 if (eth_stat(path, &statb) < 0)
187 if (S_ISDIR(statb.st_mode))
194 test_for_fifo(const char *path)
198 if (eth_stat(path, &statb) < 0)
201 if (S_ISFIFO(statb.st_mode))
207 static char *progfile_dir;
210 * Get the pathname of the directory from which the executable came,
211 * and save it for future use. Returns NULL on success, and a
212 * g_mallocated string containing an error on failure.
215 init_progfile_dir(const char *arg0
224 TCHAR prog_pathname_w[_MAX_PATH+2];
225 size_t progfile_dir_len;
233 * Attempt to get the full pathname of the currently running
236 if (GetModuleFileName(NULL, prog_pathname_w, sizeof prog_pathname_w) != 0) {
238 * XXX - Should we use g_utf16_to_utf8(), as in
241 prog_pathname = utf_16to8(prog_pathname_w);
243 * We got it; strip off the last component, which would be
244 * the file name of the executable, giving us the pathname
245 * of the directory where the executable resies
247 * First, find the last "\" in the directory, as that
248 * marks the end of the directory pathname.
250 * XXX - Can the pathname be something such as
251 * "C:wireshark.exe"? Or is it always a full pathname
252 * beginning with "\" after the drive letter?
254 dir_end = strrchr(prog_pathname, '\\');
255 if (dir_end != NULL) {
257 * Found it - now figure out how long the program
258 * directory pathname will be.
260 progfile_dir_len = (dir_end - prog_pathname);
263 * Allocate a buffer for the program directory
264 * pathname, and construct it.
266 path = g_malloc(progfile_dir_len + 1);
267 strncpy(path, prog_pathname, progfile_dir_len);
268 path[progfile_dir_len] = '\0';
271 return NULL; /* we succeeded */
274 * OK, no \ - what do we do now?
276 return g_strdup_printf("No \\ in executable pathname \"%s\"",
281 * Oh, well. Return an indication of the error.
283 error = GetLastError();
284 if (FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER|FORMAT_MESSAGE_FROM_SYSTEM,
285 NULL, error, 0, (LPTSTR) &msg_w, 0, NULL) == 0) {
287 * Gak. We can't format the message.
289 return g_strdup_printf("GetModuleFileName failed: %u (FormatMessage failed: %u)",
290 error, GetLastError());
292 msg = utf_16to8(msg_w);
295 * "FormatMessage()" "helpfully" sticks CR/LF at the
296 * end of the message. Get rid of it.
298 msglen = strlen(msg);
300 msg[msglen - 1] = '\0';
301 msg[msglen - 2] = '\0';
303 return g_strdup_printf("GetModuleFileName failed: %s (%u)",
311 char *path_start, *path_end;
312 size_t path_component_len;
316 * Try to figure out the directory in which the currently running
317 * program resides, given the argv[0] it was started with. That
318 * might be the absolute path of the program, or a path relative
319 * to the current directory of the process that started it, or
320 * just a name for the program if it was started from the command
321 * line and was searched for in $PATH. It's not guaranteed to be
322 * any of those, however, so there are no guarantees....
324 if (arg0[0] == '/') {
326 * It's an absolute path.
328 prog_pathname = g_strdup(arg0);
329 } else if (strchr(arg0, '/') != NULL) {
331 * It's a relative path, with a directory in it.
332 * Get the current directory, and combine it
333 * with that directory.
335 path_max = pathconf(".", _PC_PATH_MAX);
336 if (path_max == -1) {
338 * We have no idea how big a buffer to
339 * allocate for the current directory.
341 return g_strdup_printf("pathconf failed: %s\n",
344 curdir = g_malloc(path_max);
345 if (getcwd(curdir, path_max) == NULL) {
347 * It failed - give up, and just stick
351 return g_strdup_printf("getcwd failed: %s\n",
354 path = g_malloc(strlen(curdir) + 1 + strlen(arg0) + 1);
355 strcpy(path, curdir);
359 prog_pathname = path;
362 * It's just a file name.
363 * Search the path for a file with that name
366 prog_pathname = NULL; /* haven't found it yet */
367 pathstr = getenv("PATH");
368 path_start = pathstr;
369 if (path_start != NULL) {
370 while (*path_start != '\0') {
371 path_end = strchr(path_start, ':');
372 if (path_end == NULL)
373 path_end = path_start + strlen(path_start);
374 path_component_len = path_end - path_start;
375 path = g_malloc(path_component_len + 1
377 memcpy(path, path_start, path_component_len);
378 path[path_component_len] = '\0';
381 if (access(path, X_OK) == 0) {
385 prog_pathname = path;
390 * That's not it. If there are more
391 * path components to test, try them.
393 if (*path_end == '\0') {
395 * There's nothing more to try.
399 if (*path_end == ':')
401 path_start = path_end;
404 if (prog_pathname == NULL) {
406 * Program not found in path.
408 return g_strdup_printf("\"%s\" not found in \"%s\"",
414 * XXX - should we pick a default?
416 return g_strdup("PATH isn't set");
421 * OK, we have what we think is the pathname
424 * First, find the last "/" in the directory,
425 * as that marks the end of the directory pathname.
427 dir_end = strrchr(prog_pathname, '/');
428 if (dir_end != NULL) {
430 * Found it. Strip off the last component,
431 * as that's the path of the program.
436 * Is there a "/.libs" at the end?
438 dir_end = strrchr(prog_pathname, '/');
439 if (dir_end != NULL) {
440 if (strcmp(dir_end, "/.libs") == 0) {
443 * Strip that off; it's an
444 * artifact of libtool.
451 * OK, we have the path we want.
453 progfile_dir = prog_pathname;
457 * This "shouldn't happen"; we apparently
458 * have no "/" in the pathname.
459 * Just free up prog_pathname.
461 retstr = g_strdup_printf("No / found in \"%s\"", prog_pathname);
462 g_free(prog_pathname);
469 * Get the directory in which the program resides.
472 get_progfile_dir(void)
478 * Get the directory in which the global configuration and data files are
481 * XXX - if we ever make libwireshark a real library, used by multiple
482 * applications (more than just TShark and versions of Wireshark with
483 * various UIs), should the configuration files belong to the library
484 * (and be shared by all those applications) or to the applications?
486 * If they belong to the library, that could be done on UNIX by the
487 * configure script, but it's trickier on Windows, as you can't just
488 * use the pathname of the executable.
490 * If they belong to the application, that could be done on Windows
491 * by using the pathname of the executable, but we'd have to have it
492 * passed in as an argument, in some call, on UNIX.
494 * Note that some of those configuration files might be used by code in
495 * libwireshark, some of them might be used by dissectors (would they
496 * belong to libwireshark, the application, or a separate library?),
497 * and some of them might be used by other code (the Wireshark preferences
498 * file includes resolver preferences that control the behavior of code
499 * in libwireshark, dissector preferences, and UI preferences, for
503 get_datafile_dir(void)
506 char *u3deviceexecpath;
508 static char *datafile_dir = NULL;
510 if(datafile_dir != NULL)
515 u3deviceexecpath = getenv_utf8("U3_DEVICE_EXEC_PATH");
517 if(u3deviceexecpath != NULL) {
518 datafile_dir = u3deviceexecpath;
522 * Do we have the pathname of the program? If so, assume we're
523 * running an installed version of the program. If we fail,
524 * we don't change "datafile_dir", and thus end up using the
527 * XXX - does NSIS put the installation directory into
528 * "\HKEY_LOCAL_MACHINE\SOFTWARE\Wireshark\InstallDir"?
529 * If so, perhaps we should read that from the registry,
532 if (progfile_dir != NULL)
533 datafile_dir = progfile_dir;
537 * Fall back on the default installation directory.
539 datafile_dir = "C:\\Program Files\\Wireshark\\";
543 * Just use DATAFILE_DIR, as that's what the configure script
546 datafile_dir = DATAFILE_DIR;
552 * Get the directory in which files that, at least on UNIX, are
553 * system files (such as "/etc/ethers") are stored; on Windows,
554 * there's no "/etc" directory, so we get them from the global
555 * configuration and data file directory.
558 get_systemfile_dir(void)
561 return get_datafile_dir();
568 * Name of directory, under the user's home directory, in which
569 * personal configuration files are stored.
572 #define PF_DIR "Wireshark"
575 * XXX - should this be ".libepan"? For backwards-compatibility, I'll keep
576 * it ".wireshark" for now.
578 #define PF_DIR ".wireshark"
582 /* utf8 version of getenv, needed to get win32 filename paths */
583 char *getenv_utf8(const char *varname)
589 envvar = getenv(varname);
591 /* since GLib 2.6 we need an utf8 version of the filename */
592 #if GLIB_MAJOR_VERSION > 2 || (GLIB_MAJOR_VERSION == 2 && GLIB_MINOR_VERSION >= 6)
593 if (!G_WIN32_HAVE_WIDECHAR_API ()) {
594 /* Windows OT (9x, ME), convert from current code page to utf8 */
595 /* it's the best we can do here ... */
596 envvar = g_locale_to_utf8(envvar, -1, NULL, NULL, NULL);
601 /* Windows NT, 2000, XP, ... */
602 /* using the wide char version of getenv should work under all circumstances */
604 /* convert given varname to utf16, needed by _wgetenv */
605 varnamew = g_utf8_to_utf16(varname, -1, NULL, NULL, NULL);
606 if (varnamew == NULL) {
610 /* use wide char version of getenv */
611 envvarw = _wgetenv(varnamew);
613 if (envvarw == NULL) {
617 /* convert value to utf8 */
618 envvar = g_utf16_to_utf8(envvarw, -1, NULL, NULL, NULL);
627 * Get the directory in which personal configuration files reside;
628 * in UNIX-compatible systems, it's ".wireshark", under the user's home
629 * directory, and on Windows systems, it's "Wireshark", under %APPDATA%
630 * or, if %APPDATA% isn't set, it's "%USERPROFILE%\Application Data"
631 * (which is what %APPDATA% normally is on Windows 2000).
634 get_persconffile_dir(void)
638 char *userprofiledir;
644 static char *pf_dir = NULL;
646 /* Return the cached value, if available */
653 * See if we are running in a U3 environment
656 u3appdatapath = getenv_utf8("U3_APP_DATA_PATH");
658 if(u3appdatapath != NULL) {
660 pf_dir = u3appdatapath;
665 * Use %APPDATA% or %USERPROFILE%, so that configuration files are
666 * stored in the user profile, rather than in the home directory.
667 * The Windows convention is to store configuration information
668 * in the user profile, and doing so means you can use
669 * Wireshark even if the home directory is an inaccessible
672 appdatadir = getenv_utf8("APPDATA");
673 if (appdatadir != NULL) {
675 * Concatenate %APPDATA% with "\Wireshark".
677 pf_dir = g_strdup_printf("%s" G_DIR_SEPARATOR_S "%s",
681 * OK, %APPDATA% wasn't set, so use
682 * %USERPROFILE%\Application Data.
684 userprofiledir = getenv_utf8("USERPROFILE");
685 if (userprofiledir != NULL) {
686 pf_dir = g_strdup_printf(
687 "%s" G_DIR_SEPARATOR_S "Application Data" G_DIR_SEPARATOR_S "%s",
688 userprofiledir, PF_DIR);
691 * Give up and use "C:".
693 pf_dir = g_strdup_printf("C:" G_DIR_SEPARATOR_S "%s", PF_DIR);
699 * If $HOME is set, use that.
701 homedir = getenv("HOME");
702 if (homedir == NULL) {
704 * Get their home directory from the password file.
705 * If we can't even find a password file entry for them,
708 pwd = getpwuid(getuid());
711 * This is cached, so we don't need to worry
712 * about allocating multiple ones of them.
714 homedir = g_strdup(pwd->pw_dir);
718 pf_dir = g_strdup_printf("%s" G_DIR_SEPARATOR_S "%s", homedir, PF_DIR);
725 * Create the directory that holds personal configuration files, if
726 * necessary. If we attempted to create it, and failed, return -1 and
727 * set "*pf_dir_path_return" to the pathname of the directory we failed
728 * to create (it's g_mallocated, so our caller should free it); otherwise,
732 create_persconffile_dir(char **pf_dir_path_return)
734 const char *pf_dir_path;
736 char *pf_dir_path_copy, *pf_dir_parent_path;
737 size_t pf_dir_parent_path_len;
742 pf_dir_path = get_persconffile_dir();
743 if (eth_stat(pf_dir_path, &s_buf) != 0 && errno == ENOENT) {
746 * Does the parent directory of that directory
747 * exist? %APPDATA% may not exist even though
748 * %USERPROFILE% does.
750 * We check for the existence of the directory
751 * by first checking whether the parent directory
752 * is just a drive letter and, if it's not, by
753 * doing a "stat()" on it. If it's a drive letter,
754 * or if the "stat()" succeeds, we assume it exists.
756 pf_dir_path_copy = g_strdup(pf_dir_path);
757 pf_dir_parent_path = get_dirname(pf_dir_path_copy);
758 pf_dir_parent_path_len = strlen(pf_dir_parent_path);
759 if (pf_dir_parent_path_len > 0
760 && pf_dir_parent_path[pf_dir_parent_path_len - 1] != ':'
761 && eth_stat(pf_dir_parent_path, &s_buf) != 0) {
763 * No, it doesn't exist - make it first.
765 ret = eth_mkdir(pf_dir_parent_path, 0755);
767 *pf_dir_path_return = pf_dir_parent_path;
771 g_free(pf_dir_path_copy);
772 ret = eth_mkdir(pf_dir_path, 0755);
774 ret = eth_mkdir(pf_dir_path, 0755);
778 * Something with that pathname exists; if it's not
779 * a directory, we'll get an error if we try to put
780 * something in it, so we don't fail here, we wait
781 * for that attempt fo fail.
786 *pf_dir_path_return = g_strdup(pf_dir_path);
792 * Returns the user's home directory on Win32.
797 static const char *home = NULL;
798 char *homedrive, *homepath;
802 /* Return the cached value, if available */
807 * XXX - should we use USERPROFILE anywhere in this process?
808 * Is there a chance that it might be set but one or more of
809 * HOMEDRIVE or HOMEPATH isn't set?
811 homedrive = getenv_utf8("HOMEDRIVE");
812 if (homedrive != NULL) {
813 homepath = getenv_utf8("HOMEPATH");
814 if (homepath != NULL) {
816 * This is cached, so we don't need to worry about
817 * allocating multiple ones of them.
820 g_malloc(strlen(homedrive) + strlen(homepath) + 1);
821 strcpy(homestring, homedrive);
822 strcat(homestring, homepath);
825 * Trim off any trailing slash or backslash.
827 lastsep = find_last_pathname_separator(homestring);
828 if (lastsep != NULL && *(lastsep + 1) == '\0') {
830 * Last separator is the last character
831 * in the string. Nuke it.
840 * Give up and use C:.
850 * Construct the path name of a personal configuration file, given the
853 * On Win32, if "for_writing" is FALSE, we check whether the file exists
854 * and, if not, construct a path name relative to the ".wireshark"
855 * subdirectory of the user's home directory, and check whether that
856 * exists; if it does, we return that, so that configuration files
857 * from earlier versions can be read.
860 get_persconffile_path(const char *filename, gboolean for_writing
872 path = g_strdup_printf("%s" G_DIR_SEPARATOR_S "%s", get_persconffile_dir(),
876 if (eth_stat(path, &s_buf) != 0 && errno == ENOENT) {
878 * OK, it's not in the personal configuration file
879 * directory; is it in the ".wireshark" subdirectory
880 * of their home directory?
882 old_path = g_strdup_printf(
883 "%s" G_DIR_SEPARATOR_S ".wireshark" G_DIR_SEPARATOR_S "%s",
884 get_home_dir(), filename);
885 if (eth_stat(old_path, &s_buf) == 0) {
887 * OK, it exists; return it instead.
900 * Construct the path name of a global configuration file, given the
904 get_datafile_path(const char *filename)
907 return g_strdup_printf("%s" G_DIR_SEPARATOR_S "%s", get_datafile_dir(),
913 deletefile(const char *path)
915 return eth_unlink(path) == 0;
919 * Construct and return the path name of a file in the
920 * appropriate temporary file directory.
922 char *get_tempfile_path(const char *filename)
925 return g_strdup_printf("%s" G_DIR_SEPARATOR_S "%s", g_get_tmp_dir(), filename);
929 * Return an error message for UNIX-style errno indications on open or
933 file_open_error_message(int err, gboolean for_writing)
936 static char errmsg_errno[1024+1];
942 errmsg = "The path to the file \"%s\" doesn't exist.";
944 errmsg = "The file \"%s\" doesn't exist.";
949 errmsg = "You don't have permission to create or write to the file \"%s\".";
951 errmsg = "You don't have permission to read the file \"%s\".";
955 errmsg = "\"%s\" is a directory (folder), not a file.";
959 errmsg = "The file \"%s\" could not be created because there is no space left on the file system.";
964 errmsg = "The file \"%s\" could not be created because you are too close to, or over, your disk quota.";
969 g_snprintf(errmsg_errno, sizeof(errmsg_errno),
970 "The file \"%%s\" could not be %s: %s.",
971 for_writing ? "created" : "opened",
973 errmsg = errmsg_errno;
980 * Return an error message for UNIX-style errno indications on write
984 file_write_error_message(int err)
987 static char errmsg_errno[1024+1];
992 errmsg = "The file \"%s\" could not be saved because there is no space left on the file system.";
997 errmsg = "The file \"%s\" could not be saved because you are too close to, or over, your disk quota.";
1002 g_snprintf(errmsg_errno, sizeof(errmsg_errno),
1003 "An error occurred while writing to the file \"%%s\": %s.",
1005 errmsg = errmsg_errno;
1013 file_exists(const char *fname)
1015 struct stat file_stat;
1020 * This is a bit tricky on win32. The st_ino field is documented as:
1021 * "The inode, and therefore st_ino, has no meaning in the FAT, ..."
1022 * but it *is* set to zero if stat() returns without an error,
1023 * so this is working, but maybe not quite the way expected. ULFL
1025 file_stat.st_ino = 1; /* this will make things work if an error occured */
1026 eth_stat(fname, &file_stat);
1027 if (file_stat.st_ino == 0) {
1033 if (eth_stat(fname, &file_stat) != 0 && errno == ENOENT) {
1043 * Check that the from file is not the same as to file
1044 * We do it here so we catch all cases ...
1045 * Unfortunately, the file requester gives us an absolute file
1046 * name and the read file name may be relative (if supplied on
1047 * the command line), so we can't just compare paths. From Joerg Mayer.
1050 files_identical(const char *fname1, const char *fname2)
1052 /* Two different implementations, because:
1054 * - _fullpath is not available on UN*X, so we can't get full
1055 * paths and compare them (which wouldn't work with hard links
1058 * - st_ino isn't filled in with a meaningful value on Windows.
1061 char full1[MAX_PATH], full2[MAX_PATH];
1064 * Get the absolute full paths of the file and compare them.
1065 * That won't work if you have hard links, but those aren't
1066 * much used on Windows, even though NTFS supports them.
1068 * XXX - will _fullpath work with UNC?
1070 if( _fullpath( full1, fname1, MAX_PATH ) == NULL ) {
1074 if( _fullpath( full2, fname2, MAX_PATH ) == NULL ) {
1078 if(strcmp(full1, full2) == 0) {
1084 struct stat filestat1, filestat2;
1087 * Compare st_dev and st_ino.
1089 if (eth_stat(fname1, &filestat1) == -1)
1090 return FALSE; /* can't get info about the first file */
1091 if (eth_stat(fname2, &filestat2) == -1)
1092 return FALSE; /* can't get info about the second file */
1093 return (filestat1.st_dev == filestat2.st_dev &&
1094 filestat1.st_ino == filestat2.st_ino);