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     long repeat;
  53     int dbnum;
  54 } config;
  55
  56 struct redisCommand {
  57     char *name;
  58     int arity;
  59     int flags;
  60 };
  61
  62 static struct redisCommand cmdTable[] = {
  63     {"get",2,REDIS_CMD_INLINE},
  64     {"set",3,REDIS_CMD_BULK},
  65     {"setnx",3,REDIS_CMD_BULK},
  66     {"del",-2,REDIS_CMD_INLINE},
  67     {"exists",2,REDIS_CMD_INLINE},
  68     {"incr",2,REDIS_CMD_INLINE},
  69     {"decr",2,REDIS_CMD_INLINE},
  70     {"rpush",3,REDIS_CMD_BULK},
  71     {"lpush",3,REDIS_CMD_BULK},
  72     {"rpop",2,REDIS_CMD_INLINE},
  73     {"lpop",2,REDIS_CMD_INLINE},
  74     {"llen",2,REDIS_CMD_INLINE},
  75     {"lindex",3,REDIS_CMD_INLINE},
  76     {"lset",4,REDIS_CMD_BULK},
  77     {"lrange",4,REDIS_CMD_INLINE},
  78     {"ltrim",4,REDIS_CMD_INLINE},
  79     {"lrem",4,REDIS_CMD_BULK},
  80     {"rpoplpush",3,REDIS_CMD_BULK},
  81     {"sadd",3,REDIS_CMD_BULK},
  82     {"srem",3,REDIS_CMD_BULK},
  83     {"smove",4,REDIS_CMD_BULK},
  84     {"sismember",3,REDIS_CMD_BULK},
  85     {"scard",2,REDIS_CMD_INLINE},
  86     {"spop",2,REDIS_CMD_INLINE},
  87     {"srandmember",2,REDIS_CMD_INLINE},
  88     {"sinter",-2,REDIS_CMD_INLINE},
  89     {"sinterstore",-3,REDIS_CMD_INLINE},
  90     {"sunion",-2,REDIS_CMD_INLINE},
  91     {"sunionstore",-3,REDIS_CMD_INLINE},
  92     {"sdiff",-2,REDIS_CMD_INLINE},
  93     {"sdiffstore",-3,REDIS_CMD_INLINE},
  94     {"smembers",2,REDIS_CMD_INLINE},
  95     {"zadd",4,REDIS_CMD_BULK},
  96     {"zrem",3,REDIS_CMD_BULK},
  97     {"zremrangebyscore",4,REDIS_CMD_INLINE},
  98     {"zrange",4,REDIS_CMD_INLINE},
  99     {"zrangebyscore",4,REDIS_CMD_INLINE},
 100     {"zrevrange",4,REDIS_CMD_INLINE},
 101     {"zcard",2,REDIS_CMD_INLINE},
 102     {"zscore",3,REDIS_CMD_BULK},
 103     {"incrby",3,REDIS_CMD_INLINE},
 104     {"decrby",3,REDIS_CMD_INLINE},
 105     {"getset",3,REDIS_CMD_BULK},
 106     {"randomkey",1,REDIS_CMD_INLINE},
 107     {"select",2,REDIS_CMD_INLINE},
 108     {"move",3,REDIS_CMD_INLINE},
 109     {"rename",3,REDIS_CMD_INLINE},
 110     {"renamenx",3,REDIS_CMD_INLINE},
 111     {"keys",2,REDIS_CMD_INLINE},
 112     {"dbsize",1,REDIS_CMD_INLINE},
 113     {"ping",1,REDIS_CMD_INLINE},
 114     {"echo",2,REDIS_CMD_BULK},
 115     {"save",1,REDIS_CMD_INLINE},
 116     {"bgsave",1,REDIS_CMD_INLINE},
 117     {"shutdown",1,REDIS_CMD_INLINE},
 118     {"lastsave",1,REDIS_CMD_INLINE},
 119     {"type",2,REDIS_CMD_INLINE},
 120     {"flushdb",1,REDIS_CMD_INLINE},
 121     {"flushall",1,REDIS_CMD_INLINE},
 122     {"sort",-2,REDIS_CMD_INLINE},
 123     {"info",1,REDIS_CMD_INLINE},
 124     {"mget",-2,REDIS_CMD_INLINE},
 125     {"expire",3,REDIS_CMD_INLINE},
 126     {"expireat",3,REDIS_CMD_INLINE},
 127     {"ttl",2,REDIS_CMD_INLINE},
 128     {"slaveof",3,REDIS_CMD_INLINE},
 129     {"debug",-2,REDIS_CMD_INLINE},
 130     {"mset",-3,REDIS_CMD_MULTIBULK},
 131     {"msetnx",-3,REDIS_CMD_MULTIBULK},
 132     {NULL,0,0}
 133 };
 134
 135 static int cliReadReply(int fd);
 136
 137 static struct redisCommand *lookupCommand(char *name) {
 138     int j = 0;
 139     while(cmdTable[j].name != NULL) {
 140         if (!strcasecmp(name,cmdTable[j].name)) return &cmdTable[j];
 141         j++;
 142     }
 143     return NULL;
 144 }
 145
 146 static int cliConnect(void) {
 147     char err[ANET_ERR_LEN];
 148     int fd;
 149
 150     fd = anetTcpConnect(err,config.hostip,config.hostport);
 151     if (fd == ANET_ERR) {
 152         fprintf(stderr,"Connect: %s\n",err);
 153         return -1;
 154     }
 155     anetTcpNoDelay(NULL,fd);
 156     return fd;
 157 }
 158
 159 static sds cliReadLine(int fd) {
 160     sds line = sdsempty();
 161
 162     while(1) {
 163         char c;
 164         ssize_t ret;
 165
 166         ret = read(fd,&c,1);
 167         if (ret == -1) {
 168             sdsfree(line);
 169             return NULL;
 170         } else if ((ret == 0) || (c == '\n')) {
 171             break;
 172         } else {
 173             line = sdscatlen(line,&c,1);
 174         }
 175     }
 176     return sdstrim(line,"\r\n");
 177 }
 178
 179 static int cliReadSingleLineReply(int fd, int quiet) {
 180     sds reply = cliReadLine(fd);
 181
 182     if (reply == NULL) return 1;
 183     if (!quiet)
 184         printf("%s\n", reply);
 185     return 0;
 186 }
 187
 188 static int cliReadBulkReply(int fd) {
 189     sds replylen = cliReadLine(fd);
 190     char *reply, crlf[2];
 191     int bulklen;
 192
 193     if (replylen == NULL) return 1;
 194     bulklen = atoi(replylen);
 195     if (bulklen == -1) {
 196         sdsfree(replylen);
 197         printf("(nil)\n");
 198         return 0;
 199     }
 200     reply = zmalloc(bulklen);
 201     anetRead(fd,reply,bulklen);
 202     anetRead(fd,crlf,2);
 203     if (bulklen && fwrite(reply,bulklen,1,stdout) == 0) {
 204         zfree(reply);
 205         return 1;
 206     }
 207     if (isatty(fileno(stdout)) && reply[bulklen-1] != '\n')
 208         printf("\n");
 209     zfree(reply);
 210     return 0;
 211 }
 212
 213 static int cliReadMultiBulkReply(int fd) {
 214     sds replylen = cliReadLine(fd);
 215     int elements, c = 1;
 216
 217     if (replylen == NULL) return 1;
 218     elements = atoi(replylen);
 219     if (elements == -1) {
 220         sdsfree(replylen);
 221         printf("(nil)\n");
 222         return 0;
 223     }
 224     if (elements == 0) {
 225         printf("(empty list or set)\n");
 226     }
 227     while(elements--) {
 228         printf("%d. ", c);
 229         if (cliReadReply(fd)) return 1;
 230         c++;
 231     }
 232     return 0;
 233 }
 234
 235 static int cliReadReply(int fd) {
 236     char type;
 237
 238     if (anetRead(fd,&type,1) <= 0) exit(1);
 239     switch(type) {
 240     case '-':
 241         printf("(error) ");
 242         cliReadSingleLineReply(fd,0);
 243         return 1;
 244     case '+':
 245         return cliReadSingleLineReply(fd,0);
 246     case ':':
 247         printf("(integer) ");
 248         return cliReadSingleLineReply(fd,0);
 249     case '$':
 250         return cliReadBulkReply(fd);
 251     case '*':
 252         return cliReadMultiBulkReply(fd);
 253     default:
 254         printf("protocol error, got '%c' as reply type byte\n", type);
 255         return 1;
 256     }
 257 }
 258
 259 static int selectDb(int fd)
 260 {
 261     int retval;
 262     sds cmd;
 263     char type;
 264
 265     if (config.dbnum == 0)
 266         return 0;
 267
 268     cmd = sdsempty();
 269     cmd = sdscatprintf(cmd,"SELECT %d\r\n",config.dbnum);
 270     anetWrite(fd,cmd,sdslen(cmd));
 271     anetRead(fd,&type,1);
 272     if (type <= 0 || type != '+') return 1;
 273     retval = cliReadSingleLineReply(fd,1);
 274     if (retval) {
 275         close(fd);
 276         return retval;
 277     }
 278     return 0;
 279 }
 280
 281 static int cliSendCommand(int argc, char **argv) {
 282     struct redisCommand *rc = lookupCommand(argv[0]);
 283     int fd, j, retval = 0;
 284     sds cmd;
 285
 286     if (!rc) {
 287         fprintf(stderr,"Unknown command '%s'\n",argv[0]);
 288         return 1;
 289     }
 290
 291     if ((rc->arity > 0 && argc != rc->arity) ||
 292         (rc->arity < 0 && argc < -rc->arity)) {
 293             fprintf(stderr,"Wrong number of arguments for '%s'\n",rc->name);
 294             return 1;
 295     }
 296     if ((fd = cliConnect()) == -1) return 1;
 297
 298     /* Select db number */
 299     retval = selectDb(fd);
 300     if (retval) {
 301         fprintf(stderr,"Error setting DB num\n");
 302         return 1;
 303     }
 304
 305     while(config.repeat--) {
 306         /* Build the command to send */
 307         cmd = sdsempty();
 308         if (rc->flags & REDIS_CMD_MULTIBULK) {
 309             cmd = sdscatprintf(cmd,"*%d\r\n",argc);
 310             for (j = 0; j < argc; j++) {
 311                 cmd = sdscatprintf(cmd,"$%d\r\n",sdslen(argv[j]));
 312                 cmd = sdscatlen(cmd,argv[j],sdslen(argv[j]));
 313                 cmd = sdscatlen(cmd,"\r\n",2);
 314             }
 315         } else {
 316             for (j = 0; j < argc; j++) {
 317                 if (j != 0) cmd = sdscat(cmd," ");
 318                 if (j == argc-1 && rc->flags & REDIS_CMD_BULK) {
 319                     cmd = sdscatprintf(cmd,"%d",sdslen(argv[j]));
 320                 } else {
 321                     cmd = sdscatlen(cmd,argv[j],sdslen(argv[j]));
 322                 }
 323             }
 324             cmd = sdscat(cmd,"\r\n");
 325             if (rc->flags & REDIS_CMD_BULK) {
 326                 cmd = sdscatlen(cmd,argv[argc-1],sdslen(argv[argc-1]));
 327                 cmd = sdscatlen(cmd,"\r\n",2);
 328             }
 329         }
 330         anetWrite(fd,cmd,sdslen(cmd));
 331         sdsfree(cmd);
 332         retval = cliReadReply(fd);
 333         if (retval) {
 334             close(fd);
 335             return retval;
 336         }
 337     }
 338     close(fd);
 339     return 0;
 340 }
 341
 342 static int parseOptions(int argc, char **argv) {
 343     int i;
 344
 345     for (i = 1; i < argc; i++) {
 346         int lastarg = i==argc-1;
 347
 348         if (!strcmp(argv[i],"-h") && !lastarg) {
 349             char *ip = zmalloc(32);
 350             if (anetResolve(NULL,argv[i+1],ip) == ANET_ERR) {
 351                 printf("Can't resolve %s\n", argv[i]);
 352                 exit(1);
 353             }
 354             config.hostip = ip;
 355             i++;
 356         } else if (!strcmp(argv[i],"-p") && !lastarg) {
 357             config.hostport = atoi(argv[i+1]);
 358             i++;
 359         } else if (!strcmp(argv[i],"-r") && !lastarg) {
 360             config.repeat = strtoll(argv[i+1],NULL,10);
 361             i++;
 362         } else if (!strcmp(argv[i],"-n") && !lastarg) {
 363             config.dbnum = atoi(argv[i+1]);
 364             i++;
 365         } else {
 366             break;
 367         }
 368     }
 369     return i;
 370 }
 371
 372 static sds readArgFromStdin(void) {
 373     char buf[1024];
 374     sds arg = sdsempty();
 375
 376     while(1) {
 377         int nread = read(fileno(stdin),buf,1024);
 378
 379         if (nread == 0) break;
 380         else if (nread == -1) {
 381             perror("Reading from standard input");
 382             exit(1);
 383         }
 384         arg = sdscatlen(arg,buf,nread);
 385     }
 386     return arg;
 387 }
 388
 389 int main(int argc, char **argv) {
 390     int firstarg, j;
 391     char **argvcopy;
 392     struct redisCommand *rc;
 393
 394     config.hostip = "127.0.0.1";
 395     config.hostport = 6379;
 396     config.repeat = 1;
 397     config.dbnum = 0;
 398
 399     firstarg = parseOptions(argc,argv);
 400     argc -= firstarg;
 401     argv += firstarg;
 402
 403     /* Turn the plain C strings into Sds strings */
 404     argvcopy = zmalloc(sizeof(char*)*argc+1);
 405     for(j = 0; j < argc; j++)
 406         argvcopy[j] = sdsnew(argv[j]);
 407
 408     if (argc < 1) {
 409         fprintf(stderr, "usage: redis-cli [-h host] [-p port] [-r repeat_times] [-n db_num] cmd arg1 arg2 arg3 ... argN\n");
 410         fprintf(stderr, "usage: echo \"argN\" | redis-cli [-h host] [-p port] [-r repeat_times] [-n db_num] cmd arg1 arg2 ... arg(N-1)\n");
 411         fprintf(stderr, "\nIf a pipe from standard input is detected this data is used as last argument.\n\n");
 412         fprintf(stderr, "example: cat /etc/passwd | redis-cli set my_passwd\n");
 413         fprintf(stderr, "example: redis-cli get my_passwd\n");
 414         fprintf(stderr, "example: redis-cli -r 100 lpush mylist x\n");
 415         exit(1);
 416     }
 417
 418     /* Read the last argument from stdandard input if needed */
 419     if ((rc = lookupCommand(argv[0])) != NULL) {
 420         if (rc->arity > 0 && argc == rc->arity-1) {
 421             sds lastarg = readArgFromStdin();
 422             argvcopy[argc] = lastarg;
 423             argc++;
 424         }
 425     }
 426
 427     return cliSendCommand(argc, argvcopy);
 428 }