Great news improvements, .env for configuration, full uv guide update command and more

.env.example

@@ -0,0 +1,11 @@
+HTTPS=off
+SITH_DEBUG=true
+
+# This is not the real key used in prod
+SECRET_KEY=(4sjxvhz@m5$0a$j0_pqicnc$s!vbve)z+&++m%g%bjhlz4+g2
+
+# comment the sqlite line and uncomment the postgres one to switch the dbms
+DATABASE_URL=sqlite:///db.sqlite3
+#DATABASE_URL=postgres://user:[email protected]:5432/sith
+
+CACHE_URL=redis://127.0.0.1:6379/0

.github/workflows/ci.yml

@@ -7,6 +7,10 @@ on:
     branches: [master, taiste]
   workflow_dispatch:
 
+env:
+  SECRET_KEY: notTheRealOne
+  DATABASE_URL: sqlite:///db.sqlite3
+
 jobs:
   pre-commit:
     name: Launch pre-commits checks (ruff)

.gitignore

@@ -21,3 +21,4 @@ node_modules/
 
 # compiled documentation
 site/
+.env

club/schemas.py

@@ -7,3 +7,17 @@ class ClubSchema(ModelSchema):
     class Meta:
         model = Club
         fields = ["id", "name"]
+
+
+class ClubProfileSchema(ModelSchema):
+    """The infos needed to display a simple club profile."""
+
+    class Meta:
+        model = Club
+        fields = ["id", "name", "logo"]
+
+    url: str
+
+    @staticmethod
+    def resolve_url(obj: Club) -> str:
+        return obj.get_absolute_url()

com/api.py

@@ -1,10 +1,18 @@
 from pathlib import Path
+from typing import Literal
 
 from django.conf import settings
-from django.http import Http404
-from ninja_extra import ControllerBase, api_controller, route
+from django.http import Http404, HttpResponse
+from ninja import Query
+from ninja_extra import ControllerBase, api_controller, paginate, route
+from ninja_extra.pagination import PageNumberPaginationExtra
+from ninja_extra.permissions import IsAuthenticated
+from ninja_extra.schemas import PaginatedResponseSchema
 
 from com.calendar import IcsCalendar
+from com.models import News, NewsDate
+from com.schemas import NewsDateFilterSchema, NewsDateSchema
+from core.auth.api_permissions import HasPerm
 from core.views.files import send_raw_file
 
 
