src/catalogue/models/bookmedia.py

   1 # This file is part of Wolnelektury, licensed under GNU Affero GPLv3 or later.
   2 # Copyright © Fundacja Nowoczesna Polska. See NOTICE for more information.
   3 #
   4 from collections import OrderedDict
   5 import json
   6 from collections import namedtuple
   7 from django.db import models
   8 from django.utils.translation import ugettext_lazy as _
   9 from slugify import slugify
  10 from mutagen import MutagenError
  11
  12 from catalogue.fields import OverwriteStorage
  13
  14
  15 def _file_upload_to(i, _n):
  16     return 'book/%(ext)s/%(name)s.%(ext)s' % {'ext': i.ext(), 'name': slugify(i.name)}
  17
  18
  19 class BookMedia(models.Model):
  20     """Represents media attached to a book."""
  21     FileFormat = namedtuple("FileFormat", "name ext")
  22     formats = OrderedDict([
  23         ('mp3', FileFormat(name='MP3', ext='mp3')),
  24         ('ogg', FileFormat(name='Ogg Vorbis', ext='ogg')),
  25         ('daisy', FileFormat(name='DAISY', ext='daisy.zip')),
  26     ])
  27     format_choices = [(k, _('%s file' % t.name)) for k, t in formats.items()]
  28
  29     type = models.CharField(_('type'), db_index=True, choices=format_choices, max_length=20)
  30     name = models.CharField(_('name'), max_length=512)
  31     part_name = models.CharField(_('part name'), default='', blank=True, max_length=512)
  32     index = models.IntegerField(_('index'), default=0)
  33     file = models.FileField(_('file'), max_length=600, upload_to=_file_upload_to, storage=OverwriteStorage())
  34     uploaded_at = models.DateTimeField(_('creation date'), auto_now_add=True, editable=False, db_index=True)
  35     extra_info = models.TextField(_('extra information'), default='{}', editable=False)
  36     book = models.ForeignKey('Book', models.CASCADE, related_name='media')
  37     source_sha1 = models.CharField(null=True, blank=True, max_length=40, editable=False)
  38
  39     def __str__(self):
  40         return "%s (%s)" % (self.name, self.file.name.split("/")[-1])
  41
  42     class Meta:
  43         ordering = ('type', 'name')
  44         verbose_name = _('book media')
  45         verbose_name_plural = _('book media')
  46         app_label = 'catalogue'
  47
  48     def get_extra_info_json(self):
  49         return json.loads(self.extra_info or '{}')
  50
  51     def save(self, parts_count=None, *args, **kwargs):
  52         from catalogue.utils import ExistingFile, remove_zip
  53
  54         if not parts_count:
  55             parts_count = 1 + BookMedia.objects.filter(book=self.book, type=self.type).exclude(pk=self.pk).count()
  56         if parts_count == 1:
  57             self.name = self.book.pretty_title()
  58         else:
  59             no = ('%02d' if parts_count < 100 else '%03d') % self.index
  60             self.name = '%s. %s' % (no, self.book.pretty_title())
  61             if self.part_name:
  62                 self.name += ', ' + self.part_name
  63
  64         try:
  65             old = BookMedia.objects.get(pk=self.pk)
  66         except BookMedia.DoesNotExist:
  67             old = None
  68         else:
  69             # if name changed, change the file name, too
  70             if slugify(self.name) != slugify(old.name):
  71                 self.file.save(None, ExistingFile(self.file.path), save=False)
  72
  73         super(BookMedia, self).save(*args, **kwargs)
  74
  75         # remove the zip package for book with modified media
  76         if old:
  77             remove_zip("%s_%s" % (old.book.slug, old.type))
  78         remove_zip("%s_%s" % (self.book.slug, self.type))
  79
  80         extra_info = self.get_extra_info_json()
  81         extra_info.update(self.read_meta())
  82         self.extra_info = json.dumps(extra_info)
  83         self.source_sha1 = self.read_source_sha1(self.file.path, self.type)
  84         return super(BookMedia, self).save(*args, **kwargs)
  85
  86     def read_meta(self):
  87         """
  88             Reads some metadata from the audiobook.
  89         """
  90         import mutagen
  91         from mutagen import id3
  92
  93         artist_name = director_name = project = funded_by = ''
  94         if self.type == 'mp3':
  95             try:
  96                 audio = id3.ID3(self.file.path)
  97                 artist_name = ', '.join(', '.join(tag.text) for tag in audio.getall('TPE1'))
  98                 director_name = ', '.join(', '.join(tag.text) for tag in audio.getall('TPE3'))
  99                 license = ', '.join(tag.url for tag in audio.getall('WCOP'))
 100                 project = ", ".join([
 101                     t.data.decode('utf-8') for t in audio.getall('PRIV')
 102                     if t.owner == 'wolnelektury.pl?project'])
 103                 funded_by = ", ".join([
 104                     t.data.decode('utf-8') for t in audio.getall('PRIV')
 105                     if t.owner == 'wolnelektury.pl?funded_by'])
 106             except MutagenError:
 107                 pass
 108         elif self.type == 'ogg':
 109             try:
 110                 audio = mutagen.File(self.file.path)
 111                 artist_name = ', '.join(audio.get('artist', []))
 112                 director_name = ', '.join(audio.get('conductor', []))
 113                 license = ', '.join(audio.get('license', []))
 114                 project = ", ".join(audio.get('project', []))
 115                 funded_by = ", ".join(audio.get('funded_by', []))
 116             except (MutagenError, AttributeError):
 117                 pass
 118         else:
 119             return {}
 120         return {'artist_name': artist_name, 'director_name': director_name,
 121                 'project': project, 'funded_by': funded_by, 'license': license}
 122
 123     def ext(self):
 124         return self.formats[self.type].ext
 125
 126     @staticmethod
 127     def read_source_sha1(filepath, filetype):
 128         """
 129             Reads source file SHA1 from audiobok metadata.
 130         """
 131         import mutagen
 132         from mutagen import id3
 133
 134         if filetype == 'mp3':
 135             try:
 136                 audio = id3.ID3(filepath)
 137                 return [t.data.decode('utf-8') for t in audio.getall('PRIV')
 138                         if t.owner == 'wolnelektury.pl?flac_sha1'][0]
 139             except (MutagenError, IndexError):
 140                 return None
 141         elif filetype == 'ogg':
 142             try:
 143                 audio = mutagen.File(filepath)
 144                 return audio.get('flac_sha1', [None])[0]
 145             except (MutagenError, AttributeError, IndexError):
 146                 return None
 147         else:
 148             return None
 149
 150     @property
 151     def director(self):
 152         return self.get_extra_info_json().get('director_name', None)
 153
 154     @property
 155     def artist(self):
 156         return self.get_extra_info_json().get('artist_name', None)
 157
 158     def file_url(self):
 159         return self.file.url