git.sur5r.net Git - bacula/bacula/blob - bacula/src/qt-console/bat_conf.cpp

   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 Kern Sibbald.
  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  *   Main configuration file parser for Bacula User Agent
  30  *    some parts may be split into separate files such as
  31  *    the schedule configuration (sch_config.c).
  32  *
  33  *   Note, the configuration file parser consists of three parts
  34  *
  35  *   1. The generic lexical scanner in lib/lex.c and lib/lex.h
  36  *
  37  *   2. The generic config  scanner in lib/parse_config.c and
  38  *      lib/parse_config.h.
  39  *      These files contain the parser code, some utility
  40  *      routines, and the common store routines (name, int,
  41  *      string).
  42  *
  43  *   3. The daemon specific file, which contains the Resource
  44  *      definitions as well as any specific store routines
  45  *      for the resource records.
  46  *
  47  *     Kern Sibbald, January MM, September MM
  48  *
  49  *     Version $Id$
  50  */
  51
  52 #include "bacula.h"
  53 #include "bat_conf.h"
  54
  55 /* Define the first and last resource ID record
  56  * types. Note, these should be unique for each
  57  * daemon though not a requirement.
  58  */
  59 int32_t r_first = R_FIRST;
  60 int32_t r_last  = R_LAST;
  61 static RES *sres_head[R_LAST - R_FIRST + 1];
  62 RES **res_head = sres_head;
  63
  64 /* Forward referenced subroutines */
  65
  66
  67 /* We build the current resource here as we are
  68  * scanning the resource configuration definition,
  69  * then move it to allocated memory when the resource
  70  * scan is complete.
  71  */
  72 #if defined(MSC_VER)
  73 extern "C" URES res_all; /* visual c mangles variable names */
  74 #else
  75 URES res_all;
  76 #endif
  77 int32_t res_all_size = sizeof(res_all);
  78
  79 /* Definition of records permitted within each
  80  * resource with the routine to process the record
  81  * information.
  82  */
  83 static RES_ITEM dir_items[] = {
  84    {"name",        store_name,     ITEM(dir_res.hdr.name), 0, ITEM_REQUIRED, 0},
  85    {"description", store_str,      ITEM(dir_res.hdr.desc), 0, 0, 0},
  86    {"dirport",     store_pint32,   ITEM(dir_res.DIRport),  0, ITEM_DEFAULT, 9101},
  87    {"address",     store_str,      ITEM(dir_res.address),  0, ITEM_REQUIRED, 0},
  88    {"password",    store_password, ITEM(dir_res.password), 0, 0, 0},
  89    {"tlsauthenticate",store_bool,    ITEM(dir_res.tls_authenticate), 0, 0, 0},
  90    {"tlsenable",      store_bool,    ITEM(dir_res.tls_enable), 0, 0, 0},
  91    {"tlsrequire",     store_bool,    ITEM(dir_res.tls_require), 0, 0, 0},
  92    {"tlscacertificatefile", store_dir, ITEM(dir_res.tls_ca_certfile), 0, 0, 0},
  93    {"tlscacertificatedir", store_dir,  ITEM(dir_res.tls_ca_certdir), 0, 0, 0},
  94    {"tlscertificate", store_dir,       ITEM(dir_res.tls_certfile), 0, 0, 0},
  95    {"tlskey",         store_dir,       ITEM(dir_res.tls_keyfile), 0, 0, 0},
  96    {"heartbeatinterval", store_time, ITEM(dir_res.heartbeat_interval), 0, ITEM_DEFAULT, 0},
  97    {NULL, NULL, {0}, 0, 0, 0}
  98 };
  99
 100 static RES_ITEM con_items[] = {
 101    {"name",        store_name,     ITEM(con_res.hdr.name), 0, ITEM_REQUIRED, 0},
 102    {"description", store_str,      ITEM(con_res.hdr.desc), 0, 0, 0},
 103    {"password",    store_password, ITEM(con_res.password), 0, ITEM_REQUIRED, 0},
 104    {"tlsauthenticate",store_bool,    ITEM(con_res.tls_authenticate), 0, 0, 0},
 105    {"tlsenable",      store_bool,    ITEM(con_res.tls_enable), 0, 0, 0},
 106    {"tlsrequire",     store_bool,    ITEM(con_res.tls_require), 0, 0, 0},
 107    {"tlscacertificatefile", store_dir, ITEM(con_res.tls_ca_certfile), 0, 0, 0},
 108    {"tlscacertificatedir", store_dir,  ITEM(con_res.tls_ca_certdir), 0, 0, 0},
 109    {"tlscertificate", store_dir,       ITEM(con_res.tls_certfile), 0, 0, 0},
 110    {"tlskey",         store_dir,       ITEM(con_res.tls_keyfile), 0, 0, 0},
 111    {"heartbeatinterval", store_time, ITEM(con_res.heartbeat_interval), 0, ITEM_DEFAULT, 0},
 112    {NULL, NULL, {0}, 0, 0, 0}
 113 };
 114
 115 static RES_ITEM con_font_items[] = {
 116    {"name",        store_name,     ITEM(con_font.hdr.name), 0, ITEM_REQUIRED, 0},
 117    {"description", store_str,      ITEM(con_font.hdr.desc), 0, 0, 0},
 118    {"font",        store_str,      ITEM(con_font.fontface), 0, 0, 0},
 119    {NULL, NULL, {0}, 0, 0, 0}
 120 };
 121
 122
 123 /*
 124  * This is the master resource definition.
 125  * It must have one item for each of the resources.
 126  */
 127 RES_TABLE resources[] = {
 128    {"director",      dir_items,   R_DIRECTOR},
 129    {"console",       con_items,   R_CONSOLE},
 130    {"consolefont",   con_font_items, R_CONSOLE_FONT},
 131    {NULL,            NULL,        0}
 132 };
 133
 134
 135 /* Dump contents of resource */
 136 void dump_resource(int type, RES *reshdr, void sendit(void *sock, const char *fmt, ...), void *sock)
 137 {
 138    URES *res = (URES *)reshdr;
 139    bool recurse = true;
 140
 141    if (res == NULL) {
 142       printf(_("No record for %d %s\n"), type, res_to_str(type));
 143       return;
 144    }
 145    if (type < 0) {                    /* no recursion */
 146       type = - type;
 147       recurse = false;
 148    }
 149    switch (type) {
 150    case R_DIRECTOR:
 151       printf(_("Director: name=%s address=%s DIRport=%d\n"), reshdr->name,
 152               res->dir_res.address, res->dir_res.DIRport);
 153       break;
 154    case R_CONSOLE:
 155       printf(_("Console: name=%s\n"), reshdr->name);
 156       break;
 157    case R_CONSOLE_FONT:
 158       printf(_("ConsoleFont: name=%s font face=%s\n"),
 159              reshdr->name, NPRT(res->con_font.fontface));
 160       break;
 161    default:
 162       printf(_("Unknown resource type %d\n"), type);
 163    }
 164    if (recurse && res->dir_res.hdr.next) {
 165       dump_resource(type, res->dir_res.hdr.next, sendit, sock);
 166    }
 167 }
 168
 169 /*
 170  * Free memory of resource.
 171  * NB, we don't need to worry about freeing any references
 172  * to other resources as they will be freed when that
 173  * resource chain is traversed.  Mainly we worry about freeing
 174  * allocated strings (names).
 175  */
 176 void free_resource(RES *sres, int type)
 177 {
 178    RES *nres;
 179    URES *res = (URES *)sres;
 180
 181    if (res == NULL)
 182       return;
 183
 184    /* common stuff -- free the resource name */
 185    nres = (RES *)res->dir_res.hdr.next;
 186    if (res->dir_res.hdr.name) {
 187       free(res->dir_res.hdr.name);
 188    }
 189    if (res->dir_res.hdr.desc) {
 190       free(res->dir_res.hdr.desc);
 191    }
 192
 193    switch (type) {
 194    case R_DIRECTOR:
 195       if (res->dir_res.address) {
 196          free(res->dir_res.address);
 197       }
 198       if (res->dir_res.tls_ctx) {
 199          free_tls_context(res->dir_res.tls_ctx);
 200       }
 201       if (res->dir_res.tls_ca_certfile) {
 202          free(res->dir_res.tls_ca_certfile);
 203       }
 204       if (res->dir_res.tls_ca_certdir) {
 205          free(res->dir_res.tls_ca_certdir);
 206       }
 207       if (res->dir_res.tls_certfile) {
 208          free(res->dir_res.tls_certfile);
 209       }
 210       if (res->dir_res.tls_keyfile) {
 211          free(res->dir_res.tls_keyfile);
 212       }
 213       break;
 214    case R_CONSOLE:
 215       if (res->con_res.password) {
 216          free(res->con_res.password);
 217       }
 218       if (res->con_res.tls_ctx) {
 219          free_tls_context(res->con_res.tls_ctx);
 220       }
 221       if (res->con_res.tls_ca_certfile) {
 222          free(res->con_res.tls_ca_certfile);
 223       }
 224       if (res->con_res.tls_ca_certdir) {
 225          free(res->con_res.tls_ca_certdir);
 226       }
 227       if (res->con_res.tls_certfile) {
 228          free(res->con_res.tls_certfile);
 229       }
 230       if (res->con_res.tls_keyfile) {
 231          free(res->con_res.tls_keyfile);
 232       }
 233       break;
 234    case R_CONSOLE_FONT:
 235       if (res->con_font.fontface) {
 236          free(res->con_font.fontface);
 237       }
 238       break;
 239    default:
 240       printf(_("Unknown resource type %d\n"), type);
 241    }
 242    /* Common stuff again -- free the resource, recurse to next one */
 243    free(res);
 244    if (nres) {
 245       free_resource(nres, type);
 246    }
 247 }
 248
 249 /* Save the new resource by chaining it into the head list for
 250  * the resource. If this is pass 2, we update any resource
 251  * pointers (currently only in the Job resource).
 252  */
 253 void save_resource(int type, RES_ITEM *items, int pass)
 254 {
 255    URES *res;
 256    int rindex = type - r_first;
 257    int i, size = 0;
 258    int error = 0;
 259
 260    /*
 261     * Ensure that all required items are present
 262     */
 263    for (i=0; items[i].name; i++) {
 264       if (items[i].flags & ITEM_REQUIRED) {
 265             if (!bit_is_set(i, res_all.dir_res.hdr.item_present)) {
 266                Emsg2(M_ABORT, 0, _("%s item is required in %s resource, but not found.\n"),
 267                  items[i].name, resources[rindex]);
 268              }
 269       }
 270    }
 271
 272    /* During pass 2, we looked up pointers to all the resources
 273     * referrenced in the current resource, , now we
 274     * must copy their address from the static record to the allocated
 275     * record.
 276     */
 277    if (pass == 2) {
 278       switch (type) {
 279       /* Resources not containing a resource */
 280       case R_DIRECTOR:
 281          break;
 282
 283       case R_CONSOLE:
 284       case R_CONSOLE_FONT:
 285          break;
 286
 287       default:
 288          Emsg1(M_ERROR, 0, _("Unknown resource type %d\n"), type);
 289          error = 1;
 290          break;
 291       }
 292       /* Note, the resoure name was already saved during pass 1,
 293        * so here, we can just release it.
 294        */
 295       if (res_all.dir_res.hdr.name) {
 296          free(res_all.dir_res.hdr.name);
 297          res_all.dir_res.hdr.name = NULL;
 298       }
 299       if (res_all.dir_res.hdr.desc) {
 300          free(res_all.dir_res.hdr.desc);
 301          res_all.dir_res.hdr.desc = NULL;
 302       }
 303       return;
 304    }
 305
 306    /* The following code is only executed during pass 1 */
 307    switch (type) {
 308    case R_DIRECTOR:
 309       size = sizeof(DIRRES);
 310       break;
 311    case R_CONSOLE_FONT:
 312       size = sizeof(CONFONTRES);
 313       break;
 314    case R_CONSOLE:
 315       size = sizeof(CONRES);
 316       break;
 317    default:
 318       printf(_("Unknown resource type %d\n"), type);
 319       error = 1;
 320       break;
 321    }
 322    /* Common */
 323    if (!error) {
 324       res = (URES *)malloc(size);
 325       memcpy(res, &res_all, size);
 326       if (!res_head[rindex]) {
 327          res_head[rindex] = (RES *)res; /* store first entry */
 328       } else {
 329          RES *next, *last;
 330          /* Add new res to end of chain */
 331          for (last=next=res_head[rindex]; next; next=next->next) {
 332             last = next;
 333             if (strcmp(next->name, res->dir_res.hdr.name) == 0) {
 334                Emsg2(M_ERROR_TERM, 0,
 335                   _("Attempt to define second %s resource named \"%s\" is not permitted.\n"),
 336                   resources[rindex].name, res->dir_res.hdr.name);
 337             }
 338          }
 339          last->next = (RES *)res;
 340          Dmsg2(90, "Inserting %s res: %s\n", res_to_str(type),
 341                res->dir_res.hdr.name);
 342       }
 343    }
 344 }
 345
 346 bool parse_bat_config(CONFIG *config, const char *configfile, int exit_code)
 347 {
 348    config->init(configfile, NULL, exit_code, (void *)&res_all, res_all_size,
 349       r_first, r_last, resources, res_head);
 350    return config->parse_config();
 351 }