X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=turbot%2Fpuzzle.py;h=f0456c6cba4c29d05cf4dcc23ed96953fea5c940;hb=915b439e07c5b4aaef754f5f41360d862149a3fc;hp=810c97e5e671c977bab712b79acd4ddf973e5516;hpb=0076b5c890b0a6cfb61dac56f94e71566c669bc2;p=turbot diff --git a/turbot/puzzle.py b/turbot/puzzle.py index 810c97e..f0456c6 100644 --- a/turbot/puzzle.py +++ b/turbot/puzzle.py @@ -1,6 +1,29 @@ -from turbot.blocks import section_block, text_block +from turbot.blocks import ( + section_block, text_block, button_block, accessory_block +) 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 + + 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. + """ + + response = turb.table.get_item( + Key={ + 'hunt_id': hunt_id, + 'SK': 'puzzle-{}'.format(puzzle_id) + }) + + if 'Item' in response: + return response['Item'] + else: + return None def find_puzzle_for_url(turb, hunt_id, url): """Given a hunt_id and URL, return the puzzle with that URL @@ -23,7 +46,7 @@ def find_puzzle_for_url(turb, hunt_id, url): return response['Items'][0] -def puzzle_block(puzzle): +def puzzle_blocks(puzzle): """Generate Slack blocks for a puzzle The puzzle argument should be a dictionary as returned from the @@ -66,4 +89,161 @@ def puzzle_block(puzzle): ', '.join(links), state_str ) - return section_block(text_block(puzzle_text)) + # Combining hunt ID and puzzle ID together here is safe because + # both IDs are restricted to not contain a hyphen, (see + # valid_id_re in interaction.py) + hunt_and_puzzle = "{}-{}".format(puzzle['hunt_id'], puzzle['puzzle_id']) + + return [ + accessory_block( + section_block(text_block(puzzle_text)), + button_block("✏", "edit_puzzle", hunt_and_puzzle) + ) + ] + +def puzzle_matches_one(puzzle, pattern): + """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. + """ + + p = re.compile('.*'+pattern+'.*', re.IGNORECASE) + + if p.match(puzzle['name']): + return True + + if 'rounds' in puzzle: + for round in puzzle['rounds']: + if p.match(round): + return True + + if 'url' in puzzle: + if p.match(puzzle['url']): + return True + + if 'state' in puzzle: + if p.match(puzzle['state']): + return True + + if 'solution' in puzzle: + for solution in puzzle['solution']: + if p.match(solution): + 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. + """ + + for pattern in patterns: + if not puzzle_matches_one(puzzle, pattern): + return False + + return True + +def puzzle_id_from_name(name): + return re.sub(r'[^a-zA-Z0-9_]', '', name).lower() + +def puzzle_channel_topic(puzzle): + """Compute the channel topic for a puzzle""" + + topic = '' + + if puzzle['status'] == 'solved': + topic += "SOLVED: `{}` ".format('`, `'.join(puzzle['solution'])) + + topic += puzzle['name'] + + 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)) + + state = puzzle.get('state', None) + if state: + topic += " {}".format(state) + + return topic + +def puzzle_channel_name(puzzle): + """Compute the channel name for a puzzle""" + + # Note: We don't use puzzle['hunt_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'], + 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 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.renameSheet(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 + )