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