Merge develop commits into changes branch

.github/workflows/jekyll-gh-pages.yml

@@ -1,38 +1,51 @@
 
-name: Jekyll
+name: Docs Deployment
 
 on:
   push:
-    branches: ["main"]
+    branches: ["main", "develop"]
+    paths:
+      - 'docs/**'
+      - '.github/workflows/jekyll-gh-pages.yml'
   workflow_dispatch:
 
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
 permissions:
   contents: read
   pages: write
   id-token: write
 
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
 concurrency:
   group: "pages"
-  cancel-in-progress: true
+  cancel-in-progress: false
 
 jobs:
+  # Build job
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/configure-pages@v2
-      - uses: actions/jekyll-build-pages@v1
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - name: Build with Jekyll
+        uses: actions/jekyll-build-pages@v1
         with:
-          source: ./docs
+          source: ./
           destination: ./_site
-      - uses: actions/upload-pages-artifact@v1
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v2
 
+  # Deployment job
   deploy:
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}
     runs-on: ubuntu-latest
     needs: build
     steps:
-      - id: deployment
-        uses: actions/deploy-pages@v1
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

.gitignore

@@ -10,3 +10,9 @@ node_modules/
 celerybeat-schedule
 /mobile
 /doodle
+# editors
+/.idea
+.vscode/*
+# django stuff
+local_settings.py
+*.log

README.md

@@ -1,25 +1,5 @@
-# Metropolis (Backend)
-Make sure you have python 3.9+ installed. As of now, the project is only compatible with versions between python 3.9 and 3.10.11.
-## Running Locally
+# Metropolis
+[__Mac Lyons’ Den__](https://docs.google.com/document/d/1ycoI7KbStukZ_B89UxVFGqYHBrw5D2clpVDAL3R23GM/edit)'s backend systems.
 
-Recommended: install [Nix](https://nixos.org/download) and [direnv](https://direnv.net) and run:
-```sh
-make
-direnv allow
-./manage.py migrate
-nix run
-```
-If not using direnv:
-```sh
-nix develop # and run `./manage.py migrate` inside
-nix run
-```
 
-If you do not want to use Nix:
-(Note: only tested on Unix-like platforms)
-
-```
-make
-poetry run python ./manage.py migrate
-poetry run python ./manage.py runserver
-```
+### To set up metropolis locally, please follow the [setup guide](https://docs.maclyonsden.com/docs/onboarding.html)

_config.yml

@@ -1,4 +1,4 @@
 remote_theme: wlmac/just-the-docs
 
-title: Docs
+title: Metropolis Docs
 author: Metropolis

core/admin.py

@@ -10,7 +10,6 @@
 from django.utils.translation import gettext_lazy as _
 from martor.widgets import AdminMartorWidget
 
-from metropolis import settings
 from . import models
 from .forms import (
     AnnouncementAdminForm,

core/api/views/meta.py

@@ -1,7 +1,7 @@
+from datetime import datetime
 from typing import Dict
 
 from django.conf import settings
-from django.utils import timezone
 from rest_framework.response import Response
 from rest_framework.views import APIView
 
@@ -29,9 +29,13 @@ def censor(cls, banner: Dict) -> Dict:
 
     @staticmethod
     def get(request):
-        now = timezone.now()
+        return Response(Banners.calculate_banners())
+
+    @classmethod
+    def calculate_banners(cls):
+        now = datetime.now(settings.TZ)
         current = filter(lambda b: b["start"] < now < b["end"], settings.BANNER3)
         current = list(map(Banners.censor, current))
         upcoming = filter(lambda b: now <= b["start"], settings.BANNER3)
         upcoming = list(map(Banners.censor, upcoming))
-        return Response(dict(current=current, upcoming=upcoming))
+        return dict(current=current, upcoming=upcoming)

core/api/views/objects/base.py

@@ -1,11 +1,12 @@
-from typing import List
+from typing import List, Literal
 
 
 class BaseProvider:
-    allow_list: bool = True
-    allow_new: bool = True
-    kind: str = ""
+    allow_list: bool = True  # Is the view able to list the model's objects. (e.g. /user would list all users
+    allow_new: bool = True  # Is the provider able to create a new object.
+    kind: Literal["list", "new", "single", "retrieve"]  # type of view
     listing_filters_ignore: List[str] = []
+    # ^ don't treat the passed in params as a listing filter but instead as a param for the view.
 
     def __init__(self, request):
         self.request = request

core/api/views/objects/blog_post.py

@@ -45,7 +45,7 @@ class Meta:
 class BlogPostProvider(BaseProvider):
     serializer_class = Serializer
     model = BlogPost
-    lookup_fields = ["id", "slug"]
+    additional_lookup_fields = ["slug"]
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)

core/api/views/objects/exhibit.py

@@ -39,7 +39,7 @@ class Meta:
 
 class ExhibitProvider(BaseProvider):
     model = Exhibit
-    lookup_fields = ["id", "slug"]
+    additional_lookup_fields = ["slug"]
     serializer_class = Serializer
 
     def __init__(self, *args, **kwargs):

core/api/views/objects/flatpage.py

@@ -20,7 +20,7 @@ class FlatPageProvider(BaseProvider):
     serializer_class = Serializer
     model = FlatPage
     allow_list = True
-    lookup_fields = ["id", "url"]
+    additional_lookup_fields = ["url"]
 
     @property
     def permission_classes(self):

core/api/views/objects/main.py

@@ -1,7 +1,10 @@
+from __future__ import annotations
+
 import os
 from json import JSONDecodeError
-from typing import Dict, Callable, List, Tuple
+from typing import Dict, Callable, List, Tuple, Set, Final
 
+from django.conf import settings
 from django.core.exceptions import ObjectDoesNotExist, BadRequest
 from django.db.models import Model, Q, QuerySet
 from django.http import QueryDict
@@ -80,42 +83,76 @@ def initial(self, *args, **kwargs):
             self.permission_classes = [permissions.AllowAny]
         else:
             self.permission_classes = provider.permission_classes
-        self.as_su = as_su
+        self.as_su = as_su  # if the user is a SU
         self.serializer_class = provider.serializer_class
-        self.lookup_fields = getattr(
-            provider, "lookup_fields", getattr(provider, "lookup_field", ["id", "pk"])
-        )
+        self.additional_lookup_fields = self._compile_lookup_fields()
         self.listing_filters = getattr(
             provider,
             "listing_filters",
             getattr(provider, "listing_filter", {"id": int, "pk": int}),
+        )  # NOTE: better to have the following if after initial, but this is easier
+
+    def _compile_lookup_fields(self) -> Set[str]:
+        """
+        Compiles the additional lookup fields + the two required into one clean set.
+        """
+        allowed_fields: List = getattr(  # the lookup fields allowed for the provider
+            self.provider, "additional_lookup_fields", []
         )
-        # NOTE: better to have the following if after initial, but this is easier
+        allowed_fields.extend(settings.GLOBAL_LOOKUPS)
+        return set(
+            allowed_fields
+        )  # use a set for better memory performance & no duplicates.
 
-    def get_object(self):
-        queryset = self.get_queryset()
+    @property
+    def lookup_field(self) -> str:
         lookup = (
             self.request.query_params.get("lookup", "id")
-            if self.request.query_params.get("lookup") in self.lookup_fields
+            if self.request.query_params.get("lookup") in self.additional_lookup_fields
             else "id"
         )
+
+        field_type = self.provider.model._meta.get_field(
+            lookup
+        ).get_internal_type()  # get value like CharField
+        if field_type in settings.LOOKUP_FIELD_REPLACEMENTS.keys():
+            lookup += settings.LOOKUP_FIELD_REPLACEMENTS[field_type]
+        return lookup
+
+    def validate_lookup(self) -> None:
+        """
+        checks the lookup field to see if it's a valid lookup field for the provider.
+        :return: NoneType
+        """
+        lookup = self.request.query_params.get("lookup")
+        if lookup is None:
+            return
+        lookup = lookup or settings.GLOBAL_LOOKUPS[0]
+        if lookup not in self.additional_lookup_fields:
+            raise BadRequest(
+                f"Invalid lookup field {lookup}. Valid fields are: {', '.join(self.additional_lookup_fields)}."
+            )
+
+    def get_object(self) -> Model | None:  # None if a 404 (obj not found)
+        self.validate_lookup()
+        queryset = self.get_queryset()
+
         q = Q()
-        raw = {lookup: [self.kwargs.get("lookup")]}
-        if lookup == "id":
-            if not raw[lookup][0].isdigit():
+        raw = {self.lookup_field: self.kwargs.get("lookup")}
+        if self.lookup_field == "id":
+            if not raw[self.lookup_field][0].isdigit():
                 raise BadRequest(
                     "ID must be an integer, if you want to use a different lookup, refer to the docs for the supported lookups."
                 )
-        filtered = False
-        for field in self.lookup_fields:
-            if field in raw:
-                if field in ("id", "pk") and raw[field][0] == "0":
-                    # ignore 0 pk
-                    continue
-                q |= Q(**{f"{field}__in": raw[field]})
-                filtered = True
-        if not filtered:
-            raise BadRequest("not enough filters")
+        if self.lookup_field in raw:
+            if (
+                self.lookup_field in ("id", "pk") and raw[self.lookup_field][0] == "0"
+            ):  # todo, check if needed
+                # ignore 0 pk
+                pass
+            q |= Q(**{self.lookup_field: raw[self.lookup_field]})
+        else:
+            raise BadRequest("Invalid filtering - Most likely a server error")
 
         obj = get_object_or_404(queryset, q)
         self.check_object_permissions(self.request, obj)
@@ -169,10 +206,8 @@ def dispatch(self, request, *args, **kwargs):
             self.initial(request, *args, **kwargs)
 
             # Get the appropriate handler method
-            if request.method.lower() in self.http_method_names:
-                handler = getattr(
-                    self, request.method.lower(), self.http_method_not_allowed
-                )
+            if (request_type := request.method.lower()) in self.http_method_names:
+                handler = getattr(self, request_type, self.http_method_not_allowed)
             else:
                 handler = self.http_method_not_allowed
 
@@ -225,8 +260,7 @@ def __convert_query_params__(self, query_params: QueryDict) -> List[Tuple]:
         for key, value in query_params.lists():
             if (
                 key
-                in ["limit", "offset", "search_type", "format"]
-                + self.provider.listing_filters_ignore
+                in settings.IGNORED_QUERY_PARAMS + self.provider.listing_filters_ignore
             ):
                 continue
             if key not in self.listing_filters:
@@ -277,9 +311,8 @@ def __compile_filters__(query_params: List) -> Dict:
 
             if isinstance(lookup_value, list) and len(lookup_value) > 1:
                 if isinstance(lookup_value[0], dict):
-                    filters[
-                        f"{lookup_filter}__{lookup_value['category']}__in"
-                    ] = (  # todo add option to use ID or spec field (fix option)
+                    filters[f"{lookup_filter}__{lookup_value['category']}__in"] = (
+                        # todo add option to use ID or specified field (fix option)
                         lookup_value["item"]
                         if not isinstance(lookup_value["item"], list)
                         else lookup_value["item"][0]

core/api/views/objects/organization.py

@@ -44,7 +44,7 @@ class OrganizationProvider(BaseProvider):
         "is_active": bool,
         "is_open": bool,
     }
-    lookup_fields = ["id", "slug"]
+    additional_lookup_fields = ["slug"]
 
     @property
     def permission_classes(self):

core/api/views/objects/user.py

@@ -178,7 +178,7 @@ def has_object_permission(self, request, view, user):
 
 class UserProvider(BaseProvider):
     model = User
-    lookup_fields = ["id", "username"]
+    additional_lookup_fields = ["username"]
 
     @property
     def permission_classes(self):

core/models/post.py

@@ -12,6 +12,7 @@
 from django.utils import timezone
 
 from .choices import announcement_status_choices
+
 # from ..api.utils.profanity import predict
 from ..utils.file_upload import file_upload_path_generator
 

core/models/user.py

@@ -3,6 +3,7 @@
 from django.core.exceptions import ObjectDoesNotExist
 from django.db import models
 from django.db.models import Q
+from django.db.models.functions import Lower
 from django.utils import timezone
 
 from .choices import graduating_year_choices, timezone_choices
@@ -101,3 +102,8 @@ def can_approve(self, obj):
     @classmethod
     def all(cls):
         return cls.objects.filter(is_active=True)
+
+    class Meta:
+        constraints = [
+            models.UniqueConstraint(Lower("username"), name="username-lower-check")
+        ]

core/templates/core/base.html

@@ -1,6 +1,7 @@
 {% extends 'base.html' %}
 {% load common_tags %}
 {% load settings_tags %}
+{% load banners %}
 {% load static %}
 
 {% block title %}{% block head_title %}{{ title }}{% endblock %} | Metropolis{% endblock %}
@@ -18,8 +19,8 @@
 
 {% settings_value "PRE" as pre %}
 {% if pre %}{{ pre | safe }}{% endif %}
-{% settings_value "BANNER3" as banner3 %}
-{% for value in banner3 %}
+{% banners "current" as current_banners %}
+{% for value in current_banners %}
     <div class="install-popup">
         {% if value.icon_url %}
             <img src="{{ value.icon_url }}" alt="Banner Icon">