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