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