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);
227 static long goodfor=0;
228 static char **calcpr=NULL;
229 static void calfree (void){
232 for(i=0;calcpr[i];i++){
243 /* create freeable version of the string */
244 char * stralloc(const char *str){
249 nstr = malloc((strlen(str)+1));
254 int main(int argc, char *argv[]) {
257 char *server_url = NULL;
260 #ifdef MUST_DISABLE_SIGFPE
261 signal(SIGFPE,SIG_IGN);
263 #ifdef MUST_DISABLE_FPMASK
266 /* what do we get for cmdline arguments?
268 printf("%d-'%s'\n",i,argv[i]); */
270 static struct option long_options[] = {
271 { "filter", no_argument, 0, 'f' },
274 int option_index = 0;
276 opt = getopt_long(argc, argv, "f", long_options, &option_index);
286 printf("unknown commandline option '%s'\n",argv[optind-1]);
294 server_url = getenv("SERVER_URL");
297 /* make sure we have one extra argument,
298 if there are others, we do not care Apache gives several */
300 /* if ( (optind != argc-2
301 && strstr( getenv("SERVER_SOFTWARE"),"Apache/2") != NULL)
302 && optind != argc-1) { */
304 if ( optind >= argc ) {
305 fprintf(stderr, "ERROR: expected a filename\n");
308 length = readfile(argv[optind], &buffer, 1);
311 if(rrd_test_error()) {
312 fprintf(stderr, "ERROR: %s\n",rrd_get_error());
316 /* initialize variable heap */
319 /* expand rrd directives in buffer recursivly */
320 for (i=0; buffer[i]; i++) {
321 if (buffer[i] != '<')
324 parse(&buffer, i, "<RRD::CV", cgiget);
325 parse(&buffer, i, "<RRD::CV::PATH", cgigetqp);
326 parse(&buffer, i, "<RRD::CV::QUOTE", cgigetq);
327 parse(&buffer, i, "<RRD::GETENV", rrdgetenv);
329 parse(&buffer, i, "<RRD::GETVAR", rrdgetvar);
330 parse(&buffer, i, "<RRD::GOODFOR", rrdgoodfor);
331 parse(&buffer, i, "<RRD::GRAPH", drawgraph);
332 parse(&buffer, i, "<RRD::INCLUDE", includefile);
333 parse(&buffer, i, "<RRD::PRINT", drawprint);
334 parse(&buffer, i, "<RRD::SETCONSTVAR", rrdsetvarconst);
335 parse(&buffer, i, "<RRD::SETENV", rrdsetenv);
336 parse(&buffer, i, "<RRD::SETVAR", rrdsetvar);
337 parse(&buffer, i, "<RRD::TIME::LAST", printtimelast);
338 parse(&buffer, i, "<RRD::TIME::NOW", printtimenow);
339 parse(&buffer, i, "<RRD::TIME::STRFTIME", printstrftime);
343 printf ("Content-Type: text/html\n"
344 "Content-Length: %d\n",
347 if (labs(goodfor) > 0) {
350 printf("Last-Modified: %s\n", http_time(&now));
351 now += labs(goodfor);
352 printf("Expires: %s\n", http_time(&now));
354 printf("Refresh: %ld\n", labs(goodfor));
361 printf("%s", buffer);
372 /* remove occurrences of .. this is a general measure to make
373 paths which came in via cgi do not go UP ... */
375 char* rrdsetenv(long argc, const char **args) {
377 char *xyz = malloc((strlen(args[0]) + strlen(args[1]) + 2));
379 return stralloc("[ERROR: allocating setenv buffer]");
381 sprintf(xyz, "%s=%s", args[0], args[1]);
382 if(putenv(xyz) == -1) {
384 return stralloc("[ERROR: failed to do putenv]");
387 return stralloc("[ERROR: setenv failed because not enough "
388 "arguments were defined]");
391 /* rrd interface to the variable function putvar() */
393 rrdsetvar(long argc, const char **args)
397 const char* result = putvar(args[0], args[1], 0 /* not const */);
399 /* setvar does not return the value set */
402 return stralloc("[ERROR: putvar failed]");
404 return stralloc("[ERROR: putvar failed because not enough arguments "
408 /* rrd interface to the variable function putvar() */
410 rrdsetvarconst(long argc, const char **args)
414 const char* result = putvar(args[0], args[1], 1 /* const */);
416 /* setvar does not return the value set */
419 return stralloc("[ERROR: putvar failed]");
421 return stralloc("[ERROR: putvar failed because not enough arguments "
425 char* rrdgetenv(long argc, const char **args) {
429 return stralloc("[ERROR: getenv failed because it did not "
430 "get 1 argument only]");
432 envvar = getenv(args[0]);
434 return stralloc(envvar);
436 snprintf(buf, sizeof(buf), "[ERROR:_getenv_'%s'_failed", args[0]);
437 return stralloc(buf);
441 char* rrdgetvar(long argc, const char **args) {
445 return stralloc("[ERROR: getvar failed because it did not "
446 "get 1 argument only]");
448 value = getvar(args[0]);
450 return stralloc(value);
452 snprintf(buf, sizeof(buf), "[ERROR:_getvar_'%s'_failed", args[0]);
453 return stralloc(buf);
457 char* rrdgoodfor(long argc, const char **args){
459 goodfor = atol(args[0]);
461 return stralloc("[ERROR: goodfor expected 1 argument]");
465 return stralloc("[ERROR: goodfor value must not be 0]");
471 /* Format start or end times using strftime. We always need both the
472 * start and end times, because, either might be relative to the other.
474 #define MAX_STRFTIME_SIZE 256
475 char* printstrftime(long argc, const char **args){
476 struct rrd_time_value start_tv, end_tv;
477 char *parsetime_error = NULL;
478 char formatted[MAX_STRFTIME_SIZE];
480 time_t start_tmp, end_tmp;
482 /* Make sure that we were given the right number of args */
484 rrd_set_error( "wrong number of args %d", argc);
488 /* Init start and end time */
489 parsetime("end-24h", &start_tv);
490 parsetime("now", &end_tv);
492 /* Parse the start and end times we were given */
493 if( (parsetime_error = parsetime( args[1], &start_tv))) {
494 rrd_set_error( "start time: %s", parsetime_error);
497 if( (parsetime_error = parsetime( args[2], &end_tv))) {
498 rrd_set_error( "end time: %s", parsetime_error);
501 if( proc_start_end( &start_tv, &end_tv, &start_tmp, &end_tmp) == -1) {
505 /* Do we do the start or end */
506 if( strcasecmp( args[0], "START") == 0) {
507 the_tm = localtime( &start_tmp);
509 else if( strcasecmp( args[0], "END") == 0) {
510 the_tm = localtime( &end_tmp);
513 rrd_set_error( "start/end not found in '%s'", args[0]);
518 if( strftime( formatted, MAX_STRFTIME_SIZE, args[3], the_tm)) {
519 return( stralloc( formatted));
522 rrd_set_error( "strftime failed");
527 char* includefile(long argc, const char **args){
530 readfile(args[0], &buffer, 0);
531 if (rrd_test_error()) {
532 char *err = malloc((strlen(rrd_get_error())+DS_NAM_SIZE));
533 sprintf(err, "[ERROR: %s]",rrd_get_error());
542 return stralloc("[ERROR: No Inclue file defined]");
546 /* make a copy of buf and replace open/close brackets with '_' */
547 char* rrdstrip(char *buf) {
552 /* make a copy of the buffer */
560 if (*p == '<' || *p == '>') {
568 char* cgigetq(long argc, const char **args){
570 char *buf = rrdstrip(cgiGetValue(cgiArg,args[0]));
574 if (buf==NULL) return NULL;
576 for(c=buf;*c != '\0';c++)
578 if ((buf2 = malloc((strlen(buf) + 4 * qc + 4))) == NULL) {
579 perror("Malloc Buffer");
600 return stralloc("[ERROR: not enough argument for RRD::CV::QUOTE]");
603 /* remove occurrences of .. this is a general measure to make
604 paths which came in via cgi do not go UP ... */
606 char* cgigetqp(long argc, const char **args){
608 char *buf = rrdstrip(cgiGetValue(cgiArg,args[0]));
616 for(c=buf;*c != '\0';c++) {
622 if ((buf2 = malloc((strlen(buf) + 4 * qc + 4))) == NULL) {
623 perror("Malloc Buffer");
642 if (*c=='.' && *(c+1) == '.') {
644 *(d++) = '_'; *(d++) ='_';
655 return stralloc("[ERROR: not enough arguments for RRD::CV::PATH]");
659 char* cgiget(long argc, const char **args){
661 return rrdstrip(cgiGetValue(cgiArg,args[0]));
663 return stralloc("[ERROR: not enough arguments for RRD::CV]");
668 char* drawgraph(long argc, char **args){
671 if(strcmp(args[i],"--imginfo")==0 || strcmp(args[i],"-g")==0) break;
673 args[argc++] = "--imginfo";
674 args[argc++] = "<IMG SRC=\"./%s\" WIDTH=\"%lu\" HEIGHT=\"%lu\">";
676 optind=0; /* reset gnu getopt */
677 opterr=0; /* reset gnu getopt */
679 if( rrd_graph(argc+1, args-1, &calcpr, &xsize, &ysize,NULL) != -1 ) {
680 return stralloc(calcpr[0]);
682 if (rrd_test_error()) {
683 char *err = malloc((strlen(rrd_get_error())+DS_NAM_SIZE)*sizeof(char));
684 sprintf(err, "[ERROR: %s]",rrd_get_error());
693 char* drawprint(long argc, const char **args){
694 if (argc==1 && calcpr){
696 while (calcpr[i] != NULL) i++; /*determine number lines in calcpr*/
697 if (atol(args[0])<i-1)
698 return stralloc(calcpr[atol(args[0])+1]);
700 return stralloc("[ERROR: RRD::PRINT argument error]");
703 char* printtimelast(long argc, const char **args) {
710 return stralloc("[ERROR: allocating strftime buffer]");
712 last = rrd_last(argc+1, args-1);
713 if (rrd_test_error()) {
714 char *err = malloc((strlen(rrd_get_error())+DS_NAM_SIZE)*sizeof(char));
715 sprintf(err, "[ERROR: %s]",rrd_get_error());
719 tm_last = *localtime(&last);
720 strftime(buf,254,args[1],&tm_last);
724 return stralloc("[ERROR: too few arguments for RRD::TIME::LAST]");
726 return stralloc("[ERROR: not enough arguments for RRD::TIME::LAST]");
729 char* printtimenow(long argc, const char **args) {
730 time_t now = time(NULL);
736 return stralloc("[ERROR: allocating strftime buffer]");
738 tm_now = *localtime(&now);
739 strftime(buf,254,args[0],&tm_now);
743 return stralloc("[ERROR: too few arguments for RRD::TIME::NOW]");
745 return stralloc("[ERROR: not enough arguments for RRD::TIME::NOW]");
748 /* Scan buffer until an unescaped '>' arives.
749 * Update argument array with arguments found.
750 * Return end cursor where parsing stopped, or NULL in case of failure.
753 * To allow nested constructs, we call rrd_expand_vars() for arguments
754 * that contain RRD::x directives. These introduce a small memory leak
755 * since we have to stralloc the arguments the way parse() works.
758 scanargs(char *line, int *argument_count, char ***arguments)
760 char *getP; /* read cursor */
761 char *putP; /* write cursor */
762 char Quote; /* type of quote if in quoted string, 0 otherwise */
763 int tagcount; /* open tag count */
764 int in_arg; /* if we currently are parsing an argument or not */
765 int argsz; /* argument array size */
766 int curarg_contains_rrd_directives;
768 /* local array of arguments while parsing */
773 printf("<-- scanargs(%s) -->\n", line);
779 /* create initial argument array of char pointers */
781 argv = (char **)malloc(argsz * sizeof(char *));
786 /* skip leading blanks */
787 while (isspace((int)*line)) {
798 curarg_contains_rrd_directives = 0;
800 /* start parsing 'line' for arguments */
803 unsigned char c = *getP++;
805 if (c == '>' && !Quote && !tagcount) {
806 /* this is our closing tag, quit scanning */
810 /* remove all special chars */
818 if (Quote || tagcount) {
819 /* copy quoted/tagged string */
824 /* end argument string */
827 if (curarg_contains_rrd_directives) {
828 argv[argc-1] = rrd_expand_vars(stralloc(argv[argc-1]));
829 curarg_contains_rrd_directives = 0;
834 case '"': /* Fall through */
840 /* copy quoted string */
845 /* reference argument string in argument array */
856 /* start new argument */
867 if (0 == strncmp(getP, "RRD::", strlen("RRD::"))) {
868 curarg_contains_rrd_directives = 1;
876 /* check if our argument array is still large enough */
878 /* resize argument array */
880 argv = rrd_realloc(argv, argsz * sizeof(char *));
887 /* terminate last argument found */
889 if (curarg_contains_rrd_directives) {
890 argv[argc-1] = rrd_expand_vars(stralloc(argv[argc-1]));
896 printf("<-- arguments found [%d]\n", argc);
897 for (n=0; n<argc; n++) {
898 printf("arg %02d: '%s'\n", n, argv[n]);
902 printf("<!-- No arguments found -->\n");
906 /* update caller's notion of the argument array and it's size */
908 *argument_count = argc;
914 /* Return new scanning cursor:
915 pointer to char after closing bracket */
921 * Parse(): scan current portion of buffer for given tag.
922 * If found, parse tag arguments and call 'func' for it.
923 * The result of func is inserted at the current position
928 char **buf, /* buffer */
929 long i, /* offset in buffer */
930 char *tag, /* tag to handle */
931 char *(*func)(long , const char **) /* function to call for 'tag' */
934 /* the name of the vairable ... */
941 size_t taglen = strlen(tag);
943 /* Current position in buffer should start with 'tag' */
944 if (strncmp((*buf)+i, tag, taglen) != 0) {
947 /* .. and match exactly (a whitespace following 'tag') */
948 if (! isspace(*((*buf) + i + taglen)) ) {
953 printf("parse(): handling tag '%s'\n", tag);
956 /* Scan for arguments following the tag;
957 scanargs() puts \0 into *buf ... so after scanargs it is probably
958 not a good time to use strlen on buf */
959 end = scanargs((*buf) + i + taglen, &argc, &args);
962 /* got arguments, call function for 'tag' with arguments */
963 val = func(argc, args);
968 /* unable to parse arguments, undo 0-termination by scanargs */
969 for (; argc > 0; argc--) {
970 *((args[argc-1])-1) = ' ';
973 /* next call, try parsing at current offset +1 */
974 end = (*buf) + i + 1;
976 val = stralloc("[ERROR: Parsing Problem with the following text\n"
977 " Check original file. This may have been altered "
981 /* remember offset where we have to continue parsing */
982 end_offset = end - (*buf);
989 /* Optionally resize buffer to hold the replacement value:
990 Calculating the new length of the buffer is simple. add current
991 buffer pos (i) to length of string after replaced tag to length
992 of replacement string and add 1 for the final zero ... */
993 if (end - (*buf) < (i + valln)) {
994 /* make sure we do not shrink the mallocd block */
995 size_t newbufsize = i + strlen(end) + valln + 1;
996 *buf = rrd_realloc(*buf, newbufsize);
999 perror("Realoc buf:");
1004 /* Update new end pointer:
1005 make sure the 'end' pointer gets moved along with the
1006 buf pointer when realloc moves memory ... */
1007 end = (*buf) + end_offset;
1009 /* splice the variable:
1010 step 1. Shift pending data to make room for 'val' */
1011 memmove((*buf) + i + valln, end, strlen(end) + 1);
1013 /* step 2. Insert val */
1015 memmove((*buf)+i, val, valln);
1018 return (valln > 0 ? valln-1: valln);
1022 http_time(time_t *now) {
1024 static char buf[60];
1026 tmptime=gmtime(now);
1027 strftime(buf,sizeof(buf),"%a, %d %b %Y %H:%M:%S GMT",tmptime);