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