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