Catalogue: wikidata suggestions
[redakcja.git] / src / catalogue / models.py
index bb738a2..b974de1 100644 (file)
@@ -1,26 +1,45 @@
+from collections import Counter
 import decimal
 from django.apps import apps
 from django.db import models
 from django.urls import reverse
 from django.utils.translation import gettext_lazy as _
+from admin_ordering.models import OrderableModel
 from wikidata.client import Client
 from .constants import WIKIDATA
-from .utils import UnrelatedManager
-from .wikidata import WikidataMixin
+from .wikidata import WikidataModel
 
 
-class Author(WikidataMixin, models.Model):
+class Author(WikidataModel):
     slug = models.SlugField(max_length=255, null=True, blank=True, unique=True)
-    first_name = models.CharField(max_length=255, blank=True)
-    last_name = models.CharField(max_length=255, blank=True)
-
-    name_de = models.CharField(max_length=255, blank=True)
-    name_lt = models.CharField(max_length=255, blank=True)
-
-    gender = models.CharField(max_length=255, blank=True)
-    nationality = models.CharField(max_length=255, blank=True)
-    year_of_death = models.SmallIntegerField(null=True, blank=True)
+    first_name = models.CharField(_("first name"), max_length=255, blank=True)
+    last_name = models.CharField(_("last name"), max_length=255, blank=True)
+
+    name_de = models.CharField(_("name (de)"), max_length=255, blank=True)
+    name_lt = models.CharField(_("name (lt)"), max_length=255, blank=True)
+
+    gender = models.CharField(_("gender"), max_length=255, blank=True)
+    nationality = models.CharField(_("nationality"), max_length=255, blank=True)
+    year_of_birth = models.SmallIntegerField(_("year of birth"), null=True, blank=True)
+    year_of_birth_inexact = models.BooleanField(_("inexact"), default=False)
+    year_of_birth_range = models.SmallIntegerField(_("year of birth, range end"), null=True, blank=True)
+    date_of_birth = models.DateField(_("date_of_birth"), null=True, blank=True)
+    place_of_birth = models.ForeignKey(
+        'Place', models.PROTECT, null=True, blank=True,
+        verbose_name=_('place of birth'),
+        related_name='authors_born'
+    )
+    year_of_death = models.SmallIntegerField(_("year of death"), null=True, blank=True)
+    year_of_death_inexact = models.BooleanField(_("inexact"), default=False)
+    year_of_death_range = models.SmallIntegerField(_("year of death, range end"), null=True, blank=True)
+    date_of_death = models.DateField(_("date_of_death"), null=True, blank=True)
+    place_of_death = models.ForeignKey(
+        'Place', models.PROTECT, null=True, blank=True,
+        verbose_name=_('place of death'),
+        related_name='authors_died'
+    )
     status = models.PositiveSmallIntegerField(
+        _("status"), 
         null=True,
         blank=True,
         choices=[
@@ -30,18 +49,17 @@ class Author(WikidataMixin, models.Model):
             (4, _("Unknown")),
         ],
     )
-    notes = models.TextField(blank=True)
-    gazeta_link = models.CharField(max_length=255, blank=True)
-    culturepl_link = models.CharField(max_length=255, blank=True)
+    notes = models.TextField(_("notes"), blank=True)
+    gazeta_link = models.CharField(_("gazeta link"), max_length=255, blank=True)
+    culturepl_link = models.CharField(_("culture.pl link"), max_length=255, blank=True)
 
-    description = models.TextField(blank=True)
-    description_de = models.TextField(blank=True)
-    description_lt = models.TextField(blank=True)
+    description = models.TextField(_("description"), blank=True)
 
     priority = models.PositiveSmallIntegerField(
+        _("priority"), 
         default=0, choices=[(0, _("Low")), (1, _("Medium")), (2, _("High"))]
     )
-    collections = models.ManyToManyField("Collection", blank=True)
+    collections = models.ManyToManyField("Collection", blank=True, verbose_name=_("collections"))
 
     class Meta:
         verbose_name = _('author')
@@ -51,16 +69,32 @@ class Author(WikidataMixin, models.Model):
     class Wikidata:
         first_name = WIKIDATA.GIVEN_NAME
         last_name = WIKIDATA.LAST_NAME
+        date_of_birth = WIKIDATA.DATE_OF_BIRTH
+        year_of_birth = WIKIDATA.DATE_OF_BIRTH
+        place_of_birth = WIKIDATA.PLACE_OF_BIRTH
+        date_of_death = WIKIDATA.DATE_OF_DEATH
         year_of_death = WIKIDATA.DATE_OF_DEATH
+        place_of_death = WIKIDATA.PLACE_OF_DEATH
         gender = WIKIDATA.GENDER
         notes = "description"
 
+        def _supplement(obj):
+            if not obj.first_name and not obj.last_name:
+                yield 'first_name', 'label'
+
     def __str__(self):
-        return f"{self.first_name} {self.last_name}"
+        name = f"{self.first_name} {self.last_name}"
+        if self.year_of_death is not None:
+            name += f' (zm. {self.year_of_death})'
+        return name
 
     def get_absolute_url(self):
         return reverse("catalogue_author", args=[self.slug])
 
