bookwyrm/bookwyrm/models/author.py

""" database schema for info about authors """

import re
from typing import Tuple, Any

from django.db import models
from django.contrib.postgres.indexes import GinIndex
import pgtrigger

from bookwyrm import activitypub
from bookwyrm.settings import DOMAIN
from bookwyrm.utils.db import format_trigger

from .book import BookDataModel, MergedAuthor
from . import fields


class Author(BookDataModel):
    """basic biographic info"""

    merged_model = MergedAuthor

    wikipedia_link = fields.CharField(
        max_length=255, blank=True, null=True, deduplication_field=True
    )
    isni = fields.CharField(
        max_length=255, blank=True, null=True, deduplication_field=True
    )
    gutenberg_id = fields.CharField(
        max_length=255, blank=True, null=True, deduplication_field=True
    )
    isfdb = fields.CharField(
        max_length=255, blank=True, null=True, deduplication_field=True
    )

    website = fields.CharField(
        max_length=255, blank=True, null=True, deduplication_field=True
    )
    # idk probably other keys would be useful here?
    born = fields.DateTimeField(blank=True, null=True)
    died = fields.DateTimeField(blank=True, null=True)
    name = fields.CharField(max_length=255)
    aliases = fields.ArrayField(
        models.CharField(max_length=255), blank=True, default=list
    )
    bio = fields.HtmlField(null=True, blank=True)

    def save(self, *args: Tuple[Any, ...], **kwargs: dict[str, Any]) -> None:
        """normalize isni format"""
        if self.isni:
            self.isni = re.sub(r"\s", "", self.isni)

        return super().save(*args, **kwargs)

    @property
    def isni_link(self):
        """generate the url from the isni id"""
        clean_isni = re.sub(r"\s", "", self.isni)
        return f"https://isni.org/isni/{clean_isni}"

    @property
    def openlibrary_link(self):
        """generate the url from the openlibrary id"""
        return f"https://openlibrary.org/authors/{self.openlibrary_key}"

    @property
    def isfdb_link(self):
        """generate the url from the isni id"""
        return f"https://www.isfdb.org/cgi-bin/ea.cgi?{self.isfdb}"

    def get_remote_id(self):
        """editions and works both use "book" instead of model_name"""
        return f"https://{DOMAIN}/author/{self.id}"

    class Meta:
        """sets up indexes and triggers"""

        # pylint: disable=line-too-long

        indexes = (GinIndex(fields=["search_vector"]),)
        triggers = [
            pgtrigger.Trigger(
                name="update_search_vector_on_author_edit",
                when=pgtrigger.Before,
                operation=pgtrigger.Insert
                | pgtrigger.UpdateOf("name", "aliases", "search_vector"),
                func=format_trigger(
                    """new.search_vector :=
                    -- author name, with priority A
                    setweight(to_tsvector('simple', new.name), 'A') ||
                    -- author aliases, with priority B
                    setweight(to_tsvector('simple', coalesce(array_to_string(new.aliases, ' '), '')), 'B');
                    RETURN new;
                """
                ),
            ),
            pgtrigger.Trigger(
                name="reset_book_search_vector_on_author_edit",
                when=pgtrigger.After,
                operation=pgtrigger.UpdateOf("name", "aliases"),
                func=format_trigger(
                    """WITH updated_books AS (
                         SELECT book_id
                         FROM bookwyrm_book_authors
                         WHERE author_id = new.id
                    )
                    UPDATE bookwyrm_book
                    SET search_vector = ''
                    FROM updated_books
                    WHERE id = updated_books.book_id;
                    RETURN new;
                """
                ),
            ),
        ]

    activity_serializer = activitypub.Author