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
49 #include <direct.h> /* to declare "mkdir()" on Windows */
56 #include "filesystem.h"
59 * Given a pathname, return a pointer to the last pathname separator
60 * character in the pathname, or NULL if the pathname contains no
64 find_last_pathname_separator(const char *path)
72 * We have to scan for '\' or '/'.
73 * Get to the end of the string.
75 separator = strchr(path, '\0'); /* points to ending '\0' */
76 while (separator > path) {
78 if (c == '\\' || c == '/')
79 return separator; /* found it */
83 * OK, we didn't find any, so no directories - but there might
84 * be a drive letter....
86 return strchr(path, ':');
88 separator = strrchr(path, '/');
94 * Given a pathname, return the last component.
97 get_basename(const char *path)
101 g_assert(path != NULL);
102 filename = find_last_pathname_separator(path);
103 if (filename == NULL) {
105 * There're no directories, drive letters, etc. in the
106 * name; the pathname *is* the file name.
111 * Skip past the pathname or drive letter separator.
119 * Given a pathname, return a string containing everything but the
120 * last component. NOTE: this overwrites the pathname handed into
124 get_dirname(char *path)
128 g_assert(path != NULL);
129 separator = find_last_pathname_separator(path);
130 if (separator == NULL) {
132 * There're no directories, drive letters, etc. in the
133 * name; there is no directory path to return.
139 * Get rid of the last pathname separator and the final file
145 * "path" now contains the pathname of the directory containing
146 * the file/directory to which it referred.
152 * Given a pathname, return:
154 * the errno, if an attempt to "stat()" the file fails;
156 * EISDIR, if the attempt succeeded and the file turned out
159 * 0, if the attempt succeeded and the file turned out not
164 * Visual C++ on Win32 systems doesn't define these. (Old UNIX systems don't
165 * define them either.)
167 * Visual C++ on Win32 systems doesn't define S_IFIFO, it defines _S_IFIFO.
170 #define S_ISREG(mode) (((mode) & S_IFMT) == S_IFREG)
173 #define S_IFIFO _S_IFIFO
176 #define S_ISFIFO(mode) (((mode) & S_IFMT) == S_IFIFO)
179 #define S_ISDIR(mode) (((mode) & S_IFMT) == S_IFDIR)
183 test_for_directory(const char *path)
187 if (stat(path, &statb) < 0)
190 if (S_ISDIR(statb.st_mode))
197 test_for_fifo(const char *path)
201 if (stat(path, &statb) < 0)
204 if (S_ISFIFO(statb.st_mode))
211 * Get the directory in which Ethereal's global configuration and data
214 * XXX - if we ever make libethereal a real library, used by multiple
215 * applications (more than just Tethereal and versions of Ethereal with
216 * various UIs), should the configuration files belong to the library
217 * (and be shared by all those applications) or to the applications?
219 * If they belong to the library, that could be done on UNIX by the
220 * configure script, but it's trickier on Windows, as you can't just
221 * use the pathname of the executable.
223 * If they belong to the application, that could be done on Windows
224 * by using the pathname of the executable, but we'd have to have it
225 * passed in as an argument, in some call, on UNIX.
227 * Note that some of those configuration files might be used by code in
228 * libethereal, some of them might be used by dissectors (would they
229 * belong to libethereal, the application, or a separate library?),
230 * and some of them might be used by other code (the Ethereal preferences
231 * file includes resolver preferences that control the behavior of code
232 * in libethereal, dissector preferences, and UI preferences, for
236 get_datafile_dir(void)
239 char prog_pathname[_MAX_PATH+2];
241 size_t datafile_dir_len;
242 static char *datafile_dir;
245 * Have we already gotten the pathname?
246 * If so, just return it.
248 if (datafile_dir != NULL)
253 * Start out by assuming it's the default installation directory.
255 datafile_dir = "C:\\Program Files\\Ethereal\\";
258 * Now we attempt to get the full pathname of the currently running
259 * program, under the assumption that we're running an installed
260 * version of the program. If we fail, we don't change "datafile_dir",
261 * and thus end up using the default.
263 * XXX - does NSIS put the installation directory into
264 * "\HKEY_LOCAL_MACHINE\SOFTWARE\Ethereal\InstallDir"?
265 * If so, perhaps we should read that from the registry,
268 if (GetModuleFileName(NULL, prog_pathname, sizeof prog_pathname) != 0) {
270 * If the program is an installed version, the full pathname
271 * includes the pathname of the directory in which it was
272 * installed; get that directory's pathname, and construct
273 * from it the pathname of the directory in which the
274 * plugins were installed.
276 * First, find the last "\\" in the directory, as that
277 * marks the end of the directory pathname.
279 * XXX - Can the pathname be something such as
280 * "C:ethereal.exe"? Or is it always a full pathname
281 * beginning with "\\" after the drive letter?
283 dir_end = strrchr(prog_pathname, '\\');
284 if (dir_end != NULL) {
286 * Found it - now figure out how long the datafile
287 * directory pathname will be.
289 datafile_dir_len = (dir_end - prog_pathname);
292 * Allocate a buffer for the plugin directory
293 * pathname, and construct it.
295 datafile_dir = g_malloc(datafile_dir_len + 1);
296 strncpy(datafile_dir, prog_pathname, datafile_dir_len);
297 datafile_dir[datafile_dir_len] = '\0';
303 * Just use DATAFILE_DIR, as that's what the configure script
311 * Get the directory in which files that, at least on UNIX, are
312 * system files (such as "/etc/ethers") are stored; on Windows,
313 * there's no "/etc" directory, so we get them from the Ethereal
314 * global configuration and data file directory.
317 get_systemfile_dir(void)
320 return get_datafile_dir();
327 * Name of directory, under the user's home directory, in which
328 * personal configuration files are stored.
331 #define PF_DIR "Ethereal"
334 * XXX - should this be ".libepan"? For backwards-compatibility, I'll keep
335 * it ".ethereal" for now.
337 #define PF_DIR ".ethereal"
341 * Get the directory in which personal configuration files reside;
342 * in UNIX-compatible systems, it's ".ethereal", under the user's home
343 * directory, and on Windows systems, it's "Ethereal", under %APPDATA%
344 * or, if %APPDATA% isn't set, it's "%USERPROFILE%\Application Data"
345 * (which is what %APPDATA% normally is on Windows 2000).
348 get_persconffile_dir(void)
352 char *userprofiledir;
357 static char *pf_dir = NULL;
359 /* Return the cached value, if available */
365 * Use %APPDATA% or %USERPROFILE%, so that configuration files are
366 * stored in the user profile, rather than in the home directory.
367 * The Windows convention is to store configuration information
368 * in the user profile, and doing so means you can use
369 * Ethereal even if the home directory is an inaccessible
372 appdatadir = getenv("APPDATA");
373 if (appdatadir != NULL) {
375 * Concatenate %APPDATA% with "\Ethereal".
377 pf_dir = g_strdup_printf("%s" G_DIR_SEPARATOR_S "%s",
381 * OK, %APPDATA% wasn't set, so use
382 * %USERPROFILE%\Application Data.
384 userprofiledir = getenv("USERPROFILE");
385 if (userprofiledir != NULL) {
386 pf_dir = g_strdup_printf(
387 "%s" G_DIR_SEPARATOR_S "Application Data" G_DIR_SEPARATOR_S "%s",
388 userprofiledir, PF_DIR);
391 * Give up and use "C:".
393 pf_dir = g_strdup_printf("C:" G_DIR_SEPARATOR_S "%s", PF_DIR);
398 * If $HOME is set, use that.
400 homedir = getenv("HOME");
401 if (homedir == NULL) {
403 * Get their home directory from the password file.
404 * If we can't even find a password file entry for them,
407 pwd = getpwuid(getuid());
410 * This is cached, so we don't need to worry
411 * about allocating multiple ones of them.
413 homedir = g_strdup(pwd->pw_dir);
417 pf_dir = g_strdup_printf("%s" G_DIR_SEPARATOR_S "%s", homedir, PF_DIR);
424 * Create the directory that holds personal configuration files, if
425 * necessary. If we attempted to create it, and failed, return -1 and
426 * set "*pf_dir_path_return" to the pathname of the directory we failed
427 * to create (it's g_mallocated, so our caller should free it); otherwise,
431 create_persconffile_dir(char **pf_dir_path_return)
433 const char *pf_dir_path;
435 char *pf_dir_path_copy, *pf_dir_parent_path;
436 size_t pf_dir_parent_path_len;
441 pf_dir_path = get_persconffile_dir();
442 if (stat(pf_dir_path, &s_buf) != 0 && errno == ENOENT) {
445 * Does the parent directory of that directory
446 * exist? %APPDATA% may not exist even though
447 * %USERPROFILE% does.
449 * We check for the existence of the directory
450 * by first checking whether the parent directory
451 * is just a drive letter and, if it's not, by
452 * doing a "stat()" on it. If it's a drive letter,
453 * or if the "stat()" succeeds, we assume it exists.
455 pf_dir_path_copy = g_strdup(pf_dir_path);
456 pf_dir_parent_path = get_dirname(pf_dir_path_copy);
457 pf_dir_parent_path_len = strlen(pf_dir_parent_path);
458 if (pf_dir_parent_path_len > 0
459 && pf_dir_parent_path[pf_dir_parent_path_len - 1] != ':'
460 && stat(pf_dir_parent_path, &s_buf) != 0) {
462 * No, it doesn't exist - make it first.
464 ret = mkdir(pf_dir_parent_path);
466 *pf_dir_path_return = pf_dir_parent_path;
470 g_free(pf_dir_path_copy);
471 ret = mkdir(pf_dir_path);
473 ret = mkdir(pf_dir_path, 0755);
477 * Something with that pathname exists; if it's not
478 * a directory, we'll get an error if we try to put
479 * something in it, so we don't fail here, we wait
480 * for that attempt fo fail.
485 *pf_dir_path_return = g_strdup(pf_dir_path);
491 * Returns the user's home directory on Win32.
496 static const char *home = NULL;
497 char *homedrive, *homepath;
501 /* Return the cached value, if available */
506 * XXX - should we use USERPROFILE anywhere in this process?
507 * Is there a chance that it might be set but one or more of
508 * HOMEDRIVE or HOMEPATH isn't set?
510 homedrive = getenv("HOMEDRIVE");
511 if (homedrive != NULL) {
512 homepath = getenv("HOMEPATH");
513 if (homepath != NULL) {
515 * This is cached, so we don't need to worry about
516 * allocating multiple ones of them.
519 g_malloc(strlen(homedrive) + strlen(homepath) + 1);
520 strcpy(homestring, homedrive);
521 strcat(homestring, homepath);
524 * Trim off any trailing slash or backslash.
526 lastsep = find_last_pathname_separator(homestring);
527 if (lastsep != NULL && *(lastsep + 1) == '\0') {
529 * Last separator is the last character
530 * in the string. Nuke it.
539 * Give up and use C:.
549 * Construct the path name of a personal configuration file, given the
552 * On Win32, if "for_writing" is FALSE, we check whether the file exists
553 * and, if not, construct a path name relative to the ".ethereal"
554 * subdirectory of the user's home directory, and check whether that
555 * exists; if it does, we return that, so that configuration files
556 * from earlier versions can be read.
559 get_persconffile_path(const char *filename, gboolean for_writing
571 path = g_strdup_printf("%s" G_DIR_SEPARATOR_S "%s", get_persconffile_dir(),
575 if (stat(path, &s_buf) != 0 && errno == ENOENT) {
577 * OK, it's not in the personal configuration file
578 * directory; is it in the ".ethereal" subdirectory
579 * of their home directory?
581 old_path = g_strdup_printf(
582 "%s" G_DIR_SEPARATOR_S ".ethereal" G_DIR_SEPARATOR_S "%s",
583 get_home_dir(), filename);
584 if (stat(old_path, &s_buf) == 0) {
586 * OK, it exists; return it instead.
599 * Construct the path name of a global configuration file, given the
603 get_datafile_path(const char *filename)
606 return g_strdup_printf("%s" G_DIR_SEPARATOR_S "%s", get_datafile_dir(),
612 deletefile(const char *path)
614 return unlink(path) == 0;
618 * Construct and return the path name of a file in the
619 * appropriate temporary file directory.
621 char *get_tempfile_path(const char *filename)
624 return g_strdup_printf("%s" G_DIR_SEPARATOR_S "%s", g_get_tmp_dir(), filename);
628 * Return an error message for UNIX-style errno indications on open or
632 file_open_error_message(int err, gboolean for_writing)
635 static char errmsg_errno[1024+1];
641 errmsg = "The path to the file \"%s\" doesn't exist.";
643 errmsg = "The file \"%s\" doesn't exist.";
648 errmsg = "You don't have permission to create or write to the file \"%s\".";
650 errmsg = "You don't have permission to read the file \"%s\".";
654 errmsg = "\"%s\" is a directory (folder), not a file.";
658 errmsg = "The file \"%s\" could not be created because there is no space left on the file system.";
663 errmsg = "The file \"%s\" could not be created because you are too close to, or over, your disk quota.";
668 g_snprintf(errmsg_errno, sizeof(errmsg_errno),
669 "The file \"%%s\" could not be %s: %s.",
670 for_writing ? "created" : "opened",
672 errmsg = errmsg_errno;
679 * Return an error message for UNIX-style errno indications on write
683 file_write_error_message(int err)
686 static char errmsg_errno[1024+1];
691 errmsg = "The file \"%s\" could not be saved because there is no space left on the file system.";
696 errmsg = "The file \"%s\" could not be saved because you are too close to, or over, your disk quota.";
701 g_snprintf(errmsg_errno, sizeof(errmsg_errno),
702 "An error occurred while writing to the file \"%%s\": %s.",
704 errmsg = errmsg_errno;
712 file_exists(const char *fname)
714 struct stat file_stat;
718 * This is a bit tricky on win32. The st_ino field is documented as:
719 * "The inode, and therefore st_ino, has no meaning in the FAT, ..."
720 * but it *is* set to zero if stat() returns without an error,
721 * so this is working, but maybe not quite the way expected. ULFL
723 file_stat.st_ino = 1; /* this will make things work if an error occured */
724 stat(fname, &file_stat);
725 if (file_stat.st_ino == 0) {
735 files_identical(const char *fname1, const char *fname2)
737 /* Two different implementations, because:
738 * - _fullpath is not available on unix
739 * - the stat inode will not work as expected on Win32, so two different implementations.
741 * XXX - will _fullpath work with UNC?
744 char full1[MAX_PATH], full2[MAX_PATH];
747 if( _fullpath( full1, fname1, MAX_PATH ) == NULL ) {
751 if( _fullpath( full2, fname2, MAX_PATH ) == NULL ) {
755 if(strcmp(full1, full2) == 0) {
761 struct stat infile, outfile;
764 * Check that the from file is not the same as to file
765 * We do it here so we catch all cases ...
766 * Unfortunately, the file requester gives us an absolute file
767 * name and the read file name may be relative (if supplied on
768 * the command line). From Joerg Mayer.
770 * This is a bit tricky on win32. The st_ino field is documented as:
771 * "The inode, and therefore st_ino, has no meaning in the FAT, ..."
772 * but it *is* set to zero if stat() returns without an error,
773 * so this is not working, as it only checks if both files existing. ULFL
775 infile.st_ino = 1; /* These prevent us from getting equality */
776 outfile.st_ino = 2; /* If one or other of the files is not accessible */
777 stat(fname1, &infile);
778 stat(fname2, &outfile);
779 if (infile.st_ino == outfile.st_ino) {