redis-cli.c 24.8 KB
Newer Older
A
antirez 已提交
1 2
/* Redis CLI (command line interface)
 *
3
 * Copyright (c) 2009-2010, Salvatore Sanfilippo <antirez at gmail dot com>
A
antirez 已提交
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   * Redistributions of source code must retain the above copyright notice,
 *     this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *   * Neither the name of Redis nor the names of its contributors may be used
 *     to endorse or promote products derived from this software without
 *     specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

31
#include "fmacros.h"
32
#include "version.h"
33

A
antirez 已提交
34 35 36 37
#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <unistd.h>
38
#include <ctype.h>
39
#include <errno.h>
40
#include <sys/stat.h>
41
#include <sys/time.h>
42
#include <assert.h>
A
antirez 已提交
43

P
Pieter Noordhuis 已提交
44
#include "hiredis.h"
A
antirez 已提交
45 46
#include "sds.h"
#include "zmalloc.h"
47
#include "linenoise.h"
48
#include "help.h"
A
antirez 已提交
49 50 51

#define REDIS_NOTUSED(V) ((void) V)

P
Pieter Noordhuis 已提交
52
static redisContext *context;
A
antirez 已提交
53 54 55
static struct config {
    char *hostip;
    int hostport;
56
    char *hostsocket;
57
    long repeat;
58
    long interval;
I
ian 已提交
59
    int dbnum;
60
    int interactive;
61
    int shutdown;
62 63
    int monitor_mode;
    int pubsub_mode;
A
antirez 已提交
64
    int latency_mode;
65
    int stdinarg; /* get last arg from stdin. (-x option) */
A
antirez 已提交
66
    char *auth;
P
Pieter Noordhuis 已提交
67 68
    int raw_output; /* output mode per command */
    sds mb_delim;
69
    char prompt[32];
A
antirez 已提交
70 71
} config;

A
antirez 已提交
72
static void usage();
73
char *redisGitSHA1(void);
74
char *redisGitDirty(void);
75

76 77 78 79 80 81 82 83 84 85 86 87 88 89
/*------------------------------------------------------------------------------
 * Utility functions
 *--------------------------------------------------------------------------- */

static long long mstime(void) {
    struct timeval tv;
    long long mst;

    gettimeofday(&tv, NULL);
    mst = ((long)tv.tv_sec)*1000;
    mst += tv.tv_usec/1000;
    return mst;
}

90 91
static void cliRefreshPrompt(void) {
    if (config.dbnum == 0)
92 93
        snprintf(config.prompt,sizeof(config.prompt),"redis %s:%d> ",
            config.hostip, config.hostport);
94
    else
95 96
        snprintf(config.prompt,sizeof(config.prompt),"redis %s:%d[%d]> ",
            config.hostip, config.hostport, config.dbnum);
97 98
}

99 100 101 102
/*------------------------------------------------------------------------------
 * Help functions
 *--------------------------------------------------------------------------- */

103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118
#define CLI_HELP_COMMAND 1
#define CLI_HELP_GROUP 2

typedef struct {
    int type;
    int argc;
    sds *argv;
    sds full;

    /* Only used for help on commands */
    struct commandHelp *org;
} helpEntry;

static helpEntry *helpEntries;
static int helpEntriesLen;

119 120 121 122 123 124 125 126 127 128 129 130 131 132
static sds cliVersion() {
    sds version;
    version = sdscatprintf(sdsempty(), "%s", REDIS_VERSION);

    /* Add git commit and working tree status when available */
    if (strtoll(redisGitSHA1(),NULL,16)) {
        version = sdscatprintf(version, " (git:%s", redisGitSHA1());
        if (strtoll(redisGitDirty(),NULL,10))
            version = sdscatprintf(version, "-dirty");
        version = sdscat(version, ")");
    }
    return version;
}

