)
from turbot.channel import channel_url
from boto3.dynamodb.conditions import Key
+import turbot.sheets
import re
-def find_puzzle_for_puzzle_id(turb, hunt_id, puzzle_id):
- """Given a hunt_id and puzzle_id, return that puzzle
+def find_puzzle_for_sort_key(turb, hunt_id, sort_key):
+ """Given a hunt_id and sort_key, return that puzzle
- Returns None if no puzzle with the given hunt_id and puzzle_id
+ Returns None if no puzzle with the given hunt_id and sort_key
exists in the database, otherwise a dictionary with all fields
from the puzzle's row in the database.
+
+ Note: The sort_key is a modified version of the puzzle_id, (used
+ to make metapuzzles appear in the ordering before non-metapuzzles).
+ If you've been handed a sort_key, then looking up a puzzle by
+ sort_key is the right thing to do. But if you instead have just
+ a puzzle_id, see find_puzzle_for_puzzle_id rather than trying
+ to convert the puzzle_id into a sort_key to use this function.
"""
response = turb.table.get_item(
Key={
'hunt_id': hunt_id,
- 'SK': 'puzzle-{}'.format(puzzle_id)
+ 'SK': sort_key,
})
if 'Item' in response:
else:
return None
+def find_puzzle_for_puzzle_id(turb, hunt_id, puzzle_id):
+ """Given a hunt_id and puzzle_id, return that puzzle
+
+ Returns None if no puzzle with the given hunt_id and puzzle_id
+ exists in the database, otherwise a dictionary with all fields
+ from the puzzle's row in the database.
+
+ Note: The sort_key is a modified version of the puzzle_id, (used
+ to make metapuzzles appear in the ordering before non-metapuzzles).
+ If you've been handed a sort_key, then looking up a puzzle by
+ sort_key is the right thing to do. But if you instead have just
+ a puzzle_id, see find_puzzle_for_puzzle_id rather than trying
+ to convert the puzzle_id into a sort_key to use this function.
+ """
+
+ response = turb.table.query(
+ IndexName='puzzle_id_index',
+ KeyConditionExpression=(
+ Key('hunt_id').eq(hunt_id) &
+ Key('puzzle_id').eq(puzzle_id)
+ )
+ )
+
+ if response['Count'] == 0:
+ return None
+
+ return response['Items'][0]
+
def find_puzzle_for_url(turb, hunt_id, url):
"""Given a hunt_id and URL, return the puzzle with that URL
return response['Items'][0]
-def puzzle_blocks(puzzle):
+def puzzle_blocks(puzzle, include_rounds=False):
"""Generate Slack blocks for a puzzle
The puzzle argument should be a dictionary as returned from the
url = puzzle.get('url', None)
sheet_url = puzzle.get('sheet_url', None)
state = puzzle.get('state', None)
+ tags = puzzle.get('tags', [])
status_emoji = ''
solution_str = ''
if len(solution):
solution_str = "*`" + '`, `'.join(solution) + "`*"
+ meta_str = ''
+ if puzzle.get('type', 'plain') == 'meta':
+ meta_str = "*META* "
+
links = []
if url:
links.append("<{}|Puzzle>".format(url))
state_str = ''
if state:
- state_str = "\n{}".format(state)
+ state_str = " State: {}".format(state)
+
+ tags_str = ''
+ if tags:
+ tags_str = " Tags: "+" ".join(["`{}`".format(tag) for tag in tags])
+
+ extra_str = ''
+ if state_str or tags_str:
+ extra_str = "\n{}{}".format(tags_str, state_str)
+
+ rounds_str = ''
+ if include_rounds and 'rounds' in puzzle:
+ rounds = puzzle['rounds']
+ rounds_str = " in round{}: {}".format(
+ "s" if len(rounds) > 1 else "",
+ ", ".join(rounds)
+ )
- puzzle_text = "{}{} <{}|{}> ({}){}".format(
- status_emoji, solution_str,
+ puzzle_text = "{} {}<{}|{}> {} ({}){}{}".format(
+ status_emoji,
+ meta_str,
channel_url(channel_id), name,
- ', '.join(links), state_str
+ solution_str,
+ ', '.join(links), rounds_str,
+ extra_str
)
# 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)
)
]
"""Returns True if this puzzle matches the given string (regexp)
A match will be considered on any of puzzle title, round title,
- puzzle URL, puzzle state, or solution string. The string can
- include regular expression syntax. Matching is case insensitive.
+ puzzle URL, puzzle state, puzzle type, tags, or solution
+ string. The string can include regular expression syntax. Matching
+ is case insensitive.
"""
p = re.compile('.*'+pattern+'.*', re.IGNORECASE)
if p.match(puzzle['state']):
return True
+ if 'type' in puzzle:
+ if p.match(puzzle['type']):
+ return True
+
if 'solution' in puzzle:
for solution in puzzle['solution']:
if p.match(solution):
return True
+ if 'tags' in puzzle:
+ for tag in puzzle['tags']:
+ if p.match(tag):
+ return True
+
return False
def puzzle_matches_all(puzzle, patterns):
"""Returns True if this puzzle matches all of the given list of patterns
A match will be considered on any of puzzle title, round title,
- puzzle URL, puzzle state, or solution string. All patterns must
- match the puzzle somewhere, (that is, there is an implicit logical
- AND between patterns). Patterns can include regular expression
- syntax. Matching is case insensitive.
+ puzzle URL, puzzle state, puzzle types, tags, or solution
+ string. All patterns must match the puzzle somewhere, (that is,
+ there is an implicit logical AND between patterns). Patterns can
+ include regular expression syntax. Matching is case insensitive.
+
"""
for pattern in patterns:
return False
return True
+
+def puzzle_id_from_name(name):
+ return re.sub(r'[^a-zA-Z0-9_]', '', name).lower()
+
+def round_id_from_name(name):
+ """Normalize and abbreviate round name for use as a prefix
+ in a channel name."""
+
+ return re.sub(r'[^a-zA-Z0-9_]', '', name).lower()[:7]
+
+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"""
+
+ topic = ''
+
+ if puzzle['status'] == 'solved':
+ topic += "SOLVED: `{}` ".format('`, `'.join(puzzle['solution']))
+
+ links = []
+
+ url = puzzle.get('url', None)
+ if url:
+ links.append("<{}|Puzzle>".format(url))
+
+ sheet_url = puzzle.get('sheet_url', None)
+ if sheet_url:
+ links.append("<{}|Sheet>".format(sheet_url))
+
+ if len(links):
+ topic += "({}) ".format(', '.join(links))
+
+ tags = puzzle.get('tags', [])
+ if tags:
+ topic += " {}".format(" ".join(["`{}`".format(t) for t in tags]))
+
+ state = puzzle.get('state', None)
+ if state:
+ topic += " {}".format(state)
+
+ return topic
+
+def puzzle_channel_description(puzzle):
+ """Compute the channel description for a puzzle"""
+
+ url = puzzle.get('url', None)
+ sheet_url = puzzle.get('sheet_url', None)
+ tags = puzzle.get('tags', [])
+ state = puzzle.get('state', None)
+
+ description = (
+ "Puzzle: \"{}\".\n".format(puzzle['name'])
+ )
+
+ links = ''
+ if url:
+ links += " <{}|Original puzzle> ".format(url)
+
+ if sheet_url:
+ links += " <{}|Sheet>".format(sheet_url)
+
+ if links:
+ description += "Links:{}\n".format(links)
+
+ if tags:
+ description += "Tags: {}\n".format(
+ " ".join(["`{}`".format(t) for t in tags]))
+
+ if state:
+ description += "State: {}\n".format(state)
+
+ return description
+
+def puzzle_channel_name(puzzle):
+ """Compute the channel name for a puzzle"""
+
+ round = ''
+ if 'rounds' in puzzle:
+ round = '-' + round_id_from_name(puzzle['rounds'][0])
+
+ meta = ''
+ if puzzle.get('type', 'plain') == 'meta':
+ meta = '--m'
+
+ # Note: We don't use puzzle['puzzle_id'] here because we're keeping
+ # that as a persistent identifier in the database. Instead we
+ # create a new ID-like identifier from the current name.
+ channel_name = "{}{}{}-{}".format(
+ puzzle['hunt_id'],
+ round,
+ meta,
+ puzzle_id_from_name(puzzle['name'])
+ )
+
+ if puzzle['status'] == 'solved':
+ channel_name += "-solved"
+
+ return channel_name
+
+def puzzle_sheet_name(puzzle):
+ """Compute the sheet name for a puzzle"""
+
+ sheet_name = puzzle['name']
+ if puzzle['status'] == 'solved':
+ sheet_name += " - Solved {}".format(", ".join(puzzle['solution']))
+
+ return sheet_name
+
+def puzzle_update_channel_and_sheet(turb, puzzle, old_puzzle=None):
+
+ channel_id = puzzle['channel_id']
+
+ # Compute the channel topic and set it if it has changed
+ channel_topic = puzzle_channel_topic(puzzle)
+
+ old_channel_topic = None
+ if old_puzzle:
+ old_channel_topic = puzzle_channel_topic(old_puzzle)
+
+ if channel_topic != old_channel_topic:
+ # Slack only allows 250 characters for a topic
+ if len(channel_topic) > 250:
+ channel_topic = channel_topic[:247] + "..."
+ turb.slack_client.conversations_setTopic(channel=channel_id,
+ topic=channel_topic)
+
+ # Compute the channel description and set it if it has changed
+ channel_description = puzzle_channel_description(puzzle)
+
+ old_channel_description = None
+ if old_puzzle:
+ old_channel_description = puzzle_channel_description(old_puzzle)
+
+ if channel_description != old_channel_description:
+ # Slack also only allows 250 characters for a description
+ if len(channel_description) > 250:
+ channel_description = channel_description[:247] + "..."
+ turb.slack_client.conversations_setPurpose(channel=channel_id,
+ purpose=channel_description)
+
+ # Compute the sheet name and set it if it has changed
+ sheet_name = puzzle_sheet_name(puzzle)
+
+ old_sheet_name = None
+ if old_puzzle:
+ old_sheet_name = puzzle_sheet_name(old_puzzle)
+
+ if sheet_name != old_sheet_name:
+ turbot.sheets.rename_spreadsheet(turb, puzzle['sheet_url'], sheet_name)
+
+ # Compute the Slack channel name and set it if it has changed
+ channel_name = puzzle_channel_name(puzzle)
+
+ old_channel_name = None
+ if old_puzzle:
+ old_channel_name = puzzle_channel_name(old_puzzle)
+
+ if channel_name != old_channel_name:
+ turb.slack_client.conversations_rename(
+ channel=channel_id,
+ name=channel_name
+ )
+
+# A copy deep enough to work for puzzle_update_channel_and_sheet above
+def puzzle_copy(old_puzzle):
+ new_puzzle = old_puzzle.copy()
+
+ if 'tags' in old_puzzle:
+ new_puzzle['tags'] = old_puzzle['tags'].copy()
+
+ if 'solution' in old_puzzle:
+ new_puzzle['solution'] = old_puzzle['solution'].copy()
+
+ return new_puzzle
projects / turbot / blobdiff