redis-cli now is able to also output the string representation instead of the raw...

[redis.git] / redis-cli.c

diff --git a/redis-cli.c b/redis-cli.c
index eef85f2453f642737c1a2883bc255f8f389b56ff..21959022e338e6daccdbbda619930885d3335ec7 100644 (file)
--- a/redis-cli.c
+++ b/redis-cli.c
@@ -1,6 +1,6 @@
 /* Redis CLI (command line interface)
  *
 /* Redis CLI (command line interface)
  *

- * Copyright (c) 2006-2009, Salvatore Sanfilippo <antirez at gmail dot com>
+ * Copyright (c) 2009-2010, Salvatore Sanfilippo <antirez at gmail dot com>

  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without


@@ -34,11 +34,13 @@
 #include <string.h>
 #include <stdlib.h>
 #include <unistd.h>
 #include <string.h>
 #include <stdlib.h>
 #include <unistd.h>

+#include <ctype.h>

 
 #include "anet.h"
 #include "sds.h"
 #include "adlist.h"
 #include "zmalloc.h"
 
 #include "anet.h"
 #include "sds.h"
 #include "adlist.h"
 #include "zmalloc.h"

+#include "linenoise.h"

 
 #define REDIS_CMD_INLINE 1
 #define REDIS_CMD_BULK 2
 
 #define REDIS_CMD_INLINE 1
 #define REDIS_CMD_BULK 2


@@ -51,6 +53,8 @@ static struct config {
     int hostport;
     long repeat;
     int dbnum;
     int hostport;
     long repeat;
     int dbnum;

+    int interactive;
+    char *auth;

 } config;
 
 struct redisCommand {
 } config;
 
 struct redisCommand {


@@ -60,9 +64,13 @@ struct redisCommand {
 };
 
 static struct redisCommand cmdTable[] = {
 };
 
 static struct redisCommand cmdTable[] = {

+    {"auth",2,REDIS_CMD_INLINE},

     {"get",2,REDIS_CMD_INLINE},
     {"set",3,REDIS_CMD_BULK},
     {"setnx",3,REDIS_CMD_BULK},
     {"get",2,REDIS_CMD_INLINE},
     {"set",3,REDIS_CMD_BULK},
     {"setnx",3,REDIS_CMD_BULK},

+    {"setex",4,REDIS_CMD_BULK},
+    {"append",3,REDIS_CMD_BULK},
+    {"substr",4,REDIS_CMD_INLINE},

     {"del",-2,REDIS_CMD_INLINE},
     {"exists",2,REDIS_CMD_INLINE},
     {"incr",2,REDIS_CMD_INLINE},
     {"del",-2,REDIS_CMD_INLINE},
     {"exists",2,REDIS_CMD_INLINE},
     {"incr",2,REDIS_CMD_INLINE},


@@ -71,6 +79,8 @@ static struct redisCommand cmdTable[] = {
     {"lpush",3,REDIS_CMD_BULK},
     {"rpop",2,REDIS_CMD_INLINE},
     {"lpop",2,REDIS_CMD_INLINE},
     {"lpush",3,REDIS_CMD_BULK},
     {"rpop",2,REDIS_CMD_INLINE},
     {"lpop",2,REDIS_CMD_INLINE},

+    {"brpop",-3,REDIS_CMD_INLINE},
+    {"blpop",-3,REDIS_CMD_INLINE},

     {"llen",2,REDIS_CMD_INLINE},
     {"lindex",3,REDIS_CMD_INLINE},
     {"lset",4,REDIS_CMD_BULK},
     {"llen",2,REDIS_CMD_INLINE},
     {"lindex",3,REDIS_CMD_INLINE},
     {"lset",4,REDIS_CMD_BULK},


@@ -96,9 +106,14 @@ static struct redisCommand cmdTable[] = {
     {"zincrby",4,REDIS_CMD_BULK},
     {"zrem",3,REDIS_CMD_BULK},
     {"zremrangebyscore",4,REDIS_CMD_INLINE},
     {"zincrby",4,REDIS_CMD_BULK},
     {"zrem",3,REDIS_CMD_BULK},
     {"zremrangebyscore",4,REDIS_CMD_INLINE},

-    {"zrange",4,REDIS_CMD_INLINE},
+    {"zmerge",-3,REDIS_CMD_INLINE},
+    {"zmergeweighed",-4,REDIS_CMD_INLINE},
+    {"zrange",-4,REDIS_CMD_INLINE},
+    {"zrank",3,REDIS_CMD_BULK},
+    {"zrevrank",3,REDIS_CMD_BULK},

     {"zrangebyscore",-4,REDIS_CMD_INLINE},
     {"zrangebyscore",-4,REDIS_CMD_INLINE},

-    {"zrevrange",4,REDIS_CMD_INLINE},
+    {"zcount",4,REDIS_CMD_INLINE},
+    {"zrevrange",-4,REDIS_CMD_INLINE},

     {"zcard",2,REDIS_CMD_INLINE},
     {"zscore",3,REDIS_CMD_BULK},
     {"incrby",3,REDIS_CMD_INLINE},
     {"zcard",2,REDIS_CMD_INLINE},
     {"zscore",3,REDIS_CMD_BULK},
     {"incrby",3,REDIS_CMD_INLINE},


@@ -132,10 +147,30 @@ static struct redisCommand cmdTable[] = {
     {"debug",-2,REDIS_CMD_INLINE},
     {"mset",-3,REDIS_CMD_MULTIBULK},
     {"msetnx",-3,REDIS_CMD_MULTIBULK},
     {"debug",-2,REDIS_CMD_INLINE},
     {"mset",-3,REDIS_CMD_MULTIBULK},
     {"msetnx",-3,REDIS_CMD_MULTIBULK},

+    {"monitor",1,REDIS_CMD_INLINE},
+    {"multi",1,REDIS_CMD_INLINE},
+    {"exec",1,REDIS_CMD_INLINE},
+    {"discard",1,REDIS_CMD_INLINE},
+    {"hset",4,REDIS_CMD_MULTIBULK},
+    {"hget",3,REDIS_CMD_BULK},
+    {"hmset",-4,REDIS_CMD_MULTIBULK},
+    {"hmget",-3,REDIS_CMD_MULTIBULK},
+    {"hincrby",4,REDIS_CMD_INLINE},
+    {"hdel",3,REDIS_CMD_BULK},
+    {"hlen",2,REDIS_CMD_INLINE},
+    {"hkeys",2,REDIS_CMD_INLINE},
+    {"hvals",2,REDIS_CMD_INLINE},
+    {"hgetall",2,REDIS_CMD_INLINE},
+    {"hexists",3,REDIS_CMD_BULK},
+    {"config",-2,REDIS_CMD_BULK},
+    {"subscribe",-2,REDIS_CMD_INLINE},
+    {"unsubscribe",-1,REDIS_CMD_INLINE},
+    {"publish",3,REDIS_CMD_BULK},

     {NULL,0,0}
 };
 
 static int cliReadReply(int fd);
     {NULL,0,0}
 };
 
 static int cliReadReply(int fd);

+static void usage();

 
 static struct redisCommand *lookupCommand(char *name) {
     int j = 0;
 
 static struct redisCommand *lookupCommand(char *name) {
     int j = 0;


@@ -148,14 +183,16 @@ static struct redisCommand *lookupCommand(char *name) {
 
 static int cliConnect(void) {
     char err[ANET_ERR_LEN];
 
 static int cliConnect(void) {
     char err[ANET_ERR_LEN];

-    int fd;
+    static int fd = ANET_ERR;

 
 

-    fd = anetTcpConnect(err,config.hostip,config.hostport);

     if (fd == ANET_ERR) {
     if (fd == ANET_ERR) {

-        fprintf(stderr,"Connect: %s\n",err);
-        return -1;
+        fd = anetTcpConnect(err,config.hostip,config.hostport);
+        if (fd == ANET_ERR) {
+            fprintf(stderr, "Could not connect to Redis at %s:%d: %s", config.hostip, config.hostport, err);
+            return -1;
+        }
+        anetTcpNoDelay(NULL,fd);

     }
     }

-    anetTcpNoDelay(NULL,fd);

     return fd;
 }
 
     return fd;
 }
 


@@ -185,9 +222,35 @@ static int cliReadSingleLineReply(int fd, int quiet) {
     if (reply == NULL) return 1;
     if (!quiet)
         printf("%s\n", reply);
     if (reply == NULL) return 1;
     if (!quiet)
         printf("%s\n", reply);

+    sdsfree(reply);

     return 0;
 }
 
     return 0;
 }
 

+static void printStringRepr(char *s, int len) {
+    printf("\"");
+    while(len--) {
+        switch(*s) {
+        case '\\':
+        case '"':
+            printf("\\%c",*s);
+            break;
+        case '\n': printf("\\n"); break;
+        case '\r': printf("\\r"); break;
+        case '\t': printf("\\t"); break;
+        case '\a': printf("\\a"); break;
+        case '\b': printf("\\b"); break;
+        default:
+            if (isprint(*s))
+                printf("%c",*s);
+            else
+                printf("\\x%02x",(unsigned char)*s);
+            break;
+        }
+        s++;
+    }
+    printf("\"\n");
+}
+

 static int cliReadBulkReply(int fd) {
     sds replylen = cliReadLine(fd);
     char *reply, crlf[2];
 static int cliReadBulkReply(int fd) {
     sds replylen = cliReadLine(fd);
     char *reply, crlf[2];


@@ -203,12 +266,17 @@ static int cliReadBulkReply(int fd) {
     reply = zmalloc(bulklen);
     anetRead(fd,reply,bulklen);
     anetRead(fd,crlf,2);
     reply = zmalloc(bulklen);
     anetRead(fd,reply,bulklen);
     anetRead(fd,crlf,2);

-    if (bulklen && fwrite(reply,bulklen,1,stdout) == 0) {
-        zfree(reply);
-        return 1;
+    if (!isatty(fileno(stdout))) {
+        if (bulklen && fwrite(reply,bulklen,1,stdout) == 0) {
+            zfree(reply);
+            return 1;
+        }
+        if (reply[bulklen-1] != '\n') printf("\n");
+    } else {
+        /* If you are producing output for the standard output we want
+         * a more interesting output with quoted characters and so forth */
+        printStringRepr(reply,bulklen);

     }
     }

