#!/usr/bin/python
from __future__ import absolute_import, division, print_function
# Copyright 2019-2024 Fortinet, Inc.
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

__metaclass__ = type

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

DOCUMENTATION = '''
---
module: fmgr_dlp_profile
short_description: Configure DLP profiles.
description:
    - This module is able to configure a FortiManager device.
    - Examples include all parameters and values which need to be adjusted to data sources before usage.

version_added: "2.1.0"
author:
    - Xinwei Du (@dux-fortinet)
    - Xing Li (@lix-fortinet)
    - Jie Xue (@JieX19)
    - Link Zheng (@chillancezen)
    - Frank Shen (@fshen01)
    - Hongbin Lu (@fgtdev-hblu)
notes:
    - Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case).
      Please change the arguments such as "var-name" to "var_name".
      Old argument names are still available yet you will receive deprecation warnings.
      You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
    - Running in workspace locking mode is supported in this FortiManager module, the top
      level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
    - To create or update an object, use state present directive.
    - To delete an object, use state absent directive.
    - Normally, running one module can fail when a non-zero rc is returned. you can also override
      the conditions to fail or succeed with parameters rc_failed and rc_succeeded
options:
    access_token:
        description: The token to access FortiManager without using username and password.
        type: str
    bypass_validation:
        description: Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters.
        type: bool
        default: false
    enable_log:
        description: Enable/Disable logging for task.
        type: bool
        default: false
    forticloud_access_token:
        description: Authenticate Ansible client with forticloud API access token.
        type: str
    proposed_method:
        description: The overridden method for the underlying Json RPC request.
        type: str
        choices:
          - update
          - set
          - add
    rc_succeeded:
        description: The rc codes list with which the conditions to succeed will be overriden.
        type: list
        elements: int
    rc_failed:
        description: The rc codes list with which the conditions to fail will be overriden.
        type: list
        elements: int
    state:
        description: The directive to create, update or delete an object.
        type: str
        required: true
        choices:
          - present
          - absent
    workspace_locking_adom:
        description: The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.
        type: str
    workspace_locking_timeout:
        description: The maximum time in seconds to wait for other user to release the workspace lock.
        type: int
        default: 300
    adom:
        description: The parameter (adom) in requested url.
        type: str
        required: true
    dlp_profile:
        description: The top level parameters set.
        required: false
        type: dict
        suboptions:
            comment:
                type: str
                description: Comment.
            dlp_log:
                aliases: ['dlp-log']
                type: str
                description: Enable/disable DLP logging.
                choices:
                    - 'disable'
                    - 'enable'
            extended_log:
                aliases: ['extended-log']
                type: str
                description: Enable/disable extended logging for data leak prevention.
                choices:
                    - 'disable'
                    - 'enable'
            feature_set:
                aliases: ['feature-set']
                type: str
                description: Flow/proxy feature set.
                choices:
                    - 'flow'
                    - 'proxy'
            full_archive_proto:
                aliases: ['full-archive-proto']
                type: list
                elements: str
                description: Protocols to always content archive.
                choices:
                    - 'smtp'
                    - 'pop3'
                    - 'imap'
                    - 'http-post'
                    - 'http-get'
                    - 'ftp'
                    - 'nntp'
                    - 'mapi'
                    - 'ssh'
                    - 'cifs'
            nac_quar_log:
                aliases: ['nac-quar-log']
                type: str
                description: Enable/disable NAC quarantine logging.
                choices:
                    - 'disable'
                    - 'enable'
            name:
                type: str
                description: Name of the DLP profile.
                required: true
            replacemsg_group:
                aliases: ['replacemsg-group']
                type: str
                description: Replacement message group used by this DLP profile.
            rule:
                type: list
                elements: dict
                description: Rule.
                suboptions:
                    action:
                        type: str
                        description: Action to take with content that this DLP profile matches.
                        choices:
                            - 'log-only'
                            - 'block'
                            - 'quarantine-ip'
                            - 'allow'
                    archive:
                        type: str
                        description: Enable/disable DLP archiving.
                        choices:
                            - 'disable'
                            - 'enable'
                    expiry:
                        type: str
                        description: Quarantine duration in days, hours, minutes
                    file_size:
                        aliases: ['file-size']
                        type: int
                        description: Match files this size or larger
                    file_type:
                        aliases: ['file-type']
                        type: str
                        description: Select the number of a DLP file pattern table to match.
                    filter_by:
                        aliases: ['filter-by']
                        type: str
                        description: Select the type of content to match.
                        choices:
                            - 'fingerprint'
                            - 'sensor'
                            - 'encrypted'
                            - 'none'
                            - 'mip'
                    id:
                        type: int
                        description: ID.
                    label:
                        type: str
                        description: MIP label dictionary.
                    match_percentage:
                        aliases: ['match-percentage']
                        type: int
                        description: Percentage of fingerprints in the fingerprint databases designated with the selected sensitivity to match.
                    name:
                        type: str
                        description: Filter name.
                    proto:
                        type: list
                        elements: str
                        description: Check messages or files over one or more of these protocols.
                        choices:
                            - 'smtp'
                            - 'pop3'
                            - 'imap'
                            - 'http-post'
                            - 'http-get'
                            - 'ftp'
                            - 'nntp'
                            - 'mapi'
                            - 'ssh'
                            - 'cifs'
                    sensitivity:
                        type: raw
                        description: (list) Select a DLP file pattern sensitivity to match.
                    sensor:
                        type: raw
                        description: (list) Select DLP sensors.
                    severity:
                        type: str
                        description: Select the severity or threat level that matches this filter.
                        choices:
                            - 'info'
                            - 'low'
                            - 'medium'
                            - 'high'
                            - 'critical'
                    type:
                        type: str
                        description: Select whether to check the content of messages
                        choices:
                            - 'file'
                            - 'message'
            summary_proto:
                aliases: ['summary-proto']
                type: list
                elements: str
                description: Protocols to always log summary.
                choices:
                    - 'smtp'
                    - 'pop3'
                    - 'imap'
                    - 'http-post'
                    - 'http-get'
                    - 'ftp'
                    - 'nntp'
                    - 'mapi'
                    - 'ssh'
                    - 'cifs'
'''

