Unlisted collections.
[wolnelektury.git] / src / catalogue / models / collection.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 django.conf import settings
5 from django.db import models
6 from django.urls import reverse
7 from django.utils.translation import ugettext_lazy as _
8 import re
9 from wolnelektury.utils import cached_render, clear_cached_renders
10
11
12 class Collection(models.Model):
13     """A collection of books, which might be defined before publishing them."""
14     title = models.CharField(_('title'), max_length=120, db_index=True)
15     slug = models.SlugField(_('slug'), max_length=120, primary_key=True)
16     description = models.TextField(_('description'), null=True, blank=True)
17     book_slugs = models.TextField(_('book slugs'))
18     kind = models.CharField(_('kind'), max_length=10, blank=False, default='book', db_index=True,
19                             choices=(('book', _('book')), ('picture', _('picture'))))
20     listed = models.BooleanField(_('listed'), default=True, db_index=True)
21     role = models.CharField(max_length=128, blank=True, db_index=True, choices=[
22         ('', '–'),
23         ('recommend', _('recommended')),
24     ])
25
26     class Meta:
27         ordering = ('title',)
28         verbose_name = _('collection')
29         verbose_name_plural = _('collections')
30         app_label = 'catalogue'
31
32     def __str__(self):
33         return self.title
34
35     def get_initial(self):
36         try:
37             return re.search(r'\w', self.title, re.U).group(0)
38         except AttributeError:
39             return ''
40
41     def get_absolute_url(self):
42         return reverse("collection", args=[self.slug])
43
44     def get_query(self):
45         slugs = self.book_slugs.split()
46         # allow URIs
47         slugs = [slug.rstrip('/').rsplit('/', 1)[-1] if '/' in slug else slug for slug in slugs]
48         return models.Q(slug__in=slugs)
49
50     def get_books(self):
51         from catalogue.models import Book
52         return Book.objects.filter(self.get_query())
53
54     @cached_render('catalogue/collection_box.html')
55     def box(self):
56         return {
57             'collection': self
58         }
59
60     def clear_cache(self):
61         clear_cached_renders(self.box)