add help text
[oweals/busybox.git] / debianutils / run_parts.c
index 56f70c6eea22841947a03acca4b2f9edbd7bbc80..0c230269635f000cb5a510b3b81f09beb798b5ae 100644 (file)
@@ -2,7 +2,7 @@
 /*
  * Mini run-parts implementation for busybox
  *
- * Copyright (C) 2007 Bernhard Fischer
+ * Copyright (C) 2007 Bernhard Reutner-Fischer
  *
  * Based on a older version that was in busybox which was 1k big..
  *   Copyright (C) 2001 by Emanuele Aina <emanuele.aina@tiscali.it>
@@ -12,7 +12,7 @@
  *   Copyright (C) 1996-1999 Guy Maor <maor@debian.org>
  *
  *
- * Licensed under GPL v2 or later, see file LICENSE in this tarball for details.
+ * Licensed under GPLv2 or later, see file LICENSE in this source tree.
  */
 
 /* This is my first attempt to write a program in C (well, this is my first
  * report mode. As the original run-parts support only long options, I've
  * broken compatibility because the BusyBox policy doesn't allow them.
  * The supported options are:
- * -t                  test. Print the name of the files to be executed, without
- *                             execute them.
- * -a ARG              argument. Pass ARG as an argument the program executed. It can
- *                             be repeated to pass multiple arguments.
- * -u MASK             umask. Set the umask of the program executed to MASK.
+ * -t           test. Print the name of the files to be executed, without
+ *              execute them.
+ * -a ARG       argument. Pass ARG as an argument the program executed. It can
+ *              be repeated to pass multiple arguments.
+ * -u MASK      umask. Set the umask of the program executed to MASK.
  */
 
-#include <getopt.h>
+//usage:#define run_parts_trivial_usage
+//usage:       "[-t] "IF_FEATURE_RUN_PARTS_FANCY("[-l] ")"[-a ARG] [-u MASK] DIRECTORY"
+//usage:#define run_parts_full_usage "\n\n"
+//usage:       "Run a bunch of scripts in DIRECTORY\n"
+//usage:     "\nOptions:"
+//usage:     "\n       -t      Print what would be run, but don't actually run anything"
+//usage:     "\n       -a ARG  Pass ARG as argument for every program"
+//usage:     "\n       -u MASK Set the umask to MASK before running every program"
+//usage:       IF_FEATURE_RUN_PARTS_FANCY(
+//usage:     "\n       -l      Print names of all matching files even if they are not executable"
+//usage:       )
+//usage:
+//usage:#define run_parts_example_usage
+//usage:       "$ run-parts -a start /etc/init.d\n"
+//usage:       "$ run-parts -a stop=now /etc/init.d\n\n"
+//usage:       "Let's assume you have a script foo/dosomething:\n"
+//usage:       "#!/bin/sh\n"
+//usage:       "for i in $*; do eval $i; done; unset i\n"
+//usage:       "case \"$1\" in\n"
+//usage:       "start*) echo starting something;;\n"
+//usage:       "stop*) set -x; shutdown -h $stop;;\n"
+//usage:       "esac\n\n"
+//usage:       "Running this yields:\n"
+//usage:       "$run-parts -a stop=+4m foo/\n"
+//usage:       "+ shutdown -h +4m"
 
 #include "libbb.h"
 
@@ -38,23 +62,24 @@ struct globals {
        char **names;
        int    cur;
        char  *cmd[1];
-};
+} FIX_ALIASING;
 #define G (*(struct globals*)&bb_common_bufsiz1)
 #define names (G.names)
 #define cur   (G.cur  )
 #define cmd   (G.cmd  )
 
-enum { NUM_CMD = (COMMON_BUFSIZE - sizeof(struct globals)) / sizeof(cmd[0]) };
+enum { NUM_CMD = (COMMON_BUFSIZE - sizeof(G)) / sizeof(cmd[0]) - 1 };
 
 enum {
-       RUN_PARTS_OPT_a = (1 << 0),
-       RUN_PARTS_OPT_u = (1 << 1),
-       RUN_PARTS_OPT_t = (1 << 2),
-       RUN_PARTS_OPT_l = (1 << 3) * ENABLE_FEATURE_RUN_PARTS_FANCY,
+       OPT_r = (1 << 0),
+       OPT_a = (1 << 1),
+       OPT_u = (1 << 2),
+       OPT_t = (1 << 3),
+       OPT_l = (1 << 4) * ENABLE_FEATURE_RUN_PARTS_FANCY,
 };
 
 #if ENABLE_FEATURE_RUN_PARTS_FANCY
