import re
import requests
from botocore.exceptions import ClientError
+from turbot.slack import slack_send_message
actions = {}
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]+$'
+
+lambda_ok = {'statusCode': 200}
def bot_reply(message):
"""Construct a return value suitable for a bot reply
if (result['ok']):
submission_handlers[result['view']['id']] = new_hunt_submission
- return {
- 'statusCode': 200,
- 'body': 'OK'
- }
+ return lambda_ok
actions['button'] = {"new_hunt": new_hunt}
# 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
# Invite the initiating user to the channel
turb.slack_client.conversations_invite(channel=channel_id, users=user_id)
- return {
- 'statusCode': 200,
- }
+ return lambda_ok
def view_submission(turb, payload):
"""Handler for Slack interactive view submission
else:
turb.slack_client.chat_postMessage(channel=channel_id, text=result)
- return {
- 'statusCode': 200,
- 'body': ""
- }
+ return lambda_ok
commands["/rot"] = rot
if 'Item' in response:
return (response['Item'], table)
else:
- return None
+ return (None, None)
def channel_is_puzzle(turb, channel_id, channel_name):
"""Given a channel ID/name return the database item for the puzzle
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)."""
+ 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_, hun_id, name, url, sheet_url, etc.).
+
+ """
- (hunt, hunts_table) = channel_is_hunt(turb, channel_id)
+ (hunt, _) = channel_is_hunt(turb, channel_id)
if hunt:
- return (hunt['hunt_id'], hunt['name'])
+ return 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]
+ hunts_table = turb.db.Table("hunts")
+
response = hunts_table.scan(
FilterExpression='hunt_id = :hunt_id',
ExpressionAttributeValues={':hunt_id': hunt_id}
)
- if 'Items' in response:
+ if 'Items' in response and len(response['Items']):
item = response['Items'][0]
- return (item['hunt_id'], item['name'])
+ return item
- return (None, None)
+ return None
def puzzle(turb, body, args):
"""Implementation of the /puzzle command
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 = find_hunt_for_channel(turb,
+ channel_id,
+ channel_name)
- 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 ID", "puzzle_id",
- "Used as part of channel name "
- + "(no spaces nor punctuation)"),
input_block("Puzzle URL", "url", "External URL of puzzle",
optional=True)
]
if (result['ok']):
submission_handlers[result['view']['id']] = puzzle_submission
- return {
- 'statusCode': 200
- }
+ return lambda_ok
commands["/puzzle"] = puzzle
state = payload['view']['state']['values']
name = state['name']['name']['value']
- puzzle_id = state['puzzle_id']['puzzle_id']['value']
url = state['url']['url']['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, "
- + "numbers, and underscores")
+ # Create a Slack-channel-safe puzzle_id
+ puzzle_id = re.sub(r'[^a-zA-Z0-9_]', '', name).lower()
# Create a channel for the puzzle
hunt_dash_channel = "{}-{}".format(hunt_id, puzzle_id)
response = turb.slack_client.conversations_create(
name=hunt_dash_channel)
except SlackApiError as e:
- return submission_error("puzzle_id",
- "Error creating Slack channel: {}"
- .format(e.response['error']))
+ return submission_error(
+ "name",
+ "Error creating Slack channel {}: {}"
+ .format(hunt_dash_channel, e.response['error']))
puzzle_channel_id = response['channel']['id']
table.put_item(
Item={
"channel_id": puzzle_channel_id,
+ "orig_channel_name": hunt_dash_channel,
"solution": [],
"status": 'unsolved',
"name": name,
}
)
- return {
- 'statusCode': 200
- }
+ 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 = puzzle['name']
+ name = puzzle['name']
url = puzzle.get('url', None)
sheet_url = puzzle.get('sheet_url', None)
state = puzzle.get('state', None)
+ status = puzzle['status']
+
+ description = ''
+
+ if status == 'solved':
+ description += "SOLVED: `{}` ".format('`, `'.join(puzzle['solution']))
+
+ description += name
links = []
if url:
table.put_item(Item=puzzle)
set_channel_topic(turb, puzzle)
+
+ return lambda_ok
+
+commands["/state"] = state
+
+def solved(turb, body, args):
+ """Implementation of the /solved command
+
+ 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)
+
+ 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)
+
+ # 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, _) = get_table_item(turb, "hunts", "hunt_id", 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'])
+
+ # Finally, rename the Slack channel to add the suffix '-solved'
+ rename_channel_to_solved(turb, puzzle)
+
+ return lambda_ok
+
+commands["/solved"] = solved
projects / turbot / blobdiff