Improve page & profile deletion

Author: ObserverOfTime

config/management/commands/fs2import.py

@@ -17,7 +17,7 @@
 
 if TYPE_CHECKING:  # pragma: no cover
     from argparse import ArgumentParser
-    from xml.etree.ElementTree import Element  # nosec: B405
+    from xml.etree.ElementTree import Element
 
 
 class Command(BaseCommand):

docs/modules/config.management.commands.rst

@@ -9,6 +9,14 @@ config.management.commands package
 Submodules
 ----------
 
+config.management.commands.clearcache module
+--------------------------------------------
+
+.. automodule:: config.management.commands.clearcache
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 config.management.commands.createsuperuser module
 -------------------------------------------------
 

pyproject.toml

@@ -163,6 +163,7 @@ skips = [
   "B104", # 0.0.0.0 is only used in debug mode
   "B301", # pickled data is verified with HMAC
   "B403", # pickled data is verified with HMAC
+  "B405", # covered by B314 (xml parse)
   "B703", # covered by B308 (mark_safe)
 ]
 

reader/models.py

@@ -17,8 +17,8 @@
 from pathlib import PurePath
 from shutil import rmtree
 from threading import Lock, Thread
-from typing import Any, List, Tuple, Union
-from xml.etree import ElementTree as ET  # nosec: B405
+from typing import Any, Dict, List, Optional, Tuple, Union
+from xml.etree import ElementTree as ET
 from zipfile import ZipFile
 
 from django.conf import settings
@@ -545,7 +545,7 @@ def comicinfo(self) -> ET.Element:
         web.text = f'{scheme}://{domain}{self.get_absolute_url()}'
 
         count = ET.SubElement(root, 'PageCount')
-        count.text = str(len(self.pages.all()))
+        count.text = str(self.pages.count())
 
         language = ET.SubElement(root, 'LanguageISO')
         language.text = 'en'
@@ -701,6 +701,13 @@ class Meta:
             ),
         )
 
+    def delete(self, using: Optional[str] = None,
+               keep_parents: bool = False) -> Tuple[int, Dict[str, int]]:
+        if self.image:
+            # XXX: can't use self.image.delete() for some reason
+            self.image.storage.delete(self.image.name)
+        return super().delete()
+
     def get_absolute_url(self) -> str:
         """
         Get the absolute URL of the object.

reader/receivers.py

@@ -129,19 +129,6 @@ def complete_series(sender: Type[Chapter], instance: Chapter, **kwargs):
         instance.series.save(update_fields=('status',))
 
 
-@receiver(signals.post_delete, sender=Page)
-def remove_page(sender: Type[Page], instance: Page, **kwargs):
-    """
-    Receive a signal when a page has been deleted.
-
-    Remove the image file of the page.
-
-    :param sender: The model class that sent the signal.
-    :param instance: The instance of the model.
-    """
-    instance.image.storage.delete(instance.image.name)
-
-
 @receiver(signals.post_save, sender=Chapter)
 def clear_chapter_cache(sender: Type[Chapter], instance:
                         Chapter, created: bool, **kwargs):
@@ -201,5 +188,5 @@ def track_view(sender: Type[WSGIHandler], environ:
 
 __all__ = [
     'redirect_series', 'redirect_chapter',
-    'complete_series', 'remove_page', 'track_view'
+    'complete_series', 'track_view'
 ]

reader/tests/test_models.py

@@ -1,3 +1,5 @@
+from os.path import exists
+
 from django.core.exceptions import ValidationError
 from django.urls import reverse
 
@@ -178,6 +180,13 @@ def test_create(self):
         assert str(page) == 'My Series - 1/0.5 #001'
         assert hash(page) > 0
 
+    def test_delete(self):
+        page = self.create_page()
+        path = page.image.path
+        assert exists(path)
+        page.delete()
+        assert not exists(path)
+
     def test_get_absolute_url(self):
         page = self.create_page()
         assert page.get_absolute_url() == reverse('reader:page', kwargs={

reader/tests/test_receivers.py

@@ -1,4 +1,3 @@
-from os.path import exists
 from typing import List, Tuple
 
 from django.conf import settings
@@ -88,20 +87,6 @@ def test_complete(self):
         assert self.series.status == 'completed'
 
 
-class TestRemovePage(ReaderTestBase):
-    def setup_method(self):
-        super().setup_method()
-        series = Series.objects.create(title='series')
-        chapter = series.chapters.create(title='Chapter', number=1)
-        self.page = chapter.pages.create(number=1, image=get_test_image())
-
-    def test_delete(self):
-        path = self.page.image.path
-        assert exists(path)
-        self.page.delete()
-        assert not exists(path)
-
-
 class TestClearChapterCache(ReaderTestBase):
     def setup_method(self):
         super().setup_method()

users/models.py

@@ -6,6 +6,7 @@
 from hashlib import blake2b
 from pathlib import PurePath
 from secrets import token_hex
+from typing import Dict, Optional, Tuple
 
 from django.conf import settings
 from django.contrib.auth.models import User
@@ -80,6 +81,29 @@ def save(self, *args, **kwargs):
             ).hexdigest()
         super().save(*args, **kwargs)
 
+    def delete(self, using: Optional[str] = None,
+               keep_parents: bool = False) -> Tuple[int, Dict[str, int]]:
+        """Delete or anonymize data associated with the user."""
+        if not keep_parents:
+            self.user.username = f'ANON-{token_hex(8)}'
+            self.user.email = ''
+            self.user.first_name = ''
+            self.user.last_name = ''
+            self.user.is_active = False
+            self.user.last_login = None
+            self.user.date_joined = dt.fromtimestamp(0, tz=tz.utc)
+            self.user.save(update_fields=(
+                'username', 'first_name', 'last_name',
+                'is_active', 'email', 'date_joined', 'last_login'
+            ))
+            self.user.bookmarks.all().delete()
+            self.user.emailaddress_set.all().delete()  # type: ignore
+            self.user.socialaccount_set.all().delete()  # type: ignore
+            ApiKey.objects.filter(user_id=self.user.id).delete()
+        if self.avatar:
+            self.avatar.delete()
+        return super().delete()
+
     def get_absolute_url(self) -> str:
         """
         Get the absolute URL of the object.
