Add Newsfeed

.env.example

@@ -33,3 +33,6 @@ TENCA_HASH_STORAGE_CLASS=myhpi.tenca_django.models.DjangoModelCachedDescriptionH
 TENCA_TEST_LIST_DOMAIN=TENCA_WEB_UI_HOSTNAME
 
 ANONYMOUS_IP_RANGE_GROUPS="127.0.0.1/32=Moderators,127.0.0.0/8=localhost"
+REDIRECT_TO_FEED=True
+FEED_TRUNCATE_LIMIT=400
+RELEASE_POST_ACCOUNT_ID=2 # Will be 2 if the create test data script is used

entrypoint.sh

@@ -4,5 +4,6 @@ python manage.py migrate
 python manage.py compilestatic
 python manage.py collectstatic --no-input
 python manage.py compilemessages
+python manage.py publish_release_post
 
 exec "$@"

myhpi/core/management/commands/create_test_data.py

@@ -1,3 +1,4 @@
+import datetime
 import random
 from datetime import date
 
@@ -14,6 +15,7 @@
     RootPage,
     SecondLevelMenuItem,
 )
+from myhpi.feed.models import NewsFeed, NewsFeedAccount, Post
 from myhpi.polls.models import PollList, RankedChoiceOption, RankedChoicePoll
 from myhpi.tests.core.setup import create_collections, create_documents
 
@@ -327,6 +329,9 @@ def create_some_pages(users, groups, documents):
             visible_for=[groups[0]],
         )
     )
+
+    # Create poll
+
     option_alice = RankedChoiceOption(
         name="Alice", description=generate_text(), poll=slash_1999_poll
     )
@@ -341,6 +346,44 @@ def create_some_pages(users, groups, documents):
     slash_1999_poll.options.add(option_bob)
     slash_1999_poll.options.add(option_charlie)
 
+    # Create feed and posts
+
+    feed = root_page.add_child(
+        instance=NewsFeed(
+            title="Feed",
+            slug="feed",
+            show_in_menus=True,
+            is_public=False,
+            visible_for=[groups[0]],
+        )
+    )
+
+    the_potsdam_post = NewsFeedAccount.objects.create(
+        post_key="SECRET_TEST_KEY",
+        name="the Potsdam Post",
+    )
+
+    for i in range(10):
+        feed.add_child(
+            instance=Post(
+                title=f"Post {i}",
+                slug=f"post-{i}",
+                show_in_menus=False,
+                is_public=False,
+                post_account=the_potsdam_post,
+                body=generate_text(),
+                visible_for=[groups[0]],
+                first_published_at=datetime.datetime.now(datetime.UTC)
+                - datetime.timedelta(10)
+                + datetime.timedelta(days=i),
+            )
+        )
+
+    myhpi_releases = NewsFeedAccount.objects.create(
+        post_key="SECRET_TEST_KEY_2",
+        name="myHPI Releases",
+    )
+
 
 class Command(BaseCommand):
     help = "Creates test data (user, pages, etc.) for myHPI."
@@ -354,6 +397,6 @@ def handle(self, *args, **options):
         create_some_pages(users, groups, documents)
         self.stdout.write(
             self.style.SUCCESS(
-                'Test data created succesfully. Remember that you need to create a superuser manually with "python manage.py createsuperuser".'
+                'Test data created successfully. Remember that you need to create a superuser manually with "python manage.py createsuperuser".'
             )
         )

myhpi/core/markdown/utils.py

@@ -6,13 +6,13 @@
 from myhpi.core.markdown.extensions import MinuteExtension
 
 
-def render_markdown(text, context=None, with_abbreveations=True):
+def render_markdown(text, context=None, with_abbreviations=True):
     """
     Turn markdown into HTML.
     """
     if context is None or not isinstance(context, dict):
         context = {}
-    markdown_html, toc = _transform_markdown_into_html(text, with_abbreviations=with_abbreveations)
+    markdown_html, toc = _transform_markdown_into_html(text, with_abbreviations=with_abbreviations)
     sanitised_markdown_html = _sanitise_markdown_html(markdown_html)
     return mark_safe(sanitised_markdown_html), mark_safe(toc)
 

myhpi/core/models.py

@@ -43,6 +43,12 @@ class BasePage(Page):
         index.FilterField("is_public"),
     ]
 
