X-Git-Url: https://git.gag.com/?a=blobdiff_plain;f=common-src%2Futil.h;h=59d29a0cef6986810b9c73a196af103893a5d947;hb=2627875b7d18858bc1f9f7652811e4d8c15a23eb;hp=4ebe39cab50bf78685ff25f4f5edbf21ca8ba2ad;hpb=12179dea039515c06168c0037d048566a3f623de;p=debian%2Famanda diff --git a/common-src/util.h b/common-src/util.h index 4ebe39c..59d29a0 100644 --- a/common-src/util.h +++ b/common-src/util.h @@ -32,325 +32,26 @@ #include "amanda.h" #include "sl.h" -/* */ -typedef enum { - CONFTYPE_INT, - CONFTYPE_LONG, - CONFTYPE_AM64, - CONFTYPE_REAL, - CONFTYPE_STRING, - CONFTYPE_IDENT, - CONFTYPE_TIME, - CONFTYPE_SIZE, - CONFTYPE_SL, - CONFTYPE_BOOL, - CONFTYPE_COMPRESS, - CONFTYPE_ENCRYPT, - CONFTYPE_HOLDING, - CONFTYPE_ESTIMATE, - CONFTYPE_STRATEGY, - CONFTYPE_TAPERALGO, - CONFTYPE_PRIORITY, - CONFTYPE_RATE, - CONFTYPE_EXINCLUDE, -} conftype_t; - -/* Compression types */ -typedef enum { - COMP_NONE, /* No compression */ - COMP_FAST, /* Fast compression on client */ - COMP_BEST, /* Best compression on client */ - COMP_CUST, /* Custom compression on client */ - COMP_SERV_FAST, /* Fast compression on server */ - COMP_SERV_BEST, /* Best compression on server */ - COMP_SERV_CUST /* Custom compression on server */ -} comp_t; - -/* Encryption types */ -typedef enum { - ENCRYPT_NONE, /* No encryption */ - ENCRYPT_CUST, /* Custom encryption on client */ - ENCRYPT_SERV_CUST, /* Custom encryption on server */ -} encrypt_t; +#include +#include +#include -/* holdingdisk types */ -typedef enum { - HOLD_NEVER, /* Always direct to tape */ - HOLD_AUTO, /* If possible */ - HOLD_REQUIRED /* Always to holding disk */ -} dump_holdingdisk_t; - -/* Dump strategies */ -#define DS_SKIP 0 /* Don't do any dumps at all */ -#define DS_STANDARD 1 /* Standard (0 1 1 1 1 2 2 2 ...) */ -#define DS_NOFULL 2 /* No full's (1 1 1 ...) */ -#define DS_NOINC 3 /* No inc's (0 0 0 ...) */ -#define DS_4 4 /* ? (0 1 2 3 4 5 6 7 8 9 10 11 ...) */ -#define DS_5 5 /* ? (0 1 1 1 1 1 1 1 1 1 1 1 ...) */ -#define DS_HANOI 6 /* Tower of Hanoi (? ? ? ? ? ...) */ -#define DS_INCRONLY 7 /* Forced fulls (0 1 1 2 2 FORCE0 1 1 ...) */ - -/* Estimate strategies */ -#define ES_CLIENT 0 /* client estimate */ -#define ES_SERVER 1 /* server estimate */ -#define ES_CALCSIZE 2 /* calcsize estimate */ - -#define ALGO_FIRST 0 -#define ALGO_FIRSTFIT 1 -#define ALGO_LARGEST 2 -#define ALGO_LARGESTFIT 3 -#define ALGO_SMALLEST 4 -#define ALGO_LAST 5 - -#define BSTRNCMP(a,b) strncmp(a, b, strlen(b)) - -typedef enum { - CONF_UNKNOWN, CONF_ANY, CONF_COMMA, - CONF_LBRACE, CONF_RBRACE, CONF_NL, - CONF_END, CONF_IDENT, CONF_INT, - CONF_LONG, CONF_AM64, CONF_BOOL, - CONF_REAL, CONF_STRING, CONF_TIME, - CONF_SIZE, - - /* config parameters */ - CONF_INCLUDEFILE, CONF_ORG, CONF_MAILTO, - CONF_DUMPUSER, CONF_TAPECYCLE, CONF_TAPEDEV, - CONF_CHNGRDEV, CONF_CHNGRFILE, CONF_LABELSTR, - CONF_BUMPPERCENT, CONF_BUMPSIZE, CONF_BUMPDAYS, - CONF_BUMPMULT, CONF_ETIMEOUT, CONF_DTIMEOUT, - CONF_CTIMEOUT, CONF_TAPEBUFS, CONF_TAPELIST, - CONF_DISKFILE, CONF_INFOFILE, CONF_LOGDIR, - CONF_LOGFILE, CONF_DISKDIR, CONF_DISKSIZE, - CONF_INDEXDIR, CONF_NETUSAGE, CONF_INPARALLEL, - CONF_DUMPORDER, CONF_TIMEOUT, CONF_TPCHANGER, - CONF_RUNTAPES, CONF_DEFINE, CONF_DUMPTYPE, - CONF_TAPETYPE, CONF_INTERFACE, CONF_PRINTER, - CONF_AUTOFLUSH, CONF_RESERVE, CONF_MAXDUMPSIZE, - CONF_COLUMNSPEC, CONF_AMRECOVER_DO_FSF, CONF_AMRECOVER_CHECK_LABEL, - CONF_AMRECOVER_CHANGER, CONF_LABEL_NEW_TAPES, CONF_USETIMESTAMPS, - - CONF_TAPERALGO, CONF_FIRST, CONF_FIRSTFIT, - CONF_LARGEST, CONF_LARGESTFIT, CONF_SMALLEST, - CONF_LAST, CONF_DISPLAYUNIT, - - /* kerberos 5 */ - CONF_KRB5KEYTAB, CONF_KRB5PRINCIPAL, - - /* holding disk */ - CONF_COMMENT, CONF_DIRECTORY, CONF_USE, - CONF_CHUNKSIZE, - - /* dump type */ - /*COMMENT,*/ CONF_PROGRAM, CONF_DUMPCYCLE, - CONF_RUNSPERCYCLE, CONF_MAXCYCLE, CONF_MAXDUMPS, - CONF_OPTIONS, CONF_PRIORITY, CONF_FREQUENCY, - CONF_INDEX, CONF_MAXPROMOTEDAY, CONF_STARTTIME, - CONF_COMPRESS, CONF_ENCRYPT, CONF_AUTH, - CONF_STRATEGY, CONF_ESTIMATE, CONF_SKIP_INCR, - CONF_SKIP_FULL, CONF_RECORD, CONF_HOLDING, - CONF_EXCLUDE, CONF_INCLUDE, CONF_KENCRYPT, - CONF_IGNORE, CONF_COMPRATE, CONF_TAPE_SPLITSIZE, - CONF_SPLIT_DISKBUFFER, CONF_FALLBACK_SPLITSIZE,CONF_SRVCOMPPROG, - CONF_CLNTCOMPPROG, CONF_SRV_ENCRYPT, CONF_CLNT_ENCRYPT, - CONF_SRV_DECRYPT_OPT, CONF_CLNT_DECRYPT_OPT, CONF_AMANDAD_PATH, - CONF_CLIENT_USERNAME, - - /* tape type */ - /*COMMENT,*/ CONF_BLOCKSIZE, CONF_FILE_PAD, - CONF_LBL_TEMPL, CONF_FILEMARK, CONF_LENGTH, - CONF_SPEED, - - /* client conf */ - CONF_CONF, CONF_INDEX_SERVER, CONF_TAPE_SERVER, - CONF_SSH_KEYS, CONF_GNUTAR_LIST_DIR, CONF_AMANDATES, - - /* network interface */ - /* COMMENT, */ /* USE, */ - - /* dump options (obsolete) */ - CONF_EXCLUDE_FILE, CONF_EXCLUDE_LIST, - - /* compress, estimate, encryption */ - CONF_NONE, CONF_FAST, CONF_BEST, - CONF_SERVER, CONF_CLIENT, CONF_CALCSIZE, - CONF_CUSTOM, - - /* holdingdisk */ - CONF_NEVER, CONF_AUTO, CONF_REQUIRED, - - /* priority */ - CONF_LOW, CONF_MEDIUM, CONF_HIGH, - - /* dump strategy */ - CONF_SKIP, CONF_STANDARD, CONF_NOFULL, - CONF_NOINC, CONF_HANOI, CONF_INCRONLY, - - /* exclude list */ - CONF_LIST, CONF_EFILE, CONF_APPEND, - CONF_OPTIONAL, - - /* numbers */ - CONF_AMINFINITY, CONF_MULT1, CONF_MULT7, - CONF_MULT1K, CONF_MULT1M, CONF_MULT1G, - - /* boolean */ - CONF_ATRUE, CONF_AFALSE, - - CONF_RAWTAPEDEV -} tok_t; +#include "glib-util.h" #define BIGINT INT_MAX +#define BSTRNCMP(a,b) strncmp(a, b, strlen(b)) + /* internal types and variables */ -typedef struct { /* token table entry */ - char *keyword; - tok_t token; -} keytab_t; - -keytab_t *keytable; - -typedef struct { - char *name; - char *value; - int used; -} command_option_t; - -typedef struct exinclude_s { - int type; /* 0=list 1=file */ - sl_t *sl; - int optional; -} exinclude_t; - -typedef struct val_s { - union { - int i; - long l; - off_t am64; - double r; - char *s; - sl_t *sl; - ssize_t size; - time_t t; - float rate[2]; - exinclude_t exinclude; - } v; - int seen; - conftype_t type; -} val_t; - -typedef struct s_conf_var { - tok_t token; - conftype_t type; - void (*read_function) (struct s_conf_var *, val_t*); - int parm; - void (*validate) (struct s_conf_var *, val_t *); -} t_conf_var; - -extern int allow_overwrites; -extern int token_pushed; - -extern tok_t tok, pushed_tok; -extern val_t tokenval; - -extern int conf_line_num, got_parserror; -extern FILE *conf_conf; -extern char *conf_confname; -extern char *conf_line; -extern char *conf_char; - -/* predeclare local functions */ - -t_conf_var *get_np(t_conf_var *get_var, int parm); -void get_simple(val_t *var, tok_t type); -int get_int(void); -long get_long(void); -time_t get_time(void); -ssize_t get_size(void); -off_t get_am64_t(void); -int get_bool(void); -void ckseen(int *seen); -void conf_parserror(const char *format, ...) - __attribute__ ((format (printf, 1, 2))); -tok_t lookup_keyword(char *str); -void unget_conftoken(void); -void get_conftoken(tok_t exp); - -void read_string(t_conf_var *, val_t *); -void read_ident(t_conf_var *, val_t *); -void read_int(t_conf_var *, val_t *); -void read_long(t_conf_var *, val_t *); -void read_size(t_conf_var *, val_t *); -void read_am64(t_conf_var *, val_t *); -void read_bool(t_conf_var *, val_t *); -void read_real(t_conf_var *, val_t *); -void read_time(t_conf_var *, val_t *); -void copy_val_t(val_t *, val_t *); -void free_val_t(val_t *); -char *conf_print(val_t *); -void conf_init_string(val_t *, char *); -void conf_init_ident(val_t *, char *); -void conf_init_int(val_t *, int); -void conf_init_bool(val_t *, int); -void conf_init_strategy(val_t *, int); -void conf_init_estimate(val_t *, int); -void conf_init_taperalgo(val_t *, int); -void conf_init_priority(val_t *, int); -void conf_init_strategy(val_t *, int); -void conf_init_compress(val_t *, comp_t); -void conf_init_encrypt(val_t *, encrypt_t); -void conf_init_holding(val_t *, dump_holdingdisk_t); -void conf_init_long(val_t *, long); -void conf_init_size(val_t *, ssize_t); -void conf_init_am64(val_t *, off_t); -void conf_init_real(val_t *, double); -void conf_init_rate(val_t *, double, double); -void conf_init_time(val_t *, time_t); -void conf_init_sl(val_t *, sl_t *); -void conf_init_exinclude(val_t *); -void conf_set_string(val_t *, char *); -void conf_set_int(val_t *, int); -void conf_set_bool(val_t *, int); -void conf_set_compress(val_t *, comp_t); -void conf_set_encrypt(val_t *, encrypt_t); -void conf_set_holding(val_t *, dump_holdingdisk_t); -void conf_set_strategy(val_t *, int); -int get_conftype_int (val_t *); -long get_conftype_long (val_t *); -off_t get_conftype_am64 (val_t *); -double get_conftype_real (val_t *); -char *get_conftype_string (val_t *); -char *get_conftype_ident (val_t *); -time_t get_conftype_time (val_t *); -ssize_t get_conftype_size (val_t *); -sl_t *get_conftype_sl (val_t *); -int get_conftype_bool (val_t *); -int get_conftype_hold (val_t *); -int get_conftype_compress (val_t *); -int get_conftype_encrypt (val_t *); -int get_conftype_estimate (val_t *); -int get_conftype_strategy (val_t *); -int get_conftype_taperalgo(val_t *); -int get_conftype_priority (val_t *); -float *get_conftype_rate (val_t *); -exinclude_t get_conftype_exinclude(val_t *); - -void read_block(command_option_t *command_options, t_conf_var *read_var, - keytab_t *keytab, val_t *valarray, char *prefix, char *errormsg, - int read_brace, void (*copy_function)(void)); -void command_overwrite(command_option_t *command_options, t_conf_var *overwrite_var, - keytab_t *keytab, val_t *valarray, char *prefix); - - - -ssize_t fullread(int, void *, size_t); -ssize_t fullwrite(int, const void *, size_t); - -int connect_portrange(struct sockaddr_in *, in_port_t, in_port_t, char *, - struct sockaddr_in *, int); -int bind_portrange(int, struct sockaddr_in *, in_port_t, in_port_t, + +int connect_portrange(sockaddr_union *, in_port_t, in_port_t, char *, + sockaddr_union *, int); +int bind_portrange(int, sockaddr_union *, in_port_t, in_port_t, char *); +ssize_t full_writev(int, struct iovec *, int); + char * construct_datestamp(time_t *t); char * construct_timestamp(time_t *t); @@ -358,10 +59,27 @@ char * construct_timestamp(time_t *t); /*@only@*//*@null@*/char *unquote_string(const char *str); int needs_quotes(const char * str); +/* Split a string into space-delimited words, obeying quoting as created by + * quote_string. To keep compatibility with the old split(), this has the + * characteristic that multiple consecutive spaces are not collapsed into + * a single space: "x y" parses as [ "x", "", "y", NULL ]. The strings are + * unquoted before they are returned, unlike split(). An empty string is + * split into [ "", NULL ]. + * + * Returns a NULL-terminated array of strings, which should be freed with + * g_strfreev. + */ +gchar ** split_quoted_strings(const gchar *string); + +/* Like strtok_r, but consider a quoted string to be a single token. Caller + * must begin parsing with strtok_r first, then pass the saveptr to this function. + * + * Returns NULL on unparseable strings (e.g., unterminated quotes, bad escapes) + */ +char * strquotedstr(char **saveptr); + char * sanitize_string(const char *str); -char * strquotedstr(void); -ssize_t hexdump(const char *buffer, size_t bytes); -void dump_sockaddr(struct sockaddr_in * sa); +int copy_file(char *dst, char *src, char **errmsg); /* * validate_email return 0 if the following characters are present @@ -370,7 +88,243 @@ void dump_sockaddr(struct sockaddr_in * sa); */ 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); + +/* 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 { + /* doesn't matter */ + RUNNING_AS_ANY, + + /* 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 + */ + +/* The 'context' of a process gives a general description of how it is + * used. This affects log output, among other things. + */ +typedef enum { + /* default context (logging to stderr, etc. -- not pretty) */ + CONTEXT_DEFAULT = 0, + + /* user-interfacing command-line utility like amadmin */ + CONTEXT_CMDLINE, + + /* daemon like amandad or sendbackup */ + CONTEXT_DAEMON, + + /* a utility used from shell scripts, and thus probably invoked + * quite often */ + CONTEXT_SCRIPTUTIL, +} pcontext_t; + +/* 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); + +/* Set the type of the process. The parameter is copied, and remains + * the responsibility of the caller on return. This value dictates the + * directory in which debug logs are stored. + * + * @param pname: the new process type + */ +void set_ptype(char *ptype); + +/* 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_ptype(void); + +/* Set the process's context + * + * @param context: the new context + */ +void set_pcontext(pcontext_t context); + +/* Get the process's context + * + * @returns: the context + */ +pcontext_t get_pcontext(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 +# ifdef HAVE_READLINE_HISTORY_H +# include +# endif +# else +# ifdef HAVE_READLINE_H +# include +# ifdef HAVE_HISTORY_H +# include +# endif +# endif +# endif +#else + +char * readline(const char *prompt); +void add_history(const char *line); + +#endif + +char *base64_decode_alloc_string(char *); + +/* A GHFunc (callback for g_hash_table_foreach), + * Count the number of properties. + * + * @param key_p: (char *) property name. + * @param value_p: (GSList *) property values list. + * @param user_data_p: (int *) count are added to that value. + */ +void count_proplist(gpointer key_p, + gpointer value_p, + gpointer user_data_p); + +/* A GHFunc (callback for g_hash_table_foreach), + * Store a property and it's value in an ARGV. + * + * @param key_p: (char *) property name. + * @param value_p: (GSList *) property values list. + * @param user_data_p: (char ***) pointer to ARGV. + */ +void proplist_add_to_argv(gpointer key_p, + gpointer value_p, + gpointer user_data_p); + #endif /* UTIL_H */