@@ -97,27 +121,6 @@ def get_directory(self) -> PurePath:
         """
         return PurePath('users', str(self.id))
 
-    def delete(self):
-        """Delete or anonymize data associated with the user."""
-        self.user.username = f'ANON-{token_hex(8)}'
-        self.user.email = ''
-        self.user.first_name = ''
-        self.user.last_name = ''
-        self.user.is_active = False
-        self.user.last_login = None
-        self.user.date_joined = dt.fromtimestamp(0, tz=tz.utc)
-        self.user.save(update_fields=(
-            'username', 'first_name', 'last_name',
-            'is_active', 'email', 'date_joined', 'last_login'
-        ))
-        self.user.bookmarks.all().delete()
-        self.user.emailaddress_set.all().delete()
-        self.user.socialaccount_set.all().delete()
-        ApiKey.objects.filter(user_id=self.user.id).delete()
-        if self.avatar:
-            self.avatar.delete()
-        super().delete()
-
     def export(self) -> dict:
         """Export the data associated with the user."""
         bookmarks = self.user.bookmarks.values(

users/tests/test_models.py

@@ -1,8 +1,12 @@
+from os.path import exists
+
 from django.contrib.auth.models import User
 from django.db import IntegrityError
 
 from pytest import raises
 
+from MangAdventure.tests.utils import get_test_image
+
 from reader.models import Series
 from users.models import ApiKey, Bookmark, UserProfile, _avatar_uploader
 
@@ -35,7 +39,9 @@ def test_integrity(self):
 class TestUserProfile(UsersTestBase):
     def setup_method(self):
         super().setup_method()
-        self.profile = UserProfile.objects.create(user=self.user, bio='Test')
+        self.profile = UserProfile.objects.create(
+            user=self.user, bio='Test', avatar=get_test_image()
+        )
 
     def test_create(self):
         """Test object creation & relations."""
@@ -57,8 +63,9 @@ def test_export(self):
 
     def test_delete(self):
         """Test account deletion."""
+        path = self.profile.avatar.path
         self.profile.delete()
-        self.user.refresh_from_db()
+        assert not exists(path)
         assert self.user.email == ''
         assert self.user.first_name == ''
         assert self.user.last_name == ''