+    @property
+    def last_edited_by(self):
+        if self.get_latest_revision():
+            user = self.get_latest_revision().user
+            return f"{user.first_name} {user.last_name}"
+
 
 class InformationPageForm(WagtailAdminPageForm):
     def __init__(self, *args, **kwargs):
@@ -83,12 +89,6 @@ class InformationPage(BasePage):
 
     base_form_class = InformationPageForm
 
-    @property
-    def last_edited_by(self):
-        if self.get_latest_revision():
-            user = self.get_latest_revision().user
-            return f"{user.first_name} {user.last_name}"
-
 
 class MinutesList(BasePage):
     group = ForeignKey(Group, on_delete=models.PROTECT)

myhpi/feed/management/commands/publish_release_post.py

@@ -0,0 +1,77 @@
+import sys
+
+import requests
+from django.conf import settings
+from django.contrib.auth.models import Group
+from django.core.management import BaseCommand
+
+from myhpi.feed.models import NewsFeed, NewsFeedAccount, Post
+
+
+def get_release(tag):
+    r = requests.get(f"https://api.github.com/repos/fsr-de/myHPI/releases/tags/{tag}")
+    r.raise_for_status()
+    return r.json()
+
+
+def publish_release_post(force_publish, tag=None):
+    if tag is None:
+        version = settings.MYHPI_VERSION
+        tag = f"v{version}"
+    release = get_release(tag)
+
+    feed = NewsFeed.objects.first()
+    if feed is None:
+        print("No feed found, not publishing release post", file=sys.stderr)
+        return
+
+    existing_posts = Post.objects.filter(title=release["name"])
+    if existing_posts.exists() and not force_publish:
+        print(
+            "Release post already exists, not publishing again. Use -f option to create a post anyway.",
+            file=sys.stderr,
+        )
+        return
+
+    account_id = settings.RELEASE_POST_ACCOUNT_ID
+    if account_id is None:
+        print("No account id found, not publishing release post", file=sys.stderr)
+        return
+    account = NewsFeedAccount.objects.filter(id=account_id).first()
+    if account is None:
+        print("No account found, not publishing release post", file=sys.stderr)
+        return
+
+    post = feed.add_child(
+        instance=Post(
+            title=release["name"],
+            body=release["body"],
+            post_account=account,
+            visible_for=Group.objects.all(),
+            is_public=True,
+            first_published_at=release["published_at"],
+        )
+    )
+    print(f"Published release post with id {post.id}", file=sys.stderr)
+
+
+class Command(BaseCommand):
+    help = "Creates a feed post for the latest release of myHPI"
+
+    def add_arguments(self, parser):
+        parser.add_argument(
+            "--force",
+            "-f",
+            action="store_true",
+            help="Create a release post even if the release is already published.",
+        )
+
+        parser.add_argument(
+            "--tag",
+            "-t",
+            type=str,
+            help="Specify a tag to publish a release post for (defaults to currently installed version, typically latest tag).",
+        )
+
+    def handle(self, *args, **options):
+        publish_release_post(options["force"], options["tag"])

myhpi/feed/middleware.py

@@ -0,0 +1,26 @@
+from django.http import HttpResponseRedirect
+
+from myhpi import settings
+from myhpi.feed.models import NewsFeed
+
+
+class FeedRedirectMiddleware:
+    def __init__(self, get_response):
+        self.get_response = get_response
+        self.feed = NewsFeed.objects.first()
+
+    def __call__(self, request):
+        self.process_request(request)
+        return self.get_response(request)
+
+    def process_request(self, request):
+        user = request.user
+        if (
+            self.feed
+            and request.path == "/"
+            and user.is_authenticated
+            and self.feed.visible_for.intersection(user.groups.all()).exists()
+            and request.GET.get("no_redirect") != "true"
+            and settings.REDIRECT_TO_FEED
+        ):
+            request.path = self.feed.slug

myhpi/feed/migrations/0001_initial.py

