3 * Bacula Director -- expand.c -- does variable expansion
4 * in particular for the LabelFormat specification.
6 * Kern Sibbald, June MMIII
11 Copyright (C) 2000-2003 Kern Sibbald and John Walker
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.
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.
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,
35 static int date_item(JCR *jcr, int code,
36 const char **val_ptr, int *val_len, int *val_size)
39 time_t now = time(NULL);
40 localtime_r(&now, &tm);
46 val = tm.tm_year + 1900;
63 case 7: /* Week day */
67 bsnprintf(buf, sizeof(buf), "%d", val);
68 *val_ptr = bstrdup(buf);
69 *val_len = strlen(buf);
74 static int job_item(JCR *jcr, int code,
75 const char **val_ptr, int *val_len, int *val_size)
82 str = jcr->job->hdr.name;
84 case 2: /* Director's name */
88 str = job_level_to_str(jcr->JobLevel);
91 str = job_type_to_str(jcr->JobType);
94 bsnprintf(buf, sizeof(buf), "%d", jcr->JobId);
98 str = jcr->client->hdr.name;
103 case 7: /* NumVols */
104 bsnprintf(buf, sizeof(buf), "%d", jcr->NumVols);
108 str = jcr->pool->hdr.name;
110 case 9: /* Storage */
111 str = jcr->store->hdr.name;
113 case 10: /* Catalog */
114 str = jcr->catalog->hdr.name;
116 case 11: /* MediaType */
117 str = jcr->store->media_type;
119 case 12: /* JobName */
123 *val_ptr = bstrdup(str);
124 *val_len = strlen(str);
125 *val_size = *val_len;
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);};
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},
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},
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)
163 JCR *jcr = (JCR *)my_ctx;
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);
176 return VAR_ERR_UNDEFINED_VARIABLE;
181 * Search counter variables
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)
188 var_rc_t stat = VAR_ERR_UNDEFINED_VARIABLE;
190 if (var_len > (int)sizeof(buf) - 1) {
191 return VAR_ERR_OUT_OF_MEMORY;
193 memcpy(buf, var_ptr, var_len);
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;
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;
212 counter->CurrentValue++;
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));
231 * Called here to look up a variable
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)
237 char buf[MAXSTRING], *val, *p, *v;
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) {
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) {
251 /* Look in environment */
252 if (var_len > (int)sizeof(buf) - 1) {
253 return VAR_ERR_OUT_OF_MEMORY;
255 memcpy(buf, var_ptr, var_len + 1);
257 // Dmsg1(000, "Var=%s\n", buf);
259 if ((val = getenv(buf)) == NULL) {
260 return VAR_ERR_UNDEFINED_VARIABLE;
262 if (var_index == 0) {
264 *val_len = strlen(val);
268 /* He wants to index the "array" */
270 /* Find the size of the "array"
271 * each element is separated by a |
273 for (p = val; *p; p++) {
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;
284 /* Now find the particular item (var_index) he wants */
288 if (count < var_index) {
297 if (p-val > (int)sizeof(buf) - 1) {
298 return VAR_ERR_OUT_OF_MEMORY;
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);
308 // Dmsg1(000, "v=%s\n", v);
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
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)
325 var_rc_t stat = VAR_ERR_UNDEFINED_OPERATION;
326 // Dmsg0(000, "Enter operate_var\n");
331 if (op_len == 3 && strncmp(op_ptr, "inc", 3) == 0) {
333 if (val_len > (int)sizeof(buf) - 1) {
334 return VAR_ERR_OUT_OF_MEMORY;
336 memcpy(buf, arg_ptr, arg_len);
338 // Dmsg1(000, "Arg=%s\n", buf);
339 memcpy(buf, val_ptr, val_len);
341 // Dmsg1(000, "Val=%s\n", buf);
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);
358 * Expand an input line and return it.
360 * Returns: 0 on failure
361 * 1 on success and exp has expanded input
363 int variable_expansion(JCR *jcr, char *inp, POOLMEM **exp)
371 in_len = strlen(inp);
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));
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));
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));
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));
398 in_len = strlen(inp);
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));
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));
413 pm_strcpy(exp, outp);
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));