Logo Search packages:      
Sourcecode: wireshark version File versions  Download package

filesystem.c

/* filesystem.c
 * Filesystem utility routines
 *
 * $Id: filesystem.c 27234 2009-01-15 01:33:04Z gerald $
 *
 * Wireshark - Network traffic analyzer
 * By Gerald Combs <gerald@wireshark.org>
 * Copyright 1998 Gerald Combs
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */

#ifdef HAVE_CONFIG_H
# include "config.h"
#endif

#ifdef HAVE_DIRENT_H
#include <dirent.h>
#endif

#include <stdio.h>
#include <ctype.h>
#include <stdlib.h>
#include <string.h>
#include <errno.h>

#include <glib.h>

#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif

#ifdef HAVE_SYS_STAT_H
#include <sys/stat.h>
#endif

#ifdef _WIN32
#include <windows.h>
#include <tchar.h>
#include <shlobj.h>
#include "epan/unicode-utils.h"
#else
#include <pwd.h>
#endif

#include "filesystem.h"
#include "privileges.h"
#include <wiretap/file_util.h>

#define PROFILES_DIR    "profiles"
#define U3_MY_CAPTURES  "\\My Captures"

char *persconffile_dir = NULL;
char *persdatafile_dir = NULL;
char *persconfprofile = NULL;

/*
 * Given a pathname, return a pointer to the last pathname separator
 * character in the pathname, or NULL if the pathname contains no
 * separators.
 */
static char *
find_last_pathname_separator(const char *path)
{
      char *separator;

#ifdef _WIN32
      char c;

      /*
       * We have to scan for '\' or '/'.
       * Get to the end of the string.
       */
      separator = strchr(path, '\0');           /* points to ending '\0' */
      while (separator > path) {
            c = *--separator;
            if (c == '\\' || c == '/')
                  return separator; /* found it */
      }

      /*
       * OK, we didn't find any, so no directories - but there might
       * be a drive letter....
       */
      return strchr(path, ':');
#else
      separator = strrchr(path, '/');
#endif
      return separator;
}

/*
 * Given a pathname, return the last component.
 */
const char *
get_basename(const char *path)
{
      const char *filename;

      g_assert(path != NULL);
      filename = find_last_pathname_separator(path);
      if (filename == NULL) {
            /*
             * There're no directories, drive letters, etc. in the
             * name; the pathname *is* the file name.
             */
            filename = path;
      } else {
            /*
             * Skip past the pathname or drive letter separator.
             */
            filename++;
      }
      return filename;
}

/*
 * Given a pathname, return a string containing everything but the
 * last component.  NOTE: this overwrites the pathname handed into
 * it....
 */
char *
get_dirname(char *path)
{
      char *separator;

      g_assert(path != NULL);
      separator = find_last_pathname_separator(path);
      if (separator == NULL) {
            /*
             * There're no directories, drive letters, etc. in the
             * name; there is no directory path to return.
             */
            return NULL;
      }

      /*
       * Get rid of the last pathname separator and the final file
       * name following it.
       */
      *separator = '\0';

      /*
       * "path" now contains the pathname of the directory containing
       * the file/directory to which it referred.
       */
      return path;
}

/*
 * Given a pathname, return:
 *
 *    the errno, if an attempt to "stat()" the file fails;
 *
 *    EISDIR, if the attempt succeeded and the file turned out
 *    to be a directory;
 *
 *    0, if the attempt succeeded and the file turned out not
 *    to be a directory.
 */

/*
 * Visual C++ on Win32 systems doesn't define these.  (Old UNIX systems don't
 * define them either.)
 *
 * Visual C++ on Win32 systems doesn't define S_IFIFO, it defines _S_IFIFO.
 */
#ifndef S_ISREG
#define S_ISREG(mode)   (((mode) & S_IFMT) == S_IFREG)
#endif
#ifndef S_IFIFO
#define S_IFIFO   _S_IFIFO
#endif
#ifndef S_ISFIFO
#define S_ISFIFO(mode)  (((mode) & S_IFMT) == S_IFIFO)
#endif
#ifndef S_ISDIR
#define S_ISDIR(mode)   (((mode) & S_IFMT) == S_IFDIR)
#endif

int
test_for_directory(const char *path)
{
      struct stat statb;

      if (eth_stat(path, &statb) < 0)
            return errno;

      if (S_ISDIR(statb.st_mode))
            return EISDIR;
      else
            return 0;
}

int
test_for_fifo(const char *path)
{
      struct stat statb;

      if (eth_stat(path, &statb) < 0)
            return errno;

      if (S_ISFIFO(statb.st_mode))
            return ESPIPE;
      else
            return 0;
}

/*
 * Directory from which the executable came.
 */
static char *progfile_dir;

/*
 * TRUE if we're running from the build directory and we aren't running
 * with special privileges.
 */
static gboolean running_in_build_directory_flag = FALSE;

