commands = {}
submission_handlers = {}
-# Hunt and Puzzle IDs are restricted to letters, numbers, and underscores
-valid_id_re = r'^[_a-zA-Z0-9]+$'
+# Hunt/Puzzle IDs are restricted to lowercase letters, numbers, and underscores
+valid_id_re = r'^[_a-z0-9]+$'
def bot_reply(message):
"""Construct a return value suitable for a bot reply
# Validate that the hunt_id contains no invalid characters
if not re.match(valid_id_re, hunt_id):
return submission_error("hunt_id",
- "Hunt ID can only contain letters, "
+ "Hunt ID can only contain lowercase letters, "
+ "numbers, and underscores")
# Check to see if the hunts table exists
commands["/rot"] = rot
+def get_table_item(turb, table_name, key, value):
+ """Get an item from the database 'table_name' with 'key' as 'value'
+
+ Returns a tuple of (item, table) if found and (None, None) otherwise."""
+
+ table = turb.db.Table(table_name)
+
+ response = table.get_item(Key={key: value})
+
+ if 'Item' in response:
+ return (response['Item'], table)
+ else:
+ return None
+
+def channel_is_puzzle(turb, channel_id, channel_name):
+ """Given a channel ID/name return the database item for the puzzle
+
+ If this channel is a puzzle, this function returns a tuple:
+
+ (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)
+
+ return get_table_item(turb, hunt_id, 'channel_id', channel_id)
+
+def channel_is_hunt(turb, channel_id):
+
+ """Given a channel ID/name return the database item for the hunt
+
+ Returns a dict (filled with database entries) if there is a hunt
+ for this channel, otherwise returns None."""
+
+ return get_table_item(turb, "hunts", 'channel_id', channel_id)
+
+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
+
+ 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 a tuple of (hunt_name, hunt_id) or (None, None)."""
+
+ (hunt, hunts_table) = channel_is_hunt(turb, channel_id)
+
+ if hunt:
+ return (hunt['hunt_id'], hunt['name'])
+
+ # 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]
+
+ response = hunts_table.scan(
+ FilterExpression='hunt_id = :hunt_id',
+ ExpressionAttributeValues={':hunt_id': hunt_id}
+ )
+
+ if 'Items' in response:
+ item = response['Items'][0]
+ return (item['hunt_id'], item['name'])
+
+ return (None, None)
+
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]
- hunts_table = turb.db.Table("hunts")
- response = hunts_table.get_item(Key={'channel_id': channel_id})
+ (hunt_id, hunt_name) = find_hunt_for_channel(turb,
+ channel_id,
+ channel_name)
- if 'Item' in response:
- hunt_name = response['Item']['name']
- hunt_id = response['Item']['hunt_id']
- else:
+ if not hunt_id:
return bot_reply("Sorry, this channel doesn't appear to "
- + "be a hunt channel")
+ + "be a hunt or puzzle channel")
view = {
"type": "modal",
"private_metadata": json.dumps({
"hunt_id": hunt_id,
- "hunt_channel_id": channel_id
}),
"title": {"type": "plain_text", "text": "New Puzzle"},
"submit": { "type": "plain_text", "text": "Create" },
meta = json.loads(metadata)
hunt_id = meta['hunt_id']
- hunt_channel_id = meta['hunt_channel_id']
state = payload['view']['state']['values']
name = state['name']['name']['value']
# Validate that the puzzle_id contains no invalid characters
if not re.match(valid_id_re, puzzle_id):
return submission_error("puzzle_id",
- "Puzzle ID can only contain letters, "
+ "Puzzle ID can only contain lowercase letters, "
+ "numbers, and underscores")
# Create a channel for the puzzle
return {
'statusCode': 200
}
+
+# XXX: This duplicates functionality eith events.py:set_channel_description
+def set_channel_topic(turb, puzzle):
+ channel_id = puzzle['channel_id']
+ description = puzzle['name']
+ url = puzzle.get('url', None)
+ sheet_url = puzzle.get('sheet_url', None)
+ state = puzzle.get('state', None)
+
+ links = []
+ if url:
+ links.append("<{}|Puzzle>".format(url))
+ if sheet_url:
+ links.append("<{}|Sheet>".format(sheet_url))
+
+ if len(links):
+ description += "({})".format(', '.join(links))
+
+ if state:
+ description += " {}".format(state)
+
+ turb.slack_client.conversations_setTopic(channel=channel_id,
+ topic=description)
+
+def state(turb, body, args):
+ """Implementation of the /state command
+
+ The args string should be a brief sentence describing where things
+ 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)
+
+ if not puzzle:
+ return bot_reply("Sorry, this is not a puzzle channel.")
+
+ # Set the state field in the database
+ puzzle['state'] = args
+ table.put_item(Item=puzzle)
+
+ set_channel_topic(turb, puzzle)
projects / turbot / blobdiff