from turbot.hunt import find_hunt_for_hunt_id, hunt_blocks
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
)
import turbot.rot
import turbot.sheets
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,
)
# 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)
# Construct a puzzle dict
puzzle = {
"hunt_id": hunt_id,
- "SK": "puzzle-{}".format(puzzle_id),
"puzzle_id": puzzle_id,
"channel_id": channel_id,
"solution": [],
if rounds:
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)
import turbot.sheets
import re
-def find_puzzle_for_puzzle_id(turb, hunt_id, puzzle_id):
+def find_puzzle_for_sort_key(turb, hunt_id, sort_key):
"""Given a hunt_id and puzzle_id, return that puzzle
Returns None if no puzzle with the given hunt_id and puzzle_id
response = turb.table.get_item(
Key={
'hunt_id': hunt_id,
- 'SK': 'puzzle-{}'.format(puzzle_id)
+ 'SK': sort_key,
})
if 'Item' in response:
)
# Combining hunt ID and puzzle ID together here is safe because
- # both IDs are restricted to not contain a hyphen, (see
+ # hunt_id is restricted to not contain a hyphen, (see
# valid_id_re in interaction.py)
- hunt_and_puzzle = "{}-{}".format(puzzle['hunt_id'], puzzle['puzzle_id'])
+ hunt_and_sort_key = "{}-{}".format(puzzle['hunt_id'], puzzle['SK'])
return [
accessory_block(
section_block(text_block(puzzle_text)),
- button_block("✏", "edit_puzzle", hunt_and_puzzle)
+ button_block("✏", "edit_puzzle", hunt_and_sort_key)
)
]
def puzzle_id_from_name(name):
return re.sub(r'[^a-zA-Z0-9_]', '', name).lower()
+def puzzle_sort_key(puzzle):
+ """Return an appropriate sort key for a puzzle in the database
+
+ The sort key must start with "puzzle-" to distinguish puzzle items
+ in the database from all non-puzzle items. After that, though, the
+ only requirements are that each puzzle have a unique key and they
+ give us the ordering we want. And for ordering, we want meta puzzles
+ before non-meta puzzles and then alphabetical order by name within
+ each of those groups.
+
+ So puting a "-meta-" prefix in front of the puzzle ID does the trick.
+ """
+
+ return "puzzle-{}{}".format(
+ "-meta-" if puzzle['type'] == "meta" else "",
+ puzzle['puzzle_id']
+ )
+
def puzzle_channel_topic(puzzle):
"""Compute the channel topic for a puzzle"""