1 /*****************************************************************************
2 * RRDtool 1.1.x Copyright Tobias Oetiker, 1997 - 2004
3 *****************************************************************************
4 * rrd_cgi.c RRD Web Page Generator
5 *****************************************************************************/
13 /*#define DEBUG_PARSER
16 /* global variable for libcgi */
19 /* in arg[0] find tags beginning with arg[1] call arg[2] on them
20 and replace by result of arg[2] call */
21 int parse(char **, long, char *, char *(*)(long , const char **));
23 /**************************************************/
24 /* tag replacers ... they are called from parse */
25 /* through function pointers */
26 /**************************************************/
28 /* return cgi var named arg[0] */
29 char* cgiget(long , const char **);
31 /* return a quoted cgi var named arg[0] */
32 char* cgigetq(long , const char **);
34 /* return a quoted and sanitized cgi variable */
35 char* cgigetqp(long , const char **);
37 /* call rrd_graph and insert appropriate image tag */
38 char* drawgraph(long, char **);
40 /* return PRINT functions from last rrd_graph call */
41 char* drawprint(long, const char **);
43 /* pretty-print the <last></last> value for some.rrd via strftime() */
44 char* printtimelast(long, const char **);
46 /* pretty-print current time */
47 char* printtimenow(long, const char **);
49 /* set an environment variable */
50 char* rrdsetenv(long, const char **);
52 /* get an environment variable */
53 char* rrdgetenv(long, const char **);
55 /* include the named file at this point */
56 char* includefile(long, const char **);
58 /* for how long is the output of the cgi valid ? */
59 char* rrdgoodfor(long, const char **);
61 char* rrdstrip(char *buf);
62 char* scanargs(char *line, int *argc, char ***args);
64 /* format at-time specified times using strftime */
65 char* printstrftime(long, const char**);
67 /** HTTP protocol needs special format, and GMT time **/
68 char *http_time(time_t *);
70 /* return a pointer to newly allocated copy of this string */
71 char *stralloc(const char *);
74 /* rrd interface to the variable functions {put,get}var() */
75 char* rrdgetvar(long argc, const char **args);
76 char* rrdsetvar(long argc, const char **args);
77 char* rrdsetvarconst(long argc, const char **args);
80 /* variable store: put/get key-value pairs */
82 static void donevar();
83 static const char* getvar(const char* varname);
84 static const char* putvar(const char* name, const char* value, int is_const);
86 /* key value pair that makes up an entry in the variable store */
89 int is_const; /* const variable or not */
90 const char* name; /* variable name */
91 const char* value; /* variable value */
95 start with a heapsize of 10 variables */
96 #define INIT_VARSTORE_SIZE 10
97 static vardata* varheap = NULL;
98 static size_t varheap_size = 0;
100 /* allocate and initialize variable heap */
104 varheap = (vardata*)malloc(sizeof(vardata) * INIT_VARSTORE_SIZE);
105 if (varheap == NULL) {
106 fprintf(stderr, "ERROR: unable to initialize variable store\n");
109 memset(varheap, 0, sizeof(vardata) * INIT_VARSTORE_SIZE);
110 varheap_size = INIT_VARSTORE_SIZE;
114 /* cleanup: free allocated memory */
120 for (i=0; i<(int)varheap_size; i++) {
121 if (varheap[i].name) {
122 free((char*)varheap[i].name);
124 if (varheap[i].value) {
125 free((char*)varheap[i].value);
132 /* Get a variable from the variable store.
133 Return NULL in case the requested variable was not found. */
135 getvar(const char* name)
138 for (i=0; i<(int)varheap_size && varheap[i].name; i++) {
139 if (0 == strcmp(name, varheap[i].name)) {
141 printf("<!-- getvar(%s) -> %s -->\n", name, varheap[i].value);
143 return varheap[i].value;
147 printf("<!-- getvar(%s) -> Not found-->\n", name);
152 /* Put a variable into the variable store. If a variable by that
153 name exists, it's value is overwritten with the new value unless it was
154 marked as 'const' (initialized by RRD::SETCONSTVAR).
155 Returns a copy the newly allocated value on success, NULL on error. */
157 putvar(const char* name, const char* value, int is_const)
160 for (i=0; i < (int)varheap_size && varheap[i].name; i++) {
161 if (0 == strcmp(name, varheap[i].name)) {
162 /* overwrite existing entry */
163 if (varheap[i].is_const) {
165 printf("<!-- setver(%s, %s): not assigning: "
166 "const variable -->\n", name, value);
168 return varheap[i].value;
171 printf("<!-- setvar(%s, %s): overwriting old value (%s) -->\n",
172 name, value, varheap[i].value);
174 /* make it possible to promote a variable to readonly */
175 varheap[i].is_const = is_const;
176 free((char*)varheap[i].value);
177 varheap[i].value = stralloc(value);
178 return varheap[i].value;
182 /* no existing variable found by that name, add it */
183 if (i == (int)varheap_size) {
184 /* ran out of heap: resize heap to double size */
185 size_t new_size = varheap_size * 2;
186 varheap = (vardata*)(realloc(varheap, sizeof(vardata) * new_size));
188 fprintf(stderr, "ERROR: Unable to realloc variable heap\n");
191 /* initialize newly allocated memory */;
192 memset(&varheap[varheap_size], 0, sizeof(vardata) * varheap_size);
193 varheap_size = new_size;
195 varheap[i].is_const = is_const;
196 varheap[i].name = stralloc(name);
197 varheap[i].value = stralloc(value);
200 printf("<!-- setvar(%s, %s): adding new variable -->\n", name, value);
202 return varheap[i].value;
205 /* expand those RRD:* directives that can be used recursivly */
207 rrd_expand_vars(char* buffer)
212 printf("expanding variables in '%s'\n", buffer);
215 for (i=0; buffer[i]; i++) {
216 if (buffer[i] != '<')
218 parse(&buffer, i, "<RRD::CV", cgiget);
219 parse(&buffer, i, "<RRD::CV::QUOTE", cgigetq);
220 parse(&buffer, i, "<RRD::CV::PATH", cgigetqp);
221 parse(&buffer, i, "<RRD::GETENV", rrdgetenv);
222 parse(&buffer, i, "<RRD::GETVAR", rrdgetvar);
223 parse(&buffer, i, "<RRD::TIME::LAST", printtimelast);
224 parse(&buffer, i, "<RRD::TIME::NOW", printtimenow);
225 parse(&buffer, i, "<RRD::TIME::STRFTIME", printstrftime);
230 static long goodfor=0;
231 static char **calcpr=NULL;
232 static void calfree (void){
235 for(i=0;calcpr[i];i++){
246 /* create freeable version of the string */
247 char * stralloc(const char *str){
252 nstr = malloc((strlen(str)+1));
257 int main(int argc, char *argv[]) {
260 char *server_url = NULL;
263 #ifdef MUST_DISABLE_SIGFPE
264 signal(SIGFPE,SIG_IGN);
266 #ifdef MUST_DISABLE_FPMASK
269 /* what do we get for cmdline arguments?
271 printf("%d-'%s'\n",i,argv[i]); */
273 static struct option long_options[] = {
274 { "filter", no_argument, 0, 'f' },
277 int option_index = 0;
279 opt = getopt_long(argc, argv, "f", long_options, &option_index);
289 printf("unknown commandline option '%s'\n",argv[optind-1]);
297 server_url = getenv("SERVER_URL");
300 /* make sure we have one extra argument,
301 if there are others, we do not care Apache gives several */
303 /* if ( (optind != argc-2
304 && strstr( getenv("SERVER_SOFTWARE"),"Apache/2") != NULL)
305 && optind != argc-1) { */
307 if ( optind >= argc ) {
308 fprintf(stderr, "ERROR: expected a filename\n");
311 length = readfile(argv[optind], &buffer, 1);
314 if(rrd_test_error()) {
315 fprintf(stderr, "ERROR: %s\n",rrd_get_error());
319 /* initialize variable heap */
323 /* some fake header for testing */
324 printf ("Content-Type: text/html\nContent-Length: 10000000\n\n\n");
328 /* expand rrd directives in buffer recursivly */
329 for (i=0; buffer[i]; i++) {
330 if (buffer[i] != '<')
333 parse(&buffer, i, "<RRD::CV", cgiget);
334 parse(&buffer, i, "<RRD::CV::PATH", cgigetqp);
335 parse(&buffer, i, "<RRD::CV::QUOTE", cgigetq);
336 parse(&buffer, i, "<RRD::GETENV", rrdgetenv);
338 parse(&buffer, i, "<RRD::GETVAR", rrdgetvar);
339 parse(&buffer, i, "<RRD::GOODFOR", rrdgoodfor);
340 parse(&buffer, i, "<RRD::GRAPH", drawgraph);
341 parse(&buffer, i, "<RRD::INCLUDE", includefile);
342 parse(&buffer, i, "<RRD::PRINT", drawprint);
343 parse(&buffer, i, "<RRD::SETCONSTVAR", rrdsetvarconst);
344 parse(&buffer, i, "<RRD::SETENV", rrdsetenv);
345 parse(&buffer, i, "<RRD::SETVAR", rrdsetvar);
346 parse(&buffer, i, "<RRD::TIME::LAST", printtimelast);
347 parse(&buffer, i, "<RRD::TIME::NOW", printtimenow);
348 parse(&buffer, i, "<RRD::TIME::STRFTIME", printstrftime);
352 printf ("Content-Type: text/html\n"
353 "Content-Length: %d\n",
356 if (labs(goodfor) > 0) {
359 printf("Last-Modified: %s\n", http_time(&now));
360 now += labs(goodfor);
361 printf("Expires: %s\n", http_time(&now));
363 printf("Refresh: %ld\n", labs(goodfor));
370 printf("%s", buffer);
381 /* remove occurrences of .. this is a general measure to make
382 paths which came in via cgi do not go UP ... */
384 char* rrdsetenv(long argc, const char **args) {
386 char *xyz = malloc((strlen(args[0]) + strlen(args[1]) + 2));
388 return stralloc("[ERROR: allocating setenv buffer]");
390 sprintf(xyz, "%s=%s", args[0], args[1]);
391 if(putenv(xyz) == -1) {
393 return stralloc("[ERROR: failed to do putenv]");
396 return stralloc("[ERROR: setenv failed because not enough "
397 "arguments were defined]");
400 /* rrd interface to the variable function putvar() */
402 rrdsetvar(long argc, const char **args)
406 const char* result = putvar(args[0], args[1], 0 /* not const */);
408 /* setvar does not return the value set */
411 return stralloc("[ERROR: putvar failed]");
413 return stralloc("[ERROR: putvar failed because not enough arguments "
417 /* rrd interface to the variable function putvar() */
419 rrdsetvarconst(long argc, const char **args)
423 const char* result = putvar(args[0], args[1], 1 /* const */);
425 /* setvar does not return the value set */
428 return stralloc("[ERROR: putvar failed]");
430 return stralloc("[ERROR: putvar failed because not enough arguments "
434 char* rrdgetenv(long argc, const char **args) {
438 return stralloc("[ERROR: getenv failed because it did not "
439 "get 1 argument only]");
441 envvar = getenv(args[0]);
443 return stralloc(envvar);
446 _snprintf(buf, sizeof(buf), "[ERROR:_getenv_'%s'_failed", args[0]);
448 snprintf(buf, sizeof(buf), "[ERROR:_getenv_'%s'_failed", args[0]);
450 return stralloc(buf);
454 char* rrdgetvar(long argc, const char **args) {
458 return stralloc("[ERROR: getvar failed because it did not "
459 "get 1 argument only]");
461 value = getvar(args[0]);
463 return stralloc(value);
466 _snprintf(buf, sizeof(buf), "[ERROR:_getvar_'%s'_failed", args[0]);
468 snprintf(buf, sizeof(buf), "[ERROR:_getvar_'%s'_failed", args[0]);
470 return stralloc(buf);
474 char* rrdgoodfor(long argc, const char **args){
476 goodfor = atol(args[0]);
478 return stralloc("[ERROR: goodfor expected 1 argument]");
482 return stralloc("[ERROR: goodfor value must not be 0]");
488 /* Format start or end times using strftime. We always need both the
489 * start and end times, because, either might be relative to the other.
491 #define MAX_STRFTIME_SIZE 256
492 char* printstrftime(long argc, const char **args){
493 struct rrd_time_value start_tv, end_tv;
494 char *parsetime_error = NULL;
495 char formatted[MAX_STRFTIME_SIZE];
497 time_t start_tmp, end_tmp;
499 /* Make sure that we were given the right number of args */
501 rrd_set_error( "wrong number of args %d", argc);
505 /* Init start and end time */
506 parsetime("end-24h", &start_tv);
507 parsetime("now", &end_tv);
509 /* Parse the start and end times we were given */
510 if( (parsetime_error = parsetime( args[1], &start_tv))) {
511 rrd_set_error( "start time: %s", parsetime_error);
514 if( (parsetime_error = parsetime( args[2], &end_tv))) {
515 rrd_set_error( "end time: %s", parsetime_error);
518 if( proc_start_end( &start_tv, &end_tv, &start_tmp, &end_tmp) == -1) {
522 /* Do we do the start or end */
523 if( strcasecmp( args[0], "START") == 0) {
524 the_tm = localtime( &start_tmp);
526 else if( strcasecmp( args[0], "END") == 0) {
527 the_tm = localtime( &end_tmp);
530 rrd_set_error( "start/end not found in '%s'", args[0]);
535 if( strftime( formatted, MAX_STRFTIME_SIZE, args[3], the_tm)) {
536 return( stralloc( formatted));
539 rrd_set_error( "strftime failed");
544 char* includefile(long argc, const char **args){
547 char* filename = args[0];
548 readfile(filename, &buffer, 0);
549 if (rrd_test_error()) {
550 char *err = malloc((strlen(rrd_get_error())+DS_NAM_SIZE));
551 sprintf(err, "[ERROR: %s]",rrd_get_error());
560 return stralloc("[ERROR: No Inclue file defined]");
564 /* make a copy of buf and replace open/close brackets with '_' */
565 char* rrdstrip(char *buf) {
570 /* make a copy of the buffer */
578 if (*p == '<' || *p == '>') {
586 char* cgigetq(long argc, const char **args){
588 char *buf = rrdstrip(cgiGetValue(cgiArg,args[0]));
592 if (buf==NULL) return NULL;
594 for(c=buf;*c != '\0';c++)
596 if ((buf2 = malloc((strlen(buf) + 4 * qc + 4))) == NULL) {
597 perror("Malloc Buffer");
618 return stralloc("[ERROR: not enough argument for RRD::CV::QUOTE]");
621 /* remove occurrences of .. this is a general measure to make
622 paths which came in via cgi do not go UP ... */
624 char* cgigetqp(long argc, const char **args){
632 return stralloc("[ERROR: not enough arguments for RRD::CV::PATH]");
635 buf = rrdstrip(cgiGetValue(cgiArg, args[0]));
641 buf2 = malloc(strlen(buf)+1);
644 perror("cgigetqp(): Malloc Path Buffer");
653 /* prevent mallicious paths from entering the system */
654 if (p[0] == '.' && p[1] == '.')
669 /* Make sure the path is relative, e.g. does not start with '/' */
680 char* cgiget(long argc, const char **args){
682 return rrdstrip(cgiGetValue(cgiArg,args[0]));
684 return stralloc("[ERROR: not enough arguments for RRD::CV]");
689 char* drawgraph(long argc, char **args){
693 if(strcmp(args[i],"--imginfo")==0 || strcmp(args[i],"-g")==0) break;
695 args[argc++] = "--imginfo";
696 args[argc++] = "<IMG SRC=\"./%s\" WIDTH=\"%lu\" HEIGHT=\"%lu\">";
698 optind=0; /* reset gnu getopt */
699 opterr=0; /* reset gnu getopt */
701 if( rrd_graph(argc+1, args-1, &calcpr, &xsize, &ysize,NULL,&ymin,&ymax) != -1 ) {
702 return stralloc(calcpr[0]);
704 if (rrd_test_error()) {
705 char *err = malloc((strlen(rrd_get_error())+DS_NAM_SIZE)*sizeof(char));
706 sprintf(err, "[ERROR: %s]",rrd_get_error());
715 char* drawprint(long argc, const char **args){
716 if (argc==1 && calcpr){
718 while (calcpr[i] != NULL) i++; /*determine number lines in calcpr*/
719 if (atol(args[0])<i-1)
720 return stralloc(calcpr[atol(args[0])+1]);
722 return stralloc("[ERROR: RRD::PRINT argument error]");
725 char* printtimelast(long argc, const char **args) {
732 return stralloc("[ERROR: allocating strftime buffer]");
734 last = rrd_last(argc+1, args-1);
735 if (rrd_test_error()) {
736 char *err = malloc((strlen(rrd_get_error())+DS_NAM_SIZE)*sizeof(char));
737 sprintf(err, "[ERROR: %s]",rrd_get_error());
741 tm_last = *localtime(&last);
742 strftime(buf,254,args[1],&tm_last);
746 return stralloc("[ERROR: too few arguments for RRD::TIME::LAST]");
748 return stralloc("[ERROR: not enough arguments for RRD::TIME::LAST]");
751 char* printtimenow(long argc, const char **args) {
752 time_t now = time(NULL);
758 return stralloc("[ERROR: allocating strftime buffer]");
760 tm_now = *localtime(&now);
761 strftime(buf,254,args[0],&tm_now);
765 return stralloc("[ERROR: too few arguments for RRD::TIME::NOW]");
767 return stralloc("[ERROR: not enough arguments for RRD::TIME::NOW]");
770 /* Scan buffer until an unescaped '>' arives.
771 * Update argument array with arguments found.
772 * Return end cursor where parsing stopped, or NULL in case of failure.
775 * To allow nested constructs, we call rrd_expand_vars() for arguments
776 * that contain RRD::x directives. These introduce a small memory leak
777 * since we have to stralloc the arguments the way parse() works.
780 scanargs(char *line, int *argument_count, char ***arguments)
782 char *getP; /* read cursor */
783 char *putP; /* write cursor */
784 char Quote; /* type of quote if in quoted string, 0 otherwise */
785 int tagcount; /* open tag count */
786 int in_arg; /* if we currently are parsing an argument or not */
787 int argsz; /* argument array size */
788 int curarg_contains_rrd_directives;
790 /* local array of arguments while parsing */
795 printf("<-- scanargs(%s) -->\n", line);
801 /* create initial argument array of char pointers */
803 argv = (char **)malloc(argsz * sizeof(char *));
808 /* skip leading blanks */
809 while (isspace((int)*line)) {
820 curarg_contains_rrd_directives = 0;
822 /* start parsing 'line' for arguments */
825 unsigned char c = *getP++;
827 if (c == '>' && !Quote && !tagcount) {
828 /* this is our closing tag, quit scanning */
832 /* remove all special chars */
840 if (Quote || tagcount) {
841 /* copy quoted/tagged (=RRD expanded) string */
846 /* end argument string */
849 if (curarg_contains_rrd_directives) {
850 argv[argc-1] = rrd_expand_vars(stralloc(argv[argc-1]));
851 curarg_contains_rrd_directives = 0;
856 case '"': /* Fall through */
862 /* copy quoted string */
867 /* reference start of argument string in argument array */
877 /* start new argument */
888 if (0 == strncmp(getP, "RRD::", strlen("RRD::"))) {
889 curarg_contains_rrd_directives = 1;
896 /* check if our argument array is still large enough */
898 /* resize argument array */
900 argv = rrd_realloc(argv, argsz * sizeof(char *));
907 /* terminate last argument found */
909 if (curarg_contains_rrd_directives) {
910 argv[argc-1] = rrd_expand_vars(stralloc(argv[argc-1]));
916 printf("<-- arguments found [%d]\n", argc);
917 for (n=0; n<argc; n++) {
918 printf("arg %02d: '%s'\n", n, argv[n]);
922 printf("<!-- No arguments found -->\n");
926 /* update caller's notion of the argument array and it's size */
928 *argument_count = argc;
934 /* Return new scanning cursor:
935 pointer to char after closing bracket */
941 * Parse(): scan current portion of buffer for given tag.
942 * If found, parse tag arguments and call 'func' for it.
943 * The result of func is inserted at the current position
948 char **buf, /* buffer */
949 long i, /* offset in buffer */
950 char *tag, /* tag to handle */
951 char *(*func)(long , const char **) /* function to call for 'tag' */
954 /* the name of the vairable ... */
961 size_t taglen = strlen(tag);
963 /* Current position in buffer should start with 'tag' */
964 if (strncmp((*buf)+i, tag, taglen) != 0) {
967 /* .. and match exactly (a whitespace following 'tag') */
968 if (! isspace(*((*buf) + i + taglen)) ) {
973 printf("parse(): handling tag '%s'\n", tag);
976 /* Scan for arguments following the tag;
977 scanargs() puts \0 into *buf ... so after scanargs it is probably
978 not a good time to use strlen on buf */
979 end = scanargs((*buf) + i + taglen, &argc, &args);
982 /* got arguments, call function for 'tag' with arguments */
983 val = func(argc, args);
988 /* unable to parse arguments, undo 0-termination by scanargs */
989 for (; argc > 0; argc--) {
990 *((args[argc-1])-1) = ' ';
993 /* next call, try parsing at current offset +1 */
994 end = (*buf) + i + 1;
996 val = stralloc("[ERROR: Parsing Problem with the following text\n"
997 " Check original file. This may have been altered "
1001 /* remember offset where we have to continue parsing */
1002 end_offset = end - (*buf);
1006 valln = strlen(val);
1009 /* Optionally resize buffer to hold the replacement value:
1010 Calculating the new length of the buffer is simple. add current
1011 buffer pos (i) to length of string after replaced tag to length
1012 of replacement string and add 1 for the final zero ... */
1013 if (end - (*buf) < (i + valln)) {
1014 /* make sure we do not shrink the mallocd block */
1015 size_t newbufsize = i + strlen(end) + valln + 1;
1016 *buf = rrd_realloc(*buf, newbufsize);
1019 perror("Realoc buf:");
1024 /* Update new end pointer:
1025 make sure the 'end' pointer gets moved along with the
1026 buf pointer when realloc moves memory ... */
1027 end = (*buf) + end_offset;
1029 /* splice the variable:
1030 step 1. Shift pending data to make room for 'val' */
1031 memmove((*buf) + i + valln, end, strlen(end) + 1);
1033 /* step 2. Insert val */
1035 memmove((*buf)+i, val, valln);
1038 return (valln > 0 ? valln-1: valln);
1042 http_time(time_t *now) {
1044 static char buf[60];
1046 tmptime=gmtime(now);
1047 strftime(buf,sizeof(buf),"%a, %d %b %Y %H:%M:%S GMT",tmptime);