]> git.cworth.org Git - turbot/blobdiff - turbot/interaction.py
Add a /tag command to add or remove tags from puzzle
[turbot] / turbot / interaction.py
index f9640ca3473b3abb8adc8e742b9065112c389158..fb11599034fc1f518a1ec7a19a7d54ade43862be 100644 (file)
@@ -2,14 +2,20 @@ from slack.errors import SlackApiError
 from turbot.blocks import (
     input_block, section_block, text_block, multi_select_block, checkbox_block
 )
-from turbot.hunt import find_hunt_for_hunt_id, hunt_blocks
+from turbot.hunt import (
+    find_hunt_for_hunt_id,
+    hunt_blocks,
+    hunt_puzzles_for_hunt_id
+)
 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
 )
+from turbot.round import round_quoted_puzzles_titles_answers
 import turbot.rot
 import turbot.sheets
 import turbot.slack
@@ -75,6 +81,20 @@ def multi_static_select(turb, payload):
 
 actions['multi_static_select'] = {"*": multi_static_select}
 
+def edit(turb, body, args):
+
+    """Implementation of the `/edit` command
+
+    To edit the puzzle for the current channel.
+
+    This is simply a shortcut for `/puzzle edit`.
+    """
+
+    return edit_puzzle_command(turb, body)
+
+commands["/edit"] = edit
+
+
 def edit_puzzle_command(turb, body):
     """Implementation of the `/puzzle edit` command
 
@@ -100,9 +120,9 @@ def edit_puzzle_button(turb, payload):
     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,
@@ -160,6 +180,8 @@ def edit_puzzle(turb, puzzle, trigger_id):
             input_block("Puzzle URL", "url", "External URL of puzzle",
                         initial_value=puzzle.get("url", None),
                         optional=True),
+            checkbox_block("Is this a meta puzzle?", "Meta", "meta",
+                           checked=(puzzle.get('type', 'plain') == 'meta')),
             * round_options_block,
             input_block("New round(s)", "new_rounds",
                         "New round(s) this puzzle belongs to " +
@@ -212,6 +234,10 @@ def edit_puzzle_submission(turb, payload, metadata):
     url = state['url']['url']['value']
     if url:
         puzzle['url'] = url
+    if state['meta']['meta']['selected_options']:
+        puzzle['type'] = 'meta'
+    else:
+        puzzle['type'] = 'plain'
     rounds = [option['value'] for option in
               state['rounds']['rounds']['selected_options']]
     if rounds:
@@ -259,9 +285,27 @@ def edit_puzzle_submission(turb, payload, metadata):
             )
 
     # 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)
@@ -639,6 +683,24 @@ def puzzle(turb, body, args):
 
     blocks = puzzle_blocks(puzzle, include_rounds=True)
 
+    # For a meta puzzle, also display the titles and solutions for all
+    # puzzles in the same round.
+    if puzzle['type'] == 'meta':
+        puzzles = hunt_puzzles_for_hunt_id(turb, puzzle['hunt_id'])
+
+        # Drop this puzzle itself from the report
+        puzzles = [p for p in puzzles if p['puzzle_id'] != puzzle['puzzle_id']]
+
+        for round in puzzle.get('rounds', [None]):
+            answers = round_quoted_puzzles_titles_answers(round, puzzles)
+            blocks += [
+                section_block(text_block(
+                    "*Feeder solutions from round {}*".format(
+                        round if round else "<none>"
+                    ))),
+                section_block(text_block(answers))
+            ]
+
     requests.post(response_url,
                   json = {'blocks': blocks},
                   headers = {'Content-type': 'application/json'}
@@ -648,6 +710,18 @@ def puzzle(turb, body, args):
 
 commands["/puzzle"] = puzzle
 
+def new(turb, body, args):
+    """Implementation of the `/new` command
+
+    To create a new puzzle.
+
+    This is simply a shortcut for `/puzzle new`.
+    """
+
+    return new_puzzle(turb, body)
+
+commands["/new"] = new
+
 def new_puzzle(turb, body):
     """Implementation of the "/puzzle new" command
 