@@ -17,7 +25,7 @@ def calendar_external(self):
         """Return the ICS file of the AE Google Calendar
 
         Because of Google's cors rules, we can't just do a request to google ics
-        from the frontend. Google is blocking CORS request in it's responses headers.
+        from the frontend. Google is blocking CORS request in its responses headers.
         The only way to do it from the frontend is to use Google Calendar API with an API key
         This is not especially desirable as your API key is going to be provided to the frontend.
 
@@ -30,3 +38,67 @@ def calendar_external(self):
     @route.get("/internal.ics", url_name="calendar_internal")
     def calendar_internal(self):
         return send_raw_file(IcsCalendar.get_internal())
+
+    @route.get(
+        "/unpublished.ics",
+        permissions=[IsAuthenticated],
+        url_name="calendar_unpublished",
+    )
+    def calendar_unpublished(self):
+        return HttpResponse(
+            IcsCalendar.get_unpublished(self.context.request.user),
+            content_type="text/calendar",
+        )
+
+
+@api_controller("/news")
+class NewsController(ControllerBase):
+    @route.patch(
+        "/{int:news_id}/publish",
+        permissions=[HasPerm("com.moderate_news")],
+        url_name="moderate_news",
+    )
+    def publish_news(self, news_id: int):
+        news = self.get_object_or_exception(News, id=news_id)
+        if not news.is_published:
+            news.is_published = True
+            news.moderator = self.context.request.user
+            news.save()
+
+    @route.patch(
+        "/{int:news_id}/unpublish",
+        permissions=[HasPerm("com.moderate_news")],
+        url_name="unpublish_news",
+    )
+    def unpublish_news(self, news_id: int):
+        news = self.get_object_or_exception(News, id=news_id)
+        if news.is_published:
+            news.is_published = False
+            news.moderator = self.context.request.user
+            news.save()
+
+    @route.delete(
+        "/{int:news_id}",
+        permissions=[HasPerm("com.delete_news")],
+        url_name="delete_news",
+    )
+    def delete_news(self, news_id: int):
+        news = self.get_object_or_exception(News, id=news_id)
+        news.delete()
+
+    @route.get(
+        "/date",
+        url_name="fetch_news_dates",
+        response=PaginatedResponseSchema[NewsDateSchema],
+    )
+    @paginate(PageNumberPaginationExtra, page_size=50)
+    def fetch_news_dates(
+        self,
+        filters: Query[NewsDateFilterSchema],
+        text_format: Literal["md", "html"] = "md",
+    ):
+        return filters.filter(
+            NewsDate.objects.viewable_by(self.context.request.user)
+            .order_by("start_date")
+            .select_related("news", "news__club")
+        )

com/calendar.py

@@ -2,16 +2,18 @@
 from pathlib import Path
 from typing import final
 
-import urllib3
+import requests
 from dateutil.relativedelta import relativedelta
 from django.conf import settings
+from django.db.models import F, QuerySet
 from django.urls import reverse
 from django.utils import timezone
 from ical.calendar import Calendar
 from ical.calendar_stream import IcsCalendarStream
 from ical.event import Event
 
 from com.models import NewsDate
+from core.models import User
 
 
 @final
@@ -35,16 +37,15 @@ def get_external(cls, expiration: timedelta = timedelta(hours=1)) -> Path | None
 
     @classmethod
     def make_external(cls) -> Path | None:
-        calendar = urllib3.request(
-            "GET",
-            "https://calendar.google.com/calendar/ical/ae.utbm%40gmail.com/public/basic.ics",
+        calendar = requests.get(
+            "https://calendar.google.com/calendar/ical/ae.utbm%40gmail.com/public/basic.ics"
         )
-        if calendar.status != 200:
+        if not calendar.ok:
             return None
 
         cls._CACHE_FOLDER.mkdir(parents=True, exist_ok=True)
         with open(cls._EXTERNAL_CALENDAR, "wb") as f:
-            _ = f.write(calendar.data)
+            _ = f.write(calendar.content)
         return cls._EXTERNAL_CALENDAR
 
     @classmethod
@@ -56,21 +57,38 @@ def get_internal(cls) -> Path:
     @classmethod
     def make_internal(cls) -> Path:
         # Updated through a post_save signal on News in com.signals
+        # Create a file so we can offload the download to the reverse proxy if available
+        cls._CACHE_FOLDER.mkdir(parents=True, exist_ok=True)
+        with open(cls._INTERNAL_CALENDAR, "wb") as f:
+            _ = f.write(
+                cls.ics_from_queryset(
+                    NewsDate.objects.filter(
+                        news__is_published=True,
+                        end_date__gte=timezone.now() - (relativedelta(months=6)),
+                    )
+                )
+            )
+        return cls._INTERNAL_CALENDAR
+
+    @classmethod
+    def get_unpublished(cls, user: User) -> bytes:
+        return cls.ics_from_queryset(
+            NewsDate.objects.viewable_by(user).filter(
+                news__is_published=False,
+                end_date__gte=timezone.now() - (relativedelta(months=6)),
+            ),
+        )
+
+    @classmethod
+    def ics_from_queryset(cls, queryset: QuerySet[NewsDate]) -> bytes:
         calendar = Calendar()
-        for news_date in NewsDate.objects.filter(
-            news__is_moderated=True,
-            end_date__gte=timezone.now() - (relativedelta(months=6)),
-        ).prefetch_related("news"):
+        for news_date in queryset.annotate(news_title=F("news__title")):
             event = Event(
-                summary=news_date.news.title,
+                summary=news_date.news_title,
                 start=news_date.start_date,
                 end=news_date.end_date,
                 url=reverse("com:news_detail", kwargs={"news_id": news_date.news.id}),
             )
             calendar.events.append(event)
 
-        # Create a file so we can offload the download to the reverse proxy if available
-        cls._CACHE_FOLDER.mkdir(parents=True, exist_ok=True)
-        with open(cls._INTERNAL_CALENDAR, "wb") as f:
-            _ = f.write(IcsCalendarStream.calendar_to_ics(calendar).encode("utf-8"))
-        return cls._INTERNAL_CALENDAR
+        return IcsCalendarStream.calendar_to_ics(calendar).encode("utf-8")

com/forms.py

@@ -147,8 +147,8 @@ class Meta:
             "content": MarkdownInput,
         }
 
-    auto_moderate = forms.BooleanField(
-        label=_("Automoderation"),
+    auto_publish = forms.BooleanField(
+        label=_("Auto publication"),
         widget=CheckboxInput(attrs={"class": "switch"}),
         required=False,
     )
@@ -182,12 +182,12 @@ def full_clean(self):
     def save(self, commit: bool = True):  # noqa FBT001
         self.instance.author = self.author
         if (self.author.is_com_admin or self.author.is_root) and (
-            self.cleaned_data.get("auto_moderate") is True
+            self.cleaned_data.get("auto_publish") is True
         ):
-            self.instance.is_moderated = True
+            self.instance.is_published = True
             self.instance.moderator = self.author
         else:
-            self.instance.is_moderated = False
+            self.instance.is_published = False
         created_news = super().save(commit=commit)
         self.date_form.save(commit=commit, news=created_news)
         return created_news

com/migrations/0009_remove_news_is_moderated_news_is_published.py

@@ -0,0 +1,16 @@
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [("com", "0008_alter_news_options_alter_newsdate_options_and_more")]
+
+    operations = [
+        migrations.RenameField(
+            model_name="news", old_name="is_moderated", new_name="is_published"
+        ),
+        migrations.AlterField(
+            model_name="news",
+            name="is_published",
+            field=models.BooleanField(default=False, verbose_name="is published"),
+        ),
+    ]

com/models.py

@@ -56,7 +56,7 @@ def is_owned_by(self, user):
 
 class NewsQuerySet(models.QuerySet):
     def moderated(self) -> Self:
-        return self.filter(is_moderated=True)
+        return self.filter(is_published=True)
 
     def viewable_by(self, user: User) -> Self:
         """Filter news that the given user can view.
