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     {"debug",-2,REDIS_CMD_INLINE},
 115     {NULL,0,0}
 116 };
 117
 118 static int cliReadReply(int fd);
 119
 120 static struct redisCommand *lookupCommand(char *name) {
 121     int j = 0;
 122     while(cmdTable[j].name != NULL) {
 123         if (!strcasecmp(name,cmdTable[j].name)) return &cmdTable[j];
 124         j++;
 125     }
 126     return NULL;
 127 }
 128
 129 static int cliConnect(void) {
 130     char err[ANET_ERR_LEN];
 131     int fd;
 132
 133     fd = anetTcpConnect(err,config.hostip,config.hostport);
 134     if (fd == ANET_ERR) {
 135         fprintf(stderr,"Connect: %s\n",err);
 136         return -1;
 137     }
 138     anetTcpNoDelay(NULL,fd);
 139     return fd;
 140 }
 141
 142 static sds cliReadLine(int fd) {
 143     sds line = sdsempty();
 144
 145     while(1) {
 146         char c;
 147         ssize_t ret;
 148
 149         ret = read(fd,&c,1);
 150         if (ret == -1) {
 151             sdsfree(line);
 152             return NULL;
 153         } else if ((ret == 0) || (c == '\n')) {
 154             break;
 155         } else {
 156             line = sdscatlen(line,&c,1);
 157         }
 158     }
 159     return sdstrim(line,"\r\n");
 160 }
 161
 162 static int cliReadSingleLineReply(int fd) {
 163     sds reply = cliReadLine(fd);
 164
 165     if (reply == NULL) return 1;
 166     printf("%s\n", reply);
 167     return 0;
 168 }
 169
 170 static int cliReadBulkReply(int fd) {
 171     sds replylen = cliReadLine(fd);
 172     char *reply, crlf[2];
 173     int bulklen;
 174
 175     if (replylen == NULL) return 1;
 176     bulklen = atoi(replylen);
 177     if (bulklen == -1) {
 178         sdsfree(replylen);
 179         printf("(nil)");
 180         return 0;
 181     }
 182     reply = zmalloc(bulklen);
 183     anetRead(fd,reply,bulklen);
 184     anetRead(fd,crlf,2);
 185     if (bulklen && fwrite(reply,bulklen,1,stdout) == 0) {
 186         zfree(reply);
 187         return 1;
 188     }
 189     if (isatty(fileno(stdout)) && reply[bulklen-1] != '\n')
 190         printf("\n");
 191     zfree(reply);
 192     return 0;
 193 }
 194
 195 static int cliReadMultiBulkReply(int fd) {
 196     sds replylen = cliReadLine(fd);
 197     int elements, c = 1;
 198
 199     if (replylen == NULL) return 1;
 200     elements = atoi(replylen);
 201     if (elements == -1) {
 202         sdsfree(replylen);
 203         printf("(nil)\n");
 204         return 0;
 205     }
 206     if (elements == 0) {
 207         printf("(empty list or set)\n");
 208     }
 209     while(elements--) {
 210         printf("%d. ", c);
 211         if (cliReadReply(fd)) return 1;
 212         c++;
 213     }
 214     return 0;
 215 }
 216
 217 static int cliReadReply(int fd) {
 218     char type;
 219
 220     if (anetRead(fd,&type,1) <= 0) exit(1);
 221     switch(type) {
 222     case '-':
 223         printf("(error) ");
 224         cliReadSingleLineReply(fd);
 225         return 1;
 226     case '+':
 227     case ':':
 228         return cliReadSingleLineReply(fd);
 229     case '$':
 230         return cliReadBulkReply(fd);
 231     case '*':
 232         return cliReadMultiBulkReply(fd);
 233     default:
 234         printf("protocol error, got '%c' as reply type byte\n", type);
 235         return 1;
 236     }
 237 }
 238
 239 static int cliSendCommand(int argc, char **argv) {
 240     struct redisCommand *rc = lookupCommand(argv[0]);
 241     int fd, j, retval = 0;
 242     sds cmd = sdsempty();
 243
 244     if (!rc) {
 245         fprintf(stderr,"Unknown command '%s'\n",argv[0]);
 246         return 1;
 247     }
 248
 249     if ((rc->arity > 0 && argc != rc->arity) ||
 250         (rc->arity < 0 && argc < -rc->arity)) {
 251             fprintf(stderr,"Wrong number of arguments for '%s'\n",rc->name);
 252             return 1;
 253     }
 254     if ((fd = cliConnect()) == -1) return 1;
 255
 256     /* Build the command to send */
 257     for (j = 0; j < argc; j++) {
 258         if (j != 0) cmd = sdscat(cmd," ");
 259         if (j == argc-1 && rc->flags & REDIS_CMD_BULK) {
 260             cmd = sdscatprintf(cmd,"%d",sdslen(argv[j]));
 261         } else {
 262             cmd = sdscatlen(cmd,argv[j],sdslen(argv[j]));
 263         }
 264     }
 265     cmd = sdscat(cmd,"\r\n");
 266     if (rc->flags & REDIS_CMD_BULK) {
 267         cmd = sdscatlen(cmd,argv[argc-1],sdslen(argv[argc-1]));
 268         cmd = sdscat(cmd,"\r\n");
 269     }
 270     anetWrite(fd,cmd,sdslen(cmd));
 271     retval = cliReadReply(fd);
 272     if (retval) {
 273         close(fd);
 274         return retval;
 275     }
 276     close(fd);
 277     return 0;
 278 }
 279
 280 static int parseOptions(int argc, char **argv) {
 281     int i;
 282
 283     for (i = 1; i < argc; i++) {
 284         int lastarg = i==argc-1;
 285
 286         if (!strcmp(argv[i],"-h") && !lastarg) {
 287             char *ip = zmalloc(32);
 288             if (anetResolve(NULL,argv[i+1],ip) == ANET_ERR) {
 289                 printf("Can't resolve %s\n", argv[i]);
 290                 exit(1);
 291             }
 292             config.hostip = ip;
 293             i++;
 294         } else if (!strcmp(argv[i],"-p") && !lastarg) {
 295             config.hostport = atoi(argv[i+1]);
 296             i++;
 297         } else {
 298             break;
 299         }
 300     }
 301     return i;
 302 }
 303
 304 static sds readArgFromStdin(void) {
 305     char buf[1024];
 306     sds arg = sdsempty();
 307
 308     while(1) {
 309         int nread = read(fileno(stdin),buf,1024);
 310
 311         if (nread == 0) break;
 312         else if (nread == -1) {
 313             perror("Reading from standard input");
 314             exit(1);
 315         }
 316         arg = sdscatlen(arg,buf,nread);
 317     }
 318     return arg;
 319 }
 320
 321 int main(int argc, char **argv) {
 322     int firstarg, j;
 323     char **argvcopy;
 324     struct redisCommand *rc;
 325
 326     config.hostip = "127.0.0.1";
 327     config.hostport = 6379;
 328
 329     firstarg = parseOptions(argc,argv);
 330     argc -= firstarg;
 331     argv += firstarg;
 332
 333     /* Turn the plain C strings into Sds strings */
 334     argvcopy = zmalloc(sizeof(char*)*argc+1);
 335     for(j = 0; j < argc; j++)
 336         argvcopy[j] = sdsnew(argv[j]);
 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     /* Read the last argument from stdandard input if needed */
 348     if ((rc = lookupCommand(argv[0])) != NULL) {
 349         if (rc->arity > 0 && argc == rc->arity-1) {
 350             sds lastarg = readArgFromStdin();
 351             argvcopy[argc] = lastarg;
 352             argc++;
 353         }
 354     }
 355
 356     return cliSendCommand(argc, argvcopy);
 357 }