data() considered harmful
[edumed.git] / catalogue / models.py
1 from django.core.files import File
2 from django.core.urlresolvers import reverse
3 from django.db import models
4 from jsonfield import JSONField
5 from curriculum.models import Level, Curriculum, CurriculumCourse
6
7
8 class Section(models.Model):
9     title = models.CharField(max_length=255, unique=True)
10     slug = models.SlugField(unique=True)
11     order = models.IntegerField()
12     xml_file = models.FileField(upload_to="catalogue/section/xml",
13         null=True, blank=True)
14
15     class Meta:
16         ordering = ['order']
17
18     class IncompleteError(BaseException):
19         pass
20
21     def __unicode__(self):
22         return self.title
23
24     def get_absolute_url(self):
25         return "%s#%s" % (reverse("catalogue_lessons"), self.slug)
26
27     @classmethod
28     def publish(cls, infile):
29         from librarian.parser import WLDocument
30         from django.core.files.base import ContentFile
31         xml = infile.get_string()
32         wldoc = WLDocument.from_string(xml)
33
34         try:
35             lessons = [Lesson.objects.get(slug=part.slug)
36                         for part in wldoc.book_info.parts]
37         except Lesson.DoesNotExist, e:
38             raise cls.IncompleteError(part.slug)
39
40         slug = wldoc.book_info.url.slug
41         try:
42             section = cls.objects.get(slug=slug)
43         except cls.DoesNotExist:
44             section = cls(slug=slug, order=0)
45
46         # Save XML file
47         section.xml_file.save('%s.xml' % slug, ContentFile(xml), save=False)
48         section.title = wldoc.book_info.title
49         section.save()
50
51         section.lesson_set.all().update(section=None)
52         for i, lesson in enumerate(lessons):
53             lesson.section = section
54             lesson.order = i
55             lesson.save()
56
57         return section
58
59     def syntetic_lesson(self, level):
60         try:
61             return self.lesson_set.filter(type='synthetic', level=level)[0]
62         except IndexError:
63             return None
64
65
66 class Lesson(models.Model):
67     section = models.ForeignKey(Section, null=True, blank=True)
68     level = models.ForeignKey(Level)
69     title = models.CharField(max_length=255)
70     slug = models.SlugField(unique=True)
71     type = models.CharField(max_length=15, db_index=True)
72     order = models.IntegerField(db_index=True)
73     dc = JSONField(default='{}')
74     curriculum_courses = models.ManyToManyField(CurriculumCourse)
75
76     xml_file = models.FileField(upload_to="catalogue/lesson/xml",
77         null=True, blank=True) # FIXME: slug in paths
78     html_file = models.FileField(upload_to="catalogue/lesson/html",
79         null=True, blank=True)
80     package = models.FileField(upload_to="catalogue/lesson/pack",
81         null=True, blank=True)
82     student_package = models.FileField(upload_to="catalogue/lesson/student_pack",
83         null=True, blank=True)
84     pdf = models.FileField(upload_to="catalogue/lesson/pdf",
85         null=True, blank=True)
86     student_pdf = models.FileField(upload_to="catalogue/lesson/student_pdf",
87         null=True, blank=True)
88
89     class Meta:
90         ordering = ['section', 'level', 'order']
91
92     def __unicode__(self):
93         return self.title
94
95     @models.permalink
96     def get_absolute_url(self):
97         return ('catalogue_lesson', [self.slug])
98
99     @classmethod
100     def publish(cls, infile):
101         from librarian.parser import WLDocument
102         from django.core.files.base import ContentFile
103         xml = infile.get_string()
104         wldoc = WLDocument.from_string(xml)
105
106         # Check if not section metadata block.
107         if wldoc.book_info.parts:
108             return Section.publish(infile)
109         
110         slug = wldoc.book_info.url.slug
111         try:
112             lesson = cls.objects.get(slug=slug)
113             lesson.attachment_set.all().delete()
114         except cls.DoesNotExist:
115             lesson = cls(slug=slug, order=0)
116
117         # Save XML file
118         lesson.xml_file.save('%s.xml' % slug, ContentFile(xml), save=False)
119         lesson.title = wldoc.book_info.title
120
121         lesson.level = Level.objects.get(slug=wldoc.book_info.audience)
122         lesson.populate_dc()
123         lesson.build_html(infile=infile)
124         lesson.build_package()
125         lesson.build_package(student=True)
126         return lesson
127
128     def populate_dc(self):
129         from librarian.parser import WLDocument
130         wldoc = WLDocument.from_file(self.xml_file.path)
131         self.dc = wldoc.book_info.to_dict()
132         self.type = self.dc["type"]
133         self.save()
134
135         courses = set()
136         for identifier in wldoc.book_info.curriculum:
137             try:
138                 curr = Curriculum.objects.get(identifier=identifier)
139             except Curriculum.DoesNotExist:
140                 pass
141             else:
142                 courses.add(curr.course)
143         self.curriculum_courses = courses
144
145     def build_html(self, infile=None):
146         from librarian.parser import WLDocument
147         from .publish import HtmlFormat, OrmDocProvider
148
149         if infile is None:
150             wldoc = WLDocument.from_file(self.xml_file.path, provider=OrmDocProvider)
151         else:
152             wldoc = WLDocument(infile, provider=OrmDocProvider())
153         html = HtmlFormat(wldoc).build()
154         self.html_file.save("%s.html" % self.slug,
155             File(open(html.get_filename())))
156
157     def add_to_zip(self, zipf, student=False, prefix=''):
158         zipf.write(self.xml_file.path,
159             "%spliki-zrodlowe/%s.xml" % (prefix, self.slug))
160         pdf = self.student_pdf if student else self.pdf
161         if pdf:
162             zipf.write(self.xml_file.path, 
163                 "%s%s%s.pdf" % (prefix, self.slug, "_student" if student else ""))
164         
165
166     def build_package(self, student=False):
167         from StringIO import StringIO
168         import zipfile
169         from django.core.files.base import ContentFile
170         buff = StringIO()
171         zipf = zipfile.ZipFile(buff, 'w', zipfile.ZIP_STORED)
172         self.add_to_zip(zipf, student)
173         zipf.close()
174         fieldname = "student_package" if student else "package"
175         getattr(self, fieldname).save(
176             "%s%s.zip" % (self.slug, "_student" if student else ""),
177             ContentFile(buff.getvalue()))
178
179     def get_syntetic(self):
180         return self.section.syntetic_lesson(self.level)
181
182     def get_previous(self):
183         if self.section is None: return None
184         try:
185             return self.section.lesson_set.filter(
186                 type=self.type, level=self.level,
187                 order__lt=self.order).order_by('-order')[0]
188         except IndexError:
189             return None
190
191     def get_next(self):
192         if self.section is None: return None
193         try:
194             return self.section.lesson_set.filter(
195                 type=self.type, level=self.level,
196                 order__gt=self.order).order_by('order')[0]
197         except IndexError:
198             return None
199
200
201 class Attachment(models.Model):
202     slug = models.CharField(max_length=255)
203     ext = models.CharField(max_length=15)
204     lesson = models.ForeignKey(Lesson)
205     file = models.FileField(upload_to="catalogue/attachment")
206
207     class Meta:
208         ordering = ['slug', 'ext']
209         unique_together = ['lesson', 'slug', 'ext']
210
211     def __unicode__(self):
212         return "%s.%s" % (self.slug, self.ext)
213
214
215 class Part(models.Model):
216     lesson = models.ForeignKey(Lesson)
217     pdf = models.FileField(upload_to="catalogue/part/pdf",
218         null=True, blank=True)
219     student_pdf = models.FileField(upload_to="catalogue/part/student_pdf",
220         null=True, blank=True)