diff --git a/apps/articles/migrations/0003_migrate_folders_to_tags.py b/apps/articles/migrations/0003_migrate_folders_to_tags.py
new file mode 100644
index 0000000..2d7af32
--- /dev/null
+++ b/apps/articles/migrations/0003_migrate_folders_to_tags.py
@@ -0,0 +1,32 @@
+from django.db import migrations
+
+
+def migrate_folders_to_tags(apps, schema_editor):
+ Folder = apps.get_model("feeds", "Folder")
+ Tag = apps.get_model("articles", "Tag")
+ SubscriptionTag = apps.get_model("articles", "SubscriptionTag")
+
+ for folder in Folder.objects.all():
+ tag, _ = Tag.objects.get_or_create(user_id=folder.user_id, name=folder.name[:100])
+ for subscription in folder.subscriptions.all():
+ SubscriptionTag.objects.get_or_create(
+ user_id=folder.user_id, subscription=subscription, tag=tag
+ )
+
+
+def noop_reverse(apps, schema_editor):
+ # Folders are gone by the time anyone would reverse this; nothing to
+ # restore them from.
+ pass
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ("articles", "0002_subscriptiontag"),
+ ("feeds", "0001_initial"),
+ ]
+
+ operations = [
+ migrations.RunPython(migrate_folders_to_tags, noop_reverse),
+ ]
diff --git a/apps/articles/tasks.py b/apps/articles/tasks.py
index 9951927..32ba06a 100644
--- a/apps/articles/tasks.py
+++ b/apps/articles/tasks.py
@@ -5,13 +5,13 @@ from apps.feeds.models import Subscription
from apps.rules.engine import evaluate_rules_for_article
from apps.rules.models import FilterRule
-from .models import Article
+from .models import Article, SubscriptionTag
@shared_task
def apply_filter_rules_for_feed(feed_id: int, article_ids: list[int]):
"""For every subscriber of ``feed_id``, evaluate their enabled
- FilterRules (scoped to this feed/folder or unscoped) against the given
+ FilterRules (scoped to this feed/tag or unscoped) against the given
articles. Dispatched by the fetch pipeline after new/updated articles
are committed for a feed.
"""
@@ -29,10 +29,15 @@ def apply_filter_rules_for_feed(feed_id: int, article_ids: list[int]):
rules = FilterRule.objects.filter(user=subscription.user, is_enabled=True).filter(
Q(feed_id=feed_id) | Q(feed__isnull=True)
)
- if subscription.folder_id:
- rules = rules.filter(Q(folder_id=subscription.folder_id) | Q(folder__isnull=True))
+ subscription_tag_ids = list(
+ SubscriptionTag.objects.filter(
+ user=subscription.user, subscription=subscription
+ ).values_list("tag_id", flat=True)
+ )
+ if subscription_tag_ids:
+ rules = rules.filter(Q(tag_id__in=subscription_tag_ids) | Q(tag__isnull=True))
else:
- rules = rules.filter(folder__isnull=True)
+ rules = rules.filter(tag__isnull=True)
rules = list(rules.order_by("priority", "id"))
if not rules:
continue
diff --git a/apps/articles/test_rule_dispatch.py b/apps/articles/test_rule_dispatch.py
index bb075eb..d4916fc 100644
--- a/apps/articles/test_rule_dispatch.py
+++ b/apps/articles/test_rule_dispatch.py
@@ -1,10 +1,10 @@
import pytest
from django.contrib.auth import get_user_model
-from apps.feeds.models import Feed, Folder, Subscription
+from apps.feeds.models import Feed, Subscription
from apps.rules.models import FilterRule
-from .models import Article, UserArticleState
+from .models import Article, SubscriptionTag, Tag, UserArticleState
from .tasks import apply_filter_rules_for_feed
User = get_user_model()
@@ -72,31 +72,55 @@ def test_feed_scoped_rule_does_not_apply_to_other_feeds(alice):
@pytest.mark.django_db
-def test_folder_scoped_rule_only_applies_within_that_folder(alice, feed):
+def test_tag_scoped_rule_only_applies_to_feeds_carrying_that_tag(alice, feed):
other_feed = Feed.objects.create(feed_url="https://other.example.com/feed.xml")
- folder = Folder.objects.create(user=alice, name="Tech")
- Subscription.objects.create(user=alice, feed=feed, folder=folder)
- Subscription.objects.create(user=alice, feed=other_feed, folder=None)
+ tagged_sub = Subscription.objects.create(user=alice, feed=feed)
+ Subscription.objects.create(user=alice, feed=other_feed)
+ tag = Tag.objects.create(user=alice, name="Tech")
+ SubscriptionTag.objects.create(user=alice, subscription=tagged_sub, tag=tag)
FilterRule.objects.create(
user=alice,
- folder=folder,
+ tag=tag,
match_field=FilterRule.FIELD_TITLE,
match_type=FilterRule.MATCH_CONTAINS,
match_value="Python",
action=FilterRule.ACTION_STAR,
)
- in_folder_article = Article.objects.create(feed=feed, guid="guid-1", title="Python in folder")
- outside_folder_article = Article.objects.create(
- feed=other_feed, guid="guid-2", title="Python outside folder"
+ tagged_article = Article.objects.create(feed=feed, guid="guid-1", title="Python in tagged feed")
+ untagged_article = Article.objects.create(
+ feed=other_feed, guid="guid-2", title="Python in untagged feed"
)
- apply_filter_rules_for_feed(feed.id, [in_folder_article.pk])
- apply_filter_rules_for_feed(other_feed.id, [outside_folder_article.pk])
+ apply_filter_rules_for_feed(feed.id, [tagged_article.pk])
+ apply_filter_rules_for_feed(other_feed.id, [untagged_article.pk])
- assert UserArticleState.objects.get(user=alice, article=in_folder_article).is_starred is True
- assert not UserArticleState.objects.filter(user=alice, article=outside_folder_article).exists()
+ assert UserArticleState.objects.get(user=alice, article=tagged_article).is_starred is True
+ assert not UserArticleState.objects.filter(user=alice, article=untagged_article).exists()
+
+
+@pytest.mark.django_db
+def test_rule_scoped_to_one_tag_still_applies_to_a_feed_with_multiple_tags(alice, feed):
+ subscription = Subscription.objects.create(user=alice, feed=feed)
+ tech_tag = Tag.objects.create(user=alice, name="Tech")
+ news_tag = Tag.objects.create(user=alice, name="News")
+ SubscriptionTag.objects.create(user=alice, subscription=subscription, tag=tech_tag)
+ SubscriptionTag.objects.create(user=alice, subscription=subscription, tag=news_tag)
+
+ FilterRule.objects.create(
+ user=alice,
+ tag=news_tag,
+ match_field=FilterRule.FIELD_TITLE,
+ match_type=FilterRule.MATCH_CONTAINS,
+ match_value="Python",
+ action=FilterRule.ACTION_STAR,
+ )
+ article = Article.objects.create(feed=feed, guid="guid-1", title="Python news")
+
+ apply_filter_rules_for_feed(feed.id, [article.pk])
+
+ assert UserArticleState.objects.get(user=alice, article=article).is_starred is True
@pytest.mark.django_db
diff --git a/apps/core/context_processors.py b/apps/core/context_processors.py
index 8864a87..9f0fd31 100644
--- a/apps/core/context_processors.py
+++ b/apps/core/context_processors.py
@@ -1,40 +1,50 @@
-from apps.articles.models import Tag, UserArticleState
+from apps.articles.models import SubscriptionTag, Tag, UserArticleState
from apps.articles.queries import unread_counts_by_feed
-from apps.feeds.models import Folder, Subscription
+from apps.feeds.models import Subscription
def sidebar(request):
- """Folder/feed tree, tags, and starred count for the persistent sidebar
- rendered by base.html on every authenticated page. Kept out of
- individual views so every page gets the same sidebar for free.
+ """Tag/feed tree and starred count for the persistent sidebar rendered
+ by base.html on every authenticated page. Kept out of individual views
+ so every page gets the same sidebar for free.
+
+ Feeds are grouped by tag (a feed can appear under more than one, since
+ SubscriptionTag is many-to-many — unlike the single-folder scheme this
+ replaced); feeds with no tags at all fall into "untagged".
"""
user = getattr(request, "user", None)
if user is None or not user.is_authenticated:
return {}
unread_counts = unread_counts_by_feed(user)
- subscriptions = (
- Subscription.objects.filter(user=user)
- .select_related("feed", "folder")
- .order_by("order", "id")
- )
+ tags = list(Tag.objects.filter(user=user))
- folders = list(Folder.objects.filter(user=user).order_by("order", "name"))
- by_folder = {folder.pk: [] for folder in folders}
- unfoldered = []
- for subscription in subscriptions:
+ tag_rows = (
+ SubscriptionTag.objects.filter(user=user)
+ .select_related("subscription__feed", "tag")
+ .order_by("tag__name", "subscription__order", "subscription__id")
+ )
+ feeds_by_tag = {tag.pk: [] for tag in tags}
+ tagged_subscription_ids = set()
+ for row in tag_rows:
+ subscription = row.subscription
subscription.unread_count = unread_counts.get(subscription.feed_id, 0)
- if subscription.folder_id and subscription.folder_id in by_folder:
- by_folder[subscription.folder_id].append(subscription)
- else:
- unfoldered.append(subscription)
+ feeds_by_tag.setdefault(row.tag_id, []).append(subscription)
+ tagged_subscription_ids.add(subscription.pk)
+
+ untagged = []
+ for subscription in (
+ Subscription.objects.filter(user=user).select_related("feed").order_by("order", "id")
+ ):
+ if subscription.pk not in tagged_subscription_ids:
+ subscription.unread_count = unread_counts.get(subscription.feed_id, 0)
+ untagged.append(subscription)
return {
- "sidebar_folders": [
- {"folder": folder, "subscriptions": by_folder[folder.pk]} for folder in folders
+ "sidebar_tag_groups": [
+ {"tag": tag, "subscriptions": feeds_by_tag.get(tag.pk, [])} for tag in tags
],
- "sidebar_unfoldered": unfoldered,
- "sidebar_tags": Tag.objects.filter(user=user),
+ "sidebar_untagged": untagged,
"sidebar_starred_count": UserArticleState.objects.filter(
user=user, is_starred=True
).count(),
diff --git a/apps/feeds/admin.py b/apps/feeds/admin.py
index b8cbf3e..252ac6d 100644
--- a/apps/feeds/admin.py
+++ b/apps/feeds/admin.py
@@ -1,12 +1,6 @@
from django.contrib import admin
-from .models import Feed, Folder, Subscription
-
-
-@admin.register(Folder)
-class FolderAdmin(admin.ModelAdmin):
- list_display = ["name", "user", "order"]
- list_filter = ["user"]
+from .models import Feed, Subscription
@admin.register(Feed)
@@ -25,5 +19,5 @@ class FeedAdmin(admin.ModelAdmin):
@admin.register(Subscription)
class SubscriptionAdmin(admin.ModelAdmin):
- list_display = ["user", "feed", "folder", "custom_title"]
- list_filter = ["user", "folder"]
+ list_display = ["user", "feed", "custom_title"]
+ list_filter = ["user"]
diff --git a/apps/feeds/forms.py b/apps/feeds/forms.py
index 2482d22..ff9af68 100644
--- a/apps/feeds/forms.py
+++ b/apps/feeds/forms.py
@@ -1,46 +1,27 @@
from django import forms
-from .models import Folder, Subscription
+from .models import Subscription
class AddFeedForm(forms.Form):
feed_url = forms.URLField(label="Feed URL", max_length=1000, assume_scheme="https")
- folder = forms.ModelChoiceField(queryset=Folder.objects.none(), required=False)
-
- def __init__(self, *args, user=None, **kwargs):
- super().__init__(*args, **kwargs)
- if user is not None:
- self.fields["folder"].queryset = Folder.objects.filter(user=user)
+ tag_names = forms.CharField(
+ label="Tags",
+ max_length=500,
+ required=False,
+ help_text="Comma-separated. Leave blank to tag it later.",
+ )
class EditSubscriptionForm(forms.ModelForm):
- new_folder_name = forms.CharField(
- label="Or create a new folder",
- max_length=255,
- required=False,
- help_text="Leave blank to use the folder selected above.",
- )
-
class Meta:
model = Subscription
- fields = ["custom_title", "folder"]
+ fields = ["custom_title"]
labels = {"custom_title": "Title (leave blank to use the feed's own title)"}
def __init__(self, *args, user=None, **kwargs):
super().__init__(*args, **kwargs)
self._user = user
- self.fields["folder"].queryset = Folder.objects.filter(user=user)
- self.fields["folder"].required = False
-
- def save(self, commit=True):
- subscription = super().save(commit=False)
- new_folder_name = self.cleaned_data.get("new_folder_name", "").strip()
- if new_folder_name:
- folder, _created = Folder.objects.get_or_create(user=self._user, name=new_folder_name)
- subscription.folder = folder
- if commit:
- subscription.save()
- return subscription
class OPMLImportForm(forms.Form):
diff --git a/apps/feeds/migrations/0002_remove_folder.py b/apps/feeds/migrations/0002_remove_folder.py
new file mode 100644
index 0000000..1d62be7
--- /dev/null
+++ b/apps/feeds/migrations/0002_remove_folder.py
@@ -0,0 +1,23 @@
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ("feeds", "0001_initial"),
+ # Both of these convert any Folder/FilterRule.folder data into its
+ # tag equivalent before the Folder table disappears out from under
+ # them.
+ ("articles", "0003_migrate_folders_to_tags"),
+ ("rules", "0002_folder_scope_to_tag_scope"),
+ ]
+
+ operations = [
+ migrations.RemoveField(
+ model_name="subscription",
+ name="folder",
+ ),
+ migrations.DeleteModel(
+ name="Folder",
+ ),
+ ]
diff --git a/apps/feeds/models.py b/apps/feeds/models.py
index c858d5d..98418b2 100644
--- a/apps/feeds/models.py
+++ b/apps/feeds/models.py
@@ -2,21 +2,6 @@ from django.conf import settings
from django.db import models
-class Folder(models.Model):
- user = models.ForeignKey(
- settings.AUTH_USER_MODEL, on_delete=models.CASCADE, related_name="folders"
- )
- name = models.CharField(max_length=255)
- order = models.PositiveIntegerField(default=0)
-
- class Meta:
- unique_together = [("user", "name")]
- ordering = ["order", "name"]
-
- def __str__(self):
- return self.name
-
-
class Feed(models.Model):
"""A single polled RSS/Atom source, shared across every subscriber.
@@ -68,9 +53,6 @@ class Subscription(models.Model):
settings.AUTH_USER_MODEL, on_delete=models.CASCADE, related_name="subscriptions"
)
feed = models.ForeignKey(Feed, on_delete=models.CASCADE, related_name="subscriptions")
- folder = models.ForeignKey(
- Folder, null=True, blank=True, on_delete=models.SET_NULL, related_name="subscriptions"
- )
custom_title = models.CharField(max_length=500, blank=True)
order = models.PositiveIntegerField(default=0)
created_at = models.DateTimeField(auto_now_add=True)
diff --git a/apps/feeds/opml.py b/apps/feeds/opml.py
index 0d7684d..9745151 100644
--- a/apps/feeds/opml.py
+++ b/apps/feeds/opml.py
@@ -14,15 +14,20 @@ from datetime import timezone as dt_timezone
import defusedxml.ElementTree as DefusedET
-from .models import Feed, Folder, Subscription
+from apps.articles.models import SubscriptionTag, Tag
+
+from .models import Feed, Subscription
def parse_opml(file_obj) -> list[dict]:
- """Returns a flat list of {feed_url, title, site_url, folder_name}.
+ """Returns a flat list of {feed_url, title, site_url, tag_names}.
- 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.
+ A feed's tags come from two places, combined: every enclosing
+ category/folder outline's name (so a feed nested two levels deep picks
+ up both as separate tags — tags aren't limited to one level the way
+ the old folder scheme was), and a comma-separated "category" attribute
+ on the feed's own outline, the convention export_opml below writes and
+ many other readers use for a flat multi-category representation.
"""
tree = DefusedET.parse(file_obj)
root = tree.getroot()
@@ -31,44 +36,45 @@ def parse_opml(file_obj) -> list[dict]:
if body is None:
return entries
- def walk(container, folder_name):
+ def walk(container, ancestor_names):
for outline in container.findall("outline"):
xml_url = outline.get("xmlUrl")
if xml_url:
+ tag_names = list(ancestor_names)
+ category_attr = outline.get("category")
+ if category_attr:
+ for name in category_attr.split(","):
+ name = name.strip()
+ if name and name not in tag_names:
+ tag_names.append(name)
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,
+ "tag_names": tag_names,
}
)
else:
- nested_name = outline.get("title") or outline.get("text") or folder_name
- walk(outline, nested_name)
+ nested_name = outline.get("title") or outline.get("text")
+ next_ancestors = ancestor_names + [nested_name] if nested_name else ancestor_names
+ walk(outline, next_ancestors)
- walk(body, None)
+ walk(body, [])
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."""
+ """Creates/reuses Feeds and Subscriptions for every entry, tagging each
+ subscription per its entry's tag_names. 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] = {}
+ tag_cache: dict[str, Tag] = {}
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={
@@ -76,16 +82,23 @@ def import_opml(user, file_obj) -> dict:
"site_url": entry["site_url"][:1000],
},
)
- _, created = Subscription.objects.get_or_create(
+ subscription, created = Subscription.objects.get_or_create(
user=user,
feed=feed,
- defaults={"folder": folder, "custom_title": ""},
+ defaults={"custom_title": ""},
)
if created:
created_count += 1
else:
already_subscribed_count += 1
+ for tag_name in entry["tag_names"]:
+ tag = tag_cache.get(tag_name)
+ if tag is None:
+ tag, _ = Tag.objects.get_or_create(user=user, name=tag_name[:100])
+ tag_cache[tag_name] = tag
+ SubscriptionTag.objects.get_or_create(user=user, subscription=subscription, tag=tag)
+
return {
"total": len(entries),
"created": created_count,
@@ -94,6 +107,10 @@ def import_opml(user, file_obj) -> dict:
def export_opml(user) -> bytes:
+ """A flat list of outlines (no folder nesting) with each feed's tags
+ joined into a comma-separated "category" attribute — the standard OPML
+ way to represent multi-category membership without picking one tag to
+ nest under, which a feed with several tags wouldn't fit."""
root = ET.Element("opml", version="2.0")
head = ET.SubElement(root, "head")
ET.SubElement(head, "title").text = "Evection subscriptions"
@@ -103,33 +120,25 @@ def export_opml(user) -> bytes:
body = ET.SubElement(root, "body")
subscriptions = (
- Subscription.objects.filter(user=user)
- .select_related("feed", "folder")
- .order_by("folder__name", "order", "id")
+ Subscription.objects.filter(user=user).select_related("feed").order_by("order", "id")
)
+ tag_names_by_subscription: dict[int, list[str]] = {}
+ for row in (
+ SubscriptionTag.objects.filter(user=user).select_related("tag").order_by("tag__name")
+ ):
+ tag_names_by_subscription.setdefault(row.subscription_id, []).append(row.tag.name)
- 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 "",
- )
+ attrs = {
+ "type": "rss",
+ "text": subscription.display_title,
+ "title": subscription.display_title,
+ "xmlUrl": subscription.feed.feed_url,
+ "htmlUrl": subscription.feed.site_url or "",
+ }
+ tag_names = tag_names_by_subscription.get(subscription.pk)
+ if tag_names:
+ attrs["category"] = ",".join(tag_names)
+ ET.SubElement(body, "outline", attrs)
return ET.tostring(root, encoding="utf-8", xml_declaration=True)
diff --git a/apps/feeds/test_opml.py b/apps/feeds/test_opml.py
index ccb5f14..5afed4b 100644
--- a/apps/feeds/test_opml.py
+++ b/apps/feeds/test_opml.py
@@ -3,7 +3,9 @@ from io import BytesIO
import pytest
from django.contrib.auth import get_user_model
-from .models import Feed, Folder, Subscription
+from apps.articles.models import SubscriptionTag, Tag
+
+from .models import Feed, Subscription
from .opml import export_opml, import_opml, parse_opml
User = get_user_model()
@@ -16,8 +18,8 @@ SIMPLE_OPML = b"""
-
+