Repository navigation
Expand file tree
/
Copy pathserializers.py
More file actions
178 lines (129 loc) · 5.09 KB
/
Copy pathserializers.py
File metadata and controls
178 lines (129 loc) · 5.09 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
"""JSON serializers for plugin app."""
from django.core.exceptions import ValidationError
from django.utils.translation import gettext_lazy as _
from rest_framework import serializers
from common.serializers import GenericReferencedSettingSerializer
from plugin.models import NotificationUserSetting, PluginConfig, PluginSetting
class MetadataSerializer(serializers.ModelSerializer):
"""Serializer class for model metadata API access."""
metadata = serializers.JSONField(required=True)
class Meta:
"""Metaclass options."""
fields = [
'metadata',
]
def __init__(self, model_type, *args, **kwargs):
"""Initialize the metadata serializer with information on the model type"""
self.Meta.model = model_type
super().__init__(*args, **kwargs)
def update(self, instance, data):
"""Perform update on the metadata field:
- If this is a partial (PATCH) update, try to 'merge' data in
- Else, if it is a PUT update, overwrite any existing metadata
"""
if self.partial:
# Default behaviour is to "merge" new data in
metadata = instance.metadata.copy() if instance.metadata else {}
metadata.update(data['metadata'])
data['metadata'] = metadata
return super().update(instance, data)
class PluginConfigSerializer(serializers.ModelSerializer):
"""Serializer for a PluginConfig."""
class Meta:
"""Meta for serializer."""
model = PluginConfig
fields = [
'pk',
'key',
'name',
'active',
'meta',
'mixins',
'is_builtin',
'is_sample',
'is_installed',
]
read_only_fields = [
'key',
'is_builtin',
'is_sample',
'is_installed',
]
meta = serializers.DictField(read_only=True)
mixins = serializers.DictField(read_only=True)
class PluginConfigInstallSerializer(serializers.Serializer):
"""Serializer for installing a new plugin."""
class Meta:
"""Meta for serializer."""
fields = [
'url',
'packagename',
'confirm',
]
url = serializers.CharField(
required=False,
allow_blank=True,
label=_('Source URL'),
help_text=_('Source for the package - this can be a custom registry or a VCS path')
)
packagename = serializers.CharField(
required=False,
allow_blank=True,
label=_('Package Name'),
help_text=_('Name for the Plugin Package - can also contain a version indicator'),
)
confirm = serializers.BooleanField(
label=_('Confirm plugin installation'),
help_text=_('This will install this plugin now into the current instance. The instance will go into maintenance.')
)
def validate(self, data):
"""Validate inputs.
Make sure both confirm and url are provided.
"""
super().validate(data)
# check the base requirements are met
if not data.get('confirm'):
raise ValidationError({'confirm': _('Installation not confirmed')})
if (not data.get('url')) and (not data.get('packagename')):
msg = _('Either packagename of URL must be provided')
raise ValidationError({'url': msg, 'packagename': msg})
return data
def save(self):
"""Install a plugin from a package registry and set operational results as instance data."""
from plugin.installer import install_plugin
data = self.validated_data
packagename = data.get('packagename', '')
url = data.get('url', '')
return install_plugin(url=url, packagename=packagename)
class PluginConfigEmptySerializer(serializers.Serializer):
"""Serializer for a PluginConfig."""
...
class PluginActivateSerializer(serializers.Serializer):
"""Serializer for activating or deactivating a plugin"""
model = PluginConfig
active = serializers.BooleanField(
required=False, default=True,
label=_('Activate Plugin'),
help_text=_('Activate this plugin')
)
def update(self, instance, validated_data):
"""Apply the new 'active' value to the plugin instance"""
from InvenTree.tasks import check_for_migrations, offload_task
instance.active = validated_data.get('active', True)
instance.save()
if instance.active:
# A plugin has just been activated - check for database migrations
offload_task(check_for_migrations)
return instance
class PluginSettingSerializer(GenericReferencedSettingSerializer):
"""Serializer for the PluginSetting model."""
MODEL = PluginSetting
EXTRA_FIELDS = [
'plugin',
]
plugin = serializers.CharField(source='plugin.key', read_only=True)
class NotificationUserSettingSerializer(GenericReferencedSettingSerializer):
"""Serializer for the PluginSetting model."""
MODEL = NotificationUserSetting
EXTRA_FIELDS = ['method', ]
method = serializers.CharField(read_only=True)