add ESEM forms

[edumed.git] / catalogue / models.py

diff --git a/catalogue/models.py b/catalogue/models.py
index 394e938..c73c762 100644 (file)
--- a/catalogue/models.py
+++ b/catalogue/models.py
@@ -1,113 +1,260 @@
+# -*- coding: utf-8
+from django.conf import settings

 from django.core.files import File
 from django.core.urlresolvers import reverse
 from django.db import models
 from jsonfield import JSONField
 from django.core.files import File
 from django.core.urlresolvers import reverse
 from django.db import models
 from jsonfield import JSONField

-from curriculum.models import Level
+from fnpdjango.storage import BofhFileSystemStorage
+
+from curriculum.models import Level, Curriculum, CurriculumCourse
+import logging
+
+bofh_storage = BofhFileSystemStorage()

 
 
 class Section(models.Model):
     title = models.CharField(max_length=255, unique=True)
 
 
 class Section(models.Model):
     title = models.CharField(max_length=255, unique=True)

-    slug = models.SlugField(unique=True)
+    slug = models.SlugField(max_length=255, unique=True)

     order = models.IntegerField()
     order = models.IntegerField()

+    xml_file = models.FileField(
+        upload_to="catalogue/section/xml",
+        null=True, blank=True, max_length=255,
+        storage=bofh_storage)
+    image = models.ImageField(upload_to="catalogue/section/image", null=True, blank=True)
+
+    pic = models.ImageField(upload_to="catalogue/section/pic", null=True, blank=True)
+    pic_attribution = models.CharField(max_length=255, null=True, blank=True)
+    pic_src = models.URLField(null=True, blank=True)
+    
+    summary = models.TextField(blank=True, null=True)

 
     class Meta:
         ordering = ['order']
 
 
     class Meta:
         ordering = ['order']
 

+    class IncompleteError(BaseException):
+        pass
+

     def __unicode__(self):
         return self.title
 
     def get_absolute_url(self):
     def __unicode__(self):
         return self.title
 
     def get_absolute_url(self):

-        return "%s#%s" % (reverse("catalogue_lessons"), self.slug)
+        return "%s#gimnazjum_%s" % (reverse("catalogue_lessons"), self.slug)
+
+    @classmethod
+    def publish(cls, infile, ignore_incomplete=False):
+        from librarian.parser import WLDocument
+        from django.core.files.base import ContentFile
+        xml = infile.get_string()
+        wldoc = WLDocument.from_string(xml)
+
+        lessons = []
+        for part in wldoc.book_info.parts:
+            try:
+                lessons.append(Lesson.objects.get(slug=part.slug))
+            except Lesson.DoesNotExist, e:
+                if not ignore_incomplete:
+                    raise cls.IncompleteError(part.slug)

 
 

-    def syntetic_lesson(self):
+        slug = wldoc.book_info.url.slug

         try:
         try:

-            return self.lesson_set.filter(depth=0)[0]
+            section = cls.objects.get(slug=slug)
+        except cls.DoesNotExist:
+            section = cls(slug=slug, order=0)
+
+        # Save XML file
+        section.xml_file.save('%s.xml' % slug, ContentFile(xml), save=False)
+        section.title = wldoc.book_info.title
+        section.save()
+
+        section.lesson_set.all().update(section=None)
+        for i, lesson in enumerate(lessons):
+            lesson.section = section
+            lesson.order = i
+            lesson.save()
+
+        return section
+
+    def syntetic_lesson(self, level):
+        try:
+            return self.lesson_set.filter(type='synthetic', level=level)[0]

         except IndexError:
             return None
 
 
 class Lesson(models.Model):
         except IndexError:
             return None
 
 
 class Lesson(models.Model):

-    section = models.ForeignKey(Section)
+    section = models.ForeignKey(Section, null=True, blank=True)

     level = models.ForeignKey(Level)
     title = models.CharField(max_length=255)
     level = models.ForeignKey(Level)
     title = models.CharField(max_length=255)

-    slug = models.SlugField(unique=True)
-    depth = models.IntegerField()
-    order = models.IntegerField()
+    slug = models.SlugField(max_length=255, unique=True)
+    type = models.CharField(max_length=15, db_index=True)
+    order = models.IntegerField(db_index=True)

     dc = JSONField(default='{}')
     dc = JSONField(default='{}')

+    curriculum_courses = models.ManyToManyField(CurriculumCourse, blank=True)
+    description = models.TextField(null=True, blank=True)

 
 

