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) 2000-2003 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;
  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    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;
 126    return 1;
 127 }
 128
 129
 130 struct s_built_in_vars {char *var_name; int code; int (*func)(JCR *jcr, int code,
 131                          const char **val_ptr, int *val_len, int *val_size);};
 132
 133 static struct s_built_in_vars built_in_vars[] = {
 134    { N_("Year"),       1, date_item},
 135    { N_("Month"),      2, date_item},
 136    { N_("Day"),        3, date_item},
 137    { N_("Hour"),       4, date_item},
 138    { N_("Minute"),     5, date_item},
 139    { N_("Second"),     6, date_item},
 140    { N_("WeekDay"),    7, date_item},
 141
 142    { N_("Job"),        1, job_item},
 143    { N_("Dir"),        2, job_item},
 144    { N_("Level"),      3, job_item},
 145    { N_("Type"),       4, job_item},
 146    { N_("JobId"),      5, job_item},
 147    { N_("Client"),     6, job_item},
 148    { N_("NumVols"),    7, job_item},
 149    { N_("Pool"),       8, job_item},
 150    { N_("Storage"),    9, job_item},
 151    { N_("Catalog"),   10, job_item},
 152    { N_("MediaType"), 11, job_item},
 153    { N_("JobName"),   12, job_item},
 154
 155    { NULL, 0, NULL}
 156 };
 157
 158
 159 static var_rc_t lookup_built_in_var(var_t *ctx, void *my_ctx,
 160           const char *var_ptr, int var_len, int var_index,
 161           const char **val_ptr, int *val_len, int *val_size)
 162 {
 163    JCR *jcr = (JCR *)my_ctx;
 164    int stat;
 165
 166    for (int i=0; _(built_in_vars[i].var_name); i++) {
 167       if (strncmp(_(built_in_vars[i].var_name), var_ptr, var_len) == 0) {
 168          stat = (*built_in_vars[i].func)(jcr, built_in_vars[i].code,
 169             val_ptr, val_len, val_size);
 170          if (stat) {
 171             return VAR_OK;
 172          }
 173          break;
 174       }
 175    }
 176    return VAR_ERR_UNDEFINED_VARIABLE;
 177 }
 178
 179
 180 /*
 181  * Search counter variables
 182  */
 183 static var_rc_t lookup_counter_var(var_t *ctx, void *my_ctx,
 184           const char *var_ptr, int var_len, int var_inc, int var_index,
 185           const char **val_ptr, int *val_len, int *val_size)
 186 {
 187    char buf[MAXSTRING];
 188    var_rc_t stat = VAR_ERR_UNDEFINED_VARIABLE;
 189
 190    if (var_len > (int)sizeof(buf) - 1) {
 191        return VAR_ERR_OUT_OF_MEMORY;
 192    }
 193    memcpy(buf, var_ptr, var_len);
 194    buf[var_len] = 0;
 195    LockRes();
 196    for (COUNTER *counter=NULL; (counter = (COUNTER *)GetNextRes(R_COUNTER, (RES *)counter)); ) {
 197       if (strcmp(counter->hdr.name, buf) == 0) {
 198          bsnprintf(buf, sizeof(buf), "%d", counter->CurrentValue);
 199          *val_ptr = bstrdup(buf);
 200          *val_len = strlen(buf);
 201          *val_size = *val_len;
 202          if (var_inc) {
 203             COUNTER_DBR cr;
 204             JCR *jcr = (JCR *)my_ctx;
 205             memset(&cr, 0, sizeof(cr));
 206             bstrncpy(cr.Counter, counter->hdr.name, sizeof(cr.Counter));
 207             cr.MinValue = counter->MinValue;
 208             cr.MaxValue = counter->MaxValue;
 209             if (counter->CurrentValue == counter->MaxValue) {
 210                counter->CurrentValue = counter->MinValue;
 211             } else {
 212                counter->CurrentValue++;
 213             }
 214             cr.CurrentValue = counter->CurrentValue;
 215             bstrncpy(cr.WrapCounter, counter->WrapCounter->hdr.name, sizeof(cr.WrapCounter));
 216             if (!db_update_counter_record(jcr, jcr->db, &cr)) {
 217                Jmsg(jcr, M_ERROR, 0, _("Count not update counter %s: ERR=%s\n"),
 218                   counter->hdr.name, db_strerror(jcr->db));
 219             }
 220          }
 221          stat = VAR_OK;
 222          break;
 223       }
 224    }
 225    UnlockRes();
 226    return stat;
 227 }
 228
 229
 230 /*
 231  * Called here to look up a variable
 232  */
 233 static var_rc_t lookup_var(var_t *ctx, void *my_ctx,
 234           const char *var_ptr, int var_len, int var_inc, int var_index,
 235           const char **val_ptr, int *val_len, int *val_size)
 236 {
 237    char buf[MAXSTRING], *val, *p, *v;
 238    var_rc_t stat;
 239    int count;
 240
 241    if ((stat = lookup_built_in_var(ctx, my_ctx, var_ptr, var_len, var_index,
 242         val_ptr, val_len, val_size)) == VAR_OK) {
 243       return VAR_OK;
 244    }
 245
 246    if ((stat = lookup_counter_var(ctx, my_ctx, var_ptr, var_len, var_inc, var_index,
 247         val_ptr, val_len, val_size)) == VAR_OK) {
 248       return VAR_OK;
 249    }
 250
 251    /* Look in environment */
 252    if (var_len > (int)sizeof(buf) - 1) {
 253        return VAR_ERR_OUT_OF_MEMORY;
 254    }
 255    memcpy(buf, var_ptr, var_len + 1);
 256    buf[var_len] = 0;
 257 // Dmsg1(000, "Var=%s\n", buf);
 258
 259    if ((val = getenv(buf)) == NULL) {
 260        return VAR_ERR_UNDEFINED_VARIABLE;
 261    }
 262    if (var_index == 0) {
 263       *val_ptr = val;
 264       *val_len = strlen(val);
 265       *val_size = 0;
 266       return VAR_OK;
 267    }
 268    /* He wants to index the "array" */
 269    count = 0;
 270    /* Find the size of the "array"
 271     *   each element is separated by a |
 272     */
 273    for (p = val; *p; p++) {
 274       if (*p == '|') {
 275          count++;
 276       }
 277    }
 278    count++;
 279 // Dmsg3(000, "For %s, reqest index=%d have=%d\n",
 280 //    buf, var_index, count);
 281    if (var_index < 0 || var_index > count) {
 282       return VAR_ERR_SUBMATCH_OUT_OF_RANGE;
 283    }
 284    /* Now find the particular item (var_index) he wants */
 285    count = 1;
 286    for (p=val; *p; ) {
 287       if (*p == '|') {
 288          if (count < var_index) {
 289             val = ++p;
 290             count++;
 291             continue;
 292          }
 293          break;
 294       }
 295       p++;
 296    }
 297    if (p-val > (int)sizeof(buf) - 1) {
 298        return VAR_ERR_OUT_OF_MEMORY;
 299    }
 300 // Dmsg2(000, "val=%s len=%d\n", val, p-val);
 301    /* Make a copy of item, and pass it back */
 302    v = (char *)malloc(p-val+1);
 303    memcpy(v, val, p-val);
 304    v[p-val] = 0;
 305    *val_ptr = v;
 306    *val_len = p-val;
 307    *val_size = p-val;
 308 // Dmsg1(000, "v=%s\n", v);
 309    return VAR_OK;
 310 }
 311
 312 /*
 313  * Called here to do a special operation on a variable
 314  *   op_ptr  points to the special operation code (not EOS terminated)
 315  *   arg_ptr points to argument to special op code
 316  *   val_ptr points to the value string
 317  *   out_ptr points to string to be returned
 318  */
 319 static var_rc_t operate_var(var_t *var, void *my_ctx,
 320           const char *op_ptr, int op_len,
 321           const char *arg_ptr, int arg_len,
 322           const char *val_ptr, int val_len,
 323           char **out_ptr, int *out_len, int *out_size)
 324 {
 325    var_rc_t stat = VAR_ERR_UNDEFINED_OPERATION;
 326 // Dmsg0(000, "Enter operate_var\n");
 327    if (!val_ptr) {
 328       *out_size = 0;
 329       return stat;
 330    }
 331    if (op_len == 3 && strncmp(op_ptr, "inc", 3) == 0) {
 332       char buf[MAXSTRING];
 333       if (val_len > (int)sizeof(buf) - 1) {
 334           return VAR_ERR_OUT_OF_MEMORY;
 335       }
 336       memcpy(buf, arg_ptr, arg_len);
 337       buf[arg_len] = 0;
 338 //    Dmsg1(000, "Arg=%s\n", buf);
 339       memcpy(buf, val_ptr, val_len);
 340       buf[val_len] = 0;
 341 //    Dmsg1(000, "Val=%s\n", buf);
 342       LockRes();
 343       for (COUNTER *counter=NULL; (counter = (COUNTER *)GetNextRes(R_COUNTER, (RES *)counter)); ) {
 344          if (strcmp(counter->hdr.name, buf) == 0) {
 345 //          Dmsg2(000, "counter=%s val=%s\n", counter->hdr.name, buf);
 346             break;
 347          }
 348       }
 349       UnlockRes();
 350       return stat;
 351    }
 352    *out_size = 0;
 353    return stat;
 354 }
 355
 356
 357 /*
 358  * Expand an input line and return it.
 359  *
 360  *  Returns: 0 on failure
 361  *           1 on success and exp has expanded input
 362  */
 363 int variable_expansion(JCR *jcr, char *inp, POOLMEM **exp)
 364 {
 365    var_t *var_ctx;
 366    var_rc_t stat;
 367    char *outp;
 368    int in_len, out_len;
 369    int rtn_stat = 0;
 370
 371    in_len = strlen(inp);
 372    outp = NULL;
 373    out_len = 0;
 374
 375    /* create context */
 376    if ((stat = var_create(&var_ctx)) != VAR_OK) {
 377        Jmsg(jcr, M_ERROR, 0, _("Cannot create var context: ERR=%s\n"), var_strerror(var_ctx, stat));
 378        goto bail_out;
 379    }
 380    /* define callback */
 381    if ((stat = var_config(var_ctx, VAR_CONFIG_CB_VALUE, lookup_var, (void *)jcr)) != VAR_OK) {
 382        Jmsg(jcr, M_ERROR, 0, _("Cannot set var callback: ERR=%s\n"), var_strerror(var_ctx, stat));
 383        goto bail_out;
 384    }
 385
 386    /* define special operations */
 387    if ((stat = var_config(var_ctx, VAR_CONFIG_CB_OPERATION, operate_var, (void *)jcr)) != VAR_OK) {
 388        Jmsg(jcr, M_ERROR, 0, _("Cannot set var operate: ERR=%s\n"), var_strerror(var_ctx, stat));
 389        goto bail_out;
 390    }
 391
 392    /* unescape in place */
 393    if ((stat = var_unescape(var_ctx, inp, in_len, inp, in_len+1, 0)) != VAR_OK) {
 394        Jmsg(jcr, M_ERROR, 0, _("Cannot unescape string: ERR=%s\n"), var_strerror(var_ctx, stat));
 395        goto bail_out;
 396    }
 397
 398    in_len = strlen(inp);
 399
 400    /* expand variables */
 401    if ((stat = var_expand(var_ctx, inp, in_len, &outp, &out_len, 1)) != VAR_OK) {
 402        Jmsg(jcr, M_ERROR, 0, _("Cannot expand LabelFormat \"%s\": ERR=%s\n"),
 403           inp, var_strerror(var_ctx, stat));
 404        goto bail_out;
 405    }
 406
 407    /* unescape once more in place */
 408    if ((stat = var_unescape(var_ctx, outp, out_len, outp, out_len+1, 1)) != VAR_OK) {
 409        Jmsg(jcr, M_ERROR, 0, _("Cannot unescape string: ERR=%s\n"), var_strerror(var_ctx, stat));
 410        goto bail_out;
 411    }
 412
 413    pm_strcpy(exp, outp);
 414
 415    rtn_stat = 1;
 416
 417 bail_out:
 418    /* destroy expansion context */
 419    if ((stat = var_destroy(var_ctx)) != VAR_OK) {
 420        Jmsg(jcr, M_ERROR, 0, _("Cannot destroy var context: ERR=%s\n"), var_strerror(var_ctx, stat));
 421    }
 422    if (outp) {
 423       free(outp);
 424    }
 425    return rtn_stat;
 426 }