Support for slack events

.travis.yml

@@ -0,0 +1,31 @@
+sudo: false
+language: python
+matrix:
+  include:
+    - python: 3.6
+      env: TOXENV=py36
+    - python: 3.7
+      env: TOXENV=py37
+    - python: 3.8
+      env: TOXENV=py38
+    - python: 3.9
+      env: TOXENV=py39
+    - python: 3.7
+      env: TOXENV=pypi-lint
+    - python: 3.7
+      env: TOXENV=codestyle
+    - python: 3.7
+      env: TOXENV=security
+
+install: pip install tox
+before_script: cp tests/config-travisci.py config.py
+script: tox
+
+# notification for gitter integration
+notifications:
+  webhooks:
+    urls:
+      - https://webhooks.gitter.im/e/788e94bb42a75aa2df4c
+    on_success: always  # options: [always|never|change] default: always
+    on_failure: always  # options: [always|never|change] default: always
+    on_start: true     # default: false

errbot/backends/_slack/markdown.py

@@ -0,0 +1,30 @@
+import re
+from markdown import Markdown
+from markdown.extensions.extra import ExtraExtension
+from markdown.preprocessors import Preprocessor
+from errbot.rendering.ansiext import AnsiExtension, enable_format, IMTEXT_CHRS
+
+MARKDOWN_LINK_REGEX = re.compile(r"(?<!!)\[(?P<text>[^\]]+?)\]\((?P<uri>[a-zA-Z0-9]+?:\S+?)\)")
+
+
+def slack_markdown_converter(compact_output=False):
+    """
+    This is a Markdown converter for use with Slack.
+    """
+    enable_format("imtext", IMTEXT_CHRS, borders=not compact_output)
+    md = Markdown(output_format="imtext", extensions=[ExtraExtension(), AnsiExtension()])
+    md.preprocessors.register(LinkPreProcessor(md), "LinkPreProcessor", 30)
+    md.stripTopLevelTags = False
+    return md
+
+
+class LinkPreProcessor(Preprocessor):
+    """
+    This preprocessor converts markdown URL notation into Slack URL notation
+    as described at https://api.slack.com/docs/formatting, section "Linking to URLs".
+    """
+
+    def run(self, lines):
+        for i, line in enumerate(lines):
+            lines[i] = MARKDOWN_LINK_REGEX.sub(r"&lt;\2|\1&gt;", line)
+        return lines

errbot/backends/_slack/person.py

@@ -0,0 +1,139 @@
+
+import logging
+from errbot.backends.base import (
+    Person,
+    RoomDoesNotExistError
+)
+from slack_sdk.web import WebClient
+
+log = logging.getLogger(__name__)
+
+
+class SlackPerson(Person):
+    """
+    This class describes a person on Slack's network.
+    """
+
+    def __init__(self, webclient: WebClient, userid=None, channelid=None):
+        if userid is not None and userid[0] not in ("U", "B", "W"):
+            raise Exception(
+                f"This is not a Slack user or bot id: {userid} (should start with U, B or W)"
+            )
+
+        if channelid is not None and channelid[0] not in ("D", "C", "G"):
+            raise Exception(
+                f"This is not a valid Slack channelid: {channelid} (should start with D, C or G)"
+            )
+
+        self._userid = userid
+        self._channelid = channelid
+        self._webclient = webclient
+        self._username = None  # cache
+        self._fullname = None
+        self._email = None
+        self._channelname = None
+        self._email = None
+
+    @property
+    def userid(self):
+        return self._userid
+
+    @property
+    def username(self):
+        """Convert a Slack user ID to their user name"""
+        if self._username:
+            return self._username
+        self._get_user_info()
+        if self._username is None:
+            return f"<{self._userid}>"
+        return self._username
+
+    @property
+    def fullname(self):
+        """Convert a Slack user ID to their full name"""
+        if self._fullname:
+            return self._fullname
+        self._get_user_info()
+        if self._fullname is None:
+            return f"<{self._userid}>"
+        return self._fullname
+
+    @property
+    def email(self):
+        """Convert a Slack user ID to their user email"""
+        if self._email:
+            return self._email
+        self._get_user_info()
+        if self._email is None:
+            return "<%s>" % self._userid
+        return self._email
+
+    def _get_user_info(self):
+        """Cache all user info"""
+        user = self._webclient.users_info(user=self._userid)["user"]
+
+        if user is None:
+            log.error("Cannot find user with ID %s" % self._userid)
+            return
+
+        self._email = user["profile"]["email"]
+        self._fullname = user["real_name"]
+        self._username = user["name"]
+
+    @property
+    def channelid(self):
+        return self._channelid
+
+    @property
+    def channelname(self):
+        """Convert a Slack channel ID to its channel name"""
+        if self._channelid is None:
+            return None
+
+        if self._channelname:
+            return self._channelname
+
+        channel = [
+            channel
+            for channel in self._webclient.conversations_list()["channels"]
+            if channel["id"] == self._channelid
+        ]
+
+        if not channel:
+            raise RoomDoesNotExistError(f"No channel with ID {self._channelid} exists.")
+
+        if not self._channelname:
+            self._channelname = channel[0]["name"]
+        return self._channelname
+
+    @property
+    def domain(self):
+        raise NotImplementedError
+
+    # Compatibility with the generic API.
+    client = channelid
+    nick = username
+
+    # Override for ACLs
+    @property
+    def aclattr(self):
+        # Note: Don't use str(self) here because that will return
+        # an incorrect format from SlackMUCOccupant.
+        return f"@{self.username}"
+
+    person = aclattr
+
+    def __unicode__(self):
+        return f"@{self.username}"
+
+    def __str__(self):
+        return self.__unicode__()
+
+    def __eq__(self, other):
+        if not isinstance(other, SlackPerson):
+            log.warning("tried to compare a SlackPerson with a %s", type(other))
+            return False
+        return other.userid == self.userid
+
+    def __hash__(self):
+        return self.userid.__hash__()