-    xml_file = models.FileField(upload_to="catalogue/lesson/xml",
-        null=True, blank=True) # FIXME: slug in paths
-    html_file = models.FileField(upload_to="catalogue/lesson/html",
-        null=True, blank=True)
-    package = models.FileField(upload_to="catalogue/lesson/pack",
-        null=True, blank=True)
-    student_package = models.FileField(upload_to="catalogue/lesson/student_pack",
-        null=True, blank=True)
-    pdf = models.FileField(upload_to="catalogue/lesson/pdf",
-        null=True, blank=True)
-    student_pdf = models.FileField(upload_to="catalogue/lesson/student_pdf",
-        null=True, blank=True)
+    xml_file = models.FileField(
+        upload_to="catalogue/lesson/xml",
+        null=True, blank=True, max_length=255, storage=bofh_storage)
+    html_file = models.FileField(
+        upload_to="catalogue/lesson/html",
+        null=True, blank=True, max_length=255, storage=bofh_storage)
+    package = models.FileField(
+        upload_to="catalogue/lesson/pack",
+        null=True, blank=True, max_length=255, storage=bofh_storage)
+    student_package = models.FileField(
+        upload_to="catalogue/lesson/student_pack",
+        null=True, blank=True, max_length=255, storage=bofh_storage)
+    pdf = models.FileField(
+        upload_to="catalogue/lesson/pdf",
+        null=True, blank=True, max_length=255, storage=bofh_storage)
+    student_pdf = models.FileField(
+        upload_to="catalogue/lesson/student_pdf",
+        null=True, blank=True, max_length=255, storage=bofh_storage)
+    weasy_pdf = models.FileField(
+        upload_to="catalogue/lesson/weasy",
+        null=True, blank=True, max_length=255, storage=bofh_storage)

 
     class Meta:
 
     class Meta:

-        ordering = ['section', 'level', 'depth', 'order']
+        ordering = ['section', 'level', 'order']

 
     def __unicode__(self):
         return self.title
 
     @models.permalink
     def get_absolute_url(self):
 
     def __unicode__(self):
         return self.title
 
     @models.permalink
     def get_absolute_url(self):

-        return ('catalogue_lesson', [self.slug])
+        return 'catalogue_lesson', [self.slug]

 
     @classmethod
 
     @classmethod

-    def publish(cls, infile):
+    def publish(cls, infile, ignore_incomplete=False, repackage_level=False):

         from librarian.parser import WLDocument
         from django.core.files.base import ContentFile
         from librarian.parser import WLDocument
         from django.core.files.base import ContentFile

-        xml = infile.get_string()
-        wldoc = WLDocument.from_string(xml)
-        slug = wldoc.book_info.url.slug
+        wldoc = WLDocument(infile)
+
+        # Check if not section metadata block.
+        if wldoc.book_info.parts:
+            return Section.publish(infile, ignore_incomplete=ignore_incomplete)

 
 

+        slug = wldoc.book_info.url.slug

         try:
             lesson = cls.objects.get(slug=slug)
         try:
             lesson = cls.objects.get(slug=slug)

+            lesson.attachment_set.all().delete()

         except cls.DoesNotExist:
         except cls.DoesNotExist:

-            lesson = cls(slug=slug)
-
-        lesson.attachment_set.all().delete()
-        for att_name, att_file in infile.attachments.items():
-            try:
-                slug, ext = att_name.rsplit('.', 1)
-            except ValueError:
-                slug, ext = att_name, ''
-            attachment = lesson.attachment_set.create(slug=slug, ext=ext)
-            attachment.file.save(att_name, ContentFile(att_file.get_string()))
+            lesson = cls(slug=slug, order=0)

 
         # Save XML file
 
         # Save XML file

-        lesson.xml_file.save('%s.xml' % slug, ContentFile(xml), save=False)
+        lesson.xml_file.save('%s.xml' % slug, ContentFile(infile.get_string()), save=False)

         lesson.title = wldoc.book_info.title
 
         lesson.title = wldoc.book_info.title
 

-        lesson.level = Level.objects.get(slug=wldoc.book_info.audience)
-        # TODO: no xml data?
-        lesson.section = Section.objects.all()[0]
-        lesson.order = 1
-        lesson.depth = 1
+        lesson.level = Level.objects.get(meta_name=wldoc.book_info.audience)

         lesson.populate_dc()
         lesson.populate_dc()

-        lesson.save()
-        lesson.build_html()
+        lesson.populate_description(wldoc=wldoc)
+        lesson.build_html(infile=infile)
+        lesson.build_pdf()

         lesson.build_package()
         lesson.build_package()

-        lesson.build_package(student=True)
+        if lesson.type != 'project':
+            lesson.build_pdf(student=True)
+            lesson.build_package(student=True)
+        if repackage_level:
+            lesson.level.build_packages()

         return lesson
 
         return lesson
 

