from slack.errors import SlackApiError
from turbot.blocks import input_block, section_block, text_block
+from turbot.hunt import find_hunt_for_hunt_id
import turbot.rot
import turbot.sheets
import turbot.slack
import re
import requests
from botocore.exceptions import ClientError
+from boto3.dynamodb.conditions import Key
from turbot.slack import slack_send_message
actions = {}
})
}
+def multi_static_select(turb, payload):
+ """Handler for the action of user entering a multi-select value"""
+
+ return lambda_ok
+
+actions['multi_static_select'] = {"*": multi_static_select}
+
def new_hunt(turb, payload):
"""Handler for the action of user pressing the new_hunt button"""
"Hunt ID can only contain lowercase letters, "
+ "numbers, and underscores")
- # Check to see if the hunts table exists
- hunts_table = turb.db.Table("hunts")
-
+ # Check to see if the turbot table exists
try:
- exists = hunts_table.table_status in ("CREATING", "UPDATING",
- "ACTIVE")
+ exists = turb.table.table_status in ("CREATING", "UPDATING",
+ "ACTIVE")
except ClientError:
exists = False
- # Create the hunts table if necessary.
+ # Create the turbot table if necessary.
if not exists:
- hunts_table = turb.db.create_table(
- TableName='hunts',
+ turb.table = turb.db.create_table(
+ TableName='turbot',
KeySchema=[
- {'AttributeName': 'channel_id', 'KeyType': 'HASH'},
+ {'AttributeName': 'hunt_id', 'KeyType': 'HASH'},
+ {'AttributeName': 'SK', 'KeyType': 'RANGE'},
],
AttributeDefinitions=[
+ {'AttributeName': 'hunt_id', 'AttributeType': 'S'},
+ {'AttributeName': 'SK', 'AttributeType': 'S'},
{'AttributeName': 'channel_id', 'AttributeType': 'S'},
+ {'AttributeName': 'is_hunt', 'AttributeType': 'S'},
],
ProvisionedThroughput={
'ReadCapacityUnits': 5,
'WriteCapacityUnits': 5
- }
+ },
+ GlobalSecondaryIndexes=[
+ {
+ 'IndexName': 'channel_id_index',
+ 'KeySchema': [
+ {'AttributeName': 'channel_id', 'KeyType': 'HASH'}
+ ],
+ 'Projection': {
+ 'ProjectionType': 'ALL'
+ },
+ 'ProvisionedThroughput': {
+ 'ReadCapacityUnits': 5,
+ 'WriteCapacityUnits': 5
+ }
+ },
+ {
+ 'IndexName': 'is_hunt_index',
+ 'KeySchema': [
+ {'AttributeName': 'is_hunt', 'KeyType': 'HASH'}
+ ],
+ 'Projection': {
+ 'ProjectionType': 'ALL'
+ },
+ 'ProvisionedThroughput': {
+ 'ReadCapacityUnits': 5,
+ 'WriteCapacityUnits': 5
+ }
+ }
+ ]
)
- return submission_error("hunt_id",
- "Still bootstrapping hunts table. Try again.")
+ return submission_error(
+ "hunt_id",
+ "Still bootstrapping turbot table. Try again in a minute, please.")
# Create a channel for the hunt
try:
# Insert the newly-created hunt into the database
# (leaving it as non-active for now until the channel-created handler
# finishes fixing it up with a sheet and a companion table)
- hunts_table.put_item(
- Item={
- 'channel_id': channel_id,
- "active": False,
- "name": name,
- "hunt_id": hunt_id,
- "url": url
- }
- )
+ item={
+ "hunt_id": hunt_id,
+ "SK": "hunt-{}".format(hunt_id),
+ "is_hunt": hunt_id,
+ "channel_id": channel_id,
+ "active": False,
+ "name": name,
+ }
+ if url:
+ item['url'] = url
+ turb.table.put_item(Item=item)
# Invite the initiating user to the channel
turb.slack_client.conversations_invite(channel=channel_id, users=user_id)
else:
return (None, None)
-def channel_is_puzzle(turb, channel_id, channel_name):
- """Given a channel ID/name return the database item for the puzzle
+def db_entry_for_channel(turb, channel_id):
+ """Given a channel ID return the database item for this channel
- If this channel is a puzzle, this function returns a tuple:
+ If this channel is a registered hunt or puzzle channel, return the
+ corresponding row from the database for this channel. Otherwise,
+ return None.
- (puzzle, table)
+ Note: If you need to specifically ensure that the channel is a
+ puzzle or a hunt, please call puzzle_for_channel or
+ hunt_for_channel respectively.
+ """
- Where puzzle is dict filled with database entries, and table is a
- database table that can be used to update the puzzle in the
- database.
-
- Otherwise, this function returns (None, None)."""
+ response = turb.table.query(
+ IndexName = "channel_id_index",
+ KeyConditionExpression=Key("channel_id").eq(channel_id)
+ )
- hunt_id = channel_name.split('-')[0]
+ if response['Count'] == 0:
+ return None
- # Not a puzzle channel if there is no hyphen in the name
- if hunt_id == channel_name:
- return (None, None)
+ return response['Items'][0]
- return get_table_item(turb, hunt_id, 'channel_id', channel_id)
-def channel_is_hunt(turb, channel_id):
+def puzzle_for_channel(turb, channel_id):
- """Given a channel ID/name return the database item for the hunt
+ """Given a channel ID return the puzzle from the database for this channel
- Returns a dict (filled with database entries) if there is a hunt
- for this channel, otherwise returns None."""
+ If the given channel_id is a puzzle's channel, this function
+ returns a dict filled with the attributes from the puzzle's entry
+ in the database.
- return get_table_item(turb, "hunts", 'channel_id', channel_id)
+ Otherwise, this function returns None.
+ """
-def find_hunt_for_channel(turb, channel_id, channel_name):
- """Given a channel ID/name find the id/name of the hunt for this channel
+ entry = db_entry_for_channel(turb, channel_id)
- This works whether the original channel is a primary hunt channel,
- or if it is one of the channels of a puzzle belonging to the hunt.
+ if entry and entry['SK'].startswith('puzzle-'):
+ return entry
+ else:
+ return None
- Returns a tuple of (hunt_name, hunt_id) or (None, None)."""
+def hunt_for_channel(turb, channel_id):
- (hunt, _) = channel_is_hunt(turb, channel_id)
+ """Given a channel ID return the hunt from the database for this channel
- if hunt:
- return (hunt['hunt_id'], hunt['name'])
+ This works whether the original channel is a primary hunt channel,
+ or if it is one of the channels of a puzzle belonging to the hunt.
- # So we're not a hunt channel, let's look to see if we are a
- # puzzle channel with a hunt-id prefix.
- hunt_id = channel_name.split('-')[0]
+ Returns None if channel does not belong to a hunt, otherwise a
+ dictionary with all fields from the hunt's row in the table,
+ (channel_id, active, hunt_id, name, url, sheet_url, etc.).
+ """
- hunts_table = turb.db.Table("hunts")
+ entry = db_entry_for_channel(turb, channel_id)
- response = hunts_table.scan(
- FilterExpression='hunt_id = :hunt_id',
- ExpressionAttributeValues={':hunt_id': hunt_id}
- )
+ # We're done if this channel doesn't exist in the database at all
+ if not entry:
+ return None
- if 'Items' in response and len(response['Items']):
- item = response['Items'][0]
- return (item['hunt_id'], item['name'])
+ # Also done if this channel is a hunt channel
+ if entry['SK'].startswith('hunt-'):
+ return entry
- return (None, None)
+ # Otherwise, (the channel is in the database, but is not a hunt),
+ # we expect this to be a puzzle channel instead
+ return find_hunt_for_hunt_id(turb, entry['hunt_id'])
def puzzle(turb, body, args):
"""Implementation of the /puzzle command
a modal dialog for user input instead)."""
channel_id = body['channel_id'][0]
- channel_name = body['channel_name'][0]
trigger_id = body['trigger_id'][0]
- (hunt_id, hunt_name) = find_hunt_for_channel(turb,
- channel_id,
- channel_name)
+ hunt = hunt_for_channel(turb, channel_id)
- if not hunt_id:
+ if not hunt:
return bot_reply("Sorry, this channel doesn't appear to "
+ "be a hunt or puzzle channel")
view = {
"type": "modal",
"private_metadata": json.dumps({
- "hunt_id": hunt_id,
+ "hunt_id": hunt['hunt_id'],
}),
"title": {"type": "plain_text", "text": "New Puzzle"},
"submit": { "type": "plain_text", "text": "Create" },
"blocks": [
- section_block(text_block("*For {}*".format(hunt_name))),
+ section_block(text_block("*For {}*".format(hunt['name']))),
input_block("Puzzle name", "name", "Name of the puzzle"),
input_block("Puzzle URL", "url", "External URL of puzzle",
optional=True)
"Error creating Slack channel {}: {}"
.format(hunt_dash_channel, e.response['error']))
- puzzle_channel_id = response['channel']['id']
+ channel_id = response['channel']['id']
# Insert the newly-created puzzle into the database
- table = turb.db.Table(hunt_id)
- table.put_item(
- Item={
- "channel_id": puzzle_channel_id,
- "orig_channel_name": hunt_dash_channel,
- "solution": [],
- "status": 'unsolved',
- "name": name,
- "puzzle_id": puzzle_id,
- "url": url,
- }
- )
+ item={
+ "hunt_id": hunt_id,
+ "SK": "puzzle-{}".format(puzzle_id),
+ "puzzle_id": puzzle_id,
+ "channel_id": channel_id,
+ "solution": [],
+ "status": 'unsolved',
+ "name": name,
+ }
+ if url:
+ item['url'] = url
+ turb.table.put_item(Item=item)
return lambda_ok
-def rename_channel_to_solved(turb, puzzle):
- orig_channel_name = puzzle['orig_channel_name']
- channel_id = puzzle['channel_id']
- newName = orig_channel_name + '-solved'
- turb.slack_client.conversations_rename(channel=channel_id,
- name=newName)
-
# XXX: This duplicates functionality eith events.py:set_channel_description
def set_channel_topic(turb, puzzle):
channel_id = puzzle['channel_id']
description = ''
if status == 'solved':
- description += "Solved: `{}` ".format('`, `'.join(puzzle['solution']))
+ description += "SOLVED: `{}` ".format('`, `'.join(puzzle['solution']))
description += name
stand or what's needed."""
channel_id = body['channel_id'][0]
- channel_name = body['channel_name'][0]
- (puzzle, table) = channel_is_puzzle(turb, channel_id, channel_name)
+ puzzle = puzzle_for_channel(turb, channel_id)
if not puzzle:
- return bot_reply("Sorry, this is not a puzzle channel.")
+ return bot_reply(
+ "Sorry, the /state command only works in a puzzle channel")
# Set the state field in the database
puzzle['state'] = args
- table.put_item(Item=puzzle)
+ turb.table.put_item(Item=puzzle)
set_channel_topic(turb, puzzle)
The args string should be a confirmed solution."""
channel_id = body['channel_id'][0]
- channel_name = body['channel_name'][0]
user_name = body['user_name'][0]
- (puzzle, table) = channel_is_puzzle(turb, channel_id, channel_name)
+ puzzle = puzzle_for_channel(turb, channel_id)
if not puzzle:
return bot_reply("Sorry, this is not a puzzle channel.")
# Set the status and solution fields in the database
puzzle['status'] = 'solved'
puzzle['solution'].append(args)
- table.put_item(Item=puzzle)
+ turb.table.put_item(Item=puzzle)
# Report the solution to the puzzle's channel
slack_send_message(
turb.slack_client, channel_id,
"Puzzle mark solved by {}: `{}`".format(user_name, args))
+ # Also report the solution to the hunt channel
+ hunt = find_hunt_for_hunt_id(turb, puzzle['hunt_id'])
+ slack_send_message(
+ turb.slack_client, hunt['channel_id'],
+ "Puzzle <{}|{}> has been solved!".format(
+ puzzle['channel_url'],
+ puzzle['name'])
+ )
+
# And update the puzzle's description
set_channel_topic(turb, puzzle)
- # And rename the sheet to prefix with SOLVED -
- turbot.sheets.renameSheet(turb, puzzle['sheet_url'], 'SOLVED - ' + puzzle['name'])
+ # And rename the sheet to prefix with "SOLVED: "
+ turbot.sheets.renameSheet(turb, puzzle['sheet_url'],
+ 'SOLVED: ' + puzzle['name'])
# Finally, rename the Slack channel to add the suffix '-solved'
- rename_channel_to_solved(turb, puzzle)
+ channel_name = "{}-{}-solved".format(
+ puzzle['hunt_id'],
+ puzzle['puzzle_id'])
+ turb.slack_client.conversations_rename(
+ channel=puzzle['channel_id'],
+ name=channel_name)
return lambda_ok
projects / turbot / blobdiff