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