open-law/app/controllers/breadcrumbs.py

from flask import url_for
from flask_login import current_user

from app import models as m, db, schema as s


def create_collections_breadcrumb(
    bread_crumbs: list[s.BreadCrumb], collection: m.Collection
) -> list[s.BreadCrumb]:
    bread_crumbs += [
        s.BreadCrumb(
            type=s.BreadCrumbType.Collection,
            url=url_for("book.collection_view", book_id=collection.book_id)
            + f"#collection-{collection.label}",
            label=collection.label,
        )
    ]

    if collection.parent and not collection.parent.is_root:
        create_collections_breadcrumb(bread_crumbs, collection.parent)


def create_breadcrumbs(
    book_id: int, section_id: int = 0, collection_id: int = 0, short=True
) -> list[s.BreadCrumb]:
    """
    How breadcrumbs look like:

    Book List -> Book Name -> Top Level Collection -> SubCollection -> Section -> Interpretation

    - If i am not owner of a book
    John's books -> Book Name -> Top Level Collection -> SubCollection -> Section -> Interpretation

    - If i am owner
    My Books -> Book Title -> Part I -> Chapter X -> Paragraph 1.7 -> By John
    """

    crumples: list[s.BreadCrumb] = []
    book: m.Book = db.session.get(m.Book, book_id)
    if current_user.is_authenticated and book.user_id == current_user.id:
        # My Book
        crumples += [
            s.BreadCrumb(
                type=s.BreadCrumbType.MyBookList,
                url=url_for("user.profile", user_id=current_user.id),
                label="Me",
            )
        ]
    else:
        # Not mine book
        crumples += [
            s.BreadCrumb(
                type=s.BreadCrumbType.AuthorBookList,
                url=url_for("user.profile", user_id=book.owner.id),
                label=book.owner.username,
            )
        ]

    crumples += [
        s.BreadCrumb(
            type=s.BreadCrumbType.Collection,
            url=url_for("book.collection_view", book_id=book_id),
            label=book.label,
        )
    ]

    section: m.Section = None
    if section_id:
        section: m.Section = db.session.get(m.Section, section_id)

    if collection_id and not section:
        collections_crumbs = []
        collection: m.Collection = db.session.get(m.Collection, collection_id)
        if not collection.is_root:
            create_collections_breadcrumb(collections_crumbs, collection)
            collections_crumbs.reverse()
            crumples += collections_crumbs

    if section:
        collections_crumbs = []
        collection: m.Collection = db.session.get(m.Collection, section.collection_id)
        if not collection.is_root:
            create_collections_breadcrumb(collections_crumbs, collection)
            collections_crumbs.reverse()
            crumples += collections_crumbs

        crumples += [
            s.BreadCrumb(
                type=s.BreadCrumbType.Section,
                url=url_for(
                    "book.interpretation_view",
                    book_id=book_id,
                    section_id=section_id,
                ),
                label=section.label,
            )
        ]

    if short and len(crumples) > 5:
        crumples = (
            crumples[:3]
            + [s.BreadCrumb(type=s.BreadCrumbType.Splitter, url="", label="...")]
            + crumples[-2:]
        )

    return crumples