errbot/backends/slack.py

@@ -21,7 +21,7 @@
 log = logging.getLogger(__name__)
 
 try:
-    from slackclient import SlackClient
+    from slackclient import WebClient
 except ImportError:
     log.exception("Could not start the Slack back-end")
     log.fatal(
@@ -157,7 +157,7 @@ def email(self):
         """Convert a Slack user ID to their user email"""
         user = self._sc.server.users.find(self._userid)
         if user is None:
-            log.error("Cannot find user with ID %s", self._userid)
+            log.error("Cannot find user with ID %s" % self._userid)
             return "<%s>" % self._userid
         return user.email
 
@@ -373,7 +373,7 @@ def update_alternate_prefixes(self):
         log.debug('Converted bot_alt_prefixes: %s', self.bot_config.BOT_ALT_PREFIXES)
 
     def serve_once(self):
-        self.sc = SlackClient(self.token, proxies=self.proxies)
+        self.sc = WebClient(self.token, proxies=self.proxies)
 
         log.info('Verifying authentication token')
         self.auth = self.api_call("auth.test", raise_errors=False)

errbot/backends/slack_rtm.py

@@ -132,6 +132,7 @@ def username(self):
             return self._username
 
         user = self._webclient.users_info(user=self._userid)['user']
+
         if user is None:
             log.error('Cannot find user with ID %s', self._userid)
             return f'<{self._userid}>'
@@ -153,7 +154,10 @@ def channelname(self):
         if self._channelname:
             return self._channelname
 
-        channel = [channel for channel in self._webclient.channels_list() if channel['id'] == self._channelid][0]
+        channel = [
+            channel for channel in self._webclient.conversations_list()['channels']
+            if channel['id'] == self._channelid
+        ][0]
         if channel is None:
             raise RoomDoesNotExistError(f'No channel with ID {self._channelid} exists.')
         if not self._channelname:
@@ -301,7 +305,7 @@ def __eq__(self, other):
         return other.room.id == self.room.id and other.userid == self.userid
 
 
-class SlackRTMBackend(ErrBot):
+class SlackBackendBase():
 
     @staticmethod
     def _unpickle_identifier(identifier_str):
@@ -323,25 +327,6 @@ def _register_identifiers_pickling(self):
         for cls in (SlackPerson, SlackRoomOccupant, SlackRoom):
             copyreg.pickle(cls, SlackRTMBackend._pickle_identifier, SlackRTMBackend._unpickle_identifier)
 
-    def __init__(self, config):
-        super().__init__(config)
-        identity = config.BOT_IDENTITY
-        self.token = identity.get('token', None)
-        self.proxies = identity.get('proxies', None)
-        if not self.token:
-            log.fatal(
-                'You need to set your token (found under "Bot Integration" on Slack) in '
-                'the BOT_IDENTITY setting in your configuration. Without this token I '
-                'cannot connect to Slack.'
-            )
-            sys.exit(1)
-        self.sc = None  # Will be initialized in serve_once
-        self.webclient = None
-        self.bot_identifier = None
-        compact = config.COMPACT_OUTPUT if hasattr(config, 'COMPACT_OUTPUT') else False
-        self.md = slack_markdown_converter(compact)
-        self._register_identifiers_pickling()
-
     def update_alternate_prefixes(self):
         """Converts BOT_ALT_PREFIXES to use the slack ID instead of name
 
@@ -419,6 +404,16 @@ def _hello_event_handler(self, webclient: WebClient, event):
         self.connect_callback()
         self.callback_presence(Presence(identifier=self.bot_identifier, status=ONLINE))
 
+    def _reaction_added_event_handler(self, webclient: WebClient, event):
+        """Event handler for the 'reaction_added' event"""
+        emoji = event["reaction"]
+        log.debug('Added reaction: {}'.format(emoji))
+
+    def _reaction_removed_event_handler(self, webclient: WebClient, event):
+        """Event handler for the 'reaction_removed' event"""
+        emoji = event["reaction"]
+        log.debug('Removed reaction: {}'.format(emoji))
+
     def _presence_change_event_handler(self, webclient: WebClient, event):
         """Event handler for the 'presence_change' event"""
 
@@ -553,10 +548,10 @@ def channelid_to_channelname(self, id_: str):
     def channelname_to_channelid(self, name: str):
         """Convert a Slack channel name to its channel ID"""
         name = name.lstrip('#')
-        channel = [channel for channel in self.webclient.channels_list() if channel.name == name]
+        channel = [channel for channel in self.webclient.conversations_list()['channels'] if channel['name'] == name]
         if not channel:
             raise RoomDoesNotExistError(f'No channel named {name} exists')
-        return channel[0].id
+        return channel[0]['id']
 
     def channels(self, exclude_archived=True, joined_only=False):
         """
@@ -574,7 +569,7 @@ def channels(self, exclude_archived=True, joined_only=False):
           * https://api.slack.com/methods/channels.list
           * https://api.slack.com/methods/groups.list
         """
-        response = self.webclient.channels_list(exclude_archived=exclude_archived)
+        response = self.webclient.conversations_list(exclude_archived=exclude_archived)
         channels = [channel for channel in response['channels']
                     if channel['is_member'] or not joined_only]
 
@@ -590,7 +585,7 @@ def channels(self, exclude_archived=True, joined_only=False):
     def get_im_channel(self, id_):
         """Open a direct message channel to a user"""
         try:
-            response = self.webclient.im_open(user=id_)
+            response = self.webclient.conversations_open(user=id_)
             return response['channel']['id']
         except SlackAPIResponseError as e:
             if e.error == "cannot_dm_bot":
@@ -1022,6 +1017,28 @@ def process_mentions(self, text):
         return text, mentioned
 
 
+class SlackRTMBackend(SlackBackendBase, ErrBot):
+
+    def __init__(self, config):
+        super().__init__(config)
+        identity = config.BOT_IDENTITY
+        self.token = identity.get('token', None)
+        self.proxies = identity.get('proxies', None)
+        if not self.token:
+            log.fatal(
+                'You need to set your token (found under "Bot Integration" on Slack) in '
+                'the BOT_IDENTITY setting in your configuration. Without this token I '
+                'cannot connect to Slack.'
+            )
+            sys.exit(1)
+        self.sc = None  # Will be initialized in serve_once
+        self.webclient = None
+        self.bot_identifier = None
+        compact = config.COMPACT_OUTPUT if hasattr(config, 'COMPACT_OUTPUT') else False
+        self.md = slack_markdown_converter(compact)
+        self._register_identifiers_pickling()
+
+
 class SlackRoom(Room):
     def __init__(self, webclient=None, name=None, channelid=None, bot=None):
         if channelid is not None and name is not None:
@@ -1035,7 +1052,7 @@ def __init__(self, webclient=None, name=None, channelid=None, bot=None):
         else:
             self._name = bot.channelid_to_channelname(channelid)
 
-        self._id = None
+        self._id = channelid
         self._bot = bot
         self.webclient = webclient
 
@@ -1052,12 +1069,22 @@ def _channel(self):
         The channel object exposed by SlackClient
         """
         _id = None
-        for channel in self.webclient.conversations_list()['channels']:
-            if channel['name'] == self.name:
-                _id = channel['id']
-                break
-        else:
-            raise RoomDoesNotExistError(f"{str(self)} does not exist (or is a private group you don't have access to)")
+        # Cursors
+        cursor = ''
+        while cursor is not None:
+            conversations_list = self.webclient.conversations_list(cursor=cursor)
+            cursor = None
+            for channel in conversations_list['channels']:
+                if channel['name'] == self.name:
+                    _id = channel['id']
+                    break
+            else:
+                if conversations_list['response_metadata']['next_cursor'] is not None:
+                    cursor = conversations_list['response_metadata']['next_cursor']
+                else:
+                    raise RoomDoesNotExistError(
+                        f"{str(self)} does not exist (or is a private group you don't have access to)"
+                    )
         return _id
 
     @property