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

   1 from turbot.blocks import (
   2     section_block, text_block, button_block, actions_block, divider_block
   3 )
   4 from turbot.hunt import find_hunt_for_hunt_id
   5 from turbot.puzzle import (
   6     puzzle_channel_topic, puzzle_channel_description,
   7 )
   8 from turbot.sheets import (
   9     sheets_create, sheets_create_for_puzzle, sheets_create_folder
  10 )
  11 from turbot.slack import slack_send_message, slack_channel_members
  12 from turbot.channel import channel_url
  13 from boto3.dynamodb.conditions import Key
  14
  15 TURBOT_USER_ID = 'U01B9QM4P9R'
  16
  17 events = {}
  18
  19 lambda_success = {'statusCode': 200}
  20 lambda_error = {'statusCode': 400}
  21
  22 def hunt_link_block(turb, hunt):
  23
  24     name = hunt['name']
  25     channel_id = hunt['channel_id']
  26
  27     hunt_link = "*<{}|{}>*".format(channel_url(channel_id), name)
  28
  29     return section_block(text_block(hunt_link))
  30
  31 def home(turb, user_id):
  32     """Returns a view to be published as the turbot home tab for user_id
  33
  34     The return value is a dictionary suitable to be published to the
  35     Slack views_publish API."""
  36
  37     # Behave cleanly if there is no "turbot" table at all yet.
  38     try:
  39         response = turb.table.scan(
  40             IndexName="is_hunt_index",
  41         )
  42         hunts = response['Items']
  43     except Exception:
  44         hunts = []
  45
  46     my_hunt_blocks = []
  47     available_hunt_blocks = []
  48     for hunt in hunts:
  49         if not hunt['active']:
  50             continue
  51         if user_id in slack_channel_members(turb.slack_client,
  52                                             hunt['channel_id']):
  53             my_hunt_blocks.append(hunt_link_block(turb, hunt))
  54         else:
  55             available_hunt_blocks.append(hunt_link_block(turb, hunt))
  56
  57     if len(my_hunt_blocks):
  58         my_hunt_blocks = [
  59             section_block(text_block("*Hunts you belong to:*")),
  60             divider_block(),
  61             * my_hunt_blocks
  62         ]
  63     else:
  64         my_hunt_blocks.append([
  65             section_block(text_block("You do not belong to any hunts"))
  66         ])
  67
  68     if len(available_hunt_blocks):
  69         available_hunt_blocks = [
  70             section_block(text_block("*Hunts you can join:*")),
  71             divider_block(),
  72             * available_hunt_blocks
  73         ]
  74
  75     return {
  76         "type": "home",
  77         "blocks": [
  78             * my_hunt_blocks,
  79             * available_hunt_blocks,
  80             actions_block(button_block("New hunt", "new_hunt"))
  81         ]
  82     }
  83
  84 def app_home_opened(turb, event):
  85     """Handler for the app_home_opened event
  86
  87     This event occurs when a user visits the home tab for the turbot app.
  88     In response to this event we need to publish a view for the user."""
  89
  90     user_id = event['user']
  91     view = home(turb, user_id)
  92     turb.slack_client.views_publish(user_id=user_id, view=view)
  93     return lambda_success
  94
  95 events['app_home_opened'] = app_home_opened
  96
  97 def hunt_channel_created(turb, channel_name, channel_id):
  98     """Creates a Google sheet for a newly-created hunt channel"""
  99
 100     # First see if we can find an entry for this hunt in the database.
 101     # If not, simply return an error and let Slack retry
 102     response = turb.table.query(
 103         IndexName='channel_id_index',
 104         KeyConditionExpression=Key("channel_id").eq(channel_id)
 105     )
 106     if 'Items' not in response:
 107         print("Warning: Cannot find channel_id {} in turbot table. "
 108               .format(channel_id) + "Letting Slack retry this event")
 109         return lambda_error
 110
 111     hunt = response['Items'][0]
 112
 113     if 'sheet_url' in hunt:
 114         print("Info: channel_id {} already has sheet_url {}. Exiting."
 115               .format(channel_id, hunt['sheet_url']))
 116         return lambda_success
 117
 118     # Before launching into sheet creation, indicate that we're doing this
 119     # in the database. This way, if we take too long to create the sheet
 120     # and Slack retries the event, that next event will see this 'pending'
 121     # string and cleanly return (eliminating all future retries).
 122     hunt['sheet_url'] = 'pending'
 123     turb.table.put_item(Item=hunt)
 124
 125     # Also, let the channel users know what we are up to
 126     slack_send_message(
 127         turb.slack_client, channel_id,
 128         "Welcome to the channel for the {} hunt! ".format(hunt['name'])
 129         + "Please wait a moment or two while I create some backend resources.")
 130
 131     # Create a new folder within Google drive for the hunt in two parts:
 132
 133     # ... first, a top-level folder named for the hunt
 134     hunt_folder = sheets_create_folder(turb, hunt['hunt_id'])
 135
 136     # ... second, a folder within that named "turbot"
 137     #
 138     # The concept here is that non-turbot related content could
 139     # be placed adjacent to the turbot folder.
 140     hunt['folder_id'] = sheets_create_folder(turb, "turbot",
 141                                              parents = [hunt_folder])
 142
 143     # Create a sheet for the hunt
 144     sheet = sheets_create(turb, hunt['name'], hunt['folder_id'])
 145     hunt['sheet_url'] = sheet['url']
 146
 147     # Message the channel with the URL of the sheet
 148     slack_send_message(turb.slack_client, channel_id,
 149                        "Sheet created for this hunt: {}".format(sheet['url']))
 150
 151     # Mark the hunt as active now
 152     hunt['active'] = True
 153
 154     # Update the database with all the changes we have made to the hunt
 155     turb.table.put_item(Item=hunt)
 156
 157     # Message the hunt channel that the database is ready
 158     slack_send_message(
 159         turb.slack_client, channel_id,
 160         "Thank you for waiting. This hunt is now ready to begin! "
 161         + "Type `/new` to create a puzzle for the hunt and `/help` for help.")
 162
 163     return lambda_success
 164
 165 def set_channel_topic_and_description(turb, puzzle):
 166
 167     channel_id = puzzle['channel_id']
 168
 169     topic = puzzle_channel_topic(puzzle)
 170     description = puzzle_channel_description(puzzle)
 171
 172     turb.slack_client.conversations_setPurpose(channel=channel_id,
 173                                                purpose=description)
 174     turb.slack_client.conversations_setTopic(channel=channel_id,
 175                                              topic=topic)
 176
 177 def puzzle_channel_created(turb, channel_name, channel_id):
 178     """Creates sheet and invites user for a newly-created puzzle channel"""
 179
 180     # First see if we can find an entry for this puzzle in the database.
 181     # If not, simply return an error and let Slack retry
 182     response = turb.table.query(
 183         IndexName="channel_id_index",
 184         KeyConditionExpression=Key("channel_id").eq(channel_id),
 185     )
 186     if 'Items' not in response:
 187         print("Warning: Cannot find channel_id {} in turbot table. "
 188               .format(channel_id) + "Letting Slack retry this event")
 189         return lambda_error
 190
 191     puzzle = response['Items'][0]
 192
 193     if 'sheet_url' in puzzle:
 194         print("Info: channel_id {} already has sheet_url {}. Exiting."
 195               .format(channel_id, puzzle['sheet_url']))
 196         return lambda_success
 197
 198     # We need hunt from the database to know which folder to create
 199     # the sheet in.
 200     hunt_id = puzzle['hunt_id']
 201     hunt = find_hunt_for_hunt_id(turb, hunt_id)
 202
 203     # Before launching into sheet creation, indicate that we're doing this
 204     # in the database. This way, if we take too long to create the sheet
 205     # and Slack retries the event, that next event will see this 'pending'
 206     # string and cleanly return (eliminating all future retries).
 207     puzzle['sheet_url'] = 'pending'
 208     puzzle['channel_url'] = channel_url(channel_id)
 209     turb.table.put_item(Item=puzzle)
 210
 211     # Create a sheet for the puzzle
 212     sheet = sheets_create_for_puzzle(turb, puzzle, hunt['folder_id'])
 213
 214     # Update the database with the URL of the sheet
 215     puzzle['sheet_url'] = sheet['url']
 216     turb.table.put_item(Item=puzzle)
 217
 218     # Get the new sheet_url into the channel topic and description
 219     set_channel_topic_and_description(turb, puzzle)
 220
 221     # Lookup and invite all users from this hunt to this new puzzle
 222
 223     # Find all members of the hunt channel
 224     members = slack_channel_members(turb.slack_client, hunt['channel_id'])
 225
 226     # Filter out Turbot's own ID to avoid inviting itself
 227     # has opted out of being auto-invited
 228     members = [m for m in members if m != TURBOT_USER_ID]
 229
 230     slack_send_message(
 231         turb.slack_client, channel_id,
 232         "Inviting all members from the hunt channel: "
 233         + "<#{}>".format(hunt['channel_id']))
 234
 235     # Invite those members to the puzzle channel (in chunks of 500)
 236     cursor = 0
 237     while cursor < len(members):
 238         turb.slack_client.conversations_invite(
 239             channel=channel_id,
 240             users=members[cursor:cursor + 500])
 241         cursor += 500
 242
 243     # And finally, give a welcome message with some documentation
 244     # on how to update the state of the puzzle in the database.
 245     welcome_msg = (
 246         "Welcome! This channel is the primary place to "
 247         + "discuss things as the team works together to solve the "
 248         + "puzzle \"{}\". ".format(puzzle['name'])
 249     )
 250
 251     if 'url' in puzzle:
 252         welcome_msg += (
 253             "See the <{}|puzzle itself> ".format(puzzle['url'])
 254             + "for what was originally presented to us. "
 255         )
 256
 257     welcome_msg += (
 258         "Actual puzzle solving work will take place within the following " +
 259         "<{}|shared spreadsheet> ".format(puzzle['sheet_url']) +
 260         "\n\n"
 261         "Common commands for updating the puzzle are `/state NEW STATE`, " +
 262         "`/tag NEW_TAG`, and `/solved SOLUTION` . See `/help` for details " +
 263         "and for additional commands."
 264     )
 265
 266     turb.slack_client.chat_postMessage(channel=channel_id, text=welcome_msg)
 267
 268     # Finally, finally, notify the hunt channel about the new puzzle
 269     slack_send_message(
 270         turb.slack_client, hunt['channel_id'],
 271         "New puzzle available: <{}|{}>".format(
 272             puzzle['channel_url'],
 273             puzzle['name'])
 274     )
 275
 276     return lambda_success
 277
 278 def channel_created(turb, event):
 279
 280     channel = event['channel']
 281     channel_id = channel['id']
 282     channel_name = channel['name']
 283     creator = channel['creator']
 284
 285     # Ignore any channels that turbot didn't create
 286     if creator != TURBOT_USER_ID:
 287         print("channel_created: Not a turbot-created channel. Exiting.")
 288         return lambda_success
 289
 290     # The presence of a hyphen determines whether this is a puzzle
 291     # channel or a hunt channel.
 292     if '-' in channel_name:
 293         return puzzle_channel_created(turb, channel_name, channel_id)
 294     else:
 295         return hunt_channel_created(turb, channel_name, channel_id)
 296
 297 events['channel_created'] = channel_created