vtt/src/ttfrog/schema.py

from grung.types import BackReference, Collection, Field, Record, Pointer


class Page(Record):
    """
    A page in the wiki. Just about everything in the databse is either a Page or a subclass of a Page.
    """

    @classmethod
    def fields(cls):
        return [
            *super().fields(),                         # Pick up the UID and whatever other non-optional fields exist
            Field("uri", unique=True),                 # The URI for the page, relative to the app's VIEW_URI
            Field("name"),                             # The portion of the URI after the last /
            Field("title"),                            # The page title
            Field("body"),                             # The main content blob of the page
            Collection("members", Page),               # The pages that exist below this page's URI
            BackReference("parent", value_type=Page),  # The page that exists above this page's URI
            Pointer("author", value_type=User),        # The last user to touch the page.
            # DateTime("last_modified"),                 # The last time the page was modified.
        ]

    def before_insert(self, db):
        """
        Make the following adjustments before saving this record:
          * Derive the name from the title, or the title from the name
          * Derive the URI from the hierarchy of the parent.
        """
        super().before_insert(db)

        if not self.name and not self.title:
            raise Exception("Must provide either a name or a title!")
        if not self.name:
            self.name = self.title.title().replace(" ", "")
        if not self.title:
            self.title = self.name

        self.uri = (self.parent.uri + "/" if self.parent and self.parent.uri != "/" else "") + self.name

    def after_insert(self, db):
        """
        After saving this record, ensure that any page in the members collection is updated with the
        correct URI. This ensures that if a page is moved from one collection to another, the URI is updated.
        """
        super().after_insert(db)
        if not hasattr(self, 'members'):
            return
        for child in self.members:
            obj = BackReference.dereference(child, db)
            obj.uri = f"{self.uri}/{obj.name}"
            child = db.save(obj)

    def get_child(self, obj: Record):
        for page in self.members:
            if page.uid == obj.uid:
                return page
        return None


class User(Page):
    """
    A website user, editable as a wiki page.
    """

    @classmethod
    def fields(cls):
        return [
            field
            for field in [
                *super().fields(),
                Field("email", unique=True)
            ] if field.name != "members"
        ]


class Group(Page):
    """
    A set of users, editable as a wiki page.
    """


class NPC(Page):
    """
    An NPC, editable as a wiki page.
    """