ash: builtin: Mark more regular built-ins
[oweals/busybox.git] / libbb / appletlib.c
index 805cd3ae69d0a9a15dcef5477a4009b2b868879a..f842e73cc28d6a8b8d05bc48f620dd6f3d0bdda4 100644 (file)
@@ -11,7 +11,6 @@
  *
  * Licensed under GPLv2 or later, see file LICENSE in this source tree.
  */
-
 /* We are trying to not use printf, this benefits the case when selected
  * applets are really simple. Example:
  *
@@ -34,7 +33,6 @@
 # include <malloc.h> /* for mallopt */
 #endif
 
-
 /* Declare <applet>_main() */
 #define PROTOTYPES
 #include "applets.h"
 
 #include "usage_compressed.h"
 
+#if ENABLE_FEATURE_SH_EMBEDDED_SCRIPTS
+# define DEFINE_SCRIPT_DATA 1
+# include "embedded_scripts.h"
+#else
+# define NUM_SCRIPTS 0
+#endif
+#if NUM_SCRIPTS > 0
+# include "bb_archive.h"
+static const char packed_scripts[] ALIGN1 = { PACKED_SCRIPTS };
+#endif
+
+/* "Do not compress usage text if uncompressed text is small
+ *  and we don't include bunzip2 code for other reasons"
+ *
+ * Useful for mass one-applet rebuild (bunzip2 code is ~2.7k).
+ *
+ * Unlike BUNZIP2, if FEATURE_SEAMLESS_BZ2 is on, bunzip2 code is built but
+ * still may be unused if none of the selected applets calls open_zipped()
+ * or its friends; we test for (FEATURE_SEAMLESS_BZ2 && <APPLET>) instead.
+ * For example, only if TAR and FEATURE_SEAMLESS_BZ2 are both selected,
+ * then bunzip2 code will be linked in anyway, and disabling help compression
+ * would be not optimal:
+ */
+#if UNPACKED_USAGE_LENGTH < 4*1024 \
+ && !(ENABLE_FEATURE_SEAMLESS_BZ2 && ENABLE_TAR) \
+ && !(ENABLE_FEATURE_SEAMLESS_BZ2 && ENABLE_MODPROBE) \
+ && !(ENABLE_FEATURE_SEAMLESS_BZ2 && ENABLE_INSMOD) \
+ && !(ENABLE_FEATURE_SEAMLESS_BZ2 && ENABLE_DEPMOD) \
+ && !(ENABLE_FEATURE_SEAMLESS_BZ2 && ENABLE_MAN) \
+ && !ENABLE_BUNZIP2 \
+ && !ENABLE_BZCAT
+# undef  ENABLE_FEATURE_COMPRESS_USAGE
+# define ENABLE_FEATURE_COMPRESS_USAGE 0
+#endif
+
+
+unsigned FAST_FUNC string_array_len(char **argv)
+{
+       char **start = argv;
+
+       while (*argv)
+               argv++;
+
+       return argv - start;
+}
+
+
 #if ENABLE_SHOW_USAGE && !ENABLE_FEATURE_COMPRESS_USAGE
 static const char usage_messages[] ALIGN1 = UNPACKED_USAGE;
 #else
@@ -62,27 +107,8 @@ static const char usage_messages[] ALIGN1 = UNPACKED_USAGE;
 
 static const char packed_usage[] ALIGN1 = { PACKED_USAGE };
 # include "bb_archive.h"
-static const char *unpack_usage_messages(void)
-{
-       char *outbuf = NULL;
-       bunzip_data *bd;
-       int i;
-
-       i = start_bunzip(&bd,
-                       /* src_fd: */ -1,
-                       /* inbuf:  */ packed_usage,
-                       /* len:    */ sizeof(packed_usage));
-       /* read_bunzip can longjmp to start_bunzip, and ultimately
-        * end up here with i != 0 on read data errors! Not trivial */
-       if (!i) {
-               /* Cannot use xmalloc: will leak bd in NOFORK case! */
-               outbuf = malloc_or_warn(sizeof(UNPACKED_USAGE));
-               if (outbuf)
-                       read_bunzip(bd, outbuf, sizeof(UNPACKED_USAGE));
-       }
-       dealloc_bunzip(bd);
-       return outbuf;
-}
+# define unpack_usage_messages() \
+       unpack_bz2_data(packed_usage, sizeof(packed_usage), sizeof(UNPACKED_USAGE))
 # define dealloc_usage_messages(s) free(s)
 
 #else
