1 /****************************************************************************
2 * RRDtool 1.2rc2 Copyright by Tobi Oetiker, 1997-2005
3 ****************************************************************************
4 * rrd_graph_helper.c commandline parser functions
5 * this code was probably writtenn by Alex van den Bogaerdt
6 ****************************************************************************/
8 #include "rrd_graph.h"
10 #define dprintf if (gdp->debug) printf
12 /* Define prototypes for the parsing methods.
13 Inputs:
14 char *line - pointer to base of input source
15 unsigned int eaten - index to next input character (INPUT/OUTPUT)
16 graph_desc_t *gdp - pointer to a graph description
17 image_desc_t *im - pointer to an image description
18 */
20 int rrd_parse_find_gf (char *, unsigned int *, graph_desc_t *);
21 int rrd_parse_legend (char *, unsigned int *, graph_desc_t *);
22 int rrd_parse_color (char *, graph_desc_t *);
23 int rrd_parse_CF (char *, unsigned int *, graph_desc_t *, enum cf_en *);
24 int rrd_parse_print (char *, unsigned int *, graph_desc_t *, image_desc_t *);
25 int rrd_parse_shift (char *, unsigned int *, graph_desc_t *, image_desc_t *);
26 int rrd_parse_xport (char *, unsigned int *, graph_desc_t *, image_desc_t *);
27 int rrd_parse_PVHLAST (char *, unsigned int *, graph_desc_t *, image_desc_t *);
28 int rrd_parse_vname (char *, unsigned int *, graph_desc_t *, image_desc_t *);
29 int rrd_parse_def (char *, unsigned int *, graph_desc_t *, image_desc_t *);
30 int rrd_parse_vdef (char *, unsigned int *, graph_desc_t *, image_desc_t *);
31 int rrd_parse_cdef (char *, unsigned int *, graph_desc_t *, image_desc_t *);
35 int
36 rrd_parse_find_gf(char *line, unsigned int *eaten, graph_desc_t *gdp) {
37 char funcname[11],c1=0,c2=0;
38 int i=0;
40 sscanf(&line[*eaten], "DEBUG%n", &i);
41 if (i) {
42 gdp->debug=1;
43 (*eaten)+=i;
44 i=0;
45 dprintf("Scanning line '%s'\n",&line[*eaten]);
46 }
47 sscanf(&line[*eaten], "%10[A-Z]%n%c%c", funcname, &i, &c1, &c2);
48 if (!i) {
49 rrd_set_error("Could not make sense out of '%s'",line);
50 return 1;
51 }
52 if ((int)(gdp->gf=gf_conv(funcname)) == -1) {
53 rrd_set_error("'%s' is not a valid function name", funcname);
54 return 1;
55 }
56 if (gdp->gf == GF_LINE) {
57 if (c1 < '1' || c1 > '3' || c2 != ':') {
58 rrd_set_error("Malformed LINE command: %s",line);
59 return 1;
60 }
61 gdp->linewidth=c1-'0';
62 i++;
63 } else {
64 if (c1 != ':') {
65 rrd_set_error("Malformed %s command: %s",funcname,line);
66 return 1;
67 }
68 }
69 *eaten+=++i;
70 return 0;
71 }
73 int
74 rrd_parse_legend(char *line, unsigned int *eaten, graph_desc_t *gdp) {
75 int i;
77 dprintf("- examining '%s'\n",&line[*eaten]);
79 i=scan_for_col(&line[*eaten],FMT_LEG_LEN,gdp->legend);
81 *eaten += i;
82 if (line[*eaten]!='\0' && line[*eaten]!=':') {
83 rrd_set_error("Legend too long");
84 return 1;
85 } else {
86 dprintf("- found legend '%s'\n", gdp->legend);
87 return 0;
88 }
89 }
91 int
92 rrd_parse_color(char *string, graph_desc_t *gdp) {
93 unsigned int r=0,g=0,b=0,a=0;
94 int i1=0,i2=0,i3=0;
96 if (string[0] != '#') return 1;
97 sscanf(string, "#%02x%02x%02x%n%02x%n%*s%n",
98 &r,&g,&b,&i1,&a,&i2,&i3);
100 if (i3) return 1; /* garbage after color */
101 if (!i2) a=0xFF;
102 if (!i1) return 1; /* no color after '#' */
103 gdp->col = r<<24|g<<16|b<<8|a;
104 return 0;
105 }
107 int
108 rrd_parse_CF(char *line, unsigned int *eaten, graph_desc_t *gdp, enum cf_en *cf) {
109 char symname[CF_NAM_SIZE];
110 int i=0;
112 sscanf(&line[*eaten], CF_NAM_FMT "%n", symname,&i);
113 if ((!i)||((line[*eaten+i]!='\0')&&(line[*eaten+i]!=':'))) {
114 rrd_set_error("Cannot parse CF in '%s'",line);
115 return 1;
116 }
117 (*eaten)+=i;
118 dprintf("- using CF '%s'\n",symname);
120 if ((int)(*cf = cf_conv(symname))==-1) {
121 rrd_set_error("Unknown CF '%s' in '%s'",symname,line);
122 return 1;
123 }
125 if (line[*eaten]!='\0') (*eaten)++;
126 return 0;
127 }
129 /* Parsing old-style xPRINT and new-style xPRINT */
130 int
131 rrd_parse_print(char *line, unsigned int *eaten, graph_desc_t *gdp, image_desc_t *im) {
132 /* vname:CF:format in case of DEF-based vname
133 ** vname:CF:format in case of CDEF-based vname
134 ** vname:format in case of VDEF-based vname
135 */
136 char tmpstr[MAX_VNAME_LEN+1];
137 int i=0;
139 sscanf(&line[*eaten], DEF_NAM_FMT ":%n", tmpstr,&i);
140 if (!i) {
141 rrd_set_error("Could not parse line '%s'",line);
142 return 1;
143 }
144 (*eaten)+=i;
145 dprintf("- Found candidate vname '%s'\n",tmpstr);
147 if ((gdp->vidx=find_var(im,tmpstr))<0) {
148 rrd_set_error("Not a valid vname: %s in line %s",tmpstr,line);
149 return 1;
150 }
151 switch (im->gdes[gdp->vidx].gf) {
152 case GF_DEF:
153 case GF_CDEF:
154 dprintf("- vname is of type DEF or CDEF, looking for CF\n");
155 if (rrd_parse_CF(line,eaten,gdp,&gdp->cf)) return 1;
156 break;
157 case GF_VDEF:
158 dprintf("- vname is of type VDEF\n");
159 break;
160 default:
161 rrd_set_error("Encountered unknown type variable '%s'",tmpstr);
162 return 1;
163 }
165 if (rrd_parse_legend(line,eaten,gdp)) return 1;
166 /* for *PRINT the legend itself gets renderd later. We only
167 get the format at this juncture */
168 strcpy(gdp->format,gdp->legend);
169 gdp->legend[0]='\0';
170 return 0;
171 }
173 int
174 rrd_parse_shift(char *line, unsigned int *eaten, graph_desc_t *gdp, image_desc_t *im) {
175 char *l = strdup(line + *eaten), *p;
176 int rc = 1;
178 p = strchr(l, ':');
179 if (p == NULL) {
180 rrd_set_error("Invalid SHIFT syntax");
181 goto out;
182 }
183 *p++ = '\0';
185 if ((gdp->vidx=find_var(im,l))<0) {
186 rrd_set_error("Not a valid vname: %s in line %s",l,line);
187 goto out;
188 }
190 /* constant will parse; otherwise, must be VDEF reference */
191 if (sscanf(p, "%ld", &gdp->shval) != 1) {
192 graph_desc_t *vdp;
194 if ((gdp->shidx=find_var(im, p))<0) {
195 rrd_set_error("invalid offset vname: %s", p);
196 goto out;
197 }
199 vdp = &im->gdes[gdp->shidx];
200 if (vdp->gf != GF_VDEF) {
201 rrd_set_error("offset must specify value or VDEF");
202 goto out;
203 }
204 } else {
205 gdp->shidx = -1;
206 }
208 *eaten = strlen(line);
209 rc = 0;
211 out:
212 free(l);
213 return rc;
214 }
216 int
217 rrd_parse_xport(char *line, unsigned int *eaten, graph_desc_t *gdp, image_desc_t *im) {
218 char *l = strdup(line + *eaten), *p;
219 int rc = 1;
221 p = strchr(l, ':');
222 if (p != NULL)
223 *p++ = '\0';
224 else
225 p = "";
227 if ((gdp->vidx=find_var(im, l))==-1){
228 rrd_set_error("unknown variable '%s'",l);
229 goto out;
230 }
232 if (strlen(p) >= FMT_LEG_LEN)
233 *(p + FMT_LEG_LEN) = '\0';
235 strcpy(gdp->legend, p);
236 *eaten = strlen(line);
237 rc = 0;
239 out:
240 free(l);
241 return rc;
242 }
244 /* Parsing of PART, VRULE, HRULE, LINE, AREA, STACK and TICK
245 ** is done in one function. Stacking STACK is silently ignored
246 ** as it is redundant. Stacking PART, VRULE, HRULE or TICK is
247 ** not allowed. The check for color doesn't need to be so strict
248 ** anymore, the user can specify the color '#00000000' and
249 ** effectively circumvent this check, so why bother.
250 **
251 ** If a number (which is valid to enter) is more than a
252 ** certain amount of characters, it is caught as an error.
253 ** While this is arguable, so is entering fixed numbers
254 ** with more than MAX_VNAME_LEN significant digits.
255 */
256 int
257 rrd_parse_PVHLAST(char *line, unsigned int *eaten, graph_desc_t *gdp, image_desc_t *im) {
258 int i,j;
259 int colorfound=0;
260 char tmpstr[MAX_VNAME_LEN + 10]; /* vname#RRGGBBAA\0 */
262 dprintf("- parsing '%s'\n",&line[*eaten]);
263 dprintf("- from line '%s'\n",line);
265 i=scan_for_col(&line[*eaten],MAX_VNAME_LEN+9,tmpstr);
266 if (line[*eaten+i]!='\0' && line[*eaten+i]!=':') {
267 rrd_set_error("Cannot parse line '%s'",line);
268 return 1;
269 }
271 j=i; while (j>0 && tmpstr[j]!='#') j--;
273 if (tmpstr[j]=='#') {
274 if (rrd_parse_color(&tmpstr[j],gdp)) {
275 rrd_set_error("Could not parse color in '%s'",tmpstr[j]);
276 return 1;
277 }
278 tmpstr[j]='\0';
279 dprintf("- parsed color 0x%08x\n",(unsigned int)gdp->col);
280 colorfound=1;
281 }
283 dprintf("- examining '%s'\n",tmpstr);
284 j=0;
285 if (gdp->gf == GF_VRULE) {
286 sscanf(tmpstr,"%li%n",&gdp->xrule,&j);
287 if (j) dprintf("- found time: %li\n",gdp->xrule);
288 } else {
289 sscanf(tmpstr,"%lf%n",&gdp->yrule,&j);
290 if (j) dprintf("- found number: %f\n",gdp->yrule);
291 }
292 if (!j) {
293 if ((gdp->vidx=find_var(im,tmpstr))<0) {
294 rrd_set_error("Not a valid vname: %s in line %s",tmpstr,line);
295 return 1;
296 }
297 dprintf("- found vname: '%s' vidx %li\n",tmpstr,gdp->vidx);
298 }
299 /* "*eaten" is still pointing to the original location,
300 ** "*eaten +i" is pointing to the character after the color
301 ** or to the terminating '\0' in which case we're finished.
302 */
303 if (line[*eaten+i]=='\0') {
304 *eaten+=i;
305 return 0;
306 }
307 *eaten+=++i;
309 /* If a color is specified and the only remaining part is
310 ** ":STACK" then it is assumed to be the legend. An empty
311 ** legend can be specified as expected. This means the
312 ** following can be done: LINE1:x#FF0000FF::STACK
313 */
314 if (colorfound) { /* no legend if no color */
315 if (gdp->gf == GF_TICK) {
316 dprintf("- looking for optional number\n");
317 sscanf(&line[*eaten],"%lf%n",&gdp->yrule,&j);
318 if (j) {
319 dprintf("- found number %f\n",gdp->yrule);
320 (*eaten)+=j;
321 if (gdp->yrule > 1.0 || gdp->yrule < -1.0) {
322 rrd_set_error("Tick factor should be <= 1.0");
323 return 1;
324 }
325 if (line[*eaten] == ':')
326 (*eaten)++;
327 } else {
328 dprintf("- not found, defaulting to 0.1\n");
329 gdp->yrule=0.1;
330 return 0;
331 }
332 }
333 dprintf("- looking for optional legend\n");
334 dprintf("- in '%s'\n",&line[*eaten]);
335 /* the legend for a graph item must start with "m " the first
336 m will then be over drawn with a color box. Since there
337 is ample space I overwrite the first few characters of the line
338 with the material that I want to see in the legend */
339 if (line[*eaten] != '\0' && line[*eaten] != ':'){
340 *eaten = *eaten - 2;
341 line[*eaten] = 'm';
342 line[*eaten+1] = ' ';
343 }
344 if (rrd_parse_legend(line, eaten, gdp)) return 1;
345 }
347 /* PART, HRULE, VRULE and TICK cannot be stacked. We're finished */
348 if ( (gdp->gf == GF_HRULE)
349 || (gdp->gf == GF_VRULE)
350 #ifdef WITH_PIECHART
351 || (gdp->gf == GF_PART)
352 #endif
353 || (gdp->gf == GF_TICK)
354 ) return 0;
356 if (line[*eaten]!='\0') {
357 dprintf("- still more, should be STACK\n");
358 (*eaten)++;
359 j=scan_for_col(&line[*eaten],5,tmpstr);
360 if (line[*eaten+j]!='\0') {
361 rrd_set_error("Garbage found where STACK expected");
362 return 1;
363 }
364 if (!strcmp("STACK",tmpstr)) {
365 dprintf("- found STACK\n");
366 gdp->stack=1;
367 (*eaten)+=5;
368 } else {
369 rrd_set_error("Garbage found where STACK expected");
370 return 1;
371 }
372 }
373 return 0;
374 }
376 int
377 rrd_parse_vname(char *line, unsigned int *eaten, graph_desc_t *gdp, image_desc_t *im) {
378 char tmpstr[MAX_VNAME_LEN + 10];
379 int i=0;
381 sscanf(&line[*eaten], DEF_NAM_FMT "=%n", tmpstr,&i);
382 if (!i) {
383 rrd_set_error("Cannot parse vname from '%s'",line);
384 return 1;
385 }
386 dprintf("- found candidate '%s'\n",tmpstr);
388 if ((gdp->vidx=find_var(im,tmpstr))>=0) {
389 rrd_set_error("Attempting to reuse '%s'",im->gdes[gdp->vidx].vname);
390 return 1;
391 }
392 strcpy(gdp->vname,tmpstr);
393 dprintf("- created vname '%s' vidx %lu\n", gdp->vname,im->gdes_c-1);
394 (*eaten)+=i;
395 return 0;
396 }
398 int
399 rrd_parse_def(char *line, unsigned int *eaten, graph_desc_t *gdp, image_desc_t *im) {
400 int i=0;
401 char command[7]; /* step, start, end, reduce */
402 char tmpstr[256];
403 struct rrd_time_value start_tv,end_tv;
404 time_t start_tmp=0,end_tmp=0;
405 char *parsetime_error=NULL;
407 start_tv.type = end_tv.type=ABSOLUTE_TIME;
408 start_tv.offset = end_tv.offset=0;
409 localtime_r(&gdp->start, &start_tv.tm);
410 localtime_r(&gdp->end, &end_tv.tm);
412 dprintf("- parsing '%s'\n",&line[*eaten]);
413 dprintf("- from line '%s'\n",line);
415 if (rrd_parse_vname(line,eaten,gdp,im)) return 1;
416 i=scan_for_col(&line[*eaten],254,gdp->rrd);
417 if (line[*eaten+i]!=':') {
418 rrd_set_error("Problems reading database name");
419 return 1;
420 }
421 (*eaten)+=++i;
422 dprintf("- using file '%s'\n",gdp->rrd);
424 i=0;
425 sscanf(&line[*eaten], DS_NAM_FMT ":%n", gdp->ds_nam,&i);
426 if (!i) {
427 rrd_set_error("Cannot parse DS in '%s'",line);
428 return 1;
429 }
430 (*eaten)+=i;
431 dprintf("- using DS '%s'\n",gdp->ds_nam);
433 if (rrd_parse_CF(line,eaten,gdp,&gdp->cf)) return 1;
434 gdp->cf_reduce = gdp->cf;
436 if (line[*eaten]=='\0') return 0;
438 while (1) {
439 dprintf("- optional parameter follows: %s\n", &line[*eaten]);
440 i=0;
441 sscanf(&line[*eaten], "%6[a-z]=%n", command, &i);
442 if (!i) {
443 rrd_set_error("Parse error in '%s'",line);
444 return 1;
445 }
446 (*eaten)+=i;
447 dprintf("- processing '%s'\n",command);
448 if (!strcmp("reduce",command)) {
449 if (rrd_parse_CF(line,eaten,gdp,&gdp->cf_reduce)) return 1;
450 if (line[*eaten] != '\0')
451 (*eaten)--;
452 } else if (!strcmp("step",command)) {
453 i=0;
454 sscanf(&line[*eaten],"%lu%n",&gdp->step,&i);
455 (*eaten)+=i;
456 dprintf("- using step %lu\n",gdp->step);
457 } else if (!strcmp("start",command)) {
458 i=scan_for_col(&line[*eaten],255,tmpstr);
459 (*eaten)+=i;
460 if ((parsetime_error = parsetime(tmpstr, &start_tv))) {
461 rrd_set_error( "start time: %s", parsetime_error );
462 return 1;
463 }
464 dprintf("- done parsing: '%s'\n",&line[*eaten]);
465 } else if (!strcmp("end",command)) {
466 i=scan_for_col(&line[*eaten],255,tmpstr);
467 (*eaten)+=i;
468 if ((parsetime_error = parsetime(tmpstr, &end_tv))) {
469 rrd_set_error( "end time: %s", parsetime_error );
470 return 1;
471 }
472 dprintf("- done parsing: '%s'\n",&line[*eaten]);
473 } else {
474 rrd_set_error("Parse error in '%s'",line);
475 return 1;
476 }
477 if (line[*eaten]=='\0') break;
478 if (line[*eaten]!=':') {
479 dprintf("- Expected to see end of string but got '%s'\n",\
480 &line[*eaten]);
481 rrd_set_error("Parse error in '%s'",line);
482 return 1;
483 }
484 (*eaten)++;
485 }
486 if (proc_start_end(&start_tv,&end_tv,&start_tmp,&end_tmp) == -1){
487 /* error string is set in parsetime.c */
488 return 1;
489 }
490 if (start_tmp < 3600*24*365*10) {
491 rrd_set_error("the first entry to fetch should be "
492 "after 1980 (%ld)",start_tmp);
493 return 1;
494 }
496 if (end_tmp < start_tmp) {
497 rrd_set_error("start (%ld) should be less than end (%ld)",
498 start_tmp, end_tmp);
499 return 1;
500 }
502 gdp->start = start_tmp;
503 gdp->end = end_tmp;
505 dprintf("- start time %lu\n",gdp->start);
506 dprintf("- end time %lu\n",gdp->end);
508 return 0;
509 }
511 int
512 rrd_parse_vdef(char *line, unsigned int *eaten, graph_desc_t *gdp, image_desc_t *im) {
513 char tmpstr[MAX_VNAME_LEN+1]; /* vname\0 */
514 int i=0;
516 dprintf("- parsing '%s'\n",&line[*eaten]);
517 if (rrd_parse_vname(line,eaten,gdp,im)) return 1;
519 sscanf(&line[*eaten], DEF_NAM_FMT ",%n", tmpstr,&i);
520 if (!i) {
521 rrd_set_error("Cannot parse line '%s'",line);
522 return 1;
523 }
524 if ((gdp->vidx=find_var(im,tmpstr))<0) {
525 rrd_set_error("Not a valid vname: %s in line %s",tmpstr,line);
526 return 1;
527 }
528 if ( im->gdes[gdp->vidx].gf != GF_DEF
529 && im->gdes[gdp->vidx].gf != GF_CDEF) {
530 rrd_set_error("variable '%s' not DEF nor "
531 "CDEF in VDEF '%s'", tmpstr,gdp->vname);
532 return 1;
533 }
534 dprintf("- found vname: '%s' vidx %li\n",tmpstr,gdp->vidx);
535 (*eaten)+=i;
537 dprintf("- calling vdef_parse with param '%s'\n",&line[*eaten]);
538 vdef_parse(gdp,&line[*eaten]);
539 while (line[*eaten]!='\0'&&line[*eaten]!=':')
540 (*eaten)++;
542 return 0;
543 }
545 int
546 rrd_parse_cdef(char *line, unsigned int *eaten, graph_desc_t *gdp, image_desc_t *im) {
547 dprintf("- parsing '%s'\n",&line[*eaten]);
548 if (rrd_parse_vname(line,eaten,gdp,im)) return 1;
549 if ((gdp->rpnp = rpn_parse(
550 (void *)im,
551 &line[*eaten],
552 &find_var_wrapper)
553 )==NULL) {
554 rrd_set_error("invalid rpn expression in: %s",&line[*eaten]);
555 return 1;
556 };
557 while (line[*eaten]!='\0'&&line[*eaten]!=':')
558 (*eaten)++;
559 return 0;
560 }
562 void
563 rrd_graph_script(int argc, char *argv[], image_desc_t *im, int optno) {
564 int i;
566 for (i=optind+optno;i<argc;i++) {
567 graph_desc_t *gdp;
568 unsigned int eaten=0;
570 if (gdes_alloc(im)) return; /* the error string is already set */
571 gdp = &im->gdes[im->gdes_c-1];
572 #ifdef DEBUG
573 gdp->debug = 1;
574 #endif
576 if (rrd_parse_find_gf(argv[i],&eaten,gdp)) return;
578 switch (gdp->gf) {
579 case GF_SHIFT: /* vname:value */
580 if (rrd_parse_shift(argv[i],&eaten,gdp,im)) return;
581 break;
582 case GF_XPORT:
583 if (rrd_parse_xport(argv[i],&eaten,gdp,im)) return;
584 break;
585 case GF_PRINT: /* vname:CF:format -or- vname:format */
586 case GF_GPRINT: /* vname:CF:format -or- vname:format */
587 if (rrd_parse_print(argv[i],&eaten,gdp,im)) return;
588 break;
589 case GF_COMMENT: /* text */
590 if (rrd_parse_legend(argv[i],&eaten,gdp)) return;
591 break;
592 #ifdef WITH_PIECHART
593 case GF_PART: /* value[#color[:legend]] */
594 #endif
595 case GF_VRULE: /* value#color[:legend] */
596 case GF_HRULE: /* value#color[:legend] */
597 case GF_LINE: /* vname-or-value[#color[:legend]][:STACK] */
598 case GF_AREA: /* vname-or-value[#color[:legend]][:STACK] */
599 case GF_STACK: /* vname-or-value[#color[:legend]] */
600 case GF_TICK: /* vname#color[:num[:legend]] */
601 if (rrd_parse_PVHLAST(argv[i],&eaten,gdp,im)) return;
602 break;
603 /* data acquisition */
604 case GF_DEF: /* vname=x:DS:CF:[:step=#][:start=#][:end=#] */
605 if (rrd_parse_def(argv[i],&eaten,gdp,im)) return;
606 break;
607 case GF_CDEF: /* vname=rpn-expression */
608 if (rrd_parse_cdef(argv[i],&eaten,gdp,im)) return;
609 break;
610 case GF_VDEF: /* vname=rpn-expression */
611 if (rrd_parse_vdef(argv[i],&eaten,gdp,im)) return;
612 break;
613 }
614 if (gdp->debug) {
615 dprintf("used %i out of %i chars\n",eaten,strlen(argv[i]));
616 dprintf("parsed line: '%s'\n",argv[i]);
617 dprintf("remaining: '%s'\n",&argv[i][eaten]);
618 if (eaten >= strlen(argv[i]))
619 dprintf("Command finished successfully\n");
620 }
621 if (eaten < strlen(argv[i])) {
622 rrd_set_error("Garbage '%s' after command:\n%s",
623 &argv[i][eaten],argv[i]);
624 return;
625 }
626 }
627 }