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     {"zrangebyscore",-4,REDIS_CMD_INLINE},
 109     {"zcount",4,REDIS_CMD_INLINE},
 110     {"zrevrange",-4,REDIS_CMD_INLINE},
 111     {"zcard",2,REDIS_CMD_INLINE},
 112     {"zscore",3,REDIS_CMD_BULK},
 113     {"incrby",3,REDIS_CMD_INLINE},
 114     {"decrby",3,REDIS_CMD_INLINE},
 115     {"getset",3,REDIS_CMD_BULK},
 116     {"randomkey",1,REDIS_CMD_INLINE},
 117     {"select",2,REDIS_CMD_INLINE},
 118     {"move",3,REDIS_CMD_INLINE},
 119     {"rename",3,REDIS_CMD_INLINE},
 120     {"renamenx",3,REDIS_CMD_INLINE},
 121     {"keys",2,REDIS_CMD_INLINE},
 122     {"dbsize",1,REDIS_CMD_INLINE},
 123     {"ping",1,REDIS_CMD_INLINE},
 124     {"echo",2,REDIS_CMD_BULK},
 125     {"save",1,REDIS_CMD_INLINE},
 126     {"bgsave",1,REDIS_CMD_INLINE},
 127     {"rewriteaof",1,REDIS_CMD_INLINE},
 128     {"bgrewriteaof",1,REDIS_CMD_INLINE},
 129     {"shutdown",1,REDIS_CMD_INLINE},
 130     {"lastsave",1,REDIS_CMD_INLINE},
 131     {"type",2,REDIS_CMD_INLINE},
 132     {"flushdb",1,REDIS_CMD_INLINE},
 133     {"flushall",1,REDIS_CMD_INLINE},
 134     {"sort",-2,REDIS_CMD_INLINE},
 135     {"info",1,REDIS_CMD_INLINE},
 136     {"mget",-2,REDIS_CMD_INLINE},
 137     {"expire",3,REDIS_CMD_INLINE},
 138     {"expireat",3,REDIS_CMD_INLINE},
 139     {"ttl",2,REDIS_CMD_INLINE},
 140     {"slaveof",3,REDIS_CMD_INLINE},
 141     {"debug",-2,REDIS_CMD_INLINE},
 142     {"mset",-3,REDIS_CMD_MULTIBULK},
 143     {"msetnx",-3,REDIS_CMD_MULTIBULK},
 144     {"monitor",1,REDIS_CMD_INLINE},
 145     {"multi",1,REDIS_CMD_INLINE},
 146     {"exec",1,REDIS_CMD_INLINE},
 147     {"discard",1,REDIS_CMD_INLINE},
 148     {"hset",4,REDIS_CMD_MULTIBULK},
 149     {"hget",3,REDIS_CMD_BULK},
 150     {NULL,0,0}
 151 };
 152
 153 static int cliReadReply(int fd);
 154 static void usage();
 155
 156 static struct redisCommand *lookupCommand(char *name) {
 157     int j = 0;
 158     while(cmdTable[j].name != NULL) {
 159         if (!strcasecmp(name,cmdTable[j].name)) return &cmdTable[j];
 160         j++;
 161     }
 162     return NULL;
 163 }
 164
 165 static int cliConnect(void) {
 166     char err[ANET_ERR_LEN];
 167     static int fd = ANET_ERR;
 168
 169     if (fd == ANET_ERR) {
 170         fd = anetTcpConnect(err,config.hostip,config.hostport);
 171         if (fd == ANET_ERR) {
 172             fprintf(stderr, "Could not connect to Redis at %s:%d: %s", config.hostip, config.hostport, err);
 173             return -1;
 174         }
 175         anetTcpNoDelay(NULL,fd);
 176     }
 177     return fd;
 178 }
 179
 180 static sds cliReadLine(int fd) {
 181     sds line = sdsempty();
 182
 183     while(1) {
 184         char c;
 185         ssize_t ret;
 186
 187         ret = read(fd,&c,1);
 188         if (ret == -1) {
 189             sdsfree(line);
 190             return NULL;
 191         } else if ((ret == 0) || (c == '\n')) {
 192             break;
 193         } else {
 194             line = sdscatlen(line,&c,1);
 195         }
 196     }
 197     return sdstrim(line,"\r\n");
 198 }
 199
 200 static int cliReadSingleLineReply(int fd, int quiet) {
 201     sds reply = cliReadLine(fd);
 202
 203     if (reply == NULL) return 1;
 204     if (!quiet)
 205         printf("%s\n", reply);
 206     sdsfree(reply);
 207     return 0;
 208 }
 209
 210 static int cliReadBulkReply(int fd) {
 211     sds replylen = cliReadLine(fd);
 212     char *reply, crlf[2];
 213     int bulklen;
 214
 215     if (replylen == NULL) return 1;
 216     bulklen = atoi(replylen);
 217     if (bulklen == -1) {
 218         sdsfree(replylen);
 219         printf("(nil)\n");
 220         return 0;
 221     }
 222     reply = zmalloc(bulklen);
 223     anetRead(fd,reply,bulklen);
 224     anetRead(fd,crlf,2);
 225     if (bulklen && fwrite(reply,bulklen,1,stdout) == 0) {
 226         zfree(reply);
 227         return 1;
 228     }
 229     if (isatty(fileno(stdout)) && reply[bulklen-1] != '\n')
 230         printf("\n");
 231     zfree(reply);
 232     return 0;
 233 }
 234
 235 static int cliReadMultiBulkReply(int fd) {
 236     sds replylen = cliReadLine(fd);
 237     int elements, c = 1;
 238
 239     if (replylen == NULL) return 1;
 240     elements = atoi(replylen);
 241     if (elements == -1) {
 242         sdsfree(replylen);
 243         printf("(nil)\n");
 244         return 0;
 245     }
 246     if (elements == 0) {
 247         printf("(empty list or set)\n");
 248     }
 249     while(elements--) {
 250         printf("%d. ", c);
 251         if (cliReadReply(fd)) return 1;
 252         c++;
 253     }
 254     return 0;
 255 }
 256
 257 static int cliReadReply(int fd) {
 258     char type;
 259
 260     if (anetRead(fd,&type,1) <= 0) exit(1);
 261     switch(type) {
 262     case '-':
 263         printf("(error) ");
 264         cliReadSingleLineReply(fd,0);
 265         return 1;
 266     case '+':
 267         return cliReadSingleLineReply(fd,0);
 268     case ':':
 269         printf("(integer) ");
 270         return cliReadSingleLineReply(fd,0);
 271     case '$':
 272         return cliReadBulkReply(fd);
 273     case '*':
 274         return cliReadMultiBulkReply(fd);
 275     default:
 276         printf("protocol error, got '%c' as reply type byte\n", type);
 277         return 1;
 278     }
 279 }
 280
 281 static int selectDb(int fd) {
 282     int retval;
 283     sds cmd;
 284     char type;
 285
 286     if (config.dbnum == 0)
 287         return 0;
 288
 289     cmd = sdsempty();
 290     cmd = sdscatprintf(cmd,"SELECT %d\r\n",config.dbnum);
 291     anetWrite(fd,cmd,sdslen(cmd));
 292     anetRead(fd,&type,1);
 293     if (type <= 0 || type != '+') return 1;
 294     retval = cliReadSingleLineReply(fd,1);
 295     if (retval) {
 296         return retval;
 297     }
 298     return 0;
 299 }
 300
 301 static int cliSendCommand(int argc, char **argv) {
 302     struct redisCommand *rc = lookupCommand(argv[0]);
 303     int fd, j, retval = 0;
 304     int read_forever = 0;
 305     sds cmd;
 306
 307     if (!rc) {
 308         fprintf(stderr,"Unknown command '%s'\n",argv[0]);
 309         return 1;
 310     }
 311
 312     if ((rc->arity > 0 && argc != rc->arity) ||
 313         (rc->arity < 0 && argc < -rc->arity)) {
 314             fprintf(stderr,"Wrong number of arguments for '%s'\n",rc->name);
 315             return 1;
 316     }
 317     if (!strcasecmp(rc->name,"monitor")) read_forever = 1;
 318     if ((fd = cliConnect()) == -1) return 1;
 319
 320     /* Select db number */
 321     retval = selectDb(fd);
 322     if (retval) {
 323         fprintf(stderr,"Error setting DB num\n");
 324         return 1;
 325     }
 326
 327     while(config.repeat--) {
 328         /* Build the command to send */
 329         cmd = sdsempty();
 330         if (rc->flags & REDIS_CMD_MULTIBULK) {
 331             cmd = sdscatprintf(cmd,"*%d\r\n",argc);
 332             for (j = 0; j < argc; j++) {
 333                 cmd = sdscatprintf(cmd,"$%lu\r\n",
 334                     (unsigned long)sdslen(argv[j]));
 335                 cmd = sdscatlen(cmd,argv[j],sdslen(argv[j]));
 336                 cmd = sdscatlen(cmd,"\r\n",2);
 337             }
 338         } else {
 339             for (j = 0; j < argc; j++) {
 340                 if (j != 0) cmd = sdscat(cmd," ");
 341                 if (j == argc-1 && rc->flags & REDIS_CMD_BULK) {
 342                     cmd = sdscatprintf(cmd,"%lu",
 343                         (unsigned long)sdslen(argv[j]));
 344                 } else {
 345                     cmd = sdscatlen(cmd,argv[j],sdslen(argv[j]));
 346                 }
 347             }
 348             cmd = sdscat(cmd,"\r\n");
 349             if (rc->flags & REDIS_CMD_BULK) {
 350                 cmd = sdscatlen(cmd,argv[argc-1],sdslen(argv[argc-1]));
 351                 cmd = sdscatlen(cmd,"\r\n",2);
 352             }
 353         }
 354         anetWrite(fd,cmd,sdslen(cmd));
 355         sdsfree(cmd);
 356
 357         while (read_forever) {
 358             cliReadSingleLineReply(fd,0);
 359         }
 360
 361         retval = cliReadReply(fd);
 362         if (retval) {
 363             return retval;
 364         }
 365     }
 366     return 0;
 367 }
 368
 369 static int parseOptions(int argc, char **argv) {
 370     int i;
 371
 372     for (i = 1; i < argc; i++) {
 373         int lastarg = i==argc-1;
 374
 375         if (!strcmp(argv[i],"-h") && !lastarg) {
 376             char *ip = zmalloc(32);
 377             if (anetResolve(NULL,argv[i+1],ip) == ANET_ERR) {
 378                 printf("Can't resolve %s\n", argv[i]);
 379                 exit(1);
 380             }
 381             config.hostip = ip;
 382             i++;
 383         } else if (!strcmp(argv[i],"-h") && lastarg) {
 384             usage();
 385         } else if (!strcmp(argv[i],"-p") && !lastarg) {
 386             config.hostport = atoi(argv[i+1]);
 387             i++;
 388         } else if (!strcmp(argv[i],"-r") && !lastarg) {
 389             config.repeat = strtoll(argv[i+1],NULL,10);
 390             i++;
 391         } else if (!strcmp(argv[i],"-n") && !lastarg) {
 392             config.dbnum = atoi(argv[i+1]);
 393             i++;
 394         } else if (!strcmp(argv[i],"-i")) {
 395             config.interactive = 1;
 396         } else {
 397             break;
 398         }
 399     }
 400     return i;
 401 }
 402
 403 static sds readArgFromStdin(void) {
 404     char buf[1024];
 405     sds arg = sdsempty();
 406
 407     while(1) {
 408         int nread = read(fileno(stdin),buf,1024);
 409
 410         if (nread == 0) break;
 411         else if (nread == -1) {
 412             perror("Reading from standard input");
 413             exit(1);
 414         }
 415         arg = sdscatlen(arg,buf,nread);
 416     }
 417     return arg;
 418 }
 419
 420 static void usage() {
 421     fprintf(stderr, "usage: redis-cli [-h host] [-p port] [-r repeat_times] [-n db_num] [-i] cmd arg1 arg2 arg3 ... argN\n");
 422     fprintf(stderr, "usage: echo \"argN\" | redis-cli [-h host] [-p port] [-r repeat_times] [-n db_num] cmd arg1 arg2 ... arg(N-1)\n");
 423     fprintf(stderr, "\nIf a pipe from standard input is detected this data is used as last argument.\n\n");
 424     fprintf(stderr, "example: cat /etc/passwd | redis-cli set my_passwd\n");
 425     fprintf(stderr, "example: redis-cli get my_passwd\n");
 426     fprintf(stderr, "example: redis-cli -r 100 lpush mylist x\n");
 427     fprintf(stderr, "\nRun in interactive mode: redis-cli -i or just don't pass any command\n");
 428     exit(1);
 429 }
 430
 431 /* Turn the plain C strings into Sds strings */
 432 static char **convertToSds(int count, char** args) {
 433   int j;
 434   char **sds = zmalloc(sizeof(char*)*count+1);
 435
 436   for(j = 0; j < count; j++)
 437     sds[j] = sdsnew(args[j]);
 438
 439   return sds;
 440 }
 441
 442 static char *prompt(char *line, int size) {
 443     char *retval;
 444
 445     do {
 446         printf(">> ");
 447         retval = fgets(line, size, stdin);
 448     } while (retval && *line == '\n');
 449     line[strlen(line) - 1] = '\0';
 450
 451     return retval;
 452 }
 453
 454 static void repl() {
 455     int size = 4096, max = size >> 1, argc;
 456     char buffer[size];
 457     char *line = buffer;
 458     char **ap, *args[max];
 459
 460     while (prompt(line, size)) {
 461         argc = 0;
 462
 463         for (ap = args; (*ap = strsep(&line, " \t")) != NULL;) {
 464             if (**ap != '\0') {
 465                 if (argc >= max) break;
 466                 if (strcasecmp(*ap,"quit") == 0 || strcasecmp(*ap,"exit") == 0)
 467                     exit(0);
 468                 ap++;
 469                 argc++;
 470             }
 471         }
 472
 473         config.repeat = 1;
 474         cliSendCommand(argc, convertToSds(argc, args));
 475         line = buffer;
 476     }
 477
 478     exit(0);
 479 }
 480
 481 int main(int argc, char **argv) {
 482     int firstarg;
 483     char **argvcopy;
 484     struct redisCommand *rc;
 485
 486     config.hostip = "127.0.0.1";
 487     config.hostport = 6379;
 488     config.repeat = 1;
 489     config.dbnum = 0;
 490     config.interactive = 0;
 491
 492     firstarg = parseOptions(argc,argv);
 493     argc -= firstarg;
 494     argv += firstarg;
 495
 496     if (argc == 0 || config.interactive == 1) repl();
 497
 498     argvcopy = convertToSds(argc, argv);
 499
 500     /* Read the last argument from stdandard input if needed */
 501     if ((rc = lookupCommand(argv[0])) != NULL) {
 502       if (rc->arity > 0 && argc == rc->arity-1) {
 503         sds lastarg = readArgFromStdin();
 504         argvcopy[argc] = lastarg;
 505         argc++;
 506       }
 507     }
 508
 509     return cliSendCommand(argc, argvcopy);
 510 }