redis-cli.c

   1 /* Redis CLI (command line interface)
   2  *
   3  * Copyright (c) 2009-2010, Salvatore Sanfilippo <antirez at gmail dot com>
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions are met:
   8  *
   9  *   * Redistributions of source code must retain the above copyright notice,
  10  *     this list of conditions and the following disclaimer.
  11  *   * Redistributions in binary form must reproduce the above copyright
  12  *     notice, this list of conditions and the following disclaimer in the
  13  *     documentation and/or other materials provided with the distribution.
  14  *   * Neither the name of Redis nor the names of its contributors may be used
  15  *     to endorse or promote products derived from this software without
  16  *     specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28  * POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #include "fmacros.h"
  32
  33 #include <stdio.h>
  34 #include <string.h>
  35 #include <stdlib.h>
  36 #include <unistd.h>
  37
  38 #include "anet.h"
  39 #include "sds.h"
  40 #include "adlist.h"
  41 #include "zmalloc.h"
  42
  43 #define REDIS_CMD_INLINE 1
  44 #define REDIS_CMD_BULK 2
  45 #define REDIS_CMD_MULTIBULK 4
  46
  47 #define REDIS_NOTUSED(V) ((void) V)
  48
  49 static struct config {
  50     char *hostip;
  51     int hostport;
  52     long repeat;
  53     int dbnum;
  54     int interactive;
  55 } config;
  56
  57 struct redisCommand {
  58     char *name;
  59     int arity;
  60     int flags;
  61 };
  62
  63 static struct redisCommand cmdTable[] = {
  64     {"get",2,REDIS_CMD_INLINE},
  65     {"set",3,REDIS_CMD_BULK},
  66     {"setnx",3,REDIS_CMD_BULK},
  67     {"append",3,REDIS_CMD_BULK},
  68     {"substr",4,REDIS_CMD_INLINE},
  69     {"del",-2,REDIS_CMD_INLINE},
  70     {"exists",2,REDIS_CMD_INLINE},
  71     {"incr",2,REDIS_CMD_INLINE},
  72     {"decr",2,REDIS_CMD_INLINE},
  73     {"rpush",3,REDIS_CMD_BULK},
  74     {"lpush",3,REDIS_CMD_BULK},
  75     {"rpop",2,REDIS_CMD_INLINE},
  76     {"lpop",2,REDIS_CMD_INLINE},
  77     {"brpop",-3,REDIS_CMD_INLINE},
  78     {"blpop",-3,REDIS_CMD_INLINE},
  79     {"llen",2,REDIS_CMD_INLINE},
  80     {"lindex",3,REDIS_CMD_INLINE},
  81     {"lset",4,REDIS_CMD_BULK},
  82     {"lrange",4,REDIS_CMD_INLINE},
  83     {"ltrim",4,REDIS_CMD_INLINE},
  84     {"lrem",4,REDIS_CMD_BULK},
  85     {"rpoplpush",3,REDIS_CMD_BULK},
  86     {"sadd",3,REDIS_CMD_BULK},
  87     {"srem",3,REDIS_CMD_BULK},
  88     {"smove",4,REDIS_CMD_BULK},
  89     {"sismember",3,REDIS_CMD_BULK},
  90     {"scard",2,REDIS_CMD_INLINE},
  91     {"spop",2,REDIS_CMD_INLINE},
  92     {"srandmember",2,REDIS_CMD_INLINE},
  93     {"sinter",-2,REDIS_CMD_INLINE},
  94     {"sinterstore",-3,REDIS_CMD_INLINE},
  95     {"sunion",-2,REDIS_CMD_INLINE},
  96     {"sunionstore",-3,REDIS_CMD_INLINE},
  97     {"sdiff",-2,REDIS_CMD_INLINE},
  98     {"sdiffstore",-3,REDIS_CMD_INLINE},
  99     {"smembers",2,REDIS_CMD_INLINE},
 100     {"zadd",4,REDIS_CMD_BULK},
 101     {"zincrby",4,REDIS_CMD_BULK},
 102     {"zrem",3,REDIS_CMD_BULK},
 103     {"zremrangebyscore",4,REDIS_CMD_INLINE},
 104     {"zmerge",-3,REDIS_CMD_INLINE},
 105     {"zmergeweighed",-4,REDIS_CMD_INLINE},
 106     {"zrange",-4,REDIS_CMD_INLINE},
 107     {"zrank",3,REDIS_CMD_BULK},
 108     {"zrevrank",3,REDIS_CMD_BULK},
 109     {"zrangebyscore",-4,REDIS_CMD_INLINE},
 110     {"zcount",4,REDIS_CMD_INLINE},
 111     {"zrevrange",-4,REDIS_CMD_INLINE},
 112     {"zcard",2,REDIS_CMD_INLINE},
 113     {"zscore",3,REDIS_CMD_BULK},
 114     {"incrby",3,REDIS_CMD_INLINE},
 115     {"decrby",3,REDIS_CMD_INLINE},
 116     {"getset",3,REDIS_CMD_BULK},
 117     {"randomkey",1,REDIS_CMD_INLINE},
 118     {"select",2,REDIS_CMD_INLINE},
 119     {"move",3,REDIS_CMD_INLINE},
 120     {"rename",3,REDIS_CMD_INLINE},
 121     {"renamenx",3,REDIS_CMD_INLINE},
 122     {"keys",2,REDIS_CMD_INLINE},
 123     {"dbsize",1,REDIS_CMD_INLINE},
 124     {"ping",1,REDIS_CMD_INLINE},
 125     {"echo",2,REDIS_CMD_BULK},
 126     {"save",1,REDIS_CMD_INLINE},
 127     {"bgsave",1,REDIS_CMD_INLINE},
 128     {"rewriteaof",1,REDIS_CMD_INLINE},
 129     {"bgrewriteaof",1,REDIS_CMD_INLINE},
 130     {"shutdown",1,REDIS_CMD_INLINE},
 131     {"lastsave",1,REDIS_CMD_INLINE},
 132     {"type",2,REDIS_CMD_INLINE},
 133     {"flushdb",1,REDIS_CMD_INLINE},
 134     {"flushall",1,REDIS_CMD_INLINE},
 135     {"sort",-2,REDIS_CMD_INLINE},
 136     {"info",1,REDIS_CMD_INLINE},
 137     {"mget",-2,REDIS_CMD_INLINE},
 138     {"expire",3,REDIS_CMD_INLINE},
 139     {"expireat",3,REDIS_CMD_INLINE},
 140     {"ttl",2,REDIS_CMD_INLINE},
 141     {"slaveof",3,REDIS_CMD_INLINE},
 142     {"debug",-2,REDIS_CMD_INLINE},
 143     {"mset",-3,REDIS_CMD_MULTIBULK},
 144     {"msetnx",-3,REDIS_CMD_MULTIBULK},
 145     {"monitor",1,REDIS_CMD_INLINE},
 146     {"multi",1,REDIS_CMD_INLINE},
 147     {"exec",1,REDIS_CMD_INLINE},
 148     {"discard",1,REDIS_CMD_INLINE},
 149     {"hset",4,REDIS_CMD_MULTIBULK},
 150     {"hget",3,REDIS_CMD_BULK},
 151     {"hdel",3,REDIS_CMD_BULK},
 152     {"hlen",2,REDIS_CMD_INLINE},
 153     {"hkeys",2,REDIS_CMD_INLINE},
 154     {"hvals",2,REDIS_CMD_INLINE},
 155     {"hgetall",2,REDIS_CMD_INLINE},
 156     {"hexists",3,REDIS_CMD_BULK},
 157     {NULL,0,0}
 158 };
 159
 160 static int cliReadReply(int fd);
 161 static void usage();
 162
 163 static struct redisCommand *lookupCommand(char *name) {
 164     int j = 0;
 165     while(cmdTable[j].name != NULL) {
 166         if (!strcasecmp(name,cmdTable[j].name)) return &cmdTable[j];
 167         j++;
 168     }
 169     return NULL;
 170 }
 171
 172 static int cliConnect(void) {
 173     char err[ANET_ERR_LEN];
 174     static int fd = ANET_ERR;
 175
 176     if (fd == ANET_ERR) {
 177         fd = anetTcpConnect(err,config.hostip,config.hostport);
 178         if (fd == ANET_ERR) {
 179             fprintf(stderr, "Could not connect to Redis at %s:%d: %s", config.hostip, config.hostport, err);
 180             return -1;
 181         }
 182         anetTcpNoDelay(NULL,fd);
 183     }
 184     return fd;
 185 }
 186
 187 static sds cliReadLine(int fd) {
 188     sds line = sdsempty();
 189
 190     while(1) {
 191         char c;
 192         ssize_t ret;
 193
 194         ret = read(fd,&c,1);
 195         if (ret == -1) {
 196             sdsfree(line);
 197             return NULL;
 198         } else if ((ret == 0) || (c == '\n')) {
 199             break;
 200         } else {
 201             line = sdscatlen(line,&c,1);
 202         }
 203     }
 204     return sdstrim(line,"\r\n");
 205 }
 206
 207 static int cliReadSingleLineReply(int fd, int quiet) {
 208     sds reply = cliReadLine(fd);
 209
 210     if (reply == NULL) return 1;
 211     if (!quiet)
 212         printf("%s\n", reply);
 213     sdsfree(reply);
 214     return 0;
 215 }
 216
 217 static int cliReadBulkReply(int fd) {
 218     sds replylen = cliReadLine(fd);
 219     char *reply, crlf[2];
 220     int bulklen;
 221
 222     if (replylen == NULL) return 1;
 223     bulklen = atoi(replylen);
 224     if (bulklen == -1) {
 225         sdsfree(replylen);
 226         printf("(nil)\n");
 227         return 0;
 228     }
 229     reply = zmalloc(bulklen);
 230     anetRead(fd,reply,bulklen);
 231     anetRead(fd,crlf,2);
 232     if (bulklen && fwrite(reply,bulklen,1,stdout) == 0) {
 233         zfree(reply);
 234         return 1;
 235     }
 236     if (isatty(fileno(stdout)) && reply[bulklen-1] != '\n')
 237         printf("\n");
 238     zfree(reply);
 239     return 0;
 240 }
 241
 242 static int cliReadMultiBulkReply(int fd) {
 243     sds replylen = cliReadLine(fd);
 244     int elements, c = 1;
 245
 246     if (replylen == NULL) return 1;
 247     elements = atoi(replylen);
 248     if (elements == -1) {
 249         sdsfree(replylen);
 250         printf("(nil)\n");
 251         return 0;
 252     }
 253     if (elements == 0) {
 254         printf("(empty list or set)\n");
 255     }
 256     while(elements--) {
 257         printf("%d. ", c);
 258         if (cliReadReply(fd)) return 1;
 259         c++;
 260     }
 261     return 0;
 262 }
 263
 264 static int cliReadReply(int fd) {
 265     char type;
 266
 267     if (anetRead(fd,&type,1) <= 0) exit(1);
 268     switch(type) {
 269     case '-':
 270         printf("(error) ");
 271         cliReadSingleLineReply(fd,0);
 272         return 1;
 273     case '+':
 274         return cliReadSingleLineReply(fd,0);
 275     case ':':
 276         printf("(integer) ");
 277         return cliReadSingleLineReply(fd,0);
 278     case '$':
 279         return cliReadBulkReply(fd);
 280     case '*':
 281         return cliReadMultiBulkReply(fd);
 282     default:
 283         printf("protocol error, got '%c' as reply type byte\n", type);
 284         return 1;
 285     }
 286 }
 287
 288 static int selectDb(int fd) {
 289     int retval;
 290     sds cmd;
 291     char type;
 292
 293     if (config.dbnum == 0)
 294         return 0;
 295
 296     cmd = sdsempty();
 297     cmd = sdscatprintf(cmd,"SELECT %d\r\n",config.dbnum);
 298     anetWrite(fd,cmd,sdslen(cmd));
 299     anetRead(fd,&type,1);
 300     if (type <= 0 || type != '+') return 1;
 301     retval = cliReadSingleLineReply(fd,1);
 302     if (retval) {
 303         return retval;
 304     }
 305     return 0;
 306 }
 307
 308 static int cliSendCommand(int argc, char **argv) {
 309     struct redisCommand *rc = lookupCommand(argv[0]);
 310     int fd, j, retval = 0;
 311     int read_forever = 0;
 312     sds cmd;
 313
 314     if (!rc) {
 315         fprintf(stderr,"Unknown command '%s'\n",argv[0]);
 316         return 1;
 317     }
 318
 319     if ((rc->arity > 0 && argc != rc->arity) ||
 320         (rc->arity < 0 && argc < -rc->arity)) {
 321             fprintf(stderr,"Wrong number of arguments for '%s'\n",rc->name);
 322             return 1;
 323     }
 324     if (!strcasecmp(rc->name,"monitor")) read_forever = 1;
 325     if ((fd = cliConnect()) == -1) return 1;
 326
 327     /* Select db number */
 328     retval = selectDb(fd);
 329     if (retval) {
 330         fprintf(stderr,"Error setting DB num\n");
 331         return 1;
 332     }
 333
 334     while(config.repeat--) {
 335         /* Build the command to send */
 336         cmd = sdsempty();
 337         if (rc->flags & REDIS_CMD_MULTIBULK) {
 338             cmd = sdscatprintf(cmd,"*%d\r\n",argc);
 339             for (j = 0; j < argc; j++) {
 340                 cmd = sdscatprintf(cmd,"$%lu\r\n",
 341                     (unsigned long)sdslen(argv[j]));
 342                 cmd = sdscatlen(cmd,argv[j],sdslen(argv[j]));
 343                 cmd = sdscatlen(cmd,"\r\n",2);
 344             }
 345         } else {
 346             for (j = 0; j < argc; j++) {
 347                 if (j != 0) cmd = sdscat(cmd," ");
 348                 if (j == argc-1 && rc->flags & REDIS_CMD_BULK) {
 349                     cmd = sdscatprintf(cmd,"%lu",
 350                         (unsigned long)sdslen(argv[j]));
 351                 } else {
 352                     cmd = sdscatlen(cmd,argv[j],sdslen(argv[j]));
 353                 }
 354             }
 355             cmd = sdscat(cmd,"\r\n");
 356             if (rc->flags & REDIS_CMD_BULK) {
 357                 cmd = sdscatlen(cmd,argv[argc-1],sdslen(argv[argc-1]));
 358                 cmd = sdscatlen(cmd,"\r\n",2);
 359             }
 360         }
 361         anetWrite(fd,cmd,sdslen(cmd));
 362         sdsfree(cmd);
 363
 364         while (read_forever) {
 365             cliReadSingleLineReply(fd,0);
 366         }
 367
 368         retval = cliReadReply(fd);
 369         if (retval) {
 370             return retval;
 371         }
 372     }
 373     return 0;
 374 }
 375
 376 static int parseOptions(int argc, char **argv) {
 377     int i;
 378
 379     for (i = 1; i < argc; i++) {
 380         int lastarg = i==argc-1;
 381
 382         if (!strcmp(argv[i],"-h") && !lastarg) {
 383             char *ip = zmalloc(32);
 384             if (anetResolve(NULL,argv[i+1],ip) == ANET_ERR) {
 385                 printf("Can't resolve %s\n", argv[i]);
 386                 exit(1);
 387             }
 388             config.hostip = ip;
 389             i++;
 390         } else if (!strcmp(argv[i],"-h") && lastarg) {
 391             usage();
 392         } else if (!strcmp(argv[i],"-p") && !lastarg) {
 393             config.hostport = atoi(argv[i+1]);
 394             i++;
 395         } else if (!strcmp(argv[i],"-r") && !lastarg) {
 396             config.repeat = strtoll(argv[i+1],NULL,10);
 397             i++;
 398         } else if (!strcmp(argv[i],"-n") && !lastarg) {
 399             config.dbnum = atoi(argv[i+1]);
 400             i++;
 401         } else if (!strcmp(argv[i],"-i")) {
 402             config.interactive = 1;
 403         } else {
 404             break;
 405         }
 406     }
 407     return i;
 408 }
 409
 410 static sds readArgFromStdin(void) {
 411     char buf[1024];
 412     sds arg = sdsempty();
 413
 414     while(1) {
 415         int nread = read(fileno(stdin),buf,1024);
 416
 417         if (nread == 0) break;
 418         else if (nread == -1) {
 419             perror("Reading from standard input");
 420             exit(1);
 421         }
 422         arg = sdscatlen(arg,buf,nread);
 423     }
 424     return arg;
 425 }
 426
 427 static void usage() {
 428     fprintf(stderr, "usage: redis-cli [-h host] [-p port] [-r repeat_times] [-n db_num] [-i] cmd arg1 arg2 arg3 ... argN\n");
 429     fprintf(stderr, "usage: echo \"argN\" | redis-cli [-h host] [-p port] [-r repeat_times] [-n db_num] cmd arg1 arg2 ... arg(N-1)\n");
 430     fprintf(stderr, "\nIf a pipe from standard input is detected this data is used as last argument.\n\n");
 431     fprintf(stderr, "example: cat /etc/passwd | redis-cli set my_passwd\n");
 432     fprintf(stderr, "example: redis-cli get my_passwd\n");
 433     fprintf(stderr, "example: redis-cli -r 100 lpush mylist x\n");
 434     fprintf(stderr, "\nRun in interactive mode: redis-cli -i or just don't pass any command\n");
 435     exit(1);
 436 }
 437
 438 /* Turn the plain C strings into Sds strings */
 439 static char **convertToSds(int count, char** args) {
 440   int j;
 441   char **sds = zmalloc(sizeof(char*)*count+1);
 442
 443   for(j = 0; j < count; j++)
 444     sds[j] = sdsnew(args[j]);
 445
 446   return sds;
 447 }
 448
 449 static char *prompt(char *line, int size) {
 450     char *retval;
 451
 452     do {
 453         printf(">> ");
 454         retval = fgets(line, size, stdin);
 455     } while (retval && *line == '\n');
 456     line[strlen(line) - 1] = '\0';
 457
 458     return retval;
 459 }
 460
 461 static void repl() {
 462     int size = 4096, max = size >> 1, argc;
 463     char buffer[size];
 464     char *line = buffer;
 465     char **ap, *args[max];
 466
 467     while (prompt(line, size)) {
 468         argc = 0;
 469
 470         for (ap = args; (*ap = strsep(&line, " \t")) != NULL;) {
 471             if (**ap != '\0') {
 472                 if (argc >= max) break;
 473                 if (strcasecmp(*ap,"quit") == 0 || strcasecmp(*ap,"exit") == 0)
 474                     exit(0);
 475                 ap++;
 476                 argc++;
 477             }
 478         }
 479
 480         config.repeat = 1;
 481         cliSendCommand(argc, convertToSds(argc, args));
 482         line = buffer;
 483     }
 484
 485     exit(0);
 486 }
 487
 488 int main(int argc, char **argv) {
 489     int firstarg;
 490     char **argvcopy;
 491     struct redisCommand *rc;
 492
 493     config.hostip = "127.0.0.1";
 494     config.hostport = 6379;
 495     config.repeat = 1;
 496     config.dbnum = 0;
 497     config.interactive = 0;
 498
 499     firstarg = parseOptions(argc,argv);
 500     argc -= firstarg;
 501     argv += firstarg;
 502
 503     if (argc == 0 || config.interactive == 1) repl();
 504
 505     argvcopy = convertToSds(argc, argv);
 506
 507     /* Read the last argument from stdandard input if needed */
 508     if ((rc = lookupCommand(argv[0])) != NULL) {
 509       if (rc->arity > 0 && argc == rc->arity-1) {
 510         sds lastarg = readArgFromStdin();
 511         argvcopy[argc] = lastarg;
 512         argc++;
 513       }
 514     }
 515
 516     return cliSendCommand(argc, argvcopy);
 517 }