from turbot.blocks import (
input_block, section_block, text_block, multi_select_block, checkbox_block
)
-from turbot.hunt import find_hunt_for_hunt_id, hunt_blocks
+from turbot.hunt import (
+ find_hunt_for_hunt_id,
+ hunt_blocks,
+ hunt_puzzles_for_hunt_id
+)
from turbot.puzzle import (
find_puzzle_for_url,
- find_puzzle_for_puzzle_id,
+ find_puzzle_for_sort_key,
puzzle_update_channel_and_sheet,
puzzle_id_from_name,
- puzzle_blocks
+ puzzle_blocks,
+ puzzle_sort_key,
+ puzzle_copy
)
+from turbot.round import round_quoted_puzzles_titles_answers
import turbot.rot
import turbot.sheets
import turbot.slack
actions['multi_static_select'] = {"*": multi_static_select}
+def edit(turb, body, args):
+
+ """Implementation of the `/edit` command
+
+ To edit the puzzle for the current channel.
+
+ This is simply a shortcut for `/puzzle edit`.
+ """
+
+ return edit_puzzle_command(turb, body)
+
+commands["/edit"] = edit
+
+
def edit_puzzle_command(turb, body):
"""Implementation of the `/puzzle edit` command
response_url = payload['response_url']
trigger_id = payload['trigger_id']
- (hunt_id, puzzle_id) = action_id.split('-', 1)
+ (hunt_id, sort_key) = action_id.split('-', 1)
- puzzle = find_puzzle_for_puzzle_id(turb, hunt_id, puzzle_id)
+ puzzle = find_puzzle_for_sort_key(turb, hunt_id, sort_key)
if not puzzle:
requests.post(response_url,
input_block("Puzzle URL", "url", "External URL of puzzle",
initial_value=puzzle.get("url", None),
optional=True),
+ checkbox_block("Is this a meta puzzle?", "Meta", "meta",
+ checked=(puzzle.get('type', 'plain') == 'meta')),
* round_options_block,
input_block("New round(s)", "new_rounds",
"New round(s) this puzzle belongs to " +
url = state['url']['url']['value']
if url:
puzzle['url'] = url
+ if state['meta']['meta']['selected_options']:
+ puzzle['type'] = 'meta'
+ else:
+ puzzle['type'] = 'plain'
rounds = [option['value'] for option in
state['rounds']['rounds']['selected_options']]
if rounds:
)
# Get old puzzle from the database (to determine what's changed)
- old_puzzle = find_puzzle_for_puzzle_id(turb,
- puzzle['hunt_id'],
- puzzle['puzzle_id'])
+ old_puzzle = find_puzzle_for_sort_key(turb,
+ puzzle['hunt_id'],
+ puzzle['SK'])
+
+ # If we are changing puzzle type (meta -> plain or plain -> meta)
+ # the the sort key has to change, so compute the new one and delete
+ # the old item from the database.
+ #
+ # XXX: We should really be using a transaction here to combine the
+ # delete_item and the put_item into a single transaction, but
+ # the boto interface is annoying in that transactions are only on
+ # the "Client" object which has a totally different interface than
+ # the "Table" object I've been using so I haven't figured out how
+ # to do that yet.
+
+ if puzzle['type'] != old_puzzle.get('type', 'plain'):
+ puzzle['SK'] = puzzle_sort_key(puzzle)
+ turb.table.delete_item(Key={
+ 'hunt_id': old_puzzle['hunt_id'],
+ 'SK': old_puzzle['SK']
+ })
# Update the puzzle in the database
turb.table.put_item(Item=puzzle)
blocks = puzzle_blocks(puzzle, include_rounds=True)
+ # For a meta puzzle, also display the titles and solutions for all
+ # puzzles in the same round.
+ if puzzle.get('type', 'plain') == 'meta':
+ puzzles = hunt_puzzles_for_hunt_id(turb, puzzle['hunt_id'])
+
+ # Drop this puzzle itself from the report
+ puzzles = [p for p in puzzles if p['puzzle_id'] != puzzle['puzzle_id']]
+
+ for round in puzzle.get('rounds', [None]):
+ answers = round_quoted_puzzles_titles_answers(round, puzzles)
+ blocks += [
+ section_block(text_block(
+ "*Feeder solutions from round {}*".format(
+ round if round else "<none>"
+ ))),
+ section_block(text_block(answers))
+ ]
+
requests.post(response_url,
json = {'blocks': blocks},
headers = {'Content-type': 'application/json'}
commands["/puzzle"] = puzzle
+def new(turb, body, args):
+ """Implementation of the `/new` command
+
+ To create a new puzzle.
+
+ This is simply a shortcut for `/puzzle new`.
+ """
+
+ return new_puzzle(turb, body)
+
+commands["/new"] = new
+
def new_puzzle(turb, body):
"""Implementation of the "/puzzle new" command
input_block("Puzzle name", "name", "Name of the puzzle"),
input_block("Puzzle URL", "url", "External URL of puzzle",
optional=True),
+ checkbox_block("Is this a meta puzzle?", "Meta", "meta"),
* round_options_block,
input_block("New round(s)", "new_rounds",
"New round(s) this puzzle belongs to " +
state = payload['view']['state']['values']
name = state['name']['name']['value']
url = state['url']['url']['value']
+ if state['meta']['meta']['selected_options']:
+ puzzle_type = 'meta'
+ else:
+ puzzle_type = 'plain'
if 'rounds' in state:
rounds = [option['value'] for option in
state['rounds']['rounds']['selected_options']]
}
)
- # Insert the newly-created puzzle into the database
- item={
+ # Construct a puzzle dict
+ puzzle = {
"hunt_id": hunt_id,
- "SK": "puzzle-{}".format(puzzle_id),
"puzzle_id": puzzle_id,
"channel_id": channel_id,
"solution": [],
"status": 'unsolved',
"name": name,
+ "type": puzzle_type
}
if url:
- item['url'] = url
+ puzzle['url'] = url
if rounds:
- item['rounds'] = rounds
- turb.table.put_item(Item=item)
+ puzzle['rounds'] = rounds
+
+ # Finally, compute the appropriate sort key
+ puzzle["SK"] = puzzle_sort_key(puzzle)
+
+ # Insert the newly-created puzzle into the database
+ turb.table.put_item(Item=puzzle)
return lambda_ok
return bot_reply(
"Sorry, the /state command only works in a puzzle channel")
- # Make a copy of the puzzle object
- puzzle = old_puzzle.copy()
+ # Make a deep copy of the puzzle object
+ puzzle = puzzle_copy(old_puzzle)
# Update the puzzle in the database
puzzle['state'] = args
commands["/state"] = state
+def tag(turb, body, args):
+ """Implementation of the `/tag` command.
+
+ Arg is either a tag to add (optionally prefixed with '+'), or if
+ prefixed with '-' is a tag to remove.
+ """
+
+ if not args:
+ return bot_reply("Usage: `/tag [+]TAG_TO_ADD` "
+ + "or `/tag -TAG_TO_REMOVE`.")
+
+ channel_id = body['channel_id'][0]
+
+ old_puzzle = puzzle_for_channel(turb, channel_id)
+
+ if not old_puzzle:
+ return bot_reply(
+ "Sorry, the /tag command only works in a puzzle channel")
+
+ if args[0] == '-':
+ tag = args[1:]
+ action = 'remove'
+ else:
+ tag = args
+ if tag[0] == '+':
+ tag = tag[1:]
+ action = 'add'
+
+ # Force tag to all uppercase
+ tag = tag.upper()
+
+ # Reject a tag that is not alphabetic or underscore A-Z_
+ if not re.match(r'^[A-Z0-9_]*$', tag):
+ return bot_reply("Sorry, tags can only contain letters, numbers, "
+ + "and the underscore character.")
+
+ if action == 'remove':
+ if 'tags' not in old_puzzle or tag not in old_puzzle['tags']:
+ return bot_reply("Nothing to do. This puzzle is not tagged "
+ + "with the tag: {}".format(tag))
+ else:
+ if 'tags' in old_puzzle and tag in old_puzzle['tags']:
+ return bot_reply("Nothing to do. This puzzle is already tagged "
+ + "with the tag: {}".format(tag))
+
+ # OK. Error checking is done. Let's get to work
+
+ # Make a deep copy of the puzzle object
+ puzzle = puzzle_copy(old_puzzle)
+
+ if action == 'remove':
+ puzzle['tags'] = [t for t in puzzle['tags'] if t != tag]
+ else:
+ if 'tags' not in puzzle:
+ puzzle['tags'] = [tag]
+ else:
+ puzzle['tags'].append(tag)
+
+ turb.table.put_item(Item=puzzle)
+
+ puzzle_update_channel_and_sheet(turb, puzzle, old_puzzle=old_puzzle)
+
+ return lambda_ok
+
+commands["/tag"] = tag
+
def solved(turb, body, args):
"""Implementation of the /solved command
The args string should be a confirmed solution."""
channel_id = body['channel_id'][0]
- user_name = body['user_name'][0]
+ user_id = body['user_id'][0]
old_puzzle = puzzle_for_channel(turb, channel_id)
return bot_reply(
"Error, no solution provided. Usage: `/solved SOLUTION HERE`")
- # Make a copy of the puzzle object
- puzzle = old_puzzle.copy()
+ # Make a deep copy of the puzzle object
+ puzzle = puzzle_copy(old_puzzle)
# Set the status and solution fields in the database
puzzle['status'] = 'solved'
# Report the solution to the puzzle's channel
slack_send_message(
turb.slack_client, channel_id,
- "Puzzle mark solved by {}: `{}`".format(user_name, args))
+ "Puzzle mark solved by <@{}>: `{}`".format(user_id, args))
# Also report the solution to the hunt channel
hunt = find_hunt_for_hunt_id(turb, puzzle['hunt_id'])
character in a term). All terms must match on a puzzle in order
for that puzzle to be included. But a puzzle will be considered to
match if any of the puzzle title, round title, puzzle URL, puzzle
- state, or puzzle solution match. Matching will be performed
- without regard to case sensitivity and the search terms can
- include regular expression syntax.
+ state, puzzle type, tags, or puzzle solution match. Matching will
+ be performed without regard to case sensitivity and the search
+ terms can include regular expression syntax.
+
"""
channel_id = body['channel_id'][0]