]> git.tuebingen.mpg.de Git - adu.git/blobdiff - select.c
adu.c: Add a comment describing the user table.
[adu.git] / select.c
index ab958461da82e2d2e50fa582b2d37c3a3b656b76..84e18d4ff0beab82497b6e028a9035e2c07bd323 100644 (file)
--- a/select.c
+++ b/select.c
@@ -7,6 +7,7 @@
 /** \file select.c The select mode of adu. */
 
 #include <dirent.h> /* readdir() */
+#include "format.h"
 #include "adu.h"
 #include "gcc-compat.h"
 #include "cmdline.h"
@@ -14,7 +15,6 @@
 #include "string.h"
 #include "error.h"
 #include "portable_io.h"
-#include "select.cmdline.h"
 
 /** Global dir count. */
 static uint64_t num_dirs;
@@ -23,9 +23,43 @@ static uint64_t num_files;
 /** Global bytes count. */
 static uint64_t num_bytes;
 
+
 /** The decimal representation of an uint64_t never exceeds that size. */
 #define FORMATED_VALUE_SIZE 25
 
+#define GLOBAL_SUMMARY_ATOMS \
+       ATOM(dirs, COUNT) \
+       ATOM(files, COUNT) \
+       ATOM(size, SIZE)
+
+#define ATOM(x, y) { .name = #x, .type = AT_ ## y},
+struct atom global_summary_atoms[] = {
+       GLOBAL_SUMMARY_ATOMS
+       {.name = NULL}
+};
+#undef ATOM
+#define ATOM(x, y) gsa_ ## x,
+enum global_summary_atoms {GLOBAL_SUMMARY_ATOMS};
+#undef ATOM
+
+#define USER_SUMMARY_ATOMS \
+       ATOM(pw_name, STRING) \
+       ATOM(uid, ID) \
+       ATOM(dirs, COUNT) \
+       ATOM(files, COUNT) \
+       ATOM(size, SIZE)
+
+#define ATOM(x, y) { .name = #x, .type = AT_ ## y},
+struct atom user_summary_atoms[] = {
+       USER_SUMMARY_ATOMS
+       {.name = NULL}
+};
+#undef ATOM
+#define ATOM(x, y) usa_ ## x,
+enum user_summary_atoms {USER_SUMMARY_ATOMS};
+#undef ATOM
+
+
 /* these get filled in by the select command. */
 static char count_unit_buf[4] = "( )", size_unit_buf[4] = "( )";
 
