Merge branch 'miscs'

Author: Jenselme

Diff for: CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## Unreleased
+
+- Add link to changelog in footer.
+- Improve existing links in footer.
+- Allow you to add a custom script.
+- Can fetch feed without an explicit full site URL.
+- Can force feeds to refresh in the admin.
+- Can refresh a reading list no mobile easily, without going to the top of the page or opening the reading list selector.
+
 ## 24.12.4
 
 - Use the theme (light or dark) that matches the system theme.

Diff for: config/settings.py

@@ -626,11 +626,12 @@ def before_send_to_sentry(event, hint):
 NINJA_PAGINATION_CLASS = "legadilo.utils.pagination.LimitOffsetPagination"
 
 
-# Your stuff...
+# Legadilo's specific stuff...
 # ------------------------------------------------------------------------------
 ARTICLE_FETCH_TIMEOUT = env.int("LEGADILO_ARTICLE_FETCH_TIMEOUT", default=50)
 RSS_FETCH_TIMEOUT = env.int("LEGADILO_RSS_FETCH_TIMEOUT", default=300)
 CONTACT_EMAIL = env.str("LEGADILO_CONTACT_EMAIL", default=None)
+CUSTOM_SCRIPT = env.json("LEGADILO_CUSTOM_SCRIPT", default=None)
 TOKEN_LENGTH = 50
 JWT_ALGORITHM = "HS256"
 ACCESS_TOKEN_MAX_AGE = timedelta(hours=24)

Diff for: docs/deploy.md

@@ -104,7 +104,7 @@ These variables are required for the container to start and create the proper da
 | `DJANGO_DEFAULT_FROM_EMAIL`  | Email used as from unless otherwise specified.                                                                                                    |
 | `ADMIN_URL`                  | To change the default admin URL in production for security reason. Will default to `/admin/` in dev.                                              |
 | `ACCOUNT_ALLOW_REGISTRATION` | Whether to enable account registration on the instance or not. If disabled, you will have to create the user in the Django admin or with the CLI. |
-| `DATABASE_URL`               | The URL to the database formatted like this: postgres://POSTGRES_USER:POSTGRES_PASSWORD@POSTGRES_HOST:POSTGRES_PORT/POSTGRES_DB                   |
+| `DATABASE_URL`               | The URL to the database formatted like this: `postgres://POSTGRES_USER:POSTGRES_PASSWORD@POSTGRES_HOST:POSTGRES_PORT/POSTGRES_DB`                 |
 
 ```{admonition} DATABASE_URL
 :class: note
@@ -122,20 +122,20 @@ You can create cryptahpicaly sure secrets in Python with `python3 -c "import sec
 
 ### Other variables
 
