chiark / gitweb /
journal: implement message catalog
[elogind.git] / src / journal / journalctl.c
index 5980eb0b48b8c45d61d05ff863abb7344e860e5d..46a7be20cea1c1e76d97d23f9cf2ecda2f4c201b 100644 (file)
@@ -19,6 +19,7 @@
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 ***/
 
+#include <locale.h>
 #include <fcntl.h>
 #include <errno.h>
 #include <stddef.h>
@@ -33,8 +34,6 @@
 #include <sys/stat.h>
 #include <sys/ioctl.h>
 #include <linux/fs.h>
-#include <locale.h>
-#include <langinfo.h>
 
 #include <systemd/sd-journal.h>
 
 #include "journal-qrcode.h"
 #include "fsprg.h"
 #include "unit-name.h"
+#include "catalog.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 unsigned arg_lines = 0;
 static bool arg_no_tail = false;
@@ -75,6 +75,7 @@ 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 bool arg_catalog = false;
 
 static enum {
         ACTION_SHOW,
@@ -83,24 +84,27 @@ static enum {
         ACTION_SETUP_KEYS,
         ACTION_VERIFY,
         ACTION_DISK_USAGE,
+        ACTION_LIST_CATALOG,
+        ACTION_UPDATE_CATALOG
 } arg_action = ACTION_SHOW;
 
 static int help(void) {
 
-        printf("%s [OPTIONS...] [MATCH]\n\n"
+        printf("%s [OPTIONS...] [MATCHES...]\n\n"
                "Query the journal.\n\n"
                "Flags:\n"
-               "  -c --cursor=CURSOR     Start showing entries from specified cursor\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\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"
+               "  -x --catalog           Add message explanations where available\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"
@@ -117,6 +121,8 @@ static int help(void) {
                "     --header            Show journal header information\n"
                "     --disk-usage        Show total disk usage\n"
                "  -F --field=FIELD       List all values a certain field takes\n"
+               "     --list-catalog      Show message IDs of all entries in the message catalog\n"
+               "     --update-catalog    Update the message catalog database\n"
 #ifdef HAVE_GCRYPT
                "     --setup-keys        Generate new FSS key pair\n"
                "     --verify            Verify journal file consistency\n"
@@ -140,7 +146,9 @@ static int parse_argv(int argc, char *argv[]) {
                 ARG_VERIFY_KEY,
                 ARG_DISK_USAGE,
                 ARG_SINCE,
-                ARG_UNTIL
+                ARG_UNTIL,
+                ARG_LIST_CATALOG,
+                ARG_UPDATE_CATALOG
         };
 
         static const struct option options[] = {
@@ -158,7 +166,7 @@ static int parse_argv(int argc, char *argv[]) {
                 { "this-boot",    no_argument,       NULL, 'b'              },
                 { "directory",    required_argument, NULL, 'D'              },
                 { "header",       no_argument,       NULL, ARG_HEADER       },
-                { "priority",     no_argument,       NULL, 'p'              },
+                { "priority",     required_argument, NULL, 'p'              },
                 { "setup-keys",   no_argument,       NULL, ARG_SETUP_KEYS   },
                 { "interval",     required_argument, NULL, ARG_INTERVAL     },
                 { "verify",       no_argument,       NULL, ARG_VERIFY       },
@@ -169,6 +177,9 @@ static int parse_argv(int argc, char *argv[]) {
                 { "until",        required_argument, NULL, ARG_UNTIL        },
                 { "unit",         required_argument, NULL, 'u'              },
                 { "field",        required_argument, NULL, 'F'              },
+                { "catalog",      no_argument,       NULL, 'x'              },
+                { "list-catalog", no_argument,       NULL, ARG_LIST_CATALOG },
+                { "update-catalog",no_argument,      NULL, ARG_UPDATE_CATALOG },
                 { NULL,           0,                 NULL, 0                }
         };
 
@@ -177,7 +188,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:u:F:", options, NULL)) >= 0) {
+        while ((c = getopt_long(argc, argv, "hfo:an::qmbD:p:c:u:F:x", options, NULL)) >= 0) {
 
                 switch (c) {
 
@@ -197,7 +208,6 @@ static int parse_argv(int argc, char *argv[]) {
 
                 case 'f':
                         arg_follow = true;
-                        signal(SIGWINCH, columns_cache_reset);
                         break;
 
                 case 'o':
@@ -217,7 +227,7 @@ static int parse_argv(int argc, char *argv[]) {
                         break;
 
                 case 'a':
-                        arg_show_all = true;
+                        arg_all = true;
                         break;
 
                 case 'n':
@@ -378,6 +388,18 @@ static int parse_argv(int argc, char *argv[]) {
                         arg_field = optarg;
                         break;
 
+                case 'x':
+                        arg_catalog = true;
+                        break;
+
+                case ARG_LIST_CATALOG:
+                        arg_action = ACTION_LIST_CATALOG;
+                        break;
+
+                case ARG_UPDATE_CATALOG:
+                        arg_action = ACTION_UPDATE_CATALOG;
+                        break;
+
                 default:
                         log_error("Unknown option code %c", c);
                         return -EINVAL;
@@ -400,21 +422,6 @@ static int parse_argv(int argc, char *argv[]) {
         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 (_unlikely_(t < 0))
-                t = isatty(STDOUT_FILENO) > 0;
-
-        return t;
-}
-
 static int generate_new_id128(void) {
         sd_id128_t id;
         int r;
@@ -563,8 +570,6 @@ static int add_priorities(sd_journal *j) {
                 if (arg_priorities & (1 << i)) {
                         match[sizeof(match)-2] = '0' + i;
 
-                        log_info("adding match %s", match);
-
                         r = sd_journal_add_match(j, match, strlen(match));
                         if (r < 0) {
                                 log_error("Failed to add match: %s", strerror(-r));
@@ -697,7 +702,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"
@@ -719,7 +724,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,
@@ -737,9 +742,7 @@ static int setup_keys(void) {
 
 #ifdef HAVE_QRENCODE
                 /* If this is not an UTF-8 system don't print any QR codes */
-                setlocale(LC_CTYPE, "");
-
-                if (streq_ptr(nl_langinfo(CODESET), "UTF-8")) {
+                if (is_locale_utf8()) {
                         fputs("\nTo transfer the verification key to your phone please scan the QR code below:\n\n", stderr);
                         print_qr_code(stderr, seed, seed_size, n, arg_interval, hn, machine);
                 }
@@ -840,9 +843,9 @@ int main(int argc, char *argv[]) {
         bool need_seek = false;
         sd_id128_t previous_boot_id;
         bool previous_boot_id_valid = false;
-        bool have_pager;
         unsigned n_shown = 0;
 
+        setlocale(LC_ALL, "");
         log_parse_environment();
         log_open();
 
@@ -850,6 +853,8 @@ int main(int argc, char *argv[]) {
         if (r <= 0)
                 goto finish;
 
+        signal(SIGWINCH, columns_lines_cache_reset);
+
         if (arg_action == ACTION_NEW_ID128) {
                 r = generate_new_id128();
                 goto finish;
@@ -860,6 +865,16 @@ int main(int argc, char *argv[]) {
                 goto finish;
         }
 
+        if (arg_action == ACTION_LIST_CATALOG)  {
+                r = catalog_list(stdout);
+                goto finish;
+        }
+
+        if (arg_action == ACTION_UPDATE_CATALOG)  {
+                r = catalog_update();
+                goto finish;
+        }
+
         r = access_check();
         if (r < 0)
                 goto finish;
@@ -926,11 +941,16 @@ int main(int argc, char *argv[]) {
                 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("%.*s\n", (int) size, (const char*) data);
+
+                        n_shown ++;
                 }
 
                 r = 0;
@@ -978,8 +998,8 @@ 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;
@@ -1042,9 +1062,10 @@ int main(int argc, char *argv[]) {
                         }
 
                         flags =
-                                arg_show_all * OUTPUT_SHOW_ALL |
-                                have_pager * OUTPUT_FULL_WIDTH |
-                                on_tty() * OUTPUT_COLOR;
+                                arg_all * OUTPUT_SHOW_ALL |
+                                (!on_tty() || pager_have()) * OUTPUT_FULL_WIDTH |
+                                on_tty() * OUTPUT_COLOR |
+                                arg_catalog * OUTPUT_CATALOG;
 
                         r = output_journal(stdout, j, arg_output, 0, flags);
                         if (r < 0)