-    if (isatty(fileno(stdout)) && reply[bulklen-1] != '\n')
-        printf("\n");

     zfree(reply);
     return 0;
 }
     zfree(reply);
     return 0;
 }


@@ -259,8 +327,7 @@ static int cliReadReply(int fd) {
     }
 }
 
     }
 }
 

-static int selectDb(int fd)
-{
+static int selectDb(int fd) {

     int retval;
     sds cmd;
     char type;
     int retval;
     sds cmd;
     char type;


@@ -275,15 +342,15 @@ static int selectDb(int fd)
     if (type <= 0 || type != '+') return 1;
     retval = cliReadSingleLineReply(fd,1);
     if (retval) {
     if (type <= 0 || type != '+') return 1;
     retval = cliReadSingleLineReply(fd,1);
     if (retval) {

-        close(fd);
-       return retval;
+        return retval;

     }
     return 0;
 }
 
     }
     return 0;
 }
 

-static int cliSendCommand(int argc, char **argv) {
+static int cliSendCommand(int argc, char **argv, int repeat) {

     struct redisCommand *rc = lookupCommand(argv[0]);
     int fd, j, retval = 0;
     struct redisCommand *rc = lookupCommand(argv[0]);
     int fd, j, retval = 0;

+    int read_forever = 0;

     sds cmd;
 
     if (!rc) {
     sds cmd;
 
     if (!rc) {


@@ -296,6 +363,7 @@ static int cliSendCommand(int argc, char **argv) {
             fprintf(stderr,"Wrong number of arguments for '%s'\n",rc->name);
             return 1;
     }
             fprintf(stderr,"Wrong number of arguments for '%s'\n",rc->name);
             return 1;
     }

+    if (!strcasecmp(rc->name,"monitor")) read_forever = 1;

     if ((fd = cliConnect()) == -1) return 1;
 
     /* Select db number */
     if ((fd = cliConnect()) == -1) return 1;
 
     /* Select db number */


@@ -304,14 +372,15 @@ static int cliSendCommand(int argc, char **argv) {
         fprintf(stderr,"Error setting DB num\n");
         return 1;
     }
         fprintf(stderr,"Error setting DB num\n");
         return 1;
     }

- 
-    while(config.repeat--) {
+
+    while(repeat--) {

         /* Build the command to send */
         cmd = sdsempty();
         if (rc->flags & REDIS_CMD_MULTIBULK) {
             cmd = sdscatprintf(cmd,"*%d\r\n",argc);
             for (j = 0; j < argc; j++) {
         /* Build the command to send */
         cmd = sdsempty();
         if (rc->flags & REDIS_CMD_MULTIBULK) {
             cmd = sdscatprintf(cmd,"*%d\r\n",argc);
             for (j = 0; j < argc; j++) {

-                cmd = sdscatprintf(cmd,"$%d\r\n",sdslen(argv[j]));
+                cmd = sdscatprintf(cmd,"$%lu\r\n",
+                    (unsigned long)sdslen(argv[j]));

                 cmd = sdscatlen(cmd,argv[j],sdslen(argv[j]));
                 cmd = sdscatlen(cmd,"\r\n",2);
             }
                 cmd = sdscatlen(cmd,argv[j],sdslen(argv[j]));
                 cmd = sdscatlen(cmd,"\r\n",2);
             }


@@ -319,7 +388,8 @@ static int cliSendCommand(int argc, char **argv) {
             for (j = 0; j < argc; j++) {
                 if (j != 0) cmd = sdscat(cmd," ");
                 if (j == argc-1 && rc->flags & REDIS_CMD_BULK) {
             for (j = 0; j < argc; j++) {
                 if (j != 0) cmd = sdscat(cmd," ");
                 if (j == argc-1 && rc->flags & REDIS_CMD_BULK) {

-                    cmd = sdscatprintf(cmd,"%d",sdslen(argv[j]));
+                    cmd = sdscatprintf(cmd,"%lu",
+                        (unsigned long)sdslen(argv[j]));

                 } else {
                     cmd = sdscatlen(cmd,argv[j],sdslen(argv[j]));
                 }
                 } else {
                     cmd = sdscatlen(cmd,argv[j],sdslen(argv[j]));
                 }


@@ -332,13 +402,16 @@ static int cliSendCommand(int argc, char **argv) {
         }
         anetWrite(fd,cmd,sdslen(cmd));
         sdsfree(cmd);
         }
         anetWrite(fd,cmd,sdslen(cmd));
         sdsfree(cmd);

+
+        while (read_forever) {
+            cliReadSingleLineReply(fd,0);
+        }
+

         retval = cliReadReply(fd);
         if (retval) {
         retval = cliReadReply(fd);
         if (retval) {

-            close(fd);

             return retval;
         }
     }
             return retval;
         }
     }

-    close(fd);

     return 0;
 }
 
     return 0;
 }
 


@@ -347,7 +420,7 @@ static int parseOptions(int argc, char **argv) {
 
     for (i = 1; i < argc; i++) {
         int lastarg = i==argc-1;
 
     for (i = 1; i < argc; i++) {
         int lastarg = i==argc-1;

-        
+

         if (!strcmp(argv[i],"-h") && !lastarg) {
             char *ip = zmalloc(32);
             if (anetResolve(NULL,argv[i+1],ip) == ANET_ERR) {
         if (!strcmp(argv[i],"-h") && !lastarg) {
             char *ip = zmalloc(32);
             if (anetResolve(NULL,argv[i+1],ip) == ANET_ERR) {


@@ -356,6 +429,8 @@ static int parseOptions(int argc, char **argv) {
             }
             config.hostip = ip;
             i++;
             }
             config.hostip = ip;
             i++;

+        } else if (!strcmp(argv[i],"-h") && lastarg) {
+            usage();

         } else if (!strcmp(argv[i],"-p") && !lastarg) {
             config.hostport = atoi(argv[i+1]);
             i++;
         } else if (!strcmp(argv[i],"-p") && !lastarg) {
             config.hostport = atoi(argv[i+1]);
             i++;


@@ -365,6 +440,11 @@ static int parseOptions(int argc, char **argv) {
         } else if (!strcmp(argv[i],"-n") && !lastarg) {
             config.dbnum = atoi(argv[i+1]);
             i++;
         } else if (!strcmp(argv[i],"-n") && !lastarg) {
             config.dbnum = atoi(argv[i+1]);
             i++;

+        } else if (!strcmp(argv[i],"-a") && !lastarg) {
+            config.auth = argv[i+1];
+            i++;
+        } else if (!strcmp(argv[i],"-i")) {
+            config.interactive = 1;

         } else {
             break;
         }
         } else {
             break;
         }


@@ -389,8 +469,122 @@ static sds readArgFromStdin(void) {
     return arg;
 }
 
     return arg;
 }
 

+static void usage() {
+    fprintf(stderr, "usage: redis-cli [-h host] [-p port] [-a authpw] [-r repeat_times] [-n db_num] [-i] cmd arg1 arg2 arg3 ... argN\n");
+    fprintf(stderr, "usage: echo \"argN\" | redis-cli [-h host] [-a authpw] [-p port] [-r repeat_times] [-n db_num] cmd arg1 arg2 ... arg(N-1)\n");
+    fprintf(stderr, "\nIf a pipe from standard input is detected this data is used as last argument.\n\n");
+    fprintf(stderr, "example: cat /etc/passwd | redis-cli set my_passwd\n");
+    fprintf(stderr, "example: redis-cli get my_passwd\n");
+    fprintf(stderr, "example: redis-cli -r 100 lpush mylist x\n");
+    fprintf(stderr, "\nRun in interactive mode: redis-cli -i or just don't pass any command\n");
+    exit(1);
+}
+
+/* Turn the plain C strings into Sds strings */
+static char **convertToSds(int count, char** args) {
+  int j;
+  char **sds = zmalloc(sizeof(char*)*count+1);
+
+  for(j = 0; j < count; j++)
+    sds[j] = sdsnew(args[j]);
+
+  return sds;
+}
+
+static char **splitArguments(char *line, int *argc) {
+    char *p = line;
+    char *current = NULL;
+    char **vector = NULL;
+
+    *argc = 0;
+    while(1) {
+        /* skip blanks */
+        while(*p && isspace(*p)) p++;
+        if (*p) {
+            /* get a token */
+            int inq=0; /* set to 1 if we are in "quotes" */
+            int done = 0;
+
+            if (current == NULL) current = sdsempty();
+            while(!done) {
+                if (inq) {
+                    if (*p == '\\' && *(p+1)) {
+                        char c;
+
+                        p++;
+                        switch(*p) {
+                        case 'n': c = '\n'; break;
+                        case 'r': c = '\r'; break;
+                        case 't': c = '\t'; break;
+                        case 'b': c = '\b'; break;
+                        case 'a': c = '\a'; break;
+                        default: c = *p; break;
+                        }
+                        current = sdscatlen(current,&c,1);
+                    } else if (*p == '"') {
+                        done = 1;
+                    } else {
+                        current = sdscatlen(current,p,1);
+                    }
+                } else {
+                    switch(*p) {
+                    case ' ':
+                    case '\n':
+                    case '\r':
+                    case '\t':
+                    case '\0':
+                        done=1;
+                        break;
+                    case '"':
+                        inq=1;
+                        break;
+                    default:
+                        current = sdscatlen(current,p,1);
+                        break;
+                    }
+                }
+                if (*p) p++;
+            }
+            /* add the token to the vector */
+            vector = zrealloc(vector,((*argc)+1)*sizeof(char*));
+            vector[*argc] = current;
+            (*argc)++;
+            current = NULL;
+        } else {
+            return vector;
+        }
+    }
+}
+
+#define LINE_BUFLEN 4096
+static void repl() {
+    int argc, j;
+    char *line, **argv;
+
+    while((line = linenoise("redis> ")) != NULL) {
+        if (line[0] != '\0') {
+            argv = splitArguments(line,&argc);
+            linenoiseHistoryAdd(line);
+            if (argc > 0) {
+                if (strcasecmp(argv[0],"quit") == 0 ||
+                    strcasecmp(argv[0],"exit") == 0)
+                        exit(0);
+                else
+                    cliSendCommand(argc, argv, 1);
+            }
+            /* Free the argument vector */
+            for (j = 0; j < argc; j++)
+                sdsfree(argv[j]);
+            free(argv);
+        }
+        /* linenoise() returns malloc-ed lines like readline() */
+        free(line);
+    }
+    exit(0);
+}
+

 int main(int argc, char **argv) {
 int main(int argc, char **argv) {

-    int firstarg, j;
+    int firstarg;

     char **argvcopy;
     struct redisCommand *rc;
 
     char **argvcopy;
     struct redisCommand *rc;
 


@@ -398,34 +592,33 @@ int main(int argc, char **argv) {
     config.hostport = 6379;
     config.repeat = 1;
     config.dbnum = 0;
     config.hostport = 6379;
     config.repeat = 1;
     config.dbnum = 0;

+    config.interactive = 0;
+    config.auth = NULL;

 
     firstarg = parseOptions(argc,argv);
     argc -= firstarg;
     argv += firstarg;
 
     firstarg = parseOptions(argc,argv);
     argc -= firstarg;
     argv += firstarg;

-    
-    /* Turn the plain C strings into Sds strings */
-    argvcopy = zmalloc(sizeof(char*)*argc+1);
-    for(j = 0; j < argc; j++)
-        argvcopy[j] = sdsnew(argv[j]);
-
-    if (argc < 1) {
-        fprintf(stderr, "usage: redis-cli [-h host] [-p port] [-r repeat_times] [-n db_num] cmd arg1 arg2 arg3 ... argN\n");
-        fprintf(stderr, "usage: echo \"argN\" | redis-cli [-h host] [-p port] [-r repeat_times] [-n db_num] cmd arg1 arg2 ... arg(N-1)\n");
-        fprintf(stderr, "\nIf a pipe from standard input is detected this data is used as last argument.\n\n");
-        fprintf(stderr, "example: cat /etc/passwd | redis-cli set my_passwd\n");
-        fprintf(stderr, "example: redis-cli get my_passwd\n");
-        fprintf(stderr, "example: redis-cli -r 100 lpush mylist x\n");
-        exit(1);
+
+    if (config.auth != NULL) {
+        char *authargv[2];
+
+        authargv[0] = "AUTH";
+        authargv[1] = config.auth;
+        cliSendCommand(2, convertToSds(2, authargv), 1);

     }
 
     }
 

+    if (argc == 0 || config.interactive == 1) repl();
+
+    argvcopy = convertToSds(argc, argv);
+

     /* Read the last argument from stdandard input if needed */
     if ((rc = lookupCommand(argv[0])) != NULL) {
     /* Read the last argument from stdandard input if needed */
     if ((rc = lookupCommand(argv[0])) != NULL) {

-        if (rc->arity > 0 && argc == rc->arity-1) {
-            sds lastarg = readArgFromStdin();
-            argvcopy[argc] = lastarg;
-            argc++;
-        }
+      if (rc->arity > 0 && argc == rc->arity-1) {
+        sds lastarg = readArgFromStdin();
+        argvcopy[argc] = lastarg;
+        argc++;
+      }

     }
 
     }
 

-    return cliSendCommand(argc, argvcopy);
+    return cliSendCommand(argc, argvcopy, config.repeat);

 }
 }