EXAMPLES = '''
- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure DLP profiles.
      fortinet.fortimanager.fmgr_dlp_profile:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: present # <value in [present, absent]>
        dlp_profile:
          name: "your value" # Required variable, string
          # comment: <string>
          # dlp_log: <value in [disable, enable]>
          # extended_log: <value in [disable, enable]>
          # feature_set: <value in [flow, proxy]>
          # full_archive_proto:
          #   - "smtp"
          #   - "pop3"
          #   - "imap"
          #   - "http-post"
          #   - "http-get"
          #   - "ftp"
          #   - "nntp"
          #   - "mapi"
          #   - "ssh"
          #   - "cifs"
          # nac_quar_log: <value in [disable, enable]>
          # replacemsg_group: <string>
          # rule:
          #   - action: <value in [log-only, block, quarantine-ip, ...]>
          #     archive: <value in [disable, enable]>
          #     expiry: <string>
          #     file_size: <integer>
          #     file_type: <string>
          #     filter_by: <value in [fingerprint, sensor, encrypted, ...]>
          #     id: <integer>
          #     label: <string>
          #     match_percentage: <integer>
          #     name: <string>
          #     proto:
          #       - "smtp"
          #       - "pop3"
          #       - "imap"
          #       - "http-post"
          #       - "http-get"
          #       - "ftp"
          #       - "nntp"
          #       - "mapi"
          #       - "ssh"
          #       - "cifs"
          #     sensitivity: <list or string>
          #     sensor: <list or string>
          #     severity: <value in [info, low, medium, ...]>
          #     type: <value in [file, message]>
          # summary_proto:
          #   - "smtp"
          #   - "pop3"
          #   - "imap"
          #   - "http-post"
          #   - "http-get"
          #   - "ftp"
          #   - "nntp"
          #   - "mapi"
          #   - "ssh"
          #   - "cifs"
'''

RETURN = '''
meta:
    description: The result of the request.
    type: dict
    returned: always
    contains:
        request_url:
            description: The full url requested.
            returned: always
            type: str
            sample: /sys/login/user
        response_code:
            description: The status of api request.
            returned: always
            type: int
            sample: 0
        response_data:
            description: The api response.
            type: list
            returned: always
        response_message:
            description: The descriptive message of the api response.
            type: str
            returned: always
            sample: OK.
        system_information:
            description: The information of the target system.
            type: dict
            returned: always
rc:
    description: The status the request.
    type: int
    returned: always
    sample: 0
version_check_warning:
    description: Warning if the parameters used in the playbook are not supported by the current FortiManager version.
    type: list
    returned: complex
'''
from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.connection import Connection
from ansible_collections.fortinet.fortimanager.plugins.module_utils.napi import NAPIManager, check_galaxy_version, check_parameter_bypass
from ansible_collections.fortinet.fortimanager.plugins.module_utils.common import get_module_arg_spec


