replace *a lot* of file related calls by their GLib counterparts. This is necessary...
[obnox/wireshark/wip.git] / epan / filesystem.c
index 82d412abe3cdc14490fc6a137a6684cffd3e8a5d..b77c7d07933aef6eab08ce92806b101bbdbe62da 100644 (file)
@@ -1,7 +1,7 @@
 /* filesystem.c
  * Filesystem utility routines
  *
- * $Id: filesystem.c,v 1.22 2003/03/26 00:34:27 guy Exp $
+ * $Id$
  *
  * Ethereal - Network traffic analyzer
  * By Gerald Combs <gerald@ethereal.com>
 #include <unistd.h>
 #endif
 
-#ifdef HAVE_SYS_STAT_H
-#include <sys/stat.h>
-#endif
-
 #ifdef HAVE_WINDOWS_H
 #include <windows.h>
 #endif
 
-#ifdef HAVE_DIRECT_H
-#include <direct.h>            /* to declare "mkdir()" on Windows */
-#endif
-
-#ifndef WIN32
+#ifndef _WIN32
 #include <pwd.h>
 #endif
 
 #include "filesystem.h"
+#include "file_util.h"
 
 /*
  * Given a pathname, return a pointer to the last pathname separator
  * character in the pathname, or NULL if the pathname contains no
  * separators.
  */
