Add an example to README.
[adu.git] / select.c
index d6585857e62e32d2e0abc2da8bb0ff6d6683779a..9dda08909c6803d5827ef1f020ab819cb476418c 100644 (file)
--- a/select.c
+++ b/select.c
@@ -72,18 +72,18 @@ enum user_list_atoms {USER_LIST_ATOMS};
 #undef ATOM
 
 /* user list header */
-#define USER_LIST_HEADER_ATOMS \
+#define USER_LIST_HEADER_TRAILER_ATOMS \
        ATOM(pw_name, STRING) \
        ATOM(uid, ID)
 
 #define ATOM(x, y) { .name = #x, .type = AT_ ## y},
-struct atom user_list_header_atoms[] = {
-       USER_LIST_HEADER_ATOMS
+struct atom user_list_header_trailer_atoms[] = {
+       USER_LIST_HEADER_TRAILER_ATOMS
        {.name = NULL}
 };
 #undef ATOM
 #define ATOM(x, y) ulha_ ## x,
-enum user_list_header_atoms {USER_LIST_HEADER_ATOMS};
+enum user_list_header_trailer_atoms {USER_LIST_HEADER_TRAILER_ATOMS};
 #undef ATOM
 
 /* user summary */
@@ -141,19 +141,28 @@ struct user_list_info {
 struct user_list_format_info {
        struct format_info *fi;
        struct format_info *header_fi;
+       struct format_info *trailer_fi;
 };
 
 struct user_summary_info {
        struct user_info *ui;
+       /** Total number of files owned by this user. */
+       uint64_t files;
+       /** Total number of bytes owned by this user. */
+       uint64_t bytes;
+       /** Total number of directories that contain at least one file */
+       uint64_t dirs;
        int ret;
        int osl_errno;
        regex_t *preg;
        int inverse_matching;
 };
 
-struct user_summary_line_info {
+struct user_summary_loop_data {
+       unsigned num_admissible_users;
+       struct user_summary_info *usis;
+       struct user_summary_info *current;
        struct format_info *fi;
-       uint32_t count;
 };
 
 static FILE *output_file;
@@ -422,7 +431,9 @@ static int print_global_summary(struct format_info *fi)
        buf = format_items(fi, values);
        ret = output("%s", buf);
        free(buf);
-       return ret;
+       if (ret < 0)
+               return ret;
+       return output("%s", select_conf.trailer_arg);
 }
 
 static int user_summary_loop_function(struct osl_row *row, void *data)
@@ -444,12 +455,12 @@ static int user_summary_loop_function(struct osl_row *row, void *data)
        ret = get_num_user_files(row, usi->ui, &num);
        if (ret < 0)
                goto err;
-       usi->ui->files += num;
+       usi->files += num;
        ret = get_num_user_bytes(row, usi->ui, &num);
        if (ret < 0)
                goto err;
-       usi->ui->bytes += num;
-       usi->ui->dirs++;
+       usi->bytes += num;
+       usi->dirs++;
        return 1;
 err:
        usi->ret = ret;
@@ -457,92 +468,106 @@ err:
        return ret;
 }
 
-static int compute_user_summary(struct user_info *ui, __a_unused void *data)
+static int compute_user_summary(struct user_info *ui, void *data)
 {
-       struct user_summary_info usi = {.ui = ui};
-       int ret = compile_regex(&usi.preg, &usi.inverse_matching);
+       struct user_summary_loop_data *usld = data;
+       struct user_summary_info *usi = usld->current++;
+       int ret = compile_regex(&usi->preg, &usi->inverse_matching);
 
        if (ret < 0)
                return ret;
-       ret = adu_loop_reverse(ui->table, UT_BYTES, &usi, user_summary_loop_function,
-               &usi.ret, &usi.osl_errno);
-       free_regex(usi.preg);
+       usi->ui = ui;
+       ret = adu_loop_reverse(ui->table, UT_BYTES, usi, user_summary_loop_function,
+               &usi->ret, &usi->osl_errno);
+       free_regex(usi->preg);
        return ret;
 }
 
-static int print_user_summary_line(struct user_info *ui, void *data)
+static int print_user_summary_line(struct user_summary_info *usi,
+               struct format_info *fi)
 {
-       struct user_summary_line_info *usli = data;
+       struct user_info *ui = usi->ui;
        union atom_value values[] = {
                [usa_pw_name] = {.string_value = ui->pw_name?
                        ui->pw_name : "?"},
                [usa_uid] = {.num_value = (long long unsigned)ui->uid},
-               [usa_dirs] = {.num_value = (long long unsigned)ui->dirs},
-               [usa_files] = {.num_value = (long long unsigned)ui->files},
-               [usa_size] = {.num_value =  (long long unsigned)ui->bytes}
+               [usa_dirs] = {.num_value = (long long unsigned)usi->dirs},
+               [usa_files] = {.num_value = (long long unsigned)usi->files},
+               [usa_size] = {.num_value =  (long long unsigned)usi->bytes}
        };
-       char *buf;
-       int ret = -E_LOOP_COMPLETE;
+       char *buf = format_items(fi, values);
+       int ret = output("%s", buf);
 
-       if (!usli->count)
-               return ret;
-
-       buf = format_items(usli->fi, values);
-       ret = output("%s", buf);
        free(buf);
-       usli->count--;
        return ret;
 }
 
-static int name_comp(struct user_info *a, struct user_info *b)
+static int name_comp(const void *a, const void *b)
 {
-       char *x = a->pw_name;
-       char *y = b->pw_name;
+       const struct user_summary_info *x = a, *y = b;
+       char *n1 = x->ui->pw_name;
+       char *n2 = y->ui->pw_name;
 
-       if (!x)
+       if (!n1)
                return 1;
-       if (!y)
+       if (!n2)
                return -1;
-       return strcmp(x, y);
+       return strcmp(n1, n2);
+}
+
+static int uid_comp(const void *a, const void *b)
+{
+       const struct user_summary_info *x = a, *y = b;
+       return -NUM_COMPARE(x->ui->uid, y->ui->uid);
 }
 
-static int uid_comp(struct user_info *a, struct user_info *b)
+static int dir_count_comp(const void *a, const void *b)
 {
-       return -NUM_COMPARE(a->uid, b->uid);
+       const struct user_summary_info *x = a, *y = b;
+       return NUM_COMPARE(x->dirs, y->dirs);
 }
 
-static int dir_count_comp(struct user_info *a, struct user_info *b)
+static int file_count_comp(const void *a, const void *b)
 {
-       return NUM_COMPARE(a->dirs, b->dirs);
+       const struct user_summary_info *x = a, *y = b;
+       return NUM_COMPARE(x->files, y->files);
 }
 
-static int file_count_comp(struct user_info *a, struct user_info *b)
+static int size_comp(const void *a, const void *b)
 {
-       return NUM_COMPARE(a->files, b->files);
+       const struct user_summary_info *x = a, *y = b;
+       return NUM_COMPARE(x->bytes, y->bytes);
 }
 
-static int size_comp(struct user_info *a, struct user_info *b)
+static int count_admissible_users(__a_unused struct user_info *ui, void *data)
 {
-       return NUM_COMPARE(a->bytes, b->bytes);
+       struct user_summary_loop_data *usld = data;
+       usld->num_admissible_users++;
+       return 1;
 }
 
 static int print_user_summary(struct format_info *fi)
 {
-       int ret;
-       int (*comp)(struct user_info *a, struct user_info *b);
-       struct user_summary_line_info usli = {
-               .fi = fi,
-               .count = select_conf.limit_arg
-       };
+       int i, ret;
+       int (*comp)(const void *a, const void *b);
+       struct user_summary_loop_data usld = { .fi = fi};
        char *header = select_conf.header_given? select_conf.header_arg :
                "User summary\n";
 
        ret = output("%s", header);
        if (ret < 0)
                return ret;
-       ret = for_each_admissible_user(compute_user_summary, NULL);
+       ret = for_each_admissible_user(count_admissible_users, &usld);
        if (ret < 0)
                return ret;
+       if (usld.num_admissible_users == 0)
+               return 1;
+       usld.usis = adu_calloc(usld.num_admissible_users
+               * sizeof(struct user_summary_info));
+       usld.current = usld.usis;
+       ret = for_each_admissible_user(compute_user_summary, &usld);
+       if (ret < 0)
+               goto out;
        switch (select_conf.user_summary_sort_arg) {
        case user_summary_sort_arg_name:
                comp = name_comp;
@@ -563,10 +588,18 @@ static int print_user_summary(struct format_info *fi)
                comp = size_comp;
                break;
        }
-       sort_hash_table(comp);
-       ret = for_each_admissible_user(print_user_summary_line, &usli);
-       if (ret == -E_LOOP_COMPLETE)
-               ret = 1;
+       qsort(usld.usis, usld.num_admissible_users,
+               sizeof(struct user_summary_info), comp);
+       for (i = 0; i < usld.num_admissible_users; i++) {
+               if (select_conf.limit_arg >= 0 && i > select_conf.limit_arg)
+                       break;
+               ret = print_user_summary_line(usld.usis + i, usld.fi);
+               if (ret < 0)
+                       goto out;
+       }
+       ret = output("%s", select_conf.trailer_arg);
+out:
+       free(usld.usis);
        return ret;
 }
 
@@ -635,12 +668,12 @@ static int print_user_list(struct user_info *ui, void *data)
                .fi = ulfi->fi,
                .count = select_conf.limit_arg
        };
