Merge pull request #99 from LamArt/feature/SCHOOL-344/safedelete_integration

Make models soft-deletable or undeletable

Author: mzavarka

config/django/base.py

@@ -66,6 +66,7 @@
     'phonenumber_field',
     'rules.apps.AutodiscoverRulesConfig',
     'storages',
+    'safedelete'
 ]
 
 INSTALLED_APPS = [
@@ -181,7 +182,7 @@
     ),
     'DEFAULT_AUTHENTICATION_CLASSES': [],
     'DEFAULT_PERMISSION_CLASSES': [
-       'rest_framework.permissions.AllowAny',
+        'rest_framework.permissions.AllowAny',
     ],
     'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.LimitOffsetPagination',
 }
@@ -206,5 +207,5 @@
 from config.settings.sessions import *  # noqa
 from config.settings.celery import *  # noqa
 from config.settings.sentry import *  # noqa
-from config.settings.geo_django import * # noqa
-from config.settings.object_storage import * # noqa
+from config.settings.geo_django import *  # noqa
+from config.settings.object_storage import *  # noqa

open_schools_platform/common/admin.py

@@ -1,4 +1,16 @@
+from typing import Type, Sequence, Union, Callable, Any
+
 from django.contrib import admin
+from safedelete.admin import SafeDeleteAdmin, SafeDeleteAdminFilter
+
+
+class BaseAdmin(SafeDeleteAdmin):
+    list_display = ("highlight_deleted_field",)  # type: Sequence[Union[str, Callable[[Any], Any]]]
+    list_filter = (SafeDeleteAdminFilter,) + SafeDeleteAdmin.list_filter  # type: ignore[operator]
+    field_to_highlight = "name"
+
+    class Meta:
+        abstract = True
 
 
 class InputFilter(admin.SimpleListFilter):
@@ -15,3 +27,19 @@ def choices(self, changelist):
             if k != self.parameter_name
         )
         yield all_choice
+
+
+def admin_wrapper(admin_model: Type[BaseAdmin]):
+    admin_model.highlight_deleted_field.short_description = admin_model.field_to_highlight  # type: ignore[attr-defined]
+
+    if admin_model.list_display:
+        admin_model.list_display = BaseAdmin.list_display + admin_model.list_display  # type: ignore[operator]
+    else:
+        admin_model.list_display = BaseAdmin.list_display
+
+    if admin_model.list_filter:
+        admin_model.list_filter = BaseAdmin.list_filter + admin_model.list_filter
+    else:
+        admin_model.list_filter = BaseAdmin.list_filter
+
+    return admin_model

open_schools_platform/common/filters.py

@@ -1,10 +1,22 @@
+from enum import Enum
 from typing import List, Type
 
 import django_filters
-from django.db.models import Q
+from django.db.models import Q, QuerySet
 from django_filters import CharFilter, BaseInFilter, UUIDFilter
 from django_filters.rest_framework import DjangoFilterBackend
 from rest_framework.exceptions import ValidationError
+from safedelete.config import DELETED_ONLY_VISIBLE, DELETED_VISIBLE
+
+
+class SoftCondition(Enum):
+    """
+    This Enum determines which objects will be filtered regarding their soft deleting state
+    * it is used in SafeDeleteManager.all
+    """
+    NOT_DELETED = None
+    DELETED_ONLY = DELETED_ONLY_VISIBLE
+    ALL = DELETED_VISIBLE
 
 
 class CustomDjangoFilterBackend(DjangoFilterBackend):
@@ -46,20 +58,26 @@ class BaseFilterSet(django_filters.FilterSet):
 
     1. Opportunity to use special field OR_SEARCH_FIELD that will search
     for all char fields and combine results
+        * Your filter should contain this attribute: 'search = CharFilter(field_name="search", method="OR")'
         * This feature works only if your input dictionary has  pair [OR_SEARCH_FIELD: some_value]
     2. Will raise ValidationError when filter get not valid data
     3. Will order result by "-created_at" field
         * To use this class your input model type should inherit BaseModel
         otherwise you can redefine ORDER_FIELD
         * To disable this feature write ORDER_FIELD=None
         * Note: symbol '-' is the reverse trigger