+    @property
+    def name(self):
+        return f"{self.last_name}, {self.first_name}"
+    
     @property
     def pd_year(self):
         if self.year_of_death:
@@ -71,8 +105,13 @@ class Author(WikidataMixin, models.Model):
             return None
 
 
-class Category(WikidataMixin, models.Model):
-    name = models.CharField(max_length=255)
+class NotableBook(OrderableModel):
+    author = models.ForeignKey(Author, models.CASCADE)
+    book = models.ForeignKey('Book', models.CASCADE)
+
+
+class Category(WikidataModel):
+    name = models.CharField(_("name"), max_length=255)
     slug = models.SlugField(max_length=255, unique=True)
 
     class Meta:
@@ -99,38 +138,42 @@ class Kind(Category):
         verbose_name_plural = _('kinds')
 
 
-class Book(WikidataMixin, models.Model):
+class Book(WikidataModel):
     slug = models.SlugField(max_length=255, blank=True, null=True, unique=True)
-    authors = models.ManyToManyField(Author, blank=True)
+    authors = models.ManyToManyField(Author, blank=True, verbose_name=_("authors"))
     translators = models.ManyToManyField(
         Author,
         related_name="translated_book_set",
         related_query_name="translated_book",
         blank=True,
+        verbose_name=_("translators")
     )
-    epochs = models.ManyToManyField(Epoch, blank=True)
-    kinds = models.ManyToManyField(Kind, blank=True)
-    genres = models.ManyToManyField(Genre, blank=True)
-    title = models.CharField(max_length=255, blank=True)
-    language = models.CharField(max_length=255, blank=True)
+    epochs = models.ManyToManyField(Epoch, blank=True, verbose_name=_("epochs"))
+    kinds = models.ManyToManyField(Kind, blank=True, verbose_name=_("kinds"))
+    genres = models.ManyToManyField(Genre, blank=True, verbose_name=_("genres"))
+    title = models.CharField(_("title"), max_length=255, blank=True)
+    language = models.CharField(_("language"), max_length=255, blank=True)
     based_on = models.ForeignKey(
-        "self", models.PROTECT, related_name="translation", null=True, blank=True
+        "self", models.PROTECT, related_name="translation", null=True, blank=True,
+        verbose_name=_("based on")
     )
-    scans_source = models.CharField(max_length=255, blank=True)
-    text_source = models.CharField(max_length=255, blank=True)
-    notes = models.TextField(blank=True)
+    scans_source = models.CharField(_("scans source"), max_length=255, blank=True)
+    text_source = models.CharField(_("text source"), max_length=255, blank=True)
+    notes = models.TextField(_("notes"), blank=True)
     priority = models.PositiveSmallIntegerField(
+        _("priority"),
         default=0, choices=[(0, _("Low")), (1, _("Medium")), (2, _("High"))]
     )
-    pd_year = models.IntegerField(null=True, blank=True)
-    gazeta_link = models.CharField(max_length=255, blank=True)
-    collections = models.ManyToManyField("Collection", blank=True)
+    pd_year = models.IntegerField(_('year of entry into PD'), null=True, blank=True)
+    gazeta_link = models.CharField(_("gazeta link"), max_length=255, blank=True)
+    collections = models.ManyToManyField("Collection", blank=True, verbose_name=_("collections"))
 
-    estimated_chars = models.IntegerField(null=True, blank=True)
-    estimated_verses = models.IntegerField(null=True, blank=True)
-    estimate_source = models.CharField(max_length=2048, blank=True)
+    estimated_chars = models.IntegerField(_("estimated number of characters"), null=True, blank=True)
+    estimated_verses = models.IntegerField(_("estimated number of verses"), null=True, blank=True)
+    estimate_source = models.CharField(_("source of estimates"), max_length=2048, blank=True)
 
-    objects = UnrelatedManager()
+    free_license = models.BooleanField(_('free license'), default=False)
+    polona_missing = models.BooleanField(_('missing on Polona'), default=False)
 
     class Meta:
         ordering = ("title",)
@@ -149,50 +192,94 @@ class Book(WikidataMixin, models.Model):
         txt = self.title
         astr = self.authors_str()
         if astr:
-            txt = f"{astr} – {txt}"
+            txt = f"{txt}, {astr}"
         tstr = self.translators_str()
         if tstr:
-            txt = f"{txt} (tłum. {tstr})"
+            txt = f"{txt}, tłum. {tstr}"
         return txt
 
     def get_absolute_url(self):
         return reverse("catalogue_book", args=[self.slug])
+
+    @property
+    def wluri(self):
+        return f'https://wolnelektury.pl/katalog/lektura/{self.slug}/'
     
     def authors_str(self):
         return ", ".join(str(author) for author in self.authors.all())
+    authors_str.admin_order_field = 'authors__last_name'
+    authors_str.short_description = _('Author')
 
     def translators_str(self):
         return ", ".join(str(author) for author in self.translators.all())
