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