-char *
-find_last_pathname_separator(char *path)
+static char *
+find_last_pathname_separator(const char *path)
 {
        char *separator;
 
-#ifdef WIN32
+#ifdef _WIN32
        char c;
 
        /*
         * We have to scan for '\' or '/'.
         * Get to the end of the string.
         */
-       separator = path + strlen(path);        /* points to ending '\0' */
+       separator = strchr(path, '\0');         /* points to ending '\0' */
        while (separator > path) {
                c = *--separator;
                if (c == '\\' || c == '/')
@@ -93,11 +86,12 @@ find_last_pathname_separator(char *path)
 /*
  * Given a pathname, return the last component.
  */
-char *
-get_basename(char *path)
+const char *
+get_basename(const char *path)
 {
-       char *filename;
+       const char *filename;
 
+       g_assert(path != NULL);
        filename = find_last_pathname_separator(path);
        if (filename == NULL) {
                /*
@@ -124,6 +118,7 @@ get_dirname(char *path)
 {
        char *separator;
 
+       g_assert(path != NULL);
        separator = find_last_pathname_separator(path);
        if (separator == NULL) {
                /*
@@ -182,7 +177,7 @@ test_for_directory(const char *path)
 {
        struct stat statb;
 
-       if (stat(path, &statb) < 0)
+       if (eth_stat(path, &statb) < 0)
                return errno;
 
        if (S_ISDIR(statb.st_mode))
@@ -196,7 +191,7 @@ test_for_fifo(const char *path)
 {
        struct stat statb;
 
-       if (stat(path, &statb) < 0)
+       if (eth_stat(path, &statb) < 0)
                return errno;
 
        if (S_ISFIFO(statb.st_mode))
@@ -233,7 +228,7 @@ test_for_fifo(const char *path)
 const char *
 get_datafile_dir(void)
 {
-#ifdef WIN32
+#ifdef _WIN32
        char prog_pathname[_MAX_PATH+2];
        char *dir_end;
        size_t datafile_dir_len;
@@ -314,7 +309,7 @@ get_datafile_dir(void)
 const char *
 get_systemfile_dir(void)
 {
-#ifdef WIN32
+#ifdef _WIN32
        return get_datafile_dir();
 #else
        return "/etc";
@@ -325,7 +320,7 @@ get_systemfile_dir(void)
  * Name of directory, under the user's home directory, in which
  * personal configuration files are stored.
  */
-#ifdef WIN32
+#ifdef _WIN32
 #define PF_DIR "Ethereal"
 #else
 /*
@@ -345,11 +340,11 @@ get_systemfile_dir(void)
 static const char *
 get_persconffile_dir(void)
 {
-#ifdef WIN32
+#ifdef _WIN32
        char *appdatadir;
        char *userprofiledir;
 #else
-       char *homedir;
+       const char *homedir;
        struct passwd *pwd;
 #endif
        static char *pf_dir = NULL;
@@ -358,7 +353,7 @@ get_persconffile_dir(void)
        if (pf_dir != NULL)
                return pf_dir;
 
-#ifdef WIN32
+#ifdef _WIN32
        /*
         * Use %APPDATA% or %USERPROFILE%, so that configuration files are
         * stored in the user profile, rather than in the home directory.
@@ -372,9 +367,8 @@ get_persconffile_dir(void)
                /*
                 * Concatenate %APPDATA% with "\Ethereal".
                 */
-               pf_dir = g_malloc(strlen(appdatadir) + strlen(PF_DIR) + 2);
-               sprintf(pf_dir, "%s" G_DIR_SEPARATOR_S "%s", appdatadir,
-                   PF_DIR);
+               pf_dir = g_strdup_printf("%s" G_DIR_SEPARATOR_S "%s", 
+                       appdatadir, PF_DIR);
        } else {
                /*
                 * OK, %APPDATA% wasn't set, so use
@@ -382,17 +376,14 @@ get_persconffile_dir(void)
                 */
                userprofiledir = getenv("USERPROFILE");
                if (userprofiledir != NULL) {
-                       pf_dir = g_malloc(strlen(userprofiledir) +
-                           strlen("Application Data") + strlen(PF_DIR) + 3);
-                       sprintf(pf_dir,
+                       pf_dir = g_strdup_printf(
                            "%s" G_DIR_SEPARATOR_S "Application Data" G_DIR_SEPARATOR_S "%s",
                            userprofiledir, PF_DIR);
                } else {
                        /*
                         * Give up and use "C:".
                         */
-                       pf_dir = g_malloc(strlen("C:") + strlen(PF_DIR) + 2);
-                       sprintf(pf_dir, "C:" G_DIR_SEPARATOR_S "%s", PF_DIR);
+                       pf_dir = g_strdup_printf("C:" G_DIR_SEPARATOR_S "%s", PF_DIR);
                }
        }
 #else
@@ -416,8 +407,7 @@ get_persconffile_dir(void)
                } else
                        homedir = "/tmp";
        }
-       pf_dir = g_malloc(strlen(homedir) + strlen(PF_DIR) + 2);
-       sprintf(pf_dir, "%s" G_DIR_SEPARATOR_S "%s", homedir, PF_DIR);
+       pf_dir = g_strdup_printf("%s" G_DIR_SEPARATOR_S "%s", homedir, PF_DIR);
 #endif
 
        return pf_dir;
@@ -434,7 +424,7 @@ int
 create_persconffile_dir(char **pf_dir_path_return)
 {
        const char *pf_dir_path;
-#ifdef WIN32
+#ifdef _WIN32
        char *pf_dir_path_copy, *pf_dir_parent_path;
        size_t pf_dir_parent_path_len;
 #endif
@@ -442,8 +432,8 @@ create_persconffile_dir(char **pf_dir_path_return)
        int ret;
 
        pf_dir_path = get_persconffile_dir();
-       if (stat(pf_dir_path, &s_buf) != 0 && errno == ENOENT) {
-#ifdef WIN32
+       if (eth_stat(pf_dir_path, &s_buf) != 0 && errno == ENOENT) {
+#ifdef _WIN32
                /*
                 * Does the parent directory of that directory
                 * exist?  %APPDATA% may not exist even though
@@ -460,20 +450,20 @@ create_persconffile_dir(char **pf_dir_path_return)
                pf_dir_parent_path_len = strlen(pf_dir_parent_path);
                if (pf_dir_parent_path_len > 0
                    && pf_dir_parent_path[pf_dir_parent_path_len - 1] != ':'
-                   && stat(pf_dir_parent_path, &s_buf) != 0) {
+                   && eth_stat(pf_dir_parent_path, &s_buf) != 0) {
                        /*
                         * No, it doesn't exist - make it first.
                         */
-                       ret = mkdir(pf_dir_parent_path);
+                       ret = eth_mkdir(pf_dir_parent_path, 0755);
                        if (ret == -1) {
                                *pf_dir_path_return = pf_dir_parent_path;
                                return -1;
                        }
                }
                g_free(pf_dir_path_copy);
-               ret = mkdir(pf_dir_path);
+               ret = eth_mkdir(pf_dir_path, 0755);
 #else
-               ret = mkdir(pf_dir_path, 0755);
+               ret = eth_mkdir(pf_dir_path, 0755);
 #endif
        } else {
                /*
@@ -489,7 +479,7 @@ create_persconffile_dir(char **pf_dir_path_return)
        return ret;
 }
 
-#ifdef WIN32
+#ifdef _WIN32
 /*
  * Returns the user's home directory on Win32.
  */
@@ -560,35 +550,31 @@ get_home_dir(void)
  */
 char *
 get_persconffile_path(const char *filename, gboolean for_writing
-#ifndef WIN32
+#ifndef _WIN32
        _U_
 #endif
 )
 {
        char *path;
-#ifdef WIN32
+#ifdef _WIN32
        struct stat s_buf;
        char *old_path;
 #endif
 
-       path = (gchar *) g_malloc(strlen(get_persconffile_dir()) +
-           strlen(filename) + 2);
-       sprintf(path, "%s" G_DIR_SEPARATOR_S "%s", get_persconffile_dir(),
+       path = g_strdup_printf("%s" G_DIR_SEPARATOR_S "%s", get_persconffile_dir(),
            filename);
-#ifdef WIN32
+#ifdef _WIN32
        if (!for_writing) {
-               if (stat(path, &s_buf) != 0 && errno == ENOENT) {
+               if (eth_stat(path, &s_buf) != 0 && errno == ENOENT) {
                        /*
                         * OK, it's not in the personal configuration file
                         * directory; is it in the ".ethereal" subdirectory
                         * of their home directory?
                         */
-                       old_path = (gchar *) g_malloc(strlen(get_home_dir()) +
-                           strlen(".ethereal") + strlen(filename) + 3);
-                       sprintf(old_path,
+                       old_path = g_strdup_printf(
                            "%s" G_DIR_SEPARATOR_S ".ethereal" G_DIR_SEPARATOR_S "%s",
                            get_home_dir(), filename);
-                       if (stat(old_path, &s_buf) == 0) {
+                       if (eth_stat(old_path, &s_buf) == 0) {
                                /*
                                 * OK, it exists; return it instead.
                                 */
@@ -601,3 +587,194 @@ get_persconffile_path(const char *filename, gboolean for_writing
 
        return path;
 }
+
+/*
+ * Construct the path name of a global configuration file, given the
+ * file name.
+ */
+char *
+get_datafile_path(const char *filename)
+{
+
+       return g_strdup_printf("%s" G_DIR_SEPARATOR_S "%s", get_datafile_dir(),
+           filename);
+}
+
+/* Delete a file */
+gboolean
+deletefile(const char *path)
+{
+       return eth_unlink(path) == 0;
+}
+
+/*
+ * Construct and return the path name of a file in the
+ * appropriate temporary file directory.
+ */
+char *get_tempfile_path(const char *filename)
+{
+
+       return g_strdup_printf("%s" G_DIR_SEPARATOR_S "%s", g_get_tmp_dir(), filename);
+}
+
+/*
+ * Return an error message for UNIX-style errno indications on open or
+ * create operations.
+ */
+const char *
+file_open_error_message(int err, gboolean for_writing)
+{
+       const char *errmsg;
+       static char errmsg_errno[1024+1];
+
+       switch (err) {
+
+       case ENOENT:
+               if (for_writing)
+                       errmsg = "The path to the file \"%s\" doesn't exist.";
+               else
+                       errmsg = "The file \"%s\" doesn't exist.";
+               break;
+
+       case EACCES:
+               if (for_writing)
+                       errmsg = "You don't have permission to create or write to the file \"%s\".";
+               else
+                       errmsg = "You don't have permission to read the file \"%s\".";
+               break;
+
+       case EISDIR:
+               errmsg = "\"%s\" is a directory (folder), not a file.";
+               break;
+
+       case ENOSPC:
+               errmsg = "The file \"%s\" could not be created because there is no space left on the file system.";
+               break;
+
+#ifdef EDQUOT
+       case EDQUOT:
+               errmsg = "The file \"%s\" could not be created because you are too close to, or over, your disk quota.";
+               break;
+#endif
+
+       default:
+               g_snprintf(errmsg_errno, sizeof(errmsg_errno),
+                               "The file \"%%s\" could not be %s: %s.",
+                               for_writing ? "created" : "opened",
+                               strerror(err));
+               errmsg = errmsg_errno;
+               break;
+       }
+       return errmsg;
+}
+
+/*
+ * Return an error message for UNIX-style errno indications on write
+ * operations.
+ */
+const char *
+file_write_error_message(int err)
+{
+       const char *errmsg;
+       static char errmsg_errno[1024+1];
+
+       switch (err) {
+
+       case ENOSPC:
+               errmsg = "The file \"%s\" could not be saved because there is no space left on the file system.";
+               break;
+
+#ifdef EDQUOT
+       case EDQUOT:
+               errmsg = "The file \"%s\" could not be saved because you are too close to, or over, your disk quota.";
+               break;
+#endif
+
+       default:
+               g_snprintf(errmsg_errno, sizeof(errmsg_errno),
+                   "An error occurred while writing to the file \"%%s\": %s.",
+                   strerror(err));
+               errmsg = errmsg_errno;
+               break;
+       }
+       return errmsg;
+}
+
+
+gboolean
+file_exists(const char *fname)
+{
+  struct stat   file_stat;
+
+
+  /*
+   * This is a bit tricky on win32. The st_ino field is documented as:
+   * "The inode, and therefore st_ino, has no meaning in the FAT, ..."
+   * but it *is* set to zero if stat() returns without an error,
+   * so this is working, but maybe not quite the way expected. ULFL
+   */
+   file_stat.st_ino = 1;   /* this will make things work if an error occured */
+   eth_stat(fname, &file_stat);
+   if (file_stat.st_ino == 0) {
+       return TRUE;
+   } else {
+       return FALSE;
+   }
+
+}
+
+
+gboolean
+files_identical(const char *fname1, const char *fname2)
+{
+    /* Two different implementations, because:
+     * - _fullpath is not available on unix 
+     * - the stat inode will not work as expected on Win32, so two different implementations.
+     *
+     * XXX - will _fullpath work with UNC?
+     */
+#ifdef _WIN32
+    char full1[MAX_PATH], full2[MAX_PATH];
+
+
+    if( _fullpath( full1, fname1, MAX_PATH ) == NULL ) {
+        return FALSE;
+    }
+
+    if( _fullpath( full2, fname2, MAX_PATH ) == NULL ) {
+        return FALSE;
+    }
+    
+    if(strcmp(full1, full2) == 0) {
+        return TRUE;
+    } else {
+        return FALSE;
+    }
+#else
+  struct stat   infile, outfile;
+
+  /*
+   * Check that the from file is not the same as to file
+   * We do it here so we catch all cases ...
+   * Unfortunately, the file requester gives us an absolute file
+   * name and the read file name may be relative (if supplied on
+   * the command line). From Joerg Mayer.
+   *
+   * This is a bit tricky on win32. The st_ino field is documented as:
+   * "The inode, and therefore st_ino, has no meaning in the FAT, ..."
+   * but it *is* set to zero if stat() returns without an error,
+   * so this is not working, as it only checks if both files existing. ULFL
+   */
+   infile.st_ino = 1;   /* These prevent us from getting equality         */
+   outfile.st_ino = 2;  /* If one or other of the files is not accessible */
+   eth_stat(fname1, &infile);
+   eth_stat(fname2, &outfile);
+   if (infile.st_ino == outfile.st_ino) {
+       return TRUE;
+   } else {
+       return FALSE;
+   }
+
+#endif
+}
+