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