/*
 * Get the pathname of the directory from which the executable came,
 * and save it for future use.  Returns NULL on success, and a
 * g_mallocated string containing an error on failure.
 */
char *
init_progfile_dir(const char *arg0
#ifdef _WIN32
      _U_
#endif
)
{
      char *dir_end;
      char *path;
#ifdef _WIN32
      TCHAR prog_pathname_w[_MAX_PATH+2];
      size_t progfile_dir_len;
        char *prog_pathname;
        DWORD error;
        TCHAR *msg_w;
        guchar *msg;
        size_t msglen;

      /*
       * Attempt to get the full pathname of the currently running
       * program.
       */
      if (GetModuleFileName(NULL, prog_pathname_w, sizeof prog_pathname_w) != 0) {
                /*
                 * XXX - Should we use g_utf16_to_utf8(), as in
                 * getenv_utf8()?
                 */
                prog_pathname = utf_16to8(prog_pathname_w);
            /*
             * We got it; strip off the last component, which would be
             * the file name of the executable, giving us the pathname
             * of the directory where the executable resies
             *
             * First, find the last "\" in the directory, as that
             * marks the end of the directory pathname.
             *
             * XXX - Can the pathname be something such as
             * "C:wireshark.exe"?  Or is it always a full pathname
             * beginning with "\" after the drive letter?
             */
            dir_end = strrchr(prog_pathname, '\\');
            if (dir_end != NULL) {
                  /*
                   * Found it - now figure out how long the program
                   * directory pathname will be.
                   */
                  progfile_dir_len = (dir_end - prog_pathname);

                  /*
                   * Allocate a buffer for the program directory
                   * pathname, and construct it.
                   */
                  path = g_malloc(progfile_dir_len + 1);
                  strncpy(path, prog_pathname, progfile_dir_len);
                  path[progfile_dir_len] = '\0';
                  progfile_dir = path;

                  return NULL;      /* we succeeded */
            } else {
                  /*
                   * OK, no \ - what do we do now?
                   */
                  return g_strdup_printf("No \\ in executable pathname \"%s\"",
                      prog_pathname);
            }
      } else {
            /*
             * Oh, well.  Return an indication of the error.
             */
            error = GetLastError();
            if (FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER|FORMAT_MESSAGE_FROM_SYSTEM,
                NULL, error, 0, (LPTSTR) &msg_w, 0, NULL) == 0) {
                  /*
                   * Gak.  We can't format the message.
                   */
                  return g_strdup_printf("GetModuleFileName failed: %u (FormatMessage failed: %u)",
                      error, GetLastError());
            }
            msg = utf_16to8(msg_w);
            LocalFree(msg_w);
            /*
             * "FormatMessage()" "helpfully" sticks CR/LF at the
             * end of the message.  Get rid of it.
             */
            msglen = strlen(msg);
            if (msglen >= 2) {
                  msg[msglen - 1] = '\0';
                  msg[msglen - 2] = '\0';
            }
            return g_strdup_printf("GetModuleFileName failed: %s (%u)",
                msg, error);
      }
