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