Files
Evection/apps/articles/models.py
T
ksmithandClaude Sonnet 5 753ae9efc7 Make Starred and Saved-for-later pre-configured system tags
UserArticleState.is_starred/is_saved_for_later/starred_at are gone —
starring and saving now add/remove an ArticleTag against a per-user
"Starred" / "Saved for later" Tag, created lazily on first use and marked
Tag.is_system=True. is_read/is_hidden stay on UserArticleState since
they're genuine reading state, not categorization, which is what made
these two candidates for unifying into the general tag mechanism.

System tags are excluded from the Manage Tags page and from delete_tag
(get_object_or_404 now requires is_system=False, so attempting to delete
one 404s) and from the subscription-tag autocomplete, since they
categorize articles, not feeds. The star/save icons are still exactly
where they were — this only changes what powers them.

apps.rules.engine's star action now does get_system_tag + ArticleTag.
get_or_create instead of setting a boolean field. A data migration
converts every existing is_starred=True/is_saved_for_later=True row into
its ArticleTag equivalent before the fields are dropped — verified by
seeding the pre-removal schema directly (including a row with both flags
set) and confirming the migration produces the right tags.

apps.articles.queries.with_user_state gained one more query (tag lookup
for the current page's articles) to stay in the same "fixed number of
queries regardless of article count" shape it already had.

Verified end to end against a running dev server: toggling star/saved,
the starred/saved filters, the sidebar's Favourites count, and that the
Starred tag doesn't appear on the Manage Tags page.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
2026-10-30 21:36:44 -06:00

126 lines
4.4 KiB
Python

from django.conf import settings
from django.db import models
from apps.feeds.models import Feed, Subscription
class Article(models.Model):
"""A single fetched entry, shared across every subscriber of its feed.
Per-user state (read/starred/saved/hidden) lives in UserArticleState,
never on this model — editing an article's content on re-fetch must
never touch anyone's read/star state.
"""
feed = models.ForeignKey(Feed, on_delete=models.CASCADE, related_name="articles")
guid = models.CharField(max_length=1000)
link = models.URLField(max_length=2000, blank=True)
title = models.CharField(max_length=1000, blank=True)
author = models.CharField(max_length=500, blank=True)
content_html = models.TextField(blank=True)
summary = models.TextField(blank=True)
content_hash = models.CharField(max_length=64, blank=True)
published_at = models.DateTimeField(null=True, blank=True)
fetched_at = models.DateTimeField(auto_now_add=True)
class Meta:
unique_together = [("feed", "guid")]
indexes = [models.Index(fields=["feed", "published_at"])]
ordering = ["-published_at", "-fetched_at"]
def __str__(self):
return self.title or self.guid
class UserArticleState(models.Model):
"""Per-user read/hide state for an Article.
Starred and saved-for-later are ArticleTags against pre-configured
system tags instead of fields here (see Tag.is_system) — read/hidden
stay here since they're genuine reading state, not categorization.
Rows are created lazily, only on first interaction — a row with no
explicit True flags is equivalent to "no row exists" (unread). Never
bulk-create one of these per subscriber on ingest.
"""
user = models.ForeignKey(
settings.AUTH_USER_MODEL, on_delete=models.CASCADE, related_name="article_states"
)
article = models.ForeignKey(Article, on_delete=models.CASCADE, related_name="user_states")
is_read = models.BooleanField(default=False)
is_hidden = models.BooleanField(default=False)
read_at = models.DateTimeField(null=True, blank=True)
class Meta:
unique_together = [("user", "article")]
indexes = [
models.Index(fields=["user", "is_read"]),
]
def __str__(self):
return f"{self.user}: {self.article}"
# Pre-configured per-user tags backing the star/save-for-later icons —
# created lazily on first use (see get_system_tag), same as any other tag,
# just under a name the app itself controls rather than the user.
STARRED_TAG_NAME = "Starred"
SAVED_TAG_NAME = "Saved for later"
class Tag(models.Model):
user = models.ForeignKey(
settings.AUTH_USER_MODEL, on_delete=models.CASCADE, related_name="tags"
)
name = models.CharField(max_length=100)
color = models.CharField(max_length=7, blank=True)
is_system = models.BooleanField(default=False)
class Meta:
unique_together = [("user", "name")]
ordering = ["name"]
def __str__(self):
return self.name
def get_system_tag(user, name):
tag, _ = Tag.objects.get_or_create(user=user, name=name, defaults={"is_system": True})
return tag
class ArticleTag(models.Model):
user = models.ForeignKey(settings.AUTH_USER_MODEL, on_delete=models.CASCADE)
article = models.ForeignKey(Article, on_delete=models.CASCADE, related_name="article_tags")
tag = models.ForeignKey(Tag, on_delete=models.CASCADE, related_name="article_tags")
class Meta:
unique_together = [("user", "article", "tag")]
def __str__(self):
return f"{self.article} -> {self.tag}"
class SubscriptionTag(models.Model):
"""Tags a feed itself (via the user's Subscription to it), independent
of tagging individual articles — e.g. tagging a whole feed "backend"
rather than tagging each of its articles one by one. Articles from a
tagged feed show up under that tag in the stream alongside any
individually-tagged articles (see apps.reader.views._apply_scope).
"""
user = models.ForeignKey(settings.AUTH_USER_MODEL, on_delete=models.CASCADE)
subscription = models.ForeignKey(
Subscription, on_delete=models.CASCADE, related_name="subscription_tags"
)
tag = models.ForeignKey(Tag, on_delete=models.CASCADE, related_name="subscription_tags")
class Meta:
unique_together = [("user", "subscription", "tag")]
def __str__(self):
return f"{self.subscription} -> {self.tag}"