/* SPDX-License-Identifier: LGPL-2.1+ */

/*

 * Copyright (C) 2011 - 2013 Red Hat, Inc.

 */

#include "nm-default.h"

#include "nm-setting-adsl.h"

#include "nm-setting-ppp.h"

#include "nm-setting-private.h"

#include "nm-utils.h"

#include "nm-core-enum-types.h"

/**

 * SECTION:nm-setting-adsl

 * @short_description: Describes ADSL-based properties

 *

 * The #NMSettingAdsl object is a #NMSetting subclass that describes

 * properties of ADSL connections.

 */

/*****************************************************************************/

NM_GOBJECT_PROPERTIES_DEFINE_BASE(PROP_USERNAME,

                                  PROP_PASSWORD,

                                  PROP_PASSWORD_FLAGS,

                                  PROP_PROTOCOL,

                                  PROP_ENCAPSULATION,

                                  PROP_VPI,

                                  PROP_VCI, );

typedef struct {

    char *               username;

    char *               password;

    NMSettingSecretFlags password_flags;

    char *               protocol;

    char *               encapsulation;

    guint32              vpi;

    guint32              vci;

} NMSettingAdslPrivate;

G_DEFINE_TYPE(NMSettingAdsl, nm_setting_adsl, NM_TYPE_SETTING)

#define NM_SETTING_ADSL_GET_PRIVATE(o) \

    (G_TYPE_INSTANCE_GET_PRIVATE((o), NM_TYPE_SETTING_ADSL, NMSettingAdslPrivate))

/*****************************************************************************/

/**

 * nm_setting_adsl_get_username:

 * @setting: the #NMSettingAdsl

 *

 * Returns: the #NMSettingAdsl:username property of the setting

 **/

const char *

nm_setting_adsl_get_username(NMSettingAdsl *setting)

{

    g_return_val_if_fail(NM_IS_SETTING_ADSL(setting), NULL);

    return NM_SETTING_ADSL_GET_PRIVATE(setting)->username;

}

/**

 * nm_setting_adsl_get_password:

 * @setting: the #NMSettingAdsl

 *

 * Returns: the #NMSettingAdsl:password property of the setting

 **/

const char *

nm_setting_adsl_get_password(NMSettingAdsl *setting)

{

    g_return_val_if_fail(NM_IS_SETTING_ADSL(setting), NULL);

    return NM_SETTING_ADSL_GET_PRIVATE(setting)->password;

}

/**

 * nm_setting_adsl_get_password_flags:

 * @setting: the #NMSettingAdsl

 *

 * Returns: the #NMSettingSecretFlags pertaining to the #NMSettingAdsl:password

 **/

NMSettingSecretFlags

nm_setting_adsl_get_password_flags(NMSettingAdsl *setting)

{

    g_return_val_if_fail(NM_IS_SETTING_ADSL(setting), NM_SETTING_SECRET_FLAG_NONE);

    return NM_SETTING_ADSL_GET_PRIVATE(setting)->password_flags;

}

/**

 * nm_setting_adsl_get_protocol:

 * @setting: the #NMSettingAdsl

 *

 * Returns: the #NMSettingAdsl:protocol property of the setting

 **/

const char *

nm_setting_adsl_get_protocol(NMSettingAdsl *setting)

{

    g_return_val_if_fail(NM_IS_SETTING_ADSL(setting), NULL);

    return NM_SETTING_ADSL_GET_PRIVATE(setting)->protocol;

}

/**

 * nm_setting_adsl_get_encapsulation:

 * @setting: the #NMSettingAdsl

 *

 * Returns: the #NMSettingAdsl:encapsulation property of the setting

 **/

const char *

nm_setting_adsl_get_encapsulation(NMSettingAdsl *setting)

{

    g_return_val_if_fail(NM_IS_SETTING_ADSL(setting), NULL);

    return NM_SETTING_ADSL_GET_PRIVATE(setting)->encapsulation;

}

/**

 * nm_setting_adsl_get_vpi:

 * @setting: the #NMSettingAdsl

 *

 * Returns: the #NMSettingAdsl:vpi property of the setting

 **/

guint32

nm_setting_adsl_get_vpi(NMSettingAdsl *setting)

{

    g_return_val_if_fail(NM_IS_SETTING_ADSL(setting), 0);

    return NM_SETTING_ADSL_GET_PRIVATE(setting)->vpi;

}

/**

 * nm_setting_adsl_get_vci:

 * @setting: the #NMSettingAdsl

 *

 * Returns: the #NMSettingAdsl:vci property of the setting

 **/

guint32

nm_setting_adsl_get_vci(NMSettingAdsl *setting)

{

    g_return_val_if_fail(NM_IS_SETTING_ADSL(setting), 0);

    return NM_SETTING_ADSL_GET_PRIVATE(setting)->vci;

}

static gboolean