133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
static void cliInitHelp() {
    int commandslen = sizeof(commandHelp)/sizeof(struct commandHelp);
    int groupslen = sizeof(commandGroups)/sizeof(char*);
    int i, len, pos = 0;
    helpEntry tmp;

    helpEntriesLen = len = commandslen+groupslen;
    helpEntries = malloc(sizeof(helpEntry)*len);

    for (i = 0; i < groupslen; i++) {
        tmp.argc = 1;
        tmp.argv = malloc(sizeof(sds));
        tmp.argv[0] = sdscatprintf(sdsempty(),"@%s",commandGroups[i]);
        tmp.full = tmp.argv[0];
        tmp.type = CLI_HELP_GROUP;
        tmp.org = NULL;
        helpEntries[pos++] = tmp;
    }

    for (i = 0; i < commandslen; i++) {
        tmp.argv = sdssplitargs(commandHelp[i].name,&tmp.argc);
        tmp.full = sdsnew(commandHelp[i].name);
        tmp.type = CLI_HELP_COMMAND;
        tmp.org = &commandHelp[i];
        helpEntries[pos++] = tmp;
    }
}

161
/* Output command help to stdout. */
162 163 164 165 166 167 168
static void cliOutputCommandHelp(struct commandHelp *help, int group) {
    printf("\r\n  \x1b[1m%s\x1b[0m \x1b[90m%s\x1b[0m\r\n", help->name, help->params);
    printf("  \x1b[33msummary:\x1b[0m %s\r\n", help->summary);
    printf("  \x1b[33msince:\x1b[0m %s\r\n", help->since);
    if (group) {
        printf("  \x1b[33mgroup:\x1b[0m %s\r\n", commandGroups[help->group]);
    }
169 170
}

171 172
/* Print generic help. */
static void cliOutputGenericHelp() {
173
    sds version = cliVersion();
174 175 176 177 178 179
    printf(
        "redis-cli %s\r\n"
        "Type: \"help @<group>\" to get a list of commands in <group>\r\n"
        "      \"help <command>\" for help on <command>\r\n"
        "      \"help <tab>\" to get a list of possible help topics\r\n"
        "      \"quit\" to exit\r\n",
180
        version
181
    );
182
    sdsfree(version);
183 184 185
}

/* Output all command help, filtering by group or command name. */
186
static void cliOutputHelp(int argc, char **argv) {
187
    int i, j, len;
188
    int group = -1;
189 190
    helpEntry *entry;
    struct commandHelp *help;
191

192 193
    if (argc == 0) {
        cliOutputGenericHelp();
194
        return;
195 196 197 198 199 200 201 202
    } else if (argc > 0 && argv[0][0] == '@') {
        len = sizeof(commandGroups)/sizeof(char*);
        for (i = 0; i < len; i++) {
            if (strcasecmp(argv[0]+1,commandGroups[i]) == 0) {
                group = i;
                break;
            }
        }
203 204
    }

205
    assert(argc > 0);
206 207 208 209 210
    for (i = 0; i < helpEntriesLen; i++) {
        entry = &helpEntries[i];
        if (entry->type != CLI_HELP_COMMAND) continue;

        help = entry->org;
211
        if (group == -1) {
212 213 214 215 216 217 218 219
            /* Compare all arguments */
            if (argc == entry->argc) {
                for (j = 0; j < argc; j++) {
                    if (strcasecmp(argv[j],entry->argv[j]) != 0) break;
                }
                if (j == argc) {
                    cliOutputCommandHelp(help,1);
                }
220 221 222
            }
        } else {
            if (group == help->group) {
223
                cliOutputCommandHelp(help,0);
224 225 226
            }
        }
    }
227 228 229 230 231 232 233 234
    printf("\r\n");
}

static void completionCallback(const char *buf, linenoiseCompletions *lc) {
    size_t startpos = 0;
    int mask;
    int i;
    size_t matchlen;
235
    sds tmp;
236 237 238 239

    if (strncasecmp(buf,"help ",5) == 0) {
        startpos = 5;
        while (isspace(buf[startpos])) startpos++;
240
        mask = CLI_HELP_COMMAND | CLI_HELP_GROUP;
241
    } else {
242
        mask = CLI_HELP_COMMAND;
243 244
    }

245 246
    for (i = 0; i < helpEntriesLen; i++) {
        if (!(helpEntries[i].type & mask)) continue;
247 248

        matchlen = strlen(buf+startpos);
249 250 251
        if (strncasecmp(buf+startpos,helpEntries[i].full,matchlen) == 0) {
            tmp = sdsnewlen(buf,startpos);
            tmp = sdscat(tmp,helpEntries[i].full);
252
            linenoiseAddCompletion(lc,tmp);
253
            sdsfree(tmp);
254 255
        }
    }
256 257
}

