Make volumes default to NULL

Closes #30

Author: ObserverOfTime

.github/workflows/tests.yml

@@ -30,6 +30,7 @@ jobs:
       - name: "Set up coveralls"
         uses: AndreMiras/coveralls-python-action@v20201129
         if: success()
+        continue-on-error: true
         with:
           parallel: true
           flag-name: SQLite
@@ -79,6 +80,7 @@ jobs:
       - name: "Set up coveralls"
         uses: AndreMiras/coveralls-python-action@v20201129
         if: success()
+        continue-on-error: true
         with:
           parallel: true
           flag-name: MySQL
@@ -129,6 +131,7 @@ jobs:
       - name: "Set up coveralls"
         uses: AndreMiras/coveralls-python-action@v20201129
         if: success()
+        continue-on-error: true
         with:
           parallel: true
           flag-name: PostgreSQL

MangAdventure/templates/index.html

@@ -17,10 +17,8 @@ <h2 class="release-title">
             </a>
           </h2>
           <div class="release-info">
-            {% with vol=release.volume num=release.number %}
-              <a href="{{ release.get_absolute_url }}" title="{{ release.title }}"
-                 class="release-link{% if release.final %} end{% endif %}">{{ release }}</a>
-            {% endwith %}
+            <a href="{{ release.get_absolute_url }}" title="{{ release.title }}"
+               class="release-link{% if release.final %} end{% endif %}">{{ release }}</a>
             <div class="chapter-metadata">
               <span class="divider"></span>
               {% with groups=release.groups.all  %}

api/v1/views.py

@@ -42,10 +42,11 @@ def _latest(request: HttpRequest, slug: Optional[str] = None,
             ).distinct().get().modified
         if num is None:
             return Chapter.objects.only('modified').filter(
-                series__slug=slug, volume=vol, published__lte=tz.now()
+                series__slug=slug, volume=vol or None,
+                published__lte=tz.now()
             ).latest().modified
         return Chapter.objects.only('modified').filter(
-            series__slug=slug, volume=vol,
+            series__slug=slug, volume=vol or None,
             number=num, published__lte=tz.now()
         ).latest().modified
     except ObjectDoesNotExist:
@@ -256,7 +257,9 @@ def volume(request: HttpRequest, slug: str, vol: int) -> JsonResponse:
             .prefetch_related('chapters__pages').get(slug=slug)
     except ObjectDoesNotExist:
         return JsonError('Not found', 404)
-    chapters = _series.chapters.filter(volume=vol, published__lte=tz.now())
+    chapters = _series.chapters.filter(
+        volume=vol or None, published__lte=tz.now()
+    )
     if not chapters:
         return JsonError('Not found', 404)
     return JsonResponse(_volume_response(request, chapters))
