Add notification when received message

Author: duynguyenhoang

README.md

@@ -42,7 +42,7 @@ pip
 ```bash
 git clone https://github.com/haskellcamargo/sclack.git
 cd sclack
-pip3 install -r requirements.txt
+pip3 install --upgrade -r requirements.txt
 chmod +x ./app.py
 ./app.py
 ```
@@ -76,8 +76,7 @@ Your `~/.sclack` file will look like:
 
 ### Multiple workspaces
 
-If you want to, you can use Sclack in multiple workspaces. You can have
-at most 9 workspaces defined inside `workspaces`:
+If you want to, you can use Sclack in multiple workspaces. You can have at most 9 workspaces defined inside `workspaces`:
 
 ```json
 {
@@ -98,6 +97,23 @@ You can use the keys from 1 up to 9 to switch workspaces or event right-click th
 
 ![Multiple workspaces](./resources/example_7.png)
 
+### Enable features
+
+There are some features available, you can adjust them by change the config file
+
+
+```json
+{
+    "features": {
+        "emoji": true,
+        "markdown": true,
+        "pictures": true,
+        "notification": ""
+    },
+}
+```
+
+* notification: How we send notification for you (*MacOS* supported now): `none` Disable notification / `mentioned` Direct message or mentioned in channel / `all` Receive all notifications
 
 ### Default keybindings
 ```json
@@ -190,5 +206,7 @@ Contributions are very welcome, and there is a lot of work to do! You can...
 ![](./resources/example_4.png)
 ![](./resources/example_5.png)
 ![](./resources/example_6.png)
+![](./resources/example_7.png)
+![](./resources/example_8.png)
 
 <p align="center">Made with :rage: by <a href="https://github.com/haskellcamargo">@haskellcamargo</a></p>

TODO.md

@@ -18,4 +18,4 @@
 - 'Do not disturb' status
 - Integration with reminders
 - Handle slash commands
-- RTM events (see https://api.slack.com/rtm)
+- RTM events (see https://api.slack.com/rtm)

app.py

@@ -3,15 +3,16 @@
 import concurrent.futures
 import functools
 import json
+import re
 import os
 import requests
-import subprocess
 import sys
+import platform
 import traceback
 import tempfile
 import urwid
 from datetime import datetime
-from slackclient import SlackClient
+
 from sclack.components import Attachment, Channel, ChannelHeader, ChatBox, Dm
 from sclack.components import Indicators, MarkdownText, Message, MessageBox
 from sclack.components import NewMessagesDivider, Profile, ProfileSideBar
@@ -80,6 +81,48 @@ def __init__(self, config):
             unhandled_input=self.unhandled_input
         )
         self.configure_screen(self.urwid_loop.screen)
+        self.mentioned_patterns = None
+
+    def get_mentioned_patterns(self):
+        slack_mentions = [
+            '<!everyone>',
+            '<!here>',
+            '<!channel>',
+            '<@{}>'.format(self.store.state.auth['user_id']),
+        ]
+
+        patterns = []
+
+        for mention in slack_mentions:
+            patterns.append('^{}[ ]+'.format(mention))
+            patterns.append('^{}$'.format(mention))
+            patterns.append('[ ]+{}'.format(mention))
+
+        return re.compile('|'.join(patterns))
+
+    def should_notify_me(self, message_obj):
+        """
+        Checking whether notify to user
+        :param message_obj:
+        :return:
+        """
+        # You send message, don't need notification
+        if self.config['features']['notification'] in ['', 'none'] or message_obj['user'] == self.store.state.auth['user_id']:
+            return False
+
+        if self.config['features']['notification'] == 'all':
+            return True
+
+        # Private message
+        if message_obj.get('channel') is not None and message_obj.get('channel')[0] == 'D':
+            return True
+
+        regex = self.mentioned_patterns
+        if regex is None:
+            regex = self.get_mentioned_patterns()
+            self.mentioned_patterns = regex
+
+        return len(re.findall(regex, message_obj['text'])) > 0
 
     def start(self):
         self._loading = True
@@ -134,6 +177,8 @@ def mount_sidebar(self, executor):
             loop.run_in_executor(executor, self.store.load_groups),
             loop.run_in_executor(executor, self.store.load_users)
         )