258 259 260 261
/*------------------------------------------------------------------------------
 * Networking / parsing
 *--------------------------------------------------------------------------- */

P
Pieter Noordhuis 已提交
262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279
/* Send AUTH command to the server */
static int cliAuth() {
    redisReply *reply;
    if (config.auth == NULL) return REDIS_OK;

    reply = redisCommand(context,"AUTH %s",config.auth);
    if (reply != NULL) {
        freeReplyObject(reply);
        return REDIS_OK;
    }
    return REDIS_ERR;
}

/* Send SELECT dbnum to the server */
static int cliSelect() {
    redisReply *reply;
    if (config.dbnum == 0) return REDIS_OK;

280
    reply = redisCommand(context,"SELECT %d",config.dbnum);
P
Pieter Noordhuis 已提交
281 282 283 284 285 286 287
    if (reply != NULL) {
        freeReplyObject(reply);
        return REDIS_OK;
    }
    return REDIS_ERR;
}

288 289 290
/* Connect to the client. If force is not zero the connection is performed
 * even if there is already a connected socket. */
static int cliConnect(int force) {
P
Pieter Noordhuis 已提交
291 292 293
    if (context == NULL || force) {
        if (context != NULL)
            redisFree(context);
A
antirez 已提交
294

295
        if (config.hostsocket == NULL) {
P
Pieter Noordhuis 已提交
296
            context = redisConnect(config.hostip,config.hostport);
297
        } else {
P
Pieter Noordhuis 已提交
298
            context = redisConnectUnix(config.hostsocket);
299
        }
P
Pieter Noordhuis 已提交
300 301

        if (context->err) {
302 303
            fprintf(stderr,"Could not connect to Redis at ");
            if (config.hostsocket == NULL)
P
Pieter Noordhuis 已提交
304
                fprintf(stderr,"%s:%d: %s\n",config.hostip,config.hostport,context->errstr);
305
            else
P
Pieter Noordhuis 已提交
306 307 308 309
                fprintf(stderr,"%s: %s\n",config.hostsocket,context->errstr);
            redisFree(context);
            context = NULL;
            return REDIS_ERR;
310
        }
A
antirez 已提交
311

P
Pieter Noordhuis 已提交
312 313 314 315 316
        /* Do AUTH and select the right DB. */
        if (cliAuth() != REDIS_OK)
            return REDIS_ERR;
        if (cliSelect() != REDIS_OK)
            return REDIS_ERR;
A
antirez 已提交
317
    }
P
Pieter Noordhuis 已提交
318
    return REDIS_OK;
A
antirez 已提交
319 320
}

321
static void cliPrintContextError() {
P
Pieter Noordhuis 已提交
322 323
    if (context == NULL) return;
    fprintf(stderr,"Error: %s\n",context->errstr);
A
antirez 已提交
324 325
}

