git.sur5r.net Git - bacula/bacula/blob - bacula/src/filed/filed_conf.c

   1 /*
   2  *   Main configuration file parser for Bacula File Daemon (Client)
   3  *    some parts may be split into separate files such as
   4  *    the schedule configuration (sch_config.c).
   5  *
   6  *   Note, the configuration file parser consists of three parts
   7  *
   8  *   1. The generic lexical scanner in lib/lex.c and lib/lex.h
   9  *
  10  *   2. The generic config  scanner in lib/parse_config.c and
  11  *      lib/parse_config.h.
  12  *      These files contain the parser code, some utility
  13  *      routines, and the common store routines (name, int,
  14  *      string).
  15  *
  16  *   3. The daemon specific file, which contains the Resource
  17  *      definitions as well as any specific store routines
  18  *      for the resource records.
  19  *
  20  *     Kern Sibbald, September MM
  21  *
  22  *   Version $Id$
  23  */
  24 /*
  25    Copyright (C) 2000, 2001, 2002 Kern Sibbald and John Walker
  26
  27    This program is free software; you can redistribute it and/or
  28    modify it under the terms of the GNU General Public License as
  29    published by the Free Software Foundation; either version 2 of
  30    the License, or (at your option) any later version.
  31
  32    This program is distributed in the hope that it will be useful,
  33    but WITHOUT ANY WARRANTY; without even the implied warranty of
  34    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  35    General Public License for more details.
  36
  37    You should have received a copy of the GNU General Public
  38    License along with this program; if not, write to the Free
  39    Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  40    MA 02111-1307, USA.
  41
  42  */
  43
  44
  45 #include "bacula.h"
  46 #include "filed.h"
  47
  48 /* Define the first and last resource ID record
  49  * types. Note, these should be unique for each
  50  * daemon though not a requirement.
  51  */
  52 int r_first = R_FIRST;
  53 int r_last  = R_LAST;
  54 static RES *sres_head[R_LAST - R_FIRST + 1];
  55 RES **res_head = sres_head;
  56
  57
  58 /* Forward referenced subroutines */
  59
  60
  61 /* We build the current resource here as we are
  62  * scanning the resource configuration definition,
  63  * then move it to allocated memory when the resource
  64  * scan is complete.
  65  */
  66 #if defined(HAVE_WIN32) && !defined(HAVE_CYGWIN)
  67 extern "C" { // work around visual compiler mangling variables
  68     URES res_all;
  69     int  res_all_size = sizeof(res_all);
  70 }
  71 #else
  72 URES res_all;
  73 int  res_all_size = sizeof(res_all);
  74 #endif
  75
  76 /* Definition of records permitted within each
  77  * resource with the routine to process the record
  78  * information.
  79  */
  80
  81 /* Client or File daemon "Global" resources */
  82 static RES_ITEM cli_items[] = {
  83    {"name",        store_name,  ITEM(res_client.hdr.name), 0, ITEM_REQUIRED, 0},
  84    {"description", store_str,   ITEM(res_client.hdr.desc), 0, 0, 0},
  85    {"fdport",      store_addresses_port,    ITEM(res_client.FDaddrs),  0, ITEM_DEFAULT, 9102},
  86    {"fdaddress",   store_addresses_address, ITEM(res_client.FDaddrs),  0, ITEM_DEFAULT, 9102},
  87    {"fdaddresses", store_addresses,         ITEM(res_client.FDaddrs),  0, ITEM_DEFAULT, 9102},
  88
  89    {"workingdirectory",  store_dir, ITEM(res_client.working_directory), 0, ITEM_REQUIRED, 0},
  90    {"piddirectory",  store_dir,     ITEM(res_client.pid_directory),     0, ITEM_REQUIRED, 0},
  91    {"subsysdirectory",  store_dir,  ITEM(res_client.subsys_directory),  0, 0, 0},
  92    {"scriptsdirectory",  store_dir,  ITEM(res_client.scripts_directory),  0, 0, 0},
  93    {"requiressl",  store_yesno,     ITEM(res_client.require_ssl),       1, ITEM_DEFAULT, 0},
  94    {"maximumconcurrentjobs", store_pint,  ITEM(res_client.MaxConcurrentJobs), 0, ITEM_DEFAULT, 10},
  95    {"messages",      store_res, ITEM(res_client.messages), R_MSGS, 0, 0},
  96    {"heartbeatinterval", store_time, ITEM(res_client.heartbeat_interval), 0, ITEM_DEFAULT, 0},
  97    {"sdconnecttimeout", store_time,ITEM(res_client.SDConnectTimeout), 0, ITEM_DEFAULT, 60 * 30},
  98    {"maximumnetworkbuffersize", store_pint, ITEM(res_client.max_network_buffer_size), 0, 0, 0},
  99    {NULL, NULL, NULL, 0, 0, 0}
 100 };
 101
 102 /* Directors that can use our services */
 103 static RES_ITEM dir_items[] = {
 104    {"name",        store_name,     ITEM(res_dir.hdr.name),  0, ITEM_REQUIRED, 0},
 105    {"description", store_str,      ITEM(res_dir.hdr.desc),  0, 0, 0},
 106    {"password",    store_password, ITEM(res_dir.password),  0, ITEM_REQUIRED, 0},
 107    {"address",     store_str,      ITEM(res_dir.address),   0, 0, 0},
 108    {"enablessl",   store_yesno,    ITEM(res_dir.enable_ssl),1, ITEM_DEFAULT, 0},
 109    {"monitor",     store_yesno,    ITEM(res_dir.monitor),   1, ITEM_DEFAULT, 0},
 110    {NULL, NULL, NULL, 0, 0, 0}
 111 };
 112
 113 /* Message resource */
 114 extern RES_ITEM msgs_items[];
 115
 116 /*
 117  * This is the master resource definition.
 118  * It must have one item for each of the resources.
 119  */
 120 RES_TABLE resources[] = {
 121    {"director",      dir_items,   R_DIRECTOR},
 122    {"filedaemon",    cli_items,   R_CLIENT},
 123    {"client",        cli_items,   R_CLIENT},     /* alias for filedaemon */
 124    {"messages",      msgs_items,  R_MSGS},
 125    {NULL,            NULL,        0}
 126 };
 127
 128
 129 /* Dump contents of resource */
 130 void dump_resource(int type, RES *reshdr, void sendit(void *sock, const char *fmt, ...), void *sock)
 131 {
 132    URES *res = (URES *)reshdr;
 133    int recurse = 1;
 134
 135    if (res == NULL) {
 136       sendit(sock, "No record for %d %s\n", type, res_to_str(type));
 137       return;
 138    }
 139    if (type < 0) {                    /* no recursion */
 140       type = - type;
 141       recurse = 0;
 142    }
 143    switch (type) {
 144       case R_DIRECTOR:
 145          sendit(sock, "Director: name=%s password=%s\n", reshdr->name,
 146                  res->res_dir.password);
 147          break;
 148       case R_CLIENT:
 149          sendit(sock, "Client: name=%s FDport=%d\n", reshdr->name,
 150                  get_first_port_host_order(res->res_client.FDaddrs));
 151          break;
 152       case R_MSGS:
 153          sendit(sock, "Messages: name=%s\n", res->res_msgs.hdr.name);
 154          if (res->res_msgs.mail_cmd)
 155             sendit(sock, "      mailcmd=%s\n", res->res_msgs.mail_cmd);
 156          if (res->res_msgs.operator_cmd)
 157             sendit(sock, "      opcmd=%s\n", res->res_msgs.operator_cmd);
 158          break;
 159       default:
 160          sendit(sock, "Unknown resource type %d\n", type);
 161    }
 162    if (recurse && res->res_dir.hdr.next)
 163       dump_resource(type, res->res_dir.hdr.next, sendit, sock);
 164 }
 165
 166 /*
 167  * Free memory of resource.
 168  * NB, we don't need to worry about freeing any references
 169  * to other resources as they will be freed when that
 170  * resource chain is traversed.  Mainly we worry about freeing
 171  * allocated strings (names).
 172  */
 173 void free_resource(RES *sres, int type)
 174 {
 175    RES *nres;
 176    URES *res = (URES *)sres;
 177
 178    if (res == NULL) {
 179       return;
 180    }
 181
 182    /* common stuff -- free the resource name */
 183    nres = (RES *)res->res_dir.hdr.next;
 184    if (res->res_dir.hdr.name) {
 185       free(res->res_dir.hdr.name);
 186    }
 187    if (res->res_dir.hdr.desc) {
 188       free(res->res_dir.hdr.desc);
 189    }
 190    switch (type) {
 191    case R_DIRECTOR:
 192       if (res->res_dir.password) {
 193          free(res->res_dir.password);
 194       }
 195       if (res->res_dir.address) {
 196          free(res->res_dir.address);
 197       }
 198       break;
 199    case R_CLIENT:
 200       if (res->res_client.working_directory) {
 201          free(res->res_client.working_directory);
 202       }
 203       if (res->res_client.pid_directory) {
 204          free(res->res_client.pid_directory);
 205       }
 206       if (res->res_client.subsys_directory) {
 207          free(res->res_client.subsys_directory);
 208       }
 209       if (res->res_client.FDaddrs) {
 210          free_addresses(res->res_client.FDaddrs);
 211       }
 212       break;
 213    case R_MSGS:
 214       if (res->res_msgs.mail_cmd)
 215          free(res->res_msgs.mail_cmd);
 216       if (res->res_msgs.operator_cmd)
 217          free(res->res_msgs.operator_cmd);
 218       free_msgs_res((MSGS *)res);  /* free message resource */
 219       res = NULL;
 220       break;
 221    default:
 222       printf("Unknown resource type %d\n", type);
 223    }
 224    /* Common stuff again -- free the resource, recurse to next one */
 225    if (res) {
 226       free(res);
 227    }
 228    if (nres) {
 229       free_resource(nres, type);
 230    }
 231 }
 232
 233 /* Save the new resource by chaining it into the head list for
 234  * the resource. If this is pass 2, we update any resource
 235  * pointers (currently only in the Job resource).
 236  */
 237 void save_resource(int type, RES_ITEM *items, int pass)
 238 {
 239    URES *res;
 240    int rindex = type - r_first;
 241    int i, size;
 242    int error = 0;
 243
 244    /*
 245     * Ensure that all required items are present
 246     */
 247    for (i=0; items[i].name; i++) {
 248       if (items[i].flags & ITEM_REQUIRED) {
 249             if (!bit_is_set(i, res_all.res_dir.hdr.item_present)) {
 250                Emsg2(M_ABORT, 0, _("%s item is required in %s resource, but not found.\n"),
 251                  items[i].name, resources[rindex]);
 252              }
 253       }
 254    }
 255
 256    /* During pass 2, we looked up pointers to all the resources
 257     * referrenced in the current resource, , now we
 258     * must copy their address from the static record to the allocated
 259     * record.
 260     */
 261    if (pass == 2) {
 262       switch (type) {
 263          /* Resources not containing a resource */
 264          case R_MSGS:
 265          case R_DIRECTOR:
 266             break;
 267
 268          /* Resources containing another resource */
 269          case R_CLIENT:
 270             if ((res = (URES *)GetResWithName(R_CLIENT, res_all.res_dir.hdr.name)) == NULL) {
 271                Emsg1(M_ABORT, 0, "Cannot find Client resource %s\n", res_all.res_dir.hdr.name);
 272             }
 273             res->res_client.messages = res_all.res_client.messages;
 274             break;
 275          default:
 276             Emsg1(M_ERROR, 0, _("Unknown resource type %d\n"), type);
 277             error = 1;
 278             break;
 279       }
 280       /* Note, the resoure name was already saved during pass 1,
 281        * so here, we can just release it.
 282        */
 283       if (res_all.res_dir.hdr.name) {
 284          free(res_all.res_dir.hdr.name);
 285          res_all.res_dir.hdr.name = NULL;
 286       }
 287       if (res_all.res_dir.hdr.desc) {
 288          free(res_all.res_dir.hdr.desc);
 289          res_all.res_dir.hdr.desc = NULL;
 290       }
 291       return;
 292    }
 293
 294    /* The following code is only executed on pass 1 */
 295    switch (type) {
 296       case R_DIRECTOR:
 297          size = sizeof(DIRRES);
 298          break;
 299       case R_CLIENT:
 300          size = sizeof(CLIENT);
 301          break;
 302       case R_MSGS:
 303          size = sizeof(MSGS);
 304          break;
 305       default:
 306          printf(_("Unknown resource type %d\n"), type);
 307          error = 1;
 308          size = 1;
 309          break;
 310    }
 311    /* Common */
 312    if (!error) {
 313       res = (URES *)malloc(size);
 314       memcpy(res, &res_all, size);
 315       if (!res_head[rindex]) {
 316          res_head[rindex] = (RES *)res; /* store first entry */
 317       } else {
 318          RES *next;
 319          /* Add new res to end of chain */
 320          for (next=res_head[rindex]; next->next; next=next->next) {
 321             if (strcmp(next->name, res->res_dir.hdr.name) == 0) {
 322                Emsg2(M_ERROR_TERM, 0,
 323                   _("Attempt to define second %s resource named \"%s\" is not permitted.\n"),
 324                   resources[rindex].name, res->res_dir.hdr.name);
 325             }
 326          }
 327          next->next = (RES *)res;
 328          Dmsg2(90, "Inserting %s res: %s\n", res_to_str(type),
 329                res->res_dir.hdr.name);
 330       }
 331    }
 332 }