fdo-mirrors/NetworkManager
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/NetworkManager/NetworkManager.git synced 2025-12-25 18:50:07 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
NetworkManager/src/nmcli/nmcli.h

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

270 lines
7.7 KiB
C
Raw Normal View History

all: update deprecated SPDX license identifiers These SPDX license identifiers are deprecated ([1]). Update them. [1] https://spdx.org/licenses/ sed \ -e '1 s%^/\* SPDX-License-Identifier: \(GPL-2.0\|LGPL-2.1\)+ \*/$%/* SPDX-License-Identifier: \1-or-later */%' \ -e '1,2 s%^\(--\|#\|//\) SPDX-License-Identifier: \(GPL-2.0\|LGPL-2.1\)+$%\1 SPDX-License-Identifier: \2-or-later%' \ -i \ $(git grep -l SPDX-License-Identifier -- \ ':(exclude)shared/c-*/' \ ':(exclude)shared/n-*/' \ ':(exclude)shared/systemd/src' \ ':(exclude)src/systemd/src')
2020-12-23 22:21:36 +01:00
/* SPDX-License-Identifier: GPL-2.0-or-later */
all: manually drop code comments with file description
2019-09-25 13:13:40 +02:00
/*
nmcli: add --offline option for "add" and "modify" This adds a global "--offline" option and allows its use with "add" and "modify" commands. The "add" looks like this: $ nmcli --offline conn add type ethernet ens3 ipv4.dns 192.168.1.1 \ >output.nmconnection The "modify" is essentially implementing what's been suggested by Beniamino in bugzilla ticked (referred to below): $ nmcli --offline connection modify ens3 ipv4.dns 192.168.1.1 \ <input.nmconnection >output.nmconnection Other commands don't support the argument at the moment: $ nmcli --offline c up ens3 Error: 'up' command doesn't support --offline mode. https://bugzilla.redhat.com/show_bug.cgi?id=1361145
2022-04-05 19:47:32 +02:00
* Copyright (C) 2010 - 2022 Red Hat, Inc.
cli: add initial pieces of nmcli
2010-02-25 09:52:30 -08:00
*/
#ifndef NMC_NMCLI_H
#define NMC_NMCLI_H
build: move "clients/common/" to "src/libnmc-{base,setting}/"
2021-03-01 12:42:48 +01:00
#include "libnmc-base/nm-secret-agent-simple.h"
#include "libnmc-setting/nm-meta-setting-desc.h"
cli: rework callbacks in NMPolkitListener to use one vtable structure Instead of setting multiple callbacks, just let the user set one vtable with callbacks. Usually, GObject would implement this via signals. While that makes sense for public objects, for example to work better with GIR and allow intercepting the signal, this is overkill for our internal type. And NMPolkitListener already did not make use of signals, for good reason. Instead of passing multiple callbacks, must pass one structure with callback pointers. Also, extend the signature of the callbacks to always contain a @self argument and a @user_data.
2018-04-06 23:54:33 +02:00
struct _NMPolkitListener;
cli: add a polkit agent support for nmcli Example: nmcli --ask general hostname computer007
2014-10-30 11:25:55 +01:00
cli: move completion for connection type to meta data
2017-04-11 15:48:04 +02:00
typedef char *(*NmcCompEntryFunc)(const char *, int);
cli: add initial pieces of nmcli
2010-02-25 09:52:30 -08:00
/* nmcli exit codes */
typedef enum {
/* Indicates successful execution */
NMC_RESULT_SUCCESS = 0,
/* Unknown / unspecified error */
cli: add NMC_RESULT_ERROR_USER_INPUT code for bad invocation of nmcli
2010-03-24 13:42:47 +01:00
NMC_RESULT_ERROR_UNKNOWN = 1,
/* Wrong invocation of nmcli */
NMC_RESULT_ERROR_USER_INPUT = 2,
cli: add initial pieces of nmcli
2010-02-25 09:52:30 -08:00
/* A timeout expired */
cli: add NMC_RESULT_ERROR_USER_INPUT code for bad invocation of nmcli
2010-03-24 13:42:47 +01:00
NMC_RESULT_ERROR_TIMEOUT_EXPIRED = 3,
cli: add initial pieces of nmcli
2010-02-25 09:52:30 -08:00
/* Error in connection activation */
cli: add NMC_RESULT_ERROR_USER_INPUT code for bad invocation of nmcli
2010-03-24 13:42:47 +01:00
NMC_RESULT_ERROR_CON_ACTIVATION = 4,
cli: add initial pieces of nmcli
2010-02-25 09:52:30 -08:00
/* Error in connection deactivation */
cli: add NMC_RESULT_ERROR_USER_INPUT code for bad invocation of nmcli
2010-03-24 13:42:47 +01:00
NMC_RESULT_ERROR_CON_DEACTIVATION = 5,
cli: add initial pieces of nmcli
2010-02-25 09:52:30 -08:00
/* Error in device disconnect */
cli: improve/add NM running checks Check whether NetworkManager is running and return new error NMC_RESULT_ERROR_NM_NOT_RUNNING when appropriate.
2011-02-10 14:21:18 +01:00
NMC_RESULT_ERROR_DEV_DISCONNECT = 6,
cli: fix 'nmcli con delete' (rh #771258) The command didn't delete the connection, because nmcli exited before NM could check permissions (actually ConsoleKit didn't see the process). Now nmcli waits for "Removed" signal or D-Bus return (error) message on "Delete" method call.
2012-01-10 16:18:27 +01:00
/* Error in connection deletion */
NMC_RESULT_ERROR_CON_DEL = 7,
cli: improve/add NM running checks Check whether NetworkManager is running and return new error NMC_RESULT_ERROR_NM_NOT_RUNNING when appropriate.
2011-02-10 14:21:18 +01:00
/* NetworkManager is not running */
cli: fix 'nmcli con delete' (rh #771258) The command didn't delete the connection, because nmcli exited before NM could check permissions (actually ConsoleKit didn't see the process). Now nmcli waits for "Removed" signal or D-Bus return (error) message on "Delete" method call.
2012-01-10 16:18:27 +01:00
NMC_RESULT_ERROR_NM_NOT_RUNNING = 8,
cli: compare nmcli and NM versions nmcli gets NM version and compares it with its own and complains when they differ. This is to indicate that the results are not reliable, because the API could differ. '--nocheck' switches the checks off.
2011-02-16 17:36:50 +01:00
cli: remove version check against NM When performing NM package upgrade the new version of nmcli will be immediately available while NM daemon will not, as it would not restart in order to avoid to disrupt connectivity. This could create issues with tools leveraging on nmcli output (till reboot). As apart from this case it is very unlikely that a user can have this nmcli / NM daemon version mismatch situation, the check could cause more harm than benefit in real user case scenarios. https://bugzilla.redhat.com/show_bug.cgi?id=1291785
2016-04-18 18:50:56 +02:00
/* No more used, keep to preserve API */
cli: add NMC_RESULT_ERROR_NOT_FOUND and use as appropriate This will allow callers to distinguish "no such connection" from "connection failed to activate", etc. https://bugzilla.redhat.com/show_bug.cgi?id=1022256
2013-11-21 09:19:18 -05:00
NMC_RESULT_ERROR_VERSIONS_MISMATCH = 9,
/* Connection/Device/AP not found */
cli: add ability to indicate command completion expects a file name
2016-07-12 15:43:56 +02:00
NMC_RESULT_ERROR_NOT_FOUND = 10,
/* --complete-args signals a file name may follow */
NMC_RESULT_COMPLETE_FILE = 65,
cli: add initial pieces of nmcli
2010-02-25 09:52:30 -08:00
} NMCResultCode;
cli: reformat file to look better Comments on the same line as field names are not rendered well by clang-format. Even if manually edited, it seems not a preferable way to comment on a field. Move the comment in the line before.
2022-06-16 11:00:12 +02:00
typedef enum {
NMC_PRINT_TERSE = 0,
NMC_PRINT_NORMAL = 1,
NMC_PRINT_PRETTY = 2,
} NMCPrintOutput;
cli: add initial pieces of nmcli
2010-02-25 09:52:30 -08:00
cli: rework printing of `nmcli connection` for multiple active connections The output of `nmcli connection show` contains also information about whether the profile is currently active, for example the device and the current (activation) state. Even when a profile can be activated only once (without supporting mutiple activations at the same time), there are moments when a connection is activating and still deactivating on another device. NetworkManager ensures in the case with single activations that a profile cannot be in state "activated" multiple times. But that doesn't mean, that one profile cannot have multiple active connection which reference it. That was already handled wrongly before, because `nmcli connection show` would only search the first matching active-connection. That is, it would arbitrarily pick an active connection in case there were multiple and only show activation state about one. Furthermore, we will soon also add the possibility, that a profile can be active multiple times (at the same time). Especially then, we need to extend the output format to show all the devices on which the profile is currently active. Rework printing the connection list to use nmc_print(), and fix various issues. - as discussed, a profile may have multiple active connections at each time. There are only two possibilities: if a profile is active multiple times, show a line for each activation, or otherwise, show the information about multiple activations combined in one line, e.g. by printing "DEVICE eth0,eth1". This patch, does the former. We will now print a line for each active connection, to show all the devices and activation states in multiple lines. Yes, this may result in the same profile being printed multiple times. That is a change in behavior, and inconvenient if you do something like for UUID in $(nmcli connection show | awk '{print$2}'); do ... However, above is anyway wrong because it assumes that there are no spaces in the connection name. The proper way to do this is like for UUID in $(nmcli -g UUID connection show); do ... In the latter case, whenever a user selects a subset of fields (--fields, --get) which don't print information about active connections, these multiple lines are combined. So, above still works as expected, never returning duplicate UUIDs. - if a user has no permissions to see a connection, we previously would print "<invisible> $NAME". No longer do this but just print the ID was it is reported by the active-connection. If the goal of this was to prevent users from accidentally access the non-existing connection by $NAME, then this was a bad solution, because a script would instead try to access "<invisible> $NAME". This is now solved better by hiding the active connection if the user selects "-g NAME". - the --order option now sorts according to how the fields are shown. For example, with --terse mode, it will evaluate type "802-11-wireless" but with pretty mode it will consider "wifi". This may change the ordering in which connections are shown. Also, for sorting the name, we use g_utf8_collate() because it's unicode.
2018-04-25 10:00:40 +02:00
static inline NMMetaAccessorGetType
nmc_print_output_to_accessor_get_type(NMCPrintOutput print_output)
{
cli: minor cleanup explicitly checking print_output The print-output knows three modes: NORMAL, PRETTY, TERSE. Never compare whether a mode is != a particular mode. Instead, always explicitly check for the modes for which we enable a particular behavior. The effect is, that we always do something when the mode is set to a particular value. We don't ever do something, if the mode is not set to a particular value. Consistently opt-in is easier to understand.
2018-05-02 10:47:20 +02:00
return NM_IN_SET(print_output, NMC_PRINT_NORMAL, NMC_PRINT_PRETTY)
cli: rework printing of `nmcli connection` for multiple active connections The output of `nmcli connection show` contains also information about whether the profile is currently active, for example the device and the current (activation) state. Even when a profile can be activated only once (without supporting mutiple activations at the same time), there are moments when a connection is activating and still deactivating on another device. NetworkManager ensures in the case with single activations that a profile cannot be in state "activated" multiple times. But that doesn't mean, that one profile cannot have multiple active connection which reference it. That was already handled wrongly before, because `nmcli connection show` would only search the first matching active-connection. That is, it would arbitrarily pick an active connection in case there were multiple and only show activation state about one. Furthermore, we will soon also add the possibility, that a profile can be active multiple times (at the same time). Especially then, we need to extend the output format to show all the devices on which the profile is currently active. Rework printing the connection list to use nmc_print(), and fix various issues. - as discussed, a profile may have multiple active connections at each time. There are only two possibilities: if a profile is active multiple times, show a line for each activation, or otherwise, show the information about multiple activations combined in one line, e.g. by printing "DEVICE eth0,eth1". This patch, does the former. We will now print a line for each active connection, to show all the devices and activation states in multiple lines. Yes, this may result in the same profile being printed multiple times. That is a change in behavior, and inconvenient if you do something like for UUID in $(nmcli connection show | awk '{print$2}'); do ... However, above is anyway wrong because it assumes that there are no spaces in the connection name. The proper way to do this is like for UUID in $(nmcli -g UUID connection show); do ... In the latter case, whenever a user selects a subset of fields (--fields, --get) which don't print information about active connections, these multiple lines are combined. So, above still works as expected, never returning duplicate UUIDs. - if a user has no permissions to see a connection, we previously would print "<invisible> $NAME". No longer do this but just print the ID was it is reported by the active-connection. If the goal of this was to prevent users from accidentally access the non-existing connection by $NAME, then this was a bad solution, because a script would instead try to access "<invisible> $NAME". This is now solved better by hiding the active connection if the user selects "-g NAME". - the --order option now sorts according to how the fields are shown. For example, with --terse mode, it will evaluate type "802-11-wireless" but with pretty mode it will consider "wifi". This may change the ordering in which connections are shown. Also, for sorting the name, we use g_utf8_collate() because it's unicode.
2018-04-25 10:00:40 +02:00
? NM_META_ACCESSOR_GET_TYPE_PRETTY
: NM_META_ACCESSOR_GET_TYPE_PARSABLE;
}
cli: changing nmcli output to better fit both computer and human needs The output is basically tabular with fields (columns) presenting specific pieces of info. Each line represents a single object. It's possible to switch to multiline output using '--multiline' option. In that mode single object is presented on more lines - each field on its line. Terse mode now uses ':' as field separator. It also escapes all occurences of ':' and '\' inside field values to ease parsing. The escaping behaviour can be controlled through '--escape' option. By default, escaping is switched on in tabular mode. When using terse mode ('--terse'), '--fields' option is mandatory for specifying required fields. That helps for flexibility and backwards compatibility. Not all output is converted yet.
2010-03-18 15:39:15 +01:00
/* === Output fields === */
cli: use enum NmcOfFlags instead of plain integer flags and pass to print_required_fields()
2017-03-31 12:12:21 +02:00
typedef enum {
cli: reformat file to look better Comments on the same line as field names are not rendered well by clang-format. Even if manually edited, it seems not a preferable way to comment on a field. Move the comment in the line before.
2022-06-16 11:00:12 +02:00
/* Print field names instead of values */
NMC_OF_FLAG_FIELD_NAMES = 0x00000001,
/* Use the first value as section prefix for the other field names - just in multiline */
NMC_OF_FLAG_SECTION_PREFIX = 0x00000002,
/* Print main header in addition to values/field names */
NMC_OF_FLAG_MAIN_HEADER_ADD = 0x00000004,
/* Print main header only */
NMC_OF_FLAG_MAIN_HEADER_ONLY = 0x00000008,
cli: use enum NmcOfFlags instead of plain integer flags and pass to print_required_fields()
2017-03-31 12:12:21 +02:00
} NmcOfFlags;
cli: allow field values to be null-terminated string arrays Field values can now be string arrays. print_fields() recognizes the format and prints values accordingly. Setter functions was added to facilitate setting string vs. array: set_val_str(), set_val_arr()
2012-01-03 15:07:17 +01:00
cli: introduce NmcColorPalette struct instead of plain array We do have types in C. Use them.
2020-10-08 12:33:16 +02:00
typedef struct {
const char *ansi_seq[_NM_META_COLOR_NUM];
} NmcColorPalette;
cli: fix redundant "const const" declaration in nmcli.h Fixes: bfb9fd0d2f3d602a69537fe7776426ee9202ce9e
2017-05-12 14:04:04 +02:00
extern const NMMetaType nmc_meta_type_generic_info;
cli: split tracking of meta data out of NmcOutputField When generating output data, nmcli iterates over a list of property-descriptors (nmc_fields_ip4_config), creates an intermediate array (output_data) and finally prints it. However, previously both the meta data (nmc_fields_ip4_config) and the intermediate format use the same type NmcOutputField. This means, certain fields are relevant to describe a property, and other fields are output/formatting fields. Split this up. Now, the meta data is tracked in form of an NMMetaAbstractInfo lists. This separates the information about properties from intermediate steps during creation of the output. Note that currently functions like print_ip4_config() still have all the knowledge about how to generate the output. That is wrong, instead, the meta data (NMMetaAbstractInfo) should describe how to create the output and then all those functions could be replaced. This means, later we want to add more knowledge to the NMMetaAbstractInfo, so it is important to keep them separate from NmcOutputField.
2017-03-31 19:18:16 +02:00
typedef struct _NmcOutputField NmcOutputField;
typedef struct _NmcMetaGenericInfo NmcMetaGenericInfo;
struct _NmcOutputField {
const NMMetaAbstractInfo *info;
nmcli.h: tidy up boolean struct members Use bitfields to save a few bytes. This involves swapping gboolean for bool and some reordering in order to get them grouped together. The patch looks horrible, because clang-format decides to put itself and seem to go out of its way to make this whole file look idiotic. What can you do.
2022-04-06 12:16:21 +02:00
cli: reformat file to look better Comments on the same line as field names are not rendered well by clang-format. Even if manually edited, it seems not a preferable way to comment on a field. Move the comment in the line before.
2022-06-16 11:00:12 +02:00
/* Width in screen columns */
int width;
/* Value of current field - char* or char** (NULL-terminated array) */
void *value;
/* Whether value is char** instead of char* */
bool value_is_array : 1;
/* Whether to free the value */
bool free_value : 1;
nmcli.h: tidy up boolean struct members Use bitfields to save a few bytes. This involves swapping gboolean for bool and some reordering in order to get them grouped together. The patch looks horrible, because clang-format decides to put itself and seem to go out of its way to make this whole file look idiotic. What can you do.
2022-04-06 12:16:21 +02:00
NmcOfFlags flags; /* Flags - whether and how to print values/field names/headers */
NMMetaColor color; /* Use this color to print value */
cli: split tracking of meta data out of NmcOutputField When generating output data, nmcli iterates over a list of property-descriptors (nmc_fields_ip4_config), creates an intermediate array (output_data) and finally prints it. However, previously both the meta data (nmc_fields_ip4_config) and the intermediate format use the same type NmcOutputField. This means, certain fields are relevant to describe a property, and other fields are output/formatting fields. Split this up. Now, the meta data is tracked in form of an NMMetaAbstractInfo lists. This separates the information about properties from intermediate steps during creation of the output. Note that currently functions like print_ip4_config() still have all the knowledge about how to generate the output. That is wrong, instead, the meta data (NMMetaAbstractInfo) should describe how to create the output and then all those functions could be replaced. This means, later we want to add more knowledge to the NMMetaAbstractInfo, so it is important to keep them separate from NmcOutputField.
2017-03-31 19:18:16 +02:00
};
cli: changing nmcli output to better fit both computer and human needs The output is basically tabular with fields (columns) presenting specific pieces of info. Each line represents a single object. It's possible to switch to multiline output using '--multiline' option. In that mode single object is presented on more lines - each field on its line. Terse mode now uses ':' as field separator. It also escapes all occurences of ':' and '\' inside field values to ease parsing. The escaping behaviour can be controlled through '--escape' option. By default, escaping is switched on in tabular mode. When using terse mode ('--terse'), '--fields' option is mandatory for specifying required fields. That helps for flexibility and backwards compatibility. Not all output is converted yet.
2010-03-18 15:39:15 +01:00
cli: pass use_colors as separate option instead of global nmc nmc contains all options and collects output data. It is very hard to understand what it does. Start splitting it up, and pass arguments along -- as needed.
2017-03-30 12:23:26 +02:00
typedef struct _NmcConfig {
cli: reformat file to look better Comments on the same line as field names are not rendered well by clang-format. Even if manually edited, it seems not a preferable way to comment on a field. Move the comment in the line before.
2022-06-16 11:00:12 +02:00
/* Output mode */
NMCPrintOutput print_output;
/* Whether to use colors for output: option '--color' */
bool use_colors;
/* Multiline output instead of default tabular */
bool multiline_output : 1;
/* Whether to escape ':' and '\' in terse tabular mode */
bool escape_values : 1;
/* Whether running the editor - nmcli con edit' */
bool in_editor : 1;
/* Whether to display secrets (both input and output): option '--show-secrets' */
bool show_secrets : 1;
/* Overview mode (hide default values) */
bool overview : 1;
cli: introduce NmcColorPalette struct instead of plain array We do have types in C. Use them.
2020-10-08 12:33:16 +02:00
NmcColorPalette palette;
cli: pass use_colors as separate option instead of global nmc nmc contains all options and collects output data. It is very hard to understand what it does. Start splitting it up, and pass arguments along -- as needed.
2017-03-30 12:23:26 +02:00
} NmcConfig;
cli: avoid passing full NmCli global variable to nm_cli_spawn_pager() We should not use global variables, and we should minimize the state that we pass around. Instead of requiring the full NmCli struct in nm_cli_spawn_pager(), pass only the necessary data. This reduces our use of global variables.
2020-04-02 13:59:53 +02:00
typedef struct {
pid_t pid;
} NmcPagerData;
cli: split output data from NmCli to a separate field
2017-03-30 13:34:35 +02:00
typedef struct _NmcOutputData {
cli: reformat file to look better Comments on the same line as field names are not rendered well by clang-format. Even if manually edited, it seems not a preferable way to comment on a field. Move the comment in the line before.
2022-06-16 11:00:12 +02:00
/* GPtrArray of arrays of NmcOutputField structs - accumulates data for output */
GPtrArray *output_data;
cli: split output data from NmCli to a separate field
2017-03-30 13:34:35 +02:00
} NmcOutputData;
cli: add initial pieces of nmcli
2010-02-25 09:52:30 -08:00
/* NmCli - main structure */
typedef struct _NmCli {
cli: reformat file to look better Comments on the same line as field names are not rendered well by clang-format. Even if manually edited, it seems not a preferable way to comment on a field. Move the comment in the line before.
2022-06-16 11:00:12 +02:00
/* Pointer to NMClient of libnm */
NMClient *client;
all: reformat all with new clang-format style Run: ./contrib/scripts/nm-code-format.sh -i ./contrib/scripts/nm-code-format.sh -i Yes, it needs to run twice because the first run doesn't yet produce the final result. Signed-off-by: Antonio Cardace <acardace@redhat.com>
2020-09-28 16:03:33 +02:00
cli: reformat file to look better Comments on the same line as field names are not rendered well by clang-format. Even if manually edited, it seems not a preferable way to comment on a field. Move the comment in the line before.
2022-06-16 11:00:12 +02:00
/* Return code of nmcli */
NMCResultCode return_value;
/* Reason text */
GString *return_text;
all: reformat all with new clang-format style Run: ./contrib/scripts/nm-code-format.sh -i ./contrib/scripts/nm-code-format.sh -i Yes, it needs to run twice because the first run doesn't yet produce the final result. Signed-off-by: Antonio Cardace <acardace@redhat.com>
2020-09-28 16:03:33 +02:00
cli: avoid passing full NmCli global variable to nm_cli_spawn_pager() We should not use global variables, and we should minimize the state that we pass around. Instead of requiring the full NmCli struct in nm_cli_spawn_pager(), pass only the necessary data. This reduces our use of global variables.
2020-04-02 13:59:53 +02:00
NmcPagerData pager_data;
all: reformat all with new clang-format style Run: ./contrib/scripts/nm-code-format.sh -i ./contrib/scripts/nm-code-format.sh -i Yes, it needs to run twice because the first run doesn't yet produce the final result. Signed-off-by: Antonio Cardace <acardace@redhat.com>
2020-09-28 16:03:33 +02:00
cli: reformat file to look better Comments on the same line as field names are not rendered well by clang-format. Even if manually edited, it seems not a preferable way to comment on a field. Move the comment in the line before.
2022-06-16 11:00:12 +02:00
/* Operation timeout */
int timeout;
/* Secret agent */
NMSecretAgentSimple *secret_agent;
/* Hash table with passwords in passwd-file */
GHashTable *pwds_hash;
/* polkit agent listener */
struct _NMPolkitListener *pk_listener;
/* Semaphore indicating whether nmcli should not end or not yet */
int should_wait;
/* '--nowait' option; used for passing to callbacks */
bool nowait_flag : 1;
/* Whether tabular/multiline mode was specified via '--mode' option */
bool mode_specified : 1;
all: reformat all with new clang-format style Run: ./contrib/scripts/nm-code-format.sh -i ./contrib/scripts/nm-code-format.sh -i Yes, it needs to run twice because the first run doesn't yet produce the final result. Signed-off-by: Antonio Cardace <acardace@redhat.com>
2020-09-28 16:03:33 +02:00
cli: reformat file to look better Comments on the same line as field names are not rendered well by clang-format. Even if manually edited, it seems not a preferable way to comment on a field. Move the comment in the line before.
2022-06-16 11:00:12 +02:00
/* Communicate the connection data over stdin/stdout instead of talking to the daemon. */
bool offline : 1;
all: reformat all with new clang-format style Run: ./contrib/scripts/nm-code-format.sh -i ./contrib/scripts/nm-code-format.sh -i Yes, it needs to run twice because the first run doesn't yet produce the final result. Signed-off-by: Antonio Cardace <acardace@redhat.com>
2020-09-28 16:03:33 +02:00
cli: reformat file to look better Comments on the same line as field names are not rendered well by clang-format. Even if manually edited, it seems not a preferable way to comment on a field. Move the comment in the line before.
2022-06-16 11:00:12 +02:00
/* Ask for missing parameters: option '--ask' */
bool ask : 1;
nmcli.h: tidy up boolean struct members Use bitfields to save a few bytes. This involves swapping gboolean for bool and some reordering in order to get them grouped together. The patch looks horrible, because clang-format decides to put itself and seem to go out of its way to make this whole file look idiotic. What can you do.
2022-04-06 12:16:21 +02:00
cli: reformat file to look better Comments on the same line as field names are not rendered well by clang-format. Even if manually edited, it seems not a preferable way to comment on a field. Move the comment in the line before.
2022-06-16 11:00:12 +02:00
/* Autocomplete the command line */
bool complete : 1;
/* Whether to display status line in connection editor */
bool editor_status_line : 1;
/* Whether to ask for confirmation on saving connections with 'autoconnect=yes' */
bool editor_save_confirmation : 1;
nmcli.h: tidy up boolean struct members Use bitfields to save a few bytes. This involves swapping gboolean for bool and some reordering in order to get them grouped together. The patch looks horrible, because clang-format decides to put itself and seem to go out of its way to make this whole file look idiotic. What can you do.
2022-04-06 12:16:21 +02:00
cli: pass configuration options separately from NmCli structure The NmCli structure is passed around everywhere and contains all the state of the program. It is very hard to follow which parts are used where. Split out more configuration options to a NmcConfig field. This field is mostly immutable, and modified at particular places that now can be easily found.
2017-03-30 12:45:41 +02:00
union {
const NmcConfig nmc_config;
NmcConfig nmc_config_mutable;
};
all: reformat all with new clang-format style Run: ./contrib/scripts/nm-code-format.sh -i ./contrib/scripts/nm-code-format.sh -i Yes, it needs to run twice because the first run doesn't yet produce the final result. Signed-off-by: Antonio Cardace <acardace@redhat.com>
2020-09-28 16:03:33 +02:00
cli: reformat file to look better Comments on the same line as field names are not rendered well by clang-format. Even if manually edited, it seems not a preferable way to comment on a field. Move the comment in the line before.
2022-06-16 11:00:12 +02:00
/* Required fields in output: '--fields' option */
char *required_fields;
/* Buffer with sequences for terminal-colors.d(5)-based coloring. */
char *palette_buffer;
nmcli: add --offline option for "add" and "modify" This adds a global "--offline" option and allows its use with "add" and "modify" commands. The "add" looks like this: $ nmcli --offline conn add type ethernet ens3 ipv4.dns 192.168.1.1 \ >output.nmconnection The "modify" is essentially implementing what's been suggested by Beniamino in bugzilla ticked (referred to below): $ nmcli --offline connection modify ens3 ipv4.dns 192.168.1.1 \ <input.nmconnection >output.nmconnection Other commands don't support the argument at the moment: $ nmcli --offline c up ens3 Error: 'up' command doesn't support --offline mode. https://bugzilla.redhat.com/show_bug.cgi?id=1361145
2022-04-05 19:47:32 +02:00
GPtrArray *offline_connections;
cli: add initial pieces of nmcli
2010-02-25 09:52:30 -08:00
} NmCli;
cli: add and use nm_cli_global_readline global variable We should try to avoid access to global variables. For libreadline callbacks we still need a global variable. Introduce a global variable nm_cli_global_readline, specially for this use. It makes the places clear where we use it, and discourages the use at other places, where we better avoid global variables.
2020-04-02 13:33:10 +02:00
extern const NmCli *const nm_cli_global_readline;
cli: use an error quark for domain in g_set_error() instead of 0 (rh #842975) glib 2.32 makes a runtime check that domain is not NULL: GLib-WARNING **: (gerror.c:390):g_error_new_valist: runtime check failed: (domain != 0)
2012-07-25 13:57:45 +02:00
/* Error quark for GError domain */
#define NMCLI_ERROR (nmcli_error_quark())
GQuark nmcli_error_quark(void);
cli: move global "loop" variable to nmcli.h header
2017-04-06 19:39:36 +02:00
extern GMainLoop *loop;
cli: don't quit nmcli on Ctrl-C while in readline() We rather cancel the input and show new prompt on readline. It is more expected behaviour for interactive input when quitting.
2014-06-16 08:30:22 +02:00
gboolean nmc_seen_sigint(void);
void nmc_clear_sigint(void);
cli: don't print "Error: nmcli terminated by signal Quit (3)" on Ctrl-D Also make sure we don't print anything before quitting on Ctrl-D.
2014-06-20 14:50:18 +02:00
void nmc_set_sigquit_internal(void);
cli: remove editor thread Currently the editor runs in a dedicated thread so that the blocking call to readline() doesn't stop the processing of D-Bus events in the main loop. The editor thread can access objects concurrently with the main thread and this can cause races and crashes. Remove the editor thread and use the non-blocking readline API. https://bugzilla.gnome.org/show_bug.cgi?id=732097 https://bugzilla.redhat.com/show_bug.cgi?id=1368353
2016-09-02 16:16:34 +02:00
void nmc_exit(void);
cli: don't print "Error: nmcli terminated by signal Quit (3)" on Ctrl-D Also make sure we don't print anything before quitting on Ctrl-D.
2014-06-20 14:50:18 +02:00
cli: avoid passing full NmCli global variable to nm_cli_spawn_pager() We should not use global variables, and we should minimize the state that we pass around. Instead of requiring the full NmCli struct in nm_cli_spawn_pager(), pass only the necessary data. This reduces our use of global variables.
2020-04-02 13:59:53 +02:00
void nm_cli_spawn_pager(const NmcConfig *nmc_config, NmcPagerData *pager_data);
cli: don't use global variable nm_cli in nmc_terminal_spawn_pager() print_required_fields() still accesses the global variable. We can only move the uses of globals up the call-stack, one bit at a time.
2018-10-09 13:08:24 +02:00
cli: don't track output data in global NmCli structure We should not violate the global data to track the output data while it is constructed and printed. Most of the time, we actually clear the output data anyway -- either before constructing it, or after printing it. In some cases we didn't, but I think that is a bug. It's really hard to keep track of this. The output data should belong to a certain scope and get destroyed afterwards. Passing it around is very confusing. Don't do that.
2017-03-30 14:56:19 +02:00
void nmc_empty_output_fields(NmcOutputData *output_data);
#define NMC_OUTPUT_DATA_DEFINE_SCOPED(out) \
format: reformat source tree with clang-format 13.0 We use clang-format for automatic formatting of our source files. Since clang-format is actively maintained software, the actual formatting depends on the used version of clang-format. That is unfortunate and painful, but really unavoidable unless clang-format would be strictly bug-compatible. So the version that we must use is from the current Fedora release, which is also tested by our gitlab-ci. Previously, we were using Fedora 34 with clang-tools-extra-12.0.1-1.fc34.x86_64. As Fedora 35 comes along, we need to update our formatting as Fedora 35 comes with version "13.0.0~rc1-1.fc35". An alternative would be to freeze on version 12, but that has different problems (like, it's cumbersome to rebuild clang 12 on Fedora 35 and it would be cumbersome for our developers which are on Fedora 35 to use a clang that they cannot easily install). The (differently painful) solution is to reformat from time to time, as we switch to a new Fedora (and thus clang) version. Usually we would expect that such a reformatting brings minor changes. But this time, the changes are huge. That is mentioned in the release notes [1] as Makes PointerAligment: Right working with AlignConsecutiveDeclarations. (Fixes https://llvm.org/PR27353) [1] https://releases.llvm.org/13.0.0/tools/clang/docs/ReleaseNotes.html#clang-format
2021-11-09 13:28:54 +01:00
gs_unref_array GArray *out##_indices = NULL; \
cli: don't track output data in global NmCli structure We should not violate the global data to track the output data while it is constructed and printed. Most of the time, we actually clear the output data anyway -- either before constructing it, or after printing it. In some cases we didn't, but I think that is a bug. It's really hard to keep track of this. The output data should belong to a certain scope and get destroyed afterwards. Passing it around is very confusing. Don't do that.
2017-03-30 14:56:19 +02:00
nm_auto(nmc_empty_output_fields) NmcOutputData out = { \
format: reformat source tree with clang-format 13.0 We use clang-format for automatic formatting of our source files. Since clang-format is actively maintained software, the actual formatting depends on the used version of clang-format. That is unfortunate and painful, but really unavoidable unless clang-format would be strictly bug-compatible. So the version that we must use is from the current Fedora release, which is also tested by our gitlab-ci. Previously, we were using Fedora 34 with clang-tools-extra-12.0.1-1.fc34.x86_64. As Fedora 35 comes along, we need to update our formatting as Fedora 35 comes with version "13.0.0~rc1-1.fc35". An alternative would be to freeze on version 12, but that has different problems (like, it's cumbersome to rebuild clang 12 on Fedora 35 and it would be cumbersome for our developers which are on Fedora 35 to use a clang that they cannot easily install). The (differently painful) solution is to reformat from time to time, as we switch to a new Fedora (and thus clang) version. Usually we would expect that such a reformatting brings minor changes. But this time, the changes are huge. That is mentioned in the release notes [1] as Makes PointerAligment: Right working with AlignConsecutiveDeclarations. (Fixes https://llvm.org/PR27353) [1] https://releases.llvm.org/13.0.0/tools/clang/docs/ReleaseNotes.html#clang-format
2021-11-09 13:28:54 +01:00
.output_data = g_ptr_array_new_full(20, g_free), \
cli: don't track output data in global NmCli structure We should not violate the global data to track the output data while it is constructed and printed. Most of the time, we actually clear the output data anyway -- either before constructing it, or after printing it. In some cases we didn't, but I think that is a bug. It's really hard to keep track of this. The output data should belong to a certain scope and get destroyed afterwards. Passing it around is very confusing. Don't do that.
2017-03-30 14:56:19 +02:00
}
cli: cleanup NMCCommand and declarations of func implementations - move the main func declarations to nmcli.h and give them a common prefix "nmc_command_func_" prefix. - remove some of the header files that are now empty. In fact, these headers did not really declare some well separated module. While we probably should structure the code in nmcli better with better layering, it was not and still is not. Having these dummy headers don't mean that the code is well structured and they serve little purpose. - move the static NMCommand lists variables into the function scope where they are used.
2020-04-05 11:47:07 +02:00
/*****************************************************************************/
cli: pass cmd to NMCCommand.func() It is useful from inside a function to know the command that it belongs to. Currently we have do_networking_on() and do_networking_off() as separate functions. However, these are basically the same with a minor difference. If the func callback could know the "cmd" that it was called for, these function can be combined. Of course, without passing the NMCCommand instance, you still can achieve the same results, especially as the NMCCommand instances are static and known at compile time: just have separate func implementations. But by passing the command to the function, they *can* be combined, which is a useful thing to do.
2020-04-05 12:16:08 +02:00
struct _NMCCommand;
typedef struct _NMCCommand {
cli: cleanup NMCCommand and declarations of func implementations - move the main func declarations to nmcli.h and give them a common prefix "nmc_command_func_" prefix. - remove some of the header files that are now empty. In fact, these headers did not really declare some well separated module. While we probably should structure the code in nmcli better with better layering, it was not and still is not. Having these dummy headers don't mean that the code is well structured and they serve little purpose. - move the static NMCommand lists variables into the function scope where they are used.
2020-04-05 11:47:07 +02:00
const char *cmd;
cli: remove redundant return value from NMCCommand funcs Many func implementations are asynchronous, that means, they cannot return right away. Instead, they record the return value in nmc->result_value. The return value from the command functions was thus redundant. In the best case, the return value agrees with the cached result in nmc->result_value, in which it was unnecessary. In the worst case, they disagree, and overwrite each other. nmc->result_value is state. Tracking state is hard, and there should be fewer places where the state gets mutated. Also, the rules how that happened should be clearer. Drop the redundant, conflicting mechanism.
2020-04-05 15:36:30 +02:00
void (*func)(const struct _NMCCommand *cmd, NmCli *nmc, int argc, const char *const *argv);
cli: cleanup NMCCommand and declarations of func implementations - move the main func declarations to nmcli.h and give them a common prefix "nmc_command_func_" prefix. - remove some of the header files that are now empty. In fact, these headers did not really declare some well separated module. While we probably should structure the code in nmcli better with better layering, it was not and still is not. Having these dummy headers don't mean that the code is well structured and they serve little purpose. - move the static NMCommand lists variables into the function scope where they are used.
2020-04-05 11:47:07 +02:00
void (*usage)(void);
nmcli: add --offline option for "add" and "modify" This adds a global "--offline" option and allows its use with "add" and "modify" commands. The "add" looks like this: $ nmcli --offline conn add type ethernet ens3 ipv4.dns 192.168.1.1 \ >output.nmconnection The "modify" is essentially implementing what's been suggested by Beniamino in bugzilla ticked (referred to below): $ nmcli --offline connection modify ens3 ipv4.dns 192.168.1.1 \ <input.nmconnection >output.nmconnection Other commands don't support the argument at the moment: $ nmcli --offline c up ens3 Error: 'up' command doesn't support --offline mode. https://bugzilla.redhat.com/show_bug.cgi?id=1361145
2022-04-05 19:47:32 +02:00
cli: reformat file to look better Comments on the same line as field names are not rendered well by clang-format. Even if manually edited, it seems not a preferable way to comment on a field. Move the comment in the line before.
2022-06-16 11:00:12 +02:00
/* Ensure a client instance is there before calling the handler (unless --offline has been given). */
bool needs_client : 1;
/* Client instance exists *and* the service is actually present on the bus. */
bool needs_nm_running : 1;
/* Run the handler without a client even if the comand usually requires one if --offline option was used. */
bool supports_offline : 1;
/* With --online, read in a keyfile from standard input before dispatching the handler. */
bool needs_offline_conn : 1;
cli: cleanup NMCCommand and declarations of func implementations - move the main func declarations to nmcli.h and give them a common prefix "nmc_command_func_" prefix. - remove some of the header files that are now empty. In fact, these headers did not really declare some well separated module. While we probably should structure the code in nmcli better with better layering, it was not and still is not. Having these dummy headers don't mean that the code is well structured and they serve little purpose. - move the static NMCommand lists variables into the function scope where they are used.
2020-04-05 11:47:07 +02:00
} NMCCommand;
cli: remove redundant return value from NMCCommand funcs Many func implementations are asynchronous, that means, they cannot return right away. Instead, they record the return value in nmc->result_value. The return value from the command functions was thus redundant. In the best case, the return value agrees with the cached result in nmc->result_value, in which it was unnecessary. In the worst case, they disagree, and overwrite each other. nmc->result_value is state. Tracking state is hard, and there should be fewer places where the state gets mutated. Also, the rules how that happened should be clearer. Drop the redundant, conflicting mechanism.
2020-04-05 15:36:30 +02:00
void nmc_command_func_agent(const NMCCommand *cmd, NmCli *nmc, int argc, const char *const *argv);
void nmc_command_func_general(const NMCCommand *cmd, NmCli *nmc, int argc, const char *const *argv);
void
nmc_command_func_networking(const NMCCommand *cmd, NmCli *nmc, int argc, const char *const *argv);
void nmc_command_func_radio(const NMCCommand *cmd, NmCli *nmc, int argc, const char *const *argv);
void nmc_command_func_monitor(const NMCCommand *cmd, NmCli *nmc, int argc, const char *const *argv);
void
nmc_command_func_overview(const NMCCommand *cmd, NmCli *nmc, int argc, const char *const *argv);
void
nmc_command_func_connection(const NMCCommand *cmd, NmCli *nmc, int argc, const char *const *argv);
void nmc_command_func_device(const NMCCommand *cmd, NmCli *nmc, int argc, const char *const *argv);
cli: cleanup NMCCommand and declarations of func implementations - move the main func declarations to nmcli.h and give them a common prefix "nmc_command_func_" prefix. - remove some of the header files that are now empty. In fact, these headers did not really declare some well separated module. While we probably should structure the code in nmcli better with better layering, it was not and still is not. Having these dummy headers don't mean that the code is well structured and they serve little purpose. - move the static NMCommand lists variables into the function scope where they are used.
2020-04-05 11:47:07 +02:00
/*****************************************************************************/
cli: add initial pieces of nmcli
2010-02-25 09:52:30 -08:00
#endif /* NMC_NMCLI_H */
Reference in a new issue Copy permalink