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