src/archive/models.py

   1 import io
   2 import json
   3 import os.path
   4
   5 from django.db import models
   6 from time import sleep
   7 from django.utils.functional import cached_property
   8 from django.utils.timezone import now
   9 from django.utils.translation import gettext_lazy as _
  10 from django_pglocks import advisory_lock
  11 import requests
  12 from archive.constants import status
  13 from archive.settings import FILES_SAVE_PATH, ADVERT, ORGANIZATION, PROJECT
  14 from archive.utils import OverwriteStorage, sha1_file
  15
  16
  17 class License(models.Model):
  18     uri = models.CharField(max_length=255, unique=True)
  19     name = models.CharField(max_length=255)
  20
  21     def __str__(self):
  22         return self.name
  23
  24
  25 class Project(models.Model):
  26     """ an audiobook project, needed for specyfing sponsors """
  27
  28     name = models.CharField(max_length=128, unique=True, db_index=True, verbose_name="Nazwa")
  29     sponsors = models.TextField(blank=True, null=True, verbose_name="Sponsorzy")
  30     description = models.TextField(blank=True, verbose_name="Opis")
  31     youtube = models.ForeignKey('youtube.YouTube', models.PROTECT)
  32
  33     class Meta:
  34         verbose_name = _("project")
  35         verbose_name_plural = _("projects")
  36         ordering = ("name",)
  37
  38     def __str__(self):
  39         return self.name
  40
  41     def get_description(self):
  42         if self.description:
  43             return self.description
  44         return "Audiobook nagrany w ramach projektu %s%s." % (
  45             self.name,
  46             " finansowanego przez %s" % self.sponsors if self.sponsors else "",
  47         )
  48
  49
  50 class Piece(models.Model):
  51     name = models.CharField(max_length=255)
  52     source_file = models.FileField(upload_to='piece')
  53     is_outro = models.BooleanField(default=False)
  54     min_audiobook_duration = models.IntegerField(default=0)
  55
  56     def __str__(self):
  57         return self.name
  58
  59
  60 def source_upload_to(intance, filename):
  61     return os.path.join(FILES_SAVE_PATH, filename) # FIXME: what about really long file names?
  62
  63
  64 class Audiobook(models.Model):
  65     source_file = models.FileField(upload_to=source_upload_to, max_length=255,
  66             verbose_name=_('source file'), editable=False)
  67     source_sha1 = models.CharField(max_length=40, editable=False)
  68
  69     title = models.CharField(max_length=255, verbose_name=_('title'))
  70     part_name = models.CharField(max_length=255, verbose_name=_('part name'), help_text=_('eg. chapter in a novel'),
  71                                  default='', blank=True)
  72     index = models.IntegerField(verbose_name=_('index'), default=0, help_text=_('Ordering of parts of a book.'))
  73     youtube_volume = models.CharField(
  74         _("Volume name for YouTube"),
  75         max_length=100,
  76         blank=True,
  77         help_text=_(
  78             "If set, audiobooks with the save value will be published as single YouTube video."
  79         ),
  80     )
  81     artist = models.CharField(max_length=255, verbose_name=_('artist'))
  82     conductor = models.CharField(max_length=255, verbose_name=_('conductor'))
  83     encoded_by = models.CharField(max_length=255, verbose_name=_('encoded by'))
  84     date = models.CharField(max_length=255, verbose_name=_('date'))
  85     project = models.ForeignKey(Project, models.PROTECT, verbose_name=_('project'))
  86     slug = models.SlugField(max_length=120, blank=True, help_text=_('WL catalogue slug of the book.'))
  87     translator = models.CharField(max_length=255, null=True, blank=True, verbose_name=_('translator'))
  88     modified = models.DateTimeField(null=True, editable=False)
  89     license = models.ForeignKey(License, models.PROTECT, null=True, blank=True, verbose_name=_('license'))
  90
  91     # publishing process
  92     mp3_status = models.SmallIntegerField(null=True, editable=False, choices=status.choices)
  93     mp3_task = models.CharField(max_length=64, null=True, editable=False)
  94     mp3_tags = models.TextField(null=True, editable=False)
  95     mp3_file = models.FileField(null=True, upload_to='archive/final', storage=OverwriteStorage(), editable=False)
  96     mp3_published_tags = models.TextField(null=True, editable=False)
  97     mp3_published = models.DateTimeField(null=True, editable=False)
  98
  99     ogg_status = models.SmallIntegerField(null=True, editable=False, choices=status.choices)
 100     ogg_task = models.CharField(max_length=64, null=True, editable=False)
 101     ogg_tags = models.TextField(null=True, editable=False)
 102     ogg_file = models.FileField(null=True, upload_to='archive/final', storage=OverwriteStorage(), editable=False)
 103     ogg_published_tags = models.TextField(null=True, editable=False)
 104     ogg_published = models.DateTimeField(null=True, editable=False)
 105
 106     youtube_status = models.SmallIntegerField(null=True, editable=False, choices=status.choices)
 107     youtube_task = models.CharField(max_length=64, null=True, editable=False)
 108     youtube_tags = models.TextField(null=True, editable=False)
 109     youtube_published_tags = models.TextField(null=True, editable=False)
 110     youtube_published = models.DateTimeField(null=True, editable=False)
 111     youtube_id = models.CharField(max_length=255, blank=True, default='')
 112     youtube_queued = models.DateTimeField(null=True, blank=True)
 113
 114     class Meta:
 115         verbose_name = _("audiobook")
 116         verbose_name_plural = _("audiobooks")
 117         ordering = ("title",)
 118
 119     def __str__(self):
 120         return self.title
 121
 122     @property
 123     def url(self):
 124         return f'https://wolnelektury.pl/katalog/lektura/{self.slug}/'
 125
 126     @property
 127     def parts_count(self):
 128         return type(self).objects.filter(slug=self.slug).count()
 129
 130     @property
 131     def youtube_volume_count(self):
 132         total = 0
 133         prev_volume = None
 134         for a in type(self).objects.filter(slug=self.slug).order_by("index"):
 135             if not a.youtube_volume or a.youtube_volume != prev_volume:
 136                 total += 1
 137             prev_volume = a.youtube_volume
 138         return total
 139
 140     @property
 141     def youtube_volume_index(self):
 142         index = 0
 143         prev_volume = None
 144         for a in type(self).objects.filter(slug=self.slug, index__lte=self.index).order_by("index"):
 145             if not a.youtube_volume or a.youtube_volume != prev_volume:
 146                 index += 1
 147             prev_volume = a.youtube_volume
 148         return index
 149
 150     @property
 151     def is_youtube_publishable(self):
 152         return (
 153             not self.youtube_volume
 154             or not type(self)
 155             .objects.filter(youtube_volume=self.youtube_volume, index__lt=self.index)
 156             .exists()
 157         )
 158
 159     def youtube_publish(self):
 160         if not self.is_youtube_publishable:
 161             return False
 162         self.youtube_status = status.QUEUED
 163         self.youtube_queued = now()
 164         self.save(update_fields=['youtube_status', 'youtube_queued'])
 165
 166     def get_mp3_tags(self): return json.loads(self.mp3_tags) if self.mp3_tags else None
 167     def get_ogg_tags(self): return json.loads(self.ogg_tags) if self.ogg_tags else None
 168     def get_mp3_published_tags(self): return json.loads(self.mp3_published_tags) if self.mp3_published_tags else None
 169     def get_ogg_published_tags_tags(self): return json.loads(self.ogg_published_tags) if self.ogg_published_tags else None
 170     def set_mp3_tags(self, tags): self.mp3_tags = json.dumps(tags)
 171     def set_ogg_tags(self, tags): self.ogg_tags = json.dumps(tags)
 172
 173     def published(self):
 174         return self.mp3_published and self.ogg_published
 175
 176     def get_source_sha1(self):
 177         assert self.pk or self.source_sha1
 178         if not self.source_sha1:
 179             with advisory_lock(f'get_source_sha1_{self.pk}'):
 180                 with open(self.source_file.path, 'rb') as f:
 181                     self.source_sha1 = sha1_file(f)
 182                 self.save(update_fields=['source_sha1'])
 183         return self.source_sha1
 184
 185     def new_publish_tags(self):
 186         title = self.title
 187         if self.translator:
 188             title += ' (tłum. %s)' % self.translator
 189
 190         copyright = "%s %s." % (
 191                 self.date, ORGANIZATION)
 192         if self.license:
 193             copyright += " Licensed to the public under %s verify at %s" % (
 194                 self.license.uri, self.url)
 195
 196         comment = "\n".join((
 197             self.project.get_description(),
 198             ADVERT
 199         ))
 200
 201         tags = {
 202             'album': PROJECT,
 203             'albumartist': ORGANIZATION,
 204             'artist': self.artist,
 205             'comment': comment,
 206             'conductor': self.conductor,
 207             'contact': self.url,
 208             'copyright': copyright,
 209             'date': self.date,
 210             'genre': 'Speech',
 211             'language': 'pol',
 212             'organization': ORGANIZATION,
 213             'title': title,
 214             'project': self.project.name,
 215         }
 216         if self.license:
 217             tags['license'] = self.license.uri
 218         if self.project.sponsors:
 219             tags['funded_by'] = self.project.sponsors
 220
 221         if self.source_sha1:
 222             tags['flac_sha1'] = self.source_sha1
 223         return tags
 224
 225     @cached_property
 226     def book(self):
 227         if self.slug:
 228             apidata = requests.get(f'https://wolnelektury.pl/api/books/{self.slug}/').json()
 229         else:
 230             return {}
 231         return apidata
 232
 233     @property
 234     def document(self):
 235         from librarian.document import WLDocument, parser
 236         from lxml import etree
 237
 238         xml_url = self.book.get('xml', None)
 239         if xml_url is None:
 240             return None
 241
 242         return WLDocument(
 243                 etree.parse(
 244                     io.BytesIO(
 245                         requests.get(xml_url).content
 246                     )
 247                     ,parser = parser
 248                 )
 249             )