1 # -*- coding: utf-8 -*-
2 # This file is part of Wolnelektury, licensed under GNU Affero GPLv3 or later.
3 # Copyright © Fundacja Nowoczesna Polska. See NOTICE for more information.
5 from django.conf import settings
6 from django.contrib.contenttypes.fields import GenericForeignKey
7 from django.contrib.contenttypes.models import ContentType
8 from django.core.cache import caches
9 from django.contrib.auth.models import User
10 from django.core.exceptions import ObjectDoesNotExist
11 from django.db import models
12 from django.db.models import permalink
13 from django.db.models.query import Prefetch
14 from django.dispatch import Signal
15 from django.utils.translation import ugettext_lazy as _
17 from newtagging.models import TagBase
18 from ssify import flush_ssi_includes
21 # Those are hard-coded here so that makemessages sees them.
23 ('author', _('author')),
24 ('epoch', _('epoch')),
26 ('genre', _('genre')),
27 ('theme', _('theme')),
29 ('thing', _('thing')), # things shown on pictures
33 class TagRelation(models.Model):
35 tag = models.ForeignKey('Tag', verbose_name=_('tag'), related_name='items')
36 content_type = models.ForeignKey(ContentType, verbose_name=_('content type'))
37 object_id = models.PositiveIntegerField(_('object id'), db_index=True)
38 content_object = GenericForeignKey('content_type', 'object_id')
41 db_table = 'catalogue_tag_relation'
42 unique_together = (('tag', 'content_type', 'object_id'),)
44 def __unicode__(self):
46 return u'%s [%s]' % (self.content_type.get_object_for_this_type(pk=self.object_id), self.tag)
47 except ObjectDoesNotExist:
48 return u'<deleted> [%s]' % self.tag
52 """A tag attachable to books and fragments (and possibly anything).
54 Used to represent searchable metadata (authors, epochs, genres, kinds),
55 fragment themes (motifs) and some book hierarchy related kludges."""
56 name = models.CharField(_('name'), max_length=120, db_index=True)
57 slug = models.SlugField(_('slug'), max_length=120, db_index=True)
58 sort_key = models.CharField(_('sort key'), max_length=120, db_index=True)
59 category = models.CharField(
60 _('category'), max_length=50, blank=False, null=False, db_index=True, choices=TAG_CATEGORIES)
61 description = models.TextField(_('description'), blank=True)
63 user = models.ForeignKey(User, blank=True, null=True)
64 gazeta_link = models.CharField(blank=True, max_length=240)
65 culturepl_link = models.CharField(blank=True, max_length=240)
66 wiki_link = models.CharField(blank=True, max_length=240)
68 created_at = models.DateTimeField(_('creation date'), auto_now_add=True, db_index=True)
69 changed_at = models.DateTimeField(_('creation date'), auto_now=True, db_index=True)
71 after_change = Signal(providing_args=['instance', 'languages'])
73 intermediary_table_model = TagRelation
75 class UrlDeprecationWarning(DeprecationWarning):
76 def __init__(self, tags=None):
77 super(Tag.UrlDeprecationWarning, self).__init__()
89 categories_dict = dict((item[::-1] for item in categories_rev.iteritems()))
92 ordering = ('sort_key',)
93 verbose_name = _('tag')
94 verbose_name_plural = _('tags')
95 unique_together = (("slug", "category"),)
96 app_label = 'catalogue'
98 def save(self, *args, **kwargs):
99 flush_cache = flush_all_includes = False
100 if self.pk and self.category != 'set':
101 # Flush the whole views cache.
102 # Seem a little harsh, but changed tag names, descriptions
103 # and links come up at any number of places.
106 # Find in which languages we need to flush related includes.
107 old_self = type(self).objects.get(pk=self.pk)
108 # Category shouldn't normally be changed, but just in case.
109 if self.category != old_self.category:
110 flush_all_includes = True
111 languages_changed = self.languages_changed(old_self)
113 ret = super(Tag, self).save(*args, **kwargs)
116 caches[settings.CACHE_MIDDLEWARE_ALIAS].clear()
117 if flush_all_includes:
120 self.flush_includes()
121 self.after_change.send(sender=type(self), instance=self, languages=languages_changed)
125 def languages_changed(self, old):
126 all_langs = [lc for (lc, _ln) in settings.LANGUAGES]
127 if (old.category, old.slug) != (self.category, self.slug):
130 for lang in all_langs:
131 name_field = 'name_%s' % lang
132 if getattr(old, name_field) != getattr(self, name_field):
136 def flush_includes(self, languages=True):
139 if languages is True:
140 languages = [lc for (lc, _ln) in settings.LANGUAGES]
142 template % (self.pk, lang)
144 '/api/include/tag/%d.%s.json',
145 '/api/include/tag/%d.%s.xml',
147 for lang in languages
150 '/katalog/%s.json' % lang for lang in languages])
152 def __unicode__(self):
156 return "Tag(slug=%r)" % self.slug
158 def get_initial(self):
159 if self.category == 'author':
160 return self.sort_key[0]
167 def get_absolute_url(self):
168 return 'tagged_object_list', [self.url_chunk]
171 def get_absolute_gallery_url(self):
172 return 'tagged_object_list_gallery', [self.url_chunk]
176 def create_url(cls, category, slug):
177 return ('catalogue.views.tagged_object_list', [
178 '/'.join((cls.categories_dict[category], slug))
181 def has_description(self):
182 return len(self.description) > 0
183 has_description.short_description = _('description')
184 has_description.boolean = True
187 def get_tag_list(tag_str):
188 if isinstance(tag_str, basestring):
195 tags_splitted = tag_str.split('/')
196 for name in tags_splitted:
198 tags.append(Tag.objects.get(slug=name, category=category))
200 elif name in Tag.categories_rev:
201 category = Tag.categories_rev[name]
204 tags.append(Tag.objects.get(slug=name))
206 except Tag.MultipleObjectsReturned:
207 ambiguous_slugs.append(name)
210 # something strange left off
211 raise Tag.DoesNotExist()
213 # some tags should be qualified
214 e = Tag.MultipleObjectsReturned()
216 e.ambiguous_slugs = ambiguous_slugs
219 raise Tag.UrlDeprecationWarning(tags=tags)
222 return TagBase.get_tag_list(tag_str)
226 return '/'.join((Tag.categories_dict[self.category], self.slug))
229 def tags_from_info(info):
230 from fnpdjango.utils.text.slughifi import slughifi
231 from sortify import sortify
233 categories = (('kinds', 'kind'), ('genres', 'genre'), ('authors', 'author'), ('epochs', 'epoch'))
234 for field_name, category in categories:
236 tag_names = getattr(info, field_name)
239 tag_names = [getattr(info, category)]
241 # For instance, Pictures do not have 'genre' field.
243 for tag_name in tag_names:
244 lang = getattr(tag_name, 'lang', settings.LANGUAGE_CODE)
245 tag_sort_key = tag_name
246 if category == 'author':
247 tag_sort_key = ' '.join((tag_name.last_name,) + tag_name.first_names)
248 tag_name = tag_name.readable()
249 if lang == settings.LANGUAGE_CODE:
250 # Allow creating new tag, if it's in default language.
251 tag, created = Tag.objects.get_or_create(slug=slughifi(tag_name), category=category)
253 tag_name = unicode(tag_name)
255 setattr(tag, "name_%s" % lang, tag_name)
256 tag.sort_key = sortify(tag_sort_key.lower())
259 meta_tags.append(tag)
261 # Ignore unknown tags in non-default languages.
263 tag = Tag.objects.get(category=category, **{"name_%s" % lang: tag_name})
264 except Tag.DoesNotExist:
267 meta_tags.append(tag)
271 def prefetch_relations(objects, category, only_name=True):
272 queryset = TagRelation.objects.filter(tag__category=category).select_related('tag')
274 queryset = queryset.only('tag__name_pl', 'object_id')
275 return objects.prefetch_related(
276 Prefetch('tag_relations', queryset=queryset, to_attr='%s_relations' % category))
279 def prefetched_relations(obj, category):
280 if hasattr(obj, '%s_relations' % category):
281 return getattr(obj, '%s_relations' % category)