X-Git-Url: https://git.cworth.org/git?p=turbot;a=blobdiff_plain;f=turbot%2Finteraction.py;h=05bbbb88d3c09f5eade01318604df40d330484e1;hp=13b8ebf00fd6a31ceb60757b076ff86f30421dcd;hb=1ef1c6f234ba7fb1f88900a664369efb1fc61efb;hpb=4bca55ecc12eb56357e5a5279fece0adced30430 diff --git a/turbot/interaction.py b/turbot/interaction.py index 13b8ebf..05bbbb8 100644 --- a/turbot/interaction.py +++ b/turbot/interaction.py @@ -86,11 +86,15 @@ def edit(turb, body, args): """Implementation of the `/edit` command - To edit the puzzle for the current channel. + This can be used as `/edit hunt` or `/edit puzzle`, (and if issued as + just `/edit` will default to editing the current puzzle. - This is simply a shortcut for `/puzzle edit`. + These are simply shortcuts for `/hunt edit` and `/puzzle edit`. """ + if args == "hunt": + return edit_hunt_command(turb, body) + return edit_puzzle_command(turb, body) commands["/edit"] = edit @@ -112,8 +116,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""" @@ -339,9 +341,155 @@ def edit_puzzle_submission(turb, payload, metadata): return lambda_ok -def new_hunt(turb, payload): +def edit_hunt_command(turb, body): + """Implementation of the `/hunt edit` command + + As dispatched from the hunt() function. + """ + + channel_id = body['channel_id'][0] + trigger_id = body['trigger_id'][0] + + hunt = hunt_for_channel(turb, channel_id) + + if not hunt: + return bot_reply("Sorry, this does not appear to be a hunt channel.") + + return edit_hunt(turb, hunt, trigger_id) + +def edit_hunt_button(turb, payload): + """Handler for the action of user pressing an edit_hunt button""" + + hunt_id = payload['actions'][0]['action_id'] + response_url = payload['response_url'] + trigger_id = payload['trigger_id'] + + hunt = find_hunt_for_hunt_id(hunt_id) + + if not hunt: + requests.post(response_url, + json = {"text": "Error: Hunt not found!"}, + headers = {"Content-type": "application/json"}) + return bot_reply("Error: Hunt not found.") + + return edit_hunt(turb, hunt, trigger_id) + +actions['button']['edit_hunt'] = edit_hunt_button + +def edit_hunt(turb, hunt, trigger_id): + """Common code for implementing an edit hunt dialog + + This implementation is common whether the edit operation was invoked + by a button (edit_hunt_button) or a command (edit_hunt_command). + """ + + view = { + "type": "modal", + "private_metadata": json.dumps({ + "hunt_id": hunt["hunt_id"], + "SK": hunt["SK"], + "is_hunt": hunt["is_hunt"], + "channel_id": hunt["channel_id"], + "sheet_url": hunt["sheet_url"], + "folder_id": hunt["folder_id"], + }), + "title": { "type": "plain_text", "text": "Edit Hunt" }, + "submit": { "type": "plain_text", "text": "Save" }, + "blocks": [ + input_block("Hunt name", "name", "Name of the hunt", + initial_value=hunt["name"]), + input_block("Hunt URL", "url", "External URL of hunt", + initial_value=hunt.get("url", None), + optional=True), + checkbox_block("Is this hunt active?", "Active", "active", + checked=(hunt.get('active', False))) + ] + } + + result = turb.slack_client.views_open(trigger_id=trigger_id, + view=view) + + if result['ok']: + submission_handlers[result['view']['id']] = edit_hunt_submission + + return lambda_ok + +def edit_hunt_submission(turb, payload, metadata): + """Handler for the user submitting the edit hunt modal + + This is the modal view presented by the edit_hunt function above. + """ + + hunt={} + + # First, read all the various data from the request + meta = json.loads(metadata) + hunt['hunt_id'] = meta['hunt_id'] + hunt['SK'] = meta['SK'] + hunt['is_hunt'] = meta['is_hunt'] + hunt['channel_id'] = meta['channel_id'] + hunt['sheet_url'] = meta['sheet_url'] + hunt['folder_id'] = meta['folder_id'] + + state = payload['view']['state']['values'] + user_id = payload['user']['id'] + + hunt['name'] = state['name']['name']['value'] + url = state['url']['url']['value'] + if url: + hunt['url'] = url + + if state['active']['active']['selected_options']: + hunt['active'] = True + else: + hunt['active'] = False + + # Update the hunt in the database + turb.table.put_item(Item=hunt) + + # Inform the hunt channel about the edit + edit_message = "Hunt edited by <@{}>".format(user_id) + blocks = [ + section_block(text_block(edit_message)), + section_block(text_block("Hunt name: {}".format(hunt['name']))), + ] + + url = hunt.get('url', None) + if url: + blocks.append( + section_block(text_block("Hunt URL: {}".format(hunt['url']))) + ) + + slack_send_message( + turb.slack_client, hunt['channel_id'], + edit_message, blocks=blocks) + + return lambda_ok + +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({}), @@ -357,7 +505,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 @@ -686,7 +834,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 @@ -714,11 +862,20 @@ commands["/puzzle"] = puzzle def new(turb, body, args): """Implementation of the `/new` command - To create a new puzzle. + This can be used to create a new hunt ("/new hunt") or a new + puzzle ("/new puzzle" or simply "/new"). So puzzle creation is the + default behavior (as it is much more common). - This is simply a shortcut for `/puzzle new`. + This operations are identical to the existing "/hunt new" and + "/puzzle new". I don't know that that redundancy is actually + helpful in the interface. But at least having both allows us to + experiment and decide which is more natural and should be kept + around long-term. """ + if args == 'hunt': + return new_hunt_command(turb, body) + return new_puzzle(turb, body) commands["/new"] = new @@ -1033,6 +1190,13 @@ def hunt(turb, body, args): channel_id = body['channel_id'][0] response_url = body['response_url'][0] + # First, farm off "/hunt new" and "/hunt edit" a separate commands + if args == "new": + return new_hunt_command(turb, body) + + if args == "edit": + return edit_hunt_command(turb, body) + terms = None if args: # The first word can be a puzzle status and all remaining word