prep for 1.2rc3 release
[rrdtool.git] / src / rrd_tool.c
index 4a6c8cd..e2bd1db 100644 (file)
@@ -1,5 +1,5 @@
 /*****************************************************************************
- * RRDtool 1.1.x  Copyright Tobias Oetiker, 1997 - 2002
+ * RRDtool 1.2rc3  Copyright by Tobi Oetiker, 1997-2005
  *****************************************************************************
  * rrd_tool.c  Startup wrapper
  *****************************************************************************/
@@ -22,12 +22,17 @@ 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, xport\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";
@@ -50,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"
@@ -63,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"
@@ -70,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"
@@ -81,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"
@@ -89,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"
@@ -100,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"
@@ -110,14 +134,16 @@ 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[] =
@@ -130,7 +156,7 @@ void PrintUsage(char *cmd)
            "\t\t[XPORT:vname:legend]\n\n";
 
     char help_quit[] =
-          " * quit - closeing a session in remote mode\n\n"
+          " * quit - closing a session in remote mode\n\n"
           "\trrdtool quit\n\n";
 
     char help_ls[] =
@@ -139,11 +165,11 @@ void PrintUsage(char *cmd)
 
     char help_cd[] =
           " * cd - changes the current directory\n\n"
-          "\trrdtool cd new direcotry\n\n";
+          "\trrdtool cd new directory\n\n";
 
     char help_mkdir[] =
-          " * mkdir - creates a new direcotry\n\n"
-          "\trrdtool mkdir newdirecotryname\n\n";
+          " * 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"
@@ -151,9 +177,9 @@ void PrintUsage(char *cmd)
 
           "For more information read the RRD manpages\n\n";
 
-    enum { C_NONE, C_CREATE, C_DUMP, C_INFO, C_RESTORE, C_LAST,
+    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_QUIT, C_LS, C_CD, C_MKDIR, C_UPDATEV };
 
     int help_cmd = C_NONE;
 
@@ -169,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"))
@@ -214,17 +244,26 @@ 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);
@@ -253,7 +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
@@ -279,7 +320,7 @@ int main(int argc, char *argv[])
            gettimeofday(&starttime,&tz);
 #endif
          RemoteMode=1;
-#ifndef WIN32
+#ifdef HAVE_CHROOT
           if ((argc == 3) && strcmp("",argv[2])){
              if (getuid()==0){
                 chroot(argv[2]);
@@ -298,13 +339,13 @@ int main(int argc, char *argv[])
           if (strcmp(firstdir,"")){
              chdir(firstdir);
              if (errno!=0){
-                fprintf(stderr,"ERROR: %s\n",strerror(errno));
+                fprintf(stderr,"ERROR: %s\n",rrd_strerror(errno));
                 exit(errno);
              }
           }
 #else
-          fprintf(stderr,"ERROR: change root only in unix "
-                         "enviroment posible\n");
+          fprintf(stderr,"ERROR: change root is not supported by your OS "
+                         "or at least by this copy of rrdtool\n");
           exit(1);
 #endif
 
@@ -353,16 +394,25 @@ int main(int argc, char *argv[])
                PrintUsage(argv[2]);
                exit(0);
        }
-    else
-       HandleInputLine(argc, argv, stderr);    
+    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 */
 
@@ -374,21 +424,22 @@ int HandleInputLine(int argc, char **argv, FILE* out)
           }
           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);
           }
-#ifndef WIN32
+#if ! defined(HAVE_CHROOT) || ! defined(HAVE_GETUID)
           if (getuid()==0 && ! ChangeRoot){
-             printf("ERROR: chdir security problem - rrdtool is runnig as "
+             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",strerror(errno));
+             printf("ERROR: %s\n",rrd_strerror(errno));
           }
           return(0);
        }
@@ -397,16 +448,16 @@ int HandleInputLine(int argc, char **argv, FILE* out)
              printf("ERROR: invalid parameter count for mkdir\n");
              return(0);
           }
-#ifndef WIN32
+#if ! defined(HAVE_CHROOT) || ! defined(HAVE_GETUID)
           if (getuid()==0 && ! ChangeRoot){
-             printf("ERROR: mkdir security problem - rrdtool is runnig as "
+             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",strerror(errno));
+             printf("ERROR: %s\n",rrd_strerror(errno));
           }
           return(0);
        }
@@ -431,11 +482,13 @@ int HandleInputLine(int argc, char **argv, FILE* out)
              }
           }
           else{
-             printf("ERROR: %s\n",strerror(errno));
+             printf("ERROR: %s\n",rrd_strerror(errno));
              return(errno);
           }
           return(0);
        }
+#endif /* opendir and readdir */
+
     }
     if (argc < 3 
        || strcmp("help", argv[1]) == 0
@@ -451,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);
@@ -469,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);
@@ -486,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;
@@ -504,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");
@@ -519,8 +581,8 @@ int HandleInputLine(int argc, char **argv, FILE* out)
        }
     } else if (strcmp("xport", argv[1]) == 0) {
        int xxsize;
-       int i = 0, j = 0;
-       time_t        start,end;
+       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;
@@ -546,9 +608,9 @@ int HandleInputLine(int argc, char **argv, FILE* out)
          printf("    </%s>\n", LEGEND_TAG);
          printf("  </%s>\n", META_TAG);
          printf("  <%s>\n", DATA_TAG);
-         for (i = start+step; i <= end; i += step) {
+         for (ti = start+step; ti <= end; ti += step) {
            printf ("    <%s>", DATA_ROW_TAG);
-           printf ("<%s>%lu</%s>", COL_TIME_TAG, i, COL_TIME_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;
@@ -568,15 +630,19 @@ int HandleInputLine(int argc, char **argv, FILE* out)
     }
     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(imgfile,"-") != 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(imgfile,"-") != 0
+                   if (!tostdout
                        printf("%s\n",calcpr[i]);
                    free(calcpr[i]);
                } 
@@ -592,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);
 }