/* filesystem.c
* Filesystem utility routines
*
- * $Id: filesystem.c,v 1.13 2001/10/24 06:13:05 guy Exp $
+ * $Id$
*
- * Ethereal - Network traffic analyzer
- * By Gerald Combs <gerald@ethereal.com>
+ * 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.
# include "config.h"
#endif
+/*
+ * Required with GNU libc to get dladdr().
+ * We define it here because <dlfcn.h> apparently gets included by
+ * one of the headers we include below.
+ */
+#define _GNU_SOURCE
+
+#ifdef HAVE_DIRENT_H
+#include <dirent.h>
+#endif
+
#include <stdio.h>
+#include <ctype.h>
#include <stdlib.h>
#include <string.h>
#include <errno.h>
#include <unistd.h>
#endif
-#ifdef HAVE_SYS_TYPES_H
-#include <sys/types.h>
+#ifdef HAVE_FCNTL_H
+#include <fcntl.h>
#endif
#ifdef HAVE_SYS_STAT_H
#include <sys/stat.h>
#endif
-#ifdef HAVE_WINDOWS_H
+#ifdef _WIN32
#include <windows.h>
-#endif
-
-#ifdef HAVE_DIRECT_H
-#include <direct.h> /* to declare "mkdir()" on Windows */
-#endif
-
-#ifndef WIN32
+#include <tchar.h>
+#include <shlobj.h>
+#include <wsutil/unicode-utils.h>
+#else /* _WIN32 */
+#ifdef DLADDR_FINDS_EXECUTABLE_PATH
+#include <dlfcn.h>
+#endif /* DLADDR_FINDS_EXECUTABLE_PATH */
#include <pwd.h>
-#endif
+#endif /* _WIN32 */
#include "filesystem.h"
+#include "report_err.h"
+#include <wsutil/privileges.h>
+#include <wsutil/file_util.h>
+
+#include <wiretap/wtap.h> /* for WTAP_ERR_SHORT_WRITE */
+
+#define PROFILES_DIR "profiles"
+#define PLUGINS_DIR_NAME "plugins"
+
+#define U3_MY_CAPTURES "\\My Captures"
+
+char *persconffile_dir = NULL;
+char *persdatafile_dir = NULL;
+char *persconfprofile = NULL;
+
+static gboolean do_store_persconffiles = FALSE;
+static GHashTable *profile_files = NULL;
/*
* Given a pathname, return a pointer to the last pathname separator
* separators.
*/
char *
-find_last_pathname_separator(char *path)
+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 == '/')
/*
* 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) {
/*
{
char *separator;
+ g_assert(path != NULL);
separator = find_last_pathname_separator(path);
if (separator == NULL) {
/*
{
struct stat statb;
- if (stat(path, &statb) < 0)
+ if (ws_stat(path, &statb) < 0)
return errno;
if (S_ISDIR(statb.st_mode))
return 0;
}
+int
+test_for_fifo(const char *path)
+{
+ struct stat statb;
+
+ if (ws_stat(path, &statb) < 0)
+ return errno;
+
+ if (S_ISFIFO(statb.st_mode))
+ return ESPIPE;
+ else
+ return 0;
+}
+
/*
- * Get the directory in which Ethereal's global configuration and data
- * files are stored.
+ * Directory from which the executable came.
*/
-const char *
-get_datafile_dir(void)
-{
-#ifdef WIN32
- char prog_pathname[_MAX_PATH+2];
- char *dir_end;
- size_t datafile_dir_len;
- static char *datafile_dir;
+static char *progfile_dir;
- /*
- * Have we already gotten the pathname?
- * If so, just return it.
- */
- if (datafile_dir != NULL)
- return datafile_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;
- /*
- * No, we haven't.
- * Start out by assuming it's the default installation directory.
- */
- datafile_dir = "C:\\Program Files\\Ethereal\\";
+/*
+ * 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
+, int (*main_addr)(int, char **)
+#if defined(_WIN32) || !defined(DLADDR_FINDS_EXECUTABLE_PATH)
+ _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;
/*
- * Now we attempt to get the full pathname of the currently running
- * program, under the assumption that we're running an installed
- * version of the program. If we fail, we don't change "datafile_dir",
- * and thus end up using DATAFILE_DIR.
- *
- * XXX - does NSIS put the installation directory into
- * "\HKEY_LOCAL_MACHINE\SOFTWARE\Ethereal\InstallDir"?
- * If so, perhaps we should read that from the registry,
- * instead.
+ * Attempt to get the full pathname of the currently running
+ * program.
*/
- if (GetModuleFileName(NULL, prog_pathname, sizeof prog_pathname) != 0) {
+ if (GetModuleFileName(NULL, prog_pathname_w, G_N_ELEMENTS(prog_pathname_w)) != 0 && GetLastError() != ERROR_INSUFFICIENT_BUFFER) {
+ /*
+ * XXX - Should we use g_utf16_to_utf8(), as in
+ * getenv_utf8()?
+ */
+ prog_pathname = utf_16to8(prog_pathname_w);
/*
- * If the program is an installed version, the full pathname
- * includes the pathname of the directory in which it was
- * installed; get that directory's pathname, and construct
- * from it the pathname of the directory in which the
- * plugins were installed.
+ * 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
+ * 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:ethereal.exe"? Or is it always a full pathname
- * beginning with "\\" after the drive letter?
+ * "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 datafile
+ * Found it - now figure out how long the program
* directory pathname will be.
*/
- datafile_dir_len = (dir_end - prog_pathname);
+ progfile_dir_len = (dir_end - prog_pathname);
/*
- * Allocate a buffer for the plugin directory
+ * Allocate a buffer for the program directory
* pathname, and construct it.
*/
- datafile_dir = g_malloc(datafile_dir_len + 1);
- strncpy(datafile_dir, prog_pathname, datafile_dir_len);
- datafile_dir[datafile_dir_len] = '\0';
+ 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);
}
- return datafile_dir;
#else
+#ifdef DLADDR_FINDS_EXECUTABLE_PATH
+ Dl_info info;
+#endif
+ 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;
+
+#ifdef DLADDR_FINDS_EXECUTABLE_PATH
+ /*
+ * Try to use dladdr() to find the pathname of the executable.
+ * dladdr() is not guaranteed to give you anything better than
+ * argv[0] (i.e., it might not contain a / at all, much less
+ * being an absolute path), and doesn't appear to do so on
+ * Linux, but on other platforms it could give you an absolute
+ * path and obviate the need for us to determine the absolute
+ * path.
+ */
+ if (dladdr((void *)main_addr, &info))
+ arg0 = info.dli_fname;
+#endif
+ /*
+ * Try to figure out the directory in which the currently running
+ * program resides, given something purporting to be the executable
+ * name (from dladdr() or from 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 = (char *)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 = (char *)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");
+ }
+ }
+
/*
- * Just use DATAFILE_DIR, as that's what the configure script
- * set it to be.
+ * 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.
*/
- return DATAFILE_DIR;
+ 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 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 Ethereal
- * global configuration and data file directory.
+ * Get the directory in which the program resides.
*/
const char *
-get_systemfile_dir(void)
+get_progfile_dir(void)
{
-#ifdef WIN32
- return get_datafile_dir();
-#else
- return "/etc";
-#endif
+ return progfile_dir;
}
/*
- * Name of directory, under the user's home directory, in which
- * personal configuration files are stored.
- */
-#ifdef WIN32
-#define PF_DIR "Ethereal"
-#else
-/*
- * XXX - should this be ".libepan"? For backwards-compatibility, I'll keep
- * it ".ethereal" for now.
- */
-#define PF_DIR ".ethereal"
-#endif
-
-/*
- * Get the directory in which personal configuration files reside;
- * in UNIX-compatible systems, it's ".ethereal", under the user's home
- * directory, and on Windows systems, it's "Ethereal", under %APPDATA%
- * or, if %APPDATA% isn't set, it's "%USERPROFILE%\Application Data"
- * (which is what %APPDATA% normally is on Windows 2000).
+ * 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_persconffile_dir(void)
+get_datafile_dir(void)
{
-#ifdef WIN32
- char *appdatadir;
- char *userprofiledir;
-#else
- char *homedir;
- struct passwd *pwd;
+#ifdef _WIN32
+ char *u3deviceexecpath;
#endif
- static char *pf_dir = NULL;
+ static const char *datafile_dir = NULL;
- /* Return the cached value, if available */
- if (pf_dir != NULL)
- return pf_dir;
+ if (datafile_dir != NULL)
+ return datafile_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.
- * The Windows convention is to store configuration information
- * in the user profile, and doing so means you can use
- * Ethereal even if the home directory is an inaccessible
- * network drive.
+ * See if we are running in a U3 environment.
*/
- appdatadir = getenv("APPDATA");
- if (appdatadir != NULL) {
+ u3deviceexecpath = getenv_utf8("U3_DEVICE_EXEC_PATH");
+
+ if (u3deviceexecpath != NULL) {
/*
- * Concatenate %APPDATA% with "\Ethereal".
+ * We are; use the U3 device executable path.
*/
- pf_dir = g_malloc(strlen(appdatadir) + strlen(PF_DIR) + 2);
- sprintf(pf_dir, "%s" G_DIR_SEPARATOR_S "%s", appdatadir,
- PF_DIR);
+ datafile_dir = u3deviceexecpath;
} else {
/*
- * OK, %APPDATA% wasn't set, so use
- * %USERPROFILE%\Application Data.
+ * 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.
*/
- userprofiledir = getenv("USERPROFILE");
- if (userprofiledir != NULL) {
- pf_dir = g_malloc(strlen(userprofiledir) +
- strlen("Application Data" + strlen(PF_DIR) + 3);
- sprintf(pf_dir,
- "%s" G_DIR_SEPARATOR_S "Application Data" G_DIR_SEPARATOR_S "%s",
- userprofiledir, PF_DIR);
+ if (progfile_dir != NULL) {
+ /*
+ * Yes, we do; use that.
+ */
+ datafile_dir = progfile_dir;
} else {
/*
- * Give up and use "C:".
+ * No, we don't.
+ * Fall back on the default installation directory.
*/
- pf_dir = g_malloc(strlen("C:") + strlen(PF_DIR) + 2);
- sprintf(pf_dir, "C:" G_DIR_SEPARATOR_S "%s", PF_DIR);
+ datafile_dir = "C:\\Program Files\\Wireshark\\";
}
}
#else
- /*
- * If $HOME is set, use that.
- */
- homedir = getenv("HOME");
- if (homedir == NULL) {
+ if (running_in_build_directory_flag && progfile_dir != NULL) {
/*
- * Get their home directory from the password file.
- * If we can't even find a password file entry for them,
- * use "/tmp".
+ * 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.
*/
- pwd = getpwuid(getuid());
- if (pwd != NULL) {
+ 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()) {
/*
- * This is cached, so we don't need to worry
- * about allocating multiple ones of them.
+ * 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
*/
- homedir = g_strdup(pwd->pw_dir);
- } else
- homedir = "/tmp";
+ datafile_dir = g_strdup(getenv("WIRESHARK_DATA_DIR"));
+ } else {
+ datafile_dir = DATAFILE_DIR;
+ }
}
- pf_dir = g_malloc(strlen(homedir) + strlen(PF_DIR) + 2);
- sprintf(pf_dir, "%s" G_DIR_SEPARATOR_S "%s", homedir, PF_DIR);
-#endif
- return pf_dir;
+#endif
+ return datafile_dir;
}
+#ifdef HAVE_PYTHON
/*
- * 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.
+ * Find the directory where the python dissectors are stored.
+ *
+ * On Windows, we use the "py_dissector" subdirectory of the datafile directory.
+ *
+ * On UN*X, we use the PYTHON_DIR value supplied by the configure
+ * script, unless we think we're being run from the build directory,
+ * in which case we use the "py_dissector" 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.
*/
-int
-create_persconffile_dir(char **pf_dir_path_return)
+static const char *wspython_dir = NULL;
+
+static void
+init_wspython_dir(void)
{
- const char *pf_dir_path;
- struct stat s_buf;
- int ret;
+#ifdef _WIN32
+ /*
+ * On Windows, the data file directory is the installation
+ * directory; the python dissectors 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.
+ */
+ wspython_dir = g_strdup_printf("%s\\python\\%s", get_datafile_dir(),
+ VERSION);
- pf_dir_path = get_persconffile_dir();
- if (stat(pf_dir_path, &s_buf) != 0 && errno == ENOENT) {
-#ifdef WIN32
+ /*
+ * Make sure that pathname refers to a directory.
+ */
+ if (test_for_directory(wspython_dir) != EISDIR) {
/*
- * Does the parent directory of that directory
- * exist? %APPDATA% may not exist even though
- * %USERPROFILE% does.
+ * 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}\python 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 python dissectors.
*/
- pf_dir_path_copy = g_strdup(pf_dir_path);
- pf_dir_parent_path = get_dirname(pf_dir_path_copy);
- if (stat(pf_dir_parent_path, &s_buf) != 0) {
+ g_free( (gpointer) wspython_dir);
+ wspython_dir = g_strdup_printf("%s\\python", 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 "python" subdirectory of the datafile directory
+ * (the datafile directory is the build directory).
+ */
+ wspython_dir = g_strdup_printf("%s/epan/wspython/", get_datafile_dir());
+ } else {
+ if (getenv("WIRESHARK_PYTHON_DIR") && !started_with_special_privs()) {
/*
- * No - make it first.
+ * The user specified a different directory for plugins
+ * and we aren't running with special privileges.
*/
- ret = mkdir(pf_dir_parent_path);
- if (ret == -1) {
- *pf_dir_path_return = pf_dir_parent_path;
- return -1;
- }
+ wspython_dir = g_strdup(getenv("WIRESHARK_PYTHON_DIR"));
+ } else {
+ wspython_dir = PYTHON_DIR;
}
- g_free(pf_dir_path_copy);
- ret = mkdir(pf_dir_path);
+ }
+#endif
+}
+#endif /* HAVE_PYTHON */
+
+/*
+ * Get the directory in which the python dissectors are stored.
+ */
+const char *
+get_wspython_dir(void)
+{
+#ifdef HAVE_PYTHON
+ if (!wspython_dir) init_wspython_dir();
+ return wspython_dir;
#else
- ret = mkdir(pf_dir_path, 0755);
+ return NULL;
#endif
- } else {
+}
+
+
+#if defined(HAVE_PLUGINS) || defined(HAVE_LUA_5_1)
+/*
+ * 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) {
/*
- * 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.
+ * 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.
*/
- ret = 0;
+ g_free( (gpointer) plugin_dir);
+ plugin_dir = g_strdup_printf("%s\\plugins", get_datafile_dir());
+ running_in_build_directory_flag = TRUE;
}
- if (ret == -1)
- *pf_dir_path_return = g_strdup(pf_dir_path);
- return ret;
-}
+#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 || HAVE_LUA_5_1 */
+
+/*
+ * Get the directory in which the plugins are stored.
+ */
+const char *
+get_plugin_dir(void)
+{
+#if defined(HAVE_PLUGINS) || defined(HAVE_LUA_5_1)
+ 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_CHECK_VERSION(2,6,0)
+ /* 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)
+{
+ 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;
+ }
+}
+
+void
+profile_store_persconffiles(gboolean store)
+{
+ if (store) {
+ profile_files = g_hash_table_new (g_str_hash, g_str_equal);
+ }
+ do_store_persconffiles = store;
+}
+
+/*
+ * 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;
+
+ 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;
+
+ 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)
+{
+ WS_DIR *dir;
+ WS_DIRENT *file;
+ gchar *filename;
+ int ret = 0;
+
+ if ((dir = ws_dir_open(directory, 0, NULL)) != NULL) {
+ while ((file = ws_dir_read_name(dir)) != NULL) {
+ filename = g_strdup_printf ("%s%s%s", directory, G_DIR_SEPARATOR_S,
+ ws_dir_get_name(file));
+ if (test_for_directory(filename) != EISDIR) {
+ ret = ws_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);
+ }
+ ws_dir_close(dir);
+ }
+
+ if (ret == 0 && (ret = ws_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 = ws_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 (ws_stat(pf_dir_path, &s_buf) != 0 && errno == ENOENT) {
+ ret = ws_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 (ws_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] != ':'
+ && ws_stat(pf_dir_parent_path, &s_buf) != 0) {
+ /*
+ * No, it doesn't exist - make it first.
+ */
+ ret = ws_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 = ws_mkdir(pf_dir_path, 0755);
+#else
+ ret = ws_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);
+}
+
+#if ! GLIB_CHECK_VERSION(2,14,0)
+static void
+hash_table_get_keys(gpointer key, gpointer value _U_, gpointer user_data)
+{
+ GList **files = ((GList **)user_data);
+ *files = g_list_append (*files, key);
+}
+#endif
+
+int
+copy_persconffile_profile(const char *toname, const char *fromname, char **pf_filename_return,
+ char **pf_to_dir_path_return, char **pf_from_dir_path_return)
+{
+ gchar *from_dir = g_strdup (get_persconffile_dir(fromname));
+ gchar *to_dir = g_strdup (get_persconffile_dir(toname));
+ gchar *filename, *from_file, *to_file;
+ GList *files, *file;
+
+#if GLIB_CHECK_VERSION(2,14,0)
+ files = g_hash_table_get_keys(profile_files);
+#else
+ files = NULL;
+ g_hash_table_foreach(profile_files, hash_table_get_keys, &files);
+#endif
+
+ file = g_list_first(files);
+ while (file) {
+ filename = (gchar *)file->data;
+ from_file = g_strdup_printf ("%s%s%s", from_dir, G_DIR_SEPARATOR_S, filename);
+ to_file = g_strdup_printf ("%s%s%s", to_dir, G_DIR_SEPARATOR_S, filename);
+
+ if (file_exists(from_file) && !copy_file_binary_mode(from_file, to_file)) {
+ *pf_filename_return = g_strdup(filename);
+ *pf_to_dir_path_return = to_dir;
+ *pf_from_dir_path_return = from_dir;
+ g_free (from_file);
+ g_free (to_file);
+ return -1;
+ }
+
+ g_free (from_file);
+ g_free (to_file);
+
+ file = g_list_next(file);
+ }
+
+ g_list_free (files);
+ g_free (from_dir);
+ g_free (to_dir);
+
+ return 0;
+}
+
+/*
+ * Get the (default) directory in which personal data is stored.
+ *
+ * On Win32, this is the "My Documents" folder in the personal profile,
+ * except that, if we're running from a U3 device, this is the
+ * "$U3_DEVICE_DOCUMENT_PATH\My Captures" folder.
+ * On UNIX this is simply the current directory.
+ */
+/* XXX - should this and the get_home_dir() be merged? */
+extern const 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 (do_store_persconffiles && from_profile && !g_hash_table_lookup (profile_files, filename)) {
+ /* Store filenames so we know which filenames belongs to a configuration profile */
+ g_hash_table_insert (profile_files, g_strdup(filename), g_strdup(filename));
+ }
+
+ 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 (ws_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 (ws_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 *optstr)
+{
+ gchar *p, *colonp;
+
+ colonp = strchr(optstr, ':');
+ 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(optstr,"persconf") == 0) {
+ persconffile_dir = p;
+ } else if (strcmp(optstr,"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);
+}
+
+/* Get the personal plugin dir */
+/* Return value is malloced so the caller should g_free() it. */
+char *
+get_plugins_pers_dir(void)
+{
+ return get_persconffile_path(PLUGINS_DIR_NAME, FALSE, FALSE);
+}
+
+/* Delete a file */
+gboolean
+deletefile(const char *path)
+{
+ return ws_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
+
+ case WTAP_ERR_SHORT_WRITE:
+ errmsg = "A full write couldn't be done to the file \"%s\".";
+ break;
+
+ 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 */
+ ws_stat(fname, &file_stat);
+ if (file_stat.st_ino == 0) {
+ return TRUE;
+ } else {
+ return FALSE;
+ }
+#else
+ if (ws_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 (ws_stat(fname1, &filestat1) == -1)
+ return FALSE; /* can't get info about the first file */
+ if (ws_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
+}
+
+/*
+ * Copy a file in binary mode, for those operating systems that care about
+ * such things. This should be OK for all files, even text files, as
+ * we'll copy the raw bytes, and we don't look at the bytes as we copy
+ * them.
+ *
+ * Returns TRUE on success, FALSE on failure. If a failure, it also
+ * displays a simple dialog window with the error message.
+ */
+gboolean
+copy_file_binary_mode(const char *from_filename, const char *to_filename)
+{
+ int from_fd, to_fd, nread, nwritten, err;
+ guint8 pd[65536];
+
+ /* Copy the raw bytes of the file. */
+ from_fd = ws_open(from_filename, O_RDONLY | O_BINARY, 0000 /* no creation so don't matter */);
+ if (from_fd < 0) {
+ report_open_failure(from_filename, errno, FALSE);
+ goto done;
+ }
+
+ /* Use open() instead of creat() so that we can pass the O_BINARY
+ flag, which is relevant on Win32; it appears that "creat()"
+ may open the file in text mode, not binary mode, but we want
+ to copy the raw bytes of the file, so we need the output file
+ to be open in binary mode. */
+ to_fd = ws_open(to_filename, O_WRONLY | O_CREAT | O_TRUNC | O_BINARY, 0644);
+ if (to_fd < 0) {
+ report_open_failure(to_filename, errno, TRUE);
+ ws_close(from_fd);
+ goto done;
+ }
+
+ while ((nread = ws_read(from_fd, pd, sizeof pd)) > 0) {
+ nwritten = ws_write(to_fd, pd, nread);
+ if (nwritten < nread) {
+ if (nwritten < 0)
+ err = errno;
+ else
+ err = WTAP_ERR_SHORT_WRITE;
+ report_write_failure(to_filename, err);
+ ws_close(from_fd);
+ ws_close(to_fd);
+ goto done;
+ }
+ }
+ if (nread < 0) {
+ err = errno;
+ report_read_failure(from_filename, err);
+ ws_close(from_fd);
+ ws_close(to_fd);
+ goto done;
+ }
+ ws_close(from_fd);
+ if (ws_close(to_fd) < 0) {
+ report_write_failure(to_filename, errno);
+ goto done;
+ }
+
+ return TRUE;
+
+done:
+ return FALSE;
+}
+
+/*
+ * Editor modelines
+ *
+ * Local Variables:
+ * c-basic-offset: 4
+ * tab-width: 4
+ * indent-tabs-mode: t
+ * End:
+ *
+ * ex: set shiftwidth=4 tabstop=4 noexpandtab
+ * :indentSize=4:tabSize=4:noTabs=false:
+ */
git.samba.org / obnox / wireshark / wip.git / blobdiff