18978467db5789299f8aa434caacc87092e21552
[redakcja.git] / 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
167     def translators_str(self):
168         return ", ".join(str(author) for author in self.translators.all())
169
170     def get_estimated_costs(self):
171         return {
172             work_type: work_type.calculate(self)
173             for work_type in WorkType.objects.all()
174         }
175
176
177 class CollectionCategory(models.Model):
178     name = models.CharField(_("name"), max_length=255)
179     parent = models.ForeignKey('self', models.SET_NULL, related_name='children', null=True, blank=True, verbose_name=_("parent"))
180
181     class Meta:
182         ordering = ('parent__name', 'name')
183         verbose_name = _('collection category')
184         verbose_name_plural = _('collection categories')
185
186     def __str__(self):
187         if self.parent:
188             return f"{self.parent} / {self.name}"
189         else:
190             return self.name
191
192
193 class Collection(models.Model):
194     name = models.CharField(_("name"), max_length=255)
195     slug = models.SlugField(max_length=255, unique=True)
196     category = models.ForeignKey(CollectionCategory, models.SET_NULL, null=True, blank=True, verbose_name=_("category"))
197
198     class Meta:
199         ordering = ('category', 'name')
200         verbose_name = _('collection')
201         verbose_name_plural = _('collections')
202
203     def __str__(self):
204         if self.category:
205             return f"{self.category} / {self.name}"
206         else:
207             return self.name
208
209     def get_estimated_costs(self):
210         costs = Counter()
211         for book in self.book_set.all():
212             for k, v in book.get_estimated_costs().items():
213                 costs[k] += v or 0
214
215         for author in self.author_set.all():
216             for book in author.book_set.all():
217                 for k, v in book.get_estimated_costs().items():
218                     costs[k] += v or 0
219             for book in author.translated_book_set.all():
220                 for k, v in book.get_estimated_costs().items():
221                     costs[k] += v or 0
222         return costs
223
224
225 class WorkType(models.Model):
226     name = models.CharField(_("name"), max_length=255)
227
228     class Meta:
229         ordering = ('name',)
230         verbose_name = _('work type')
231         verbose_name_plural = _('work types')
232     
233     def get_rate_for(self, book):
234         for workrate in self.workrate_set.all():
235             if workrate.matches(book):
236                 return workrate
237
238     def calculate(self, book):
239         workrate = self.get_rate_for(book)
240         if workrate is not None:
241             return workrate.calculate(book)
242         
243
244
245 class WorkRate(models.Model):
246     priority = models.IntegerField(_("priority"), default=1)
247     per_normpage = models.DecimalField(_("per normalized page"), decimal_places=2, max_digits=6, null=True, blank=True)
248     per_verse = models.DecimalField(_("per verse"), decimal_places=2, max_digits=6, null=True, blank=True)
249     work_type = models.ForeignKey(WorkType, models.CASCADE, verbose_name=_("work type"))
250     epochs = models.ManyToManyField(Epoch, blank=True, verbose_name=_("epochs"))
251     kinds = models.ManyToManyField(Kind, blank=True, verbose_name=_("kinds"))
252     genres = models.ManyToManyField(Genre, blank=True, verbose_name=_("genres"))
253     collections = models.ManyToManyField(Collection, blank=True, verbose_name=_("collections"))
254
255     class Meta:
256         ordering = ('priority',)
257         verbose_name = _('work rate')
258         verbose_name_plural = _('work rates')
259
260     def matches(self, book):
261         for category in 'epochs', 'kinds', 'genres', 'collections':
262             oneof = getattr(self, category).all()
263             if oneof:
264                 if not set(oneof).intersection(
265                         getattr(book, category).all()):
266                     return False
267         return True
268
269     def calculate(self, book):
270         if self.per_verse:
271             if book.estimated_verses:
272                 return book.estimated_verses * self.per_verse
273         elif self.per_normpage:
274             if book.estimated_chars:
275                 return (decimal.Decimal(book.estimated_chars) / 1800 * self.per_normpage).quantize(decimal.Decimal('1.00'), rounding=decimal.ROUND_HALF_UP)
276