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