Begin using Doxygen-style comments.

[apply-default-acl.git] / src / apply-default-acl.c

diff --git a/src/apply-default-acl.c b/src/apply-default-acl.c
index 2111e0eeda08b1b16335710b82a4936f2e353ae7..f6aa5be75e860a6cf459fbf788d77614dfabcbe5 100644 (file)
--- a/src/apply-default-acl.c
+++ b/src/apply-default-acl.c
@@ -1,3 +1,10 @@
+/**
+ * @file apply-default-acl.c
+ *
+ * @brief The entire implementation.
+ *
+ */
+
 /* On Linux, ftw.h needs this special voodoo to work. */
 #define _XOPEN_SOURCE 500
 
@@ -19,10 +26,20 @@
 #include <sys/acl.h>
 
 
+/* Command-line options */
+static bool no_exec_mask = false;
+
+
+/**
+ * @brief Get the mode bits from the given path.
+ *
+ * @param path
+ *   The path (file or directory) whose mode we want.
+ *
+ * @return A mode_t (st_mode) structure containing the mode bits.
+ *   See sys/stat.h for details.
+ */
 mode_t get_mode(const char* path) {
-  /*
-   * Get the mode bits from path.
-   */
   if (path == NULL) {
     errno = ENOENT;
     return -1;
@@ -41,10 +58,15 @@ mode_t get_mode(const char* path) {
 }
 
 
+/**
+ * @brief Determine whether or not the given path is a regular file.
+ *
+ * @param path
+ *   The path to test.
+ *
+ * @return true if @c path is a regular file, false otherwise.
+ */
 bool is_regular_file(const char* path) {
-  /*
-   * Returns true if path is a regular file, false otherwise.
-   */
   if (path == NULL) {
     return false;
   }
@@ -59,10 +81,16 @@ bool is_regular_file(const char* path) {
   }
 }
 
+
+/**
+ * @brief Determine whether or not the given path is a directory.
+ *
+ * @param path
+ *   The path to test.
+ *
+ * @return true if @c path is a directory, false otherwise.
+ */
 bool is_directory(const char* path) {
-  /*
-   * Returns true if path is a directory, false otherwise.
-   */
   if (path == NULL) {
     return false;
   }
@@ -474,6 +502,7 @@ int apply_default_acl(const char* path) {
   /* Really apply the default ACL by looping through it. Returns one
    * for success, zero for failure (i.e. no ACL), and -1 on unexpected
    * errors.
+
    */
   if (path == NULL) {
     return 0;
@@ -494,13 +523,20 @@ int apply_default_acl(const char* path) {
     return 0;
   }
 
-  int ace_result = any_can_execute_or_dir(path);
-  if (ace_result == -1) {
+  /* Default to not masking the exec bit; i.e. applying the default
+     ACL literally. If --no-exec-mask was not specified, then we try
+     to "guess" whether or not to mask the exec bit. */
+  bool allow_exec = true;
+
+  if (!no_exec_mask) {
+    int ace_result = any_can_execute_or_dir(path);
+
+    if (ace_result == -1) {
     perror("apply_default_acl (any_can_execute_or_dir)");
     return -1;
   }
-
-  bool allow_exec = (bool)ace_result;
+    allow_exec = (bool)ace_result;
+  }
 
   acl_t defacl = acl_get_file(parent, ACL_TYPE_DEFAULT);
 
@@ -563,6 +599,7 @@ int apply_default_acl(const char* path) {
        tag == ACL_USER_OBJ ||
        tag == ACL_GROUP_OBJ ||
        tag == ACL_OTHER) {
+
       if (!allow_exec) {
        /* The mask doesn't affect acl_user_obj, acl_group_obj (in
           minimal ACLs) or acl_other entries, so if execute should be
@@ -626,13 +663,16 @@ void usage(char* program_name) {
   printf("Flags:\n");
   printf(" -h, --help         Print this help message\n");
   printf(" -r, --recursive    Act on any given directories recursively\n");
+  printf(" -x, --no-exec-mask Apply execute permissions unconditionally\n");
+
+  return;
 }
 
 
 int apply_default_acl_nftw(const char *target,
-                            const struct stat *s,
-                            int info,
-                            struct FTW *ftw) {
+                          const struct stat *s,
+                          int info,
+                          struct FTW *ftw) {
   /* A wrapper around the apply_default_acl() function for use with
    * nftw(). We need to adjust the return value so that nftw() doesn't
    * think we've failed.
@@ -693,19 +733,20 @@ int main(int argc, char* argv[]) {
     return EXIT_FAILURE;
   }
 
-
   bool recursive = false;
+  /* bool no_exec_mask is declared static/global */
 
   struct option long_options[] = {
     /* These options set a flag. */
     {"help",      no_argument, NULL, 'h'},
     {"recursive", no_argument, NULL, 'r'},
+    {"no-exec-mask", no_argument, NULL, 'x'},
     {NULL,        0,           NULL, 0}
   };
 
   int opt = 0;
 
-  while ((opt = getopt_long(argc, argv, "hr", long_options, NULL)) != -1) {
+  while ((opt = getopt_long(argc, argv, "hrx", long_options, NULL)) != -1) {
     switch (opt) {
     case 'h':
       usage(argv[0]);
@@ -713,6 +754,9 @@ int main(int argc, char* argv[]) {
     case 'r':
       recursive = true;
       break;
+    case 'x':
+      no_exec_mask = true;
+      break;
     default:
       usage(argv[0]);
       return EXIT_FAILURE;