Add file_url and json_url to File model and refactor

jochenklar · jochenklar · commit 641b92610090 · 2025-10-02T13:52:58.000+02:00
diff --git a/isimip_data/caveats/viewsets.py b/isimip_data/caveats/viewsets.py
@@ -5,7 +5,6 @@
 from rest_framework.response import Response
 from rest_framework.viewsets import GenericViewSet, ReadOnlyModelViewSet
 
-from isimip_data.core.utils import get_file_base_url
 from isimip_data.metadata.models import Dataset, File
 
 from .models import Caveat
@@ -30,43 +29,47 @@ def index(self, request):
     @action(detail=True, url_path='datasets', renderer_classes=[JSONRenderer])
     def detail_datasets(self, request, pk):
         caveat = self.get_object()
-        metadata_url_template = request.build_absolute_uri('/datasets/') + '{}/'
-        datasets = [
-            dict(**dataset, metadata_url=metadata_url_template.format(dataset['id']))
-            for dataset in Dataset.objects.using('metadata').filter(id__in=caveat.datasets)
-                                                            .values('id', 'path', 'version', 'public')
-        ]
-
-        response = Response(datasets)
+        base_url = request.build_absolute_uri()
+        datasets = Dataset.objects.using('metadata').filter(id__in=caveat.datasets)
+        response = Response([
+            {
+                'id': dataset.id,
+                'path': dataset.path,
+                'version': dataset.version,
+                'public': dataset.public,
+                'metadata_url': base_url + dataset.get_absolute_url(),
+            } for dataset in datasets
+        ])
         response['Content-Disposition'] = f'attachment; filename=caveat-{caveat.id}.datasets.json'
         return response
 
     @action(detail=True, url_path='files', renderer_classes=[JSONRenderer])
     def detail_files(self, request, pk):
         caveat = self.get_object()
-        metadata_url_template = request.build_absolute_uri('/files/') + '{}/'
-        file_url_template = get_file_base_url(request)
-        datasets = [
-            dict(
-                **file,
-                metadata_url=metadata_url_template.format(file['id']),
-                file_url=file_url_template + file['path']
-            )
-            for file in File.objects.using('metadata').filter(dataset__id__in=caveat.datasets)
-                                                      .values('id', 'dataset_id', 'path', 'version')
-        ]
-
-        response = Response(datasets)
+        base_url = request.build_absolute_uri()
+        files = File.objects.using('metadata').select_related('dataset').filter(dataset__id__in=caveat.datasets)
+        response = Response([
+            {
+                'id': file.id,
+                'dataset_id': file.dataset_id,
+                'path': file.path,
+                'version': file.version,
+                'public': file.public,
+                'metadata_url': base_url + file.get_absolute_url(),
+                'file_url': file.file_url,
+                'json_url': file.json_url
+            } for file in files
+        ])
         response['Content-Disposition'] = f'attachment; filename=caveat-{caveat.id}.files.json'
         return response
 
     @action(detail=True, url_path='filelist', renderer_classes=[TemplateHTMLRenderer])
     def detail_filelist(self, request, pk):
         caveat = self.get_object()
-
+        files = File.objects.using('metadata').select_related('dataset') \
+                            .filter(dataset__id__in=caveat.datasets, dataset__public=True)
         response = Response({
-            'file_base_url': get_file_base_url(request),
-            'files': File.objects.using('metadata').filter(dataset__id__in=caveat.datasets, dataset__public=True)
+            'files': files
         }, template_name='metadata/filelist.txt', content_type='text/plain; charset=utf-8')
         response['Content-Disposition'] = f'attachment; filename=caveat-{caveat.id}.txt'
         return response
diff --git a/isimip_data/core/utils.py b/isimip_data/core/utils.py
@@ -5,27 +5,6 @@
 from django.template.loader import get_template
 
 