@@ -97,38 +123,43 @@ void FAST_FUNC bb_show_usage(void)
 {
        if (ENABLE_SHOW_USAGE) {
 #ifdef SINGLE_APPLET_STR
-               /* Imagine that this applet is "true". Dont suck in printf! */
+               /* Imagine that this applet is "true". Dont link in printf! */
                const char *usage_string = unpack_usage_messages();
 
-               if (*usage_string == '\b') {
-                       full_write2_str("No help available.\n\n");
-               } else {
-                       full_write2_str("Usage: "SINGLE_APPLET_STR" ");
-                       full_write2_str(usage_string);
-                       full_write2_str("\n\n");
+               if (usage_string) {
+                       if (*usage_string == '\b') {
+                               full_write2_str("No help available\n");
+                       } else {
+                               full_write2_str("Usage: "SINGLE_APPLET_STR" ");
+                               full_write2_str(usage_string);
+                               full_write2_str("\n");
+                       }
+                       if (ENABLE_FEATURE_CLEAN_UP)
+                               dealloc_usage_messages((char*)usage_string);
                }
-               if (ENABLE_FEATURE_CLEAN_UP)
-                       dealloc_usage_messages((char*)usage_string);
 #else
                const char *p;
                const char *usage_string = p = unpack_usage_messages();
                int ap = find_applet_by_name(applet_name);
 
-               if (ap < 0) /* never happens, paranoia */
+               if (ap < 0 || usage_string == NULL)
                        xfunc_die();
                while (ap) {
                        while (*p++) continue;
                        ap--;
                }
                full_write2_str(bb_banner);
-               full_write2_str(" multi-call binary.\n");
+               full_write2_str(" multi-call binary.\n"); /* common string */
                if (*p == '\b')
-                       full_write2_str("\nNo help available.\n\n");
+                       full_write2_str("\nNo help available\n");
                else {
                        full_write2_str("\nUsage: ");
                        full_write2_str(applet_name);
-                       full_write2_str(" ");
-                       full_write2_str(p);
+                       if (p[0]) {
+                               if (p[0] != '\n')
+                                       full_write2_str(" ");
+                               full_write2_str(p);
+                       }
                        full_write2_str("\n");
                }
                if (ENABLE_FEATURE_CLEAN_UP)
@@ -273,7 +304,7 @@ void lbb_prepare(const char *applet
                IF_FEATURE_INDIVIDUAL(, char **argv))
 {
 #ifdef __GLIBC__
-       (*(int **)&bb_errno) = __errno_location();
+       (*(int **)not_const_pp(&bb_errno)) = __errno_location();
        barrier();
 #endif
        applet_name = applet;
@@ -600,7 +631,7 @@ static void check_suid(int applet_no)
                        /* same group / in group */
                        m >>= 3;
                if (!(m & S_IXOTH)) /* is x bit not set? */
-                       bb_error_msg_and_die("you have no permission to run this applet");
+                       bb_simple_error_msg_and_die("you have no permission to run this applet");
 
                /* We set effective AND saved ids. If saved-id is not set
                 * like we do below, seteuid(0) can still later succeed! */
@@ -612,7 +643,7 @@ static void check_suid(int applet_no)
                        rgid = sct->m_ugid.gid;
                /* else: we will set egid = rgid, thus dropping sgid effect */
                if (setresgid(-1, rgid, rgid))
-                       bb_perror_msg_and_die("setresgid");
+                       bb_simple_perror_msg_and_die("setresgid");
 
                /* Are we directed to change uid
                 * (APPLET = s** USER.GROUP or APPLET = S** USER.GROUP)?
@@ -622,7 +653,7 @@ static void check_suid(int applet_no)
                        uid = sct->m_ugid.uid;
                /* else: we will set euid = ruid, thus dropping suid effect */
                if (setresuid(-1, uid, uid))
-                       bb_perror_msg_and_die("setresuid");
+                       bb_simple_perror_msg_and_die("setresuid");
 
                goto ret;
        }
@@ -632,7 +663,7 @@ static void check_suid(int applet_no)
 
                if (!onetime) {
                        onetime = 1;
-                       bb_error_msg("using fallback suid method");
+                       bb_simple_error_msg("using fallback suid method");
                }
        }
 #   endif
@@ -642,10 +673,23 @@ static void check_suid(int applet_no)
                /* Real uid is not 0. If euid isn't 0 too, suid bit
                 * is most probably not set on our executable */
                if (geteuid())
-                       bb_error_msg_and_die("must be suid to work properly");
+                       bb_simple_error_msg_and_die("must be suid to work properly");
        } else if (APPLET_SUID(applet_no) == BB_SUID_DROP) {
-               xsetgid(rgid);  /* drop all privileges */
-               xsetuid(ruid);
+               /*
+                * Drop all privileges.
+                *
+                * Don't check for errors: in normal use, they are impossible,
+                * and in special cases, exiting is harmful. Example:
+                * 'unshare --user' when user's shell is also from busybox.
+                *
+                * 'unshare --user' creates a new user namespace without any
+                * uid mappings. Thus, busybox binary is setuid nobody:nogroup
+                * within the namespace, as that is the only user. However,
+                * since no uids are mapped, calls to setgid/setuid
+                * fail (even though they would do nothing).
+                */
+               setgid(rgid);
+               setuid(ruid);
        }
 #  if ENABLE_FEATURE_SUID_CONFIG
  ret: ;
@@ -679,7 +723,7 @@ static void install_links(const char *busybox, int use_symbolic_links,
         * busybox.h::bb_install_loc_t, or else... */
        int (*lf)(const char *, const char *);
        char *fpc;
-        const char *appname = applet_names;
+       const char *appname = applet_names;
        unsigned i;
        int rc;
 
@@ -710,11 +754,71 @@ static void install_links(const char *busybox UNUSED_PARAM,
 }
 # endif
 
-# if ENABLE_BUSYBOX
 static void run_applet_and_exit(const char *name, char **argv) NORETURN;
 
-/* If we were called as "busybox..." */
-static int busybox_main(char **argv)
+# if NUM_SCRIPTS > 0
+static int find_script_by_name(const char *name)
+{
+       int i;
+       int applet = find_applet_by_name(name);
+
+       if (applet >= 0) {
+               for (i = 0; i < NUM_SCRIPTS; ++i)
+                       if (applet_numbers[i] == applet)
+                               return i;
+       }
+       return -1;
+}
+
+int scripted_main(int argc UNUSED_PARAM, char **argv) MAIN_EXTERNALLY_VISIBLE;
+int scripted_main(int argc UNUSED_PARAM, char **argv)
+{
+       int script = find_script_by_name(applet_name);
+       if (script >= 0)
+#if ENABLE_ASH || ENABLE_SH_IS_ASH || ENABLE_BASH_IS_ASH
+               exit(ash_main(-script - 1, argv));
+#elif ENABLE_HUSH || ENABLE_SH_IS_HUSH || ENABLE_BASH_IS_HUSH
+               exit(hush_main(-script - 1, argv));
+#else
+               return 1;
+#endif
+       return 0;
+}
+
+char* FAST_FUNC
+get_script_content(unsigned n)
+{
+       char *t = unpack_bz2_data(packed_scripts, sizeof(packed_scripts),
+                                       UNPACKED_SCRIPTS_LENGTH);
+       if (t) {
+               while (n != 0) {
+                       while (*t++ != '\0')
+                               continue;
+                       n--;
+               }
+       }
+       return t;
+}
+# endif /* NUM_SCRIPTS > 0 */
+
+# if ENABLE_BUSYBOX
+#  if ENABLE_FEATURE_SH_STANDALONE && ENABLE_FEATURE_TAB_COMPLETION
+    /*
+     * Insert "busybox" into applet table as well.
+     * This makes standalone shell tab-complete this name too.
+     * (Otherwise having "busybox" in applet table is not necessary,
+     * there is other code which routes "busyboxANY_SUFFIX" name
+     * to busybox_main()).
+     */
+//usage:#define busybox_trivial_usage NOUSAGE_STR
+//usage:#define busybox_full_usage ""
+//applet:IF_BUSYBOX(IF_FEATURE_SH_STANDALONE(IF_FEATURE_TAB_COMPLETION(APPLET(busybox, BB_DIR_BIN, BB_SUID_MAYBE))))
+int busybox_main(int argc, char *argv[]) MAIN_EXTERNALLY_VISIBLE;
+#  else
+#   define busybox_main(argc,argv) busybox_main(argv)
+static
+#  endif
+int busybox_main(int argc UNUSED_PARAM, char **argv)
 {
        if (!argv[1]) {
                /* Called without arguments */
@@ -722,11 +826,7 @@ static int busybox_main(char **argv)
                int col;
                unsigned output_width;
  help:
-               output_width = 80;
-               if (ENABLE_FEATURE_AUTOWIDTH) {
-                       /* Obtain the terminal width */
-                       output_width = get_terminal_width(2);
-               }
+               output_width = get_terminal_width(2);
 
                dup2(1, 2);
                full_write2_str(bb_banner); /* reuse const string */
@@ -738,6 +838,9 @@ static int busybox_main(char **argv)
                        "\n"
                        "Usage: busybox [function [arguments]...]\n"
                        "   or: busybox --list"IF_FEATURE_INSTALLER("[-full]")"\n"
+#  if ENABLE_FEATURE_SHOW_SCRIPT && NUM_SCRIPTS > 0
+                       "   or: busybox --show SCRIPT\n"
+#  endif
                        IF_FEATURE_INSTALLER(
                        "   or: busybox --install [-s] [DIR]\n"
                        )
@@ -760,9 +863,9 @@ static int busybox_main(char **argv)
                        "Currently defined functions:\n"
                );
                col = 0;
-               a = applet_names;
                /* prevent last comma to be in the very last pos */
                output_width--;
+               a = applet_names;
                while (*a) {
                        int len2 = strlen(a) + 2;
                        if (col >= (int)output_width - len2) {
@@ -783,6 +886,19 @@ static int busybox_main(char **argv)
                return 0;
        }
 
+#  if ENABLE_FEATURE_SHOW_SCRIPT && NUM_SCRIPTS > 0
+       if (strcmp(argv[1], "--show") == 0) {
+               int n;
+               if (!argv[2])
+                       bb_error_msg_and_die(bb_msg_requires_arg, "--show");
+               n = find_script_by_name(argv[2]);
+               if (n < 0)
+                       bb_error_msg_and_die("script '%s' not found", argv[2]);
+               full_write1_str(get_script_content(n));
+               return 0;
+       }
+#  endif
+
        if (is_prefixed_with(argv[1], "--list")) {
                unsigned i = 0;
                const char *a = applet_names;
@@ -844,16 +960,15 @@ static int busybox_main(char **argv)
 # endif
 
 # if NUM_APPLETS > 0
-void FAST_FUNC run_applet_no_and_exit(int applet_no, char **argv)
+void FAST_FUNC run_applet_no_and_exit(int applet_no, const char *name, char **argv)
 {
-       int argc = 1;
+       int argc = string_array_len(argv);
 
-       while (argv[argc])
-               argc++;
-
-       /* Reinit some shared global data */
-       xfunc_error_retval = EXIT_FAILURE;
-       applet_name = bb_get_last_path_component_nostrip(argv[0]);
+       /*
+        * We do not use argv[0]: do not want to repeat massaging of
+        * "-/sbin/halt" -> "halt", for example.
+        */
+       applet_name = name;
 
        /* Special case. POSIX says "test --help"
         * should be no different from e.g. "test --foo".
@@ -890,14 +1005,14 @@ static NORETURN void run_applet_and_exit(const char *name, char **argv)
 {
 #  if ENABLE_BUSYBOX
        if (is_prefixed_with(name, "busybox"))
-               exit(busybox_main(argv));
+               exit(busybox_main(/*unused:*/ 0, argv));
 #  endif
 #  if NUM_APPLETS > 0
        /* find_applet_by_name() search is more expensive, so goes second */
        {
                int applet = find_applet_by_name(name);
                if (applet >= 0)
-                       run_applet_no_and_exit(applet, argv);
+                       run_applet_no_and_exit(applet, name, argv);
        }
 #  endif
 
@@ -971,7 +1086,11 @@ int main(int argc UNUSED_PARAM, char **argv)
        }
        /* applet_names in this case is just "applet\0\0" */
        lbb_prepare(applet_names IF_FEATURE_INDIVIDUAL(, argv));
+# if ENABLE_BUILD_LIBBUSYBOX
+       return SINGLE_APPLET_MAIN(string_array_len(argv), argv);
+# else
        return SINGLE_APPLET_MAIN(argc, argv);
+# endif
 
 #elif !ENABLE_BUSYBOX && NUM_APPLETS == 0
 
@@ -990,6 +1109,16 @@ int main(int argc UNUSED_PARAM, char **argv)
        if (applet_name[0] == '-')
                applet_name++;
        applet_name = bb_basename(applet_name);
+
+       /* If we are a result of execv("/proc/self/exe"), fix ugly comm of "exe" */
+       if (ENABLE_FEATURE_SH_STANDALONE
+        || ENABLE_FEATURE_PREFER_APPLETS
+        || !BB_MMU
+       ) {
+               if (NUM_APPLETS > 1)
+                       set_task_comm(applet_name);
+       }
+
        parse_config_file(); /* ...maybe, if FEATURE_SUID_CONFIG */
        run_applet_and_exit(applet_name, argv);