src/catalogue/models.py

   1 from collections import Counter
   2 import decimal
   3 from django.apps import apps
   4 from django.db import models
   5 from django.urls import reverse
   6 from django.utils.translation import gettext_lazy as _
   7 from wikidata.client import Client
   8 from .constants import WIKIDATA
   9 from .wikidata import WikidataMixin
  10
  11
  12 class Author(WikidataMixin, models.Model):
  13     slug = models.SlugField(max_length=255, null=True, blank=True, unique=True)
  14     first_name = models.CharField(_("first name"), max_length=255, blank=True)
  15     last_name = models.CharField(_("last name"), max_length=255, blank=True)
  16
  17     name_de = models.CharField(_("name (de)"), max_length=255, blank=True)
  18     name_lt = models.CharField(_("name (lt)"), max_length=255, blank=True)
  19
  20     gender = models.CharField(_("gender"), max_length=255, blank=True)
  21     nationality = models.CharField(_("nationality"), max_length=255, blank=True)
  22     year_of_death = models.SmallIntegerField(_("year of death"), null=True, blank=True)
  23     status = models.PositiveSmallIntegerField(
  24         _("status"),
  25         null=True,
  26         blank=True,
  27         choices=[
  28             (1, _("Alive")),
  29             (2, _("Dead")),
  30             (3, _("Long dead")),
  31             (4, _("Unknown")),
  32         ],
  33     )
  34     notes = models.TextField(_("notes"), blank=True)
  35     gazeta_link = models.CharField(_("gazeta link"), max_length=255, blank=True)
  36     culturepl_link = models.CharField(_("culture.pl link"), max_length=255, blank=True)
  37
  38     description = models.TextField(_("description"), blank=True)
  39     description_de = models.TextField(_("description (de)"), blank=True)
  40     description_lt = models.TextField(_("description (lt)"), blank=True)
  41
  42     priority = models.PositiveSmallIntegerField(
  43         _("priority"),
  44         default=0, choices=[(0, _("Low")), (1, _("Medium")), (2, _("High"))]
  45     )
  46     collections = models.ManyToManyField("Collection", blank=True, verbose_name=_("collections"))
  47
  48     class Meta:
  49         verbose_name = _('author')
  50         verbose_name_plural = _('authors')
  51         ordering = ("last_name", "first_name", "year_of_death")
  52
  53     class Wikidata:
  54         first_name = WIKIDATA.GIVEN_NAME
  55         last_name = WIKIDATA.LAST_NAME
  56         year_of_death = WIKIDATA.DATE_OF_DEATH
  57         gender = WIKIDATA.GENDER
  58         notes = "description"
  59
  60     def __str__(self):
  61         return f"{self.first_name} {self.last_name}"
  62
  63     def get_absolute_url(self):
  64         return reverse("catalogue_author", args=[self.slug])
  65
  66     @property
  67     def pd_year(self):
  68         if self.year_of_death:
  69             return self.year_of_death + 71
  70         elif self.year_of_death == 0:
  71             return 0
  72         else:
  73             return None
  74
  75
  76 class Category(WikidataMixin, models.Model):
  77     name = models.CharField(_("name"), max_length=255)
  78     slug = models.SlugField(max_length=255, unique=True)
  79
  80     class Meta:
  81         abstract = True
  82
  83     def __str__(self):
  84         return self.name
  85
  86 class Epoch(Category):
  87     class Meta:
  88         verbose_name = _('epoch')
  89         verbose_name_plural = _('epochs')
  90
  91
  92 class Genre(Category):
  93     class Meta:
  94         verbose_name = _('genre')
  95         verbose_name_plural = _('genres')
  96
  97
  98 class Kind(Category):
  99     class Meta:
 100         verbose_name = _('kind')
 101         verbose_name_plural = _('kinds')
 102
 103
 104 class Book(WikidataMixin, models.Model):
 105     slug = models.SlugField(max_length=255, blank=True, null=True, unique=True)
 106     authors = models.ManyToManyField(Author, blank=True, verbose_name=_("authors"))
 107     translators = models.ManyToManyField(
 108         Author,
 109         related_name="translated_book_set",
 110         related_query_name="translated_book",
 111         blank=True,
 112         verbose_name=_("translators")
 113     )
 114     epochs = models.ManyToManyField(Epoch, blank=True, verbose_name=_("epochs"))
 115     kinds = models.ManyToManyField(Kind, blank=True, verbose_name=_("kinds"))
 116     genres = models.ManyToManyField(Genre, blank=True, verbose_name=_("genres"))
 117     title = models.CharField(_("title"), max_length=255, blank=True)
 118     language = models.CharField(_("language"), max_length=255, blank=True)
 119     based_on = models.ForeignKey(
 120         "self", models.PROTECT, related_name="translation", null=True, blank=True,
 121         verbose_name=_("based on")
 122     )
 123     scans_source = models.CharField(_("scans source"), max_length=255, blank=True)
 124     text_source = models.CharField(_("text source"), max_length=255, blank=True)
 125     notes = models.TextField(_("notes"), blank=True)
 126     priority = models.PositiveSmallIntegerField(
 127         _("priority"),
 128         default=0, choices=[(0, _("Low")), (1, _("Medium")), (2, _("High"))]
 129     )
 130     pd_year = models.IntegerField(_('year of entry into PD'), null=True, blank=True)
 131     gazeta_link = models.CharField(_("gazeta link"), max_length=255, blank=True)
 132     collections = models.ManyToManyField("Collection", blank=True, verbose_name=_("collections"))
 133
 134     estimated_chars = models.IntegerField(_("estimated number of characters"), null=True, blank=True)
 135     estimated_verses = models.IntegerField(_("estimated number of verses"), null=True, blank=True)
 136     estimate_source = models.CharField(_("source of estimates"), max_length=2048, blank=True)
 137
 138     class Meta:
 139         ordering = ("title",)
 140         verbose_name = _('book')
 141         verbose_name_plural = _('books')
 142
 143     class Wikidata:
 144         authors = WIKIDATA.AUTHOR
 145         translators = WIKIDATA.TRANSLATOR
 146         title = WIKIDATA.TITLE
 147         language = WIKIDATA.LANGUAGE
 148         based_on = WIKIDATA.BASED_ON
 149         notes = "description"
 150
 151     def __str__(self):
 152         txt = self.title
 153         astr = self.authors_str()
 154         if astr:
 155             txt = f"{astr} – {txt}"
 156         tstr = self.translators_str()
 157         if tstr:
 158             txt = f"{txt} (tłum. {tstr})"
 159         return txt
 160
 161     def get_absolute_url(self):
 162         return reverse("catalogue_book", args=[self.slug])
 163
 164     def authors_str(self):
 165         return ", ".join(str(author) for author in self.authors.all())
 166     authors_str.admin_order_field = 'authors__last_name'
 167
 168     def translators_str(self):
 169         return ", ".join(str(author) for author in self.translators.all())
 170     translators_str.admin_order_field = 'translators__last_name'
 171
 172     def get_estimated_costs(self):
 173         return {
 174             work_type: work_type.calculate(self)
 175             for work_type in WorkType.objects.all()
 176         }
 177
 178
 179 class CollectionCategory(models.Model):
 180     name = models.CharField(_("name"), max_length=255)
 181     parent = models.ForeignKey('self', models.SET_NULL, related_name='children', null=True, blank=True, verbose_name=_("parent"))
 182     notes = models.TextField(_("notes"), blank=True)
 183
 184     class Meta:
 185         ordering = ('parent__name', 'name')
 186         verbose_name = _('collection category')
 187         verbose_name_plural = _('collection categories')
 188
 189     def __str__(self):
 190         if self.parent:
 191             return f"{self.parent} / {self.name}"
 192         else:
 193             return self.name
 194
 195
 196 class Collection(models.Model):
 197     name = models.CharField(_("name"), max_length=255)
 198     slug = models.SlugField(max_length=255, unique=True)
 199     category = models.ForeignKey(CollectionCategory, models.SET_NULL, null=True, blank=True, verbose_name=_("category"))
 200     notes = models.TextField(_("notes"), blank=True)
 201
 202     class Meta:
 203         ordering = ('category', 'name')
 204         verbose_name = _('collection')
 205         verbose_name_plural = _('collections')
 206
 207     def __str__(self):
 208         if self.category:
 209             return f"{self.category} / {self.name}"
 210         else:
 211             return self.name
 212
 213     def get_estimated_costs(self):
 214         costs = Counter()
 215         for book in self.book_set.all():
 216             for k, v in book.get_estimated_costs().items():
 217                 costs[k] += v or 0
 218
 219         for author in self.author_set.all():
 220             for book in author.book_set.all():
 221                 for k, v in book.get_estimated_costs().items():
 222                     costs[k] += v or 0
 223             for book in author.translated_book_set.all():
 224                 for k, v in book.get_estimated_costs().items():
 225                     costs[k] += v or 0
 226         return costs
 227
 228
 229 class WorkType(models.Model):
 230     name = models.CharField(_("name"), max_length=255)
 231
 232     class Meta:
 233         ordering = ('name',)
 234         verbose_name = _('work type')
 235         verbose_name_plural = _('work types')
 236
 237     def get_rate_for(self, book):
 238         for workrate in self.workrate_set.all():
 239             if workrate.matches(book):
 240                 return workrate
 241
 242     def calculate(self, book):
 243         workrate = self.get_rate_for(book)
 244         if workrate is not None:
 245             return workrate.calculate(book)
 246
 247
 248
 249 class WorkRate(models.Model):
 250     priority = models.IntegerField(_("priority"), default=1)
 251     per_normpage = models.DecimalField(_("per normalized page"), decimal_places=2, max_digits=6, null=True, blank=True)
 252     per_verse = models.DecimalField(_("per verse"), decimal_places=2, max_digits=6, null=True, blank=True)
 253     work_type = models.ForeignKey(WorkType, models.CASCADE, verbose_name=_("work type"))
 254     epochs = models.ManyToManyField(Epoch, blank=True, verbose_name=_("epochs"))
 255     kinds = models.ManyToManyField(Kind, blank=True, verbose_name=_("kinds"))
 256     genres = models.ManyToManyField(Genre, blank=True, verbose_name=_("genres"))
 257     collections = models.ManyToManyField(Collection, blank=True, verbose_name=_("collections"))
 258
 259     class Meta:
 260         ordering = ('priority',)
 261         verbose_name = _('work rate')
 262         verbose_name_plural = _('work rates')
 263
 264     def matches(self, book):
 265         for category in 'epochs', 'kinds', 'genres', 'collections':
 266             oneof = getattr(self, category).all()
 267             if oneof:
 268                 if not set(oneof).intersection(
 269                         getattr(book, category).all()):
 270                     return False
 271         return True
 272
 273     def calculate(self, book):
 274         if self.per_verse:
 275             if book.estimated_verses:
 276                 return book.estimated_verses * self.per_verse
 277         elif self.per_normpage:
 278             if book.estimated_chars:
 279                 return (decimal.Decimal(book.estimated_chars) / 1800 * self.per_normpage).quantize(decimal.Decimal('1.00'), rounding=decimal.ROUND_HALF_UP)
 280