verify(NMSetting *setting, NMConnection *connection, GError **error)

{

    NMSettingAdslPrivate *priv = NM_SETTING_ADSL_GET_PRIVATE(setting);

    if (!priv->username) {

        g_set_error_literal(error,

                            NM_CONNECTION_ERROR,

                            NM_CONNECTION_ERROR_MISSING_PROPERTY,

                            _("property is missing"));

        g_prefix_error(error, "%s.%s: ", NM_SETTING_ADSL_SETTING_NAME, NM_SETTING_ADSL_USERNAME);

        return FALSE;

    }

    if (!priv->username[0]) {

        g_set_error_literal(error,

                            NM_CONNECTION_ERROR,

                            NM_CONNECTION_ERROR_INVALID_PROPERTY,

                            _("property is empty"));

        g_prefix_error(error, "%s.%s: ", NM_SETTING_ADSL_SETTING_NAME, NM_SETTING_ADSL_USERNAME);

        return FALSE;

    }

    if (!NM_IN_STRSET(priv->protocol,

                      NM_SETTING_ADSL_PROTOCOL_PPPOA,

                      NM_SETTING_ADSL_PROTOCOL_PPPOE,

                      NM_SETTING_ADSL_PROTOCOL_IPOATM)) {

        g_set_error(error,

                    NM_CONNECTION_ERROR,

                    NM_CONNECTION_ERROR_INVALID_PROPERTY,

                    _("'%s' is not a valid value for the property"),

                    priv->protocol ?: "(null)");

        g_prefix_error(error, "%s.%s: ", NM_SETTING_ADSL_SETTING_NAME, NM_SETTING_ADSL_PROTOCOL);

        return FALSE;

    }

    if (!NM_IN_STRSET(priv->encapsulation,

                      NULL,

                      NM_SETTING_ADSL_ENCAPSULATION_VCMUX,

                      NM_SETTING_ADSL_ENCAPSULATION_LLC)) {

        g_set_error(error,

                    NM_CONNECTION_ERROR,

                    NM_CONNECTION_ERROR_INVALID_PROPERTY,

                    _("'%s' is not a valid value for the property"),

                    priv->encapsulation);

        g_prefix_error(error,

                       "%s.%s: ",

                       NM_SETTING_ADSL_SETTING_NAME,

                       NM_SETTING_ADSL_ENCAPSULATION);

        return FALSE;

    }

    return TRUE;

}

static gboolean

verify_secrets(NMSetting *setting, NMConnection *connection, GError **error)

{

    return _nm_setting_verify_secret_string(NM_SETTING_ADSL_GET_PRIVATE(setting)->password,

                                            NM_SETTING_ADSL_SETTING_NAME,

                                            NM_SETTING_ADSL_PASSWORD,

                                            error);

}

static GPtrArray *

need_secrets(NMSetting *setting)

{

    NMSettingAdslPrivate *priv    = NM_SETTING_ADSL_GET_PRIVATE(setting);

    GPtrArray *           secrets = NULL;

    if (priv->password && *priv->password)

        return NULL;

    if (!(priv->password_flags & NM_SETTING_SECRET_FLAG_NOT_REQUIRED)) {

        secrets = g_ptr_array_sized_new(1);

        g_ptr_array_add(secrets, NM_SETTING_ADSL_PASSWORD);

    }

    return secrets;

}

/*****************************************************************************/

static void

get_property(GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)

{

    NMSettingAdsl *setting = NM_SETTING_ADSL(object);

    switch (prop_id) {

    case PROP_USERNAME:

        g_value_set_string(value, nm_setting_adsl_get_username(setting));

        break;

    case PROP_PASSWORD:

        g_value_set_string(value, nm_setting_adsl_get_password(setting));

        break;

    case PROP_PASSWORD_FLAGS:

        g_value_set_flags(value, nm_setting_adsl_get_password_flags(setting));

        break;

    case PROP_PROTOCOL:

        g_value_set_string(value, nm_setting_adsl_get_protocol(setting));

        break;

    case PROP_ENCAPSULATION:

        g_value_set_string(value, nm_setting_adsl_get_encapsulation(setting));

        break;

    case PROP_VPI:

        g_value_set_uint(value, nm_setting_adsl_get_vpi(setting));

        break;

    case PROP_VCI:

        g_value_set_uint(value, nm_setting_adsl_get_vci(setting));

        break;

    default:

        G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);

        break;

    }

}

static void

set_property(GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)