@@ -686,6 +760,7 @@ def new_puzzle(turb, body):
             input_block("Puzzle name", "name", "Name of the puzzle"),
             input_block("Puzzle URL", "url", "External URL of puzzle",
                         optional=True),
+            checkbox_block("Is this a meta puzzle?", "Meta", "meta"),
             * round_options_block,
             input_block("New round(s)", "new_rounds",
                         "New round(s) this puzzle belongs to " +
@@ -716,6 +791,10 @@ def new_puzzle_submission(turb, payload, metadata):
     state = payload['view']['state']['values']
     name = state['name']['name']['value']
     url = state['url']['url']['value']
+    if state['meta']['meta']['selected_options']:
+        puzzle_type = 'meta'
+    else:
+        puzzle_type = 'plain'
     if 'rounds' in state:
         rounds = [option['value'] for option in
                   state['rounds']['rounds']['selected_options']]
@@ -765,21 +844,26 @@ def new_puzzle_submission(turb, payload, metadata):
                 }
             )
 
-    # Insert the newly-created puzzle into the database
-    item={
+    # Construct a puzzle dict
+    puzzle = {
         "hunt_id": hunt_id,
-        "SK": "puzzle-{}".format(puzzle_id),
         "puzzle_id": puzzle_id,
         "channel_id": channel_id,
         "solution": [],
         "status": 'unsolved',
         "name": name,
+        "type": puzzle_type
     }
     if url:
-        item['url'] = url
+        puzzle['url'] = url
     if rounds:
-        item['rounds'] = rounds
-    turb.table.put_item(Item=item)
+        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)
 
     return lambda_ok
 
@@ -810,6 +894,72 @@ def state(turb, body, args):
 
 commands["/state"] = state
 
+def tag(turb, body, args):
+    """Implementation of the `/tag` command.
+
+    Arg is either a tag to add (optionally prefixed with '+'), or if
+    prefixed with '-' is a tag to remove.
+    """
+
+    if not args:
+        return bot_reply("Usage: `/tag [+]TAG_TO_ADD` "
+                         + "or `/tag -TAG_TO_REMOVE`.")
+
+    channel_id = body['channel_id'][0]
+
+    old_puzzle = puzzle_for_channel(turb, channel_id)
+
+    if not old_puzzle:
+        return bot_reply(
+            "Sorry, the /tag command only works in a puzzle channel")
+
+    if args[0] == '-':
+        tag = args[1:]
+        action = 'remove'
+    else:
+        tag = args
+        if tag[0] == '+':
+            tag = tag[1:]
+        action = 'add'
+
+    # Force tag to all uppercase
+    tag = tag.upper()
+
+    # Reject a tag that is not alphabetic or underscore A-Z_
+    if not re.match(r'^[A-Z_]*$', tag):
+        return bot_reply("Sorry, tags can only contain letters "
+                         + "and the underscore character.")
+
+    if action == 'remove':
+        if 'tags' not in old_puzzle or tag not in old_puzzle['tags']:
+            return bot_reply("Nothing to do. This puzzle is not tagged "
+                             + "with the tag: {}".format(tag))
+    else:
+        if 'tags' in old_puzzle and tag in old_puzzle['tags']:
+            return bot_reply("Nothing to do. This puzzle is already tagged "
+                             + "with the tag: {}".format(tag))
+
+    # OK. Error checking is done. Let's get to work
+
+    # Make a copy of the puzzle object
+    puzzle = old_puzzle.copy()
+
+    if action == 'remove':
+        puzzle['tags'] = [t for t in puzzle['tags'] if t != tag]
+    else:
+        if 'tags' not in puzzle:
+            puzzle['tags'] = [tag]
+        else:
+            puzzle['tags'].append(tag)
+
+    turb.table.put_item(Item=puzzle)
+
+    puzzle_update_channel_and_sheet(turb, puzzle, old_puzzle=old_puzzle)
+
+    return lambda_ok
+
+commands["/tag"] = tag
+
 def solved(turb, body, args):
     """Implementation of the /solved command