text: #!/usr/bin/python
  # -*- coding: utf-8 -*-
  #
  # Copyright: (c) 2017, F5 Networks Inc.
  # GNU General Public License v3.0 (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
  
  from __future__ import absolute_import, division, print_function
  __metaclass__ = type
  
  DOCUMENTATION = r'''
  ---
  module: bigip_firewall_port_list
  short_description: Manage port lists on BIG-IP AFM
  description:
    - Manages the AFM (Advanced Firewall Manager) port lists on a BIG-IP. This module can be used to add
      and remove port list entries.
  version_added: "1.0.0"
  options:
    name:
      description:
        - Specifies the name of the port list.
      type: str
      required: True
    partition:
      description:
        - Device partition to manage resources on.
      type: str
      default: Common
    description:
      description:
        - Description of the port list.
      type: str
    ports:
      description:
        - Simple list of port values to add to the list.
      type: list
      elements: str
    port_ranges:
      description:
        - A list of port ranges where the range starts with a port number, is followed
          by a dash (-), and then a second number.
        - If the first number is greater than the second number, the numbers will be
          reversed to be properly formatted, for example 90-78 would become 78-90.
      type: list
      elements: str
    port_lists:
      description:
        - Simple list of existing port lists to add to this list. Port lists can be
          specified in either their fully qualified name (/Common/foo) or their short
          name (foo). If a short name is used, the C(partition) argument will automatically
          be prepended to the short name.
      type: list
      elements: str
    state:
      description:
        - When C(present), ensures the address list and entries exists.
        - When C(absent), ensures the address list is removed.
      type: str
      choices:
        - present
        - absent
      default: present
  extends_documentation_fragment: f5networks.f5_modules.f5
  author:
    - Tim Rupp (@caphrim007)
    - Wojciech Wypior (@wojtek0806)
  '''
  
  EXAMPLES = r'''
  - name: Create a simple port list
    bigip_firewall_port_list:
      name: foo
      ports:
        - 80
        - 443
      state: present
      provider:
        password: secret
        server: lb.mydomain.com
        user: admin
    delegate_to: localhost
  
  - name: Override the above list of ports with a new list
    bigip_firewall_port_list:
      name: foo
      ports:
        - 3389
        - 8080
        - 25
      state: present
      provider:
        password: secret
        server: lb.mydomain.com
        user: admin
    delegate_to: localhost
  
  - name: Create port list with series of ranges
    bigip_firewall_port_list:
      name: foo
      port_ranges:
        - 25-30
        - 80-500
        - 50-78
      state: present
      provider:
        password: secret
        server: lb.mydomain.com
        user: admin
    delegate_to: localhost
  
  - name: Use multiple types of port arguments
    bigip_firewall_port_list:
      name: foo
      port_ranges:
        - 25-30
        - 80-500
        - 50-78
      ports:
        - 8080
        - 443
      state: present
      provider:
        password: secret
        server: lb.mydomain.com
        user: admin
    delegate_to: localhost
  
  - name: Remove port list
    bigip_firewall_port_list:
      name: foo
      state: absent
      provider:
        password: secret
        server: lb.mydomain.com
        user: admin
    delegate_to: localhost
  
  - name: Create port list from a file with one port per line
    bigip_firewall_port_list:
      name: lot-of-ports
      ports: "{{ lookup('file', 'my-large-port-list.txt').split('\n') }}"
      state: present
      provider:
        password: secret
        server: lb.mydomain.com
        user: admin
    delegate_to: localhost
  '''
  
  RETURN = r'''
  description:
    description: The new description of the port list.
    returned: changed
    type: str
    sample: My port list
  ports:
    description: The new list of ports applied to the port list.
    returned: changed
    type: list
    sample: [80, 443]
  port_ranges:
    description: The new list of port ranges applied to the port list.
    returned: changed
    type: list
    sample: [80-100, 200-8080]
  port_lists:
    description: The new list of port list names applied to the port list.
    returned: changed
    type: list
    sample: [/Common/list1, /Common/list2]
  '''
  from datetime import datetime
  
  from ansible.module_utils.basic import (
      AnsibleModule, env_fallback
  )
  
  from ..module_utils.bigip import F5RestClient
  from ..module_utils.common import (
      F5ModuleError, AnsibleF5Parameters, transform_name, f5_argument_spec, fq_name
  )
  from ..module_utils.icontrol import (
      module_provisioned, tmos_version
  )
  from ..module_utils.teem import send_teem
  
  
  class Parameters(AnsibleF5Parameters):
      api_map = {
          'portLists': 'port_lists',
      }
  
      api_attributes = [
          'portLists', 'ports', 'description',
      ]
  
      returnables = [
          'ports', 'port_ranges', 'port_lists', 'description',
      ]
  
      updatables = [
          'description', 'ports', 'port_ranges', 'port_lists',
      ]
  
  
  class ApiParameters(Parameters):
      @property
      def port_ranges(self):
          if self._values['ports'] is None:
              return None
          result = []
          for port_range in self._values['ports']:
              if '-' not in port_range['name']:
                  continue
              start, stop = port_range['name'].split('-')
              start = int(start.strip())
              stop = int(stop.strip())
              if start > stop:
                  stop, start = start, stop
              item = '{0}-{1}'.format(start, stop)
              result.append(item)
          return result
  
      @property
      def port_lists(self):
          if self._values['port_lists'] is None:
              return None
          result = []
          for x in self._values['port_lists']:
              item = '/{0}/{1}'.format(x['partition'], x['name'])
              result.append(item)
          return result
  
      @property
      def ports(self):
          if self._values['ports'] is None:
              return None
          result = [int(x['name']) for x in self._values['ports'] if '-' not in x['name']]
          return result
  
  
  class ModuleParameters(Parameters):
      @property
      def ports(self):
          if self._values['ports'] is None:
              return None
          if any(x for x in self._values['ports'] if '-' in str(x)):
              raise F5ModuleError(
                  "Ports must be whole numbers between 0 and 65,535"
              )
          if any(x for x in self._values['ports'] if 0 < int(x) > 65535):
              raise F5ModuleError(
                  "Ports must be whole numbers between 0 and 65,535"
              )
          result = [int(x) for x in self._values['ports']]
          return result
  
      @property
      def port_ranges(self):
          if self._values['port_ranges'] is None:
              return None
          result = []
          for port_range in self._values['port_ranges']:
              if '-' not in port_range:
                  continue
              start, stop = port_range.split('-')
              start = int(start.strip())
              stop = int(stop.strip())
              if start > stop:
                  stop, start = start, stop
              if 0 < start > 65535 or 0 < stop > 65535:
                  raise F5ModuleError(
                      "Ports must be whole numbers between 0 and 65,535"
                  )
              item = '{0}-{1}'.format(start, stop)
              result.append(item)
          return result
  
      @property
      def port_lists(self):
          if self._values['port_lists'] is None:
              return None
          result = []
          for x in self._values['port_lists']:
              item = fq_name(self.partition, x)
              result.append(item)
          return result
  
  
  class Changes(Parameters):
      def to_return(self):
          result = {}
          try:
              for returnable in self.returnables:
                  result[returnable] = getattr(self, returnable)
              result = self._filter_params(result)
          except Exception:
              raise
          return result
  
  
  class ReportableChanges(Changes):
      @property
      def ports(self):
          if not self._values['ports']:
              return None
          result = []
          for item in self._values['ports']:
              if '-' in item['name']:
                  continue
              result.append(item['name'])
          return result
  
      @property
      def port_ranges(self):
          if not self._values['ports']:
              return None
          result = []
          for item in self._values['ports']:
              if '-' not in item['name']:
                  continue
              result.append(item['name'])
          return result
  
  
  class UsableChanges(Changes):
      @property
      def ports(self):
          if self._values['ports'] is None and self._values['port_ranges'] is None:
              return None
          result = []
          if self._values['ports']:
              # The values of the 'key' index literally need to be string values.
              # If they are not, on BIG-IP 12.1.0 they will raise this REST exception.
              #
              # {
              #   "code": 400,
              #   "message": "one or more configuration identifiers must be provided",
              #   "errorStack": [],
              #   "apiError": 26214401
              # }
              result += [dict(name=str(x)) for x in self._values['ports']]
          if self._values['port_ranges']:
              result += [dict(name=str(x)) for x in self._values['port_ranges']]
          return result
  
      @property
      def port_lists(self):
          if self._values['port_lists'] is None:
              return None
          result = []
          for x in self._values['port_lists']:
              partition, name = x.split('/')[1:]
              result.append(dict(
                  name=name,
                  partition=partition
              ))
          return result
  
  
  class Difference(object):
      def __init__(self, want, have=None):
          self.want = want
          self.have = have
  
      def compare(self, param):
          try:
              result = getattr(self, param)
              return result
          except AttributeError:
              return self.__default(param)
  
      def __default(self, param):
          attr1 = getattr(self.want, param)
          try:
              attr2 = getattr(self.have, param)
              if attr1 != attr2:
                  return attr1
          except AttributeError:
              return attr1
  
      @property
      def ports(self):
          if self.want.ports is None:
              return None
          elif self.have.ports is None:
              return self.want.ports
          if sorted(self.want.ports) != sorted(self.have.ports):
              return self.want.ports
  
      @property
      def port_lists(self):
          if self.want.port_lists is None:
              return None
          elif self.have.port_lists is None:
              return self.want.port_lists
          if sorted(self.want.port_lists) != sorted(self.have.port_lists):
              return self.want.port_lists
  
      @property
      def port_ranges(self):
          if self.want.port_ranges is None:
              return None
          elif self.have.port_ranges is None:
              return self.want.port_ranges
          if sorted(self.want.port_ranges) != sorted(self.have.port_ranges):
              return self.want.port_ranges
  
  
  class ModuleManager(object):
      def __init__(self, *args, **kwargs):
          self.module = kwargs.get('module', None)
          self.client = F5RestClient(**self.module.params)
          self.want = ModuleParameters(params=self.module.params)
          self.have = ApiParameters()
          self.changes = UsableChanges()
  
      def _set_changed_options(self):
          changed = {}
          for key in Parameters.returnables:
              if getattr(self.want, key) is not None:
                  changed[key] = getattr(self.want, key)
          if changed:
              self.changes = UsableChanges(params=changed)
  
      def _update_changed_options(self):
          diff = Difference(self.want, self.have)
          updatables = Parameters.updatables
          changed = dict()
          for k in updatables:
              change = diff.compare(k)
              if change is None:
                  continue
              else:
                  if isinstance(change, dict):
                      changed.update(change)
                  else:
                      changed[k] = change
          if changed:
              self.changes = UsableChanges(params=changed)
              return True
          return False
  
      def should_update(self):
          result = self._update_changed_options()
          if result:
              return True
          return False
  
      def exec_module(self):
          if not module_provisioned(self.client, 'afm'):
              raise F5ModuleError(
                  "AFM must be provisioned to use this module."
              )
          start = datetime.now().isoformat()
          version = tmos_version(self.client)
          changed = False
          result = dict()
          state = self.want.state
  
          if state == "present":
              changed = self.present()
          elif state == "absent":
              changed = self.absent()
  
          reportable = ReportableChanges(params=self.changes.to_return())
          changes = reportable.to_return()
          result.update(**changes)
          result.update(dict(changed=changed))
          self._announce_deprecations(result)
          send_teem(start, self.client, self.module, version)
          return result
  
      def _announce_deprecations(self, result):
          warnings = result.pop('__warnings', [])
          for warning in warnings:
              self.module.deprecate(
                  msg=warning['msg'],
                  version=warning['version']
              )
  
      def present(self):
          if self.exists():
              return self.update()
          else:
              return self.create()
  
      def absent(self):
          if self.exists():
              return self.remove()
          return False
  
      def update(self):
          self.have = self.read_current_from_device()
          if not self.should_update():
              return False
          if self.module.check_mode:
              return True
          self.update_on_device()
          return True
  
      def remove(self):
          if self.module.check_mode:
              return True
          self.remove_from_device()
          if self.exists():
              raise F5ModuleError("Failed to delete the resource.")
          return True
  
      def create(self):
          self._set_changed_options()
          if self.module.check_mode:
              return True
          self.create_on_device()
          return True
  
      def exists(self):
          uri = "https://{0}:{1}/mgmt/tm/security/firewall/port-list/{2}".format(
              self.client.provider['server'],
              self.client.provider['server_port'],
              transform_name(self.want.partition, self.want.name)
          )
          resp = self.client.api.get(uri)
          try:
              response = resp.json()
          except ValueError as ex:
              raise F5ModuleError(str(ex))
  
          if resp.status == 404 or 'code' in response and response['code'] == 404:
              return False
          if resp.status in [200, 201] or 'code' in response and response['code'] in [200, 201]:
              return True
  
          errors = [401, 403, 409, 500, 501, 502, 503, 504]
  
          if resp.status in errors or 'code' in response and response['code'] in errors:
              if 'message' in response:
                  raise F5ModuleError(response['message'])
              else:
                  raise F5ModuleError(resp.content)
  
      def update_on_device(self):
          params = self.changes.api_params()
          uri = "https://{0}:{1}/mgmt/tm/security/firewall/port-list/{2}".format(
              self.client.provider['server'],
              self.client.provider['server_port'],
              transform_name(self.want.partition, self.want.name)
          )
          resp = self.client.api.patch(uri, json=params)
          try:
              response = resp.json()
          except ValueError as ex:
              raise F5ModuleError(str(ex))
  
          if resp.status in [200, 201] or 'code' in response and response['code'] in [200, 201]:
              return True
          raise F5ModuleError(resp.content)
  
      def read_current_from_device(self):
          uri = "https://{0}:{1}/mgmt/tm/security/firewall/port-list/{2}".format(
              self.client.provider['server'],
              self.client.provider['server_port'],
              transform_name(self.want.partition, self.want.name)
          )
          resp = self.client.api.get(uri)
  
          try:
              response = resp.json()
          except ValueError as ex:
              raise F5ModuleError(str(ex))
  
          if resp.status in [200, 201] or 'code' in response and response['code'] in [200, 201]:
              return ApiParameters(params=response)
          raise F5ModuleError(resp.content)
  
      def create_on_device(self):
          params = self.changes.api_params()
          params['name'] = self.want.name
          params['partition'] = self.want.partition
          uri = "https://{0}:{1}/mgmt/tm/security/firewall/port-list/".format(
              self.client.provider['server'],
              self.client.provider['server_port'],
          )
          resp = self.client.api.post(uri, json=params)
          try:
              response = resp.json()
          except ValueError as ex:
              raise F5ModuleError(str(ex))
  
          if resp.status in [200, 201] or 'code' in response and response['code'] in [200, 201]:
              return True
          raise F5ModuleError(resp.content)
  
      def remove_from_device(self):
          uri = "https://{0}:{1}/mgmt/tm/security/firewall/port-list/{2}".format(
              self.client.provider['server'],
              self.client.provider['server_port'],
              transform_name(self.want.partition, self.want.name)
          )
          response = self.client.api.delete(uri)
          if response.status == 200:
              return True
          raise F5ModuleError(response.content)
  
  
  class ArgumentSpec(object):
      def __init__(self):
          self.supports_check_mode = True
          argument_spec = dict(
              name=dict(required=True),
              description=dict(),
              ports=dict(
                  type='list',
                  elements='str',
              ),
              port_ranges=dict(
                  type='list',
                  elements='str',
              ),
              port_lists=dict(
                  type='list',
                  elements='str',
              ),
              partition=dict(
                  default='Common',
                  fallback=(env_fallback, ['F5_PARTITION'])
              ),
              state=dict(
                  default='present',
                  choices=['present', 'absent']
              )
          )
          self.argument_spec = {}
          self.argument_spec.update(f5_argument_spec)
          self.argument_spec.update(argument_spec)
  
  
  def main():
      spec = ArgumentSpec()
  
      module = AnsibleModule(
          argument_spec=spec.argument_spec,
          supports_check_mode=spec.supports_check_mode
      )
  
      try:
          mm = ModuleManager(module=module)
          results = mm.exec_module()
          module.exit_json(**results)
      except F5ModuleError as ex:
          module.fail_json(msg=str(ex))
  
  
  if __name__ == '__main__':
      main()
  