SymbX/systemd
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

importctl: draw a pretty progress bar while downloading

Browse Source 
Everybody loves pretty terminal progress bar.
This commit is contained in:
Lennart Poettering
2024-03-01 22:25:42 +01:00
parent 8ce438bb71
commit 71cb203a6e
9 changed files with 228 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/import/importctl.c
+76 -15
View File
@@ -45,6 +45,8 @@ static const char* arg_format = NULL;
static JsonFormatFlags arg_json_format_flags = JSON_FORMAT_OFF;
static ImageClass arg_image_class = _IMAGE_CLASS_INVALID;
#define PROGRESS_PREFIX "Total: "
static int settle_image_class(void) {
if (arg_image_class < 0) {
@@ -68,13 +70,21 @@ static int settle_image_class(void) {
return 0;
}
typedef struct Context {
const char *object_path;
double progress;
} Context;
static int match_log_message(sd_bus_message *m, void *userdata, sd_bus_error *error) {
const char **our_path = userdata, *line;
Context *c = ASSERT_PTR(userdata);
const char *line;
unsigned priority;
int r;
assert(m);
assert(our_path);
if (!streq_ptr(c->object_path, sd_bus_message_get_path(m)))
return 0;
r = sd_bus_message_read(m, "us", &priority, &line);
if (r < 0) {
@@ -82,23 +92,51 @@ static int match_log_message(sd_bus_message *m, void *userdata, sd_bus_error *er
return 0;
}
if (!streq_ptr(*our_path, sd_bus_message_get_path(m)))
return 0;
if (arg_quiet && LOG_PRI(priority) >= LOG_INFO)
return 0;
if (!arg_quiet)
clear_progress_bar(PROGRESS_PREFIX);
log_full(priority, "%s", line);
if (!arg_quiet)
draw_progress_bar(PROGRESS_PREFIX, c->progress * 100);
return 0;
}
static int match_progress_update(sd_bus_message *m, void *userdata, sd_bus_error *error) {
Context *c = ASSERT_PTR(userdata);
int r;
assert(m);
if (!streq_ptr(c->object_path, sd_bus_message_get_path(m)))
return 0;
r = sd_bus_message_read(m, "d", &c->progress);
if (r < 0) {
bus_log_parse_error(r);
return 0;
}
if (!arg_quiet)
draw_progress_bar(PROGRESS_PREFIX, c->progress * 100);
return 0;
}
static int match_transfer_removed(sd_bus_message *m, void *userdata, sd_bus_error *error) {
const char **our_path = userdata, *path, *result;
Context *c = ASSERT_PTR(userdata);
const char *path, *result;
uint32_t id;
int r;
assert(m);
assert(our_path);
if (!arg_quiet)
clear_progress_bar(PROGRESS_PREFIX);
r = sd_bus_message_read(m, "uos", &id, &path, &result);
if (r < 0) {
@@ -106,7 +144,7 @@ static int match_transfer_removed(sd_bus_message *m, void *userdata, sd_bus_erro
return 0;
}
if (!streq_ptr(*our_path, path))
if (!streq_ptr(c->object_path, path))
return 0;
sd_event_exit(sd_bus_get_event(sd_bus_message_get_bus(m)), !streq_ptr(result, "done"));
@@ -117,6 +155,9 @@ static int transfer_signal_handler(sd_event_source *s, const struct signalfd_sig
assert(s);
assert(si);
if (!arg_quiet)
clear_progress_bar(PROGRESS_PREFIX);
if (!arg_quiet)
log_info("Continuing download in the background. Use \"%s cancel-transfer %" PRIu32 "\" to abort transfer.",
program_invocation_short_name,
@@ -127,11 +168,11 @@ static int transfer_signal_handler(sd_event_source *s, const struct signalfd_sig
}
static int transfer_image_common(sd_bus *bus, sd_bus_message *m) {
_cleanup_(sd_bus_slot_unrefp) sd_bus_slot *slot_job_removed = NULL, *slot_log_message = NULL;
_cleanup_(sd_bus_slot_unrefp) sd_bus_slot *slot_job_removed = NULL, *slot_log_message = NULL, *slot_progress_update = NULL;
_cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
_cleanup_(sd_bus_message_unrefp) sd_bus_message *reply = NULL;
_cleanup_(sd_event_unrefp) sd_event* event = NULL;
const char *path = NULL;
Context c = {};
uint32_t id;
int r;
@@ -153,7 +194,9 @@ static int transfer_image_common(sd_bus *bus, sd_bus_message *m) {
&slot_job_removed,
bus_import_mgr,
"TransferRemoved",
match_transfer_removed, NULL, &path);
match_transfer_removed,
/* add_callback= */ NULL,
&c);
if (r < 0)
return log_error_errno(r, "Failed to request match: %m");
@@ -161,10 +204,25 @@ static int transfer_image_common(sd_bus *bus, sd_bus_message *m) {
bus,
&slot_log_message,
"org.freedesktop.import1",
NULL,
/* object_path= */ NULL,
"org.freedesktop.import1.Transfer",
"LogMessage",
match_log_message, NULL, &path);
match_log_message,
/* add_callback= */ NULL,
&c);
if (r < 0)
return log_error_errno(r, "Failed to request match: %m");
r = sd_bus_match_signal_async(
bus,
&slot_progress_update,
"org.freedesktop.import1",
/* object_path= */ NULL,
"org.freedesktop.import1.Transfer",
"ProgressUpdate",
match_progress_update,
/* add_callback= */ NULL,
&c);
if (r < 0)
return log_error_errno(r, "Failed to request match: %m");
@@ -172,12 +230,15 @@ static int transfer_image_common(sd_bus *bus, sd_bus_message *m) {
if (r < 0)
return log_error_errno(r, "Failed to transfer image: %s", bus_error_message(&error, r));
r = sd_bus_message_read(reply, "uo", &id, &path);
r = sd_bus_message_read(reply, "uo", &id, &c.object_path);
if (r < 0)
return bus_log_parse_error(r);
if (!arg_quiet)
if (!arg_quiet) {
clear_progress_bar(PROGRESS_PREFIX);
log_info("Enqueued transfer job %u. Press C-c to continue download in background.", id);
draw_progress_bar(PROGRESS_PREFIX, c.progress);
}
(void) sd_event_add_signal(event, NULL, SIGINT|SD_EVENT_SIGNAL_PROCMASK, transfer_signal_handler, UINT32_TO_PTR(id));
(void) sd_event_add_signal(event, NULL, SIGTERM|SD_EVENT_SIGNAL_PROCMASK, transfer_signal_handler, UINT32_TO_PTR(id));
src/import/importd.c
+31 -2
View File
@@ -83,6 +83,7 @@ struct Transfer {
unsigned n_canceled;
unsigned progress_percent;
unsigned progress_percent_sent;
int stdin_fd;
int stdout_fd;
@@ -166,7 +167,8 @@ static int transfer_new(Manager *m, Transfer **ret) {
.stdin_fd = -EBADF,
.stdout_fd = -EBADF,
.verify = _IMPORT_VERIFY_INVALID,
.progress_percent= UINT_MAX,
.progress_percent = UINT_MAX,
.progress_percent_sent = UINT_MAX,
};
id = m->current_transfer_id + 1;
@@ -217,7 +219,28 @@ static void transfer_send_log_line(Transfer *t, const char *line) {
line);
if (r < 0)
log_warning_errno(r, "Cannot emit log message signal, ignoring: %m");
}
}
static void transfer_send_progress_update(Transfer *t) {
int r;
assert(t);
if (t->progress_percent_sent == t->progress_percent)
return;
r = sd_bus_emit_signal(
t->manager->bus,
t->object_path,
"org.freedesktop.import1.Transfer",
"ProgressUpdate",
"d",
transfer_percent_as_double(t));
if (r < 0)
log_warning_errno(r, "Cannot emit progress update signal, ignoring: %m");
t->progress_percent_sent = t->progress_percent;
}
static void transfer_send_logs(Transfer *t, bool flush) {
assert(t);
@@ -635,6 +658,8 @@ static int manager_on_notify(sd_event_source *s, int fd, uint32_t revents, void
t->progress_percent = (unsigned) r;
log_debug("Got percentage from client: %u%%", t->progress_percent);
transfer_send_progress_update(t);
return 0;
}
@@ -1369,6 +1394,10 @@ static const sd_bus_vtable transfer_vtable[] = {
SD_BUS_PARAM(priority)
SD_BUS_PARAM(line),
0),
SD_BUS_SIGNAL_WITH_NAMES("ProgressUpdate",
"d",
SD_BUS_PARAM(progress),
0),
SD_BUS_VTABLE_END,
};