@@ -68,7 +68,7 @@ def viewable_by(self, user: User) -> Self:
         """
         if user.has_perm("com.view_unmoderated_news"):
             return self
-        q_filter = Q(is_moderated=True)
+        q_filter = Q(is_published=True)
         if user.is_authenticated:
             q_filter |= Q(author_id=user.id)
         return self.filter(q_filter)
@@ -104,7 +104,7 @@ class News(models.Model):
         verbose_name=_("author"),
         on_delete=models.PROTECT,
     )
-    is_moderated = models.BooleanField(_("is moderated"), default=False)
+    is_published = models.BooleanField(_("is published"), default=False)
     moderator = models.ForeignKey(
         User,
         related_name="moderated_news",
@@ -127,7 +127,7 @@ def __str__(self):
 
     def save(self, *args, **kwargs):
         super().save(*args, **kwargs)
-        if self.is_moderated:
+        if self.is_published:
             return
         for user in User.objects.filter(
             groups__id__in=[settings.SITH_GROUP_COM_ADMIN_ID]
@@ -154,15 +154,15 @@ def can_be_edited_by(self, user: User):
 
     def can_be_viewed_by(self, user: User):
         return (
-            self.is_moderated
+            self.is_published
             or user.has_perm("com.view_unmoderated_news")
             or (user.is_authenticated and self.author_id == user.id)
         )
 
 
 def news_notification_callback(notif):
     count = News.objects.filter(
-        dates__start_date__gt=timezone.now(), is_moderated=False
+        dates__start_date__gt=timezone.now(), is_published=False
     ).count()
     if count:
         notif.viewed = False
@@ -172,6 +172,22 @@ def news_notification_callback(notif):
         notif.viewed = True
 
 
+class NewsDateQuerySet(models.QuerySet):
+    def viewable_by(self, user: User) -> Self:
+        """Filter the event dates that the given user can view.
+
+        - If the can view non moderated news, he can view all news dates
+        - else, he can view the dates of news that are either
+          authored by him or moderated.
+        """
+        if user.has_perm("com.view_unmoderated_news"):
+            return self
+        q_filter = Q(news__is_published=True)
+        if user.is_authenticated:
+            q_filter |= Q(news__author_id=user.id)
+        return self.filter(q_filter)
+
+
 class NewsDate(models.Model):
     """A date associated with news.
 
@@ -187,6 +203,8 @@ class NewsDate(models.Model):
     start_date = models.DateTimeField(_("start_date"))
     end_date = models.DateTimeField(_("end_date"))
 
+    objects = NewsDateQuerySet.as_manager()
+
     class Meta:
         verbose_name = _("news date")
         verbose_name_plural = _("news dates")
@@ -319,7 +337,7 @@ def __str__(self):
 
     def active_posters(self):
         now = timezone.now()
-        return self.posters.filter(is_moderated=True, date_begin__lte=now).filter(
+        return self.posters.filter(d=True, date_begin__lte=now).filter(
             Q(date_end__isnull=True) | Q(date_end__gte=now)
         )