text: # Copyright 2017-2021 IBM Corp. All Rights Reserved.
  #
  # Licensed under the Apache License, Version 2.0 (the "License");
  # you may not use this file except in compliance with the License.
  # You may obtain a copy of the License at
  #
  #    http://www.apache.org/licenses/LICENSE-2.0
  #
  # Unless required by applicable law or agreed to in writing, software
  # distributed under the License is distributed on an "AS IS" BASIS,
  # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  # See the License for the specific language governing permissions and
  # limitations under the License.
  
  """
  A :term:`User Pattern` resource represents a pattern for HMC user IDs that are
  not defined on the HMC but can be verified by an LDAP server for user
  authentication.
  
  User Patterns and user templates allow a system administrator to define a group
  of HMC users at once whose user IDs all match a certain pattern (for example,
  a regular expression) and who have a certain set of attributes. Each pattern
  identifies a template User object which defines many characteristics of such
  users. A successful logon with a user ID that matches a User Pattern results in
  the creation of a pattern-based user, with many of its attributes coming from
  the associated template.
  
  User Patterns are searched in a defined order during logon processing. That
  order can be customized through the
  :meth:`~zhmcclient.UserPatternManager.reorder` method.
  """
  
  from __future__ import absolute_import
  
  import copy
  
  from ._manager import BaseManager
  from ._resource import BaseResource
  from ._logging import logged_api_call
  from ._utils import matches_filters, divide_filter_args, RC_USER_PATTERN
  
  __all__ = ['UserPatternManager', 'UserPattern']
  
  
  class UserPatternManager(BaseManager):
      """
      Manager providing access to the :term:`User Pattern` resources of a HMC.
  
      Derived from :class:`~zhmcclient.BaseManager`; see there for common methods
      and attributes.
  
      Objects of this class are not directly created by the user; they are
      accessible via the following instance variable of a
      :class:`~zhmcclient.Console` object:
  
      * :attr:`zhmcclient.Console.user_patterns`
      """
  
      def __init__(self, console):
          # This function should not go into the docs.
          # Parameters:
          #   console (:class:`~zhmcclient.Console`):
          #      Console object representing the HMC.
  
          # Resource properties that are supported as filter query parameters.
          # If the support for a resource property changes within the set of HMC
          # versions that support this type of resource, this list must be set up
          # for the version of the HMC this session is connected to.
          query_props = [
              'name',
              'type',
          ]
  
          super(UserPatternManager, self).__init__(
              resource_class=UserPattern,
              class_name=RC_USER_PATTERN,
              session=console.manager.session,
              parent=console,
              base_uri='/api/console/user-patterns',
              oid_prop='element-id',
              uri_prop='element-uri',
              name_prop='name',
              query_props=query_props)
  
      @property
      def console(self):
          """
          :class:`~zhmcclient.Console`: :term:`Console` defining the scope for
          this manager.
          """
          return self._parent
  
      @logged_api_call
      def list(self, full_properties=True, filter_args=None):
          """
          List the :term:`User Pattern` resources representing the user patterns
          defined in this HMC.
  
          Authorization requirements:
  
          * User-related-access permission to the User Pattern objects included
            in the result, or task permission to the "Manage User Patterns" task.
  
          Parameters:
  
            full_properties (bool):
              Controls whether the full set of resource properties should be
              retrieved, vs. only the short set as returned by the list
              operation.
  
            filter_args (dict):
              Filter arguments that narrow the list of returned resources to
              those that match the specified filter arguments. For details, see
              :ref:`Filtering`.
  
              `None` causes no filtering to happen, i.e. all resources are
              returned.
  
          Returns:
  
            : A list of :class:`~zhmcclient.UserPattern` objects.
  
          Raises:
  
            :exc:`~zhmcclient.HTTPError`
            :exc:`~zhmcclient.ParseError`
            :exc:`~zhmcclient.AuthError`
            :exc:`~zhmcclient.ConnectionError`
          """
          resource_obj_list = []
          query_parms, client_filters = divide_filter_args(
              self._query_props, filter_args)
          resources_name = 'user-patterns'
          uri = '{}/{}{}'.format(self.console.uri, resources_name, query_parms)
  
          result = self.session.get(uri)
          if result:
              props_list = result[resources_name]
              for props in props_list:
  
                  resource_obj = self.resource_class(
                      manager=self,
                      uri=props[self._uri_prop],
                      name=props.get(self._name_prop, None),
                      properties=props)
  
                  if matches_filters(resource_obj, client_filters):
                      resource_obj_list.append(resource_obj)
                      if full_properties:
                          resource_obj.pull_full_properties()
  
          self._name_uri_cache.update_from(resource_obj_list)
          return resource_obj_list
  
      @logged_api_call
      def create(self, properties):
          """
          Create a new User Pattern in this HMC.
  
          Authorization requirements:
  
          * Task permission to the "Manage User Patterns" task.
  
          Parameters:
  
            properties (dict): Initial property values.
              Allowable properties are defined in section 'Request body contents'
              in section 'Create User Pattern' in the :term:`HMC API` book.
  
          Returns:
  
            UserPattern:
              The resource object for the new User Pattern.
              The object will have its 'element-uri' property set as returned by
              the HMC, and will also have the input properties set.
  
          Raises:
  
            :exc:`~zhmcclient.HTTPError`
            :exc:`~zhmcclient.ParseError`
            :exc:`~zhmcclient.AuthError`
            :exc:`~zhmcclient.ConnectionError`
          """
          result = self.session.post(self.console.uri + '/user-patterns',
                                     body=properties)
          # There should not be overlaps, but just in case there are, the
          # returned props should overwrite the input props:
          props = copy.deepcopy(properties)
          props.update(result)
          name = props.get(self._name_prop, None)
          uri = props[self._uri_prop]
          user_pattern = UserPattern(self, uri, name, props)
          self._name_uri_cache.update(name, uri)
          return user_pattern
  
      @logged_api_call
      def reorder(self, user_patterns):
          """
          Reorder the User Patterns of the HMC as specified.
  
          The order of User Patterns determines the search order during logon
          processing.
  
          Authorization requirements:
  
          * Task permission to the "Manage User Patterns" task.
  
          Parameters:
  
            user_patterns (list of :class:`~zhmcclient.UserPattern`):
              The User Patterns in the desired order.
  
              Must not be `None`.
  
          Raises:
  
            :exc:`~zhmcclient.HTTPError`
            :exc:`~zhmcclient.ParseError`
            :exc:`~zhmcclient.AuthError`
            :exc:`~zhmcclient.ConnectionError`
          """  # noqa: E501
          body = {
              'user-pattern-uris': [up.uri for up in user_patterns]
          }
          self.session.post(
              '/api/console/operations/reorder-user-patterns',
              body=body)
  
  
  class UserPattern(BaseResource):
      """
      Representation of a :term:`User Pattern`.
  
      Derived from :class:`~zhmcclient.BaseResource`; see there for common
      methods and attributes.
  
      Objects of this class are not directly created by the user; they are
      returned from creation or list functions on their manager object
      (in this case, :class:`~zhmcclient.UserPatternManager`).
      """
  
      def __init__(self, manager, uri, name=None, properties=None):
          # This function should not go into the docs.
          #   manager (:class:`~zhmcclient.UserPatternManager`):
          #     Manager object for this resource object.
          #   uri (string):
          #     Canonical URI path of the resource.
          #   name (string):
          #     Name of the resource.
          #   properties (dict):
          #     Properties to be set for this resource object. May be `None` or
          #     empty.
          assert isinstance(manager, UserPatternManager), \
              "Console init: Expected manager type %s, got %s" % \
              (UserPatternManager, type(manager))
          super(UserPattern, self).__init__(manager, uri, name, properties)
  
      @logged_api_call
      def delete(self):
          """
          Delete this User Pattern.
  
          Authorization requirements:
  
          * Task permission to the "Manage User Patterns" task.
  
          Raises:
  
            :exc:`~zhmcclient.HTTPError`
            :exc:`~zhmcclient.ParseError`
            :exc:`~zhmcclient.AuthError`
            :exc:`~zhmcclient.ConnectionError`
          """
          # pylint: disable=protected-access
          self.manager.session.delete(self.uri)
          self.manager._name_uri_cache.delete(
              self.get_properties_local(self.manager._name_prop, None))
  
      @logged_api_call
      def update_properties(self, properties):
          """
          Update writeable properties of this UserPattern.
  
          This method serializes with other methods that access or change
          properties on the same Python object.
  
          Authorization requirements:
  
          * Task permission to the "Manage User Patterns" task.
  
          Parameters:
  
            properties (dict): New values for the properties to be updated.
              Properties not to be updated are omitted.
              Allowable properties are the properties with qualifier (w) in
              section 'Data model' in section 'User Pattern object' in the
              :term:`HMC API` book.
  
          Raises:
  
            :exc:`~zhmcclient.HTTPError`
            :exc:`~zhmcclient.ParseError`
            :exc:`~zhmcclient.AuthError`
            :exc:`~zhmcclient.ConnectionError`
          """
          # pylint: disable=protected-access
          self.manager.session.post(self.uri, body=properties)
          is_rename = self.manager._name_prop in properties
          if is_rename:
              # Delete the old name from the cache
              self.manager._name_uri_cache.delete(self.name)
          self.update_properties_local(copy.deepcopy(properties))
          if is_rename:
              # Add the new name to the cache
              self.manager._name_uri_cache.update(self.name, self.uri)
  