mirror of
https://github.com/tmate-io/tmate.git
synced 2024-11-09 01:35:20 +01:00
d637cb33da
Make all messages sent between the client and server fixed size. This is the first of two changes to make the protocol more resilient and less sensitive to other changes in the code, particularly with commands. The client now packs argv into a buffer and sends it to the server for parsing, rather than doing it itself and sending the parsed command data. As a side-effect this also removes a lot of now-unused command marshalling code. Mixing a server without this change and a client with or vice versa will cause tmux to hang or crash, please ensure that tmux is entirely killed before upgrading.
560 lines
12 KiB
C
560 lines
12 KiB
C
/* $Id: cmd-generic.c,v 1.31 2009-07-28 22:12:16 tcunha Exp $ */
|
|
|
|
/*
|
|
* Copyright (c) 2008 Nicholas Marriott <nicm@users.sourceforge.net>
|
|
*
|
|
* Permission to use, copy, modify, and distribute this software for any
|
|
* purpose with or without fee is hereby granted, provided that the above
|
|
* copyright notice and this permission notice appear in all copies.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
* WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER
|
|
* IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
|
|
* OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
*/
|
|
|
|
#include <sys/types.h>
|
|
|
|
#include <stdlib.h>
|
|
#include <string.h>
|
|
|
|
#include "tmux.h"
|
|
|
|
int cmd_getopt(int, char **, const char *, uint64_t);
|
|
int cmd_flags(int, uint64_t, uint64_t *);
|
|
size_t cmd_print_flags(char *, size_t, size_t, uint64_t);
|
|
int cmd_fill_argument(int, char **, int, char **);
|
|
|
|
size_t
|
|
cmd_prarg(char *buf, size_t len, const char *prefix, char *arg)
|
|
{
|
|
if (strchr(arg, ' ') != NULL)
|
|
return (xsnprintf(buf, len, "%s\"%s\"", prefix, arg));
|
|
return (xsnprintf(buf, len, "%s%s", prefix, arg));
|
|
}
|
|
|
|
/* Prepend flags from chflags onto flagstr and call getopt. */
|
|
int
|
|
cmd_getopt(int argc, char **argv, const char *flagstr, uint64_t chflags)
|
|
{
|
|
u_char ch;
|
|
char buf[128];
|
|
size_t len, off;
|
|
|
|
*buf = '\0';
|
|
|
|
len = sizeof buf;
|
|
off = 0;
|
|
|
|
for (ch = 0; ch < 26; ch++) {
|
|
if (chflags & CMD_CHFLAG('a' + ch))
|
|
off += xsnprintf(buf + off, len - off, "%c", 'a' + ch);
|
|
if (chflags & CMD_CHFLAG('A' + ch))
|
|
off += xsnprintf(buf + off, len - off, "%c", 'A' + ch);
|
|
}
|
|
|
|
strlcat(buf, flagstr, sizeof buf);
|
|
|
|
return (getopt(argc, argv, buf));
|
|
}
|
|
|
|
/*
|
|
* If this option is expected (in ichflags), set it in ochflags, otherwise
|
|
* return -1.
|
|
*/
|
|
int
|
|
cmd_flags(int opt, uint64_t ichflags, uint64_t *ochflags)
|
|
{
|
|
u_char ch;
|
|
|
|
for (ch = 0; ch < 26; ch++) {
|
|
if (opt == 'a' + ch && ichflags & CMD_CHFLAG(opt)) {
|
|
(*ochflags) |= CMD_CHFLAG(opt);
|
|
return (0);
|
|
}
|
|
if (opt == 'A' + ch && ichflags & CMD_CHFLAG(opt)) {
|
|
(*ochflags) |= CMD_CHFLAG(opt);
|
|
return (0);
|
|
}
|
|
}
|
|
return (-1);
|
|
}
|
|
|
|
/* Print the flags supported in chflags. */
|
|
size_t
|
|
cmd_print_flags(char *buf, size_t len, size_t off, uint64_t chflags)
|
|
{
|
|
u_char ch;
|
|
size_t boff = off;
|
|
|
|
if (chflags == 0)
|
|
return (0);
|
|
off += xsnprintf(buf + off, len - off, " -");
|
|
|
|
for (ch = 0; ch < 26; ch++) {
|
|
if (chflags & CMD_CHFLAG('a' + ch))
|
|
off += xsnprintf(buf + off, len - off, "%c", 'a' + ch);
|
|
if (chflags & CMD_CHFLAG('A' + ch))
|
|
off += xsnprintf(buf + off, len - off, "%c", 'A' + ch);
|
|
}
|
|
return (off - boff);
|
|
}
|
|
|
|
int
|
|
cmd_fill_argument(int flags, char **arg, int argc, char **argv)
|
|
{
|
|
*arg = NULL;
|
|
|
|
if (flags & CMD_ARG1) {
|
|
if (argc != 1)
|
|
return (-1);
|
|
*arg = xstrdup(argv[0]);
|
|
return (0);
|
|
}
|
|
|
|
if (flags & CMD_ARG01) {
|
|
if (argc != 0 && argc != 1)
|
|
return (-1);
|
|
if (argc == 1)
|
|
*arg = xstrdup(argv[0]);
|
|
return (0);
|
|
}
|
|
|
|
if (argc != 0)
|
|
return (-1);
|
|
return (0);
|
|
}
|
|
|
|
void
|
|
cmd_target_init(struct cmd *self, unused int key)
|
|
{
|
|
struct cmd_target_data *data;
|
|
|
|
self->data = data = xmalloc(sizeof *data);
|
|
data->chflags = 0;
|
|
data->target = NULL;
|
|
data->arg = NULL;
|
|
}
|
|
|
|
int
|
|
cmd_target_parse(struct cmd *self, int argc, char **argv, char **cause)
|
|
{
|
|
struct cmd_target_data *data;
|
|
const struct cmd_entry *entry = self->entry;
|
|
int opt;
|
|
|
|
/* Don't use the entry version since it may be dependent on key. */
|
|
cmd_target_init(self, 0);
|
|
data = self->data;
|
|
|
|
while ((opt = cmd_getopt(argc, argv, "t:", entry->chflags)) != -1) {
|
|
if (cmd_flags(opt, entry->chflags, &data->chflags) == 0)
|
|
continue;
|
|
switch (opt) {
|
|
case 't':
|
|
if (data->target == NULL)
|
|
data->target = xstrdup(optarg);
|
|
break;
|
|
default:
|
|
goto usage;
|
|
}
|
|
}
|
|
argc -= optind;
|
|
argv += optind;
|
|
|
|
if (cmd_fill_argument(self->entry->flags, &data->arg, argc, argv) != 0)
|
|
goto usage;
|
|
return (0);
|
|
|
|
usage:
|
|
xasprintf(cause, "usage: %s %s", self->entry->name, self->entry->usage);
|
|
|
|
self->entry->free(self);
|
|
return (-1);
|
|
}
|
|
|
|
void
|
|
cmd_target_free(struct cmd *self)
|
|
{
|
|
struct cmd_target_data *data = self->data;
|
|
|
|
if (data->target != NULL)
|
|
xfree(data->target);
|
|
if (data->arg != NULL)
|
|
xfree(data->arg);
|
|
xfree(data);
|
|
}
|
|
|
|
size_t
|
|
cmd_target_print(struct cmd *self, char *buf, size_t len)
|
|
{
|
|
struct cmd_target_data *data = self->data;
|
|
size_t off = 0;
|
|
|
|
off += xsnprintf(buf, len, "%s", self->entry->name);
|
|
if (data == NULL)
|
|
return (off);
|
|
off += cmd_print_flags(buf, len, off, data->chflags);
|
|
if (off < len && data->target != NULL)
|
|
off += cmd_prarg(buf + off, len - off, " -t ", data->target);
|
|
if (off < len && data->arg != NULL)
|
|
off += cmd_prarg(buf + off, len - off, " ", data->arg);
|
|
return (off);
|
|
}
|
|
|
|
void
|
|
cmd_srcdst_init(struct cmd *self, unused int key)
|
|
{
|
|
struct cmd_srcdst_data *data;
|
|
|
|
self->data = data = xmalloc(sizeof *data);
|
|
data->chflags = 0;
|
|
data->src = NULL;
|
|
data->dst = NULL;
|
|
data->arg = NULL;
|
|
}
|
|
|
|
int
|
|
cmd_srcdst_parse(struct cmd *self, int argc, char **argv, char **cause)
|
|
{
|
|
struct cmd_srcdst_data *data;
|
|
const struct cmd_entry *entry = self->entry;
|
|
int opt;
|
|
|
|
cmd_srcdst_init(self, 0);
|
|
data = self->data;
|
|
|
|
while ((opt = cmd_getopt(argc, argv, "s:t:", entry->chflags)) != -1) {
|
|
if (cmd_flags(opt, entry->chflags, &data->chflags) == 0)
|
|
continue;
|
|
switch (opt) {
|
|
case 's':
|
|
if (data->src == NULL)
|
|
data->src = xstrdup(optarg);
|
|
break;
|
|
case 't':
|
|
if (data->dst == NULL)
|
|
data->dst = xstrdup(optarg);
|
|
break;
|
|
default:
|
|
goto usage;
|
|
}
|
|
}
|
|
argc -= optind;
|
|
argv += optind;
|
|
|
|
if (cmd_fill_argument(self->entry->flags, &data->arg, argc, argv) != 0)
|
|
goto usage;
|
|
return (0);
|
|
|
|
usage:
|
|
xasprintf(cause, "usage: %s %s", self->entry->name, self->entry->usage);
|
|
|
|
self->entry->free(self);
|
|
return (-1);
|
|
}
|
|
|
|
void
|
|
cmd_srcdst_free(struct cmd *self)
|
|
{
|
|
struct cmd_srcdst_data *data = self->data;
|
|
|
|
if (data->src != NULL)
|
|
xfree(data->src);
|
|
if (data->dst != NULL)
|
|
xfree(data->dst);
|
|
if (data->arg != NULL)
|
|
xfree(data->arg);
|
|
xfree(data);
|
|
}
|
|
|
|
size_t
|
|
cmd_srcdst_print(struct cmd *self, char *buf, size_t len)
|
|
{
|
|
struct cmd_srcdst_data *data = self->data;
|
|
size_t off = 0;
|
|
|
|
off += xsnprintf(buf, len, "%s", self->entry->name);
|
|
if (data == NULL)
|
|
return (off);
|
|
off += cmd_print_flags(buf, len, off, data->chflags);
|
|
if (off < len && data->src != NULL)
|
|
off += xsnprintf(buf + off, len - off, " -s %s", data->src);
|
|
if (off < len && data->dst != NULL)
|
|
off += xsnprintf(buf + off, len - off, " -t %s", data->dst);
|
|
if (off < len && data->arg != NULL)
|
|
off += cmd_prarg(buf + off, len - off, " ", data->arg);
|
|
return (off);
|
|
}
|
|
|
|
void
|
|
cmd_buffer_init(struct cmd *self, unused int key)
|
|
{
|
|
struct cmd_buffer_data *data;
|
|
|
|
self->data = data = xmalloc(sizeof *data);
|
|
data->chflags = 0;
|
|
data->target = NULL;
|
|
data->buffer = -1;
|
|
data->arg = NULL;
|
|
}
|
|
|
|
int
|
|
cmd_buffer_parse(struct cmd *self, int argc, char **argv, char **cause)
|
|
{
|
|
struct cmd_buffer_data *data;
|
|
const struct cmd_entry *entry = self->entry;
|
|
int opt, n;
|
|
const char *errstr;
|
|
|
|
cmd_buffer_init(self, 0);
|
|
data = self->data;
|
|
|
|
while ((opt = cmd_getopt(argc, argv, "b:t:", entry->chflags)) != -1) {
|
|
if (cmd_flags(opt, entry->chflags, &data->chflags) == 0)
|
|
continue;
|
|
switch (opt) {
|
|
case 'b':
|
|
if (data->buffer == -1) {
|
|
n = strtonum(optarg, 0, INT_MAX, &errstr);
|
|
if (errstr != NULL) {
|
|
xasprintf(cause, "buffer %s", errstr);
|
|
goto error;
|
|
}
|
|
data->buffer = n;
|
|
}
|
|
break;
|
|
case 't':
|
|
if (data->target == NULL)
|
|
data->target = xstrdup(optarg);
|
|
break;
|
|
default:
|
|
goto usage;
|
|
}
|
|
}
|
|
argc -= optind;
|
|
argv += optind;
|
|
|
|
if (cmd_fill_argument(self->entry->flags, &data->arg, argc, argv) != 0)
|
|
goto usage;
|
|
return (0);
|
|
|
|
usage:
|
|
xasprintf(cause, "usage: %s %s", self->entry->name, self->entry->usage);
|
|
|
|
error:
|
|
self->entry->free(self);
|
|
return (-1);
|
|
}
|
|
|
|
void
|
|
cmd_buffer_free(struct cmd *self)
|
|
{
|
|
struct cmd_buffer_data *data = self->data;
|
|
|
|
if (data->target != NULL)
|
|
xfree(data->target);
|
|
if (data->arg != NULL)
|
|
xfree(data->arg);
|
|
xfree(data);
|
|
}
|
|
|
|
size_t
|
|
cmd_buffer_print(struct cmd *self, char *buf, size_t len)
|
|
{
|
|
struct cmd_buffer_data *data = self->data;
|
|
size_t off = 0;
|
|
|
|
off += xsnprintf(buf, len, "%s", self->entry->name);
|
|
if (data == NULL)
|
|
return (off);
|
|
off += cmd_print_flags(buf, len, off, data->chflags);
|
|
if (off < len && data->buffer != -1)
|
|
off += xsnprintf(buf + off, len - off, " -b %d", data->buffer);
|
|
if (off < len && data->target != NULL)
|
|
off += cmd_prarg(buf + off, len - off, " -t ", data->target);
|
|
if (off < len && data->arg != NULL)
|
|
off += cmd_prarg(buf + off, len - off, " ", data->arg);
|
|
return (off);
|
|
}
|
|
|
|
void
|
|
cmd_option_init(struct cmd *self, unused int key)
|
|
{
|
|
struct cmd_option_data *data;
|
|
|
|
self->data = data = xmalloc(sizeof *data);
|
|
data->chflags = 0;
|
|
data->target = NULL;
|
|
data->option = NULL;
|
|
data->value = NULL;
|
|
}
|
|
|
|
int
|
|
cmd_option_parse(struct cmd *self, int argc, char **argv, char **cause)
|
|
{
|
|
struct cmd_option_data *data;
|
|
const struct cmd_entry *entry = self->entry;
|
|
int opt;
|
|
|
|
/* Don't use the entry version since it may be dependent on key. */
|
|
cmd_option_init(self, 0);
|
|
data = self->data;
|
|
|
|
while ((opt = cmd_getopt(argc, argv, "t:", entry->chflags)) != -1) {
|
|
if (cmd_flags(opt, entry->chflags, &data->chflags) == 0)
|
|
continue;
|
|
switch (opt) {
|
|
case 't':
|
|
if (data->target == NULL)
|
|
data->target = xstrdup(optarg);
|
|
break;
|
|
default:
|
|
goto usage;
|
|
}
|
|
}
|
|
argc -= optind;
|
|
argv += optind;
|
|
|
|
if (argc == 2) {
|
|
data->option = xstrdup(argv[0]);
|
|
data->value = xstrdup(argv[1]);
|
|
} else if (argc == 1)
|
|
data->option = xstrdup(argv[0]);
|
|
else
|
|
goto usage;
|
|
return (0);
|
|
|
|
usage:
|
|
xasprintf(cause, "usage: %s %s", self->entry->name, self->entry->usage);
|
|
|
|
self->entry->free(self);
|
|
return (-1);
|
|
}
|
|
|
|
void
|
|
cmd_option_free(struct cmd *self)
|
|
{
|
|
struct cmd_option_data *data = self->data;
|
|
|
|
if (data->target != NULL)
|
|
xfree(data->target);
|
|
if (data->option != NULL)
|
|
xfree(data->option);
|
|
if (data->value != NULL)
|
|
xfree(data->value);
|
|
xfree(data);
|
|
}
|
|
|
|
size_t
|
|
cmd_option_print(struct cmd *self, char *buf, size_t len)
|
|
{
|
|
struct cmd_option_data *data = self->data;
|
|
size_t off = 0;
|
|
|
|
off += xsnprintf(buf, len, "%s", self->entry->name);
|
|
if (data == NULL)
|
|
return (off);
|
|
off += cmd_print_flags(buf, len, off, data->chflags);
|
|
if (off < len && data->target != NULL)
|
|
off += cmd_prarg(buf + off, len - off, " -t ", data->target);
|
|
if (off < len && data->option != NULL)
|
|
off += xsnprintf(buf + off, len - off, " %s", data->option);
|
|
if (off < len && data->value != NULL)
|
|
off += xsnprintf(buf + off, len - off, " %s", data->value);
|
|
return (off);
|
|
}
|
|
|
|
void
|
|
cmd_pane_init(struct cmd *self, unused int key)
|
|
{
|
|
struct cmd_pane_data *data;
|
|
|
|
self->data = data = xmalloc(sizeof *data);
|
|
data->chflags = 0;
|
|
data->target = NULL;
|
|
data->arg = NULL;
|
|
data->pane = -1;
|
|
}
|
|
|
|
int
|
|
cmd_pane_parse(struct cmd *self, int argc, char **argv, char **cause)
|
|
{
|
|
struct cmd_pane_data *data;
|
|
const struct cmd_entry *entry = self->entry;
|
|
int opt, n;
|
|
const char *errstr;
|
|
|
|
/* Don't use the entry version since it may be dependent on key. */
|
|
cmd_pane_init(self, 0);
|
|
data = self->data;
|
|
|
|
while ((opt = cmd_getopt(argc, argv, "p:t:", entry->chflags)) != -1) {
|
|
if (cmd_flags(opt, entry->chflags, &data->chflags) == 0)
|
|
continue;
|
|
switch (opt) {
|
|
case 'p':
|
|
if (data->pane == -1) {
|
|
n = strtonum(optarg, 0, INT_MAX, &errstr);
|
|
if (errstr != NULL) {
|
|
xasprintf(cause, "pane %s", errstr);
|
|
goto error;
|
|
}
|
|
data->pane = n;
|
|
}
|
|
break;
|
|
case 't':
|
|
if (data->target == NULL)
|
|
data->target = xstrdup(optarg);
|
|
break;
|
|
default:
|
|
goto usage;
|
|
}
|
|
}
|
|
argc -= optind;
|
|
argv += optind;
|
|
|
|
if (cmd_fill_argument(self->entry->flags, &data->arg, argc, argv) != 0)
|
|
goto usage;
|
|
return (0);
|
|
|
|
usage:
|
|
xasprintf(cause, "usage: %s %s", self->entry->name, self->entry->usage);
|
|
|
|
error:
|
|
self->entry->free(self);
|
|
return (-1);
|
|
}
|
|
|
|
void
|
|
cmd_pane_free(struct cmd *self)
|
|
{
|
|
struct cmd_pane_data *data = self->data;
|
|
|
|
if (data->target != NULL)
|
|
xfree(data->target);
|
|
if (data->arg != NULL)
|
|
xfree(data->arg);
|
|
xfree(data);
|
|
}
|
|
|
|
size_t
|
|
cmd_pane_print(struct cmd *self, char *buf, size_t len)
|
|
{
|
|
struct cmd_pane_data *data = self->data;
|
|
size_t off = 0;
|
|
|
|
off += xsnprintf(buf, len, "%s", self->entry->name);
|
|
if (data == NULL)
|
|
return (off);
|
|
off += cmd_print_flags(buf, len, off, data->chflags);
|
|
if (off < len && data->target != NULL)
|
|
off += cmd_prarg(buf + off, len - off, " -t ", data->target);
|
|
if (off < len && data->arg != NULL)
|
|
off += cmd_prarg(buf + off, len - off, " ", data->arg);
|
|
return (off);
|
|
}
|