diff options
author | Guy Harris <guy@alum.mit.edu> | 2013-11-17 02:55:14 +0000 |
---|---|---|
committer | Guy Harris <guy@alum.mit.edu> | 2013-11-17 02:55:14 +0000 |
commit | db25270df8bb4e4800e4d2c8a9f930b7a9fbc8df (patch) | |
tree | 93833061315be739594ff3614850eb4ca63266ec /wsutil/filesystem.h | |
parent | dd1034e1f5f2285721a9deb8b95ea17222e50939 (diff) |
Move the epan/filesystem.c routines to wsutil; they're not specific to
packet dissection, they're specific to the entire Wireshark suite of
programs.
svn path=/trunk/; revision=53377
Diffstat (limited to 'wsutil/filesystem.h')
-rw-r--r-- | wsutil/filesystem.h | 306 |
1 files changed, 306 insertions, 0 deletions
diff --git a/wsutil/filesystem.h b/wsutil/filesystem.h new file mode 100644 index 0000000000..6b76bab4fc --- /dev/null +++ b/wsutil/filesystem.h @@ -0,0 +1,306 @@ +/* filesystem.h + * Filesystem utility definitions + * + * $Id$ + * + * 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + */ + +#ifndef FILESYSTEM_H +#define FILESYSTEM_H + +#include "ws_symbol_export.h" + +#ifdef __cplusplus +extern "C" { +#endif /* __cplusplus */ + +/* + * Default profile name. + */ +#define DEFAULT_PROFILE "Default" + + +/* + * 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. + */ +WS_DLL_PUBLIC char *init_progfile_dir(const char *arg0, int (*main)(int, char **)); + +/* + * Get the directory in which the program resides. + */ +WS_DLL_PUBLIC const char *get_progfile_dir(void); + +/* + * Get the directory in which plugins are stored; this must not be called + * before init_progfile_dir() is called, as they might be stored in a + * subdirectory of the program file directory. + */ +WS_DLL_PUBLIC const char *get_plugin_dir(void); + +/* + * Get the directory in which python plugins are stored; this must not be + * called before init_progfile_dir() is called, as they might be stored in a + * subdirectory of the program file directory. + */ +WS_DLL_PUBLIC const char *get_wspython_dir(void); + +/* + * Get the flag indicating whether we're running from a build + * directory. + */ +WS_DLL_PUBLIC gboolean running_in_build_directory(void); + +/* + * Get the directory in which global configuration files are + * stored. + */ +WS_DLL_PUBLIC const char *get_datafile_dir(void); + +/* + * 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. + */ +WS_DLL_PUBLIC char *get_datafile_path(const char *filename); + +/* + * Get the personal plugin dir. + */ +WS_DLL_PUBLIC char *get_plugins_pers_dir(void); + +/* + * 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 Wireshark + * global configuration and data file directory. + */ +WS_DLL_PUBLIC const char *get_systemfile_dir(void); + +/* + * Set the configuration profile name to be used for storing + * personal configuration files. + */ +WS_DLL_PUBLIC void set_profile_name(const gchar *profilename); + +/* + * Get the current configuration profile name used for storing + * personal configuration files. + */ +WS_DLL_PUBLIC const char *get_profile_name(void); + +/* + * Check if current profile is default profile. + */ +WS_DLL_PUBLIC gboolean is_default_profile(void); + +/* + * Check if we have global profiles. + */ +WS_DLL_PUBLIC gboolean has_global_profiles(void); + +/* + * Get the directory used to store configuration profile directories. + */ +WS_DLL_PUBLIC const char *get_profiles_dir(void); + +/* + * Get the directory used to store global configuration profile directories. + */ +WS_DLL_PUBLIC const char *get_global_profiles_dir(void); + + +/* + * Store filenames used for personal config files so we know which + * files to copy when duplicate a configuration profile. + */ +WS_DLL_PUBLIC void profile_store_persconffiles(gboolean store); + +/* + * Check if given configuration profile exists. + */ +WS_DLL_PUBLIC gboolean profile_exists(const gchar *profilename, gboolean global); + +/* + * Create a directory for the given configuration profile. + * 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. + */ +WS_DLL_PUBLIC int create_persconffile_profile(const char *profilename, + char **pf_dir_path_return); + +/* + * Delete the directory for the given configuration profile. + * If we attempted to delete it, and failed, return -1 and + * set "*pf_dir_path_return" to the pathname of the directory we failed + * to delete (it's g_mallocated, so our caller should free it); otherwise, + * return 0. + */ +WS_DLL_PUBLIC int delete_persconffile_profile(const char *profilename, + char **pf_dir_path_return); + +/* + * Rename the directory for the given confinguration profile. + */ +WS_DLL_PUBLIC int rename_persconffile_profile(const char *fromname, const char *toname, + char **pf_from_dir_path_return, + char **pf_to_dir_path_return); + +/* + * Copy files in one profile to the other. + */ +WS_DLL_PUBLIC int copy_persconffile_profile(const char *toname, const char *fromname, + gboolean from_global, + char **pf_filename_return, + char **pf_to_dir_path_return, + char **pf_from_dir_path_return); + +/* + * 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. + */ +WS_DLL_PUBLIC int create_persconffile_dir(char **pf_dir_path_return); + +/* + * Construct the path name of a personal configuration file, given the + * file name. If using configuration profiles this directory will be + * used if "from_profile" is TRUE. + * + * The returned file name was g_malloc()'d so it must be g_free()d when the + * caller is done with it. + */ +WS_DLL_PUBLIC char *get_persconffile_path(const char *filename, gboolean from_profile); + +/* + * 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. + */ +WS_DLL_PUBLIC const char *get_persdatafile_dir(void); + +/* + * Construct the path name of a file in $TMP/%TEMP% directory. + * Or "/tmp/<filename>" (C:\<filename>) if that fails. + * + * Return value is g_malloced so the caller should g_free it. + */ +WS_DLL_PUBLIC char *get_tempfile_path(const char *filename); + +/* + * process command line option belonging to the filesystem settings + */ +WS_DLL_PUBLIC int filesystem_opt(int opt, const char *optstr); + +/* + * Return an error message for UNIX-style errno indications on open or + * create operations. + */ +WS_DLL_PUBLIC const char *file_open_error_message(int err, gboolean for_writing); + +/* + * Return an error message for UNIX-style errno indications on write + * operations. + */ +WS_DLL_PUBLIC const char *file_write_error_message(int err); + +/* + * Given a pathname, return the last component. + */ +WS_DLL_PUBLIC const char *get_basename(const char *); + + /* + * Given a pathname, return a pointer to the last pathname separator + * character in the pathname, or NULL if the pathname contains no + * separators. + */ +WS_DLL_PUBLIC char *find_last_pathname_separator(const char *path); + +/* + * Given a pathname, return a string containing everything but the + * last component. NOTE: this overwrites the pathname handed into + * it.... + */ +WS_DLL_PUBLIC char *get_dirname(char *); + +/* + * 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. + */ +WS_DLL_PUBLIC int test_for_directory(const char *); + +/* + * Given a pathname, return: + * + * the errno, if an attempt to "stat()" the file fails; + * + * ESPIPE, if the attempt succeeded and the file turned out + * to be a FIFO; + * + * 0, if the attempt succeeded and the file turned out not + * to be a FIFO. + */ +WS_DLL_PUBLIC int test_for_fifo(const char *); + +/* Delete a file */ +WS_DLL_PUBLIC gboolean deletefile (const char *path); + +/* + * Check, if file is existing. + */ +WS_DLL_PUBLIC gboolean file_exists(const char *fname); + +/* + * Check if two filenames are identical (with absolute and relative paths). + */ +WS_DLL_PUBLIC gboolean files_identical(const char *fname1, const char *fname2); + +/* + * 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. + */ +WS_DLL_PUBLIC gboolean copy_file_binary_mode(const char *from_filename, + const char *to_filename); + +#ifdef __cplusplus +} +#endif /* __cplusplus */ + +#endif /* FILESYSTEM_H */ |