Improved Apprise encoding and text format support (#566)

2025-08-19 04:47:20 +02:00 · 2022-04-16 15:33:49 -04:00
parent 5d14259227
commit a05b042c6d
8 changed files with 595 additions and 69 deletions
--- a/test/test_plugin_telegram.py
+++ b/test/test_plugin_telegram.py
@@ -25,6 +25,7 @@

 import os
 import six
+import sys
 import pytest
 import mock
 import requests
@@ -34,6 +35,7 @@ from apprise import Apprise
 from apprise import AppriseAttachment
 from apprise import AppriseAsset
 from apprise import NotifyType
+from apprise import NotifyFormat
 from apprise import plugins
 from helpers import AppriseURLTester

@@ -211,20 +213,22 @@ def test_plugin_telegram_urls():

    """

+    # Disable Throttling to speed testing
+    plugins.NotifyTelegram.request_rate_per_sec = 0
+
    # Run our general tests
    AppriseURLTester(tests=apprise_url_tests).run_all()


-@mock.patch('requests.get')
@mock.patch('requests.post')
-def test_plugin_telegram_general(mock_post, mock_get):
+def test_plugin_telegram_general(mock_post):
    """
    NotifyTelegram() General Tests

    """

    # Disable Throttling to speed testing
-    plugins.NotifyBase.request_rate_per_sec = 0
+    plugins.NotifyTelegram.request_rate_per_sec = 0

    # Bot Token
    bot_token = '123456789:abcdefg_hijklmnop'
@@ -234,11 +238,8 @@ def test_plugin_telegram_general(mock_post, mock_get):
    chat_ids = 'l2g, lead2gold'

    # Prepare Mock
-    mock_get.return_value = requests.Request()
    mock_post.return_value = requests.Request()
    mock_post.return_value.status_code = requests.codes.ok
-    mock_get.return_value.status_code = requests.codes.ok
-    mock_get.return_value.content = '{}'
    mock_post.return_value.content = '{}'

    # Exception should be thrown about the fact no bot token was specified
@@ -246,20 +247,17 @@ def test_plugin_telegram_general(mock_post, mock_get):
        plugins.NotifyTelegram(bot_token=None, targets=chat_ids)

    # Invalid JSON while trying to detect bot owner
-    mock_get.return_value.content = '{'
    mock_post.return_value.content = '}'
    obj = plugins.NotifyTelegram(bot_token=bot_token, targets=None)
    obj.notify(title='hello', body='world')

    # Invalid JSON while trying to detect bot owner + 400 error
-    mock_get.return_value.status_code = requests.codes.internal_server_error
    mock_post.return_value.status_code = requests.codes.internal_server_error
    obj = plugins.NotifyTelegram(bot_token=bot_token, targets=None)
    obj.notify(title='hello', body='world')

    # Return status back to how they were
    mock_post.return_value.status_code = requests.codes.ok
-    mock_get.return_value.status_code = requests.codes.ok

    # Exception should be thrown about the fact an invalid bot token was
    # specifed
@@ -280,9 +278,7 @@ def test_plugin_telegram_general(mock_post, mock_get):
    assert not obj.send_media(obj.targets[0], NotifyType.INFO)

    # Restore their entries
-    mock_get.side_effect = None
    mock_post.side_effect = None
-    mock_get.return_value.content = '{}'
    mock_post.return_value.content = '{}'

    # test url call
@@ -304,7 +300,6 @@ def test_plugin_telegram_general(mock_post, mock_get):
    response.content = dumps({
        'description': 'test',
    })
-    mock_get.return_value = response
    mock_post.return_value = response

    # No image asset
@@ -410,10 +405,9 @@ def test_plugin_telegram_general(mock_post, mock_get):
    assert mock_post.call_count == 1
    payload = loads(mock_post.call_args_list[0][1]['data'])

-    # Our special characters are escaped properly
+    # Test our payload
    assert payload['text'] == \
-        '<b>special characters</b>\r\n&lt;p&gt;'\
-        '\'"This can\'t\t\r\nfail us"\'&lt;/p&gt;'
+        '<h1>special characters</h1><p>\'"This can\'t\t\r\nfail us"\'</p>'

    # Test sending attachments
    attach = AppriseAttachment(os.path.join(TEST_VAR_DIR, 'apprise-test.gif'))
@@ -545,3 +539,415 @@ def test_plugin_telegram_general(mock_post, mock_get):
    assert isinstance(obj, plugins.NotifyTelegram)
    assert len(obj.targets) == 1
    assert '-123456789525' in obj.targets
+
+
+@pytest.mark.skipif(sys.version_info.major <= 2, reason="Requires Python 3.x+")
+@mock.patch('requests.post')
+def test_plugin_telegram_formating_py3(mock_post):
+    """
+    NotifyTelegram() Python v3+ Formatting Tests
+
+    """
+
+    # Disable Throttling to speed testing
+    plugins.NotifyTelegram.request_rate_per_sec = 0
+
+    # Prepare Mock
+    mock_post.return_value = requests.Request()
+    mock_post.return_value.status_code = requests.codes.ok
+    mock_post.return_value.content = '{}'
+
+    # Simple success response
+    mock_post.return_value.content = dumps({
+        "ok": True,
+        "result": [{
+            "update_id": 645421321,
+            "message": {
+                "message_id": 2,
+                "from": {
+                    "id": 532389719,
+                    "is_bot": False,
+                    "first_name": "Chris",
+                    "language_code": "en-US"
+                },
+                "chat": {
+                    "id": 532389719,
+                    "first_name": "Chris",
+                    "type": "private"
+                },
+                "date": 1519694394,
+                "text": "/start",
+                "entities": [{
+                    "offset": 0,
+                    "length": 6,
+                    "type": "bot_command",
+                }],
+            }},
+        ],
+    })
+    mock_post.return_value.status_code = requests.codes.ok
+
+    results = plugins.NotifyTelegram.parse_url(
+        'tgram://123456789:abcdefg_hijklmnop/')
+
+    instance = plugins.NotifyTelegram(**results)
+    assert isinstance(instance, plugins.NotifyTelegram)
+
+    response = instance.send(title='title', body='body')
+    assert response is True
+    # 1 call to look up bot owner, and second for notification
+    assert mock_post.call_count == 2
+
+    assert mock_post.call_args_list[0][0][0] == \
+        'https://api.telegram.org/bot123456789:abcdefg_hijklmnop/getUpdates'
+    assert mock_post.call_args_list[1][0][0] == \
+        'https://api.telegram.org/bot123456789:abcdefg_hijklmnop/sendMessage'
+
+    # Reset our values
+    mock_post.reset_mock()
+
+    # Now test our HTML Conversion as TEXT)
+    aobj = Apprise()
+    aobj.add('tgram://123456789:abcdefg_hijklmnop/')
+    assert len(aobj) == 1
+
+    title = '🚨 Change detected for <i>Apprise Test Title</i>'
+    body = '<a href="http://localhost"><i>Apprise Body Title</i></a>' \
+           ' had <a href="http://127.0.0.1">a change</a>'
+
+    assert aobj.notify(title=title, body=body, body_format=NotifyFormat.TEXT)
+
+    # Test our calls
+    assert mock_post.call_count == 2
+
+    assert mock_post.call_args_list[0][0][0] == \
+        'https://api.telegram.org/bot123456789:abcdefg_hijklmnop/getUpdates'
+    assert mock_post.call_args_list[1][0][0] == \
+        'https://api.telegram.org/bot123456789:abcdefg_hijklmnop/sendMessage'
+
+    payload = loads(mock_post.call_args_list[1][1]['data'])
+
+    # Test that everything is escaped properly in a TEXT mode
+    assert payload['text'] == \
+        '<h1>🚨 Change detected for &lt;i&gt;Apprise Test Title&lt;/i&gt;' \
+        '</h1>&lt;a href="http://localhost"&gt;&lt;i&gt;Apprise Body Title' \
+        '&lt;/i&gt;&lt;/a&gt; had &lt;a href="http://127.0.0.1"&gt;a change' \
+        '&lt;/a&gt;'
+
+    # Reset our values
+    mock_post.reset_mock()
+
+    # Now test our HTML Conversion as TEXT)
+    aobj = Apprise()
+    aobj.add('tgram://123456789:abcdefg_hijklmnop/?format=html')
+    assert len(aobj) == 1
+
+    assert aobj.notify(title=title, body=body, body_format=NotifyFormat.HTML)
+
+    # Test our calls
+    assert mock_post.call_count == 2
+
+    assert mock_post.call_args_list[0][0][0] == \
+        'https://api.telegram.org/bot123456789:abcdefg_hijklmnop/getUpdates'
+    assert mock_post.call_args_list[1][0][0] == \
+        'https://api.telegram.org/bot123456789:abcdefg_hijklmnop/sendMessage'
+
+    payload = loads(mock_post.call_args_list[1][1]['data'])
+
+    # Test that everything is escaped properly in a HTML mode
+    assert payload['text'] == \
+        '<h1>🚨 Change detected for <i>Apprise Test Title</i></h1>' \
+        '<a href="http://localhost"><i>Apprise Body Title</i></a> had ' \
+        '<a href="http://127.0.0.1">a change</a>'
+
+    # Reset our values
+    mock_post.reset_mock()
+
+    # Now test our MARKDOWN Handling
+    title = '# 🚨 Change detected for _Apprise Test Title_'
+    body = '_[Apprise Body Title](http://localhost)_' \
+           ' had [a change](http://127.0.0.1)'
+
+    aobj = Apprise()
+    aobj.add('tgram://123456789:abcdefg_hijklmnop/?format=markdown')
+    assert len(aobj) == 1
+
+    assert aobj.notify(
+        title=title, body=body, body_format=NotifyFormat.MARKDOWN)
+
+    # Test our calls
+    assert mock_post.call_count == 2
+
+    assert mock_post.call_args_list[0][0][0] == \
+        'https://api.telegram.org/bot123456789:abcdefg_hijklmnop/getUpdates'
+    assert mock_post.call_args_list[1][0][0] == \
+        'https://api.telegram.org/bot123456789:abcdefg_hijklmnop/sendMessage'
+
+    payload = loads(mock_post.call_args_list[1][1]['data'])
+
+    # Test that everything is escaped properly in a HTML mode
+    assert payload['text'] == \
+        '# 🚨 Change detected for _Apprise Test Title_\r\n' \
+        '_[Apprise Body Title](http://localhost)_ had ' \
+        '[a change](http://127.0.0.1)'
+
+    # Reset our values
+    mock_post.reset_mock()
+
+    # Upstream to use HTML but input specified as Markdown
+    aobj = Apprise()
+    aobj.add('tgram://987654321:abcdefg_hijklmnop/?format=html')
+    assert len(aobj) == 1
+
+    # HTML forced by the command line, but MARKDOWN spacified as
+    # upstream mode
+    assert aobj.notify(
+        title=title, body=body, body_format=NotifyFormat.MARKDOWN)
+
+    # Test our calls
+    assert mock_post.call_count == 2
+
+    assert mock_post.call_args_list[0][0][0] == \
+        'https://api.telegram.org/bot987654321:abcdefg_hijklmnop/getUpdates'
+    assert mock_post.call_args_list[1][0][0] == \
+        'https://api.telegram.org/bot987654321:abcdefg_hijklmnop/sendMessage'
+
+    payload = loads(mock_post.call_args_list[1][1]['data'])
+
+    # Test that everything is escaped properly in a HTML mode
+    assert payload['text'] == \
+        '<h1><p>🚨 Change detected for <em>Apprise Test Title</em></p>' \
+        '</h1><p><em><a href="http://localhost">Apprise Body Title</a></em> ' \
+        'had <a href="http://127.0.0.1">a change</a></p>'
+
+
+@pytest.mark.skipif(sys.version_info.major >= 3, reason="Requires Python 2.x+")
+@mock.patch('requests.post')
+def test_plugin_telegram_formating_py2(mock_post):
+    """
+    NotifyTelegram() Python v2 Formatting Tests
+
+    """
+
+    # Disable Throttling to speed testing
+    plugins.NotifyTelegram.request_rate_per_sec = 0
+
+    # Prepare Mock
+    mock_post.return_value = requests.Request()
+    mock_post.return_value.status_code = requests.codes.ok
+    mock_post.return_value.content = '{}'
+
+    # Simple success response
+    mock_post.return_value.content = dumps({
+        "ok": True,
+        "result": [{
+            "update_id": 645421321,
+            "message": {
+                "message_id": 2,
+                "from": {
+                    "id": 532389719,
+                    "is_bot": False,
+                    "first_name": "Chris",
+                    "language_code": "en-US"
+                },
+                "chat": {
+                    "id": 532389719,
+                    "first_name": "Chris",
+                    "type": "private"
+                },
+                "date": 1519694394,
+                "text": "/start",
+                "entities": [{
+                    "offset": 0,
+                    "length": 6,
+                    "type": "bot_command",
+                }],
+            }},
+        ],
+    })
+    mock_post.return_value.status_code = requests.codes.ok
+
+    results = plugins.NotifyTelegram.parse_url(
+        'tgram://123456789:abcdefg_hijklmnop/')
+
+    instance = plugins.NotifyTelegram(**results)
+    assert isinstance(instance, plugins.NotifyTelegram)
+
+    response = instance.send(title='title', body='body')
+    assert response is True
+    # 1 call to look up bot owner, and second for notification
+    assert mock_post.call_count == 2
+
+    assert mock_post.call_args_list[0][0][0] == \
+        'https://api.telegram.org/bot123456789:abcdefg_hijklmnop/getUpdates'
+    assert mock_post.call_args_list[1][0][0] == \
+        'https://api.telegram.org/bot123456789:abcdefg_hijklmnop/sendMessage'
+
+    # Reset our values
+    mock_post.reset_mock()
+
+    # Now test our HTML Conversion as TEXT)
+    aobj = Apprise()
+    aobj.add('tgram://123456789:abcdefg_hijklmnop/')
+    assert len(aobj) == 1
+
+    title = '🚨 Change detected for <i>Apprise Test Title</i>'
+    body = '<a href="http://localhost"><i>Apprise Body Title</i></a>' \
+           ' had <a href="http://127.0.0.1">a change</a>'
+
+    assert aobj.notify(title=title, body=body, body_format=NotifyFormat.TEXT)
+
+    # Test our calls
+    assert mock_post.call_count == 2
+
+    assert mock_post.call_args_list[0][0][0] == \
+        'https://api.telegram.org/bot123456789:abcdefg_hijklmnop/getUpdates'
+    assert mock_post.call_args_list[1][0][0] == \
+        'https://api.telegram.org/bot123456789:abcdefg_hijklmnop/sendMessage'
+
+    payload = loads(mock_post.call_args_list[1][1]['data'])
+
+    # Test that everything is escaped properly in a TEXT mode
+    assert payload['text'].encode('utf-8') == \
+        '<h1>\xf0\x9f\x9a\xa8 Change detected for &lt;i&gt;' \
+        'Apprise Test Title&lt;/i&gt;</h1>' \
+        '&lt;a href="http://localhost"&gt;&lt;i&gt;' \
+        'Apprise Body Title&lt;/i&gt;&lt;/a&gt; had &lt;a ' \
+        'href="http://127.0.0.1"&gt;a change&lt;/a&gt;'
+
+    # Reset our values
+    mock_post.reset_mock()
+
+    # Now test our HTML Conversion as TEXT)
+    aobj = Apprise()
+    aobj.add('tgram://123456789:abcdefg_hijklmnop/?format=html')
+    assert len(aobj) == 1
+
+    assert aobj.notify(title=title, body=body, body_format=NotifyFormat.HTML)
+
+    # Test our calls
+    assert mock_post.call_count == 2
+
+    assert mock_post.call_args_list[0][0][0] == \
+        'https://api.telegram.org/bot123456789:abcdefg_hijklmnop/getUpdates'
+    assert mock_post.call_args_list[1][0][0] == \
+        'https://api.telegram.org/bot123456789:abcdefg_hijklmnop/sendMessage'
+
+    payload = loads(mock_post.call_args_list[1][1]['data'])
+
+    # Test that everything is escaped properly in a HTML mode
+    assert payload['text'].encode('utf-8') == \
+        '<h1>\xf0\x9f\x9a\xa8 Change detected for <i>Apprise Test Title</i>' \
+        '</h1><a href="http://localhost"><i>Apprise Body Title</i></a> had ' \
+        '<a href="http://127.0.0.1">a change</a>'
+
+    # Reset our values
+    mock_post.reset_mock()
+
+    # Now test our MARKDOWN Handling
+    title = '# 🚨 Change detected for _Apprise Test Title_'
+    body = '_[Apprise Body Title](http://localhost)_' \
+           ' had [a change](http://127.0.0.1)'
+
+    aobj = Apprise()
+    aobj.add('tgram://123456789:abcdefg_hijklmnop/?format=markdown')
+    assert len(aobj) == 1
+
+    assert aobj.notify(
+        title=title, body=body, body_format=NotifyFormat.MARKDOWN)
+
+    # Test our calls
+    assert mock_post.call_count == 2
+
+    assert mock_post.call_args_list[0][0][0] == \
+        'https://api.telegram.org/bot123456789:abcdefg_hijklmnop/getUpdates'
+    assert mock_post.call_args_list[1][0][0] == \
+        'https://api.telegram.org/bot123456789:abcdefg_hijklmnop/sendMessage'
+
+    payload = loads(mock_post.call_args_list[1][1]['data'])
+
+    # Test that everything is escaped properly in a HTML mode
+    assert payload['text'].encode('utf-8') == \
+        '# \xf0\x9f\x9a\xa8 Change detected for _Apprise Test Title_\r\n_' \
+        '[Apprise Body Title](http://localhost)_ had ' \
+        '[a change](http://127.0.0.1)'
+
+    # Reset our values
+    mock_post.reset_mock()
+
+    # Upstream to use HTML but input specified as Markdown
+    aobj = Apprise()
+    aobj.add('tgram://987654321:abcdefg_hijklmnop/?format=html')
+    assert len(aobj) == 1
+
+    # HTML forced by the command line, but MARKDOWN spacified as
+    # upstream mode
+    assert aobj.notify(
+        title=title, body=body, body_format=NotifyFormat.MARKDOWN)
+
+    # Test our calls
+    assert mock_post.call_count == 2
+
+    assert mock_post.call_args_list[0][0][0] == \
+        'https://api.telegram.org/bot987654321:abcdefg_hijklmnop/getUpdates'
+    assert mock_post.call_args_list[1][0][0] == \
+        'https://api.telegram.org/bot987654321:abcdefg_hijklmnop/sendMessage'
+
+    payload = loads(mock_post.call_args_list[1][1]['data'])
+
+    # Test that everything is escaped properly in a HTML mode
+    assert payload['text'].encode('utf-8') == \
+        '<h1><p>\xf0\x9f\x9a\xa8 Change detected for ' \
+        '<em>Apprise Test Title</em></p></h1><p><em>' \
+        '<a href="http://localhost">Apprise Body Title</a></em>' \
+        ' had <a href="http://127.0.0.1">a change</a></p>'
+
+    # Reset our values
+    mock_post.reset_mock()
+
+    # Now test hebrew types (outside of default utf-8)
+    # כותרת נפלאה translates to 'A wonderful title'
+    # זו הודעה translates to 'This is a notification'
+    title = 'כותרת נפלאה' \
+            .decode('utf-8').encode('ISO-8859-8')
+    body = '[_[זו הודעה](http://localhost)_' \
+           .decode('utf-8').encode('ISO-8859-8')
+
+    asset = AppriseAsset(encoding='utf-8')
+    # Now test default entries
+    aobj = Apprise(asset=asset)
+    aobj.add('tgram://123456789:abcdefg_hijklmnop/')
+    assert len(aobj) == 1
+
+    # Our notification will fail because we'll have an encoding error
+    assert not aobj.notify(title=title, body=body)
+    # Nothing was even attempted to be notified
+    assert mock_post.call_count == 0
+
+    # Let's use the expected input
+    asset = AppriseAsset(encoding='ISO-8859-8')
+
+    # Now test default entries
+    aobj = Apprise(asset=asset)
+
+    aobj.add('tgram://123456789:abcdefg_hijklmnop/')
+    assert len(aobj) == 1
+
+    # Our notification will work now
+    assert aobj.notify(title=title, body=body)
+
+    # Test our calls
+    assert mock_post.call_count == 2
+
+    assert mock_post.call_args_list[0][0][0] == \
+        'https://api.telegram.org/bot123456789:abcdefg_hijklmnop/getUpdates'
+    assert mock_post.call_args_list[1][0][0] == \
+        'https://api.telegram.org/bot123456789:abcdefg_hijklmnop/sendMessage'
+
+    payload = loads(mock_post.call_args_list[1][1]['data'])
+
+    # Test that everything is escaped properly in a HTML mode
+    assert payload['text'].encode('utf-8') == \
+        '<h1>\xd7\x9b\xd7\x95\xd7\xaa\xd7\xa8\xd7\xaa '\
+        '\xd7\xa0\xd7\xa4\xd7\x9c\xd7\x90\xd7\x94</h1>[_[\xd7\x96\xd7\x95 '\
+        '\xd7\x94\xd7\x95\xd7\x93\xd7\xa2\xd7\x94](http://localhost)_'