#else
      char *prog_pathname;
      char *curdir;
      long path_max;
      char *pathstr;
      char *path_start, *path_end;
      size_t path_component_len;
      char *retstr;

      /*
       * Check whether WIRESHARK_RUN_FROM_BUILD_DIRECTORY is set in the
       * environment; if so, set running_in_build_directory_flag if we
       * weren't started with special privileges.  (If we were started
       * with special privileges, it's not safe to allow the user to point
       * us to some other directory; running_in_build_directory_flag, when
       * set, causes us to look for plugins and the like in the build
       * directory.)
       */
      if (getenv("WIRESHARK_RUN_FROM_BUILD_DIRECTORY") != NULL
          && !started_with_special_privs())
            running_in_build_directory_flag = TRUE;

      /*
       * Try to figure out the directory in which the currently running
       * program resides, given the argv[0] it was started with.  That
       * might be the absolute path of the program, or a path relative
       * to the current directory of the process that started it, or
       * just a name for the program if it was started from the command
       * line and was searched for in $PATH.  It's not guaranteed to be
       * any of those, however, so there are no guarantees....
       */
      if (arg0[0] == '/') {
            /*
             * It's an absolute path.
             */
            prog_pathname = g_strdup(arg0);
      } else if (strchr(arg0, '/') != NULL) {
            /*
             * It's a relative path, with a directory in it.
             * Get the current directory, and combine it
             * with that directory.
             */
            path_max = pathconf(".", _PC_PATH_MAX);
            if (path_max == -1) {
                  /*
                   * We have no idea how big a buffer to
                   * allocate for the current directory.
                   */
                  return g_strdup_printf("pathconf failed: %s\n",
                      strerror(errno));
            }
            curdir = g_malloc(path_max);
            if (getcwd(curdir, path_max) == NULL) {
                  /*
                   * It failed - give up, and just stick
                   * with DATAFILE_DIR.
                   */
                  g_free(curdir);
                  return g_strdup_printf("getcwd failed: %s\n",
                      strerror(errno));
            }
            path = g_strdup_printf("%s/%s", curdir, arg0);
            g_free(curdir);
            prog_pathname = path;
      } else {
            /*
             * It's just a file name.
             * Search the path for a file with that name
             * that's executable.
             */
            prog_pathname = NULL;   /* haven't found it yet */
            pathstr = getenv("PATH");
            path_start = pathstr;
            if (path_start != NULL) {
                  while (*path_start != '\0') {
                        path_end = strchr(path_start, ':');
                        if (path_end == NULL)
                              path_end = path_start + strlen(path_start);
                        path_component_len = path_end - path_start;
                        path = g_malloc(path_component_len + 1
                            + strlen(arg0) + 1);
                        memcpy(path, path_start, path_component_len);
                        path[path_component_len] = '\0';
                        strncat(path, "/", 2);
                        strncat(path, arg0, strlen(arg0) + 1);
                        if (access(path, X_OK) == 0) {
                              /*
                               * Found it!
                               */
                              prog_pathname = path;
                              break;
                        }

                        /*
                         * That's not it.  If there are more
                         * path components to test, try them.
                         */
                        if (*path_end == '\0') {
                              /*
                               * There's nothing more to try.
                               */
                              break;
                        }
                        if (*path_end == ':')
                              path_end++;
                        path_start = path_end;
                        g_free(path);
                  }
                  if (prog_pathname == NULL) {
                        /*
                         * Program not found in path.
                         */
                        return g_strdup_printf("\"%s\" not found in \"%s\"",
                            arg0, pathstr);
                  }
            } else {
                  /*
                   * PATH isn't set.
                   * XXX - should we pick a default?
                   */
                  return g_strdup("PATH isn't set");
            }
      }

      /*
       * OK, we have what we think is the pathname
       * of the program.
       *
       * First, find the last "/" in the directory,
       * as that marks the end of the directory pathname.
       */
      dir_end = strrchr(prog_pathname, '/');
      if (dir_end != NULL) {
            /*
             * Found it.  Strip off the last component,
             * as that's the path of the program.
             */
            *dir_end = '\0';

            /*
             * Is there a "/.libs" at the end?
             */
            dir_end = strrchr(prog_pathname, '/');
            if (dir_end != NULL) {
                  if (strcmp(dir_end, "/.libs") == 0) {
                        /*
                         * Yup, it's ".libs".
                         * Strip that off; it's an
                         * artifact of libtool.
                         */
                        *dir_end = '\0';

                        /*
                         * This presumably means we're run from
                         * the libtool wrapper, which probably
                         * means we're being run from the build
                         * directory.  If we weren't started
                         * with special privileges, set
                         * running_in_build_directory_flag.
                         *
                         * XXX - should we check whether what
                         * follows ".libs/" begins with "lt-"?
                         */
                        if (!started_with_special_privs())
                              running_in_build_directory_flag = TRUE;
                  }
            }

            /*
             * OK, we have the path we want.
             */
            progfile_dir = prog_pathname;
            return NULL;
      } else {
            /*
             * This "shouldn't happen"; we apparently
             * have no "/" in the pathname.
             * Just free up prog_pathname.
             */
            retstr = g_strdup_printf("No / found in \"%s\"", prog_pathname);
            g_free(prog_pathname);
            return retstr;
      }
#endif
}

/*
 * Get the directory in which the program resides.
 */
const char *
get_progfile_dir(void)
{
      return progfile_dir;
}

/*
 * Get the directory in which the global configuration and data files are
 * stored.
 *
 * On Windows, we use the directory in which the executable for this
 * process resides.
 *
 * On UN*X, we use the DATAFILE_DIR value supplied by the configure
 * script, unless we think we're being run from the build directory,
 * in which case we use the directory in which the executable for this
 * process resides.
 *
 * XXX - if we ever make libwireshark a real library, used by multiple
 * applications (more than just TShark and versions of Wireshark with
 * various UIs), should the configuration files belong to the library
 * (and be shared by all those applications) or to the applications?
 *
 * If they belong to the library, that could be done on UNIX by the
 * configure script, but it's trickier on Windows, as you can't just
 * use the pathname of the executable.
 *
 * If they belong to the application, that could be done on Windows
 * by using the pathname of the executable, but we'd have to have it
 * passed in as an argument, in some call, on UNIX.
 *
 * Note that some of those configuration files might be used by code in
 * libwireshark, some of them might be used by dissectors (would they
 * belong to libwireshark, the application, or a separate library?),
 * and some of them might be used by other code (the Wireshark preferences
 * file includes resolver preferences that control the behavior of code
 * in libwireshark, dissector preferences, and UI preferences, for
 * example).
 */
