text: # -*- coding: utf-8 -*-
  # ------------------------------------------------------------------------------
  #
  #   Copyright 2022 fetchai
  #
  #   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.
  #
  # ------------------------------------------------------------------------------
  
  """This module contains fipa's message definition."""
  
  # pylint: disable=too-many-statements,too-many-locals,no-member,too-few-public-methods,too-many-branches,not-an-iterable,unidiomatic-typecheck,unsubscriptable-object
  import logging
  from typing import Any, Dict, Set, Tuple, cast
  
  from aea.configurations.base import PublicId
  from aea.exceptions import AEAEnforceError, enforce
  from aea.protocols.base import Message
  
  from packages.fetchai.protocols.fipa.custom_types import (
      Description as CustomDescription,
  )
  from packages.fetchai.protocols.fipa.custom_types import Query as CustomQuery
  
  
  _default_logger = logging.getLogger("aea.packages.fetchai.protocols.fipa.message")
  
  DEFAULT_BODY_SIZE = 4
  
  
  class FipaMessage(Message):
      """A protocol for FIPA ACL."""
  
      protocol_id = PublicId.from_str("fetchai/fipa:1.0.0")
      protocol_specification_id = PublicId.from_str("fetchai/fipa:1.0.0")
  
      Description = CustomDescription
  
      Query = CustomQuery
  
      class Performative(Message.Performative):
          """Performatives for the fipa protocol."""
  
          ACCEPT = "accept"
          ACCEPT_W_INFORM = "accept_w_inform"
          CFP = "cfp"
          DECLINE = "decline"
          END = "end"
          INFORM = "inform"
          MATCH_ACCEPT = "match_accept"
          MATCH_ACCEPT_W_INFORM = "match_accept_w_inform"
          PROPOSE = "propose"
  
          def __str__(self) -> str:
              """Get the string representation."""
              return str(self.value)
  
      _performatives = {
          "accept",
          "accept_w_inform",
          "cfp",
          "decline",
          "end",
          "inform",
          "match_accept",
          "match_accept_w_inform",
          "propose",
      }
      __slots__: Tuple[str, ...] = tuple()
  
      class _SlotsCls:
          __slots__ = (
              "dialogue_reference",
              "info",
              "message_id",
              "performative",
              "proposal",
              "query",
              "target",
          )
  
      def __init__(
          self,
          performative: Performative,
          dialogue_reference: Tuple[str, str] = ("", ""),
          message_id: int = 1,
          target: int = 0,
          **kwargs: Any,
      ):
          """
          Initialise an instance of FipaMessage.
  
          :param message_id: the message id.
          :param dialogue_reference: the dialogue reference.
          :param target: the message target.
          :param performative: the message performative.
          :param **kwargs: extra options.
          """
          super().__init__(
              dialogue_reference=dialogue_reference,
              message_id=message_id,
              target=target,
              performative=FipaMessage.Performative(performative),
              **kwargs,
          )
  
      @property
      def valid_performatives(self) -> Set[str]:
          """Get valid performatives."""
          return self._performatives
  
      @property
      def dialogue_reference(self) -> Tuple[str, str]:
          """Get the dialogue_reference of the message."""
          enforce(self.is_set("dialogue_reference"), "dialogue_reference is not set.")
          return cast(Tuple[str, str], self.get("dialogue_reference"))
  
      @property
      def message_id(self) -> int:
          """Get the message_id of the message."""
          enforce(self.is_set("message_id"), "message_id is not set.")
          return cast(int, self.get("message_id"))
  
      @property
      def performative(self) -> Performative:  # type: ignore # noqa: F821
          """Get the performative of the message."""
          enforce(self.is_set("performative"), "performative is not set.")
          return cast(FipaMessage.Performative, self.get("performative"))
  
      @property
      def target(self) -> int:
          """Get the target of the message."""
          enforce(self.is_set("target"), "target is not set.")
          return cast(int, self.get("target"))
  
      @property
      def info(self) -> Dict[str, str]:
          """Get the 'info' content from the message."""
          enforce(self.is_set("info"), "'info' content is not set.")
          return cast(Dict[str, str], self.get("info"))
  
      @property
      def proposal(self) -> CustomDescription:
          """Get the 'proposal' content from the message."""
          enforce(self.is_set("proposal"), "'proposal' content is not set.")
          return cast(CustomDescription, self.get("proposal"))
  
      @property
      def query(self) -> CustomQuery:
          """Get the 'query' content from the message."""
          enforce(self.is_set("query"), "'query' content is not set.")
          return cast(CustomQuery, self.get("query"))
  
      def _is_consistent(self) -> bool:
          """Check that the message follows the fipa protocol."""
          try:
              enforce(
                  isinstance(self.dialogue_reference, tuple),
                  "Invalid type for 'dialogue_reference'. Expected 'tuple'. Found '{}'.".format(
                      type(self.dialogue_reference)
                  ),
              )
              enforce(
                  isinstance(self.dialogue_reference[0], str),
                  "Invalid type for 'dialogue_reference[0]'. Expected 'str'. Found '{}'.".format(
                      type(self.dialogue_reference[0])
                  ),
              )
              enforce(
                  isinstance(self.dialogue_reference[1], str),
                  "Invalid type for 'dialogue_reference[1]'. Expected 'str'. Found '{}'.".format(
                      type(self.dialogue_reference[1])
                  ),
              )
              enforce(
                  type(self.message_id) is int,
                  "Invalid type for 'message_id'. Expected 'int'. Found '{}'.".format(
                      type(self.message_id)
                  ),
              )
              enforce(
                  type(self.target) is int,
                  "Invalid type for 'target'. Expected 'int'. Found '{}'.".format(
                      type(self.target)
                  ),
              )
  
              # Light Protocol Rule 2
              # Check correct performative
              enforce(
                  isinstance(self.performative, FipaMessage.Performative),
                  "Invalid 'performative'. Expected either of '{}'. Found '{}'.".format(
                      self.valid_performatives, self.performative
                  ),
              )
  
              # Check correct contents
              actual_nb_of_contents = len(self._body) - DEFAULT_BODY_SIZE
              expected_nb_of_contents = 0
              if self.performative == FipaMessage.Performative.CFP:
                  expected_nb_of_contents = 1
                  enforce(
                      isinstance(self.query, CustomQuery),
                      "Invalid type for content 'query'. Expected 'Query'. Found '{}'.".format(
                          type(self.query)
                      ),
                  )
              elif self.performative == FipaMessage.Performative.PROPOSE:
                  expected_nb_of_contents = 1
                  enforce(
                      isinstance(self.proposal, CustomDescription),
                      "Invalid type for content 'proposal'. Expected 'Description'. Found '{}'.".format(
                          type(self.proposal)
                      ),
                  )
              elif self.performative == FipaMessage.Performative.ACCEPT_W_INFORM:
                  expected_nb_of_contents = 1
                  enforce(
                      isinstance(self.info, dict),
                      "Invalid type for content 'info'. Expected 'dict'. Found '{}'.".format(
                          type(self.info)
                      ),
                  )
                  for key_of_info, value_of_info in self.info.items():
                      enforce(
                          isinstance(key_of_info, str),
                          "Invalid type for dictionary keys in content 'info'. Expected 'str'. Found '{}'.".format(
                              type(key_of_info)
                          ),
                      )
                      enforce(
                          isinstance(value_of_info, str),
                          "Invalid type for dictionary values in content 'info'. Expected 'str'. Found '{}'.".format(
                              type(value_of_info)
                          ),
                      )
              elif self.performative == FipaMessage.Performative.MATCH_ACCEPT_W_INFORM:
                  expected_nb_of_contents = 1
                  enforce(
                      isinstance(self.info, dict),
                      "Invalid type for content 'info'. Expected 'dict'. Found '{}'.".format(
                          type(self.info)
                      ),
                  )
                  for key_of_info, value_of_info in self.info.items():
                      enforce(
                          isinstance(key_of_info, str),
                          "Invalid type for dictionary keys in content 'info'. Expected 'str'. Found '{}'.".format(
                              type(key_of_info)
                          ),
                      )
                      enforce(
                          isinstance(value_of_info, str),
                          "Invalid type for dictionary values in content 'info'. Expected 'str'. Found '{}'.".format(
                              type(value_of_info)
                          ),
                      )
              elif self.performative == FipaMessage.Performative.INFORM:
                  expected_nb_of_contents = 1
                  enforce(
                      isinstance(self.info, dict),
                      "Invalid type for content 'info'. Expected 'dict'. Found '{}'.".format(
                          type(self.info)
                      ),
                  )
                  for key_of_info, value_of_info in self.info.items():
                      enforce(
                          isinstance(key_of_info, str),
                          "Invalid type for dictionary keys in content 'info'. Expected 'str'. Found '{}'.".format(
                              type(key_of_info)
                          ),
                      )
                      enforce(
                          isinstance(value_of_info, str),
                          "Invalid type for dictionary values in content 'info'. Expected 'str'. Found '{}'.".format(
                              type(value_of_info)
                          ),
                      )
              elif self.performative == FipaMessage.Performative.ACCEPT:
                  expected_nb_of_contents = 0
              elif self.performative == FipaMessage.Performative.DECLINE:
                  expected_nb_of_contents = 0
              elif self.performative == FipaMessage.Performative.MATCH_ACCEPT:
                  expected_nb_of_contents = 0
              elif self.performative == FipaMessage.Performative.END:
                  expected_nb_of_contents = 0
  
              # Check correct content count
              enforce(
                  expected_nb_of_contents == actual_nb_of_contents,
                  "Incorrect number of contents. Expected {}. Found {}".format(
                      expected_nb_of_contents, actual_nb_of_contents
                  ),
              )
  
              # Light Protocol Rule 3
              if self.message_id == 1:
                  enforce(
                      self.target == 0,
                      "Invalid 'target'. Expected 0 (because 'message_id' is 1). Found {}.".format(
                          self.target
                      ),
                  )
          except (AEAEnforceError, ValueError, KeyError) as e:
              _default_logger.error(str(e))
              return False
  
          return True
  