prep for 1.2rc3 release
[rrdtool.git] / src / rrd_tool.c
index 72fdddb..e2bd1db 100644 (file)
@@ -1,15 +1,18 @@
 /*****************************************************************************
- * RRDtool 1.1.x  Copyright Tobias Oetiker, 1997 - 2002
+ * RRDtool 1.2rc3  Copyright by Tobi Oetiker, 1997-2005
  *****************************************************************************
  * rrd_tool.c  Startup wrapper
  *****************************************************************************/
 
 #include "rrd_tool.h"
+#include "rrd_xport.h"
 
 void PrintUsage(char *cmd);
 int CountArgs(char *aLine);
 int CreateArgs(char *, char *, int, char **);
 int HandleInputLine(int, char **, FILE*);
+int RemoteMode=0;
+int ChangeRoot=0;
 #define TRUE           1
 #define FALSE          0
 #define MAX_LENGTH     10000
@@ -19,12 +22,21 @@ void PrintUsage(char *cmd)
 {
 
     char help_main[] =
-          "RRDtool 1.1.x  Copyright 1997-2001 by Tobias Oetiker <tobi@oetiker.ch>\n\n"
+          "RRDtool 1.2rc3  Copyright 1997-2005 by Tobias Oetiker <tobi@oetiker.ch>\n"
+#ifndef WIN32
+           "               Compiled " MAKE_TIMESTAMP "\n\n"
+#else
+           "               Compiled " __DATE__ " " __TIME__ "\n\n"
+#endif          
           "Usage: rrdtool [options] command command_options\n\n";
 
     char help_list[] =
-          "Valid commands: create, update, graph, dump, restore,\n"
-          "\t\tlast, info, fetch, tune, resize\n\n";
+          "Valid commands: create, update, updatev, graph, dump, restore,\n"
+          "\t\tlast, first, info, fetch, tune, resize, xport\n\n";
+
+    char help_listremote[] =
+           "Valid remote commands: quit, ls, cd, mkdir\n\n";
+
 
     char help_create[] =
           "* create - create a new RRD\n\n"
@@ -43,12 +55,16 @@ void PrintUsage(char *cmd)
 
     char help_restore[] =
           "* restore - restore an RRD file from its XML form\n\n"
-          "\trrdtool restore [--range-check|-r] filename.xml filename.rrd\n\n";
+          "\trrdtool restore [--range-check|-r] [--force-overwrite|-f] filename.xml filename.rrd\n\n";
 
     char help_last[] =
            "* last - show last update time for RRD\n\n"
            "\trrdtool last filename.rrd\n\n";
 
+    char help_first[] =
+           "* first - show first update time for RRA within an RRD\n\n"
+           "\trrdtool first filename.rrd [--rraindex number]\n\n";
+
     char help_update[] =
           "* update - update an RRD\n\n"
           "\trrdtool update filename\n"
@@ -56,6 +72,15 @@ void PrintUsage(char *cmd)
           "\t\ttime|N:value[:value...]\n\n"
            "\t\tat-time@value[:value...]\n\n"
           "\t\t[ time:value[:value...] ..]\n\n";
+    
+       char help_updatev[] =
+          "* updatev - a verbose version of update\n"
+          "\treturns information about values, RRAs, and datasources updated\n\n"
+          "\trrdtool updatev filename\n"
+          "\t\t--template|-t ds-name:ds-name:...\n"
+          "\t\ttime|N:value[:value...]\n\n"
+           "\t\tat-time@value[:value...]\n\n"
+          "\t\t[ time:value[:value...] ..]\n\n";
 
     char help_fetch[] =
           "* fetch - fetch data out of an RRD\n\n"
@@ -63,7 +88,9 @@ void PrintUsage(char *cmd)
           "\t\t[--resolution|-r resolution]\n"
           "\t\t[--start|-s start] [--end|-e end]\n\n";
 
-    char help_graph[] =
+/* break up very large strings (help_graph, help_tune) for ISO C89 compliance*/
+
+    char help_graph1[] =
           "* graph - generate a graph from one or several RRD\n\n"
           "\trrdtool graph filename [-s|--start seconds] [-e|--end seconds]\n"
           "\t\t[-x|--x-grid x-axis grid and label]\n"
@@ -74,6 +101,9 @@ void PrintUsage(char *cmd)
           "\t\t[-u|--upper-limit value] [-z|--lazy]\n"
           "\t\t[-l|--lower-limit value] [-r|--rigid]\n"
            "\t\t[-g|--no-legend]\n"
+          "\t\t[-F|--force-rules-legend]\n";
+    char help_graph2[] =
+           "\t\t[-j|--only-graph]\n"
           "\t\t[--font FONTTAG:size:font]\n"
            "\t\t[--zoom factor]\n"       
           "\t\t[--alt-autoscale]\n"
@@ -82,7 +112,8 @@ void PrintUsage(char *cmd)
           "\t\t[--step seconds]\n"        
           "\t\t[-f|--imginfo printfstr]\n"
           "\t\t[-a|--imgformat PNG]\n"
-          "\t\t[-c|--color COLORTAG#rrggbb[aa]] [-t|--title string]\n"
+          "\t\t[-c|--color COLORTAG#rrggbb[aa]] [-t|--title string]\n";
+    char help_graph3[] =
           "\t\t[DEF:vname=rrd:ds-name:CF]\n"
           "\t\t[CDEF:vname=rpn-expression]\n"
           "\t\t[PRINT:vname:CF:format]\n"
@@ -93,7 +124,7 @@ void PrintUsage(char *cmd)
           "\t\t[AREA:vname[#rrggbb[aa][:legend]]]\n"
           "\t\t[STACK:vname[#rrggbb[aa][:legend]]]\n\n";
 
-    char help_tune[] =
+    char help_tune1[] =
           " * tune -  Modify some basic properties of an RRD\n\n"
           "\trrdtool tune filename\n"
           "\t\t[--heartbeat|-h ds-name:heartbeat]\n"
@@ -103,24 +134,52 @@ void PrintUsage(char *cmd)
           "\t\t[--deltapos scale-value] [--deltaneg scale-value]\n"
           "\t\t[--failure-threshold integer]\n"
           "\t\t[--window-length integer]\n"
-          "\t\t[--alpha adaptation-parameter]\n"
+          "\t\t[--alpha adaptation-parameter]\n";
+    char help_tune2[] =
+          " * tune -  Modify some basic properties of an RRD\n\n"
           "\t\t[--beta adaptation-parameter]\n"
           "\t\t[--gamma adaptation-parameter]\n"
           "\t\t[--gamma-deviation adaptation-parameter]\n"
           "\t\t[--aberrant-reset ds-name]\n\n";
 
     char help_resize[] =
-          " * resize - alter the lenght of one of the RRAs in an RRD\n\n"
+          " * resize - alter the length of one of the RRAs in an RRD\n\n"
           "\trrdtool resize filename rranum GROW|SHRINK rows\n\n";
 
+    char help_xport[] =
+          "* xport - generate XML dump from one or several RRD\n\n"
+          "\trrdtool xport [-s|--start seconds] [-e|--end seconds]\n"
+          "\t\t[-m|--maxrows rows]\n"
+          "\t\t[--step seconds]\n"        
+          "\t\t[DEF:vname=rrd:ds-name:CF]\n"
+          "\t\t[CDEF:vname=rpn-expression]\n"
+           "\t\t[XPORT:vname:legend]\n\n";
+
+    char help_quit[] =
+          " * quit - closing a session in remote mode\n\n"
+          "\trrdtool quit\n\n";
+
+    char help_ls[] =
+          " * ls - lists all *.rrd files in current directory\n\n"
+          "\trrdtool ls\n\n";
+
+    char help_cd[] =
+          " * cd - changes the current directory\n\n"
+          "\trrdtool cd new directory\n\n";
+
+    char help_mkdir[] =
+          " * mkdir - creates a new directory\n\n"
+          "\trrdtool mkdir newdirectoryname\n\n";
+
     char help_lic[] =
           "RRDtool is distributed under the Terms of the GNU General\n"
           "Public License Version 2. (www.gnu.org/copyleft/gpl.html)\n\n"
 
           "For more information read the RRD manpages\n\n";
 
-    enum { C_NONE, C_CREATE, C_DUMP, C_INFO, C_RESTORE, C_LAST,
-          C_UPDATE, C_FETCH, C_GRAPH, C_TUNE, C_RESIZE };
+    enum { C_NONE, C_CREATE, C_DUMP, C_INFO, C_RESTORE, C_LAST, C_FIRST,
+          C_UPDATE, C_FETCH, C_GRAPH, C_TUNE, C_RESIZE, C_XPORT,
+           C_QUIT, C_LS, C_CD, C_MKDIR, C_UPDATEV };
 
     int help_cmd = C_NONE;
 
@@ -136,8 +195,12 @@ void PrintUsage(char *cmd)
                help_cmd = C_RESTORE;
            else if (!strcmp(cmd,"last"))
                help_cmd = C_LAST;
+           else if (!strcmp(cmd,"first"))
+               help_cmd = C_FIRST;
            else if (!strcmp(cmd,"update"))
                help_cmd = C_UPDATE;
+           else if (!strcmp(cmd,"updatev"))
+               help_cmd = C_UPDATEV;
            else if (!strcmp(cmd,"fetch"))
                help_cmd = C_FETCH;
            else if (!strcmp(cmd,"graph"))
@@ -146,12 +209,25 @@ void PrintUsage(char *cmd)
                help_cmd = C_TUNE;
            else if (!strcmp(cmd,"resize"))
                help_cmd = C_RESIZE;
+           else if (!strcmp(cmd,"xport"))
+               help_cmd = C_XPORT;
+            else if (!strcmp(cmd,"quit"))
+                help_cmd = C_QUIT;
+            else if (!strcmp(cmd,"ls"))
+                help_cmd = C_LS;
+            else if (!strcmp(cmd,"cd"))
+                help_cmd = C_CD;
+            else if (!strcmp(cmd,"mkdir"))
+                help_cmd = C_MKDIR;
        }
     fputs(help_main, stdout);
     switch (help_cmd)
        {
            case C_NONE:
                fputs(help_list, stdout);
+                if (RemoteMode){
+                   fputs(help_listremote, stdout);
+                }
                break;
            case C_CREATE:
                fputs(help_create, stdout);
@@ -168,21 +244,45 @@ void PrintUsage(char *cmd)
            case C_LAST:
                fputs(help_last, stdout);
                break;
+           case C_FIRST:
+               fputs(help_first, stdout);
+               break;
            case C_UPDATE:
                fputs(help_update, stdout);
                break;
+           case C_UPDATEV:
+               fputs(help_updatev, stdout);
+               break;
            case C_FETCH:
                fputs(help_fetch, stdout);
                break;
            case C_GRAPH:
-               fputs(help_graph, stdout);
+               fputs(help_graph1, stdout);
+               fputs(help_graph2, stdout);
+               fputs(help_graph3, stdout);
                break;
            case C_TUNE:
-               fputs(help_tune, stdout);
+               fputs(help_tune1, stdout);
+               fputs(help_tune2, stdout);
                break;
            case C_RESIZE:
                fputs(help_resize, stdout);
                break;
+           case C_XPORT:
+               fputs(help_xport, stdout);
+               break;
+           case C_QUIT:
+               fputs(help_quit, stdout);
+               break;
+           case C_LS:
+               fputs(help_ls, stdout);
+               break;
+           case C_CD:
+               fputs(help_cd, stdout);
+               break;
+           case C_MKDIR:
+               fputs(help_mkdir, stdout);
+               break;
        }
     fputs(help_lic, stdout);
 }
