diff --git a/apps/feeds/forms.py b/apps/feeds/forms.py index 8ac12db..27852ac 100644 --- a/apps/feeds/forms.py +++ b/apps/feeds/forms.py @@ -11,3 +11,7 @@ class AddFeedForm(forms.Form): super().__init__(*args, **kwargs) if user is not None: self.fields["folder"].queryset = Folder.objects.filter(user=user) + + +class OPMLImportForm(forms.Form): + opml_file = forms.FileField(label="OPML file") diff --git a/apps/feeds/opml.py b/apps/feeds/opml.py new file mode 100644 index 0000000..0d7684d --- /dev/null +++ b/apps/feeds/opml.py @@ -0,0 +1,135 @@ +"""OPML import/export. + +Import parses with defusedxml since an uploaded .opml file is untrusted +user input (XXE risk with a plain XML parser). Export uses the stdlib's +plain ElementTree since the output is entirely app-generated — no +untrusted input, no XXE concern there. +""" + +from __future__ import annotations + +import xml.etree.ElementTree as ET +from datetime import datetime +from datetime import timezone as dt_timezone + +import defusedxml.ElementTree as DefusedET + +from .models import Feed, Folder, Subscription + + +def parse_opml(file_obj) -> list[dict]: + """Returns a flat list of {feed_url, title, site_url, folder_name}. + + Folders are kept to a single flat level, matching the app's folder + model — nesting deeper than one level collapses into its nearest + enclosing folder rather than being represented as a path. + """ + tree = DefusedET.parse(file_obj) + root = tree.getroot() + body = root.find("body") + entries: list[dict] = [] + if body is None: + return entries + + def walk(container, folder_name): + for outline in container.findall("outline"): + xml_url = outline.get("xmlUrl") + if xml_url: + entries.append( + { + "feed_url": xml_url, + "title": outline.get("title") or outline.get("text") or "", + "site_url": outline.get("htmlUrl") or "", + "folder_name": folder_name, + } + ) + else: + nested_name = outline.get("title") or outline.get("text") or folder_name + walk(outline, nested_name) + + walk(body, None) + return entries + + +def import_opml(user, file_obj) -> dict: + """Creates/reuses Feeds and Subscriptions for every entry. Does not + fetch any feed content — newly created Feeds have no last_fetched_at, + so the next poll_due_feeds beat cycle picks them up naturally.""" + entries = parse_opml(file_obj) + folder_cache: dict[str, Folder] = {} + created_count = 0 + already_subscribed_count = 0 + + for entry in entries: + folder = None + folder_name = entry["folder_name"] + if folder_name: + folder = folder_cache.get(folder_name) + if folder is None: + folder, _ = Folder.objects.get_or_create(user=user, name=folder_name[:255]) + folder_cache[folder_name] = folder + + feed, _ = Feed.objects.get_or_create( + feed_url=entry["feed_url"][:1000], + defaults={ + "title": entry["title"][:500], + "site_url": entry["site_url"][:1000], + }, + ) + _, created = Subscription.objects.get_or_create( + user=user, + feed=feed, + defaults={"folder": folder, "custom_title": ""}, + ) + if created: + created_count += 1 + else: + already_subscribed_count += 1 + + return { + "total": len(entries), + "created": created_count, + "already_subscribed": already_subscribed_count, + } + + +def export_opml(user) -> bytes: + root = ET.Element("opml", version="2.0") + head = ET.SubElement(root, "head") + ET.SubElement(head, "title").text = "Evection subscriptions" + ET.SubElement(head, "dateCreated").text = datetime.now(dt_timezone.utc).strftime( + "%a, %d %b %Y %H:%M:%S %z" + ) + body = ET.SubElement(root, "body") + + subscriptions = ( + Subscription.objects.filter(user=user) + .select_related("feed", "folder") + .order_by("folder__name", "order", "id") + ) + + folder_elements: dict[str, ET.Element] = {} + for subscription in subscriptions: + parent = body + if subscription.folder: + parent = folder_elements.get(subscription.folder.name) + if parent is None: + parent = ET.SubElement( + body, + "outline", + title=subscription.folder.name, + text=subscription.folder.name, + ) + folder_elements[subscription.folder.name] = parent + + ET.SubElement( + parent, + "outline", + type="rss", + text=subscription.display_title, + title=subscription.display_title, + xmlUrl=subscription.feed.feed_url, + htmlUrl=subscription.feed.site_url or "", + ) + + return ET.tostring(root, encoding="utf-8", xml_declaration=True) diff --git a/apps/feeds/tasks.py b/apps/feeds/tasks.py index fc6606b..bf74571 100644 --- a/apps/feeds/tasks.py +++ b/apps/feeds/tasks.py @@ -1,12 +1,15 @@ import logging from datetime import timedelta +from io import BytesIO from celery import shared_task +from django.contrib.auth import get_user_model from django.utils import timezone from apps.articles.tasks import apply_filter_rules_for_feed from .models import Feed +from .opml import import_opml from .services.fetcher import effective_interval_minutes, fetch_and_ingest logger = logging.getLogger(__name__) @@ -69,3 +72,15 @@ def reset_feed_backoff(feed_id: int): """Admin-triggered: clear a feed's error count so it's retried at its normal configured interval instead of the backed-off one.""" Feed.objects.filter(pk=feed_id).update(fetch_error_count=0) + + +@shared_task +def import_opml_task(user_id: int, opml_content: str): + """Background path for large OPML imports — see OPML_ASYNC_THRESHOLD + in apps.feeds.views. opml_content is passed as text rather than a + file handle since Celery tasks must be JSON-serializable.""" + try: + user = get_user_model().objects.get(pk=user_id) + except get_user_model().DoesNotExist: + return None + return import_opml(user, BytesIO(opml_content.encode("utf-8"))) diff --git a/apps/feeds/test_opml.py b/apps/feeds/test_opml.py new file mode 100644 index 0000000..ccb5f14 --- /dev/null +++ b/apps/feeds/test_opml.py @@ -0,0 +1,128 @@ +from io import BytesIO + +import pytest +from django.contrib.auth import get_user_model + +from .models import Feed, Folder, Subscription +from .opml import export_opml, import_opml, parse_opml + +User = get_user_model() + +SIMPLE_OPML = b""" + + Subscriptions + + + + + + + +""" + +NESTED_OPML = b""" + + + + + + + + + +""" + +MALFORMED_XML = b"/unsubscribe/", + views.unsubscribe, + name="unsubscribe", + ), + path("subscriptions/import/", views.import_opml_view, name="import_opml"), + path("subscriptions/export/", views.export_opml_view, name="export_opml"), ] diff --git a/apps/feeds/views.py b/apps/feeds/views.py index 3559584..08bb5bc 100644 --- a/apps/feeds/views.py +++ b/apps/feeds/views.py @@ -1,10 +1,18 @@ +from io import BytesIO + from django.contrib import messages from django.contrib.auth.decorators import login_required -from django.shortcuts import redirect, render +from django.http import HttpResponse +from django.shortcuts import get_object_or_404, redirect, render +from django.views.decorators.http import require_POST -from .forms import AddFeedForm +from .forms import AddFeedForm, OPMLImportForm from .models import Feed, Subscription +from .opml import export_opml, import_opml, parse_opml from .services.fetcher import fetch_and_ingest +from .tasks import import_opml_task + +OPML_ASYNC_THRESHOLD = 50 @login_required @@ -43,3 +51,57 @@ def add_feed(request): return redirect("reader:stream") return render(request, "feeds/add_feed.html", {"form": form}) + + +@login_required +def subscription_list(request): + subscriptions = ( + Subscription.objects.filter(user=request.user) + .select_related("feed", "folder") + .order_by("folder__name", "order", "id") + ) + return render(request, "feeds/subscriptions.html", {"subscriptions": subscriptions}) + + +@login_required +@require_POST +def unsubscribe(request, subscription_id): + subscription = get_object_or_404(Subscription, user=request.user, pk=subscription_id) + title = subscription.display_title + subscription.delete() + messages.success(request, f"Unsubscribed from '{title}'.") + return redirect("feeds:subscription_list") + + +@login_required +def import_opml_view(request): + form = OPMLImportForm(request.POST or None, request.FILES or None) + if request.method == "POST" and form.is_valid(): + content = form.cleaned_data["opml_file"].read() + try: + entry_count = len(parse_opml(BytesIO(content))) + except Exception: + messages.error(request, "That file doesn't look like a valid OPML export.") + return redirect("feeds:import_opml") + + if entry_count > OPML_ASYNC_THRESHOLD: + import_opml_task.delay(request.user.id, content.decode("utf-8")) + messages.success(request, f"Importing {entry_count} feeds in the background.") + else: + result = import_opml(request.user, BytesIO(content)) + messages.success( + request, + f"Imported {result['created']} feed(s) " + f"({result['already_subscribed']} already subscribed).", + ) + return redirect("feeds:subscription_list") + + return render(request, "feeds/import_opml.html", {"form": form}) + + +@login_required +def export_opml_view(request): + content = export_opml(request.user) + response = HttpResponse(content, content_type="text/x-opml") + response["Content-Disposition"] = 'attachment; filename="evection-subscriptions.opml"' + return response diff --git a/static/css/base.css b/static/css/base.css index cd52bf7..039d831 100644 --- a/static/css/base.css +++ b/static/css/base.css @@ -245,6 +245,20 @@ input, button { margin: 1rem 0; } +.subscription-list { + list-style: none; + padding: 0; +} + +.subscription-row { + display: flex; + justify-content: space-between; + align-items: center; + gap: 1rem; + padding: 0.5rem 0; + border-bottom: 1px solid #eee; +} + .search-form input { flex: 1; } diff --git a/templates/feeds/import_opml.html b/templates/feeds/import_opml.html new file mode 100644 index 0000000..2758b05 --- /dev/null +++ b/templates/feeds/import_opml.html @@ -0,0 +1,12 @@ +{% extends "base.html" %} +{% block title %}Import OPML — Evection{% endblock %} +{% block content %} +

← Back to subscriptions

+

Import OPML

+

Upload an OPML file exported from FreshRSS or another feed reader.

+
+ {% csrf_token %} + {{ form.as_p }} + +
+{% endblock %} diff --git a/templates/feeds/subscriptions.html b/templates/feeds/subscriptions.html new file mode 100644 index 0000000..64a534f --- /dev/null +++ b/templates/feeds/subscriptions.html @@ -0,0 +1,29 @@ +{% extends "base.html" %} +{% block title %}Subscriptions — Evection{% endblock %} +{% block content %} +

← Back to stream

+

Subscriptions

+ +

+ Add feed + · Import OPML + · Export OPML +

+ + +{% endblock %} diff --git a/templates/reader/stream.html b/templates/reader/stream.html index a67aba4..4446fb3 100644 --- a/templates/reader/stream.html +++ b/templates/reader/stream.html @@ -4,7 +4,7 @@

Evection