Source code for betty.extension.cotton_candy

"""
Provide Betty's default theme.
"""

from __future__ import annotations

from collections import defaultdict
from pathlib import Path
from typing import Iterable, cast, TYPE_CHECKING, final

from jinja2 import pass_context
from typing_extensions import override

from betty import fs
from betty.ancestry import (
    Event,
    Person,
    Presence,
    is_public,
    HasFileReferences,
    Place,
    FileReference,
)
from betty.ancestry.event_type import StartOfLifeEventType, EndOfLifeEventType
from betty.ancestry.presence_role import Subject
from betty.extension.cotton_candy.config import CottonCandyConfiguration
from betty.extension.cotton_candy.search import Index
from betty.extension.maps import Maps
from betty.extension.trees import Trees
from betty.extension.webpack import Webpack, WebpackEntryPointProvider
from betty.functools import Uniquifier
from betty.generate import GenerateSiteEvent
from betty.html import CssProvider
from betty.jinja2 import (
    Jinja2Provider,
    context_project,
    context_localizer,
    context_job_context,
    Globals,
    Filters,
)
from betty.locale.date import Date, Datey
from betty.locale.localizable import _, static, Localizable
from betty.model import GeneratedEntityId
from betty.os import link_or_copy
from betty.project.extension import ConfigurableExtension, Theme, Extension

if TYPE_CHECKING:
    from betty.plugin import PluginIdentifier
    from betty.event_dispatcher import EventHandlerRegistry
    from betty.machine_name import MachineName
    from jinja2.runtime import Context
    from collections.abc import Sequence, AsyncIterable, Mapping


async def _generate_favicon(event: GenerateSiteEvent) -> None:
    cotton_candy = event.project.extensions[CottonCandy]
    await link_or_copy(
        cotton_candy.logo, event.project.configuration.www_directory_path / "logo.png"
    )


