src/rrd_graph_helper.c

   1 /****************************************************************************
   2  * RRDtool 1.2.23  Copyright by Tobi Oetiker, 1997-2007
   3  ****************************************************************************
   4  * rrd_graph_helper.c  commandline parser functions
   5  *                     this code initially written by Alex van den Bogaerdt
   6  ****************************************************************************/
   7
   8 #include "rrd_graph.h"
   9
  10 #define dprintf if (gdp->debug) printf
  11
  12 /* NOTE ON PARSING:
  13  *
  14  * we use the following:
  15  *
  16  * i=0;  sscanf(&line[*eaten], "what to find%n", variables, &i)
  17  *
  18  * Usually you want to find a separator as well.  Example:
  19  * i=0; sscanf(&line[*eaten], "%li:%n", &someint, &i)
  20  *
  21  * When the separator is not found, i is not set and thus remains zero.
  22  * Another way would be to compare strlen() to i
  23  *
  24  * Why is this important?  Because 12345abc should not be matched as
  25  * integer 12345 ...
  26  */
  27
  28 /* NOTE ON VNAMES:
  29  *
  30  * "if ((gdp->vidx=find_var(im, l))!=-1)" is not good enough, at least
  31  * not by itself.
  32  *
  33  * A vname as a result of a VDEF is quite different from a vname
  34  * resulting of a DEF or CDEF.
  35  */
  36
  37 /* NOTE ON VNAMES:
  38  *
  39  * A vname called "123" is not to be parsed as the number 123
  40  */
  41
  42
  43 /* Define prototypes for the parsing methods.
  44   Inputs:
  45    const char *const line    - a fixed pointer to a fixed string
  46    unsigned int *const eaten - a fixed pointer to a changing index in that line
  47    graph_desc_t *const gdp   - a fixed pointer to a changing graph description
  48    image_desc_t *const im    - a fixed pointer to a changing image description
  49 */
  50
  51 int       rrd_parse_find_gf(
  52     const char *const,
  53     unsigned int *const,
  54     graph_desc_t *const);
  55
  56 int       rrd_parse_legend(
  57     const char *const,
  58     unsigned int *const,
  59     graph_desc_t *const);
  60
  61 int       rrd_parse_color(
  62     const char *const,
  63     graph_desc_t *const);
  64
  65 int       rrd_parse_textalign(
  66     const char *const,
  67     unsigned int *const,
  68     graph_desc_t *const);
  69
  70
  71 int       rrd_parse_CF(
  72     const char *const,
  73     unsigned int *const,
  74     graph_desc_t *const,
  75     enum cf_en *const);
  76
  77 int       rrd_parse_print(
  78     const char *const,
  79     unsigned int *const,
  80     graph_desc_t *const,
  81     image_desc_t *const);
  82
  83 int       rrd_parse_shift(
  84     const char *const,
  85     unsigned int *const,
  86     graph_desc_t *const,
  87     image_desc_t *const);
  88
  89 int       rrd_parse_xport(
  90     const char *const,
  91     unsigned int *const,
  92     graph_desc_t *const,
  93     image_desc_t *const);
  94
  95 int       rrd_parse_PVHLAST(
  96     const char *const,
  97     unsigned int *const,
  98     graph_desc_t *const,
  99     image_desc_t *const);
 100
 101 int       rrd_parse_make_vname(
 102     const char *const,
 103     unsigned int *const,
 104     graph_desc_t *const,
 105     image_desc_t *const);
 106
 107 int       rrd_parse_find_vname(
 108     const char *const,
 109     unsigned int *const,
 110     graph_desc_t *const,
 111     image_desc_t *const);
 112
 113 int       rrd_parse_def(
 114     const char *const,
 115     unsigned int *const,
 116     graph_desc_t *const,
 117     image_desc_t *const);
 118
 119 int       rrd_parse_vdef(
 120     const char *const,
 121     unsigned int *const,
 122     graph_desc_t *const,
 123     image_desc_t *const);
 124
 125 int       rrd_parse_cdef(
 126     const char *const,
 127     unsigned int *const,
 128     graph_desc_t *const,
 129     image_desc_t *const);
 130
 131 int rrd_parse_find_gf(
 132     const char *const line,
 133     unsigned int *const eaten,
 134     graph_desc_t *const gdp)
 135 {
 136     char      funcname[11], c1 = 0;
 137     int       i = 0;
 138
 139     /* start an argument with DEBUG to be able to see how it is parsed */
 140     sscanf(&line[*eaten], "DEBUG%n", &i);
 141     if (i) {
 142         gdp->debug = 1;
 143         (*eaten) += i;
 144         i = 0;
 145         dprintf("Scanning line '%s'\n", &line[*eaten]);
 146     }
 147     i = 0;
 148     c1 = '\0';
 149     sscanf(&line[*eaten], "%10[A-Z]%n%c", funcname, &i, &c1);
 150     if (!i) {
 151         rrd_set_error("Could not make sense out of '%s'", line);
 152         return 1;
 153     }
 154     (*eaten) += i;
 155     if ((int) (gdp->gf = gf_conv(funcname)) == -1) {
 156         rrd_set_error("'%s' is not a valid function name", funcname);
 157         return 1;
 158     } else {
 159         dprintf("- found function name '%s'\n", funcname);
 160     }
 161
 162     if (c1 == '\0') {
 163         rrd_set_error("Function %s needs parameters.  Line: %s\n", funcname,
 164                       line);
 165         return 1;
 166     }
 167     if (c1 == ':')
 168         (*eaten)++;
 169
 170     /* Some commands have a parameter before the colon
 171      * (currently only LINE)
 172      */
 173     switch (gdp->gf) {
 174     case GF_LINE:
 175         if (c1 == ':') {
 176             gdp->linewidth = 1;
 177             dprintf("- - using default width of 1\n");
 178         } else {
 179             i = 0;
 180             sscanf(&line[*eaten], "%lf:%n", &gdp->linewidth, &i);
 181             if (!i) {
 182                 rrd_set_error("Cannot parse line width '%s' in line '%s'\n",
 183                               &line[*eaten], line);
 184                 return 1;
 185             } else {
 186                 dprintf("- - scanned width %f\n", gdp->linewidth);
 187                 if (isnan(gdp->linewidth)) {
 188                     rrd_set_error
 189                         ("LINE width '%s' is not a number in line '%s'\n",
 190                          &line[*eaten], line);
 191                     return 1;
 192                 }
 193                 if (isinf(gdp->linewidth)) {
 194                     rrd_set_error
 195                         ("LINE width '%s' is out of range in line '%s'\n",
 196                          &line[*eaten], line);
 197                     return 1;
 198                 }
 199                 if (gdp->linewidth < 0) {
 200                     rrd_set_error
 201                         ("LINE width '%s' is less than 0 in line '%s'\n",
 202                          &line[*eaten], line);
 203                     return 1;
 204                 }
 205             }
 206             (*eaten) += i;
 207         }
 208         break;
 209     default:
 210         if (c1 == ':')
 211             break;
 212         rrd_set_error("Malformed '%s' command in line '%s'\n", &line[*eaten],
 213                       line);
 214         return 1;
 215     }
 216     if (line[*eaten] == '\0') {
 217         rrd_set_error("Expected some arguments after '%s'\n", line);
 218         return 1;
 219     }
 220     return 0;
 221 }
 222
 223 int rrd_parse_legend(
 224     const char *const line,
 225     unsigned int *const eaten,
 226     graph_desc_t *const gdp)
 227 {
 228     int       i;
 229
 230     if (line[*eaten] == '\0' || line[*eaten] == ':') {
 231         dprintf("- no (or: empty) legend found\n");
 232         return 0;
 233     }
 234
 235     i = scan_for_col(&line[*eaten], FMT_LEG_LEN, gdp->legend);
 236
 237     (*eaten) += i;
 238
 239     if (line[*eaten] != '\0' && line[*eaten] != ':') {
 240         rrd_set_error("Legend too long");
 241         return 1;
 242     } else {
 243         return 0;
 244     }
 245 }
 246
 247 int rrd_parse_color(
 248     const char *const string,
 249     graph_desc_t *const gdp)
 250 {
 251     unsigned int r = 0, g = 0, b = 0, a = 0, i;
 252
 253     /* matches the following formats:
 254      ** RGB
 255      ** RGBA
 256      ** RRGGBB
 257      ** RRGGBBAA
 258      */
 259
 260     i = 0;
 261     while (string[i] && isxdigit((unsigned int) string[i]))
 262         i++;
 263     if (string[i] != '\0')
 264         return 1;       /* garbage follows hexdigits */
 265     switch (i) {
 266     case 3:
 267     case 4:
 268         sscanf(string, "%1x%1x%1x%1x", &r, &g, &b, &a);
 269         r *= 0x11;
 270         g *= 0x11;
 271         b *= 0x11;
 272         a *= 0x11;
 273         if (i == 3)
 274             a = 0xFF;
 275         break;
 276     case 6:
 277     case 8:
 278         sscanf(string, "%02x%02x%02x%02x", &r, &g, &b, &a);
 279         if (i == 6)
 280             a = 0xFF;
 281         break;
 282     default:
 283         return 1;       /* wrong number of digits */
 284     }
 285     gdp->col = gfx_hex_to_col(r << 24 | g << 16 | b << 8 | a);
 286     return 0;
 287 }
 288
 289 int rrd_parse_CF(
 290     const char *const line,
 291     unsigned int *const eaten,
 292     graph_desc_t *const gdp,
 293     enum cf_en *cf)
 294 {
 295     char      symname[CF_NAM_SIZE];
 296     int       i = 0;
 297
 298     sscanf(&line[*eaten], CF_NAM_FMT "%n", symname, &i);
 299     if ((!i) || ((line[(*eaten) + i] != '\0') && (line[(*eaten) + i] != ':'))) {
 300         rrd_set_error("Cannot parse CF in '%s'", line);
 301         return 1;
 302     }
 303     (*eaten) += i;
 304     dprintf("- using CF '%s'\n", symname);
 305
 306     if ((int) (*cf = cf_conv(symname)) == -1) {
 307         rrd_set_error("Unknown CF '%s' in '%s'", symname, line);
 308         return 1;
 309     }
 310
 311     if (line[*eaten] != '\0')
 312         (*eaten)++;
 313     return 0;
 314 }
 315
 316 /* Try to match next token as a vname.
 317  *
 318  * Returns:
 319  * -1     an error occured and the error string is set
 320  * other  the vname index number
 321  *
 322  * *eaten is incremented only when a vname is found.
 323  */
 324 int rrd_parse_find_vname(
 325     const char *const line,
 326     unsigned int *const eaten,
 327     graph_desc_t *const gdp,
 328     image_desc_t *const im)
 329 {
 330     char      tmpstr[MAX_VNAME_LEN + 1];
 331     int       i;
 332     long      vidx;
 333
 334     i = 0;
 335     sscanf(&line[*eaten], DEF_NAM_FMT "%n", tmpstr, &i);
 336     if (!i) {
 337         rrd_set_error("Could not parse line '%s'", line);
 338         return -1;
 339     }
 340     if (line[*eaten + i] != ':' && line[*eaten + i] != '\0') {
 341         rrd_set_error("Could not parse line '%s'", line);
 342         return -1;
 343     }
 344     dprintf("- Considering '%s'\n", tmpstr);
 345
 346     if ((vidx = find_var(im, tmpstr)) < 0) {
 347         dprintf("- Not a vname\n");
 348         rrd_set_error("Not a valid vname: %s in line %s", tmpstr, line);
 349         return -1;
 350     }
 351     dprintf("- Found vname '%s' vidx '%li'\n", tmpstr, gdp->vidx);
 352     if (line[*eaten + i] == ':')
 353         i++;
 354     (*eaten) += i;
 355     return vidx;
 356 }
 357
 358 /* Parsing old-style xPRINT and new-style xPRINT */
 359 int rrd_parse_print(
 360     const char *const line,
 361     unsigned int *const eaten,
 362     graph_desc_t *const gdp,
 363     image_desc_t *const im)
 364 {
 365     /* vname:CF:format in case of DEF-based vname
 366      ** vname:CF:format in case of CDEF-based vname
 367      ** vname:format[:strftime] in case of VDEF-based vname
 368      */
 369     if ((gdp->vidx = rrd_parse_find_vname(line, eaten, gdp, im)) < 0)
 370         return 1;
 371
 372     switch (im->gdes[gdp->vidx].gf) {
 373     case GF_DEF:
 374     case GF_CDEF:
 375         dprintf("- vname is of type DEF or CDEF, looking for CF\n");
 376         if (rrd_parse_CF(line, eaten, gdp, &gdp->cf))
 377             return 1;
 378         break;
 379     case GF_VDEF:
 380         dprintf("- vname is of type VDEF\n");
 381         break;
 382     default:
 383         rrd_set_error("Encountered unknown type variable '%s'",
 384                       im->gdes[gdp->vidx].vname);
 385         return 1;
 386     }
 387
 388     if (rrd_parse_legend(line, eaten, gdp))
 389         return 1;
 390     /* for *PRINT the legend itself gets rendered later. We only
 391        get the format at this juncture */
 392     strcpy(gdp->format, gdp->legend);
 393     gdp->legend[0] = '\0';
 394     /* this is a very crud test, parsing :style flags should be in a function */
 395     if (im->gdes[gdp->vidx].gf == GF_VDEF
 396         && strcmp(line + (*eaten), ":strftime") == 0) {
 397         gdp->strftm = 1;
 398         (*eaten) += strlen(":strftime");
 399     }
 400     return 0;
 401 }
 402
 403 /* SHIFT:_def_or_cdef:_vdef_or_number_
 404  */
 405 int rrd_parse_shift(
 406     const char *const line,
 407     unsigned int *const eaten,
 408     graph_desc_t *const gdp,
 409     image_desc_t *const im)
 410 {
 411     int       i;
 412
 413     if ((gdp->vidx = rrd_parse_find_vname(line, eaten, gdp, im)) < 0)
 414         return 1;
 415
 416     switch (im->gdes[gdp->vidx].gf) {
 417     case GF_DEF:
 418     case GF_CDEF:
 419         dprintf("- vname is of type DEF or CDEF, OK\n");
 420         break;
 421     case GF_VDEF:
 422         rrd_set_error("Cannot shift a VDEF: '%s' in line '%s'\n",
 423                       im->gdes[gdp->vidx].vname, line);
 424         return 1;
 425     default:
 426         rrd_set_error("Encountered unknown type variable '%s' in line '%s'",
 427                       im->gdes[gdp->vidx].vname, line);
 428         return 1;
 429     }
 430
 431     if ((gdp->shidx = rrd_parse_find_vname(line, eaten, gdp, im)) >= 0) {
 432         switch (im->gdes[gdp->shidx].gf) {
 433         case GF_DEF:
 434         case GF_CDEF:
 435             rrd_set_error("Offset cannot be a (C)DEF: '%s' in line '%s'\n",
 436                           im->gdes[gdp->shidx].vname, line);
 437             return 1;
 438         case GF_VDEF:
 439             dprintf("- vname is of type VDEF, OK\n");
 440             break;
 441         default:
 442             rrd_set_error
 443                 ("Encountered unknown type variable '%s' in line '%s'",
 444                  im->gdes[gdp->vidx].vname, line);
 445             return 1;
 446         }
 447     } else {
 448         long time_tmp = 0;
 449         rrd_clear_error();
 450         i = 0;
 451         sscanf(&line[*eaten], "%li%n", &time_tmp, &i);
 452         gdp->shval = time_tmp;
 453         if (i != (int) strlen(&line[*eaten])) {
 454             rrd_set_error("Not a valid offset: %s in line %s", &line[*eaten],
 455                           line);
 456             return 1;
 457         }
 458         (*eaten) += i;
 459         dprintf("- offset is number %li\n", gdp->shval);
 460         gdp->shidx = -1;
 461     }
 462     return 0;
 463 }
 464
 465 /* XPORT:_def_or_cdef[:legend]
 466  */
 467 int rrd_parse_xport(
 468     const char *const line,
 469     unsigned int *const eaten,
 470     graph_desc_t *const gdp,
 471     image_desc_t *const im)
 472 {
 473     if ((gdp->vidx = rrd_parse_find_vname(line, eaten, gdp, im)) < 0)
 474         return 1;
 475
 476     switch (im->gdes[gdp->vidx].gf) {
 477     case GF_DEF:
 478     case GF_CDEF:
 479         dprintf("- vname is of type DEF or CDEF, OK\n");
 480         break;
 481     case GF_VDEF:
 482         rrd_set_error("Cannot xport a VDEF: '%s' in line '%s'\n",
 483                       im->gdes[gdp->vidx].vname, line);
 484         return 1;
 485     default:
 486         rrd_set_error("Encountered unknown type variable '%s' in line '%s'",
 487                       im->gdes[gdp->vidx].vname, line);
 488         return 1;
 489     }
 490     dprintf("- looking for legend in '%s'\n", &line[*eaten]);
 491     if (rrd_parse_legend(line, eaten, gdp))
 492         return 1;
 493     return 0;
 494 }
 495
 496 int rrd_parse_textalign(
 497     const char *const line,
 498     unsigned int *const eaten,
 499     graph_desc_t *const gdp)
 500 {
 501     if (strcmp(&line[*eaten], "left") == 0) {
 502         gdp->txtalign = TXA_LEFT;
 503     } else if (strcmp(&line[*eaten], "right") == 0) {
 504         gdp->txtalign = TXA_RIGHT;
 505     } else if (strcmp(&line[*eaten], "justified") == 0) {
 506         gdp->txtalign = TXA_JUSTIFIED;
 507     } else if (strcmp(&line[*eaten], "center") == 0) {
 508         gdp->txtalign = TXA_CENTER;
 509     } else {
 510         rrd_set_error("Unknown alignement type '%s'", &line[*eaten]);
 511         return 1;
 512     }
 513     *eaten += strlen(&line[*eaten]);
 514     return 0;
 515 }
 516
 517
 518 /* Parsing of PART, VRULE, HRULE, LINE, AREA, STACK and TICK
 519 ** is done in one function.
 520 **
 521 ** Stacking PART, VRULE, HRULE or TICK is not allowed.
 522 **
 523 ** If a number (which is valid to enter) is more than a
 524 ** certain amount of characters, it is caught as an error.
 525 ** While this is arguable, so is entering fixed numbers
 526 ** with more than MAX_VNAME_LEN significant digits.
 527 */
 528 int rrd_parse_PVHLAST(
 529     const char *const line,
 530     unsigned int *const eaten,
 531     graph_desc_t *const gdp,
 532     image_desc_t *const im)
 533 {
 534     int       i, j, k;
 535     int       colorfound = 0;
 536     char      tmpstr[MAX_VNAME_LEN + 10];   /* vname#RRGGBBAA\0 */
 537     static int spacecnt = 0;
 538
 539     if (spacecnt == 0) {
 540         float     one_space = gfx_get_text_width(im, 0,
 541                                                  im->
 542                                                  text_prop[TEXT_PROP_LEGEND].
 543                                                  font,
 544                                                  im->
 545                                                  text_prop[TEXT_PROP_LEGEND].
 546                                                  size,
 547                                                  im->tabwidth, "    ") / 4.0;
 548         float     target_space = gfx_get_text_width(im, 0,
 549                                                     im->
 550                                                     text_prop
 551                                                     [TEXT_PROP_LEGEND].font,
 552                                                     im->
 553                                                     text_prop
 554                                                     [TEXT_PROP_LEGEND].size,
 555                                                     im->tabwidth, "oo");
 556
 557         spacecnt = target_space / one_space;
 558         dprintf("- spacecnt: %i onespace: %f targspace: %f\n", spacecnt,
 559                 one_space, target_space);
 560     }
 561
 562
 563     dprintf("- parsing '%s'\n", &line[*eaten]);
 564
 565     /* have simpler code in the drawing section */
 566     if (gdp->gf == GF_STACK) {
 567         gdp->stack = 1;
 568     }
 569
 570     i = scan_for_col(&line[*eaten], MAX_VNAME_LEN + 9, tmpstr);
 571     if (line[*eaten + i] != '\0' && line[*eaten + i] != ':') {
 572         rrd_set_error("Cannot parse line '%s'", line);
 573         return 1;
 574     }
 575
 576     j = i;
 577     while (j > 0 && tmpstr[j] != '#')
 578         j--;
 579
 580     if (j) {
 581         tmpstr[j] = '\0';
 582     }
 583     /* We now have:
 584      * tmpstr[0]    containing vname
 585      * tmpstr[j]    if j!=0 then containing color
 586      * i            size of vname + color
 587      * j            if j!=0 then size of vname
 588      */
 589
 590     /* Number or vname ?
 591      * If it is an existing vname, that's OK, provided that it is a
 592      * valid type (need time for VRULE, not a float)
 593      * Else see if it parses as a number.
 594      */
 595     dprintf("- examining string '%s'\n", tmpstr);
 596     if ((gdp->vidx = find_var(im, tmpstr)) >= 0) {
 597         dprintf("- found vname: '%s' vidx %li\n", tmpstr, gdp->vidx);
 598         switch (gdp->gf) {
 599         case GF_VRULE:
 600         case GF_HRULE:
 601             if (im->gdes[gdp->vidx].gf != GF_VDEF) {
 602                 rrd_set_error("Using vname %s of wrong type in line %s\n",
 603                               im->gdes[gdp->gf].vname, line);
 604                 return 1;
 605             }
 606             break;
 607         default:;
 608         }
 609     } else {
 610         long time_tmp = 0;
 611         dprintf("- it is not an existing vname\n");
 612         switch (gdp->gf) {
 613         case GF_VRULE:
 614             k = 0;
 615             sscanf(tmpstr, "%li%n",&time_tmp , &k);
 616             gdp->xrule = time_tmp;
 617             if (((j != 0) && (k == j)) || ((j == 0) && (k == i))) {
 618                 dprintf("- found time: %li\n", gdp->xrule);
 619             } else {
 620                 dprintf("- is is not a valid number: %li\n", gdp->xrule);
 621                 rrd_set_error
 622                     ("parameter '%s' does not represent time in line %s\n",
 623                      tmpstr, line);
 624                 return 1;
 625             }
 626         default:
 627             k = 0;
 628             sscanf(tmpstr, "%lf%n", &gdp->yrule, &k);
 629             if (((j != 0) && (k == j)) || ((j == 0) && (k == i))) {
 630                 dprintf("- found number: %lf\n", gdp->yrule);
 631             } else {
 632                 dprintf("- is is not a valid number: %lf\n", gdp->yrule);
 633                 rrd_set_error
 634                     ("parameter '%s' does not represent a number in line %s\n",
 635                      tmpstr, line);
 636                 return 1;
 637             }
 638         }
 639     }
 640
 641     if (j) {
 642         j++;
 643         dprintf("- examining color '%s'\n", &tmpstr[j]);
 644         if (rrd_parse_color(&tmpstr[j], gdp)) {
 645             rrd_set_error("Could not parse color in '%s'", &tmpstr[j]);
 646             return 1;
 647         }
 648         dprintf("- parsed color %0.0f,%0.0f,%0.0f,%0.0f\n", gdp->col.red,
 649                 gdp->col.green, gdp->col.blue, gdp->col.alpha);
 650         colorfound = 1;
 651     } else {
 652         dprintf("- no color present in '%s'\n", tmpstr);
 653     }
 654
 655     (*eaten) += i;      /* after vname#color */
 656     if (line[*eaten] != '\0') {
 657         (*eaten)++;     /* after colon */
 658     }
 659
 660     if (gdp->gf == GF_TICK) {
 661         dprintf("- parsing '%s'\n", &line[*eaten]);
 662         dprintf("- looking for optional TICK number\n");
 663         j = 0;
 664         sscanf(&line[*eaten], "%lf%n", &gdp->yrule, &j);
 665         if (j) {
 666             if (line[*eaten + j] != '\0' && line[*eaten + j] != ':') {
 667                 rrd_set_error("Cannot parse TICK fraction '%s'", line);
 668                 return 1;
 669             }
 670             dprintf("- found number %f\n", gdp->yrule);
 671             if (gdp->yrule > 1.0 || gdp->yrule < -1.0) {
 672                 rrd_set_error("Tick factor should be <= 1.0");
 673                 return 1;
 674             }
 675             (*eaten) += j;
 676         } else {
 677             dprintf("- not found, defaulting to 0.1\n");
 678             gdp->yrule = 0.1;
 679         }
 680         if (line[*eaten] == '\0') {
 681             dprintf("- done parsing line\n");
 682             return 0;
 683         } else {
 684             if (line[*eaten] == ':') {
 685                 (*eaten)++;
 686             } else {
 687                 rrd_set_error("Can't make sense of that TICK line");
 688                 return 1;
 689             }
 690         }
 691     }
 692
 693     dprintf("- parsing '%s'\n", &line[*eaten]);
 694
 695     /* Legend is next.  A legend without a color is an error.
 696      ** Stacking an item without having a legend is OK however
 697      ** then an empty legend should be specified.
 698      **   LINE:val#color:STACK  means legend is string "STACK"
 699      **   LINE:val#color::STACK means no legend, and do STACK
 700      **   LINE:val:STACK        is an error (legend but no color)
 701      **   LINE:val::STACK   means no legend, and do STACK
 702      */
 703     if (colorfound) {
 704         int       err = 0;
 705         char     *linecp = strdup(line);
 706
 707         dprintf("- looking for optional legend\n");
 708
 709         dprintf("- examining '%s'\n", &line[*eaten]);
 710         if (linecp[*eaten] != '\0' && linecp[*eaten] != ':') {
 711             int       spi;
 712
 713             /* If the legend is not empty, it has to be prefixed with spacecnt ' ' characters. This then gets
 714              * replaced by the color box later on. */
 715             for (spi = 0; spi < spacecnt && (*eaten) > 1; spi++) {
 716                 linecp[--(*eaten)] = ' ';
 717             }
 718         }
 719
 720         if (rrd_parse_legend(linecp, eaten, gdp))
 721             err = 1;
 722         free(linecp);
 723         if (err)
 724             return 1;
 725
 726         dprintf("- found legend '%s'\n", &gdp->legend[2]);
 727     } else {
 728         dprintf("- skipping empty legend\n");
 729         if (line[*eaten] != '\0' && line[*eaten] != ':') {
 730             rrd_set_error("Legend set but no color: %s", &line[*eaten]);
 731             return 1;
 732         }
 733     }
 734     if (line[*eaten] == '\0') {
 735         dprintf("- done parsing line\n");
 736         return 0;
 737     }
 738     (*eaten)++;         /* after colon */
 739
 740     /* PART, HRULE, VRULE and TICK cannot be stacked. */
 741     if ((gdp->gf == GF_HRULE)
 742         || (gdp->gf == GF_VRULE)
 743         || (gdp->gf == GF_TICK)
 744         )
 745         return 0;
 746
 747     dprintf("- parsing '%s'\n", &line[*eaten]);
 748     if (line[*eaten] != '\0') {
 749         dprintf("- still more, should be STACK\n");
 750         j = scan_for_col(&line[*eaten], 5, tmpstr);
 751         if (line[*eaten + j] != '\0' && line[*eaten + j] != ':') {
 752             /* not 5 chars */
 753             rrd_set_error("STACK expected and not found");
 754             return 1;
 755         }
 756         if (!strcmp("STACK", tmpstr)) {
 757             dprintf("- found STACK\n");
 758             gdp->stack = 1;
 759             (*eaten) += j;
 760         } else {
 761             rrd_set_error("STACK expected and not found");
 762             return 1;
 763         }
 764     }
 765     if (line[*eaten] == '\0') {
 766         dprintf("- done parsing line\n");
 767         return 0;
 768     }
 769     (*eaten)++;
 770     dprintf("- parsing '%s'\n", &line[*eaten]);
 771
 772     return 0;
 773 }
 774
 775 int rrd_parse_make_vname(
 776     const char *const line,
 777     unsigned int *const eaten,
 778     graph_desc_t *const gdp,
 779     image_desc_t *const im)
 780 {
 781     char      tmpstr[MAX_VNAME_LEN + 10];
 782     int       i = 0;
 783
 784     sscanf(&line[*eaten], DEF_NAM_FMT "=%n", tmpstr, &i);
 785     if (!i) {
 786         rrd_set_error("Cannot parse vname from '%s'", line);
 787         return 1;
 788     }
 789     dprintf("- found candidate '%s'\n", tmpstr);
 790
 791     if ((gdp->vidx = find_var(im, tmpstr)) >= 0) {
 792         rrd_set_error("Attempting to reuse '%s'", im->gdes[gdp->vidx].vname);
 793         return 1;
 794     }
 795     strcpy(gdp->vname, tmpstr);
 796     dprintf("- created vname '%s' vidx %lu\n", gdp->vname, im->gdes_c - 1);
 797     (*eaten) += i;
 798     return 0;
 799 }
 800
 801 int rrd_parse_def(
 802     const char *const line,
 803     unsigned int *const eaten,
 804     graph_desc_t *const gdp,
 805     image_desc_t *const im)
 806 {
 807     int       i = 0;
 808     char      command[7];   /* step, start, end, reduce */
 809     char      tmpstr[256];
 810     struct rrd_time_value start_tv, end_tv;
 811     time_t    start_tmp = 0, end_tmp = 0;
 812     char     *parsetime_error = NULL;
 813
 814     start_tv.type = end_tv.type = ABSOLUTE_TIME;
 815     start_tv.offset = end_tv.offset = 0;
 816     localtime_r(&gdp->start, &start_tv.tm);
 817     localtime_r(&gdp->end, &end_tv.tm);
 818
 819     dprintf("- parsing '%s'\n", &line[*eaten]);
 820     dprintf("- from line '%s'\n", line);
 821
 822     if (rrd_parse_make_vname(line, eaten, gdp, im))
 823         return 1;
 824     i = scan_for_col(&line[*eaten], sizeof(gdp->rrd) - 1, gdp->rrd);
 825     if (line[*eaten + i] != ':') {
 826         rrd_set_error("Problems reading database name");
 827         return 1;
 828     }
 829     (*eaten) += ++i;
 830     dprintf("- using file '%s'\n", gdp->rrd);
 831
 832     i = 0;
 833     sscanf(&line[*eaten], DS_NAM_FMT ":%n", gdp->ds_nam, &i);
 834     if (!i) {
 835         rrd_set_error("Cannot parse DS in '%s'", line);
 836         return 1;
 837     }
 838     (*eaten) += i;
 839     dprintf("- using DS '%s'\n", gdp->ds_nam);
 840
 841     if (rrd_parse_CF(line, eaten, gdp, &gdp->cf))
 842         return 1;
 843     gdp->cf_reduce = gdp->cf;
 844
 845     if (line[*eaten] == '\0')
 846         return 0;
 847
 848     while (1) {
 849         dprintf("- optional parameter follows: %s\n", &line[*eaten]);
 850         i = 0;
 851         sscanf(&line[*eaten], "%6[a-z]=%n", command, &i);
 852         if (!i) {
 853             rrd_set_error("Parse error in '%s'", line);
 854             return 1;
 855         }
 856         (*eaten) += i;
 857         dprintf("- processing '%s'\n", command);
 858         if (!strcmp("reduce", command)) {
 859             if (rrd_parse_CF(line, eaten, gdp, &gdp->cf_reduce))
 860                 return 1;
 861             if (line[*eaten] != '\0')
 862                 (*eaten)--;
 863         } else if (!strcmp("step", command)) {
 864             i = 0;
 865             sscanf(&line[*eaten], "%lu%n", &gdp->step, &i);
 866             gdp->step_orig = gdp->step;
 867             (*eaten) += i;
 868             dprintf("- using step %lu\n", gdp->step);
 869         } else if (!strcmp("start", command)) {
 870             i = scan_for_col(&line[*eaten], 255, tmpstr);
 871             (*eaten) += i;
 872             if ((parsetime_error = parsetime(tmpstr, &start_tv))) {
 873                 rrd_set_error("start time: %s", parsetime_error);
 874                 return 1;
 875             }
 876             dprintf("- done parsing:  '%s'\n", &line[*eaten]);
 877         } else if (!strcmp("end", command)) {
 878             i = scan_for_col(&line[*eaten], 255, tmpstr);
 879             (*eaten) += i;
 880             if ((parsetime_error = parsetime(tmpstr, &end_tv))) {
 881                 rrd_set_error("end time: %s", parsetime_error);
 882                 return 1;
 883             }
 884             dprintf("- done parsing:  '%s'\n", &line[*eaten]);
 885         } else {
 886             rrd_set_error("Parse error in '%s'", line);
 887             return 1;
 888         }
 889         if (line[*eaten] == '\0')
 890             break;
 891         if (line[*eaten] != ':') {
 892             dprintf("- Expected to see end of string but got '%s'\n",
 893                     &line[*eaten]);
 894             rrd_set_error("Parse error in '%s'", line);
 895             return 1;
 896         }
 897         (*eaten)++;
 898     }
 899     if (proc_start_end(&start_tv, &end_tv, &start_tmp, &end_tmp) == -1) {
 900         /* error string is set in parsetime.c */
 901         return 1;
 902     }
 903     if (start_tmp < 3600 * 24 * 365 * 10) {
 904         rrd_set_error("the first entry to fetch should be "
 905                       "after 1980 (%ld)", start_tmp);
 906         return 1;
 907     }
 908
 909     if (end_tmp < start_tmp) {
 910         rrd_set_error("start (%ld) should be less than end (%ld)",
 911                       start_tmp, end_tmp);
 912         return 1;
 913     }
 914
 915     gdp->start = start_tmp;
 916     gdp->end = end_tmp;
 917     gdp->start_orig = start_tmp;
 918     gdp->end_orig = end_tmp;
 919
 920     dprintf("- start time %lu\n", gdp->start);
 921     dprintf("- end   time %lu\n", gdp->end);
 922
 923     return 0;
 924 }
 925
 926 int rrd_parse_vdef(
 927     const char *const line,
 928     unsigned int *const eaten,
 929     graph_desc_t *const gdp,
 930     image_desc_t *const im)
 931 {
 932     char      tmpstr[MAX_VNAME_LEN + 1];    /* vname\0 */
 933     int       i = 0;
 934
 935     dprintf("- parsing '%s'\n", &line[*eaten]);
 936     if (rrd_parse_make_vname(line, eaten, gdp, im))
 937         return 1;
 938
 939     sscanf(&line[*eaten], DEF_NAM_FMT ",%n", tmpstr, &i);
 940     if (!i) {
 941         rrd_set_error("Cannot parse line '%s'", line);
 942         return 1;
 943     }
 944     if ((gdp->vidx = find_var(im, tmpstr)) < 0) {
 945         rrd_set_error("Not a valid vname: %s in line %s", tmpstr, line);
 946         return 1;
 947     }
 948     if (im->gdes[gdp->vidx].gf != GF_DEF && im->gdes[gdp->vidx].gf != GF_CDEF) {
 949         rrd_set_error("variable '%s' not DEF nor "
 950                       "CDEF in VDEF '%s'", tmpstr, gdp->vname);
 951         return 1;
 952     }
 953     dprintf("- found vname: '%s' vidx %li\n", tmpstr, gdp->vidx);
 954     (*eaten) += i;
 955
 956     dprintf("- calling vdef_parse with param '%s'\n", &line[*eaten]);
 957     vdef_parse(gdp, &line[*eaten]);
 958     while (line[*eaten] != '\0' && line[*eaten] != ':')
 959         (*eaten)++;
 960
 961     return 0;
 962 }
 963
 964 int rrd_parse_cdef(
 965     const char *const line,
 966     unsigned int *const eaten,
 967     graph_desc_t *const gdp,
 968     image_desc_t *const im)
 969 {
 970     dprintf("- parsing '%s'\n", &line[*eaten]);
 971     if (rrd_parse_make_vname(line, eaten, gdp, im))
 972         return 1;
 973     if ((gdp->rpnp = rpn_parse((void *) im, &line[*eaten], &find_var_wrapper)
 974         ) == NULL) {
 975         rrd_set_error("invalid rpn expression in: %s", &line[*eaten]);
 976         return 1;
 977     };
 978     while (line[*eaten] != '\0' && line[*eaten] != ':')
 979         (*eaten)++;
 980     return 0;
 981 }
 982
 983 void rrd_graph_script(
 984     int argc,
 985     char *argv[],
 986     image_desc_t *const im,
 987     int optno)
 988 {
 989     int       i;
 990
 991     /* save state for STACK backward compat function */
 992     enum gf_en last_gf = GF_PRINT;
 993     float     last_linewidth = 0.0;
 994
 995     for (i = optind + optno; i < argc; i++) {
 996         graph_desc_t *gdp;
 997         unsigned int eaten = 0;
 998
 999         if (gdes_alloc(im))
1000             return;     /* the error string is already set */
1001         gdp = &im->gdes[im->gdes_c - 1];
1002 #ifdef DEBUG
1003         gdp->debug = 1;
1004 #endif
1005
1006         if (rrd_parse_find_gf(argv[i], &eaten, gdp))
1007             return;
1008
1009         switch (gdp->gf) {
1010         case GF_SHIFT: /* vname:value */
1011             if (rrd_parse_shift(argv[i], &eaten, gdp, im))
1012                 return;
1013             break;
1014         case GF_TEXTALIGN: /* left|right|center|justified */
1015             if (rrd_parse_textalign(argv[i], &eaten, gdp))
1016                 return;
1017             break;
1018         case GF_XPORT:
1019             if (rrd_parse_xport(argv[i], &eaten, gdp, im))
1020                 return;
1021             break;
1022         case GF_PRINT: /* vname:CF:format -or- vname:format */
1023             im->prt_c++;
1024         case GF_GPRINT:    /* vname:CF:format -or- vname:format */
1025             if (rrd_parse_print(argv[i], &eaten, gdp, im))
1026                 return;
1027             break;
1028         case GF_COMMENT:   /* text */
1029             if (rrd_parse_legend(argv[i], &eaten, gdp))
1030                 return;
1031             break;
1032         case GF_VRULE: /* value#color[:legend] */
1033         case GF_HRULE: /* value#color[:legend] */
1034         case GF_LINE:  /* vname-or-value[#color[:legend]][:STACK] */
1035         case GF_AREA:  /* vname-or-value[#color[:legend]][:STACK] */
1036         case GF_TICK:  /* vname#color[:num[:legend]] */
1037             if (rrd_parse_PVHLAST(argv[i], &eaten, gdp, im))
1038                 return;
1039             last_gf = gdp->gf;
1040             last_linewidth = gdp->linewidth;
1041             break;
1042         case GF_STACK: /* vname-or-value[#color[:legend]] */
1043             if (rrd_parse_PVHLAST(argv[i], &eaten, gdp, im))
1044                 return;
1045             if (last_gf == GF_LINE || last_gf == GF_AREA) {
1046                 gdp->gf = last_gf;
1047                 gdp->linewidth = last_linewidth;
1048             } else {
1049                 rrd_set_error("STACK must follow LINE or AREA! command:\n%s",
1050                               &argv[i][eaten], argv[i]);
1051                 return;
1052             }
1053             break;
1054             /* data acquisition */
1055         case GF_DEF:   /* vname=x:DS:CF:[:step=#][:start=#][:end=#] */
1056             if (rrd_parse_def(argv[i], &eaten, gdp, im))
1057                 return;
1058             break;
1059         case GF_CDEF:  /* vname=rpn-expression */
1060             if (rrd_parse_cdef(argv[i], &eaten, gdp, im))
1061                 return;
1062             break;
1063         case GF_VDEF:  /* vname=rpn-expression */
1064             if (rrd_parse_vdef(argv[i], &eaten, gdp, im))
1065                 return;
1066             break;
1067         }
1068         if (gdp->debug) {
1069             dprintf("used %i out of %zi chars\n", eaten, strlen(argv[i]));
1070             dprintf("parsed line: '%s'\n", argv[i]);
1071             dprintf("remaining: '%s'\n", &argv[i][eaten]);
1072             if (eaten >= strlen(argv[i]))
1073                 dprintf("Command finished successfully\n");
1074         }
1075         if (eaten < strlen(argv[i])) {
1076             rrd_set_error("I don't understand '%s' in command: '%s'.",
1077                           &argv[i][eaten], argv[i]);
1078             return;
1079         }
1080     }
1081 }