circlecloud/tmux
1
0
Fork 0
mirror of https://github.com/tmux/tmux.git synced 2024-11-01 07:08:49 +00:00
Code Issues Projects Releases Wiki Activity
89adec0ca5
tmux/cmd-set-environment.c

120 lines
3.1 KiB
C
Raw Normal View History

Infrastructure and commands to manage the environment for processes started within tmux. There is a global environment, copied from the external environment when the server is started and each sesssion has an (initially empty) session environment which overrides it. New commands set-environment and show-environment manipulate or display the environments. A new session option, update-environment, is a space-separated list of variables which are updated from the external environment into the session environment every time a new session is created - the default is DISPLAY.
2009-08-08 21:52:43 +00:00
/* $OpenBSD$ */
/*
I no longer use my SourceForge address so replace it.
2016-01-19 15:59:12 +00:00
* Copyright (c) 2009 Nicholas Marriott <nicholas.marriott@gmail.com>
Infrastructure and commands to manage the environment for processes started within tmux. There is a global environment, copied from the external environment when the server is started and each sesssion has an (initially empty) session environment which overrides it. New commands set-environment and show-environment manipulate or display the environments. A new session option, update-environment, is a space-separated list of variables which are updated from the external environment into the session environment every time a new session is created - the default is DISPLAY.
2009-08-08 21:52:43 +00:00
*
* 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"
/*
* Set an environment variable.
*/
Mass rename struct cmd_q to struct cmdq_item and related.
2016-10-16 19:04:05 +00:00
static enum cmd_retval cmd_set_environment_exec(struct cmd *,
struct cmdq_item *);
Infrastructure and commands to manage the environment for processes started within tmux. There is a global environment, copied from the external environment when the server is started and each sesssion has an (initially empty) session environment which overrides it. New commands set-environment and show-environment manipulate or display the environments. A new session option, update-environment, is a space-separated list of variables which are updated from the external environment into the session environment every time a new session is created - the default is DISPLAY.
2009-08-08 21:52:43 +00:00
const struct cmd_entry cmd_set_environment_entry = {
Use member names in cmd_entry definitions so I stop getting confused about the order.
2015-12-13 21:53:57 +00:00
.name = "set-environment",
.alias = "setenv",
Add args parsing callback for some future work, currently unused.
2021-08-21 10:22:38 +00:00
.args = { "Fhgrt:u", 1, 2, NULL },
Add -F to set-environment and source-file; GitHub issue 2359.
2020-09-01 09:19:01 +00:00
.usage = "[-Fhgru] " CMD_TARGET_SESSION_USAGE " name [value]",
Use member names in cmd_entry definitions so I stop getting confused about the order.
2015-12-13 21:53:57 +00:00
Get rid of the extra layer of flags and cmd_prepare() and just store the CMD_FIND_* flags in the cmd_entry and call it for the command. Commands with special requirements call it themselves and update the target for hooks to use.
2017-04-22 10:22:39 +00:00
.target = { 't', CMD_FIND_SESSION, CMD_FIND_CANFAIL },
Instead of combined flags for -c, -s, -t, split into different sets using an enum and simplify the parsing code.
2015-12-14 00:31:54 +00:00
Add CMD_AFTERHOOK flag to the easy commands that don't need any special handling.
2016-10-14 22:14:22 +00:00
.flags = CMD_AFTERHOOK,
Use member names in cmd_entry definitions so I stop getting confused about the order.
2015-12-13 21:53:57 +00:00
.exec = cmd_set_environment_exec
Infrastructure and commands to manage the environment for processes started within tmux. There is a global environment, copied from the external environment when the server is started and each sesssion has an (initially empty) session environment which overrides it. New commands set-environment and show-environment manipulate or display the environments. A new session option, update-environment, is a space-separated list of variables which are updated from the external environment into the session environment every time a new session is created - the default is DISPLAY.
2009-08-08 21:52:43 +00:00
};
Add static in cmd-* and fix a few other nits.
2016-10-10 21:51:39 +00:00
static enum cmd_retval
Mass rename struct cmd_q to struct cmdq_item and related.
2016-10-16 19:04:05 +00:00
cmd_set_environment_exec(struct cmd *self, struct cmdq_item *item)
Infrastructure and commands to manage the environment for processes started within tmux. There is a global environment, copied from the external environment when the server is started and each sesssion has an (initially empty) session environment which overrides it. New commands set-environment and show-environment manipulate or display the environments. A new session option, update-environment, is a space-separated list of variables which are updated from the external environment into the session environment every time a new session is created - the default is DISPLAY.
2009-08-08 21:52:43 +00:00
{
Also move cmdq_item and cmdq_list into cmd-queue.c (this is to make its use more clearly defined and preparation for some future work).
2020-04-13 10:59:58 +00:00
struct args *args = cmd_get_args(self);
struct cmd_find_state *target = cmdq_get_target(item);
struct environ *env;
Hide struct args behind a couple of accessor functions.
2021-08-20 19:50:16 +00:00
const char *name = args_string(args, 0), *value;
const char *tflag;
char *expanded = NULL;
Add -F to set-environment and source-file; GitHub issue 2359.
2020-09-01 09:19:01 +00:00
enum cmd_retval retval = CMD_RETURN_NORMAL;
Infrastructure and commands to manage the environment for processes started within tmux. There is a global environment, copied from the external environment when the server is started and each sesssion has an (initially empty) session environment which overrides it. New commands set-environment and show-environment manipulate or display the environments. A new session option, update-environment, is a space-separated list of variables which are updated from the external environment into the session environment every time a new session is created - the default is DISPLAY.
2009-08-08 21:52:43 +00:00
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-04 00:42:46 +00:00
if (*name == '\0') {
Mass rename struct cmd_q to struct cmdq_item and related.
2016-10-16 19:04:05 +00:00
cmdq_error(item, "empty variable name");
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 07:10:15 +00:00
return (CMD_RETURN_ERROR);
Infrastructure and commands to manage the environment for processes started within tmux. There is a global environment, copied from the external environment when the server is started and each sesssion has an (initially empty) session environment which overrides it. New commands set-environment and show-environment manipulate or display the environments. A new session option, update-environment, is a space-separated list of variables which are updated from the external environment into the session environment every time a new session is created - the default is DISPLAY.
2009-08-08 21:52:43 +00:00
}
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-04 00:42:46 +00:00
if (strchr(name, '=') != NULL) {
Mass rename struct cmd_q to struct cmdq_item and related.
2016-10-16 19:04:05 +00:00
cmdq_error(item, "variable name contains =");
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 07:10:15 +00:00
return (CMD_RETURN_ERROR);
Infrastructure and commands to manage the environment for processes started within tmux. There is a global environment, copied from the external environment when the server is started and each sesssion has an (initially empty) session environment which overrides it. New commands set-environment and show-environment manipulate or display the environments. A new session option, update-environment, is a space-separated list of variables which are updated from the external environment into the session environment every time a new session is created - the default is DISPLAY.
2009-08-08 21:52:43 +00:00
}
Hide struct args behind a couple of accessor functions.
2021-08-20 19:50:16 +00:00
if (args_count(args) < 2)
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-04 00:42:46 +00:00
value = NULL;
else
Hide struct args behind a couple of accessor functions.
2021-08-20 19:50:16 +00:00
value = args_string(args, 1);
if (value != NULL && args_has(args, 'F')) {
expanded = format_single_from_target(item, value);
value = expanded;
}
Make struct cmd local to cmd.c and move it out of tmux.h.
2020-04-13 08:26:27 +00:00
if (args_has(args, 'g'))
Like options, move the environ struct into environ.c.
2015-10-28 09:51:55 +00:00
env = global_environ;
show-* and set-* need to handle a missing target.
2016-03-03 14:15:22 +00:00
else {
Also move cmdq_item and cmdq_list into cmd-queue.c (this is to make its use more clearly defined and preparation for some future work).
2020-04-13 10:59:58 +00:00
if (target->s == NULL) {
tflag = args_get(args, 't');
if (tflag != NULL)
cmdq_error(item, "no such session: %s", tflag);
show-* and set-* need to handle a missing target.
2016-03-03 14:15:22 +00:00
else
Mass rename struct cmd_q to struct cmdq_item and related.
2016-10-16 19:04:05 +00:00
cmdq_error(item, "no current session");
Add -F to set-environment and source-file; GitHub issue 2359.
2020-09-01 09:19:01 +00:00
retval = CMD_RETURN_ERROR;
goto out;
show-* and set-* need to handle a missing target.
2016-03-03 14:15:22 +00:00
}
Also move cmdq_item and cmdq_list into cmd-queue.c (this is to make its use more clearly defined and preparation for some future work).
2020-04-13 10:59:58 +00:00
env = target->s->environ;
show-* and set-* need to handle a missing target.
2016-03-03 14:15:22 +00:00
}
Infrastructure and commands to manage the environment for processes started within tmux. There is a global environment, copied from the external environment when the server is started and each sesssion has an (initially empty) session environment which overrides it. New commands set-environment and show-environment manipulate or display the environments. A new session option, update-environment, is a space-separated list of variables which are updated from the external environment into the session environment every time a new session is created - the default is DISPLAY.
2009-08-08 21:52:43 +00:00
Make struct cmd local to cmd.c and move it out of tmux.h.
2020-04-13 08:26:27 +00:00
if (args_has(args, 'u')) {
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-04 00:42:46 +00:00
if (value != NULL) {
Mass rename struct cmd_q to struct cmdq_item and related.
2016-10-16 19:04:05 +00:00
cmdq_error(item, "can't specify a value with -u");
Add -F to set-environment and source-file; GitHub issue 2359.
2020-09-01 09:19:01 +00:00
retval = CMD_RETURN_ERROR;
goto out;
Infrastructure and commands to manage the environment for processes started within tmux. There is a global environment, copied from the external environment when the server is started and each sesssion has an (initially empty) session environment which overrides it. New commands set-environment and show-environment manipulate or display the environments. A new session option, update-environment, is a space-separated list of variables which are updated from the external environment into the session environment every time a new session is created - the default is DISPLAY.
2009-08-08 21:52:43 +00:00
}
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-04 00:42:46 +00:00
environ_unset(env, name);
Make struct cmd local to cmd.c and move it out of tmux.h.
2020-04-13 08:26:27 +00:00
} else if (args_has(args, 'r')) {
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-04 00:42:46 +00:00
if (value != NULL) {
Mass rename struct cmd_q to struct cmdq_item and related.
2016-10-16 19:04:05 +00:00
cmdq_error(item, "can't specify a value with -r");
Add -F to set-environment and source-file; GitHub issue 2359.
2020-09-01 09:19:01 +00:00
retval = CMD_RETURN_ERROR;
goto out;
Infrastructure and commands to manage the environment for processes started within tmux. There is a global environment, copied from the external environment when the server is started and each sesssion has an (initially empty) session environment which overrides it. New commands set-environment and show-environment manipulate or display the environments. A new session option, update-environment, is a space-separated list of variables which are updated from the external environment into the session environment every time a new session is created - the default is DISPLAY.
2009-08-08 21:52:43 +00:00
}
Make environ_set va_args and use it to tidy up some calls. Also add a missing word in manpage (from jmc).
2015-11-24 23:46:15 +00:00
environ_clear(env, name);
Infrastructure and commands to manage the environment for processes started within tmux. There is a global environment, copied from the external environment when the server is started and each sesssion has an (initially empty) session environment which overrides it. New commands set-environment and show-environment manipulate or display the environments. A new session option, update-environment, is a space-separated list of variables which are updated from the external environment into the session environment every time a new session is created - the default is DISPLAY.
2009-08-08 21:52:43 +00:00
} else {
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-04 00:42:46 +00:00
if (value == NULL) {
Mass rename struct cmd_q to struct cmdq_item and related.
2016-10-16 19:04:05 +00:00
cmdq_error(item, "no value specified");
Add -F to set-environment and source-file; GitHub issue 2359.
2020-09-01 09:19:01 +00:00
retval = CMD_RETURN_ERROR;
goto out;
Infrastructure and commands to manage the environment for processes started within tmux. There is a global environment, copied from the external environment when the server is started and each sesssion has an (initially empty) session environment which overrides it. New commands set-environment and show-environment manipulate or display the environments. A new session option, update-environment, is a space-separated list of variables which are updated from the external environment into the session environment every time a new session is created - the default is DISPLAY.
2009-08-08 21:52:43 +00:00
}
Add -F to set-environment and source-file; GitHub issue 2359.
2020-09-01 09:19:01 +00:00
Add a way to mark environment variables as "hidden" so they can be used by tmux but are not passed into the environment of new panes.
2020-03-31 17:14:40 +00:00
if (args_has(args, 'h'))
environ_set(env, name, ENVIRON_HIDDEN, "%s", value);
else
environ_set(env, name, 0, "%s", value);
Infrastructure and commands to manage the environment for processes started within tmux. There is a global environment, copied from the external environment when the server is started and each sesssion has an (initially empty) session environment which overrides it. New commands set-environment and show-environment manipulate or display the environments. A new session option, update-environment, is a space-separated list of variables which are updated from the external environment into the session environment every time a new session is created - the default is DISPLAY.
2009-08-08 21:52:43 +00:00
}
Add -F to set-environment and source-file; GitHub issue 2359.
2020-09-01 09:19:01 +00:00
out:
Hide struct args behind a couple of accessor functions.
2021-08-20 19:50:16 +00:00
free(expanded);
Add -F to set-environment and source-file; GitHub issue 2359.
2020-09-01 09:19:01 +00:00
return (retval);
Infrastructure and commands to manage the environment for processes started within tmux. There is a global environment, copied from the external environment when the server is started and each sesssion has an (initially empty) session environment which overrides it. New commands set-environment and show-environment manipulate or display the environments. A new session option, update-environment, is a space-separated list of variables which are updated from the external environment into the session environment every time a new session is created - the default is DISPLAY.
2009-08-08 21:52:43 +00:00
}
Reference in New Issue Copy Permalink