+    def republish(self, repackage_level=True, attachments=None):
+        from librarian import IOFile
+        import os.path
+        from django.conf import settings
+        if attachments is None:
+            attachments = {}
+            for attachment in self.attachment_set.all():
+                full_name = os.path.join(settings.MEDIA_ROOT, attachment.file.name)
+                f = IOFile.from_filename(full_name)
+                attachments['%s.%s' % (attachment.slug, attachment.ext)] = f
+        infile = IOFile.from_filename(self.xml_file.path, attachments=attachments)
+        Lesson.publish(infile, repackage_level=repackage_level)
+

     def populate_dc(self):
         from librarian.parser import WLDocument
         wldoc = WLDocument.from_file(self.xml_file.path)
         self.dc = wldoc.book_info.to_dict()
     def populate_dc(self):
         from librarian.parser import WLDocument
         wldoc = WLDocument.from_file(self.xml_file.path)
         self.dc = wldoc.book_info.to_dict()

+        self.type = self.dc["type"]
+        assert self.type in ('appendix', 'course', 'synthetic', 'project', 'added', 'added-var'), \
+            u"Unknown lesson type: %s" % self.type

         self.save()
 
         self.save()
 

-    def build_html(self):
+        courses = set()
+        for identifier in wldoc.book_info.curriculum:
+            identifier = (identifier or "").replace(' ', '')
+            if not identifier:
+                continue
+            try:
+                curr = Curriculum.objects.get(identifier__iexact=identifier)
+            except Curriculum.DoesNotExist:
+                logging.warn('Unknown curriculum course %s in lesson %s' % (identifier, self.slug))
+                pass
+            else:
+                courses.add(curr.course)
+        self.curriculum_courses = courses
+
+    def populate_description(self, wldoc=None, infile=None):
+        if wldoc is None:
+            wldoc = self.wldocument(infile)
+        if self.type == 'project':
+            lookup = u'Zadanie'
+        else:
+            lookup = u'Pomysł na lekcję'
+        for header in wldoc.edoc.findall('.//naglowek_rozdzial'):
+            if (header.text or '').strip() == lookup:
+                from lxml import etree
+                self.description = etree.tostring(
+                    header.getnext(), method='text', encoding='unicode').strip()
+                self.save()
+                return
+
+    def wldocument(self, infile=None):
+        from librarian import IOFile

         from librarian.parser import WLDocument
         from librarian.parser import WLDocument

-        wldoc = WLDocument.from_file(self.xml_file.path)
-        html = wldoc.as_html()
-        self.html_file.save("%s.html" % self.slug,
-            File(open(html.get_filename())))
+        from .publish import OrmDocProvider
+
+        if infile is None:
+            infile = IOFile.from_filename(self.xml_file.path)
+            for att in self.attachment_set.all():
+                infile.attachments["%s.%s" % (att.slug, att.ext)] = \
+                    IOFile.from_filename(att.file.path)
+        return WLDocument(infile, provider=OrmDocProvider())
+
+    def build_html(self, infile=None):
+        from .publish import HtmlFormat
+        wldoc = self.wldocument(infile)
+        html = HtmlFormat(wldoc).build()
+        self.html_file.save("%s.html" % self.slug, File(open(html.get_filename())))
+
+    def build_pdf(self, student=False):
+        from .publish import PdfFormat
+        # PDF uses document with attachments already saved as media,
+        # otherwise sorl.thumbnail complains about SuspiciousOperations.
+        wldoc = self.wldocument()
+        if student:
+            pdf = PdfFormat(wldoc).build()
+            self.student_pdf.save("%s.pdf" % self.slug, File(open(pdf.get_filename())))
+        else:
+            pdf = PdfFormat(wldoc, teacher=True).build()
+            self.pdf.save("%s.pdf" % self.slug, File(open(pdf.get_filename())))
+
+    def build_pdf_from_html(self, **kwargs):
+        from .publish import PdfFromHtmlFormat
+        wldoc = self.wldocument()
+        pdf = PdfFromHtmlFormat(
+            wldoc, media_root=settings.MEDIA_ROOT,
+            html_to_pdf_command=settings.HTML_TO_PDF_COMMAND,
+            **kwargs).build()
+        self.weasy_pdf.save("%s.pdf" % self.slug, File(open(pdf.get_filename())))
+
+    def add_to_zip(self, zipf, student=False, prefix=''):
+        pdf = self.student_pdf if student else self.pdf
+        if pdf:
+            zipf.write(pdf.path, "%s%s%s.pdf" % (prefix, self.slug, "_student" if student else ""))
+            for attachment in self.attachment_set.all():
+                zipf.write(attachment.file.path, u"%smaterialy/%s.%s" % (prefix, attachment.slug, attachment.ext))
+            zipf.write(self.xml_file.path, "%spliki-zrodlowe/%s.xml" % (prefix, self.slug))

 
     def build_package(self, student=False):
         from StringIO import StringIO
 
     def build_package(self, student=False):
         from StringIO import StringIO


