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