#!/usr/bin/python
# -*- coding: utf-8 -*-
#
# Ansible module to manage CheckPoint Firewall (c) 2019
#
# Ansible 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.
#
# Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
#

from __future__ import (absolute_import, division, print_function)

__metaclass__ = type

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

DOCUMENTATION = """
---
module: cp_mgmt_data_type_file_attributes
short_description: Manages data-type-file-attributes objects on Checkpoint over Web Services API
description:
  - Manages data-type-file-attributes objects on Checkpoint devices including creating, updating and removing objects.
  - All operations are performed over Web Services API.
  - Available from R82 management version.
version_added: "6.0.0"
author: "Eden Brillant (@chkp-edenbr)"
options:
  name:
    description:
      - Object name.
    type: str
    required: True
  description:
    description:
      - For built-in data types, the description explains the purpose of this type of data representation.
        For custom-made data types, you can use this field to provide more details.
    type: str
  match_by_file_type:
    description:
      - Determine whether to consider file type.
    type: bool
  file_groups_list:
    description:
      - The file must be one of the types specified in the list. Identified by name or UID.
    type: list
    elements: str
  match_by_file_name:
    description:
      - Determine whether to consider file name.
    type: bool
  file_name_contains:
    description:
      - File name should contain the expression.
    type: str
  match_by_file_size:
    description:
      - Determine whether to consider file size.
    type: bool
  file_size:
    description:
      - Min File size in KB.
    type: int
  tags:
    description:
      - Collection of tag identifiers.
    type: list
    elements: str
  color:
    description:
      - Color of the object. Should be one of existing colors.
    type: str
    choices: ['aquamarine', 'black', 'blue', 'crete blue', 'burlywood', 'cyan', 'dark green', 'khaki', 'orchid', 'dark orange', 'dark sea green',
             'pink', 'turquoise', 'dark blue', 'firebrick', 'brown', 'forest green', 'gold', 'dark gold', 'gray', 'dark gray', 'light green', 'lemon chiffon',
             'coral', 'sea green', 'sky blue', 'magenta', 'purple', 'slate blue', 'violet red', 'navy blue', 'olive', 'orange', 'red', 'sienna', 'yellow']
  comments:
    description:
      - Comments string.
    type: str
  details_level:
    description:
      - The level of detail for some of the fields in the response can vary from showing only the UID value of the object to a fully detailed
        representation of the object.
    type: str
    choices: ['uid', 'standard', 'full']
  ignore_warnings:
    description:
      - Apply changes ignoring warnings.
    type: bool
  ignore_errors:
    description:
      - Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.
    type: bool
extends_documentation_fragment: check_point.mgmt.checkpoint_objects
"""

EXAMPLES = """
- name: add-data-type-file-attributes
  cp_mgmt_data_type_file_attributes:
    file_groups_list:
      - Viewer
    file_name_contains: expression
    file_size: 14
    match_by_file_name: 'true'
    match_by_file_size: 'true'
    match_by_file_type: 'true'
    name: file-attr-obj
    state: present

- name: set-data-type-file-attributes
  cp_mgmt_data_type_file_attributes:
    file_groups_list:
      - Word
    match_by_file_size: false
    name: file-attr-obj
    state: present

- name: delete-data-type-file-attributes
  cp_mgmt_data_type_file_attributes:
    name: file-attr-obj
    state: absent
"""

RETURN = """
cp_mgmt_data_type_file_attributes:
  description: The checkpoint object created or updated.
  returned: always, except when deleting the object.
  type: dict
"""

from ansible.module_utils.basic import AnsibleModule
from ansible_collections.check_point.mgmt.plugins.module_utils.checkpoint import checkpoint_argument_spec_for_objects, api_call


def main():
    argument_spec = dict(
        name=dict(type='str', required=True),
        description=dict(type='str'),
        match_by_file_type=dict(type='bool'),
        file_groups_list=dict(type='list', elements='str'),
        match_by_file_name=dict(type='bool'),
        file_name_contains=dict(type='str'),
        match_by_file_size=dict(type='bool'),
        file_size=dict(type='int'),
        tags=dict(type='list', elements='str'),
        color=dict(type='str', choices=['aquamarine', 'black', 'blue', 'crete blue', 'burlywood', 'cyan', 'dark green',
                                        'khaki', 'orchid', 'dark orange', 'dark sea green', 'pink', 'turquoise', 'dark blue', 'firebrick', 'brown',
                                        'forest green', 'gold', 'dark gold', 'gray', 'dark gray', 'light green', 'lemon chiffon', 'coral', 'sea green',
                                        'sky blue', 'magenta', 'purple', 'slate blue', 'violet red', 'navy blue', 'olive', 'orange', 'red', 'sienna',
                                        'yellow']),
        comments=dict(type='str'),
        details_level=dict(type='str', choices=['uid', 'standard', 'full']),
        ignore_warnings=dict(type='bool'),
        ignore_errors=dict(type='bool')
    )
    argument_spec.update(checkpoint_argument_spec_for_objects)

    module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=True)
    api_call_object = 'data-type-file-attributes'

    result = api_call(module, api_call_object)
    module.exit_json(**result)


if __name__ == '__main__':
    main()