@@ -115,23 +262,58 @@ class Lesson(models.Model):
         from django.core.files.base import ContentFile
         buff = StringIO()
         zipf = zipfile.ZipFile(buff, 'w', zipfile.ZIP_STORED)
         from django.core.files.base import ContentFile
         buff = StringIO()
         zipf = zipfile.ZipFile(buff, 'w', zipfile.ZIP_STORED)

-        zipf.write(self.xml_file.path, "pliki-zrodlowe/%s.xml" % self.slug)
-        pdf = self.student_pdf if student else self.pdf
-        if pdf:
-            zipf.write(self.xml_file.path, 
-                "%s%s.pdf" % (self.slug, "_student" if student else ""))
+        self.add_to_zip(zipf, student)

         zipf.close()
         fieldname = "student_package" if student else "package"
         getattr(self, fieldname).save(
             "%s%s.zip" % (self.slug, "_student" if student else ""),
             ContentFile(buff.getvalue()))
 
         zipf.close()
         fieldname = "student_package" if student else "package"
         getattr(self, fieldname).save(
             "%s%s.zip" % (self.slug, "_student" if student else ""),
             ContentFile(buff.getvalue()))
 

+    def get_syntetic(self):
+        if self.section is None:
+            return None
+        return self.section.syntetic_lesson(self.level)
+
+    def get_other_level(self):
+        if self.section is None:
+            return None
+        other_levels = self.section.lesson_set.exclude(level=self.level)
+        if other_levels.exists():
+            return other_levels[0].level
+
+    def get_previous(self):
+        if self.section is None:
+            return None
+        try:
+            return self.section.lesson_set.filter(
+                type=self.type, level=self.level,
+                order__lt=self.order).order_by('-order')[0]
+        except IndexError:
+            return None
+
+    def get_next(self):
+        if self.section is None:
+            return None
+        try:
+            return self.section.lesson_set.filter(
+                type=self.type, level=self.level,
+                order__gt=self.order).order_by('order')[0]
+        except IndexError:
+            return None
+
+    def requires_internet(self):
+        return any(requirement in self.dc.get('requires', []) for requirement in ('internet', 'Internet'))
+
+
+def attachment_path(instance, filename):
+    return 'catalogue/attachment/%s/%s' % (instance.lesson.slug, filename)
+

 
 class Attachment(models.Model):
     slug = models.CharField(max_length=255)
     ext = models.CharField(max_length=15)
     lesson = models.ForeignKey(Lesson)
 
 class Attachment(models.Model):
     slug = models.CharField(max_length=255)
     ext = models.CharField(max_length=15)
     lesson = models.ForeignKey(Lesson)

-    file = models.FileField(upload_to="catalogue/attachment")
+    file = models.FileField(upload_to=attachment_path, storage=bofh_storage, max_length=255)

 
     class Meta:
         ordering = ['slug', 'ext']
 
     class Meta:
         ordering = ['slug', 'ext']


@@ -143,7 +325,26 @@ class Attachment(models.Model):
 
 class Part(models.Model):
     lesson = models.ForeignKey(Lesson)
 
 class Part(models.Model):
     lesson = models.ForeignKey(Lesson)

-    pdf = models.FileField(upload_to="catalogue/part/pdf",
-        null=True, blank=True)
-    student_pdf = models.FileField(upload_to="catalogue/part/student_pdf",
-        null=True, blank=True)
+    pdf = models.FileField(upload_to="catalogue/part/pdf", null=True, blank=True)
+    student_pdf = models.FileField(upload_to="catalogue/part/student_pdf", null=True, blank=True)
+
+
+class LessonStub(models.Model):
+    section = models.ForeignKey(Section, null=True, blank=True)
+    level = models.ForeignKey(Level)
+    title = models.CharField(max_length=255)
+    type = models.CharField(max_length=15, db_index=True)
+    order = models.IntegerField(db_index=True)
+
+    class Meta:
+        ordering = ['section', 'level', 'order']
+
+    def __unicode__(self):
+        return self.title
+
+    @property
+    def slug(self):
+        return ''
+
+    def add_to_zip(self, *args, **kwargs):
+        pass