X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=turbot%2Finteraction.py;h=a929ac553fef804c6312dcb10dc107f58fd386d3;hb=90ad4737548756053a1e986295fb5c98d0caa23a;hp=4e626f39fc0c7adc4ec2a3be32c63d9aec632216;hpb=1b5f5fe117c987ddb6cb446efea31b179f9a5c79;p=turbot

diff --git a/turbot/interaction.py b/turbot/interaction.py
index 4e626f3..a929ac5 100644
--- a/turbot/interaction.py
+++ b/turbot/interaction.py
@@ -7,13 +7,16 @@ import json
 import re
 import requests
 from botocore.exceptions import ClientError
+from turbot.slack import slack_send_message
 
 actions = {}
 commands = {}
 submission_handlers = {}
 
-# Hunt and Puzzle IDs are restricted to letters, numbers, and underscores
-valid_id_re = r'^[_a-zA-Z0-9]+$'
+# Hunt/Puzzle IDs are restricted to lowercase letters, numbers, and underscores
+valid_id_re = r'^[_a-z0-9]+$'
+
+lambda_ok = {'statusCode': 200}
 
 def bot_reply(message):
     """Construct a return value suitable for a bot reply
@@ -70,10 +73,7 @@ def new_hunt(turb, payload):
     if (result['ok']):
         submission_handlers[result['view']['id']] = new_hunt_submission
 
-    return {
-        'statusCode': 200,
-        'body': 'OK'
-    }
+    return lambda_ok
 
 actions['button'] = {"new_hunt": new_hunt}
 
@@ -92,7 +92,7 @@ def new_hunt_submission(turb, payload, metadata):
     # Validate that the hunt_id contains no invalid characters
     if not re.match(valid_id_re, hunt_id):
         return submission_error("hunt_id",
-                                "Hunt ID can only contain letters, "
+                                "Hunt ID can only contain lowercase letters, "
                                 + "numbers, and underscores")
 
     # Check to see if the hunts table exists
@@ -148,9 +148,7 @@ def new_hunt_submission(turb, payload, metadata):
     # Invite the initiating user to the channel
     turb.slack_client.conversations_invite(channel=channel_id, users=user_id)
 
-    return {
-        'statusCode': 200,
-    }
+    return lambda_ok
 
 def view_submission(turb, payload):
     """Handler for Slack interactive view submission
@@ -198,42 +196,97 @@ def rot(turb, body, args):
     else:
         turb.slack_client.chat_postMessage(channel=channel_id, text=result)
 
-    return {
-        'statusCode': 200,
-        'body': ""
-    }
+    return lambda_ok
 
 commands["/rot"] = rot
 
-def find_hunt_for_channel(turb, channel_id, channel_name):
-    """Given a channel ID/name find the id/name of the hunt for this channel
+def get_table_item(turb, table_name, key, value):
+    """Get an item from the database 'table_name' with 'key' as 'value'
 
-    This works whether the original channel is a primary hunt channel,
-    or if it is one of the channels of a puzzle belonging to the hunt.
+    Returns a tuple of (item, table) if found and (None, None) otherwise."""
 
-    Returns a tuple of (hunt_name, hunt_id) or (None, None)."""
+    table = turb.db.Table(table_name)
 
-    hunts_table = turb.db.Table("hunts")
-    response = hunts_table.get_item(Key={'channel_id': channel_id})
+    response = table.get_item(Key={key: value})
 
     if 'Item' in response:
-        item = response['Item']
-        return (item['hunt_id'], item['name'])
+        return (response['Item'], table)
+    else:
+        return (None, None)
+
+def channel_is_puzzle(turb, channel_id, channel_name):
+    """Given a channel ID/name return the database item for the puzzle
+
+    If this channel is a puzzle, this function returns a tuple:
+
+        (puzzle, table)
+
+    Where puzzle is dict filled with database entries, and table is a
+    database table that can be used to update the puzzle in the
+    database.
+
+    Otherwise, this function returns (None, None)."""
 
-    # So we're not a hunt channel, let's look to see if we are a
-    # puzzle channel with a hunt-id prefix.
     hunt_id = channel_name.split('-')[0]
 