P
Pieter Noordhuis 已提交
326
static sds cliFormatReplyTTY(redisReply *r, char *prefix) {
P
Pieter Noordhuis 已提交
327 328 329
    sds out = sdsempty();
    switch (r->type) {
    case REDIS_REPLY_ERROR:
P
Pieter Noordhuis 已提交
330
        out = sdscatprintf(out,"(error) %s\n", r->str);
P
Pieter Noordhuis 已提交
331 332 333 334 335 336
    break;
    case REDIS_REPLY_STATUS:
        out = sdscat(out,r->str);
        out = sdscat(out,"\n");
    break;
    case REDIS_REPLY_INTEGER:
P
Pieter Noordhuis 已提交
337
        out = sdscatprintf(out,"(integer) %lld\n",r->integer);
P
Pieter Noordhuis 已提交
338 339
    break;
    case REDIS_REPLY_STRING:
P
Pieter Noordhuis 已提交
340 341 342 343
        /* If you are producing output for the standard output we want
        * a more interesting output with quoted characters and so forth */
        out = sdscatrepr(out,r->str,r->len);
        out = sdscat(out,"\n");
P
Pieter Noordhuis 已提交
344 345 346 347 348 349 350
    break;
    case REDIS_REPLY_NIL:
        out = sdscat(out,"(nil)\n");
    break;
    case REDIS_REPLY_ARRAY:
        if (r->elements == 0) {
            out = sdscat(out,"(empty list or set)\n");
351
        } else {
352 353 354 355
            unsigned int i, idxlen = 0;
            char _prefixlen[16];
            char _prefixfmt[16];
            sds _prefix;
P
Pieter Noordhuis 已提交
356 357
            sds tmp;

358 359 360 361 362 363 364 365 366 367 368 369 370 371 372
            /* Calculate chars needed to represent the largest index */
            i = r->elements;
            do {
                idxlen++;
                i /= 10;
            } while(i);

            /* Prefix for nested multi bulks should grow with idxlen+2 spaces */
            memset(_prefixlen,' ',idxlen+2);
            _prefixlen[idxlen+2] = '\0';
            _prefix = sdscat(sdsnew(prefix),_prefixlen);

            /* Setup prefix format for every entry */
            snprintf(_prefixfmt,sizeof(_prefixfmt),"%%s%%%dd) ",idxlen);

P
Pieter Noordhuis 已提交
373
            for (i = 0; i < r->elements; i++) {
374 375 376 377 378
                /* Don't use the prefix for the first element, as the parent
                 * caller already prepended the index number. */
                out = sdscatprintf(out,_prefixfmt,i == 0 ? "" : prefix,i+1);

                /* Format the multi bulk entry */
P
Pieter Noordhuis 已提交
379
                tmp = cliFormatReplyTTY(r->element[i],_prefix);
P
Pieter Noordhuis 已提交
380 381 382
                out = sdscatlen(out,tmp,sdslen(tmp));
                sdsfree(tmp);
            }
383
            sdsfree(_prefix);
384
        }
P
Pieter Noordhuis 已提交
385
    break;
386
    default:
P
Pieter Noordhuis 已提交
387 388
        fprintf(stderr,"Unknown reply type: %d\n", r->type);
        exit(1);
389
    }
P
Pieter Noordhuis 已提交
390
    return out;
391 392
}

P
Pieter Noordhuis 已提交
393 394 395 396 397 398 399
static sds cliFormatReplyRaw(redisReply *r) {
    sds out = sdsempty(), tmp;
    size_t i;

    switch (r->type) {
    case REDIS_REPLY_NIL:
        /* Nothing... */
400
        break;
P
Pieter Noordhuis 已提交
401
    case REDIS_REPLY_ERROR:
402 403 404
        out = sdscatlen(out,r->str,r->len);
        out = sdscatlen(out,"\n",1);
        break;
P
Pieter Noordhuis 已提交
405 406 407
    case REDIS_REPLY_STATUS:
    case REDIS_REPLY_STRING:
        out = sdscatlen(out,r->str,r->len);
408
        break;
P
Pieter Noordhuis 已提交
409 410
    case REDIS_REPLY_INTEGER:
        out = sdscatprintf(out,"%lld",r->integer);
411
        break;
P
Pieter Noordhuis 已提交
412 413 414 415 416 417 418
    case REDIS_REPLY_ARRAY:
        for (i = 0; i < r->elements; i++) {
            if (i > 0) out = sdscat(out,config.mb_delim);
            tmp = cliFormatReplyRaw(r->element[i]);
            out = sdscatlen(out,tmp,sdslen(tmp));
            sdsfree(tmp);
        }
419
        break;
P
Pieter Noordhuis 已提交
420 421 422 423 424 425 426 427
    default:
        fprintf(stderr,"Unknown reply type: %d\n", r->type);
        exit(1);
    }
    return out;
}

