2 * Filesystem utility routines
6 * Ethereal - Network traffic analyzer
7 * By Gerald Combs <gerald@ethereal.com>
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
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))
208 * Get the directory in which Ethereal's global configuration and data
211 * XXX - if we ever make libethereal a real library, used by multiple
212 * applications (more than just Tethereal and versions of Ethereal with
213 * various UIs), should the configuration files belong to the library
214 * (and be shared by all those applications) or to the applications?
216 * If they belong to the library, that could be done on UNIX by the
217 * configure script, but it's trickier on Windows, as you can't just
218 * use the pathname of the executable.
220 * If they belong to the application, that could be done on Windows
221 * by using the pathname of the executable, but we'd have to have it
222 * passed in as an argument, in some call, on UNIX.
224 * Note that some of those configuration files might be used by code in
225 * libethereal, some of them might be used by dissectors (would they
226 * belong to libethereal, the application, or a separate library?),
227 * and some of them might be used by other code (the Ethereal preferences
228 * file includes resolver preferences that control the behavior of code
229 * in libethereal, dissector preferences, and UI preferences, for
233 get_datafile_dir(void)
236 char prog_pathname[_MAX_PATH+2];
238 size_t datafile_dir_len;
239 static char *datafile_dir;
242 * Have we already gotten the pathname?
243 * If so, just return it.
245 if (datafile_dir != NULL)
250 * Start out by assuming it's the default installation directory.
252 datafile_dir = "C:\\Program Files\\Ethereal\\";
255 * Now we attempt to get the full pathname of the currently running
256 * program, under the assumption that we're running an installed
257 * version of the program. If we fail, we don't change "datafile_dir",
258 * and thus end up using the default.
260 * XXX - does NSIS put the installation directory into
261 * "\HKEY_LOCAL_MACHINE\SOFTWARE\Ethereal\InstallDir"?
262 * If so, perhaps we should read that from the registry,
265 if (GetModuleFileName(NULL, prog_pathname, sizeof prog_pathname) != 0) {
267 * If the program is an installed version, the full pathname
268 * includes the pathname of the directory in which it was
269 * installed; get that directory's pathname, and construct
270 * from it the pathname of the directory in which the
271 * plugins were installed.
273 * First, find the last "\\" in the directory, as that
274 * marks the end of the directory pathname.
276 * XXX - Can the pathname be something such as
277 * "C:ethereal.exe"? Or is it always a full pathname
278 * beginning with "\\" after the drive letter?
280 dir_end = strrchr(prog_pathname, '\\');
281 if (dir_end != NULL) {
283 * Found it - now figure out how long the datafile
284 * directory pathname will be.
286 datafile_dir_len = (dir_end - prog_pathname);
289 * Allocate a buffer for the plugin directory
290 * pathname, and construct it.
292 datafile_dir = g_malloc(datafile_dir_len + 1);
293 strncpy(datafile_dir, prog_pathname, datafile_dir_len);
294 datafile_dir[datafile_dir_len] = '\0';
300 * Just use DATAFILE_DIR, as that's what the configure script
308 * Get the directory in which files that, at least on UNIX, are
309 * system files (such as "/etc/ethers") are stored; on Windows,
310 * there's no "/etc" directory, so we get them from the Ethereal
311 * global configuration and data file directory.
314 get_systemfile_dir(void)
317 return get_datafile_dir();
324 * Name of directory, under the user's home directory, in which
325 * personal configuration files are stored.
328 #define PF_DIR "Ethereal"
331 * XXX - should this be ".libepan"? For backwards-compatibility, I'll keep
332 * it ".ethereal" for now.
334 #define PF_DIR ".ethereal"
338 /* utf8 version of getenv, needed to get win32 filename paths */
339 char *getenv_utf8(const char *varname)
345 envvar = getenv(varname);
347 /* since GLib 2.6 we need an utf8 version of the filename */
348 #if GLIB_MAJOR_VERSION > 2 || (GLIB_MAJOR_VERSION == 2 && GLIB_MINOR_VERSION >= 6)
349 if (!G_WIN32_HAVE_WIDECHAR_API ()) {
350 /* Windows OT (9x, ME), convert from current code page to utf8 */
351 /* it's the best we can do here ... */
352 envvar = g_locale_to_utf8(envvar, -1, NULL, NULL, NULL);
357 /* Windows NT, 2000, XP, ... */
358 /* using the wide char version of getenv should work under all circumstances */
360 /* convert given varname to utf16, needed by _wgetenv */
361 varnamew = g_utf8_to_utf16(varname, -1, NULL, NULL, NULL);
362 if (varnamew == NULL) {
366 /* use wide char version of getenv */
367 envvarw = _wgetenv(varnamew);
369 if (envvarw == NULL) {
373 /* convert value to utf8 */
374 envvar = g_utf16_to_utf8(envvarw, -1, NULL, NULL, NULL);
383 * Get the directory in which personal configuration files reside;
384 * in UNIX-compatible systems, it's ".ethereal", under the user's home
385 * directory, and on Windows systems, it's "Ethereal", under %APPDATA%
386 * or, if %APPDATA% isn't set, it's "%USERPROFILE%\Application Data"
387 * (which is what %APPDATA% normally is on Windows 2000).
390 get_persconffile_dir(void)
394 char *userprofiledir;
399 static char *pf_dir = NULL;
401 /* Return the cached value, if available */
407 * Use %APPDATA% or %USERPROFILE%, so that configuration files are
408 * stored in the user profile, rather than in the home directory.
409 * The Windows convention is to store configuration information
410 * in the user profile, and doing so means you can use
411 * Ethereal even if the home directory is an inaccessible
414 appdatadir = getenv_utf8("APPDATA");
415 if (appdatadir != NULL) {
417 * Concatenate %APPDATA% with "\Ethereal".
419 pf_dir = g_strdup_printf("%s" G_DIR_SEPARATOR_S "%s",
423 * OK, %APPDATA% wasn't set, so use
424 * %USERPROFILE%\Application Data.
426 userprofiledir = getenv_utf8("USERPROFILE");
427 if (userprofiledir != NULL) {
428 pf_dir = g_strdup_printf(
429 "%s" G_DIR_SEPARATOR_S "Application Data" G_DIR_SEPARATOR_S "%s",
430 userprofiledir, PF_DIR);
433 * Give up and use "C:".
435 pf_dir = g_strdup_printf("C:" G_DIR_SEPARATOR_S "%s", PF_DIR);
440 * If $HOME is set, use that.
442 homedir = getenv("HOME");
443 if (homedir == NULL) {
445 * Get their home directory from the password file.
446 * If we can't even find a password file entry for them,
449 pwd = getpwuid(getuid());
452 * This is cached, so we don't need to worry
453 * about allocating multiple ones of them.
455 homedir = g_strdup(pwd->pw_dir);
459 pf_dir = g_strdup_printf("%s" G_DIR_SEPARATOR_S "%s", homedir, PF_DIR);
466 * Create the directory that holds personal configuration files, if
467 * necessary. If we attempted to create it, and failed, return -1 and
468 * set "*pf_dir_path_return" to the pathname of the directory we failed
469 * to create (it's g_mallocated, so our caller should free it); otherwise,
473 create_persconffile_dir(char **pf_dir_path_return)
475 const char *pf_dir_path;
477 char *pf_dir_path_copy, *pf_dir_parent_path;
478 size_t pf_dir_parent_path_len;
483 pf_dir_path = get_persconffile_dir();
484 if (eth_stat(pf_dir_path, &s_buf) != 0 && errno == ENOENT) {
487 * Does the parent directory of that directory
488 * exist? %APPDATA% may not exist even though
489 * %USERPROFILE% does.
491 * We check for the existence of the directory
492 * by first checking whether the parent directory
493 * is just a drive letter and, if it's not, by
494 * doing a "stat()" on it. If it's a drive letter,
495 * or if the "stat()" succeeds, we assume it exists.
497 pf_dir_path_copy = g_strdup(pf_dir_path);
498 pf_dir_parent_path = get_dirname(pf_dir_path_copy);
499 pf_dir_parent_path_len = strlen(pf_dir_parent_path);
500 if (pf_dir_parent_path_len > 0
501 && pf_dir_parent_path[pf_dir_parent_path_len - 1] != ':'
502 && eth_stat(pf_dir_parent_path, &s_buf) != 0) {
504 * No, it doesn't exist - make it first.
506 ret = eth_mkdir(pf_dir_parent_path, 0755);
508 *pf_dir_path_return = pf_dir_parent_path;
512 g_free(pf_dir_path_copy);
513 ret = eth_mkdir(pf_dir_path, 0755);
515 ret = eth_mkdir(pf_dir_path, 0755);
519 * Something with that pathname exists; if it's not
520 * a directory, we'll get an error if we try to put
521 * something in it, so we don't fail here, we wait
522 * for that attempt fo fail.
527 *pf_dir_path_return = g_strdup(pf_dir_path);
533 * Returns the user's home directory on Win32.
538 static const char *home = NULL;
539 char *homedrive, *homepath;
543 /* Return the cached value, if available */
548 * XXX - should we use USERPROFILE anywhere in this process?
549 * Is there a chance that it might be set but one or more of
550 * HOMEDRIVE or HOMEPATH isn't set?
552 homedrive = getenv_utf8("HOMEDRIVE");
553 if (homedrive != NULL) {
554 homepath = getenv_utf8("HOMEPATH");
555 if (homepath != NULL) {
557 * This is cached, so we don't need to worry about
558 * allocating multiple ones of them.
561 g_malloc(strlen(homedrive) + strlen(homepath) + 1);
562 strcpy(homestring, homedrive);
563 strcat(homestring, homepath);
566 * Trim off any trailing slash or backslash.
568 lastsep = find_last_pathname_separator(homestring);
569 if (lastsep != NULL && *(lastsep + 1) == '\0') {
571 * Last separator is the last character
572 * in the string. Nuke it.
581 * Give up and use C:.
591 * Construct the path name of a personal configuration file, given the
594 * On Win32, if "for_writing" is FALSE, we check whether the file exists
595 * and, if not, construct a path name relative to the ".ethereal"
596 * subdirectory of the user's home directory, and check whether that
597 * exists; if it does, we return that, so that configuration files
598 * from earlier versions can be read.
601 get_persconffile_path(const char *filename, gboolean for_writing
613 path = g_strdup_printf("%s" G_DIR_SEPARATOR_S "%s", get_persconffile_dir(),
617 if (eth_stat(path, &s_buf) != 0 && errno == ENOENT) {
619 * OK, it's not in the personal configuration file
620 * directory; is it in the ".ethereal" subdirectory
621 * of their home directory?
623 old_path = g_strdup_printf(
624 "%s" G_DIR_SEPARATOR_S ".ethereal" G_DIR_SEPARATOR_S "%s",
625 get_home_dir(), filename);
626 if (eth_stat(old_path, &s_buf) == 0) {
628 * OK, it exists; return it instead.
641 * Construct the path name of a global configuration file, given the
645 get_datafile_path(const char *filename)
648 return g_strdup_printf("%s" G_DIR_SEPARATOR_S "%s", get_datafile_dir(),
654 deletefile(const char *path)
656 return eth_unlink(path) == 0;
660 * Construct and return the path name of a file in the
661 * appropriate temporary file directory.
663 char *get_tempfile_path(const char *filename)
666 return g_strdup_printf("%s" G_DIR_SEPARATOR_S "%s", g_get_tmp_dir(), filename);
670 * Return an error message for UNIX-style errno indications on open or
674 file_open_error_message(int err, gboolean for_writing)
677 static char errmsg_errno[1024+1];
683 errmsg = "The path to the file \"%s\" doesn't exist.";
685 errmsg = "The file \"%s\" doesn't exist.";
690 errmsg = "You don't have permission to create or write to the file \"%s\".";
692 errmsg = "You don't have permission to read the file \"%s\".";
696 errmsg = "\"%s\" is a directory (folder), not a file.";
700 errmsg = "The file \"%s\" could not be created because there is no space left on the file system.";
705 errmsg = "The file \"%s\" could not be created because you are too close to, or over, your disk quota.";
710 g_snprintf(errmsg_errno, sizeof(errmsg_errno),
711 "The file \"%%s\" could not be %s: %s.",
712 for_writing ? "created" : "opened",
714 errmsg = errmsg_errno;
721 * Return an error message for UNIX-style errno indications on write
725 file_write_error_message(int err)
728 static char errmsg_errno[1024+1];
733 errmsg = "The file \"%s\" could not be saved because there is no space left on the file system.";
738 errmsg = "The file \"%s\" could not be saved because you are too close to, or over, your disk quota.";
743 g_snprintf(errmsg_errno, sizeof(errmsg_errno),
744 "An error occurred while writing to the file \"%%s\": %s.",
746 errmsg = errmsg_errno;
754 file_exists(const char *fname)
756 struct stat file_stat;
761 * This is a bit tricky on win32. The st_ino field is documented as:
762 * "The inode, and therefore st_ino, has no meaning in the FAT, ..."
763 * but it *is* set to zero if stat() returns without an error,
764 * so this is working, but maybe not quite the way expected. ULFL
766 file_stat.st_ino = 1; /* this will make things work if an error occured */
767 eth_stat(fname, &file_stat);
768 if (file_stat.st_ino == 0) {
774 if (eth_stat(fname, &file_stat) != 0 && errno == ENOENT) {
784 * Check that the from file is not the same as to file
785 * We do it here so we catch all cases ...
786 * Unfortunately, the file requester gives us an absolute file
787 * name and the read file name may be relative (if supplied on
788 * the command line), so we can't just compare paths. From Joerg Mayer.
791 files_identical(const char *fname1, const char *fname2)
793 /* Two different implementations, because:
795 * - _fullpath is not available on UN*X, so we can't get full
796 * paths and compare them (which wouldn't work with hard links
799 * - st_ino isn't filled in with a meaningful value on Windows.
802 char full1[MAX_PATH], full2[MAX_PATH];
805 * Get the absolute full paths of the file and compare them.
806 * That won't work if you have hard links, but those aren't
807 * much used on Windows, even though NTFS supports them.
809 * XXX - will _fullpath work with UNC?
811 if( _fullpath( full1, fname1, MAX_PATH ) == NULL ) {
815 if( _fullpath( full2, fname2, MAX_PATH ) == NULL ) {
819 if(strcmp(full1, full2) == 0) {
825 struct stat filestat1, filestat2;
828 * Compare st_dev and st_ino.
830 if (eth_stat(fname1, &filestat1) == -1)
831 return FALSE; /* can't get info about the first file */
832 if (eth_stat(fname2, &filestat2) == -1)
833 return FALSE; /* can't get info about the second file */
834 return (filestat1.st_dev == filestat2.st_dev &&
835 filestat1.st_ino == filestat2.st_ino);