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