Standardize book serialization.
[wolnelektury.git] / src / social / models.py
index 37cfecd..2692538 100644 (file)
@@ -1,24 +1,32 @@
-# This file is part of Wolnelektury, licensed under GNU Affero GPLv3 or later.
-# Copyright © Fundacja Nowoczesna Polska. See NOTICE for more information.
+# This file is part of Wolne Lektury, licensed under GNU Affero GPLv3 or later.
+# Copyright © Fundacja Wolne Lektury. See NOTICE for more information.
 #
+from datetime import datetime
+import uuid
+from oauthlib.common import urlencode, generate_token
+from pytz import utc
 from random import randint
 from django.db import models
 from django.conf import settings
+from django.contrib.auth.models import User
 from django.core.exceptions import ValidationError
+from django.core.mail import send_mail
 from django.urls import reverse
-from django.utils.translation import ugettext_lazy as _
+from django.utils.timezone import now
 from catalogue.models import Book
+from catalogue.utils import get_random_hash
 from wolnelektury.utils import cached_render, clear_cached_renders
+from .syncable import Syncable
 
 
 class BannerGroup(models.Model):
-    name = models.CharField(_('name'), max_length=255, unique=True)
-    created_at = models.DateTimeField(_('created at'), auto_now_add=True)
+    name = models.CharField('nazwa', max_length=255, unique=True)
+    created_at = models.DateTimeField('utworzona', auto_now_add=True)
 
     class Meta:
         ordering = ('name',)
-        verbose_name = _('banner group')
-        verbose_name_plural = _('banner groups')
+        verbose_name = 'grupa bannerów'
+        verbose_name_plural = 'grupy bannerów'
 
     def __str__(self):
         return self.name
@@ -36,41 +44,42 @@ class BannerGroup(models.Model):
 
 
 class Cite(models.Model):
-    book = models.ForeignKey(Book, models.CASCADE, verbose_name=_('book'), null=True, blank=True)
-    text = models.TextField(_('text'), blank=True)
-    small = models.BooleanField(_('small'), default=False, help_text=_('Make this cite display smaller.'))
-    vip = models.CharField(_('VIP'), max_length=128, null=True, blank=True)
-    link = models.URLField(_('link'))
-    video = models.URLField(_('video'), blank=True)
-    picture = models.ImageField(_('picture'), blank=True,
+    book = models.ForeignKey(Book, models.CASCADE, verbose_name='książka', null=True, blank=True)
+    text = models.TextField('tekst', blank=True)
+    small = models.BooleanField(
+        'mały', default=False, help_text='Sprawia, że cytat wyświetla się mniejszym fontem.')
+    vip = models.CharField('VIP', max_length=128, null=True, blank=True)
+    link = models.URLField('odnośnik')
+    video = models.URLField('wideo', blank=True)
+    picture = models.ImageField('ilustracja', blank=True,
             help_text='Najlepsze wymiary: 975 x 315 z tekstem, 487 x 315 bez tekstu.')
-    picture_alt = models.CharField(_('picture alternative text'), max_length=255, blank=True)
-    picture_title = models.CharField(_('picture title'), max_length=255, null=True, blank=True)
-    picture_author = models.CharField(_('picture author'), max_length=255, blank=True, null=True)
-    picture_link = models.URLField(_('picture link'), blank=True, null=True)
-    picture_license = models.CharField(_('picture license name'), max_length=255, blank=True, null=True)
-    picture_license_link = models.URLField(_('picture license link'), blank=True, null=True)
-
-    sticky = models.BooleanField(_('sticky'), default=False, db_index=True,
-                                 help_text=_('Sticky cites will take precedense.'))
-    background_plain = models.BooleanField(_('plain background'), default=False)
-    background_color = models.CharField(_('background color'), max_length=32, blank=True)
+    picture_alt = models.CharField('alternatywny tekst ilustracji', max_length=255, blank=True)
+    picture_title = models.CharField('tytuł ilustracji', max_length=255, null=True, blank=True)
+    picture_author = models.CharField('autor ilustracji', max_length=255, blank=True, null=True)
+    picture_link = models.URLField('link ilustracji', blank=True, null=True)
+    picture_license = models.CharField('nazwa licencji ilustracji', max_length=255, blank=True, null=True)
+    picture_license_link = models.URLField('adres licencji ilustracji', blank=True, null=True)
+
+    sticky = models.BooleanField('przyklejony', default=False, db_index=True,
+                                 help_text='Przyklejone cytaty mają pierwszeństwo.')
+    background_plain = models.BooleanField('jednobarwne tło', default=False)
+    background_color = models.CharField('kolor tła', max_length=32, blank=True)
     image = models.ImageField(
-        _('background image'), upload_to='social/cite', null=True, blank=True,
-        help_text=_('Best background is 975 x 315 px and under 100kB.'))
-    image_title = models.CharField(_('background title'), max_length=255, null=True, blank=True)
-    image_author = models.CharField(_('background author'), max_length=255, blank=True, null=True)
-    image_link = models.URLField(_('background link'), blank=True, null=True)
-    image_license = models.CharField(_('background license name'), max_length=255, blank=True, null=True)
-    image_license_link = models.URLField(_('background license link'), blank=True, null=True)
+        'obraz tła', upload_to='social/cite', null=True, blank=True,
+        help_text='Najlepsze tło ma wielkość 975 x 315 px i waży poniżej 100kB.')
+    image_title = models.CharField('tytuł obrazu tła', max_length=255, null=True, blank=True)
+    image_author = models.CharField('autor obrazu tła', max_length=255, blank=True, null=True)
+    image_link = models.URLField('link obrazu tła', blank=True, null=True)
+    image_license = models.CharField('nazwa licencji obrazu tła', max_length=255, blank=True, null=True)
+    image_license_link = models.URLField('adres licencji obrazu tła', blank=True, null=True)
 
