URL Builder Support added + URL linking privacy improvements (#305)

Author: caronc

apprise_api/api/payload_mapper.py

@@ -64,7 +64,7 @@ def remap_fields(rules, payload, form=None):
                 payload[value] = payload[key]
                 del payload[key]
 
-            elif value in payload:
+            else:
                 # swap
                 _tmp = payload[value]
                 payload[value] = payload[key]

apprise_api/api/templates/base.html

@@ -104,20 +104,25 @@
 <ul class="collection z-depth-1">
   <a class="collection-item"
      target="_blank"
+     rel="noopener noreferrer"
      href="https://appriseit.com/services/"><i class="material-icons" style="color: #38967c;">style</i>{% trans "Notification Services" %}</a>
   <a class="collection-item"
      target="_blank"
+     rel="noopener noreferrer"
      href="https://appriseit.com/config/"><i class="material-icons">local_library</i> {% trans "Configuration Help" %}</a>
   <a class="collection-item"
      target="_blank"
+     rel="noopener noreferrer"
      href="https://appriseit.com/getting-started/"><i class="material-icons">library_books</i> {% trans "Documentation" %}</a>
 </ul>
 <ul class="collection z-depth-1">
   <a class="collection-item"
      target="_blank"
+     rel="noopener noreferrer"
      href="https://www.paypal.com/donate/?hosted_button_id=CR6YF7KLQWQ5E"><i class="material-icons" style="color: maroon;">free_breakfast</i> <strong>{% trans "Buy Developer A Coffee" %}</strong></a>
   <a class="collection-item"
      target="_blank"
+     rel="noopener noreferrer"
      href="https://github.com/sponsors/caronc"><i class="material-icons" style="color: red;">favorite</i> <strong>{% trans "Sponsor Apprise Development" %}</strong></a>
 </ul>
 {% block menu %}

apprise_api/api/templates/config.html

@@ -90,7 +90,7 @@ <h5>{% trans "Getting Started" %}</h5>
             <div>
               {% blocktrans %}
               <i class="material-icons">lightbulb_outline</i>You can always refer to the
-              <a href="https://appriseit.com/services/">Apprise Wiki</a> if you're having troubles assembling your URL(s).
+              <a href="https://appriseit.com/services/" target="_blank" rel="noopener noreferrer">Apprise Wiki</a> if you're having troubles assembling your URL(s).
               {% endblocktrans %}
             </div>
           </li>
@@ -157,7 +157,7 @@ <h6>{% trans "Using The Apprise CLI" %}</h6>
             <pre><code class="bash">apprise --body=&quot;Test Message&quot; --tag=all \<br />
                &nbsp;&nbsp;&nbsp;&nbsp;--config={{request.scheme}}://{{request.META.HTTP_HOST}}{{BASE_URL}}/cfg/<em>{{key}}</em></code></pre>
           </div>
-          {% blocktrans %}You may also create an <a href="https://appriseit.com/config/#cli" target="_blank">Apprise configuration file</a> that contains this line somewhere in it:{% endblocktrans %}
+          {% blocktrans %}You may also create an <a href="https://appriseit.com/config/#cli" target="_blank" rel="noopener noreferrer">Apprise configuration file</a> that contains this line somewhere in it:{% endblocktrans %}
           <div class="code-snippet"
                data-copy-text='include {{ request.scheme }}://{{ request.META.HTTP_HOST }}{{ BASE_URL }}/cfg/{{ key }}'
                data-copy-label='{% trans "Apprise configuration 'include' entry copied to clipboard" %}'></div>
@@ -222,10 +222,20 @@ <h6>{% trans "Using CURL" %}</h6>
             </div>
             {{ field.errors }}
           {% elif field.name == 'format' %}
-            <div class="input-field config-format-field">
-              {{ field.label_tag }}
-              {{ field }}
-              {{ field.errors }}
+            <div class="config-toolbar" style="justify-content: space-between;">
+              <div class="input-field config-format-field">
+                {{ field.label_tag }}
+                {{ field }}
+                {{ field.errors }}
+              </div>
+              <a href="https://appriseit.com/tools/url-builder/"
+                 target="_blank"
+                 rel="noopener noreferrer"
+                 class="btn waves-effect waves-light config-url-builder-btn"
+                 style="margin-bottom: 0.75rem">
+                {% trans "Apprise URL Builder" %}
+                <i class="material-icons right">build</i>
+              </a>
             </div>
           {% else %}
             <div class="input-field">

apprise_api/api/templates/details.html

@@ -9,7 +9,7 @@
       <h4>{% trans "Apprise Details" %}</h4>
       <p>
         {% blocktrans %}The following services are supported by this
-        <a target="_blank" href="https://github.com/caronc/apprise">Apprise</a>
+        <a target="_blank" href="https://github.com/caronc/apprise" rel="noopener noreferrer">Apprise</a>
         instance.{% endblocktrans %}
       </p>
       <p>
@@ -76,13 +76,27 @@ <h5>{{ entry.service_name }}</h5>
                 {% if entry.protocols %}
                   <li>
                     <strong>{% blocktrans %}Insecure Schema(s){% endblocktrans %}:</strong>
-                    <code>{{ entry.protocols|join:", " }}</code>
+                    <code>
+                      {% for schema in entry.protocols %}
+                        <a href="https://appriseit.com/tools/url-builder/?schema={{ schema }}"
+                           target="_blank"
+                           rel="noopener noreferrer">{{ schema }}</a>
+                        {% if not forloop.last %},{% endif %}
+                      {% endfor %}
+                    </code>
                   </li>
                 {% endif %}
                 {% if entry.secure_protocols %}
                   <li>
                     <strong>{% blocktrans %}Secure Schema(s){% endblocktrans %}:</strong>
-                    <code>{{ entry.secure_protocols|join:", " }}</code>
+                    <code>
+                      {% for schema in entry.secure_protocols %}
+                        <a href="https://appriseit.com/tools/url-builder/?schema={{ schema }}"
+                           target="_blank"
+                           rel="noopener noreferrer">{{ schema }}</a>
+                        {% if not forloop.last %},{% endif %}
+                      {% endfor %}
+                    </code>
                   </li>
                 {% endif %}
                 <li>
@@ -165,7 +179,7 @@ <h4>{% trans "API Endpoints" %}</h4>
         </li>
       </ul>
       <p>
-        {% blocktrans %}More details on the JSON format can be found <a href="https://appriseit.com/dev/apprise_details/" target="_blank">here</a>.{% endblocktrans %}
+        {% blocktrans %}More details on the JSON format can be found <a href="https://appriseit.com/dev/apprise_details/" target="_blank" rel="noopener noreferrer">here</a>.{% endblocktrans %}
       </p>
     </div>
   </div>

apprise_api/api/templates/welcome.html

@@ -8,7 +8,7 @@
       <h4>{% trans "The Apprise API" %}</h4>
       <p>
         {% blocktrans %}
-      <a target="_blank" href="https://github.com/caronc/apprise">Apprise</a> allows you to send a notification to almost
+      <a target="_blank" href="https://github.com/caronc/apprise" rel="noopener noreferrer">Apprise</a> allows you to send a notification to almost
       all of the most popular notification services available to us today such as: <em>Telegram</em>, <em>Discord</em>,
       <em>Slack</em>, <em>Amazon SNS</em>, <em>Gotify</em>, etc.
       This API provides a simple gateway to directly access it via an HTTP interface.{% endblocktrans %}
@@ -27,7 +27,7 @@ <h4>{% trans "The Apprise API" %}</h4>
     <div class="section">
       <h4>{% trans "Stateless Endpoints" %}</h4>
       <p>
-        {% blocktrans %}Those who wish to treat this API as nothing but a <a href="https://docs.microsoft.com/en-us/azure/architecture/patterns/sidecar" target="_blank">sidecar</a> and/or
+        {% blocktrans %}Those who wish to treat this API as nothing but a <a href="https://docs.microsoft.com/en-us/azure/architecture/patterns/sidecar" target="_blank" rel="noopener noreferrer">sidecar</a> and/or
     microservice to their project only need to use the following URL.{% endblocktrans %}
       </p>
       <div class="table-wrapper">
@@ -44,7 +44,7 @@ <h4>{% trans "Stateless Endpoints" %}</h4>
                 <code>{{ BASE_URL }}/notify/</code>
               </td>
               <td>
-                {% blocktrans %}Used to notify one one or more specified Apprise URLs. See the <a target="_blank" href="https://appriseit.com/services/">Apprise Wiki</a> if you need help
+                {% blocktrans %}Used to notify one one or more specified Apprise URLs. See the <a target="_blank" href="https://appriseit.com/services/" rel="noopener noreferrer">Apprise Wiki</a> if you need help
           constructing your URL(s).{% endblocktrans %}
                 <div class="section">
                   <table>
@@ -120,7 +120,7 @@ <h4>{% trans "Stateless Endpoints" %}</h4>
 									       	&nbsp;&nbsp;&nbsp;&nbsp;"{{request.scheme}}://{{request.META.HTTP_HOST}}{{BASE_URL}}/notify/"
 </code></pre>
                         <pre><code class="bash">
-                          # {% blocktrans %}Send an web based file attachment to a <a href="https://appriseit.com/services/discord/" target="_blank">Discord</a> server:{% endblocktrans %}<br />
+                          # {% blocktrans %}Send an web based file attachment to a <a href="https://appriseit.com/services/discord/" target="_blank" rel="noopener noreferrer">Discord</a> server:{% endblocktrans %}<br />
                           curl -X POST -F 'urls=discord://credentials' \<br />
                           &nbsp;&nbsp;&nbsp;&nbsp;-F "attach=https://raw.githubusercontent.com/caronc/apprise/master/apprise/assets/themes/default/apprise-logo.png" \ <br />
 													&nbsp;&nbsp;&nbsp;&nbsp;"{{request.scheme}}://{{request.META.HTTP_HOST}}{{BASE_URL}}/notify/"
@@ -280,7 +280,7 @@ <h4>{% trans "Persistent Store Endpoints" %}</h4>
                   </td>
                   <td>
                     {% blocktrans %}Used to add a new Apprise configuration or a set of URLs and associates them with configuration
-            identified with the id of <em>{{key}}</em>. See the <a target="_blank" href="https://appriseit.com/services/">Apprise Wiki</a> if you need help
+            identified with the id of <em>{{key}}</em>. See the <a target="_blank" href="https://appriseit.com/services/" rel="noopener noreferrer">Apprise Wiki</a> if you need help
             constructing your URLs.{% endblocktrans %}
                     <div class="section">
                       <table>

apprise_api/api/tests/test_add.py

@@ -133,6 +133,15 @@ def test_save_config_by_urls(self):
         response = self.client.post("/add/{}".format(key), {"urls": "slack://-/-/-"})
         assert response.status_code == 400
 
+        # Submit with an invalid config format choice — AddByConfigForm
+        # fails validation (False branch of 'if form.is_valid()') while
+        # AddByUrlForm still succeeds via the valid 'urls' field.
+        response = self.client.post(
+            "/add/{}".format(key),
+            {"format": "invalid_format_xyz", "urls": "mailto://user:pass@yahoo.ca"},
+        )
+        assert response.status_code == 200
+
         # Test with JSON
         response = self.client.post(
             "/add/{}".format(key),

apprise_api/api/tests/test_attachment.py

@@ -23,6 +23,7 @@
 # THE SOFTWARE.
 import base64
 from contextlib import suppress
+import os
 from os.path import dirname, getsize, join
 from shutil import rmtree
 from tempfile import TemporaryDirectory
@@ -89,6 +90,15 @@ def test_attachment_initialization(self):
             a = Attachment("file")
             assert a.filename
 
+            # Test with an explicit path already provided (covers the
+            # 'if not path:' False branch — mkstemp is skipped)
+            import tempfile
+
+            fd, explicit_path = tempfile.mkstemp(dir=self.tmp_dir.name)
+            os.close(fd)
+            a = Attachment("explicit.txt", path=explicit_path, delete=False)
+            assert a._path == explicit_path
+
     def test_form_file_attachment_parsing(self):
         """
         Test the parsing of file attachments
@@ -270,6 +280,18 @@ def test(*args, **kwargs):
         assert isinstance(result, list)
         assert len(result) == 0
 
+        # dict with a valid non-empty filename — exercises the False branch
+        # of 'elif not filename:' (filename is provided and non-empty, so the
+        # fallback-to-default branch is not taken)
+        attachment_payload = {
+            "base64": base64.b64encode(b"data to be encoded").decode("utf-8"),
+            "filename": "myfile.bin",
+        }
+        result = parse_attachments(attachment_payload, {})
+        assert isinstance(result, list)
+        assert len(result) == 1
+        assert result[0].name == "myfile.bin"
+
         # filename provided, but its empty (and/or contains whitespace)
         attachment_payload = {
             "base64": base64.b64encode(b"data to be encoded").decode("utf-8"),

apprise_api/api/tests/test_config_cache.py

@@ -149,6 +149,13 @@ def test_apprise_config_list_simple_mode(tmpdir):
     assert len(keys) == 10
     assert sorted(keys) == sorted(text_keys + yaml_keys)
 
+    # Add a subdirectory — keys() must skip non-file entries (covers the
+    # 'if os.path.isfile(path): False' branch)
+    subdir = os.path.join(str(tmpdir), "subdir")
+    os.makedirs(subdir)
+    keys = acc_obj.keys()
+    assert len(keys) == 10
+
 
 def test_apprise_config_list_hash_mode(tmpdir):
     """

apprise_api/api/tests/test_emoji.py

@@ -39,7 +39,7 @@ class NotifyWithEmojiTests(SimpleTestCase):
     Test notifications with Emoji Settings
     """
 
-    @mock.patch("requests.post")
+    @mock.patch("requests.request")
     def test_stateful_notify_with_emoji(self, mock_post):
         """
         Test adding a simple stateful notification with emoji flags
@@ -85,7 +85,7 @@ def test_stateful_notify_with_emoji(self, mock_post):
             assert mock_post.call_count == 1
 
             details = mock_post.call_args_list[0]
-            assert details[0][0].startswith("http://localhost")
+            assert details[0][1].startswith("http://localhost")
 
             payload = json.loads(details[1]["data"])
             assert payload["title"] == "😃"
@@ -101,7 +101,7 @@ def test_stateful_notify_with_emoji(self, mock_post):
             assert mock_post.call_count == 1
 
             details = mock_post.call_args_list[0]
-            assert details[0][0].startswith("http://localhost")
+            assert details[0][1].startswith("http://localhost")
 
             payload = json.loads(details[1]["data"])
             assert payload["title"] == ":grin:"
@@ -110,7 +110,7 @@ def test_stateful_notify_with_emoji(self, mock_post):
         # Reset our mock object
         mock_post.reset_mock()
 
-    @mock.patch("requests.post")
+    @mock.patch("requests.request")
     def test_stateless_notify_with_emoji(self, mock_post):
         """
         Test adding a simple stateless notification with emoji flags
@@ -141,7 +141,7 @@ def test_stateless_notify_with_emoji(self, mock_post):
             assert mock_post.call_count == 1
 
             details = mock_post.call_args_list[0]
-            assert details[0][0].startswith("http://localhost")
+            assert details[0][1].startswith("http://localhost")
 
             payload = json.loads(details[1]["data"])
             assert payload["title"] == "😃"
@@ -161,7 +161,7 @@ def test_stateless_notify_with_emoji(self, mock_post):
             assert mock_post.call_count == 1
 
             details = mock_post.call_args_list[0]
-            assert details[0][0].startswith("http://localhost")
+            assert details[0][1].startswith("http://localhost")
 
             payload = json.loads(details[1]["data"])
             assert payload["title"] == ":grin:"

apprise_api/api/tests/test_healthecheck.py

@@ -22,6 +22,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 from json import loads
+import time
 from unittest import mock
 
 from django.test import SimpleTestCase
@@ -313,3 +314,32 @@ def test_healthcheck_library(self):
                     "CONFIG_PERMISSION_ISSUE",
                 ],
             }
+
+    def test_healthcheck_lazy_stale_mtime(self):
+        """
+        Test that lazy healthcheck re-checks when the cached .tmp_hc file
+        exists but is older than 30 seconds (covers the delta > 30 False
+        branch at the 'if delta <= 30.00' guards).
+        """
+        # First call: creates .tmp_hc files and primes can_write_config
+        result = healthcheck(lazy=False)
+        assert result["can_write_config"] is True
+        assert result["persistent_storage"] is True
+
+        # Second call with mocked mtime returning 60 seconds in the past —
+        # delta > 30 so we skip the early-return branch and re-verify.
+        old_time = time.time() - 60
+        with mock.patch("apprise_api.api.utils.os.path.getmtime", return_value=old_time):
+            result = healthcheck(lazy=True)
+        assert result["can_write_config"] is True
+        assert result["persistent_storage"] is True
+
+    def test_healthcheck_memory_storage_mode(self):
+        """
+        Test that when APPRISE_STORAGE_MODE is 'memory' the persistent-storage
+        elif branch is skipped (store.mode == MEMORY so the elif is False).
+        """
+        with override_settings(APPRISE_STORAGE_MODE="memory"):
+            result = healthcheck(lazy=False)
+        assert result["persistent_storage"] is False
+        assert "STORE_PERMISSION_ISSUE" not in result["details"]