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