Bit nicer source flow.
[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     @classmethod
125     def get_by_literal(cls, literal):
126         names = literal.split(',', 1)
127         names = [n.strip() for n in names]
128         if len(names) == 2:
129             return cls.objects.filter(last_name=names[0], first_name=names[1]).first()
130         else:
131             return cls.objects.filter(last_name_pl=names[0], first_name_pl='').first() or \
132                 cls.objects.filter(first_name_pl=names[0], last_name_pl='').first() or \
133                 cls.objects.filter(first_name_pl=literal, last_name_pl='').first() or \
134                 cls.objects.filter(first_name_pl=literal, last_name_pl=None).first()
135
136     @property
137     def name(self):
138         return f"{self.last_name}, {self.first_name}"
139     
140     @property
141     def pd_year(self):
142         if self.year_of_death:
143             return self.year_of_death + 71
144         elif self.year_of_death == 0:
145             return 0
146         else:
147             return None
148
149     def generate_description(self):
150         t = render_to_string(
151             'catalogue/author_description.html',
152             {'obj': self}
153         )
154         return t
155
156     def century_description(self, number):
157         n = abs(number)
158         letters = ''
159         while n > 10:
160             letters += 'X'
161             n -= 10
162         if n == 9:
163             letters += 'IX'
164             n = 0
165         elif n >= 5:
166             letters += 'V'
167             n -= 5
168         if n == 4:
169             letters += 'IV'
170             n = 0
171         letters += 'I' * n
172         letters += ' w.'
173         if number < 0:
174             letters += ' p.n.e.'
175         return letters
176
177     def birth_century_description(self):
178         return self.century_description(self.century_of_birth)
179
180     def death_century_description(self):
181         return self.century_description(self.century_of_death)
182
183     def year_description(self, number):
184         n = abs(number)
185         letters = str(n)
186         letters += ' r.'
187         if number < 0:
188             letters += ' p.n.e.'
189         return letters
190
191     def year_of_birth_description(self):
192         return self.year_description(self.year_of_birth)
193     def year_of_death_description(self):
194         return self.year_description(self.year_of_death)
195
196
197 class NotableBook(OrderableModel):
198     author = models.ForeignKey(Author, models.CASCADE)
199     book = models.ForeignKey('Book', models.CASCADE)
200
201     def __str__(self):
202         return self.book.title
203
204
205 class Category(WikidataModel):
206     name = models.CharField(_("name"), max_length=255)
207     slug = models.SlugField(max_length=255, unique=True)
208     description = models.TextField(_("description"), blank=True, help_text=_('for publication'))
209
210     class Meta:
211         abstract = True
212
213     def __str__(self):
214         return self.name
215
216
217 class Epoch(Category):
218     adjective_feminine_singular = models.CharField(
219         'przymiotnik pojedynczy żeński', max_length=255, blank=True,
220         help_text='twórczość … Adama Mickiewicza'
221     )
222     adjective_nonmasculine_plural = models.CharField(
223         'przymiotnik mnogi niemęskoosobowy', max_length=255, blank=True,
224         help_text='utwory … Adama Mickiewicza'
225     )
226
227     class Meta:
228         verbose_name = _('epoch')
229         verbose_name_plural = _('epochs')
230
231
232 class Genre(Category):
233     plural = models.CharField(
234         'liczba mnoga', max_length=255, blank=True,
235     )
236     is_epoch_specific = models.BooleanField(
237         default=False,
238         help_text='Po wskazaniu tego gatunku, dodanie epoki byłoby nadmiarowe, np. „dramat romantyczny”'
239     )
240
241     class Meta:
242         verbose_name = _('genre')
243         verbose_name_plural = _('genres')
244
245
246 class Kind(Category):
247     collective_noun = models.CharField(
248         'określenie zbiorowe', max_length=255, blank=True,
249         help_text='np. „Liryka” albo „Twórczość dramatyczna”'
250     )
251
252     class Meta:
253         verbose_name = _('kind')
254         verbose_name_plural = _('kinds')
255
256
257 class Book(WikidataModel):
258     slug = models.SlugField(max_length=255, blank=True, null=True, unique=True)
259     authors = models.ManyToManyField(Author, blank=True, verbose_name=_("authors"))
260     translators = models.ManyToManyField(
261         Author,
262         related_name="translated_book_set",
263         related_query_name="translated_book",
264         blank=True,
265         verbose_name=_("translators")
266     )
267     epochs = models.ManyToManyField(Epoch, blank=True, verbose_name=_("epochs"))
268     kinds = models.ManyToManyField(Kind, blank=True, verbose_name=_("kinds"))
269     genres = models.ManyToManyField(Genre, blank=True, verbose_name=_("genres"))
270     title = models.CharField(_("title"), max_length=255, blank=True)
271     language = models.CharField(_("language"), max_length=255, blank=True)
272     based_on = models.ForeignKey(
273         "self", models.PROTECT, related_name="translation", null=True, blank=True,
274         verbose_name=_("based on")
275     )
276     scans_source = models.CharField(_("scans source"), max_length=255, blank=True)
277     text_source = models.CharField(_("text source"), max_length=255, blank=True)
278     notes = models.TextField(_("notes"), blank=True, help_text=_('private'))
279     priority = models.PositiveSmallIntegerField(
280         _("priority"),
281         default=0, choices=[(0, _("Low")), (1, _("Medium")), (2, _("High"))]
282     )
283     original_year = models.IntegerField(_('original publication year'), null=True, blank=True)
284     pd_year = models.IntegerField(_('year of entry into PD'), null=True, blank=True)
285     plwiki = models.CharField(blank=True, max_length=255)
286     gazeta_link = models.CharField(_("gazeta link"), max_length=255, blank=True)
287     collections = models.ManyToManyField("Collection", blank=True, verbose_name=_("collections"))
288
289     estimated_chars = models.IntegerField(_("estimated number of characters"), null=True, blank=True)
290     estimated_verses = models.IntegerField(_("estimated number of verses"), null=True, blank=True)
291     estimate_source = models.CharField(_("source of estimates"), max_length=2048, blank=True)
292
293     free_license = models.BooleanField(_('free license'), default=False)
294     polona_missing = models.BooleanField(_('missing on Polona'), default=False)
295
296     monthly_views_reader = models.IntegerField(default=0)
297     monthly_views_page = models.IntegerField(default=0)
298     
299     class Meta:
300         ordering = ("title",)
301         verbose_name = _('book')
302         verbose_name_plural = _('books')
303
304     class Wikidata:
305         plwiki = "plwiki"
306         authors = WIKIDATA.AUTHOR
307         translators = WIKIDATA.TRANSLATOR
308         title = WIKIDATA.TITLE
309         language = WIKIDATA.LANGUAGE
310         based_on = WIKIDATA.BASED_ON
311         original_year = WIKIDATA.PUBLICATION_DATE
312         notes = WikiMedia.append("description")
313
314     def __str__(self):
315         txt = self.title
316         if self.original_year:
317             txt = f"{txt} ({self.original_year})"
318         astr = self.authors_str()
319         if astr:
320             txt = f"{txt}, {astr}"
321         tstr = self.translators_str()
322         if tstr:
323             txt = f"{txt}, tłum. {tstr}"
324         return txt
325
326     def get_absolute_url(self):
327         return reverse("catalogue_book", args=[self.slug])
328
329     def is_text_public(self):
330         return self.free_license or (self.pd_year is not None and self.pd_year <= date.today().year)
331
332     def audio_status(self):
333         return {}
334     
335     @property
336     def wluri(self):
337         return f'https://wolnelektury.pl/katalog/lektura/{self.slug}/'
338     
339     def authors_str(self):
340         if not self.pk:
341             return ''
342         return ", ".join(str(author) for author in self.authors.all())
343     authors_str.admin_order_field = 'authors__last_name'
344     authors_str.short_description = _('Author')
345
346     def translators_str(self):
347         if not self.pk:
348             return ''
349         return ", ".join(str(author) for author in self.translators.all())
350     translators_str.admin_order_field = 'translators__last_name'
351     translators_str.short_description = _('Translator')
352
353     def authors_first_names(self):
354         return ', '.join(a.first_name for a in self.authors.all())
355
356     def authors_last_names(self):
357         return ', '.join(a.last_name for a in self.authors.all())
358
359     def translators_first_names(self):
360         return ', '.join(a.first_name for a in self.translators.all())
361
362     def translators_last_names(self):
363         return ', '.join(a.last_name for a in self.translators.all())
364
365     def document_book__project(self):
366         b = self.document_books.first()
367         if b is None: return ''
368         if b.project is None: return ''
369         return b.project.name
370
371     def audience(self):
372         try:
373             return self.document_books.first().wldocument().book_info.audience or ''
374         except:
375             return ''
376
377     def get_estimated_costs(self):
378         return {
379             work_type: work_type.calculate(self)
380             for work_type in WorkType.objects.all()
381         }
382
383     def scans_gallery(self):
384         bs = self.booksource_set.first()
385         if bs is None:
386             return ''
387         return bs.pk
388
389     def is_published(self):
390         return any(b.is_published() for b in self.document_books.all())
391     
392     def update_monthly_stats(self):
393         # Find publication date.
394         # By default, get previous 12 months.
395         this_month = date.today().replace(day=1)
396         cutoff = this_month.replace(year=this_month.year - 1)
397         months = 12
398
399         # If the book was published later,
400         # find out the denominator.
401         pbr = apps.get_model('documents', 'BookPublishRecord').objects.filter(
402             book__catalogue_book=self).order_by('timestamp').first()
403         if pbr is not None and pbr.timestamp.date() > cutoff:
404             months = (this_month - pbr.timestamp.date()).days / 365 * 12
405
406         if not months:
407             return
408
409         stats = self.bookmonthlystats_set.filter(date__gte=cutoff).aggregate(
410             views_page=models.Sum('views_page'),
411             views_reader=models.Sum('views_reader')
412         )
413         self.monthly_views_page = stats['views_page'] / months
414         self.monthly_views_reader = stats['views_reader'] / months
415         self.save(update_fields=['monthly_views_page', 'monthly_views_reader'])
416
417     @property
418     def content_stats(self):
419         if hasattr(self, '_content_stats'):
420             return self._content_stats
421         try:
422             stats = self.document_books.first().wldocument(librarian2=True).get_statistics()['total']
423         except Exception as e:
424             stats = {}
425         self._content_stats = stats
426         return stats
427
428     chars = lambda self: self.content_stats.get('chars', '')
429     chars_with_fn = lambda self: self.content_stats.get('chars_with_fn', '')
430     words = lambda self: self.content_stats.get('words', '')
431     words_with_fn = lambda self: self.content_stats.get('words_with_fn', '')
432     verses = lambda self: self.content_stats.get('verses', '')
433     verses_with_fn = lambda self: self.content_stats.get('verses_with_fn', '')
434     chars_out_verse = lambda self: self.content_stats.get('chars_out_verse', '')
435     chars_out_verse_with_fn = lambda self: self.content_stats.get('chars_out_verse_with_fn', '')
436
437 class CollectionCategory(models.Model):
438     name = models.CharField(_("name"), max_length=255)
439     parent = models.ForeignKey('self', models.SET_NULL, related_name='children', null=True, blank=True, verbose_name=_("parent"))
440     notes = models.TextField(_("notes"), blank=True, help_text=_('private'))
441
442     class Meta:
443         ordering = ('parent__name', 'name')
444         verbose_name = _('collection category')
445         verbose_name_plural = _('collection categories')
446
447     def __str__(self):
448         if self.parent:
449             return f"{self.parent} / {self.name}"
450         else:
451             return self.name
452
453
454 class Collection(models.Model):
455     name = models.CharField(_("name"), max_length=255)
456     slug = models.SlugField(max_length=255, unique=True)
457     category = models.ForeignKey(CollectionCategory, models.SET_NULL, null=True, blank=True, verbose_name=_("category"))
458     notes = models.TextField(_("notes"), blank=True, help_text=_('private'))
459     description = models.TextField(_("description"), blank=True)
460
461     class Meta:
462         ordering = ('category', 'name')
463         verbose_name = _('collection')
464         verbose_name_plural = _('collections')
465
466     def __str__(self):
467         if self.category:
468             return f"{self.category} / {self.name}"
469         else:
470             return self.name
471
472     def get_estimated_costs(self):
473         costs = Counter()
474         for book in self.book_set.all():
475             for k, v in book.get_estimated_costs().items():
476                 costs[k] += v or 0
477
478         for author in self.author_set.all():
479             for book in author.book_set.all():
480                 for k, v in book.get_estimated_costs().items():
481                     costs[k] += v or 0
482             for book in author.translated_book_set.all():
483                 for k, v in book.get_estimated_costs().items():
484                     costs[k] += v or 0
485         return costs
486
487
488 class WorkType(models.Model):
489     name = models.CharField(_("name"), max_length=255)
490
491     class Meta:
492         ordering = ('name',)
493         verbose_name = _('work type')
494         verbose_name_plural = _('work types')
495     
496     def get_rate_for(self, book):
497         for workrate in self.workrate_set.all():
498             if workrate.matches(book):
499                 return workrate
500
501     def calculate(self, book):
502         workrate = self.get_rate_for(book)
503         if workrate is not None:
504             return workrate.calculate(book)
505         
506
507
508 class WorkRate(models.Model):
509     priority = models.IntegerField(_("priority"), default=1)
510     per_normpage = models.DecimalField(_("per normalized page"), decimal_places=2, max_digits=6, null=True, blank=True)
511     per_verse = models.DecimalField(_("per verse"), decimal_places=2, max_digits=6, null=True, blank=True)
512     work_type = models.ForeignKey(WorkType, models.CASCADE, verbose_name=_("work type"))
513     epochs = models.ManyToManyField(Epoch, blank=True, verbose_name=_("epochs"))
514     kinds = models.ManyToManyField(Kind, blank=True, verbose_name=_("kinds"))
515     genres = models.ManyToManyField(Genre, blank=True, verbose_name=_("genres"))
516     collections = models.ManyToManyField(Collection, blank=True, verbose_name=_("collections"))
517
518     class Meta:
519         ordering = ('priority',)
520         verbose_name = _('work rate')
521         verbose_name_plural = _('work rates')
522
523     def matches(self, book):
524         for category in 'epochs', 'kinds', 'genres', 'collections':
525             oneof = getattr(self, category).all()
526             if oneof:
527                 if not set(oneof).intersection(
528                         getattr(book, category).all()):
529                     return False
530         return True
531
532     def calculate(self, book):
533         if self.per_verse:
534             if book.estimated_verses:
535                 return book.estimated_verses * self.per_verse
536         elif self.per_normpage:
537             if book.estimated_chars:
538                 return (decimal.Decimal(book.estimated_chars) / 1800 * self.per_normpage).quantize(decimal.Decimal('1.00'), rounding=decimal.ROUND_HALF_UP)
539
540
541 class Place(WikidataModel):
542     name = models.CharField(_('name'), max_length=255, blank=True)
543     locative = models.CharField(_('locative'), max_length=255, blank=True, help_text=_('in…'))
544
545     class Meta:
546         verbose_name = _('place')
547         verbose_name_plural = _('places')
548     
549     class Wikidata:
550         name = 'label'
551
552     def __str__(self):
553         return self.name
554
555
556 class BookMonthlyStats(models.Model):
557     book = models.ForeignKey('catalogue.Book', models.CASCADE)
558     date = models.DateField()
559     views_reader = models.IntegerField(default=0)
560     views_page = models.IntegerField(default=0)
561
562     @classmethod
563     def build_for_month(cls, date):
564         date = date.replace(day=1)
565         period = 'month'
566
567         date = date.isoformat()
568         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'
569         data = urlopen(url).read().decode('utf-16')
570         lines = data.split('\n')[1:]
571         for line in lines:
572             m = re.match('^/katalog/lektura/([^,./]+)\.html,', line)
573             if m is not None:
574                 which = 'views_reader'
575             else:
576                 m = re.match('^/katalog/lektura/([^,./]+)/,', line)
577                 if m is not None:
578                     which = 'views_page'
579             if m is not None:
580                 slug = m.group(1)
581                 _url, _uviews, views, _rest = line.split(',', 3)
582                 views = int(views)
583                 try:
584                     book = Book.objects.get(slug=slug)
585                 except Book.DoesNotExist:
586                     continue
587                 else:
588                     cls.objects.update_or_create(
589                         book=book, date=date,
590                         defaults={which: views}
591                     )
592                     book.update_monthly_stats()
593
594
595 class Thema(models.Model):
596     code = models.CharField(max_length=128, unique=True)
597     name = models.CharField(max_length=1024)
598     slug = models.SlugField(
599         max_length=255, null=True, blank=True, unique=True,
600         help_text='Element adresu na WL, w postaci: /tag/slug/. Można zmieniać.'
601     )
602     plural = models.CharField(
603         'liczba mnoga', max_length=255, blank=True,
604     )
605     description = models.TextField(blank=True)
606     public_description = models.TextField(blank=True)
607     usable = models.BooleanField()
608     usable_as_main = models.BooleanField(default=False)
609     hidden = models.BooleanField(default=False)
610     woblink_category = models.IntegerField(null=True, blank=True)
611
612     class Meta:
613         ordering = ('code',)
614         verbose_name_plural = 'Thema'
615
616
617 class Audience(models.Model):
618     code = models.CharField(
619         max_length=128, unique=True,
620         help_text='Techniczny identifyikator. W miarę możliwości nie należy zmieniać.'
621     )
622     name = models.CharField(
623         max_length=1024,
624         help_text='W formie: „dla … (kogo?)”'
625     )
626     slug = models.SlugField(
627         max_length=255, null=True, blank=True, unique=True,
628         help_text='Element adresu na WL, w postaci: /dla/slug/. Można zmieniać.'
629     )
630     description = models.TextField(blank=True)
631     thema = models.CharField(
632         max_length=32, blank=True,
633         help_text='Odpowiadający kwalifikator Thema.'
634     )
635     woblink = models.IntegerField(null=True, blank=True)
636
637     class Meta:
638         ordering = ('code',)