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