X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=turbot%2Finteraction.py;h=c1064bfa22cfb2d6e4341163480e5ea1d3edc0b4;hb=f01639c9b18dabbc5eb1c659ea871c3cda6ea727;hp=8bff8bc3cbc656571ca0a953a5002d9f7659ec3d;hpb=29c36d3057c5602c5a4b6fb0e48f454db01ddd9d;p=turbot diff --git a/turbot/interaction.py b/turbot/interaction.py index 8bff8bc..c1064bf 100644 --- a/turbot/interaction.py +++ b/turbot/interaction.py @@ -13,7 +13,8 @@ from turbot.puzzle import ( puzzle_update_channel_and_sheet, puzzle_id_from_name, puzzle_blocks, - puzzle_sort_key + puzzle_sort_key, + puzzle_copy ) from turbot.round import round_quoted_puzzles_titles_answers import turbot.rot @@ -81,6 +82,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 @@ -97,8 +112,6 @@ def edit_puzzle_command(turb, body): return edit_puzzle(turb, puzzle, trigger_id) - return lambda_ok - def edit_puzzle_button(turb, payload): """Handler for the action of user pressing an edit_puzzle button""" @@ -324,9 +337,30 @@ def edit_puzzle_submission(turb, payload, metadata): return lambda_ok -def new_hunt(turb, payload): +def new_hunt_command(turb, body): + """Implementation of the '/hunt new' command + + As dispatched from the hunt() function. + """ + + trigger_id = body['trigger_id'][0] + + return new_hunt(turb, trigger_id) + +def new_hunt_button(turb, payload): """Handler for the action of user pressing the new_hunt button""" + trigger_id = payload['trigger_id'] + + return new_hunt(turb, trigger_id) + +def new_hunt(turb, trigger_id): + """Common code for implementing a new hunt dialog + + This implementation is common whether the operations was invoked + by a button (new_hunt_button) or a command (new_hunt_command). + """ + view = { "type": "modal", "private_metadata": json.dumps({}), @@ -342,7 +376,7 @@ def new_hunt(turb, payload): ], } - result = turb.slack_client.views_open(trigger_id=payload['trigger_id'], + result = turb.slack_client.views_open(trigger_id=trigger_id, view=view) if (result['ok']): submission_handlers[result['view']['id']] = new_hunt_submission @@ -671,7 +705,7 @@ def puzzle(turb, body, args): # For a meta puzzle, also display the titles and solutions for all # puzzles in the same round. - if puzzle['type'] == 'meta': + if puzzle.get('type', 'plain') == 'meta': puzzles = hunt_puzzles_for_hunt_id(turb, puzzle['hunt_id']) # Drop this puzzle itself from the report @@ -696,6 +730,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 @@ -855,8 +901,8 @@ def state(turb, body, args): return bot_reply( "Sorry, the /state command only works in a puzzle channel") - # Make a copy of the puzzle object - puzzle = old_puzzle.copy() + # Make a deep copy of the puzzle object + puzzle = puzzle_copy(old_puzzle) # Update the puzzle in the database puzzle['state'] = args @@ -868,13 +914,79 @@ 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-Z0-9_]*$', tag): + return bot_reply("Sorry, tags can only contain letters, numbers, " + + "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 deep copy of the puzzle object + puzzle = puzzle_copy(old_puzzle) + + 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 The args string should be a confirmed solution.""" channel_id = body['channel_id'][0] - user_name = body['user_name'][0] + user_id = body['user_id'][0] old_puzzle = puzzle_for_channel(turb, channel_id) @@ -885,8 +997,8 @@ def solved(turb, body, args): return bot_reply( "Error, no solution provided. Usage: `/solved SOLUTION HERE`") - # Make a copy of the puzzle object - puzzle = old_puzzle.copy() + # Make a deep copy of the puzzle object + puzzle = puzzle_copy(old_puzzle) # Set the status and solution fields in the database puzzle['status'] = 'solved' @@ -898,7 +1010,7 @@ def solved(turb, body, args): # Report the solution to the puzzle's channel slack_send_message( turb.slack_client, channel_id, - "Puzzle mark solved by {}: `{}`".format(user_name, args)) + "Puzzle mark solved by <@{}>: `{}`".format(user_id, args)) # Also report the solution to the hunt channel hunt = find_hunt_for_hunt_id(turb, puzzle['hunt_id']) @@ -931,14 +1043,19 @@ def hunt(turb, body, args): character in a term). All terms must match on a puzzle in order for that puzzle to be included. But a puzzle will be considered to match if any of the puzzle title, round title, puzzle URL, puzzle - state, or puzzle solution match. Matching will be performed - without regard to case sensitivity and the search terms can - include regular expression syntax. + state, puzzle type, tags, or puzzle solution match. Matching will + be performed without regard to case sensitivity and the search + terms can include regular expression syntax. + """ channel_id = body['channel_id'][0] response_url = body['response_url'][0] + # First, farm off "/hunt new" as a separate command + if args == "new": + return new_hunt_command(turb, body) + terms = None if args: # The first word can be a puzzle status and all remaining word