Changeset 4511ac3

Timestamp:

Aug 5, 2017, 11:21:53 PM (8 years ago)

Author:

Jason Gross <jasongross9@gmail.com>

Branches:

master

Children:

253f37f

Parents:

565a43c

git-author:

Jason Gross <jgross@mit.edu> (08/05/17 22:06:52)

git-committer:

Jason Gross <jasongross9@gmail.com> (08/05/17 23:21:53)

Message:

Better UI for :flush-logs and flush-logs-interval

We now only print the message about how many logs there are to flush
when -q is not passed to :flush-logs.  The timer from
flush-logs-interval passes -q, so the user won't see "There are no logs
to flush." ever few minutes.

Files:

• commands.c (modified) (3 diffs)
• logging.c (modified) (6 diffs)
• perl/lib/BarnOwl/DeferredLogging.pm (modified) (1 diff)

commands.c

@@ -490 +490 @@
   OWLCMD_ARGS("flush-logs", owl_command_flushlogs, OWL_CTX_ANY,
               "flush the queue of messages waiting to be logged",
-              "flush-logs [-f | --force]",
+              "flush-logs [-f | --force] [-q | --quiet]",
               "If BarnOwl failed to log a file, this command tells\n"
               "BarnOwl to try logging the messages that have since\n"
@@ -501 +501 @@
               "any messages on the queue which cannot successfully be\n"
               "logged are dropped, and BarnOwl will resume logging\n"
-              "normally."),
+              "normally.\n"
+              "\n"
+              "Unless --quiet is passed, a message is printed about\n"
+              "how many logs there are to flush."),
 
   OWLCMD_ARGS("load-subs", owl_command_loadsubs, OWL_CTX_ANY,
@@ -1454 +1457 @@
 char *owl_command_flushlogs(int argc, const char *const *argv, const char *buff)
 {
-  if (argc == 1) {
-    owl_log_flush_logs(false);
-  } else if (argc == 2) {
-    if (!strcmp(argv[1], "-f") || !strcmp(argv[1], "--force")) {
-      owl_log_flush_logs(true);
+  bool force = false;
+  bool quiet = false;
+  int i;
+
+  for (i = 1; i < argc; i++) {
+    if (!strcmp(argv[i], "-f") || !strcmp(argv[i], "--force")) {
+      force = true;
+    } else if (!strcmp(argv[i], "-q") || !strcmp(argv[i], "--quiet")) {
+      quiet = true;
     } else {
-      owl_function_makemsg("Invalid flag to flush-logs: %s", argv[1]);
+      owl_function_makemsg("Invalid flag to flush-logs: %s", argv[i]);
     }
-  } else {
-    owl_function_makemsg("Wrong number of arguments for flush-logs.");
-  }
+  }
+  owl_log_flush_logs(force, quiet);
   return NULL;
 }

logging.c

@@ -7 +7 @@
 } owl_log_entry;
 
+typedef struct _owl_log_options { /* noproto */
+  bool drop_failed_logs;
+  bool display_initial_log_count;
+} owl_log_options;
 
 static GMainContext *log_context;
@@ -302 +306 @@
 {
   owl_log_entry *entry;
-  bool drop_failed_logs = *(bool *)data;
+  owl_log_options *opts = (owl_log_options *)data;
   int ret;
   int logged_message_count = 0;
   bool all_succeeded = true;
 
-  if (g_queue_is_empty(deferred_entry_queue)) {
-    owl_log_makemsg("There are no logs to flush.");
-  } else {
-    owl_log_makemsg("Attempting to flush %u logs...",
-                     g_queue_get_length(deferred_entry_queue));
+  if (opts->display_initial_log_count) {
+    if (g_queue_is_empty(deferred_entry_queue)) {
+      owl_log_makemsg("There are no logs to flush.");
+    } else {
+      owl_log_makemsg("Attempting to flush %u logs...",
+                      g_queue_get_length(deferred_entry_queue));
+    }
   }
 
@@ -318 +324 @@
     logged_message_count++;
     entry = (owl_log_entry*)g_queue_pop_head(deferred_entry_queue);
-    if (!drop_failed_logs) {
+    if (!opts->drop_failed_logs) {
       /* Attempt to write the log entry.  If it fails, re-queue the entry at
        * the head of the queue. */
@@ -334 +340 @@
   }
   if (logged_message_count > 0) {
-    /* first clear the "attempting to flush" message from the status bar */
-    owl_log_makemsg("");
+    if (opts->display_initial_log_count) {
+      /* first clear the "attempting to flush" message from the status bar */
+      owl_log_makemsg("");
+    }
     if (!defer_logs) {
       if (all_succeeded) {
@@ -351 +359 @@
 }
 
-void owl_log_flush_logs(bool drop_failed_logs)
-{
-  bool *data = g_new(bool, 1);
-  *data = drop_failed_logs;
+void owl_log_flush_logs(bool drop_failed_logs, bool quiet)
+{
+  owl_log_options *data = g_new(owl_log_options, 1);
+  data->drop_failed_logs = drop_failed_logs;
+  data->display_initial_log_count = !quiet;
 
   owl_select_post_task(owl_log_write_deferred_entries,
@@ -641 +650 @@
   /* flush the deferred logs queue, trying to write the
    * entries to the disk one last time.  Drop any failed
-   * entries */
-  bool bool_true = true;
-  owl_log_write_deferred_entries(&bool_true);
+   * entries, and be quiet about it. */
+  owl_log_options opts;
+  opts.drop_failed_logs = true;
+  opts.display_initial_log_count = false;
+  owl_log_write_deferred_entries(&opts);
 #if GLIB_CHECK_VERSION(2, 32, 0)
   g_queue_free_full(deferred_entry_queue, owl_log_entry_free);

perl/lib/BarnOwl/DeferredLogging.pm

@@ -50 +50 @@
                             name     => 'flush-logs interval timer',
                             interval => 60 * $flush_logs_interval,
-                            cb       => sub { BarnOwl::command("flush-logs"); }
+                            cb       => sub { BarnOwl::command("flush-logs", "-q"); }
                         });
                 }