@@ -0,0 +1,88 @@
+# Generated by Django 4.2.9 on 2024-02-15 17:16
+
+import django.db.models.deletion
+import wagtail.users.models
+from django.db import migrations, models
+
+import myhpi.core.markdown.fields
+
+
+class Migration(migrations.Migration):
+    initial = True
+
+    dependencies = [
+        ("core", "0010_minutes_location"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="NewsFeed",
+            fields=[
+                (
+                    "basepage_ptr",
+                    models.OneToOneField(
+                        auto_created=True,
+                        on_delete=django.db.models.deletion.CASCADE,
+                        parent_link=True,
+                        primary_key=True,
+                        serialize=False,
+                        to="core.basepage",
+                    ),
+                ),
+            ],
+            options={
+                "abstract": False,
+            },
+            bases=("core.basepage",),
+        ),
+        migrations.CreateModel(
+            name="NewsFeedAccount",
+            fields=[
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True, primary_key=True, serialize=False, verbose_name="ID"
+                    ),
+                ),
+                ("post_key", models.CharField(max_length=255)),
+                ("name", models.CharField(max_length=255)),
+                (
+                    "icon",
+                    models.ImageField(
+                        blank=True, null=True, upload_to=wagtail.users.models.upload_avatar_to
+                    ),
+                ),
+            ],
+        ),
+        migrations.CreateModel(
+            name="Post",
+            fields=[
+                (
+                    "basepage_ptr",
+                    models.OneToOneField(
+                        auto_created=True,
+                        on_delete=django.db.models.deletion.CASCADE,
+                        parent_link=True,
+                        primary_key=True,
+                        serialize=False,
+                        to="core.basepage",
+                    ),
+                ),
+                ("body", myhpi.core.markdown.fields.CustomMarkdownField()),
+                (
+                    "post_account",
+                    models.ForeignKey(
+                        blank=True,
+                        null=True,
+                        on_delete=django.db.models.deletion.SET_NULL,
+                        related_name="posts",
+                        to="feed.newsfeedaccount",
+                    ),
+                ),
+            ],
+            options={
+                "abstract": False,
+            },
+            bases=("core.basepage",),
+        ),
+    ]

myhpi/feed/models.py

@@ -0,0 +1,72 @@
+from django.core.paginator import Paginator
+from django.db import models
+from wagtail.admin.panels import FieldPanel
+from wagtail.snippets.models import register_snippet
+from wagtail.users.models import UserProfile, upload_avatar_to
+
+from myhpi import settings
+from myhpi.core.markdown.fields import CustomMarkdownField
+from myhpi.core.models import BasePage
+
+
+class NewsFeed(BasePage):
+    parent_page_types = ["core.RootPage"]
+    subpage_types = ["Post"]
+    max_count = 1
+
+    def get_context(self, request, *args, **kwargs):
+        context = super().get_context(request, *args, **kwargs)
+        all_posts = self.get_children().live().order_by("-first_published_at").specific()
+        paginator = Paginator(all_posts, 10)
+        page = paginator.get_page(request.GET.get("page"))
+
+        # Currently, there is no filter for visibility on posts. That is, it is assumed that all post should be visible to students
+        context["page"] = page
+        context["posts"] = page.object_list
+        context["limit"] = settings.FEED_TRUNCATE_LIMIT
+        return context
+
+
+class Post(BasePage):
+    parent_page_types = ["NewsFeed"]
+    subpage_types = []
+    body = CustomMarkdownField()
+    post_account = models.ForeignKey(
+        "NewsFeedAccount", related_name="posts", on_delete=models.SET_NULL, null=True, blank=True
+    )
+
+    content_panels = BasePage.content_panels + [
+        FieldPanel("body", classname="full"),
+    ]
+
+    @property
+    def author(self):
+        if self.last_edited_by:
+            return self.last_edited_by
+        else:
+            return self.post_account
+
+    @property
+    def date(self):
+        if self.first_published_at:
+            return self.first_published_at.date()
+
+    @property
+    def image_url(self):
+        if self.post_account and self.post_account.icon:
+            return self.post_account.icon.url
+        # Currently does not use the wagtail user icon since it is not used anywhere else
+        else:
+            return "https://www.gravatar.com/avatar/b1a83a1baa8a1d45c905a59217a7d30a?s=140&d=mm"
+
+
+# The NewsFeedAccount is used to create posts via API
+@register_snippet
+class NewsFeedAccount(models.Model):
+    post_key = models.CharField(max_length=255)
+    name = models.CharField(max_length=255)
+
+    icon = models.ImageField(upload_to=upload_avatar_to, null=True, blank=True)
+
+    def __str__(self):
+        return self.name