+    # Not a puzzle channel if there is no hyphen in the name
+    if hunt_id == channel_name:
+        return (None, None)
+
+    return get_table_item(turb, hunt_id, 'channel_id', channel_id)
+
+def channel_is_hunt(turb, channel_id):
+
+    """Given a channel ID/name return the database item for the hunt
+
+    Returns a dict (filled with database entries) if there is a hunt
+    for this channel, otherwise returns None."""
+
+    return get_table_item(turb, "hunts", 'channel_id', channel_id)
+
+def find_hunt_for_hunt_id(turb, hunt_id):
+    """Given a hunt ID find the database for for that hunt
+
+    Returns None if hunt ID is not found, otherwise a
+    dictionary with all fields from the hunt's row in the table,
+    (channel_id, active, hunt_id, name, url, sheet_url, etc.).
+
+    """
+    hunts_table = turb.db.Table("hunts")
+
     response = hunts_table.scan(
         FilterExpression='hunt_id = :hunt_id',
         ExpressionAttributeValues={':hunt_id': hunt_id}
     )
 
-    if 'Items' in response:
+    if 'Items' in response and len(response['Items']):
         item = response['Items'][0]
-        return (item['hunt_id'], item['name'])
+        return item
+
+    return None
+
+def find_hunt_for_channel(turb, channel_id, channel_name):
+    """Given a channel ID/name find the id/name of the hunt for this channel
+
+    This works whether the original channel is a primary hunt channel,
+    or if it is one of the channels of a puzzle belonging to the hunt.
+
+    Returns None if channel does not belong to a hunt, otherwise a
+    dictionary with all fields from the hunt's row in the table,
+    (channel_id, active, hunt_id, name, url, sheet_url, etc.).
+
+    """
+
+    (hunt, _) = channel_is_hunt(turb, channel_id)
+
+    if hunt:
+        return hunt
 
