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