+    4. SoftCondition by default is NOT_DELETED
     """
     OR_SEARCH_FIELD = "search"
     ORDER_FIELD = "-created_at"
 
-    def __init__(self, *args, **kwargs):
+    def __init__(self, data: dict = None, queryset: QuerySet = None, **kwargs):
         self.search_value = None
-        super().__init__(*args, **kwargs)
+        self.force_visibility = SoftCondition.NOT_DELETED
+        if data is not None:
+            self.force_visibility = data.get('DELETED', SoftCondition.NOT_DELETED)
+
+        super().__init__(data, queryset, **kwargs)
         if not self.is_valid():
             raise ValidationError(self.errors)
 
@@ -72,7 +90,8 @@ def OR(self, queryset, field_name, value):
 
     @property
     def qs(self):
-        base_queryset = super().qs
+        base_queryset = super().qs.all(force_visibility=self.force_visibility.value)
+
         if self.ORDER_FIELD:
             base_queryset = base_queryset.order_by(self.ORDER_FIELD)
 
@@ -122,4 +141,5 @@ def filter_by_object_ids(object_name: str):
     def func(queryset, name, value):
         values = value.split(',')
         return queryset.filter(**{"{object_name}__in".format(object_name=object_name): values})
+
     return func

open_schools_platform/common/models.py

@@ -1,9 +1,17 @@
+import safedelete
 from django.db import models
 from django.utils import timezone
 from rules.contrib.models import RulesModelMixin, RulesModelBase
+from safedelete.managers import SafeDeleteManager
+from safedelete.models import SafeDeleteModel
 
 
-class BaseModel(RulesModelMixin, models.Model, metaclass=RulesModelBase):
+class BaseManager(SafeDeleteManager):
+    pass
+
+
+class BaseModel(RulesModelMixin, SafeDeleteModel, metaclass=RulesModelBase):
+    _safedelete_policy = safedelete.config.NO_DELETE
     created_at = models.DateTimeField(db_index=True, default=timezone.now)
     updated_at = models.DateTimeField(auto_now=True)
 

open_schools_platform/common/selectors.py

@@ -14,4 +14,5 @@ def wrapper(*, filters=None, user: User = None, empty_exception: bool = False,
         if empty_exception and not qs:
             raise NotFound(empty_message)
         return qs
+
     return wrapper

open_schools_platform/common/types.py

@@ -2,7 +2,6 @@
 from django.db import models
 from django.views.generic.base import View
 
-
 # Generic type for a Django model
 # Reference: https://mypy.readthedocs.io/en/stable/kinds_of_types.html#the-type-of-class-objects
 

open_schools_platform/organization_management/circles/admin.py

@@ -3,7 +3,7 @@
 
 from .models import Circle
 from .selectors import get_circles
-from ...common.admin import InputFilter
+from ...common.admin import InputFilter, BaseAdmin, admin_wrapper
 from django.utils.translation import gettext_lazy as _
 
 
@@ -28,8 +28,9 @@ def queryset(self, request, queryset):
             return get_circles(filters={"address": address})
 
 
-class CircleAdmin(LeafletGeoAdmin):
-    list_display = ("name", "organization", "address", "capacity", "location", "id")
+@admin_wrapper
+class CircleAdmin(BaseAdmin, LeafletGeoAdmin):
+    list_display = ("organization", "address", "capacity", "location", "id")
     search_fields = ("name",)
     list_filter = (OrganizationFilter, AddressFilter)
 

open_schools_platform/organization_management/circles/migrations/0005_auto_20221029_1535.py

@@ -0,0 +1,23 @@
+# Generated by Django 3.2.12 on 2022-10-29 10:35
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('circles', '0004_reverse_location'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='circle',
+            name='deleted',
+            field=models.DateTimeField(db_index=True, editable=False, null=True),
+        ),
+        migrations.AddField(
+            model_name='circle',
+            name='deleted_by_cascade',
+            field=models.BooleanField(default=False, editable=False),
+        ),
+    ]

open_schools_platform/organization_management/circles/models.py

@@ -1,14 +1,16 @@
 import uuid
 from typing import Any
 
+import safedelete.models
 from django.contrib.gis.geos import Point
 from django.core.validators import MinValueValidator
 from django.contrib.gis.db import models
-from open_schools_platform.common.models import BaseModel
+
+from open_schools_platform.common.models import BaseModel, BaseManager
 from open_schools_platform.organization_management.organizations.models import Organization
 
 
-class CircleManager(models.Manager):
+class CircleManager(BaseManager):
     def create_circle(self, *args: Any, **kwargs: Any):
         circle = self.model(
             *args,
@@ -21,6 +23,7 @@ def create_circle(self, *args: Any, **kwargs: Any):
 
 
 class Circle(BaseModel):
+    _safedelete_policy = safedelete.config.SOFT_DELETE_CASCADE
     id = models.UUIDField(primary_key=True, default=uuid.uuid4)
     name = models.CharField(max_length=200)
     organization = models.ForeignKey(Organization, related_name="circles", on_delete=models.CASCADE)

open_schools_platform/organization_management/circles/selectors.py

@@ -27,7 +27,7 @@ def get_circle(*, filters=None, user: User = None) -> Circle:
     qs = Circle.objects.all()
     circle = CircleFilter(filters, qs).qs.first()
 
-    if user and not user.has_perm("circles.circle_access", circle):
+    if user and circle and not user.has_perm("circles.circle_access", circle):
         raise PermissionDenied
 
     return circle