blob: 4715bf73afaee499c99be3063eaecc3dc1b63a82 [file] [log] [blame]
Eric Andersen84e229c2001-03-29 22:48:33 +00001/* vi: set sw=4 ts=4: */
2/*
3 * env implementation for busybox
4 *
5 * Copyright (c) 1988, 1993, 1994
Denys Vlasenkoe4dcba12010-10-28 18:57:19 +02006 * The Regents of the University of California. All rights reserved.
Eric Andersen84e229c2001-03-29 22:48:33 +00007 *
Denys Vlasenko0ef64bd2010-08-16 20:14:46 +02008 * Licensed under GPLv2 or later, see file LICENSE in this source tree.
Eric Andersen84e229c2001-03-29 22:48:33 +00009 *
10 * Original copyright notice is retained at the end of this file.
11 *
Eric Andersencb81e642003-07-14 21:21:08 +000012 * Modified for BusyBox by Erik Andersen <andersen@codepoet.org>
Eric Andersen84e229c2001-03-29 22:48:33 +000013 */
Manuel Novoa III cad53642003-03-19 09:13:01 +000014/* Mar 16, 2003 Manuel Novoa III (mjn3@codepoet.org)
15 *
16 * Fixed bug involving exit return codes if execvp fails. Also added
17 * output error checking.
18 */
Eric Andersen05df91a2003-07-28 07:42:19 +000019/*
Eric Andersen7ff33f12004-04-16 15:02:10 +000020 * Modified by Vladimir Oleynik <dzo@simtreas.ru> (C) 2003
Eric Andersenaff114c2004-04-14 17:51:38 +000021 * - correct "-" option usage
Eric Andersen05df91a2003-07-28 07:42:19 +000022 * - multiple "-u unsetenv" support
23 * - GNU long option support
Denis Vlasenko40920822006-10-03 20:28:06 +000024 * - use xfunc_error_retval
Eric Andersen05df91a2003-07-28 07:42:19 +000025 */
Denys Vlasenkoaf3f4202016-11-23 14:46:56 +010026//config:config ENV
Denys Vlasenkob097a842018-12-28 03:20:17 +010027//config: bool "env (4 kb)"
Denys Vlasenkoaf3f4202016-11-23 14:46:56 +010028//config: default y
29//config: help
Denys Vlasenko72089cf2017-07-21 09:50:55 +020030//config: env is used to set an environment variable and run
31//config: a command; without options it displays the current
32//config: environment.
Eric Andersen05df91a2003-07-28 07:42:19 +000033
Denys Vlasenkoaf3f4202016-11-23 14:46:56 +010034//applet:IF_ENV(APPLET_NOEXEC(env, env, BB_DIR_USR_BIN, BB_SUID_DROP, env))
35
36//kbuild:lib-$(CONFIG_ENV) += env.o
37
38/* BB_AUDIT SUSv3 compliant */
39/* http://www.opengroup.org/onlinepubs/007904975/utilities/env.html */
Denis Vlasenkob7304742008-10-20 08:15:51 +000040
Pere Orga34425382011-03-31 14:43:25 +020041//usage:#define env_trivial_usage
Denys Vlasenko6b6826f2021-06-13 01:08:48 +020042//usage: "[-i] [-u NAME]... [-] [NAME=VALUE]... [PROG ARGS]"
43// The "-" can occur only once (unlike, say, -i): it terminates option processing,
44// so if it is followed by another "-" arg (or any option-looking arg),
45// that arg will be taken as PROG (or even as NAME=VALUE, example: "-z=QWE").
Pere Orga34425382011-03-31 14:43:25 +020046//usage:#define env_full_usage "\n\n"
Denys Vlasenko6b6826f2021-06-13 01:08:48 +020047//usage: "Print current environment or run PROG after setting up environment\n"
48//usage: "\n -, -i Start with empty environment"
49//usage: "\n -u NAME Remove variable from environment"
Pere Orga34425382011-03-31 14:43:25 +020050
Denis Vlasenkob6adbf12007-05-26 19:00:18 +000051#include "libbb.h"
52
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +000053int env_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +000054int env_main(int argc UNUSED_PARAM, char **argv)
Eric Andersen84e229c2001-03-29 22:48:33 +000055{
Denys Vlasenkof4fee412009-11-12 14:52:47 +010056 unsigned opts;
Eric Andersen1b1942f2003-11-07 11:20:21 +000057 llist_t *unset_env = NULL;
Eric Andersen84e229c2001-03-29 22:48:33 +000058
Ron Yorston8d8ee912017-12-25 21:36:05 +010059 opts = getopt32long(argv, "+iu:*",
Denys Vlasenko036585a2017-08-08 16:38:18 +020060 "ignore-environment\0" No_argument "i"
61 "unset\0" Required_argument "u"
62 , &unset_env
63 );
Manuel Novoa III cad53642003-03-19 09:13:01 +000064 argv += optind;
Denys Vlasenkof4fee412009-11-12 14:52:47 +010065 if (argv[0] && LONE_DASH(argv[0])) {
66 opts |= 1;
Manuel Novoa III cad53642003-03-19 09:13:01 +000067 ++argv;
Matt Kraai5b44f482001-05-11 14:26:29 +000068 }
Denys Vlasenkof4fee412009-11-12 14:52:47 +010069 if (opts & 1) {
Denis Vlasenkof3c2d132008-11-11 21:32:39 +000070 clearenv();
71 }
72 while (unset_env) {
73 char *var = llist_pop(&unset_env);
74 /* This does not handle -uVAR=VAL
75 * (coreutils _sets_ the variable in that case): */
76 /*unsetenv(var);*/
77 /* This does, but uses somewhan undocumented feature that
78 * putenv("name_without_equal_sign") unsets the variable: */
79 putenv(var);
Eric Andersen05df91a2003-07-28 07:42:19 +000080 }
81
Bernhard Reutner-Fischerd591a362006-08-20 17:35:13 +000082 while (*argv && (strchr(*argv, '=') != NULL)) {
Manuel Novoa III cad53642003-03-19 09:13:01 +000083 if (putenv(*argv) < 0) {
James Byrne69374872019-07-02 11:35:03 +020084 bb_simple_perror_msg_and_die("putenv");
Manuel Novoa III cad53642003-03-19 09:13:01 +000085 }
86 ++argv;
87 }
88
Denys Vlasenko41ddd9f2010-06-25 01:46:53 +020089 if (argv[0]) {
Pascal Bellard21e8e8d2010-07-04 00:57:03 +020090 BB_EXECVP_or_die(argv);
Eric Andersen84e229c2001-03-29 22:48:33 +000091 }
Manuel Novoa III cad53642003-03-19 09:13:01 +000092
Denys Vlasenkof4fee412009-11-12 14:52:47 +010093 if (environ) { /* clearenv() may set environ == NULL! */
94 char **ep;
95 for (ep = environ; *ep; ep++) {
96 puts(*ep);
97 }
Manuel Novoa III cad53642003-03-19 09:13:01 +000098 }
99
Bernhard Reutner-Fischer636a1f82008-05-19 09:29:47 +0000100 fflush_stdout_and_exit(EXIT_SUCCESS);
Eric Andersen84e229c2001-03-29 22:48:33 +0000101}
102
103/*
104 * Copyright (c) 1988, 1993, 1994
Eric Andersen05df91a2003-07-28 07:42:19 +0000105 * The Regents of the University of California. All rights reserved.
Eric Andersen84e229c2001-03-29 22:48:33 +0000106 *
107 * Redistribution and use in source and binary forms, with or without
108 * modification, are permitted provided that the following conditions
109 * are met:
110 * 1. Redistributions of source code must retain the above copyright
111 * notice, this list of conditions and the following disclaimer.
112 * 2. Redistributions in binary form must reproduce the above copyright
113 * notice, this list of conditions and the following disclaimer in the
114 * documentation and/or other materials provided with the distribution.
115 *
Denys Vlasenkoe4dcba12010-10-28 18:57:19 +0200116 * 3. BSD Advertising Clause omitted per the July 22, 1999 licensing change
117 * ftp://ftp.cs.berkeley.edu/pub/4bsd/README.Impt.License.Change
Eric Andersen84e229c2001-03-29 22:48:33 +0000118 *
119 * 4. Neither the name of the University nor the names of its contributors
120 * may be used to endorse or promote products derived from this software
121 * without specific prior written permission.
122 *
Denys Vlasenko95f79532017-08-02 14:26:33 +0200123 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ''AS IS'' AND
Eric Andersen84e229c2001-03-29 22:48:33 +0000124 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
125 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
126 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
127 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
128 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
129 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
130 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
131 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
132 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
133 * SUCH DAMAGE.
134 */