const char *
get_datafile_dir(void)
{
#ifdef _WIN32
      char *u3deviceexecpath;
#endif
      static char *datafile_dir = NULL;

      if (datafile_dir != NULL)
            return datafile_dir;

#ifdef _WIN32
      /*
       * See if we are running in a U3 environment.
       */
      u3deviceexecpath = getenv_utf8("U3_DEVICE_EXEC_PATH");

      if (u3deviceexecpath != NULL) {
            /*
             * We are; use the U3 device executable path.
             */
            datafile_dir = u3deviceexecpath;
      } else {
            /*
             * Do we have the pathname of the program?  If so, assume we're
             * running an installed version of the program.  If we fail,
             * we don't change "datafile_dir", and thus end up using the
             * default.
             *
             * XXX - does NSIS put the installation directory into
             * "\HKEY_LOCAL_MACHINE\SOFTWARE\Wireshark\InstallDir"?
             * If so, perhaps we should read that from the registry,
             * instead.
             */
            if (progfile_dir != NULL) {
                  /*
                   * Yes, we do; use that.
                   */
                  datafile_dir = progfile_dir;
            } else {
                  /*
                   * No, we don't.
                   * Fall back on the default installation directory.
                   */
                  datafile_dir = "C:\\Program Files\\Wireshark\\";
            }
      }
#else
      if (running_in_build_directory_flag && progfile_dir != NULL) {
            /*
             * We're (probably) being run from the build directory and
             * weren't started with special privileges, and we were
             * able to determine the directory in which the program
             * was found, so use that.
             */
            datafile_dir = progfile_dir;
      } else {
            /*
             * Return the directory specified when the build was
             * configured, prepending the run path prefix if it exists.
             */
            if (getenv("WIRESHARK_DATA_DIR") && !started_with_special_privs()) {
                  /*
                   * The user specified a different directory for data files
                   * and we aren't running with special privileges.
                   * XXX - We might be able to dispense with the priv check
                   */
                  datafile_dir = g_strdup(getenv("WIRESHARK_DATA_DIR"));
            } else {
                  datafile_dir = DATAFILE_DIR;
            }
      }

#endif
      return datafile_dir;
}

#ifdef HAVE_PLUGINS
/*
 * Find the directory where the plugins are stored.
 *
 * On Windows, we use the "plugin" subdirectory of the datafile directory.
 *
 * On UN*X, we use the PLUGIN_DIR value supplied by the configure
 * script, unless we think we're being run from the build directory,
 * in which case we use the "plugin" subdirectory of the datafile directory.
 *
 * In both cases, we then use the subdirectory of that directory whose
 * name is the version number.
 *
 * XXX - if we think we're being run from the build directory, perhaps we
 * should have the plugin code not look in the version subdirectory
 * of the plugin directory, but look in all of the subdirectories
 * of the plugin directory, so it can just fetch the plugins built
 * as part of the build process.
 */
static const char *plugin_dir = NULL;

static void
init_plugin_dir(void)
{
#ifdef _WIN32
      /*
       * On Windows, the data file directory is the installation
       * directory; the plugins are stored under it.
       *
       * Assume we're running the installed version of Wireshark;
       * on Windows, the data file directory is the directory
       * in which the Wireshark binary resides.
       */
      plugin_dir = g_strdup_printf("%s\\plugins\\%s", get_datafile_dir(),
          VERSION);

      /*
       * Make sure that pathname refers to a directory.
       */
      if (test_for_directory(plugin_dir) != EISDIR) {
            /*
             * Either it doesn't refer to a directory or it
             * refers to something that doesn't exist.
             *
             * Assume that means we're running a version of
             * Wireshark we've built in a build directory,
             * in which case {datafile dir}\plugins is the
             * top-level plugins source directory, and use
             * that directory and set the "we're running in
             * a build directory" flag, so the plugin
             * scanner will check all subdirectories of that
             * directory for plugins.
             */
            g_free( (gpointer) plugin_dir);
            plugin_dir = g_strdup_printf("%s\\plugins", get_datafile_dir());
            running_in_build_directory_flag = TRUE;
      }
#else
      if (running_in_build_directory_flag) {
            /*
             * We're (probably) being run from the build directory and
             * weren't started with special privileges, so we'll use
             * the "plugins" subdirectory of the datafile directory
             * (the datafile directory is the build directory).
             */
            plugin_dir = g_strdup_printf("%s/plugins", get_datafile_dir());
      } else {
            if (getenv("WIRESHARK_PLUGIN_DIR") && !started_with_special_privs()) {
                  /*
                   * The user specified a different directory for plugins
                   * and we aren't running with special privileges.
                   */
                  plugin_dir = g_strdup(getenv("WIRESHARK_PLUGIN_DIR"));
            } else {
                  plugin_dir = PLUGIN_DIR;
            }
      }
#endif
}
#endif /* HAVE_PLUGINS */