-| Variable name                           | Default value      | Description                                                                            |
-|-----------------------------------------|--------------------|----------------------------------------------------------------------------------------|
-| `DJANGO_SECURE_HSTS_INCLUDE_SUBDOMAINS` | `True`             | See https://docs.djangoproject.com/en/dev/ref/settings/#secure-hsts-include-subdomains |
-| `DJANGO_SECURE_HSTS_PRELOAD`            | `True`             | See https://docs.djangoproject.com/en/dev/ref/settings/#secure-hsts-preload            |
-| `DJANGO_SERVER_EMAIL`                   | DEFAULT_FROM_EMAIL | The email address that error messages come from.                                       |
-| `DJANGO_EMAIL_SUBJECT_PREFIX`           | `[Legadilo]`       | Each email will be prefixed by this.                                                   |
-| `EMAIL_HOST`                            | `mailpit`          | On which host to connect to send an email. Leave the default to not send in production |
-| `EMAIL_PORT`                            | 1025               | On which port to connect to send an email.                                             |
-| `EMAIL_HOST_USER`                       | Empty string       | Username to use for the SMTP server defined in `EMAIL_HOST`                            |
-| `EMAIL_HOST_PASSWORD`                   | Empty string       | The password associated with the above username                                        |
-| `EMAIL_TIMEOUT`                         | 30                 | Max time to wait for when trying to send an email before failing.                      |
-| `EMAIL_USE_TLS`                         | False              | Whether to use TLS to send email with SMTP                                             |
-| `SENTRY_DSN`                            | `None`             | To enable error monitoring with Sentry (leave empty to leave it deactivated).          |
-| `LEGADILO_ARTICLE_FETCH_TIMEOUT`        | 50                 | The fetch timeout when fetching articles in seconds.                                   |
-| `LEGADILO_RSS_FETCH_TIMEOUT`            | 300                | The fetch timeout when fetching feeds in seconds.                                      |
-| `LEGADILO_CONTACT_EMAIL`                | `None`             | The contact email to display to authenticated user.                                    |
-
+| Variable name                           | Default value      | Description                                                                                                                                                                                                    |
+|-----------------------------------------|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `DJANGO_SECURE_HSTS_INCLUDE_SUBDOMAINS` | `True`             | See https://docs.djangoproject.com/en/dev/ref/settings/#secure-hsts-include-subdomains                                                                                                                         |
+| `DJANGO_SECURE_HSTS_PRELOAD`            | `True`             | See https://docs.djangoproject.com/en/dev/ref/settings/#secure-hsts-preload                                                                                                                                    |
+| `DJANGO_SERVER_EMAIL`                   | DEFAULT_FROM_EMAIL | The email address that error messages come from.                                                                                                                                                               |
+| `DJANGO_EMAIL_SUBJECT_PREFIX`           | `[Legadilo]`       | Each email will be prefixed by this.                                                                                                                                                                           |
+| `EMAIL_HOST`                            | `mailpit`          | On which host to connect to send an email. Leave the default to not send in production                                                                                                                         |
+| `EMAIL_PORT`                            | 1025               | On which port to connect to send an email.                                                                                                                                                                     |
+| `EMAIL_HOST_USER`                       | Empty string       | Username to use for the SMTP server defined in `EMAIL_HOST`                                                                                                                                                    |
+| `EMAIL_HOST_PASSWORD`                   | Empty string       | The password associated with the above username                                                                                                                                                                |
+| `EMAIL_TIMEOUT`                         | 30                 | Max time to wait for when trying to send an email before failing.                                                                                                                                              |
+| `EMAIL_USE_TLS`                         | False              | Whether to use TLS to send email with SMTP                                                                                                                                                                     |
+| `SENTRY_DSN`                            | `None`             | To enable error monitoring with Sentry (leave empty to leave it deactivated).                                                                                                                                  |
+| `LEGADILO_ARTICLE_FETCH_TIMEOUT`        | 50                 | The fetch timeout when fetching articles in seconds.                                                                                                                                                           |
+| `LEGADILO_RSS_FETCH_TIMEOUT`            | 300                | The fetch timeout when fetching feeds in seconds.                                                                                                                                                              |
+| `LEGADILO_CONTACT_EMAIL`                | `None`             | The contact email to display to authenticated user.                                                                                                                                                            |
+| `LEGADILO_CUSTOM_SCRIPT`                | `None`             | To inject an extra script (typically a visitor tracker) to the site. Must a JSON mapping of attribute to value like this: `{"src": "https://plausible.io"}`.<br>Nonce and `defer` will be added automatically. |

Diff for: legadilo/core/context_processors.py

@@ -21,4 +21,5 @@ def provide_global_context(request):
     return {
         "VERSION": settings.VERSION,
         "CONTACT_EMAIL": settings.CONTACT_EMAIL,
+        "CUSTOM_SCRIPT": settings.CUSTOM_SCRIPT,
     }

Diff for: legadilo/feeds/admin.py

@@ -14,7 +14,10 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+import logging
+
 from django.contrib import admin
+from django.core.management import call_command
 
 from legadilo.feeds.models import (
     Feed,
@@ -25,6 +28,8 @@
     FeedUpdate,
 )
 
+logger = logging.getLogger(__name__)
+
 
 class FeedTagInline(admin.TabularInline):
     model = FeedTag
@@ -65,6 +70,24 @@ class FeedAdmin(admin.ModelAdmin):
         FeedTagInline,
         FeedUpdateInline,
     ]
+    actions = ["refresh_feeds", "force_refresh_feeds"]
+
+    @admin.action(description="Refresh selected feeds")
+    def refresh_feeds(self, request, queryset):
+        logger.info("Refresh selected feeds from admin")
+        call_command("update_feeds", "--feed-ids", *queryset.values_list("id", flat=True))
+        logger.info(f"Refreshed {len(queryset)} feeds from admin")
+
+    @admin.action(description="Force a refresh of selected feeds")
+    def force_refresh_feeds(self, request, queryset):
+        logger.info("Force refresh selected feeds from admin")
+        call_command(
+            "update_feeds",
+            "--feed-ids",
+            *queryset.values_list("id", flat=True),
+            "--force",
+        )
+        logger.info(f"Refreshed {len(queryset)} feeds from admin")
 
 
 @admin.register(FeedCategory)

Diff for: legadilo/feeds/services/feed_parsing.py

