diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..b73c124 --- /dev/null +++ b/.env.example @@ -0,0 +1,28 @@ +# Copy this file to .env (in the repository root) and fill in the values. +# Never commit .env: it is in .gitignore. + +# Required outside debug mode. Generate one with: +# python -c "from django.core.management.utils import get_random_secret_key as k; print(k())" +DJANGO_SECRET_KEY= + +# Set to True only on your own computer, never on a server. +DJANGO_DEBUG=False + +# Comma-separated host names the site is served from. +DJANGO_ALLOWED_HOSTS=127.0.0.1,localhost,.eu.pythonanywhere.com +# Full origins (with https://) allowed to send forms, for HTTPS deployments. +DJANGO_CSRF_TRUSTED_ORIGINS= + +# Optional +# DJANGO_LOG_LEVEL=INFO +# DJANGO_SECURE_SSL_REDIRECT=True +# DJANGO_SECURE_HSTS_SECONDS=31536000 +# DJANGO_ANON_THROTTLE=30/minute +# DJANGO_MEDIA_ROOT=/path/to/uploads + +# PostgreSQL (leave POSTGRES_DB empty to use SQLite) +# POSTGRES_DB= +# POSTGRES_USER= +# POSTGRES_PASSWORD= +# POSTGRES_HOST=127.0.0.1 +# POSTGRES_PORT=5432 diff --git a/.github/workflows/django.yml b/.github/workflows/django.yml index e4f0513..80d8661 100644 --- a/.github/workflows/django.yml +++ b/.github/workflows/django.yml @@ -28,6 +28,8 @@ jobs: pip install pytest-django - name: Run tests working-directory: ./mysite + env: + DJANGO_SECRET_KEY: ci-only-not-secret run: | DJANGO_SETTINGS_MODULE=mysite.settings pytest dss/tests.py python manage.py test api dpp diff --git a/README.md b/README.md index 5212d5c..b18487c 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,15 @@ To install the application on your computer, open a command line and run: pip install sce@git+https://github.com/CMLPlatform/SCE_API.git ``` +# Configuration +Settings that differ per computer or server (secret key, debug mode, host names, database) are read from environment variables or from a `.env` file in the repository root. Copy `.env.example` to `.env` and fill it in. For local development, setting `DJANGO_DEBUG=True` is enough; on a server, always set `DJANGO_SECRET_KEY` and keep `DJANGO_DEBUG=False`. + +## Access rules +- The web interface requires login, except the welcome page and published DPPs (`/dpp/final//`). +- Production lines, and their processes, exchanges, transport entries and publishing steps, are only visible to the user who created the production line (and to staff). Companies, materials, products and background processes are shared between all logged-in users. +- The REST API (`/api/`) requires login. Published DPPs (`/api/metadata/`) can be read by anyone; only staff can change them. +- The Decision Support System API (`/dss/`) does not require login, so other tools can call it, but anonymous calls are rate-limited. Sessions are identified by a random ID (UUID), returned as `session_id`. + # User Manual ## Key features This software helps you to create Digital Product Passports in a streamlined way, to comply with the EU ESPR regulations. It is designed for manufacturers of consumer goods such as clothes, electronics, and batteries. diff --git a/mysite/api/serializers.py b/mysite/api/serializers.py index 27c16f2..8ece1e2 100644 --- a/mysite/api/serializers.py +++ b/mysite/api/serializers.py @@ -57,9 +57,9 @@ class Meta: model = Document fields = ['file', 'type', 'issuer', 'instructions', 'language', 'issue_date', 'expiry_date', 'file_url'] - def get_document_url(self): + def get_file_url(self, document: Document) -> str: request = self.context.get('request') - file_url = self.file.url + file_url = document.file.url return request.build_absolute_uri(file_url) class ProductPropertiesSerializer(serializers.ModelSerializer): diff --git a/mysite/api/tests.py b/mysite/api/tests.py index d0a047a..9277718 100644 --- a/mysite/api/tests.py +++ b/mysite/api/tests.py @@ -10,7 +10,7 @@ ManufacturingProcess, Facility, ProductExchange, SustainabilityEvaluation, SustainabilityScore, ImpactCategory, ImpactIndicator, ) -from api.serializers import MetadataSerializer, ProductItemSerializer, ProductModelSerializer, SustainabilityEvaluationSerializer +from api.serializers import DocumentSerializer, MetadataSerializer, ProductItemSerializer, ProductModelSerializer, SustainabilityEvaluationSerializer class MetadataSerializerTests(TestCase): @@ -173,6 +173,17 @@ def test_file_urls_are_absolute(self): self.assertTrue(first_doc["file_url"].startswith("http")) self.assertIn(doc.file, first_doc["file_url"]) +class DocumentSerializerTests(TestCase): + """DocumentSerializer must return an absolute URL in file_url.""" + + def test_file_url_is_absolute(self): + doc = Document.objects.create(file="documents/LICENSE", type="manual") + doc.refresh_from_db() # Load as an API request does (issue_date as datetime). + request = APIRequestFactory().get("/api/document/") + data = DocumentSerializer(doc, context={"request": request}).data + self.assertEqual(data["file_url"], request.build_absolute_uri(doc.file.url)) + + class LifeCycleEventSerializerTests(TestCase): """ Tests for LifeCycleEventSerializer and its child classes diff --git a/mysite/api/urls.py b/mysite/api/urls.py index 0bf352e..59754a0 100644 --- a/mysite/api/urls.py +++ b/mysite/api/urls.py @@ -1,61 +1,76 @@ -from django.contrib import admin from django.urls import path, include -from . import views +from drf_spectacular.utils import extend_schema from rest_framework.routers import DefaultRouter -router = DefaultRouter() -router.register(r'organization', views.OrganizationViewSet, basename='Organization') -router.register(r'institution', views.InstitutionViewSet, basename='Institution') -router.register(r'company', views.CompanyViewSet, basename='Company') -router.register(r'importer', views.ImporterViewSet, basename='Importer') -router.register(r'serviceoperator', views.ServiceOperatorViewSet, basename='ServiceOperator') -router.register(r'metadata', views.MetadataViewSet, basename='Metadata') -router.register(r'instruction', views.InstructionViewSet, basename='Instruction') -router.register(r'document', views.DocumentViewSet, basename='Document') -router.register(r'material', views.MaterialViewSet, basename='Material') -router.register(r'hazardousmaterial', views.HazardousMaterialViewSet, basename='HazardousMaterial') -router.register(r'productmodel', views.ProductModelViewSet, basename='ProductModel') -router.register(r'productbatch', views.ProductBatchViewSet, basename='ProductBatch') -router.register(r'productproperties', views.ProductPropertiesViewSet, basename='ProductProperties') -router.register(r'dppdetails', views.DppDetailsViewSet, basename='DppDetails') -router.register(r'secondaryproduct', views.SecondaryProductViewSet, basename='SecondaryProduct') -router.register(r'emission', views.EmissionViewSet, basename='Emission') -router.register(r'composition', views.CompositionViewSet, basename='Composition') -router.register(r'productitem', views.ProductItemViewSet, basename='ProductItem') -router.register(r'activity', views.ActivityViewSet, basename='Activity') -router.register(r'manufacturingprocess', views.ManufacturingProcessViewSet, basename='ManufacturingProcess') -router.register(r'productionline', views.ProductionLineViewSet, basename='ProductionLine') -router.register(r'process', views.ProcessViewSet, basename='Process') -router.register(r'backgroundprocess', views.BackgroundProcessViewSet, basename='BackgroundProcess') -router.register(r'productexchange', views.ProductExchangeViewSet, basename='ProductExchange') -router.register(r'envexchange', views.EnvExchangeViewSet, basename='EnvExchange') -router.register(r'alias', views.AliasViewSet, basename='Alias') -router.register(r'transport', views.TransportViewSet, basename='Transport') -router.register(r'lifecycleevent', views.LifeCycleEventViewSet, basename='LifeCycleEvent') -router.register(r'inspectionevent', views.InspectionEventViewSet, basename='InspectionEvent') -router.register(r'maintenanceevent', views.MaintenanceEventViewSet, basename='MaintenanceEvent') -router.register(r'itemexchange', views.ItemExchangeViewSet, basename='ItemExchange') -router.register(r'disassemblyevent', views.DisassemblyEventViewSet, basename='DisassemblyEvent') -router.register(r'indicatorset', views.IndicatorSetViewSet, basename='IndicatorSet') -router.register(r'impactcategory', views.ImpactCategoryViewSet, basename='ImpactCategory') -router.register(r'impactindicator', views.ImpactIndicatorViewSet, basename='ImpactIndicator') -router.register(r'sustainabilityevaluation', views.SustainabilityEvaluationViewSet, basename='SustainabilityEvaluation') -router.register(r'sustainabilityscore', views.SustainabilityScoreViewSet, basename='SustainabilityScore') -router.register(r'circularityevaluation', views.CircularityEvaluationViewSet, basename='CircularityEvaluation') -router.register(r'circularityindicator', views.CircularityIndicatorViewSet, basename='CircularityIndicator') -router.register(r'circularityscore', views.CircularityScoreViewSet, basename='CircularityScore') -router.register(r'circularityenabler', views.CircularityTrackerViewSet, basename='CircularityTracker') +from . import views +# Routes grouped by concern. Each group is one tag (section) in the +# OpenAPI docs at /schema/swagger/ and /schema/redoc/. +ROUTE_GROUPS = { + "Organizations": [ + ("organization", views.OrganizationViewSet, "Organization"), + ("institution", views.InstitutionViewSet, "Institution"), + ("company", views.CompanyViewSet, "Company"), + ("importer", views.ImporterViewSet, "Importer"), + ("serviceoperator", views.ServiceOperatorViewSet, "ServiceOperator"), + ], + "Documents": [ + ("instruction", views.InstructionViewSet, "Instruction"), + ("document", views.DocumentViewSet, "Document"), + ], + "Products": [ + ("productmodel", views.ProductModelViewSet, "ProductModel"), + ("productbatch", views.ProductBatchViewSet, "ProductBatch"), + ("secondaryproduct", views.SecondaryProductViewSet, "SecondaryProduct"), + ("productitem", views.ProductItemViewSet, "ProductItem"), + ("productproperties", views.ProductPropertiesViewSet, "ProductProperties"), + ("dppdetails", views.DppDetailsViewSet, "DppDetails"), + ("metadata", views.MetadataViewSet, "Metadata"), + ("alias", views.AliasViewSet, "Alias"), + ], + "Materials": [ + ("material", views.MaterialViewSet, "Material"), + ("hazardousmaterial", views.HazardousMaterialViewSet, "HazardousMaterial"), + ("composition", views.CompositionViewSet, "Composition"), + ], + "Processes and inventory": [ + ("activity", views.ActivityViewSet, "Activity"), + ("manufacturingprocess", views.ManufacturingProcessViewSet, "ManufacturingProcess"), + ("productionline", views.ProductionLineViewSet, "ProductionLine"), + ("process", views.ProcessViewSet, "Process"), + ("backgroundprocess", views.BackgroundProcessViewSet, "BackgroundProcess"), + ("productexchange", views.ProductExchangeViewSet, "ProductExchange"), + ("envexchange", views.EnvExchangeViewSet, "EnvExchange"), + ("emission", views.EmissionViewSet, "Emission"), + ("transport", views.TransportViewSet, "Transport"), + ], + "Life cycle events": [ + ("lifecycleevent", views.LifeCycleEventViewSet, "LifeCycleEvent"), + ("inspectionevent", views.InspectionEventViewSet, "InspectionEvent"), + ("maintenanceevent", views.MaintenanceEventViewSet, "MaintenanceEvent"), + ("disassemblyevent", views.DisassemblyEventViewSet, "DisassemblyEvent"), + ("itemexchange", views.ItemExchangeViewSet, "ItemExchange"), + ], + "Sustainability assessment": [ + ("indicatorset", views.IndicatorSetViewSet, "IndicatorSet"), + ("impactcategory", views.ImpactCategoryViewSet, "ImpactCategory"), + ("impactindicator", views.ImpactIndicatorViewSet, "ImpactIndicator"), + ("sustainabilityevaluation", views.SustainabilityEvaluationViewSet, "SustainabilityEvaluation"), + ("sustainabilityscore", views.SustainabilityScoreViewSet, "SustainabilityScore"), + ], + "Circularity assessment": [ + ("circularityevaluation", views.CircularityEvaluationViewSet, "CircularityEvaluation"), + ("circularityindicator", views.CircularityIndicatorViewSet, "CircularityIndicator"), + ("circularityscore", views.CircularityScoreViewSet, "CircularityScore"), + ("circularityenabler", views.CircularityTrackerViewSet, "CircularityTracker"), + ], +} -urlpatterns = [ - path(r'', include(router.urls)), -] +router = DefaultRouter() +for tag, routes in ROUTE_GROUPS.items(): + for prefix, viewset, basename in routes: + router.register(prefix, extend_schema(tags=[tag])(viewset), basename=basename) -""" urlpatterns = [ - path('productionlines/', views.ProductionLinesListCreate.as_view(), name="production-view-create"), - path('productionlines/', views.ProductionLineHandle.as_view(), name="handle-productionline"), - path('processes/', views.ProcessCreate.as_view(), name="process-view-create"), - path('processes/search/', views.ProcessSearch.as_view(), name='process-search'), + path(r'', include(router.urls)), ] -""" \ No newline at end of file diff --git a/mysite/api/views.py b/mysite/api/views.py index 7569892..649b748 100644 --- a/mysite/api/views.py +++ b/mysite/api/views.py @@ -1,211 +1,213 @@ -from rest_framework import generics, status -from rest_framework.response import Response -from rest_framework.views import APIView +from django.db import models as dj_models +from rest_framework.exceptions import PermissionDenied +from rest_framework.permissions import BasePermission, SAFE_METHODS from rest_framework.viewsets import ModelViewSet from dpp.models import * +from dpp.permissions import can_access, filter_owned from .serializers import * -# This view allows to see all Production Lines. -class ProductionLinesListCreate(generics.ListCreateAPIView): - queryset = ProductionLine.objects.all() - serializer_class = ProductionLineSerializer - - # Delete all Production Lines - def delete(self, request, *args, **kwargs): - ProductionLine.objects.all().delete() - return Response(status=status.HTTP_204_NO_CONTENT) - -# Retrieve, update or delete a specific Production Line by its ID -class ProductionLineHandle(generics.RetrieveUpdateDestroyAPIView): - queryset = ProductionLine.objects.all() - serializer_class = ProductionLineSerializer - lookup_field = 'pk' # Primary key - -# Create a new Process and view all -class ProcessCreate(generics.CreateAPIView): - queryset = Process.objects.all() - serializer_class = ProcessSerializer -class ProcessSearch(APIView): - """GET /api/processes/search/?q=foobar +class OwnedModelViewSet(ModelViewSet): + """ModelViewSet that applies the ownership rules of dpp.permissions: + users only see their own production lines (and what belongs to them), + cannot link new data to another user's production line, and become + the owner of production lines they create. + Login is required by default (see REST_FRAMEWORK in settings). """ - def get(self, request, *args, **kwargs): - query = request.query_params.get('q', '').strip() - if not query: - return Response( - {"detail": "Parameter 'q' is required."}, - status=status.HTTP_400_BAD_REQUEST, - ) - - results = Process.objects.filter(process_name__icontains=query) - serializer = ProcessSerializer(results, many=True) - return Response(serializer.data, status=status.HTTP_200_OK) - - -class OrganizationViewSet(ModelViewSet): + def get_queryset(self): + return filter_owned(super().get_queryset(), self.request.user) + + def _check_references(self, serializer): + for value in serializer.validated_data.values(): + if isinstance(value, dj_models.Model) and not can_access(self.request.user, value): + raise PermissionDenied("You cannot link to another user's data.") + + def perform_create(self, serializer): + self._check_references(serializer) + model = self.get_queryset().model + if any(f.name == "created_by" for f in model._meta.fields): + serializer.save(created_by=self.request.user) + else: + serializer.save() + + def perform_update(self, serializer): + self._check_references(serializer) + serializer.save() + + +class PublicReadStaffWrite(BasePermission): + """Anyone may read; only staff may change.""" + def has_permission(self, request, view): + if request.method in SAFE_METHODS: + return True + return bool(request.user and request.user.is_staff) + +class OrganizationViewSet(OwnedModelViewSet): queryset = Organization.objects.all() serializer_class = OrganizationSerializer -class InstitutionViewSet(ModelViewSet): +class InstitutionViewSet(OwnedModelViewSet): queryset = Institution.objects.all() serializer_class = InstitutionSerializer -class CompanyViewSet(ModelViewSet): +class CompanyViewSet(OwnedModelViewSet): queryset = Company.objects.all() serializer_class = CompanySerializer -class ImporterViewSet(ModelViewSet): +class ImporterViewSet(OwnedModelViewSet): queryset = Importer.objects.all() serializer_class = ImporterSerializer -class ServiceOperatorViewSet(ModelViewSet): +class ServiceOperatorViewSet(OwnedModelViewSet): queryset = ServiceOperator.objects.all() serializer_class = ServiceOperatorSerializer -class MetadataViewSet(ModelViewSet): +class MetadataViewSet(OwnedModelViewSet): + """Published DPPs: public to read, only staff can change them.""" queryset = Metadata.objects.all() serializer_class = MetadataSerializer + permission_classes = [PublicReadStaffWrite] -class InstructionViewSet(ModelViewSet): +class InstructionViewSet(OwnedModelViewSet): queryset = Instruction.objects.all() serializer_class = InstructionSerializer -class DocumentViewSet(ModelViewSet): +class DocumentViewSet(OwnedModelViewSet): queryset = Document.objects.all() serializer_class = DocumentSerializer -class MaterialViewSet(ModelViewSet): +class MaterialViewSet(OwnedModelViewSet): queryset = Material.objects.all() serializer_class = MaterialSerializer -class HazardousMaterialViewSet(ModelViewSet): +class HazardousMaterialViewSet(OwnedModelViewSet): queryset = HazardousMaterial.objects.all() serializer_class = HazardousMaterialSerializer -class FlowViewSet(ModelViewSet): +class FlowViewSet(OwnedModelViewSet): queryset = Flow.objects.all() serializer_class = FlowSerializer -class ProductModelViewSet(ModelViewSet): +class ProductModelViewSet(OwnedModelViewSet): queryset = ProductModel.objects.all() serializer_class = ProductModelSerializer -class ProductBatchViewSet(ModelViewSet): +class ProductBatchViewSet(OwnedModelViewSet): queryset = ProductBatch.objects.all() serializer_class = ProductBatchSerializer -class ProductPropertiesViewSet(ModelViewSet): +class ProductPropertiesViewSet(OwnedModelViewSet): queryset = ProductProperties.objects.all() serializer_class = ProductPropertiesSerializer -class DppDetailsViewSet(ModelViewSet): +class DppDetailsViewSet(OwnedModelViewSet): queryset = DppDetails.objects.all() serializer_class = DppDetailsSerializer -class SecondaryProductViewSet(ModelViewSet): +class SecondaryProductViewSet(OwnedModelViewSet): queryset = SecondaryProduct.objects.all() serializer_class = SecondaryProductSerializer -class EmissionViewSet(ModelViewSet): +class EmissionViewSet(OwnedModelViewSet): queryset = Emission.objects.all() serializer_class = EmissionSerializer -class CompositionViewSet(ModelViewSet): +class CompositionViewSet(OwnedModelViewSet): queryset = Composition.objects.all() serializer_class = CompositionSerializer -class ProductItemViewSet(ModelViewSet): +class ProductItemViewSet(OwnedModelViewSet): queryset = ProductItem.objects.all() serializer_class = ProductItemSerializer -class ActivityViewSet(ModelViewSet): +class ActivityViewSet(OwnedModelViewSet): queryset = Activity.objects.all() serializer_class = ActivitySerializer -class ManufacturingProcessViewSet(ModelViewSet): +class ManufacturingProcessViewSet(OwnedModelViewSet): queryset = ManufacturingProcess.objects.all() serializer_class = ManufacturingProcessSerializer -class ProductionLineViewSet(ModelViewSet): +class ProductionLineViewSet(OwnedModelViewSet): queryset = ProductionLine.objects.all() serializer_class = ProductionLineSerializer -class ProcessViewSet(ModelViewSet): +class ProcessViewSet(OwnedModelViewSet): queryset = Process.objects.all() serializer_class = ProcessSerializer -class BackgroundProcessViewSet(ModelViewSet): +class BackgroundProcessViewSet(OwnedModelViewSet): queryset = BackgroundProcess.objects.all() serializer_class = BackgroundProcessSerializer -class ProductExchangeViewSet(ModelViewSet): +class ProductExchangeViewSet(OwnedModelViewSet): queryset = ProductExchange.objects.all() serializer_class = ProductExchangeSerializer -class EnvExchangeViewSet(ModelViewSet): +class EnvExchangeViewSet(OwnedModelViewSet): queryset = EnvExchange.objects.all() serializer_class = EnvExchangeSerializer -class AliasViewSet(ModelViewSet): +class AliasViewSet(OwnedModelViewSet): queryset = Alias.objects.all() serializer_class = AliasSerializer -class TransportViewSet(ModelViewSet): +class TransportViewSet(OwnedModelViewSet): queryset = Transport.objects.all() serializer_class = TransportSerializer -class LifeCycleEventViewSet(ModelViewSet): +class LifeCycleEventViewSet(OwnedModelViewSet): queryset = LifeCycleEvent.objects.all() serializer_class = LifeCycleEventSerializer -class InspectionEventViewSet(ModelViewSet): +class InspectionEventViewSet(OwnedModelViewSet): queryset = InspectionEvent.objects.all() serializer_class = InspectionEventSerializer -class MaintenanceEventViewSet(ModelViewSet): +class MaintenanceEventViewSet(OwnedModelViewSet): queryset = MaintenanceEvent.objects.all() serializer_class = MaintenanceEventSerializer -class ItemExchangeViewSet(ModelViewSet): +class ItemExchangeViewSet(OwnedModelViewSet): queryset = ItemExchange.objects.all() serializer_class = ItemExchangeSerializer -class DisassemblyEventViewSet(ModelViewSet): +class DisassemblyEventViewSet(OwnedModelViewSet): queryset = DisassemblyEvent.objects.all() serializer_class = DisassemblyEventSerializer -class IndicatorSetViewSet(ModelViewSet): +class IndicatorSetViewSet(OwnedModelViewSet): queryset = IndicatorSet.objects.all() serializer_class = IndicatorSetSerializer -class ImpactCategoryViewSet(ModelViewSet): +class ImpactCategoryViewSet(OwnedModelViewSet): queryset = ImpactCategory.objects.all() serializer_class = ImpactCategorySerializer -class ImpactIndicatorViewSet(ModelViewSet): +class ImpactIndicatorViewSet(OwnedModelViewSet): queryset = ImpactIndicator.objects.all() serializer_class = ImpactIndicatorSerializer -class SustainabilityEvaluationViewSet(ModelViewSet): +class SustainabilityEvaluationViewSet(OwnedModelViewSet): queryset = SustainabilityEvaluation.objects.all() serializer_class = SustainabilityEvaluationSerializer -class SustainabilityScoreViewSet(ModelViewSet): +class SustainabilityScoreViewSet(OwnedModelViewSet): queryset = SustainabilityScore.objects.all() serializer_class = SustainabilityScoreSerializer -class CircularityEvaluationViewSet(ModelViewSet): +class CircularityEvaluationViewSet(OwnedModelViewSet): queryset = CircularityEvaluation.objects.all() serializer_class = CircularityEvaluationSerializer -class CircularityIndicatorViewSet(ModelViewSet): +class CircularityIndicatorViewSet(OwnedModelViewSet): queryset = CircularityIndicator.objects.all() serializer_class = CircularityIndicatorSerializer -class CircularityScoreViewSet(ModelViewSet): +class CircularityScoreViewSet(OwnedModelViewSet): queryset = CircularityScore.objects.all() serializer_class = CircularityScoreSerializer -class CircularityTrackerViewSet(ModelViewSet): +class CircularityTrackerViewSet(OwnedModelViewSet): queryset = CircularityTracker.objects.all() serializer_class = CircularityTrackerSerializer diff --git a/mysite/dpp/migrations/0044_document_upload_validation.py b/mysite/dpp/migrations/0044_document_upload_validation.py new file mode 100644 index 0000000..cb22ab6 --- /dev/null +++ b/mysite/dpp/migrations/0044_document_upload_validation.py @@ -0,0 +1,20 @@ +# Generated by Django 6.1.3 on 2026-11-16 20:44 + +import django.core.validators +import dpp.models +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('dpp', '0043_alter_gtin'), + ] + + operations = [ + migrations.AlterField( + model_name='document', + name='file', + field=models.FileField(upload_to='documents/', validators=[django.core.validators.FileExtensionValidator(['pdf', 'txt', 'csv', 'doc', 'docx', 'xls', 'xlsx', 'odt', 'ods', 'png', 'jpg', 'jpeg']), dpp.models.validate_upload_size]), + ), + ] diff --git a/mysite/dpp/models.py b/mysite/dpp/models.py index 026a0d9..9a1f982 100644 --- a/mysite/dpp/models.py +++ b/mysite/dpp/models.py @@ -133,7 +133,22 @@ class Instruction(models.Model): def __str__(self): return self.label -class Document(models.Model): #TODO: security check on files +# Uploads: common document and image types only. No SVG or HTML, +# which browsers can run scripts from. +ALLOWED_UPLOAD_EXTENSIONS = [ + "pdf", "txt", "csv", "doc", "docx", "xls", "xlsx", "odt", "ods", + "png", "jpg", "jpeg", +] +MAX_UPLOAD_MB = 20 + +def validate_upload_size(file): + """Reject new uploads larger than MAX_UPLOAD_MB.""" + if getattr(file, "_committed", True): + return # File already stored; don't re-check (it may not be on this disk) + if file.size > MAX_UPLOAD_MB * 1024 * 1024: + raise ValidationError(f"File is larger than {MAX_UPLOAD_MB} MB.") + +class Document(models.Model): DOCUMENT_TYPES = { 'other': 'Other', "Technical document": @@ -152,7 +167,13 @@ class Document(models.Model): #TODO: security check on files {'label': 'Voluntary label', 'energy_label': 'Energy label', 'ecolabel': 'Ecolabel', 'circularity_label': 'Circularity label', 'legal': 'Legal markings'}, } - file = models.FileField(upload_to='documents/') + file = models.FileField( + upload_to='documents/', + validators=[ + FileExtensionValidator(ALLOWED_UPLOAD_EXTENSIONS), + validate_upload_size, + ], + ) type = models.CharField( "Document type", max_length=25, choices=DOCUMENT_TYPES, default='other' ) diff --git a/mysite/dpp/permissions.py b/mysite/dpp/permissions.py new file mode 100644 index 0000000..5b20712 --- /dev/null +++ b/mysite/dpp/permissions.py @@ -0,0 +1,78 @@ +"""Ownership rules for data that belongs to a user. + +A ProductionLine belongs to the user who created it. Processes, +transport entries, publishers and the exchanges of a process belong to +the owner of their production line. Everything else (companies, +materials, products, background processes, ...) is shared reference +data that every logged-in user can use. + +Staff users can see and edit everything. +""" +from django.core.exceptions import ObjectDoesNotExist +from django.db.models import Q + +from .models import ( + Activity, EnvExchange, Process, ProductExchange, ProductionLine, + Publisher, Transport, +) + + +def is_privileged(user) -> bool: + return bool(user and user.is_authenticated and user.is_staff) + + +def get_owner(obj): + """Return the user who owns `obj`, or None for shared data.""" + if isinstance(obj, ProductionLine): + return obj.created_by + if isinstance(obj, (Process, Transport, Publisher)): + return obj.production_line.created_by + if isinstance(obj, (ProductExchange, EnvExchange)): + return get_owner(obj.process) + if isinstance(obj, Activity): + try: # An Activity may be the parent row of a Process + return obj.process.production_line.created_by + except ObjectDoesNotExist: + return None + return None + + +def can_access(user, obj) -> bool: + """True if `user` may view or change `obj`.""" + if is_privileged(user): + return True + owner = get_owner(obj) + return owner is None or owner == user + + +def filter_owned(queryset, user): + """Limit `queryset` to objects that `user` may see.""" + if is_privileged(user): + return queryset + if not (user and user.is_authenticated): + return queryset.none() + model = queryset.model + if issubclass(model, ProductionLine): + return queryset.filter(created_by=user) + if issubclass(model, (Process, Transport, Publisher)): + return queryset.filter(production_line__created_by=user) + if issubclass(model, (ProductExchange, EnvExchange)): + return queryset.filter( + Q(process__process__isnull=True) + | Q(process__process__production_line__created_by=user) + ) + if model is Activity: + return queryset.filter( + Q(process__isnull=True) + | Q(process__production_line__created_by=user) + ) + return queryset + + +def limit_form_choices(form, user): + """Hide other users' production lines and processes in form dropdowns.""" + for field in form.fields.values(): + queryset = getattr(field, "queryset", None) + if queryset is not None: + field.queryset = filter_owned(queryset, user) + return form diff --git a/mysite/dpp/templates/dpp/base.html b/mysite/dpp/templates/dpp/base.html index c3d1a82..1f2ff9e 100644 --- a/mysite/dpp/templates/dpp/base.html +++ b/mysite/dpp/templates/dpp/base.html @@ -66,10 +66,10 @@