/*
 * Get the directory in which the plugins are stored.
 */
const char *
get_plugin_dir(void)
{
#ifdef HAVE_PLUGINS
      if (!plugin_dir) init_plugin_dir();
      return plugin_dir;
#else
      return NULL;
#endif
}

/*
 * Get the flag indicating whether we're running from a build
 * directory.
 */
gboolean
running_in_build_directory(void)
{
      return running_in_build_directory_flag;
}

/*
 * Get the directory in which files that, at least on UNIX, are
 * system files (such as "/etc/ethers") are stored; on Windows,
 * there's no "/etc" directory, so we get them from the global
 * configuration and data file directory.
 */
const char *
get_systemfile_dir(void)
{
#ifdef _WIN32
      return get_datafile_dir();
#else
      return "/etc";
#endif
}

/*
 * Name of directory, under the user's home directory, in which
 * personal configuration files are stored.
 */
#ifdef _WIN32
#define PF_DIR "Wireshark"
#else
/*
 * XXX - should this be ".libepan"? For backwards-compatibility, I'll keep
 * it ".wireshark" for now.
 */
#define PF_DIR ".wireshark"
#endif

#ifdef _WIN32
/* utf8 version of getenv, needed to get win32 filename paths */
char *getenv_utf8(const char *varname)
{
      char *envvar;
      wchar_t *envvarw;
      wchar_t *varnamew;

      envvar = getenv(varname);

      /* since GLib 2.6 we need an utf8 version of the filename */
#if (GLIB_MAJOR_VERSION > 2 || (GLIB_MAJOR_VERSION == 2 && GLIB_MINOR_VERSION >= 6))
      /* using the wide char version of getenv should work under all circumstances */

      /* convert given varname to utf16, needed by _wgetenv */
      varnamew = g_utf8_to_utf16(varname, -1, NULL, NULL, NULL);
      if (varnamew == NULL) {
            return envvar;
      }

      /* use wide char version of getenv */
      envvarw = _wgetenv(varnamew);
      g_free(varnamew);
      if (envvarw == NULL) {
            return envvar;
      }

      /* convert value to utf8 */
      envvar = g_utf16_to_utf8(envvarw, -1, NULL, NULL, NULL);
      /* XXX - memleak */
#endif

      return envvar;
}
#endif

void
set_profile_name(const gchar *profilename)
{
      if (persconfprofile) {
            g_free (persconfprofile);
      }

      if (profilename && strlen(profilename) > 0 &&
          strcmp(profilename, DEFAULT_PROFILE) != 0) {
            persconfprofile = g_strdup (profilename);
      } else {
            /* Default Profile */
            persconfprofile = NULL;
      }
}

const char *
get_profile_name(void)
{
      if (persconfprofile) {
            return persconfprofile;
      } else {
            return DEFAULT_PROFILE;
      }
}

/*
 * Get the directory in which personal configuration files reside;
 * in UNIX-compatible systems, it's ".wireshark", under the user's home
 * directory, and on Windows systems, it's "Wireshark", under %APPDATA%
 * or, if %APPDATA% isn't set, it's "%USERPROFILE%\Application Data"
 * (which is what %APPDATA% normally is on Windows 2000).
 */
static const char *
get_persconffile_dir_no_profile(void)
{
#ifdef _WIN32
      char *appdatadir;
      char *userprofiledir;
      char *u3appdatapath;
#else
      const char *homedir;
      struct passwd *pwd;
#endif

      /* Return the cached value, if available */
      if (persconffile_dir != NULL)
            return persconffile_dir;

#ifdef _WIN32
      /*
       * See if we are running in a U3 environment.
       */
      u3appdatapath = getenv_utf8("U3_APP_DATA_PATH");
      if (u3appdatapath != NULL) {
            /*
             * We are; use the U3 application data path.
             */
            persconffile_dir = u3appdatapath;
      } else {
            /*
             * Use %APPDATA% or %USERPROFILE%, so that configuration
             * files are stored in the user profile, rather than in
             * the home directory.  The Windows convention is to store
             * configuration information in the user profile, and doing
             * so means you can use Wireshark even if the home directory
             * is an inaccessible network drive.
             */
            appdatadir = getenv_utf8("APPDATA");
            if (appdatadir != NULL) {
                  /*
                   * Concatenate %APPDATA% with "\Wireshark".
                   */
                  persconffile_dir = g_strdup_printf("%s" G_DIR_SEPARATOR_S "%s",
                                             appdatadir, PF_DIR);
            } else {
                  /*
                   * OK, %APPDATA% wasn't set, so use
                   * %USERPROFILE%\Application Data.
                   */
                  userprofiledir = getenv_utf8("USERPROFILE");
                  if (userprofiledir != NULL) {
                        persconffile_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:".
                         */
                        persconffile_dir = g_strdup_printf("C:" G_DIR_SEPARATOR_S "%s", PF_DIR);
                  }
            }
      }
#else
      /*
       * If $HOME is set, use that.
       */
      homedir = getenv("HOME");
      if (homedir == NULL) {
            /*
             * Get their home directory from the password file.
             * If we can't even find a password file entry for them,
             * use "/tmp".
             */
            pwd = getpwuid(getuid());
            if (pwd != NULL) {
                  /*
                   * This is cached, so we don't need to worry
                   * about allocating multiple ones of them.
                   */
                  homedir = g_strdup(pwd->pw_dir);
            } else
                  homedir = "/tmp";
      }
      persconffile_dir = g_strdup_printf("%s" G_DIR_SEPARATOR_S "%s", homedir, PF_DIR);
#endif

      return persconffile_dir;
}

