201 lines
7.6 KiB
C
201 lines
7.6 KiB
C
/* nmcli - command-line tool to control NetworkManager
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program 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 General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
*
|
|
* Copyright 2010 - 2015 Red Hat, Inc.
|
|
*/
|
|
|
|
#ifndef NMC_NMCLI_H
|
|
#define NMC_NMCLI_H
|
|
|
|
#include "NetworkManager.h"
|
|
#include "nm-secret-agent-old.h"
|
|
|
|
#if WITH_POLKIT_AGENT
|
|
#include "nm-polkit-listener.h"
|
|
#else
|
|
/* polkit agent is not available; define fake NMPolkitListener */
|
|
typedef gpointer NMPolkitListener;
|
|
#endif
|
|
|
|
/* nmcli exit codes */
|
|
typedef enum {
|
|
/* Indicates successful execution */
|
|
NMC_RESULT_SUCCESS = 0,
|
|
|
|
/* Unknown / unspecified error */
|
|
NMC_RESULT_ERROR_UNKNOWN = 1,
|
|
|
|
/* Wrong invocation of nmcli */
|
|
NMC_RESULT_ERROR_USER_INPUT = 2,
|
|
|
|
/* A timeout expired */
|
|
NMC_RESULT_ERROR_TIMEOUT_EXPIRED = 3,
|
|
|
|
/* Error in connection activation */
|
|
NMC_RESULT_ERROR_CON_ACTIVATION = 4,
|
|
|
|
/* Error in connection deactivation */
|
|
NMC_RESULT_ERROR_CON_DEACTIVATION = 5,
|
|
|
|
/* Error in device disconnect */
|
|
NMC_RESULT_ERROR_DEV_DISCONNECT = 6,
|
|
|
|
/* Error in connection deletion */
|
|
NMC_RESULT_ERROR_CON_DEL = 7,
|
|
|
|
/* NetworkManager is not running */
|
|
NMC_RESULT_ERROR_NM_NOT_RUNNING = 8,
|
|
|
|
/* No more used, keep to preserve API */
|
|
NMC_RESULT_ERROR_VERSIONS_MISMATCH = 9,
|
|
|
|
/* Connection/Device/AP not found */
|
|
NMC_RESULT_ERROR_NOT_FOUND = 10,
|
|
|
|
/* --complete-args signals a file name may follow */
|
|
NMC_RESULT_COMPLETE_FILE = 65,
|
|
} NMCResultCode;
|
|
|
|
typedef enum {
|
|
NMC_TERM_COLOR_NORMAL = 0,
|
|
NMC_TERM_COLOR_BLACK = 1,
|
|
NMC_TERM_COLOR_RED = 2,
|
|
NMC_TERM_COLOR_GREEN = 3,
|
|
NMC_TERM_COLOR_YELLOW = 4,
|
|
NMC_TERM_COLOR_BLUE = 5,
|
|
NMC_TERM_COLOR_MAGENTA = 6,
|
|
NMC_TERM_COLOR_CYAN = 7,
|
|
NMC_TERM_COLOR_WHITE = 8
|
|
} NmcTermColor;
|
|
|
|
typedef enum {
|
|
NMC_TERM_FORMAT_NORMAL,
|
|
NMC_TERM_FORMAT_BOLD,
|
|
NMC_TERM_FORMAT_DIM,
|
|
NMC_TERM_FORMAT_UNDERLINE,
|
|
NMC_TERM_FORMAT_BLINK,
|
|
NMC_TERM_FORMAT_REVERSE,
|
|
NMC_TERM_FORMAT_HIDDEN,
|
|
} NmcTermFormat;
|
|
|
|
typedef enum {
|
|
NMC_PRINT_TERSE = 0,
|
|
NMC_PRINT_NORMAL = 1,
|
|
NMC_PRINT_PRETTY = 2
|
|
} NMCPrintOutput;
|
|
|
|
/* === Output fields === */
|
|
|
|
typedef enum {
|
|
NMC_OF_FLAG_FIELD_NAMES = 0x00000001, /* Print field names instead of values */
|
|
NMC_OF_FLAG_SECTION_PREFIX = 0x00000002, /* Use the first value as section prefix for the other field names - just in multiline */
|
|
NMC_OF_FLAG_MAIN_HEADER_ADD = 0x00000004, /* Print main header in addition to values/field names */
|
|
NMC_OF_FLAG_MAIN_HEADER_ONLY = 0x00000008, /* Print main header only */
|
|
} NmcOfFlags;
|
|
|
|
struct _NMMetaSettingInfoEditor;
|
|
|
|
typedef struct _NmcOutputField {
|
|
const char *name; /* Field's name */
|
|
int width; /* Width in screen columns */
|
|
const struct _NmcOutputField *group_list; /* Points to an array with available section field names if this is a section (group) field */
|
|
void *value; /* Value of current field - char* or char** (NULL-terminated array) */
|
|
gboolean value_is_array; /* Whether value is char** instead of char* */
|
|
gboolean free_value; /* Whether to free the value */
|
|
NmcOfFlags flags; /* Flags - whether and how to print values/field names/headers */
|
|
NmcTermColor color; /* Use this color to print value */
|
|
NmcTermFormat color_fmt; /* Use this terminal format to print value */
|
|
|
|
/* in a very particular case NmcOutputField is used in combination with
|
|
* the @group_list above. That list will go away (and the entire NmcOutputField
|
|
* should separate formatting-options, setting-metadata and output.
|
|
*
|
|
* For now, hack around that by alternatively providing a @setting_info instead
|
|
* of @group_list. */
|
|
const struct _NMMetaSettingInfoEditor *setting_info;
|
|
} NmcOutputField;
|
|
|
|
typedef enum {
|
|
NMC_USE_COLOR_AUTO,
|
|
NMC_USE_COLOR_YES,
|
|
NMC_USE_COLOR_NO,
|
|
} NmcColorOption;
|
|
|
|
typedef struct _NmcConfig {
|
|
NMCPrintOutput print_output; /* Output mode */
|
|
NmcColorOption use_colors; /* Whether to use colors for output: option '--color' */
|
|
gboolean multiline_output; /* Multiline output instead of default tabular */
|
|
gboolean escape_values; /* Whether to escape ':' and '\' in terse tabular mode */
|
|
gboolean in_editor; /* Whether running the editor - nmcli con edit' */
|
|
} NmcConfig;
|
|
|
|
typedef struct _NmcOutputData {
|
|
GPtrArray *output_data; /* GPtrArray of arrays of NmcOutputField structs - accumulates data for output */
|
|
GArray *indices; /* Array of field indices to the array of allowed fields */
|
|
const char *header_name; /* Name of the output */
|
|
int indent; /* Indent by this number of spaces */
|
|
} NmcOutputData;
|
|
|
|
/* NmCli - main structure */
|
|
typedef struct _NmCli {
|
|
NMClient *client; /* Pointer to NMClient of libnm */
|
|
|
|
NMCResultCode return_value; /* Return code of nmcli */
|
|
GString *return_text; /* Reason text */
|
|
|
|
int timeout; /* Operation timeout */
|
|
|
|
NMSecretAgentOld *secret_agent; /* Secret agent */
|
|
GHashTable *pwds_hash; /* Hash table with passwords in passwd-file */
|
|
NMPolkitListener *pk_listener ; /* polkit agent listener */
|
|
|
|
int should_wait; /* Semaphore indicating whether nmcli should not end or not yet */
|
|
gboolean nowait_flag; /* '--nowait' option; used for passing to callbacks */
|
|
gboolean mode_specified; /* Whether tabular/multiline mode was specified via '--mode' option */
|
|
union {
|
|
const NmcConfig nmc_config;
|
|
NmcConfig nmc_config_mutable;
|
|
};
|
|
char *required_fields; /* Required fields in output: '--fields' option */
|
|
gboolean ask; /* Ask for missing parameters: option '--ask' */
|
|
gboolean complete; /* Autocomplete the command line */
|
|
gboolean show_secrets; /* Whether to display secrets (both input and output): option '--show-secrets' */
|
|
gboolean editor_status_line; /* Whether to display status line in connection editor */
|
|
gboolean editor_save_confirmation; /* Whether to ask for confirmation on saving connections with 'autoconnect=yes' */
|
|
gboolean editor_show_secrets; /* Whether to display secrets in the editor' */
|
|
NmcTermColor editor_prompt_color; /* Color of prompt in connection editor */
|
|
} NmCli;
|
|
|
|
extern NmCli nm_cli;
|
|
|
|
/* Error quark for GError domain */
|
|
#define NMCLI_ERROR (nmcli_error_quark ())
|
|
GQuark nmcli_error_quark (void);
|
|
|
|
gboolean nmc_seen_sigint (void);
|
|
void nmc_clear_sigint (void);
|
|
void nmc_set_sigquit_internal (void);
|
|
void nmc_exit (void);
|
|
|
|
void nmc_empty_output_fields (NmcOutputData *output_data);
|
|
|
|
#define NMC_OUTPUT_DATA_DEFINE_SCOPED(out) \
|
|
nm_auto (nmc_empty_output_fields) NmcOutputData out = { \
|
|
.output_data = g_ptr_array_new_full (20, g_free), \
|
|
}
|
|
|
|
#endif /* NMC_NMCLI_H */
|