X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=turbot%2Fpuzzle.py;h=d24a7c9a4da955120f565a3ea43db4e8d66f61d5;hb=5f24de7e9cdb24f5bf751e3ce1d6d7333241747f;hp=1dbea5d74906c447b3e6b09df70758f4379389d5;hpb=0878d40471403513b6da016d7412d07a5d903e9b;p=turbot diff --git a/turbot/puzzle.py b/turbot/puzzle.py index 1dbea5d..d24a7c9 100644 --- a/turbot/puzzle.py +++ b/turbot/puzzle.py @@ -7,11 +7,18 @@ import turbot.sheets import re def find_puzzle_for_sort_key(turb, hunt_id, sort_key): - """Given a hunt_id and puzzle_id, return that puzzle + """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( @@ -25,6 +32,34 @@ def find_puzzle_for_sort_key(turb, hunt_id, sort_key): 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 @@ -214,8 +249,6 @@ def puzzle_channel_topic(puzzle): if puzzle['status'] == 'solved': topic += "SOLVED: `{}` ".format('`, `'.join(puzzle['solution'])) - topic += puzzle['name'] - links = [] url = puzzle.get('url', None) @@ -227,7 +260,7 @@ def puzzle_channel_topic(puzzle): links.append("<{}|Sheet>".format(sheet_url)) if len(links): - topic += "({})".format(', '.join(links)) + topic += "({}) ".format(', '.join(links)) tags = puzzle.get('tags', []) if tags: @@ -239,14 +272,55 @@ def puzzle_channel_topic(puzzle): 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 = '-' + puzzle_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( + channel_name = "{}{}{}-{}".format( puzzle['hunt_id'], + round, + meta, puzzle_id_from_name(puzzle['name']) ) @@ -282,6 +356,20 @@ def puzzle_update_channel_and_sheet(turb, puzzle, old_puzzle=None): 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) @@ -290,7 +378,7 @@ def puzzle_update_channel_and_sheet(turb, puzzle, old_puzzle=None): old_sheet_name = puzzle_sheet_name(old_puzzle) if sheet_name != old_sheet_name: - turbot.sheets.renameSheet(turb, puzzle['sheet_url'], 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) @@ -312,4 +400,7 @@ def puzzle_copy(old_puzzle): 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