[docs] @final class CottonCandy( Theme, CssProvider, ConfigurableExtension[CottonCandyConfiguration], Jinja2Provider, WebpackEntryPointProvider, ): """ Provide Betty's default front-end theme. """
[docs] @override @classmethod def plugin_id(cls) -> MachineName: return "cotton-candy"
[docs] @override def register_event_handlers(self, registry: EventHandlerRegistry) -> None: registry.add_handler(GenerateSiteEvent, _generate_favicon)
[docs] @override @classmethod def depends_on(cls) -> set[PluginIdentifier[Extension]]: return {Webpack}
[docs] @override @classmethod def comes_after(cls) -> set[PluginIdentifier[Extension]]: return {Maps, Trees}
[docs] @override @classmethod def assets_directory_path(cls) -> Path: return Path(__file__).parent / "assets"
[docs] @override @classmethod def webpack_entry_point_directory_path(cls) -> Path: return Path(__file__).parent / "webpack"
[docs] @override def webpack_entry_point_cache_keys(self) -> Sequence[str]: return ( self.project.configuration.root_path, self._configuration.primary_inactive_color.hex, self._configuration.primary_active_color.hex, self._configuration.link_inactive_color.hex, self._configuration.link_active_color.hex, )
@override @property def public_css_paths(self) -> Sequence[str]: return [ self.project.static_url_generator.generate("/css/cotton-candy.css"), ]
[docs] @override @classmethod def plugin_label(cls) -> Localizable: return static("Cotton Candy")
[docs] @override @classmethod def default_configuration(cls) -> CottonCandyConfiguration: return CottonCandyConfiguration()
[docs] @override @classmethod def plugin_description(cls) -> Localizable: return _("Cotton Candy is Betty's default theme.")
@property def logo(self) -> Path: """ The path to the logo file. """ return ( self._configuration.logo or fs.ASSETS_DIRECTORY_PATH / "public" / "static" / "betty-512x512.png" ) @override @property def globals(self) -> Globals: return { "search_index": _global_search_index, } @override @property def filters(self) -> Filters: return { "person_timeline_events": lambda person: person_timeline_events( person, self.project.configuration.lifetime_threshold ), "person_descendant_families": person_descendant_families, "associated_file_references": associated_file_references, }
@pass_context async def _global_search_index(context: Context) -> AsyncIterable[Mapping[str, str]]: return Index( context_project(context), context_job_context(context), context_localizer(context), ).build() def _is_person_timeline_presence(presence: Presence) -> bool: if presence.private: return False if not presence.event: return False if not presence.event.date: return False if not presence.event.date.comparable: return False return True
[docs] def person_timeline_events(person: Person, lifetime_threshold: int) -> Iterable[Event]: """ Gather all events for a person's timeline. """ yield from Uniquifier(_person_timeline_events(person, lifetime_threshold))
[docs] def person_descendant_families( person: Person, ) -> Iterable[tuple[Sequence[Person], Sequence[Person]]]: """ Gather a person's families they are a parent in. """ parents = {} children = defaultdict(set) for child in person.children: family = tuple(sorted((parent.id for parent in child.parents))) if family not in parents: parents[family] = tuple(child.parents) children[family].add(child) yield from zip(parents.values(), children.values())
[docs] def associated_file_references( has_file_references: HasFileReferences, ) -> Iterable[FileReference]: """ Get the associated file references for an entity that has file references. """ yield from Uniquifier( _associated_file_references(has_file_references), key=lambda file_reference: file_reference.file, )
def _associated_file_references( has_file_references: HasFileReferences, ) -> Iterable[FileReference]: yield from has_file_references.file_references if isinstance(has_file_references, Event): for citation in has_file_references.citations: yield from _associated_file_references(citation) if isinstance(has_file_references, Person): for name in has_file_references.names: for citation in name.citations: yield from _associated_file_references(citation) for presence in has_file_references.presences: if presence.event is not None: yield from _associated_file_references(presence.event) if isinstance(has_file_references, Place): for event in has_file_references.events: yield from _associated_file_references(event) def _person_timeline_events(person: Person, lifetime_threshold: int) -> Iterable[Event]: # Collect all associated events for a person. # Start with the person's own events for which their presence is public. for presence in person.presences: if _is_person_timeline_presence(presence): assert presence.event is not None yield presence.event continue # If the person has start- or end-of-life events, we use those to constrain associated people's events. start_dates = [] end_dates = [] for presence in person.presences: if not _is_person_timeline_presence(presence): continue assert presence.event is not None assert presence.event.date is not None if not isinstance(presence.role, Subject): continue if isinstance(presence.event.event_type, StartOfLifeEventType): start_dates.append(presence.event.date) if isinstance(presence.event.event_type, EndOfLifeEventType): end_dates.append(presence.event.date) start_date = sorted(start_dates)[0] if start_dates else None end_date = sorted(end_dates)[0] if end_dates else None # If an end-of-life event exists, but no start-of-life event, create a start-of-life date based on the end date, # minus the lifetime threshold. if start_date is None and end_date is not None: if isinstance(end_date, Date): start_date_reference = end_date else: if end_date.end is not None and end_date.end.comparable: start_date_reference = end_date.end else: assert end_date.start is not None start_date_reference = end_date.start assert start_date_reference.year is not None start_date = Date( start_date_reference.year - lifetime_threshold, start_date_reference.month, start_date_reference.day, start_date_reference.fuzzy, ) # If a start-of-life event exists, but no end-of-life event, create an end-of-life date based on the start date, # plus the lifetime threshold. if end_date is None and start_date is not None: if isinstance(start_date, Date): end_date_reference = start_date else: if start_date.start and start_date.start.comparable: end_date_reference = start_date.start else: assert start_date.end is not None end_date_reference = start_date.end assert end_date_reference.year is not None end_date = Date( end_date_reference.year + lifetime_threshold, end_date_reference.month, end_date_reference.day, end_date_reference.fuzzy, ) if start_date is None or end_date is None: reference_dates = sorted( cast(Datey, cast(Event, presence.event).date) for presence in person.presences if _is_person_timeline_presence(presence) ) if reference_dates: if not start_date: start_date = reference_dates[0] if not end_date: end_date = reference_dates[-1] if start_date is not None and end_date is not None: associated_people = filter( is_public, ( # All ancestors. *person.ancestors, # All descendants. *person.descendants, # All siblings. *person.siblings, ), ) for associated_person in associated_people: # For associated events, we are only interested in people's start- or end-of-life events. for associated_presence in associated_person.presences: if not associated_presence.event or not isinstance( associated_presence.event.event_type, (StartOfLifeEventType, EndOfLifeEventType), ): continue if isinstance(associated_presence.event.id, GeneratedEntityId): continue if not isinstance(associated_presence.role, Subject): continue if not _is_person_timeline_presence(associated_presence): continue if not associated_presence.event.date: continue if associated_presence.event.date < start_date: continue if associated_presence.event.date > end_date: continue yield associated_presence.event