const char *
get_profiles_dir(void)
{
      static char *profiles_dir = NULL;

      if (profiles_dir) {
            g_free (profiles_dir);
      }

      profiles_dir = g_strdup_printf ("%s%s%s", get_persconffile_dir_no_profile (),
                              G_DIR_SEPARATOR_S, PROFILES_DIR);

      return profiles_dir;
}

static const char *
get_persconffile_dir(const gchar *profilename)
{
      static char *persconffile_profile_dir = NULL;

      if (persconffile_profile_dir) {
            g_free (persconffile_profile_dir);
      }

      if (profilename && strlen(profilename) > 0 &&
          strcmp(profilename, DEFAULT_PROFILE) != 0) {
        persconffile_profile_dir = g_strdup_printf ("%s%s%s", get_profiles_dir (),
                                          G_DIR_SEPARATOR_S, profilename);
      } else {
        persconffile_profile_dir = g_strdup (get_persconffile_dir_no_profile ());
      }

      return persconffile_profile_dir;
}

gboolean
profile_exists(const gchar *profilename)
{
      if (test_for_directory (get_persconffile_dir (profilename)) == EISDIR) {
            return TRUE;
      }

      return FALSE;
}

static int
delete_directory (const char *directory, char **pf_dir_path_return)
{
      ETH_DIR *dir;
      ETH_DIRENT *file;
      gchar *filename;
      int ret = 0;

      if ((dir = eth_dir_open(directory, 0, NULL)) != NULL) {
            while ((file = eth_dir_read_name(dir)) != NULL) {
                  filename = g_strdup_printf ("%s%s%s", directory, G_DIR_SEPARATOR_S,
                                        eth_dir_get_name(file));
                  if (test_for_directory(filename) != EISDIR) {
                        ret = eth_remove(filename);
#if 0
                  } else {
                        /* The user has manually created a directory in the profile directory */
                        /* I do not want to delete the directory recursively yet */
                        ret = delete_directory (filename, pf_dir_path_return);
#endif
                  }
                  if (ret != 0) {
                        *pf_dir_path_return = filename;
                        break;
                  }
                  g_free (filename);
            }
            eth_dir_close(dir);
      }

      if (ret == 0 && (ret = eth_remove(directory)) != 0) {
            *pf_dir_path_return = g_strdup (directory);
      }

      return ret;
}

int
delete_persconffile_profile(const char *profilename, char **pf_dir_path_return)
{
      const char *profile_dir = get_persconffile_dir(profilename);
      int ret = 0;

      if (test_for_directory (profile_dir) == EISDIR) {
            ret = delete_directory (profile_dir, pf_dir_path_return);
      }

      return ret;
}

int
rename_persconffile_profile(const char *fromname, const char *toname,
                      char **pf_from_dir_path_return, char **pf_to_dir_path_return)
{
      char *from_dir = g_strdup (get_persconffile_dir(fromname));
      char *to_dir = g_strdup (get_persconffile_dir(toname));
      int ret = 0;

      ret = eth_rename (from_dir, to_dir);
      if (ret != 0) {
            *pf_from_dir_path_return = g_strdup (from_dir);
            *pf_to_dir_path_return = g_strdup (to_dir);
      }

      g_free (from_dir);
      g_free (to_dir);

      return ret;
}

/*
 * Create the directory that holds personal configuration files, if
 * necessary.  If we attempted to create it, and failed, return -1 and
 * set "*pf_dir_path_return" to the pathname of the directory we failed
 * to create (it's g_mallocated, so our caller should free it); otherwise,
 * return 0.
 */