static int cliReadReply(int output_raw_strings) {
428
    void *_reply;
P
Pieter Noordhuis 已提交
429 430 431
    redisReply *reply;
    sds out;

432
    if (redisGetReply(context,&_reply) != REDIS_OK) {
P
Pieter Noordhuis 已提交
433 434 435 436 437 438 439 440 441
        if (config.shutdown)
            return REDIS_OK;
        if (config.interactive) {
            /* Filter cases where we should reconnect */
            if (context->err == REDIS_ERR_IO && errno == ECONNRESET)
                return REDIS_ERR;
            if (context->err == REDIS_ERR_EOF)
                return REDIS_ERR;
        }
442 443
        cliPrintContextError();
        exit(1);
P
Pieter Noordhuis 已提交
444
        return REDIS_ERR; /* avoid compiler warning */
I
ian 已提交
445
    }
P
Pieter Noordhuis 已提交
446

447
    reply = (redisReply*)_reply;
P
Pieter Noordhuis 已提交
448 449 450 451 452 453 454 455 456 457
    if (output_raw_strings) {
        out = cliFormatReplyRaw(reply);
    } else {
        if (config.raw_output) {
            out = cliFormatReplyRaw(reply);
            out = sdscat(out,"\n");
        } else {
            out = cliFormatReplyTTY(reply,"");
        }
    }
P
Pieter Noordhuis 已提交
458 459
    fwrite(out,sdslen(out),1,stdout);
    sdsfree(out);
P
Pieter Noordhuis 已提交
460
    freeReplyObject(reply);
P
Pieter Noordhuis 已提交
461
    return REDIS_OK;
I
ian 已提交
462 463
}

464
static int cliSendCommand(int argc, char **argv, int repeat) {
465
    char *command = argv[0];
P
Pieter Noordhuis 已提交
466
    size_t *argvlen;
P
Pieter Noordhuis 已提交
467
    int j, output_raw;
A
antirez 已提交
468

469 470 471 472 473 474 475 476 477
    if (context == NULL) return REDIS_ERR;

    output_raw = 0;
    if (!strcasecmp(command,"info") ||
        (argc == 2 && !strcasecmp(command,"client") &&
                       !strcasecmp(argv[1],"list")))

    {
        output_raw = 1;
A
antirez 已提交
478 479
    }

480 481
    if (!strcasecmp(command,"help") || !strcasecmp(command,"?")) {
        cliOutputHelp(--argc, ++argv);
P
Pieter Noordhuis 已提交
482
        return REDIS_OK;
483
    }
484 485 486 487
    if (!strcasecmp(command,"shutdown")) config.shutdown = 1;
    if (!strcasecmp(command,"monitor")) config.monitor_mode = 1;
    if (!strcasecmp(command,"subscribe") ||
        !strcasecmp(command,"psubscribe")) config.pubsub_mode = 1;
A
antirez 已提交
488

P
Pieter Noordhuis 已提交
489 490 491 492
    /* Setup argument length */
    argvlen = malloc(argc*sizeof(size_t));
    for (j = 0; j < argc; j++)
        argvlen[j] = sdslen(argv[j]);
493

494
    while(repeat--) {
P
Pieter Noordhuis 已提交
495
        redisAppendCommandArgv(context,argc,(const char**)argv,argvlen);
496
        while (config.monitor_mode) {
P
Pieter Noordhuis 已提交
497
            if (cliReadReply(output_raw) != REDIS_OK) exit(1);
498
            fflush(stdout);
499 500
        }

501
        if (config.pubsub_mode) {
P
Pieter Noordhuis 已提交
502 503
            if (!config.raw_output)
                printf("Reading messages... (press Ctrl-C to quit)\n");
504
            while (1) {
P
Pieter Noordhuis 已提交
505
                if (cliReadReply(output_raw) != REDIS_OK) exit(1);
506 507 508
            }
        }

509 510
        if (cliReadReply(output_raw) != REDIS_OK) {
            free(argvlen);
P
Pieter Noordhuis 已提交
511
            return REDIS_ERR;
512 513
        } else {
            /* Store database number when SELECT was successfully executed. */
514
            if (!strcasecmp(command,"select") && argc == 2) {
515
                config.dbnum = atoi(argv[1]);
516 517
                cliRefreshPrompt();
            }
518
        }
519 520
        if (config.interval) usleep(config.interval);
        fflush(stdout); /* Make it grep friendly */
A
antirez 已提交
521
    }
522 523

    free(argvlen);
P
Pieter Noordhuis 已提交
524
    return REDIS_OK;
A
antirez 已提交
525 526
}

