diff options
Diffstat (limited to 'wsutil/filesystem.h')
-rw-r--r-- | wsutil/filesystem.h | 426 |
1 files changed, 426 insertions, 0 deletions
diff --git a/wsutil/filesystem.h b/wsutil/filesystem.h new file mode 100644 index 00000000..fd3e3ebc --- /dev/null +++ b/wsutil/filesystem.h @@ -0,0 +1,426 @@ +/** @file + * Filesystem utility definitions + * + * Wireshark - Network traffic analyzer + * By Gerald Combs <gerald@wireshark.org> + * Copyright 1998 Gerald Combs + * + * SPDX-License-Identifier: GPL-2.0-or-later + */ + +#ifndef FILESYSTEM_H +#define FILESYSTEM_H + +#include <wireshark.h> + +#ifdef __cplusplus +extern "C" { +#endif /* __cplusplus */ + +/* + * Default profile name. + */ +#define DEFAULT_PROFILE "Default" + +/** + * Initialize our configuration environment. + * + * Get the pathname of the directory from which the executable came, + * and save it for future use. + * + * Set our configuration namespace, which determines the top-level + * configuration directory name and environment variable prefixes. + * Default is "Wireshark". + * + * @param arg0 Executable name hint. Should be argv[0]. + * @param namespace_name The namespace to use. "Wireshark" or NULL uses + * the Wireshark namespace. "Logray" uses the Logray namespace. + * @return NULL on success, and a g_mallocated string containing an error on failure. + */ +WS_DLL_PUBLIC char *configuration_init(const char *arg0, const char *namespace_name); + +/** + * Get the configuration namespace name. + * @return The namespace name. One of "Wireshark" or "Logray". + */ +WS_DLL_PUBLIC const char *get_configuration_namespace(void); + +/** + * Check to see if the configuration namespace is for packet analysis + * (Wireshark) or log analysis (Logray). + * @return true if the configuration namespace is for packets. + */ +WS_DLL_PUBLIC bool is_packet_configuration_namespace(void); + +/* + * Get the directory in which the main (Wireshark, TShark, Logray, etc) + * program resides. + * Extcaps should use get_extcap_dir() to get their path. + * + * @return The main program file directory. + */ +WS_DLL_PUBLIC const char *get_progfile_dir(void); + +/* + * Construct the path name of a non-extcap Wireshark executable file, + * given the program name. The executable name doesn't include ".exe"; + * append it on Windows, so that callers don't have to worry about that. + * + * This presumes that all non-extcap executables are in the same directory. + * + * 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_executable_path(const char *filename); + +/* + * Get the directory in which plugins are stored; this must not be called + * before configuration_init() is called, as they might be stored in a + * subdirectory of the program file directory. + */ +WS_DLL_PUBLIC const char *get_plugins_dir(void); + +/* + * Append VERSION_MAJOR.VERSION_MINOR to the plugin dir. + */ +WS_DLL_PUBLIC const char *get_plugins_dir_with_version(void); + +/* + * Get the personal plugin dir. + */ +WS_DLL_PUBLIC const char *get_plugins_pers_dir(void); + +/* + * Append VERSION_MAJOR.VERSION_MINOR to the plugin personal dir. + */ +WS_DLL_PUBLIC const char *get_plugins_pers_dir_with_version(void); + +/* + * Get the directory in which extcap hooks are stored; this must not be called + * before configuration_init() is called, as they might be stored in a + * subdirectory of the program file directory. + */ +WS_DLL_PUBLIC const char *get_extcap_dir(void); + +/* + * Get the personal extcap dir. + */ +WS_DLL_PUBLIC const char *get_extcap_pers_dir(void); + +/* + * Get the flag indicating whether we're running from a build + * directory. + */ +WS_DLL_PUBLIC bool 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 directory in which global documentation files are + * stored. + */ +WS_DLL_PUBLIC const char *get_doc_dir(void); + +/* + * Construct the path name of a global documentation 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_docfile_path(const char *filename); + +/* + * Construct the path URL of a global documentation 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 *doc_file_url(const char *filename); + +/* + * 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 char *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 bool is_default_profile(void); + +/* + * Check if we have global profiles. + */ +WS_DLL_PUBLIC bool has_global_profiles(void); + +/* + * Get the directory used to store configuration profile directories. + * Caller must free the returned string + */ +WS_DLL_PUBLIC char *get_profiles_dir(void); + +/* + * Get the directory used to store configuration files for a given profile. + * Caller must free the returned string. + */ +WS_DLL_PUBLIC char *get_profile_dir(const char *profilename, bool is_global); + +/* + * Create the directory used to store configuration profile directories. + */ +WS_DLL_PUBLIC int create_profiles_dir(char **pf_dir_path_return); + +/* + * Get the directory used to store global configuration profile directories. + * Caller must free the returned string + */ +WS_DLL_PUBLIC 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(bool store); + +/* + * Register a filename to the personal config files storage. + * This is for files which are not read using get_persconffile_path() during startup. + */ +WS_DLL_PUBLIC void profile_register_persconffile(const char *filename); + +/* + * Check if given configuration profile exists. + */ +WS_DLL_PUBLIC bool profile_exists(const char *profilename, bool 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); + +/* + * Returns the list of known profile config filenames + */ +WS_DLL_PUBLIC const GHashTable * allowed_profile_filenames(void); + +/* + * 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, + bool 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, bool from_profile); + +/* + * Set the path of the personal configuration file directory. + */ +WS_DLL_PUBLIC void set_persconffile_dir(const char *p); + +/* + * 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); + +/* + * Set the path of the directory in which personal data is stored. + */ +WS_DLL_PUBLIC void set_persdatafile_dir(const char *p); + +/* + * 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, bool 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 *); + +/* + * Check, if file is existing. + */ +WS_DLL_PUBLIC bool file_exists(const char *fname); + +/* + * Check if file is existing and has text entries which does not start + * with the comment character. + */ +WS_DLL_PUBLIC bool config_file_exists_with_entries(const char *fname, char comment_char); + +/* + * Check if two filenames are identical (with absolute and relative paths). + */ +WS_DLL_PUBLIC bool files_identical(const char *fname1, const char *fname2); + +/* + * Check if file has been recreated since it was opened. + */ +WS_DLL_PUBLIC bool file_needs_reopen(int fd, const char* filename); + +/* + * Write content to 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 write 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 bool write_file_binary_mode(const char *filename, + const void *content, size_t content_len); + +/* + * 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 bool copy_file_binary_mode(const char *from_filename, + const char *to_filename); + + +/* + * Given a filename return a filesystem URL. Relative paths are prefixed with + * the datafile directory path. + * + * @param filename A file name or path. Relative paths will be prefixed with + * the data file directory path. + * @return A filesystem URL for the file or NULL on failure. A non-NULL return + * value must be freed with g_free(). + */ +WS_DLL_PUBLIC char* data_file_url(const char *filename); + +/* + * Free the internal structtures + */ +WS_DLL_PUBLIC void free_progdirs(void); + +#ifdef __cplusplus +} +#endif /* __cplusplus */ + +#endif /* FILESYSTEM_H */ |