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 pthread_mutex_t res_mutex =  PTHREAD_MUTEX_INITIALIZER;
  55
  56 /* Forward referenced subroutines */
  57
  58
  59 /* We build the current resource here as we are
  60  * scanning the resource configuration definition,
  61  * then move it to allocated memory when the resource
  62  * scan is complete.
  63  */
  64 URES res_all;
  65 int  res_all_size = sizeof(res_all);
  66
  67 /* Definition of records permitted within each
  68  * resource with the routine to process the record
  69  * information.
  70  */
  71
  72 /* Client or File daemon "Global" resources */
  73 static struct res_items cli_items[] = {
  74    {"name",        store_name,  ITEM(res_client.hdr.name), 0, ITEM_REQUIRED, 0},
  75    {"description", store_str,   ITEM(res_client.hdr.desc), 0, 0, 0},
  76    {"fdport",      store_pint,  ITEM(res_client.FDport),  0, ITEM_DEFAULT, 9102},
  77    {"fdaddress",   store_str,   ITEM(res_client.FDaddr),  0, 0, 0},
  78    {"workingdirectory",  store_dir, ITEM(res_client.working_directory), 0, ITEM_REQUIRED, 0},
  79    {"piddirectory",  store_dir,     ITEM(res_client.pid_directory),     0, ITEM_REQUIRED, 0},
  80    {"subsysdirectory",  store_dir,  ITEM(res_client.subsys_directory),  0, 0, 0},
  81    {"requiressl",  store_yesno,     ITEM(res_client.require_ssl),       1, ITEM_DEFAULT, 0},
  82    {"maximumconcurrentjobs", store_pint,  ITEM(res_client.MaxConcurrentJobs), 0, ITEM_DEFAULT, 5},
  83    {"messages",      store_res, ITEM(res_client.messages), R_MSGS, 0, 0},
  84    {"heartbeatinterval", store_time, ITEM(res_client.heartbeat_interval), 0, ITEM_DEFAULT, 20*60},
  85    {NULL, NULL, NULL, 0, 0, 0}
  86 };
  87
  88 /* Directors that can use our services */
  89 static struct res_items dir_items[] = {
  90    {"name",        store_name,     ITEM(res_dir.hdr.name),  0, ITEM_REQUIRED, 0},
  91    {"description", store_str,      ITEM(res_dir.hdr.desc),  0, 0, 0},
  92    {"password",    store_password, ITEM(res_dir.password),  0, ITEM_REQUIRED, 0},
  93    {"address",     store_str,      ITEM(res_dir.address),   0, 0, 0},
  94    {"enablessl",   store_yesno,    ITEM(res_dir.enable_ssl),1, ITEM_DEFAULT, 0},
  95    {NULL, NULL, NULL, 0, 0, 0}
  96 };
  97
  98 /* Message resource */
  99 extern struct res_items msgs_items[];
 100
 101 /*
 102  * This is the master resource definition.
 103  * It must have one item for each of the resources.
 104  */
 105 struct s_res resources[] = {
 106    {"director",      dir_items,   R_DIRECTOR,  NULL},
 107    {"filedaemon",    cli_items,   R_CLIENT,    NULL},
 108    {"client",        cli_items,   R_CLIENT,    NULL}, /* alias for filedaemon */
 109    {"messages",      msgs_items,  R_MSGS,      NULL},
 110    {NULL,            NULL,        0,           NULL}
 111 };
 112
 113
 114 /* Dump contents of resource */
 115 void dump_resource(int type, RES *reshdr, void sendit(void *sock, char *fmt, ...), void *sock)
 116 {
 117    URES *res = (URES *)reshdr;
 118    int recurse = 1;
 119
 120    if (res == NULL) {
 121       sendit(sock, "No record for %d %s\n", type, res_to_str(type));
 122       return;
 123    }
 124    if (type < 0) {                    /* no recursion */
 125       type = - type;
 126       recurse = 0;
 127    }
 128    switch (type) {
 129       case R_DIRECTOR:
 130          sendit(sock, "Director: name=%s password=%s\n", reshdr->name,
 131                  res->res_dir.password);
 132          break;
 133       case R_CLIENT:
 134          sendit(sock, "Client: name=%s FDport=%d\n", reshdr->name,
 135                  res->res_client.FDport);
 136          break;
 137       case R_MSGS:
 138          sendit(sock, "Messages: name=%s\n", res->res_msgs.hdr.name);
 139          if (res->res_msgs.mail_cmd)
 140             sendit(sock, "      mailcmd=%s\n", res->res_msgs.mail_cmd);
 141          if (res->res_msgs.operator_cmd)
 142             sendit(sock, "      opcmd=%s\n", res->res_msgs.operator_cmd);
 143          break;
 144       default:
 145          sendit(sock, "Unknown resource type %d\n", type);
 146    }
 147    if (recurse && res->res_dir.hdr.next)
 148       dump_resource(type, res->res_dir.hdr.next, sendit, sock);
 149 }
 150
 151 /*
 152  * Free memory of resource.
 153  * NB, we don't need to worry about freeing any references
 154  * to other resources as they will be freed when that
 155  * resource chain is traversed.  Mainly we worry about freeing
 156  * allocated strings (names).
 157  */
 158 void free_resource(int type)
 159 {
 160    URES *res;
 161    RES *nres;
 162    int rindex = type - r_first;
 163
 164    res = (URES *)resources[rindex].res_head;
 165
 166    if (res == NULL) {
 167       return;
 168    }
 169
 170    /* common stuff -- free the resource name */
 171    nres = (RES *)res->res_dir.hdr.next;
 172    if (res->res_dir.hdr.name) {
 173       free(res->res_dir.hdr.name);
 174    }
 175    if (res->res_dir.hdr.desc) {
 176       free(res->res_dir.hdr.desc);
 177    }
 178
 179    switch (type) {
 180       case R_DIRECTOR:
 181          if (res->res_dir.password) {
 182             free(res->res_dir.password);
 183          }
 184          if (res->res_dir.address) {
 185             free(res->res_dir.address);
 186          }
 187          break;
 188       case R_CLIENT:
 189          if (res->res_client.working_directory) {
 190             free(res->res_client.working_directory);
 191          }
 192          if (res->res_client.pid_directory) {
 193             free(res->res_client.pid_directory);
 194          }
 195          if (res->res_client.subsys_directory) {
 196             free(res->res_client.subsys_directory);
 197          }
 198          if (res->res_client.FDaddr) {
 199             free(res->res_client.FDaddr);
 200          }
 201          break;
 202       case R_MSGS:
 203          if (res->res_msgs.mail_cmd)
 204             free(res->res_msgs.mail_cmd);
 205          if (res->res_msgs.operator_cmd)
 206             free(res->res_msgs.operator_cmd);
 207          free_msgs_res((MSGS *)res);  /* free message resource */
 208          res = NULL;
 209          break;
 210       default:
 211          printf("Unknown resource type %d\n", type);
 212    }
 213    /* Common stuff again -- free the resource, recurse to next one */
 214    if (res) {
 215       free(res);
 216    }
 217    resources[rindex].res_head = nres;
 218    if (nres) {
 219       free_resource(type);
 220    }
 221 }
 222
 223 /* Save the new resource by chaining it into the head list for
 224  * the resource. If this is pass 2, we update any resource
 225  * pointers (currently only in the Job resource).
 226  */
 227 void save_resource(int type, struct res_items *items, int pass)
 228 {
 229    URES *res;
 230    int rindex = type - r_first;
 231    int i, size;
 232    int error = 0;
 233
 234    /*
 235     * Ensure that all required items are present
 236     */
 237    for (i=0; items[i].name; i++) {
 238       if (items[i].flags & ITEM_REQUIRED) {
 239             if (!bit_is_set(i, res_all.res_dir.hdr.item_present)) {
 240                Emsg2(M_ABORT, 0, _("%s item is required in %s resource, but not found.\n"),
 241                  items[i].name, resources[rindex]);
 242              }
 243       }
 244    }
 245
 246    /* During pass 2, we looked up pointers to all the resources
 247     * referrenced in the current resource, , now we
 248     * must copy their address from the static record to the allocated
 249     * record.
 250     */
 251    if (pass == 2) {
 252       switch (type) {
 253          /* Resources not containing a resource */
 254          case R_MSGS:
 255          case R_DIRECTOR:
 256             break;
 257
 258          /* Resources containing another resource */
 259          case R_CLIENT:
 260             if ((res = (URES *)GetResWithName(R_CLIENT, res_all.res_dir.hdr.name)) == NULL) {
 261                Emsg1(M_ABORT, 0, "Cannot find Client resource %s\n", res_all.res_dir.hdr.name);
 262             }
 263             res->res_client.messages = res_all.res_client.messages;
 264             break;
 265          default:
 266             Emsg1(M_ERROR, 0, _("Unknown resource type %d\n"), type);
 267             error = 1;
 268             break;
 269       }
 270       /* Note, the resoure name was already saved during pass 1,
 271        * so here, we can just release it.
 272        */
 273       if (res_all.res_dir.hdr.name) {
 274          free(res_all.res_dir.hdr.name);
 275          res_all.res_dir.hdr.name = NULL;
 276       }
 277       if (res_all.res_dir.hdr.desc) {
 278          free(res_all.res_dir.hdr.desc);
 279          res_all.res_dir.hdr.desc = NULL;
 280       }
 281       return;
 282    }
 283
 284    /* The following code is only executed on pass 1 */
 285    switch (type) {
 286       case R_DIRECTOR:
 287          size = sizeof(DIRRES);
 288          break;
 289       case R_CLIENT:
 290          size = sizeof(CLIENT);
 291          break;
 292       case R_MSGS:
 293          size = sizeof(MSGS);
 294          break;
 295       default:
 296          printf(_("Unknown resource type %d\n"), type);
 297          error = 1;
 298          size = 1;
 299          break;
 300    }
 301    /* Common */
 302    if (!error) {
 303       res = (URES *)malloc(size);
 304       memcpy(res, &res_all, size);
 305       if (!resources[rindex].res_head) {
 306          resources[rindex].res_head = (RES *)res; /* store first entry */
 307       } else {
 308          RES *next;
 309          /* Add new res to end of chain */
 310          for (next=resources[rindex].res_head; next->next; next=next->next)
 311             { }
 312          next->next = (RES *)res;
 313          Dmsg2(90, "Inserting %s res: %s\n", res_to_str(type),
 314                res->res_dir.hdr.name);
 315       }
 316    }
 317 }