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