+        self.mentioned_patterns = self.get_mentioned_patterns()
+
         profile = Profile(name=self.store.state.auth['user'])
         channels = [
             Channel(
@@ -152,7 +197,7 @@ def mount_sidebar(self, executor):
             if user:
                 dms.append(Dm(
                     dm['id'],
-                    name=user.get('display_name') or user.get('real_name') or user['name'],
+                    name=self.store.get_user_display_name(user),
                     user=dm['user'],
                     you=user['id'] == self.store.state.auth['user_id']
                 ))
@@ -238,7 +283,7 @@ def go_to_profile(self, user_id):
                 return
             self.store.state.profile_user_id = user_id
             profile = ProfileSideBar(
-                user.get('display_name') or user.get('real_name') or user['name'],
+                self.store.get_user_display_name(user),
                 user['profile'].get('status_text', None),
                 user['profile'].get('tz_label', None),
                 user['profile'].get('phone', None),
@@ -254,7 +299,7 @@ def render_chatbox_header(self):
         if self.store.state.channel['id'][0] == 'D':
             user = self.store.find_user_by_id(self.store.state.channel['user'])
             header = ChannelHeader(
-                name=user.get('display_name') or user.get('real_name') or user['name'],
+                name=self.store.get_user_display_name(user),
                 topic=user['profile']['status_text'],
                 is_starred=self.store.state.channel.get('is_starred', False),
                 is_dm_workaround_please_remove_me=True
@@ -276,6 +321,16 @@ def on_change_topic(self, text):
         self.store.set_topic(self.store.state.channel['id'], text)
         self.go_to_sidebar()
 
+    def notification_messages(self, messages):
+        """
+        Check and send notifications
+        :param messages:
+        :return:
+        """
+        for message in messages:
+            if self.should_notify_me(message):
+                self.send_notification(message, MarkdownText(message['text']))
+
     def render_message(self, message):
         is_app = False
         subtype = message.get('subtype')
@@ -325,6 +380,7 @@ def render_message(self, message):
                 return None
 
             user_id = user['id']
+            # TODO
             user_name = user['profile']['display_name'] or user.get('name')
             color = user.get('color')
             if message.get('file'):
@@ -337,6 +393,7 @@ def render_message(self, message):
                 return None
 
             user_id = user['id']
+            # TODO
             user_name = user['profile']['display_name'] or user.get('name')
             color = user.get('color')
 
@@ -349,6 +406,7 @@ def render_message(self, message):
         ]
 
         attachments = []
+
         for attachment in message.get('attachments', []):
             attachment_widget = Attachment(
                 service_name=attachment.get('service_name'),
@@ -422,8 +480,9 @@ def render_messages(self, messages):
         previous_date = self.store.state.last_date
         last_read_datetime = datetime.fromtimestamp(float(self.store.state.channel.get('last_read', '0')))
         today = datetime.today().date()
-        for message in messages:
-            message_datetime = datetime.fromtimestamp(float(message['ts']))
+
+        for raw_message in messages:
+            message_datetime = datetime.fromtimestamp(float(raw_message['ts']))
             message_date = message_datetime.date()
             date_text = None
             unread_text = None
@@ -443,11 +502,50 @@ def render_messages(self, messages):
                 _messages.append(NewMessagesDivider(unread_text, date=date_text))
             elif date_text is not None:
                 _messages.append(TextDivider(('history_date', date_text), 'center'))
-            message = self.render_message(message)
+
+            message = self.render_message(raw_message)
+
             if message is not None:
                 _messages.append(message)
+
         return _messages
 
+    def send_notification(self, raw_message, markdown_text):
+        """
+        Only MacOS
+        @TODO Linux libnotify and Windows
+        :param raw_message:
+        :param markdown_text:
+        :return:
+        """
+        user = self.store.find_user_by_id(raw_message.get('user'))
+        sender_name = self.store.get_user_display_name(user)
+
+        # TODO Checking bot
+        if raw_message.get('channel')[0] == 'D':
+            notification_title = 'New message in {}'.format(
+                self.store.state.auth['team']
+            )
+        else:
+            notification_title = 'New message in {} #{}'.format(
+                self.store.state.auth['team'],
+                self.store.get_channel_name(raw_message.get('channel')),
+            )
+
+        sub_title = sender_name
+
+        if platform.system() == 'Darwin':
+            # Macos
+            import pync
+            pync.notify(
+                markdown_text.render_text(),
+                title=notification_title,
+                subtitle=sub_title,
+                appIcon='./resources/slack_icon.png'
+            )
+        else:
+            pass
+
     @asyncio.coroutine
     def _go_to_channel(self, channel_id):
         with concurrent.futures.ThreadPoolExecutor(max_workers=20) as executor:
@@ -527,6 +625,7 @@ def start_real_time(self):
         def stop_typing(*args):
             self.chatbox.message_box.typing = None
         alarm = None
+
         while self.store.slack.server.connected is True:
             events = self.store.slack.rtm_read()
             for event in events:
@@ -537,9 +636,8 @@ def stop_typing(*args):
                     for channel in self.sidebar.channels:
                         if channel.id == event['channel']:
                             channel.set_unread(unread)
-                elif event.get('channel') == self.store.state.channel['id']:
-                    if event['type'] == 'message':
-                        # Delete message
+                elif event['type'] == 'message':
+                    if event.get('channel') == self.store.state.channel['id']:
                         if event.get('subtype') == 'message_deleted':
                             for widget in self.chatbox.body.body:
                                 if hasattr(widget, 'ts') and getattr(widget, 'ts') == event['deleted_ts']:
@@ -553,16 +651,23 @@ def stop_typing(*args):
                         else:
                             self.chatbox.body.body.extend(self.render_messages([event]))
                             self.chatbox.body.scroll_to_bottom()
-                    elif event['type'] == 'user_typing':
+                    else:
+                        pass
+
+                    if event.get('subtype') != 'message_deleted' and event.get('subtype') != 'message_changed':
+                        # Notification
+                        self.notification_messages([event])
+                elif event['type'] == 'user_typing':
+                    if event.get('channel') == self.store.state.channel['id']:
                         user = self.store.find_user_by_id(event['user'])
-                        name = user.get('display_name') or user.get('real_name') or user['name']
+                        name = self.store.get_user_display_name(user)
+
                         if alarm is not None:
                             self.urwid_loop.remove_alarm(alarm)
                         self.chatbox.message_box.typing = name
                         self.urwid_loop.set_alarm_in(3, stop_typing)
                     else:
                         pass
-                        # print(json.dumps(event, indent=2))
                 elif event.get('ok', False):
                     # Message was sent, Slack confirmed it.
                     self.chatbox.body.body.extend(self.render_messages([{

config.json

@@ -25,7 +25,8 @@
         "emoji": true,
         "markdown": true,
         "pictures": true,
-        "browser": ""
+        "browser": "",
+        "notification": ""
     },
     "icons": {
         "block": "\u258C",

requirements.txt

@@ -4,3 +4,4 @@ pyperclip==1.6.2
 requests
 slackclient==1.2.1
 urwid_readline
+git+git://github.com/duynguyenhoang/pync@994fbf77360a273fac1225558de01c8d0040dc6c#egg=pync

resources/slack_icon.png

@@ -40,6 +40,7 @@ def parse_message(self, text):
         self._state = 'message'
         self._previous_state = 'message'
         self._result = []
+
         def render_emoji(result):
             return emoji_codemap.get(result.group(1), result.group(0))
 
@@ -71,3 +72,6 @@ def render_emoji(result):
 
         self._result.append(('message', self.decode_buffer()))
         return self._result
+
+    def render_text(self):
+        return urwid.Text(self.markup).text

sclack/markdown.py

@@ -1,5 +1,6 @@
 from slackclient import SlackClient
 
+
 class State:
     def __init__(self):
         self.channels = []
@@ -42,6 +43,14 @@ def switch_to_workspace(self, workspace_number):
     def find_user_by_id(self, user_id):
         return self._users_dict.get(user_id)
 
+    def get_user_display_name(self, user_detail):
+        """
+        Get real name of user to display
+        :param user_detail:
+        :return:
+        """
+        return user_detail.get('display_name') or user_detail.get('real_name') or user_detail['name']
+
     def load_auth(self):
         self.state.auth = self.slack.api_call('auth.test')
 
@@ -97,6 +106,19 @@ def load_channels(self):
         self.state.channels.sort(key=lambda channel: channel['name'])
         self.state.dms.sort(key=lambda dm: dm['created'])
 
+    def get_channel_name(self, channel_id):
+        matched_channel = None
+
+        for channel in self.state.channels:
+            if channel['id'] == channel_id:
+                matched_channel = channel
+                break
+
+        if matched_channel:
+            return matched_channel['name']
+
+        return channel_id
+
     def load_groups(self):
         self.state.groups = self.slack.api_call('mpim.list')['groups']
 
@@ -144,4 +166,4 @@ def get_presence(self, user_id):
                 self.state.online_users.add(user_id)
             else:
                 self.state.online_users.discard(user_id)
-        return response
+        return response