Big cleanup in config help and description
[oweals/busybox.git] / coreutils / chown.c
index c14c62db674c9280dfe2d4c609774744c83b78ac..12cd0eacccbf2f46048bfd552d5108bd5cbc258f 100644 (file)
@@ -4,25 +4,64 @@
  *
  * Copyright (C) 1999-2004 by Erik Andersen <andersen@codepoet.org>
  *
- * Licensed under GPLv2 or later, see file LICENSE in this tarball for details.
+ * Licensed under GPLv2 or later, see file LICENSE in this source tree.
  */
+//config:config CHOWN
+//config:      bool "chown"
+//config:      default y
+//config:      help
+//config:        chown is used to change the user and/or group ownership
+//config:        of files.
+//config:
+//config:config FEATURE_CHOWN_LONG_OPTIONS
+//config:      bool "Enable long options"
+//config:      default y
+//config:      depends on CHOWN && LONG_OPTS
+
+//applet:IF_CHOWN(APPLET_NOEXEC(chown, chown, BB_DIR_BIN, BB_SUID_DROP, chown))
+
+//kbuild:lib-$(CONFIG_CHOWN) += chown.o
 
 /* BB_AUDIT SUSv3 defects - none? */
-/* BB_AUDIT GNU defects - unsupported long options. */
 /* http://www.opengroup.org/onlinepubs/007904975/utilities/chown.html */
 
+//usage:#define chown_trivial_usage
+//usage:       "[-Rh"IF_DESKTOP("LHPcvf")"]... USER[:[GRP]] FILE..."
+//usage:#define chown_full_usage "\n\n"
+//usage:       "Change the owner and/or group of each FILE to USER and/or GRP\n"
+//usage:     "\n       -R      Recurse"
+//usage:     "\n       -h      Affect symlinks instead of symlink targets"
+//usage:       IF_DESKTOP(
+//usage:     "\n       -L      Traverse all symlinks to directories"
+//usage:     "\n       -H      Traverse symlinks on command line only"
+//usage:     "\n       -P      Don't traverse symlinks (default)"
+//usage:     "\n       -c      List changed files"
+//usage:     "\n       -v      List all files"
+//usage:     "\n       -f      Hide errors"
+//usage:       )
+//usage:
+//usage:#define chown_example_usage
+//usage:       "$ ls -l /tmp/foo\n"
+//usage:       "-r--r--r--    1 andersen andersen        0 Apr 12 18:25 /tmp/foo\n"
+//usage:       "$ chown root /tmp/foo\n"
+//usage:       "$ ls -l /tmp/foo\n"
+//usage:       "-r--r--r--    1 root     andersen        0 Apr 12 18:25 /tmp/foo\n"
+//usage:       "$ chown root.root /tmp/foo\n"
+//usage:       "ls -l /tmp/foo\n"
+//usage:       "-r--r--r--    1 root     root            0 Apr 12 18:25 /tmp/foo\n"
+
 #include "libbb.h"
 
 /* This is a NOEXEC applet. Be very careful! */
 
 
-#define OPT_STR     ("Rh" USE_DESKTOP("vcfLHP"))
+#define OPT_STR     ("Rh" IF_DESKTOP("vcfLHP"))
 #define BIT_RECURSE 1
-#define OPT_RECURSE (option_mask32 & 1)
-#define OPT_NODEREF (option_mask32 & 2)
-#define OPT_VERBOSE (USE_DESKTOP(option_mask32 & 0x04) SKIP_DESKTOP(0))
-#define OPT_CHANGED (USE_DESKTOP(option_mask32 & 0x08) SKIP_DESKTOP(0))
-#define OPT_QUIET   (USE_DESKTOP(option_mask32 & 0x10) SKIP_DESKTOP(0))
+#define OPT_RECURSE (opt & 1)
+#define OPT_NODEREF (opt & 2)
+#define OPT_VERBOSE (IF_DESKTOP(opt & 0x04) IF_NOT_DESKTOP(0))
+#define OPT_CHANGED (IF_DESKTOP(opt & 0x08) IF_NOT_DESKTOP(0))
+#define OPT_QUIET   (IF_DESKTOP(opt & 0x10) IF_NOT_DESKTOP(0))
 /* POSIX options
  * -L traverse every symbolic link to a directory encountered
  * -H if a command line argument is a symbolic link to a directory, traverse it
  * The last option specified shall determine the behavior of the utility." */
 /* -L */
 #define BIT_TRAVERSE 0x20
-#define OPT_TRAVERSE (USE_DESKTOP(option_mask32 & BIT_TRAVERSE) SKIP_DESKTOP(0))
+#define OPT_TRAVERSE (IF_DESKTOP(opt & BIT_TRAVERSE) IF_NOT_DESKTOP(0))
 /* -H or -L */
 #define BIT_TRAVERSE_TOP (0x20|0x40)