-def trailing_slash(string):
-    if string is None:
-        return string
-    else:
-        return string.rstrip('/') + '/'
-
-
-def via_proxy(request):
-    remote_addr = request.META.get('HTTP_X_FORWARDED_FOR') or request.META.get('REMOTE_ADDR')
-    return settings.PROXY and (remote_addr in settings.PROXY)
-
-
-def get_file_base_url(request):
-    url = settings.PROXY_FILES_BASE_URL if via_proxy(request) else settings.FILES_BASE_URL
-    return trailing_slash(url)
-
-
-def get_file_api_url(request):
-    url = settings.PROXY_FILES_API_URL if via_proxy(request) else settings.FILES_API_URL
-    return trailing_slash(url)
-
 def get_download_operations(request):
     return [
         {
diff --git a/isimip_data/core/viewsets.py b/isimip_data/core/viewsets.py
@@ -4,7 +4,7 @@
 from rest_framework.viewsets import GenericViewSet
 
 from .serializers import SettingsSerializer
-from .utils import get_download_operations, get_file_api_url, get_file_base_url
+from .utils import get_download_operations
 
 
 class SettingsViewSet(ListModelMixin, GenericViewSet):
@@ -13,14 +13,6 @@ class SettingsViewSet(ListModelMixin, GenericViewSet):
 
     def get_queryset(self):
         return [
-            {
-                'key': 'FILES_BASE_URL',
-                'value': get_file_base_url(self.request),
-            },
-            {
-                'key': 'FILES_API_URL',
-                'value': get_file_api_url(self.request),
-            },
             {
                 'key': 'DOWNLOAD_OPERATIONS',
                 'value': get_download_operations(self.request),
@@ -30,6 +22,8 @@ def get_queryset(self):
                 'key': key,
                 'value': getattr(settings, key)
             } for key in [
+                'FILES_BASE_URL',
+                'FILES_API_URL',
                 'METADATA_PAGE_SIZE',
                 'METADATA_MAX_COUNT',
                 'DOWNLOAD_OPERATIONS_HELP',
diff --git a/isimip_data/download/views.py b/isimip_data/download/views.py
@@ -1,7 +1,7 @@
+from django.conf import settings
 from django.shortcuts import render
 from django.views.decorators.csrf import csrf_exempt
 
-from isimip_data.core.utils import get_file_api_url
 from isimip_data.metadata.models import File
 
 
@@ -12,7 +12,7 @@ def download(request, job_id=None):
 
     return render(request, 'download/download.html', {
         'title': 'Configure download',
-        'job_url': get_file_api_url(request) + job_id if job_id else None,
+        'job_url': settings.FILE_API_URL + job_id if job_id else None,
         'files': [
             {
                 'path': file.path,
diff --git a/isimip_data/metadata/models.py b/isimip_data/metadata/models.py
@@ -1,6 +1,7 @@
 from datetime import datetime
 from pathlib import Path
 
+from django.conf import settings
 from django.contrib.postgres.fields import ArrayField
 from django.contrib.postgres.search import SearchVectorField
 from django.db import models
@@ -197,6 +198,20 @@ def json_ld(self):
             'isPartOf': self.dataset.json_ld
         }
 
+    @cached_property
+    def file_url(self):
+        if self.dataset.restricted:
+            return f'{settings.FILES_BASE_URL}/restricted/{self.path}'
+        else:
+            return f'{settings.FILES_BASE_URL}/{self.path}'
+
+    @cached_property
+    def json_url(self):
+        if self.dataset.restricted:
+            return f'{settings.FILES_BASE_URL}/restricted/{self.json_path}'
+        else:
+            return f'{settings.FILES_BASE_URL}/{self.json_path}'
+
     def get_absolute_url(self):
         return reverse('file', kwargs={'pk': self.pk})
 
@@ -333,9 +348,6 @@ def terms_of_use(self):
     def is_external(self):
         return self.datacite is None
 
-    def get_absolute_url(self):
-        return reverse('resource', kwargs={'doi': self.doi})
-
     @cached_property
     def json_ld(self):
         data = {
@@ -379,6 +391,9 @@ def json_ld(self):
 
         return data
 
+    def get_absolute_url(self):
+        return reverse('resource', kwargs={'doi': self.doi})
+
 
 class Tree(models.Model):
 
diff --git a/isimip_data/metadata/serializers.py b/isimip_data/metadata/serializers.py
@@ -3,15 +3,13 @@
 
 from isimip_data.annotations.models import Annotation, Download, Figure, Reference
 from isimip_data.caveats.models import Caveat
-from isimip_data.core.utils import get_file_base_url
 
 from .models import Dataset, File, Identifier, Resource
 
 
 class DatasetFileSerializer(serializers.ModelSerializer):
 
     metadata_url = serializers.SerializerMethodField()
-    file_url = serializers.SerializerMethodField()
     rights = serializers.JSONField(source='rights_dict')
 
     class Meta:
@@ -28,17 +26,13 @@ class Meta:
             'url',
             'metadata_url',
             'file_url',
+            'json_url',
             'rights',
             'terms_of_use'
         )
 
     def get_metadata_url(self, obj):
-        return reverse('file', args=[obj.id], request=self.context['request'])
-
-    def get_file_url(self, obj):
-        if obj.dataset.public:
-            base_url = get_file_base_url(self.context['request'])
-            return f'{base_url}restricted/{obj.path}' if obj.dataset.restricted else f'{base_url}{obj.path}'
+        return reverse('file', args=[obj.id], request=self.context.get('request'))
 
 
 class DatasetResourceSerializer(serializers.ModelSerializer):
@@ -204,11 +198,11 @@ class Meta:
         )
 
     def get_metadata_url(self, obj):
-        return reverse('dataset', args=[obj.id], request=self.context['request'])
+        return reverse('dataset', args=[obj.id], request=self.context.get('request'))
 
     def get_filelist_url(self, obj):
         if obj.public:
-            return reverse('dataset-detail-filelist', args=[obj.id], request=self.context['request'])
+            return reverse('dataset-detail-filelist', args=[obj.id], request=self.context.get('request'))
 
     def get_caveats(self, obj):
         if self.context.get('request').GET.get('caveats'):
@@ -259,8 +253,6 @@ class FileSerializer(serializers.ModelSerializer):
     links = FileLinkSerializer(many=True)
     search_rank = serializers.FloatField(required=False, default=0.0)
     metadata_url = serializers.SerializerMethodField()
-    file_url = serializers.SerializerMethodField()
-    json_url = serializers.SerializerMethodField()
     rights = serializers.JSONField(source='rights_dict')
 
     class Meta:
@@ -289,17 +281,7 @@ class Meta:
         )
 
     def get_metadata_url(self, obj):
-        return reverse('file', args=[obj.id], request=self.context['request'])
-
-    def get_file_url(self, obj):
-        if obj.dataset.public:
-            base_url = get_file_base_url(self.context['request'])
-            return f'{base_url}restricted/{obj.path}' if obj.dataset.restricted else f'{base_url}{obj.path}'
-
-    def get_json_url(self, obj):
-        if obj.dataset.public:
-            base_url = get_file_base_url(self.context['request'])
-            return f'{base_url}restricted/{obj.json_path}' if obj.dataset.restricted else f'{base_url}{obj.json_path}'
+        return reverse('file', args=[obj.id], request=self.context.get('request'))
 
 
 class ResourceIndexSerializer(serializers.ModelSerializer):
@@ -319,17 +301,20 @@ class Meta:
             'previous_version',
             'new_version',
             'is_external',
+            'url',
             'resource_url',
             'creators_str',
             'publication_date'
         )
 
     def get_resource_url(self, obj):
-        return reverse('resource', args=[str(obj.doi)], request=self.context['request'])
+        return reverse('resource', args=[str(obj.doi)], request=self.context.get('request'))
 
 
 class ResourceSerializer(serializers.ModelSerializer):
 
+    resource_url = serializers.SerializerMethodField()
+
     class Meta:
         model = Resource
         fields = (
@@ -348,9 +333,14 @@ class Meta:
             'previous_version',
             'new_version',
             'is_external',
+            'url',
+            'resource_url',
             'datacite',
         )
 
+    def get_resource_url(self, obj):
+        return reverse('resource', args=[str(obj.doi)], request=self.context.get('request'))
+
 
 class IdentifierSerializer(serializers.ModelSerializer):
 
diff --git a/isimip_data/metadata/templates/metadata/file.html b/isimip_data/metadata/templates/metadata/file.html
@@ -96,10 +96,10 @@ <h3>{% trans 'Download' %}</h3>
             <div class="card">
                 <ul class="list-group list-group-flush">
                     <li class="list-group-item">
-                        <a href="{{ file_base_url }}{{ file.path }}">{% trans 'Download file' %}</a>
+                        <a href="{{ file.file_url }}">{% trans 'Download file' %}</a>
                     </li>
                     <li class="list-group-item">
-                        <a href="{{ file_base_url }}{{ file.json_path }}">{% trans 'Download metadata file' %}</a>
+                        <a href="{{ file.json_url }}">{% trans 'Download metadata file' %}</a>
                     </li>
                     {% if file.is_global and file.is_netcdf %}
                     <li class="list-group-item">
diff --git a/isimip_data/metadata/templates/metadata/filelist.txt b/isimip_data/metadata/templates/metadata/filelist.txt
@@ -1,2 +1,2 @@
-{% for file in files %}{{ file_base_url }}{{ file.path }}
+{% for file in files %}{{ file.file_url }}
 {% endfor %}
diff --git a/isimip_data/metadata/views.py b/isimip_data/metadata/views.py
@@ -12,7 +12,6 @@
 from isimip_data.access.utils import check_access
 from isimip_data.annotations.models import Download, Figure, Reference
 from isimip_data.caveats.models import Caveat
-from isimip_data.core.utils import get_file_base_url
 
 from .models import Dataset, File, Identifier, Resource
 from .utils import render_bibtex
@@ -74,7 +73,6 @@ def dataset(request, pk=None, path=None):
     return render(request, 'metadata/dataset.html', {
         'title': f'Dataset {obj.name}',
         'dataset': obj,
-        'file_base_url': get_file_base_url(request),
         'versions': versions,
         'public_version': versions.exclude(id=obj.id).filter(public=True).first(),
         'figures': Figure.objects.filter(annotations__datasets__contains=[obj.id]),
@@ -116,7 +114,6 @@ def file(request, pk=None, path=None):
     return render(request, 'metadata/file.html', {
         'title': f'File {obj.name}',
         'file': obj,
-        'file_base_url': get_file_base_url(request),
         'parents': [obj.dataset],
         'versions': versions,
         'public_version': versions.exclude(id=obj.id).filter(dataset__public=True).first(),
diff --git a/isimip_data/metadata/viewsets.py b/isimip_data/metadata/viewsets.py

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`		`-{% for file in files %}{{ file_base_url }}{{ file.path }}`
	`1`	`+{% for file in files %}{{ file.file_url }}`
`2`	`2`	`{% endfor %}`