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