Nicer collection boxes.
[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 _, get_language
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     background_plain = models.BooleanField(_('plain background'), default=False)
57     background_color = models.CharField(_('background color'), max_length=32, blank=True)
58     image = models.ImageField(
59         _('background image'), upload_to='social/cite', null=True, blank=True,
60         help_text=_('Best background is 975 x 315 px and under 100kB.'))
61     image_title = models.CharField(_('background title'), max_length=255, null=True, blank=True)
62     image_author = models.CharField(_('background author'), max_length=255, blank=True, null=True)
63     image_link = models.URLField(_('background link'), blank=True, null=True)
64     image_license = models.CharField(_('background license name'), max_length=255, blank=True, null=True)
65     image_license_link = models.URLField(_('background license link'), blank=True, null=True)
66
67     created_at = models.DateTimeField(_('created at'), auto_now_add=True)
68     group = models.ForeignKey(BannerGroup, verbose_name=_('group'), null=True, blank=True, on_delete=models.SET_NULL)
69
70     class Meta:
71         ordering = ('vip', 'text')
72         verbose_name = _('banner')
73         verbose_name_plural = _('banners')
74
75     def __str__(self):
76         t = []
77         if self.text:
78             t.append(self.text[:60])
79         if self.book_id:
80             t.append('[ks.]'[:60])
81         t.append(self.link[:60])
82         if self.vip:
83             t.append('vip: ' + self.vip)
84         if self.picture:
85             t.append('[obr.]')
86         if self.video:
87             t.append('[vid.]')
88         return ', '.join(t)
89
90     def get_absolute_url(self):
91         """This is used for testing."""
92         return "%s?banner=%d" % (reverse('main_page'), self.id)
93
94     def has_box(self):
95         return self.video or self.picture
96
97     def has_body(self):
98         return self.vip or self.text or self.book
99
100     def layout(self):
101         pieces = []
102         if self.has_box():
103             pieces.append('box')
104         if self.has_body():
105             pieces.append('text')
106         return '-'.join(pieces)
107
108
109     def save(self, *args, **kwargs):
110         ret = super(Cite, self).save(*args, **kwargs)
111         self.clear_cache()
112         return ret
113
114     @cached_render('social/cite_promo.html')
115     def main_box(self):
116         return {
117             'cite': self,
118             'main': True,
119         }
120
121     def clear_cache(self):
122         clear_cached_renders(self.main_box)
123
124
125 class Carousel(models.Model):
126     placement = models.SlugField(_('placement'), choices=[
127         ('main', 'main'),
128     ])
129     priority = models.SmallIntegerField(_('priority'), default=0)
130     language = models.CharField(_('language'), max_length=2, blank=True, default='', choices=settings.LANGUAGES)
131
132     class Meta:
133 #        ordering = ('placement', '-priority')
134         verbose_name = _('carousel')
135         verbose_name_plural = _('carousels')
136
137     def __str__(self):
138         return self.placement
139
140     @classmethod
141     def get(cls, placement):
142         carousel = cls.objects.filter(models.Q(language='') | models.Q(language=get_language()), placement=placement).order_by('-priority', '?').first()
143         if carousel is None:
144             carousel = cls.objects.create(placement=placement)
145         return carousel
146
147
148 class CarouselItem(models.Model):
149     order = models.PositiveSmallIntegerField(_('order'), unique=True)
150     carousel = models.ForeignKey(Carousel, models.CASCADE, verbose_name=_('carousel'))
151     banner = models.ForeignKey(Cite, models.CASCADE, null=True, blank=True, verbose_name=_('banner'))
152     banner_group = models.ForeignKey(BannerGroup, models.CASCADE, null=True, blank=True, verbose_name=_('banner group'))
153
154     class Meta:
155         ordering = ('order',)
156         unique_together = [('carousel', 'order')]
157         verbose_name = _('carousel item')
158         verbose_name_plural = _('carousel items')
159
160     def __str__(self):
161         return str(self.banner or self.banner_group)
162
163     def clean(self):
164         if not self.banner and not self.banner_group:
165             raise ValidationError(_('Either banner or banner group is required.'))
166         elif self.banner and self.banner_group:
167             raise ValidationError(_('Either banner or banner group is required.'))
168
169     def get_banner(self):
170         return self.banner or self.banner_group.get_banner()