Generate tags for picture themes
[wolnelektury.git] / apps / picture / models.py
1 from django.db import models
2 import catalogue.models
3 from django.db.models import permalink
4 from sorl.thumbnail import ImageField
5 from django.conf import settings
6 from django.core.files.storage import FileSystemStorage
7 from django.utils.datastructures import SortedDict
8 from librarian import dcparser, picture
9 from slughifi import slughifi
10
11 from django.utils.translation import ugettext_lazy as _
12 from newtagging import managers
13 from os import path
14
15
16 picture_storage = FileSystemStorage(location=path.join(settings.MEDIA_ROOT, 'pictures'), base_url=settings.MEDIA_URL + "pictures/")
17
18
19 class Picture(models.Model):
20     """
21     Picture resource.
22
23     """
24     title       = models.CharField(_('title'), max_length=120)
25     slug        = models.SlugField(_('slug'), max_length=120, db_index=True, unique=True)
26     sort_key    = models.CharField(_('sort key'), max_length=120, db_index=True, editable=False)
27     created_at  = models.DateTimeField(_('creation date'), auto_now_add=True, db_index=True)
28     changed_at  = models.DateTimeField(_('creation date'), auto_now=True, db_index=True)
29     xml_file    = models.FileField('xml_file', upload_to="xml", storage=picture_storage)
30     image_file  = ImageField(_('image_file'), upload_to="images", storage=picture_storage)
31     objects     = models.Manager()
32     tagged      = managers.ModelTaggedItemManager(catalogue.models.Tag)
33     tags        = managers.TagDescriptor(catalogue.models.Tag)
34
35     class AlreadyExists(Exception):
36         pass
37
38     class Meta:
39         ordering = ('sort_key',)
40
41         verbose_name = _('picture')
42         verbose_name_plural = _('pictures')
43
44     URLID_RE = r'[a-z0-9-]+'
45     FILEID_RE = r'[a-z0-9-]+'
46
47     def save(self, force_insert=False, force_update=False, reset_short_html=True, **kwargs):
48         from sortify import sortify
49
50         self.sort_key = sortify(self.title)
51
52         ret = super(Picture, self).save(force_insert, force_update)
53
54         return ret
55
56     def __unicode__(self):
57         return self.title
58
59     @permalink
60     def get_absolute_url(self):
61         return ('picture.views.picture_detail', [self.urlid()])
62
63     def urlid(self):
64         return self.slug
65
66     @classmethod
67     def from_xml_file(cls, xml_file, image_file=None, overwrite=False):
68         """
69         Import xml and it's accompanying image file.
70         """
71         from sortify import sortify
72         from django.core.files import File
73         from librarian.picture import WLPicture
74         close_xml_file = False
75
76         if not isinstance(xml_file, File):
77             xml_file = File(open(xml_file))
78             close_xml_file = True
79         try:
80             # use librarian to parse meta-data
81             picture_xml = WLPicture.from_file(xml_file)
82
83             pict, created = Picture.objects.get_or_create(slug=picture_xml.slug)
84             if not created and not overwrite:
85                 raise Picture.AlreadyExists('Picture %s already exists' % picture_xml.slug)
86
87             pict.title = picture_xml.picture_info.title
88
89             #            from nose.tools import set_trace; set_trace()
90             motif_tags = set()
91             for part in picture_xml.partiter():
92                 for motif in part['themes']:
93                     tag, created = catalogue.models.Tag.objects.get_or_create(slug=slughifi(motif), category='theme')
94                     if created:
95                         tag.name = motif
96                         tag.sort_key = sortify(tag.name)
97                         tag.save()
98                     motif_tags.add(tag)
99
100             pict.tags = catalogue.models.Tag.tags_from_info(picture_xml.picture_info) + \
101                 list(motif_tags)
102
103             if image_file is not None:
104                 img = image_file
105             else:
106                 img = picture_xml.image_file()
107
108             pict.image_file.save(path.basename(picture_xml.image_path), File(img))
109
110             pict.xml_file.save("%s.xml" % pict.slug, File(xml_file))
111             pict.save()
112         finally:
113             if close_xml_file:
114                 xml_file.close()
115         return pict
116
117     @classmethod
118     def picture_list(cls, filter=None):
119         """Generates a hierarchical listing of all pictures
120         Pictures are optionally filtered with a test function.
121         """
122
123         pics = cls.objects.all().order_by('sort_key')\
124             .only('title', 'slug', 'image_file')
125
126         if filter:
127             pics = pics.filter(filter).distinct()
128
129         pics_by_author = SortedDict()
130         orphans = []
131         for tag in catalogue.models.Tag.objects.filter(category='author'):
132             pics_by_author[tag] = []
133
134         for pic in pics:
135             authors = list(pic.tags.filter(category='author'))
136             if authors:
137                 for author in authors:
138                     pics_by_author[author].append(pic)
139             else:
140                 orphans.append(pic)
141
142         return pics_by_author, orphans
143
144     @property
145     def info(self):
146         if not hasattr(self, '_info'):
147             info = dcparser.parse(self.xml_file.path, picture.PictureInfo)
148             self._info = info
149         return self._info