git.cworth.org Git - turbot/blob - turbot/interaction.py

   1 from slack.errors import SlackApiError
   2 from turbot.blocks import input_block, section_block, text_block
   3 import turbot.rot
   4 import turbot.sheets
   5 import turbot.slack
   6 import json
   7 import re
   8 import requests
   9 from botocore.exceptions import ClientError
  10
  11 actions = {}
  12 commands = {}
  13 submission_handlers = {}
  14
  15 # Hunt and Puzzle IDs are restricted to letters, numbers, and underscores
  16 valid_id_re = r'^[_a-zA-Z0-9]+$'
  17
  18 def bot_reply(message):
  19     """Construct a return value suitable for a bot reply
  20
  21     This is suitable as a way to give an error back to the user who
  22     initiated a slash command, for example."""
  23
  24     return {
  25         'statusCode': 200,
  26         'body': message
  27     }
  28
  29 def submission_error(field, error):
  30     """Construct an error suitable for returning for an invalid submission.
  31
  32     Returning this value will prevent a submission and alert the user that
  33     the given field is invalid because of the given error."""
  34
  35     print("Rejecting invalid modal submission: {}".format(error))
  36
  37     return {
  38         'statusCode': 200,
  39         'headers': {
  40             "Content-Type": "application/json"
  41         },
  42         'body': json.dumps({
  43             "response_action": "errors",
  44             "errors": {
  45                 field: error
  46             }
  47         })
  48     }
  49
  50 def new_hunt(turb, payload):
  51     """Handler for the action of user pressing the new_hunt button"""
  52
  53     view = {
  54         "type": "modal",
  55         "private_metadata": json.dumps({}),
  56         "title": { "type": "plain_text", "text": "New Hunt" },
  57         "submit": { "type": "plain_text", "text": "Create" },
  58         "blocks": [
  59             input_block("Hunt name", "name", "Name of the hunt"),
  60             input_block("Hunt ID", "hunt_id",
  61                         "Used as puzzle channel prefix "
  62                         + "(no spaces nor punctuation)"),
  63             input_block("Hunt URL", "url", "External URL of hunt",
  64                         optional=True)
  65         ],
  66     }
  67
  68     result = turb.slack_client.views_open(trigger_id=payload['trigger_id'],
  69                                           view=view)
  70     if (result['ok']):
  71         submission_handlers[result['view']['id']] = new_hunt_submission
  72
  73     return {
  74         'statusCode': 200,
  75         'body': 'OK'
  76     }
  77
  78 actions['button'] = {"new_hunt": new_hunt}
  79
  80 def new_hunt_submission(turb, payload, metadata):
  81     """Handler for the user submitting the new hunt modal
  82
  83     This is the modal view presented to the user by the new_hunt
  84     function above."""
  85
  86     state = payload['view']['state']['values']
  87     user_id = payload['user']['id']
  88     name = state['name']['name']['value']
  89     hunt_id = state['hunt_id']['hunt_id']['value']
  90     url = state['url']['url']['value']
  91
  92     # Validate that the hunt_id contains no invalid characters
  93     if not re.match(valid_id_re, hunt_id):
  94         return submission_error("hunt_id",
  95                                 "Hunt ID can only contain letters, "
  96                                 + "numbers, and underscores")
  97
  98     # Check to see if the hunts table exists
  99     hunts_table = turb.db.Table("hunts")
 100
 101     try:
 102         exists = hunts_table.table_status in ("CREATING", "UPDATING",
 103                                               "ACTIVE")
 104     except ClientError:
 105         exists = False
 106
 107     # Create the hunts table if necessary.
 108     if not exists:
 109         hunts_table = turb.db.create_table(
 110             TableName='hunts',
 111             KeySchema=[
 112                 {'AttributeName': 'channel_id', 'KeyType': 'HASH'},
 113             ],
 114             AttributeDefinitions=[
 115                 {'AttributeName': 'channel_id', 'AttributeType': 'S'},
 116             ],
 117             ProvisionedThroughput={
 118                 'ReadCapacityUnits': 5,
 119                 'WriteCapacityUnits': 5
 120             }
 121         )
 122         return submission_error("hunt_id",
 123                                 "Still bootstrapping hunts table. Try again.")
 124
 125     # Create a channel for the hunt
 126     try:
 127         response = turb.slack_client.conversations_create(name=hunt_id)
 128     except SlackApiError as e:
 129         return submission_error("hunt_id",
 130                                 "Error creating Slack channel: {}"
 131                                 .format(e.response['error']))
 132
 133     channel_id = response['channel']['id']
 134
 135     # Insert the newly-created hunt into the database
 136     # (leaving it as non-active for now until the channel-created handler
 137     #  finishes fixing it up with a sheet and a companion table)
 138     hunts_table.put_item(
 139         Item={
 140             'channel_id': channel_id,
 141             "active": False,
 142             "name": name,
 143             "hunt_id": hunt_id,
 144             "url": url
 145         }
 146     )
 147
 148     # Invite the initiating user to the channel
 149     turb.slack_client.conversations_invite(channel=channel_id, users=user_id)
 150
 151     return {
 152         'statusCode': 200,
 153     }
 154
 155 def view_submission(turb, payload):
 156     """Handler for Slack interactive view submission
 157
 158     Specifically, those that have a payload type of 'view_submission'"""
 159
 160     view_id = payload['view']['id']
 161     metadata = payload['view']['private_metadata']
 162
 163     if view_id in submission_handlers:
 164         return submission_handlers[view_id](turb, payload, metadata)
 165
 166     print("Error: Unknown view ID: {}".format(view_id))
 167     return {
 168         'statusCode': 400
 169     }
 170
 171 def rot(turb, body, args):
 172     """Implementation of the /rot command
 173
 174     The args string should be as follows:
 175
 176         [count|*] String to be rotated
 177
 178     That is, the first word of the string is an optional number (or
 179     the character '*'). If this is a number it indicates an amount to
 180     rotate each character in the string. If the count is '*' or is not
 181     present, then the string will be rotated through all possible 25
 182     values.
 183
 184     The result of the rotation is returned (with Slack formatting) in
 185     the body of the response so that Slack will provide it as a reply
 186     to the user who submitted the slash command."""
 187
 188     channel_name = body['channel_name'][0]
 189     response_url = body['response_url'][0]
 190     channel_id = body['channel_id'][0]
 191
 192     result = turbot.rot.rot(args)
 193
 194     if (channel_name == "directmessage"):
 195         requests.post(response_url,
 196                       json = {"text": result},
 197                       headers = {"Content-type": "application/json"})
 198     else:
 199         turb.slack_client.chat_postMessage(channel=channel_id, text=result)
 200
 201     return {
 202         'statusCode': 200,
 203         'body': ""
 204     }
 205
 206 commands["/rot"] = rot
 207
 208 def puzzle(turb, body, args):
 209     """Implementation of the /puzzle command
 210
 211     The args string is currently ignored (this command will bring up
 212     a modal dialog for user input instead)."""
 213
 214     channel_id = body['channel_id'][0]
 215     trigger_id = body['trigger_id'][0]
 216
 217     hunts_table = turb.db.Table("hunts")
 218     response = hunts_table.get_item(Key={'channel_id': channel_id})
 219
 220     if 'Item' in response:
 221         hunt_name = response['Item']['name']
 222         hunt_id = response['Item']['hunt_id']
 223     else:
 224         return bot_reply("Sorry, this channel doesn't appear to "
 225                          + "be a hunt channel")
 226
 227     view = {
 228         "type": "modal",
 229         "private_metadata": json.dumps({
 230             "hunt_id": hunt_id,
 231             "hunt_channel_id": channel_id
 232         }),
 233         "title": {"type": "plain_text", "text": "New Puzzle"},
 234         "submit": { "type": "plain_text", "text": "Create" },
 235         "blocks": [
 236             section_block(text_block("*For {}*".format(hunt_name))),
 237             input_block("Puzzle name", "name", "Name of the puzzle"),
 238             input_block("Puzzle ID", "puzzle_id",
 239                         "Used as part of channel name "
 240                         + "(no spaces nor punctuation)"),
 241             input_block("Puzzle URL", "url", "External URL of puzzle",
 242                         optional=True)
 243         ]
 244     }
 245
 246     result = turb.slack_client.views_open(trigger_id=trigger_id,
 247                                           view=view)
 248
 249     if (result['ok']):
 250         submission_handlers[result['view']['id']] = puzzle_submission
 251
 252     return {
 253         'statusCode': 200
 254     }
 255
 256 commands["/puzzle"] = puzzle
 257
 258 def puzzle_submission(turb, payload, metadata):
 259     """Handler for the user submitting the new puzzle modal
 260
 261     This is the modal view presented to the user by the puzzle function
 262     above."""
 263
 264     meta = json.loads(metadata)
 265     hunt_id = meta['hunt_id']
 266     hunt_channel_id = meta['hunt_channel_id']
 267
 268     state = payload['view']['state']['values']
 269     name = state['name']['name']['value']
 270     puzzle_id = state['puzzle_id']['puzzle_id']['value']
 271     url = state['url']['url']['value']
 272
 273     # Validate that the puzzle_id contains no invalid characters
 274     if not re.match(valid_id_re, puzzle_id):
 275         return submission_error("puzzle_id",
 276                                 "Puzzle ID can only contain letters, "
 277                                 + "numbers, and underscores")
 278
 279     # Create a channel for the puzzle
 280     hunt_dash_channel = "{}-{}".format(hunt_id, puzzle_id)
 281
 282     try:
 283         response = turb.slack_client.conversations_create(
 284             name=hunt_dash_channel)
 285     except SlackApiError as e:
 286         return submission_error("puzzle_id",
 287                                 "Error creating Slack channel: {}"
 288                                 .format(e.response['error']))
 289
 290     puzzle_channel_id = response['channel']['id']
 291
 292     # Insert the newly-created puzzle into the database
 293     table = turb.db.Table(hunt_id)
 294     table.put_item(
 295         Item={
 296             "channel_id": puzzle_channel_id,
 297             "solution": [],
 298             "status": 'unsolved',
 299             "name": name,
 300             "puzzle_id": puzzle_id,
 301             "url": url,
 302         }
 303     )
 304
 305     return {
 306         'statusCode': 200
 307     }