Portal/rsconcept/backend/apps/rsform/views/rsforms.py

596 lines
21 KiB
Python
Raw Normal View History

2024-06-07 20:17:03 +03:00
''' Endpoints for RSForm. '''
import json
from typing import Union, cast
import pyconcept
from django.db import transaction
from django.http import HttpResponse
from drf_spectacular.utils import extend_schema, extend_schema_view
from rest_framework import generics
from rest_framework import status as c
from rest_framework import views, viewsets
from rest_framework.decorators import action, api_view
from rest_framework.request import Request
from rest_framework.response import Response
2024-07-31 14:01:39 +03:00
from rest_framework.serializers import ValidationError
2024-06-07 20:17:03 +03:00
from apps.library.models import AccessPolicy, LibraryItem, LibraryItemType, LocationHead
from apps.library.serializers import LibraryItemSerializer
from apps.users.models import User
from shared import messages as msg
from shared import permissions, utility
2024-06-07 20:17:03 +03:00
from .. import models as m
from .. import serializers as s
from .. import utils
@extend_schema(tags=['RSForm'])
@extend_schema_view()
class RSFormViewSet(viewsets.GenericViewSet, generics.ListAPIView, generics.RetrieveAPIView):
''' Endpoint: RSForm operations. '''
queryset = LibraryItem.objects.filter(item_type=LibraryItemType.RSFORM)
serializer_class = LibraryItemSerializer
2024-06-07 20:17:03 +03:00
def _get_item(self) -> LibraryItem:
return cast(LibraryItem, self.get_object())
2024-06-07 20:17:03 +03:00
def get_permissions(self):
''' Determine permission class. '''
if self.action in [
2024-07-19 19:28:55 +03:00
'load_trs',
'create_cst',
'delete_multiple_cst',
'rename_cst',
'move_cst',
'substitute',
'restore_order',
2024-07-19 19:28:55 +03:00
'reset_aliases',
2024-07-31 14:01:39 +03:00
'produce_structure',
'update_cst'
2024-06-07 20:17:03 +03:00
]:
permission_list = [permissions.ItemEditor]
2024-07-19 19:28:55 +03:00
elif self.action in [
'contents',
'details',
'export_trs',
'resolve',
'check'
]:
2024-06-07 20:17:03 +03:00
permission_list = [permissions.ItemAnyone]
else:
permission_list = [permissions.Anyone]
return [permission() for permission in permission_list]
@extend_schema(
summary='create constituenta',
tags=['Constituenta'],
request=s.CstCreateSerializer,
responses={
c.HTTP_201_CREATED: s.NewCstResponse,
2024-07-19 19:28:55 +03:00
c.HTTP_400_BAD_REQUEST: None,
2024-06-07 20:17:03 +03:00
c.HTTP_403_FORBIDDEN: None,
c.HTTP_404_NOT_FOUND: None
}
)
@action(detail=True, methods=['post'], url_path='create-cst')
def create_cst(self, request: Request, pk):
2024-06-07 20:17:03 +03:00
''' Create new constituenta. '''
schema = self._get_item()
2024-06-07 20:17:03 +03:00
serializer = s.CstCreateSerializer(data=request.data)
serializer.is_valid(raise_exception=True)
data = serializer.validated_data
2024-07-23 11:49:59 +03:00
if 'insert_after' in data and data['insert_after'] is not None:
2024-07-16 12:17:40 +03:00
try:
insert_after = m.Constituenta.objects.get(pk=data['insert_after'])
except LibraryItem.DoesNotExist:
2024-07-16 12:17:40 +03:00
return Response(status=c.HTTP_404_NOT_FOUND)
else:
insert_after = None
new_cst = m.RSForm(schema).create_cst(data, insert_after)
2024-07-16 12:17:40 +03:00
2024-07-22 21:20:17 +03:00
schema.refresh_from_db()
2024-07-31 14:01:39 +03:00
return Response(
2024-06-07 20:17:03 +03:00
status=c.HTTP_201_CREATED,
data={
'new_cst': s.CstSerializer(new_cst).data,
2024-07-22 21:20:17 +03:00
'schema': s.RSFormParseSerializer(schema).data
2024-06-07 20:17:03 +03:00
}
)
2024-07-31 14:01:39 +03:00
@extend_schema(
summary='update persistent attributes of a given constituenta',
tags=['RSForm'],
request=s.CstSerializer,
responses={
c.HTTP_200_OK: s.CstSerializer,
c.HTTP_400_BAD_REQUEST: None,
c.HTTP_403_FORBIDDEN: None,
c.HTTP_404_NOT_FOUND: None
}
)
@action(detail=True, methods=['patch'], url_path='update-cst')
def update_cst(self, request: Request, pk):
''' Update persistent attributes of a given constituenta. '''
schema = self._get_item()
serializer = s.CstSerializer(data=request.data, partial=True)
serializer.is_valid(raise_exception=True)
cst = m.Constituenta.objects.get(pk=request.data['id'])
if cst.schema != schema:
raise ValidationError({
'schema': msg.constituentaNotInRSform(schema.title)
2024-07-31 14:01:39 +03:00
})
serializer.update(instance=cst, validated_data=serializer.validated_data)
return Response(
status=c.HTTP_200_OK,
data=s.CstSerializer(cst).data
)
2024-06-07 20:17:03 +03:00
@extend_schema(
summary='produce the structure of a given constituenta',
tags=['RSForm'],
request=s.CstTargetSerializer,
responses={
c.HTTP_200_OK: s.NewMultiCstResponse,
2024-07-19 19:28:55 +03:00
c.HTTP_400_BAD_REQUEST: None,
2024-06-07 20:17:03 +03:00
c.HTTP_403_FORBIDDEN: None,
c.HTTP_404_NOT_FOUND: None
}
)
@action(detail=True, methods=['patch'], url_path='produce-structure')
2024-06-07 20:17:03 +03:00
def produce_structure(self, request: Request, pk):
''' Produce a term for every element of the target constituenta typification. '''
schema = self._get_item()
2024-06-07 20:17:03 +03:00
2024-07-22 21:20:17 +03:00
serializer = s.CstTargetSerializer(data=request.data, context={'schema': schema})
2024-06-07 20:17:03 +03:00
serializer.is_valid(raise_exception=True)
cst = cast(m.Constituenta, serializer.validated_data['target'])
if cst.cst_type not in [m.CstType.FUNCTION, m.CstType.STRUCTURED, m.CstType.TERM]:
raise ValidationError({
f'{cst.pk}': msg.constituentaNoStructure()
})
2024-06-07 20:17:03 +03:00
2024-07-22 21:20:17 +03:00
schema_details = s.RSFormParseSerializer(schema).data['items']
cst_parse = next(item for item in schema_details if item['id'] == cst.pk)['parse']
2024-06-07 20:17:03 +03:00
if not cst_parse['typification']:
return Response(
status=c.HTTP_400_BAD_REQUEST,
data={f'{cst.pk}': msg.constituentaNoStructure()}
2024-06-07 20:17:03 +03:00
)
result = m.RSForm(schema).produce_structure(cst, cst_parse)
2024-06-07 20:17:03 +03:00
return Response(
status=c.HTTP_200_OK,
data={
'cst_list': result,
2024-07-22 21:20:17 +03:00
'schema': s.RSFormParseSerializer(schema).data
2024-06-07 20:17:03 +03:00
}
)
@extend_schema(
summary='rename constituenta',
tags=['Constituenta'],
request=s.CstRenameSerializer,
responses={
c.HTTP_200_OK: s.NewCstResponse,
2024-07-19 19:28:55 +03:00
c.HTTP_400_BAD_REQUEST: None,
2024-06-07 20:17:03 +03:00
c.HTTP_403_FORBIDDEN: None,
c.HTTP_404_NOT_FOUND: None
}
)
@action(detail=True, methods=['patch'], url_path='rename-cst')
def rename_cst(self, request: Request, pk):
2024-06-07 20:17:03 +03:00
''' Rename constituenta possibly changing type. '''
schema = self._get_item()
2024-07-22 21:20:17 +03:00
serializer = s.CstRenameSerializer(data=request.data, context={'schema': schema})
2024-06-07 20:17:03 +03:00
serializer.is_valid(raise_exception=True)
cst = cast(m.Constituenta, serializer.validated_data['target'])
old_alias = cst.alias
cst.alias = serializer.validated_data['alias']
cst.cst_type = serializer.validated_data['cst_type']
2024-07-19 19:28:55 +03:00
with transaction.atomic():
cst.save()
m.RSForm(schema).apply_mapping(mapping={old_alias: cst.alias}, change_aliases=False)
2024-06-07 20:17:03 +03:00
schema.refresh_from_db()
cst.refresh_from_db()
2024-06-07 20:17:03 +03:00
return Response(
status=c.HTTP_200_OK,
data={
'new_cst': s.CstSerializer(cst).data,
2024-07-22 21:20:17 +03:00
'schema': s.RSFormParseSerializer(schema).data
2024-06-07 20:17:03 +03:00
}
)
@extend_schema(
summary='execute substitutions',
2024-06-07 20:17:03 +03:00
tags=['RSForm'],
request=s.CstSubstituteSerializer,
responses={
c.HTTP_200_OK: s.RSFormParseSerializer,
2024-07-19 19:28:55 +03:00
c.HTTP_400_BAD_REQUEST: None,
2024-06-07 20:17:03 +03:00
c.HTTP_403_FORBIDDEN: None,
c.HTTP_404_NOT_FOUND: None
}
)
@action(detail=True, methods=['patch'], url_path='substitute')
def substitute(self, request: Request, pk):
2024-06-07 20:17:03 +03:00
''' Substitute occurrences of constituenta with another one. '''
schema = self._get_item()
2024-06-07 20:17:03 +03:00
serializer = s.CstSubstituteSerializer(
data=request.data,
2024-07-22 21:20:17 +03:00
context={'schema': schema}
2024-06-07 20:17:03 +03:00
)
serializer.is_valid(raise_exception=True)
2024-07-19 19:28:55 +03:00
with transaction.atomic():
for substitution in serializer.validated_data['substitutions']:
original = cast(m.Constituenta, substitution['original'])
replacement = cast(m.Constituenta, substitution['substitution'])
m.RSForm(schema).substitute(original, replacement)
schema.refresh_from_db()
2024-06-07 20:17:03 +03:00
return Response(
status=c.HTTP_200_OK,
2024-07-22 21:20:17 +03:00
data=s.RSFormParseSerializer(schema).data
2024-06-07 20:17:03 +03:00
)
@extend_schema(
summary='delete constituents',
tags=['RSForm'],
request=s.CstListSerializer,
responses={
c.HTTP_200_OK: s.RSFormParseSerializer,
2024-07-19 19:28:55 +03:00
c.HTTP_400_BAD_REQUEST: None,
2024-06-07 20:17:03 +03:00
c.HTTP_403_FORBIDDEN: None,
c.HTTP_404_NOT_FOUND: None
}
)
@action(detail=True, methods=['patch'], url_path='delete-multiple-cst')
def delete_multiple_cst(self, request: Request, pk):
2024-06-07 20:17:03 +03:00
''' Endpoint: Delete multiple constituents. '''
schema = self._get_item()
2024-06-07 20:17:03 +03:00
serializer = s.CstListSerializer(
data=request.data,
2024-07-22 21:20:17 +03:00
context={'schema': schema}
2024-06-07 20:17:03 +03:00
)
serializer.is_valid(raise_exception=True)
m.RSForm(schema).delete_cst(serializer.validated_data['items'])
2024-07-22 21:20:17 +03:00
schema.refresh_from_db()
2024-06-07 20:17:03 +03:00
return Response(
status=c.HTTP_200_OK,
2024-07-22 21:20:17 +03:00
data=s.RSFormParseSerializer(schema).data
2024-06-07 20:17:03 +03:00
)
@extend_schema(
summary='move constituenta',
tags=['RSForm'],
request=s.CstMoveSerializer,
responses={
c.HTTP_200_OK: s.RSFormParseSerializer,
2024-07-19 19:28:55 +03:00
c.HTTP_400_BAD_REQUEST: None,
2024-06-07 20:17:03 +03:00
c.HTTP_403_FORBIDDEN: None,
c.HTTP_404_NOT_FOUND: None
}
)
@action(detail=True, methods=['patch'], url_path='move-cst')
def move_cst(self, request: Request, pk):
2024-06-07 20:17:03 +03:00
''' Endpoint: Move multiple constituents. '''
schema = self._get_item()
2024-06-07 20:17:03 +03:00
serializer = s.CstMoveSerializer(
data=request.data,
2024-07-22 21:20:17 +03:00
context={'schema': schema}
2024-06-07 20:17:03 +03:00
)
serializer.is_valid(raise_exception=True)
m.RSForm(schema).move_cst(
2024-06-07 20:17:03 +03:00
listCst=serializer.validated_data['items'],
target=serializer.validated_data['move_to']
)
return Response(
status=c.HTTP_200_OK,
2024-07-22 21:20:17 +03:00
data=s.RSFormParseSerializer(schema).data
2024-06-07 20:17:03 +03:00
)
@extend_schema(
summary='reset aliases, update expressions and references',
tags=['RSForm'],
request=None,
responses={
c.HTTP_200_OK: s.RSFormParseSerializer,
c.HTTP_403_FORBIDDEN: None,
c.HTTP_404_NOT_FOUND: None
}
)
@action(detail=True, methods=['patch'], url_path='reset-aliases')
def reset_aliases(self, request: Request, pk):
''' Endpoint: Recreate all aliases based on order. '''
schema = self._get_item()
m.RSForm(schema).reset_aliases()
2024-06-07 20:17:03 +03:00
return Response(
status=c.HTTP_200_OK,
2024-07-22 21:20:17 +03:00
data=s.RSFormParseSerializer(schema).data
2024-06-07 20:17:03 +03:00
)
@extend_schema(
summary='restore order based on types and term graph',
tags=['RSForm'],
request=None,
responses={
c.HTTP_200_OK: s.RSFormParseSerializer,
c.HTTP_403_FORBIDDEN: None,
c.HTTP_404_NOT_FOUND: None
}
)
@action(detail=True, methods=['patch'], url_path='restore-order')
def restore_order(self, request: Request, pk):
''' Endpoint: Restore order based on types and term graph. '''
schema = self._get_item()
m.RSForm(schema).restore_order()
2024-06-07 20:17:03 +03:00
return Response(
status=c.HTTP_200_OK,
2024-07-22 21:20:17 +03:00
data=s.RSFormParseSerializer(schema).data
2024-06-07 20:17:03 +03:00
)
@extend_schema(
summary='load data from TRS file',
tags=['RSForm'],
request=s.RSFormUploadSerializer,
responses={
c.HTTP_200_OK: s.RSFormParseSerializer,
2024-07-19 19:28:55 +03:00
c.HTTP_400_BAD_REQUEST: None,
2024-06-07 20:17:03 +03:00
c.HTTP_403_FORBIDDEN: None,
c.HTTP_404_NOT_FOUND: None
}
)
@action(detail=True, methods=['patch'], url_path='load-trs')
def load_trs(self, request: Request, pk):
''' Endpoint: Load data from file and replace current schema. '''
input_serializer = s.RSFormUploadSerializer(data=request.data)
input_serializer.is_valid(raise_exception=True)
schema = self._get_item()
2024-06-07 20:17:03 +03:00
load_metadata = input_serializer.validated_data['load_metadata']
data = utility.read_zipped_json(request.FILES['file'].file, utils.EXTEOR_INNER_FILENAME)
2024-07-22 21:20:17 +03:00
data['id'] = schema.pk
2024-06-07 20:17:03 +03:00
serializer = s.RSFormTRSSerializer(
data=data,
context={'load_meta': load_metadata}
)
serializer.is_valid(raise_exception=True)
result: m.RSForm = serializer.save()
2024-06-07 20:17:03 +03:00
return Response(
status=c.HTTP_200_OK,
data=s.RSFormParseSerializer(result.model).data
2024-06-07 20:17:03 +03:00
)
@extend_schema(
summary='get all constituents data from DB',
tags=['RSForm'],
request=None,
responses={
c.HTTP_200_OK: s.RSFormSerializer,
c.HTTP_404_NOT_FOUND: None
}
)
2024-07-16 12:17:40 +03:00
@action(detail=True, methods=['get'], url_path='contents')
2024-06-07 20:17:03 +03:00
def contents(self, request: Request, pk):
''' Endpoint: View schema db contents (including constituents). '''
serializer = s.RSFormSerializer(self.get_object())
2024-06-07 20:17:03 +03:00
return Response(
status=c.HTTP_200_OK,
data=serializer.data
2024-06-07 20:17:03 +03:00
)
@extend_schema(
summary='get all constituents data and parses',
tags=['RSForm'],
request=None,
responses={
c.HTTP_200_OK: s.RSFormParseSerializer,
c.HTTP_404_NOT_FOUND: None
}
)
2024-07-16 12:17:40 +03:00
@action(detail=True, methods=['get'], url_path='details')
2024-06-07 20:17:03 +03:00
def details(self, request: Request, pk):
''' Endpoint: Detailed schema view including statuses and parse. '''
serializer = s.RSFormParseSerializer(self.get_object())
2024-06-07 20:17:03 +03:00
return Response(
status=c.HTTP_200_OK,
data=serializer.data
)
@extend_schema(
summary='check RSLang expression',
tags=['RSForm', 'FormalLanguage'],
request=s.ExpressionSerializer,
responses={
c.HTTP_200_OK: s.ExpressionParseSerializer,
c.HTTP_404_NOT_FOUND: None
},
)
2024-07-16 12:17:40 +03:00
@action(detail=True, methods=['post'], url_path='check')
2024-06-07 20:17:03 +03:00
def check(self, request: Request, pk):
''' Endpoint: Check RSLang expression against schema context. '''
serializer = s.ExpressionSerializer(data=request.data)
serializer.is_valid(raise_exception=True)
expression = serializer.validated_data['expression']
pySchema = s.PyConceptAdapter(m.RSForm(self.get_object()))
result = pyconcept.check_expression(json.dumps(pySchema.data), expression)
2024-06-07 20:17:03 +03:00
return Response(
status=c.HTTP_200_OK,
data=json.loads(result)
)
@extend_schema(
summary='resolve text with references',
tags=['RSForm', 'NaturalLanguage'],
request=s.TextSerializer,
responses={
c.HTTP_200_OK: s.ResolverSerializer,
c.HTTP_404_NOT_FOUND: None
}
)
2024-07-16 12:17:40 +03:00
@action(detail=True, methods=['post'], url_path='resolve')
2024-06-07 20:17:03 +03:00
def resolve(self, request: Request, pk):
''' Endpoint: Resolve references in text against schema terms context. '''
serializer = s.TextSerializer(data=request.data)
serializer.is_valid(raise_exception=True)
text = serializer.validated_data['text']
resolver = m.RSForm(self.get_object()).resolver()
2024-06-07 20:17:03 +03:00
resolver.resolve(text)
return Response(
status=c.HTTP_200_OK,
data=s.ResolverSerializer(resolver).data
)
@extend_schema(
summary='export as TRS file',
tags=['RSForm'],
request=None,
responses={
(c.HTTP_200_OK, 'application/zip'): bytes,
c.HTTP_404_NOT_FOUND: None
}
)
@action(detail=True, methods=['get'], url_path='export-trs')
def export_trs(self, request: Request, pk):
''' Endpoint: Download Exteor compatible file. '''
schema = self._get_item()
data = s.RSFormTRSSerializer(m.RSForm(schema)).data
file = utility.write_zipped_json(data, utils.EXTEOR_INNER_FILENAME)
filename = utils.filename_for_schema(schema.alias)
2024-06-07 20:17:03 +03:00
response = HttpResponse(file, content_type='application/zip')
response['Content-Disposition'] = f'attachment; filename={filename}'
return response
class TrsImportView(views.APIView):
''' Endpoint: Upload RS form in Exteor format. '''
serializer_class = s.FileSerializer
permission_classes = [permissions.GlobalUser]
@extend_schema(
summary='import TRS file into RSForm',
tags=['RSForm'],
request=s.FileSerializer,
responses={
c.HTTP_201_CREATED: LibraryItemSerializer,
2024-06-07 20:17:03 +03:00
c.HTTP_403_FORBIDDEN: None
}
)
def post(self, request: Request):
data = utility.read_zipped_json(request.FILES['file'].file, utils.EXTEOR_INNER_FILENAME)
owner = cast(User, self.request.user)
2024-06-07 20:17:03 +03:00
_prepare_rsform_data(data, request, owner)
serializer = s.RSFormTRSSerializer(
data=data,
context={'load_meta': True}
)
serializer.is_valid(raise_exception=True)
schema: m.RSForm = serializer.save()
2024-06-07 20:17:03 +03:00
return Response(
status=c.HTTP_201_CREATED,
data=LibraryItemSerializer(schema.model).data
2024-06-07 20:17:03 +03:00
)
@extend_schema(
summary='create new RSForm empty or from file',
tags=['RSForm'],
request=LibraryItemSerializer,
2024-06-07 20:17:03 +03:00
responses={
c.HTTP_201_CREATED: LibraryItemSerializer,
2024-06-07 20:17:03 +03:00
c.HTTP_400_BAD_REQUEST: None,
c.HTTP_403_FORBIDDEN: None
}
)
@api_view(['POST'])
def create_rsform(request: Request):
''' Endpoint: Create RSForm from user input and/or trs file. '''
owner = cast(User, request.user) if not request.user.is_anonymous else None
2024-06-07 20:17:03 +03:00
if 'file' not in request.FILES:
return Response(
status=c.HTTP_400_BAD_REQUEST,
data={'file': msg.missingFile()}
)
data = utility.read_zipped_json(request.FILES['file'].file, utils.EXTEOR_INNER_FILENAME)
_prepare_rsform_data(data, request, owner)
serializer_rsform = s.RSFormTRSSerializer(data=data, context={'load_meta': True})
serializer_rsform.is_valid(raise_exception=True)
schema: m.RSForm = serializer_rsform.save()
2024-06-07 20:17:03 +03:00
return Response(
status=c.HTTP_201_CREATED,
data=LibraryItemSerializer(schema.model).data
2024-06-07 20:17:03 +03:00
)
def _prepare_rsform_data(data: dict, request: Request, owner: Union[User, None]):
2024-06-07 20:17:03 +03:00
data['owner'] = owner
if 'title' in request.data and request.data['title'] != '':
data['title'] = request.data['title']
if data['title'] == '':
data['title'] = 'Без названия ' + request.FILES['file'].fileName
if 'alias' in request.data and request.data['alias'] != '':
data['alias'] = request.data['alias']
if 'comment' in request.data and request.data['comment'] != '':
data['comment'] = request.data['comment']
visible = True
if 'visible' in request.data:
visible = request.data['visible'] == 'true'
data['visible'] = visible
read_only = False
if 'read_only' in request.data:
read_only = request.data['read_only'] == 'true'
data['read_only'] = read_only
data['access_policy'] = request.data.get('access_policy', AccessPolicy.PUBLIC)
data['location'] = request.data.get('location', LocationHead.USER)
2024-07-31 14:01:39 +03:00
@extend_schema(
summary='Inline synthesis: merge one schema into another',
tags=['Operations'],
request=s.InlineSynthesisSerializer,
responses={c.HTTP_200_OK: s.RSFormParseSerializer}
)
@api_view(['PATCH'])
def inline_synthesis(request: Request):
''' Endpoint: Inline synthesis. '''
serializer = s.InlineSynthesisSerializer(
data=request.data,
context={'user': request.user}
)
serializer.is_valid(raise_exception=True)
receiver = m.RSForm(serializer.validated_data['receiver'])
items = cast(list[m.Constituenta], serializer.validated_data['items'])
with transaction.atomic():
new_items = receiver.insert_copy(items)
for substitution in serializer.validated_data['substitutions']:
original = cast(m.Constituenta, substitution['original'])
replacement = cast(m.Constituenta, substitution['substitution'])
if original in items:
index = next(i for (i, cst) in enumerate(items) if cst == original)
original = new_items[index]
else:
index = next(i for (i, cst) in enumerate(items) if cst == replacement)
replacement = new_items[index]
receiver.substitute(original, replacement)
receiver.restore_order()
return Response(
status=c.HTTP_200_OK,
data=s.RSFormParseSerializer(receiver.model).data
)