diff --git a/mayan/apps/metadata/api_views.py b/mayan/apps/metadata/api_views.py index c6315d85d6..6e4d7ed0db 100644 --- a/mayan/apps/metadata/api_views.py +++ b/mayan/apps/metadata/api_views.py @@ -24,7 +24,8 @@ from .permissions import (PERMISSION_METADATA_DOCUMENT_ADD, PERMISSION_METADATA_TYPE_DELETE, PERMISSION_METADATA_TYPE_EDIT, PERMISSION_METADATA_TYPE_VIEW) -from .serializers import DocumentMetadataSerializer, MetadataTypeSerializer +from .serializers import (DocumentMetadataSerializer, + DocumentTypeNewMetadataType, MetadataTypeSerializer) class APIMetadataTypeListView(generics.ListCreateAPIView): @@ -136,12 +137,13 @@ class APIDocumentMetadataView(generics.RetrieveUpdateDestroyAPIView): return super(APIDocumentMetadataView, self).put(*args, **kwargs) -class APIDocumentTypeMetadataTypeListView(generics.ListAPIView): - serializer_class = MetadataTypeSerializer +class APIDocumentTypeMetadataTypeOptionalListView(generics.ListCreateAPIView): permission_classes = (MayanPermission,) mayan_view_permissions = {'POST': [PERMISSION_DOCUMENT_TYPE_EDIT]} + required_metadata = False + def get_queryset(self): document_type = get_object_or_404(DocumentType, pk=self.kwargs['document_type_pk']) try: @@ -149,14 +151,42 @@ class APIDocumentTypeMetadataTypeListView(generics.ListAPIView): except PermissionDenied: AccessEntry.objects.check_access(PERMISSION_DOCUMENT_TYPE_VIEW, self.request.user, document_type) - return document_type.metadata.all() + return document_type.metadata_type.filter(required=self.required_metadata) def get(self, *args, **kwargs): """Returns a list of selected document type allowed metadata types.""" - return super(APIDocumentTypeMetadataTypeListView, self).get(*args, **kwargs) + return super(APIDocumentTypeMetadataTypeOptionalListView, self).get(*args, **kwargs) + + def get_serializer_class(self): + if self.request.method == 'GET': + return MetadataTypeSerializer + elif self.request.method == 'POST': + return DocumentTypeNewMetadataType + + def post(self, request, *args, **kwargs): + """ + Add a metadata type to a document type. + """ + document_type = get_object_or_404(DocumentType, pk=self.kwargs['document_type_pk']) + + try: + Permission.objects.check_permissions(self.request.user, [PERMISSION_DOCUMENT_TYPE_EDIT]) + except PermissionDenied: + AccessEntry.objects.check_access(PERMISSION_DOCUMENT_TYPE_EDIT, self.request.user, document_type) + + serializer = self.get_serializer(data=self.request.POST) + + if serializer.is_valid(): + metadata_type = get_object_or_404(MetadataType, pk=serializer.data['metadata_type_pk']) + document_type.metadata_type.add(metadata_type, required=self.required_metadata) + return Response(status=status.HTTP_201_CREATED) -class APIDocumentTypeMetadataTypeView(views.APIView): +class APIDocumentTypeMetadataTypeRequiredListView(APIDocumentTypeMetadataTypeOptionalListView): + required_metadata = True + + +class APIDocumentTypeMetadataTypeRequiredView(views.APIView): def delete(self, request, *args, **kwargs): """ Remove a metadata type from a document type. @@ -169,21 +199,5 @@ class APIDocumentTypeMetadataTypeView(views.APIView): AccessEntry.objects.check_access(PERMISSION_DOCUMENT_TYPE_EDIT, self.request.user, document_type) metadata_type = get_object_or_404(MetadataType, pk=self.kwargs['metadata_type_pk']) - document_type.metadata.remove(metadata_type) + document_type.metadata_type.remove(metadata_type) return Response(status=status.HTTP_204_NO_CONTENT) - - def post(self, request, *args, **kwargs): - """ - Add a metadata type to a document type. - """ - # TODO: Change to be a POST method of APIDocumentTypeMetadataTypeListView - document_type = get_object_or_404(DocumentType, pk=self.kwargs['document_type_pk']) - try: - Permission.objects.check_permissions(self.request.user, [PERMISSION_DOCUMENT_TYPE_EDIT]) - except PermissionDenied: - AccessEntry.objects.check_access(PERMISSION_DOCUMENT_TYPE_EDIT, self.request.user, document_type) - - metadata_type = get_object_or_404(MetadataType, pk=self.kwargs['metadata_type_pk']) - # TODO: set required flag - document_type.metadata.add(metadata_type) - return Response(status=status.HTTP_201_CREATED) diff --git a/mayan/apps/metadata/serializers.py b/mayan/apps/metadata/serializers.py index 33fbba40d2..ea7d761b58 100644 --- a/mayan/apps/metadata/serializers.py +++ b/mayan/apps/metadata/serializers.py @@ -1,5 +1,7 @@ from __future__ import absolute_import +from django.utils.translation import ugettext_lazy as _ + from rest_framework import serializers from .models import DocumentMetadata, MetadataType @@ -15,3 +17,7 @@ class DocumentMetadataSerializer(serializers.ModelSerializer): class Meta: fields = ('id', 'document', 'metadata_type', 'value') model = DocumentMetadata + + +class DocumentTypeNewMetadataType(serializers.Serializer): + metadata_type_pk = serializers.IntegerField(help_text=_('Primary key of the metadata type to be added.')) diff --git a/mayan/apps/metadata/urls.py b/mayan/apps/metadata/urls.py index a4f746b324..527e557c1b 100644 --- a/mayan/apps/metadata/urls.py +++ b/mayan/apps/metadata/urls.py @@ -1,8 +1,9 @@ from django.conf.urls import patterns, url from .api_views import (APIDocumentMetadataListView, APIDocumentMetadataView, - APIDocumentTypeMetadataTypeListView, - APIDocumentTypeMetadataTypeView, + APIDocumentTypeMetadataTypeOptionalListView, + APIDocumentTypeMetadataTypeRequiredListView, + APIDocumentTypeMetadataTypeRequiredView, APIMetadataTypeListView, APIMetadataTypeView) urlpatterns = patterns('metadata.views', @@ -28,6 +29,7 @@ api_urls = patterns('', url(r'^metadatatypes/(?P[0-9]+)/$', APIMetadataTypeView.as_view(), name='metadatatype-detail'), url(r'^document/(?P[0-9]+)/metadata/$', APIDocumentMetadataListView.as_view(), name='documentmetadata-list'), url(r'^document/(?P[0-9]+)/metadata/(?P[0-9]+)/$', APIDocumentMetadataView.as_view(), name='documentmetadata-detail'), - url(r'^document_type/(?P[0-9]+)/metadatatypes/$', APIDocumentTypeMetadataTypeListView.as_view(), name='documenttypemetadatatype-list'), - url(r'^document_type/(?P[0-9]+)/metadatatypes/(?P[0-9]+)/$', APIDocumentTypeMetadataTypeView.as_view(), name='documenttypemetadatatype-detail'), + url(r'^document_type/(?P[0-9]+)/metadatatypes/optional/$', APIDocumentTypeMetadataTypeOptionalListView.as_view(), name='documenttypemetadatatype-list'), + url(r'^document_type/(?P[0-9]+)/metadatatypes/required/$', APIDocumentTypeMetadataTypeRequiredListView.as_view(), name='documenttypemetadatatype-list'), + url(r'^document_type/(?P[0-9]+)/metadatatypes/(?P[0-9]+)/$', APIDocumentTypeMetadataTypeRequiredView.as_view(), name='documenttypemetadatatype-detail'), )