from slack.errors import SlackApiError
-from turbot.blocks import input_block, section_block, text_block
+from turbot.blocks import (
+ input_block, section_block, text_block, multi_select_block
+)
+from turbot.hunt import find_hunt_for_hunt_id, hunt_blocks
+from turbot.puzzle import find_puzzle_for_url
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"""
turb.table = turb.db.create_table(
TableName='turbot',
KeySchema=[
- {'AttributeName': 'PK', 'KeyType': 'HASH'},
- {'AttributeName': 'SK', 'KeyType': 'RANGE'},
+ {'AttributeName': 'hunt_id', 'KeyType': 'HASH'},
+ {'AttributeName': 'SK', 'KeyType': 'RANGE'}
],
AttributeDefinitions=[
- {'AttributeName': 'PK', 'AttributeType': 'S'},
+ {'AttributeName': 'hunt_id', 'AttributeType': 'S'},
{'AttributeName': 'SK', 'AttributeType': 'S'},
{'AttributeName': 'channel_id', 'AttributeType': 'S'},
- {'AttributeName': 'hunt_id', 'AttributeType': 'S'},
+ {'AttributeName': 'is_hunt', 'AttributeType': 'S'},
+ {'AttributeName': 'url', 'AttributeType': 'S'}
],
ProvisionedThroughput={
'ReadCapacityUnits': 5,
}
},
{
- 'IndexName': 'hunt_id_index',
+ 'IndexName': 'is_hunt_index',
'KeySchema': [
- {'AttributeName': 'hunt_id', 'KeyType': 'HASH'}
+ {'AttributeName': 'is_hunt', 'KeyType': 'HASH'}
],
'Projection': {
'ProjectionType': 'ALL'
'WriteCapacityUnits': 5
}
}
+ ],
+ LocalSecondaryIndexes = [
+ {
+ 'IndexName': 'url_index',
+ 'KeySchema': [
+ {'AttributeName': 'hunt_id', 'KeyType': 'HASH'},
+ {'AttributeName': 'url', 'KeyType': 'RANGE'},
+ ],
+ 'Projection': {
+ 'ProjectionType': 'ALL'
+ }
+ }
]
)
- return submission_error("hunt_id",
- "Still bootstrapping turbot 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)
- turb.table.put_item(
- Item={
- "PK": "hunt-{}".format(hunt_id),
- "SK": "hunt-{}".format(hunt_id),
- "hunt_id": hunt_id,
- "channel_id": channel_id,
- "active": False,
- "name": name,
- "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)
-
- 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)."""
-
- hunt_id = channel_name.split('-')[0]
-
- # Not a puzzle channel if there is no hyphen in the name
- if hunt_id == channel_name:
- return (None, None)
+ 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.
+ """
- return get_table_item(turb, hunt_id, 'channel_id', channel_id)
+ response = turb.table.query(
+ IndexName = "channel_id_index",
+ KeyConditionExpression=Key("channel_id").eq(channel_id)
+ )
-def channel_is_hunt(turb, channel_id):
+ if response['Count'] == 0:
+ return None
- """Given a channel ID/name return the database item for the hunt
+ return response['Items'][0]
- Returns a dict (filled with database entries) if there is a hunt
- for this channel, otherwise returns None."""
- return get_table_item(turb, "channel_id_index", 'channel_id', channel_id)
+def puzzle_for_channel(turb, channel_id):
-def find_hunt_for_hunt_id(turb, hunt_id):
- """Given a hunt ID find the database for for that hunt
+ """Given a channel ID return the puzzle from the database for this channel
- Returns None if hunt ID is not found, otherwise a
- dictionary with all fields from the hunt's row in the table,
- (channel_id, active, hunt_id, name, url, sheet_url, etc.).
+ 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.
+ Otherwise, this function returns None.
"""
- turbot_table = turb.db.Table("turbot")
- response = turbot_table.get_item(Key={'PK': 'hunt-{}'.format(hunt_id)})
+ entry = db_entry_for_channel(turb, channel_id)
- if 'Item' in response:
- return response['Item']
+ if entry and entry['SK'].startswith('puzzle-'):
+ return entry
else:
return 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
+def hunt_for_channel(turb, channel_id):
+
+ """Given a channel ID return the hunt from the database for this channel
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.
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.).
-
"""
- (hunt, _) = channel_is_hunt(turb, channel_id)
+ entry = db_entry_for_channel(turb, channel_id)
+
+ # We're done if this channel doesn't exist in the database at all
+ if not entry:
+ return None
+
+ # Also done if this channel is a hunt channel
+ if entry['SK'].startswith('hunt-'):
+ return entry
+
+ # 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'])
+
+# python3.9 has a built-in removeprefix but AWS only has python3.8
+def remove_prefix(text, prefix):
+ if text.startswith(prefix):
+ return text[len(prefix):]
+ return text
+
+def hunt_rounds(turb, hunt_id):
+ """Returns array of strings giving rounds that exist in the given hunt"""
- if hunt:
- return hunt
+ response = turb.table.query(
+ KeyConditionExpression=(
+ Key('hunt_id').eq(hunt_id) &
+ Key('SK').begins_with('round-')
+ )
+ )
- # 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]
+ if response['Count'] == 0:
+ return []
- return find_hunt_for_hunt_id(turb, hunt_id)
+ return [remove_prefix(option['SK'], 'round-')
+ for option in response['Items']]
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 = find_hunt_for_channel(turb,
- channel_id,
- channel_name)
+ hunt = hunt_for_channel(turb, channel_id)
if not hunt:
return bot_reply("Sorry, this channel doesn't appear to "
+ "be a hunt or puzzle channel")
+ round_options = hunt_rounds(turb, hunt['hunt_id'])
+
+ if len(round_options):
+ round_options_block = [
+ multi_select_block("Round(s)", "rounds",
+ "Existing round(s) this puzzle belongs to",
+ round_options)
+ ]
+ else:
+ round_options_block = []
+
view = {
"type": "modal",
"private_metadata": json.dumps({
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),
+ * round_options_block,
+ input_block("New round(s)", "new_rounds",
+ "New round(s) this puzzle belongs to " +
+ "(comma separated)",
optional=True)
]
}
This is the modal view presented to the user by the puzzle function
above."""
+ # First, read all the various data from the request
meta = json.loads(metadata)
hunt_id = meta['hunt_id']
state = payload['view']['state']['values']
name = state['name']['name']['value']
url = state['url']['url']['value']
+ if 'rounds' in state:
+ rounds = [option['value'] for option in
+ state['rounds']['rounds']['selected_options']]
+ else:
+ rounds = []
+ new_rounds = state['new_rounds']['new_rounds']['value']
+
+ # Before doing anything, reject this puzzle if a puzzle already
+ # exists with the same URL.
+ if url:
+ existing = find_puzzle_for_url(turb, hunt_id, url)
+ if existing:
+ return submission_error(
+ "url",
+ "Error: A puzzle with this URL already exists.")
# Create a Slack-channel-safe puzzle_id
puzzle_id = re.sub(r'[^a-zA-Z0-9_]', '', name).lower()
"Error creating Slack channel {}: {}"
.format(hunt_dash_channel, e.response['error']))
- puzzle_channel_id = response['channel']['id']
+ channel_id = response['channel']['id']
+
+ # Add any new rounds to the database
+ if new_rounds:
+ for round in new_rounds.split(','):
+ # Drop any leading/trailing spaces from the round name
+ round = round.strip()
+ # Ignore any empty string
+ if not len(round):
+ continue
+ rounds.append(round)
+ turb.table.put_item(
+ Item={
+ 'hunt_id': hunt_id,
+ 'SK': 'round-' + round
+ }
+ )
# Insert the newly-created puzzle into the database
- table = turb.db.Table(hunt_id)
- table.put_item(
- Item={
- "channel_id": puzzle_channel_id,
- "solution": [],
- "status": 'unsolved',
- "hunt_id": hunt_id,
- "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
+ if rounds:
+ item['rounds'] = rounds
+ turb.table.put_item(Item=item)
return lambda_ok
if state:
description += " {}".format(state)
+ # Slack only allows 250 characters for a topic
+ if len(description) > 250:
+ description = description[:247] + "..."
+
turb.slack_client.conversations_setTopic(channel=channel_id,
topic=description)
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.")
+ if not args:
+ return bot_reply(
+ "Error, no solution provided. Usage: `/solved SOLUTION HERE`")
+
# Set the status and solution fields in the database
puzzle['status'] = 'solved'
puzzle['solution'].append(args)
- table.put_item(Item=puzzle)
+ if 'state' in puzzle:
+ del puzzle['state']
+ turb.table.put_item(Item=puzzle)
# Report the solution to the puzzle's channel
slack_send_message(
return lambda_ok
commands["/solved"] = solved
+
+
+def hunt(turb, body, args):
+ """Implementation of the /hunt command
+
+ The (optional) args string should be one of 'all', 'solved', or
+ 'unsolved' to indicate which set of puzzles should be
+ displayed. If omitted, this command will default to showing only
+ unsolved puzzles.
+ """
+
+ channel_id = body['channel_id'][0]
+ response_url = body['response_url'][0]
+
+ hunt = hunt_for_channel(turb, channel_id)
+
+ if not hunt:
+ return bot_reply("Sorry, this channel doesn't appear to "
+ + "be a hunt or puzzle channel")
+
+ blocks = hunt_blocks(turb, hunt)
+
+ requests.post(response_url,
+ json = { 'blocks': blocks },
+ headers = {'Content-type': 'application/json'}
+ )
+
+ return lambda_ok
+
+commands["/hunt"] = hunt