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