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