1 from slack.errors import SlackApiError
2 from turbot.blocks import input_block, section_block, text_block
9 from botocore.exceptions import ClientError
10 from turbot.slack import slack_send_message
14 submission_handlers = {}
16 # Hunt/Puzzle IDs are restricted to lowercase letters, numbers, and underscores
17 valid_id_re = r'^[_a-z0-9]+$'
19 lambda_ok = {'statusCode': 200}
21 def bot_reply(message):
22 """Construct a return value suitable for a bot reply
24 This is suitable as a way to give an error back to the user who
25 initiated a slash command, for example."""
32 def submission_error(field, error):
33 """Construct an error suitable for returning for an invalid submission.
35 Returning this value will prevent a submission and alert the user that
36 the given field is invalid because of the given error."""
38 print("Rejecting invalid modal submission: {}".format(error))
43 "Content-Type": "application/json"
46 "response_action": "errors",
53 def new_hunt(turb, payload):
54 """Handler for the action of user pressing the new_hunt button"""
58 "private_metadata": json.dumps({}),
59 "title": { "type": "plain_text", "text": "New Hunt" },
60 "submit": { "type": "plain_text", "text": "Create" },
62 input_block("Hunt name", "name", "Name of the hunt"),
63 input_block("Hunt ID", "hunt_id",
64 "Used as puzzle channel prefix "
65 + "(no spaces nor punctuation)"),
66 input_block("Hunt URL", "url", "External URL of hunt",
71 result = turb.slack_client.views_open(trigger_id=payload['trigger_id'],
74 submission_handlers[result['view']['id']] = new_hunt_submission
78 actions['button'] = {"new_hunt": new_hunt}
80 def new_hunt_submission(turb, payload, metadata):
81 """Handler for the user submitting the new hunt modal
83 This is the modal view presented to the user by the new_hunt
86 state = payload['view']['state']['values']
87 user_id = payload['user']['id']
88 name = state['name']['name']['value']
89 hunt_id = state['hunt_id']['hunt_id']['value']
90 url = state['url']['url']['value']
92 # Validate that the hunt_id contains no invalid characters
93 if not re.match(valid_id_re, hunt_id):
94 return submission_error("hunt_id",
95 "Hunt ID can only contain lowercase letters, "
96 + "numbers, and underscores")
98 # Check to see if the hunts table exists
99 hunts_table = turb.db.Table("hunts")
102 exists = hunts_table.table_status in ("CREATING", "UPDATING",
107 # Create the hunts table if necessary.
109 hunts_table = turb.db.create_table(
112 {'AttributeName': 'channel_id', 'KeyType': 'HASH'},
114 AttributeDefinitions=[
115 {'AttributeName': 'channel_id', 'AttributeType': 'S'},
117 ProvisionedThroughput={
118 'ReadCapacityUnits': 5,
119 'WriteCapacityUnits': 5
122 return submission_error("hunt_id",
123 "Still bootstrapping hunts table. Try again.")
125 # Create a channel for the hunt
127 response = turb.slack_client.conversations_create(name=hunt_id)
128 except SlackApiError as e:
129 return submission_error("hunt_id",
130 "Error creating Slack channel: {}"
131 .format(e.response['error']))
133 channel_id = response['channel']['id']
135 # Insert the newly-created hunt into the database
136 # (leaving it as non-active for now until the channel-created handler
137 # finishes fixing it up with a sheet and a companion table)
138 hunts_table.put_item(
140 'channel_id': channel_id,
148 # Invite the initiating user to the channel
149 turb.slack_client.conversations_invite(channel=channel_id, users=user_id)
153 def view_submission(turb, payload):
154 """Handler for Slack interactive view submission
156 Specifically, those that have a payload type of 'view_submission'"""
158 view_id = payload['view']['id']
159 metadata = payload['view']['private_metadata']
161 if view_id in submission_handlers:
162 return submission_handlers[view_id](turb, payload, metadata)
164 print("Error: Unknown view ID: {}".format(view_id))
169 def rot(turb, body, args):
170 """Implementation of the /rot command
172 The args string should be as follows:
174 [count|*] String to be rotated
176 That is, the first word of the string is an optional number (or
177 the character '*'). If this is a number it indicates an amount to
178 rotate each character in the string. If the count is '*' or is not
179 present, then the string will be rotated through all possible 25
182 The result of the rotation is returned (with Slack formatting) in
183 the body of the response so that Slack will provide it as a reply
184 to the user who submitted the slash command."""
186 channel_name = body['channel_name'][0]
187 response_url = body['response_url'][0]
188 channel_id = body['channel_id'][0]
190 result = turbot.rot.rot(args)
192 if (channel_name == "directmessage"):
193 requests.post(response_url,
194 json = {"text": result},
195 headers = {"Content-type": "application/json"})
197 turb.slack_client.chat_postMessage(channel=channel_id, text=result)
201 commands["/rot"] = rot
203 def get_table_item(turb, table_name, key, value):
204 """Get an item from the database 'table_name' with 'key' as 'value'
206 Returns a tuple of (item, table) if found and (None, None) otherwise."""
208 table = turb.db.Table(table_name)
210 response = table.get_item(Key={key: value})
212 if 'Item' in response:
213 return (response['Item'], table)
217 def channel_is_puzzle(turb, channel_id, channel_name):
218 """Given a channel ID/name return the database item for the puzzle
220 If this channel is a puzzle, this function returns a tuple:
224 Where puzzle is dict filled with database entries, and table is a
225 database table that can be used to update the puzzle in the
228 Otherwise, this function returns (None, None)."""
230 hunt_id = channel_name.split('-')[0]
232 # Not a puzzle channel if there is no hyphen in the name
233 if hunt_id == channel_name:
236 return get_table_item(turb, hunt_id, 'channel_id', channel_id)
238 def channel_is_hunt(turb, channel_id):
240 """Given a channel ID/name return the database item for the hunt
242 Returns a dict (filled with database entries) if there is a hunt
243 for this channel, otherwise returns None."""
245 return get_table_item(turb, "hunts", 'channel_id', channel_id)
247 def find_hunt_for_channel(turb, channel_id, channel_name):
248 """Given a channel ID/name find the id/name of the hunt for this channel
250 This works whether the original channel is a primary hunt channel,
251 or if it is one of the channels of a puzzle belonging to the hunt.
253 Returns None if channel does not belong to a hunt, otherwise a
254 dictionary with all fields from the hunt's row in the table,
255 (channel_id, active_, hun_id, name, url, sheet_url, etc.).
259 (hunt, _) = channel_is_hunt(turb, channel_id)
264 # So we're not a hunt channel, let's look to see if we are a
265 # puzzle channel with a hunt-id prefix.
266 hunt_id = channel_name.split('-')[0]
268 hunts_table = turb.db.Table("hunts")
270 response = hunts_table.scan(
271 FilterExpression='hunt_id = :hunt_id',
272 ExpressionAttributeValues={':hunt_id': hunt_id}
275 if 'Items' in response and len(response['Items']):
276 item = response['Items'][0]
281 def puzzle(turb, body, args):
282 """Implementation of the /puzzle command
284 The args string is currently ignored (this command will bring up
285 a modal dialog for user input instead)."""
287 channel_id = body['channel_id'][0]
288 channel_name = body['channel_name'][0]
289 trigger_id = body['trigger_id'][0]
291 hunt = find_hunt_for_channel(turb,
296 return bot_reply("Sorry, this channel doesn't appear to "
297 + "be a hunt or puzzle channel")
301 "private_metadata": json.dumps({
302 "hunt_id": hunt['hunt_id'],
304 "title": {"type": "plain_text", "text": "New Puzzle"},
305 "submit": { "type": "plain_text", "text": "Create" },
307 section_block(text_block("*For {}*".format(hunt['name']))),
308 input_block("Puzzle name", "name", "Name of the puzzle"),
309 input_block("Puzzle URL", "url", "External URL of puzzle",
314 result = turb.slack_client.views_open(trigger_id=trigger_id,
318 submission_handlers[result['view']['id']] = puzzle_submission
322 commands["/puzzle"] = puzzle
324 def puzzle_submission(turb, payload, metadata):
325 """Handler for the user submitting the new puzzle modal
327 This is the modal view presented to the user by the puzzle function
330 meta = json.loads(metadata)
331 hunt_id = meta['hunt_id']
333 state = payload['view']['state']['values']
334 name = state['name']['name']['value']
335 url = state['url']['url']['value']
337 # Create a Slack-channel-safe puzzle_id
338 puzzle_id = re.sub(r'[^a-zA-Z0-9_]', '', name).lower()
340 # Create a channel for the puzzle
341 hunt_dash_channel = "{}-{}".format(hunt_id, puzzle_id)
344 response = turb.slack_client.conversations_create(
345 name=hunt_dash_channel)
346 except SlackApiError as e:
347 return submission_error(
349 "Error creating Slack channel {}: {}"
350 .format(hunt_dash_channel, e.response['error']))
352 puzzle_channel_id = response['channel']['id']
354 # Insert the newly-created puzzle into the database
355 table = turb.db.Table(hunt_id)
358 "channel_id": puzzle_channel_id,
359 "orig_channel_name": hunt_dash_channel,
361 "status": 'unsolved',
363 "puzzle_id": puzzle_id,
370 def rename_channel_to_solved(turb, puzzle):
371 orig_channel_name = puzzle['orig_channel_name']
372 channel_id = puzzle['channel_id']
373 newName = orig_channel_name + '-solved'
374 turb.slack_client.conversations_rename(channel=channel_id,
377 # XXX: This duplicates functionality eith events.py:set_channel_description
378 def set_channel_topic(turb, puzzle):
379 channel_id = puzzle['channel_id']
380 name = puzzle['name']
381 url = puzzle.get('url', None)
382 sheet_url = puzzle.get('sheet_url', None)
383 state = puzzle.get('state', None)
384 status = puzzle['status']
388 if status == 'solved':
389 description += "SOLVED: `{}` ".format('`, `'.join(puzzle['solution']))
395 links.append("<{}|Puzzle>".format(url))
397 links.append("<{}|Sheet>".format(sheet_url))
400 description += "({})".format(', '.join(links))
403 description += " {}".format(state)
405 turb.slack_client.conversations_setTopic(channel=channel_id,
408 def state(turb, body, args):
409 """Implementation of the /state command
411 The args string should be a brief sentence describing where things
412 stand or what's needed."""
414 channel_id = body['channel_id'][0]
415 channel_name = body['channel_name'][0]
417 (puzzle, table) = channel_is_puzzle(turb, channel_id, channel_name)
420 return bot_reply("Sorry, this is not a puzzle channel.")
422 # Set the state field in the database
423 puzzle['state'] = args
424 table.put_item(Item=puzzle)
426 set_channel_topic(turb, puzzle)
430 commands["/state"] = state
432 def solved(turb, body, args):
433 """Implementation of the /solved command
435 The args string should be a confirmed solution."""
437 channel_id = body['channel_id'][0]
438 channel_name = body['channel_name'][0]
439 user_name = body['user_name'][0]
441 (puzzle, table) = channel_is_puzzle(turb, channel_id, channel_name)
444 return bot_reply("Sorry, this is not a puzzle channel.")
446 # Set the status and solution fields in the database
447 puzzle['status'] = 'solved'
448 puzzle['solution'].append(args)
449 table.put_item(Item=puzzle)
451 # Report the solution to the puzzle's channel
453 turb.slack_client, channel_id,
454 "Puzzle mark solved by {}: `{}`".format(user_name, args))
456 # And update the puzzle's description
457 set_channel_topic(turb, puzzle)
459 # And rename the sheet to prefix with "SOLVED: "
460 turbot.sheets.renameSheet(turb, puzzle['sheet_url'], 'SOLVED: ' + puzzle['name'])
462 # Finally, rename the Slack channel to add the suffix '-solved'
463 rename_channel_to_solved(turb, puzzle)
467 commands["/solved"] = solved