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