#!/usr/bin/python
from __future__ import absolute_import, division, print_function

# Copyright: (c) 2022 Fortinet
# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
#
# 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 3 of the License, or
# (at your option) any later version.

__metaclass__ = type

ANSIBLE_METADATA = {
    "status": ["preview"],
    "supported_by": "community",
    "metadata_version": "1.1",
}

DOCUMENTATION = """
---
module: fortios_vpn_ssl_client
short_description: Client in Fortinet's FortiOS and FortiGate.
description:
    - This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the
      user to set and modify vpn_ssl feature and client category.
      Examples include all parameters and values need to be adjusted to datasources before usage.
      Tested with FOS v6.0.0
version_added: "2.0.0"
author:
    - Link Zheng (@chillancezen)
    - Jie Xue (@JieX19)
    - Hongbin Lu (@fgtdev-hblu)
    - Frank Shen (@frankshen01)
    - Miguel Angel Munoz (@mamunozgonzalez)
    - Nicolas Thomas (@thomnico)
notes:
    - Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks


requirements:
    - ansible>=2.15
options:
    access_token:
        description:
            - Token-based authentication.
              Generated from GUI of Fortigate.
        type: str
        required: false
    enable_log:
        description:
            - Enable/Disable logging for task.
        type: bool
        required: false
        default: false
    vdom:
        description:
            - Virtual domain, among those defined previously. A vdom is a
              virtual instance of the FortiGate that can be configured and
              used as a different unit.
        type: str
        default: root
    member_path:
        type: str
        description:
            - Member attribute path to operate on.
            - Delimited by a slash character if there are more than one attribute.
            - Parameter marked with member_path is legitimate for doing member operation.
    member_state:
        type: str
        description:
            - Add or delete a member under specified attribute path.
            - When member_state is specified, the state option is ignored.
        choices:
            - 'present'
            - 'absent'

    state:
        description:
            - Indicates whether to create or remove the object.
        type: str
        required: true
        choices:
            - 'present'
            - 'absent'
    vpn_ssl_client:
        description:
            - Client.
        default: null
        type: dict
        suboptions:
            certificate:
                description:
                    - Certificate to offer to SSL-VPN server if it requests one. Source vpn.certificate.local.name.
                type: str
            class_id:
                description:
                    - Traffic class ID. Source firewall.traffic-class.class-id.
                type: int
            comment:
                description:
                    - Comment.
                type: str
            distance:
                description:
                    - Distance for routes added by SSL-VPN (1 - 255).
                type: int
            interface:
                description:
                    - SSL interface to send/receive traffic over. Source system.interface.name.
                type: str
            ipv4_subnets:
                description:
                    - IPv4 subnets that the client is protecting. Source firewall.address.name firewall.addrgrp.name.
                type: str
            ipv6_subnets:
                description:
                    - IPv6 subnets that the client is protecting. Source firewall.address6.name firewall.addrgrp6.name.
                type: str
            name:
                description:
                    - SSL-VPN tunnel name.
                required: true
                type: str
            peer:
                description:
                    - Authenticate peer"s certificate with the peer/peergrp. Source user.peer.name user.peergrp.name.
                type: str
            port:
                description:
                    - SSL-VPN server port.
                type: int
            priority:
                description:
                    - Priority for routes added by SSL-VPN (1 - 65535).
                type: int
            psk:
                description:
                    - Pre-shared secret to authenticate with the server (ASCII string or hexadecimal encoded with a leading 0x).
                type: str
            realm:
                description:
                    - Realm name configured on SSL-VPN server.
                type: str
            server:
                description:
                    - IPv4, IPv6 or DNS address of the SSL-VPN server.
                type: str
            source_ip:
                description:
                    - IPv4 or IPv6 address to use as a source for the SSL-VPN connection to the server.
                type: str
            status:
                description:
                    - Enable/disable this SSL-VPN client configuration.
                type: str
                choices:
                    - 'enable'
                    - 'disable'
            user:
                description:
                    - Username to offer to the peer to authenticate the client.
                type: str
"""

EXAMPLES = """
- name: Client.
  fortinet.fortios.fortios_vpn_ssl_client:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      vpn_ssl_client:
          certificate: "<your_own_value> (source vpn.certificate.local.name)"
          class_id: "0"
          comment: "Comment."
          distance: "10"
          interface: "<your_own_value> (source system.interface.name)"
          ipv4_subnets: "<your_own_value> (source firewall.address.name firewall.addrgrp.name)"
          ipv6_subnets: "<your_own_value> (source firewall.address6.name firewall.addrgrp6.name)"
          name: "default_name_10"
          peer: "<your_own_value> (source user.peer.name user.peergrp.name)"
          port: "443"
          priority: "1"
          psk: "<your_own_value>"
          realm: "<your_own_value>"
          server: "192.168.100.40"
          source_ip: "84.230.14.43"
          status: "enable"
          user: "<your_own_value>"
"""

