Uses settings to control ephemeral state.

docs/design.md

@@ -162,4 +162,6 @@ Some known limitations of currently supported platforms:
 - No table functionality in cards (blocks). The `ColumnSet` card layout feature allows for wrapping content across
   multiple columns, but does not provide for any alignment across columns, so it's not suitable for tables.
 
+## Settings
 
+The setting of `send_all_messages_private` within the configuration applied within the Nautobot config is used to send all messages as private messages. The messages will be sent in private when this is set to `True`. The default setting is `False`, which is the behavior for several message settings.

nautobot_chatops/__init__.py

@@ -45,6 +45,10 @@ class NautobotChatOpsConfig(PluginConfig):
         # Mattermost-specific settings
         "mattermost_api_token": None,
         "mattermost_url": None,
+        # As requested on https://github.com/nautobot/nautobot-plugin-chatops/issues/114 this setting is used for
+        # sending all messages as an ephemeral message, meaning only the person interacting with the bot will see the
+        # responses.
+        "send_all_messages_private": False,
     }
 
     max_version = "1.999"

nautobot_chatops/dispatchers/adaptive_cards.py

@@ -1,5 +1,4 @@
 """Dispatcher subclass for chat platforms that use Adaptive Cards (https://adaptivecards.io/)."""
-
 from .base import Dispatcher
 
 # pylint: disable=abstract-method
@@ -121,7 +120,13 @@ def multi_input_dialog(self, command, sub_command, dialog_title, dialog_list):
             ],
         }
         blocks.append(buttons)
-        return self.send_blocks(blocks, callback_id=callback_id, modal=True, ephemeral=False, title=dialog_title)
+        return self.send_blocks(
+            blocks,
+            callback_id=callback_id,
+            modal=True,
+            ephemeral=False,
+            title=dialog_title,
+        )
 
     def send_warning(self, message):
         """Send a warning message to the user/channel specified by the context."""

nautobot_chatops/dispatchers/base.py

@@ -216,12 +216,23 @@ def ask_permission_to_send_image(self, filename, action_id):
 
     # Send various content to the user or channel
 
-    def send_markdown(self, message, ephemeral=False):
+    def send_markdown(self, message, ephemeral=None):
         """Send a Markdown-formatted text message to the user/channel specified by the context."""
+        if ephemeral is None:
+            ephemeral = settings.PLUGINS_CONFIG["nautobot_chatops"]["send_all_messages_private"]
         raise NotImplementedError
 
-    def send_blocks(self, blocks, callback_id=None, modal=False, ephemeral=False, title=None):
+    def send_blocks(
+        self,
+        blocks,
+        callback_id=None,
+        modal=False,
+        ephemeral=None,
+        title=None,
+    ):
         """Send a series of formatting blocks to the user/channel specified by the context."""
+        if ephemeral is None:
+            ephemeral = settings.PLUGINS_CONFIG["nautobot_chatops"]["send_all_messages_private"]
         raise NotImplementedError
 
     def send_snippet(self, text, title=None):
