Housekeeping.
[wolnelektury.git] / src / social / models.py
1 # This file is part of Wolnelektury, licensed under GNU Affero GPLv3 or later.
2 # Copyright © Fundacja Nowoczesna Polska. See NOTICE for more information.
3 #
4 from random import randint
5 from django.db import models
6 from django.conf import settings
7 from django.core.exceptions import ValidationError
8 from django.urls import reverse
9 from django.utils.translation import ugettext_lazy as _
10 from catalogue.models import Book
11 from wolnelektury.utils import cached_render, clear_cached_renders
12
13
14 class BannerGroup(models.Model):
15     name = models.CharField(_('name'), max_length=255, unique=True)
16     created_at = models.DateTimeField(_('created at'), auto_now_add=True)
17
18     class Meta:
19         ordering = ('name',)
20         verbose_name = _('banner group')
21         verbose_name_plural = _('banner groups')
22
23     def __str__(self):
24         return self.name
25
26     def get_absolute_url(self):
27         """This is used for testing."""
28         return "%s?banner_group=%d" % (reverse('main_page'), self.id)
29
30     def get_banner(self):
31         banners = self.cite_set.all()
32         count = banners.count()
33         if not count:
34             return None
35         return banners[randint(0, count-1)]
36
37
38 class Cite(models.Model):
39     book = models.ForeignKey(Book, models.CASCADE, verbose_name=_('book'), null=True, blank=True)
40     text = models.TextField(_('text'), blank=True)
41     small = models.BooleanField(_('small'), default=False, help_text=_('Make this cite display smaller.'))
42     vip = models.CharField(_('VIP'), max_length=128, null=True, blank=True)
43     link = models.URLField(_('link'))
44     video = models.URLField(_('video'), blank=True)
45     picture = models.ImageField(_('picture'), blank=True,
46             help_text='Najlepsze wymiary: 975 x 315 z tekstem, 487 x 315 bez tekstu.')
47     picture_alt = models.CharField(_('picture alternative text'), max_length=255, blank=True)
48     picture_title = models.CharField(_('picture title'), max_length=255, null=True, blank=True)
49     picture_author = models.CharField(_('picture author'), max_length=255, blank=True, null=True)
50     picture_link = models.URLField(_('picture link'), blank=True, null=True)
51     picture_license = models.CharField(_('picture license name'), max_length=255, blank=True, null=True)
52     picture_license_link = models.URLField(_('picture license link'), blank=True, null=True)
53
54     sticky = models.BooleanField(_('sticky'), default=False, db_index=True,
55                                  help_text=_('Sticky cites will take precedense.'))
56     banner = models.BooleanField(_('banner'), default=False, help_text=
57             'Dostosuj wielkość do obrazu tła, zignoruj tekst.'
58             '<br>(Przestarzałe; użyj funkcji "Obraz" w sekcji "Media box")')
59
60     background_plain = models.BooleanField(_('plain background'), default=False)
61     background_color = models.CharField(_('background color'), max_length=32, blank=True)
62     image = models.ImageField(
63         _('image'), upload_to='social/cite', null=True, blank=True,
64         help_text=_('Best image is exactly 975px wide and weights under 100kB.'))
65     image_shift = models.IntegerField(
66         _('shift'), null=True, blank=True,
67         help_text='Przesunięcie w pionie, w procentach. 0 to wyrównanie do górnej krawędzi, 100 do dolnej. Domyślne jest 50%.'
68             '<br>(Przestarzałe; użyj obrazka o właściwych proporcjach;)')
69     image_title = models.CharField(_('title'), max_length=255, null=True, blank=True)
70     image_author = models.CharField(_('author'), max_length=255, blank=True, null=True)
71     image_link = models.URLField(_('link'), blank=True, null=True)
72     image_license = models.CharField(_('license name'), max_length=255, blank=True, null=True)
73     image_license_link = models.URLField(_('license link'), blank=True, null=True)
74
75     created_at = models.DateTimeField(_('created at'), auto_now_add=True)
76     group = models.ForeignKey(BannerGroup, verbose_name=_('group'), null=True, blank=True, on_delete=models.SET_NULL)
77
78     class Meta:
79         ordering = ('vip', 'text')
80         verbose_name = _('banner')
81         verbose_name_plural = _('banners')
82
83     def __str__(self):
84         t = []
85         if self.text:
86             t.append(self.text[:60])
87         if self.book_id:
88             t.append('[ks.]'[:60])
89         t.append(self.link[:60])
90         if self.vip:
91             t.append('vip: ' + self.vip)
92         if self.picture:
93             t.append('[obr.]')
94         if self.video:
95             t.append('[vid.]')
96         return ', '.join(t)
97
98     def get_absolute_url(self):
99         """This is used for testing."""
100         return "%s?banner=%d" % (reverse('main_page'), self.id)
101
102     def has_box(self):
103         return self.video or self.picture
104
105     def has_body(self):
106         return self.vip or self.text or self.book
107
108     def layout(self):
109         if self.banner:
110             # TODO: move all banners to pictures.
111             return 'banner'
112         pieces = []
113         if self.has_box():
114             pieces.append('box')
115         if self.has_body():
116             pieces.append('text')
117         return '-'.join(pieces)
118
119
120     def save(self, *args, **kwargs):
121         ret = super(Cite, self).save(*args, **kwargs)
122         self.clear_cache()
123         return ret
124
125     @cached_render('social/cite_promo.html')
126     def main_box(self):
127         return {
128             'cite': self,
129             'main': True,
130         }
131
132     def clear_cache(self):
133         clear_cached_renders(self.main_box)
134
135
136 class Carousel(models.Model):
137     slug = models.SlugField(_('slug'), unique=True)
138
139     class Meta:
140         ordering = ('slug',)
141         verbose_name = _('carousel')
142         verbose_name_plural = _('carousels')
143
144     def __str__(self):
145         return self.slug
146
147 class CarouselItem(models.Model):
148     order = models.PositiveSmallIntegerField(_('order'), unique=True)
149     carousel = models.ForeignKey(Carousel, models.CASCADE, verbose_name=_('carousel'))
150     banner = models.ForeignKey(Cite, models.CASCADE, null=True, blank=True, verbose_name=_('banner'))
151     banner_group = models.ForeignKey(BannerGroup, models.CASCADE, null=True, blank=True, verbose_name=_('banner group'))
152
153     class Meta:
154         ordering = ('order',)
155         unique_together = [('carousel', 'order')]
156         verbose_name = _('carousel item')
157         verbose_name_plural = _('carousel items')
158
159     def __str__(self):
160         return str(self.banner or self.banner_group)
161
162     def clean(self):
163         if not self.banner and not self.banner_group:
164             raise ValidationError(_('Either banner or banner group is required.'))
165         elif self.banner and self.banner_group:
166             raise ValidationError(_('Either banner or banner group is required.'))
167
168     def get_banner(self):
169         return self.banner or self.banner_group.get_banner()