RETURN = """
build:
  description: Build number of the fortigate image
  returned: always
  type: str
  sample: '1547'
http_method:
  description: Last method used to provision the content into FortiGate
  returned: always
  type: str
  sample: 'PUT'
http_status:
  description: Last result given by FortiGate on last operation applied
  returned: always
  type: str
  sample: "200"
mkey:
  description: Master key (id) used in the last call to FortiGate
  returned: success
  type: str
  sample: "id"
name:
  description: Name of the table used to fulfill the request
  returned: always
  type: str
  sample: "urlfilter"
path:
  description: Path of the table used to fulfill the request
  returned: always
  type: str
  sample: "webfilter"
revision:
  description: Internal revision number
  returned: always
  type: str
  sample: "17.0.2.10658"
serial:
  description: Serial number of the unit
  returned: always
  type: str
  sample: "FGVMEVYYQT3AB5352"
status:
  description: Indication of the operation's result
  returned: always
  type: str
  sample: "success"
vdom:
  description: Virtual domain used
  returned: always
  type: str
  sample: "root"
version:
  description: Version of the FortiGate
  returned: always
  type: str
  sample: "v5.6.3"
"""
from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.connection import Connection
from ansible_collections.fortinet.fortios.plugins.module_utils.fortios.fortios import (
    FortiOSHandler,
)
from ansible_collections.fortinet.fortios.plugins.module_utils.fortios.fortios import (
    check_legacy_fortiosapi,
)
from ansible_collections.fortinet.fortios.plugins.module_utils.fortios.fortios import (
    schema_to_module_spec,
)
from ansible_collections.fortinet.fortios.plugins.module_utils.fortios.fortios import (
    check_schema_versioning,
)
from ansible_collections.fortinet.fortios.plugins.module_utils.fortimanager.common import (
    FAIL_SOCKET_MSG,
)
from ansible_collections.fortinet.fortios.plugins.module_utils.fortios.data_post_processor import (
    remove_invalid_fields,
)


def filter_vpn_ssl_client_data(json):
    option_list = [
        "certificate",
        "class_id",
        "comment",
        "distance",
        "interface",
        "ipv4_subnets",
        "ipv6_subnets",
        "name",
        "peer",
        "port",
        "priority",
        "psk",
        "realm",
        "server",
        "source_ip",
        "status",
        "user",
    ]

    json = remove_invalid_fields(json)
    dictionary = {}

    for attribute in option_list:
        if attribute in json and json[attribute] is not None:
            dictionary[attribute] = json[attribute]

    return dictionary


def underscore_to_hyphen(data):
    if isinstance(data, list):
        for i, elem in enumerate(data):
            data[i] = underscore_to_hyphen(elem)
    elif isinstance(data, dict):
        new_data = {}
        for k, v in data.items():
            new_data[k.replace("_", "-")] = underscore_to_hyphen(v)
        data = new_data

    return data


def vpn_ssl_client(data, fos):
    state = None
    vdom = data["vdom"]

    state = data["state"]

    vpn_ssl_client_data = data["vpn_ssl_client"]

    filtered_data = filter_vpn_ssl_client_data(vpn_ssl_client_data)
    converted_data = underscore_to_hyphen(filtered_data)

    # pass post processed data to member operations
    data_copy = data.copy()
    data_copy["vpn_ssl_client"] = converted_data
    fos.do_member_operation(
        "vpn.ssl",
        "client",
        data_copy,
    )

    if state == "present" or state is True:
        return fos.set("vpn.ssl", "client", data=converted_data, vdom=vdom)

    elif state == "absent":
        return fos.delete("vpn.ssl", "client", mkey=converted_data["name"], vdom=vdom)
    else:
        fos._module.fail_json(msg="state must be present or absent!")


def is_successful_status(resp):
    return (
        "status" in resp
        and resp["status"] == "success"
        or "http_status" in resp
        and resp["http_status"] == 200
        or "http_method" in resp
        and resp["http_method"] == "DELETE"
        and resp["http_status"] == 404
    )


