diff options
Diffstat (limited to 'src/nmcli/utils.h')
| -rw-r--r-- | src/nmcli/utils.h | 372 |
1 files changed, 372 insertions, 0 deletions
diff --git a/src/nmcli/utils.h b/src/nmcli/utils.h new file mode 100644 index 00000000..aadaab67 --- /dev/null +++ b/src/nmcli/utils.h @@ -0,0 +1,372 @@ +/* SPDX-License-Identifier: GPL-2.0-or-later */ +/* + * Copyright (C) 2010 - 2018 Red Hat, Inc. + */ + +#ifndef NMC_UTILS_H +#define NMC_UTILS_H + +#include "nmcli.h" + +/* === Types === */ + +typedef struct { + const char * name; + gboolean has_value; + const char **value; + gboolean mandatory; + gboolean found; +} nmc_arg_t; + +/* === Functions === */ +int next_arg(NmCli *nmc, int *argc, const char *const **argv, ...); +gboolean nmc_arg_is_help(const char *arg); +gboolean nmc_arg_is_option(const char *arg, const char *opt_name); +gboolean nmc_parse_args(nmc_arg_t * arg_arr, + gboolean last, + int * argc, + const char *const **argv, + GError ** error); +char * ssid_to_hex(const char *str, gsize len); +void nmc_terminal_erase_line(void); +void nmc_terminal_show_progress(const char *str); +pid_t nmc_terminal_spawn_pager(const NmcConfig *nmc_config); +char * nmc_colorize(const NmcConfig *nmc_config, NMMetaColor color, const char *fmt, ...) + _nm_printf(3, 4); +void nmc_filter_out_colors_inplace(char *str); +char *nmc_filter_out_colors(const char *str); +char *nmc_get_user_input(const char *ask_str); +int nmc_string_to_arg_array(const char *line, + const char *delim, + gboolean unquote, + char *** argv, + int * argc); +char *nmc_util_strv_for_display(const char *const *strv, gboolean brackets); +int nmc_string_screen_width(const char *start, const char *end); +void set_val_str(NmcOutputField fields_array[], guint32 index, char *value); +void set_val_strc(NmcOutputField fields_array[], guint32 index, const char *value); +void set_val_arr(NmcOutputField fields_array[], guint32 index, char **value); +void set_val_arrc(NmcOutputField fields_array[], guint32 index, const char **value); +void set_val_color_all(NmcOutputField fields_array[], NMMetaColor color); +void nmc_free_output_field_values(NmcOutputField fields_array[]); + +GArray * parse_output_fields(const char * fields_str, + const NMMetaAbstractInfo *const *fields_array, + gboolean parse_groups, + GPtrArray ** group_fields, + GError ** error); +NmcOutputField *nmc_dup_fields_array(const NMMetaAbstractInfo *const *fields, NmcOfFlags flags); +void nmc_empty_output_fields(NmcOutputData *output_data); +void print_required_fields(const NmcConfig * nmc_config, + NmcPagerData * pager_data, + NmcOfFlags of_flags, + const GArray * indices, + const char * header_name, + int indent, + const NmcOutputField *field_values); +void print_data_prepare_width(GPtrArray *output_data); +void print_data(const NmcConfig * nmc_config, + NmcPagerData * pager_data, + const GArray * indices, + const char * header_name, + int indent, + const NmcOutputData *out); + +/*****************************************************************************/ + +extern const NMMetaEnvironment *const nmc_meta_environment; +extern const NmCli *const nmc_meta_environment_arg; + +typedef enum { + + NMC_GENERIC_INFO_TYPE_GENERAL_STATUS_RUNNING = 0, + NMC_GENERIC_INFO_TYPE_GENERAL_STATUS_VERSION, + NMC_GENERIC_INFO_TYPE_GENERAL_STATUS_STATE, + NMC_GENERIC_INFO_TYPE_GENERAL_STATUS_STARTUP, + NMC_GENERIC_INFO_TYPE_GENERAL_STATUS_CONNECTIVITY, + NMC_GENERIC_INFO_TYPE_GENERAL_STATUS_NETWORKING, + NMC_GENERIC_INFO_TYPE_GENERAL_STATUS_WIFI_HW, + NMC_GENERIC_INFO_TYPE_GENERAL_STATUS_WIFI, + NMC_GENERIC_INFO_TYPE_GENERAL_STATUS_WWAN_HW, + NMC_GENERIC_INFO_TYPE_GENERAL_STATUS_WWAN, + NMC_GENERIC_INFO_TYPE_GENERAL_STATUS_WIMAX_HW, + NMC_GENERIC_INFO_TYPE_GENERAL_STATUS_WIMAX, + _NMC_GENERIC_INFO_TYPE_GENERAL_STATUS_NUM, + + NMC_GENERIC_INFO_TYPE_GENERAL_PERMISSIONS_PERMISSION = 0, + NMC_GENERIC_INFO_TYPE_GENERAL_PERMISSIONS_VALUE, + _NMC_GENERIC_INFO_TYPE_GENERAL_PERMISSIONS_NUM, + + NMC_GENERIC_INFO_TYPE_GENERAL_LOGGING_LEVEL = 0, + NMC_GENERIC_INFO_TYPE_GENERAL_LOGGING_DOMAINS, + _NMC_GENERIC_INFO_TYPE_GENERAL_LOGGING_NUM, + + NMC_GENERIC_INFO_TYPE_IP4_CONFIG_ADDRESS = 0, + NMC_GENERIC_INFO_TYPE_IP4_CONFIG_GATEWAY, + NMC_GENERIC_INFO_TYPE_IP4_CONFIG_ROUTE, + NMC_GENERIC_INFO_TYPE_IP4_CONFIG_DNS, + NMC_GENERIC_INFO_TYPE_IP4_CONFIG_DOMAIN, + NMC_GENERIC_INFO_TYPE_IP4_CONFIG_SEARCHES, + NMC_GENERIC_INFO_TYPE_IP4_CONFIG_WINS, + _NMC_GENERIC_INFO_TYPE_IP4_CONFIG_NUM, + + NMC_GENERIC_INFO_TYPE_IP6_CONFIG_ADDRESS = 0, + NMC_GENERIC_INFO_TYPE_IP6_CONFIG_GATEWAY, + NMC_GENERIC_INFO_TYPE_IP6_CONFIG_ROUTE, + NMC_GENERIC_INFO_TYPE_IP6_CONFIG_DNS, + NMC_GENERIC_INFO_TYPE_IP6_CONFIG_DOMAIN, + NMC_GENERIC_INFO_TYPE_IP6_CONFIG_SEARCHES, + _NMC_GENERIC_INFO_TYPE_IP6_CONFIG_NUM, + + NMC_GENERIC_INFO_TYPE_DHCP_CONFIG_OPTION = 0, + _NMC_GENERIC_INFO_TYPE_DHCP_CONFIG_NUM, + + NMC_GENERIC_INFO_TYPE_CON_SHOW_NAME = 0, + NMC_GENERIC_INFO_TYPE_CON_SHOW_UUID, + NMC_GENERIC_INFO_TYPE_CON_SHOW_TYPE, + NMC_GENERIC_INFO_TYPE_CON_SHOW_TIMESTAMP, + NMC_GENERIC_INFO_TYPE_CON_SHOW_TIMESTAMP_REAL, + NMC_GENERIC_INFO_TYPE_CON_SHOW_AUTOCONNECT, + NMC_GENERIC_INFO_TYPE_CON_SHOW_AUTOCONNECT_PRIORITY, + NMC_GENERIC_INFO_TYPE_CON_SHOW_READONLY, + NMC_GENERIC_INFO_TYPE_CON_SHOW_DBUS_PATH, + NMC_GENERIC_INFO_TYPE_CON_SHOW_ACTIVE, + NMC_GENERIC_INFO_TYPE_CON_SHOW_DEVICE, + NMC_GENERIC_INFO_TYPE_CON_SHOW_STATE, + NMC_GENERIC_INFO_TYPE_CON_SHOW_ACTIVE_PATH, + NMC_GENERIC_INFO_TYPE_CON_SHOW_SLAVE, + NMC_GENERIC_INFO_TYPE_CON_SHOW_FILENAME, + _NMC_GENERIC_INFO_TYPE_CON_SHOW_NUM, + + NMC_GENERIC_INFO_TYPE_CON_ACTIVE_GENERAL_NAME = 0, + NMC_GENERIC_INFO_TYPE_CON_ACTIVE_GENERAL_UUID, + NMC_GENERIC_INFO_TYPE_CON_ACTIVE_GENERAL_DEVICES, + NMC_GENERIC_INFO_TYPE_CON_ACTIVE_GENERAL_IP_IFACE, + NMC_GENERIC_INFO_TYPE_CON_ACTIVE_GENERAL_STATE, + NMC_GENERIC_INFO_TYPE_CON_ACTIVE_GENERAL_DEFAULT, + NMC_GENERIC_INFO_TYPE_CON_ACTIVE_GENERAL_DEFAULT6, + NMC_GENERIC_INFO_TYPE_CON_ACTIVE_GENERAL_SPEC_OBJECT, + NMC_GENERIC_INFO_TYPE_CON_ACTIVE_GENERAL_VPN, + NMC_GENERIC_INFO_TYPE_CON_ACTIVE_GENERAL_DBUS_PATH, + NMC_GENERIC_INFO_TYPE_CON_ACTIVE_GENERAL_CON_PATH, + NMC_GENERIC_INFO_TYPE_CON_ACTIVE_GENERAL_ZONE, + NMC_GENERIC_INFO_TYPE_CON_ACTIVE_GENERAL_MASTER_PATH, + _NMC_GENERIC_INFO_TYPE_CON_ACTIVE_GENERAL_NUM, + + NMC_GENERIC_INFO_TYPE_CON_VPN_TYPE = 0, + NMC_GENERIC_INFO_TYPE_CON_VPN_USERNAME, + NMC_GENERIC_INFO_TYPE_CON_VPN_GATEWAY, + NMC_GENERIC_INFO_TYPE_CON_VPN_BANNER, + NMC_GENERIC_INFO_TYPE_CON_VPN_VPN_STATE, + NMC_GENERIC_INFO_TYPE_CON_VPN_CFG, + _NMC_GENERIC_INFO_TYPE_CON_ACTIVE_VPN_NUM, + + NMC_GENERIC_INFO_TYPE_DEVICE_STATUS_DEVICE = 0, + NMC_GENERIC_INFO_TYPE_DEVICE_STATUS_TYPE, + NMC_GENERIC_INFO_TYPE_DEVICE_STATUS_STATE, + NMC_GENERIC_INFO_TYPE_DEVICE_STATUS_IP4_CONNECTIVITY, + NMC_GENERIC_INFO_TYPE_DEVICE_STATUS_IP6_CONNECTIVITY, + NMC_GENERIC_INFO_TYPE_DEVICE_STATUS_DBUS_PATH, + NMC_GENERIC_INFO_TYPE_DEVICE_STATUS_CONNECTION, + NMC_GENERIC_INFO_TYPE_DEVICE_STATUS_CON_UUID, + NMC_GENERIC_INFO_TYPE_DEVICE_STATUS_CON_PATH, + _NMC_GENERIC_INFO_TYPE_DEVICE_STATUS_NUM, + + NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_DEVICE = 0, + NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_TYPE, + NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_NM_TYPE, + NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_DBUS_PATH, + NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_VENDOR, + NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_PRODUCT, + NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_DRIVER, + NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_DRIVER_VERSION, + NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_FIRMWARE_VERSION, + NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_HWADDR, + NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_MTU, + NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_STATE, + NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_REASON, + NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_IP4_CONNECTIVITY, + NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_IP6_CONNECTIVITY, + NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_UDI, + NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_PATH, + NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_IP_IFACE, + NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_IS_SOFTWARE, + NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_NM_MANAGED, + NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_AUTOCONNECT, + NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_FIRMWARE_MISSING, + NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_NM_PLUGIN_MISSING, + NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_PHYS_PORT_ID, + NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_CONNECTION, + NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_CON_UUID, + NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_CON_PATH, + NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_METERED, + _NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_NUM, + + NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_CONNECTIONS_AVAILABLE_CONNECTION_PATHS = 0, + NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_CONNECTIONS_AVAILABLE_CONNECTIONS, + _NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_CONNECTIONS_NUM, + + NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_CAPABILITIES_CARRIER_DETECT = 0, + NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_CAPABILITIES_SPEED, + NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_CAPABILITIES_IS_SOFTWARE, + NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_CAPABILITIES_SRIOV, + _NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_CAPABILITIES_NUM, + + NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_WIRED_PROPERTIES_CARRIER = 0, + NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_WIRED_PROPERTIES_S390_SUBCHANNELS, + _NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_WIRED_PROPERTIES_NUM, + + NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_WIFI_PROPERTIES_WEP = 0, + NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_WIFI_PROPERTIES_WPA, + NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_WIFI_PROPERTIES_WPA2, + NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_WIFI_PROPERTIES_TKIP, + NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_WIFI_PROPERTIES_CCMP, + NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_WIFI_PROPERTIES_AP, + NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_WIFI_PROPERTIES_ADHOC, + NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_WIFI_PROPERTIES_2GHZ, + NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_WIFI_PROPERTIES_5GHZ, + NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_WIFI_PROPERTIES_MESH, + NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_WIFI_PROPERTIES_IBSS_RSN, + _NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_WIFI_PROPERTIES_NUM, + + NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_INTERFACE_FLAGS_UP = 0, + NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_INTERFACE_FLAGS_LOWER_UP, + NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_INTERFACE_FLAGS_CARRIER, + NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_INTERFACE_FLAGS_PROMISC, + _NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_INTERFACE_FLAGS_NUM, + +} NmcGenericInfoType; + +#define NMC_HANDLE_COLOR(color) \ + G_STMT_START \ + { \ + if (get_type == NM_META_ACCESSOR_GET_TYPE_COLOR) \ + return GINT_TO_POINTER(color); \ + } \ + G_STMT_END + +struct _NmcMetaGenericInfo { + union { + NMObjBaseInst parent; + const NMMetaType *meta_type; + }; + NmcGenericInfoType info_type; + const char * name; + const char * name_header; + const NmcMetaGenericInfo *const *nested; + +#define NMC_META_GENERIC_INFO_GET_FCN_ARGS \ + const NMMetaEnvironment *environment, gpointer environment_user_data, \ + const NmcMetaGenericInfo *info, gpointer target, gpointer target_data, \ + NMMetaAccessorGetType get_type, NMMetaAccessorGetFlags get_flags, \ + NMMetaAccessorGetOutFlags *out_flags, gboolean *out_is_default, gpointer *out_to_free + + gconstpointer (*get_fcn)(NMC_META_GENERIC_INFO_GET_FCN_ARGS); +}; + +#define NMC_META_GENERIC(n, ...) \ + (&((NmcMetaGenericInfo){.meta_type = &nmc_meta_type_generic_info, .name = n, __VA_ARGS__})) + +#define NMC_META_GENERIC_WITH_NESTED(n, nest, ...) \ + NMC_META_GENERIC(n, .nested = (nest), __VA_ARGS__) + +#define NMC_META_GENERIC_GROUP(_group_name, _nested, _name_header) \ + ((const NMMetaAbstractInfo *const *) ((const NmcMetaGenericInfo *const[]){ \ + NMC_META_GENERIC_WITH_NESTED(_group_name, _nested, .name_header = _name_header), \ + NULL, \ + })) + +static inline const char * +nmc_meta_generic_get_str_i18n(const char *s, NMMetaAccessorGetType get_type) +{ + if (!NM_IN_SET(get_type, NM_META_ACCESSOR_GET_TYPE_PRETTY, NM_META_ACCESSOR_GET_TYPE_PARSABLE)) + g_return_val_if_reached(NULL); + + if (!s) + return NULL; + if (get_type == NM_META_ACCESSOR_GET_TYPE_PRETTY) + return gettext(s); + return s; +} + +static inline const char * +nmc_meta_generic_get_str_i18n_null(const char *s, NMMetaAccessorGetType get_type) +{ + if (get_type == NM_META_ACCESSOR_GET_TYPE_PARSABLE) { + /* in parsable mode, return NULL. That is useful if @s is a pretty string + * to describe a missing value (like "(unknown)"). We don't want to print + * that for parsable mode. */ + return NULL; + } + return nmc_meta_generic_get_str_i18n(s, get_type); +} + +static inline const char * +nmc_meta_generic_get_unknown(NMMetaAccessorGetType get_type) +{ + return nmc_meta_generic_get_str_i18n_null(N_("(unknown)"), get_type); +} + +static inline const char * +nmc_meta_generic_get_bool(gboolean val, NMMetaAccessorGetType get_type) +{ + return nmc_meta_generic_get_str_i18n(val ? N_("yes") : N_("no"), get_type); +} + +static inline const char * +nmc_meta_generic_get_bool_onoff(gboolean val, NMMetaAccessorGetType get_type) +{ + return nmc_meta_generic_get_str_i18n(val ? N_("on") : N_("off"), get_type); +} + +typedef enum { + NMC_META_GENERIC_GET_ENUM_TYPE_PARENTHESES, + NMC_META_GENERIC_GET_ENUM_TYPE_DASH, +} NmcMetaGenericGetEnumType; + +static inline char * +nmc_meta_generic_get_enum_with_detail(NmcMetaGenericGetEnumType get_enum_type, + gint64 enum_val, + const char * str_val, + NMMetaAccessorGetType get_type) +{ + if (!NM_IN_SET(get_type, NM_META_ACCESSOR_GET_TYPE_PRETTY, NM_META_ACCESSOR_GET_TYPE_PARSABLE)) + g_return_val_if_reached(NULL); + + if (!str_val) { + /* Pass %NULL for only printing the numeric value. */ + return g_strdup_printf("%lld", (long long) enum_val); + } + + switch (get_enum_type) { + case NMC_META_GENERIC_GET_ENUM_TYPE_PARENTHESES: + /* note that this function will always print "$NUM ($NICK)", also in PARSABLE + * mode. That might not be desired, but it's done for certain properties to preserve + * previous behavior. */ + if (get_type == NM_META_ACCESSOR_GET_TYPE_PRETTY) + return g_strdup_printf(_("%lld (%s)"), (long long) enum_val, gettext(str_val)); + return g_strdup_printf("%lld (%s)", (long long) enum_val, str_val); + case NMC_META_GENERIC_GET_ENUM_TYPE_DASH: + /* note that this function will always print "$NUM ($NICK)", also in PARSABLE + * mode. That might not be desired, but it's done for certain properties to preserve + * previous behavior. */ + if (get_type == NM_META_ACCESSOR_GET_TYPE_PRETTY) + return g_strdup_printf(_("%lld - %s"), (long long) enum_val, gettext(str_val)); + return g_strdup_printf("%lld - %s", (long long) enum_val, str_val); + } + g_return_val_if_reached(NULL); +} + +/*****************************************************************************/ + +gboolean nmc_print(const NmcConfig * nmc_config, + gpointer const * targets, + gpointer targets_data, + const char * header_name_no_l10n, + const NMMetaAbstractInfo *const *fields, + const char * fields_str, + GError ** error); + +/*****************************************************************************/ + +#endif /* NMC_UTILS_H */ |