add message report action button

Author: AllenAnthes

pybot/endpoints/slack/actions.py

@@ -16,6 +16,37 @@ def create_endpoints(plugin):
     plugin.on_action("reset_claim_mentee", claim_mentee, wait=False)
     plugin.on_action("claimed", claimed, name='claimed', wait=False)
     plugin.on_action("claimed", reset_claim, name='reset_claim', wait=False)
+    plugin.on_action("report_message", open_report_dialog, wait=False)
+    plugin.on_action("report_dialog", send_report, wait=False)
+
+
+async def send_report(action: Action, app: SirBot):
+    """
+    Called when a user submits the report dialog.  Pulls the original message
+    info from the state and posts the details to the moderators channel
+    """
+    slack_id = action['user']['id']
+    details = action['submission']['details']
+    message_details = json.loads(action.action['state'])
+
+    response = build_report_message(slack_id, details, message_details)
+
+    await app["plugins"]["slack"].api.query(methods.CHAT_POST_MESSAGE, response)
+
+
+async def open_report_dialog(action: Action, app: SirBot):
+    """
+    Opens the message reporting dialog for the user to provide details.
+
+    Adds the message that they're reporting to the dialog's hidden state
+    to be pulled out when submitted.
+    """
+    trigger_id = action['trigger_id']
+    response = {
+        'trigger_id': trigger_id,
+        'dialog': report_dialog(action),
+    }
+    await app.plugins["slack"].api.query(methods.DIALOG_OPEN, response)
 
 
 async def resource_buttons(action: Action, app: SirBot):

pybot/endpoints/slack/utils/action_messages.py

@@ -1,8 +1,11 @@
+import json
 from time import time
 from typing import List
 
 from slack.events import Message
 
+from pybot.endpoints.slack.utils import REPORT_CHANNEL
+
 
 def now():
     """
@@ -111,6 +114,62 @@ def suggestion_dialog(trigger_id):
     }
 
 
+def report_dialog(action):
+    trigger_id = action['trigger_id']
+
+    user = action['message'].get('user') or action['message'].get('username')  # for bots
+    message_data = {
+        'text': action['message']['text'],
+        'user': user,
+        'channel': action['channel']
+    }
+    return {
+        "callback_id": "report_dialog",
+        "state": json.dumps(message_data),
+        "title": "Report details",
+        "submit_label": "Submit",
+        "trigger_id": trigger_id,
+        "elements": [{
+            "type": "textarea",
+            "label": "Details",
+            "name": "details",
+            "placeholder": "",
+            "required": False
+        }]
+    }
+
+
+def build_report_message(slack_id, details, message_details):
+    message = f'<@{slack_id}> sent a report with details: {details}'
+
+    attachment = [{
+        "fields": [
+            {
+                "title": "User",
+                "value": f"<@{message_details['user']}>",
+                "short": True
+            },
+            {
+                "title": "Channel",
+                "value": f"<#{message_details['channel']['id']}|{message_details['channel']['name']}>",
+                "short": True
+            },
+            {
+                "title": "Message",
+                "value": message_details['text'],
+                "short": False
+            }
+
+        ]
+    }]
+
+    return {
+        "text": message,
+        "channel": REPORT_CHANNEL,
+        "attachments": attachment
+    }
+
+
 def mentee_claimed_attachment(user_id: str, record: str) -> List[dict]:
     return [{
         "text": f":100: Request claimed by <@{user_id}>:100:\n"