@@ -192,6 +292,9 @@ int main(int argc, char *argv[])
 {
     char **myargv;
     char aLine[MAX_LENGTH];
+#ifdef HAVE_CHROOT    
+    char *firstdir="";
+#endif
 #ifdef MUST_DISABLE_SIGFPE
     signal(SIGFPE,SIG_IGN);
 #endif
@@ -204,7 +307,7 @@ int main(int argc, char *argv[])
            return 0;
        }
     
-    if ((argc == 2) && !strcmp("-",argv[1]))
+    if (((argc == 2)||(argc == 3)) && !strcmp("-",argv[1]))
        {
 #if HAVE_GETRUSAGE
          struct rusage  myusage;
@@ -216,6 +319,35 @@ int main(int argc, char *argv[])
            tz.tz_dsttime=0;
            gettimeofday(&starttime,&tz);
 #endif
+         RemoteMode=1;
+#ifdef HAVE_CHROOT
+          if ((argc == 3) && strcmp("",argv[2])){
+             if (getuid()==0){
+                chroot(argv[2]);
+                if (errno!=0){
+                   fprintf(stderr,"ERROR: can't change root to '%s' errno=%d\n",
+                           argv[2],errno);
+                    exit(errno);
+                }
+                ChangeRoot=1;
+                firstdir="/";
+             }
+             else{
+                firstdir=argv[2];
+             }
+          }
+          if (strcmp(firstdir,"")){
+             chdir(firstdir);
+             if (errno!=0){
+                fprintf(stderr,"ERROR: %s\n",rrd_strerror(errno));
+                exit(errno);
+             }
+          }
+#else
+          fprintf(stderr,"ERROR: change root is not supported by your OS "
+                         "or at least by this copy of rrdtool\n");
+          exit(1);
+#endif
 
            while (fgets(aLine, sizeof(aLine)-1, stdin)){
                if ((argc = CountArgs(aLine)) == 0)  {
@@ -257,16 +389,107 @@ int main(int argc, char *argv[])
                PrintUsage(argv[1]);
                exit(0);
        }
-    else
-       HandleInputLine(argc, argv, stderr);    
+    else if (argc == 3 && !strcmp(argv[1],"help"))
+       {
+               PrintUsage(argv[2]);
+               exit(0);
+       }
+    else {
+        if(HandleInputLine(argc, argv, stderr)) {
+            return 1;
+        }
+    }
     return 0;
 }
 
+/* HandleInputLine is NOT thread safe - due to readdir issues,
+   resolving them portably is not really simple. */
 int HandleInputLine(int argc, char **argv, FILE* out)
 {
+#if defined(HAVE_OPENDIR) && defined (HAVE_READDIR)
+    DIR           *curdir; /* to read current dir with ls */
+    struct dirent *dent;
+#endif
+#if defined(HAVE_SYS_STAT_H)
+    struct stat   st;
+#endif
     optind=0; /* reset gnu getopt */
     opterr=0; /* no error messages */
 
+    if (RemoteMode){
+       if (argc>1 && strcmp("quit", argv[1]) == 0){
+          if (argc>2){
+             printf("ERROR: invalid parameter count for quit\n");
+             return(0);
+          }
+          exit(0);
+       }
+#if defined(HAVE_OPENDIR) && defined(HAVE_READDIR) && defined(HAVE_CHDIR)
+       if (argc>1 && strcmp("cd", argv[1]) == 0){
+          if (argc>3){
+             printf("ERROR: invalid parameter count for cd\n");
+             return(0);
+          }
+#if ! defined(HAVE_CHROOT) || ! defined(HAVE_GETUID)
+          if (getuid()==0 && ! ChangeRoot){
+             printf("ERROR: chdir security problem - rrdtool is running as "
+                    "root an no chroot!\n");
+             return(0); 
+          }
+#endif
+          chdir(argv[2]);
+          if (errno!=0){
+             printf("ERROR: %s\n",rrd_strerror(errno));
+          }
+          return(0);
+       }
+       if (argc>1 && strcmp("mkdir", argv[1]) == 0){
+          if (argc>3){
+             printf("ERROR: invalid parameter count for mkdir\n");
+             return(0);
+          }
+#if ! defined(HAVE_CHROOT) || ! defined(HAVE_GETUID)
+          if (getuid()==0 && ! ChangeRoot){
+             printf("ERROR: mkdir security problem - rrdtool is running as "
+                    "root an no chroot!\n");
+             return(0); 
+          }
+#endif
+          mkdir(argv[2],0777);
+          if (errno!=0){
+             printf("ERROR: %s\n",rrd_strerror(errno));
+          }
+          return(0);
+       }
+       if (argc>1 && strcmp("ls", argv[1]) == 0){
+          if (argc>2){
+             printf("ERROR: invalid parameter count for ls\n");
+             return(0);
+          }
+          if ((curdir=opendir("."))!=NULL){
+             while((dent=readdir(curdir))!=NULL){
+                if (!stat(dent->d_name,&st)){
+                   if (S_ISDIR(st.st_mode)){
+                      printf("d %s\n",dent->d_name);
+                   }
+                   if (strlen(dent->d_name)>4 && S_ISREG(st.st_mode)){
+                      if (!strcmp(dent->d_name+NAMLEN(dent)-4,".rrd") ||
+                          !strcmp(dent->d_name+NAMLEN(dent)-4,".RRD")){
+                         printf("- %s\n",dent->d_name);
+                      }
+                   }
+                }
+             }
+          }
+          else{
+             printf("ERROR: %s\n",rrd_strerror(errno));
+             return(errno);
+          }
+          return(0);
+       }
+#endif /* opendir and readdir */
+
+    }
     if (argc < 3 
        || strcmp("help", argv[1]) == 0
        || strcmp("--help", argv[1]) == 0
@@ -281,9 +504,13 @@ int HandleInputLine(int argc, char **argv, FILE* out)
        rrd_create(argc-1, &argv[1]);
     else if (strcmp("dump", argv[1]) == 0)
        rrd_dump(argc-1, &argv[1]);
-    else if (strcmp("info", argv[1]) == 0){
+    else if (strcmp("info", argv[1]) == 0 
+               || strcmp("updatev", argv[1]) == 0){
        info_t *data,*save;
-       data=rrd_info(argc-1, &argv[1]);
+       if (strcmp("info",argv[1]) == 0)
+          data=rrd_info(argc-1, &argv[1]);
+    else
+          data=rrd_update_v(argc-1, &argv[1]);
        while (data) {
            save=data;
            printf ("%s = ", data->key);
@@ -299,6 +526,9 @@ int HandleInputLine(int argc, char **argv, FILE* out)
            case RD_I_CNT:
                printf ("%lu", data->value.u_cnt);
                break;
+           case RD_I_INT:
+               printf ("%d", data->value.u_int);
+               break;
            case RD_I_STR:
                printf ("\"%s\"", data->value.u_str);
                free(data->value.u_str);
@@ -316,17 +546,19 @@ int HandleInputLine(int argc, char **argv, FILE* out)
             strcmp("v", argv[1]) == 0 ||
             strcmp("-v", argv[1]) == 0  ||
             strcmp("-version", argv[1]) == 0  )
-        printf("RRDtool 1.1.x  Copyright (C) 1997-2001 by Tobias Oetiker <tobi@oetiker.ch>\n");
+        printf("RRDtool 1.2rc3  Copyright by Tobi Oetiker, 1997-2005\n");
     else if (strcmp("restore", argv[1]) == 0)
        rrd_restore(argc-1, &argv[1]);
     else if (strcmp("resize", argv[1]) == 0)
        rrd_resize(argc-1, &argv[1]);
     else if (strcmp("last", argv[1]) == 0)
         printf("%ld\n",rrd_last(argc-1, &argv[1]));
+    else if (strcmp("first", argv[1]) == 0)
+        printf("%ld\n",rrd_first(argc-1, &argv[1]));
     else if (strcmp("update", argv[1]) == 0)
        rrd_update(argc-1, &argv[1]);
     else if (strcmp("fetch", argv[1]) == 0) {
-       time_t        start,end;
+       time_t        start,end, ti;
        unsigned long step, ds_cnt,i,ii;
        rrd_value_t   *data,*datai;
        char          **ds_namv;
@@ -334,10 +566,10 @@ int HandleInputLine(int argc, char **argv, FILE* out)
            datai=data;
            printf("           ");
            for (i = 0; i<ds_cnt;i++)
-               printf("%14s",ds_namv[i]);
+               printf("%20s",ds_namv[i]);
            printf ("\n\n");
-           for (i = start+step; i <= end; i += step){
-               printf("%10lu:", i);
+           for (ti = start+step; ti <= end; ti += step){
+               printf("%10lu:", ti);
                for (ii = 0; ii < ds_cnt; ii++)
                    printf(" %0.10e", *(datai++));
                printf("\n");
@@ -347,17 +579,70 @@ int HandleInputLine(int argc, char **argv, FILE* out)
            free(ds_namv);
            free (data);
        }
+    } else if (strcmp("xport", argv[1]) == 0) {
+       int xxsize;
+       unsigned long int j = 0;
+       time_t        start,end, ti;
+       unsigned long step, col_cnt,row_cnt;
+       rrd_value_t   *data,*ptr;
+       char          **legend_v;
+       if(rrd_xport(argc-1, &argv[1], &xxsize,&start,&end,&step,&col_cnt,&legend_v,&data) != -1) {
+         row_cnt = (end-start)/step;
+         ptr = data;
+         printf("<?xml version=\"1.0\" encoding=\"%s\"?>\n\n", XML_ENCODING);
+         printf("<%s>\n", ROOT_TAG);
+         printf("  <%s>\n", META_TAG);
+         printf("    <%s>%lu</%s>\n", META_START_TAG, start+step, META_START_TAG);
+         printf("    <%s>%lu</%s>\n", META_STEP_TAG, step, META_STEP_TAG);
+         printf("    <%s>%lu</%s>\n", META_END_TAG, end, META_END_TAG);
+         printf("    <%s>%lu</%s>\n", META_ROWS_TAG, row_cnt, META_ROWS_TAG);
+         printf("    <%s>%lu</%s>\n", META_COLS_TAG, col_cnt, META_COLS_TAG);
+         printf("    <%s>\n", LEGEND_TAG);
+         for (j = 0; j < col_cnt; j++) {
+           char *entry = NULL;
+           entry = legend_v[j];
+           printf("      <%s>%s</%s>\n", LEGEND_ENTRY_TAG, entry, LEGEND_ENTRY_TAG);
+           free(entry);
+         }
+         free(legend_v);
+         printf("    </%s>\n", LEGEND_TAG);
+         printf("  </%s>\n", META_TAG);
+         printf("  <%s>\n", DATA_TAG);
+         for (ti = start+step; ti <= end; ti += step) {
+           printf ("    <%s>", DATA_ROW_TAG);
+           printf ("<%s>%lu</%s>", COL_TIME_TAG, ti, COL_TIME_TAG);
+           for (j = 0; j < col_cnt; j++) {
+             rrd_value_t newval = DNAN;
+             newval = *ptr;
+             if(isnan(newval)){
+               printf("<%s>NaN</%s>", COL_DATA_TAG, COL_DATA_TAG);
+             } else {
+               printf("<%s>%0.10e</%s>", COL_DATA_TAG, newval, COL_DATA_TAG);
+             };
+             ptr++;
+           }
+           printf("</%s>\n", DATA_ROW_TAG);
+         }
+         free(data);
+         printf("  </%s>\n", DATA_TAG);
+         printf("</%s>\n", ROOT_TAG);
+       }
     }
     else if (strcmp("graph", argv[1]) == 0) {
        char **calcpr;
+#ifdef notused  /*XXX*/
+       const char *imgfile = argv[2]; /* rrd_graph changes argv pointer */
+#endif
        int xsize, ysize;
+       double ymin,ymax;
        int i;
-       if( rrd_graph(argc-1, &argv[1], &calcpr, &xsize, &ysize) != -1 ) {
-           if (strcmp(argv[2],"-") != 0) 
+       int tostdout = (strcmp(argv[2],"-") == 0);      
+       if( rrd_graph(argc-1, &argv[1], &calcpr, &xsize, &ysize, NULL, &ymin, &ymax) != -1 ) {
+           if (!tostdout) 
                printf ("%dx%d\n",xsize,ysize);
            if (calcpr) {
                for(i=0;calcpr[i];i++){
-                   if (strcmp(argv[2],"-") != 0
+                   if (!tostdout
                        printf("%s\n",calcpr[i]);
                    free(calcpr[i]);
                } 
@@ -373,6 +658,7 @@ int HandleInputLine(int argc, char **argv, FILE* out)
     if (rrd_test_error()) {
        fprintf(out, "ERROR: %s\n",rrd_get_error());
        rrd_clear_error();
+       return 1;
     }
     return(0);
 }