Lasers4MaaS DPP Platform

@@ -80,23 +80,23 @@

Lasers4MaaS DPP Platform

- {{ title }} New analysis - {# href="{% url 'mcda-results-pdf' session_id=session.id %}" #} + {# href="{% url 'mcda-results-pdf' token=session.token %}" #} Analysis setup {# ── Navigation ── #}
- diff --git a/mysite/dss/templates/dss/step_2.html b/mysite/dss/templates/dss/step_2.html index fcbde7b..d5f87e8 100644 --- a/mysite/dss/templates/dss/step_2.html +++ b/mysite/dss/templates/dss/step_2.html @@ -214,7 +214,7 @@

Weights & threshold {# ── Navigation ── #}
- diff --git a/mysite/dss/templates/dss/step_3.html b/mysite/dss/templates/dss/step_3.html index 639151f..31f2d9f 100644 --- a/mysite/dss/templates/dss/step_3.html +++ b/mysite/dss/templates/dss/step_3.html @@ -204,7 +204,7 @@

Sampling & ranking {# ── Navigation ── #}
- diff --git a/mysite/dss/tests.py b/mysite/dss/tests.py index a00d076..beacc69 100644 --- a/mysite/dss/tests.py +++ b/mysite/dss/tests.py @@ -836,3 +836,21 @@ class Explanations(): """ weight_mode = "flat" + + +class SessionTokenTests(APITestCase): + """MCDA sessions are reached through a random token, not a counter.""" + + def test_links_use_token(self): + from .models import McdaSession + session = McdaSession.objects.create() + url = reverse("wizard", kwargs={"token": session.token, "step": 0}) + self.assertIn(str(session.token), url) + self.assertNotIn(f"/dss/{session.pk}/", url) + + def test_unknown_token_is_not_found(self): + import uuid + url = reverse("wizard", kwargs={"token": uuid.uuid4(), "step": 0}) + self.assertEqual(self.client.get(url).status_code, 404) + response = self.client.get(f"/dss/results/{uuid.uuid4()}/") + self.assertEqual(response.status_code, 404) diff --git a/mysite/dss/urls.py b/mysite/dss/urls.py index 71f9158..3e547b6 100644 --- a/mysite/dss/urls.py +++ b/mysite/dss/urls.py @@ -13,7 +13,7 @@ path("experiments/", ExperimentComparisonInitView.as_view(), name="pd-init"), path("welding-stations/", KamComparisonInitView.as_view(), name="kam-init"), path("calculate/", McdaCalculationView.as_view(), name="mcda"), - path("/step//", McdaWizardView.as_view(), name="wizard"), - path("results//", McdaResultsView.as_view(), name="results"), - path("mcda//plot//", plot_view, name="mcda-plot"), + path("/step//", McdaWizardView.as_view(), name="wizard"), + path("results//", McdaResultsView.as_view(), name="results"), + path("mcda//plot//", plot_view, name="mcda-plot"), ] diff --git a/mysite/dss/views.py b/mysite/dss/views.py index d53e996..7e6aac1 100644 --- a/mysite/dss/views.py +++ b/mysite/dss/views.py @@ -9,6 +9,11 @@ from rest_framework.views import APIView, View from rest_framework.response import Response from rest_framework import status +from rest_framework.permissions import AllowAny +from rest_framework.throttling import AnonRateThrottle +from rest_framework import serializers +from drf_spectacular.types import OpenApiTypes +from drf_spectacular.utils import OpenApiResponse, extend_schema, inline_serializer from .serializers import ( ExperimentSerializer, ExperimentComparisonSerializer, @@ -388,7 +393,14 @@ def step3_context(session) -> dict: # The actual views # ----------------------------------- -class ExperimentKpiView(APIView): +class OpenApiView(APIView): + """DSS API endpoints stay usable without login, so partner tools can + call them. Anonymous callers are rate-limited (see settings).""" + permission_classes = [AllowAny] + throttle_classes = [AnonRateThrottle] + +@extend_schema(tags=["Decision support"], request=ExperimentSerializer, responses={200: OpenApiTypes.OBJECT}) +class ExperimentKpiView(OpenApiView): """Receives an experiment, returns a KPI set.""" def post(self, request): serializer = ExperimentSerializer(data=request.data) @@ -397,7 +409,8 @@ def post(self, request): kpi_dict = calculate_experiment_kpis(serializer.validated_data, "pd") return Response(kpi_dict, status=status.HTTP_200_OK) -class WeldStationKpiView(APIView): +@extend_schema(tags=["Decision support"], request=WeldStationSerializer, responses={200: OpenApiTypes.OBJECT}) +class WeldStationKpiView(OpenApiView): """Receives a weld station, returns a KPI set.""" def post(self, request): serializer = WeldStationSerializer(data=request.data) @@ -406,7 +419,9 @@ def post(self, request): kpi_dict = calculate_experiment_kpis(serializer.validated_data, "kam") return Response(kpi_dict, status=status.HTTP_200_OK) -class ExperimentComparisonInitView(APIView): +@extend_schema(tags=["Decision support"], request=ExperimentSerializer(many=True), + responses={302: OpenApiResponse(description="Redirect to the MCDA wizard.")}) +class ExperimentComparisonInitView(OpenApiView): """Receives an experiment list, redirects to MCDA wizard.""" def post(self, request): serializer = ExperimentComparisonSerializer(data=request.data) @@ -415,11 +430,12 @@ def post(self, request): session = calculate_kpis(serializer.validated_data) return redirect( - reverse("wizard", kwargs={"session_id": session.id, "step": 0}) + reverse("wizard", kwargs={"token": session.token, "step": 0}) ) - return Response({"session_id": session.id}, status=status.HTTP_201_CREATED) + return Response({"session_id": str(session.token)}, status=status.HTTP_201_CREATED) -class KamComparisonInitView(APIView): +@extend_schema(tags=["Decision support"], request=WeldStationSerializer(many=True), responses={201: inline_serializer("McdaSessionId", {"session_id": serializers.UUIDField()})}) +class KamComparisonInitView(OpenApiView): """Receives a weld station list, returns an MCDA session ID.""" def post(self, request): serializer = WeldStationComparisonSerializer(data=request.data) @@ -427,9 +443,9 @@ def post(self, request): session = calculate_kpis(serializer.validated_data, user="kam") - return Response({"session_id": session.id}, status=status.HTTP_201_CREATED) + return Response({"session_id": str(session.token)}, status=status.HTTP_201_CREATED) return redirect( - reverse("wizard", kwargs={"session_id": session.id, "step": 0}) + reverse("wizard", kwargs={"token": session.token, "step": 0}) ) class McdaWizardView(View): @@ -468,14 +484,14 @@ def get_context(self, step: int, session: McdaSession, **kwargs): context["session"] = session return context - def get(self, request, session_id: int, step: int): - session = get_object_or_404(McdaSession, pk=session_id) + def get(self, request, token, step: int): + session = get_object_or_404(McdaSession, token=token) form = self.get_form(step, session) context = self.get_context(step, session=session, form=form) return render(request, f"dss/step_{step}.html", context) - def post(self, request, session_id: int, step: int): - session = get_object_or_404(McdaSession, pk=session_id) + def post(self, request, token, step: int): + session = get_object_or_404(McdaSession, token=token) form = self.get_form(step, session, data=request.POST) if not form.is_valid(): @@ -486,7 +502,7 @@ def post(self, request, session_id: int, step: int): next_step = self._next_step(step, session) if next_step: - return redirect("wizard", session_id=session_id, step=next_step) + return redirect("wizard", token=token, step=next_step) # All steps done. Run the MCDA calculations config = session.build_config() @@ -498,7 +514,7 @@ def post(self, request, session_id: int, step: int): # Cache the created figures for name, fig in plots.items(): cache.set( - f"mcda_plot_{session_id}_{name}", + f"mcda_plot_{token}_{name}", fig_to_bytes(fig), timeout=PLOT_TIMEOUT, ) @@ -511,7 +527,7 @@ def post(self, request, session_id: int, step: int): 'sections': _build_sections(results), } ) - return redirect('results', pk=result.pk) + return redirect('results', token=token) return Response(response_data, status=status.HTTP_200_OK) @@ -521,6 +537,9 @@ class McdaResultsView(DetailView): template_name = "dss/results.html" context_object_name = 'result' + def get_object(self, queryset=None): + return get_object_or_404(Results, session__token=self.kwargs["token"]) + def get_context_data(self, **kwargs): context = super().get_context_data(**kwargs) result = self.object @@ -533,9 +552,9 @@ def get_context_data(self, **kwargs): return context -def plot_view(request, session_id: int, plot_name: str) -> HttpResponse: +def plot_view(request, token, plot_name: str) -> HttpResponse: """Plots a single figure (embedded in another page)""" - fig_bytes = cache.get(f"mcda_plot_{session_id}_{plot_name}") + fig_bytes = cache.get(f"mcda_plot_{token}_{plot_name}") if fig_bytes is None: return HttpResponse( "Plot not found or session expired.", @@ -545,7 +564,8 @@ def plot_view(request, session_id: int, plot_name: str) -> HttpResponse: return HttpResponse(fig_bytes, content_type="image/svg+xml") -class McdaCalculationView(APIView): +@extend_schema(tags=["Decision support"], request=McdaRequestSerializer, responses={200: OpenApiTypes.OBJECT}) +class McdaCalculationView(OpenApiView): """ Receives: decision matrix & MCDA setttings. Returns: ranking and score of alternatives. diff --git a/mysite/mysite/settings.py b/mysite/mysite/settings.py index a99438e..c0c91d4 100644 --- a/mysite/mysite/settings.py +++ b/mysite/mysite/settings.py @@ -12,19 +12,39 @@ from pathlib import Path +from django.core.exceptions import ImproperlyConfigured +from environs import Env + # Build paths inside the project like this: BASE_DIR / 'subdir'. BASE_DIR = Path(__file__).resolve().parent.parent DATA_DIR = BASE_DIR / "init_data" +# Read settings from environment variables, or from a .env file +# in the repository root (see .env.example). Never commit .env. +env = Env() +env.read_env(BASE_DIR.parent / ".env", recurse=False) -# Quick-start development settings - unsuitable for production -# See https://docs.djangoproject.com/en/5.2/howto/deployment/checklist/ -# SECURITY WARNING: keep the secret key used in production secret! -SECRET_KEY = 'django-insecure-4(nj$n*iw98^--gz@^1p-)!&4xi12y_wy5!=d86w9i=njb(aih' +# See https://docs.djangoproject.com/en/5.2/howto/deployment/checklist/ -# SECURITY WARNING: don't run with debug turned on in production! -DEBUG = True +# Debug mode is off unless explicitly enabled (DJANGO_DEBUG=True). +DEBUG = env.bool("DJANGO_DEBUG", default=False) + +# The secret key must come from the environment. Only in debug mode +# a fixed development key is used when none is set. +SECRET_KEY = env.str("DJANGO_SECRET_KEY", default="") +if not SECRET_KEY: + if DEBUG: + SECRET_KEY = "django-insecure-development-key-do-not-use-in-production" + else: + raise ImproperlyConfigured( + "Set DJANGO_SECRET_KEY (or DJANGO_DEBUG=True for local development)." + ) + +ALLOWED_HOSTS = env.list( + "DJANGO_ALLOWED_HOSTS", + default=["127.0.0.1", "localhost", ".eu.pythonanywhere.com", "www.l4m-dss.eu"], +) (BASE_DIR / "logs").mkdir(parents=True, exist_ok=True) LOGGING = { @@ -40,13 +60,19 @@ "loggers": { "django": { "handlers": ["file"], - "level": "DEBUG", + # DEBUG level logs every SQL query; keep it opt-in + "level": env.str("DJANGO_LOG_LEVEL", default="INFO"), "propagate": True, }, }, } -ALLOWED_HOSTS = ['127.0.0.1', '.eu.pythonanywhere.com'] +# HTTPS-related protections, on by default outside debug mode. +SESSION_COOKIE_SECURE = env.bool("DJANGO_SECURE_COOKIES", default=not DEBUG) +CSRF_COOKIE_SECURE = SESSION_COOKIE_SECURE +SECURE_SSL_REDIRECT = env.bool("DJANGO_SECURE_SSL_REDIRECT", default=False) +SECURE_HSTS_SECONDS = env.int("DJANGO_SECURE_HSTS_SECONDS", default=0) +CSRF_TRUSTED_ORIGINS = env.list("DJANGO_CSRF_TRUSTED_ORIGINS", default=[]) # Application definition @@ -67,6 +93,7 @@ 'dpp.apps.DppConfig', 'dss', 'rest_framework', + 'drf_spectacular', ] MIDDLEWARE = [ @@ -104,20 +131,24 @@ # Database # https://docs.djangoproject.com/en/5.2/ref/settings/#databases -DATABASES = { - 'default': { - 'ENGINE': 'django.db.backends.sqlite3', - 'NAME': BASE_DIR / 'db.sqlite3', - }, - 'deployment': { - "ENGINE": "django.db.backends.postgresql", - "NAME": "mydatabase", - "USER": "mydatabaseuser", - "PASSWORD": "mypassword", - "HOST": "127.0.0.1", - "PORT": "5432", - }, -} +if env.str("POSTGRES_DB", default=""): + DATABASES = { + "default": { + "ENGINE": "django.db.backends.postgresql", + "NAME": env.str("POSTGRES_DB"), + "USER": env.str("POSTGRES_USER", default=""), + "PASSWORD": env.str("POSTGRES_PASSWORD", default=""), + "HOST": env.str("POSTGRES_HOST", default="127.0.0.1"), + "PORT": env.str("POSTGRES_PORT", default="5432"), + }, + } +else: + DATABASES = { + "default": { + "ENGINE": "django.db.backends.sqlite3", + "NAME": BASE_DIR / "db.sqlite3", + }, + } # Password validation @@ -157,6 +188,13 @@ STATIC_ROOT = BASE_DIR / "mysite/static" STATIC_URL = 'static/' +# Uploaded files (documents). The default keeps the previous location +# (mysite/documents/) so existing uploads stay valid. Do not serve this +# folder as public static files. +MEDIA_ROOT = env.path("DJANGO_MEDIA_ROOT", default=BASE_DIR) +FILE_UPLOAD_MAX_MEMORY_SIZE = 2_621_440 # 2.5 MB in memory, larger to disk +DATA_UPLOAD_MAX_MEMORY_SIZE = 10_485_760 # 10 MB request body (non-file) + # Default primary key field type # https://docs.djangoproject.com/en/5.2/ref/settings/#default-auto-field @@ -165,3 +203,36 @@ # Redirect users to the homepage LOGIN_REDIRECT_URL = "/dpp/welcome" LOGOUT_REDIRECT_URL = "/dpp/welcome" + +# REST API: login required unless a view explicitly allows otherwise. +REST_FRAMEWORK = { + "DEFAULT_SCHEMA_CLASS": "drf_spectacular.openapi.AutoSchema", + "DEFAULT_PERMISSION_CLASSES": [ + "rest_framework.permissions.IsAuthenticated", + ], + "DEFAULT_THROTTLE_RATES": { + "anon": env.str("DJANGO_ANON_THROTTLE", default="30/minute"), + }, +} + +# OpenAPI schema (drf-spectacular). The schema and docs pages are public. +# They show the API structure only, not data. +SPECTACULAR_SETTINGS = { + "TITLE": "SCE API", + "DESCRIPTION": "DPP CRUD endpoints (/api/, login required) and DSS endpoints (/dss/, open).", + "VERSION": "1.0.0", + "SERVE_INCLUDE_SCHEMA": False, + # Tag order and descriptions in the docs. Tags are set in api/urls.py + # (ROUTE_GROUPS) and on the views in dss/views.py. + "TAGS": [ + {"name": "Organizations", "description": "Companies, institutions, importers and service operators."}, + {"name": "Documents", "description": "Uploaded documents and instructions."}, + {"name": "Products", "description": "Product models, batches, items and DPP details."}, + {"name": "Materials", "description": "Materials, hazardous materials and compositions."}, + {"name": "Processes and inventory", "description": "Production lines, processes, exchanges and transport (LCA inventory)."}, + {"name": "Life cycle events", "description": "Inspection, maintenance and disassembly events of product items."}, + {"name": "Sustainability assessment", "description": "Impact indicators, evaluations and scores."}, + {"name": "Circularity assessment", "description": "Circularity indicators, evaluations and scores."}, + {"name": "Decision support", "description": "KPI calculation and MCDA (multi-criteria decision analysis). No login required."}, + ], +} diff --git a/mysite/mysite/urls.py b/mysite/mysite/urls.py index 08f0b25..4d9b6f8 100644 --- a/mysite/mysite/urls.py +++ b/mysite/mysite/urls.py @@ -16,6 +16,7 @@ """ from django.contrib import admin from django.urls import path, include +from drf_spectacular.views import SpectacularAPIView, SpectacularRedocView, SpectacularSwaggerView urlpatterns = [ path('admin/', admin.site.urls), @@ -24,4 +25,7 @@ path('dss/', include("dss.urls")), # API for decision support path("accounts/", include("accounts.urls")), # User registration path("accounts/", include("django.contrib.auth.urls")), # User login + path("schema/", SpectacularAPIView.as_view(), name="schema"), # OpenAPI schema (YAML/JSON) + path("schema/swagger/", SpectacularSwaggerView.as_view(url_name="schema"), name="swagger-ui"), + path("schema/redoc/", SpectacularRedocView.as_view(url_name="schema"), name="redoc"), ] diff --git a/mysite/templates/base.html b/mysite/templates/base.html index 01c06a4..86dc7db 100644 --- a/mysite/templates/base.html +++ b/mysite/templates/base.html @@ -1,20 +1,20 @@ {% load i18n %} {% load static %} - - {% block title %}Lasers4MaaS authentication{% endblock %} + + {% block header %}