#include "amanda.h"
#include "sl.h"
+#include <glib.h>
+#include <glib-object.h>
+#include <regex.h>
+
+#include "glib-util.h"
+
#define BIGINT INT_MAX
#define BSTRNCMP(a,b) strncmp(a, b, strlen(b))
int needs_quotes(const char * str);
char * sanitize_string(const char *str);
-char * strquotedstr(void);
-ssize_t hexdump(const char *buffer, size_t bytes);
-void dump_sockaddr(struct sockaddr_storage * sa);
-char * str_sockaddr(struct sockaddr_storage *sa);
-/* Compare two sockaddr_storage objects, optionally comparing
- * only the address (and thus ignoring port, flow info, etc.).
- * @returns: -1, 0, or 1 for <, ==, >, respectively
- */
-int cmp_sockaddr(struct sockaddr_storage *ss1,
- struct sockaddr_storage *ss2,
- int addr_only);
int copy_file(char *dst, char *src, char **errmsg);
/*
*/
int validate_mailto(const char *mailto);
-char *taperalgo2str(int taperalgo);
+/* This function is a portable reimplementation of readdir(). It
+ * returns a newly-allocated string, that should be freed with
+ * free(). Returns NULL on error or end of directory.
+ * It is reentrant, with the following exceptions:
+ * - This function cannot be run at the same time as readdir() or
+ * readdir64().
+ * - This function cannot be run simultaneously on the same directory
+ * handle. */
+char * portable_readdir(DIR*);
+
+typedef gboolean (*SearchDirectoryFunctor)(const char * filename,
+ gpointer user_data);
+/* This function will search the given directory handle for files
+ matching the given POSIX extended regular expression.
+ For each matching file, the functor will be called with the given
+ user data. Stops when the functor returns FALSE, or all files have
+ been searched. Returns the number of matching files. */
+int search_directory(DIR * handle, const char * regex,
+ SearchDirectoryFunctor functor, gpointer user_data);
+
+/* This function extracts a substring match from a regular expression
+ match result, and copies it into a newly allocated string. Example
+ usage to get the first matched substring:
+ substring = find_regmatch(whole_string, pmatch[1])
+ Note that pmatch[0] yields the entire matching portion of the string. */
+char* find_regex_substring(const char* base_string, const regmatch_t match);
+
+void free_new_argv(int new_argc, char **new_argv);
+
+/* Like strcmp(a, b), except that NULL strings are sorted before non-NULL
+ * strings, instead of segfaulting. */
+int compare_possibly_null_strings(const char * a, const char * b);
+
+/* Does g_thread_init(), along with anything else that should be done
+ * before/after thread setup. It's OK to call this function more than once.
+ * Returns TRUE if threads are supported. */
+gboolean amanda_thread_init(void);
+
+/* Given a hostname, call getaddrinfo to resolve it. Optionally get the
+ * entire set of results (if res is not NULL) and the canonical name of
+ * the host (if canonname is not NULL). The canonical name might
+ * expand e.g., www.domain.com to server3.webfarm.hosting.com.
+ *
+ * If not NULL, the caller is responsible for freeing res with freeaddrinfo().
+ * Similarly, the caller is responsible for freeing canonname if it is
+ * not NULL.
+ *
+ * @param hostname: the hostname to start with
+ * @param res: (result) if not NULL, the results from getaddrinfo()
+ * @param canonname: (result) if not NULL, the canonical name of the host
+ * @returns: newly allocated canonical hostname, or NULL if no
+ * canonical hostname was available.
+ */
+int resolve_hostname(const char *hostname, int socktype,
+ struct addrinfo **res, char **canonname);
+
+/* Interpret a status (as returned from wait() and friends)
+ * into a human-readable sentence.
+ *
+ * Caller is responsible for freeing the resulting string.
+ * The resulting string has already been translated.
+ *
+ * The macro definition allows this to work even when amwait_t
+ * is 'union wait' (4.3BSD). The cast is safe because the two
+ * argument types are interchangeable.
+ *
+ * @param subject: subject of the sentence (program name, etc.)
+ * @param status: the exit status
+ * @returns: newly allocated string describing status
+ */
+#define str_exit_status(subject, status) \
+ _str_exit_status((subject), *(amwait_t *)&(status))
+char *_str_exit_status(char *subject, amwait_t status);
+
+/*
+ * Userid manipulation
+ */
+
+/* Check that the current uid and euid are set to a specific user,
+ * calling error() if not. Does nothing if CHECK_USERID is not
+ * defined.
+ *
+ * @param who: one of the RUNNING_AS_* constants, below.
+ */
+typedef enum {
+ /* userid is 0 */
+ RUNNING_AS_ROOT,
+
+ /* userid belongs to dumpuser (from config) */
+ RUNNING_AS_DUMPUSER,
+
+ /* prefer that userid belongs to dumpuser, but accept when userid belongs to
+ * CLIENT_LOGIN with a debug-log message (needed because amandad always runs
+ * as CLIENT_LOGIN, even on server) */
+ RUNNING_AS_DUMPUSER_PREFERRED,
+
+ /* userid belongs to CLIENT_LOGIN (from --with-user) */
+ RUNNING_AS_CLIENT_LOGIN,
+
+ RUNNING_AS_USER_MASK = (1 << 8) - 1,
+ /* '&' this on to only check the uid, not the euid; use this for programs
+ * that will call become_root() */
+ RUNNING_AS_UID_ONLY = 1 << 8
+} running_as_flags;
+
+void check_running_as(running_as_flags who);
+
+/* Drop and regain root priviledges; used from setuid-root binaries which only
+ * need to be root for certain operations. Does nothing if SINGLE_USERID is
+ * defined.
+ *
+ * @param need_root: if true, try to assume root priviledges; otherwise, drop
+ * priviledges.
+ * @returns: true if the priviledge change succeeded
+ */
+int set_root_privs(int need_root);
+
+/* Become root completely, by setting the uid to 0. This is used by setuid-root
+ * apps which will exec subprocesses which will also need root priviledges. Does
+ * nothing if SINGLE_USERID is defined.
+ *
+ * @returns: true if the priviledge change succeeded
+ */
+int become_root(void);
+
+/*
+ * Process parameters
+ */
+
+/* Set the name of the process. The parameter is copied, and remains
+ * the responsibility of the caller on return. This value is used in log
+ * messages and other output throughout Amanda.
+ *
+ * @param pname: the new process name
+ */
+void set_pname(char *pname);
+
+/* Get the current process name; the result is in a static buffer, and
+ * should *not* be free()d by the caller.
+ *
+ * @returns: process name
+ */
+char *get_pname(void);
+
+/*
+ * Readline support
+ *
+ * This either includes the system readline header we found in configure,
+ * or prototypes some simple stub functions that are used instead.
+ */
+
+#ifdef HAVE_READLINE
+# ifdef HAVE_READLINE_READLINE_H
+# include <readline/readline.h>
+# ifdef HAVE_READLINE_HISTORY_H
+# include <readline/history.h>
+# endif
+# else
+# ifdef HAVE_READLINE_H
+# include <readline.h>
+# ifdef HAVE_HISTORY_H
+# include <history.h>
+# endif
+# endif
+# endif
+#else
+
+char * readline(const char *prompt);
+void add_history(const char *line);
+
+#endif
#endif /* UTIL_H */
projects / debian / amanda / blobdiff