-       union atom_value header_values[] = {
+       union atom_value header_trailer_values[] = {
                [ulha_uid] = {.num_value = (long long unsigned)ui->uid},
                [ulha_pw_name] = {.string_value = ui->pw_name?
                        ui->pw_name : "?"}
        };
-       char *buf = format_items(ulfi->header_fi, header_values);
+       char *buf = format_items(ulfi->header_fi, header_trailer_values);
 
        ret = output("%s", buf);
        free(buf);
@@ -657,6 +690,11 @@ static int print_user_list(struct user_info *ui, void *data)
        ret = adu_loop_reverse(ui->table, sort_column, &uli,
                user_list_loop_function, &uli.ret, &uli.osl_errno);
        free_regex(uli.preg);
+       if (ret < 0)
+               return ret;
+       buf = format_items(ulfi->trailer_fi, header_trailer_values);
+       ret = output("%s", buf);
+       free(buf);
        return ret;
 }
 
@@ -665,12 +703,18 @@ static int print_user_lists(struct format_info *fi)
        struct user_list_format_info ulfi = {.fi = fi};
        char *header_fmt = select_conf.header_given?
                select_conf.header_arg : "uid %(uid)(%(pw_name)):\n";
+       char *trailer_fmt = select_conf.trailer_arg;
        int ret = parse_format_string(header_fmt,
-               user_list_header_atoms, &ulfi.header_fi);
+               user_list_header_trailer_atoms, &ulfi.header_fi);
+       if (ret < 0)
+               return ret;
+       ret = parse_format_string(trailer_fmt,
+               user_list_header_trailer_atoms, &ulfi.trailer_fi);
        if (ret < 0)
                return ret;
        ret = for_each_admissible_user(print_user_list, &ulfi);
        free_format_info(ulfi.header_fi);
