src/rrd_graph_helper.c

   1 /****************************************************************************
   2  * RRDtool 1.2.99907080300  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
 450         rrd_clear_error();
 451         i = 0;
 452         sscanf(&line[*eaten], "%li%n", &time_tmp, &i);
 453         gdp->shval = time_tmp;
 454         if (i != (int) strlen(&line[*eaten])) {
 455             rrd_set_error("Not a valid offset: %s in line %s", &line[*eaten],
 456                           line);
 457             return 1;
 458         }
 459         (*eaten) += i;
 460         dprintf("- offset is number %li\n", gdp->shval);
 461         gdp->shidx = -1;
 462     }
 463     return 0;
 464 }
 465
 466 /* XPORT:_def_or_cdef[:legend]
 467  */
 468 int rrd_parse_xport(
 469     const char *const line,
 470     unsigned int *const eaten,
 471     graph_desc_t *const gdp,
 472     image_desc_t *const im)
 473 {
 474     if ((gdp->vidx = rrd_parse_find_vname(line, eaten, gdp, im)) < 0)
 475         return 1;
 476
 477     switch (im->gdes[gdp->vidx].gf) {
 478     case GF_DEF:
 479     case GF_CDEF:
 480         dprintf("- vname is of type DEF or CDEF, OK\n");
 481         break;
 482     case GF_VDEF:
 483         rrd_set_error("Cannot xport a VDEF: '%s' in line '%s'\n",
 484                       im->gdes[gdp->vidx].vname, line);
 485         return 1;
 486     default:
 487         rrd_set_error("Encountered unknown type variable '%s' in line '%s'",
 488                       im->gdes[gdp->vidx].vname, line);
 489         return 1;
 490     }
 491     dprintf("- looking for legend in '%s'\n", &line[*eaten]);
 492     if (rrd_parse_legend(line, eaten, gdp))
 493         return 1;
 494     return 0;
 495 }
 496
 497 int rrd_parse_textalign(
 498     const char *const line,
 499     unsigned int *const eaten,
 500     graph_desc_t *const gdp)
 501 {
 502     if (strcmp(&line[*eaten], "left") == 0) {
 503         gdp->txtalign = TXA_LEFT;
 504     } else if (strcmp(&line[*eaten], "right") == 0) {
 505         gdp->txtalign = TXA_RIGHT;
 506     } else if (strcmp(&line[*eaten], "justified") == 0) {
 507         gdp->txtalign = TXA_JUSTIFIED;
 508     } else if (strcmp(&line[*eaten], "center") == 0) {
 509         gdp->txtalign = TXA_CENTER;
 510     } else {
 511         rrd_set_error("Unknown alignement type '%s'", &line[*eaten]);
 512         return 1;
 513     }
 514     *eaten += strlen(&line[*eaten]);
 515     return 0;
 516 }
 517
 518
 519 /* Parsing of PART, VRULE, HRULE, LINE, AREA, STACK and TICK
 520 ** is done in one function.
 521 **
 522 ** Stacking PART, VRULE, HRULE or TICK is not allowed.
 523 **
 524 ** If a number (which is valid to enter) is more than a
 525 ** certain amount of characters, it is caught as an error.
 526 ** While this is arguable, so is entering fixed numbers
 527 ** with more than MAX_VNAME_LEN significant digits.
 528 */
 529 int rrd_parse_PVHLAST(
 530     const char *const line,
 531     unsigned int *const eaten,
 532     graph_desc_t *const gdp,
 533     image_desc_t *const im)
 534 {
 535     int       i, j, k;
 536     int       colorfound = 0;
 537     char      tmpstr[MAX_VNAME_LEN + 10];   /* vname#RRGGBBAA\0 */
 538     static int spacecnt = 0;
 539
 540     if (spacecnt == 0) {
 541         float     one_space = gfx_get_text_width(im, 0,
 542                                                  im->
 543                                                  text_prop[TEXT_PROP_LEGEND].
 544                                                  font,
 545                                                  im->
 546                                                  text_prop[TEXT_PROP_LEGEND].
 547                                                  size,
 548                                                  im->tabwidth, "    ") / 4.0;
 549         float     target_space = gfx_get_text_width(im, 0,
 550                                                     im->
 551                                                     text_prop
 552                                                     [TEXT_PROP_LEGEND].font,
 553                                                     im->
 554                                                     text_prop
 555                                                     [TEXT_PROP_LEGEND].size,
 556                                                     im->tabwidth, "oo");
 557
 558         spacecnt = target_space / one_space;
 559         dprintf("- spacecnt: %i onespace: %f targspace: %f\n", spacecnt,
 560                 one_space, target_space);
 561     }
 562
 563
 564     dprintf("- parsing '%s'\n", &line[*eaten]);
 565
 566     /* have simpler code in the drawing section */
 567     if (gdp->gf == GF_STACK) {
 568         gdp->stack = 1;
 569     }
 570
 571     i = scan_for_col(&line[*eaten], MAX_VNAME_LEN + 9, tmpstr);
 572     if (line[*eaten + i] != '\0' && line[*eaten + i] != ':') {
 573         rrd_set_error("Cannot parse line '%s'", line);
 574         return 1;
 575     }
 576
 577     j = i;
 578     while (j > 0 && tmpstr[j] != '#')
 579         j--;
 580
 581     if (j) {
 582         tmpstr[j] = '\0';
 583     }
 584     /* We now have:
 585      * tmpstr[0]    containing vname
 586      * tmpstr[j]    if j!=0 then containing color
 587      * i            size of vname + color
 588      * j            if j!=0 then size of vname
 589      */
 590
 591     /* Number or vname ?
 592      * If it is an existing vname, that's OK, provided that it is a
 593      * valid type (need time for VRULE, not a float)
 594      * Else see if it parses as a number.
 595      */
 596     dprintf("- examining string '%s'\n", tmpstr);
 597     if ((gdp->vidx = find_var(im, tmpstr)) >= 0) {
 598         dprintf("- found vname: '%s' vidx %li\n", tmpstr, gdp->vidx);
 599         switch (gdp->gf) {
 600         case GF_VRULE:
 601         case GF_HRULE:
 602             if (im->gdes[gdp->vidx].gf != GF_VDEF) {
 603                 rrd_set_error("Using vname %s of wrong type in line %s\n",
 604                               im->gdes[gdp->gf].vname, line);
 605                 return 1;
 606             }
 607             break;
 608         default:;
 609         }
 610     } else {
 611         long      time_tmp = 0;
 612
 613         dprintf("- it is not an existing vname\n");
 614         switch (gdp->gf) {
 615         case GF_VRULE:
 616             k = 0;
 617             sscanf(tmpstr, "%li%n", &time_tmp, &k);
 618             gdp->xrule = time_tmp;
 619             if (((j != 0) && (k == j)) || ((j == 0) && (k == i))) {
 620                 dprintf("- found time: %li\n", gdp->xrule);
 621             } else {
 622                 dprintf("- is is not a valid number: %li\n", gdp->xrule);
 623                 rrd_set_error
 624                     ("parameter '%s' does not represent time in line %s\n",
 625                      tmpstr, line);
 626                 return 1;
 627             }
 628         default:
 629             k = 0;
 630             sscanf(tmpstr, "%lf%n", &gdp->yrule, &k);
 631             if (((j != 0) && (k == j)) || ((j == 0) && (k == i))) {
 632                 dprintf("- found number: %lf\n", gdp->yrule);
 633             } else {
 634                 dprintf("- is is not a valid number: %lf\n", gdp->yrule);
 635                 rrd_set_error
 636                     ("parameter '%s' does not represent a number in line %s\n",
 637                      tmpstr, line);
 638                 return 1;
 639             }
 640         }
 641     }
 642
 643     if (j) {
 644         j++;
 645         dprintf("- examining color '%s'\n", &tmpstr[j]);
 646         if (rrd_parse_color(&tmpstr[j], gdp)) {
 647             rrd_set_error("Could not parse color in '%s'", &tmpstr[j]);
 648             return 1;
 649         }
 650         dprintf("- parsed color %0.0f,%0.0f,%0.0f,%0.0f\n", gdp->col.red,
 651                 gdp->col.green, gdp->col.blue, gdp->col.alpha);
 652         colorfound = 1;
 653     } else {
 654         dprintf("- no color present in '%s'\n", tmpstr);
 655     }
 656
 657     (*eaten) += i;      /* after vname#color */
 658     if (line[*eaten] != '\0') {
 659         (*eaten)++;     /* after colon */
 660     }
 661
 662     if (gdp->gf == GF_TICK) {
 663         dprintf("- parsing '%s'\n", &line[*eaten]);
 664         dprintf("- looking for optional TICK number\n");
 665         j = 0;
 666         sscanf(&line[*eaten], "%lf%n", &gdp->yrule, &j);
 667         if (j) {
 668             if (line[*eaten + j] != '\0' && line[*eaten + j] != ':') {
 669                 rrd_set_error("Cannot parse TICK fraction '%s'", line);
 670                 return 1;
 671             }
 672             dprintf("- found number %f\n", gdp->yrule);
 673             if (gdp->yrule > 1.0 || gdp->yrule < -1.0) {
 674                 rrd_set_error("Tick factor should be <= 1.0");
 675                 return 1;
 676             }
 677             (*eaten) += j;
 678         } else {
 679             dprintf("- not found, defaulting to 0.1\n");
 680             gdp->yrule = 0.1;
 681         }
 682         if (line[*eaten] == '\0') {
 683             dprintf("- done parsing line\n");
 684             return 0;
 685         } else {
 686             if (line[*eaten] == ':') {
 687                 (*eaten)++;
 688             } else {
 689                 rrd_set_error("Can't make sense of that TICK line");
 690                 return 1;
 691             }
 692         }
 693     }
 694
 695     dprintf("- parsing '%s'\n", &line[*eaten]);
 696
 697     /* Legend is next.  A legend without a color is an error.
 698      ** Stacking an item without having a legend is OK however
 699      ** then an empty legend should be specified.
 700      **   LINE:val#color:STACK  means legend is string "STACK"
 701      **   LINE:val#color::STACK means no legend, and do STACK
 702      **   LINE:val:STACK        is an error (legend but no color)
 703      **   LINE:val::STACK   means no legend, and do STACK
 704      */
 705     if (colorfound) {
 706         int       err = 0;
 707         char     *linecp = strdup(line);
 708
 709         dprintf("- looking for optional legend\n");
 710
 711         dprintf("- examining '%s'\n", &line[*eaten]);
 712         if (linecp[*eaten] != '\0' && linecp[*eaten] != ':') {
 713             int       spi;
 714
 715             /* If the legend is not empty, it has to be prefixed with spacecnt ' ' characters. This then gets
 716              * replaced by the color box later on. */
 717             for (spi = 0; spi < spacecnt && (*eaten) > 1; spi++) {
 718                 linecp[--(*eaten)] = ' ';
 719             }
 720         }
 721
 722         if (rrd_parse_legend(linecp, eaten, gdp))
 723             err = 1;
 724         free(linecp);
 725         if (err)
 726             return 1;
 727
 728         dprintf("- found legend '%s'\n", &gdp->legend[2]);
 729     } else {
 730         dprintf("- skipping empty legend\n");
 731         if (line[*eaten] != '\0' && line[*eaten] != ':') {
 732             rrd_set_error("Legend set but no color: %s", &line[*eaten]);
 733             return 1;
 734         }
 735     }
 736     if (line[*eaten] == '\0') {
 737         dprintf("- done parsing line\n");
 738         return 0;
 739     }
 740     (*eaten)++;         /* after colon */
 741
 742     /* PART, HRULE, VRULE and TICK cannot be stacked. */
 743     if ((gdp->gf != GF_HRULE)
 744         && (gdp->gf != GF_VRULE)
 745         && (gdp->gf != GF_TICK)) {
 746
 747         dprintf("- parsing '%s', looking for STACK\n", &line[*eaten]);
 748         j = scan_for_col(&line[*eaten], 5, tmpstr);
 749         if (!strcmp("STACK", tmpstr)) {
 750             dprintf("- found STACK\n");
 751             gdp->stack = 1;
 752             (*eaten) += j;
 753             if (line[*eaten] == ':') {
 754                 (*eaten) += 1;
 755             } else if (line[*eaten] == '\0') {
 756                 dprintf("- done parsing line\n");
 757                 return 0;
 758             } else {
 759                 dprintf("- found %s instead of just STACK\n", &line[*eaten]);
 760                 rrd_set_error("STACK expected but %s found", &line[*eaten]);
 761                 return 1;
 762             }
 763         } else
 764             dprintf("- not STACKing\n");
 765     }
 766
 767     dprintf("- still more, should be DASHED[:...]\n");
 768     dprintf("- parsing '%s'\n", &line[*eaten]);
 769     if (line[*eaten] != '\0') {
 770         // parse dash arguments here. Possible options:
 771         // DASHED
 772         // DASHED:dashes=n_on,n_off,n_on,n_off
 773         // DASHED:dashes=n_on,n_off,n_on,n_off:dash-offset=offset
 774         // start with DASHED
 775         j = scan_for_col(&line[*eaten], 6, tmpstr);
 776         if (!strcmp("DASHED", tmpstr)) {
 777             dprintf("- found %s\n", tmpstr);
 778             // initialise all required variables we need for dashed lines
 779             // using default dash length of 5 pixels
 780             gdp->dash = 1;
 781             gdp->p_dashes = (double *) malloc(sizeof(double));
 782             gdp->p_dashes[0] = 5;
 783             gdp->ndash = 1;
 784             gdp->offset = 0;
 785             (*eaten) += j;
 786             if (line[*eaten] == ':')
 787                 (*eaten) += 1;
 788         }
 789         if (line[*eaten] == '\0') {
 790             dprintf("- done parsing line\n");
 791             return 0;
 792         }
 793         // DASHED:dashes=n_on,n_off,n_on,n_off
 794         // allowing 64 characters for definition of dash style
 795         j = scan_for_col(&line[*eaten], 64, tmpstr);
 796         if (sscanf(tmpstr, "dashes=%s", tmpstr)) {
 797             char      csv[64];
 798             char     *pch;
 799             float     dsh;
 800
 801             strcpy(csv, tmpstr);
 802             int       count = 0;
 803
 804             pch = strtok(tmpstr, ",");
 805             while (pch != NULL) {
 806                 pch = strtok(NULL, ",");
 807                 count++;
 808             }
 809             dprintf("- %d dash values found: ", count);
 810             gdp->ndash = count;
 811             if (gdp->p_dashes != NULL)
 812                 free(gdp->p_dashes);
 813             gdp->p_dashes = (double *) malloc(sizeof(double) * count);
 814             pch = strtok(csv, ",");
 815             count = 0;
 816             while (pch != NULL) {
 817                 if (sscanf(pch, "%f", &dsh)) {
 818                     gdp->p_dashes[count] = (double) dsh;
 819                     dprintf("%.1f ", gdp->p_dashes[count]);
 820                     count++;
 821                 }
 822                 pch = strtok(NULL, ",");
 823             }
 824             dprintf("\n");
 825             (*eaten) += j;
 826             if (line[*eaten] == ':')
 827                 (*eaten) += 1;
 828         }
 829         if (line[*eaten] == '\0') {
 830             dprintf("- done parsing line\n");
 831             return 0;
 832         }
 833         // DASHED:dashes=n_on,n_off,n_on,n_off:dash-offset=offset
 834         // allowing 16 characters for dash-offset=....
 835         // => 4 characters for the offset value
 836         j = scan_for_col(&line[*eaten], 16, tmpstr);
 837         if (sscanf(tmpstr, "dash-offset=%lf", &gdp->offset)) {
 838             dprintf("- found %s\n", tmpstr);
 839             gdp->dash = 1;
 840             (*eaten) += j;
 841             if (line[*eaten] == ':')
 842                 (*eaten) += 1;
 843         }
 844         if (line[*eaten] == '\0') {
 845             dprintf("- done parsing line\n");
 846             return 0;
 847         }
 848     }
 849     if (line[*eaten] == '\0') {
 850         dprintf("- done parsing line\n");
 851         return 0;
 852     }
 853     (*eaten)++;
 854     dprintf("- parsing '%s'\n", &line[*eaten]);
 855
 856     return 0;
 857 }
 858
 859 int rrd_parse_make_vname(
 860     const char *const line,
 861     unsigned int *const eaten,
 862     graph_desc_t *const gdp,
 863     image_desc_t *const im)
 864 {
 865     char      tmpstr[MAX_VNAME_LEN + 10];
 866     int       i = 0;
 867
 868     sscanf(&line[*eaten], DEF_NAM_FMT "=%n", tmpstr, &i);
 869     if (!i) {
 870         rrd_set_error("Cannot parse vname from '%s'", line);
 871         return 1;
 872     }
 873     dprintf("- found candidate '%s'\n", tmpstr);
 874
 875     if ((gdp->vidx = find_var(im, tmpstr)) >= 0) {
 876         rrd_set_error("Attempting to reuse '%s'", im->gdes[gdp->vidx].vname);
 877         return 1;
 878     }
 879     strcpy(gdp->vname, tmpstr);
 880     dprintf("- created vname '%s' vidx %lu\n", gdp->vname, im->gdes_c - 1);
 881     (*eaten) += i;
 882     return 0;
 883 }
 884
 885 int rrd_parse_def(
 886     const char *const line,
 887     unsigned int *const eaten,
 888     graph_desc_t *const gdp,
 889     image_desc_t *const im)
 890 {
 891     int       i = 0;
 892     char      command[7];   /* step, start, end, reduce */
 893     char      tmpstr[256];
 894     struct rrd_time_value start_tv, end_tv;
 895     time_t    start_tmp = 0, end_tmp = 0;
 896     char     *parsetime_error = NULL;
 897
 898     start_tv.type = end_tv.type = ABSOLUTE_TIME;
 899     start_tv.offset = end_tv.offset = 0;
 900     localtime_r(&gdp->start, &start_tv.tm);
 901     localtime_r(&gdp->end, &end_tv.tm);
 902
 903     dprintf("- parsing '%s'\n", &line[*eaten]);
 904     dprintf("- from line '%s'\n", line);
 905
 906     if (rrd_parse_make_vname(line, eaten, gdp, im))
 907         return 1;
 908     i = scan_for_col(&line[*eaten], sizeof(gdp->rrd) - 1, gdp->rrd);
 909     if (line[*eaten + i] != ':') {
 910         rrd_set_error("Problems reading database name");
 911         return 1;
 912     }
 913     (*eaten) += ++i;
 914     dprintf("- using file '%s'\n", gdp->rrd);
 915
 916     i = 0;
 917     sscanf(&line[*eaten], DS_NAM_FMT ":%n", gdp->ds_nam, &i);
 918     if (!i) {
 919         rrd_set_error("Cannot parse DS in '%s'", line);
 920         return 1;
 921     }
 922     (*eaten) += i;
 923     dprintf("- using DS '%s'\n", gdp->ds_nam);
 924
 925     if (rrd_parse_CF(line, eaten, gdp, &gdp->cf))
 926         return 1;
 927     gdp->cf_reduce = gdp->cf;
 928
 929     if (line[*eaten] == '\0')
 930         return 0;
 931
 932     while (1) {
 933         dprintf("- optional parameter follows: %s\n", &line[*eaten]);
 934         i = 0;
 935         sscanf(&line[*eaten], "%6[a-z]=%n", command, &i);
 936         if (!i) {
 937             rrd_set_error("Parse error in '%s'", line);
 938             return 1;
 939         }
 940         (*eaten) += i;
 941         dprintf("- processing '%s'\n", command);
 942         if (!strcmp("reduce", command)) {
 943             if (rrd_parse_CF(line, eaten, gdp, &gdp->cf_reduce))
 944                 return 1;
 945             if (line[*eaten] != '\0')
 946                 (*eaten)--;
 947         } else if (!strcmp("step", command)) {
 948             i = 0;
 949             sscanf(&line[*eaten], "%lu%n", &gdp->step, &i);
 950             gdp->step_orig = gdp->step;
 951             (*eaten) += i;
 952             dprintf("- using step %lu\n", gdp->step);
 953         } else if (!strcmp("start", command)) {
 954             i = scan_for_col(&line[*eaten], 255, tmpstr);
 955             (*eaten) += i;
 956             if ((parsetime_error = parsetime(tmpstr, &start_tv))) {
 957                 rrd_set_error("start time: %s", parsetime_error);
 958                 return 1;
 959             }
 960             dprintf("- done parsing:  '%s'\n", &line[*eaten]);
 961         } else if (!strcmp("end", command)) {
 962             i = scan_for_col(&line[*eaten], 255, tmpstr);
 963             (*eaten) += i;
 964             if ((parsetime_error = parsetime(tmpstr, &end_tv))) {
 965                 rrd_set_error("end time: %s", parsetime_error);
 966                 return 1;
 967             }
 968             dprintf("- done parsing:  '%s'\n", &line[*eaten]);
 969         } else {
 970             rrd_set_error("Parse error in '%s'", line);
 971             return 1;
 972         }
 973         if (line[*eaten] == '\0')
 974             break;
 975         if (line[*eaten] != ':') {
 976             dprintf("- Expected to see end of string but got '%s'\n",
 977                     &line[*eaten]);
 978             rrd_set_error("Parse error in '%s'", line);
 979             return 1;
 980         }
 981         (*eaten)++;
 982     }
 983     if (proc_start_end(&start_tv, &end_tv, &start_tmp, &end_tmp) == -1) {
 984         /* error string is set in parsetime.c */
 985         return 1;
 986     }
 987     if (start_tmp < 3600 * 24 * 365 * 10) {
 988         rrd_set_error("the first entry to fetch should be "
 989                       "after 1980 (%ld)", start_tmp);
 990         return 1;
 991     }
 992
 993     if (end_tmp < start_tmp) {
 994         rrd_set_error("start (%ld) should be less than end (%ld)",
 995                       start_tmp, end_tmp);
 996         return 1;
 997     }
 998
 999     gdp->start = start_tmp;
1000     gdp->end = end_tmp;
1001     gdp->start_orig = start_tmp;
1002     gdp->end_orig = end_tmp;
1003
1004     dprintf("- start time %lu\n", gdp->start);
1005     dprintf("- end   time %lu\n", gdp->end);
1006
1007     return 0;
1008 }
1009
1010 int rrd_parse_vdef(
1011     const char *const line,
1012     unsigned int *const eaten,
1013     graph_desc_t *const gdp,
1014     image_desc_t *const im)
1015 {
1016     char      tmpstr[MAX_VNAME_LEN + 1];    /* vname\0 */
1017     int       i = 0;
1018
1019     dprintf("- parsing '%s'\n", &line[*eaten]);
1020     if (rrd_parse_make_vname(line, eaten, gdp, im))
1021         return 1;
1022
1023     sscanf(&line[*eaten], DEF_NAM_FMT ",%n", tmpstr, &i);
1024     if (!i) {
1025         rrd_set_error("Cannot parse line '%s'", line);
1026         return 1;
1027     }
1028     if ((gdp->vidx = find_var(im, tmpstr)) < 0) {
1029         rrd_set_error("Not a valid vname: %s in line %s", tmpstr, line);
1030         return 1;
1031     }
1032     if (im->gdes[gdp->vidx].gf != GF_DEF && im->gdes[gdp->vidx].gf != GF_CDEF) {
1033         rrd_set_error("variable '%s' not DEF nor "
1034                       "CDEF in VDEF '%s'", tmpstr, gdp->vname);
1035         return 1;
1036     }
1037     dprintf("- found vname: '%s' vidx %li\n", tmpstr, gdp->vidx);
1038     (*eaten) += i;
1039
1040     dprintf("- calling vdef_parse with param '%s'\n", &line[*eaten]);
1041     vdef_parse(gdp, &line[*eaten]);
1042     while (line[*eaten] != '\0' && line[*eaten] != ':')
1043         (*eaten)++;
1044
1045     return 0;
1046 }
1047
1048 int rrd_parse_cdef(
1049     const char *const line,
1050     unsigned int *const eaten,
1051     graph_desc_t *const gdp,
1052     image_desc_t *const im)
1053 {
1054     dprintf("- parsing '%s'\n", &line[*eaten]);
1055     if (rrd_parse_make_vname(line, eaten, gdp, im))
1056         return 1;
1057     if ((gdp->rpnp = rpn_parse((void *) im, &line[*eaten], &find_var_wrapper)
1058         ) == NULL) {
1059         rrd_set_error("invalid rpn expression in: %s", &line[*eaten]);
1060         return 1;
1061     };
1062     while (line[*eaten] != '\0' && line[*eaten] != ':')
1063         (*eaten)++;
1064     return 0;
1065 }
1066
1067 void rrd_graph_script(
1068     int argc,
1069     char *argv[],
1070     image_desc_t *const im,
1071     int optno)
1072 {
1073     int       i;
1074
1075     /* save state for STACK backward compat function */
1076     enum gf_en last_gf = GF_PRINT;
1077     float     last_linewidth = 0.0;
1078
1079     for (i = optind + optno; i < argc; i++) {
1080         graph_desc_t *gdp;
1081         unsigned int eaten = 0;
1082
1083         if (gdes_alloc(im))
1084             return;     /* the error string is already set */
1085         gdp = &im->gdes[im->gdes_c - 1];
1086 #ifdef DEBUG
1087         gdp->debug = 1;
1088 #endif
1089
1090         if (rrd_parse_find_gf(argv[i], &eaten, gdp))
1091             return;
1092
1093         switch (gdp->gf) {
1094         case GF_SHIFT: /* vname:value */
1095             if (rrd_parse_shift(argv[i], &eaten, gdp, im))
1096                 return;
1097             break;
1098         case GF_TEXTALIGN: /* left|right|center|justified */
1099             if (rrd_parse_textalign(argv[i], &eaten, gdp))
1100                 return;
1101             break;
1102         case GF_XPORT:
1103             if (rrd_parse_xport(argv[i], &eaten, gdp, im))
1104                 return;
1105             break;
1106         case GF_PRINT: /* vname:CF:format -or- vname:format */
1107             im->prt_c++;
1108         case GF_GPRINT:    /* vname:CF:format -or- vname:format */
1109             if (rrd_parse_print(argv[i], &eaten, gdp, im))
1110                 return;
1111             break;
1112         case GF_COMMENT:   /* text */
1113             if (rrd_parse_legend(argv[i], &eaten, gdp))
1114                 return;
1115             break;
1116         case GF_VRULE: /* value#color[:legend] */
1117         case GF_HRULE: /* value#color[:legend] */
1118         case GF_LINE:  /* vname-or-value[#color[:legend]][:STACK] */
1119         case GF_AREA:  /* vname-or-value[#color[:legend]][:STACK] */
1120         case GF_TICK:  /* vname#color[:num[:legend]] */
1121             if (rrd_parse_PVHLAST(argv[i], &eaten, gdp, im))
1122                 return;
1123             last_gf = gdp->gf;
1124             last_linewidth = gdp->linewidth;
1125             break;
1126         case GF_STACK: /* vname-or-value[#color[:legend]] */
1127             if (rrd_parse_PVHLAST(argv[i], &eaten, gdp, im))
1128                 return;
1129             if (last_gf == GF_LINE || last_gf == GF_AREA) {
1130                 gdp->gf = last_gf;
1131                 gdp->linewidth = last_linewidth;
1132             } else {
1133                 rrd_set_error("STACK must follow LINE or AREA! command:\n%s",
1134                               &argv[i][eaten], argv[i]);
1135                 return;
1136             }
1137             break;
1138             /* data acquisition */
1139         case GF_DEF:   /* vname=x:DS:CF:[:step=#][:start=#][:end=#] */
1140             if (rrd_parse_def(argv[i], &eaten, gdp, im))
1141                 return;
1142             break;
1143         case GF_CDEF:  /* vname=rpn-expression */
1144             if (rrd_parse_cdef(argv[i], &eaten, gdp, im))
1145                 return;
1146             break;
1147         case GF_VDEF:  /* vname=rpn-expression */
1148             if (rrd_parse_vdef(argv[i], &eaten, gdp, im))
1149                 return;
1150             break;
1151         }
1152         if (gdp->debug) {
1153             dprintf("used %i out of %zi chars\n", eaten, strlen(argv[i]));
1154             dprintf("parsed line: '%s'\n", argv[i]);
1155             dprintf("remaining: '%s'\n", &argv[i][eaten]);
1156             if (eaten >= strlen(argv[i]))
1157                 dprintf("Command finished successfully\n");
1158         }
1159         if (eaten < strlen(argv[i])) {
1160             rrd_set_error("I don't understand '%s' in command: '%s'.",
1161                           &argv[i][eaten], argv[i]);
1162             return;
1163         }
1164     }
1165 }