X-Git-Url: https://git.saurik.com/redis.git/blobdiff_plain/99628c1af8ab2a2af4f2baf7039c08acdf0974ce..339b9dc2d2e7d319e29581b367a1027365186cc3:/src/redis-cli.c diff --git a/src/redis-cli.c b/src/redis-cli.c index dac82862..fec0fce4 100644 --- a/src/redis-cli.c +++ b/src/redis-cli.c @@ -36,255 +36,280 @@ #include #include #include +#include +#include +#include -#include "anet.h" +#include "hiredis.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_MULTIBULK 4 - #define REDIS_NOTUSED(V) ((void) V) +static redisContext *context; static struct config { char *hostip; int hostport; + char *hostsocket; long repeat; int dbnum; - int argn_from_stdin; int interactive; int shutdown; int monitor_mode; int pubsub_mode; - int raw_output; + int raw_output; /* output mode per command */ + int tty; /* flag for default output format */ + int stdinarg; /* get last arg from stdin. (-x option) */ + char mb_sep; char *auth; char *historyfile; } config; -static int cliReadReply(int fd); static void usage(); -static int cliConnect(void) { - char err[ANET_ERR_LEN]; - static int fd = ANET_ERR; - - if (fd == ANET_ERR) { - 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); - } - return fd; -} +/*------------------------------------------------------------------------------ + * Utility functions + *--------------------------------------------------------------------------- */ -static sds cliReadLine(int fd) { - sds line = sdsempty(); +static long long mstime(void) { + struct timeval tv; + long long mst; - while(1) { - char c; - ssize_t ret; - - ret = read(fd,&c,1); - if (ret == -1) { - sdsfree(line); - return NULL; - } else if ((ret == 0) || (c == '\n')) { - break; - } else { - line = sdscatlen(line,&c,1); - } - } - return sdstrim(line,"\r\n"); + gettimeofday(&tv, NULL); + mst = ((long)tv.tv_sec)*1000; + mst += tv.tv_usec/1000; + return mst; } -static int cliReadSingleLineReply(int fd, int quiet) { - sds reply = cliReadLine(fd); +/*------------------------------------------------------------------------------ + * Networking / parsing + *--------------------------------------------------------------------------- */ - if (reply == NULL) return 1; - if (!quiet) - printf("%s\n", reply); - sdsfree(reply); - return 0; -} +/* Send AUTH command to the server */ +static int cliAuth() { + redisReply *reply; + if (config.auth == NULL) return REDIS_OK; -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++; + reply = redisCommand(context,"AUTH %s",config.auth); + if (reply != NULL) { + freeReplyObject(reply); + return REDIS_OK; } - printf("\"\n"); + return REDIS_ERR; } -static int cliReadBulkReply(int fd) { - sds replylen = cliReadLine(fd); - char *reply, crlf[2]; - int bulklen; - - if (replylen == NULL) return 1; - bulklen = atoi(replylen); - if (bulklen == -1) { - sdsfree(replylen); - printf("(nil)\n"); - return 0; +/* Send SELECT dbnum to the server */ +static int cliSelect() { + redisReply *reply; + char dbnum[16]; + if (config.dbnum == 0) return REDIS_OK; + + snprintf(dbnum,sizeof(dbnum),"%d",config.dbnum); + reply = redisCommand(context,"SELECT %s",dbnum); + if (reply != NULL) { + freeReplyObject(reply); + return REDIS_OK; } - reply = zmalloc(bulklen); - anetRead(fd,reply,bulklen); - anetRead(fd,crlf,2); - if (config.raw_output || !isatty(fileno(stdout))) { - if (bulklen && fwrite(reply,bulklen,1,stdout) == 0) { - zfree(reply); - return 1; - } - } 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); - } - zfree(reply); - return 0; + return REDIS_ERR; } -static int cliReadMultiBulkReply(int fd) { - sds replylen = cliReadLine(fd); - int elements, c = 1; +/* Connect to the client. If force is not zero the connection is performed + * even if there is already a connected socket. */ +static int cliConnect(int force) { + if (context == NULL || force) { + if (context != NULL) + redisFree(context); - if (replylen == NULL) return 1; - elements = atoi(replylen); - if (elements == -1) { - sdsfree(replylen); - printf("(nil)\n"); - return 0; - } - if (elements == 0) { - printf("(empty list or set)\n"); - } - while(elements--) { - printf("%d. ", c); - if (cliReadReply(fd)) return 1; - c++; + if (config.hostsocket == NULL) { + context = redisConnect(config.hostip,config.hostport); + } else { + context = redisConnectUnix(config.hostsocket); + } + + if (context->err) { + fprintf(stderr,"Could not connect to Redis at "); + if (config.hostsocket == NULL) + fprintf(stderr,"%s:%d: %s\n",config.hostip,config.hostport,context->errstr); + else + fprintf(stderr,"%s: %s\n",config.hostsocket,context->errstr); + redisFree(context); + context = NULL; + return REDIS_ERR; + } + + /* Do AUTH and select the right DB. */ + if (cliAuth() != REDIS_OK) + return REDIS_ERR; + if (cliSelect() != REDIS_OK) + return REDIS_ERR; } - return 0; + return REDIS_OK; } -static int cliReadReply(int fd) { - char type; +static void cliPrintContextErrorAndExit() { + if (context == NULL) return; + fprintf(stderr,"Error: %s\n",context->errstr); + exit(1); +} - if (anetRead(fd,&type,1) <= 0) { - if (config.shutdown) return 0; - exit(1); - } - switch(type) { - case '-': - printf("(error) "); - cliReadSingleLineReply(fd,0); - return 1; - case '+': - return cliReadSingleLineReply(fd,0); - case ':': - printf("(integer) "); - return cliReadSingleLineReply(fd,0); - case '$': - return cliReadBulkReply(fd); - case '*': - return cliReadMultiBulkReply(fd); +static sds cliFormatReply(redisReply *r, char *prefix) { + sds out = sdsempty(); + switch (r->type) { + case REDIS_REPLY_ERROR: + if (config.tty) out = sdscat(out,"(error) "); + out = sdscatprintf(out,"%s\n", r->str); + break; + case REDIS_REPLY_STATUS: + out = sdscat(out,r->str); + out = sdscat(out,"\n"); + break; + case REDIS_REPLY_INTEGER: + if (config.tty) out = sdscat(out,"(integer) "); + out = sdscatprintf(out,"%lld\n",r->integer); + break; + case REDIS_REPLY_STRING: + if (config.raw_output || !config.tty) { + out = sdscatlen(out,r->str,r->len); + } else { + /* If you are producing output for the standard output we want + * a more interesting output with quoted characters and so forth */ + out = sdscatrepr(out,r->str,r->len); + out = sdscat(out,"\n"); + } + break; + case REDIS_REPLY_NIL: + out = sdscat(out,"(nil)\n"); + break; + case REDIS_REPLY_ARRAY: + if (r->elements == 0) { + out = sdscat(out,"(empty list or set)\n"); + } else { + unsigned int i, idxlen = 0; + char _prefixlen[16]; + char _prefixfmt[16]; + sds _prefix; + sds tmp; + + /* Calculate chars needed to represent the largest index */ + i = r->elements; + do { + idxlen++; + i /= 10; + } while(i); + + /* Prefix for nested multi bulks should grow with idxlen+2 spaces */ + memset(_prefixlen,' ',idxlen+2); + _prefixlen[idxlen+2] = '\0'; + _prefix = sdscat(sdsnew(prefix),_prefixlen); + + /* Setup prefix format for every entry */ + snprintf(_prefixfmt,sizeof(_prefixfmt),"%%s%%%dd) ",idxlen); + + for (i = 0; i < r->elements; i++) { + /* Don't use the prefix for the first element, as the parent + * caller already prepended the index number. */ + out = sdscatprintf(out,_prefixfmt,i == 0 ? "" : prefix,i+1); + + /* Format the multi bulk entry */ + tmp = cliFormatReply(r->element[i],_prefix); + out = sdscatlen(out,tmp,sdslen(tmp)); + sdsfree(tmp); + } + sdsfree(_prefix); + } + break; default: - printf("protocol error, got '%c' as reply type byte\n", type); - return 1; + fprintf(stderr,"Unknown reply type: %d\n", r->type); + exit(1); } + return out; } -static int selectDb(int fd) { - int retval; - sds cmd; - char type; - - if (config.dbnum == 0) - return 0; - - cmd = sdsempty(); - cmd = sdscatprintf(cmd,"SELECT %d\r\n",config.dbnum); - anetWrite(fd,cmd,sdslen(cmd)); - anetRead(fd,&type,1); - if (type <= 0 || type != '+') return 1; - retval = cliReadSingleLineReply(fd,1); - if (retval) { - return retval; +static int cliReadReply() { + redisReply *reply; + sds out; + + if (redisGetReply(context,(void**)&reply) != REDIS_OK) { + if (config.shutdown) + return REDIS_OK; + if (config.interactive) { + /* Filter cases where we should reconnect */ + if (context->err == REDIS_ERR_IO && errno == ECONNRESET) + return REDIS_ERR; + if (context->err == REDIS_ERR_EOF) + return REDIS_ERR; + } + cliPrintContextErrorAndExit(); + return REDIS_ERR; /* avoid compiler warning */ } - return 0; + + out = cliFormatReply(reply,""); + freeReplyObject(reply); + fwrite(out,sdslen(out),1,stdout); + sdsfree(out); + return REDIS_OK; +} + +static void showInteractiveHelp(void) { + printf( + "\n" + "Welcome to redis-cli " REDIS_VERSION "!\n" + "Just type any valid Redis command to see a pretty printed output.\n" + "\n" + "It is possible to quote strings, like in:\n" + " set \"my key\" \"some string \\xff\\n\"\n" + "\n" + "You can find a list of valid Redis commands at\n" + " http://code.google.com/p/redis/wiki/CommandReference\n" + "\n" + "Note: redis-cli supports line editing, use up/down arrows for history." + "\n\n"); } static int cliSendCommand(int argc, char **argv, int repeat) { char *command = argv[0]; - int fd, j, retval = 0; - sds cmd; + size_t *argvlen; + int j; config.raw_output = !strcasecmp(command,"info"); + if (!strcasecmp(command,"help")) { + showInteractiveHelp(); + return REDIS_OK; + } if (!strcasecmp(command,"shutdown")) config.shutdown = 1; if (!strcasecmp(command,"monitor")) config.monitor_mode = 1; if (!strcasecmp(command,"subscribe") || !strcasecmp(command,"psubscribe")) config.pubsub_mode = 1; - if ((fd = cliConnect()) == -1) return 1; - - /* Select db number */ - retval = selectDb(fd); - if (retval) { - fprintf(stderr,"Error setting DB num\n"); - return 1; - } - /* Build the command to send */ - cmd = sdscatprintf(sdsempty(),"*%d\r\n",argc); - for (j = 0; j < argc; 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); - } + /* Setup argument length */ + argvlen = malloc(argc*sizeof(size_t)); + for (j = 0; j < argc; j++) + argvlen[j] = sdslen(argv[j]); while(repeat--) { - anetWrite(fd,cmd,sdslen(cmd)); + redisAppendCommandArgv(context,argc,(const char**)argv,argvlen); while (config.monitor_mode) { - cliReadSingleLineReply(fd,0); + if (cliReadReply() != REDIS_OK) exit(1); } if (config.pubsub_mode) { - printf("Reading messages... (press Ctrl-c to quit)\n"); + printf("Reading messages... (press Ctrl-C to quit)\n"); while (1) { - cliReadReply(fd); - printf("\n"); + if (cliReadReply() != REDIS_OK) exit(1); } } - retval = cliReadReply(fd); - if (retval) { - return retval; - } + if (cliReadReply() != REDIS_OK) + return REDIS_ERR; } - return 0; + return REDIS_OK; } +/*------------------------------------------------------------------------------ + * User interface + *--------------------------------------------------------------------------- */ + static int parseOptions(int argc, char **argv) { int i; @@ -292,18 +317,18 @@ static int parseOptions(int argc, char **argv) { int lastarg = i==argc-1; if (!strcmp(argv[i],"-h") && !lastarg) { - char *ip = zmalloc(32); - if (anetResolve(NULL,argv[i+1],ip) == ANET_ERR) { - printf("Can't resolve %s\n", argv[i]); - exit(1); - } - config.hostip = ip; + config.hostip = argv[i+1]; i++; } else if (!strcmp(argv[i],"-h") && lastarg) { usage(); + } else if (!strcmp(argv[i],"-x")) { + config.stdinarg = 1; } else if (!strcmp(argv[i],"-p") && !lastarg) { config.hostport = atoi(argv[i+1]); i++; + } else if (!strcmp(argv[i],"-s") && !lastarg) { + config.hostsocket = argv[i+1]; + i++; } else if (!strcmp(argv[i],"-r") && !lastarg) { config.repeat = strtoll(argv[i+1],NULL,10); i++; @@ -314,11 +339,18 @@ static int parseOptions(int argc, char **argv) { config.auth = argv[i+1]; i++; } else if (!strcmp(argv[i],"-i")) { - config.interactive = 1; + fprintf(stderr, +"Starting interactive mode using -i is deprecated. Interactive mode is started\n" +"by default when redis-cli is executed without a command to execute.\n" + ); } else if (!strcmp(argv[i],"-c")) { - config.argn_from_stdin = 1; + fprintf(stderr, +"Reading last argument from standard input using -c is deprecated.\n" +"When standard input is connected to a pipe or regular file, it is\n" +"automatically used as last argument.\n" + ); } else if (!strcmp(argv[i],"-v")) { - printf("redis-cli shipped with Redis verison %s\n", REDIS_VERSION); + printf("redis-cli shipped with Redis version %s\n", REDIS_VERSION); exit(0); } else { break; @@ -345,10 +377,9 @@ static sds readArgFromStdin(void) { } static void usage() { - fprintf(stderr, "usage: redis-cli [-iv] [-h host] [-p port] [-a authpw] [-r repeat_times] [-n db_num] cmd arg1 arg2 arg3 ... argN\n"); - fprintf(stderr, "usage: echo \"argN\" | redis-cli -c [-h host] [-p port] [-a authpw] [-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, "usage: redis-cli [-iv] [-h host] [-p port] [-s /path/to/socket] [-a authpw] [-r repeat_times] [-n db_num] cmd arg1 arg2 arg3 ... argN\n"); + fprintf(stderr, "usage: echo \"argN\" | redis-cli -x [options] cmd arg1 arg2 ... arg(N-1)\n\n"); + fprintf(stderr, "example: cat /etc/passwd | redis-cli -x 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"); @@ -366,87 +397,45 @@ static char **convertToSds(int count, char** args) { 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; + char *line; + sds *argv; + config.interactive = 1; while((line = linenoise("redis> ")) != NULL) { if (line[0] != '\0') { - argv = splitArguments(line,&argc); + argv = sdssplitargs(line,&argc); linenoiseHistoryAdd(line); if (config.historyfile) linenoiseHistorySave(config.historyfile); - if (argc > 0) { + if (argv == NULL) { + printf("Invalid argument(s)\n"); + continue; + } else if (argc > 0) { if (strcasecmp(argv[0],"quit") == 0 || strcasecmp(argv[0],"exit") == 0) - exit(0); - else - cliSendCommand(argc, argv, 1); + { + exit(0); + } else { + long long start_time = mstime(), elapsed; + + if (cliSendCommand(argc,argv,1) != REDIS_OK) { + printf("Reconnecting... "); + fflush(stdout); + if (cliConnect(1) != REDIS_OK) exit(1); + printf("OK\n"); + + /* If we still cannot send the command, + * print error and abort. */ + if (cliSendCommand(argc,argv,1) != REDIS_OK) + cliPrintContextErrorAndExit(); + } + elapsed = mstime()-start_time; + if (elapsed >= 500) { + printf("(%.2fs)\n",(double)elapsed/1000); + } + } } /* Free the argument vector */ for (j = 0; j < argc; j++) @@ -459,22 +448,37 @@ static void repl() { exit(0); } +static int noninteractive(int argc, char **argv) { + int retval = 0; + if (config.stdinarg) { + argv = zrealloc(argv, (argc+1)*sizeof(char*)); + argv[argc] = readArgFromStdin(); + retval = cliSendCommand(argc+1, argv, config.repeat); + } else { + /* stdin is probably a tty, can be tested with S_ISCHR(s.st_mode) */ + retval = cliSendCommand(argc, argv, config.repeat); + } + return retval; +} + int main(int argc, char **argv) { int firstarg; - char **argvcopy; config.hostip = "127.0.0.1"; config.hostport = 6379; + config.hostsocket = NULL; config.repeat = 1; config.dbnum = 0; - config.argn_from_stdin = 0; - config.shutdown = 0; config.interactive = 0; + config.shutdown = 0; config.monitor_mode = 0; config.pubsub_mode = 0; config.raw_output = 0; + config.stdinarg = 0; config.auth = NULL; config.historyfile = NULL; + config.tty = isatty(fileno(stdout)) || (getenv("FAKETTY") != NULL); + config.mb_sep = '\n'; if (getenv("HOME") != NULL) { config.historyfile = malloc(256); @@ -486,21 +490,11 @@ int main(int argc, char **argv) { argc -= firstarg; argv += firstarg; - if (config.auth != NULL) { - char *authargv[2]; + /* Try to connect */ + if (cliConnect(0) != REDIS_OK) exit(1); - authargv[0] = "AUTH"; - authargv[1] = config.auth; - cliSendCommand(2, convertToSds(2, authargv), 1); - } - - if (argc == 0 || config.interactive == 1) repl(); - - argvcopy = convertToSds(argc+1, argv); - if (config.argn_from_stdin) { - sds lastarg = readArgFromStdin(); - argvcopy[argc] = lastarg; - argc++; - } - return cliSendCommand(argc, argvcopy, config.repeat); + /* Start interactive mode when no command is provided */ + if (argc == 0) repl(); + /* Otherwise, we have some arguments to execute */ + return noninteractive(argc,convertToSds(argc,argv)); }