-    created_at = models.DateTimeField(_('created at'), auto_now_add=True)
-    group = models.ForeignKey(BannerGroup, verbose_name=_('group'), null=True, blank=True, on_delete=models.SET_NULL)
+    created_at = models.DateTimeField('utworzony', auto_now_add=True)
+    group = models.ForeignKey(BannerGroup, verbose_name='grupa', null=True, blank=True, on_delete=models.SET_NULL)
 
     class Meta:
         ordering = ('vip', 'text')
-        verbose_name = _('banner')
-        verbose_name_plural = _('banners')
+        verbose_name = 'banner'
+        verbose_name_plural = 'bannery'
 
     def __str__(self):
         t = []
@@ -123,36 +132,290 @@ class Cite(models.Model):
 
 
 class Carousel(models.Model):
-    slug = models.SlugField(_('slug'), unique=True)
+    placement = models.SlugField('miejsce', choices=[
+        ('main', 'main'),
+        ('main_2022', 'main 2022'),
+    ])
+    priority = models.SmallIntegerField('priorytet', default=0)
+    language = models.CharField('język', max_length=2, blank=True, default='', choices=settings.LANGUAGES)
 
     class Meta:
-        ordering = ('slug',)
-        verbose_name = _('carousel')
-        verbose_name_plural = _('carousels')
+#        ordering = ('placement', '-priority')
+        verbose_name = 'karuzela'
+        verbose_name_plural = 'karuzele'
 
     def __str__(self):
-        return self.slug
+        return self.placement
+
+    @classmethod
+    def get(cls, placement):
+        carousel = cls.objects.filter(placement=placement).order_by('-priority', '?').first()
+        if carousel is None:
+            carousel = cls.objects.create(placement=placement)
+        return carousel
+
 
 class CarouselItem(models.Model):
-    order = models.PositiveSmallIntegerField(_('order'), unique=True)
-    carousel = models.ForeignKey(Carousel, models.CASCADE, verbose_name=_('carousel'))
-    banner = models.ForeignKey(Cite, models.CASCADE, null=True, blank=True, verbose_name=_('banner'))
-    banner_group = models.ForeignKey(BannerGroup, models.CASCADE, null=True, blank=True, verbose_name=_('banner group'))
+    order = models.PositiveSmallIntegerField('kolejność')
+    carousel = models.ForeignKey(Carousel, models.CASCADE, verbose_name='karuzela')
+    banner = models.ForeignKey(
+        Cite, models.CASCADE, null=True, blank=True, verbose_name='banner')
+    banner_group = models.ForeignKey(
+        BannerGroup, models.CASCADE, null=True, blank=True, verbose_name='grupa bannerów')
 
     class Meta:
         ordering = ('order',)
