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