src/redis-cli.c

   1 /* Redis CLI (command line interface)
   2  *
   3  * Copyright (c) 2009-2010, 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 #include "version.h"
  33
  34 #include <stdio.h>
  35 #include <string.h>
  36 #include <stdlib.h>
  37 #include <unistd.h>
  38 #include <ctype.h>
  39
  40 #include "anet.h"
  41 #include "sds.h"
  42 #include "adlist.h"
  43 #include "zmalloc.h"
  44 #include "linenoise.h"
  45
  46 #define REDIS_CMD_INLINE 1
  47 #define REDIS_CMD_BULK 2
  48 #define REDIS_CMD_MULTIBULK 4
  49
  50 #define REDIS_NOTUSED(V) ((void) V)
  51
  52 static struct config {
  53     char *hostip;
  54     int hostport;
  55     long repeat;
  56     int dbnum;
  57     int argn_from_stdin;
  58     int interactive;
  59     int shutdown;
  60     int monitor_mode;
  61     int pubsub_mode;
  62     int raw_output;
  63     char *auth;
  64     char *historyfile;
  65 } config;
  66
  67 static int cliReadReply(int fd);
  68 static void usage();
  69
  70 static int cliConnect(void) {
  71     char err[ANET_ERR_LEN];
  72     static int fd = ANET_ERR;
  73
  74     if (fd == ANET_ERR) {
  75         fd = anetTcpConnect(err,config.hostip,config.hostport);
  76         if (fd == ANET_ERR) {
  77             fprintf(stderr, "Could not connect to Redis at %s:%d: %s", config.hostip, config.hostport, err);
  78             return -1;
  79         }
  80         anetTcpNoDelay(NULL,fd);
  81     }
  82     return fd;
  83 }
  84
  85 static sds cliReadLine(int fd) {
  86     sds line = sdsempty();
  87
  88     while(1) {
  89         char c;
  90         ssize_t ret;
  91
  92         ret = read(fd,&c,1);
  93         if (ret == -1) {
  94             sdsfree(line);
  95             return NULL;
  96         } else if ((ret == 0) || (c == '\n')) {
  97             break;
  98         } else {
  99             line = sdscatlen(line,&c,1);
 100         }
 101     }
 102     return sdstrim(line,"\r\n");
 103 }
 104
 105 static int cliReadSingleLineReply(int fd, int quiet) {
 106     sds reply = cliReadLine(fd);
 107
 108     if (reply == NULL) return 1;
 109     if (!quiet)
 110         printf("%s\n", reply);
 111     sdsfree(reply);
 112     return 0;
 113 }
 114
 115 static void printStringRepr(char *s, int len) {
 116     printf("\"");
 117     while(len--) {
 118         switch(*s) {
 119         case '\\':
 120         case '"':
 121             printf("\\%c",*s);
 122             break;
 123         case '\n': printf("\\n"); break;
 124         case '\r': printf("\\r"); break;
 125         case '\t': printf("\\t"); break;
 126         case '\a': printf("\\a"); break;
 127         case '\b': printf("\\b"); break;
 128         default:
 129             if (isprint(*s))
 130                 printf("%c",*s);
 131             else
 132                 printf("\\x%02x",(unsigned char)*s);
 133             break;
 134         }
 135         s++;
 136     }
 137     printf("\"\n");
 138 }
 139
 140 static int cliReadBulkReply(int fd) {
 141     sds replylen = cliReadLine(fd);
 142     char *reply, crlf[2];
 143     int bulklen;
 144
 145     if (replylen == NULL) return 1;
 146     bulklen = atoi(replylen);
 147     if (bulklen == -1) {
 148         sdsfree(replylen);
 149         printf("(nil)\n");
 150         return 0;
 151     }
 152     reply = zmalloc(bulklen);
 153     anetRead(fd,reply,bulklen);
 154     anetRead(fd,crlf,2);
 155     if (config.raw_output || !isatty(fileno(stdout))) {
 156         if (bulklen && fwrite(reply,bulklen,1,stdout) == 0) {
 157             zfree(reply);
 158             return 1;
 159         }
 160     } else {
 161         /* If you are producing output for the standard output we want
 162          * a more interesting output with quoted characters and so forth */
 163         printStringRepr(reply,bulklen);
 164     }
 165     zfree(reply);
 166     return 0;
 167 }
 168
 169 static int cliReadMultiBulkReply(int fd) {
 170     sds replylen = cliReadLine(fd);
 171     int elements, c = 1;
 172
 173     if (replylen == NULL) return 1;
 174     elements = atoi(replylen);
 175     if (elements == -1) {
 176         sdsfree(replylen);
 177         printf("(nil)\n");
 178         return 0;
 179     }
 180     if (elements == 0) {
 181         printf("(empty list or set)\n");
 182     }
 183     while(elements--) {
 184         printf("%d. ", c);
 185         if (cliReadReply(fd)) return 1;
 186         c++;
 187     }
 188     return 0;
 189 }
 190
 191 static int cliReadReply(int fd) {
 192     char type;
 193
 194     if (anetRead(fd,&type,1) <= 0) {
 195         if (config.shutdown) return 0;
 196         exit(1);
 197     }
 198     switch(type) {
 199     case '-':
 200         printf("(error) ");
 201         cliReadSingleLineReply(fd,0);
 202         return 1;
 203     case '+':
 204         return cliReadSingleLineReply(fd,0);
 205     case ':':
 206         printf("(integer) ");
 207         return cliReadSingleLineReply(fd,0);
 208     case '$':
 209         return cliReadBulkReply(fd);
 210     case '*':
 211         return cliReadMultiBulkReply(fd);
 212     default:
 213         printf("protocol error, got '%c' as reply type byte\n", type);
 214         return 1;
 215     }
 216 }
 217
 218 static int selectDb(int fd) {
 219     int retval;
 220     sds cmd;
 221     char type;
 222
 223     if (config.dbnum == 0)
 224         return 0;
 225
 226     cmd = sdsempty();
 227     cmd = sdscatprintf(cmd,"SELECT %d\r\n",config.dbnum);
 228     anetWrite(fd,cmd,sdslen(cmd));
 229     anetRead(fd,&type,1);
 230     if (type <= 0 || type != '+') return 1;
 231     retval = cliReadSingleLineReply(fd,1);
 232     if (retval) {
 233         return retval;
 234     }
 235     return 0;
 236 }
 237
 238 static int cliSendCommand(int argc, char **argv, int repeat) {
 239     char *command = argv[0];
 240     int fd, j, retval = 0;
 241     sds cmd;
 242
 243     config.raw_output = !strcasecmp(command,"info");
 244     if (!strcasecmp(command,"shutdown")) config.shutdown = 1;
 245     if (!strcasecmp(command,"monitor")) config.monitor_mode = 1;
 246     if (!strcasecmp(command,"subscribe") ||
 247         !strcasecmp(command,"psubscribe")) config.pubsub_mode = 1;
 248     if ((fd = cliConnect()) == -1) return 1;
 249
 250     /* Select db number */
 251     retval = selectDb(fd);
 252     if (retval) {
 253         fprintf(stderr,"Error setting DB num\n");
 254         return 1;
 255     }
 256
 257     /* Build the command to send */
 258     cmd = sdscatprintf(sdsempty(),"*%d\r\n",argc);
 259     for (j = 0; j < argc; j++) {
 260         cmd = sdscatprintf(cmd,"$%lu\r\n",
 261             (unsigned long)sdslen(argv[j]));
 262         cmd = sdscatlen(cmd,argv[j],sdslen(argv[j]));
 263         cmd = sdscatlen(cmd,"\r\n",2);
 264     }
 265
 266     while(repeat--) {
 267         anetWrite(fd,cmd,sdslen(cmd));
 268         while (config.monitor_mode) {
 269             cliReadSingleLineReply(fd,0);
 270         }
 271
 272         if (config.pubsub_mode) {
 273             printf("Reading messages... (press Ctrl-c to quit)\n");
 274             while (1) {
 275                 cliReadReply(fd);
 276                 printf("\n");
 277             }
 278         }
 279
 280         retval = cliReadReply(fd);
 281         if (retval) {
 282             return retval;
 283         }
 284     }
 285     return 0;
 286 }
 287
 288 static int parseOptions(int argc, char **argv) {
 289     int i;
 290
 291     for (i = 1; i < argc; i++) {
 292         int lastarg = i==argc-1;
 293
 294         if (!strcmp(argv[i],"-h") && !lastarg) {
 295             char *ip = zmalloc(32);
 296             if (anetResolve(NULL,argv[i+1],ip) == ANET_ERR) {
 297                 printf("Can't resolve %s\n", argv[i]);
 298                 exit(1);
 299             }
 300             config.hostip = ip;
 301             i++;
 302         } else if (!strcmp(argv[i],"-h") && lastarg) {
 303             usage();
 304         } else if (!strcmp(argv[i],"-p") && !lastarg) {
 305             config.hostport = atoi(argv[i+1]);
 306             i++;
 307         } else if (!strcmp(argv[i],"-r") && !lastarg) {
 308             config.repeat = strtoll(argv[i+1],NULL,10);
 309             i++;
 310         } else if (!strcmp(argv[i],"-n") && !lastarg) {
 311             config.dbnum = atoi(argv[i+1]);
 312             i++;
 313         } else if (!strcmp(argv[i],"-a") && !lastarg) {
 314             config.auth = argv[i+1];
 315             i++;
 316         } else if (!strcmp(argv[i],"-i")) {
 317             config.interactive = 1;
 318         } else if (!strcmp(argv[i],"-c")) {
 319             config.argn_from_stdin = 1;
 320         } else if (!strcmp(argv[i],"-v")) {
 321             printf("redis-cli shipped with Redis verison %s\n", REDIS_VERSION);
 322             exit(0);
 323         } else {
 324             break;
 325         }
 326     }
 327     return i;
 328 }
 329
 330 static sds readArgFromStdin(void) {
 331     char buf[1024];
 332     sds arg = sdsempty();
 333
 334     while(1) {
 335         int nread = read(fileno(stdin),buf,1024);
 336
 337         if (nread == 0) break;
 338         else if (nread == -1) {
 339             perror("Reading from standard input");
 340             exit(1);
 341         }
 342         arg = sdscatlen(arg,buf,nread);
 343     }
 344     return arg;
 345 }
 346
 347 static void usage() {
 348     fprintf(stderr, "usage: redis-cli [-iv] [-h host] [-p port] [-a authpw] [-r repeat_times] [-n db_num] cmd arg1 arg2 arg3 ... argN\n");
 349     fprintf(stderr, "usage: echo \"argN\" | redis-cli -c [-h host] [-p port] [-a authpw] [-r repeat_times] [-n db_num] cmd arg1 arg2 ... arg(N-1)\n");
 350     fprintf(stderr, "\nIf a pipe from standard input is detected this data is used as last argument.\n\n");
 351     fprintf(stderr, "example: cat /etc/passwd | redis-cli set my_passwd\n");
 352     fprintf(stderr, "example: redis-cli get my_passwd\n");
 353     fprintf(stderr, "example: redis-cli -r 100 lpush mylist x\n");
 354     fprintf(stderr, "\nRun in interactive mode: redis-cli -i or just don't pass any command\n");
 355     exit(1);
 356 }
 357
 358 /* Turn the plain C strings into Sds strings */
 359 static char **convertToSds(int count, char** args) {
 360   int j;
 361   char **sds = zmalloc(sizeof(char*)*count);
 362
 363   for(j = 0; j < count; j++)
 364     sds[j] = sdsnew(args[j]);
 365
 366   return sds;
 367 }
 368
 369 #define LINE_BUFLEN 4096
 370 static void repl() {
 371     int argc, j;
 372     char *line;
 373     sds *argv;
 374
 375     while((line = linenoise("redis> ")) != NULL) {
 376         if (line[0] != '\0') {
 377             argv = sdssplitargs(line,&argc);
 378             linenoiseHistoryAdd(line);
 379             if (config.historyfile) linenoiseHistorySave(config.historyfile);
 380             if (argc > 0) {
 381                 if (strcasecmp(argv[0],"quit") == 0 ||
 382                     strcasecmp(argv[0],"exit") == 0)
 383                         exit(0);
 384                 else
 385                     cliSendCommand(argc, argv, 1);
 386             }
 387             /* Free the argument vector */
 388             for (j = 0; j < argc; j++)
 389                 sdsfree(argv[j]);
 390             zfree(argv);
 391         }
 392         /* linenoise() returns malloc-ed lines like readline() */
 393         free(line);
 394     }
 395     exit(0);
 396 }
 397
 398 int main(int argc, char **argv) {
 399     int firstarg;
 400     char **argvcopy;
 401
 402     config.hostip = "127.0.0.1";
 403     config.hostport = 6379;
 404     config.repeat = 1;
 405     config.dbnum = 0;
 406     config.argn_from_stdin = 0;
 407     config.shutdown = 0;
 408     config.interactive = 0;
 409     config.monitor_mode = 0;
 410     config.pubsub_mode = 0;
 411     config.raw_output = 0;
 412     config.auth = NULL;
 413     config.historyfile = NULL;
 414
 415     if (getenv("HOME") != NULL) {
 416         config.historyfile = malloc(256);
 417         snprintf(config.historyfile,256,"%s/.rediscli_history",getenv("HOME"));
 418         linenoiseHistoryLoad(config.historyfile);
 419     }
 420
 421     firstarg = parseOptions(argc,argv);
 422     argc -= firstarg;
 423     argv += firstarg;
 424
 425     if (config.auth != NULL) {
 426         char *authargv[2];
 427
 428         authargv[0] = "AUTH";
 429         authargv[1] = config.auth;
 430         cliSendCommand(2, convertToSds(2, authargv), 1);
 431     }
 432
 433     if (argc == 0 || config.interactive == 1) repl();
 434
 435     argvcopy = convertToSds(argc+1, argv);
 436     if (config.argn_from_stdin) {
 437         sds lastarg = readArgFromStdin();
 438         argvcopy[argc] = lastarg;
 439         argc++;
 440     }
 441     return cliSendCommand(argc, argvcopy, config.repeat);
 442 }