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