+ result = turb.slack_client.views_open(trigger_id=trigger_id,
+ view=view)
+
+ if (result['ok']):
+ submission_handlers[result['view']['id']] = new_puzzle_submission
+
+ return lambda_ok
+
+def new_puzzle_submission(turb, payload, metadata):
+ """Handler for the user submitting the new puzzle modal
+
+ This is the modal view presented to the user by the new_puzzle
+ function above.
+ """
+
+ # First, read all the various data from the request
+ meta = json.loads(metadata)
+ hunt_id = meta['hunt_id']
+
+ state = payload['view']['state']['values']
+
+ # And start loading data into a puzzle dict
+ puzzle = {}
+ puzzle['hunt_id'] = hunt_id
+ puzzle['name'] = state['name']['name']['value']
+ url = state['url']['url']['value']
+ if url:
+ puzzle['url'] = url
+ 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']]
+ else:
+ rounds = []
+ new_rounds = state['new_rounds']['new_rounds']['value']
+
+ # Create a Slack-channel-safe puzzle_id
+ puzzle['puzzle_id'] = puzzle_id_from_name(puzzle['name'])
+
+ # Before doing anything, reject this puzzle if a puzzle already
+ # exists with the same puzzle_id or url
+ existing = find_puzzle_for_puzzle_id(turb, hunt_id, puzzle['puzzle_id'])
+ if existing:
+ return submission_error(
+ "name",
+ "Error: This name collides with an existing puzzle.")
+
+ if url:
+ existing = find_puzzle_for_url(turb, hunt_id, url)
+ if existing:
+ return submission_error(
+ "url",
+ "Error: A puzzle with this URL already exists.")
+
+ # Add any new rounds to the database
+ if new_rounds:
+ for round in new_rounds.split(','):
+ # Drop any leading/trailing spaces from the round name
+ round = round.strip()
+ # Ignore any empty string
+ if not len(round):
+ continue
+ rounds.append(round)
+ turb.table.put_item(
+ Item={
+ 'hunt_id': hunt_id,
+ 'SK': 'round-' + round
+ }
+ )
+
+ if rounds:
+ puzzle['rounds'] = rounds
+
+ puzzle['solution'] = []
+ puzzle['status'] = 'unsolved'
+
+ # Create a channel for the puzzle
+ channel_name = puzzle_channel_name(puzzle)
+
+ try:
+ response = turb.slack_client.conversations_create(
+ name=channel_name)
+ except SlackApiError as e:
+ return submission_error(
+ "name",
+ "Error creating Slack channel {}: {}"
+ .format(channel_name, e.response['error']))
+
+ puzzle['channel_id'] = response['channel']['id']
+
+ # 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
+
+def state(turb, body, args):
+ """Implementation of the /state command
+
+ The args string should be a brief sentence describing where things
+ stand or what's needed."""
+
+ channel_id = body['channel_id'][0]
+
+ old_puzzle = puzzle_for_channel(turb, channel_id)
+
+ if not old_puzzle:
+ return bot_reply(
+ "Sorry, the /state command only works in a puzzle channel")
+
+ # Make a deep copy of the puzzle object
+ puzzle = puzzle_copy(old_puzzle)
+
+ # Update the puzzle in the database
+ puzzle['state'] = args
+ turb.table.put_item(Item=puzzle)
+
+ puzzle_update_channel_and_sheet(turb, puzzle, old_puzzle=old_puzzle)
+
+ return lambda_ok
+
+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_id = body['user_id'][0]
+
+ old_puzzle = puzzle_for_channel(turb, channel_id)
+
+ if not old_puzzle:
+ return bot_reply("Sorry, this is not a puzzle channel.")
+
+ if not args:
+ return bot_reply(
+ "Error, no solution provided. Usage: `/solved SOLUTION HERE`")
+
+ # 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'
+ puzzle['solution'].append(args)
+ if 'state' in puzzle:
+ del puzzle['state']
+ turb.table.put_item(Item=puzzle)
+
+ # Report the solution to the puzzle's channel
+ slack_send_message(
+ turb.slack_client, channel_id,
+ "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'])
+ slack_send_message(
+ turb.slack_client, hunt['channel_id'],
+ "Puzzle <{}|{}> has been solved!".format(
+ puzzle['channel_url'],
+ puzzle['name'])
+ )
+
+ # And update the puzzle's description
+ puzzle_update_channel_and_sheet(turb, puzzle, old_puzzle=old_puzzle)
+
+ return lambda_ok
+
+commands["/solved"] = solved
+
+def hunt(turb, body, args):
+ """Implementation of the /hunt command
+
+ The (optional) args string can be used to filter which puzzles to
+ display. The first word can be one of 'all', 'unsolved', or
+ 'solved' and can be used to display only puzzles with the given
+ status. If this first word is missing, this command will display
+ only unsolved puzzles by default.
+
+ Any remaining text in the args string will be interpreted as
+ search terms. These will be split into separate terms on space
+ characters, (though quotation marks can be used to include a space
+ 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, 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" 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
+ # (if any) are search terms. _But_, if the first word is not a
+ # valid puzzle status ('all', 'unsolved', 'solved'), then all
+ # words are search terms and we default status to 'unsolved'.
+ split_args = args.split(' ', 1)
+ status = split_args[0]
+ if (len(split_args) > 1):
+ terms = split_args[1]
+ if status not in ('unsolved', 'solved', 'all'):
+ terms = args
+ status = 'unsolved'
+ else:
+ status = 'unsolved'
+
+ # Separate search terms on spaces (but allow for quotation marks
+ # to capture spaces in a search term)
+ if terms:
+ terms = shlex.split(terms)
+
+ hunt = hunt_for_channel(turb, channel_id)
+
+ if not hunt:
+ return bot_reply("Sorry, this channel doesn't appear to "
+ + "be a hunt or puzzle channel")
+
+ blocks = hunt_blocks(turb, hunt, puzzle_status=status, search_terms=terms)
+
+ requests.post(response_url,
+ json = { 'blocks': blocks },
+ headers = {'Content-type': 'application/json'}
+ )
+
+ return lambda_ok
+
+commands["/hunt"] = hunt
+
+def round(turb, body, args):
+ """Implementation of the /round command
+
+ Displays puzzles in the same round(s) as the puzzle for the
+ current channel.
+
+ The (optional) args string can be used to filter which puzzles to
+ display. The first word can be one of 'all', 'unsolved', or
+ 'solved' and can be used to display only puzzles with the given
+ status. If this first word is missing, this command will display
+ all puzzles in the round by default.
+
+ Any remaining text in the args string will be interpreted as
+ search terms. These will be split into separate terms on space
+ characters, (though quotation marks can be used to include a space
+ 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.
+ """
+
+ channel_id = body['channel_id'][0]
+ response_url = body['response_url'][0]
+
+ puzzle = puzzle_for_channel(turb, channel_id)
+ hunt = hunt_for_channel(turb, channel_id)
+
+ if not puzzle:
+ if hunt:
+ return bot_reply(
+ "This is not a puzzle channel, but is a hunt channel. "
+ + "Use /hunt if you want to see all rounds for this hunt.")
+ else:
+ return bot_reply(
+ "Sorry, this channel doesn't appear to be a puzzle channel "
+ + "so the `/round` command cannot work here.")
+
+ terms = None
+ if args:
+ # The first word can be a puzzle status and all remaining word
+ # (if any) are search terms. _But_, if the first word is not a
+ # valid puzzle status ('all', 'unsolved', 'solved'), then all
+ # words are search terms and we default status to 'unsolved'.
+ split_args = args.split(' ', 1)
+ status = split_args[0]
+ if (len(split_args) > 1):
+ terms = split_args[1]
+ if status not in ('unsolved', 'solved', 'all'):
+ terms = args
+ status = 'all'
+ else:
+ status = 'all'
+
+ # Separate search terms on spaces (but allow for quotation marks
+ # to capture spaces in a search term)
+ if terms:
+ terms = shlex.split(terms)
+
+ blocks = hunt_blocks(turb, hunt,
+ puzzle_status=status, search_terms=terms,
+ limit_to_rounds=puzzle.get('rounds', [])
+ )
+
+ requests.post(response_url,
+ json = { 'blocks': blocks },
+ headers = {'Content-type': 'application/json'}
+ )
+
+ return lambda_ok
+
+commands["/round"] = round
+
+def help_command(turb, body, args):
+ """Implementation of the /help command
+
+ Displays help on how to use Turbot.
+ """
+
+ channel_id = body['channel_id'][0]
+ response_url = body['response_url'][0]
+ user_id = body['user_id'][0]
+
+ # Process "/help me" first. It calls out to have_you_tried rather
+ # than going through our help system.
+ #
+ # Also, it reports in the current channel, (where all other help
+ # output is reported privately to the invoking user).
+ if args == "me":
+ to_try = "In response to <@{}> asking `/help me`:\n\n{}\n".format(
+ user_id, have_you_tried())
+
+ # We'll try first to reply directly to the channel (for the benefit
+ # of anyone else in the same channel that might be stuck too.
+ #
+ # But if this doesn't work, (direct message or private channel),
+ # then we can instead reply with an ephemeral message by using
+ # the response_url.
+ try:
+ turb.slack_client.chat_postMessage(
+ channel=channel_id, text=to_try)
+ except SlackApiError:
+ requests.post(response_url,
+ json = {"text": to_try},
+ headers = {"Content-type": "application/json"})
+ return lambda_ok
+
+ help_string = turbot_help(args)
+
+ requests.post(response_url,
+ json = {"text": help_string},
+ headers = {"Content-type": "application/json"})
+
+ return lambda_ok
+
+commands["/help"] = help_command