+    translators_str.admin_order_field = 'translators__last_name'
+    translators_str.short_description = _('Translator')
 
-    def get_document_books(self):
-        DBook = apps.get_model("documents", "Book")
-        return DBook.objects.filter(dc_slug=self.slug)
-
-    def estimated_costs(self):
-        return "\n".join(
-            "{}: {} zł".format(
-                work_type.name,
-                work_type.calculate(self) or '—'
-            )
+    def get_estimated_costs(self):
+        return {
+            work_type: work_type.calculate(self)
             for work_type in WorkType.objects.all()
-        )
+        }
+
+
+class CollectionCategory(models.Model):
+    name = models.CharField(_("name"), max_length=255)
+    parent = models.ForeignKey('self', models.SET_NULL, related_name='children', null=True, blank=True, verbose_name=_("parent"))
+    notes = models.TextField(_("notes"), blank=True)
+
+    class Meta:
+        ordering = ('parent__name', 'name')
+        verbose_name = _('collection category')
+        verbose_name_plural = _('collection categories')
+
+    def __str__(self):
+        if self.parent:
+            return f"{self.parent} / {self.name}"
+        else:
+            return self.name
 
 
 class Collection(models.Model):
-    name = models.CharField(max_length=255)
+    name = models.CharField(_("name"), max_length=255)
     slug = models.SlugField(max_length=255, unique=True)
+    category = models.ForeignKey(CollectionCategory, models.SET_NULL, null=True, blank=True, verbose_name=_("category"))
+    notes = models.TextField(_("notes"), blank=True)
 
     class Meta:
+        ordering = ('category', 'name')
         verbose_name = _('collection')
         verbose_name_plural = _('collections')
 
     def __str__(self):
-        return self.name
+        if self.category:
+            return f"{self.category} / {self.name}"
+        else:
+            return self.name
+
+    def get_estimated_costs(self):
+        costs = Counter()
+        for book in self.book_set.all():
+            for k, v in book.get_estimated_costs().items():
+                costs[k] += v or 0
+
+        for author in self.author_set.all():
+            for book in author.book_set.all():
+                for k, v in book.get_estimated_costs().items():
+                    costs[k] += v or 0
+            for book in author.translated_book_set.all():
+                for k, v in book.get_estimated_costs().items():
+                    costs[k] += v or 0
+        return costs
 
 
 class WorkType(models.Model):
-    name = models.CharField(max_length=255)
+    name = models.CharField(_("name"), max_length=255)
 
+    class Meta:
+        ordering = ('name',)
+        verbose_name = _('work type')
+        verbose_name_plural = _('work types')
+    
     def get_rate_for(self, book):
         for workrate in self.workrate_set.all():
             if workrate.matches(book):
@@ -206,17 +293,19 @@ class WorkType(models.Model):
 
 
 class WorkRate(models.Model):
-    priority = models.IntegerField(default=1)
-    per_normpage = models.DecimalField(decimal_places=2, max_digits=6, null=True, blank=True)
-    per_verse = models.DecimalField(decimal_places=2, max_digits=6, null=True, blank=True)
-    work_type = models.ForeignKey(WorkType, models.CASCADE)
-    epochs = models.ManyToManyField(Epoch, blank=True)
-    kinds = models.ManyToManyField(Kind, blank=True)
-    genres = models.ManyToManyField(Genre, blank=True)
-    collections = models.ManyToManyField(Collection, blank=True)
+    priority = models.IntegerField(_("priority"), default=1)
+    per_normpage = models.DecimalField(_("per normalized page"), decimal_places=2, max_digits=6, null=True, blank=True)
+    per_verse = models.DecimalField(_("per verse"), decimal_places=2, max_digits=6, null=True, blank=True)
+    work_type = models.ForeignKey(WorkType, models.CASCADE, verbose_name=_("work type"))
+    epochs = models.ManyToManyField(Epoch, blank=True, verbose_name=_("epochs"))
+    kinds = models.ManyToManyField(Kind, blank=True, verbose_name=_("kinds"))
+    genres = models.ManyToManyField(Genre, blank=True, verbose_name=_("genres"))
+    collections = models.ManyToManyField(Collection, blank=True, verbose_name=_("collections"))
 
     class Meta:
         ordering = ('priority',)
+        verbose_name = _('work rate')
+        verbose_name_plural = _('work rates')
 
     def matches(self, book):
         for category in 'epochs', 'kinds', 'genres', 'collections':
@@ -235,3 +324,17 @@ class WorkRate(models.Model):
             if book.estimated_chars:
                 return (decimal.Decimal(book.estimated_chars) / 1800 * self.per_normpage).quantize(decimal.Decimal('1.00'), rounding=decimal.ROUND_HALF_UP)
 
+
+class Place(WikidataModel):
+    name = models.CharField(_('name'), max_length=255, blank=True)
+    locative = models.CharField(_('locative'), max_length=255, blank=True, help_text=_('in…'))
+
+    class Meta:
+        verbose_name = _('place')
+        verbose_name_plural = _('places')
+    
+    class Wikidata:
+        name = 'label'
+
+    def __str__(self):
+        return self.name