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