git.sur5r.net Git - bacula/bacula/blob - bacula/src/lib/parse_conf.h

   1 /*
   2    Bacula® - The Network Backup Solution
   3
   4    Copyright (C) 2000-2008 Free Software Foundation Europe e.V.
   5
   6    The main author of Bacula is Kern Sibbald, with contributions from
   7    many others, a complete list can be found in the file AUTHORS.
   8    This program is Free Software; you can redistribute it and/or
   9    modify it under the terms of version two of the GNU General Public
  10    License as published by the Free Software Foundation and included
  11    in the file LICENSE.
  12
  13    This program is distributed in the hope that it will be useful, but
  14    WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  16    General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program; if not, write to the Free Software
  20    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  21    02110-1301, USA.
  22
  23    Bacula® is a registered trademark of John Walker.
  24    The licensor of Bacula is the Free Software Foundation Europe
  25    (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
  26    Switzerland, email:ftf@fsfeurope.org.
  27 */
  28 /*
  29  *
  30  *     Kern Sibbald, January MM
  31  *
  32  *   Version $Id$
  33  *
  34  */
  35
  36 struct RES_ITEM;                    /* Declare forward referenced structure */
  37 class RES;                         /* Declare forware referenced structure */
  38 typedef void (MSG_RES_HANDLER)(LEX *lc, RES_ITEM *item, int index, int pass);
  39
  40
  41 /* This is the structure that defines
  42  * the record types (items) permitted within each
  43  * resource. It is used to define the configuration
  44  * tables.
  45  */
  46 struct RES_ITEM {
  47    const char *name;                  /* Resource name i.e. Director, ... */
  48    MSG_RES_HANDLER *handler;          /* Routine storing the resource item */
  49    union {
  50       char **value;                   /* Where to store the item */
  51       char **charvalue;
  52       uint32_t ui32value;
  53       int32_t i32value;
  54       uint64_t ui64value;
  55       int64_t i64value;
  56       bool boolvalue;
  57       utime_t utimevalue;
  58       RES *resvalue;
  59       RES **presvalue;
  60    };
  61    int  code;                         /* item code/additional info */
  62    int  flags;                        /* flags: default, required, ... */
  63    int  default_value;                /* default value */
  64 };
  65
  66 /* For storing name_addr items in res_items table */
  67 #define ITEM(x) {(char **)&res_all.x}
  68
  69 #define MAX_RES_ITEMS 80              /* maximum resource items per RES */
  70
  71 /* This is the universal header that is
  72  * at the beginning of every resource
  73  * record.
  74  */
  75 class RES {
  76 public:
  77    RES *next;                         /* pointer to next resource of this type */
  78    char *name;                        /* resource name */
  79    char *desc;                        /* resource description */
  80    int   rcode;                       /* resource id or type */
  81    int   refcnt;                      /* reference count for releasing */
  82    char  item_present[MAX_RES_ITEMS]; /* set if item is present in conf file */
  83 };
  84
  85
  86 /*
  87  * Master Resource configuration structure definition
  88  * This is the structure that defines the
  89  * resources that are available to this daemon.
  90  */
  91 struct RES_TABLE {
  92    const char *name;                  /* resource name */
  93    RES_ITEM *items;                   /* list of resource keywords */
  94    int rcode;                         /* code if needed */
  95 };
  96
  97 class PARSER {
  98 public:
  99    const char *m_cf;                   /* config file */
 100    LEX_ERROR_HANDLER *m_scan_error;    /* error handler if non-null */
 101    int m_err_type;                     /* the way to terminate on failure */
 102    void *m_res_all;                    /* pointer to res_all buffer */
 103    int m_res_all_size;                 /* length of buffer */
 104    /* The below are not yet implemented */
 105    int m_r_first;                      /* first daemon resource type */
 106    int m_r_last;                       /* last daemon resource type */
 107    RES_TABLE *m_resources;             /* pointer to table of permitted resources */
 108    RES **m_res_head;                   /* pointer to defined resources */
 109    brwlock_t m_res_lock;               /* resource lock */
 110
 111    /* functions */
 112    void init(
 113       const char *cf,
 114       LEX_ERROR_HANDLER *scan_error,
 115       int err_type,
 116       void *vres_all,
 117       int res_all_size,
 118       int r_first,
 119       int r_last,
 120       RES_TABLE *resources,
 121       RES **res_head);
 122
 123    bool parse_config();
 124 };
 125
 126 PARSER *new_parser();
 127
 128
 129 /* Common Resource definitions */
 130
 131 #define MAX_RES_NAME_LENGTH MAX_NAME_LENGTH-1       /* maximum resource name length */
 132
 133 #define ITEM_REQUIRED    0x1          /* item required */
 134 #define ITEM_DEFAULT     0x2          /* default supplied */
 135 #define ITEM_NO_EQUALS   0x4          /* Don't scan = after name */
 136
 137 /* Message Resource */
 138 class MSGS {
 139 public:
 140    RES   hdr;
 141    char *mail_cmd;                    /* mail command */
 142    char *operator_cmd;                /* Operator command */
 143    DEST *dest_chain;                  /* chain of destinations */
 144    char send_msg[nbytes_for_bits(M_MAX+1)];  /* bit array of types */
 145
 146    /* Methods */
 147    char *name() const;
 148 };
 149
 150 inline char *MSGS::name() const { return hdr.name; }
 151
 152 /* Configuration routines */
 153
 154 int   parse_config(const char *cf, LEX_ERROR_HANDLER *scan_error = NULL, int err_type=M_ERROR_TERM);
 155 void    free_config_resources(void);
 156 RES   **save_config_resources(void);
 157 RES   **new_res_head();
 158
 159
 160 /* Resource routines */
 161 RES *GetResWithName(int rcode, const char *name);
 162 RES *GetNextRes(int rcode, RES *res);
 163 void b_LockRes(const char *file, int line);
 164 void b_UnlockRes(const char *file, int line);
 165 void dump_resource(int type, RES *res, void sendmsg(void *sock, const char *fmt, ...), void *sock);
 166 void free_resource(RES *res, int type);
 167 void init_resource(int type, RES_ITEM *item);
 168 void save_resource(int type, RES_ITEM *item, int pass);
 169 const char *res_to_str(int rcode);
 170
 171 /* Loop through each resource of type, returning in var */
 172 #ifdef HAVE_TYPEOF
 173 #define foreach_res(var, type) \
 174         for((var)=NULL; ((var)=(typeof(var))GetNextRes((type), (RES *)var));)
 175 #else
 176 #define foreach_res(var, type) \
 177     for(var=NULL; (*((void **)&(var))=(void *)GetNextRes((type), (RES *)var));)
 178 #endif
 179
 180
 181 /*
 182  * Standard global parsers defined in parse_config.c
 183  */
 184 void store_str(LEX *lc, RES_ITEM *item, int index, int pass);
 185 void store_dir(LEX *lc, RES_ITEM *item, int index, int pass);
 186 void store_password(LEX *lc, RES_ITEM *item, int index, int pass);
 187 void store_name(LEX *lc, RES_ITEM *item, int index, int pass);
 188 void store_strname(LEX *lc, RES_ITEM *item, int index, int pass);
 189 void store_res(LEX *lc, RES_ITEM *item, int index, int pass);
 190 void store_alist_res(LEX *lc, RES_ITEM *item, int index, int pass);
 191 void store_alist_str(LEX *lc, RES_ITEM *item, int index, int pass);
 192 void store_int(LEX *lc, RES_ITEM *item, int index, int pass);
 193 void store_pint(LEX *lc, RES_ITEM *item, int index, int pass);
 194 void store_msgs(LEX *lc, RES_ITEM *item, int index, int pass);
 195 void store_int64(LEX *lc, RES_ITEM *item, int index, int pass);
 196 void store_bit(LEX *lc, RES_ITEM *item, int index, int pass);
 197 void store_bool(LEX *lc, RES_ITEM *item, int index, int pass);
 198 void store_time(LEX *lc, RES_ITEM *item, int index, int pass);
 199 void store_size(LEX *lc, RES_ITEM *item, int index, int pass);
 200 void store_defs(LEX *lc, RES_ITEM *item, int index, int pass);
 201 void store_label(LEX *lc, RES_ITEM *item, int index, int pass);