git.cworth.org Git - turbot/blob - turbot/hunt.py

   1 from turbot.blocks import section_block, text_block, divider_block
   2 from turbot.round import round_blocks
   3 from turbot.puzzle import puzzle_blocks, puzzle_matches_all
   4 from turbot.channel import channel_url
   5 from boto3.dynamodb.conditions import Key
   6
   7 def find_hunt_for_hunt_id(turb, hunt_id):
   8     """Given a hunt ID find the database item for that hunt
   9
  10     Returns None if hunt ID is not found, otherwise a
  11     dictionary with all fields from the hunt's row in the table,
  12     (channel_id, active, hunt_id, name, url, sheet_url, etc.).
  13     """
  14
  15     response = turb.table.get_item(
  16         Key={
  17             'hunt_id': hunt_id,
  18             'SK': 'hunt-{}'.format(hunt_id)
  19         })
  20
  21     if 'Item' in response:
  22         return response['Item']
  23     else:
  24         return None
  25
  26 def hunt_puzzles_for_hunt_id(turb, hunt_id):
  27     """Return all puzzles that belong to the given hunt_id"""
  28
  29     response = turb.table.query(
  30         KeyConditionExpression=(
  31             Key('hunt_id').eq(hunt_id) &
  32             Key('SK').begins_with('puzzle-')
  33         )
  34     )
  35
  36     return response['Items']
  37
  38 def hunt_blocks(turb, hunt, puzzle_status='unsolved', search_terms=[],
  39                 limit_to_rounds=None):
  40     """Generate Slack blocks for a hunt
  41
  42     The hunt argument should be a dictionary as returned from the
  43     database.
  44
  45     Three optional arguments can be used to filter which puzzles to
  46     include in the result:
  47
  48       puzzle_status: If either 'solved' or 'unsolved' only puzzles
  49                      with that status will be included in the
  50                      result. If any other value, all puzzles in the
  51                      hunt will be considered.
  52
  53       search_terms: A list of search terms. Only puzzles that match
  54                     all of these terms will be included in the
  55                     result. A match will be considered on any of
  56                     puzzle title, round title, puzzle URL, puzzle
  57                     state or solution string. Terms can include
  58                     regular expression syntax.
  59
  60       limit_to_rounds: A list of rounds. If provided only the given
  61                        rounds will be included in the output. Note:
  62                        an empty list means to display only puzzles
  63                        assigned to no rounds, while an argument of
  64                        None means to display all puzzles with no
  65                        limit on the rounds.
  66
  67     The return value can be used in a Slack command expecting blocks to
  68     provide all the details of a hunt, (puzzles, their state,
  69     solution, links to channels and sheets, etc.).
  70
  71     """
  72
  73     name = hunt['name']
  74     hunt_id = hunt['hunt_id']
  75     channel_id = hunt['channel_id']
  76
  77     puzzles = hunt_puzzles_for_hunt_id(turb, hunt_id)
  78
  79     # Filter the set of puzzles according the the requested puzzle_status
  80     if puzzle_status in ('solved', 'unsolved'):
  81         puzzles = [p for p in puzzles if p['status'] == puzzle_status]
  82     else:
  83         puzzle_status = 'all'
  84
  85     if search_terms:
  86         puzzles = [puzzle for puzzle in puzzles
  87                    if puzzle_matches_all(puzzle, search_terms)]
  88
  89     # Compute the set of rounds across all puzzles
  90     rounds = set()
  91     for puzzle in puzzles:
  92         if 'rounds' not in puzzle:
  93             continue
  94         for round in puzzle['rounds']:
  95             rounds.add(round)
  96
  97     hunt_text = "*{} puzzles in hunt <{}|{}>*".format(
  98         puzzle_status.capitalize(),
  99         channel_url(channel_id),
 100         name
 101     )
 102     if limit_to_rounds is not None:
 103         hunt_text += " *in round{}: {}*".format(
 104             "s" if len(limit_to_rounds) > 1 else "",
 105             ", ".join(limit_to_rounds) if limit_to_rounds else "<no round>"
 106         )
 107     if search_terms:
 108         quoted_terms = ['`{}`'.format(term) for term in search_terms]
 109         hunt_text += " matching {}".format(" AND ".join(quoted_terms))
 110
 111     blocks = [
 112         section_block(text_block(hunt_text)),
 113     ]
 114
 115     if not len(puzzles):
 116         blocks += [
 117             section_block(text_block("No puzzles found."))
 118         ]
 119
 120     # Construct blocks for each round
 121     for round in rounds:
 122         if limit_to_rounds is not None and round not in limit_to_rounds:
 123             continue
 124         # If we're only displaying one round the round header is redundant
 125         if limit_to_rounds and len(limit_to_rounds) == 1:
 126             blocks += round_blocks(round, puzzles, omit_header=True)
 127         else:
 128             blocks += round_blocks(round, puzzles)
 129         blocks.append(divider_block())
 130
 131     # Also blocks for any puzzles not in any round
 132     stray_puzzles = [puzzle for puzzle in puzzles if 'rounds' not in puzzle]
 133
 134     # For this condition, either limit_to_rounds is None which
 135     # means we definitely want to display these stray puzzles
 136     # (since we are not limiting), _OR_ limit_to_rounds is not
 137     # None but is a zero-length array, meaning we are limiting
 138     # to rounds but specifically the round of unassigned puzzles
 139     if len(stray_puzzles) and not limit_to_rounds:
 140         stray_text = "*Puzzles with no assigned round*"
 141         blocks.append(section_block(text_block(stray_text)))
 142         for puzzle in stray_puzzles:
 143             blocks += puzzle_blocks(puzzle)
 144
 145     blocks.append(divider_block())
 146
 147     return blocks