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