1 from collections import Counter
2 from datetime import date, timedelta
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
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?)'
28 name_de = models.CharField(_("name (de)"), max_length=255, blank=True)
29 name_lt = models.CharField(_("name (lt)"), max_length=255, blank=True)
31 gender = models.CharField(_("gender"), max_length=255, blank=True)
32 nationality = models.CharField(_("nationality"), max_length=255, blank=True)
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.')
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'
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.')
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'
60 status = models.PositiveSmallIntegerField(
71 notes = models.TextField(_("notes"), blank=True, help_text=_('private'))
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)
80 description = models.TextField(_("description"), blank=True, help_text=_('for publication'))
82 priority = models.PositiveSmallIntegerField(
84 default=0, choices=[(0, _("Low")), (1, _("Medium")), (2, _("High"))]
86 collections = models.ManyToManyField("Collection", blank=True, verbose_name=_("collections"))
88 woblink = models.IntegerField(null=True, blank=True)
91 verbose_name = _('author')
92 verbose_name_plural = _('authors')
93 ordering = ("last_name", "first_name", "year_of_death")
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")
107 photo = WikiMedia.download(WIKIDATA.IMAGE)
108 photo_source = WikiMedia.descriptionurl(WIKIDATA.IMAGE)
109 photo_attribution = WikiMedia.attribution(WIKIDATA.IMAGE)
111 def _supplement(obj):
112 if not obj.first_name and not obj.last_name:
113 yield 'first_name', 'label'
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})'
121 def get_absolute_url(self):
122 return reverse("catalogue_author", args=[self.slug])
125 def get_by_literal(cls, literal):
126 names = literal.split(',', 1)
127 names = [n.strip() for n in names]
129 return cls.objects.filter(last_name=names[0], first_name=names[1]).first()
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()
138 return f"{self.last_name}, {self.first_name}"
142 if self.year_of_death:
143 return self.year_of_death + 71
144 elif self.year_of_death == 0:
149 def generate_description(self):
150 t = render_to_string(
151 'catalogue/author_description.html',
156 def century_description(self, number):
177 def birth_century_description(self):
178 return self.century_description(self.century_of_birth)
180 def death_century_description(self):
181 return self.century_description(self.century_of_death)
183 def year_description(self, number):
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)
197 class NotableBook(OrderableModel):
198 author = models.ForeignKey(Author, models.CASCADE)
199 book = models.ForeignKey('Book', models.CASCADE)
202 return self.book.title
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'))
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'
222 adjective_nonmasculine_plural = models.CharField(
223 'przymiotnik mnogi niemęskoosobowy', max_length=255, blank=True,
224 help_text='utwory … Adama Mickiewicza'
228 verbose_name = _('epoch')
229 verbose_name_plural = _('epochs')
232 class Genre(Category):
233 plural = models.CharField(
234 'liczba mnoga', max_length=255, blank=True,
236 is_epoch_specific = models.BooleanField(
238 help_text='Po wskazaniu tego gatunku, dodanie epoki byłoby nadmiarowe, np. „dramat romantyczny”'
242 verbose_name = _('genre')
243 verbose_name_plural = _('genres')
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”'
253 verbose_name = _('kind')
254 verbose_name_plural = _('kinds')
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(
262 related_name="translated_book_set",
263 related_query_name="translated_book",
265 verbose_name=_("translators")
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")
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(
281 default=0, choices=[(0, _("Low")), (1, _("Medium")), (2, _("High"))]
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"))
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)
293 free_license = models.BooleanField(_('free license'), default=False)
294 polona_missing = models.BooleanField(_('missing on Polona'), default=False)
296 monthly_views_reader = models.IntegerField(default=0)
297 monthly_views_page = models.IntegerField(default=0)
300 ordering = ("title",)
301 verbose_name = _('book')
302 verbose_name_plural = _('books')
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")
316 if self.original_year:
317 txt = f"{txt} ({self.original_year})"
318 astr = self.authors_str()
320 txt = f"{txt}, {astr}"
321 tstr = self.translators_str()
323 txt = f"{txt}, tłum. {tstr}"
326 def get_absolute_url(self):
327 return reverse("catalogue_book", args=[self.slug])
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)
332 def audio_status(self):
337 return f'https://wolnelektury.pl/katalog/lektura/{self.slug}/'
339 def authors_str(self):
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')
346 def translators_str(self):
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')
353 def authors_first_names(self):
354 return ', '.join(a.first_name for a in self.authors.all())
356 def authors_last_names(self):
357 return ', '.join(a.last_name for a in self.authors.all())
359 def translators_first_names(self):
360 return ', '.join(a.first_name for a in self.translators.all())
362 def translators_last_names(self):
363 return ', '.join(a.last_name for a in self.translators.all())
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
373 return self.document_books.first().wldocument().book_info.audience or ''
377 def get_estimated_costs(self):
379 work_type: work_type.calculate(self)
380 for work_type in WorkType.objects.all()
383 def scans_gallery(self):
384 bs = self.booksource_set.first()
389 def is_published(self):
390 return any(b.is_published() for b in self.document_books.all())
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)
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
409 stats = self.bookmonthlystats_set.filter(date__gte=cutoff).aggregate(
410 views_page=models.Sum('views_page'),
411 views_reader=models.Sum('views_reader')
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'])
418 def content_stats(self):
419 if hasattr(self, '_content_stats'):
420 return self._content_stats
422 stats = self.document_books.first().wldocument(librarian2=True).get_statistics()['total']
423 except Exception as e:
425 self._content_stats = stats
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', '')
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'))
443 ordering = ('parent__name', 'name')
444 verbose_name = _('collection category')
445 verbose_name_plural = _('collection categories')
449 return f"{self.parent} / {self.name}"
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)
462 ordering = ('category', 'name')
463 verbose_name = _('collection')
464 verbose_name_plural = _('collections')
468 return f"{self.category} / {self.name}"
472 def get_estimated_costs(self):
474 for book in self.book_set.all():
475 for k, v in book.get_estimated_costs().items():
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():
482 for book in author.translated_book_set.all():
483 for k, v in book.get_estimated_costs().items():
488 class WorkType(models.Model):
489 name = models.CharField(_("name"), max_length=255)
493 verbose_name = _('work type')
494 verbose_name_plural = _('work types')
496 def get_rate_for(self, book):
497 for workrate in self.workrate_set.all():
498 if workrate.matches(book):
501 def calculate(self, book):
502 workrate = self.get_rate_for(book)
503 if workrate is not None:
504 return workrate.calculate(book)
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"))
519 ordering = ('priority',)
520 verbose_name = _('work rate')
521 verbose_name_plural = _('work rates')
523 def matches(self, book):
524 for category in 'epochs', 'kinds', 'genres', 'collections':
525 oneof = getattr(self, category).all()
527 if not set(oneof).intersection(
528 getattr(book, category).all()):
532 def calculate(self, book):
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)
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…'))
546 verbose_name = _('place')
547 verbose_name_plural = _('places')
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)
563 def build_for_month(cls, date):
564 date = date.replace(day=1)
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:]
572 m = re.match('^/katalog/lektura/([^,./]+)\.html,', line)
574 which = 'views_reader'
576 m = re.match('^/katalog/lektura/([^,./]+)/,', line)
581 _url, _uviews, views, _rest = line.split(',', 3)
584 book = Book.objects.get(slug=slug)
585 except Book.DoesNotExist:
588 cls.objects.update_or_create(
589 book=book, date=date,
590 defaults={which: views}
592 book.update_monthly_stats()
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ć.'
602 plural = models.CharField(
603 'liczba mnoga', max_length=255, blank=True,
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)
614 verbose_name_plural = 'Thema'
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ć.'
622 name = models.CharField(
624 help_text='W formie: „dla … (kogo?)”'
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ć.'
630 description = models.TextField(blank=True)
631 thema = models.CharField(
632 max_length=32, blank=True,
633 help_text='Odpowiadający kwalifikator Thema.'
635 woblink = models.IntegerField(null=True, blank=True)