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

   1 /*
   2  *
   3  *   Bacula Director -- expand.c -- does variable expansion
   4  *    in particular for the LabelFormat specification.
   5  *
   6  *     Kern Sibbald, June MMIII
   7  *
   8  *   Version $Id$
   9  */
  10 /*
  11    Copyright (C) 2003-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
  34
  35 static int date_item(JCR *jcr, int code,
  36               const char **val_ptr, int *val_len, int *val_size)
  37 {
  38    struct tm tm;
  39    time_t now = time(NULL);
  40    localtime_r(&now, &tm);
  41    int val = 0;
  42    char buf[10];
  43
  44    switch (code) {
  45    case 1:                            /* year */
  46       val = tm.tm_year + 1900;
  47       break;
  48    case 2:                            /* month */
  49       val = tm.tm_mon + 1;
  50       break;
  51    case 3:                            /* day */
  52       val = tm.tm_mday;
  53       break;
  54    case 4:                            /* hour */
  55       val = tm.tm_hour;
  56       break;
  57    case 5:                            /* minute */
  58       val = tm.tm_min;
  59       break;
  60    case 6:                            /* second */
  61       val = tm.tm_sec;
  62       break;
  63    case 7:                            /* Week day */
  64       val = tm.tm_wday;
  65       break;
  66    }
  67    bsnprintf(buf, sizeof(buf), "%d", val);
  68    *val_ptr = bstrdup(buf);
  69    *val_len = strlen(buf);
  70    *val_size = *val_len + 1;
  71    return 1;
  72 }
  73
  74 static int job_item(JCR *jcr, int code,
  75               const char **val_ptr, int *val_len, int *val_size)
  76 {
  77    const char *str = " ";
  78    char buf[20];
  79
  80    switch (code) {
  81    case 1:                            /* Job */
  82       str = jcr->job->hdr.name;
  83       break;
  84    case 2:                            /* Director's name */
  85       str = my_name;
  86       break;
  87    case 3:                            /* level */
  88       str = job_level_to_str(jcr->JobLevel);
  89       break;
  90    case 4:                            /* type */
  91       str = job_type_to_str(jcr->JobType);
  92       break;
  93    case 5:                            /* JobId */
  94       bsnprintf(buf, sizeof(buf), "%d", jcr->JobId);
  95       str = buf;
  96       break;
  97    case 6:                            /* Client */
  98       str = jcr->client->hdr.name;
  99       if (!str) {
 100          str = " ";
 101       }
 102       break;
 103    case 7:                            /* NumVols */
 104       bsnprintf(buf, sizeof(buf), "%d", jcr->NumVols);
 105       str = buf;
 106       break;
 107    case 8:                            /* Pool */
 108       str = jcr->pool->hdr.name;
 109       break;
 110    case 9:                            /* Storage */
 111       str = jcr->store->hdr.name;
 112       break;
 113    case 10:                           /* Catalog */
 114       str = jcr->catalog->hdr.name;
 115       break;
 116    case 11:                           /* MediaType */
 117       str = jcr->store->media_type;
 118       break;
 119    case 12:                           /* JobName */
 120       str = jcr->Job;
 121       break;
 122    }
 123    *val_ptr = bstrdup(str);
 124    *val_len = strlen(str);
 125    *val_size = *val_len + 1;
 126    return 1;
 127 }
 128
 129 struct s_built_in_vars {const char *var_name; int code; int (*func)(JCR *jcr, int code,
 130                          const char **val_ptr, int *val_len, int *val_size);};
 131
 132 /*
 133  * Table of build in variables
 134  */
 135 static struct s_built_in_vars built_in_vars[] = {
 136    { NT_("Year"),       1, date_item},
 137    { NT_("Month"),      2, date_item},
 138    { NT_("Day"),        3, date_item},
 139    { NT_("Hour"),       4, date_item},
 140    { NT_("Minute"),     5, date_item},
 141    { NT_("Second"),     6, date_item},
 142    { NT_("WeekDay"),    7, date_item},
 143
 144    { NT_("Job"),        1, job_item},
 145    { NT_("Dir"),        2, job_item},
 146    { NT_("Level"),      3, job_item},
 147    { NT_("Type"),       4, job_item},
 148    { NT_("JobId"),      5, job_item},
 149    { NT_("Client"),     6, job_item},
 150    { NT_("NumVols"),    7, job_item},
 151    { NT_("Pool"),       8, job_item},
 152    { NT_("Storage"),    9, job_item},
 153    { NT_("Catalog"),   10, job_item},
 154    { NT_("MediaType"), 11, job_item},
 155    { NT_("JobName"),   12, job_item},
 156
 157    { NULL, 0, NULL}
 158 };
 159
 160
 161 /*
 162  * Search the table of built-in variables, and if found,
 163  *   call the appropriate subroutine to do the work.
 164  */
 165 static var_rc_t lookup_built_in_var(var_t *ctx, void *my_ctx,
 166           const char *var_ptr, int var_len, int var_index,
 167           const char **val_ptr, int *val_len, int *val_size)
 168 {
 169    JCR *jcr = (JCR *)my_ctx;
 170    int stat;
 171
 172    for (int i=0; _(built_in_vars[i].var_name); i++) {
 173       if (strncmp(_(built_in_vars[i].var_name), var_ptr, var_len) == 0) {
 174          stat = (*built_in_vars[i].func)(jcr, built_in_vars[i].code,
 175             val_ptr, val_len, val_size);
 176          if (stat) {
 177             return VAR_OK;
 178          }
 179          break;
 180       }
 181    }
 182    return VAR_ERR_UNDEFINED_VARIABLE;
 183 }
 184
 185
 186 /*
 187  * Search counter variables
 188  */
 189 static var_rc_t lookup_counter_var(var_t *ctx, void *my_ctx,
 190           const char *var_ptr, int var_len, int var_inc, int var_index,
 191           const char **val_ptr, int *val_len, int *val_size)
 192 {
 193    char buf[MAXSTRING];
 194    var_rc_t stat = VAR_ERR_UNDEFINED_VARIABLE;
 195
 196    if (var_len > (int)sizeof(buf) - 1) {
 197        return VAR_ERR_OUT_OF_MEMORY;
 198    }
 199    memcpy(buf, var_ptr, var_len);
 200    buf[var_len] = 0;
 201    LockRes();
 202    for (COUNTER *counter=NULL; (counter = (COUNTER *)GetNextRes(R_COUNTER, (RES *)counter)); ) {
 203       if (strcmp(counter->hdr.name, buf) == 0) {
 204          Dmsg2(100, "Counter=%s val=%d\n", buf, counter->CurrentValue);
 205          /* -1 => return size of array */
 206         if (var_index == -1) {
 207             bsnprintf(buf, sizeof(buf), "%d", counter->CurrentValue);
 208             *val_len = bsnprintf(buf, sizeof(buf), "%d", strlen(buf));
 209             *val_ptr = buf;
 210             *val_size = 0;                  /* don't try to free val_ptr */
 211             return VAR_OK;
 212          } else {
 213             bsnprintf(buf, sizeof(buf), "%d", counter->CurrentValue);
 214             *val_ptr = bstrdup(buf);
 215             *val_len = strlen(buf);
 216             *val_size = *val_len + 1;
 217          }
 218          if (var_inc) {               /* increment the variable? */
 219             if (counter->CurrentValue == counter->MaxValue) {
 220                counter->CurrentValue = counter->MinValue;
 221             } else {
 222                counter->CurrentValue++;
 223             }
 224             if (counter->Catalog) {   /* update catalog if need be */
 225                COUNTER_DBR cr;
 226                JCR *jcr = (JCR *)my_ctx;
 227                memset(&cr, 0, sizeof(cr));
 228                bstrncpy(cr.Counter, counter->hdr.name, sizeof(cr.Counter));
 229                cr.MinValue = counter->MinValue;
 230                cr.MaxValue = counter->MaxValue;
 231                cr.CurrentValue = counter->CurrentValue;
 232                Dmsg1(100, "New value=%d\n", cr.CurrentValue);
 233                if (counter->WrapCounter) {
 234                   bstrncpy(cr.WrapCounter, counter->WrapCounter->hdr.name, sizeof(cr.WrapCounter));
 235                } else {
 236                   cr.WrapCounter[0] = 0;
 237                }
 238                if (!db_update_counter_record(jcr, jcr->db, &cr)) {
 239                   Jmsg(jcr, M_ERROR, 0, _("Count not update counter %s: ERR=%s\n"),
 240                      counter->hdr.name, db_strerror(jcr->db));
 241                }
 242             }
 243          }
 244          stat = VAR_OK;
 245          break;
 246       }
 247    }
 248    UnlockRes();
 249    return stat;
 250 }
 251
 252
 253 /*
 254  * Called here from "core" expand code to look up a variable
 255  */
 256 static var_rc_t lookup_var(var_t *ctx, void *my_ctx,
 257           const char *var_ptr, int var_len, int var_inc, int var_index,
 258           const char **val_ptr, int *val_len, int *val_size)
 259 {
 260    char buf[MAXSTRING], *val, *p, *v;
 261    var_rc_t stat;
 262    int count;
 263
 264    /* Note, if val_size > 0 and val_ptr!=NULL, the core code will free() it */
 265    if ((stat = lookup_built_in_var(ctx, my_ctx, var_ptr, var_len, var_index,
 266         val_ptr, val_len, val_size)) == VAR_OK) {
 267       return VAR_OK;
 268    }
 269
 270    if ((stat = lookup_counter_var(ctx, my_ctx, var_ptr, var_len, var_inc, var_index,
 271         val_ptr, val_len, val_size)) == VAR_OK) {
 272       return VAR_OK;
 273    }
 274
 275    /* Look in environment */
 276    if (var_len > (int)sizeof(buf) - 1) {
 277        return VAR_ERR_OUT_OF_MEMORY;
 278    }
 279    memcpy(buf, var_ptr, var_len + 1);
 280    buf[var_len] = 0;
 281    Dmsg1(100, "Var=%s\n", buf);
 282
 283    if ((val = getenv(buf)) == NULL) {
 284        return VAR_ERR_UNDEFINED_VARIABLE;
 285    }
 286    /* He wants to index the "array" */
 287    count = 1;
 288    /* Find the size of the "array"
 289     *   each element is separated by a |
 290     */
 291    for (p = val; *p; p++) {
 292       if (*p == '|') {
 293          count++;
 294       }
 295    }
 296    Dmsg3(100, "For %s, reqest index=%d have=%d\n",
 297       buf, var_index, count);
 298
 299    /* -1 => return size of array */
 300    if (var_index == -1) {
 301       int len;
 302       if (count == 1) {               /* if not array */
 303          len = strlen(val);           /* return length of string */
 304       } else {
 305          len = count;                 /* else return # array items */
 306       }
 307       *val_len = bsnprintf(buf, sizeof(buf), "%d", len);
 308       *val_ptr = buf;
 309       *val_size = 0;                  /* don't try to free val_ptr */
 310       return VAR_OK;
 311    }
 312
 313
 314    if (var_index < -1 || var_index > --count) {
 315 //    return VAR_ERR_SUBMATCH_OUT_OF_RANGE;
 316       return VAR_ERR_UNDEFINED_VARIABLE;
 317    }
 318    /* Now find the particular item (var_index) he wants */
 319    count = 0;
 320    for (p=val; *p; ) {
 321       if (*p == '|') {
 322          if (count < var_index) {
 323             val = ++p;
 324             count++;
 325             continue;
 326          }
 327          break;
 328       }
 329       p++;
 330    }
 331    if (p-val > (int)sizeof(buf) - 1) {
 332        return VAR_ERR_OUT_OF_MEMORY;
 333    }
 334    Dmsg2(100, "val=%s len=%d\n", val, p-val);
 335    /* Make a copy of item, and pass it back */
 336    v = (char *)malloc(p-val+1);
 337    memcpy(v, val, p-val);
 338    v[p-val] = 0;
 339    *val_ptr = v;
 340    *val_len = p-val;
 341    *val_size = p-val+1;
 342    Dmsg1(100, "v=%s\n", v);
 343    return VAR_OK;
 344 }
 345
 346 /*
 347  * Called here to do a special operation on a variable
 348  *   op_ptr  points to the special operation code (not EOS terminated)
 349  *   arg_ptr points to argument to special op code
 350  *   val_ptr points to the value string
 351  *   out_ptr points to string to be returned
 352  */
 353 static var_rc_t operate_var(var_t *var, void *my_ctx,
 354           const char *op_ptr, int op_len,
 355           const char *arg_ptr, int arg_len,
 356           const char *val_ptr, int val_len,
 357           char **out_ptr, int *out_len, int *out_size)
 358 {
 359    var_rc_t stat = VAR_ERR_UNDEFINED_OPERATION;
 360    Dmsg0(100, "Enter operate_var\n");
 361    if (!val_ptr) {
 362       *out_size = 0;
 363       return stat;
 364    }
 365    if (op_len == 3 && strncmp(op_ptr, "inc", 3) == 0) {
 366       char buf[MAXSTRING];
 367       if (val_len > (int)sizeof(buf) - 1) {
 368           return VAR_ERR_OUT_OF_MEMORY;
 369       }
 370       memcpy(buf, arg_ptr, arg_len);
 371       buf[arg_len] = 0;
 372       Dmsg1(100, "Arg=%s\n", buf);
 373       memcpy(buf, val_ptr, val_len);
 374       buf[val_len] = 0;
 375       Dmsg1(100, "Val=%s\n", buf);
 376       LockRes();
 377       for (COUNTER *counter=NULL; (counter = (COUNTER *)GetNextRes(R_COUNTER, (RES *)counter)); ) {
 378          if (strcmp(counter->hdr.name, buf) == 0) {
 379             Dmsg2(100, "counter=%s val=%s\n", counter->hdr.name, buf);
 380             break;
 381          }
 382       }
 383       UnlockRes();
 384       return stat;
 385    }
 386    *out_size = 0;
 387    return stat;
 388 }
 389
 390
 391 /*
 392  * Expand an input line and return it.
 393  *
 394  *  Returns: 0 on failure
 395  *           1 on success and exp has expanded input
 396  */
 397 int variable_expansion(JCR *jcr, char *inp, POOLMEM **exp)
 398 {
 399    var_t *var_ctx;
 400    var_rc_t stat;
 401    char *outp;
 402    int in_len, out_len;
 403    int rtn_stat = 0;
 404
 405    in_len = strlen(inp);
 406    outp = NULL;
 407    out_len = 0;
 408
 409    /* create context */
 410    if ((stat = var_create(&var_ctx)) != VAR_OK) {
 411        Jmsg(jcr, M_ERROR, 0, _("Cannot create var context: ERR=%s\n"), var_strerror(var_ctx, stat));
 412        goto bail_out;
 413    }
 414    /* define callback */
 415    if ((stat = var_config(var_ctx, VAR_CONFIG_CB_VALUE, lookup_var, (void *)jcr)) != VAR_OK) {
 416        Jmsg(jcr, M_ERROR, 0, _("Cannot set var callback: ERR=%s\n"), var_strerror(var_ctx, stat));
 417        goto bail_out;
 418    }
 419
 420    /* define special operations */
 421    if ((stat = var_config(var_ctx, VAR_CONFIG_CB_OPERATION, operate_var, (void *)jcr)) != VAR_OK) {
 422        Jmsg(jcr, M_ERROR, 0, _("Cannot set var operate: ERR=%s\n"), var_strerror(var_ctx, stat));
 423        goto bail_out;
 424    }
 425
 426    /* unescape in place */
 427    if ((stat = var_unescape(var_ctx, inp, in_len, inp, in_len+1, 0)) != VAR_OK) {
 428        Jmsg(jcr, M_ERROR, 0, _("Cannot unescape string: ERR=%s\n"), var_strerror(var_ctx, stat));
 429        goto bail_out;
 430    }
 431
 432    in_len = strlen(inp);
 433
 434    /* expand variables */
 435    if ((stat = var_expand(var_ctx, inp, in_len, &outp, &out_len, 0)) != VAR_OK) {
 436        Jmsg(jcr, M_ERROR, 0, _("Cannot expand expression \"%s\": ERR=%s\n"),
 437           inp, var_strerror(var_ctx, stat));
 438        goto bail_out;
 439    }
 440
 441    /* unescape once more in place */
 442    if ((stat = var_unescape(var_ctx, outp, out_len, outp, out_len+1, 1)) != VAR_OK) {
 443        Jmsg(jcr, M_ERROR, 0, _("Cannot unescape string: ERR=%s\n"), var_strerror(var_ctx, stat));
 444        goto bail_out;
 445    }
 446
 447    pm_strcpy(exp, outp);
 448
 449    rtn_stat = 1;
 450
 451 bail_out:
 452    /* destroy expansion context */
 453    if ((stat = var_destroy(var_ctx)) != VAR_OK) {
 454        Jmsg(jcr, M_ERROR, 0, _("Cannot destroy var context: ERR=%s\n"), var_strerror(var_ctx, stat));
 455    }
 456    if (outp) {
 457       free(outp);
 458    }
 459    return rtn_stat;
 460 }