src/nm-config-data.h

   1 /* -*- Mode: C; tab-width: 4; indent-tabs-mode: t; c-basic-offset: 4 -*- */
   2 /* NetworkManager -- Network link manager
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  17  *
  18  * Copyright (C) 2014 Red Hat, Inc.
  19  */
  20
  21 #ifndef NM_CONFIG_DATA_H
  22 #define NM_CONFIG_DATA_H
  23
  24
  25 #include "nm-default.h"
  26
  27 G_BEGIN_DECLS
  28
  29 #define NM_TYPE_CONFIG_DATA            (nm_config_data_get_type ())
  30 #define NM_CONFIG_DATA(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), NM_TYPE_CONFIG_DATA, NMConfigData))
  31 #define NM_CONFIG_DATA_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass),  NM_TYPE_CONFIG_DATA, NMConfigDataClass))
  32 #define NM_IS_CONFIG_DATA(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), NM_TYPE_CONFIG_DATA))
  33 #define NM_IS_CONFIG_DATA_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass),  NM_TYPE_CONFIG_DATA))
  34 #define NM_CONFIG_DATA_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj),  NM_TYPE_CONFIG_DATA, NMConfigDataClass))
  35
  36
  37 #define NM_CONFIG_DATA_CONFIG_MAIN_FILE      "config-main-file"
  38 #define NM_CONFIG_DATA_CONFIG_DESCRIPTION    "config-description"
  39 #define NM_CONFIG_DATA_KEYFILE_USER          "keyfile-user"
  40 #define NM_CONFIG_DATA_KEYFILE_INTERN        "keyfile-intern"
  41 #define NM_CONFIG_DATA_CONNECTIVITY_URI      "connectivity-uri"
  42 #define NM_CONFIG_DATA_CONNECTIVITY_INTERVAL "connectivity-interval"
  43 #define NM_CONFIG_DATA_CONNECTIVITY_RESPONSE "connectivity-response"
  44 #define NM_CONFIG_DATA_NO_AUTO_DEFAULT       "no-auto-default"
  45 #define NM_CONFIG_DATA_DNS_MODE              "dns"
  46
  47 typedef enum { /*<flags >*/
  48         NM_CONFIG_GET_VALUE_NONE                   = 0,
  49
  50         /* use g_key_file_get_value() instead of g_key_file_get_string(). */
  51         NM_CONFIG_GET_VALUE_RAW                    = (1LL << 0),
  52
  53         /* strip whitespaces */
  54         NM_CONFIG_GET_VALUE_STRIP                  = (1LL << 1),
  55
  56         /* if the returned string would be the empty word, return NULL. */
  57         NM_CONFIG_GET_VALUE_NO_EMPTY               = (1LL << 2),
  58
  59         /* special flag to read device spec. You want to use this before passing the
  60          * value to nm_match_spec_split(). */
  61         NM_CONFIG_GET_VALUE_TYPE_SPEC              = NM_CONFIG_GET_VALUE_RAW,
  62 } NMConfigGetValueFlags;
  63
  64 typedef enum { /*< flags >*/
  65         NM_CONFIG_CHANGE_NONE                      = 0,
  66
  67         NM_CONFIG_CHANGE_SIGHUP                    = (1L << 0),
  68         NM_CONFIG_CHANGE_SIGUSR1                   = (1L << 1),
  69         NM_CONFIG_CHANGE_SIGUSR2                   = (1L << 2),
  70
  71         NM_CONFIG_CHANGE_CONFIG_FILES              = (1L << 3),
  72         NM_CONFIG_CHANGE_VALUES                    = (1L << 4),
  73         NM_CONFIG_CHANGE_VALUES_USER               = (1L << 5),
  74         NM_CONFIG_CHANGE_VALUES_INTERN             = (1L << 6),
  75         NM_CONFIG_CHANGE_CONNECTIVITY              = (1L << 7),
  76         NM_CONFIG_CHANGE_NO_AUTO_DEFAULT           = (1L << 8),
  77         NM_CONFIG_CHANGE_DNS_MODE                  = (1L << 9),
  78         NM_CONFIG_CHANGE_RC_MANAGER                = (1L << 10),
  79         NM_CONFIG_CHANGE_GLOBAL_DNS_CONFIG         = (1L << 11),
  80
  81         _NM_CONFIG_CHANGE_LAST,
  82         NM_CONFIG_CHANGE_ALL                       = ((_NM_CONFIG_CHANGE_LAST - 1) << 1) - 1,
  83 } NMConfigChangeFlags;
  84
  85 struct _NMConfigData {
  86         GObject parent;
  87 };
  88
  89 typedef struct {
  90         GObjectClass parent;
  91 } NMConfigDataClass;
  92
  93 typedef struct _NMGlobalDnsConfig NMGlobalDnsConfig;
  94 typedef struct _NMGlobalDnsDomain NMGlobalDnsDomain;
  95
  96 GType nm_config_data_get_type (void);
  97
  98 NMConfigData *nm_config_data_new (const char *config_main_file,
  99                                   const char *config_description,
 100                                   const char *const*no_auto_default,
 101                                   GKeyFile *keyfile_user,
 102                                   GKeyFile *keyfile_intern);
 103 NMConfigData *nm_config_data_new_update_keyfile_intern (const NMConfigData *base, GKeyFile *keyfile_intern);
 104 NMConfigData *nm_config_data_new_update_no_auto_default (const NMConfigData *base, const char *const*no_auto_default);
 105
 106 NMConfigChangeFlags nm_config_data_diff (NMConfigData *old_data, NMConfigData *new_data);
 107
 108 void nm_config_data_log (const NMConfigData *self,
 109                                const char *prefix,
 110                                const char *key_prefix,
 111                                /* FILE* */ gpointer print_stream);
 112
 113 const char *nm_config_data_get_config_main_file (const NMConfigData *config_data);
 114 const char *nm_config_data_get_config_description (const NMConfigData *config_data);
 115
 116 gboolean nm_config_data_has_group (const NMConfigData *self, const char *group);
 117 gboolean nm_config_data_has_value (const NMConfigData *self, const char *group, const char *key, NMConfigGetValueFlags flags);
 118 char *nm_config_data_get_value (const NMConfigData *config_data, const char *group, const char *key, NMConfigGetValueFlags flags);
 119 const char *nm_config_data_get_value_cached (const NMConfigData *config_data, const char *group, const char *key, NMConfigGetValueFlags flags);
 120 gint nm_config_data_get_value_boolean (const NMConfigData *self, const char *group, const char *key, gint default_value);
 121
 122 const char *nm_config_data_get_connectivity_uri (const NMConfigData *config_data);
 123 const guint nm_config_data_get_connectivity_interval (const NMConfigData *config_data);
 124 const char *nm_config_data_get_connectivity_response (const NMConfigData *config_data);
 125
 126 const char *const*nm_config_data_get_no_auto_default (const NMConfigData *config_data);
 127 gboolean          nm_config_data_get_no_auto_default_for_device (const NMConfigData *self, NMDevice *device);
 128
 129 const char *nm_config_data_get_dns_mode (const NMConfigData *self);
 130 const char *nm_config_data_get_rc_manager (const NMConfigData *self);
 131
 132 gboolean nm_config_data_get_ignore_carrier (const NMConfigData *self, NMDevice *device);
 133 gboolean nm_config_data_get_assume_ipv6ll_only (const NMConfigData *self, NMDevice *device);
 134 NMGlobalDnsConfig *nm_config_data_get_global_dns_config (const NMConfigData *self);
 135
 136 char *nm_config_data_get_connection_default (const NMConfigData *self,
 137                                              const char *property,
 138                                              NMDevice *device);
 139
 140 char **nm_config_data_get_groups (const NMConfigData *self);
 141 char **nm_config_data_get_keys (const NMConfigData *self, const char *group);
 142 gboolean nm_config_data_is_intern_atomic_group (const NMConfigData *self, const char *group);
 143
 144 GKeyFile *nm_config_data_clone_keyfile_intern (const NMConfigData *self);
 145
 146 const char *const *nm_global_dns_config_get_searches (const NMGlobalDnsConfig *dns);
 147 const char *const *nm_global_dns_config_get_options (const NMGlobalDnsConfig *dns);
 148 guint nm_global_dns_config_get_num_domains (const NMGlobalDnsConfig *dns);
 149 NMGlobalDnsDomain *nm_global_dns_config_get_domain (const NMGlobalDnsConfig *dns, guint i);
 150 NMGlobalDnsDomain *nm_global_dns_config_lookup_domain (const NMGlobalDnsConfig *dns, const char *name);
 151 const char *nm_global_dns_domain_get_name (const NMGlobalDnsDomain *domain);
 152 const char *const *nm_global_dns_domain_get_servers (const NMGlobalDnsDomain *domain);
 153 const char *const *nm_global_dns_domain_get_options (const NMGlobalDnsDomain *domain);
 154 gboolean nm_global_dns_config_is_internal (const NMGlobalDnsConfig *dns);
 155 gboolean nm_global_dns_config_is_empty (const NMGlobalDnsConfig *dns);
 156 void nm_global_dns_config_update_checksum (const NMGlobalDnsConfig *dns, GChecksum *sum);
 157 void nm_global_dns_config_free (NMGlobalDnsConfig *conf);
 158
 159 NMGlobalDnsConfig *nm_global_dns_config_from_dbus (const GValue *value, GError **error);
 160 void nm_global_dns_config_to_dbus (const NMGlobalDnsConfig *dns_config, GValue *value);
 161
 162 /* private accessors */
 163 GKeyFile *_nm_config_data_get_keyfile (const NMConfigData *self);
 164 GKeyFile *_nm_config_data_get_keyfile_user (const NMConfigData *self);
 165 GKeyFile *_nm_config_data_get_keyfile_intern (const NMConfigData *self);
 166
 167 G_END_DECLS
 168
 169 #endif /* NM_CONFIG_DATA_H */
 170