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