int
create_persconffile_profile(const char *profilename, char **pf_dir_path_return)
{
      const char *pf_dir_path;
#ifdef _WIN32
      char *pf_dir_path_copy, *pf_dir_parent_path;
      size_t pf_dir_parent_path_len;
#endif
      struct stat s_buf;
      int ret;

      if (profilename) {
            /*
             * Check if profiles directory exists.
             * If not then create it.
             */
            pf_dir_path = get_profiles_dir ();
            if (eth_stat(pf_dir_path, &s_buf) != 0 && errno == ENOENT) {
                  ret = eth_mkdir(pf_dir_path, 0755);
                  if (ret == -1) {
                        *pf_dir_path_return = g_strdup(pf_dir_path);
                        return ret;
                  }
            }
      }

      pf_dir_path = get_persconffile_dir(profilename);
      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
             * %USERPROFILE% does.
             *
             * We check for the existence of the directory
             * by first checking whether the parent directory
             * is just a drive letter and, if it's not, by
             * doing a "stat()" on it.  If it's a drive letter,
             * or if the "stat()" succeeds, we assume it exists.
             */
            pf_dir_path_copy = g_strdup(pf_dir_path);
            pf_dir_parent_path = get_dirname(pf_dir_path_copy);
            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] != ':'
                && eth_stat(pf_dir_parent_path, &s_buf) != 0) {
                  /*
                   * No, it doesn't exist - make it first.
                   */
                  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 = eth_mkdir(pf_dir_path, 0755);
#else
            ret = eth_mkdir(pf_dir_path, 0755);
#endif
      } else {
            /*
             * Something with that pathname exists; if it's not
             * a directory, we'll get an error if we try to put
             * something in it, so we don't fail here, we wait
             * for that attempt fo fail.
             */
            ret = 0;
      }
      if (ret == -1)
            *pf_dir_path_return = g_strdup(pf_dir_path);
      return ret;
}

int
create_persconffile_dir(char **pf_dir_path_return)
{
  return create_persconffile_profile(persconfprofile, pf_dir_path_return);
}

/*
 * Get the (default) directory in which personal data is stored.
 *
 * On Win32, this is the "My Documents" folder in the personal profile.
 * On UNIX this is simply the current directory.
 * On a U3 device this is "$U3_DEVICE_DOCUMENT_PATH\My Captures" folder.
 */
/* XXX - should this and the get_home_dir() be merged? */
extern char *
get_persdatafile_dir(void)
{
#ifdef _WIN32
      char *u3devicedocumentpath;
      TCHAR tszPath[MAX_PATH];
      char *szPath;
      BOOL bRet;


      /* Return the cached value, if available */
      if (persdatafile_dir != NULL)
            return persdatafile_dir;

      /*
       * See if we are running in a U3 environment.
       */
      u3devicedocumentpath = getenv_utf8("U3_DEVICE_DOCUMENT_PATH");

      if (u3devicedocumentpath != NULL) {

        /* the "My Captures" sub-directory is created (if it doesn't exist)
             by u3util.exe when the U3 Wireshark is first run */

        szPath = g_strdup_printf("%s%s", u3devicedocumentpath, U3_MY_CAPTURES);

        persdatafile_dir = szPath;
        return szPath;

            } else {
      /* Hint: SHGetFolderPath is not available on MSVC 6 - without Platform SDK */
      bRet = SHGetSpecialFolderPath(NULL, tszPath, CSIDL_PERSONAL, FALSE);
      if(bRet == TRUE) {
            szPath = utf_16to8(tszPath);
            persdatafile_dir = szPath;
            return szPath;
      } else {
            return "";
      }
}
#else
  return "";
#endif
}

#ifdef _WIN32
/*
 * Returns the user's home directory on Win32.
 */
static const char *
get_home_dir(void)
{
      static const char *home = NULL;
      char *homedrive, *homepath;
      char *homestring;
      char *lastsep;

      /* Return the cached value, if available */
      if (home)
            return home;

      /*
       * XXX - should we use USERPROFILE anywhere in this process?
       * Is there a chance that it might be set but one or more of
       * HOMEDRIVE or HOMEPATH isn't set?
       */
      homedrive = getenv_utf8("HOMEDRIVE");
      if (homedrive != NULL) {
            homepath = getenv_utf8("HOMEPATH");
            if (homepath != NULL) {
                  /*
                   * This is cached, so we don't need to worry about
                   * allocating multiple ones of them.
                   */
                  homestring = g_strdup_printf("%s%s", homedrive, homepath);

                  /*
                   * Trim off any trailing slash or backslash.
                   */
                  lastsep = find_last_pathname_separator(homestring);
                  if (lastsep != NULL && *(lastsep + 1) == '\0') {
                        /*
                         * Last separator is the last character
                         * in the string.  Nuke it.
                         */
                        *lastsep = '\0';
                  }
                  home = homestring;
            } else
                  home = homedrive;
      } else {
            /*
             * Give up and use C:.
             */
            home = "C:";
      }

      return home;
}
#endif

/*
 * Construct the path name of a personal configuration file, given the
 * file name.
 *
 * On Win32, if "for_writing" is FALSE, we check whether the file exists
 * and, if not, construct a path name relative to the ".wireshark"
 * subdirectory of the user's home directory, and check whether that
 * exists; if it does, we return that, so that configuration files
 * from earlier versions can be read.
 *
 * The returned file name was g_malloc()'d so it must be g_free()d when the
 * caller is done with it.
 */
