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