extern/apprise
1
0
Fork 0
mirror of https://github.com/caronc/apprise.git synced 2025-03-13 14:28:23 +01:00
Code Issues Packages Projects Releases Wiki Activity

Telegram messages leverage caption field when attachments

Browse Source
This commit is contained in:
Chris Caron 2025-02-19 19:57:03 -05:00
parent fcc4939328
commit 3b9b4c84b4
1 changed files with 35 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
apprise/plugins/telegram.py
View File

@ -157,6 +157,11 @@ class NotifyTelegram(NotifyBase):
# The maximum allowable characters allowed in the body per message # The maximum allowable characters allowed in the body per message
body_maxlen = 4096 body_maxlen = 4096
# The maximum number of characters a telegram attachment caption can be
# If an attachment is provided and the body is within the caption limit
# then it is captioned with the attachment instead.
telegram_caption_maxlen = 1024
# Title is to be part of body # Title is to be part of body
title_maxlen = 0 title_maxlen = 0
@ -485,7 +490,7 @@ class NotifyTelegram(NotifyBase):
# or not. # or not.
self.include_image = include_image self.include_image = include_image
def send_media(self, target, notify_type, attach=None): def send_media(self, target, notify_type, payload={}, attach=None):
""" """
Sends a sticker based on the specified notify type Sends a sticker based on the specified notify type
@ -547,7 +552,7 @@ class NotifyTelegram(NotifyBase):
# Extract our target # Extract our target
chat_id, topic = target chat_id, topic = target
payload = {'chat_id': chat_id} payload['chat_id'] = chat_id
if topic: if topic:
payload['message_thread_id'] = topic payload['message_thread_id'] = topic
@ -798,9 +803,19 @@ class NotifyTelegram(NotifyBase):
# Prepare our payload based on HTML or TEXT # Prepare our payload based on HTML or TEXT
_payload['text'] = body _payload['text'] = body
# Prepare our caption payload
caption_payload = {
'caption': _payload['text'],
'show_caption_above_media': True
if self.content == TelegramContentPlacement.BEFORE else False,
'parse_mode': _payload['parse_mode']} \
if attach and body and len(_payload.get('text', '')) < \
self.telegram_caption_maxlen else {}
# Handle payloads without a body specified (but an attachment present) # Handle payloads without a body specified (but an attachment present)
attach_content = \ attach_content = \
TelegramContentPlacement.AFTER if not body else self.content TelegramContentPlacement.AFTER \
if not body or caption_payload else self.content
# Create a copy of the chat_ids list # Create a copy of the chat_ids list
targets = list(self.targets) targets = list(self.targets)
@ -822,7 +837,7 @@ class NotifyTelegram(NotifyBase):
# We failed to send the image associated with our # We failed to send the image associated with our
notify_type notify_type
self.logger.warning( self.logger.warning(
'Failed to send Telegram type image to {}.', 'Failed to send Telegram attachment to {}.',
pchat_id) pchat_id)
if attach and self.attachment_support and \ if attach and self.attachment_support and \
@ -830,6 +845,7 @@ class NotifyTelegram(NotifyBase):
# Send our attachments now (if specified and if it exists) # Send our attachments now (if specified and if it exists)
if not self._send_attachments( if not self._send_attachments(
target, notify_type=notify_type, target, notify_type=notify_type,
payload=caption_payload,
attach=attach): attach=attach):
has_error = True has_error = True
@ -839,6 +855,10 @@ class NotifyTelegram(NotifyBase):
# Nothing more to do; move along to the next attachment # Nothing more to do; move along to the next attachment
continue continue
if caption_payload:
# nothing further to do; move along to the next attachment
continue
# Always call throttle before any remote server i/o is made; # Always call throttle before any remote server i/o is made;
# Telegram throttles to occur before sending the image so that # Telegram throttles to occur before sending the image so that
# content can arrive together. # content can arrive together.
@ -916,14 +936,22 @@ class NotifyTelegram(NotifyBase):
return not has_error return not has_error
def _send_attachments(self, target, notify_type, attach): def _send_attachments(self, target, notify_type, attach, payload={}):
""" """
Sends our attachments Sends our attachments
""" """
has_error = False has_error = False
# Send our attachments now (if specified and if it exists) # Send our attachments now (if specified and if it exists)
for attachment in attach: for no, attachment in enumerate(attach, start=1):
if not self.send_media(target, notify_type, attach=attachment): payload = payload if payload and no == 1 else {}
payload.update({
'title': attachment.name
if attachment.name else f'file{no:03}.dat'})
if not self.send_media(
target, notify_type,
payload=payload,
attach=attachment):
# We failed; don't continue # We failed; don't continue
has_error = True has_error = True