/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
* Copyright (C) 2007 - 2018 Red Hat, Inc.
* Copyright (C) 2008 Novell, Inc.
*/
#ifndef __NM_SETTINGS_PLUGIN_H__
#define __NM_SETTINGS_PLUGIN_H__
#include "nm-connection.h"
#include "nm-settings-storage.h"
typedef struct _NMSettingsPlugin NMSettingsPlugin;
typedef void (*NMSettingsPluginConnectionLoadCallback)(NMSettingsPlugin * self,
NMSettingsStorage *storage,
NMConnection * connection,
gpointer user_data);
typedef struct {
const char *filename;
GError * error;
bool handled : 1;
} NMSettingsPluginConnectionLoadEntry;
#define NM_TYPE_SETTINGS_PLUGIN (nm_settings_plugin_get_type())
#define NM_SETTINGS_PLUGIN(obj) \
(G_TYPE_CHECK_INSTANCE_CAST((obj), NM_TYPE_SETTINGS_PLUGIN, NMSettingsPlugin))
#define NM_SETTINGS_PLUGIN_CLASS(klass) \
(G_TYPE_CHECK_CLASS_CAST((klass), NM_TYPE_SETTINGS_PLUGIN, NMSettingsPluginClass))
#define NM_IS_SETTINGS_PLUGIN(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), NM_TYPE_SETTINGS_PLUGIN))
#define NM_IS_SETTINGS_PLUGIN_CLASS(klass) \
(G_TYPE_CHECK_CLASS_TYPE((klass), NM_TYPE_SETTINGS_PLUGIN))
#define NM_SETTINGS_PLUGIN_GET_CLASS(obj) \
(G_TYPE_INSTANCE_GET_CLASS((obj), NM_TYPE_SETTINGS_PLUGIN, NMSettingsPluginClass))
#define NM_SETTINGS_PLUGIN_UNMANAGED_SPECS_CHANGED "unmanaged-specs-changed"
#define NM_SETTINGS_PLUGIN_UNRECOGNIZED_SPECS_CHANGED "unrecognized-specs-changed"
struct _NMSettingsPlugin {
GObject parent;
};
typedef struct {
GObjectClass parent;
/*
* Return a string list of specifications of devices which NetworkManager
* should not manage. Returned list will be freed by the system settings
* service, and each element must be allocated using g_malloc() or its
* variants (g_strdup, g_strdup_printf, etc).
*
* Each string in the list must be in one of the formats recognized by
* nm_device_spec_match_list().
*/
GSList *(*get_unmanaged_specs)(NMSettingsPlugin *self);
/*
* Return a string list of specifications of devices for which at least
* one non-NetworkManager-based configuration is defined. Returned list
* will be freed by the system settings service, and each element must be
* allocated using g_malloc() or its variants (g_strdup, g_strdup_printf,
* etc).
*
* Each string in the list must be in one of the formats recognized by
* nm_device_spec_match_list().
*/
GSList *(*get_unrecognized_specs)(NMSettingsPlugin *self);
/* Requests that the plugin load/reload a set of filenames.
*/
void (*load_connections)(NMSettingsPlugin * self,
NMSettingsPluginConnectionLoadEntry * entries,
gsize n_entries,
NMSettingsPluginConnectionLoadCallback callback,
gpointer user_data);
/* Requests that the plugin reload all connection files from disk,
* and emit signals reflecting new, changed, and removed connections.
*/
void (*reload_connections)(NMSettingsPlugin * self,
NMSettingsPluginConnectionLoadCallback callback,
gpointer user_data);
void (*load_connections_done)(NMSettingsPlugin *self);
gboolean (*add_connection)(NMSettingsPlugin * self,
NMConnection * connection,
NMSettingsStorage **out_storage,
NMConnection ** out_connection,
GError ** error);
gboolean (*update_connection)(NMSettingsPlugin * self,
NMSettingsStorage * storage,
NMConnection * connection,
NMSettingsStorage **out_storage,
NMConnection ** out_connection,
GError ** error);
gboolean (*delete_connection)(NMSettingsPlugin * self,
NMSettingsStorage *storage,
GError ** error);
const char *plugin_name;
} NMSettingsPluginClass;
/*****************************************************************************/
GType nm_settings_plugin_get_type(void);
/*****************************************************************************/
#define NM_SETTINGS_STORAGE_PRINT_FMT NM_HASH_OBFUSCATE_PTR_FMT "/%s"
#define NM_SETTINGS_STORAGE_PRINT_ARG(storage) \
NM_HASH_OBFUSCATE_PTR(storage), \
nm_settings_plugin_get_plugin_name(nm_settings_storage_get_plugin(storage))
static inline const char *
nm_settings_plugin_get_plugin_name(NMSettingsPlugin *self)
{
NMSettingsPluginClass *klass;
nm_assert(NM_SETTINGS_PLUGIN(self));
klass = NM_SETTINGS_PLUGIN_GET_CLASS(self);
nm_assert(klass && klass->plugin_name && strlen(klass->plugin_name) > 0);
return klass->plugin_name;
}
/*****************************************************************************/
GSList *nm_settings_plugin_get_unmanaged_specs(NMSettingsPlugin *self);
GSList *nm_settings_plugin_get_unrecognized_specs(NMSettingsPlugin *self);
void nm_settings_plugin_reload_connections(NMSettingsPlugin * self,
NMSettingsPluginConnectionLoadCallback callback,
gpointer user_data);
NMSettingsPluginConnectionLoadEntry *
nm_settings_plugin_create_connection_load_entries(const char *const *filenames, gsize *out_len);
void nm_settings_plugin_load_connections(NMSettingsPlugin * self,
NMSettingsPluginConnectionLoadEntry * entries,
gsize n_entries,
NMSettingsPluginConnectionLoadCallback callback,
gpointer user_data);
void nm_settings_plugin_load_connections_done(NMSettingsPlugin *self);
gboolean nm_settings_plugin_add_connection(NMSettingsPlugin * self,
NMConnection * connection,
NMSettingsStorage **out_storage,
NMConnection ** out_connection,
GError ** error);
gboolean nm_settings_plugin_update_connection(NMSettingsPlugin * self,
NMSettingsStorage * storage,
NMConnection * connection,
NMSettingsStorage **out_storage,
NMConnection ** out_connection,
GError ** error);
gboolean nm_settings_plugin_delete_connection(NMSettingsPlugin * self,
NMSettingsStorage *storage,
GError ** error);
/*****************************************************************************/
typedef NMSettingsPlugin *(*NMSettingsPluginFactoryFunc)(void);
NMSettingsPlugin *nm_settings_plugin_factory(void);
/*****************************************************************************
* Internal API
*****************************************************************************/
void _nm_settings_plugin_emit_signal_unmanaged_specs_changed(NMSettingsPlugin *self);
void _nm_settings_plugin_emit_signal_unrecognized_specs_changed(NMSettingsPlugin *self);
/*****************************************************************************/
int nm_settings_plugin_cmp_by_priority(const NMSettingsPlugin *a,
const NMSettingsPlugin *b,
const GSList * plugin_list);
/*****************************************************************************/
/* forward declare this function from NMSettings. It's used by the ifcfg-rh plugin,
* but that shouldn't include all "nm-settings.h" header. */
NMSettings *nm_settings_get(void);
const char *nm_settings_get_dbus_path_for_uuid(NMSettings *self, const char *uuid);
#endif /* __NM_SETTINGS_PLUGIN_H__ */