@@ -77,9 +111,6 @@ static const uint64_t count_unit_divisors[] = {
 
 static const char size_unit_abbrevs[] = " BKMGT";
 static const char count_unit_abbrevs[] = "  kmgt";
-struct select_args_info select_conf;
-static struct uid_range *admissible_uids;
-
 static enum enum_size_unit format_size_value(enum enum_size_unit unit,
                uint64_t value, int print_unit, char *result)
 {
@@ -114,6 +145,19 @@ static enum enum_count_unit format_count_value(enum enum_count_unit unit,
        return u;
 }
 
+static FILE *output_file;
+
+__printf_1_2 static int output(const char const *fmt, ...)
+{
+       va_list argp;
+       int ret;
+
+       va_start(argp, fmt);
+       ret = vfprintf(output_file, fmt, argp);
+       va_end(argp);
+       return ret < 0? -E_OUTPUT : 1;
+}
+
 static int get_dir_name_by_number(uint64_t *dirnum, char **name)
 {
        char *result = NULL, *tmp;
@@ -136,7 +180,7 @@ again:
        ret = osl(osl_get_object(dir_table, row, DT_NAME, &obj));
        if (ret < 0)
                goto out;
-       pfx = (conf.print_base_dir_given || val)? (char *)obj.data :  ".";
+       pfx = (select_conf.print_base_dir_given || val)? (char *)obj.data :  ".";
        tmp = make_message("%s/%s", pfx, result? result : "");
        free(result);
        result = tmp;
@@ -184,13 +228,14 @@ static int user_stats_loop_function(struct osl_row *row, void *data)
                        goto err;
                files = *(uint64_t *)obj.data;
                if (usi->count && (usi->flags & USF_PRINT_FILES)) {
-                       format_count_value(conf.count_unit_arg, files,
-                               conf.count_unit_arg == count_unit_arg_h,
+                       format_count_value(select_conf.count_unit_arg, files,
+                               select_conf.count_unit_arg == count_unit_arg_h,
                                formated_value);
-                       printf("\t%s%s", formated_value,
+                       ret = output("\t%s%s", formated_value,
                                (usi->flags & (USF_PRINT_BYTES | USF_PRINT_DIRNAME))?
-                                       "\t" : "\n"
-                       );
+                                       "\t" : "\n");
+                       if (ret < 0)
+                               goto err;
                }
                if (summary)
                        usi->ui->files += files;
@@ -202,14 +247,16 @@ static int user_stats_loop_function(struct osl_row *row, void *data)
                        goto err;
                bytes = *(uint64_t *)obj.data;
                if (usi->count && (usi->flags & USF_PRINT_BYTES)) {
-                       format_size_value(conf.size_unit_arg, bytes,
-                               conf.size_unit_arg == size_unit_arg_h,
+                       format_size_value(select_conf.size_unit_arg, bytes,
+                               select_conf.size_unit_arg == size_unit_arg_h,
                                formated_value);
-                       printf("%s%s%s",
+                       ret = output("%s%s%s",
                                (usi->flags & USF_PRINT_FILES)? "" : "\t",
                                formated_value,
                                usi->flags & USF_PRINT_DIRNAME?  "\t" : "\n"
                        );
+                       if (ret < 0)
+                               goto err;
                }
                if (summary) {
                        usi->ui->bytes += bytes;
@@ -225,10 +272,12 @@ static int user_stats_loop_function(struct osl_row *row, void *data)
                ret = get_dir_name_by_number((uint64_t *)obj.data, &dirname);
                if (ret < 0)
                        goto err;
-               printf("%s%s\n",
+               ret = output("%s%s\n",
                        (usi->flags & (USF_PRINT_BYTES | USF_PRINT_FILES))? "" : "\t",
                        dirname);
                free(dirname);
+               if (ret < 0)
+                       goto err;
        }
        if (usi->count > 0)
                usi->count--;
@@ -258,12 +307,14 @@ static int global_stats_loop_function(struct osl_row *row, void *data)
                        goto err;
                files = *(uint64_t *)obj.data;
                if (gsi->count && (gsi->flags & GSF_PRINT_FILES)) {
-                       format_count_value(conf.count_unit_arg, files,
-                               conf.count_unit_arg == count_unit_arg_h,
+                       format_count_value(select_conf.count_unit_arg, files,
+                               select_conf.count_unit_arg == count_unit_arg_h,
                                formated_value);
-                       printf("\t%s%s", formated_value,
+                       ret = output("\t%s%s", formated_value,
                                (gsi->flags & (GSF_PRINT_BYTES | GSF_PRINT_DIRNAME))?
                                "\t" : "\n");
+                       if (ret < 0)
+                               goto err;
                }
                if (summary)
                        num_files += files;
@@ -275,14 +326,16 @@ static int global_stats_loop_function(struct osl_row *row, void *data)
                        goto err;
                bytes = *(uint64_t *)obj.data;
                if (gsi->count && (gsi->flags & GSF_PRINT_BYTES)) {
-                       format_size_value(conf.size_unit_arg, bytes,
-                               conf.size_unit_arg == size_unit_arg_h,
+                       format_size_value(select_conf.size_unit_arg, bytes,
+                               select_conf.size_unit_arg == size_unit_arg_h,
                                formated_value);
-                       printf("%s%s%s",
+                       ret = output("%s%s%s",
                                (gsi->flags & GSF_PRINT_FILES)? "" : "\t",
                                formated_value,
                                (gsi->flags & GSF_PRINT_DIRNAME)? "\t" : "\n"
                        );
+                       if (ret < 0)
+                               goto err;
                }
                if (summary) {
                        num_bytes += bytes;
@@ -293,10 +346,12 @@ static int global_stats_loop_function(struct osl_row *row, void *data)
                ret = get_dir_name_of_row(row, &dirname);
                if (ret < 0)
                        goto err;
-               printf("%s%s\n",
+               ret = output("%s%s\n",
                        (gsi->flags & (GSF_PRINT_BYTES | GSF_PRINT_FILES))? "" : "\t",
                        dirname);
                free(dirname);
+               if (ret < 0)
+                       goto err;
        }
        if (gsi->count > 0)
                gsi->count--;
@@ -332,52 +387,45 @@ static int adu_loop_reverse(struct osl_table *t, unsigned col_num, void *private
        return check_loop_return(ret, *loop_ret, *loop_osl_errno);
 }
 
-static void print_global_summary(void)
+static int print_global_summary(struct format_info *fi)
 {
-       char d[FORMATED_VALUE_SIZE], f[FORMATED_VALUE_SIZE],
-               s[FORMATED_VALUE_SIZE];
-       enum enum_count_unit ud, uf;
-       enum enum_size_unit us;
-
-       if (conf.no_global_summary_given)
-               return;
-       ud = format_count_value(conf.count_unit_arg, num_dirs, 0, d);
-       uf = format_count_value(conf.count_unit_arg, num_files, 0, f);
-       us = format_size_value(conf.size_unit_arg, num_bytes, 0, s);
-
-       if (!conf.no_headers_given)
-               printf("Global summary "
-                       "(dirs(%c)/files(%c)/size(%c))\n",
-                       count_unit_abbrevs[ud],
-                       count_unit_abbrevs[uf],
-                       size_unit_abbrevs[us]
-               );
-       printf("\t%s\t%s\t%s\n\n", d, f, s);
+       int ret;
+       char *buf;
+       union atom_value values[] = {
+               [gsa_dirs] = {.num_value = (long long unsigned)num_dirs},
+               [gsa_files] = {.num_value =  (long long unsigned)num_files},
+               [gsa_size] = {.num_value =  (long long unsigned)num_bytes}
+       };
+
+       if (select_conf.no_global_summary_given)
+               return 1;
+       if (!select_conf.no_headers_given) {
+               ret = output("Global summary\n");
+               if (ret < 0)
+                       return ret;
+       }
+       buf = format_items(fi, values);
+       ret = output("%s", buf);
+       free(buf);
+       return ret;
 }
 
 static int print_user_summary_line(struct user_info *ui, __a_unused void *data)
 {
-       char formated_dir_count[FORMATED_VALUE_SIZE],
-               formated_file_count[FORMATED_VALUE_SIZE],
-               formated_bytes[FORMATED_VALUE_SIZE ];
-
-       format_count_value(conf.count_unit_arg, ui->dirs,
-               conf.count_unit_arg == count_unit_arg_h,
-               formated_dir_count);
-       format_count_value(conf.count_unit_arg, ui->files,
-               conf.count_unit_arg == count_unit_arg_h,
-               formated_file_count);
-       format_size_value(conf.size_unit_arg, ui->bytes,
-               conf.size_unit_arg == size_unit_arg_h,
-               formated_bytes);
-       printf("\t%s\t%u\t%s\t%s\t%s\n",
-               ui->pw_name? ui->pw_name : "?",
-               (unsigned)ui->uid,
-               formated_dir_count,
-               formated_file_count,
-               formated_bytes
-       );
-       return 1;
+       struct format_info *fi = data;
+       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}
+       };
+       char *buf = format_items(fi, values);
+       int ret = output("%s", buf);
+
+       free(buf);
+       return ret;
 }
 
 static int name_comp(const void *a, const void *b)
@@ -430,56 +478,67 @@ static int (*summary_comparators[])(const void *, const void *) = {
        [user_summary_sort_arg_size] = size_comp,
 };
 
-static void print_user_summary(void)
+static int print_user_summary(struct format_info *fi)
 {
-       if (conf.no_user_summary_given)
-               return;
-       if (!conf.no_headers_given)
-               printf("User summary "
-                       "(pw_name/uid/dirs%s/files%s/size%s):\n",
-                       count_unit_buf, count_unit_buf, size_unit_buf);
-       sort_hash_table(summary_comparators[conf.user_summary_sort_arg]);
-       for_each_admissible_user(print_user_summary_line, NULL);
+       if (select_conf.no_user_summary_given)
+               return 1;
+       if (!select_conf.no_headers_given) {
+               int ret = output("User summary\n");
+               if (ret < 0)
+                       return ret;
+       }
+       sort_hash_table(summary_comparators[select_conf.user_summary_sort_arg]);
+       return for_each_admissible_user(print_user_summary_line, fi);
 }
 
 static int print_user_list(struct user_info *ui, __a_unused void *data)
 {
        int ret;
        struct user_stats_info usi;
-       enum enum_user_list ula = conf.user_list_arg;
+       enum enum_user_list ula = select_conf.user_list_arg;
        int print_size_list = (ula == user_list_arg_size
                || ula == user_list_arg_both);
 
        if (print_size_list) {
-               usi.count = conf.limit_arg;
+               usi.count = select_conf.limit_arg;
                usi.ui = ui;
                usi.flags = USF_PRINT_DIRNAME | USF_PRINT_BYTES | USF_COMPUTE_SUMMARY;
-               if (!conf.no_headers_given)
-                       printf("%s (uid %u), by size%s:\n",
+               if (!select_conf.no_headers_given) {
+                       ret = output("%s (uid %u), by size%s:\n",
                                ui->pw_name? ui->pw_name : "?", (unsigned)ui->uid,
                                size_unit_buf);
+                       if (ret < 0)
+                               return ret;
+               }
                ret = adu_loop_reverse(ui->table, UT_BYTES, &usi, user_stats_loop_function,
                        &usi.ret, &usi.osl_errno);
                if (ret < 0)
                        return ret;
-               printf("\n");
+               ret = output("\n");
+               if (ret < 0)
+                       return ret;
        }
        if (ula == user_list_arg_file_count || ula == user_list_arg_both) {
-               if (!conf.no_headers_given)
-                       printf("%s (uid %u), by file count%s:\n",
+               if (!select_conf.no_headers_given) {
+                       ret = output("%s (uid %u), by file count%s:\n",
                                ui->pw_name? ui->pw_name : "?", (unsigned)ui->uid,
                                count_unit_buf);
-               usi.count = conf.limit_arg,
+                       if (ret < 0)
+                               return ret;
+               }
+               usi.count = select_conf.limit_arg,
                usi.ui = ui;
                usi.flags = USF_PRINT_DIRNAME | USF_PRINT_FILES;
                ret = adu_loop_reverse(ui->table, UT_FILES, &usi, user_stats_loop_function,
                        &usi.ret, &usi.osl_errno);
                if (ret < 0)
                        return ret;
-               printf("\n");
+               ret = output("\n");
+               if (ret < 0)
+                       return ret;
        }
-       if (ula == user_list_arg_none && !conf.no_user_summary_given) {
-               usi.count = conf.limit_arg;
+       if (ula == user_list_arg_none && !select_conf.no_user_summary_given) {
+               usi.count = select_conf.limit_arg;
                usi.ui = ui;
                usi.flags = USF_COMPUTE_SUMMARY;
                ret = adu_loop_reverse(ui->table, UT_FILES, &usi, user_stats_loop_function,
@@ -499,37 +558,47 @@ static int print_global_lists(void)
 {
        struct global_stats_info gsi;
        int ret;
-       enum enum_global_list gla = conf.global_list_arg;
+       enum enum_global_list gla = select_conf.global_list_arg;
        int print_size_list = (gla == global_list_arg_size
                || gla == global_list_arg_both);
 
        if (print_size_list) {
-               gsi.count = conf.limit_arg;
+               gsi.count = select_conf.limit_arg;
                gsi.flags = GSF_PRINT_DIRNAME | GSF_PRINT_BYTES | GSF_COMPUTE_SUMMARY;
-               if (!conf.no_headers_given)
-                       printf("By size%s:\n", size_unit_buf);
+               if (!select_conf.no_headers_given) {
+                       ret = output("By size%s:\n", size_unit_buf);
+                       if (ret < 0)
+                               return ret;
+               }
                ret = adu_loop_reverse(dir_table, DT_BYTES, &gsi,
                        global_stats_loop_function, &gsi.ret, &gsi.osl_errno);
                if (ret < 0)
                        return ret;
-               printf("\n");
+               ret = output("\n");
+               if (ret < 0)
+                       return ret;
        }
        if (gla == global_list_arg_file_count || gla == global_list_arg_both) {
-               gsi.count = conf.limit_arg;
+               gsi.count = select_conf.limit_arg;
                gsi.flags = GSF_PRINT_DIRNAME | GSF_PRINT_FILES;
                if (!print_size_list)
                        gsi.flags |= GSF_COMPUTE_SUMMARY;
-               if (!conf.no_headers_given)
-                       printf("By file count%s:\n", count_unit_buf);
+               if (!select_conf.no_headers_given) {
+                       ret = output("By file count%s:\n", count_unit_buf);
+                       if (ret < 0)
+                               return ret;
+               }
                ret = adu_loop_reverse(dir_table, DT_FILES, &gsi,
                        global_stats_loop_function, &gsi.ret, &gsi.osl_errno);
                if (ret < 0)
                        return ret;
-               printf("\n");
+               ret = output("\n");
+               if (ret < 0)
+                       return ret;
        }
-       if (gla == global_list_arg_none && !conf.no_global_summary_given) {
+       if (gla == global_list_arg_none && !select_conf.no_global_summary_given) {
                /* must compute summary */
-               gsi.count = conf.limit_arg;
+               gsi.count = select_conf.limit_arg;
                gsi.flags = GSF_COMPUTE_SUMMARY;
                ret = adu_loop_reverse(dir_table, DT_FILES, &gsi,
                        global_stats_loop_function, &gsi.ret, &gsi.osl_errno);
@@ -539,20 +608,28 @@ static int print_global_lists(void)
        return 1;
 }
 
-static int print_statistics(void)
+static int print_statistics(struct select_format_info *sli)
 {
        int ret;
 
        ret = print_global_lists();
        if (ret < 0)
                return ret;
-       print_global_summary();
-       print_user_lists();
-       print_user_summary();
+       ret = print_global_summary(sli->global_summary_fi);
+       free_format_info(sli->global_summary_fi);
+       if (ret < 0)
+               return ret;
+       ret = print_user_lists();
+       if (ret < 0)
+               return ret;
+       ret = print_user_summary(sli->user_summary_fi);
+       free_format_info(sli->user_summary_fi);
+       if (ret < 0)
+               return ret;
        return 1;
 }
 
-static int read_uid_file(void)
+static int read_uid_file(struct uid_range *admissible_uids)
 {
        size_t size;
        uint32_t n;
@@ -587,44 +664,110 @@ out:
        return ret;
 }
 
-int com_select(void)
+int run_select_query(struct uid_range *admissible_uids,
+               struct select_format_info *sfi)
 {
        int ret;
-       struct select_cmdline_parser_params params = {
-               .override = 1,
-               .initialize = 1,
-               .check_required = 1,
-               .check_ambiguity = 1,
-               .print_errors = 1
-       };
 
-       if (conf.select_options_given) {
-               if (select_cmdline_parser_string_ext(conf.select_options_arg,
-                       &select_conf, "select", &params))
-                       return -E_SYNTAX;
-               ret = parse_uid_arg(select_conf.uid_arg, &admissible_uids);
-               if (ret < 0)
-                       return ret;
-       }
+       if (select_conf.output_given && strcmp(select_conf.output_arg, "-")) {
+               output_file = fopen(select_conf.output_arg, "w");
+               if (!output_file)
+                       return -ERRNO_TO_ERROR(errno);
+       } else
+               output_file = stdout;
 
-       if (conf.count_unit_arg != count_unit_arg_h)
-               count_unit_buf[1] = count_unit_abbrevs[conf.count_unit_arg];
+       if (select_conf.count_unit_arg != count_unit_arg_h)
+               count_unit_buf[1] = count_unit_abbrevs[select_conf.count_unit_arg];
        else
                count_unit_buf[0] = '\0';
-       if (conf.size_unit_arg != size_unit_arg_h)
-               size_unit_buf[1] = size_unit_abbrevs[conf.size_unit_arg];
+       if (select_conf.size_unit_arg != size_unit_arg_h)
+               size_unit_buf[1] = size_unit_abbrevs[select_conf.size_unit_arg];
        else
                size_unit_buf[0] = '\0';
 
        ret = open_dir_table(0);
        if (ret < 0)
-               return ret;
+               goto out;
        check_signals();
-       ret = read_uid_file();
+       ret = read_uid_file(admissible_uids);
        if (ret < 0)
-               return ret;
+               goto out;
        check_signals();
-       ret = print_statistics();
+       ret = print_statistics(sfi);
+out:
        close_all_tables();
+       if (output_file != stdout)
+               fclose(output_file);
        return ret;
 }
+
+/* return: < 0: error, >0: OK, == 0: help given */
+int parse_select_options(char *string, struct select_cmdline_parser_params *params,
+               struct uid_range **admissible_uids, struct select_format_info *sfi)
+{
+       int ret;
+       const char **line;
+
+       if (conf.select_options_given) {
+               int argc;
+               char **argv;
+
+               ret = create_argv(string, &argv);
+               if (ret < 0)
+                       return ret;
+               argc = ret;
+               ret = select_cmdline_parser_ext(argc, argv, &select_conf, params);
+               free_argv(argv);
+               if (ret)
+                       return -E_SYNTAX;
+               if (select_conf.help_given || select_conf.detailed_help_given)
+                       goto help;
+
+       }
+       ret = parse_uid_arg(select_conf.uid_arg, admissible_uids);
+       if (ret < 0)
+               return ret;
+       ret = parse_format_string(select_conf.user_summary_format_arg,
+               user_summary_atoms, &sfi->user_summary_fi);
+       if (ret < 0)
+               return ret;
+       ret = parse_format_string(select_conf.global_summary_format_arg,
+               global_summary_atoms, &sfi->global_summary_fi);
+       if (ret < 0) {
+               free_format_info(sfi->user_summary_fi);
+               return ret;
+       }
+       return 1;
+help:
+       line = select_conf.detailed_help_given?
+               select_args_info_detailed_help : select_args_info_help;
+       if (!output_file)
+               output_file = stdout;
+       for (; *line; line++) {
+               ret = output("%s\n", *line);
+               if (ret < 0)
+                       return ret;
+       }
+       return 0;
+}
+
+int com_select(void)
+{
+       struct uid_range *admissible_uids = NULL;
+       struct select_format_info sfi;
+       int ret;
+       struct select_cmdline_parser_params params = {
+               .override = 1,
+               .initialize = 1,
+               .check_required = 1,
+               .check_ambiguity = 1,
+               .print_errors = 1
+       };
+
+       select_cmdline_parser_init(&select_conf);
+       ret = parse_select_options(conf.select_options_arg, &params,
+               &admissible_uids, &sfi);
+       if (ret <= 0) /* do not run query if help was given */
+               return ret;
+       return run_select_query(admissible_uids, &sfi);
+}