151 lines
5.0 KiB
Python
151 lines
5.0 KiB
Python
import re
|
|
from time import sleep
|
|
from typing import Any, Optional, Generator, Match, Callable, List, Coroutine
|
|
|
|
from slackclient import SlackClient
|
|
from slackclient.client import SlackNotConnected
|
|
|
|
"""
|
|
Slack helpers. Separated for compartmentalization
|
|
"""
|
|
|
|
|
|
def reply(slack: SlackClient, msg: dict, text: str, in_thread: bool = True, to_channel: str = None) -> dict:
|
|
"""
|
|
Sends message with "text" as its content to the channel that message came from
|
|
"""
|
|
# If no channel specified, just do same as msg
|
|
if to_channel is None:
|
|
to_channel = msg['channel']
|
|
|
|
# Send in a thread by default
|
|
if in_thread:
|
|
thread = (msg.get("thread_ts") # In-thread case - get parent ts
|
|
or msg.get("ts")) # Not in-thread case - get msg itself ts
|
|
return send_message(slack, text, to_channel, thread=thread)
|
|
else:
|
|
return send_message(slack, text, to_channel)
|
|
|
|
|
|
def send_message(slack: SlackClient, text: str, channel: str, thread: str = None, broadcast: bool = False) -> dict:
|
|
"""
|
|
Copy of the internal send message function of slack
|
|
"""
|
|
kwargs = {"channel": channel, "text": text}
|
|
if thread:
|
|
kwargs["thread_ts"] = thread
|
|
if broadcast:
|
|
kwargs["reply_broadcast"] = True
|
|
|
|
return slack.api_call("chat.postMessage", **kwargs)
|
|
|
|
|
|
def im_channel_for_id(slack: SlackClient, user_id: str) -> Optional[str]:
|
|
conversations = slack.api_call("conversations.list", types="im")
|
|
if conversations["ok"]:
|
|
channels = conversations["channels"]
|
|
for channel in channels:
|
|
if channel["is_im"] and channel["user"] == user_id:
|
|
return channel["id"]
|
|
return None
|
|
|
|
|
|
def message_stream(slack: SlackClient) -> Generator[dict, None, None]:
|
|
"""
|
|
Generator that yields messages from slack.
|
|
Messages are in standard api format, look it up.
|
|
Checks on 2 second intervals (may be changed)
|
|
"""
|
|
# Do forever
|
|
while True:
|
|
try:
|
|
if slack.rtm_connect(with_team_state=False, auto_reconnect=True):
|
|
print("Waiting for messages")
|
|
while True:
|
|
sleep(1)
|
|
update = slack.rtm_read()
|
|
for item in update:
|
|
if item.get('type') == 'message':
|
|
yield item
|
|
except (SlackNotConnected, OSError) as e:
|
|
print("Error while reading messages:")
|
|
print(e)
|
|
except (ValueError, TypeError):
|
|
print("Malformed message... Restarting connection")
|
|
|
|
sleep(5)
|
|
print("Connection failed - retrying")
|
|
|
|
|
|
MsgAction = Coroutine[Any, Any, None]
|
|
Callback = Callable[[SlackClient, dict, Match], MsgAction]
|
|
|
|
|
|
class DeadHook(Exception):
|
|
pass
|
|
|
|
|
|
class AbsHook(object):
|
|
def __init__(self, consumes_applicable: bool):
|
|
# Whether or not messages that yield a coroutine should not be checked further
|
|
self.consumes = consumes_applicable
|
|
|
|
def try_apply(self, slack: SlackClient, msg: dict) -> Optional[Coroutine[None, None, None]]:
|
|
raise NotImplementedError()
|
|
|
|
|
|
class Hook(AbsHook):
|
|
def __init__(self,
|
|
callback: Callback,
|
|
pattern: str,
|
|
channel_whitelist: Optional[List[str]] = None,
|
|
channel_blacklist: Optional[List[str]] = None,
|
|
consumer: bool = True):
|
|
super(Hook, self).__init__(consumer)
|
|
|
|
# Save all
|
|
self.pattern = pattern
|
|
self.channel_whitelist = channel_whitelist
|
|
self.channel_blacklist = channel_blacklist
|
|
self.callback = callback
|
|
|
|
# Remedy some sensible defaults
|
|
if self.channel_blacklist is None:
|
|
import channel_util
|
|
self.channel_blacklist = [channel_util.GENERAL]
|
|
elif self.channel_whitelist is None:
|
|
pass # We leave as none to show no whitelisting in effect
|
|
else:
|
|
raise Exception("Cannot whitelist and blacklist")
|
|
|
|
def try_apply(self, slack: SlackClient, msg: dict) -> Optional[Coroutine[None, None, None]]:
|
|
"""
|
|
Returns whether a message should be handled by this dict, returning a Match if so, or None
|
|
"""
|
|
# Fail if pattern invalid
|
|
match = re.match(self.pattern, msg['text'], flags=re.IGNORECASE)
|
|
if match is None:
|
|
# print("Missed pattern")
|
|
return None
|
|
|
|
# Fail if whitelist defined, and we aren't there
|
|
if self.channel_whitelist is not None and msg["channel"] not in self.channel_whitelist:
|
|
# print("Missed whitelist")
|
|
return None
|
|
|
|
# Fail if blacklist defined, and we are there
|
|
if self.channel_blacklist is not None and msg["channel"] in self.channel_blacklist:
|
|
# print("Hit blacklist")
|
|
return None
|
|
|
|
return self.callback(slack, msg, match)
|
|
|
|
|
|
class Passive(object):
|
|
"""
|
|
Base class for Periodical tasks, such as reminders and stuff
|
|
"""
|
|
async def run(self, slack: SlackClient) -> None:
|
|
# Run this passive routed through the specified slack client.
|
|
raise NotImplementedError()
|