git.gag.com Git - debian/amanda/blob - common-src/fileheader.h

   1 /*
   2  * Amanda, The Advanced Maryland Automatic Network Disk Archiver
   3  * Copyright (c) 1991-1999 University of Maryland at College Park
   4  * Copyright (c) 2007-2012 Zmanda, Inc.  All Rights Reserved.
   5  * All Rights Reserved.
   6  *
   7  * Permission to use, copy, modify, distribute, and sell this software and its
   8  * documentation for any purpose is hereby granted without fee, provided that
   9  * the above copyright notice appear in all copies and that both that
  10  * copyright notice and this permission notice appear in supporting
  11  * documentation, and that the name of U.M. not be used in advertising or
  12  * publicity pertaining to distribution of the software without specific,
  13  * written prior permission.  U.M. makes no representations about the
  14  * suitability of this software for any purpose.  It is provided "as is"
  15  * without express or implied warranty.
  16  *
  17  * U.M. DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL U.M.
  19  * BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  20  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
  21  * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
  22  * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  23  *
  24  * Authors: the Amanda Development Team.  Its members are listed in a
  25  * file named AUTHORS, in the root directory of this distribution.
  26  */
  27 /*
  28  * $Id: fileheader.h,v 1.16 2006/05/25 01:47:12 johnfranks Exp $
  29  *
  30  */
  31
  32 #ifndef FILEHEADER_H
  33 #define FILEHEADER_H
  34
  35 #include <glib.h>
  36 #include <stdio.h>
  37
  38 #define STRMAX          256
  39
  40 typedef char string_t[STRMAX];
  41 typedef enum {
  42     F_UNKNOWN = 0, F_WEIRD = -1, F_TAPESTART = 1, F_TAPEEND = 2,
  43     F_DUMPFILE = 3, F_CONT_DUMPFILE = 4, F_SPLIT_DUMPFILE = 5, F_NOOP = 6,
  44     F_EMPTY = -2
  45 } filetype_t;
  46
  47 typedef struct file_s {
  48     filetype_t type;
  49     string_t datestamp;
  50     int dumplevel;
  51     int compressed;
  52     int encrypted;
  53     string_t comp_suffix;
  54     string_t encrypt_suffix;
  55     string_t name;      /* hostname or label */
  56     string_t disk;
  57     string_t program;
  58     string_t application;
  59     string_t srvcompprog;
  60     string_t clntcompprog;
  61     string_t srv_encrypt;
  62     string_t clnt_encrypt;
  63     string_t recover_cmd;
  64     string_t uncompress_cmd;
  65     string_t decrypt_cmd;
  66     string_t srv_decrypt_opt;
  67     string_t clnt_decrypt_opt;
  68     string_t cont_filename;
  69     char     *dle_str;
  70     int is_partial;
  71     int partnum;
  72     int totalparts; /* -1 == UNKNOWN */
  73     size_t blocksize;
  74     off_t  orig_size;
  75 } dumpfile_t;
  76
  77 /* local functions */
  78
  79 /* Makes a serialized header from the dumpfile_t representation. The
  80  * return value is allocated using malloc(), so you must free it.
  81  *
  82  * Build_header returns NULL if the resulting header would be larger
  83  * than max_size bytes.  If size is not NULL, then the resulting header
  84  * will be *at least* this many bytes.  If size is NULL, then the
  85  * header will be exactly max_size bytes.  Zero bytes are used to pad the
  86  * header to the required length.
  87  *
  88  * If size is not NULL, *size is set to the actual size of the generated header.
  89  */
  90 char *  build_header        (const dumpfile_t *file, size_t *size, size_t max_size);
  91
  92 void    fh_init(dumpfile_t *file);
  93 void    parse_file_header(const char *buffer, dumpfile_t *file, size_t buflen);
  94 void    print_header(FILE *outf, const dumpfile_t *file);
  95 char   *summarize_header(const dumpfile_t *file);
  96 int     known_compress_type(const dumpfile_t *file);
  97 void    dump_dumpfile_t(const dumpfile_t *file);
  98
  99 /* Returns TRUE if the two headers are equal, FALSE otherwise. */
 100 gboolean headers_are_equal(dumpfile_t * a, dumpfile_t * b);
 101
 102 /* Returns an allocated duplicate header. */
 103 dumpfile_t * dumpfile_copy(dumpfile_t* from);
 104 void dumpfile_copy_in_place(dumpfile_t *dest, dumpfile_t* source);
 105
 106 /* Frees associated storage */
 107 void dumpfile_free_data(dumpfile_t* info);
 108
 109 /* Frees the header and associated storage */
 110 void dumpfile_free(dumpfile_t* info);
 111
 112 #endif /* !FILEHEADER_H */