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