jumpserver/apps/terminal/serializers/applet.py
2025-07-25 10:49:47 +08:00

76 lines
2.8 KiB
Python

import os
from django.utils.translation import gettext_lazy as _, get_language
from rest_framework import serializers
from common.const.choices import Status
from common.serializers.fields import ObjectRelatedField, LabeledChoiceField
from common.utils.yml import yaml_load_with_i18n
from terminal.const import PublishStatus
from ..models import Applet, AppletPublication, AppletHost
__all__ = [
'AppletSerializer', 'AppletPublicationSerializer',
]
class AppletPublicationSerializer(serializers.ModelSerializer):
applet = ObjectRelatedField(attrs=('id', 'name', 'display_name', 'icon', 'version'), label=_("Applet"),
queryset=Applet.objects.all())
host = ObjectRelatedField(queryset=AppletHost.objects.all(), label=_("Host"))
status = LabeledChoiceField(choices=PublishStatus.choices, label=_("Status"), default=Status.pending)
class Meta:
model = AppletPublication
fields_mini = ['id', 'applet', 'host']
read_only_fields = ['date_created', 'date_updated']
fields = fields_mini + ['status', 'comment'] + read_only_fields
class AppletSerializer(serializers.ModelSerializer):
icon = serializers.ReadOnlyField(label=_("Icon"))
type = LabeledChoiceField(choices=Applet.Type.choices, label=_("Type"))
edition = LabeledChoiceField(
choices=Applet.Edition.choices, label=_("Edition"), required=False,
default=Applet.Edition.community
)
class Meta:
model = Applet
fields_mini = ['id', 'name', 'display_name', 'is_active']
read_only_fields = [
'icon', 'readme', 'date_created', 'date_updated',
]
fields = fields_mini + [
'version', 'author', 'type', 'edition',
'can_concurrent', 'protocols', 'tags', 'comment',
] + read_only_fields
@staticmethod
def read_manifest_with_i18n(obj, lang='zh'):
path = os.path.join(obj.path, 'manifest.yml')
if os.path.exists(path):
with open(path, encoding='utf8') as f:
manifest = yaml_load_with_i18n(f, lang)
else:
manifest = {}
return manifest
@staticmethod
def readme(obj, lang=''):
lang = lang[:2]
readme_file = os.path.join(obj.path, f'README_{lang.upper()}.md')
if os.path.isfile(readme_file):
with open(readme_file, 'r') as f:
return f.read()
return ''
def to_representation(self, instance):
data = super().to_representation(instance)
lang = get_language()
manifest = self.read_manifest_with_i18n(instance, lang)
data['display_name'] = manifest.get('display_name', instance.display_name)
data['comment'] = manifest.get('comment', instance.comment)
data['readme'] = self.readme(instance, lang)
return data