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