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