''' Serializers for persistent data manipulation. ''' from typing import Optional, cast from django.contrib.auth.models import User from django.core.exceptions import PermissionDenied from django.db import transaction from rest_framework import serializers from rest_framework.serializers import PrimaryKeyRelatedField as PKField from shared import messages as msg from ..models import Constituenta, CstType, LibraryItem, RSForm, Version from .basics import CstParseSerializer from .io_pyconcept import PyConceptAdapter class LibraryItemBaseSerializer(serializers.ModelSerializer): ''' Serializer: LibraryItem entry full access. ''' class Meta: ''' serializer metadata. ''' model = LibraryItem fields = '__all__' read_only_fields = ('id',) class LibraryItemSerializer(serializers.ModelSerializer): ''' Serializer: LibraryItem entry limited access. ''' class Meta: ''' serializer metadata. ''' model = LibraryItem fields = '__all__' read_only_fields = ('id', 'item_type', 'owner', 'location', 'access_policy') class LibraryItemCloneSerializer(serializers.ModelSerializer): ''' Serializer: LibraryItem cloning. ''' items = PKField(many=True, required=False, queryset=Constituenta.objects.all()) class Meta: ''' serializer metadata. ''' model = LibraryItem exclude = ['id', 'item_type', 'owner'] class VersionSerializer(serializers.ModelSerializer): ''' Serializer: Version data. ''' class Meta: ''' serializer metadata. ''' model = Version fields = 'id', 'version', 'item', 'description', 'time_create' read_only_fields = ('id', 'item', 'time_create') class VersionInnerSerializer(serializers.ModelSerializer): ''' Serializer: Version data for list of versions. ''' class Meta: ''' serializer metadata. ''' model = Version fields = 'id', 'version', 'description', 'time_create' read_only_fields = ('id', 'item', 'time_create') class VersionCreateSerializer(serializers.ModelSerializer): ''' Serializer: Version create data. ''' class Meta: ''' serializer metadata. ''' model = Version fields = 'version', 'description' class LibraryItemDetailsSerializer(serializers.ModelSerializer): ''' Serializer: LibraryItem detailed data. ''' subscribers = serializers.SerializerMethodField() editors = serializers.SerializerMethodField() versions = serializers.SerializerMethodField() class Meta: ''' serializer metadata. ''' model = LibraryItem fields = '__all__' read_only_fields = ('owner', 'id', 'item_type') def get_subscribers(self, instance: LibraryItem) -> list[int]: return [item.pk for item in instance.subscribers()] def get_editors(self, instance: LibraryItem) -> list[int]: return [item.pk for item in instance.editors()] def get_versions(self, instance: LibraryItem) -> list: return [VersionInnerSerializer(item).data for item in instance.versions()] class CstBaseSerializer(serializers.ModelSerializer): ''' Serializer: Constituenta all data. ''' class Meta: ''' serializer metadata. ''' model = Constituenta fields = '__all__' read_only_fields = ('id',) class CstSerializer(serializers.ModelSerializer): ''' Serializer: Constituenta data. ''' class Meta: ''' serializer metadata. ''' model = Constituenta fields = '__all__' read_only_fields = ('id', 'order', 'alias', 'cst_type', 'definition_resolved', 'term_resolved') def update(self, instance: Constituenta, validated_data) -> Constituenta: data = validated_data # Note: use alias for better code readability definition: Optional[str] = data['definition_raw'] if 'definition_raw' in data else None term: Optional[str] = data['term_raw'] if 'term_raw' in data else None term_changed = 'term_forms' in data if definition is not None and definition != instance.definition_raw: data['definition_resolved'] = instance.schema.resolver().resolve(definition) if term is not None and term != instance.term_raw: data['term_resolved'] = instance.schema.resolver().resolve(term) if data['term_resolved'] != instance.term_resolved and 'term_forms' not in data: data['term_forms'] = [] term_changed = data['term_resolved'] != instance.term_resolved result: Constituenta = super().update(instance, data) if term_changed: instance.schema.on_term_change([result.id]) result.refresh_from_db() instance.schema.save() return result class CstDetailsSerializer(serializers.ModelSerializer): ''' Serializer: Constituenta data including parse. ''' parse = CstParseSerializer() class Meta: ''' serializer metadata. ''' model = Constituenta fields = '__all__' class CstCreateSerializer(serializers.ModelSerializer): ''' Serializer: Constituenta creation. ''' insert_after = serializers.IntegerField(required=False, allow_null=True) alias = serializers.CharField(max_length=8) cst_type = serializers.ChoiceField(CstType.choices) class Meta: ''' serializer metadata. ''' model = Constituenta fields = \ 'alias', 'cst_type', 'convention', \ 'term_raw', 'definition_raw', 'definition_formal', \ 'insert_after', 'term_forms' class RSFormSerializer(serializers.ModelSerializer): ''' Serializer: Detailed data for RSForm. ''' subscribers = serializers.ListField( child=serializers.IntegerField() ) editors = serializers.ListField( child=serializers.IntegerField() ) items = serializers.ListField( child=CstSerializer() ) class Meta: ''' serializer metadata. ''' model = LibraryItem fields = '__all__' def to_representation(self, instance: RSForm) -> dict: result = LibraryItemDetailsSerializer(instance).data result['items'] = [] for cst in instance.constituents().order_by('order'): result['items'].append(CstSerializer(cst).data) return result def to_versioned_data(self) -> dict: ''' Create serializable version representation without redundant data. ''' result = self.to_representation(cast(RSForm, self.instance)) del result['versions'] del result['subscribers'] del result['editors'] del result['owner'] del result['visible'] del result['read_only'] del result['access_policy'] del result['location'] del result['time_create'] del result['time_update'] return result def from_versioned_data(self, version: int, data: dict) -> dict: ''' Load data from version. ''' result = self.to_representation(cast(RSForm, self.instance)) result['version'] = version return result | data @transaction.atomic def restore_from_version(self, data: dict): ''' Load data from version. ''' schema = cast(RSForm, self.instance) items: list[dict] = data['items'] ids: list[int] = [item['id'] for item in items] processed: list[int] = [] for cst in schema.constituents(): if not cst.pk in ids: cst.delete() else: cst_data = next(x for x in items if x['id'] == cst.pk) new_cst = CstBaseSerializer(data=cst_data) new_cst.is_valid(raise_exception=True) new_cst.update( instance=cst, validated_data=new_cst.validated_data ) processed.append(cst.pk) for cst_data in items: if cst_data['id'] not in processed: cst = schema.insert_new(cst_data['alias']) cst_data['id'] = cst.pk new_cst = CstBaseSerializer(data=cst_data) new_cst.is_valid(raise_exception=True) new_cst.update( instance=cst, validated_data=new_cst.validated_data ) loaded_item = LibraryItemBaseSerializer(data=data) loaded_item.is_valid(raise_exception=True) loaded_item.update( instance=cast(LibraryItem, self.instance), validated_data=loaded_item.validated_data ) class RSFormParseSerializer(serializers.ModelSerializer): ''' Serializer: Detailed data for RSForm including parse. ''' subscribers = serializers.ListField( child=serializers.IntegerField() ) editors = serializers.ListField( child=serializers.IntegerField() ) items = serializers.ListField( child=CstDetailsSerializer() ) class Meta: ''' serializer metadata. ''' model = LibraryItem fields = '__all__' def to_representation(self, instance: RSForm): result = RSFormSerializer(instance).data return self._parse_data(result) def from_versioned_data(self, version: int, data: dict) -> dict: ''' Load data from version and parse. ''' item = cast(RSForm, self.instance) result = RSFormSerializer(item).from_versioned_data(version, data) return self._parse_data(result) def _parse_data(self, data: dict) -> dict: parse = PyConceptAdapter(data).parse() for cst_data in data['items']: cst_data['parse'] = next( cst['parse'] for cst in parse['items'] if cst['id'] == cst_data['id'] ) return data class CstTargetSerializer(serializers.Serializer): ''' Serializer: Target single Constituenta. ''' target = PKField(many=False, queryset=Constituenta.objects.all()) def validate(self, attrs): schema = cast(RSForm, self.context['schema']) cst = cast(Constituenta, attrs['target']) if schema and cst.schema != schema: raise serializers.ValidationError({ f'{cst.id}': msg.constituentaNotOwned(schema.title) }) if cst.cst_type not in [CstType.FUNCTION, CstType.STRUCTURED, CstType.TERM]: raise serializers.ValidationError({ f'{cst.id}': msg.constituentaNoStructure() }) self.instance = cst return attrs class UserTargetSerializer(serializers.Serializer): ''' Serializer: Target single User. ''' user = PKField(many=False, queryset=User.objects.all()) class UsersListSerializer(serializers.Serializer): ''' Serializer: List of Users. ''' users = PKField(many=True, queryset=User.objects.all()) class CstRenameSerializer(serializers.Serializer): ''' Serializer: Constituenta renaming. ''' target = PKField(many=False, queryset=Constituenta.objects.all()) alias = serializers.CharField() cst_type = serializers.CharField() def validate(self, attrs): attrs = super().validate(attrs) schema = cast(RSForm, self.context['schema']) cst = cast(Constituenta, attrs['target']) if cst.schema != schema: raise serializers.ValidationError({ f'{cst.id}': msg.constituentaNotOwned(schema.title) }) new_alias = self.initial_data['alias'] if cst.alias == new_alias: raise serializers.ValidationError({ 'alias': msg.renameTrivial(new_alias) }) if schema.constituents().filter(alias=new_alias).exists(): raise serializers.ValidationError({ 'alias': msg.aliasTaken(new_alias) }) return attrs class CstListSerializer(serializers.Serializer): ''' Serializer: List of constituents from one origin. ''' items = PKField(many=True, queryset=Constituenta.objects.all()) def validate(self, attrs): schema = cast(RSForm, self.context['schema']) if not schema: return attrs for item in attrs['items']: if item.schema != schema: raise serializers.ValidationError({ f'{item.id}': msg.constituentaNotOwned(schema.title) }) return attrs class CstMoveSerializer(CstListSerializer): ''' Serializer: Change constituenta position. ''' move_to = serializers.IntegerField() class CstSubstituteSerializerBase(serializers.Serializer): ''' Serializer: Basic substitution. ''' original = PKField(many=False, queryset=Constituenta.objects.all()) substitution = PKField(many=False, queryset=Constituenta.objects.all()) transfer_term = serializers.BooleanField(required=False, default=False) class CstSubstituteSerializer(serializers.Serializer): ''' Serializer: Constituenta substitution. ''' substitutions = serializers.ListField( child=CstSubstituteSerializerBase(), min_length=1 ) def validate(self, attrs): schema = cast(RSForm, self.context['schema']) deleted = set() for item in attrs['substitutions']: original_cst = cast(Constituenta, item['original']) substitution_cst = cast(Constituenta, item['substitution']) if original_cst.pk in deleted: raise serializers.ValidationError({ f'{original_cst.id}': msg.substituteDouble(original_cst.alias) }) if original_cst.alias == substitution_cst.alias: raise serializers.ValidationError({ 'alias': msg.substituteTrivial(original_cst.alias) }) if original_cst.schema != schema: raise serializers.ValidationError({ 'original': msg.constituentaNotOwned(schema.title) }) if substitution_cst.schema != schema: raise serializers.ValidationError({ 'substitution': msg.constituentaNotOwned(schema.title) }) deleted.add(original_cst.pk) return attrs class InlineSynthesisSerializer(serializers.Serializer): ''' Serializer: Inline synthesis operation input. ''' receiver = PKField(many=False, queryset=RSForm.objects.all()) source = PKField(many=False, queryset=RSForm.objects.all()) # type: ignore items = PKField(many=True, queryset=Constituenta.objects.all()) substitutions = serializers.ListField( child=CstSubstituteSerializerBase() ) def validate(self, attrs): user = cast(User, self.context['user']) schema_in = cast(RSForm, attrs['source']) schema_out = cast(RSForm, attrs['receiver']) if user.is_anonymous or (schema_out.owner != user and not user.is_staff): raise PermissionDenied({ 'message': msg.schemaNotOwned(), 'object_id': schema_in.id }) constituents = cast(list[Constituenta], attrs['items']) for cst in constituents: if cst.schema != schema_in: raise serializers.ValidationError({ f'{cst.id}': msg.constituentaNotOwned(schema_in.title) }) deleted = set() for item in attrs['substitutions']: original_cst = cast(Constituenta, item['original']) substitution_cst = cast(Constituenta, item['substitution']) if original_cst.schema == schema_in: if original_cst not in constituents: raise serializers.ValidationError({ f'{original_cst.id}': msg.substitutionNotInList() }) if substitution_cst.schema != schema_out: raise serializers.ValidationError({ f'{substitution_cst.id}': msg.constituentaNotOwned(schema_out.title) }) else: if substitution_cst not in constituents: raise serializers.ValidationError({ f'{substitution_cst.id}': msg.substitutionNotInList() }) if original_cst.schema != schema_out: raise serializers.ValidationError({ f'{original_cst.id}': msg.constituentaNotOwned(schema_out.title) }) if original_cst.pk in deleted: raise serializers.ValidationError({ f'{original_cst.id}': msg.substituteDouble(original_cst.alias) }) deleted.add(original_cst.pk) return attrs