#!/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_switch_controller_traffic_sniffer
short_description: Configure FortiSwitch RSPAN/ERSPAN traffic sniffing parameters 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 switch_controller feature and traffic_sniffer 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.14
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'

    switch_controller_traffic_sniffer:
        description:
            - Configure FortiSwitch RSPAN/ERSPAN traffic sniffing parameters.
        default: null
        type: dict
        suboptions:
            erspan_ip:
                description:
                    - Configure ERSPAN collector IP address.
                type: str
            mode:
                description:
                    - Configure traffic sniffer mode.
                type: str
                choices:
                    - 'erspan-auto'
                    - 'rspan'
                    - 'none'
            target_ip:
                description:
                    - Sniffer IPs to filter.
                type: list
                elements: dict
                suboptions:
                    description:
                        description:
                            - Description for the sniffer IP.
                        type: str
                    dst_entry_id:
                        description:
                            - FortiSwitch dest entry ID for the sniffer IP.
                        type: int
                    ip:
                        description:
                            - Sniffer IP.
                        required: true
                        type: str
                    src_entry_id:
                        description:
                            - FortiSwitch source entry ID for the sniffer IP.
                        type: int
            target_mac:
                description:
                    - Sniffer MACs to filter.
                type: list
                elements: dict
                suboptions:
                    description:
                        description:
                            - Description for the sniffer MAC.
                        type: str
                    dst_entry_id:
                        description:
                            - FortiSwitch dest entry ID for the sniffer MAC.
                        type: int
                    mac:
                        description:
                            - Sniffer MAC.
                        required: true
                        type: str
                    src_entry_id:
                        description:
                            - FortiSwitch source entry ID for the sniffer MAC.
                        type: int
            target_port:
                description:
                    - Sniffer ports to filter.
                type: list
                elements: dict
                suboptions:
                    description:
                        description:
                            - Description for the sniffer port entry.
                        type: str
                    in_ports:
                        description:
                            - Configure source ingress port interfaces.
                        type: list
                        elements: dict
                        suboptions:
                            name:
                                description:
                                    - Interface name.
                                required: true
                                type: str
                    out_ports:
                        description:
                            - Configure source egress port interfaces.
                        type: list
                        elements: dict
                        suboptions:
                            name:
                                description:
                                    - Interface name.
                                required: true
                                type: str
                    switch_id:
                        description:
                            - Managed-switch ID. Source switch-controller.managed-switch.switch-id.
                        required: true
                        type: str
"""

EXAMPLES = """
- name: Configure FortiSwitch RSPAN/ERSPAN traffic sniffing parameters.
  fortinet.fortios.fortios_switch_controller_traffic_sniffer:
      vdom: "{{ vdom }}"
      switch_controller_traffic_sniffer:
          erspan_ip: "<your_own_value>"
          mode: "erspan-auto"
          target_ip:
              -
                  description: "<your_own_value>"
                  dst_entry_id: "2147483647"
                  ip: "<your_own_value>"
                  src_entry_id: "2147483647"
          target_mac:
              -
                  description: "<your_own_value>"
                  dst_entry_id: "2147483647"
                  mac: "<your_own_value>"
                  src_entry_id: "2147483647"
          target_port:
              -
                  description: "<your_own_value>"
                  in_ports:
                      -
                          name: "default_name_18"
                  out_ports:
                      -
                          name: "default_name_20"
                  switch_id: "<your_own_value> (source switch-controller.managed-switch.switch-id)"
"""

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_switch_controller_traffic_sniffer_data(json):
    option_list = ["erspan_ip", "mode", "target_ip", "target_mac", "target_port"]

    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 switch_controller_traffic_sniffer(data, fos):
    vdom = data["vdom"]
    switch_controller_traffic_sniffer_data = data["switch_controller_traffic_sniffer"]
    filtered_data = underscore_to_hyphen(
        filter_switch_controller_traffic_sniffer_data(
            switch_controller_traffic_sniffer_data
        )
    )

    return fos.set(
        "switch-controller", "traffic-sniffer", data=filtered_data, vdom=vdom
    )


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_switch_controller(data, fos):
    fos.do_member_operation("switch-controller", "traffic-sniffer")
    if data["switch_controller_traffic_sniffer"]:
        resp = switch_controller_traffic_sniffer(data, fos)
    else:
        fos._module.fail_json(
            msg="missing task body: %s" % ("switch_controller_traffic_sniffer")
        )

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


versioned_schema = {
    "v_range": [["v6.2.0", ""]],
    "type": "dict",
    "children": {
        "mode": {
            "v_range": [["v6.2.0", ""]],
            "type": "string",
            "options": [
                {"value": "erspan-auto"},
                {"value": "rspan"},
                {"value": "none"},
            ],
        },
        "erspan_ip": {"v_range": [["v6.2.0", ""]], "type": "string"},
        "target_mac": {
            "type": "list",
            "elements": "dict",
            "children": {
                "mac": {
                    "v_range": [["v6.2.0", ""]],
                    "type": "string",
                    "required": True,
                },
                "description": {"v_range": [["v6.2.0", ""]], "type": "string"},
                "src_entry_id": {"v_range": [["v6.2.3", "v6.2.3"]], "type": "integer"},
                "dst_entry_id": {"v_range": [["v6.2.3", "v6.2.3"]], "type": "integer"},
            },
            "v_range": [["v6.2.0", ""]],
        },
        "target_ip": {
            "type": "list",
            "elements": "dict",
            "children": {
                "ip": {"v_range": [["v6.2.0", ""]], "type": "string", "required": True},
                "description": {"v_range": [["v6.2.0", ""]], "type": "string"},
                "src_entry_id": {"v_range": [["v6.2.3", "v6.2.3"]], "type": "integer"},
                "dst_entry_id": {"v_range": [["v6.2.3", "v6.2.3"]], "type": "integer"},
            },
            "v_range": [["v6.2.0", ""]],
        },
        "target_port": {
            "type": "list",
            "elements": "dict",
            "children": {
                "switch_id": {
                    "v_range": [["v6.2.0", ""]],
                    "type": "string",
                    "required": True,
                },
                "description": {"v_range": [["v6.2.0", ""]], "type": "string"},
                "in_ports": {
                    "type": "list",
                    "elements": "dict",
                    "children": {
                        "name": {
                            "v_range": [["v6.2.0", ""]],
                            "type": "string",
                            "required": True,
                        }
                    },
                    "v_range": [["v6.2.0", ""]],
                },
                "out_ports": {
                    "type": "list",
                    "elements": "dict",
                    "children": {
                        "name": {
                            "v_range": [["v6.2.0", ""]],
                            "type": "string",
                            "required": True,
                        }
                    },
                    "v_range": [["v6.2.0", ""]],
                },
            },
            "v_range": [["v6.2.0", ""]],
        },
    },
}


def main():
    module_spec = schema_to_module_spec(versioned_schema)
    mkeyname = None
    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"],
        },
        "switch_controller_traffic_sniffer": {
            "required": False,
            "type": "dict",
            "default": None,
            "options": {},
        },
    }
    for attribute_name in module_spec["options"]:
        fields["switch_controller_traffic_sniffer"]["options"][
            attribute_name
        ] = module_spec["options"][attribute_name]
        if mkeyname and mkeyname == attribute_name:
            fields["switch_controller_traffic_sniffer"]["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_option("access_token", module.params["access_token"])

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

        is_error, has_changed, result, diff = fortios_switch_controller(
            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()
