/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- * * Copyright (C) 2014 Anne LoVerso * Copyright (C) 2016 Red Hat, Inc. * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as published * by the Free Software Foundation; either version 2 of the licence or (at * your option) any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General * Public License along with this library; if not, write to the * Free Software Foundation, Inc., 59 Temple Place, Suite 330, * Boston, MA 02111-1307, USA. */ #include "config.h" #include #include #include #include #include #include "rpmostree-builtins.h" #include "rpmostree-libbuiltin.h" #include "rpmostree-dbus-helpers.h" #include "rpmostree-util.h" #include "rpmostree-rpm-util.h" #include "libsd-locale-util.h" #include static gboolean opt_pretty; static gboolean opt_verbose; static gboolean opt_json; static const char *opt_jsonpath; static GOptionEntry option_entries[] = { { "pretty", 'p', G_OPTION_FLAG_HIDDEN, G_OPTION_ARG_NONE, &opt_pretty, "This option is deprecated and no longer has any effect", NULL }, { "verbose", 'v', 0, G_OPTION_ARG_NONE, &opt_verbose, "Print additional fields (e.g. StateRoot)", NULL }, { "json", 0, 0, G_OPTION_ARG_NONE, &opt_json, "Output JSON", NULL }, { "jsonpath", 'J', 0, G_OPTION_ARG_STRING, &opt_jsonpath, "Filter JSONPath expression", "EXPRESSION" }, { NULL } }; /* return space available for printing value side of kv */ static guint get_textarea_width (guint maxkeylen) { const guint columns = glnx_console_columns (); /* +2 for initial leading spaces */ const guint right_side_width = maxkeylen + 2 + strlen (": "); if (right_side_width >= columns) return G_MAXUINT; /* can't even print keys without wrapping, nothing pretty to do here */ /* the sha is already 64 chars, so no point in trying to use less */ return MAX(OSTREE_SHA256_STRING_LEN, columns - right_side_width); } static GVariant * get_active_txn (RPMOSTreeSysroot *sysroot_proxy) { GVariant* txn = rpmostree_sysroot_get_active_transaction (sysroot_proxy); const char *a, *b, *c; if (txn) { g_variant_get (txn, "(&s&s&s)", &a, &b, &c); if (*a) return txn; } return NULL; } static void print_packages (const char *k, guint max_key_len, const char *const* pkgs, const char *const* omit_pkgs) { g_autoptr(GPtrArray) packages_sorted = g_ptr_array_new_with_free_func (g_free); static gsize regex_initialized; static GRegex *safe_chars_regex; if (g_once_init_enter (®ex_initialized)) { safe_chars_regex = g_regex_new ("^[[:alnum:]-._]+$", 0, 0, NULL); g_assert (safe_chars_regex); g_once_init_leave (®ex_initialized, 1); } for (char **iter = (char**) pkgs; iter && *iter; iter++) { if (omit_pkgs != NULL && g_strv_contains (omit_pkgs, *iter)) continue; /* don't quote if it just has common pkgname/shell-safe chars */ if (g_regex_match (safe_chars_regex, *iter, 0, 0)) g_ptr_array_add (packages_sorted, g_strdup (*iter)); else g_ptr_array_add (packages_sorted, g_shell_quote (*iter)); } const guint n_packages = packages_sorted->len; if (n_packages == 0) return; rpmostree_print_kv_no_newline (k, max_key_len, ""); /* wrap pkglist output ourselves rather than letting the terminal cut us up */ const guint area_width = get_textarea_width (max_key_len); guint current_width = 0; for (guint i = 0; i < n_packages; i++) { const char *pkg = packages_sorted->pdata[i]; const guint pkg_width = strlen (pkg); /* first print */ if (current_width == 0) { g_print ("%s", pkg); current_width += pkg_width; } else if ((current_width + pkg_width + 1) <= area_width) /* +1 for space separator */ { g_print (" %s", pkg); current_width += (pkg_width + 1); } else { /* always print at least one per line, even if we overflow */ putc ('\n', stdout); rpmostree_print_kv_no_newline ("", max_key_len, pkg); current_width = pkg_width; } } putc ('\n', stdout); } static const gchar** lookup_array_and_canonicalize (GVariantDict *dict, const char *key) { g_autofree const gchar **ret = NULL; if (g_variant_dict_lookup (dict, key, "^a&s", &ret)) { /* Canonicalize length 0 strv to NULL */ if (!*ret) g_clear_pointer (&ret, g_free); } return g_steal_pointer (&ret); } static void gv_nevra_to_evr (GString *buffer, GVariant *gv_nevra) { guint64 epoch; const char *version, *release; g_variant_get (gv_nevra, "(sst&s&ss)", NULL, NULL, &epoch, &version, &release, NULL); rpmostree_custom_nevra (buffer, NULL, epoch, version, release, NULL, PKG_NEVRA_FLAGS_EPOCH_VERSION_RELEASE); } /* We will have an optimized path for the case where there are just * two deployments, this code will be the generic fallback. */ static gboolean status_generic (RPMOSTreeSysroot *sysroot_proxy, RPMOSTreeOS *os_proxy, GVariant *deployments, GCancellable *cancellable, GError **error) { GVariantIter iter; gboolean first = TRUE; /* First, gather global state */ gboolean have_any_live_overlay = FALSE; g_variant_iter_init (&iter, deployments); while (TRUE) { g_autoptr(GVariant) child = g_variant_iter_next_value (&iter); if (!child) break; g_autoptr(GVariantDict) dict = g_variant_dict_new (child); const gchar *live_inprogress; if (!g_variant_dict_lookup (dict, "live-inprogress", "&s", &live_inprogress)) live_inprogress = NULL; const gchar *live_replaced; if (!g_variant_dict_lookup (dict, "live-replaced", "&s", &live_replaced)) live_replaced = NULL; const gboolean have_live_changes = live_inprogress || live_replaced; have_any_live_overlay = have_any_live_overlay || have_live_changes; } glnx_unref_object RPMOSTreeTransaction *txn_proxy = NULL; if (!rpmostree_transaction_connect_active (sysroot_proxy, NULL, &txn_proxy, cancellable, error)) return FALSE; if (txn_proxy) { const char *title = rpmostree_transaction_get_title (txn_proxy); g_print ("State: transaction: %s\n", title); } else g_print ("State: idle\n"); g_print ("Deployments:\n"); g_variant_iter_init (&iter, deployments); while (TRUE) { g_autoptr(GVariant) child = g_variant_iter_next_value (&iter); g_autoptr(GVariantDict) dict = NULL; g_autoptr(GVariantDict) commit_meta_dict = NULL; g_autoptr(GVariantDict) layered_commit_meta_dict = NULL; gboolean is_locally_assembled = FALSE; g_autofree const gchar **origin_packages = NULL; g_autofree const gchar **origin_requested_packages = NULL; g_autofree const gchar **origin_requested_local_packages = NULL; g_autoptr(GVariant) origin_base_removals = NULL; g_autofree const gchar **origin_requested_base_removals = NULL; g_autoptr(GVariant) origin_base_local_replacements = NULL; g_autofree const gchar **origin_requested_base_local_replacements = NULL; const gchar *origin_refspec; const gchar *id; const gchar *os_name; const gchar *checksum; const gchar *version_string; const gchar *unlocked; const gchar *live_inprogress; const gchar *live_replaced; gboolean gpg_enabled; gboolean regenerate_initramfs; guint64 t = 0; int serial; gboolean is_booted; const gboolean was_first = first; /* Add the long keys here */ const guint max_key_len = MAX (strlen ("InactiveBaseReplacements"), strlen ("InterruptedLiveCommit")); g_autoptr(GVariant) signatures = NULL; g_autofree char *timestamp_string = NULL; if (child == NULL) break; dict = g_variant_dict_new (child); /* osname should always be present. */ g_assert (g_variant_dict_lookup (dict, "osname", "&s", &os_name)); g_assert (g_variant_dict_lookup (dict, "id", "&s", &id)); g_assert (g_variant_dict_lookup (dict, "serial", "i", &serial)); g_assert (g_variant_dict_lookup (dict, "checksum", "&s", &checksum)); if (g_variant_dict_lookup (dict, "origin", "&s", &origin_refspec)) { origin_packages = lookup_array_and_canonicalize (dict, "packages"); origin_requested_packages = lookup_array_and_canonicalize (dict, "requested-packages"); origin_requested_local_packages = lookup_array_and_canonicalize (dict, "requested-local-packages"); origin_base_removals = g_variant_dict_lookup_value (dict, "base-removals", G_VARIANT_TYPE ("av")); origin_requested_base_removals = lookup_array_and_canonicalize (dict, "requested-base-removals"); origin_base_local_replacements = g_variant_dict_lookup_value (dict, "base-local-replacements", G_VARIANT_TYPE ("a(vv)")); origin_requested_base_local_replacements = lookup_array_and_canonicalize (dict, "requested-base-local-replacements"); } else origin_refspec = NULL; if (!g_variant_dict_lookup (dict, "version", "&s", &version_string)) version_string = NULL; if (!g_variant_dict_lookup (dict, "unlocked", "&s", &unlocked)) unlocked = NULL; if (!g_variant_dict_lookup (dict, "regenerate-initramfs", "b", ®enerate_initramfs)) regenerate_initramfs = FALSE; signatures = g_variant_dict_lookup_value (dict, "signatures", G_VARIANT_TYPE ("av")); if (first) first = FALSE; else g_print ("\n"); if (!g_variant_dict_lookup (dict, "booted", "b", &is_booted)) is_booted = FALSE; g_print ("%s ", is_booted ? libsd_special_glyph (BLACK_CIRCLE) : " "); if (origin_refspec) g_print ("ostree://%s", origin_refspec); else g_print ("%s", checksum); g_print ("\n"); const char *base_checksum = NULL; g_variant_dict_lookup (dict, "base-checksum", "&s", &base_checksum); if (base_checksum != NULL) is_locally_assembled = TRUE; /* Load the commit metadata into a dict */ { g_autoptr(GVariant) commit_meta_v = NULL; g_assert (g_variant_dict_lookup (dict, "base-commit-meta", "@a{sv}", &commit_meta_v)); commit_meta_dict = g_variant_dict_new (commit_meta_v); } if (is_locally_assembled) { g_autoptr(GVariant) layered_commit_meta_v = NULL; g_assert (g_variant_dict_lookup (dict, "layered-commit-meta", "@a{sv}", &layered_commit_meta_v)); layered_commit_meta_dict = g_variant_dict_new (layered_commit_meta_v); } const gchar *source_title = NULL; g_variant_dict_lookup (commit_meta_dict, OSTREE_COMMIT_META_KEY_SOURCE_TITLE, "&s", &source_title); if (source_title) g_print (" %s %s\n", libsd_special_glyph (TREE_RIGHT), source_title); if (is_locally_assembled) g_assert (g_variant_dict_lookup (dict, "base-timestamp", "t", &t)); else g_assert (g_variant_dict_lookup (dict, "timestamp", "t", &t)); timestamp_string = rpmostree_timestamp_str_from_unix_utc (t); rpmostree_print_timestamp_version (version_string, timestamp_string, max_key_len); if (!g_variant_dict_lookup (dict, "live-inprogress", "&s", &live_inprogress)) live_inprogress = NULL; if (!g_variant_dict_lookup (dict, "live-replaced", "&s", &live_replaced)) live_replaced = NULL; const gboolean have_live_changes = live_inprogress || live_replaced; if (is_locally_assembled) { if (have_live_changes) rpmostree_print_kv ("BootedBaseCommit", max_key_len, base_checksum); else rpmostree_print_kv ("BaseCommit", max_key_len, base_checksum); if (opt_verbose || have_any_live_overlay) rpmostree_print_kv ("Commit", max_key_len, checksum); } else { if (have_live_changes) rpmostree_print_kv ("BootedCommit", max_key_len, checksum); if (!have_live_changes || opt_verbose) rpmostree_print_kv ("Commit", max_key_len, checksum); } if (live_inprogress) { if (is_booted) g_print ("%s%s", get_red_start (), get_bold_start ()); rpmostree_print_kv ("InterruptedLiveCommit", max_key_len, live_inprogress); if (is_booted) g_print ("%s%s", get_bold_end (), get_red_end ()); } if (live_replaced) { if (is_booted) g_print ("%s%s", get_red_start (), get_bold_start ()); rpmostree_print_kv ("LiveCommit", max_key_len, live_replaced); if (is_booted) g_print ("%s%s", get_bold_end (), get_red_end ()); } /* Show any difference between the baseref vs head, but only for the booted commit, and only if there isn't a pending deployment. Otherwise it's either unnecessary or too noisy. */ if (is_booted && was_first) { const gchar *pending_checksum = NULL; const gchar *pending_version = NULL; if (g_variant_dict_lookup (dict, "pending-base-checksum", "&s", &pending_checksum)) { rpmostree_print_kv (is_locally_assembled ? "PendingBaseCommit" : "PendingCommit", max_key_len, pending_checksum); g_assert (g_variant_dict_lookup (dict, "pending-base-timestamp", "t", &t)); g_variant_dict_lookup (dict, "pending-base-version", "&s", &pending_version); if (pending_version) { g_autoptr(GDateTime) timestamp = g_date_time_new_from_unix_utc (t); g_autofree char *version_time = NULL; if (timestamp != NULL) timestamp_string = g_date_time_format (timestamp, "%Y-%m-%d %T"); else timestamp_string = g_strdup_printf ("(invalid timestamp)"); version_time = g_strdup_printf ("%s (%s)", pending_version, timestamp_string); rpmostree_print_kv (is_locally_assembled ? "PendingBaseVersion" : "PendingVersion", max_key_len, version_time); } } } /* This used to be OSName; see https://github.com/ostreedev/ostree/pull/794 */ if (opt_verbose) rpmostree_print_kv ("StateRoot", max_key_len, os_name); if (!g_variant_dict_lookup (dict, "gpg-enabled", "b", &gpg_enabled)) gpg_enabled = FALSE; if (gpg_enabled) rpmostree_print_gpg_info (signatures, opt_verbose, max_key_len); /* print base overrides before overlays */ g_autoptr(GPtrArray) active_removals = g_ptr_array_new_with_free_func (g_free); if (origin_base_removals) { g_autoptr(GString) str = g_string_new (""); const guint n = g_variant_n_children (origin_base_removals); for (guint i = 0; i < n; i++) { g_autoptr(GVariant) gv_nevra; g_variant_get_child (origin_base_removals, i, "v", &gv_nevra); const char *name, *nevra; g_variant_get_child (gv_nevra, 0, "&s", &nevra); g_variant_get_child (gv_nevra, 1, "&s", &name); if (str->len) g_string_append (str, ", "); g_string_append (str, nevra); g_ptr_array_add (active_removals, g_strdup (name)); } g_ptr_array_add (active_removals, NULL); if (str->len) rpmostree_print_kv ("RemovedBasePackages", max_key_len, str->str); } /* only print inactive base removal requests in verbose mode */ if (origin_requested_base_removals && opt_verbose) print_packages ("InactiveBaseRemovals", max_key_len, origin_requested_base_removals, (const char *const*)active_removals->pdata); g_autoptr(GPtrArray) active_replacements = g_ptr_array_new_with_free_func (g_free); if (origin_base_local_replacements) { g_autoptr(GString) str = g_string_new (""); g_autoptr(GHashTable) grouped_diffs = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, (GDestroyNotify)g_ptr_array_unref); const guint n = g_variant_n_children (origin_base_local_replacements); for (guint i = 0; i < n; i++) { g_autoptr(GVariant) gv_nevra_new; g_autoptr(GVariant) gv_nevra_old; g_variant_get_child (origin_base_local_replacements, i, "(vv)", &gv_nevra_new, &gv_nevra_old); const char *nevra_new, *name_new, *name_old; g_variant_get_child (gv_nevra_new, 0, "&s", &nevra_new); g_variant_get_child (gv_nevra_new, 1, "&s", &name_new); g_variant_get_child (gv_nevra_old, 1, "&s", &name_old); /* if pkgnames match, print a nicer version like treediff */ if (g_str_equal (name_new, name_old)) { /* let's just use str as a scratchpad to avoid excessive mallocs; the str * needs to be stretched anyway for the final output */ gsize original_size = str->len; gv_nevra_to_evr (str, gv_nevra_old); g_string_append (str, " -> "); gv_nevra_to_evr (str, gv_nevra_new); const char *diff = str->str + original_size; GPtrArray *pkgs = g_hash_table_lookup (grouped_diffs, diff); if (!pkgs) { pkgs = g_ptr_array_new_with_free_func (g_free); g_hash_table_insert (grouped_diffs, g_strdup (diff), pkgs); } g_ptr_array_add (pkgs, g_strdup (name_new)); g_string_truncate (str, original_size); } else { if (str->len) g_string_append (str, ", "); const char *nevra_old; g_variant_get_child (gv_nevra_old, 0, "&s", &nevra_old); g_string_append_printf (str, "%s -> %s", nevra_old, nevra_new); } g_ptr_array_add (active_replacements, g_strdup (nevra_new)); } GLNX_HASH_TABLE_FOREACH_KV (grouped_diffs, const char*, diff, GPtrArray*, pkgs) { if (str->len) g_string_append (str, ", "); for (guint i = 0, n = pkgs->len; i < n; i++) { const char *pkgname = g_ptr_array_index (pkgs, i); if (i > 0) g_string_append_c (str, ' '); g_string_append (str, pkgname); } g_string_append_c (str, ' '); g_string_append (str, diff); } g_ptr_array_add (active_replacements, NULL); if (str->len) rpmostree_print_kv ("ReplacedBasePackages", max_key_len, str->str); } if (origin_requested_base_local_replacements && opt_verbose) print_packages ("InactiveBaseReplacements", max_key_len, origin_requested_base_local_replacements, (const char *const*)active_replacements->pdata); /* only print inactive layering requests in verbose mode */ if (origin_requested_packages && opt_verbose) /* requested-packages - packages = inactive (i.e. dormant requests) */ print_packages ("InactiveRequests", max_key_len, origin_requested_packages, origin_packages); if (origin_packages) print_packages ("LayeredPackages", max_key_len, origin_packages, NULL); if (origin_requested_local_packages) print_packages ("LocalPackages", max_key_len, origin_requested_local_packages, NULL); if (regenerate_initramfs) { g_autoptr(GString) buf = g_string_new (""); g_autofree char **initramfs_args = NULL; g_variant_dict_lookup (dict, "initramfs-args", "^a&s", &initramfs_args); for (char **iter = initramfs_args; iter && *iter; iter++) { g_string_append (buf, *iter); g_string_append_c (buf, ' '); } if (buf->len == 0) g_string_append (buf, "regenerate"); rpmostree_print_kv ("Initramfs", max_key_len, buf->str); } if (unlocked && g_strcmp0 (unlocked, "none") != 0) { g_print ("%s%s", get_red_start (), get_bold_start ()); rpmostree_print_kv ("Unlocked", max_key_len, unlocked); g_print ("%s%s", get_bold_end (), get_red_end ()); } const char *end_of_life_string = NULL; /* look for endoflife attribute in the deployment */ g_variant_dict_lookup (dict, "endoflife", "&s", &end_of_life_string); if (end_of_life_string) { g_print ("%s%s", get_red_start (), get_bold_start ()); rpmostree_print_kv ("EndOfLife", max_key_len, end_of_life_string); g_print ("%s%s", get_bold_end (), get_red_end ()); } } return TRUE; } gboolean rpmostree_builtin_status (int argc, char **argv, RpmOstreeCommandInvocation *invocation, GCancellable *cancellable, GError **error) { g_autoptr(GOptionContext) context = g_option_context_new (""); glnx_unref_object RPMOSTreeOS *os_proxy = NULL; glnx_unref_object RPMOSTreeSysroot *sysroot_proxy = NULL; g_autoptr(GVariant) deployments = NULL; _cleanup_peer_ GPid peer_pid = 0; if (!rpmostree_option_context_parse (context, option_entries, &argc, &argv, invocation, cancellable, NULL, NULL, &sysroot_proxy, &peer_pid, NULL, error)) return FALSE; if (opt_json && opt_jsonpath) { g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT, "Cannot specify both --json and --jsonpath"); return FALSE; } if (!rpmostree_load_os_proxy (sysroot_proxy, NULL, cancellable, &os_proxy, error)) return FALSE; deployments = rpmostree_sysroot_dup_deployments (sysroot_proxy); if (opt_json || opt_jsonpath) { glnx_unref_object JsonBuilder *builder = json_builder_new (); json_builder_begin_object (builder); json_builder_set_member_name (builder, "deployments"); json_builder_add_value (builder, json_gvariant_serialize (deployments)); json_builder_set_member_name (builder, "transaction"); GVariant *txn = get_active_txn (sysroot_proxy); JsonNode *txn_node = txn ? json_gvariant_serialize (txn) : json_node_new (JSON_NODE_NULL); json_builder_add_value (builder, txn_node); json_builder_end_object (builder); JsonNode *json_root = json_builder_get_root (builder); glnx_unref_object JsonGenerator *generator = json_generator_new (); if (opt_json) json_generator_set_root (generator, json_root); else { JsonNode *result = json_path_query (opt_jsonpath, json_root, error); if (!result) { g_prefix_error (error, "While compiling jsonpath: "); return FALSE; } json_generator_set_root (generator, result); json_node_free (result); } json_node_free (json_root); /* NB: watch out for the misleading API docs */ glnx_unref_object GOutputStream *stdout_gio = g_unix_output_stream_new (1, FALSE); if (json_generator_to_stream (generator, stdout_gio, NULL, error) <= 0 || (error != NULL && *error != NULL)) return FALSE; } else { if (!status_generic (sysroot_proxy, os_proxy, deployments, cancellable, error)) return FALSE; } return TRUE; }