catalogue/models.py

   1 # -*- coding: utf-8
   2 from django.core.files import File
   3 from django.core.urlresolvers import reverse
   4 from django.db import models
   5 from jsonfield import JSONField
   6 from fnpdjango.storage import BofhFileSystemStorage
   7 from curriculum.models import Level, Curriculum, CurriculumCourse
   8 import logging
   9
  10 bofh_storage = BofhFileSystemStorage()
  11
  12
  13 class Section(models.Model):
  14     title = models.CharField(max_length=255, unique=True)
  15     slug = models.SlugField(max_length=255, unique=True)
  16     order = models.IntegerField()
  17     xml_file = models.FileField(
  18         upload_to="catalogue/section/xml",
  19         null=True, blank=True, max_length=255,
  20         storage=bofh_storage)
  21     image = models.ImageField(upload_to="catalogue/section/image", null=True, blank=True)
  22
  23     pic = models.ImageField(upload_to="catalogue/section/pic", null=True, blank=True)
  24     pic_attribution = models.CharField(max_length=255, null=True, blank=True)
  25     pic_src = models.URLField(null=True, blank=True)
  26
  27     summary = models.TextField(blank=True, null=True)
  28
  29     class Meta:
  30         ordering = ['order']
  31
  32     class IncompleteError(BaseException):
  33         pass
  34
  35     def __unicode__(self):
  36         return self.title
  37
  38     def get_absolute_url(self):
  39         return "%s#gimnazjum_%s" % (reverse("catalogue_lessons"), self.slug)
  40
  41     @classmethod
  42     def publish(cls, infile, ignore_incomplete=False):
  43         from librarian.parser import WLDocument
  44         from django.core.files.base import ContentFile
  45         xml = infile.get_string()
  46         wldoc = WLDocument.from_string(xml)
  47
  48         lessons = []
  49         for part in wldoc.book_info.parts:
  50             try:
  51                 lessons.append(Lesson.objects.get(slug=part.slug))
  52             except Lesson.DoesNotExist, e:
  53                 if not ignore_incomplete:
  54                     raise cls.IncompleteError(part.slug)
  55
  56         slug = wldoc.book_info.url.slug
  57         try:
  58             section = cls.objects.get(slug=slug)
  59         except cls.DoesNotExist:
  60             section = cls(slug=slug, order=0)
  61
  62         # Save XML file
  63         section.xml_file.save('%s.xml' % slug, ContentFile(xml), save=False)
  64         section.title = wldoc.book_info.title
  65         section.save()
  66
  67         section.lesson_set.all().update(section=None)
  68         for i, lesson in enumerate(lessons):
  69             lesson.section = section
  70             lesson.order = i
  71             lesson.save()
  72
  73         return section
  74
  75     def syntetic_lesson(self, level):
  76         try:
  77             return self.lesson_set.filter(type='synthetic', level=level)[0]
  78         except IndexError:
  79             return None
  80
  81
  82 class Lesson(models.Model):
  83     section = models.ForeignKey(Section, null=True, blank=True)
  84     level = models.ForeignKey(Level)
  85     title = models.CharField(max_length=255)
  86     slug = models.SlugField(max_length=255, unique=True)
  87     type = models.CharField(max_length=15, db_index=True)
  88     order = models.IntegerField(db_index=True)
  89     dc = JSONField(default='{}')
  90     curriculum_courses = models.ManyToManyField(CurriculumCourse, blank=True)
  91     description = models.TextField(null=True, blank=True)
  92
  93     xml_file = models.FileField(
  94         upload_to="catalogue/lesson/xml",
  95         null=True, blank=True, max_length=255, storage=bofh_storage)
  96     html_file = models.FileField(
  97         upload_to="catalogue/lesson/html",
  98         null=True, blank=True, max_length=255, storage=bofh_storage)
  99     package = models.FileField(
 100         upload_to="catalogue/lesson/pack",
 101         null=True, blank=True, max_length=255, storage=bofh_storage)
 102     student_package = models.FileField(
 103         upload_to="catalogue/lesson/student_pack",
 104         null=True, blank=True, max_length=255, storage=bofh_storage)
 105     pdf = models.FileField(
 106         upload_to="catalogue/lesson/pdf",
 107         null=True, blank=True, max_length=255, storage=bofh_storage)
 108     student_pdf = models.FileField(
 109         upload_to="catalogue/lesson/student_pdf",
 110         null=True, blank=True, max_length=255, storage=bofh_storage)
 111
 112     class Meta:
 113         ordering = ['section', 'level', 'order']
 114
 115     def __unicode__(self):
 116         return self.title
 117
 118     @models.permalink
 119     def get_absolute_url(self):
 120         return 'catalogue_lesson', [self.slug]
 121
 122     @classmethod
 123     def publish(cls, infile, ignore_incomplete=False):
 124         from librarian.parser import WLDocument
 125         from django.core.files.base import ContentFile
 126         wldoc = WLDocument(infile)
 127
 128         # Check if not section metadata block.
 129         if wldoc.book_info.parts:
 130             return Section.publish(infile, ignore_incomplete=ignore_incomplete)
 131
 132         slug = wldoc.book_info.url.slug
 133         try:
 134             lesson = cls.objects.get(slug=slug)
 135             lesson.attachment_set.all().delete()
 136         except cls.DoesNotExist:
 137             lesson = cls(slug=slug, order=0)
 138
 139         # Save XML file
 140         lesson.xml_file.save('%s.xml' % slug, ContentFile(infile.get_string()), save=False)
 141         lesson.title = wldoc.book_info.title
 142
 143         lesson.level = Level.objects.get(meta_name=wldoc.book_info.audience)
 144         lesson.populate_dc()
 145         lesson.populate_description(wldoc=wldoc)
 146         lesson.build_html(infile=infile)
 147         lesson.build_pdf()
 148         lesson.build_package()
 149         if lesson.type != 'project':
 150             lesson.build_pdf(student=True)
 151             lesson.build_package(student=True)
 152         return lesson
 153
 154     def populate_dc(self):
 155         from librarian.parser import WLDocument
 156         wldoc = WLDocument.from_file(self.xml_file.path)
 157         self.dc = wldoc.book_info.to_dict()
 158         self.type = self.dc["type"]
 159         assert self.type in ('appendix', 'course', 'synthetic', 'project', 'added', 'added-var'), \
 160             u"Unknown lesson type: %s" % self.type
 161         self.save()
 162
 163         courses = set()
 164         for identifier in wldoc.book_info.curriculum:
 165             identifier = (identifier or "").replace(' ', '')
 166             if not identifier:
 167                 continue
 168             try:
 169                 curr = Curriculum.objects.get(identifier__iexact=identifier)
 170             except Curriculum.DoesNotExist:
 171                 logging.warn('Unknown curriculum course %s in lesson %s' % (identifier, self.slug))
 172                 pass
 173             else:
 174                 courses.add(curr.course)
 175         self.curriculum_courses = courses
 176
 177     def populate_description(self, wldoc=None, infile=None):
 178         if wldoc is None:
 179             wldoc = self.wldocument(infile)
 180         if self.type == 'project':
 181             lookup = u'Zadanie'
 182         else:
 183             lookup = u'Pomysł na lekcję'
 184         for header in wldoc.edoc.findall('.//naglowek_rozdzial'):
 185             if (header.text or '').strip() == lookup:
 186                 from lxml import etree
 187                 self.description = etree.tostring(
 188                     header.getnext(), method='text', encoding='unicode').strip()
 189                 self.save()
 190                 return
 191
 192     def wldocument(self, infile=None):
 193         from librarian import IOFile
 194         from librarian.parser import WLDocument
 195         from .publish import OrmDocProvider
 196
 197         if infile is None:
 198             infile = IOFile.from_filename(self.xml_file.path)
 199             for att in self.attachment_set.all():
 200                 infile.attachments["%s.%s" % (att.slug, att.ext)] = \
 201                     IOFile.from_filename(att.file.path)
 202         return WLDocument(infile, provider=OrmDocProvider())
 203
 204     def build_html(self, infile=None):
 205         from .publish import HtmlFormat
 206         wldoc = self.wldocument(infile)
 207         html = HtmlFormat(wldoc).build()
 208         self.html_file.save("%s.html" % self.slug, File(open(html.get_filename())))
 209
 210     def build_pdf(self, student=False):
 211         from .publish import PdfFormat
 212         # PDF uses document with attachments already saved as media,
 213         # otherwise sorl.thumbnail complains about SuspiciousOperations.
 214         wldoc = self.wldocument()
 215         if student:
 216             pdf = PdfFormat(wldoc).build()
 217             self.student_pdf.save("%s.pdf" % self.slug, File(open(pdf.get_filename())))
 218         else:
 219             pdf = PdfFormat(wldoc, teacher=True).build()
 220             self.pdf.save("%s.pdf" % self.slug, File(open(pdf.get_filename())))
 221
 222     def add_to_zip(self, zipf, student=False, prefix=''):
 223         pdf = self.student_pdf if student else self.pdf
 224         if pdf:
 225             zipf.write(pdf.path, "%s%s%s.pdf" % (prefix, self.slug, "_student" if student else ""))
 226             for attachment in self.attachment_set.all():
 227                 zipf.write(attachment.file.path, u"%smaterialy/%s.%s" % (prefix, attachment.slug, attachment.ext))
 228             zipf.write(self.xml_file.path, "%spliki-zrodlowe/%s.xml" % (prefix, self.slug))
 229
 230     def build_package(self, student=False):
 231         from StringIO import StringIO
 232         import zipfile
 233         from django.core.files.base import ContentFile
 234         buff = StringIO()
 235         zipf = zipfile.ZipFile(buff, 'w', zipfile.ZIP_STORED)
 236         self.add_to_zip(zipf, student)
 237         zipf.close()
 238         fieldname = "student_package" if student else "package"
 239         getattr(self, fieldname).save(
 240             "%s%s.zip" % (self.slug, "_student" if student else ""),
 241             ContentFile(buff.getvalue()))
 242
 243     def get_syntetic(self):
 244         if self.section is None:
 245             return None
 246         return self.section.syntetic_lesson(self.level)
 247
 248     def get_other_level(self):
 249         if self.section is None:
 250             return None
 251         other_levels = self.section.lesson_set.exclude(level=self.level)
 252         if other_levels.exists():
 253             return other_levels[0].level
 254
 255     def get_previous(self):
 256         if self.section is None:
 257             return None
 258         try:
 259             return self.section.lesson_set.filter(
 260                 type=self.type, level=self.level,
 261                 order__lt=self.order).order_by('-order')[0]
 262         except IndexError:
 263             return None
 264
 265     def get_next(self):
 266         if self.section is None:
 267             return None
 268         try:
 269             return self.section.lesson_set.filter(
 270                 type=self.type, level=self.level,
 271                 order__gt=self.order).order_by('order')[0]
 272         except IndexError:
 273             return None
 274
 275     def requires_internet(self):
 276         return 'internet' in self.dc.get('requires', [])
 277
 278
 279 class Attachment(models.Model):
 280     slug = models.CharField(max_length=255)
 281     ext = models.CharField(max_length=15)
 282     lesson = models.ForeignKey(Lesson)
 283     file = models.FileField(upload_to="catalogue/attachment", storage=bofh_storage)
 284
 285     class Meta:
 286         ordering = ['slug', 'ext']
 287         unique_together = ['lesson', 'slug', 'ext']
 288
 289     def __unicode__(self):
 290         return "%s.%s" % (self.slug, self.ext)
 291
 292
 293 class Part(models.Model):
 294     lesson = models.ForeignKey(Lesson)
 295     pdf = models.FileField(upload_to="catalogue/part/pdf", null=True, blank=True)
 296     student_pdf = models.FileField(upload_to="catalogue/part/student_pdf", null=True, blank=True)
 297
 298
 299 class LessonStub(models.Model):
 300     section = models.ForeignKey(Section, null=True, blank=True)
 301     level = models.ForeignKey(Level)
 302     title = models.CharField(max_length=255)
 303     type = models.CharField(max_length=15, db_index=True)
 304     order = models.IntegerField(db_index=True)
 305
 306     class Meta:
 307         ordering = ['section', 'level', 'order']
 308
 309     def __unicode__(self):
 310         return self.title
 311
 312     @property
 313     def slug(self):
 314         return ''
 315
 316     def add_to_zip(self, *args, **kwargs):
 317         pass