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