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