-#define OPT_TRAVERSE_TOP (USE_DESKTOP(option_mask32 & BIT_TRAVERSE_TOP) SKIP_DESKTOP(0))
+#define OPT_TRAVERSE_TOP (IF_DESKTOP(opt & BIT_TRAVERSE_TOP) IF_NOT_DESKTOP(0))
+
+#if ENABLE_FEATURE_CHOWN_LONG_OPTIONS
+static const char chown_longopts[] ALIGN1 =
+       "recursive\0"        No_argument   "R"
+       "dereference\0"      No_argument   "\xff"
+       "no-dereference\0"   No_argument   "h"
+# if ENABLE_DESKTOP
+       "changes\0"          No_argument   "c"
+       "silent\0"           No_argument   "f"
+       "quiet\0"            No_argument   "f"
+       "verbose\0"          No_argument   "v"
+# endif
+       ;
+#endif
 
 typedef int (*chown_fptr)(const char *, uid_t, gid_t);
 
-static struct bb_uidgid_t ugid = { -1, -1 };
+struct param_t {
+       struct bb_uidgid_t ugid;
+       chown_fptr chown_func;
+};
 
 static int FAST_FUNC fileAction(const char *fileName, struct stat *statbuf,
-               void *cf, int depth ATTRIBUTE_UNUSED)
+               void *vparam, int depth UNUSED_PARAM)
 {
-       uid_t u = (ugid.uid == (uid_t)-1) ? statbuf->st_uid : ugid.uid;
-       gid_t g = (ugid.gid == (gid_t)-1) ? statbuf->st_gid : ugid.gid;
+#define param  (*(struct param_t*)vparam)
+#define opt option_mask32
+       uid_t u = (param.ugid.uid == (uid_t)-1L) ? statbuf->st_uid : param.ugid.uid;
+       gid_t g = (param.ugid.gid == (gid_t)-1L) ? statbuf->st_gid : param.ugid.gid;
 
-       if (!((chown_fptr)cf)(fileName, u, g)) {
+       if (param.chown_func(fileName, u, g) == 0) {
                if (OPT_VERBOSE
                 || (OPT_CHANGED && (statbuf->st_uid != u || statbuf->st_gid != g))
                ) {
@@ -57,27 +115,32 @@ static int FAST_FUNC fileAction(const char *fileName, struct stat *statbuf,
                return TRUE;
        }
        if (!OPT_QUIET)
-               bb_simple_perror_msg(fileName); /* A filename can have % in it... */
+               bb_simple_perror_msg(fileName);
        return FALSE;
+#undef opt
+#undef param
 }
 
-int chown_main(int argc ATTRIBUTE_UNUSED, char **argv)
+int chown_main(int argc UNUSED_PARAM, char **argv)
 {
        int retval = EXIT_SUCCESS;
-       int flags;
-       chown_fptr chown_func;
+       int opt, flags;
+       struct param_t param;
 
+#if ENABLE_FEATURE_CHOWN_LONG_OPTIONS
+       applet_long_options = chown_longopts;
+#endif
        opt_complementary = "-2";
-       getopt32(argv, OPT_STR);
+       opt = getopt32(argv, OPT_STR);
        argv += optind;
 
        /* This matches coreutils behavior (almost - see below) */
-       chown_func = chown;
+       param.chown_func = chown;
        if (OPT_NODEREF
-           /* || (OPT_RECURSE && !OPT_TRAVERSE_TOP): */
-           USE_DESKTOP( || (option_mask32 & (BIT_RECURSE|BIT_TRAVERSE_TOP)) == BIT_RECURSE)
+       /* || (OPT_RECURSE && !OPT_TRAVERSE_TOP): */
+       IF_DESKTOP( || (opt & (BIT_RECURSE|BIT_TRAVERSE_TOP)) == BIT_RECURSE)
        ) {
-               chown_func = lchown;
+               param.chown_func = lchown;
        }
 
        flags = ACTION_DEPTHFIRST; /* match coreutils order */
@@ -88,21 +151,20 @@ int chown_main(int argc ATTRIBUTE_UNUSED, char **argv)
        if (OPT_TRAVERSE)
                flags |= ACTION_FOLLOWLINKS; /* follow links if -L */
 
-       parse_chown_usergroup_or_die(&ugid, argv[0]);
+       parse_chown_usergroup_or_die(&param.ugid, argv[0]);
 
        /* Ok, ready to do the deed now */
-       argv++;
-       do {
+       while (*++argv) {
                if (!recursive_action(*argv,
                                flags,          /* flags */
                                fileAction,     /* file action */
                                fileAction,     /* dir action */
-                               chown_func,     /* user data */
+                               &param,         /* user data */
                                0)              /* depth */
                ) {
                        retval = EXIT_FAILURE;
                }
-       } while (*++argv);
+       }
 
        return retval;
 }