]> git.saurik.com Git - redis.git/blame - redis-cli.c
TODO changes and mostly theoretical minor skiplist change
[redis.git] / redis-cli.c
CommitLineData
ed9b544e 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
23d4709d 31#include "fmacros.h"
32
ed9b544e 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
8165a5f2 45#define REDIS_CMD_MULTIBULK 3
ed9b544e 46
47#define REDIS_NOTUSED(V) ((void) V)
48
49static struct config {
50 char *hostip;
51 int hostport;
52} config;
53
54struct redisCommand {
55 char *name;
56 int arity;
57 int flags;
58};
59
60static struct redisCommand cmdTable[] = {
c937aa89 61 {"get",2,REDIS_CMD_INLINE},
62 {"set",3,REDIS_CMD_BULK},
63 {"setnx",3,REDIS_CMD_BULK},
5109cdff 64 {"del",-2,REDIS_CMD_INLINE},
c937aa89 65 {"exists",2,REDIS_CMD_INLINE},
66 {"incr",2,REDIS_CMD_INLINE},
67 {"decr",2,REDIS_CMD_INLINE},
68 {"rpush",3,REDIS_CMD_BULK},
69 {"lpush",3,REDIS_CMD_BULK},
70 {"rpop",2,REDIS_CMD_INLINE},
71 {"lpop",2,REDIS_CMD_INLINE},
72 {"llen",2,REDIS_CMD_INLINE},
73 {"lindex",3,REDIS_CMD_INLINE},
74 {"lset",4,REDIS_CMD_BULK},
75 {"lrange",4,REDIS_CMD_INLINE},
76 {"ltrim",4,REDIS_CMD_INLINE},
77 {"lrem",4,REDIS_CMD_BULK},
78 {"sadd",3,REDIS_CMD_BULK},
79 {"srem",3,REDIS_CMD_BULK},
a4460ef4 80 {"smove",4,REDIS_CMD_BULK},
c937aa89 81 {"sismember",3,REDIS_CMD_BULK},
82 {"scard",2,REDIS_CMD_INLINE},
12fea928 83 {"spop",2,REDIS_CMD_INLINE},
2abb95a9 84 {"srandmember",2,REDIS_CMD_INLINE},
c937aa89 85 {"sinter",-2,REDIS_CMD_INLINE},
86 {"sinterstore",-3,REDIS_CMD_INLINE},
40d224a9 87 {"sunion",-2,REDIS_CMD_INLINE},
88 {"sunionstore",-3,REDIS_CMD_INLINE},
f4f56e1d 89 {"sdiff",-2,REDIS_CMD_INLINE},
90 {"sdiffstore",-3,REDIS_CMD_INLINE},
c937aa89 91 {"smembers",2,REDIS_CMD_INLINE},
fd8ccf44 92 {"zadd",4,REDIS_CMD_BULK},
1b7106e7 93 {"zrem",3,REDIS_CMD_BULK},
cc812361 94 {"zrange",4,REDIS_CMD_INLINE},
50c55df5 95 {"zrangebyscore",4,REDIS_CMD_INLINE},
e3870fab 96 {"zrevrange",4,REDIS_CMD_INLINE},
3c41331e 97 {"zcard",2,REDIS_CMD_INLINE},
6e333bbe 98 {"zscore",3,REDIS_CMD_BULK},
c937aa89 99 {"incrby",3,REDIS_CMD_INLINE},
100 {"decrby",3,REDIS_CMD_INLINE},
a431eb74 101 {"getset",3,REDIS_CMD_BULK},
c937aa89 102 {"randomkey",1,REDIS_CMD_INLINE},
103 {"select",2,REDIS_CMD_INLINE},
104 {"move",3,REDIS_CMD_INLINE},
105 {"rename",3,REDIS_CMD_INLINE},
106 {"renamenx",3,REDIS_CMD_INLINE},
107 {"keys",2,REDIS_CMD_INLINE},
108 {"dbsize",1,REDIS_CMD_INLINE},
109 {"ping",1,REDIS_CMD_INLINE},
110 {"echo",2,REDIS_CMD_BULK},
111 {"save",1,REDIS_CMD_INLINE},
112 {"bgsave",1,REDIS_CMD_INLINE},
113 {"shutdown",1,REDIS_CMD_INLINE},
114 {"lastsave",1,REDIS_CMD_INLINE},
115 {"type",2,REDIS_CMD_INLINE},
116 {"flushdb",1,REDIS_CMD_INLINE},
117 {"flushall",1,REDIS_CMD_INLINE},
118 {"sort",-2,REDIS_CMD_INLINE},
119 {"info",1,REDIS_CMD_INLINE},
120 {"mget",-2,REDIS_CMD_INLINE},
3305306f 121 {"expire",3,REDIS_CMD_INLINE},
fd88489a 122 {"ttl",2,REDIS_CMD_INLINE},
321b0e13 123 {"slaveof",3,REDIS_CMD_INLINE},
333298da 124 {"debug",-2,REDIS_CMD_INLINE},
8165a5f2 125 {"mset",-3,REDIS_CMD_MULTIBULK},
126 {"msetnx",-3,REDIS_CMD_MULTIBULK},
ed9b544e 127 {NULL,0,0}
128};
129
c937aa89 130static int cliReadReply(int fd);
131
ed9b544e 132static struct redisCommand *lookupCommand(char *name) {
133 int j = 0;
134 while(cmdTable[j].name != NULL) {
135 if (!strcasecmp(name,cmdTable[j].name)) return &cmdTable[j];
136 j++;
137 }
138 return NULL;
139}
140
141static int cliConnect(void) {
142 char err[ANET_ERR_LEN];
143 int fd;
144
145 fd = anetTcpConnect(err,config.hostip,config.hostport);
146 if (fd == ANET_ERR) {
147 fprintf(stderr,"Connect: %s\n",err);
148 return -1;
149 }
150 anetTcpNoDelay(NULL,fd);
151 return fd;
152}
153
154static sds cliReadLine(int fd) {
155 sds line = sdsempty();
156
157 while(1) {
158 char c;
b91f03a4 159 ssize_t ret;
ed9b544e 160
b91f03a4
LH
161 ret = read(fd,&c,1);
162 if (ret == -1) {
ed9b544e 163 sdsfree(line);
164 return NULL;
b91f03a4 165 } else if ((ret == 0) || (c == '\n')) {
ed9b544e 166 break;
167 } else {
168 line = sdscatlen(line,&c,1);
169 }
170 }
171 return sdstrim(line,"\r\n");
172}
173
c937aa89 174static int cliReadSingleLineReply(int fd) {
ed9b544e 175 sds reply = cliReadLine(fd);
176
177 if (reply == NULL) return 1;
178 printf("%s\n", reply);
ed9b544e 179 return 0;
180}
181
c937aa89 182static int cliReadBulkReply(int fd) {
ed9b544e 183 sds replylen = cliReadLine(fd);
184 char *reply, crlf[2];
c937aa89 185 int bulklen;
ed9b544e 186
187 if (replylen == NULL) return 1;
ed9b544e 188 bulklen = atoi(replylen);
c937aa89 189 if (bulklen == -1) {
ed9b544e 190 sdsfree(replylen);
191 printf("(nil)");
192 return 0;
193 }
ed9b544e 194 reply = zmalloc(bulklen);
195 anetRead(fd,reply,bulklen);
196 anetRead(fd,crlf,2);
197 if (bulklen && fwrite(reply,bulklen,1,stdout) == 0) {
198 zfree(reply);
199 return 1;
200 }
c937aa89 201 if (isatty(fileno(stdout)) && reply[bulklen-1] != '\n')
ed9b544e 202 printf("\n");
203 zfree(reply);
c937aa89 204 return 0;
ed9b544e 205}
206
207static int cliReadMultiBulkReply(int fd) {
208 sds replylen = cliReadLine(fd);
209 int elements, c = 1;
210
211 if (replylen == NULL) return 1;
c937aa89 212 elements = atoi(replylen);
213 if (elements == -1) {
ed9b544e 214 sdsfree(replylen);
215 printf("(nil)\n");
216 return 0;
217 }
c937aa89 218 if (elements == 0) {
219 printf("(empty list or set)\n");
220 }
ed9b544e 221 while(elements--) {
222 printf("%d. ", c);
c937aa89 223 if (cliReadReply(fd)) return 1;
ed9b544e 224 c++;
225 }
226 return 0;
227}
228
c937aa89 229static int cliReadReply(int fd) {
230 char type;
231
232 if (anetRead(fd,&type,1) <= 0) exit(1);
233 switch(type) {
234 case '-':
235 printf("(error) ");
236 cliReadSingleLineReply(fd);
237 return 1;
238 case '+':
239 case ':':
240 return cliReadSingleLineReply(fd);
241 case '$':
242 return cliReadBulkReply(fd);
243 case '*':
244 return cliReadMultiBulkReply(fd);
245 default:
246 printf("protocol error, got '%c' as reply type byte\n", type);
247 return 1;
248 }
249}
250
ed9b544e 251static int cliSendCommand(int argc, char **argv) {
252 struct redisCommand *rc = lookupCommand(argv[0]);
253 int fd, j, retval = 0;
254 sds cmd = sdsempty();
255
256 if (!rc) {
257 fprintf(stderr,"Unknown command '%s'\n",argv[0]);
258 return 1;
259 }
260
261 if ((rc->arity > 0 && argc != rc->arity) ||
a74f2af6 262 (rc->arity < 0 && argc < -rc->arity)) {
ed9b544e 263 fprintf(stderr,"Wrong number of arguments for '%s'\n",rc->name);
264 return 1;
265 }
266 if ((fd = cliConnect()) == -1) return 1;
267
268 /* Build the command to send */
8165a5f2 269 if (rc->flags & REDIS_CMD_MULTIBULK) {
270 cmd = sdscatprintf(cmd,"*%d\r\n",argc);
271 for (j = 0; j < argc; j++) {
272 cmd = sdscatprintf(cmd,"$%d\r\n",sdslen(argv[j]));
ed9b544e 273 cmd = sdscatlen(cmd,argv[j],sdslen(argv[j]));
8165a5f2 274 cmd = sdscatlen(cmd,"\r\n",2);
275 }
276 } else {
277 for (j = 0; j < argc; j++) {
278 if (j != 0) cmd = sdscat(cmd," ");
279 if (j == argc-1 && rc->flags & REDIS_CMD_BULK) {
280 cmd = sdscatprintf(cmd,"%d",sdslen(argv[j]));
281 } else {
282 cmd = sdscatlen(cmd,argv[j],sdslen(argv[j]));
283 }
ed9b544e 284 }
ed9b544e 285 cmd = sdscat(cmd,"\r\n");
8165a5f2 286 if (rc->flags & REDIS_CMD_BULK) {
287 cmd = sdscatlen(cmd,argv[argc-1],sdslen(argv[argc-1]));
288 cmd = sdscatlen(cmd,"\r\n",2);
289 }
ed9b544e 290 }
291 anetWrite(fd,cmd,sdslen(cmd));
c937aa89 292 retval = cliReadReply(fd);
ed9b544e 293 if (retval) {
294 close(fd);
295 return retval;
296 }
297 close(fd);
298 return 0;
299}
300
301static int parseOptions(int argc, char **argv) {
302 int i;
303
304 for (i = 1; i < argc; i++) {
305 int lastarg = i==argc-1;
306
307 if (!strcmp(argv[i],"-h") && !lastarg) {
308 char *ip = zmalloc(32);
309 if (anetResolve(NULL,argv[i+1],ip) == ANET_ERR) {
310 printf("Can't resolve %s\n", argv[i]);
311 exit(1);
312 }
313 config.hostip = ip;
314 i++;
315 } else if (!strcmp(argv[i],"-p") && !lastarg) {
316 config.hostport = atoi(argv[i+1]);
317 i++;
318 } else {
319 break;
320 }
321 }
322 return i;
323}
324
325static sds readArgFromStdin(void) {
326 char buf[1024];
327 sds arg = sdsempty();
328
329 while(1) {
330 int nread = read(fileno(stdin),buf,1024);
331
332 if (nread == 0) break;
333 else if (nread == -1) {
334 perror("Reading from standard input");
335 exit(1);
336 }
337 arg = sdscatlen(arg,buf,nread);
338 }
339 return arg;
340}
341
342int main(int argc, char **argv) {
343 int firstarg, j;
344 char **argvcopy;
2073a849 345 struct redisCommand *rc;
ed9b544e 346
347 config.hostip = "127.0.0.1";
348 config.hostport = 6379;
349
350 firstarg = parseOptions(argc,argv);
351 argc -= firstarg;
352 argv += firstarg;
353
354 /* Turn the plain C strings into Sds strings */
355 argvcopy = zmalloc(sizeof(char*)*argc+1);
356 for(j = 0; j < argc; j++)
357 argvcopy[j] = sdsnew(argv[j]);
358
ed9b544e 359 if (argc < 1) {
360 fprintf(stderr, "usage: redis-cli [-h host] [-p port] cmd arg1 arg2 arg3 ... argN\n");
361 fprintf(stderr, "usage: echo \"argN\" | redis-cli [-h host] [-p port] cmd arg1 arg2 ... arg(N-1)\n");
362 fprintf(stderr, "\nIf a pipe from standard input is detected this data is used as last argument.\n\n");
363 fprintf(stderr, "example: cat /etc/passwd | redis-cli set my_passwd\n");
364 fprintf(stderr, "example: redis-cli get my_passwd\n");
365 exit(1);
366 }
367
2073a849 368 /* Read the last argument from stdandard input if needed */
369 if ((rc = lookupCommand(argv[0])) != NULL) {
370 if (rc->arity > 0 && argc == rc->arity-1) {
371 sds lastarg = readArgFromStdin();
372 argvcopy[argc] = lastarg;
373 argc++;
374 }
375 }
376
ed9b544e 377 return cliSendCommand(argc, argvcopy);
378}