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