redis-cli.c

   1 /* Redis CLI (command line interface)
   2  *
   3  * Copyright (c) 2006-2009, 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 } config;
  55
  56 struct redisCommand {
  57     char *name;
  58     int arity;
  59     int flags;
  60 };
  61
  62 static struct redisCommand cmdTable[] = {
  63     {"get",2,REDIS_CMD_INLINE},
  64     {"set",3,REDIS_CMD_BULK},
  65     {"setnx",3,REDIS_CMD_BULK},
  66     {"del",-2,REDIS_CMD_INLINE},
  67     {"exists",2,REDIS_CMD_INLINE},
  68     {"incr",2,REDIS_CMD_INLINE},
  69     {"decr",2,REDIS_CMD_INLINE},
  70     {"rpush",3,REDIS_CMD_BULK},
  71     {"lpush",3,REDIS_CMD_BULK},
  72     {"rpop",2,REDIS_CMD_INLINE},
  73     {"lpop",2,REDIS_CMD_INLINE},
  74     {"brpop",-3,REDIS_CMD_INLINE},
  75     {"blpop",-3,REDIS_CMD_INLINE},
  76     {"llen",2,REDIS_CMD_INLINE},
  77     {"lindex",3,REDIS_CMD_INLINE},
  78     {"lset",4,REDIS_CMD_BULK},
  79     {"lrange",4,REDIS_CMD_INLINE},
  80     {"ltrim",4,REDIS_CMD_INLINE},
  81     {"lrem",4,REDIS_CMD_BULK},
  82     {"rpoplpush",3,REDIS_CMD_BULK},
  83     {"sadd",3,REDIS_CMD_BULK},
  84     {"srem",3,REDIS_CMD_BULK},
  85     {"smove",4,REDIS_CMD_BULK},
  86     {"sismember",3,REDIS_CMD_BULK},
  87     {"scard",2,REDIS_CMD_INLINE},
  88     {"spop",2,REDIS_CMD_INLINE},
  89     {"srandmember",2,REDIS_CMD_INLINE},
  90     {"sinter",-2,REDIS_CMD_INLINE},
  91     {"sinterstore",-3,REDIS_CMD_INLINE},
  92     {"sunion",-2,REDIS_CMD_INLINE},
  93     {"sunionstore",-3,REDIS_CMD_INLINE},
  94     {"sdiff",-2,REDIS_CMD_INLINE},
  95     {"sdiffstore",-3,REDIS_CMD_INLINE},
  96     {"smembers",2,REDIS_CMD_INLINE},
  97     {"zadd",4,REDIS_CMD_BULK},
  98     {"zincrby",4,REDIS_CMD_BULK},
  99     {"zrem",3,REDIS_CMD_BULK},
 100     {"zremrangebyscore",4,REDIS_CMD_INLINE},
 101     {"zrange",-4,REDIS_CMD_INLINE},
 102     {"zrangebyscore",-4,REDIS_CMD_INLINE},
 103     {"zrevrange",-4,REDIS_CMD_INLINE},
 104     {"zcard",2,REDIS_CMD_INLINE},
 105     {"zscore",3,REDIS_CMD_BULK},
 106     {"incrby",3,REDIS_CMD_INLINE},
 107     {"decrby",3,REDIS_CMD_INLINE},
 108     {"getset",3,REDIS_CMD_BULK},
 109     {"randomkey",1,REDIS_CMD_INLINE},
 110     {"select",2,REDIS_CMD_INLINE},
 111     {"move",3,REDIS_CMD_INLINE},
 112     {"rename",3,REDIS_CMD_INLINE},
 113     {"renamenx",3,REDIS_CMD_INLINE},
 114     {"keys",2,REDIS_CMD_INLINE},
 115     {"dbsize",1,REDIS_CMD_INLINE},
 116     {"ping",1,REDIS_CMD_INLINE},
 117     {"echo",2,REDIS_CMD_BULK},
 118     {"save",1,REDIS_CMD_INLINE},
 119     {"bgsave",1,REDIS_CMD_INLINE},
 120     {"rewriteaof",1,REDIS_CMD_INLINE},
 121     {"bgrewriteaof",1,REDIS_CMD_INLINE},
 122     {"shutdown",1,REDIS_CMD_INLINE},
 123     {"lastsave",1,REDIS_CMD_INLINE},
 124     {"type",2,REDIS_CMD_INLINE},
 125     {"flushdb",1,REDIS_CMD_INLINE},
 126     {"flushall",1,REDIS_CMD_INLINE},
 127     {"sort",-2,REDIS_CMD_INLINE},
 128     {"info",1,REDIS_CMD_INLINE},
 129     {"mget",-2,REDIS_CMD_INLINE},
 130     {"expire",3,REDIS_CMD_INLINE},
 131     {"expireat",3,REDIS_CMD_INLINE},
 132     {"ttl",2,REDIS_CMD_INLINE},
 133     {"slaveof",3,REDIS_CMD_INLINE},
 134     {"debug",-2,REDIS_CMD_INLINE},
 135     {"mset",-3,REDIS_CMD_MULTIBULK},
 136     {"msetnx",-3,REDIS_CMD_MULTIBULK},
 137     {NULL,0,0}
 138 };
 139
 140 static int cliReadReply(int fd);
 141 static void usage();
 142
 143 static struct redisCommand *lookupCommand(char *name) {
 144     int j = 0;
 145     while(cmdTable[j].name != NULL) {
 146         if (!strcasecmp(name,cmdTable[j].name)) return &cmdTable[j];
 147         j++;
 148     }
 149     return NULL;
 150 }
 151
 152 static int cliConnect(void) {
 153     char err[ANET_ERR_LEN];
 154     int fd;
 155
 156     fd = anetTcpConnect(err,config.hostip,config.hostport);
 157     if (fd == ANET_ERR) {
 158         fprintf(stderr,"Connect: %s\n",err);
 159         return -1;
 160     }
 161     anetTcpNoDelay(NULL,fd);
 162     return fd;
 163 }
 164
 165 static sds cliReadLine(int fd) {
 166     sds line = sdsempty();
 167
 168     while(1) {
 169         char c;
 170         ssize_t ret;
 171
 172         ret = read(fd,&c,1);
 173         if (ret == -1) {
 174             sdsfree(line);
 175             return NULL;
 176         } else if ((ret == 0) || (c == '\n')) {
 177             break;
 178         } else {
 179             line = sdscatlen(line,&c,1);
 180         }
 181     }
 182     return sdstrim(line,"\r\n");
 183 }
 184
 185 static int cliReadSingleLineReply(int fd, int quiet) {
 186     sds reply = cliReadLine(fd);
 187
 188     if (reply == NULL) return 1;
 189     if (!quiet)
 190         printf("%s\n", reply);
 191     return 0;
 192 }
 193
 194 static int cliReadBulkReply(int fd) {
 195     sds replylen = cliReadLine(fd);
 196     char *reply, crlf[2];
 197     int bulklen;
 198
 199     if (replylen == NULL) return 1;
 200     bulklen = atoi(replylen);
 201     if (bulklen == -1) {
 202         sdsfree(replylen);
 203         printf("(nil)\n");
 204         return 0;
 205     }
 206     reply = zmalloc(bulklen);
 207     anetRead(fd,reply,bulklen);
 208     anetRead(fd,crlf,2);
 209     if (bulklen && fwrite(reply,bulklen,1,stdout) == 0) {
 210         zfree(reply);
 211         return 1;
 212     }
 213     if (isatty(fileno(stdout)) && reply[bulklen-1] != '\n')
 214         printf("\n");
 215     zfree(reply);
 216     return 0;
 217 }
 218
 219 static int cliReadMultiBulkReply(int fd) {
 220     sds replylen = cliReadLine(fd);
 221     int elements, c = 1;
 222
 223     if (replylen == NULL) return 1;
 224     elements = atoi(replylen);
 225     if (elements == -1) {
 226         sdsfree(replylen);
 227         printf("(nil)\n");
 228         return 0;
 229     }
 230     if (elements == 0) {
 231         printf("(empty list or set)\n");
 232     }
 233     while(elements--) {
 234         printf("%d. ", c);
 235         if (cliReadReply(fd)) return 1;
 236         c++;
 237     }
 238     return 0;
 239 }
 240
 241 static int cliReadReply(int fd) {
 242     char type;
 243
 244     if (anetRead(fd,&type,1) <= 0) exit(1);
 245     switch(type) {
 246     case '-':
 247         printf("(error) ");
 248         cliReadSingleLineReply(fd,0);
 249         return 1;
 250     case '+':
 251         return cliReadSingleLineReply(fd,0);
 252     case ':':
 253         printf("(integer) ");
 254         return cliReadSingleLineReply(fd,0);
 255     case '$':
 256         return cliReadBulkReply(fd);
 257     case '*':
 258         return cliReadMultiBulkReply(fd);
 259     default:
 260         printf("protocol error, got '%c' as reply type byte\n", type);
 261         return 1;
 262     }
 263 }
 264
 265 static int selectDb(int fd)
 266 {
 267     int retval;
 268     sds cmd;
 269     char type;
 270
 271     if (config.dbnum == 0)
 272         return 0;
 273
 274     cmd = sdsempty();
 275     cmd = sdscatprintf(cmd,"SELECT %d\r\n",config.dbnum);
 276     anetWrite(fd,cmd,sdslen(cmd));
 277     anetRead(fd,&type,1);
 278     if (type <= 0 || type != '+') return 1;
 279     retval = cliReadSingleLineReply(fd,1);
 280     if (retval) {
 281         close(fd);
 282         return retval;
 283     }
 284     return 0;
 285 }
 286
 287 static int cliSendCommand(int argc, char **argv) {
 288     struct redisCommand *rc = lookupCommand(argv[0]);
 289     int fd, j, retval = 0;
 290     sds cmd;
 291
 292     if (!rc) {
 293         fprintf(stderr,"Unknown command '%s'\n",argv[0]);
 294         return 1;
 295     }
 296
 297     if ((rc->arity > 0 && argc != rc->arity) ||
 298         (rc->arity < 0 && argc < -rc->arity)) {
 299             fprintf(stderr,"Wrong number of arguments for '%s'\n",rc->name);
 300             return 1;
 301     }
 302     if ((fd = cliConnect()) == -1) return 1;
 303
 304     /* Select db number */
 305     retval = selectDb(fd);
 306     if (retval) {
 307         fprintf(stderr,"Error setting DB num\n");
 308         return 1;
 309     }
 310
 311     while(config.repeat--) {
 312         /* Build the command to send */
 313         cmd = sdsempty();
 314         if (rc->flags & REDIS_CMD_MULTIBULK) {
 315             cmd = sdscatprintf(cmd,"*%d\r\n",argc);
 316             for (j = 0; j < argc; j++) {
 317                 cmd = sdscatprintf(cmd,"$%lu\r\n",
 318                     (unsigned long)sdslen(argv[j]));
 319                 cmd = sdscatlen(cmd,argv[j],sdslen(argv[j]));
 320                 cmd = sdscatlen(cmd,"\r\n",2);
 321             }
 322         } else {
 323             for (j = 0; j < argc; j++) {
 324                 if (j != 0) cmd = sdscat(cmd," ");
 325                 if (j == argc-1 && rc->flags & REDIS_CMD_BULK) {
 326                     cmd = sdscatprintf(cmd,"%lu",
 327                         (unsigned long)sdslen(argv[j]));
 328                 } else {
 329                     cmd = sdscatlen(cmd,argv[j],sdslen(argv[j]));
 330                 }
 331             }
 332             cmd = sdscat(cmd,"\r\n");
 333             if (rc->flags & REDIS_CMD_BULK) {
 334                 cmd = sdscatlen(cmd,argv[argc-1],sdslen(argv[argc-1]));
 335                 cmd = sdscatlen(cmd,"\r\n",2);
 336             }
 337         }
 338         anetWrite(fd,cmd,sdslen(cmd));
 339         sdsfree(cmd);
 340         retval = cliReadReply(fd);
 341         if (retval) {
 342             close(fd);
 343             return retval;
 344         }
 345     }
 346     close(fd);
 347     return 0;
 348 }
 349
 350 static int parseOptions(int argc, char **argv) {
 351     int i;
 352
 353     for (i = 1; i < argc; i++) {
 354         int lastarg = i==argc-1;
 355
 356         if (!strcmp(argv[i],"-h") && !lastarg) {
 357             char *ip = zmalloc(32);
 358             if (anetResolve(NULL,argv[i+1],ip) == ANET_ERR) {
 359                 printf("Can't resolve %s\n", argv[i]);
 360                 exit(1);
 361             }
 362             config.hostip = ip;
 363             i++;
 364         } else if (!strcmp(argv[i],"-h") && lastarg) {
 365             usage();
 366         } else if (!strcmp(argv[i],"-p") && !lastarg) {
 367             config.hostport = atoi(argv[i+1]);
 368             i++;
 369         } else if (!strcmp(argv[i],"-r") && !lastarg) {
 370             config.repeat = strtoll(argv[i+1],NULL,10);
 371             i++;
 372         } else if (!strcmp(argv[i],"-n") && !lastarg) {
 373             config.dbnum = atoi(argv[i+1]);
 374             i++;
 375         } else {
 376             break;
 377         }
 378     }
 379     return i;
 380 }
 381
 382 static sds readArgFromStdin(void) {
 383     char buf[1024];
 384     sds arg = sdsempty();
 385
 386     while(1) {
 387         int nread = read(fileno(stdin),buf,1024);
 388
 389         if (nread == 0) break;
 390         else if (nread == -1) {
 391             perror("Reading from standard input");
 392             exit(1);
 393         }
 394         arg = sdscatlen(arg,buf,nread);
 395     }
 396     return arg;
 397 }
 398
 399 static void usage() {
 400     fprintf(stderr, "usage: redis-cli [-h host] [-p port] [-r repeat_times] [-n db_num] cmd arg1 arg2 arg3 ... argN\n");
 401     fprintf(stderr, "usage: echo \"argN\" | redis-cli [-h host] [-p port] [-r repeat_times] [-n db_num] cmd arg1 arg2 ... arg(N-1)\n");
 402     fprintf(stderr, "\nIf a pipe from standard input is detected this data is used as last argument.\n\n");
 403     fprintf(stderr, "example: cat /etc/passwd | redis-cli set my_passwd\n");
 404     fprintf(stderr, "example: redis-cli get my_passwd\n");
 405     fprintf(stderr, "example: redis-cli -r 100 lpush mylist x\n");
 406     exit(1);
 407 }
 408
 409 int main(int argc, char **argv) {
 410     int firstarg, j;
 411     char **argvcopy;
 412     struct redisCommand *rc;
 413
 414     config.hostip = "127.0.0.1";
 415     config.hostport = 6379;
 416     config.repeat = 1;
 417     config.dbnum = 0;
 418
 419     firstarg = parseOptions(argc,argv);
 420     argc -= firstarg;
 421     argv += firstarg;
 422
 423     /* Turn the plain C strings into Sds strings */
 424     argvcopy = zmalloc(sizeof(char*)*argc+1);
 425     for(j = 0; j < argc; j++)
 426         argvcopy[j] = sdsnew(argv[j]);
 427
 428     if (argc < 1) usage();
 429
 430     /* Read the last argument from stdandard input if needed */
 431     if ((rc = lookupCommand(argv[0])) != NULL) {
 432         if (rc->arity > 0 && argc == rc->arity-1) {
 433             sds lastarg = readArgFromStdin();
 434             argvcopy[argc] = lastarg;
 435             argc++;
 436         }
 437     }
 438
 439     return cliSendCommand(argc, argvcopy);
 440 }