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