527 528 529 530
/*------------------------------------------------------------------------------
 * User interface
 *--------------------------------------------------------------------------- */

A
antirez 已提交
531 532 533 534 535
static int parseOptions(int argc, char **argv) {
    int i;

    for (i = 1; i < argc; i++) {
        int lastarg = i==argc-1;
536

A
antirez 已提交
537
        if (!strcmp(argv[i],"-h") && !lastarg) {
A
antirez 已提交
538 539
            sdsfree(config.hostip);
            config.hostip = sdsnew(argv[i+1]);
A
antirez 已提交
540
            i++;
A
antirez 已提交
541 542
        } else if (!strcmp(argv[i],"-h") && lastarg) {
            usage();
543 544
        } else if (!strcmp(argv[i],"--help")) {
            usage();
545 546
        } else if (!strcmp(argv[i],"-x")) {
            config.stdinarg = 1;
A
antirez 已提交
547 548 549
        } else if (!strcmp(argv[i],"-p") && !lastarg) {
            config.hostport = atoi(argv[i+1]);
            i++;
550 551 552
        } else if (!strcmp(argv[i],"-s") && !lastarg) {
            config.hostsocket = argv[i+1];
            i++;
553 554 555
        } else if (!strcmp(argv[i],"-r") && !lastarg) {
            config.repeat = strtoll(argv[i+1],NULL,10);
            i++;
556 557 558 559
        } else if (!strcmp(argv[i],"-i") && !lastarg) {
            double seconds = atof(argv[i+1]);
            config.interval = seconds*1000000;
            i++;
I
ian 已提交
560 561 562
        } else if (!strcmp(argv[i],"-n") && !lastarg) {
            config.dbnum = atoi(argv[i+1]);
            i++;
563
        } else if (!strcmp(argv[i],"-a") && !lastarg) {
A
antirez 已提交
564
            config.auth = argv[i+1];
565
            i++;
P
Pieter Noordhuis 已提交
566 567
        } else if (!strcmp(argv[i],"--raw")) {
            config.raw_output = 1;
A
antirez 已提交
568 569
        } else if (!strcmp(argv[i],"--latency")) {
            config.latency_mode = 1;
570 571 572 573
        } else if (!strcmp(argv[i],"-d") && !lastarg) {
            sdsfree(config.mb_delim);
            config.mb_delim = sdsnew(argv[i+1]);
            i++;
574 575 576 577
        } else if (!strcmp(argv[i],"-v") || !strcmp(argv[i], "--version")) {
            sds version = cliVersion();
            printf("redis-cli %s\n", version);
            sdsfree(version);
578
            exit(0);
A
antirez 已提交
579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602
        } else {
            break;
        }
    }
    return i;
}

static sds readArgFromStdin(void) {
    char buf[1024];
    sds arg = sdsempty();

    while(1) {
        int nread = read(fileno(stdin),buf,1024);

        if (nread == 0) break;
        else if (nread == -1) {
            perror("Reading from standard input");
            exit(1);
        }
        arg = sdscatlen(arg,buf,nread);
    }
    return arg;
}