+       free_format_info(ulfi.trailer_fi);
        return ret;
 }
 
@@ -751,7 +795,9 @@ static int print_global_list(struct format_info *fi)
        ret = adu_loop_reverse(dir_table, sort_column, &gli,
                global_list_loop_function, &gli.ret, &gli.osl_errno);
        free_regex(gli.preg);
-       return ret;
+       if (ret < 0)
+               return ret;
+       return output("%s", select_conf.trailer_arg);
 }
 
 static int print_statistics(struct format_info *fi)
@@ -901,7 +947,7 @@ out:
 /** Default format string for global_list mode. */
 #define GLOBAL_LIST_DFLT_FMT "%(size:r:8) %(files:r:8) %(dirname)\n"
 /** Default format string for global_summary mode. */
-#define GLOBAL_SUMMARY_DFLT_FMT "#directories: %(dirs), #files: %(files), size: %(size)\n\n"
+#define GLOBAL_SUMMARY_DFLT_FMT "#directories: %(dirs), #files: %(files), size: %(size)\n"
 /** Default format string for user_list mode. */
 #define USER_LIST_DFLT_FMT "%(size:r:5) %(files:r:5) %(dirname)\n"
 /** Default format string for user_summary mode. */
@@ -942,7 +988,33 @@ static int setup_format_string(char *fmt, struct format_info **fi)
        return parse_format_string(fmt, atoms, fi);
 }
 
-/* return: < 0: error, >0: OK, == 0: help given */
+/**
+ * Parse a given format string.
+ *
+ * \param string The format string to parse.
+ * \param params gengetopt parameters.
+ * \param admissible_uids The array of admissible uid ranges.
+ * \param fi The format info to be used with format_items().
+ *
+ * If \a string is not \p NULL, it is broken down into its components using
+ * \ref create_argv() and the resulting argument vector is passed together with
+ * \a params to gengetopt's command line parser. If --help or --detailed-help
+ * was specified in \a string, the corresponding help text is printed and the
+ * function returns zero.
+ *
+ * Otherwise, any --uid or --user options are parsed and transformed into an
+ * array of admissible uids which is returned via \a admissible_uids.
+ *
+ * Finally, the format string given by --format (or the default format string
+ * for the given select mode if no --format option was given in \a string) is
+ * parsed as well resulting in a format_info structure which is returned via
+ * \a fi. The caller uses the \a fi pointer later to format each output line.
+ *
+ * \return Negative on errors, zero if --help or --detailed-help was given,
+ * positive otherwise.
+ *
+ * \sa format_items().
+ */
 int parse_select_options(char *string, struct select_cmdline_parser_params *params,
                struct uid_range **admissible_uids, struct format_info **fi)
 {