chiark / gitweb /
util: unify usage of on_tty() in util.c
[elogind.git] / src / journal / journalctl.c
index 04cebff547e4164ec4b3b2c8dbc9fedb2e2034c8..f4b651855771a42b7708cb1607ba43668f7b273d 100644 (file)
 #include "journal-authenticate.h"
 #include "journal-qrcode.h"
 #include "fsprg.h"
+#include "unit-name.h"
 
 #define DEFAULT_FSS_INTERVAL_USEC (15*USEC_PER_MINUTE)
 
 static OutputMode arg_output = OUTPUT_SHORT;
 static bool arg_follow = false;
-static bool arg_show_all = false;
+static bool arg_all = false;
 static bool arg_no_pager = false;
-static int arg_lines = -1;
+static unsigned arg_lines = 0;
 static bool arg_no_tail = false;
 static bool arg_quiet = false;
 static bool arg_merge = false;
@@ -70,6 +71,10 @@ static const char *arg_verify_key = NULL;
 #ifdef HAVE_GCRYPT
 static usec_t arg_interval = DEFAULT_FSS_INTERVAL_USEC;
 #endif
+static usec_t arg_since, arg_until;
+static bool arg_since_set = false, arg_until_set = false;
+static const char *arg_unit = NULL;
+static const char *arg_field = NULL;
 
 static enum {
         ACTION_SHOW,
@@ -82,32 +87,39 @@ static enum {
 
 static int help(void) {
 
-        printf("%s [OPTIONS...] [MATCH]\n\n"
-               "Send control commands to or query the journal.\n\n"
-               "  -h --help              Show this help\n"
-               "     --version           Show package version\n"
-               "     --no-pager          Do not pipe output into a pager\n"
-               "  -a --all               Show all fields, including long and unprintable\n"
-               "  -c --cursor=CURSOR     Jump to the specified cursor\n"
+        printf("%s [OPTIONS...] [MATCHES...]\n\n"
+               "Query the journal.\n\n"
+               "Flags:\n"
+               "     --since=DATE        Start showing entries newer or of the specified date\n"
+               "     --until=DATE        Stop showing entries older or of the specified date\n"
+               "  -c --cursor=CURSOR     Start showing entries from specified cursor\n"
+               "  -b --this-boot         Show data only from current boot\n"
+               "  -u --unit=UNIT         Show data only from the specified unit\n"
+               "  -p --priority=RANGE    Show only messages within the specified priority range\n"
                "  -f --follow            Follow journal\n"
                "  -n --lines[=INTEGER]   Number of journal entries to show\n"
                "     --no-tail           Show all lines, even in follow mode\n"
                "  -o --output=STRING     Change journal output mode (short, short-monotonic,\n"
                "                         verbose, export, json, json-pretty, json-sse, cat)\n"
+               "  -a --all               Show all fields, including long and unprintable\n"
                "  -q --quiet             Don't show privilege warning\n"
+               "     --no-pager          Do not pipe output into a pager\n"
                "  -m --merge             Show entries from all available journals\n"
-               "  -b --this-boot         Show data only from current boot\n"
                "  -D --directory=PATH    Show journal files from directory\n"
-               "  -p --priority=RANGE    Show only messages within the specified priority range\n\n"
-               "Commands:\n"
+#ifdef HAVE_GCRYPT
+               "     --interval=TIME     Time interval for changing the FSS sealing key\n"
+               "     --verify-key=KEY    Specify FSS verification key\n"
+#endif
+               "\nCommands:\n"
+               "  -h --help              Show this help\n"
+               "     --version           Show package version\n"
                "     --new-id128         Generate a new 128 Bit ID\n"
                "     --header            Show journal header information\n"
                "     --disk-usage        Show total disk usage\n"
+               "  -F --field=FIELD       List all values a certain field takes\n"
 #ifdef HAVE_GCRYPT
                "     --setup-keys        Generate new FSS key pair\n"
-               "       --interval=TIME   Time interval for changing the FSS sealing key\n"
                "     --verify            Verify journal file consistency\n"
-               "       --verify-key=KEY  Specify FSS verification key\n"
 #endif
                , program_invocation_short_name);
 
@@ -126,7 +138,9 @@ static int parse_argv(int argc, char *argv[]) {
                 ARG_INTERVAL,
                 ARG_VERIFY,
                 ARG_VERIFY_KEY,
-                ARG_DISK_USAGE
+                ARG_DISK_USAGE,
+                ARG_SINCE,
+                ARG_UNTIL
         };
 
         static const struct option options[] = {
@@ -151,6 +165,10 @@ static int parse_argv(int argc, char *argv[]) {
                 { "verify-key",   required_argument, NULL, ARG_VERIFY_KEY   },
                 { "disk-usage",   no_argument,       NULL, ARG_DISK_USAGE   },
                 { "cursor",       required_argument, NULL, 'c'              },
+                { "since",        required_argument, NULL, ARG_SINCE        },
+                { "until",        required_argument, NULL, ARG_UNTIL        },
+                { "unit",         required_argument, NULL, 'u'              },
+                { "field",        required_argument, NULL, 'F'              },
                 { NULL,           0,                 NULL, 0                }
         };
 
@@ -159,7 +177,7 @@ static int parse_argv(int argc, char *argv[]) {
         assert(argc >= 0);
         assert(argv);
 
-        while ((c = getopt_long(argc, argv, "hfo:an::qmbD:p:c:", options, NULL)) >= 0) {
+        while ((c = getopt_long(argc, argv, "hfo:an::qmbD:p:c:u:F:", options, NULL)) >= 0) {
 
                 switch (c) {
 
@@ -185,20 +203,27 @@ static int parse_argv(int argc, char *argv[]) {
                 case 'o':
                         arg_output = output_mode_from_string(optarg);
                         if (arg_output < 0) {
-                                log_error("Unknown output '%s'.", optarg);
+                                log_error("Unknown output format '%s'.", optarg);
                                 return -EINVAL;
                         }
 
+                        if (arg_output == OUTPUT_EXPORT ||
+                            arg_output == OUTPUT_JSON ||
+                            arg_output == OUTPUT_JSON_PRETTY ||
+                            arg_output == OUTPUT_JSON_SSE ||
+                            arg_output == OUTPUT_CAT)
+                                arg_quiet = true;
+
                         break;
 
                 case 'a':
-                        arg_show_all = true;
+                        arg_all = true;
                         break;
 
                 case 'n':
                         if (optarg) {
-                                r = safe_atoi(optarg, &arg_lines);
-                                if (r < 0 || arg_lines < 0) {
+                                r = safe_atou(optarg, &arg_lines);
+                                if (r < 0 || arg_lines <= 0) {
                                         log_error("Failed to parse lines '%s'", optarg);
                                         return -EINVAL;
                                 }
@@ -324,34 +349,55 @@ static int parse_argv(int argc, char *argv[]) {
                         break;
                 }
 
+                case ARG_SINCE:
+                        r = parse_timestamp(optarg, &arg_since);
+                        if (r < 0) {
+                                log_error("Failed to parse timestamp: %s", optarg);
+                                return -EINVAL;
+                        }
+                        arg_since_set = true;
+                        break;
+
+                case ARG_UNTIL:
+                        r = parse_timestamp(optarg, &arg_until);
+                        if (r < 0) {
+                                log_error("Failed to parse timestamp: %s", optarg);
+                                return -EINVAL;
+                        }
+                        arg_until_set = true;
+                        break;
+
+                case 'u':
+                        arg_unit = optarg;
+                        break;
+
                 case '?':
                         return -EINVAL;
 
+                case 'F':
+                        arg_field = optarg;
+                        break;
+
                 default:
                         log_error("Unknown option code %c", c);
                         return -EINVAL;
                 }
         }
 
-        if (arg_follow && !arg_no_tail && arg_lines < 0)
+        if (arg_follow && !arg_no_tail && arg_lines <= 0)
                 arg_lines = 10;
 
-        return 1;
-}
-
-static bool on_tty(void) {
-        static int t = -1;
-
-        /* Note that this is invoked relatively early, before we start
-         * the pager. That means the value we return reflects whether
-         * we originally were started on a tty, not if we currently
-         * are. But this is intended, since we want colour and so on
-         * when run in our own pager. */
+        if (arg_since_set && arg_until_set && arg_since_set > arg_until_set) {
+                log_error("--since= must be before --until=.");
+                return -EINVAL;
+        }
 
-        if (_unlikely_(t < 0))
-                t = isatty(STDOUT_FILENO) > 0;
+        if (arg_cursor && arg_since_set) {
+                log_error("Please specify either --since= or --cursor=, not both.");
+                return -EINVAL;
+        }
 
-        return t;
+        return 1;
 }
 
 static int generate_new_id128(void) {
@@ -463,6 +509,32 @@ static int add_this_boot(sd_journal *j) {
         return 0;
 }
 
+static int add_unit(sd_journal *j) {
+        _cleanup_free_ char *m = NULL, *u = NULL;
+        int r;
+
+        assert(j);
+
+        if (isempty(arg_unit))
+                return 0;
+
+        u = unit_name_mangle(arg_unit);
+        if (!u)
+                return log_oom();
+
+        m = strappend("_SYSTEMD_UNIT=", u);
+        if (!m)
+                return log_oom();
+
+        r = sd_journal_add_match(j, m, strlen(m));
+        if (r < 0) {
+                log_error("Failed to add match: %s", strerror(-r));
+                return r;
+        }
+
+        return 0;
+}
+
 static int add_priorities(sd_journal *j) {
         char match[] = "PRIORITY=0";
         int i, r;
@@ -610,7 +682,7 @@ static int setup_keys(void) {
                 goto finish;
         }
 
-        if (isatty(STDOUT_FILENO)) {
+        if (on_tty()) {
                 fprintf(stderr,
                         "\n"
                         "The new key pair has been generated. The " ANSI_HIGHLIGHT_ON "secret sealing key" ANSI_HIGHLIGHT_OFF " has been written to\n"
@@ -632,7 +704,7 @@ static int setup_keys(void) {
 
         printf("/%llx-%llx\n", (unsigned long long) n, (unsigned long long) arg_interval);
 
-        if (isatty(STDOUT_FILENO)) {
+        if (on_tty()) {
                 char tsb[FORMAT_TIMESPAN_MAX], *hn;
 
                 fprintf(stderr,
@@ -727,13 +799,33 @@ static int verify(sd_journal *j) {
         return r;
 }
 
+static int access_check(void) {
+
+#ifdef HAVE_ACL
+        if (access("/var/log/journal", F_OK) < 0 && geteuid() != 0 && in_group("adm") <= 0) {
+                log_error("Unprivileged users can't see messages unless persistent log storage is enabled. Users in the group 'adm' can always see messages.");
+                return -EACCES;
+        }
+
+        if (!arg_quiet && geteuid() != 0 && in_group("adm") <= 0)
+                log_warning("Showing user generated messages only. Users in the group 'adm' can see all messages. Pass -q to turn this notice off.");
+#else
+        if (geteuid() != 0 && in_group("adm") <= 0) {
+                log_error("No access to messages. Only users in the group 'adm' can see messages.");
+                return -EACCES;
+        }
+#endif
+
+        return 0;
+}
+
 int main(int argc, char *argv[]) {
         int r;
         sd_journal *j = NULL;
         bool need_seek = false;
         sd_id128_t previous_boot_id;
         bool previous_boot_id_valid = false;
-        bool have_pager;
+        unsigned n_shown = 0;
 
         log_parse_environment();
         log_open();
@@ -752,11 +844,14 @@ int main(int argc, char *argv[]) {
                 goto finish;
         }
 
+        r = access_check();
+        if (r < 0)
+                goto finish;
+
         if (arg_directory)
                 r = sd_journal_open_directory(&j, arg_directory, 0);
         else
                 r = sd_journal_open(&j, arg_merge ? 0 : SD_JOURNAL_LOCAL_ONLY);
-
         if (r < 0) {
                 log_error("Failed to open journal: %s", strerror(-r));
                 goto finish;
@@ -786,24 +881,11 @@ int main(int argc, char *argv[]) {
                 goto finish;
         }
 
-#ifdef HAVE_ACL
-        if (access("/var/log/journal", F_OK) < 0 && geteuid() != 0 && in_group("adm") <= 0) {
-                log_error("Unprivileged users can't see messages unless persistent log storage is enabled. Users in the group 'adm' can always see messages.");
-                r = -EACCES;
-                goto finish;
-        }
-
-        if (!arg_quiet && geteuid() != 0 && in_group("adm") <= 0)
-                log_warning("Showing user generated messages only. Users in the group 'adm' can see all messages. Pass -q to turn this notice off.");
-#else
-        if (geteuid() != 0 && in_group("adm") <= 0) {
-                log_error("No access to messages. Only users in the group 'adm' can see messages.");
-                r = -EACCES;
+        r = add_this_boot(j);
+        if (r < 0)
                 goto finish;
-        }
-#endif
 
-        r = add_this_boot(j);
+        r = add_unit(j);
         if (r < 0)
                 goto finish;
 
@@ -815,24 +897,33 @@ int main(int argc, char *argv[]) {
         if (r < 0)
                 goto finish;
 
-        if (!arg_quiet) {
-                usec_t start, end;
-                char start_buf[FORMAT_TIMESTAMP_MAX], end_buf[FORMAT_TIMESTAMP_MAX];
+        if (arg_field) {
+                const void *data;
+                size_t size;
 
-                r = sd_journal_get_cutoff_realtime_usec(j, &start, &end);
+                r = sd_journal_query_unique(j, arg_field);
                 if (r < 0) {
-                        log_error("Failed to get cutoff: %s", strerror(-r));
+                        log_error("Failed to query unique data objects: %s", strerror(-r));
                         goto finish;
                 }
 
-                if (r > 0) {
-                        if (arg_follow)
-                                printf("Logs begin at %s.\n", format_timestamp(start_buf, sizeof(start_buf), start));
+                SD_JOURNAL_FOREACH_UNIQUE(j, data, size) {
+                        const void *eq;
+
+                        if (arg_lines > 0 && n_shown >= arg_lines)
+                                break;
+
+                        eq = memchr(data, '=', size);
+                        if (eq)
+                                printf("%.*s\n", (int) (size - ((const uint8_t*) eq - (const uint8_t*) data + 1)), (const char*) eq + 1);
                         else
-                                printf("Logs begin at %s, end at %s.\n",
-                                       format_timestamp(start_buf, sizeof(start_buf), start),
-                                       format_timestamp(end_buf, sizeof(end_buf), end));
+                                printf("%.*s\n", (int) size, (const char*) data);
+
+                        n_shown ++;
                 }
+
+                r = 0;
+                goto finish;
         }
 
         if (arg_cursor) {
@@ -844,7 +935,15 @@ int main(int argc, char *argv[]) {
 
                 r = sd_journal_next(j);
 
-        } else if (arg_lines >= 0) {
+        } else if (arg_since_set) {
+                r = sd_journal_seek_realtime_usec(j, arg_since);
+                if (r < 0) {
+                        log_error("Failed to seek to date: %s", strerror(-r));
+                        goto finish;
+                }
+                r = sd_journal_next(j);
+
+        } else if (arg_lines > 0) {
                 r = sd_journal_seek_tail(j);
                 if (r < 0) {
                         log_error("Failed to seek to tail: %s", strerror(-r));
@@ -868,15 +967,33 @@ int main(int argc, char *argv[]) {
                 goto finish;
         }
 
-        on_tty();
-        have_pager = !arg_no_pager && !arg_follow && pager_open();
+        if (!arg_no_pager && !arg_follow)
+                pager_open();
+
+        if (!arg_quiet) {
+                usec_t start, end;
+                char start_buf[FORMAT_TIMESTAMP_MAX], end_buf[FORMAT_TIMESTAMP_MAX];
+
+                r = sd_journal_get_cutoff_realtime_usec(j, &start, &end);
+                if (r < 0) {
+                        log_error("Failed to get cutoff: %s", strerror(-r));
+                        goto finish;
+                }
+
+                if (r > 0) {
+                        if (arg_follow)
+                                printf("-- Logs begin at %s. --\n",
+                                       format_timestamp(start_buf, sizeof(start_buf), start));
+                        else
+                                printf("-- Logs begin at %s, end at %s. --\n",
+                                       format_timestamp(start_buf, sizeof(start_buf), start),
+                                       format_timestamp(end_buf, sizeof(end_buf), end));
+                }
+        }
 
         for (;;) {
-                for (;;) {
-                        int flags =
-                                arg_show_all * OUTPUT_SHOW_ALL |
-                                have_pager * OUTPUT_FULL_WIDTH |
-                                on_tty() * OUTPUT_COLOR;
+                while (arg_lines == 0 || arg_follow || n_shown < arg_lines) {
+                        int flags;
 
                         if (need_seek) {
                                 r = sd_journal_next(j);
@@ -889,6 +1006,16 @@ int main(int argc, char *argv[]) {
                         if (r == 0)
                                 break;
 
+                        if (arg_until_set) {
+                                usec_t usec;
+
+                                r = sd_journal_get_realtime_usec(j, &usec);
+                                if (r < 0) {
+                                        log_error("Failed to determine timestamp: %s", strerror(-r));
+                                        goto finish;
+                                }
+                        }
+
                         if (!arg_merge) {
                                 sd_id128_t boot_id;
 
@@ -896,18 +1023,24 @@ int main(int argc, char *argv[]) {
                                 if (r >= 0) {
                                         if (previous_boot_id_valid &&
                                             !sd_id128_equal(boot_id, previous_boot_id))
-                                                printf(ANSI_HIGHLIGHT_ON "----- Reboot -----" ANSI_HIGHLIGHT_OFF "\n");
+                                                printf(ANSI_HIGHLIGHT_ON "-- Reboot --" ANSI_HIGHLIGHT_OFF "\n");
 
                                         previous_boot_id = boot_id;
                                         previous_boot_id_valid = true;
                                 }
                         }
 
+                        flags =
+                                arg_all * OUTPUT_SHOW_ALL |
+                                (!on_tty() || pager_have()) * OUTPUT_FULL_WIDTH |
+                                on_tty() * OUTPUT_COLOR;
+
                         r = output_journal(stdout, j, arg_output, 0, flags);
                         if (r < 0)
                                 goto finish;
 
                         need_seek = true;
+                        n_shown++;
                 }
 
                 if (!arg_follow)