gonetworkmanager/Connection.go

package gonetworkmanager

import (
	"encoding/json"
	"github.com/godbus/dbus/v5"
)

const (
	ConnectionInterface = SettingsInterface + ".Connection"

	/* Methods */
	ConnectionUpdate        = ConnectionInterface + ".Update"
	ConnectionUpdateUnsaved = ConnectionInterface + ".UpdateUnsaved"
	ConnectionDelete        = ConnectionInterface + ".Delete"
	ConnectionGetSettings   = ConnectionInterface + ".GetSettings"
	ConnectionGetSecrets    = ConnectionInterface + ".GetSecrets"
	ConnectionClearSecrets  = ConnectionInterface + ".ClearSecrets"
	ConnectionSave          = ConnectionInterface + ".Save"
	ConnectionUpdate2       = ConnectionInterface + ".Update2"

	/* Properties */
	ConnectionPropertyUnsaved  = ConnectionInterface + ".Unsaved"  // readable   b
	ConnectionPropertyFlags    = ConnectionInterface + ".Flags"    // readable   u
	ConnectionPropertyFilename = ConnectionInterface + ".Filename" // readable   s
)

//type ConnectionSettings map[string]map[string]interface{}
type ConnectionSettings map[string]map[string]interface{}

type Connection interface {
	GetPath() dbus.ObjectPath

	// Update the connection with new settings and properties (replacing all previous settings and properties) and save the connection to disk. Secrets may be part of the update request, and will be either stored in persistent storage or sent to a Secret Agent for storage, depending on the flags associated with each secret.
	Update(settings ConnectionSettings) error

	// UpdateUnsaved Update the connection with new settings and properties (replacing all previous settings and properties) but do not immediately save the connection to disk. Secrets may be part of the update request and may sent to a Secret Agent for storage, depending on the flags associated with each secret. Use the 'Save' method to save these changes to disk. Note that unsaved changes will be lost if the connection is reloaded from disk (either automatically on file change or due to an explicit ReloadConnections call).
	UpdateUnsaved(settings ConnectionSettings) error

	// Delete the connection.
	Delete() error

	// GetSettings gets the settings maps describing this network configuration.
	// This will never include any secrets required for connection to the
	// network, as those are often protected. Secrets must be requested
	// separately using the GetSecrets() method.
	GetSettings() (ConnectionSettings, error)

	// GetSecrets Get the secrets belonging to this network configuration. Only secrets from
	// persistent storage or a Secret Agent running in the requestor's session
	// will be returned. The user will never be prompted for secrets as a result
	// of this request.
	GetSecrets(settingName string) (ConnectionSettings, error)

	// ClearSecrets Clear the secrets belonging to this network connection profile.
	ClearSecrets() error

	// Save a "dirty" connection (that had previously been updated with UpdateUnsaved) to persistent storage.
	Save() error

	// GetPropertyUnsaved If set, indicates that the in-memory state of the connection does not match the on-disk state. This flag will be set when UpdateUnsaved() is called or when any connection details change, and cleared when the connection is saved to disk via Save() or from internal operations.
	GetPropertyUnsaved() (bool, error)

	// GetPropertyFlags Additional flags of the connection profile.
	GetPropertyFlags() (uint32, error)

	// GetPropertyFilename File that stores the connection in case the connection is file-backed.
	GetPropertyFilename() (string, error)

	MarshalJSON() ([]byte, error)
}

func NewConnection(objectPath dbus.ObjectPath) (Connection, error) {
	var c connection
	return &c, c.init(NetworkManagerInterface, objectPath)
}

type connection struct {
	dbusBase
}

func (c *connection) GetPath() dbus.ObjectPath {
	return c.obj.Path()
}

func (c *connection) Update(settings ConnectionSettings) error {
	return c.call(ConnectionUpdate, settings)
}

func (c *connection) UpdateUnsaved(settings ConnectionSettings) error {
	return c.call(ConnectionUpdateUnsaved, settings)
}

func (c *connection) Delete() error {
	return c.call(ConnectionDelete)
}

func (c *connection) GetSettings() (ConnectionSettings, error) {
	var settings map[string]map[string]dbus.Variant

	if err := c.callWithReturn(&settings, ConnectionGetSettings); err != nil {
		return nil, err
	}

	return decodeSettings(settings), nil
}

func (c *connection) GetSecrets(settingName string) (ConnectionSettings, error) {
	var settings map[string]map[string]dbus.Variant

	if err := c.callWithReturn(&settings, ConnectionGetSecrets, settingName); err != nil {
		return nil, err
	}

	return decodeSettings(settings), nil
}

func decodeSettings(input map[string]map[string]dbus.Variant) (settings ConnectionSettings) {
	valueMap := ConnectionSettings{}
	for key, data := range input {
		valueMap[key] = decode(data).(map[string]interface{})
	}
	return valueMap
}

func decode(input interface{}) (value interface{}) {
	if variant, isVariant := input.(dbus.Variant); isVariant {
		return decode(variant.Value())
	} else {

		if inputMap, isMap := input.(map[string]dbus.Variant); isMap {
			valueMap := map[string]interface{}{}
			for key, data := range inputMap {
				valueMap[key] = decode(data)
			}
			return valueMap
		} else if inputArray, isArray := input.([]interface{}); isArray {
			var valueArray []interface{}
			for _, data := range inputArray {
				valueArray = append(valueArray, decode(data))
			}
			return valueArray
		} else if inputArray, isArray := input.([]map[string]dbus.Variant); isArray {
			var valueArray []interface{}
			for _, data := range inputArray {
				valueArray = append(valueArray, decode(data))
			}
			return valueArray
		} else {
			return input
		}
	}
}

func (c *connection) ClearSecrets() error {
	return c.call(ConnectionClearSecrets)
}

func (c *connection) Save() error {
	return c.call(ConnectionSave)
}

func (c *connection) GetPropertyUnsaved() (bool, error) {
	return c.getBoolProperty(ConnectionPropertyUnsaved)
}

func (c *connection) GetPropertyFlags() (uint32, error) {
	return c.getUint32Property(ConnectionPropertyFlags)
}

func (c *connection) GetPropertyFilename() (string, error) {
	return c.getStringProperty(ConnectionPropertyFilename)
}

func (c *connection) MarshalJSON() ([]byte, error) {
	s, _ := c.GetSettings()
	return json.Marshal(s)
}