circlecloud
/
tmux
mirror of https://github.com/tmux/tmux.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
tmux/cmd-save-buffer.c

124 lines
3.0 KiB
C
Raw Normal View History

Expand the Id keyword.
2011-07-09 09:42:33 +00:00
/* $Id$ */
save-buffer command, from Tiago Cunha.
2009-01-11 23:14:57 +00:00
/*
* Copyright (c) 2009 Tiago Cunha <me@tiagocunha.org>
*
* 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 <sys/stat.h>
#include <errno.h>
Sync OpenBSD patchset 1150: xfree is not particularly helpful, remove it. From Thomas Adam.
2012-07-11 19:34:16 +00:00
#include <stdlib.h>
save-buffer command, from Tiago Cunha.
2009-01-11 23:14:57 +00:00
#include <string.h>
#include "tmux.h"
/*
Sync OpenBSD patchset 964: Plug a memory leak and update some comments, from Tiago Cunha.
2011-10-23 15:02:20 +00:00
* Saves a paste buffer to a file.
save-buffer command, from Tiago Cunha.
2009-01-11 23:14:57 +00:00
*/
Sync OpenBSD patchset 1151: Make command exec functions return an enum rather than -1/0/1 values and add a new value to mean "leave client running but don't attach" to fix problems with using some commands in a command sequence. Most of the work by Thomas Adam, problem reported by "jspenguin" on SF bug 3535531.
2012-07-11 19:37:32 +00:00
enum cmd_retval cmd_save_buffer_exec(struct cmd *, struct cmd_ctx *);
save-buffer command, from Tiago Cunha.
2009-01-11 23:14:57 +00:00
const struct cmd_entry cmd_save_buffer_entry = {
"save-buffer", "saveb",
Sync OpenBSD patchset 829: Clean up and simplify tmux command argument parsing. Originally, tmux commands were parsed in the client process into a struct with the command data which was then serialised and sent to the server to be executed. The parsing was later moved into the server (an argv was sent from the client), but the parse step and intermediate struct was kept. This change removes that struct and the separate parse step. Argument parsing and printing is now common to all commands (in arguments.c) with each command left with just an optional check function (to validate the arguments at parse time), the exec function and a function to set up any key bindings (renamed from the old init function). This is overall more simple and consistent. There should be no changes to any commands behaviour or syntax although as this touches every command please watch for any unexpected changes.
2011-01-07 14:45:34 +00:00
"ab:", 1, 1,
Sync OpenBSD patchset 1077: Fix save-buffer usage, from Kazuhiko Sakaguchi.
2012-03-29 21:08:44 +00:00
"[-a] " CMD_BUFFER_USAGE " path",
Sync OpenBSD patchset 829: Clean up and simplify tmux command argument parsing. Originally, tmux commands were parsed in the client process into a struct with the command data which was then serialised and sent to the server to be executed. The parsing was later moved into the server (an argv was sent from the client), but the parse step and intermediate struct was kept. This change removes that struct and the separate parse step. Argument parsing and printing is now common to all commands (in arguments.c) with each command left with just an optional check function (to validate the arguments at parse time), the exec function and a function to set up any key bindings (renamed from the old init function). This is overall more simple and consistent. There should be no changes to any commands behaviour or syntax although as this touches every command please watch for any unexpected changes.
2011-01-07 14:45:34 +00:00
0,
NULL,
NULL,
cmd_save_buffer_exec
save-buffer command, from Tiago Cunha.
2009-01-11 23:14:57 +00:00
};
Sync OpenBSD patchset 1151: Make command exec functions return an enum rather than -1/0/1 values and add a new value to mean "leave client running but don't attach" to fix problems with using some commands in a command sequence. Most of the work by Thomas Adam, problem reported by "jspenguin" on SF bug 3535531.
2012-07-11 19:37:32 +00:00
enum cmd_retval
save-buffer command, from Tiago Cunha.
2009-01-11 23:14:57 +00:00
cmd_save_buffer_exec(struct cmd *self, struct cmd_ctx *ctx)
{
Sync OpenBSD patchset 829: Clean up and simplify tmux command argument parsing. Originally, tmux commands were parsed in the client process into a struct with the command data which was then serialised and sent to the server to be executed. The parsing was later moved into the server (an argv was sent from the client), but the parse step and intermediate struct was kept. This change removes that struct and the separate parse step. Argument parsing and printing is now common to all commands (in arguments.c) with each command left with just an optional check function (to validate the arguments at parse time), the exec function and a function to set up any key bindings (renamed from the old init function). This is overall more simple and consistent. There should be no changes to any commands behaviour or syntax although as this touches every command please watch for any unexpected changes.
2011-01-07 14:45:34 +00:00
struct args *args = self->args;
Fix so capture-pane/save-buffer can work in control clients, from George Nachman.
2013-02-20 09:32:52 +00:00
struct client *c;
Sync OpenBSD patchset 968: Try to resolve relative paths for loadb and saveb (first using client working directory if any then default-path or session wd).
2011-10-23 15:08:58 +00:00
struct session *s;
save-buffer command, from Tiago Cunha.
2009-01-11 23:14:57 +00:00
struct paste_buffer *pb;
Sync OpenBSD patchset 968: Try to resolve relative paths for loadb and saveb (first using client working directory if any then default-path or session wd).
2011-10-23 15:08:58 +00:00
const char *path, *newpath, *wd;
Sync OpenBSD patchset 829: Clean up and simplify tmux command argument parsing. Originally, tmux commands were parsed in the client process into a struct with the command data which was then serialised and sent to the server to be executed. The parsing was later moved into the server (an argv was sent from the client), but the parse step and intermediate struct was kept. This change removes that struct and the separate parse step. Argument parsing and printing is now common to all commands (in arguments.c) with each command left with just an optional check function (to validate the arguments at parse time), the exec function and a function to set up any key bindings (renamed from the old init function). This is overall more simple and consistent. There should be no changes to any commands behaviour or syntax although as this touches every command please watch for any unexpected changes.
2011-01-07 14:45:34 +00:00
char *cause;
int buffer;
Sync OpenBSD patchset 741: When changing so that the client passes its stdout and stderr as well as stdin up to the server, I forgot one essential point - the tmux server could now be both the producer and consumer. This happens when tmux is run inside tmux, as well as when piping tmux commands together. So, using stdio(3) was a bad idea - if sufficient data was written, this could block in write(2). When that happened and the server was both producer and consumer, it deadlocks. Change to use libevent bufferevents for the client stdin, stdout and stderr instead. This is trivial enough for output but requires a callback mechanism to trigger when stdin is finished. This relies on the underlying polling mechanism for libevent to work with whatever devices to which the user could redirect stdin, stdout or stderr, hence the change to use poll(2) over kqueue(2) for tmux.
2010-08-09 21:44:25 +00:00
mode_t mask;
FILE *f;
save-buffer command, from Tiago Cunha.
2009-01-11 23:14:57 +00:00
Sync OpenBSD patchset 829: Clean up and simplify tmux command argument parsing. Originally, tmux commands were parsed in the client process into a struct with the command data which was then serialised and sent to the server to be executed. The parsing was later moved into the server (an argv was sent from the client), but the parse step and intermediate struct was kept. This change removes that struct and the separate parse step. Argument parsing and printing is now common to all commands (in arguments.c) with each command left with just an optional check function (to validate the arguments at parse time), the exec function and a function to set up any key bindings (renamed from the old init function). This is overall more simple and consistent. There should be no changes to any commands behaviour or syntax although as this touches every command please watch for any unexpected changes.
2011-01-07 14:45:34 +00:00
if (!args_has(args, 'b')) {
Global paste buffers instead of per-session which renders copy-buffer useless. As a consequence buffer-limit is now a server option.
2010-12-30 22:39:49 +00:00
if ((pb = paste_get_top(&global_buffers)) == NULL) {
save-buffer command, from Tiago Cunha.
2009-01-11 23:14:57 +00:00
ctx->error(ctx, "no buffers");
Sync OpenBSD patchset 1151: Make command exec functions return an enum rather than -1/0/1 values and add a new value to mean "leave client running but don't attach" to fix problems with using some commands in a command sequence. Most of the work by Thomas Adam, problem reported by "jspenguin" on SF bug 3535531.
2012-07-11 19:37:32 +00:00
return (CMD_RETURN_ERROR);
Pass return code from _exec; allow command sequences to work from the command line.
2009-01-19 18:23:40 +00:00
}
save-buffer command, from Tiago Cunha.
2009-01-11 23:14:57 +00:00
} else {
Sync OpenBSD patchset 829: Clean up and simplify tmux command argument parsing. Originally, tmux commands were parsed in the client process into a struct with the command data which was then serialised and sent to the server to be executed. The parsing was later moved into the server (an argv was sent from the client), but the parse step and intermediate struct was kept. This change removes that struct and the separate parse step. Argument parsing and printing is now common to all commands (in arguments.c) with each command left with just an optional check function (to validate the arguments at parse time), the exec function and a function to set up any key bindings (renamed from the old init function). This is overall more simple and consistent. There should be no changes to any commands behaviour or syntax although as this touches every command please watch for any unexpected changes.
2011-01-07 14:45:34 +00:00
buffer = args_strtonum(args, 'b', 0, INT_MAX, &cause);
if (cause != NULL) {
ctx->error(ctx, "buffer %s", cause);
Sync OpenBSD patchset 1150: xfree is not particularly helpful, remove it. From Thomas Adam.
2012-07-11 19:34:16 +00:00
free(cause);
Sync OpenBSD patchset 1151: Make command exec functions return an enum rather than -1/0/1 values and add a new value to mean "leave client running but don't attach" to fix problems with using some commands in a command sequence. Most of the work by Thomas Adam, problem reported by "jspenguin" on SF bug 3535531.
2012-07-11 19:37:32 +00:00
return (CMD_RETURN_ERROR);
Sync OpenBSD patchset 829: Clean up and simplify tmux command argument parsing. Originally, tmux commands were parsed in the client process into a struct with the command data which was then serialised and sent to the server to be executed. The parsing was later moved into the server (an argv was sent from the client), but the parse step and intermediate struct was kept. This change removes that struct and the separate parse step. Argument parsing and printing is now common to all commands (in arguments.c) with each command left with just an optional check function (to validate the arguments at parse time), the exec function and a function to set up any key bindings (renamed from the old init function). This is overall more simple and consistent. There should be no changes to any commands behaviour or syntax although as this touches every command please watch for any unexpected changes.
2011-01-07 14:45:34 +00:00
}
pb = paste_get_index(&global_buffers, buffer);
Global paste buffers instead of per-session which renders copy-buffer useless. As a consequence buffer-limit is now a server option.
2010-12-30 22:39:49 +00:00
if (pb == NULL) {
Sync OpenBSD patchset 829: Clean up and simplify tmux command argument parsing. Originally, tmux commands were parsed in the client process into a struct with the command data which was then serialised and sent to the server to be executed. The parsing was later moved into the server (an argv was sent from the client), but the parse step and intermediate struct was kept. This change removes that struct and the separate parse step. Argument parsing and printing is now common to all commands (in arguments.c) with each command left with just an optional check function (to validate the arguments at parse time), the exec function and a function to set up any key bindings (renamed from the old init function). This is overall more simple and consistent. There should be no changes to any commands behaviour or syntax although as this touches every command please watch for any unexpected changes.
2011-01-07 14:45:34 +00:00
ctx->error(ctx, "no buffer %d", buffer);
Sync OpenBSD patchset 1151: Make command exec functions return an enum rather than -1/0/1 values and add a new value to mean "leave client running but don't attach" to fix problems with using some commands in a command sequence. Most of the work by Thomas Adam, problem reported by "jspenguin" on SF bug 3535531.
2012-07-11 19:37:32 +00:00
return (CMD_RETURN_ERROR);
Pass return code from _exec; allow command sequences to work from the command line.
2009-01-19 18:23:40 +00:00
}
save-buffer command, from Tiago Cunha.
2009-01-11 23:14:57 +00:00
}
Sync OpenBSD patchset 829: Clean up and simplify tmux command argument parsing. Originally, tmux commands were parsed in the client process into a struct with the command data which was then serialised and sent to the server to be executed. The parsing was later moved into the server (an argv was sent from the client), but the parse step and intermediate struct was kept. This change removes that struct and the separate parse step. Argument parsing and printing is now common to all commands (in arguments.c) with each command left with just an optional check function (to validate the arguments at parse time), the exec function and a function to set up any key bindings (renamed from the old init function). This is overall more simple and consistent. There should be no changes to any commands behaviour or syntax although as this touches every command please watch for any unexpected changes.
2011-01-07 14:45:34 +00:00
path = args->argv[0];
if (strcmp(path, "-") == 0) {
Fix so capture-pane/save-buffer can work in control clients, from George Nachman.
2013-02-20 09:32:52 +00:00
c = ctx->curclient;
if (c == NULL || !(c->flags & CLIENT_CONTROL))
c = ctx->cmdclient;
Sync OpenBSD patchset 829: Clean up and simplify tmux command argument parsing. Originally, tmux commands were parsed in the client process into a struct with the command data which was then serialised and sent to the server to be executed. The parsing was later moved into the server (an argv was sent from the client), but the parse step and intermediate struct was kept. This change removes that struct and the separate parse step. Argument parsing and printing is now common to all commands (in arguments.c) with each command left with just an optional check function (to validate the arguments at parse time), the exec function and a function to set up any key bindings (renamed from the old init function). This is overall more simple and consistent. There should be no changes to any commands behaviour or syntax although as this touches every command please watch for any unexpected changes.
2011-01-07 14:45:34 +00:00
if (c == NULL) {
Fix so capture-pane/save-buffer can work in control clients, from George Nachman.
2013-02-20 09:32:52 +00:00
ctx->error(ctx, "can't write to stdout");
Sync OpenBSD patchset 1151: Make command exec functions return an enum rather than -1/0/1 values and add a new value to mean "leave client running but don't attach" to fix problems with using some commands in a command sequence. Most of the work by Thomas Adam, problem reported by "jspenguin" on SF bug 3535531.
2012-07-11 19:37:32 +00:00
return (CMD_RETURN_ERROR);
Sync OpenBSD patchset 731: Send all three of stdin, stdout, stderr from the client to the server, so that commands can directly make use of them. This means that load-buffer and save-buffer can have "-" as the file to read from stdin or write to stdout. This is a protocol version bump so the tmux server will need to be restarted after upgrade (or an older client used).
2010-07-02 02:52:13 +00:00
}
Sync OpenBSD patchset 1114: Instead of passing stdin/stdout/stderr file descriptors over imsg and handling them in the server, handle them in the client and pass buffers over imsg. This is much tidier for some upcoming changes and the performance hit isn't critical. The tty fd is still passed to the server as before. This bumps the tmux protocol version so new clients and old servers are incompatible.
2012-05-22 20:56:35 +00:00
evbuffer_add(c->stdout_data, pb->data, pb->size);
server_push_stdout(c);
Sync OpenBSD patchset 731: Send all three of stdin, stdout, stderr from the client to the server, so that commands can directly make use of them. This means that load-buffer and save-buffer can have "-" as the file to read from stdin or write to stdout. This is a protocol version bump so the tmux server will need to be restarted after upgrade (or an older client used).
2010-07-02 02:52:13 +00:00
} else {
Fix so capture-pane/save-buffer can work in control clients, from George Nachman.
2013-02-20 09:32:52 +00:00
c = ctx->cmdclient;
Sync OpenBSD patchset 968: Try to resolve relative paths for loadb and saveb (first using client working directory if any then default-path or session wd).
2011-10-23 15:08:58 +00:00
if (c != NULL)
wd = c->cwd;
else if ((s = cmd_current_session(ctx, 0)) != NULL) {
wd = options_get_string(&s->options, "default-path");
if (*wd == '\0')
wd = s->cwd;
} else
wd = NULL;
if (wd != NULL && *wd != '\0') {
newpath = get_full_path(wd, path);
if (newpath != NULL)
path = newpath;
}
Sync OpenBSD patchset 731: Send all three of stdin, stdout, stderr from the client to the server, so that commands can directly make use of them. This means that load-buffer and save-buffer can have "-" as the file to read from stdin or write to stdout. This is a protocol version bump so the tmux server will need to be restarted after upgrade (or an older client used).
2010-07-02 02:52:13 +00:00
mask = umask(S_IRWXG | S_IRWXO);
Sync OpenBSD patchset 829: Clean up and simplify tmux command argument parsing. Originally, tmux commands were parsed in the client process into a struct with the command data which was then serialised and sent to the server to be executed. The parsing was later moved into the server (an argv was sent from the client), but the parse step and intermediate struct was kept. This change removes that struct and the separate parse step. Argument parsing and printing is now common to all commands (in arguments.c) with each command left with just an optional check function (to validate the arguments at parse time), the exec function and a function to set up any key bindings (renamed from the old init function). This is overall more simple and consistent. There should be no changes to any commands behaviour or syntax although as this touches every command please watch for any unexpected changes.
2011-01-07 14:45:34 +00:00
if (args_has(self->args, 'a'))
f = fopen(path, "ab");
Sync OpenBSD patchset 731: Send all three of stdin, stdout, stderr from the client to the server, so that commands can directly make use of them. This means that load-buffer and save-buffer can have "-" as the file to read from stdin or write to stdout. This is a protocol version bump so the tmux server will need to be restarted after upgrade (or an older client used).
2010-07-02 02:52:13 +00:00
else
Sync OpenBSD patchset 829: Clean up and simplify tmux command argument parsing. Originally, tmux commands were parsed in the client process into a struct with the command data which was then serialised and sent to the server to be executed. The parsing was later moved into the server (an argv was sent from the client), but the parse step and intermediate struct was kept. This change removes that struct and the separate parse step. Argument parsing and printing is now common to all commands (in arguments.c) with each command left with just an optional check function (to validate the arguments at parse time), the exec function and a function to set up any key bindings (renamed from the old init function). This is overall more simple and consistent. There should be no changes to any commands behaviour or syntax although as this touches every command please watch for any unexpected changes.
2011-01-07 14:45:34 +00:00
f = fopen(path, "wb");
Sync OpenBSD patchset 731: Send all three of stdin, stdout, stderr from the client to the server, so that commands can directly make use of them. This means that load-buffer and save-buffer can have "-" as the file to read from stdin or write to stdout. This is a protocol version bump so the tmux server will need to be restarted after upgrade (or an older client used).
2010-07-02 02:52:13 +00:00
umask(mask);
if (f == NULL) {
Sync OpenBSD patchset 829: Clean up and simplify tmux command argument parsing. Originally, tmux commands were parsed in the client process into a struct with the command data which was then serialised and sent to the server to be executed. The parsing was later moved into the server (an argv was sent from the client), but the parse step and intermediate struct was kept. This change removes that struct and the separate parse step. Argument parsing and printing is now common to all commands (in arguments.c) with each command left with just an optional check function (to validate the arguments at parse time), the exec function and a function to set up any key bindings (renamed from the old init function). This is overall more simple and consistent. There should be no changes to any commands behaviour or syntax although as this touches every command please watch for any unexpected changes.
2011-01-07 14:45:34 +00:00
ctx->error(ctx, "%s: %s", path, strerror(errno));
Sync OpenBSD patchset 1151: Make command exec functions return an enum rather than -1/0/1 values and add a new value to mean "leave client running but don't attach" to fix problems with using some commands in a command sequence. Most of the work by Thomas Adam, problem reported by "jspenguin" on SF bug 3535531.
2012-07-11 19:37:32 +00:00
return (CMD_RETURN_ERROR);
Sync OpenBSD patchset 731: Send all three of stdin, stdout, stderr from the client to the server, so that commands can directly make use of them. This means that load-buffer and save-buffer can have "-" as the file to read from stdin or write to stdout. This is a protocol version bump so the tmux server will need to be restarted after upgrade (or an older client used).
2010-07-02 02:52:13 +00:00
}
Sync OpenBSD patchset 741: When changing so that the client passes its stdout and stderr as well as stdin up to the server, I forgot one essential point - the tmux server could now be both the producer and consumer. This happens when tmux is run inside tmux, as well as when piping tmux commands together. So, using stdio(3) was a bad idea - if sufficient data was written, this could block in write(2). When that happened and the server was both producer and consumer, it deadlocks. Change to use libevent bufferevents for the client stdin, stdout and stderr instead. This is trivial enough for output but requires a callback mechanism to trigger when stdin is finished. This relies on the underlying polling mechanism for libevent to work with whatever devices to which the user could redirect stdin, stdout or stderr, hence the change to use poll(2) over kqueue(2) for tmux.
2010-08-09 21:44:25 +00:00
if (fwrite(pb->data, 1, pb->size, f) != pb->size) {
Sync OpenBSD patchset 829: Clean up and simplify tmux command argument parsing. Originally, tmux commands were parsed in the client process into a struct with the command data which was then serialised and sent to the server to be executed. The parsing was later moved into the server (an argv was sent from the client), but the parse step and intermediate struct was kept. This change removes that struct and the separate parse step. Argument parsing and printing is now common to all commands (in arguments.c) with each command left with just an optional check function (to validate the arguments at parse time), the exec function and a function to set up any key bindings (renamed from the old init function). This is overall more simple and consistent. There should be no changes to any commands behaviour or syntax although as this touches every command please watch for any unexpected changes.
2011-01-07 14:45:34 +00:00
ctx->error(ctx, "%s: fwrite error", path);
Sync OpenBSD patchset 741: When changing so that the client passes its stdout and stderr as well as stdin up to the server, I forgot one essential point - the tmux server could now be both the producer and consumer. This happens when tmux is run inside tmux, as well as when piping tmux commands together. So, using stdio(3) was a bad idea - if sufficient data was written, this could block in write(2). When that happened and the server was both producer and consumer, it deadlocks. Change to use libevent bufferevents for the client stdin, stdout and stderr instead. This is trivial enough for output but requires a callback mechanism to trigger when stdin is finished. This relies on the underlying polling mechanism for libevent to work with whatever devices to which the user could redirect stdin, stdout or stderr, hence the change to use poll(2) over kqueue(2) for tmux.
2010-08-09 21:44:25 +00:00
fclose(f);
Sync OpenBSD patchset 1151: Make command exec functions return an enum rather than -1/0/1 values and add a new value to mean "leave client running but don't attach" to fix problems with using some commands in a command sequence. Most of the work by Thomas Adam, problem reported by "jspenguin" on SF bug 3535531.
2012-07-11 19:37:32 +00:00
return (CMD_RETURN_ERROR);
Sync OpenBSD patchset 741: When changing so that the client passes its stdout and stderr as well as stdin up to the server, I forgot one essential point - the tmux server could now be both the producer and consumer. This happens when tmux is run inside tmux, as well as when piping tmux commands together. So, using stdio(3) was a bad idea - if sufficient data was written, this could block in write(2). When that happened and the server was both producer and consumer, it deadlocks. Change to use libevent bufferevents for the client stdin, stdout and stderr instead. This is trivial enough for output but requires a callback mechanism to trigger when stdin is finished. This relies on the underlying polling mechanism for libevent to work with whatever devices to which the user could redirect stdin, stdout or stderr, hence the change to use poll(2) over kqueue(2) for tmux.
2010-08-09 21:44:25 +00:00
}
fclose(f);
save-buffer command, from Tiago Cunha.
2009-01-11 23:14:57 +00:00
}
Sync OpenBSD patchset 1151: Make command exec functions return an enum rather than -1/0/1 values and add a new value to mean "leave client running but don't attach" to fix problems with using some commands in a command sequence. Most of the work by Thomas Adam, problem reported by "jspenguin" on SF bug 3535531.
2012-07-11 19:37:32 +00:00
return (CMD_RETURN_NORMAL);
save-buffer command, from Tiago Cunha.
2009-01-11 23:14:57 +00:00
}