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