Use django storages for uploading public files

Author: kbadova

config/django/base.py

@@ -49,7 +49,8 @@
     'django_celery_results',
     'django_celery_beat',
     'django_filters',
-    'corsheaders'
+    'corsheaders',
+    'storages'
 ]
 
 INSTALLED_APPS = [
@@ -170,13 +171,8 @@
 
 SERVER_HOST_DOMAIN = env("SERVER_HOST_DOMAIN", default="http://localhost:8000")
 
-# # Media
-MEDIA_ROOT = os.path.join(BASE_DIR, "media")
-MEDIA_URL = "/media/"
-
-
 from config.settings.cors import *  # noqa
 from config.settings.sessions import *  # noqa
 from config.settings.celery import *  # noqa
 from config.settings.sentry import *  # noqa
-from config.settings.aws import *  # noqa
+from config.settings.file_upload import *  # noqa

config/settings/aws.py renamed to config/settings/file_upload.py

@@ -1,21 +1,28 @@
+import os
 from config.env import env
+from config.django.base import BASE_DIR
+
+MEDIA_ROOT = os.path.join(BASE_DIR, "media")
+MEDIA_URL = "/media/"
+
+DEFAULT_FILE_STORAGE = "django.core.files.storage.FileSystemStorage"
 
-DEFAULT_FILE_STORAGE = env(
-    "DEFAULT_FILE_STORAGE",
-    default="django.core.files.storage.FileSystemStorage",
-)
 
 USE_S3_UPLOAD = env("USE_S3_UPLOAD", default=False)
 
 if USE_S3_UPLOAD:
+    DEFAULT_FILE_STORAGE = 'storages.backends.s3boto3.S3Boto3Storage'
+
     AWS_ACCESS_KEY_ID = env("AWS_ACCESS_KEY_ID")
     AWS_SECRET_ACCESS_KEY = env("AWS_SECRET_ACCESS_KEY")
     AWS_STORAGE_BUCKET_NAME = env("AWS_STORAGE_BUCKET_NAME")
 
     AWS_FILES_EXPIRY = 60 * 60  # 1 hour. Change this configuration if needed
+    AWS_S3_FILE_OVERWRITE = False
+    AWS_DEFAULT_ACL = env("AWS_DEFAULT_ACL", default='public-read')
 
-    AWS_S3_REGION_NAME = env("AWS_S3_REGION_NAME")
-    AWS_S3_CUSTOM_DOMAIN = env("AWS_S3_CUSTOM_DOMAIN")
+    # AWS_S3_REGION_NAME = env("AWS_S3_REGION_NAME")
+    AWS_S3_CUSTOM_DOMAIN = env("AWS_S3_CUSTOM_DOMAIN", default=None)
     AWS_S3_DOMAIN = (
         AWS_S3_CUSTOM_DOMAIN or f"{AWS_STORAGE_BUCKET_NAME}.s3.amazonaws.com"
     )

requirements/base.txt

@@ -13,3 +13,5 @@ django-filter==21.1
 django-cors-headers==3.10.0
 
 boto3==1.20.20
+
+django-storages==1.12.3

styleguide_example/files/migrations/0001_initial.py

@@ -1,10 +1,9 @@
-# Generated by Django 3.2.9 on 2021-12-06 15:55
+# Generated by Django 3.2.9 on 2022-02-03 13:57
 
 from django.conf import settings
 from django.db import migrations, models
 import django.db.models.deletion
 import django.utils.timezone
-import styleguide_example.files.utils
 
 
 class Migration(migrations.Migration):
@@ -22,7 +21,7 @@ class Migration(migrations.Migration):
                 ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
                 ('created_at', models.DateTimeField(db_index=True, default=django.utils.timezone.now)),
                 ('updated_at', models.DateTimeField(auto_now=True)),
-                ('file', models.FileField(blank=True, null=True, upload_to=styleguide_example.files.utils.file_generate_upload_path)),
+                ('file', models.FileField(blank=True, null=True, upload_to='files')),
                 ('file_name', models.CharField(max_length=255)),
                 ('file_type', models.CharField(max_length=255)),
                 ('uploaded_at', models.DateTimeField(blank=True, null=True)),

styleguide_example/files/models.py

@@ -5,11 +5,11 @@
 
 from styleguide_example.users.models import BaseUser
 
-from styleguide_example.files.utils import file_generate_upload_path
+# from styleguide_example.files.utils import file_generate_upload_path
 
 
 class File(BaseModel):
-    file = models.FileField(upload_to=file_generate_upload_path, null=True, blank=True)
+    file = models.FileField(upload_to="files", null=True, blank=True)  # TODO: DO we need this to be nullable?
     file_name = models.CharField(max_length=255)
     file_type = models.CharField(max_length=255)
 
@@ -18,6 +18,9 @@ class File(BaseModel):
 
     @property
     def url(self):
+        if not bool(self.file):  # TODO: DO we need this?
+            return ''
+
         if settings.USE_S3_UPLOAD:
             return self.file.url