def fortios_vpn_ssl(data, fos):
    if data["vpn_ssl_client"]:
        resp = vpn_ssl_client(data, fos)
    else:
        fos._module.fail_json(msg="missing task body: %s" % ("vpn_ssl_client"))

    return (
        not is_successful_status(resp),
        is_successful_status(resp)
        and (resp["revision_changed"] if "revision_changed" in resp else True),
        resp,
        {},
    )


versioned_schema = {
    "type": "list",
    "elements": "dict",
    "children": {
        "name": {"v_range": [["v7.0.0", ""]], "type": "string", "required": True},
        "comment": {"v_range": [["v7.0.0", ""]], "type": "string"},
        "interface": {"v_range": [["v7.0.0", ""]], "type": "string"},
        "user": {"v_range": [["v7.0.0", ""]], "type": "string"},
        "psk": {"v_range": [["v7.0.0", ""]], "type": "string"},
        "peer": {"v_range": [["v7.0.0", ""]], "type": "string"},
        "server": {"v_range": [["v7.0.0", ""]], "type": "string"},
        "port": {"v_range": [["v7.0.0", ""]], "type": "integer"},
        "realm": {"v_range": [["v7.0.1", ""]], "type": "string"},
        "status": {
            "v_range": [["v7.0.0", ""]],
            "type": "string",
            "options": [{"value": "enable"}, {"value": "disable"}],
        },
        "certificate": {"v_range": [["v7.0.0", ""]], "type": "string"},
        "source_ip": {"v_range": [["v7.0.0", ""]], "type": "string"},
        "distance": {"v_range": [["v7.0.0", ""]], "type": "integer"},
        "priority": {"v_range": [["v7.0.0", ""]], "type": "integer"},
        "class_id": {"v_range": [["v7.2.0", ""]], "type": "integer"},
        "ipv4_subnets": {"v_range": [["v7.2.4", ""]], "type": "string"},
        "ipv6_subnets": {"v_range": [["v7.2.4", ""]], "type": "string"},
    },
    "v_range": [["v7.0.0", ""]],
}


def main():
    module_spec = schema_to_module_spec(versioned_schema)
    mkeyname = "name"
    fields = {
        "access_token": {"required": False, "type": "str", "no_log": True},
        "enable_log": {"required": False, "type": "bool", "default": False},
        "vdom": {"required": False, "type": "str", "default": "root"},
        "member_path": {"required": False, "type": "str"},
        "member_state": {
            "type": "str",
            "required": False,
            "choices": ["present", "absent"],
        },
        "state": {"required": True, "type": "str", "choices": ["present", "absent"]},
        "vpn_ssl_client": {
            "required": False,
            "type": "dict",
            "default": None,
            "options": {},
        },
    }
    for attribute_name in module_spec["options"]:
        fields["vpn_ssl_client"]["options"][attribute_name] = module_spec["options"][
            attribute_name
        ]
        if mkeyname and mkeyname == attribute_name:
            fields["vpn_ssl_client"]["options"][attribute_name]["required"] = True

    module = AnsibleModule(argument_spec=fields, supports_check_mode=False)
    check_legacy_fortiosapi(module)

    is_error = False
    has_changed = False
    result = None
    diff = None

    versions_check_result = None
    if module._socket_path:
        connection = Connection(module._socket_path)
        if "access_token" in module.params:
            connection.set_custom_option("access_token", module.params["access_token"])

        if "enable_log" in module.params:
            connection.set_custom_option("enable_log", module.params["enable_log"])
        else:
            connection.set_custom_option("enable_log", False)
        fos = FortiOSHandler(connection, module, mkeyname)
        versions_check_result = check_schema_versioning(
            fos, versioned_schema, "vpn_ssl_client"
        )

        is_error, has_changed, result, diff = fortios_vpn_ssl(module.params, fos)

    else:
        module.fail_json(**FAIL_SOCKET_MSG)

    if versions_check_result and versions_check_result["matched"] is False:
        module.warn(
            "Ansible has detected version mismatch between FortOS system and your playbook, see more details by specifying option -vvv"
        )

    if not is_error:
        if versions_check_result and versions_check_result["matched"] is False:
            module.exit_json(
                changed=has_changed,
                version_check_warning=versions_check_result,
                meta=result,
                diff=diff,
            )
        else:
            module.exit_json(changed=has_changed, meta=result, diff=diff)
    else:
        if versions_check_result and versions_check_result["matched"] is False:
            module.fail_json(
                msg="Error in repo",
                version_check_warning=versions_check_result,
                meta=result,
            )
        else:
            module.fail_json(msg="Error in repo", meta=result)


if __name__ == "__main__":
    main()
