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