85757a6566380840763e82492c3cdc8c5a363bd8
[redakcja.git] / src / catalogue / models.py
1 from collections import Counter
2 from datetime import date, timedelta
3 import decimal
4 import re
5 from urllib.request import urlopen
6 from django.apps import apps
7 from django.conf import settings
8 from django.db import models
9 from django.template.loader import render_to_string
10 from django.urls import reverse
11 from django.utils.translation import gettext_lazy as _
12 from admin_ordering.models import OrderableModel
13 from wikidata.client import Client
14 from .constants import WIKIDATA
15 from .wikidata import WikidataModel
16 from .wikimedia import WikiMedia
17
18
19 class Author(WikidataModel):
20     slug = models.SlugField(max_length=255, null=True, blank=True, unique=True)
21     first_name = models.CharField(_("first name"), max_length=255, blank=True)
22     last_name = models.CharField(_("last name"), max_length=255, blank=True)
23     genitive = models.CharField(
24         'dopełniacz', max_length=255, blank=True,
25         help_text='utwory … (czyje?)'
26     )
27
28     name_de = models.CharField(_("name (de)"), max_length=255, blank=True)
29     name_lt = models.CharField(_("name (lt)"), max_length=255, blank=True)
30
31     gender = models.CharField(_("gender"), max_length=255, blank=True)
32     nationality = models.CharField(_("nationality"), max_length=255, blank=True)
33
34     year_of_birth = models.SmallIntegerField(_("year of birth"), null=True, blank=True)
35     year_of_birth_inexact = models.BooleanField(_("inexact"), default=False)
36     year_of_birth_range = models.SmallIntegerField(_("year of birth, range end"), null=True, blank=True)
37     date_of_birth = models.DateField(_("date_of_birth"), null=True, blank=True)
38     century_of_birth = models.SmallIntegerField(
39         _("century of birth"), null=True, blank=True,
40         help_text=_('Set if year unknown. Negative for BC.')
41     )
42     place_of_birth = models.ForeignKey(
43         'Place', models.PROTECT, null=True, blank=True,
44         verbose_name=_('place of birth'),
45         related_name='authors_born'
46     )
47     year_of_death = models.SmallIntegerField(_("year of death"), null=True, blank=True)
48     year_of_death_inexact = models.BooleanField(_("inexact"), default=False)
49     year_of_death_range = models.SmallIntegerField(_("year of death, range end"), null=True, blank=True)
50     date_of_death = models.DateField(_("date_of_death"), null=True, blank=True)
51     century_of_death = models.SmallIntegerField(
52         _("century of death"), null=True, blank=True,
53         help_text=_('Set if year unknown. Negative for BC.')
54     )
55     place_of_death = models.ForeignKey(
56         'Place', models.PROTECT, null=True, blank=True,
57         verbose_name=_('place of death'),
58         related_name='authors_died'
59     )
60     status = models.PositiveSmallIntegerField(
61         _("status"), 
62         null=True,
63         blank=True,
64         choices=[
65             (1, _("Alive")),
66             (2, _("Dead")),
67             (3, _("Long dead")),
68             (4, _("Unknown")),
69         ],
70     )
71     notes = models.TextField(_("notes"), blank=True, help_text=_('private'))
72
73     gazeta_link = models.CharField(_("gazeta link"), max_length=255, blank=True)
74     culturepl_link = models.CharField(_("culture.pl link"), max_length=255, blank=True)
75     plwiki = models.CharField(blank=True, max_length=255)
76     photo = models.ImageField(blank=True, null=True, upload_to='catalogue/author/')
77     photo_source = models.CharField(blank=True, max_length=255)
78     photo_attribution = models.CharField(max_length=255, blank=True)
79
80     description = models.TextField(_("description"), blank=True, help_text=_('for publication'))
81
82     priority = models.PositiveSmallIntegerField(
83         _("priority"), 
84         default=0, choices=[(0, _("Low")), (1, _("Medium")), (2, _("High"))]
85     )
86     collections = models.ManyToManyField("Collection", blank=True, verbose_name=_("collections"))
87
88     woblink = models.IntegerField(null=True, blank=True)
89     
90     class Meta:
91         verbose_name = _('author')
92         verbose_name_plural = _('authors')
93         ordering = ("last_name", "first_name", "year_of_death")
94
95     class Wikidata:
96         first_name = WIKIDATA.GIVEN_NAME
97         last_name = WIKIDATA.LAST_NAME
98         date_of_birth = WIKIDATA.DATE_OF_BIRTH
99         year_of_birth = WIKIDATA.DATE_OF_BIRTH
100         place_of_birth = WIKIDATA.PLACE_OF_BIRTH
101         date_of_death = WIKIDATA.DATE_OF_DEATH
102         year_of_death = WIKIDATA.DATE_OF_DEATH
103         place_of_death = WIKIDATA.PLACE_OF_DEATH
104         gender = WIKIDATA.GENDER
105         notes = WikiMedia.append("description")
106         plwiki = "plwiki"
107         photo = WikiMedia.download(WIKIDATA.IMAGE)
108         photo_source = WikiMedia.descriptionurl(WIKIDATA.IMAGE)
109         photo_attribution = WikiMedia.attribution(WIKIDATA.IMAGE)
110
111         def _supplement(obj):
112             if not obj.first_name and not obj.last_name:
113                 yield 'first_name', 'label'
114
115     def __str__(self):
116         name = f"{self.first_name} {self.last_name}"
117         if self.year_of_death is not None:
118             name += f' (zm. {self.year_of_death})'
119         return name
120
121     def get_absolute_url(self):
122         return reverse("catalogue_author", args=[self.slug])
123
124     @property
125     def name(self):
126         return f"{self.last_name}, {self.first_name}"
127     
128     @property
129     def pd_year(self):
130         if self.year_of_death:
131             return self.year_of_death + 71
132         elif self.year_of_death == 0:
133             return 0
134         else:
135             return None
136
137     def generate_description(self):
138         t = render_to_string(
139             'catalogue/author_description.html',
140             {'obj': self}
141         )
142         return t
143
144     def century_description(self, number):
145         n = abs(number)
146         letters = ''
147         while n > 10:
148             letters += 'X'
149             n -= 10
150         if n == 9:
151             letters += 'IX'
152             n = 0
153         elif n >= 5:
154             letters += 'V'
155             n -= 5
156         if n == 4:
157             letters += 'IV'
158             n = 0
159         letters += 'I' * n
160         letters += ' w.'
161         if number < 0:
162             letters += ' p.n.e.'
163         return letters
164
165     def birth_century_description(self):
166         return self.century_description(self.century_of_birth)
167
168     def death_century_description(self):
169         return self.century_description(self.century_of_death)
170
171     def year_description(self, number):
172         n = abs(number)
173         letters = str(n)
174         letters += ' r.'
175         if number < 0:
176             letters += ' p.n.e.'
177         return letters
178
179     def year_of_birth_description(self):
180         return self.year_description(self.year_of_birth)
181     def year_of_death_description(self):
182         return self.year_description(self.year_of_death)
183
184
185 class NotableBook(OrderableModel):
186     author = models.ForeignKey(Author, models.CASCADE)
187     book = models.ForeignKey('Book', models.CASCADE)
188
189
190 class Category(WikidataModel):
191     name = models.CharField(_("name"), max_length=255)
192     slug = models.SlugField(max_length=255, unique=True)
193     description = models.TextField(_("description"), blank=True, help_text=_('for publication'))
194
195     class Meta:
196         abstract = True
197
198     def __str__(self):
199         return self.name
200
201
202 class Epoch(Category):
203     adjective_feminine_singular = models.CharField(
204         'przymiotnik pojedynczy żeński', max_length=255, blank=True,
205         help_text='twórczość … Adama Mickiewicza'
206     )
207     adjective_nonmasculine_plural = models.CharField(
208         'przymiotnik mnogi niemęskoosobowy', max_length=255, blank=True,
209         help_text='utwory … Adama Mickiewicza'
210     )
211
212     class Meta:
213         verbose_name = _('epoch')
214         verbose_name_plural = _('epochs')
215
216
217 class Genre(Category):
218     plural = models.CharField(
219         'liczba mnoga', max_length=255, blank=True,
220     )
221     is_epoch_specific = models.BooleanField(
222         default=False,
223         help_text='Po wskazaniu tego gatunku, dodanie epoki byłoby nadmiarowe, np. „dramat romantyczny”'
224     )
225
226     class Meta:
227         verbose_name = _('genre')
228         verbose_name_plural = _('genres')
229
230
231 class Kind(Category):
232     collective_noun = models.CharField(
233         'określenie zbiorowe', max_length=255, blank=True,
234         help_text='np. „Liryka” albo „Twórczość dramatyczna”'
235     )
236
237     class Meta:
238         verbose_name = _('kind')
239         verbose_name_plural = _('kinds')
240
241
242 class Book(WikidataModel):
243     slug = models.SlugField(max_length=255, blank=True, null=True, unique=True)
244     authors = models.ManyToManyField(Author, blank=True, verbose_name=_("authors"))
245     translators = models.ManyToManyField(
246         Author,
247         related_name="translated_book_set",
248         related_query_name="translated_book",
249         blank=True,
250         verbose_name=_("translators")
251     )
252     epochs = models.ManyToManyField(Epoch, blank=True, verbose_name=_("epochs"))
253     kinds = models.ManyToManyField(Kind, blank=True, verbose_name=_("kinds"))
254     genres = models.ManyToManyField(Genre, blank=True, verbose_name=_("genres"))
255     title = models.CharField(_("title"), max_length=255, blank=True)
256     language = models.CharField(_("language"), max_length=255, blank=True)
257     based_on = models.ForeignKey(
258         "self", models.PROTECT, related_name="translation", null=True, blank=True,
259         verbose_name=_("based on")
260     )
261     scans_source = models.CharField(_("scans source"), max_length=255, blank=True)
262     text_source = models.CharField(_("text source"), max_length=255, blank=True)
263     notes = models.TextField(_("notes"), blank=True, help_text=_('private'))
264     priority = models.PositiveSmallIntegerField(
265         _("priority"),
266         default=0, choices=[(0, _("Low")), (1, _("Medium")), (2, _("High"))]
267     )
268     original_year = models.IntegerField(_('original publication year'), null=True, blank=True)
269     pd_year = models.IntegerField(_('year of entry into PD'), null=True, blank=True)
270     gazeta_link = models.CharField(_("gazeta link"), max_length=255, blank=True)
271     collections = models.ManyToManyField("Collection", blank=True, verbose_name=_("collections"))
272
273     estimated_chars = models.IntegerField(_("estimated number of characters"), null=True, blank=True)
274     estimated_verses = models.IntegerField(_("estimated number of verses"), null=True, blank=True)
275     estimate_source = models.CharField(_("source of estimates"), max_length=2048, blank=True)
276
277     free_license = models.BooleanField(_('free license'), default=False)
278     polona_missing = models.BooleanField(_('missing on Polona'), default=False)
279
280     monthly_views_reader = models.IntegerField(default=0)
281     monthly_views_page = models.IntegerField(default=0)
282     
283     class Meta:
284         ordering = ("title",)
285         verbose_name = _('book')
286         verbose_name_plural = _('books')
287
288     class Wikidata:
289         authors = WIKIDATA.AUTHOR
290         translators = WIKIDATA.TRANSLATOR
291         title = WIKIDATA.TITLE
292         language = WIKIDATA.LANGUAGE
293         based_on = WIKIDATA.BASED_ON
294         original_year = WIKIDATA.PUBLICATION_DATE
295         notes = WikiMedia.append("description")
296
297     def __str__(self):
298         txt = self.title
299         if self.original_year:
300             txt = f"{txt} ({self.original_year})"
301         astr = self.authors_str()
302         if astr:
303             txt = f"{txt}, {astr}"
304         tstr = self.translators_str()
305         if tstr:
306             txt = f"{txt}, tłum. {tstr}"
307         return txt
308
309     def get_absolute_url(self):
310         return reverse("catalogue_book", args=[self.slug])
311
312     @property
313     def wluri(self):
314         return f'https://wolnelektury.pl/katalog/lektura/{self.slug}/'
315     
316     def authors_str(self):
317         if not self.pk:
318             return ''
319         return ", ".join(str(author) for author in self.authors.all())
320     authors_str.admin_order_field = 'authors__last_name'
321     authors_str.short_description = _('Author')
322
323     def translators_str(self):
324         if not self.pk:
325             return ''
326         return ", ".join(str(author) for author in self.translators.all())
327     translators_str.admin_order_field = 'translators__last_name'
328     translators_str.short_description = _('Translator')
329
330     def authors_first_names(self):
331         return ', '.join(a.first_name for a in self.authors.all())
332
333     def authors_last_names(self):
334         return ', '.join(a.last_name for a in self.authors.all())
335
336     def translators_first_names(self):
337         return ', '.join(a.first_name for a in self.translators.all())
338
339     def translators_last_names(self):
340         return ', '.join(a.last_name for a in self.translators.all())
341
342     def document_book__project(self):
343         b = self.document_books.first()
344         if b is None: return ''
345         if b.project is None: return ''
346         return b.project.name
347
348     def audience(self):
349         try:
350             return self.document_books.first().wldocument().book_info.audience or ''
351         except:
352             return ''
353
354     def get_estimated_costs(self):
355         return {
356             work_type: work_type.calculate(self)
357             for work_type in WorkType.objects.all()
358         }
359
360     def update_monthly_stats(self):
361         # Find publication date.
362         # By default, get previous 12 months.
363         this_month = date.today().replace(day=1)
364         cutoff = this_month.replace(year=this_month.year - 1)
365         months = 12
366
367         # If the book was published later,
368         # find out the denominator.
369         pbr = apps.get_model('documents', 'BookPublishRecord').objects.filter(
370             book__catalogue_book=self).order_by('timestamp').first()
371         if pbr is not None and pbr.timestamp.date() > cutoff:
372             months = (this_month - pbr.timestamp.date()).days / 365 * 12
373
374         if not months:
375             return
376
377         stats = self.bookmonthlystats_set.filter(date__gte=cutoff).aggregate(
378             views_page=models.Sum('views_page'),
379             views_reader=models.Sum('views_reader')
380         )
381         self.monthly_views_page = stats['views_page'] / months
382         self.monthly_views_reader = stats['views_reader'] / months
383         self.save(update_fields=['monthly_views_page', 'monthly_views_reader'])
384
385     @property
386     def content_stats(self):
387         if hasattr(self, '_content_stats'):
388             return self._content_stats
389         try:
390             stats = self.document_books.first().wldocument().get_statistics()['total']
391         except Exception as e:
392             stats = {}
393         self._content_stats = stats
394         return stats
395
396     chars = lambda self: self.content_stats.get('chars', '')
397     chars_with_fn = lambda self: self.content_stats.get('chars_with_fn', '')
398     words = lambda self: self.content_stats.get('words', '')
399     words_with_fn = lambda self: self.content_stats.get('words_with_fn', '')
400     verses = lambda self: self.content_stats.get('verses', '')
401     verses_with_fn = lambda self: self.content_stats.get('verses_with_fn', '')
402     chars_out_verse = lambda self: self.content_stats.get('chars_out_verse', '')
403     chars_out_verse_with_fn = lambda self: self.content_stats.get('chars_out_verse_with_fn', '')
404
405 class CollectionCategory(models.Model):
406     name = models.CharField(_("name"), max_length=255)
407     parent = models.ForeignKey('self', models.SET_NULL, related_name='children', null=True, blank=True, verbose_name=_("parent"))
408     notes = models.TextField(_("notes"), blank=True, help_text=_('private'))
409
410     class Meta:
411         ordering = ('parent__name', 'name')
412         verbose_name = _('collection category')
413         verbose_name_plural = _('collection categories')
414
415     def __str__(self):
416         if self.parent:
417             return f"{self.parent} / {self.name}"
418         else:
419             return self.name
420
421
422 class Collection(models.Model):
423     name = models.CharField(_("name"), max_length=255)
424     slug = models.SlugField(max_length=255, unique=True)
425     category = models.ForeignKey(CollectionCategory, models.SET_NULL, null=True, blank=True, verbose_name=_("category"))
426     notes = models.TextField(_("notes"), blank=True, help_text=_('private'))
427     description = models.TextField(_("description"), blank=True)
428
429     class Meta:
430         ordering = ('category', 'name')
431         verbose_name = _('collection')
432         verbose_name_plural = _('collections')
433
434     def __str__(self):
435         if self.category:
436             return f"{self.category} / {self.name}"
437         else:
438             return self.name
439
440     def get_estimated_costs(self):
441         costs = Counter()
442         for book in self.book_set.all():
443             for k, v in book.get_estimated_costs().items():
444                 costs[k] += v or 0
445
446         for author in self.author_set.all():
447             for book in author.book_set.all():
448                 for k, v in book.get_estimated_costs().items():
449                     costs[k] += v or 0
450             for book in author.translated_book_set.all():
451                 for k, v in book.get_estimated_costs().items():
452                     costs[k] += v or 0
453         return costs
454
455
456 class WorkType(models.Model):
457     name = models.CharField(_("name"), max_length=255)
458
459     class Meta:
460         ordering = ('name',)
461         verbose_name = _('work type')
462         verbose_name_plural = _('work types')
463     
464     def get_rate_for(self, book):
465         for workrate in self.workrate_set.all():
466             if workrate.matches(book):
467                 return workrate
468
469     def calculate(self, book):
470         workrate = self.get_rate_for(book)
471         if workrate is not None:
472             return workrate.calculate(book)
473         
474
475
476 class WorkRate(models.Model):
477     priority = models.IntegerField(_("priority"), default=1)
478     per_normpage = models.DecimalField(_("per normalized page"), decimal_places=2, max_digits=6, null=True, blank=True)
479     per_verse = models.DecimalField(_("per verse"), decimal_places=2, max_digits=6, null=True, blank=True)
480     work_type = models.ForeignKey(WorkType, models.CASCADE, verbose_name=_("work type"))
481     epochs = models.ManyToManyField(Epoch, blank=True, verbose_name=_("epochs"))
482     kinds = models.ManyToManyField(Kind, blank=True, verbose_name=_("kinds"))
483     genres = models.ManyToManyField(Genre, blank=True, verbose_name=_("genres"))
484     collections = models.ManyToManyField(Collection, blank=True, verbose_name=_("collections"))
485
486     class Meta:
487         ordering = ('priority',)
488         verbose_name = _('work rate')
489         verbose_name_plural = _('work rates')
490
491     def matches(self, book):
492         for category in 'epochs', 'kinds', 'genres', 'collections':
493             oneof = getattr(self, category).all()
494             if oneof:
495                 if not set(oneof).intersection(
496                         getattr(book, category).all()):
497                     return False
498         return True
499
500     def calculate(self, book):
501         if self.per_verse:
502             if book.estimated_verses:
503                 return book.estimated_verses * self.per_verse
504         elif self.per_normpage:
505             if book.estimated_chars:
506                 return (decimal.Decimal(book.estimated_chars) / 1800 * self.per_normpage).quantize(decimal.Decimal('1.00'), rounding=decimal.ROUND_HALF_UP)
507
508
509 class Place(WikidataModel):
510     name = models.CharField(_('name'), max_length=255, blank=True)
511     locative = models.CharField(_('locative'), max_length=255, blank=True, help_text=_('in…'))
512
513     class Meta:
514         verbose_name = _('place')
515         verbose_name_plural = _('places')
516     
517     class Wikidata:
518         name = 'label'
519
520     def __str__(self):
521         return self.name
522
523
524 class BookMonthlyStats(models.Model):
525     book = models.ForeignKey('catalogue.Book', models.CASCADE)
526     date = models.DateField()
527     views_reader = models.IntegerField(default=0)
528     views_page = models.IntegerField(default=0)
529
530     @classmethod
531     def build_for_month(cls, date):
532         date = date.replace(day=1)
533         period = 'month'
534
535         date = date.isoformat()
536         url = f'{settings.PIWIK_URL}?date={date}&filter_limit=-1&format=CSV&idSite={settings.PIWIK_WL_SITE_ID}&language=pl&method=Actions.getPageUrls&module=API&period={period}&segment=&token_auth={settings.PIWIK_TOKEN}&flat=1'
537         data = urlopen(url).read().decode('utf-16')
538         lines = data.split('\n')[1:]
539         for line in lines:
540             m = re.match('^/katalog/lektura/([^,./]+)\.html,', line)
541             if m is not None:
542                 which = 'views_reader'
543             else:
544                 m = re.match('^/katalog/lektura/([^,./]+)/,', line)
545                 if m is not None:
546                     which = 'views_page'
547             if m is not None:
548                 slug = m.group(1)
549                 _url, _uviews, views, _rest = line.split(',', 3)
550                 views = int(views)
551                 try:
552                     book = Book.objects.get(slug=slug)
553                 except Book.DoesNotExist:
554                     continue
555                 else:
556                     cls.objects.update_or_create(
557                         book=book, date=date,
558                         defaults={which: views}
559                     )
560                     book.update_monthly_stats()
561
562
563 class Thema(models.Model):
564     code = models.CharField(max_length=128, unique=True)
565     name = models.CharField(max_length=1024)
566     slug = models.SlugField(
567         max_length=255, null=True, blank=True, unique=True,
568         help_text='Element adresu na WL, w postaci: /tag/slug/. Można zmieniać.'
569     )
570     plural = models.CharField(
571         'liczba mnoga', max_length=255, blank=True,
572     )
573     description = models.TextField(blank=True)
574     public_description = models.TextField(blank=True)
575     usable = models.BooleanField()
576     usable_as_main = models.BooleanField(default=False)
577     hidden = models.BooleanField(default=False)
578     woblink_category = models.IntegerField(null=True, blank=True)
579
580     class Meta:
581         ordering = ('code',)
582         verbose_name_plural = 'Thema'
583
584
585 class Audience(models.Model):
586     code = models.CharField(
587         max_length=128, unique=True,
588         help_text='Techniczny identifyikator. W miarę możliwości nie należy zmieniać.'
589     )
590     name = models.CharField(
591         max_length=1024,
592         help_text='W formie: „dla … (kogo?)”'
593     )
594     slug = models.SlugField(
595         max_length=255, null=True, blank=True, unique=True,
596         help_text='Element adresu na WL, w postaci: /dla/slug/. Można zmieniać.'
597     )
598     description = models.TextField(blank=True)
599     thema = models.CharField(
600         max_length=32, blank=True,
601         help_text='Odpowiadający kwalifikator Thema.'
602     )
603
604     class Meta:
605         ordering = ('code',)