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