Merge branch 'main' into fix_327

2 files changed, 98 insertions, 0 deletions

diff --git a/pydis_site/apps/content/views/__init__.py b/pydis_site/apps/content/views/__init__.py
new file mode 100644
index 00000000..70ea1c7a
--- /dev/null
+++ b/pydis_site/apps/content/views/__init__.py
@@ -0,0 +1,3 @@
+from .page_category import PageOrCategoryView
+
+__all__ = ["PageOrCategoryView"]
diff --git a/pydis_site/apps/content/views/page_category.py b/pydis_site/apps/content/views/page_category.py
new file mode 100644
index 00000000..5af77aff
--- /dev/null
+++ b/pydis_site/apps/content/views/page_category.py
@@ -0,0 +1,95 @@
+import typing as t
+from pathlib import Path
+
+import frontmatter
+from django.conf import settings
+from django.http import Http404
+from django.views.generic import TemplateView
+
+from pydis_site.apps.content import utils
+
+
+class PageOrCategoryView(TemplateView):
+    """Handles pages and page categories."""
+
+    def dispatch(self, request: t.Any, *args, **kwargs) -> t.Any:
+        """Conform URL path location to the filesystem path."""
+        self.location = Path(kwargs.get("location", ""))
+
+        # URL location on the filesystem
+        self.full_location = settings.CONTENT_PAGES_PATH / self.location
+
+        # Possible places to find page content information
+        self.category_path = self.full_location
+        self.page_path = self.full_location.with_suffix(".md")
+
+        return super().dispatch(request, *args, **kwargs)
+
+    def get_template_names(self) -> t.List[str]:
+        """Checks if the view uses the page template or listing template."""
+        if self.page_path.is_file():
+            template_name = "content/page.html"
+        elif self.category_path.is_dir():
+            template_name = "content/listing.html"
+        else:
+            raise Http404
+
+        return [template_name]
+
+    def get_context_data(self, **kwargs) -> t.Dict[str, t.Any]:
+        """Assign proper context variables based on what resource user requests."""
+        context = super().get_context_data(**kwargs)
+
+        if self.page_path.is_file():
+            context.update(self._get_page_context(self.page_path))
+        elif self.category_path.is_dir():
+            context.update(self._get_category_context(self.category_path))
+            context["path"] = f"{self.location}/"  # Add trailing slash to simplify template
+        else:
+            raise Http404
+
+        # Add subarticle information for dropdown menu if the page is also a category
+        if self.page_path.is_file() and self.category_path.is_dir():
+            context["subarticles"] = []
+            for entry in self.category_path.iterdir():
+                entry_info = {"path": entry.stem}
+                if entry.suffix == ".md" and not entry.with_suffix("").is_dir():
+                    entry_info["name"] = frontmatter.load(entry).metadata["title"]
+                elif entry.is_dir():
+                    entry_info["name"] = utils.get_category(entry)["title"]
+                else:  # pragma: no cover
+                    # TODO: Remove coverage.py pragma in Python 3.10
+                    # See: https://github.com/nedbat/coveragepy/issues/198
+                    continue
+                context["subarticles"].append(entry_info)
+
+        context["breadcrumb_items"] = [
+            {
+                "name": utils.get_category(settings.CONTENT_PAGES_PATH / location)["title"],
+                "path": str(location)
+            } for location in reversed(self.location.parents)
+        ]
+
+        return context
+
+    @staticmethod
+    def _get_page_context(path: Path) -> t.Dict[str, t.Any]:
+        page, metadata = utils.get_page(path)
+        return {
+            "page": page,
+            "page_title": metadata["title"],
+            "page_description": metadata["description"],
+            "relevant_links": metadata.get("relevant_links", {}),
+            "toc": metadata.get("toc")
+        }
+
+    @staticmethod
+    def _get_category_context(path: Path) -> t.Dict[str, t.Any]:
+        category = utils.get_category(path)
+        return {
+            "categories": utils.get_categories(path),
+            "pages": utils.get_category_pages(path),
+            "page_title": category["title"],
+            "page_description": category["description"],
+            "icon": category.get("icon"),
+        }