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; /* output mode per command */
  63     int tty; /* flag for default output format */
  64     char *auth;
  65     char *historyfile;
  66 } config;
  67
  68 static int cliReadReply(int fd);
  69 static void usage();
  70
  71 static int cliConnect(void) {
  72     char err[ANET_ERR_LEN];
  73     static int fd = ANET_ERR;
  74
  75     if (fd == ANET_ERR) {
  76         fd = anetTcpConnect(err,config.hostip,config.hostport);
  77         if (fd == ANET_ERR) {
  78             fprintf(stderr, "Could not connect to Redis at %s:%d: %s", config.hostip, config.hostport, err);
  79             return -1;
  80         }
  81         anetTcpNoDelay(NULL,fd);
  82     }
  83     return fd;
  84 }
  85
  86 static sds cliReadLine(int fd) {
  87     sds line = sdsempty();
  88
  89     while(1) {
  90         char c;
  91         ssize_t ret;
  92
  93         ret = read(fd,&c,1);
  94         if (ret == -1) {
  95             sdsfree(line);
  96             return NULL;
  97         } else if ((ret == 0) || (c == '\n')) {
  98             break;
  99         } else {
 100             line = sdscatlen(line,&c,1);
 101         }
 102     }
 103     return sdstrim(line,"\r\n");
 104 }
 105
 106 static int cliReadSingleLineReply(int fd, int quiet) {
 107     sds reply = cliReadLine(fd);
 108
 109     if (reply == NULL) return 1;
 110     if (!quiet)
 111         printf("%s\n", reply);
 112     sdsfree(reply);
 113     return 0;
 114 }
 115
 116 static void printStringRepr(char *s, int len) {
 117     printf("\"");
 118     while(len--) {
 119         switch(*s) {
 120         case '\\':
 121         case '"':
 122             printf("\\%c",*s);
 123             break;
 124         case '\n': printf("\\n"); break;
 125         case '\r': printf("\\r"); break;
 126         case '\t': printf("\\t"); break;
 127         case '\a': printf("\\a"); break;
 128         case '\b': printf("\\b"); break;
 129         default:
 130             if (isprint(*s))
 131                 printf("%c",*s);
 132             else
 133                 printf("\\x%02x",(unsigned char)*s);
 134             break;
 135         }
 136         s++;
 137     }
 138     printf("\"");
 139 }
 140
 141 static int cliReadBulkReply(int fd) {
 142     sds replylen = cliReadLine(fd);
 143     char *reply, crlf[2];
 144     int bulklen;
 145
 146     if (replylen == NULL) return 1;
 147     bulklen = atoi(replylen);
 148     if (bulklen == -1) {
 149         sdsfree(replylen);
 150         printf("(nil)\n");
 151         return 0;
 152     }
 153     reply = zmalloc(bulklen);
 154     anetRead(fd,reply,bulklen);
 155     anetRead(fd,crlf,2);
 156     if (config.raw_output || !config.tty) {
 157         if (bulklen && fwrite(reply,bulklen,1,stdout) == 0) {
 158             zfree(reply);
 159             return 1;
 160         }
 161     } else {
 162         /* If you are producing output for the standard output we want
 163          * a more interesting output with quoted characters and so forth */
 164         printStringRepr(reply,bulklen);
 165         printf("\n");
 166     }
 167     zfree(reply);
 168     return 0;
 169 }
 170
 171 static int cliReadMultiBulkReply(int fd) {
 172     sds replylen = cliReadLine(fd);
 173     int elements, c = 1;
 174
 175     if (replylen == NULL) return 1;
 176     elements = atoi(replylen);
 177     if (elements == -1) {
 178         sdsfree(replylen);
 179         printf("(nil)\n");
 180         return 0;
 181     }
 182     if (elements == 0) {
 183         printf("(empty list or set)\n");
 184     }
 185     while(elements--) {
 186         printf("%d. ", c);
 187         if (cliReadReply(fd)) return 1;
 188         c++;
 189     }
 190     return 0;
 191 }
 192
 193 static int cliReadReply(int fd) {
 194     char type;
 195
 196     if (anetRead(fd,&type,1) <= 0) {
 197         if (config.shutdown) return 0;
 198         exit(1);
 199     }
 200     switch(type) {
 201     case '-':
 202         printf("(error) ");
 203         cliReadSingleLineReply(fd,0);
 204         return 1;
 205     case '+':
 206         return cliReadSingleLineReply(fd,0);
 207     case ':':
 208         printf("(integer) ");
 209         return cliReadSingleLineReply(fd,0);
 210     case '$':
 211         return cliReadBulkReply(fd);
 212     case '*':
 213         return cliReadMultiBulkReply(fd);
 214     default:
 215         printf("protocol error, got '%c' as reply type byte\n", type);
 216         return 1;
 217     }
 218 }
 219
 220 static int selectDb(int fd) {
 221     int retval;
 222     sds cmd;
 223     char type;
 224
 225     if (config.dbnum == 0)
 226         return 0;
 227
 228     cmd = sdsempty();
 229     cmd = sdscatprintf(cmd,"SELECT %d\r\n",config.dbnum);
 230     anetWrite(fd,cmd,sdslen(cmd));
 231     anetRead(fd,&type,1);
 232     if (type <= 0 || type != '+') return 1;
 233     retval = cliReadSingleLineReply(fd,1);
 234     if (retval) {
 235         return retval;
 236     }
 237     return 0;
 238 }
 239
 240 static int cliSendCommand(int argc, char **argv, int repeat) {
 241     char *command = argv[0];
 242     int fd, j, retval = 0;
 243     sds cmd;
 244
 245     config.raw_output = !strcasecmp(command,"info");
 246     if (!strcasecmp(command,"shutdown")) config.shutdown = 1;
 247     if (!strcasecmp(command,"monitor")) config.monitor_mode = 1;
 248     if (!strcasecmp(command,"subscribe") ||
 249         !strcasecmp(command,"psubscribe")) config.pubsub_mode = 1;
 250     if ((fd = cliConnect()) == -1) return 1;
 251
 252     /* Select db number */
 253     retval = selectDb(fd);
 254     if (retval) {
 255         fprintf(stderr,"Error setting DB num\n");
 256         return 1;
 257     }
 258
 259     /* Build the command to send */
 260     cmd = sdscatprintf(sdsempty(),"*%d\r\n",argc);
 261     for (j = 0; j < argc; j++) {
 262         cmd = sdscatprintf(cmd,"$%lu\r\n",
 263             (unsigned long)sdslen(argv[j]));
 264         cmd = sdscatlen(cmd,argv[j],sdslen(argv[j]));
 265         cmd = sdscatlen(cmd,"\r\n",2);
 266     }
 267
 268     while(repeat--) {
 269         anetWrite(fd,cmd,sdslen(cmd));
 270         while (config.monitor_mode) {
 271             cliReadSingleLineReply(fd,0);
 272         }
 273
 274         if (config.pubsub_mode) {
 275             printf("Reading messages... (press Ctrl-c to quit)\n");
 276             while (1) {
 277                 cliReadReply(fd);
 278                 printf("\n");
 279             }
 280         }
 281
 282         retval = cliReadReply(fd);
 283         if (retval) {
 284             return retval;
 285         }
 286     }
 287     return 0;
 288 }
 289
 290 static int parseOptions(int argc, char **argv) {
 291     int i;
 292
 293     for (i = 1; i < argc; i++) {
 294         int lastarg = i==argc-1;
 295
 296         if (!strcmp(argv[i],"-h") && !lastarg) {
 297             char *ip = zmalloc(32);
 298             if (anetResolve(NULL,argv[i+1],ip) == ANET_ERR) {
 299                 printf("Can't resolve %s\n", argv[i]);
 300                 exit(1);
 301             }
 302             config.hostip = ip;
 303             i++;
 304         } else if (!strcmp(argv[i],"-h") && lastarg) {
 305             usage();
 306         } else if (!strcmp(argv[i],"-p") && !lastarg) {
 307             config.hostport = atoi(argv[i+1]);
 308             i++;
 309         } else if (!strcmp(argv[i],"-r") && !lastarg) {
 310             config.repeat = strtoll(argv[i+1],NULL,10);
 311             i++;
 312         } else if (!strcmp(argv[i],"-n") && !lastarg) {
 313             config.dbnum = atoi(argv[i+1]);
 314             i++;
 315         } else if (!strcmp(argv[i],"-a") && !lastarg) {
 316             config.auth = argv[i+1];
 317             i++;
 318         } else if (!strcmp(argv[i],"-i")) {
 319             config.interactive = 1;
 320         } else if (!strcmp(argv[i],"-c")) {
 321             config.argn_from_stdin = 1;
 322         } else if (!strcmp(argv[i],"-v")) {
 323             printf("redis-cli shipped with Redis verison %s\n", REDIS_VERSION);
 324             exit(0);
 325         } else {
 326             break;
 327         }
 328     }
 329     return i;
 330 }
 331
 332 static sds readArgFromStdin(void) {
 333     char buf[1024];
 334     sds arg = sdsempty();
 335
 336     while(1) {
 337         int nread = read(fileno(stdin),buf,1024);
 338
 339         if (nread == 0) break;
 340         else if (nread == -1) {
 341             perror("Reading from standard input");
 342             exit(1);
 343         }
 344         arg = sdscatlen(arg,buf,nread);
 345     }
 346     return arg;
 347 }
 348
 349 static void usage() {
 350     fprintf(stderr, "usage: redis-cli [-iv] [-h host] [-p port] [-a authpw] [-r repeat_times] [-n db_num] cmd arg1 arg2 arg3 ... argN\n");
 351     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");
 352     fprintf(stderr, "\nIf a pipe from standard input is detected this data is used as last argument.\n\n");
 353     fprintf(stderr, "example: cat /etc/passwd | redis-cli set my_passwd\n");
 354     fprintf(stderr, "example: redis-cli get my_passwd\n");
 355     fprintf(stderr, "example: redis-cli -r 100 lpush mylist x\n");
 356     fprintf(stderr, "\nRun in interactive mode: redis-cli -i or just don't pass any command\n");
 357     exit(1);
 358 }
 359
 360 /* Turn the plain C strings into Sds strings */
 361 static char **convertToSds(int count, char** args) {
 362   int j;
 363   char **sds = zmalloc(sizeof(char*)*count);
 364
 365   for(j = 0; j < count; j++)
 366     sds[j] = sdsnew(args[j]);
 367
 368   return sds;
 369 }
 370
 371 static char **splitArguments(char *line, int *argc) {
 372     char *p = line;
 373     char *current = NULL;
 374     char **vector = NULL;
 375
 376     *argc = 0;
 377     while(1) {
 378         /* skip blanks */
 379         while(*p && isspace(*p)) p++;
 380         if (*p) {
 381             /* get a token */
 382             int inq=0; /* set to 1 if we are in "quotes" */
 383             int done=0;
 384
 385             if (current == NULL) current = sdsempty();
 386             while(!done) {
 387                 if (inq) {
 388                     if (*p == '\\' && *(p+1)) {
 389                         char c;
 390
 391                         p++;
 392                         switch(*p) {
 393                         case 'n': c = '\n'; break;
 394                         case 'r': c = '\r'; break;
 395                         case 't': c = '\t'; break;
 396                         case 'b': c = '\b'; break;
 397                         case 'a': c = '\a'; break;
 398                         default: c = *p; break;
 399                         }
 400                         current = sdscatlen(current,&c,1);
 401                     } else if (*p == '"') {
 402                         /* closing quote must be followed by a space */
 403                         if (*(p+1) && !isspace(*(p+1))) goto err;
 404                         done=1;
 405                     } else if (!*p) {
 406                         /* unterminated quotes */
 407                         goto err;
 408                     } else {
 409                         current = sdscatlen(current,p,1);
 410                     }
 411                 } else {
 412                     switch(*p) {
 413                     case ' ':
 414                     case '\n':
 415                     case '\r':
 416                     case '\t':
 417                     case '\0':
 418                         done=1;
 419                         break;
 420                     case '"':
 421                         inq=1;
 422                         break;
 423                     default:
 424                         current = sdscatlen(current,p,1);
 425                         break;
 426                     }
 427                 }
 428                 if (*p) p++;
 429             }
 430             /* add the token to the vector */
 431             vector = zrealloc(vector,((*argc)+1)*sizeof(char*));
 432             vector[*argc] = current;
 433             (*argc)++;
 434             current = NULL;
 435         } else {
 436             return vector;
 437         }
 438     }
 439
 440 err:
 441     while(*argc--)
 442         sdsfree(vector[*argc]);
 443     zfree(vector);
 444     if (current) sdsfree(current);
 445     return NULL;
 446 }
 447
 448 #define LINE_BUFLEN 4096
 449 static void repl() {
 450     int argc, j;
 451     char *line, **argv;
 452
 453     while((line = linenoise("redis> ")) != NULL) {
 454         if (line[0] != '\0') {
 455             argv = splitArguments(line,&argc);
 456             linenoiseHistoryAdd(line);
 457             if (config.historyfile) linenoiseHistorySave(config.historyfile);
 458             if (argv == NULL) {
 459                 printf("Invalid argument(s)\n");
 460                 continue;
 461             } else if (argc > 0) {
 462                 if (strcasecmp(argv[0],"quit") == 0 ||
 463                     strcasecmp(argv[0],"exit") == 0)
 464                         exit(0);
 465                 else
 466                     cliSendCommand(argc, argv, 1);
 467             }
 468             /* Free the argument vector */
 469             for (j = 0; j < argc; j++)
 470                 sdsfree(argv[j]);
 471             zfree(argv);
 472         }
 473         /* linenoise() returns malloc-ed lines like readline() */
 474         free(line);
 475     }
 476     exit(0);
 477 }
 478
 479 int main(int argc, char **argv) {
 480     int firstarg;
 481     char **argvcopy;
 482
 483     config.hostip = "127.0.0.1";
 484     config.hostport = 6379;
 485     config.repeat = 1;
 486     config.dbnum = 0;
 487     config.argn_from_stdin = 0;
 488     config.shutdown = 0;
 489     config.interactive = 0;
 490     config.monitor_mode = 0;
 491     config.pubsub_mode = 0;
 492     config.raw_output = 0;
 493     config.auth = NULL;
 494     config.historyfile = NULL;
 495     config.tty = 1;
 496
 497     if (getenv("HOME") != NULL) {
 498         config.historyfile = malloc(256);
 499         snprintf(config.historyfile,256,"%s/.rediscli_history",getenv("HOME"));
 500         linenoiseHistoryLoad(config.historyfile);
 501     }
 502
 503     firstarg = parseOptions(argc,argv);
 504     argc -= firstarg;
 505     argv += firstarg;
 506
 507     if (config.auth != NULL) {
 508         char *authargv[2];
 509
 510         authargv[0] = "AUTH";
 511         authargv[1] = config.auth;
 512         cliSendCommand(2, convertToSds(2, authargv), 1);
 513     }
 514
 515     if (argc == 0 || config.interactive == 1) {
 516         config.interactive = 1;
 517         repl();
 518     }
 519
 520     config.tty = isatty(stdout) || (getenv("FAKETTY") != NULL);
 521     argvcopy = convertToSds(argc+1, argv);
 522     if (config.argn_from_stdin) {
 523         sds lastarg = readArgFromStdin();
 524         argvcopy[argc] = lastarg;
 525         argc++;
 526     }
 527     return cliSendCommand(argc, argvcopy, config.repeat);
 528 }