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