be7c37f79944d0f58ca7837c1344cc493d2980ac
[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     thema = models.CharField(
234         max_length=32, blank=True,
235         help_text='Odpowiadający kwalifikator Thema.'
236     )
237     plural = models.CharField(
238         'liczba mnoga', max_length=255, blank=True,
239     )
240     is_epoch_specific = models.BooleanField(
241         default=False,
242         help_text='Po wskazaniu tego gatunku, dodanie epoki byłoby nadmiarowe, np. „dramat romantyczny”'
243     )
244
245     class Meta:
246         verbose_name = _('genre')
247         verbose_name_plural = _('genres')
248
249
250 class Kind(Category):
251     collective_noun = models.CharField(
252         'określenie zbiorowe', max_length=255, blank=True,
253         help_text='np. „Liryka” albo „Twórczość dramatyczna”'
254     )
255
256     class Meta:
257         verbose_name = _('kind')
258         verbose_name_plural = _('kinds')
259
260
261 class Book(WikidataModel):
262     slug = models.SlugField(max_length=255, blank=True, null=True, unique=True)
263     authors = models.ManyToManyField(Author, blank=True, verbose_name=_("authors"))
264     translators = models.ManyToManyField(
265         Author,
266         related_name="translated_book_set",
267         related_query_name="translated_book",
268         blank=True,
269         verbose_name=_("translators")
270     )
271     epochs = models.ManyToManyField(Epoch, blank=True, verbose_name=_("epochs"))
272     kinds = models.ManyToManyField(Kind, blank=True, verbose_name=_("kinds"))
273     genres = models.ManyToManyField(Genre, blank=True, verbose_name=_("genres"))
274     title = models.CharField(_("title"), max_length=255, blank=True)
275     language = models.CharField(_("language"), max_length=255, blank=True)
276     based_on = models.ForeignKey(
277         "self", models.PROTECT, related_name="translation", null=True, blank=True,
278         verbose_name=_("based on")
279     )
280     scans_source = models.CharField(_("scans source"), max_length=255, blank=True)
281     text_source = models.CharField(_("text source"), max_length=255, blank=True)
282     notes = models.TextField(_("notes"), blank=True, help_text=_('private'))
283     priority = models.PositiveSmallIntegerField(
284         _("priority"),
285         default=0, choices=[(0, _("Low")), (1, _("Medium")), (2, _("High"))]
286     )
287     original_year = models.IntegerField(_('original publication year'), null=True, blank=True)
288     pd_year = models.IntegerField(_('year of entry into PD'), null=True, blank=True)
289     plwiki = models.CharField(blank=True, max_length=255)
290     gazeta_link = models.CharField(_("gazeta link"), max_length=255, blank=True)
291     collections = models.ManyToManyField("Collection", blank=True, verbose_name=_("collections"))
292
293     estimated_chars = models.IntegerField(_("estimated number of characters"), null=True, blank=True)
294     estimated_verses = models.IntegerField(_("estimated number of verses"), null=True, blank=True)
295     estimate_source = models.CharField(_("source of estimates"), max_length=2048, blank=True)
296
297     free_license = models.BooleanField(_('free license'), default=False)
298     polona_missing = models.BooleanField(_('missing on Polona'), default=False)
299
300     monthly_views_reader = models.IntegerField(default=0)
301     monthly_views_page = models.IntegerField(default=0)
302     
303     class Meta:
304         ordering = ("title",)
305         verbose_name = _('book')
306         verbose_name_plural = _('books')
307
308     class Wikidata:
309         plwiki = "plwiki"
310         authors = WIKIDATA.AUTHOR
311         translators = WIKIDATA.TRANSLATOR
312         title = WIKIDATA.TITLE
313         language = WIKIDATA.LANGUAGE
314         based_on = WIKIDATA.BASED_ON
315         original_year = WIKIDATA.PUBLICATION_DATE
316         notes = WikiMedia.append("description")
317
318     def __str__(self):
319         txt = self.title
320         if self.original_year:
321             txt = f"{txt} ({self.original_year})"
322         astr = self.authors_str()
323         if astr:
324             txt = f"{txt}, {astr}"
325         tstr = self.translators_str()
326         if tstr:
327             txt = f"{txt}, tłum. {tstr}"
328         return txt
329
330     def get_absolute_url(self):
331         return reverse("catalogue_book", args=[self.slug])
332
333     def is_text_public(self):
334         return self.free_license or (self.pd_year is not None and self.pd_year <= date.today().year)
335
336     def audio_status(self):
337         return {}
338     
339     @property
340     def wluri(self):
341         return f'https://wolnelektury.pl/katalog/lektura/{self.slug}/'
342     
343     def authors_str(self):
344         if not self.pk:
345             return ''
346         return ", ".join(str(author) for author in self.authors.all())
347     authors_str.admin_order_field = 'authors__last_name'
348     authors_str.short_description = _('Author')
349
350     def translators_str(self):
351         if not self.pk:
352             return ''
353         return ", ".join(str(author) for author in self.translators.all())
354     translators_str.admin_order_field = 'translators__last_name'
355     translators_str.short_description = _('Translator')
356
357     def authors_first_names(self):
358         return ', '.join(a.first_name for a in self.authors.all())
359
360     def authors_last_names(self):
361         return ', '.join(a.last_name for a in self.authors.all())
362
363     def translators_first_names(self):
364         return ', '.join(a.first_name for a in self.translators.all())
365
366     def translators_last_names(self):
367         return ', '.join(a.last_name for a in self.translators.all())
368
369     def document_book__project(self):
370         b = self.document_books.first()
371         if b is None: return ''
372         if b.project is None: return ''
373         return b.project.name
374
375     def audience(self):
376         try:
377             return self.document_books.first().wldocument().book_info.audience or ''
378         except:
379             return ''
380
381     def get_estimated_costs(self):
382         return {
383             work_type: work_type.calculate(self)
384             for work_type in WorkType.objects.all()
385         }
386
387     def scans_galleries(self):
388         return [bs.pk for bs in self.booksource_set.all()]
389
390     def is_published(self):
391         return any(b.is_published() for b in self.document_books.all())
392     
393     def update_monthly_stats(self):
394         # Find publication date.
395         # By default, get previous 12 months.
396         this_month = date.today().replace(day=1)
397         cutoff = this_month.replace(year=this_month.year - 1)
398         months = 12
399
400         # If the book was published later,
401         # find out the denominator.
402         pbr = apps.get_model('documents', 'BookPublishRecord').objects.filter(
403             book__catalogue_book=self).order_by('timestamp').first()
404         if pbr is not None and pbr.timestamp.date() > cutoff:
405             months = (this_month - pbr.timestamp.date()).days / 365 * 12
406
407         if not months:
408             return
409
410         stats = self.bookmonthlystats_set.filter(date__gte=cutoff).aggregate(
411             views_page=models.Sum('views_page'),
412             views_reader=models.Sum('views_reader')
413         )
414         self.monthly_views_page = stats['views_page'] / months
415         self.monthly_views_reader = stats['views_reader'] / months
416         self.save(update_fields=['monthly_views_page', 'monthly_views_reader'])
417
418     @property
419     def content_stats(self):
420         if hasattr(self, '_content_stats'):
421             return self._content_stats
422         try:
423             stats = self.document_books.first().wldocument(librarian2=True).get_statistics()['total']
424         except Exception as e:
425             stats = {}
426         self._content_stats = stats
427         return stats
428
429     @property
430     def are_sources_ready(self):
431         if not self.booksource_set.exists():
432             return False
433         for bs in self.booksource_set.all():
434             if not bs.source.has_view_files() or not bs.source.has_ocr_files() or bs.source.modified_at > bs.source.processed_at:
435                 return False
436         return True
437
438     chars = lambda self: self.content_stats.get('chars', '')
439     chars_with_fn = lambda self: self.content_stats.get('chars_with_fn', '')
440     words = lambda self: self.content_stats.get('words', '')
441     words_with_fn = lambda self: self.content_stats.get('words_with_fn', '')
442     verses = lambda self: self.content_stats.get('verses', '')
443     verses_with_fn = lambda self: self.content_stats.get('verses_with_fn', '')
444     chars_out_verse = lambda self: self.content_stats.get('chars_out_verse', '')
445     chars_out_verse_with_fn = lambda self: self.content_stats.get('chars_out_verse_with_fn', '')
446
447 class CollectionCategory(models.Model):
448     name = models.CharField(_("name"), max_length=255)
449     parent = models.ForeignKey('self', models.SET_NULL, related_name='children', null=True, blank=True, verbose_name=_("parent"))
450     notes = models.TextField(_("notes"), blank=True, help_text=_('private'))
451
452     class Meta:
453         ordering = ('parent__name', 'name')
454         verbose_name = _('collection category')
455         verbose_name_plural = _('collection categories')
456
457     def __str__(self):
458         if self.parent:
459             return f"{self.parent} / {self.name}"
460         else:
461             return self.name
462
463
464 class Collection(models.Model):
465     name = models.CharField(_("name"), max_length=255)
466     slug = models.SlugField(max_length=255, unique=True)
467     category = models.ForeignKey(CollectionCategory, models.SET_NULL, null=True, blank=True, verbose_name=_("category"))
468     notes = models.TextField(_("notes"), blank=True, help_text=_('private'))
469     description = models.TextField(_("description"), blank=True)
470
471     class Meta:
472         ordering = ('category', 'name')
473         verbose_name = _('collection')
474         verbose_name_plural = _('collections')
475
476     def __str__(self):
477         if self.category:
478             return f"{self.category} / {self.name}"
479         else:
480             return self.name
481
482     def get_estimated_costs(self):
483         costs = Counter()
484         for book in self.book_set.all():
485             for k, v in book.get_estimated_costs().items():
486                 costs[k] += v or 0
487
488         for author in self.author_set.all():
489             for book in author.book_set.all():
490                 for k, v in book.get_estimated_costs().items():
491                     costs[k] += v or 0
492             for book in author.translated_book_set.all():
493                 for k, v in book.get_estimated_costs().items():
494                     costs[k] += v or 0
495         return costs
496
497
498 class WorkType(models.Model):
499     name = models.CharField(_("name"), max_length=255)
500
501     class Meta:
502         ordering = ('name',)
503         verbose_name = _('work type')
504         verbose_name_plural = _('work types')
505     
506     def get_rate_for(self, book):
507         for workrate in self.workrate_set.all():
508             if workrate.matches(book):
509                 return workrate
510
511     def calculate(self, book):
512         workrate = self.get_rate_for(book)
513         if workrate is not None:
514             return workrate.calculate(book)
515         
516
517
518 class WorkRate(models.Model):
519     priority = models.IntegerField(_("priority"), default=1)
520     per_normpage = models.DecimalField(_("per normalized page"), decimal_places=2, max_digits=6, null=True, blank=True)
521     per_verse = models.DecimalField(_("per verse"), decimal_places=2, max_digits=6, null=True, blank=True)
522     work_type = models.ForeignKey(WorkType, models.CASCADE, verbose_name=_("work type"))
523     epochs = models.ManyToManyField(Epoch, blank=True, verbose_name=_("epochs"))
524     kinds = models.ManyToManyField(Kind, blank=True, verbose_name=_("kinds"))
525     genres = models.ManyToManyField(Genre, blank=True, verbose_name=_("genres"))
526     collections = models.ManyToManyField(Collection, blank=True, verbose_name=_("collections"))
527
528     class Meta:
529         ordering = ('priority',)
530         verbose_name = _('work rate')
531         verbose_name_plural = _('work rates')
532
533     def matches(self, book):
534         for category in 'epochs', 'kinds', 'genres', 'collections':
535             oneof = getattr(self, category).all()
536             if oneof:
537                 if not set(oneof).intersection(
538                         getattr(book, category).all()):
539                     return False
540         return True
541
542     def calculate(self, book):
543         if self.per_verse:
544             if book.estimated_verses:
545                 return book.estimated_verses * self.per_verse
546         elif self.per_normpage:
547             if book.estimated_chars:
548                 return (decimal.Decimal(book.estimated_chars) / 1800 * self.per_normpage).quantize(decimal.Decimal('1.00'), rounding=decimal.ROUND_HALF_UP)
549
550
551 class Place(WikidataModel):
552     name = models.CharField(_('name'), max_length=255, blank=True)
553     locative = models.CharField(_('locative'), max_length=255, blank=True, help_text=_('in…'))
554
555     class Meta:
556         verbose_name = _('place')
557         verbose_name_plural = _('places')
558     
559     class Wikidata:
560         name = 'label'
561
562     def __str__(self):
563         return self.name
564
565
566 class BookMonthlyStats(models.Model):
567     book = models.ForeignKey('catalogue.Book', models.CASCADE)
568     date = models.DateField()
569     views_reader = models.IntegerField(default=0)
570     views_page = models.IntegerField(default=0)
571
572     @classmethod
573     def build_for_month(cls, date):
574         date = date.replace(day=1)
575         period = 'month'
576
577         date = date.isoformat()
578         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'
579         data = urlopen(url).read().decode('utf-16')
580         lines = data.split('\n')[1:]
581         for line in lines:
582             m = re.match('^/katalog/lektura/([^,./]+)\.html,', line)
583             if m is not None:
584                 which = 'views_reader'
585             else:
586                 m = re.match('^/katalog/lektura/([^,./]+)/,', line)
587                 if m is not None:
588                     which = 'views_page'
589             if m is not None:
590                 slug = m.group(1)
591                 _url, _uviews, views, _rest = line.split(',', 3)
592                 views = int(views)
593                 try:
594                     book = Book.objects.get(slug=slug)
595                 except Book.DoesNotExist:
596                     continue
597                 else:
598                     cls.objects.update_or_create(
599                         book=book, date=date,
600                         defaults={which: views}
601                     )
602                     book.update_monthly_stats()
603
604
605 class Thema(models.Model):
606     code = models.CharField(
607         max_length=128, unique=True,
608         help_text='Używamy rozszerzenia <code>.WL-</code> do oznaczania własnych kodów.<br> '
609         'Przykładowo, w przypadku potrzeby stworzenia nowej kategorii „insurekcja kościuszkowska”, '
610         'można by ją utworzyć jako 3MLQ‑PL‑A.WL-A, czyli w ramach już istniejącej wyższej kategorii 3MLQ‑PL‑A „rozbiory Polski”.',
611     )
612     name = models.CharField(max_length=1024)
613     slug = models.SlugField(
614         max_length=255, null=True, blank=True, unique=True,
615         help_text='Element adresu na WL, w postaci: /tag/slug/. Można zmieniać.'
616     )
617     plural = models.CharField(
618         'liczba mnoga', max_length=255, blank=True,
619     )
620     description = models.TextField(blank=True)
621     public_description = models.TextField(blank=True)
622     usable = models.BooleanField()
623     usable_as_main = models.BooleanField(default=False)
624     hidden = models.BooleanField(default=False)
625     woblink_category = models.IntegerField(null=True, blank=True)
626
627     class Meta:
628         ordering = ('code',)
629         verbose_name_plural = 'Thema'
630
631
632 class Audience(models.Model):
633     code = models.CharField(
634         max_length=128, unique=True,
635         help_text='Techniczny identifyikator. W miarę możliwości nie należy zmieniać.'
636     )
637     name = models.CharField(
638         max_length=1024,
639         help_text='W formie: „dla … (kogo?)”'
640     )
641     slug = models.SlugField(
642         max_length=255, null=True, blank=True, unique=True,
643         help_text='Element adresu na WL, w postaci: /dla/slug/. Można zmieniać.'
644     )
645     description = models.TextField(blank=True)
646     thema = models.CharField(
647         max_length=32, blank=True,
648         help_text='Odpowiadający kwalifikator Thema.'
649     )
650     woblink = models.IntegerField(null=True, blank=True)
651
652     class Meta:
653         ordering = ('code',)