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