char *
get_persconffile_path(const char *filename, gboolean from_profile, gboolean for_writing
#ifndef _WIN32
      _U_
#endif
)
{
      char *path;
#ifdef _WIN32
      struct stat s_buf;
      char *old_path;
#endif

      if (from_profile) {
        path = g_strdup_printf("%s" G_DIR_SEPARATOR_S "%s",
                         get_persconffile_dir(persconfprofile), filename);
      } else {
        path = g_strdup_printf("%s" G_DIR_SEPARATOR_S "%s",
                         get_persconffile_dir(NULL), filename);
      }
#ifdef _WIN32
      if (!for_writing) {
            if (eth_stat(path, &s_buf) != 0 && errno == ENOENT) {
                  /*
                   * OK, it's not in the personal configuration file
                   * directory; is it in the ".wireshark" subdirectory
                   * of their home directory?
                   */
                  old_path = g_strdup_printf(
                      "%s" G_DIR_SEPARATOR_S ".wireshark" G_DIR_SEPARATOR_S "%s",
                      get_home_dir(), filename);
                  if (eth_stat(old_path, &s_buf) == 0) {
                        /*
                         * OK, it exists; return it instead.
                         */
                        g_free(path);
                        path = old_path;
                  }
            }
      }
#endif

      return path;
}

/*
 * process command line option belonging to the filesystem settings
 * (move this e.g. to main.c and have set_persconffile_dir() instead in this file?)
 */
int
filesystem_opt(int opt _U_, const char *optarg)
{
      gchar *p, *colonp;

      colonp = strchr(optarg, ':');
      if (colonp == NULL) {
            return 1;
      }

      p = colonp;
      *p++ = '\0';

      /*
      * Skip over any white space (there probably won't be any, but
      * as we allow it in the preferences file, we might as well
      * allow it here).
      */
      while (isspace((guchar)*p))
      p++;
      if (*p == '\0') {
            /*
             * Put the colon back, so if our caller uses, in an
             * error message, the string they passed us, the message
             * looks correct.
             */
            *colonp = ':';
            return 1;
      }

      /* directory should be existing */
      /* XXX - is this a requirement? */
      if(test_for_directory(p) != EISDIR) {
            /*
             * Put the colon back, so if our caller uses, in an
             * error message, the string they passed us, the message
             * looks correct.
             */
            *colonp = ':';
            return 1;
      }

      if (strcmp(optarg,"persconf") == 0) {
            persconffile_dir = p;
      } else if (strcmp(optarg,"persdata") == 0) {
            persdatafile_dir = p;
            /* XXX - might need to add the temp file path */
      } else {
            return 1;
      }
      *colonp = ':'; /* put the colon back */
      return 0;
}

/*
 * Construct the path name of a global configuration file, given the
 * file name.
 *
 * The returned file name was g_malloc()'d so it must be g_free()d when the
 * caller is done with it.
 */
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

      case EINVAL:
            errmsg = "The file \"%s\" could not be created because an invalid filename was specified.";
            break;

      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;

#ifdef _WIN32
      /*
       * 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;
      }
#else
      if (eth_stat(fname, &file_stat) != 0 && errno == ENOENT) {
            return FALSE;
      } else {
            return TRUE;
      }
#endif
}

/*
 * 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), so we can't just compare paths. From Joerg Mayer.
 */
gboolean
files_identical(const char *fname1, const char *fname2)
{
      /* Two different implementations, because:
       *
       * - _fullpath is not available on UN*X, so we can't get full
       *   paths and compare them (which wouldn't work with hard links
       *   in any case);
       *
       * - st_ino isn't filled in with a meaningful value on Windows.
       */
#ifdef _WIN32
      char full1[MAX_PATH], full2[MAX_PATH];

      /*
       * Get the absolute full paths of the file and compare them.
       * That won't work if you have hard links, but those aren't
       * much used on Windows, even though NTFS supports them.
       *
       * XXX - will _fullpath work with UNC?
       */
      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   filestat1, filestat2;

      /*
       * Compare st_dev and st_ino.
       */
      if (eth_stat(fname1, &filestat1) == -1)
            return FALSE;     /* can't get info about the first file */
      if (eth_stat(fname2, &filestat2) == -1)
            return FALSE;     /* can't get info about the second file */
      return (filestat1.st_dev == filestat2.st_dev &&
            filestat1.st_ino == filestat2.st_ino);
#endif
}

/*
 * Editor modelines
 *
 * Local Variables:
 * c-basic-offset: 4
 * tab-width: 4
 * indent-tabs-mode: tabs
 * End:
 *
 * ex: set shiftwidth=4 tabstop=4 noexpandtab
 * :indentSize=4:tabSize=4:noTabs=false:
 */


Generated by  Doxygen 1.6.0   Back to index