git.sur5r.net Git - bacula/bacula/blob - bacula/src/dird/run_conf.c

   1 /*
   2  *
   3  *  Configuration parser for Director Run Configuration
   4  *   directives, which are part of the Schedule Resource
   5  *
   6  *     Kern Sibbald, May MM
   7  *
   8  *     Version $Id$
   9  */
  10 /*
  11    Copyright (C) 2000-2004 Kern Sibbald and John Walker
  12
  13    This program is free software; you can redistribute it and/or
  14    modify it under the terms of the GNU General Public License as
  15    published by the Free Software Foundation; either version 2 of
  16    the License, or (at your option) any later version.
  17
  18    This program is distributed in the hope that it will be useful,
  19    but WITHOUT ANY WARRANTY; without even the implied warranty of
  20    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  21    General Public License for more details.
  22
  23    You should have received a copy of the GNU General Public
  24    License along with this program; if not, write to the Free
  25    Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  26    MA 02111-1307, USA.
  27
  28  */
  29
  30 #include "bacula.h"
  31 #include "dird.h"
  32
  33 extern URES res_all;
  34 extern struct s_jl joblevels[];
  35
  36 /* Forward referenced subroutines */
  37
  38 enum e_state {
  39    s_none = 0,
  40    s_range,
  41    s_mday,
  42    s_month,
  43    s_time,
  44    s_at,
  45    s_wday,
  46    s_daily,
  47    s_weekly,
  48    s_monthly,
  49    s_hourly,
  50    s_wom,                           /* 1st, 2nd, ...*/
  51    s_woy                            /* week of year w00 - w53 */
  52 };
  53
  54 struct s_keyw {
  55   const char *name;                           /* keyword */
  56   enum e_state state;                 /* parser state */
  57   int code;                           /* state value */
  58 };
  59
  60 /* Keywords understood by parser */
  61 static struct s_keyw keyw[] = {
  62   {N_("on"),         s_none,    0},
  63   {N_("at"),         s_at,      0},
  64
  65   {N_("sun"),        s_wday,    0},
  66   {N_("mon"),        s_wday,    1},
  67   {N_("tue"),        s_wday,    2},
  68   {N_("wed"),        s_wday,    3},
  69   {N_("thu"),        s_wday,    4},
  70   {N_("fri"),        s_wday,    5},
  71   {N_("sat"),        s_wday,    6},
  72   {N_("jan"),        s_month,   0},
  73   {N_("feb"),        s_month,   1},
  74   {N_("mar"),        s_month,   2},
  75   {N_("apr"),        s_month,   3},
  76   {N_("may"),        s_month,   4},
  77   {N_("jun"),        s_month,   5},
  78   {N_("jul"),        s_month,   6},
  79   {N_("aug"),        s_month,   7},
  80   {N_("sep"),        s_month,   8},
  81   {N_("oct"),        s_month,   9},
  82   {N_("nov"),        s_month,  10},
  83   {N_("dec"),        s_month,  11},
  84
  85   {N_("sunday"),     s_wday,    0},
  86   {N_("monday"),     s_wday,    1},
  87   {N_("tuesday"),    s_wday,    2},
  88   {N_("wednesday"),  s_wday,    3},
  89   {N_("thursday"),   s_wday,    4},
  90   {N_("friday"),     s_wday,    5},
  91   {N_("saturday"),   s_wday,    6},
  92   {N_("january"),    s_month,   0},
  93   {N_("february"),   s_month,   1},
  94   {N_("march"),      s_month,   2},
  95   {N_("april"),      s_month,   3},
  96   {N_("june"),       s_month,   5},
  97   {N_("july"),       s_month,   6},
  98   {N_("august"),     s_month,   7},
  99   {N_("september"),  s_month,   8},
 100   {N_("october"),    s_month,   9},
 101   {N_("november"),   s_month,  10},
 102   {N_("december"),   s_month,  11},
 103
 104   {N_("daily"),      s_daily,   0},
 105   {N_("weekly"),     s_weekly,  0},
 106   {N_("monthly"),    s_monthly, 0},
 107   {N_("hourly"),     s_hourly,  0},
 108
 109   {N_("1st"),        s_wom,     0},
 110   {N_("2nd"),        s_wom,     1},
 111   {N_("3rd"),        s_wom,     2},
 112   {N_("4th"),        s_wom,     3},
 113   {N_("5th"),        s_wom,     4},
 114
 115   {N_("first"),      s_wom,     0},
 116   {N_("second"),     s_wom,     1},
 117   {N_("third"),      s_wom,     2},
 118   {N_("fourth"),     s_wom,     3},
 119   {N_("fifth"),      s_wom,     4},
 120   {NULL,         s_none,    0}
 121 };
 122
 123 static bool have_hour, have_mday, have_wday, have_month, have_wom;
 124 static bool have_at, have_woy;
 125 static RUN lrun;
 126
 127 static void set_defaults()
 128 {
 129    have_hour = have_mday = have_wday = have_month = have_wom = have_woy = false;
 130    have_at = false;
 131    set_bits(0, 23, lrun.hour);
 132    set_bits(0, 30, lrun.mday);
 133    set_bits(0, 6,  lrun.wday);
 134    set_bits(0, 11, lrun.month);
 135    set_bits(0, 4,  lrun.wom);
 136    set_bits(0, 53, lrun.woy);
 137 }
 138
 139
 140 /* Keywords (RHS) permitted in Run records */
 141 static struct s_kw RunFields[] = {
 142    {"pool",             'P'},
 143    {"fullpool",         'f'},
 144    {"incrementalpool",  'i'},
 145    {"differentialpool", 'd'},
 146    {"level",            'L'},
 147    {"storage",          'S'},
 148    {"messages",         'M'},
 149    {"priority",         'p'},
 150    {"spooldata",        's'},
 151    {NULL,                 0}
 152 };
 153
 154 /*
 155  * Store Schedule Run information
 156  *
 157  * Parse Run statement:
 158  *
 159  *  Run <keyword=value ...> [on] 2 january at 23:45
 160  *
 161  *   Default Run time is daily at 0:0
 162  *
 163  *   There can be multiple run statements, they are simply chained
 164  *   together.
 165  *
 166  */
 167 void store_run(LEX *lc, RES_ITEM *item, int index, int pass)
 168 {
 169    int i, j;
 170    bool found;
 171    int token, state, state2 = 0, code = 0, code2 = 0;
 172    int options = lc->options;
 173    RUN **run = (RUN **)(item->value);
 174    RUN *trun;
 175    char *p;
 176    RES *res;
 177
 178
 179    lc->options |= LOPT_NO_IDENT;      /* want only "strings" */
 180
 181    /* clear local copy of run record */
 182    memset(&lrun, 0, sizeof(RUN));
 183
 184    /* scan for Job level "full", "incremental", ... */
 185    for (found=true; found; ) {
 186       found = false;
 187       token = lex_get_token(lc, T_NAME);
 188       for (i=0; RunFields[i].name; i++) {
 189          if (strcasecmp(lc->str, RunFields[i].name) == 0) {
 190             found = true;
 191             if (lex_get_token(lc, T_ALL) != T_EQUALS) {
 192                scan_err1(lc, "Expected an equals, got: %s", lc->str);
 193                /* NOT REACHED */
 194             }
 195             switch (RunFields[i].token) {
 196             case 's':                 /* Data spooling */
 197                token = lex_get_token(lc, T_NAME);
 198                if (strcasecmp(lc->str, "yes") == 0) {
 199                   lrun.spool_data = true;
 200                   lrun.spool_data_set = true;
 201                } else if (strcasecmp(lc->str, "no") == 0) {
 202                   lrun.spool_data = false;
 203                   lrun.spool_data_set = true;
 204                } else {
 205                   scan_err1(lc, _("Expect a YES or NO, got: %s"), lc->str);
 206                }
 207                break;
 208             case 'L':                 /* level */
 209                token = lex_get_token(lc, T_NAME);
 210                for (j=0; joblevels[j].level_name; j++) {
 211                   if (strcasecmp(lc->str, joblevels[j].level_name) == 0) {
 212                      lrun.level = joblevels[j].level;
 213                      lrun.job_type = joblevels[j].job_type;
 214                      j = 0;
 215                      break;
 216                   }
 217                }
 218                if (j != 0) {
 219                   scan_err1(lc, _("Job level field: %s not found in run record"), lc->str);
 220                   /* NOT REACHED */
 221                }
 222                break;
 223             case 'p':                 /* Priority */
 224                token = lex_get_token(lc, T_PINT32);
 225                if (pass == 2) {
 226                   lrun.Priority = lc->pint32_val;
 227                }
 228                break;
 229             case 'P':                 /* Pool */
 230             case 'f':                 /* FullPool */
 231             case 'i':                 /* IncPool */
 232             case 'd':                 /* DifPool */
 233                token = lex_get_token(lc, T_NAME);
 234                if (pass == 2) {
 235                   res = GetResWithName(R_POOL, lc->str);
 236                   if (res == NULL) {
 237                      scan_err1(lc, "Could not find specified Pool Resource: %s",
 238                                 lc->str);
 239                      /* NOT REACHED */
 240                   }
 241                   switch(RunFields[i].token) {
 242                   case 'P':
 243                      lrun.pool = (POOL *)res;
 244                      break;
 245                   case 'f':
 246                      lrun.full_pool = (POOL *)res;
 247                      break;
 248                   case 'i':
 249                      lrun.inc_pool = (POOL *)res;
 250                      break;
 251                   case 'd':
 252                      lrun.dif_pool = (POOL *)res;
 253                      break;
 254                   }
 255                }
 256                break;
 257             case 'S':                 /* storage */
 258                token = lex_get_token(lc, T_NAME);
 259                if (pass == 2) {
 260                   res = GetResWithName(R_STORAGE, lc->str);
 261                   if (res == NULL) {
 262                      scan_err1(lc, "Could not find specified Storage Resource: %s",
 263                                 lc->str);
 264                      /* NOT REACHED */
 265                   }
 266                   lrun.storage = (STORE *)res;
 267                }
 268                break;
 269             case 'M':                 /* messages */
 270                token = lex_get_token(lc, T_NAME);
 271                if (pass == 2) {
 272                   res = GetResWithName(R_MSGS, lc->str);
 273                   if (res == NULL) {
 274                      scan_err1(lc, "Could not find specified Messages Resource: %s",
 275                                 lc->str);
 276                      /* NOT REACHED */
 277                   }
 278                   lrun.msgs = (MSGS *)res;
 279                }
 280                break;
 281             default:
 282                scan_err1(lc, "Expected a keyword name, got: %s", lc->str);
 283                /* NOT REACHED */
 284                break;
 285             } /* end switch */
 286          } /* end if strcasecmp */
 287       } /* end for RunFields */
 288
 289       /* At this point, it is not a keyword. Check for old syle
 290        * Job Levels without keyword. This form is depreciated!!!
 291        */
 292       for (j=0; joblevels[j].level_name; j++) {
 293          if (strcasecmp(lc->str, joblevels[j].level_name) == 0) {
 294             lrun.level = joblevels[j].level;
 295             lrun.job_type = joblevels[j].job_type;
 296             found = true;
 297             break;
 298          }
 299       }
 300    } /* end for found */
 301
 302
 303    /*
 304     * Scan schedule times.
 305     * Default is: daily at 0:0
 306     */
 307    state = s_none;
 308    set_defaults();
 309
 310    for ( ; token != T_EOL; (token = lex_get_token(lc, T_ALL))) {
 311       int len, pm = 0;
 312       switch (token) {
 313       case T_NUMBER:
 314          state = s_mday;
 315          code = atoi(lc->str) - 1;
 316          if (code < 0 || code > 30) {
 317             scan_err0(lc, _("Day number out of range (1-31)"));
 318          }
 319          break;
 320       case T_NAME:                 /* this handles drop through from keyword */
 321       case T_UNQUOTED_STRING:
 322          if (strchr(lc->str, (int)'-')) {
 323             state = s_range;
 324             break;
 325          }
 326          if (strchr(lc->str, (int)':')) {
 327             state = s_time;
 328             break;
 329          }
 330          if (lc->str_len == 3 && (lc->str[0] == 'w' || lc->str[0] == 'W') &&
 331              is_an_integer(lc->str+1)) {
 332             code = atoi(lc->str+1);
 333             if (code < 0 || code > 53) {
 334                scan_err0(lc, _("Week number out of range (0-53)"));
 335             }
 336             state = s_woy;            /* week of year */
 337             break;
 338          }
 339          /* everything else must be a keyword */
 340          for (i=0; keyw[i].name; i++) {
 341             if (strcasecmp(lc->str, keyw[i].name) == 0) {
 342                state = keyw[i].state;
 343                code   = keyw[i].code;
 344                i = 0;
 345                break;
 346             }
 347          }
 348          if (i != 0) {
 349             scan_err1(lc, _("Job type field: %s in run record not found"), lc->str);
 350             /* NOT REACHED */
 351          }
 352          break;
 353       case T_COMMA:
 354          continue;
 355       default:
 356          scan_err2(lc, _("Unexpected token: %d:%s"), token, lc->str);
 357          /* NOT REACHED */
 358          break;
 359       }
 360       switch (state) {
 361       case s_none:
 362          continue;
 363       case s_mday:                 /* day of month */
 364          if (!have_mday) {
 365             clear_bits(0, 30, lrun.mday);
 366             have_mday = true;
 367          }
 368          set_bit(code, lrun.mday);
 369          break;
 370       case s_month:                /* month of year */
 371          if (!have_month) {
 372             clear_bits(0, 11, lrun.month);
 373             have_month = true;
 374          }
 375          set_bit(code, lrun.month);
 376          break;
 377       case s_wday:                 /* week day */
 378          if (!have_wday) {
 379             clear_bits(0, 6, lrun.wday);
 380             have_wday = true;
 381          }
 382          set_bit(code, lrun.wday);
 383          break;
 384       case s_wom:                  /* Week of month 1st, ... */
 385          if (!have_wom) {
 386             clear_bits(0, 4, lrun.wom);
 387             have_wom = true;
 388          }
 389          set_bit(code, lrun.wom);
 390          break;
 391       case s_woy:
 392          if (!have_woy) {
 393             clear_bits(0, 53, lrun.woy);
 394             have_woy = true;
 395          }
 396          set_bit(code, lrun.woy);
 397          break;
 398       case s_time:                 /* time */
 399          if (!have_at) {
 400             scan_err0(lc, _("Time must be preceded by keyword AT."));
 401             /* NOT REACHED */
 402          }
 403          if (!have_hour) {
 404             clear_bits(0, 23, lrun.hour);
 405          }
 406          p = strchr(lc->str, ':');
 407          if (!p)  {
 408             scan_err0(lc, _("Time logic error.\n"));
 409             /* NOT REACHED */
 410          }
 411          *p++ = 0;                 /* separate two halves */
 412          code = atoi(lc->str);
 413          len = strlen(p);
 414          if (len > 2 && p[len-1] == 'm') {
 415             if (p[len-2] == 'a') {
 416                pm = 0;
 417             } else if (p[len-2] == 'p') {
 418                pm = 1;
 419             } else {
 420                scan_err0(lc, _("Bad time specification."));
 421                /* NOT REACHED */
 422             }
 423          } else {
 424             pm = 0;
 425          }
 426          code2 = atoi(p);
 427          if (pm) {
 428             code += 12;
 429          }
 430          if (code < 0 || code > 23 || code2 < 0 || code2 > 59) {
 431             scan_err0(lc, _("Bad time specification."));
 432             /* NOT REACHED */
 433          }
 434          /****FIXME**** convert to UTC */
 435          set_bit(code, lrun.hour);
 436          lrun.minute = code2;
 437          have_hour = true;
 438          break;
 439       case s_at:
 440          have_at = true;
 441          break;
 442       case s_range:
 443          p = strchr(lc->str, '-');
 444          if (!p) {
 445             scan_err0(lc, _("Range logic error.\n"));
 446          }
 447          *p++ = 0;                 /* separate two halves */
 448
 449          /* Check for day range */
 450          if (is_an_integer(lc->str) && is_an_integer(p)) {
 451             code = atoi(lc->str) - 1;
 452             code2 = atoi(p) - 1;
 453             if (code < 0 || code > 30 || code2 < 0 || code2 > 30) {
 454                scan_err0(lc, _("Bad day range specification."));
 455             }
 456             if (!have_mday) {
 457                clear_bits(0, 30, lrun.mday);
 458                have_mday = true;
 459             }
 460             if (code < code2) {
 461                set_bits(code, code2, lrun.mday);
 462             } else {
 463                set_bits(code, 30, lrun.mday);
 464                set_bits(0, code2, lrun.mday);
 465             }
 466             break;
 467          }
 468          /* Check for week of year range */
 469          if (strlen(lc->str) == 3 && strlen(p) == 3 &&
 470              (lc->str[0] == 'w' || lc->str[0] == 'W') &&
 471              (p[0] == 'w' || p[0] == 'W') &&
 472              is_an_integer(lc->str+1) && is_an_integer(p+1)) {
 473             code = atoi(lc->str+1);
 474             code2 = atoi(p+1);
 475             if (code < 0 || code > 53 || code2 < 0 || code2 > 53) {
 476                scan_err0(lc, _("Week number out of range (0-53)"));
 477             }
 478             if (!have_woy) {
 479                clear_bits(0, 53, lrun.woy);
 480                have_woy = true;
 481             }
 482             if (code < code2) {
 483                set_bits(code, code2, lrun.woy);
 484             } else {
 485                set_bits(code, 53, lrun.woy);
 486                set_bits(0, code2, lrun.woy);
 487             }
 488             break;
 489          }
 490          /* lookup first half of keyword range (week days or months) */
 491          lcase(lc->str);
 492          for (i=0; keyw[i].name; i++) {
 493             if (strcmp(lc->str, keyw[i].name) == 0) {
 494                state = keyw[i].state;
 495                code   = keyw[i].code;
 496                i = 0;
 497                break;
 498             }
 499          }
 500          if (i != 0 || (state != s_month && state != s_wday && state != s_wom)) {
 501             scan_err0(lc, _("Invalid month, week or position day range"));
 502             /* NOT REACHED */
 503          }
 504
 505          /* Lookup end of range */
 506          lcase(p);
 507          for (i=0; keyw[i].name; i++) {
 508             if (strcmp(p, keyw[i].name) == 0) {
 509                state2  = keyw[i].state;
 510                code2   = keyw[i].code;
 511                i = 0;
 512                break;
 513             }
 514          }
 515          if (i != 0 || state != state2 || code == code2) {
 516             scan_err0(lc, _("Invalid month, weekday or position range"));
 517             /* NOT REACHED */
 518          }
 519          if (state == s_wday) {
 520             if (!have_wday) {
 521                clear_bits(0, 6, lrun.wday);
 522                have_wday = true;
 523             }
 524             if (code < code2) {
 525                set_bits(code, code2, lrun.wday);
 526             } else {
 527                set_bits(code, 6, lrun.wday);
 528                set_bits(0, code2, lrun.wday);
 529             }
 530          } else if (state == s_month) {
 531             if (!have_month) {
 532                clear_bits(0, 11, lrun.month);
 533                have_month = true;
 534             }
 535             if (code < code2) {
 536                set_bits(code, code2, lrun.month);
 537             } else {
 538                /* this is a bit odd, but we accept it anyway */
 539                set_bits(code, 11, lrun.month);
 540                set_bits(0, code2, lrun.month);
 541             }
 542          } else {
 543             /* Must be position */
 544             if (!have_wom) {
 545                clear_bits(0, 4, lrun.wom);
 546                have_wom = true;
 547             }
 548             if (code < code2) {
 549                set_bits(code, code2, lrun.wom);
 550             } else {
 551                set_bits(code, 4, lrun.wom);
 552                set_bits(0, code2, lrun.wom);
 553             }
 554          }
 555          break;
 556       case s_hourly:
 557          have_hour = true;
 558          set_bits(0, 23, lrun.hour);
 559          break;
 560       case s_weekly:
 561          have_mday = have_wom = have_woy = true;
 562          set_bits(0, 30, lrun.mday);
 563          set_bits(0, 4,  lrun.wom);
 564          set_bits(0, 53, lrun.woy);
 565          break;
 566       case s_daily:
 567          have_mday = true;
 568          set_bits(0, 6, lrun.wday);
 569          break;
 570       case s_monthly:
 571          have_month = true;
 572          set_bits(0, 11, lrun.month);
 573          break;
 574       default:
 575          scan_err0(lc, _("Unexpected run state\n"));
 576          /* NOT REACHED */
 577          break;
 578       }
 579    }
 580
 581    /* Allocate run record, copy new stuff into it,
 582     * and link it into the list of run records
 583     * in the schedule resource.
 584     */
 585    if (pass == 2) {
 586       trun = (RUN *)malloc(sizeof(RUN));
 587       memcpy(trun, &lrun, sizeof(RUN));
 588       if (*run) {
 589          trun->next = *run;
 590       }
 591       *run = trun;
 592    }
 593
 594    lc->options = options;             /* restore scanner options */
 595    set_bit(index, res_all.res_sch.hdr.item_present);
 596 }