{

    NMSettingAdslPrivate *priv = NM_SETTING_ADSL_GET_PRIVATE(object);

    const char *          str;

    switch (prop_id) {

    case PROP_USERNAME:

        g_free(priv->username);

        priv->username = g_value_dup_string(value);

        break;

    case PROP_PASSWORD:

        g_free(priv->password);

        priv->password = g_value_dup_string(value);

        break;

    case PROP_PASSWORD_FLAGS:

        priv->password_flags = g_value_get_flags(value);

        break;

    case PROP_PROTOCOL:

        g_free(priv->protocol);

        str            = g_value_get_string(value);

        priv->protocol = str ? g_ascii_strdown(str, -1) : NULL;

        break;

    case PROP_ENCAPSULATION:

        g_free(priv->encapsulation);

        str                 = g_value_get_string(value);

        priv->encapsulation = str ? g_ascii_strdown(str, -1) : NULL;

        break;

    case PROP_VPI:

        priv->vpi = g_value_get_uint(value);

        break;

    case PROP_VCI:

        priv->vci = g_value_get_uint(value);

        break;

    default:

        G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);

        break;

    }

}

/*****************************************************************************/

static void

nm_setting_adsl_init(NMSettingAdsl *setting)

{}

/**

 * nm_setting_adsl_new:

 *

 * Creates a new #NMSettingAdsl object with default values.

 *

 * Returns: the new empty #NMSettingAdsl object

 **/

NMSetting *

nm_setting_adsl_new(void)

{

    return g_object_new(NM_TYPE_SETTING_ADSL, NULL);

}

static void

finalize(GObject *object)

{

    NMSettingAdslPrivate *priv = NM_SETTING_ADSL_GET_PRIVATE(object);

    g_free(priv->username);

    g_free(priv->password);

    g_free(priv->protocol);

    g_free(priv->encapsulation);

    G_OBJECT_CLASS(nm_setting_adsl_parent_class)->finalize(object);

}

static void

nm_setting_adsl_class_init(NMSettingAdslClass *klass)

{

    GObjectClass *  object_class  = G_OBJECT_CLASS(klass);

    NMSettingClass *setting_class = NM_SETTING_CLASS(klass);

    g_type_class_add_private(klass, sizeof(NMSettingAdslPrivate));

    object_class->get_property = get_property;

    object_class->set_property = set_property;

    object_class->finalize     = finalize;

    setting_class->verify         = verify;

    setting_class->verify_secrets = verify_secrets;

    setting_class->need_secrets   = need_secrets;

    /**

     * NMSettingAdsl:username:

     *

     * Username used to authenticate with the ADSL service.

     **/

    obj_properties[PROP_USERNAME] = g_param_spec_string(NM_SETTING_ADSL_USERNAME,

                                                        "",

                                                        "",

                                                        NULL,

                                                        G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);

    /**

     * NMSettingAdsl:password:

     *

     * Password used to authenticate with the ADSL service.

     **/

    obj_properties[PROP_PASSWORD] =

        g_param_spec_string(NM_SETTING_ADSL_PASSWORD,

                            "",

                            "",

                            NULL,

                            G_PARAM_READWRITE | NM_SETTING_PARAM_SECRET | G_PARAM_STATIC_STRINGS);

    /**

     * NMSettingAdsl:password-flags:

     *

     * Flags indicating how to handle the #NMSettingAdsl:password property.

     **/

    obj_properties[PROP_PASSWORD_FLAGS] =

        g_param_spec_flags(NM_SETTING_ADSL_PASSWORD_FLAGS,

                           "",

                           "",

                           NM_TYPE_SETTING_SECRET_FLAGS,

                           NM_SETTING_SECRET_FLAG_NONE,

                           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);

    /**

     * NMSettingAdsl:protocol:

     *

     * ADSL connection protocol.  Can be "pppoa", "pppoe" or "ipoatm".

     **/

    obj_properties[PROP_PROTOCOL] = g_param_spec_string(NM_SETTING_ADSL_PROTOCOL,

                                                        "",

                                                        "",

                                                        NULL,

                                                        G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);

    /**

     * NMSettingAdsl:encapsulation:

     *

     * Encapsulation of ADSL connection.  Can be "vcmux" or "llc".

     **/

    obj_properties[PROP_ENCAPSULATION] =

        g_param_spec_string(NM_SETTING_ADSL_ENCAPSULATION,

                            "",

                            "",

                            NULL,

                            G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);

    /**

     * NMSettingAdsl:vpi:

     *

     * VPI of ADSL connection

     **/

    obj_properties[PROP_VPI] = g_param_spec_uint(NM_SETTING_ADSL_VPI,

                                                 "",

                                                 "",

                                                 0,

                                                 65536,

                                                 0,

                                                 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);

    /**

     * NMSettingAdsl:vci:

     *

     * VCI of ADSL connection

     **/

    obj_properties[PROP_VCI] = g_param_spec_uint(NM_SETTING_ADSL_VCI,

                                                 "",

                                                 "",

                                                 0,

                                                 65536,

                                                 0,

                                                 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);

    g_object_class_install_properties(object_class, _PROPERTY_ENUMS_LAST, obj_properties);

    _nm_setting_class_commit(setting_class, NM_META_SETTING_TYPE_ADSL);

}