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