@@ -280,7 +283,7 @@ def chapter(request: HttpRequest, slug: str,
     """
     try:
         _chapter = Chapter.objects.prefetch_related('pages').get(
-            series__slug=slug, volume=vol,
+            series__slug=slug, volume=vol or None,
             number=num, published__lte=tz.now()
         )
     except ObjectDoesNotExist:

config/management/commands/fs2import.py

@@ -135,7 +135,7 @@ def handle(self, *args: str, **options: str):
             chapter = Chapter(
                 id=cid, series_id=sid,
                 title=self._get_column(c, 'name'),
-                volume=volume, number=number
+                volume=volume or None, number=number
             )
             self._print(
                 f'- Found {self._sql_name("Chapter")}: {chapter.series} '

docs/changelog.rst

@@ -6,6 +6,8 @@ v0.8.4
 
 * Fixed licensed chapter page
 * Fixed invalid chapter page
+* Fixed API showing licensed chapters
+* Made chapter volume default to ``NULL``
 
 v0.8.3
 ^^^^^^

reader/api.py

@@ -5,14 +5,16 @@
 from typing import TYPE_CHECKING, Type
 from warnings import filterwarnings
 
-from django.db.models import Count, Max, Prefetch, Q, Sum
+from django.db.models import Count, F, Max, Prefetch, Q, Sum
 from django.utils import timezone as tz
 
+from rest_framework.exceptions import APIException
 from rest_framework.mixins import (
     CreateModelMixin, DestroyModelMixin, ListModelMixin,
     RetrieveModelMixin, UpdateModelMixin
 )
 from rest_framework.parsers import MultiPartParser
+from rest_framework.response import Response
 from rest_framework.viewsets import GenericViewSet, ModelViewSet
 
 from api.v2.mixins import CORSMixin
@@ -23,12 +25,19 @@
 from . import filters, models, serializers
 
 if TYPE_CHECKING:  # pragma: no cover
-    from django.db.models.query import QuerySet
+    from django.db.models.query import QuerySet  # isort:skip
+    from rest_framework.request import Request  # isort:skip
 
 # XXX: We are overriding the "Series" schema on purpose.
 filterwarnings('ignore', '^Schema', module=OpenAPISchema.__base__.__module__)
 
 
+class _LegalException(APIException):
+    status_code = 451
+    default_detail = 'This series is licensed.'
+    default_code = 'licensed_series'
+
+
 class ArtistViewSet(CORSMixin, ModelViewSet):
     """
     API endpoints for artists.
@@ -145,6 +154,13 @@ class SeriesViewSet(CORSMixin, ModelViewSet):
     ordering = ('title',)
     lookup_field = 'slug'
 
+    def retrieve(self, request: Request, *args, **kwargs) -> Response:
+        instance = self.get_object()
+        if instance.licensed:
+            raise _LegalException()
+        serializer = self.get_serializer(instance)
+        return Response(serializer.data)
+
     def get_queryset(self) -> QuerySet:
         q = Q(chapters__published__lte=tz.now())
         return models.Series.objects.annotate(
@@ -167,18 +183,24 @@ class CubariViewSet(RetrieveModelMixin, CORSMixin, GenericViewSet):
     serializer_class = serializers.CubariSerializer
     lookup_field = 'slug'
 
+    def retrieve(self, request: Request, *args, **kwargs) -> Response:
+        instance = self.get_object()
+        if instance.licensed:
+            raise _LegalException()
+        serializer = self.get_serializer(instance)
+        return Response(serializer.data)
+
     def get_queryset(self) -> QuerySet:
         pages = models.Page.objects.order_by('number')
         groups = Group.objects.only('name')
         chapters = models.Chapter.objects.prefetch_related(
             Prefetch('pages', queryset=pages),
             Prefetch('groups', queryset=groups)
-        ).order_by('volume', 'number').only(
+        ).order_by(F('volume').asc(nulls_last=True), 'number').only(
             'title', 'number', 'volume', 'modified', 'series'
         )
         return models.Series.objects.defer(
-            'manager_id', 'modified',
-            'created', 'completed', 'licensed'
+            'manager_id', 'modified', 'created', 'completed'
         ).prefetch_related(
             Prefetch('authors'), Prefetch('artists'),
             Prefetch('chapters', queryset=chapters)

reader/feeds.py

@@ -7,7 +7,7 @@
 
 from django.conf import settings
 from django.contrib.syndication.views import Feed
-from django.db.models import Prefetch
+from django.db.models import F, Prefetch
 from django.utils import timezone as tz
 from django.utils.feedgenerator import Atom1Feed
 
@@ -147,7 +147,7 @@ def get_object(self, request: HttpRequest, slug:
         ).filter(
             published__lte=tz.now(),
             series__licensed=False
-        )
+        ).order_by(F('volume').asc(nulls_last=True), 'number')
         return Series.objects.only(
             'slug', 'title', 'licensed', 'format'
         ).prefetch_related(

reader/filters.py

@@ -262,8 +262,8 @@ def filter_queryset(self, request: Request, queryset: QuerySet,
                 'error': f'{params} are required parameters.'
             })
         series = request.query_params['series']
-        volume = request.query_params['volume']
-        number = request.query_params['number']
+        volume = int(request.query_params['volume']) or None
+        number = float(request.query_params['number'])
         if request.query_params.get('track') == 'true':
             Chapter.track_view(
                 series__slug=series,

reader/migrations/0001_squashed.py

@@ -5,7 +5,7 @@
 
 from MangAdventure import storage, validators
 
-from reader.models import _cover_uploader, _PageNumberField
+from reader.models import _cover_uploader, _NonZeroIntegerField
 
 
 class Migration(migrations.Migration):
@@ -139,7 +139,7 @@ class Migration(migrations.Migration):
                     storage=storage.CDNStorage(),
                     upload_to='', max_length=255
                 )),
-                ('number', _PageNumberField()),
+                ('number', _NonZeroIntegerField()),
                 ('chapter', models.ForeignKey(
                     on_delete=models.deletion.CASCADE,
                     related_name='pages', to='reader.Chapter'

reader/migrations/0010_null_volumes.py

@@ -0,0 +1,51 @@
+from django.core.validators import MinValueValidator
+from django.db import migrations, models
+
+from reader.models import _NonZeroIntegerField
+
+
+class Migration(migrations.Migration):
+    dependencies = [('reader', '0009_constraints')]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name='chapter',
+            options={
+                'get_latest_by': ('published', 'modified')
+            }
+        ),
+        migrations.AlterField(
+            model_name='chapter',
+            name='number',
+            field=models.FloatField(
+                help_text='The number of the chapter.',
+                default=0, validators=(MinValueValidator(0),)
+            )
+        ),
+        migrations.AlterField(
+            model_name='chapter',
+            name='volume',
+            field=_NonZeroIntegerField(
+                null=True, blank=True, help_text=(
+                    'The volume of the chapter. '
+                    'Leave blank if the series has no volumes.'
+                )
+            )
+        ),
+        migrations.RunSQL(
+            sql='UPDATE reader_chapter SET volume = NULL WHERE volume = 0;',
+            reverse_sql=(
+                'UPDATE reader_chapter SET volume = 0 WHERE volume IS NULL;'
+            )
+        ),
+        migrations.AddConstraint(
+            model_name='chapter',
+            constraint=models.CheckConstraint(
+                name='volume_number_positive',
+                check=models.Q(
+                    ('volume__isnull', True),
+                    ('volume__gt', 0), _connector='OR'
+                )
+            )
+        )
+    ]