@@ -41,6 +41,7 @@
     FullSanitizeValidator,
     ValidUrlValidator,
     default_frozen_model_config,
+    is_url_valid,
     normalize_url,
     truncate,
 )
@@ -141,7 +142,7 @@ def build_feed_data_from_parsed_feed(parsed_feed: FeedParserDict, resolved_url:
 
     return FeedData(
         feed_url=resolved_url,
-        site_url=_normalize_found_link(parsed_feed.feed.get("link", resolved_url)),
+        site_url=_get_feed_site_link(parsed_feed.feed.get("link"), resolved_url),
         title=feed_title,
         description=full_sanitize(parsed_feed.feed.get("description", "")),
         feed_type=constants.SupportedFeedType(parsed_feed.version),
@@ -210,6 +211,14 @@ def _find_feed_page_content(page_content: str) -> str:
     return feed_urls[0][0]
 
 
+def _get_feed_site_link(site_link: str | None, feed_link: str) -> str:
+    if site_link is None or not is_url_valid(site_link):
+        parsed_feed_url = urlparse(feed_link)
+        return f"{parsed_feed_url.scheme}://{parsed_feed_url.netloc}"
+
+    return _normalize_found_link(site_link)
+
+
 def _normalize_found_link(link: str):
     if link.startswith("//"):
         link = f"https:{link}"

Diff for: legadilo/feeds/tests/test_services/test_feed_parsing.py

@@ -24,6 +24,7 @@
     NoFeedUrlFoundError,
     _find_feed_page_content,
     _find_youtube_rss_feed_link,
+    _get_feed_site_link,
     _parse_articles_in_feed,
     get_feed_data,
     parse_feed,
@@ -313,3 +314,38 @@ def test_parse_articles(self, feed_content, snapshot):
         )
 
         snapshot.assert_match(serialize_for_snapshot(articles), "articles.json")
+
+
+class TestGetFeedSiteUrl:
+    @pytest.mark.parametrize(
+        ("found_site_link", "feed_link", "expected_site_link"),
+        [
+            pytest.param(
+                None,
+                "https://example.com/feed.xml",
+                "https://example.com",
+                id="failed-to-find-feed",
+            ),
+            pytest.param(
+                "https://example.fr/the-site/",
+                "https://example.com/feed.xml",
+                "https://example.fr/the-site/",
+                id="found-in-full",
+            ),
+            pytest.param(
+                "//example.com",
+                "https://example.com/feed.xml",
+                "https://example.com",
+                id="found-without-scheme-full",
+            ),
+            pytest.param(
+                "/", "https://example.com/feed.xml", "https://example.com", id="not-full-url"
+            ),
+        ],
+    )
+    def test_get_feed_site_url(
+        self, found_site_link: str | None, feed_link: str, expected_site_link: str
+    ):
+        build_site_link = _get_feed_site_link(found_site_link, feed_link)
+
+        assert build_site_link == expected_site_link

Diff for: legadilo/feeds/views/subscribe_to_feed_view.py

@@ -13,8 +13,8 @@
 #
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
 import json
+import logging
 from http import HTTPMethod, HTTPStatus
 from typing import cast
 
@@ -47,6 +47,8 @@
     get_feed_data,
 )
 
+logger = logging.getLogger(__name__)
+
 
 class SubscribeToFeedForm(forms.Form):
     url = forms.URLField(
@@ -207,7 +209,8 @@ async def _handle_creation(request: AuthenticatedHttpRequest):  # noqa: PLR0911
             _("The feed file is too big, we won't parse it. Try to find a more lightweight feed."),
         )
         return HTTPStatus.BAD_REQUEST, form