-#define list_mode (option_mask32 & RUN_PARTS_OPT_l)
+#define list_mode (option_mask32 & OPT_l)
 #else
 #define list_mode 0
 #endif
@@ -74,10 +99,11 @@ static bool invalid_name(const char *c)
 
 static int bb_alphasort(const void *p1, const void *p2)
 {
-       return strcmp(*(char **) p1, *(char **) p2);
+       int r = strcmp(*(char **) p1, *(char **) p2);
+       return (option_mask32 & OPT_r) ? -r : r;
 }
 
-static int act(const char *file, struct stat *statbuf, void *args, int depth)
+static int FAST_FUNC act(const char *file, struct stat *statbuf, void *args UNUSED_PARAM, int depth)
 {
        if (depth == 1)
                return TRUE;
@@ -90,9 +116,9 @@ static int act(const char *file, struct stat *statbuf, void *args, int depth)
                return SKIP;
        }
 
-       names = xrealloc(names, (cur + 2) * sizeof(names[0]));
+       names = xrealloc_vector(names, 4, cur);
        names[cur++] = xstrdup(file);
-       names[cur] = NULL;
+       /*names[cur] = NULL; - xrealloc_vector did it */
 
        return TRUE;
 }
@@ -104,14 +130,14 @@ static const char runparts_longopts[] ALIGN1 =
        "test\0"    No_argument       "t"
 #if ENABLE_FEATURE_RUN_PARTS_FANCY
        "list\0"    No_argument       "l"
-//TODO: "reverse\0" No_argument       "r"
+       "reverse\0" No_argument       "r"
 //TODO: "verbose\0" No_argument       "v"
 #endif
        ;
 #endif
 
-int run_parts_main(int argc, char **argv);
-int run_parts_main(int argc, char **argv)
+int run_parts_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
+int run_parts_main(int argc UNUSED_PARAM, char **argv)
 {
        const char *umask_p = "22";
        llist_t *arg_list = NULL;
@@ -123,15 +149,13 @@ int run_parts_main(int argc, char **argv)
 #endif
        /* We require exactly one argument: the directory name */
        opt_complementary = "=1:a::";
-       getopt32(argv, "a:u:t"USE_FEATURE_RUN_PARTS_FANCY("l"), &arg_list, &umask_p);
+       getopt32(argv, "ra:u:t"IF_FEATURE_RUN_PARTS_FANCY("l"), &arg_list, &umask_p);
 
        umask(xstrtou_range(umask_p, 8, 0, 07777));
 
        n = 1;
        while (arg_list && n < NUM_CMD) {
-               cmd[n] = arg_list->data;
-               arg_list = arg_list->link;
-               n++;
+               cmd[n++] = llist_pop(&arg_list);
        }
        /* cmd[n] = NULL; - is already zeroed out */
 
@@ -155,19 +179,19 @@ int run_parts_main(int argc, char **argv)
                char *name = *names++;
                if (!name)
                        break;
-               if (option_mask32 & (RUN_PARTS_OPT_t | RUN_PARTS_OPT_l)) {
+               if (option_mask32 & (OPT_t | OPT_l)) {
                        puts(name);
                        continue;
                }
                cmd[0] = name;
-               ret = wait4pid(spawn(cmd));
+               ret = spawn_and_wait(cmd);
                if (ret == 0)
                        continue;
                n = 1;
                if (ret < 0)
-                       bb_perror_msg("failed to exec %s", name);
+                       bb_perror_msg("can't execute '%s'", name);
                else /* ret > 0 */
-                       bb_error_msg("%s exited with return code %d", name, ret);
+                       bb_error_msg("%s exited with code %d", name, ret & 0xff);
        }
 
        return n;