@@ -327,3 +338,24 @@ def select_element(self, action_id, choices, default=(None, None), confirm=False
     def text_element(self, text):
         """Construct a simple plaintext element."""
         raise NotImplementedError
+
+    @staticmethod
+    def split_messages(text_string: str, max_message_size: int) -> list:
+        """Method to split a message into smaller messages.
+
+        Args:
+            text_string (str): Text string that should be split
+            max_message_size (int): Maximum size for a message
+        """
+        return_list = [""]
+
+        for line in text_string.splitlines():
+            # len(line) + 2 to account for a new line character in the character line
+            # Check to see if the line length of the last item in the list is longer than the max message size
+            # Once it would be larger than the max size, then start the next line.
+            if (len(line) + 2) + len(return_list[-1]) < max_message_size:
+                return_list[-1] += f"{line}\n"
+            else:
+                return_list.append(f"{line}\n")
+
+        return return_list

nautobot_chatops/dispatchers/mattermost.py

@@ -346,8 +346,10 @@ def command_response_header(self, command, subcommand, args, description="inform
     # Send various content to the user or channel
 
     @BACKEND_ACTION_MARKDOWN.time()
-    def send_markdown(self, message, ephemeral=False):
+    def send_markdown(self, message, ephemeral=None):
         """Send a Markdown-formatted text message to the user/channel specified by the context."""
+        if ephemeral is None:
+            ephemeral = settings.PLUGINS_CONFIG["nautobot_chatops"]["send_all_messages_private"]
         try:
             if ephemeral:
                 self.mm_client.chat_post_ephemeral(
@@ -360,7 +362,7 @@ def send_markdown(self, message, ephemeral=False):
 
     # pylint: disable=arguments-differ
     @BACKEND_ACTION_BLOCKS.time()
-    def send_blocks(self, blocks, callback_id=None, modal=False, ephemeral=False, title="Your attention please!"):
+    def send_blocks(self, blocks, callback_id=None, modal=False, ephemeral=None, title="Your attention please!"):
         """Send a series of formatting blocks to the user/channel specified by the context.
 
         Args:
@@ -370,6 +372,8 @@ def send_blocks(self, blocks, callback_id=None, modal=False, ephemeral=False, ti
           ephemeral (bool): Whether to send this as an ephemeral message (only visible to the targeted user).
           title (str): Title to include on a modal dialog.
         """
+        if ephemeral is None:
+            ephemeral = settings.PLUGINS_CONFIG["nautobot_chatops"]["send_all_messages_private"]
         logger.info("Sending blocks: %s", json.dumps(blocks, indent=2))
         try:
             if modal:
@@ -403,11 +407,15 @@ def send_blocks(self, blocks, callback_id=None, modal=False, ephemeral=False, ti
             self.send_exception(mm_error)
 
     @BACKEND_ACTION_SNIPPET.time()
-    def send_snippet(self, text, title=None):
+    def send_snippet(self, text, title=None, ephemeral=None):
         """Send a longer chunk of text as a file snippet."""
         channel = [self.context.get("channel_id")]
         logger.info("Sending snippet to %s: %s", channel, text)
-        self.mm_client.chat_post_message(channel_id=self.context.get("channel_id"), snippet=text)
+        if ephemeral:
+            for msg in self.split_messages(text, 16383):
+                self.mm_client.chat_post_ephemeral(channel_id=self.context.get("channel_id"), message=msg)
+        else:
+            self.mm_client.chat_post_message(channel_id=self.context.get("channel_id"), snippet=text)
 
     def send_image(self, image_path):
         """Send an image as a file upload."""

nautobot_chatops/dispatchers/ms_teams.py

@@ -149,12 +149,12 @@ def ask_permission_to_send_image(self, filename, action_id):
         )
 
     @BACKEND_ACTION_MARKDOWN.time()
-    def send_markdown(self, message, ephemeral=False):
+    def send_markdown(self, message, ephemeral=None):
         """Send a markdown-formatted text message to the user/channel specified by the context."""
         self._send({"text": message, "textFormat": "markdown"})
 
     @BACKEND_ACTION_BLOCKS.time()
-    def send_blocks(self, blocks, callback_id=None, modal=False, ephemeral=False, title=None):
+    def send_blocks(self, blocks, callback_id=None, modal=False, ephemeral=None, title=None):
         """Send a series of formatting blocks to the user/channel specified by the context."""
         if title and title not in str(blocks[0]):
             blocks.insert(0, self.markdown_element(self.bold(title)))
@@ -170,7 +170,7 @@ def send_blocks(self, blocks, callback_id=None, modal=False, ephemeral=False, ti
         )
 
     @BACKEND_ACTION_SNIPPET.time()
-    def send_snippet(self, text, title=None):
+    def send_snippet(self, text, title=None, ephemeral=None):
         """Send a longer chunk of text as a snippet or file attachment."""
         self.send_markdown(f"```\n{text}\n```")
 

nautobot_chatops/dispatchers/slack.py

@@ -136,9 +136,12 @@ def command_response_header(self, command, subcommand, args, description="inform
     # Send various content to the user or channel
 
     @BACKEND_ACTION_MARKDOWN.time()
-    def send_markdown(self, message, ephemeral=False):
+    def send_markdown(self, message, ephemeral=None):
         """Send a Markdown-formatted text message to the user/channel specified by the context."""
         try:
+            if ephemeral is None:
+                ephemeral = settings.PLUGINS_CONFIG["nautobot_chatops"]["send_all_messages_private"]
+
             if ephemeral:
                 self.slack_client.chat_postEphemeral(
                     channel=self.context.get("channel_id"),
@@ -156,7 +159,7 @@ def send_markdown(self, message, ephemeral=False):
 
     # pylint: disable=arguments-differ
     @BACKEND_ACTION_BLOCKS.time()
-    def send_blocks(self, blocks, callback_id=None, modal=False, ephemeral=False, title="Your attention please!"):
+    def send_blocks(self, blocks, callback_id=None, modal=False, ephemeral=None, title="Your attention please!"):
         """Send a series of formatting blocks to the user/channel specified by the context.
 
         Slack distinguishes between simple inline interactive elements and modal dialogs. Modals can contain multiple
@@ -171,6 +174,8 @@ def send_blocks(self, blocks, callback_id=None, modal=False, ephemeral=False, ti
           title (str): Title to include on a modal dialog.
         """
         logger.info("Sending blocks: %s", json.dumps(blocks, indent=2))
+        if ephemeral is None:
+            ephemeral = settings.PLUGINS_CONFIG["nautobot_chatops"]["send_all_messages_private"]
         try:
             if modal:
                 if not callback_id:
@@ -208,16 +213,30 @@ def send_blocks(self, blocks, callback_id=None, modal=False, ephemeral=False, ti
             self.send_exception(slack_error)
 
     @BACKEND_ACTION_SNIPPET.time()
-    def send_snippet(self, text, title=None):
+    def send_snippet(self, text, title=None, ephemeral=None):
         """Send a longer chunk of text as a file snippet."""
+        if ephemeral is None:
+            ephemeral = settings.PLUGINS_CONFIG["nautobot_chatops"]["send_all_messages_private"]
+
         if self.context.get("channel_name") == "directmessage":
             channels = [self.context.get("user_id")]
         else:
             channels = [self.context.get("channel_id")]
         channels = ",".join(channels)
         logger.info("Sending snippet to %s: %s", channels, text)
         try:
-            self.slack_client.files_upload(channels=channels, content=text, title=title)
+            # Check for the length of the file if the setup is meant to be a private message
+            if ephemeral:
+                message_list = self.split_messages(text, 40000)
+                for msg in message_list:
+                    self.slack_client.chat_postEphemeral(
+                        channel=self.context.get("channel_id"),
+                        user=self.context.get("user_id"),
+                        text="test",
+                        blocks=[{"type": "section", "text": {"type": "mrkdwn", "text": msg}}],
+                    )
+            else:
+                self.slack_client.files_upload(channels=channels, content=text, title=title)
         except SlackClientError as slack_error:
             self.send_exception(slack_error)
 

nautobot_chatops/dispatchers/webex.py

@@ -94,12 +94,12 @@ def platform_lookup(cls, item_type, item_name):
         return None
 
     @BACKEND_ACTION_MARKDOWN.time()
-    def send_markdown(self, message, ephemeral=False):
+    def send_markdown(self, message, ephemeral=None):
         """Send a markdown-formatted text message to the user/channel specified by the context."""
         self.client.messages.create(roomId=self.context["channel_id"], markdown=message)
 
     @BACKEND_ACTION_BLOCKS.time()
-    def send_blocks(self, blocks, callback_id=None, modal=False, ephemeral=False, title=None):
+    def send_blocks(self, blocks, callback_id=None, modal=False, ephemeral=None, title=None):
         """Send a series of formatting blocks to the user/channel specified by the context."""
         if title and title not in str(blocks[0]):
             blocks.insert(0, self.markdown_element(self.bold(title)))
@@ -119,7 +119,7 @@ def send_image(self, image_path):
         self.client.messages.create(roomId=self.context["channel_id"], files=[image_path])
 
     @BACKEND_ACTION_SNIPPET.time()
-    def send_snippet(self, text, title=None):
+    def send_snippet(self, text, title=None, ephemeral=None):
         """Send a longer chunk of text as a file snippet."""
         return self.send_markdown(f"```\n{text}\n```")
 

tasks.py

@@ -41,12 +41,17 @@ def is_truthy(arg):
 namespace.configure(
     {
         "nautobot_chatops": {
-            "nautobot_ver": "1.0.1",
+            "nautobot_ver": "1.1.6",
             "project_name": "nautobot-chatops",
             "python_ver": "3.6",
             "local": False,
             "compose_dir": os.path.join(os.path.dirname(__file__), "development"),
-            "compose_files": ["docker-compose.requirements.yml", "docker-compose.base.yml", "docker-compose.dev.yml"],
+            "compose_files": [
+                "docker-compose.requirements.yml",
+                # "docker-compose.celery.yml",
+                "docker-compose.base.yml",
+                "docker-compose.dev.yml",
+            ],
         }
     }
 )