A
antirez 已提交
603
static void usage() {
604 605 606 607 608 609 610 611 612 613
    sds version = cliVersion();
    fprintf(stderr,
"redis-cli %s\n"
"\n"
"Usage: redis-cli [OPTIONS] [cmd [arg [arg ...]]]\n"
"  -h <hostname>    Server hostname (default: 127.0.0.1)\n"
"  -p <port>        Server port (default: 6379)\n"
"  -s <socket>      Server socket (overrides hostname and port)\n"
"  -a <password>    Password to use when connecting to the server\n"
"  -r <repeat>      Execute specified command N times\n"
614 615
"  -i <interval>    When -r is used, waits <interval> seconds per command.\n"
"                   It is possible to specify sub-second times like -i 0.1.\n"
616 617
"  -n <db>          Database number\n"
"  -x               Read last argument from STDIN\n"
618
"  -d <delimiter>   Multi-bulk delimiter in for raw formatting (default: \\n)\n"
P
Pieter Noordhuis 已提交
619
"  --raw            Use raw formatting for replies (default when STDOUT is not a tty)\n"
A
antirez 已提交
620
"  --latency        Enter a special mode continuously sampling latency.\n"
621 622 623 624 625 626 627
"  --help           Output this help and exit\n"
"  --version        Output version and exit\n"
"\n"
"Examples:\n"
"  cat /etc/passwd | redis-cli -x set mypasswd\n"
"  redis-cli get mypasswd\n"
"  redis-cli -r 100 lpush mylist x\n"
628
"  redis-cli -r 100 -i 1 info | grep used_memory_human:\n"
629 630 631 632 633 634
"\n"
"When no command is given, redis-cli starts in interactive mode.\n"
"Type \"help\" in interactive mode for information on available commands.\n"
"\n",
        version);
    sdsfree(version);
A
antirez 已提交
635 636 637
    exit(1);
}

638 639 640
/* Turn the plain C strings into Sds strings */
static char **convertToSds(int count, char** args) {
  int j;
641
  char **sds = zmalloc(sizeof(char*)*count);
642 643 644 645 646 647 648

  for(j = 0; j < count; j++)
    sds[j] = sdsnew(args[j]);

  return sds;
}

649
#define LINE_BUFLEN 4096
650
static void repl() {
651 652
    sds historyfile = NULL;
    int history = 0;
653
    char *line;
654
    int argc;
655
    sds *argv;
656

657
    config.interactive = 1;
658
    linenoiseSetCompletionCallback(completionCallback);
659

660 661 662 663 664 665 666 667 668 669
    /* Only use history when stdin is a tty. */
    if (isatty(fileno(stdin))) {
        history = 1;

        if (getenv("HOME") != NULL) {
            historyfile = sdscatprintf(sdsempty(),"%s/.rediscli_history",getenv("HOME"));
            linenoiseHistoryLoad(historyfile);
        }
    }

670 671
    cliRefreshPrompt();
    while((line = linenoise(context ? config.prompt : "not connected> ")) != NULL) {
672
        if (line[0] != '\0') {
673
            argv = sdssplitargs(line,&argc);
674 675 676
            if (history) linenoiseHistoryAdd(line);
            if (historyfile) linenoiseHistorySave(historyfile);

677 678 679 680
            if (argv == NULL) {
                printf("Invalid argument(s)\n");
                continue;
            } else if (argc > 0) {
681 682
                if (strcasecmp(argv[0],"quit") == 0 ||
                    strcasecmp(argv[0],"exit") == 0)
683 684
                {
                    exit(0);
A
antirez 已提交
685 686 687 688 689
                } else if (argc == 3 && !strcasecmp(argv[0],"connect")) {
                    sdsfree(config.hostip);
                    config.hostip = sdsnew(argv[1]);
                    config.hostport = atoi(argv[2]);
                    cliConnect(1);
690 691
                } else if (argc == 1 && !strcasecmp(argv[0],"clear")) {
                    linenoiseClearScreen();
692
                } else {
693
                    long long start_time = mstime(), elapsed;
694
                    int repeat, skipargs = 0;
695

696 697 698 699 700 701 702 703 704 705
                    repeat = atoi(argv[0]);
                    if (repeat) {
                        skipargs = 1;
                    } else {
                        repeat = 1;
                    }

                    if (cliSendCommand(argc-skipargs,argv+skipargs,repeat)
                        != REDIS_OK)
                    {
A
antirez 已提交
706
                        cliConnect(1);
P
Pieter Noordhuis 已提交
707

708 709 710 711 712
                        /* If we still cannot send the command print error.
                         * We'll try to reconnect the next time. */
                        if (cliSendCommand(argc-skipargs,argv+skipargs,repeat)
                            != REDIS_OK)
                            cliPrintContextError();
713
                    }
714
                    elapsed = mstime()-start_time;
P
Pieter Noordhuis 已提交
715 716 717
                    if (elapsed >= 500) {
                        printf("(%.2fs)\n",(double)elapsed/1000);
                    }
718
                }
719 720
            }
            /* Free the argument vector */
721
            while(argc--) sdsfree(argv[argc]);
722
            zfree(argv);
723
        }
724
        /* linenoise() returns malloc-ed lines like readline() */
725
        free(line);
726 727 728 729
    }
    exit(0);
}