-        unique_together = [('carousel', 'order')]
-        verbose_name = _('carousel item')
-        verbose_name_plural = _('carousel items')
+        verbose_name = 'element karuzeli'
+        verbose_name_plural = 'elementy karuzeli'
 
     def __str__(self):
         return str(self.banner or self.banner_group)
 
     def clean(self):
         if not self.banner and not self.banner_group:
-            raise ValidationError(_('Either banner or banner group is required.'))
+            raise ValidationError('Proszę wskazać banner albo grupę bannerów.')
         elif self.banner and self.banner_group:
-            raise ValidationError(_('Either banner or banner group is required.'))
+            raise ValidationError('Proszę wskazać banner albo grupę bannerów.')
 
     def get_banner(self):
         return self.banner or self.banner_group.get_banner()
+
+
+class UserConfirmation(models.Model):
+    user = models.ForeignKey(User, models.CASCADE)
+    created_at = models.DateTimeField(auto_now_add=True)
+    key = models.CharField(max_length=128, unique=True)
+
+    def send(self):
+        send_mail(
+            'Potwierdź konto w bibliotece Wolne Lektury',
+            f'https://beta.wolnelektury.pl/ludzie/potwierdz/{self.key}/',
+            settings.CONTACT_EMAIL,
+            [self.user.email]
+        )
+
+    def use(self):
+        user = self.user
+        user.is_active = True
+        user.save()
+        self.delete()
+    
+    @classmethod
+    def request(cls, user):
+        cls.objects.create(
+            user=user,
+            key=generate_token()
+        ).send()
+
+
+class Progress(Syncable, models.Model):
+    user = models.ForeignKey(User, models.CASCADE)
+    book = models.ForeignKey('catalogue.Book', models.CASCADE)
+    created_at = models.DateTimeField(auto_now_add=True)
+    updated_at = models.DateTimeField(auto_now=True)
+    reported_timestamp = models.DateTimeField()
+    deleted = models.BooleanField(default=False)
+    last_mode = models.CharField(max_length=64, choices=[
+        ('text', 'text'),
+        ('audio', 'audio'),
+    ])
+    text_percent = models.FloatField(null=True, blank=True)
+    text_anchor = models.CharField(max_length=64, blank=True)
+    audio_percent = models.FloatField(null=True, blank=True)
+    audio_timestamp = models.FloatField(null=True, blank=True)
+    implicit_text_percent = models.FloatField(null=True, blank=True)
+    implicit_text_anchor = models.CharField(max_length=64, blank=True)
+    implicit_audio_percent = models.FloatField(null=True, blank=True)
+    implicit_audio_timestamp = models.FloatField(null=True, blank=True)
+
+    syncable_fields = [
+        'deleted',
+        'last_mode', 'text_anchor', 'audio_timestamp'
+    ]
+    
+    class Meta:
+        unique_together = [('user', 'book')]
+
+    @property
+    def timestamp(self):
+        return self.updated_at.timestamp()
+
+    @classmethod
+    def create_from_data(cls, user, data):
+        return cls.objects.create(
+            user=user,
+            book=data['book']
+        )
+        
+    def save(self, *args, **kwargs):
+        try:
+            audio_l = self.book.get_audio_length()
+        except:
+            audio_l = 60
+        if self.text_anchor:
+            self.text_percent = 33
+            if audio_l:
+                self.implicit_audio_percent = 40
+                self.implicit_audio_timestamp = audio_l * .4
+        if self.audio_timestamp:
+            if self.audio_timestamp > audio_l:
+                self.audio_timestamp = audio_l
+            if audio_l:
+                self.audio_percent = 100 * self.audio_timestamp / audio_l
+                self.implicit_text_percent = 60
+                self.implicit_text_anchor = 'f20'
+        return super().save(*args, **kwargs)
+
+
+class UserList(Syncable, models.Model):
+    slug = models.SlugField(unique=True)
+    user = models.ForeignKey(User, models.CASCADE)
+    name = models.CharField(max_length=1024)
+    favorites = models.BooleanField(default=False)
+    public = models.BooleanField(default=False)
+    deleted = models.BooleanField(default=False)
+    created_at = models.DateTimeField(auto_now_add=True)
+    updated_at = models.DateTimeField(auto_now=True)
+    reported_timestamp = models.DateTimeField()
+
+    syncable_fields = ['name', 'public', 'deleted']
+    
+    def get_absolute_url(self):
+        return reverse(
+            'tagged_object_list',
+            args=[f'polka/{self.slug}']
+        )
+
+    def __str__(self):
+        return self.name
+
+    @property
+    def url_chunk(self):
+        return f'polka/{self.slug}'
+    
+    @classmethod
+    def create_from_data(cls, user, data):
+        return cls.create(user, data['name'])
+
+    @classmethod
+    def create(cls, user, name):
+        n = now()
+        return cls.objects.create(
+            user=user,
+            name=name,
+            slug=get_random_hash(name),
+            updated_at=n,
+            reported_timestamp=n,
+        )
+
+    @classmethod
+    def get_by_name(cls, user, name, create=False):
+        l = cls.objects.filter(
+            user=user,
+            name=name
+        ).first()
+        if l is None and create:
+            l = cls.create(user, name)
+        return l
+        
+    @classmethod
+    def get_favorites_list(cls, user, create=False):
+        try:
+            return cls.objects.get(
+                user=user,
+                favorites=True
+            )
+        except cls.DoesNotExist:
+            if create:
+                return cls.objects.create(
+                    user=user,
+                    favorites=True,
+                    slug=get_random_hash(name),
+                    updated_at=now()
+                )
+            else:
+                return None
+        except cls.MultipleObjectsReturned:
+            # merge?
+            lists = list(cls.objects.filter(user=user, favorites=True))
+            for l in lists[1:]:
+                t.userlistitem_set.all().update(
+                    list=lists[0]
+                )
+                l.delete()
+            return lists[0]
+
+    @classmethod
+    def likes(cls, user, book):
+        ls = cls.get_favorites_list(user)
+        if ls is None:
+            return False
+        return ls.userlistitem_set.filter(deleted=False, book=book).exists()
+
+    def append(self, book):
+        # TODO: check for duplicates?
+        n = now()
+        item = self.userlistitem_set.create(
+            book=book,
+            order=(self.userlistitem_set.aggregate(m=models.Max('order'))['m'] or 0) + 1,
+            updated_at=n,
+            reported_timestamp=n,
+        )
+        book.update_popularity()
+        return item
+
+    def remove(self, book):
+        self.userlistitem_set.filter(book=book).update(
+            deleted=True,
+            updated_at=now()
+        )
+        book.update_popularity()
+
+    @classmethod
+    def like(cls, user, book):
+        ul = cls.get_favorites_list(user, create=True)
+        ul.append(book)
+
+    @classmethod
+    def unlike(cls, user, book):
+        ul = cls.get_favorites_list(user)
+        if ul is not None:
+            ul.remove(book)
+
+    def get_books(self):
+        return [item.book for item in self.userlistitem_set.exclude(deleted=True).exclude(book=None)]
+            
+
+class UserListItem(Syncable, models.Model):
+    list = models.ForeignKey(UserList, models.CASCADE)
+    uuid = models.UUIDField(unique=True, default=uuid.uuid4, editable=False, blank=True)
+    order = models.IntegerField()
+    deleted = models.BooleanField(default=False)
+    created_at = models.DateTimeField(auto_now_add=True)
+    updated_at = models.DateTimeField(auto_now=True)
+    reported_timestamp = models.DateTimeField()
+
+    book = models.ForeignKey('catalogue.Book', models.SET_NULL, null=True, blank=True)
+    fragment = models.ForeignKey('catalogue.Fragment', models.SET_NULL, null=True, blank=True)
+    quote = models.ForeignKey('bookmarks.Quote', models.SET_NULL, null=True, blank=True)
+    bookmark = models.ForeignKey('bookmarks.Bookmark', models.SET_NULL, null=True, blank=True)
+
+    note = models.TextField(blank=True)
+    
+    syncable_fields = ['order', 'deleted', 'book', 'fragment', 'quote', 'bookmark', 'note']
+
+    @classmethod
+    def create_from_data(cls, user, data):
+        if data.get('favorites'):
+            l = UserList.get_favorites_list(user, create=True)
+        else:
+            l = data['list']
+            try:
+                assert l.user == user
+            except AssertionError:
+                return
+        return l.append(book=data['book'])
+
+    @property
+    def favorites(self):
+        return self.list.favorites