-    except (InvalidFeedFileError, PydanticValidationError, ValueError, TypeError):
+    except (InvalidFeedFileError, PydanticValidationError, ValueError, TypeError) as e:
+        logger.debug("Failed to parse feed: %s", e)
         messages.error(
             request,
             _(

Diff for: legadilo/static/css/base.css

@@ -90,6 +90,14 @@ html {
     max-height 1s ease-out;
 }
 
+.refresh-btn {
+  right: 0.5rem;
+  bottom: 0.5rem;
+  width: max-content;
+  margin-left: auto;
+  display: block;
+}
+
 @media (width >= 768px) {
   .article-card-container {
     max-height: 500px;

Diff for: legadilo/templates/base.html

@@ -62,6 +62,9 @@
             <!-- This cannot be deferred: we want the proper theme to apply immediately, not after the page has loaded -->
             <script src="{% static 'js/theme_chooser.js' %}"
                     nonce="{{ request.csp_nonce }}"></script>
+            {% if CUSTOM_SCRIPT %}
+                <script defer nonce="{{ request.csp_nonce }}" {% for attr, value in CUSTOM_SCRIPT.items %} {{ attr }}="{{ value }}"{% endfor %}></script>
+            {% endif %}
             {% block page_js %}
             {% endblock page_js %}
         {% endblock javascript %}
@@ -187,6 +190,9 @@ <h1 class="modal-title fs-5"></h1>
                                                 <a class="dropdown-item" href="{% url 'feeds:feed_category_admin' %}">{% translate "Feed categories admin" %}</a>
                                                 <a class="dropdown-item" href="{% url 'reading:reading_lists_admin' %}">{% translate "Reading lists admin" %}</a>
                                                 <a class="dropdown-item" href="{% url 'users:detail' request.user.pk %}">{% translate "My Profile" %}</a>
+                                                {% if request.user.is_staff %}
+                                                    <a class="dropdown-item" href="{% url 'admin:index' %}">{% translate "Admin" %}</a>
+                                                {% endif %}
                                                 {# URL provided by django-allauth/account/urls.py #}
                                                 <a class="dropdown-item" href="{% url 'account_logout' %}">{% translate "Sign Out" %}</a>
                                             </div>
@@ -232,27 +238,27 @@ <h1 class="modal-title fs-5"></h1>
             <p class="ps-4 pe-4 text-center">
                 {% if VERSION %}
                     {% blocktranslate with version=VERSION %}
-                        Legadilo version {{ version }}
+                        Legadilo <a class="text-reset" href="https://github.com/Jenselme/legadilo/blob/main/CHANGELOG.md">version {{ version }}</a>
                     {% endblocktranslate %}
                 {% else %}
                     Legadilo
                 {% endif %}
             </p>
             <div class="d-flex flex-column flex-md-row justify-content-center align-items-center">
                 <p class="ps-4 pe-4">
-                    <a class="text-white" href="{% url 'website:home' %}">{% translate "About" %}</a>
+                    <a class="text-reset" href="{% url 'website:home' %}">{% translate "About" %}</a>
                 </p>
                 <p class="ps-4 pe-4">
-                    <a class="text-white" href="{% url 'website:privacy' %}">{% translate "Privacy" %}</a>
+                    <a class="text-reset" href="{% url 'website:privacy' %}">{% translate "Privacy" %}</a>
                 </p>
                 <p class="ps-4 pe-4">
-                    <a class="text-white" href="https://github.com/Jenselme/legadilo/issues">{% translate "Report a bug." %}</a>
+                    <a class="text-reset" href="https://github.com/Jenselme/legadilo/issues">{% translate "Report a bug." %}</a>
                 </p>
                 <p class="ps-4 pe-4">
                     {% if CONTACT_EMAIL and user.is_authenticated %}
                         <span>
                             {% blocktranslate with email=CONTACT_EMAIL %}
-                                Contact us at <a href="mailto:{{ email }}">{{ email }}</a>
+                                Contact us at <a class="text-reset" href="mailto:{{ email }}">{{ email }}</a>
                             {% endblocktranslate %}
                         </span>
                     {% endif %}

Diff for: legadilo/templates/reading/list_of_articles.html

@@ -164,4 +164,8 @@ <h2 class="fs-6 col-6 col-md-2 align-middle d-flex align-items-center px-0 mx-0"
                value="{{ displayed_reading_list.id }}" />
         <input type="hidden" name="from_url" value="{{ from_url }}" />
     </form>
+    <a class="btn btn-outline-primary sticky-bottom refresh-btn bg-secondary-subtle"
+       aria-label="{% translate 'Refresh current reading list' %}"
+       role="button"
+       href="{{ request.get_full_path }}">{% include "core/partials/bs-icons/refetch.html" %}</a>
 {% endblock content %}

Diff for: legadilo/templates/website/privacy.html

@@ -23,8 +23,8 @@ <h1 class="display-1">{% translate "Privacy" %}</h1>
     <p>
         {% blocktranslate %}
             We don’t read nor sell your data and <em>never</em> will.
-            We may add some tracking to have stats about the site usage.
-            It will <em>be GDPR compatible</em>, and we will collect so little we won’t even need to add a cookie banner.
+            We track visits with <a href="https://plausible.io">Plausible.io</a>.
+            It is <em>GDPR compatible</em>, and collects so little we won’t even need to bother you with a cookie banner.
         {% endblocktranslate %}
     </p>
     <p>