src/catalogue/api/serializers.py

   1 # This file is part of Wolne Lektury, licensed under GNU Affero GPLv3 or later.
   2 # Copyright © Fundacja Wolne Lektury. See NOTICE for more information.
   3 #
   4 from rest_framework import serializers
   5 from api.fields import AbsoluteURLField, LegacyMixin, ThumbnailField
   6 from catalogue.models import Book, Collection, Tag, BookMedia, Fragment
   7 from .fields import BookLiked, EmbargoURLField
   8
   9
  10 class TagSerializer(serializers.ModelSerializer):
  11     url = AbsoluteURLField()
  12     href = AbsoluteURLField(
  13         view_name='catalogue_api_tag',
  14         view_args=('category', 'slug')
  15     )
  16
  17     class Meta:
  18         model = Tag
  19         fields = ['url', 'href', 'name', 'slug']
  20
  21
  22 class TagDetailSerializer(serializers.ModelSerializer):
  23     url = AbsoluteURLField()
  24
  25     class Meta:
  26         model = Tag
  27         fields = [
  28             'name', 'url', 'sort_key',
  29             'description',
  30             'description_pl',
  31             'plural', 'genre_epoch_specific',
  32             'adjective_feminine_singular', 'adjective_nonmasculine_plural',
  33             'genitive', 'collective_noun',
  34         ]
  35         write_only_fields = [
  36             'description_pl',
  37             'plural', 'genre_epoch_specific',
  38             'adjective_feminine_singular', 'adjective_nonmasculine_plural',
  39             'genitive', 'collective_noun',
  40         ]
  41
  42
  43 class AuthorItemSerializer(serializers.ModelSerializer):
  44     url = AbsoluteURLField()
  45     href = AbsoluteURLField(
  46         view_name='catalogue_api_author',
  47         view_args=('slug',)
  48     )
  49
  50     class Meta:
  51         model = Tag
  52         fields = [
  53             'url', 'href', 'name', 'slug'
  54         ]
  55
  56 class AuthorSerializer(AuthorItemSerializer):
  57     photo_thumb = ThumbnailField('139x193', source='photo')
  58
  59     class Meta:
  60         model = Tag
  61         fields = [
  62             'id', 'url', 'href', 'name', 'slug', 'sort_key', 'description',
  63             'genitive', 'photo', 'photo_thumb', 'photo_attribution',
  64         ]
  65
  66 class EpochItemSerializer(serializers.ModelSerializer):
  67     url = AbsoluteURLField()
  68     href = AbsoluteURLField(
  69         view_name='catalogue_api_epoch',
  70         view_args=('slug',)
  71     )
  72     class Meta:
  73         model = Tag
  74         fields = ['url', 'href', 'name', 'slug']
  75
  76 class EpochSerializer(EpochItemSerializer):
  77     class Meta:
  78         model = Tag
  79         fields = [
  80             'url', 'href', 'name', 'slug', 'sort_key', 'description',
  81             'adjective_feminine_singular', 'adjective_nonmasculine_plural',
  82         ]
  83
  84 class GenreItemSerializer(serializers.ModelSerializer):
  85     url = AbsoluteURLField()
  86     href = AbsoluteURLField(
  87         view_name='catalogue_api_genre',
  88         view_args=('slug',)
  89     )
  90     class Meta:
  91         model = Tag
  92         fields = ['url', 'href', 'name', 'slug']
  93
  94 class GenreSerializer(GenreItemSerializer):
  95     class Meta:
  96         model = Tag
  97         fields = [
  98             'url', 'href', 'name', 'slug', 'sort_key', 'description',
  99             'plural', 'genre_epoch_specific',
 100         ]
 101
 102 class KindItemSerializer(serializers.ModelSerializer):
 103     url = AbsoluteURLField()
 104     href = AbsoluteURLField(
 105         view_name='catalogue_api_kind',
 106         view_args=('slug',)
 107     )
 108     class Meta:
 109         model = Tag
 110         fields = ['url', 'href', 'name', 'slug']
 111
 112 class KindSerializer(KindItemSerializer):
 113     class Meta:
 114         model = Tag
 115         fields = [
 116             'url', 'href', 'name', 'slug', 'sort_key', 'description',
 117             'collective_noun',
 118         ]
 119
 120 class ThemeSerializer(serializers.ModelSerializer):
 121     url = AbsoluteURLField()
 122     href = AbsoluteURLField(
 123         view_name='catalogue_api_theme',
 124         view_args=('slug',)
 125     )
 126     class Meta:
 127         model = Tag
 128         fields = [
 129             'url', 'href', 'name', 'slug', 'sort_key', 'description',
 130         ]
 131
 132
 133 class TranslatorSerializer(serializers.Serializer):
 134     name = serializers.CharField(source='*')
 135
 136
 137 class BookSerializer2(serializers.ModelSerializer):
 138     url = AbsoluteURLField()
 139     href = AbsoluteURLField(view_name='catalogue_api_book', view_args=['slug'])
 140     xml = EmbargoURLField(source='xml_url')
 141     html = EmbargoURLField(source='html_url')
 142     txt = EmbargoURLField(source='txt_url')
 143     fb2 = EmbargoURLField(source='fb2_url')
 144     epub = EmbargoURLField(source='epub_url')
 145     mobi = EmbargoURLField(source='mobi_url')
 146     pdf = EmbargoURLField(source='pdf_url')
 147
 148     authors = AuthorItemSerializer(many=True)
 149     translators = AuthorItemSerializer(many=True)
 150     epochs = EpochItemSerializer(many=True)
 151     genres = GenreItemSerializer(many=True)
 152     kinds = KindItemSerializer(many=True)
 153     parent = serializers.HyperlinkedRelatedField(
 154         read_only=True,
 155         view_name='catalogue_api_book',
 156         lookup_field='slug'
 157     )
 158
 159     class Meta:
 160         model = Book
 161         fields = [
 162             'slug', 'title', 'full_sort_key',
 163             'href', 'url', 'language',
 164             'authors', 'translators',
 165             'epochs', 'genres', 'kinds',
 166             #'children',
 167             'parent', 'preview',
 168             'epub', 'mobi', 'pdf', 'html', 'txt', 'fb2', 'xml',
 169             'cover_thumb', 'cover',
 170             'isbn_pdf', 'isbn_epub', 'isbn_mobi',
 171             'abstract',
 172             'has_mp3_file',
 173         ]
 174
 175 class BookSerializer11Labs(serializers.ModelSerializer):
 176     url = AbsoluteURLField()
 177     href = AbsoluteURLField(view_name='catalogue_api_book', view_args=['slug'])
 178     html = EmbargoURLField(source='html_nonotes_url')
 179
 180     authors = AuthorItemSerializer(many=True)
 181     translators = AuthorItemSerializer(many=True)
 182     epochs = EpochItemSerializer(many=True)
 183     genres = GenreItemSerializer(many=True)
 184     kinds = KindItemSerializer(many=True)
 185     parent = serializers.HyperlinkedRelatedField(
 186         read_only=True,
 187         view_name='catalogue_api_book',
 188         lookup_field='slug'
 189     )
 190
 191     class Meta:
 192         model = Book
 193         fields = [
 194             'slug', 'title', 'full_sort_key',
 195             'href', 'url', 'language',
 196             'authors', 'translators',
 197             'epochs', 'genres', 'kinds',
 198             #'children',
 199             'parent', 'preview',
 200             'html',
 201             'cover_thumb', 'cover',
 202             'isbn_pdf', 'isbn_epub', 'isbn_mobi',
 203         ]
 204
 205
 206 class BookSerializer(LegacyMixin, serializers.ModelSerializer):
 207     author = serializers.CharField(source='author_unicode')
 208     kind = serializers.CharField(source='kind_unicode')
 209     epoch = serializers.CharField(source='epoch_unicode')
 210     genre = serializers.CharField(source='genre_unicode')
 211     liked = BookLiked()
 212
 213     simple_thumb = serializers.FileField(source='cover_api_thumb')
 214     href = AbsoluteURLField(view_name='catalogue_api_book', view_args=['slug'])
 215     url = AbsoluteURLField()
 216     cover_thumb = ThumbnailField('139x193', source='cover')
 217
 218     class Meta:
 219         model = Book
 220         fields = [
 221             'kind', 'full_sort_key', 'title', 'url', 'cover_color', 'author',
 222             'cover', 'epoch', 'href', 'has_audio', 'genre',
 223             'simple_thumb', 'slug', 'cover_thumb', 'liked']
 224         legacy_non_null_fields = [
 225             'kind', 'author', 'epoch', 'genre',
 226             'cover', 'simple_thumb', 'cover_thumb']
 227
 228
 229 class BookListSerializer(BookSerializer):
 230     cover = serializers.CharField()
 231     cover_thumb = serializers.CharField()
 232
 233     Meta = BookSerializer.Meta
 234
 235
 236 class FilterBookListSerializer(BookListSerializer):
 237     key = serializers.CharField()
 238
 239     class Meta:
 240         model = Book
 241         fields = BookListSerializer.Meta.fields + ['key']
 242         legacy_non_null_fields = BookListSerializer.Meta.legacy_non_null_fields
 243
 244
 245 class MediaSerializer(LegacyMixin, serializers.ModelSerializer):
 246     url = EmbargoURLField(source='file_url')
 247
 248     class Meta:
 249         model = BookMedia
 250         fields = ['url', 'director', 'type', 'name', 'artist']
 251         legacy_non_null_fields = ['director', 'artist']
 252
 253
 254 class MediaSerializer2(MediaSerializer):
 255     size = serializers.SerializerMethodField()
 256
 257     class Meta:
 258         model = BookMedia
 259         fields = ['url', 'director', 'type', 'name', 'part_name', 'artist', 'duration', 'size']
 260
 261     def get_size(self, obj):
 262         return obj.file.size
 263
 264
 265 class BookDetailSerializer(LegacyMixin, serializers.ModelSerializer):
 266     url = AbsoluteURLField()
 267
 268     authors = TagSerializer(many=True)
 269     translators = TranslatorSerializer(many=True)
 270     epochs = TagSerializer(many=True)
 271     genres = TagSerializer(many=True)
 272     kinds = TagSerializer(many=True)
 273
 274     fragment_data = serializers.DictField()
 275     parent = BookSerializer()
 276     children = BookSerializer(many=True)
 277
 278     xml = EmbargoURLField(source='xml_url')
 279     html = EmbargoURLField(source='html_url')
 280     txt = EmbargoURLField(source='txt_url')
 281     fb2 = EmbargoURLField(source='fb2_url')
 282     epub = EmbargoURLField(source='epub_url')
 283     mobi = EmbargoURLField(source='mobi_url')
 284     pdf = EmbargoURLField(source='pdf_url')
 285     media = MediaSerializer(many=True)
 286     cover_thumb = ThumbnailField('139x193', source='cover')
 287     simple_thumb = serializers.FileField(source='cover_api_thumb')
 288
 289     class Meta:
 290         model = Book
 291         fields = [
 292             'title', 'url', 'language',
 293             'epochs', 'genres', 'kinds', 'authors', 'translators',
 294             'fragment_data', 'children', 'parent', 'preview',
 295             'epub', 'mobi', 'pdf', 'html', 'txt', 'fb2', 'xml', 'media', 'audio_length',
 296             'cover_color', 'simple_cover', 'cover_thumb', 'cover', 'simple_thumb',
 297             'isbn_pdf', 'isbn_epub', 'isbn_mobi',
 298         ]
 299         legacy_non_null_fields = ['html', 'txt', 'fb2', 'epub', 'mobi', 'pdf',
 300                                   'cover', 'simple_cover', 'cover_thumb', 'simple_thumb']
 301
 302
 303 class BookPreviewSerializer(BookDetailSerializer):
 304     class Meta:
 305         model = Book
 306         fields = BookDetailSerializer.Meta.fields + ['slug']
 307         legacy_non_null_fields = BookDetailSerializer.Meta.legacy_non_null_fields
 308
 309
 310 class EbookSerializer(BookListSerializer):
 311     txt = EmbargoURLField(source='txt_url')
 312     fb2 = EmbargoURLField(source='fb2_url')
 313     epub = EmbargoURLField(source='epub_url')
 314     mobi = EmbargoURLField(source='mobi_url')
 315     pdf = EmbargoURLField(source='pdf_url')
 316
 317     class Meta:
 318         model = Book
 319         fields = ['author', 'href', 'title', 'cover', 'slug'] + Book.ebook_formats
 320         legacy_non_null_fields = ['author', 'cover'] + Book.ebook_formats
 321
 322
 323 class CollectionListSerializer(serializers.ModelSerializer):
 324     url = AbsoluteURLField()
 325     href = AbsoluteURLField(view_name='collection-detail', view_args=['slug'])
 326
 327     class Meta:
 328         model = Collection
 329         fields = ['url', 'href', 'title']
 330
 331
 332 class CollectionSerializer(serializers.ModelSerializer):
 333     books = BookSerializer(many=True, source='get_books', read_only=True)
 334     authors = TagSerializer(many=True, read_only=True)
 335     book_slugs = serializers.CharField(write_only=True, required=False)
 336     author_slugs = serializers.CharField(write_only=True, required=False)
 337     url = AbsoluteURLField()
 338
 339     class Meta:
 340         model = Collection
 341         fields = [
 342             'url', 'books', 'description', 'title',
 343             'book_slugs', 'authors', 'author_slugs'
 344         ]
 345
 346     def update(self, instance, validated_data):
 347         instance = super().update(instance, validated_data)
 348         author_slugs = validated_data.get('author_slugs', '').strip().split()
 349         if author_slugs:
 350             authors = Tag.objects.filter(
 351                 category='author',
 352                 slug__in=author_slugs
 353             )
 354         else:
 355             authors = []
 356         instance.authors.set(authors)
 357         return instance
 358
 359
 360 class FragmentSerializer(serializers.ModelSerializer):
 361     book = BookSerializer()
 362     url = AbsoluteURLField()
 363     href = AbsoluteURLField(source='get_api_url')
 364
 365     class Meta:
 366         model = Fragment
 367         fields = ['book', 'url', 'anchor', 'href']
 368
 369
 370 class FragmentDetailSerializer(serializers.ModelSerializer):
 371     book = BookSerializer()
 372     url = AbsoluteURLField()
 373     themes = TagSerializer(many=True)
 374
 375     class Meta:
 376         model = Fragment
 377         fields = ['book', 'anchor', 'text', 'url', 'themes']
 378
 379
 380 class FragmentSerializer2(serializers.ModelSerializer):
 381     url = AbsoluteURLField()
 382     html = serializers.CharField(source='text')
 383
 384     class Meta:
 385         model = Fragment
 386         fields = ['anchor', 'html', 'url']
 387
 388
 389 class FilterTagSerializer(serializers.ModelSerializer):
 390     class Meta:
 391         model = Tag
 392         fields = ['id', 'category', 'name', 'slug']