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