-    return (None, None)
+    # So we're not a hunt channel, let's look to see if we are a
+    # puzzle channel with a hunt-id prefix.
+    hunt_id = channel_name.split('-')[0]
+
+    return find_hunt_for_hunt_id(turb, hunt_id)
 
 def puzzle(turb, body, args):
     """Implementation of the /puzzle command
@@ -245,25 +298,24 @@ def puzzle(turb, body, args):
     channel_name = body['channel_name'][0]
     trigger_id = body['trigger_id'][0]
 
-    (hunt_id, hunt_name) = find_hunt_for_channel(turb, channel_id, channel_name)
+    hunt = find_hunt_for_channel(turb,
+                                 channel_id,
+                                 channel_name)
 
-    if not hunt_id:
+    if not hunt:
         return bot_reply("Sorry, this channel doesn't appear to "
                          + "be a hunt or puzzle channel")
 
     view = {
         "type": "modal",
         "private_metadata": json.dumps({
-            "hunt_id": hunt_id,
+            "hunt_id": hunt['hunt_id'],
         }),
         "title": {"type": "plain_text", "text": "New Puzzle"},
         "submit": { "type": "plain_text", "text": "Create" },
         "blocks": [
-            section_block(text_block("*For {}*".format(hunt_name))),
+            section_block(text_block("*For {}*".format(hunt['name']))),
             input_block("Puzzle name", "name", "Name of the puzzle"),
-            input_block("Puzzle ID", "puzzle_id",
-                        "Used as part of channel name "
-                        + "(no spaces nor punctuation)"),
             input_block("Puzzle URL", "url", "External URL of puzzle",
                         optional=True)
         ]
@@ -275,9 +327,7 @@ def puzzle(turb, body, args):
     if (result['ok']):
         submission_handlers[result['view']['id']] = puzzle_submission
 
-    return {
-        'statusCode': 200
-    }
+    return lambda_ok
 
 commands["/puzzle"] = puzzle
 
@@ -292,14 +342,10 @@ def puzzle_submission(turb, payload, metadata):
 
     state = payload['view']['state']['values']
     name = state['name']['name']['value']
-    puzzle_id = state['puzzle_id']['puzzle_id']['value']
     url = state['url']['url']['value']
 
-    # Validate that the puzzle_id contains no invalid characters
-    if not re.match(valid_id_re, puzzle_id):
-        return submission_error("puzzle_id",
-                                "Puzzle ID can only contain letters, "
-                                + "numbers, and underscores")
+    # Create a Slack-channel-safe puzzle_id
+    puzzle_id = re.sub(r'[^a-zA-Z0-9_]', '', name).lower()
 
     # Create a channel for the puzzle
     hunt_dash_channel = "{}-{}".format(hunt_id, puzzle_id)
@@ -308,9 +354,10 @@ def puzzle_submission(turb, payload, metadata):
         response = turb.slack_client.conversations_create(
             name=hunt_dash_channel)
     except SlackApiError as e:
-        return submission_error("puzzle_id",
-                                "Error creating Slack channel: {}"
-                                .format(e.response['error']))
+        return submission_error(
+            "name",
+            "Error creating Slack channel {}: {}"
+            .format(hunt_dash_channel, e.response['error']))
 
     puzzle_channel_id = response['channel']['id']
 
@@ -321,12 +368,117 @@ def puzzle_submission(turb, payload, metadata):
             "channel_id": puzzle_channel_id,
             "solution": [],
             "status": 'unsolved',
+            "hunt_id": hunt_id,
             "name": name,
             "puzzle_id": puzzle_id,
             "url": url,
         }
     )
 
-    return {
-        'statusCode': 200
-    }
+    return lambda_ok
+
+# XXX: This duplicates functionality eith events.py:set_channel_description
+def set_channel_topic(turb, puzzle):
+    channel_id = puzzle['channel_id']
+    name = puzzle['name']
+    url = puzzle.get('url', None)
+    sheet_url = puzzle.get('sheet_url', None)
+    state = puzzle.get('state', None)
+    status = puzzle['status']
+
+    description = ''
+
+    if status == 'solved':
+        description += "SOLVED: `{}` ".format('`, `'.join(puzzle['solution']))
+
+    description += name
+
+    links = []
+    if url:
+        links.append("<{}|Puzzle>".format(url))
+    if sheet_url:
+        links.append("<{}|Sheet>".format(sheet_url))
+
+    if len(links):
+        description += "({})".format(', '.join(links))
+
+    if state:
+        description += " {}".format(state)
+
+    turb.slack_client.conversations_setTopic(channel=channel_id,
+                                             topic=description)
+
+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]
+    channel_name = body['channel_name'][0]
+
+    (puzzle, table) = channel_is_puzzle(turb, channel_id, channel_name)
+
+    if not puzzle:
+        return bot_reply("Sorry, this is not a puzzle channel.")
+
+    # Set the state field in the database
+    puzzle['state'] = args
+    table.put_item(Item=puzzle)
+
+    set_channel_topic(turb, puzzle)
+
+    return lambda_ok
+
+commands["/state"] = state
+
+def solved(turb, body, args):
+    """Implementation of the /solved command
+
+    The args string should be a confirmed solution."""
+
+    channel_id = body['channel_id'][0]
+    channel_name = body['channel_name'][0]
+    user_name = body['user_name'][0]
+
+    (puzzle, table) = channel_is_puzzle(turb, channel_id, channel_name)
+
+    if not puzzle:
+        return bot_reply("Sorry, this is not a puzzle channel.")
+
+    # Set the status and solution fields in the database
+    puzzle['status'] = 'solved'
+    puzzle['solution'].append(args)
+    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_name, 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
+    set_channel_topic(turb, puzzle)
+
+    # And rename the sheet to prefix with "SOLVED: "
+    turbot.sheets.renameSheet(turb, puzzle['sheet_url'], 'SOLVED: ' + puzzle['name'])
+
+    # Finally, rename the Slack channel to add the suffix '-solved'
+    channel_name = "{}-{}-solved".format(
+        puzzle['hunt_id'],
+        puzzle['puzzle_id'])
+    turb.slack_client.conversations_rename(
+        channel=puzzle['channel_id'],
+        name=channel_name)
+
+    return lambda_ok
+
+commands["/solved"] = solved