def main():
    urls_list = [
        '/pm/config/adom/{adom}/obj/dlp/profile',
        '/pm/config/global/obj/dlp/profile'
    ]
    url_params = ['adom']
    module_primary_key = 'name'
    module_arg_spec = {
        'adom': {'required': True, 'type': 'str'},
        'dlp_profile': {
            'type': 'dict',
            'v_range': [['7.2.0', '']],
            'options': {
                'comment': {'v_range': [['7.2.0', '']], 'type': 'str'},
                'dlp-log': {'v_range': [['7.2.0', '']], 'choices': ['disable', 'enable'], 'type': 'str'},
                'extended-log': {'v_range': [['7.2.0', '']], 'choices': ['disable', 'enable'], 'type': 'str'},
                'feature-set': {'v_range': [['7.2.0', '']], 'choices': ['flow', 'proxy'], 'type': 'str'},
                'full-archive-proto': {
                    'v_range': [['7.2.0', '']],
                    'type': 'list',
                    'choices': ['smtp', 'pop3', 'imap', 'http-post', 'http-get', 'ftp', 'nntp', 'mapi', 'ssh', 'cifs'],
                    'elements': 'str'
                },
                'nac-quar-log': {'v_range': [['7.2.0', '']], 'choices': ['disable', 'enable'], 'type': 'str'},
                'name': {'v_range': [['7.2.0', '']], 'required': True, 'type': 'str'},
                'replacemsg-group': {'v_range': [['7.2.0', '']], 'type': 'str'},
                'rule': {
                    'v_range': [['7.2.0', '']],
                    'type': 'list',
                    'options': {
                        'action': {'v_range': [['7.2.0', '']], 'choices': ['log-only', 'block', 'quarantine-ip', 'allow'], 'type': 'str'},
                        'archive': {'v_range': [['7.2.0', '']], 'choices': ['disable', 'enable'], 'type': 'str'},
                        'expiry': {'v_range': [['7.2.0', '']], 'type': 'str'},
                        'file-size': {'v_range': [['7.2.0', '']], 'type': 'int'},
                        'file-type': {'v_range': [['7.2.0', '']], 'type': 'str'},
                        'filter-by': {'v_range': [['7.2.0', '']], 'choices': ['fingerprint', 'sensor', 'encrypted', 'none', 'mip'], 'type': 'str'},
                        'id': {'v_range': [['7.2.0', '']], 'type': 'int'},
                        'label': {'v_range': [['7.2.0', '']], 'type': 'str'},
                        'match-percentage': {'v_range': [['7.2.0', '']], 'type': 'int'},
                        'name': {'v_range': [['7.2.0', '']], 'type': 'str'},
                        'proto': {
                            'v_range': [['7.2.0', '']],
                            'type': 'list',
                            'choices': ['smtp', 'pop3', 'imap', 'http-post', 'http-get', 'ftp', 'nntp', 'mapi', 'ssh', 'cifs'],
                            'elements': 'str'
                        },
                        'sensitivity': {'v_range': [['7.2.0', '']], 'type': 'raw'},
                        'sensor': {'v_range': [['7.2.0', '']], 'type': 'raw'},
                        'severity': {'v_range': [['7.2.0', '']], 'choices': ['info', 'low', 'medium', 'high', 'critical'], 'type': 'str'},
                        'type': {'v_range': [['7.2.0', '']], 'choices': ['file', 'message'], 'type': 'str'}
                    },
                    'elements': 'dict'
                },
                'summary-proto': {
                    'v_range': [['7.2.0', '']],
                    'type': 'list',
                    'choices': ['smtp', 'pop3', 'imap', 'http-post', 'http-get', 'ftp', 'nntp', 'mapi', 'ssh', 'cifs'],
                    'elements': 'str'
                }
            }
        }
    }

    module_option_spec = get_module_arg_spec('full crud')
    module_arg_spec.update(module_option_spec)
    params_validation_blob = []
    check_galaxy_version(module_arg_spec)
    module = AnsibleModule(argument_spec=check_parameter_bypass(module_arg_spec, 'dlp_profile'),
                           supports_check_mode=True)

    if not module._socket_path:
        module.fail_json(msg='MUST RUN IN HTTPAPI MODE')
    connection = Connection(module._socket_path)
    fmgr = NAPIManager('full crud', module_arg_spec, urls_list, module_primary_key, url_params,
                       module, connection, top_level_schema_name='data')
    fmgr.validate_parameters(params_validation_blob)
    fmgr.process_crud()

    module.exit_json(meta=module.params)


if __name__ == '__main__':
    main()