Removed formatting of title when not blended with body (#914)

apprise/Apprise.py

@@ -498,25 +498,29 @@ def _create_notify_gen(self, body, title='',
             # If our code reaches here, we either did not define a tag (it
             # was set to None), or we did define a tag and the logic above
             # determined we need to notify the service it's associated with
-            if server.notify_format not in conversion_body_map:
-                # Perform Conversion
-                conversion_body_map[server.notify_format] = \
-                    convert_between(
-                        body_format, server.notify_format, content=body)
+
+            # First we need to generate a key we will use to determine if we
+            # need to build our data out.  Entries without are merged with
+            # the body at this stage.
+            key = server.notify_format if server.title_maxlen > 0\
+                else f'_{server.notify_format}'
+
+            if key not in conversion_title_map:
 
                 # Prepare our title
-                conversion_title_map[server.notify_format] = \
-                    '' if not title else title
+                conversion_title_map[key] = '' if not title else title
 
-                # Tidy Title IF required (hence it will become part of the
-                # body)
-                if server.title_maxlen <= 0 and \
-                        conversion_title_map[server.notify_format]:
+                # Conversion of title only occurs for services where the title
+                # is blended with the body (title_maxlen <= 0)
+                if conversion_title_map[key] and server.title_maxlen <= 0:
+                    conversion_title_map[key] = convert_between(
+                        body_format, server.notify_format,
+                        content=conversion_title_map[key])
 
-                    conversion_title_map[server.notify_format] = \
-                        convert_between(
-                            body_format, server.notify_format,
-                            content=conversion_title_map[server.notify_format])
+                # Our body is always converted no matter what
+                conversion_body_map[key] = \
+                    convert_between(
+                        body_format, server.notify_format, content=body)
 
                 if interpret_escapes:
                     #
@@ -526,13 +530,13 @@ def _create_notify_gen(self, body, title='',
                     try:
                         # Added overhead required due to Python 3 Encoding Bug
                         # identified here: https://bugs.python.org/issue21331
-                        conversion_body_map[server.notify_format] = \
-                            conversion_body_map[server.notify_format]\
+                        conversion_body_map[key] = \
+                            conversion_body_map[key]\
                             .encode('ascii', 'backslashreplace')\
                             .decode('unicode-escape')
 
-                        conversion_title_map[server.notify_format] = \
-                            conversion_title_map[server.notify_format]\
+                        conversion_title_map[key] = \
+                            conversion_title_map[key]\
                             .encode('ascii', 'backslashreplace')\
                             .decode('unicode-escape')
 
@@ -543,8 +547,8 @@ def _create_notify_gen(self, body, title='',
                         raise TypeError(msg)
 
             kwargs = dict(
-                body=conversion_body_map[server.notify_format],
-                title=conversion_title_map[server.notify_format],
+                body=conversion_body_map[key],
+                title=conversion_title_map[key],
                 notify_type=notify_type,
                 attach=attach,
                 body_format=body_format

test/test_plugin_title_maxlen.py

@@ -0,0 +1,150 @@
+# -*- coding: utf-8 -*-
+# BSD 3-Clause License
+#
+# Apprise - Push Notification Library.
+# Copyright (c) 2023, Chris Caron <[email protected]>
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice,
+#    this list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+# 3. Neither the name of the copyright holder nor the names of its
+#    contributors may be used to endorse or promote products derived from
+#    this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
+import os
+from json import loads
+from inspect import cleandoc
+
+import pytest
+import requests
+from apprise import Apprise
+from apprise.config.ConfigBase import ConfigBase
+
+# Disable logging for a cleaner testing output
+import logging
+logging.disable(logging.CRITICAL)
+
+# Attachment Directory
+TEST_VAR_DIR = os.path.join(os.path.dirname(__file__), 'var')
+
+
+@pytest.fixture
+def request_mock(mocker):
+    """
+    Prepare requests mock.
+    """
+    mock_post = mocker.patch("requests.post")
+    mock_post.return_value = requests.Request()
+    mock_post.return_value.status_code = requests.codes.ok
+    mock_post.return_value.content = ""
+    return mock_post
+
+
+def test_plugin_title_maxlen(request_mock):
+    """
+    plugin title maxlen blending support
+
+    """
+    # Load our configuration
+    result, config = ConfigBase.config_parse_yaml(cleandoc("""
+    urls:
+
+      # Our JSON plugin allows for a title definition; we enforce a html format
+      - json://user:[email protected]?format=html
+      # Telegram has a title_maxlen of 0
+      - tgram://123456789:AABCeFGhIJKLmnOPqrStUvWxYZ12345678U/987654321
+    """))
+
+    # Verify we loaded correctly
+    assert isinstance(result, list)
+    assert len(result) == 2
+    assert len(result[0].tags) == 0
+
+    aobj = Apprise()
+    aobj.add(result)
+    assert len(aobj) == 2
+
+    title = "Hello World"
+    body = "Foo Bar"
+    assert aobj.notify(title=title, body=body)
+
+    # If a batch, there is only 1 post
+    assert request_mock.call_count == 2
+
+    details = request_mock.call_args_list[0]
+    assert details[0][0] == 'http://example.ca'
+    payload = loads(details[1]['data'])
+    assert payload['message'] == body
+    assert payload['title'] == "Hello World"
+
+    details = request_mock.call_args_list[1]
+    assert details[0][0] == \
+        'https://api.telegram.org/bot123456789:' \
+        'AABCeFGhIJKLmnOPqrStUvWxYZ12345678U/sendMessage'
+    payload = loads(details[1]['data'])
+    # HTML in Title is escaped
+    assert payload['text'] == "<b>Hello World</b>\r\nFoo Bar"
+
+    # Reset our mock object
+    request_mock.reset_mock()
+    #
+    # Reverse the configuration file and expect the same results
+    #
+    result, config = ConfigBase.config_parse_yaml(cleandoc("""
+    urls:
+
+      # Telegram has a title_maxlen of 0
+      - tgram://123456789:AABCeFGhIJKLmnOPqrStUvWxYZ12345678U/987654321
+      # Our JSON plugin allows for a title definition; we enforce a html format
+      - json://user:[email protected]?format=html
+    """))
+
+    # Verify we loaded correctly
+    assert isinstance(result, list)
+    assert len(result) == 2
+    assert len(result[0].tags) == 0
+
+    aobj = Apprise()
+    aobj.add(result)
+    assert len(aobj) == 2
+
+    title = "Hello World"
+    body = "Foo Bar"
+    assert aobj.notify(title=title, body=body)
+
+    # If a batch, there is only 1 post
+    assert request_mock.call_count == 2
+
+    details = request_mock.call_args_list[0]
+    assert details[0][0] == \
+        'https://api.telegram.org/bot123456789:' \
+        'AABCeFGhIJKLmnOPqrStUvWxYZ12345678U/sendMessage'
+    payload = loads(details[1]['data'])
+
+    # HTML in Title is escaped
+    assert payload['text'] == "<b>Hello World</b>\r\nFoo Bar"
+
+    details = request_mock.call_args_list[1]
+    assert details[0][0] == 'http://example.ca'
+    payload = loads(details[1]['data'])
+    assert payload['message'] == body
+    assert payload['title'] == "Hello World"