Add basic telegram notification integration

PlexAniSync.py

@@ -11,6 +11,7 @@
 import anilist
 import plexmodule
 import graphql
+import telegram
 from _version import __version__
 
 # Logger settings
@@ -59,6 +60,8 @@ def read_settings(settings_file) -> configparser.ConfigParser:
 settings = read_settings(SETTINGS_FILE)
 anilist_settings = settings["ANILIST"]
 plex_settings = settings["PLEX"]
+telegram_settings = settings["TELEGRAM"]
+telegram.setup(telegram_settings)
 
 graphql.ANILIST_ACCESS_TOKEN = anilist_settings["access_token"].strip()
 
@@ -79,6 +82,7 @@ def read_settings(settings_file) -> configparser.ConfigParser:
 ## Startup section ##
 def start():
     logger.info(f"PlexAniSync - version: {__version__}")
+    telegram.starting_sync(__version__)
 
     anilist.CUSTOM_MAPPINGS = read_custom_mappings()
 
@@ -123,6 +127,7 @@ def start():
         else:
             anilist.match_to_plex(anilist_series, plex_series_watched)
 
+    telegram.report_to_telegram()
     logger.info("Plex to AniList sync finished")
 
 

README.md

@@ -221,6 +221,15 @@ Depending on your OS make sure to place the show name between single or double q
 
 https://github.com/RickDB/PlexAniSync/wiki/Tautulli-sync-script
 
+### Telegram Integration
+
+We can inform you via Telegram about start / errors / finish of the sync process. This is especially useful for automatic daily syncs. In case an error occurs or a new anime got added that needs a custom mapping you are always informed.
+
+To enable this you first have to create a new Telegram Bot by talking to the neat helper [BotFather](https://t.me/BotFather). From him you get a "bot_token" which you have to save in the `settings.ini`. After that you also need a chat
+where to send the messages to. For that add the bot to any chatroom and use a bot like [IDBot](https://t.me/myidbot) to get the chats id. Save this to `chat_id` in the `settings.ini`.
+
+Last but not least you have to enable the integration by settings `eneabled` in the `[TELEGRAM]` section of `settings.ini` to `True`.
+
 ## Docker
 
 Docker version is located here: [PlexAniSync](https://github.com/RickDB/PlexAniSync/pkgs/container/plexanisync)

settings.ini.example

@@ -25,4 +25,12 @@ access_token = SomeVeryLongAccessToken
 plex_episode_count_priority = False
 skip_list_update = False
 username = SomeUsername
-log_failed_matches = False
+log_failed_matches = False
+
+[TELEGRAM]
+# Set enabled to True to get Telegram notifications upon finish
+enabled = False
+# Only send errors and no start / finish indicators
+errors_only = False
+bot_token = TOKEN
+chat_id = CHAT_ID

telegram.py

@@ -0,0 +1,84 @@
+# coding=utf-8
+import logging
+import time
+
+from io import StringIO
+from requests import get, HTTPError
+
+logger = logging.getLogger("PlexAniSync")
+# Gets overriden by settings.ini
+settings = {
+    'enabled': False,
+    'errors_only': False,
+    'bot_token': '',
+    'chat_id': '',
+}
+
+# Keep track of errors for Telegram integration
+error_tracker = StringIO()
+handler = logging.StreamHandler(error_tracker)
+handler.setLevel(logging.WARNING)
+logger.addHandler(handler)
+
+
+def setup(ini_settings):
+    global settings
+    if ini_settings.get('enabled', '').lower().strip() == 'true':
+        enabled = True
+        bot_token, chat_id = ini_settings.get('bot_token', '').strip(), ini_settings.get('chat_id').strip()
+
+        if not bot_token:
+            logger.error('[TELEGRAM] Bot token not set, disabling telegram integration')
+            enabled = False
+        if not chat_id:
+            logger.error('[TELEGRAM] Chat id not set, disabling telegram integration')
+            enabled = False
+
+        settings['enabled'] = enabled
+        settings['bot_token'] = bot_token
+        settings['chat_id'] = chat_id
+        settings['errors_only'] = ini_settings.get('errors_only', '').lower().strip() == 'true'
+
+
+def send_message(text):
+    if not settings['enabled']:
+        return
+
+    log_text = text if len(text) < 30 else (text[:27] + '...')
+    try:
+        response = get(
+                f'https://api.telegram.org/bot{settings["bot_token"]}/sendMessage',
+                data={
+                    'chat_id': settings['chat_id'],
+                    'text': text,
+                    'parse_mode': 'markdown'
+                })
+        response.raise_for_status()
+        logger.info(f'[TELEGRAM] message sent to Telegram | chat_id: {settings["chat_id"]} | text: "{log_text}"')
+    except HTTPError as e:
+        logger.error(f'[TELEGRAM] Could not send message | chat_id: {settings["chat_id"]} | text: "{log_text}" | error: {e}')
+
+
+def starting_sync(version):
+    if not settings['enabled'] or settings['errors_only']:
+        return
+
+    send_message(f'PlexAniSync - version: `{version}`\nSync Started - `{time.asctime()}`')
+
+
+def report_to_telegram():
+    if not settings['enabled']:
+        return
+
+    if error_tracker.getvalue():
+        error = ''
+        for line in error_tracker.getvalue().split('\n'):
+            if len(error) + len(line) + 3 > 4096:
+                send_message(error)
+                error = ''
+            error += f'`{line}`\n'
+        if error:
+            send_message(error)
+
+    if not settings['errors_only']:
+        send_message(f'Sync Complete - `{time.asctime()}`')