730 731
static int noninteractive(int argc, char **argv) {
    int retval = 0;
732
    if (config.stdinarg) {
733 734 735 736 737 738 739 740 741 742
        argv = zrealloc(argv, (argc+1)*sizeof(char*));
        argv[argc] = readArgFromStdin();
        retval = cliSendCommand(argc+1, argv, config.repeat);
    } else {
        /* stdin is probably a tty, can be tested with S_ISCHR(s.st_mode) */
        retval = cliSendCommand(argc, argv, config.repeat);
    }
    return retval;
}

A
antirez 已提交
743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764
static void latencyMode(void) {
    redisReply *reply;
    long long start, latency, min, max, tot, count = 0;
    double avg;

    if (!context) exit(1);
    while(1) {
        start = mstime();
        reply = redisCommand(context,"PING");
        if (reply == NULL) {
            fprintf(stderr,"\nI/O error\n");
            exit(1);
        }
        latency = mstime()-start;
        freeReplyObject(reply);
        count++;
        if (count == 1) {
            min = max = tot = latency;
            avg = (double) latency;
        } else {
            if (latency < min) min = latency;
            if (latency > max) max = latency;
765
            tot += latency;
A
antirez 已提交
766 767 768 769 770 771 772 773 774
            avg = (double) tot/count;
        }
        printf("\x1b[0G\x1b[2Kmin: %lld, max: %lld, avg: %.2f (%lld samples)",
            min, max, avg, count);
        fflush(stdout);
        usleep(10000);
    }
}

A
antirez 已提交
775
int main(int argc, char **argv) {
776
    int firstarg;
A
antirez 已提交
777

A
antirez 已提交
778
    config.hostip = sdsnew("127.0.0.1");
A
antirez 已提交
779
    config.hostport = 6379;
780
    config.hostsocket = NULL;
781
    config.repeat = 1;
782
    config.interval = 0;
I
ian 已提交
783
    config.dbnum = 0;
784
    config.interactive = 0;
785
    config.shutdown = 0;
786 787
    config.monitor_mode = 0;
    config.pubsub_mode = 0;
A
antirez 已提交
788
    config.latency_mode = 0;
789
    config.stdinarg = 0;
A
antirez 已提交
790
    config.auth = NULL;
P
Pieter Noordhuis 已提交
791 792
    config.raw_output = !isatty(fileno(stdout)) && (getenv("FAKETTY") == NULL);
    config.mb_delim = sdsnew("\n");
793
    cliInitHelp();
794

A
antirez 已提交
795 796 797 798
    firstarg = parseOptions(argc,argv);
    argc -= firstarg;
    argv += firstarg;

A
antirez 已提交
799 800 801 802 803 804
    /* Start in latency mode if appropriate */
    if (config.latency_mode) {
        cliConnect(0);
        latencyMode();
    }

805
    /* Start interactive mode when no command is provided */
806 807 808 809 810 811 812
    if (argc == 0) {
        /* Note that in repl mode we don't abort on connection error.
         * A new attempt will be performed for every command send. */
        cliConnect(0);
        repl();
    }

813
    /* Otherwise, we have some arguments to execute */
814
    if (cliConnect(0) != REDIS_OK) exit(1);
815
    return noninteractive(argc,convertToSds(argc,argv));
A
antirez 已提交
816
}