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