enableReadOnlyMode & refactor upload_url to a class

django_ckeditor_5/urls.py

@@ -1,7 +1,7 @@
 from django.urls import path
 
-from . import views
+from .views import UploadImageView
 
 urlpatterns = [
-    path("image_upload/", views.upload_file, name="ck_editor_5_upload_file"),
+    path("image_upload/", UploadImageView.as_view(), name="ck_editor_5_upload_image"),
 ]

django_ckeditor_5/views.py

@@ -7,9 +7,13 @@
 else:
     from django.utils.translation import ugettext_lazy as _
 
+import os
+import uuid
+
 from django.conf import settings
 from django.core.exceptions import ImproperlyConfigured
 from django.http import JsonResponse
+from django.views import View
 from PIL import Image
 
 from .forms import UploadFileForm
@@ -19,56 +23,59 @@ class NoImageException(Exception):
     pass
 
 
-def get_storage_class():
-    storage_setting = getattr(settings, "CKEDITOR_5_FILE_STORAGE", None)
-    default_storage_setting = getattr(settings, "DEFAULT_FILE_STORAGE", None)
-    storages_setting = getattr(settings, "STORAGES", {})
-    default_storage_name = storages_setting.get("default", {}).get("BACKEND")
-
-    if storage_setting:
-        return import_string(storage_setting)
-    elif default_storage_setting:
-        try:
-            return import_string(default_storage_setting)
-        except ImportError:
-            error_msg = f"Invalid default storage class: {default_storage_setting}"
+class UploadImageView(View):
+    def post(self, request, *args, **kwargs):
+        if request.user.is_staff or (
+            not self.request.user.is_staff
+            and getattr(settings, "CKEDITOR_5_UPLOAD_IMAGES_ALLOW_ALL_USERS", None)
+        ):
+            form = UploadFileForm(request.POST, request.FILES)
+            try:
+                self.image_verify(request.FILES["upload"])
+            except NoImageException as ex:
+                return JsonResponse({"error": {"message": f"{ex}"}})
+            if form.is_valid():
+                url = self.handle_uploaded_file(request.FILES["upload"])
+                return JsonResponse({"url": url})
+        raise Http404(_("Page not found."))
+
+    def get_storage_class(self):
+        storage_setting = getattr(settings, "CKEDITOR_5_FILE_STORAGE", None)
+        default_storage_setting = getattr(settings, "DEFAULT_FILE_STORAGE", None)
+        storages_setting = getattr(settings, "STORAGES", {})
+        default_storage_name = storages_setting.get("default", {}).get("BACKEND")
+
+        if storage_setting:
+            return import_string(storage_setting)
+        elif default_storage_setting:
+            try:
+                return import_string(default_storage_setting)
+            except ImportError:
+                error_msg = f"Invalid default storage class: {default_storage_setting}"
+                raise ImproperlyConfigured(error_msg)
+        elif default_storage_name:
+            try:
+                return import_string(default_storage_name)
+            except ImportError:
+                error_msg = f"Invalid default storage class: {default_storage_name}"
+                raise ImproperlyConfigured(error_msg)
+        else:
+            error_msg = (
+                "Either CKEDITOR_5_FILE_STORAGE, DEFAULT_FILE_STORAGE, "
+                "or STORAGES['default'] setting is required."
+            )
             raise ImproperlyConfigured(error_msg)
-    elif default_storage_name:
-        try:
-            return import_string(default_storage_name)
-        except ImportError:
-            error_msg = f"Invalid default storage class: {default_storage_name}"
-            raise ImproperlyConfigured(error_msg)
-    else:
-        error_msg = ("Either CKEDITOR_5_FILE_STORAGE, DEFAULT_FILE_STORAGE, "
-                     "or STORAGES['default'] setting is required.")
-        raise ImproperlyConfigured(error_msg)
-
-
-storage = get_storage_class()
-
-
-def image_verify(f):
-    try:
-        Image.open(f).verify()
-    except OSError:
-        raise NoImageException
-
-
-def handle_uploaded_file(f):
-    fs = storage()
-    filename = fs.save(f.name, f)
-    return fs.url(filename)
-
 
-def upload_file(request):
-    if request.method == "POST" and request.user.is_staff:
-        form = UploadFileForm(request.POST, request.FILES)
+    def image_verify(self, f):
         try:
-            image_verify(request.FILES["upload"])
-        except NoImageException as ex:
-            return JsonResponse({"error": {"message": f"{ex}"}})
-        if form.is_valid():
-            url = handle_uploaded_file(request.FILES["upload"])
-            return JsonResponse({"url": url})
-    raise Http404(_("Page not found."))
+            Image.open(f).verify()
+        except OSError:
+            raise NoImageException
+
+    def handle_uploaded_file(self, f):
+        fs = self.get_storage_class()()
+        filename = f.name.lower()
+        if getattr(settings, "CKEDITOR_5_UPLOAD_IMAGES_RENAME_UUID", None) is True:
+            new_file_name = f"{uuid.uuid4()}{os.path.splitext(filename)[1]}"
+            filename = fs.save(new_file_name, f)
+        return fs.url(filename)

example/blog/tests/test_upload_image.py

@@ -0,0 +1,26 @@
+from django.test import override_settings
+from django.urls import reverse
+
+
+def test_upload_file(admin_client, file):
+    with file as upload:
+        response = admin_client.post(
+            reverse("ck_editor_5_upload_image"),
+            {"upload": upload},
+        )
+    assert response.status_code == 200
+    assert "url" in response.json()
+
+
+@override_settings(
+    CKEDITOR_5_FILE_STORAGE="storages.backends.gcloud.GoogleCloudStorage",
+    GS_BUCKET_NAME="test",
+)
+def test_upload_file_to_google_cloud(admin_client, file, settings):
+    with file as upload:
+        response = admin_client.post(
+            reverse("ck_editor_5_upload_image"),
+            {"upload": upload},
+        )
+    assert response.status_code == 200
+    assert "url" in response.json()

pyproject.toml

@@ -183,4 +183,4 @@ max-statements = 50  # Recommended: 50
 "example/blog/manage.py" = ["TRY003"]
 "example/blog/blog/settings.py" = ["N816", "S105"]
 "example/blog/tests/*" = ["S101"]
-"example/blog/tests/test_upload_file.py" = ["ARG001"]
+"example/blog/tests/test_upload_image.py" = ["ARG001"]