serializers.py 27.1 KB
Newer Older
Maël Kervella's avatar
Maël Kervella committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
# Re2o est un logiciel d'administration développé initiallement au rezometz. Il
# se veut agnostique au réseau considéré, de manière à être installable en
# quelques clics.
#
# Copyright © 2018 Mael Kervella
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

Maël Kervella's avatar
Maël Kervella committed
21
"""
Maël Kervella's avatar
Maël Kervella committed
22 23
Serializers for the API app
"""
Maël Kervella's avatar
Maël Kervella committed
24 25

from rest_framework import serializers
26

Maël Kervella's avatar
Maël Kervella committed
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
import cotisations.models as cotisations
import machines.models as machines
import preferences.models as preferences
import topologie.models as topologie
import users.models as users


API_NAMESPACE = 'api'


class NamespacedHRField(serializers.HyperlinkedRelatedField):
    """ A HyperlinkedRelatedField subclass to automatically prefix
    view names with a namespace """
    def __init__(self, view_name=None, **kwargs):
        if view_name is not None:
            view_name = '%s:%s' % (API_NAMESPACE, view_name)
        super(NamespacedHRField, self).__init__(view_name=view_name, **kwargs)


class NamespacedHIField(serializers.HyperlinkedIdentityField):
    """ A HyperlinkedIdentityField subclass to automatically prefix
    view names with a namespace """
    def __init__(self, view_name=None, **kwargs):
        if view_name is not None:
            view_name = '%s:%s' % (API_NAMESPACE, view_name)
        super(NamespacedHIField, self).__init__(view_name=view_name, **kwargs)


class NamespacedHMSerializer(serializers.HyperlinkedModelSerializer):
    """ A HyperlinkedModelSerializer subclass to use `NamespacedHRField` as
    field and automatically prefix view names with a namespace """
    serializer_related_field = NamespacedHRField
    serializer_url_field = NamespacedHIField
Maël Kervella's avatar
Maël Kervella committed
60

Maël Kervella's avatar
Maël Kervella committed
61 62

# COTISATIONS APP
63

Maël Kervella's avatar
Maël Kervella committed
64 65

class FactureSerializer(NamespacedHMSerializer):
66
    class Meta:
Maël Kervella's avatar
Maël Kervella committed
67
        model = cotisations.Facture
68 69 70 71
        fields = ('user', 'paiement', 'banque', 'cheque', 'date', 'valid',
                  'control', 'prix_total', 'name', 'api_url')


Maël Kervella's avatar
Maël Kervella committed
72
class VenteSerializer(NamespacedHMSerializer):
73
    class Meta:
Maël Kervella's avatar
Maël Kervella committed
74
        model = cotisations.Vente
75 76 77 78
        fields = ('facture', 'number', 'name', 'prix', 'duration',
                  'type_cotisation', 'prix_total', 'api_url')


Maël Kervella's avatar
Maël Kervella committed
79
class ArticleSerializer(NamespacedHMSerializer):
80
    class Meta:
Maël Kervella's avatar
Maël Kervella committed
81
        model = cotisations.Article
82 83 84 85
        fields = ('name', 'prix', 'duration', 'type_user',
                  'type_cotisation', 'api_url')


Maël Kervella's avatar
Maël Kervella committed
86
class BanqueSerializer(NamespacedHMSerializer):
87
    class Meta:
Maël Kervella's avatar
Maël Kervella committed
88
        model = cotisations.Banque
89 90 91
        fields = ('name', 'api_url')


Maël Kervella's avatar
Maël Kervella committed
92
class PaiementSerializer(NamespacedHMSerializer):
93
    class Meta:
Maël Kervella's avatar
Maël Kervella committed
94
        model = cotisations.Paiement
95 96 97
        fields = ('moyen', 'type_paiement', 'api_url')


Maël Kervella's avatar
Maël Kervella committed
98
class CotisationSerializer(NamespacedHMSerializer):
99
    class Meta:
Maël Kervella's avatar
Maël Kervella committed
100
        model = cotisations.Cotisation
101 102 103 104
        fields = ('vente', 'type_cotisation', 'date_start', 'date_end',
                  'api_url')


Maël Kervella's avatar
Maël Kervella committed
105 106 107
# MACHINES APP


Maël Kervella's avatar
Maël Kervella committed
108
class MachineSerializer(NamespacedHMSerializer):
Maël Kervella's avatar
Maël Kervella committed
109
    class Meta:
Maël Kervella's avatar
Maël Kervella committed
110
        model = machines.Machine
Maël Kervella's avatar
Maël Kervella committed
111 112 113
        fields = ('user', 'name', 'active', 'api_url')


Maël Kervella's avatar
Maël Kervella committed
114
class MachineTypeSerializer(NamespacedHMSerializer):
Maël Kervella's avatar
Maël Kervella committed
115
    class Meta:
Maël Kervella's avatar
Maël Kervella committed
116
        model = machines.MachineType
Maël Kervella's avatar
Maël Kervella committed
117 118 119
        fields = ('type', 'ip_type', 'api_url')


Maël Kervella's avatar
Maël Kervella committed
120
class IpTypeSerializer(NamespacedHMSerializer):
Maël Kervella's avatar
Maël Kervella committed
121
    class Meta:
Maël Kervella's avatar
Maël Kervella committed
122
        model = machines.IpType
Maël Kervella's avatar
Maël Kervella committed
123 124 125 126 127
        fields = ('type', 'extension', 'need_infra', 'domaine_ip_start',
                  'domaine_ip_stop', 'prefix_v6', 'vlan', 'ouverture_ports',
                  'api_url')


Maël Kervella's avatar
Maël Kervella committed
128
class VlanSerializer(NamespacedHMSerializer):
Maël Kervella's avatar
Maël Kervella committed
129
    class Meta:
Maël Kervella's avatar
Maël Kervella committed
130
        model = machines.Vlan
Maël Kervella's avatar
Maël Kervella committed
131 132 133
        fields = ('vlan_id', 'name', 'comment', 'api_url')


Maël Kervella's avatar
Maël Kervella committed
134
class NasSerializer(NamespacedHMSerializer):
Maël Kervella's avatar
Maël Kervella committed
135
    class Meta:
Maël Kervella's avatar
Maël Kervella committed
136
        model = machines.Nas
Maël Kervella's avatar
Maël Kervella committed
137 138 139 140
        fields = ('name', 'nas_type', 'machine_type', 'port_access_mode',
                  'autocapture_mac', 'api_url')


Maël Kervella's avatar
Maël Kervella committed
141
class SOASerializer(NamespacedHMSerializer):
Maël Kervella's avatar
Maël Kervella committed
142
    class Meta:
Maël Kervella's avatar
Maël Kervella committed
143
        model = machines.SOA
Maël Kervella's avatar
Maël Kervella committed
144 145 146 147
        fields = ('name', 'mail', 'refresh', 'retry', 'expire', 'ttl',
                  'api_url')


Maël Kervella's avatar
Maël Kervella committed
148
class ExtensionSerializer(NamespacedHMSerializer):
Maël Kervella's avatar
Maël Kervella committed
149
    class Meta:
Maël Kervella's avatar
Maël Kervella committed
150
        model = machines.Extension
Maël Kervella's avatar
Maël Kervella committed
151 152 153 154
        fields = ('name', 'need_infra', 'origin', 'origin_v6', 'soa',
                  'api_url')


Maël Kervella's avatar
Maël Kervella committed
155
class MxSerializer(NamespacedHMSerializer):
Maël Kervella's avatar
Maël Kervella committed
156
    class Meta:
Maël Kervella's avatar
Maël Kervella committed
157
        model = machines.Mx
Maël Kervella's avatar
Maël Kervella committed
158 159 160
        fields = ('zone', 'priority', 'name', 'api_url')


Maël Kervella's avatar
Maël Kervella committed
161
class NsSerializer(NamespacedHMSerializer):
Maël Kervella's avatar
Maël Kervella committed
162
    class Meta:
Maël Kervella's avatar
Maël Kervella committed
163
        model = machines.Ns
Maël Kervella's avatar
Maël Kervella committed
164 165 166
        fields = ('zone', 'ns', 'api_url')


Maël Kervella's avatar
Maël Kervella committed
167
class TxtSerializer(NamespacedHMSerializer):
Maël Kervella's avatar
Maël Kervella committed
168
    class Meta:
Maël Kervella's avatar
Maël Kervella committed
169
        model = machines.Txt
Maël Kervella's avatar
Maël Kervella committed
170 171 172
        fields = ('zone', 'field1', 'field2', 'api_url')


Maël Kervella's avatar
Maël Kervella committed
173
class SrvSerializer(NamespacedHMSerializer):
Maël Kervella's avatar
Maël Kervella committed
174
    class Meta:
Maël Kervella's avatar
Maël Kervella committed
175
        model = machines.Srv
Maël Kervella's avatar
Maël Kervella committed
176 177 178 179
        fields = ('service', 'protocole', 'extension', 'ttl', 'priority',
                  'weight', 'port', 'target', 'api_url')


Maël Kervella's avatar
Maël Kervella committed
180
class InterfaceSerializer(NamespacedHMSerializer):
Maël Kervella's avatar
Maël Kervella committed
181 182 183
    active = serializers.BooleanField(source='is_active')

    class Meta:
Maël Kervella's avatar
Maël Kervella committed
184
        model = machines.Interface
Maël Kervella's avatar
Maël Kervella committed
185 186 187 188
        fields = ('ipv4', 'mac_address', 'machine', 'type', 'details',
                  'port_lists', 'active', 'api_url')


Maël Kervella's avatar
Maël Kervella committed
189
class Ipv6ListSerializer(NamespacedHMSerializer):
Maël Kervella's avatar
Maël Kervella committed
190
    class Meta:
Maël Kervella's avatar
Maël Kervella committed
191
        model = machines.Ipv6List
Maël Kervella's avatar
Maël Kervella committed
192 193 194 195
        fields = ('ipv6', 'interface', 'slaac_ip', 'date_end',
                  'api_url')


Maël Kervella's avatar
Maël Kervella committed
196
class DomainSerializer(NamespacedHMSerializer):
Maël Kervella's avatar
Maël Kervella committed
197
    class Meta:
Maël Kervella's avatar
Maël Kervella committed
198
        model = machines.Domain
Maël Kervella's avatar
Maël Kervella committed
199 200 201 202
        fields = ('interface_parent', 'name', 'extension', 'cname',
                  'api_url')


Maël Kervella's avatar
Maël Kervella committed
203
class IpListSerializer(NamespacedHMSerializer):
Maël Kervella's avatar
Maël Kervella committed
204
    class Meta:
Maël Kervella's avatar
Maël Kervella committed
205
        model = machines.IpList
Maël Kervella's avatar
Maël Kervella committed
206 207 208
        fields = ('ipv4', 'ip_type', 'need_infra', 'api_url')


Maël Kervella's avatar
Maël Kervella committed
209
class ServiceSerializer(NamespacedHMSerializer):
Maël Kervella's avatar
Maël Kervella committed
210
    class Meta:
Maël Kervella's avatar
Maël Kervella committed
211
        model = machines.Service
Maël Kervella's avatar
Maël Kervella committed
212 213 214 215
        fields = ('service_type', 'min_time_regen', 'regular_time_regen',
                  'servers', 'api_url')


Maël Kervella's avatar
Maël Kervella committed
216
class ServiceLinkSerializer(NamespacedHMSerializer):
Maël Kervella's avatar
Maël Kervella committed
217
    class Meta:
Maël Kervella's avatar
Maël Kervella committed
218
        model = machines.Service_link
Maël Kervella's avatar
Maël Kervella committed
219 220 221 222
        fields = ('service', 'server', 'last_regen', 'asked_regen',
                  'need_regen', 'api_url')


Maël Kervella's avatar
Maël Kervella committed
223
class OuverturePortListSerializer(NamespacedHMSerializer):
Maël Kervella's avatar
Maël Kervella committed
224
    class Meta:
Maël Kervella's avatar
Maël Kervella committed
225
        model = machines.OuverturePortList
Maël Kervella's avatar
Maël Kervella committed
226 227 228 229
        fields = ('name', 'tcp_ports_in', 'udp_ports_in', 'tcp_ports_out',
                  'udp_ports_out', 'api_url')


Maël Kervella's avatar
Maël Kervella committed
230
class OuverturePortSerializer(NamespacedHMSerializer):
Maël Kervella's avatar
Maël Kervella committed
231
    class Meta:
Maël Kervella's avatar
Maël Kervella committed
232
        model = machines.OuverturePort
Maël Kervella's avatar
Maël Kervella committed
233 234 235
        fields = ('begin', 'end', 'port_list', 'protocole', 'io', 'api_url')


236 237 238
# PREFERENCES APP


Maël Kervella's avatar
Maël Kervella committed
239
# class OptionalUserSerializer(NamespacedHMSerializer):
240 241 242
#     tel_mandatory = serializers.BooleanField(source='is_tel_mandatory')
# 
#     class Meta:
Maël Kervella's avatar
Maël Kervella committed
243
#         model = preferences.OptionalUser
244 245 246 247 248 249
#         fields = ('tel_mandatory', 'user_solde', 'solde_negatif', 'max_solde',
#                   'min_online_payement', 'gpg_fingerprint',
#                   'all_can_create_club', 'self_adhesion', 'shell_default',
#                   'api_url')
# 
# 
Maël Kervella's avatar
Maël Kervella committed
250
# class OptionalMachineSerializer(NamespacedHMSerializer):
251
#     class Meta:
Maël Kervella's avatar
Maël Kervella committed
252
#         model = preferences.OptionalMachine
253 254 255 256 257
#         fields = ('password_machine', 'max_lambdauser_interfaces',
#                   'max_lambdauser_aliases', 'ipv6_mode', 'create_machine',
#                   'ipv6', 'api_url')
# 
# 
Maël Kervella's avatar
Maël Kervella committed
258
# class OptionalTopologieSerializer(NamespacedHMSerializer):
259
#     class Meta:
Maël Kervella's avatar
Maël Kervella committed
260
#         model = preferences.OptionalTopologie
261 262 263 264
#         fields = ('radius_general_policy', 'vlan_decision_ok',
#                   'vlan_decision_no', 'api_url')
# 
# 
Maël Kervella's avatar
Maël Kervella committed
265
# class GeneralOptionSerializer(NamespacedHMSerializer):
266
#     class Meta:
Maël Kervella's avatar
Maël Kervella committed
267
#         model = preferences.GeneralOption
268 269 270 271 272 273
#         fields = ('general_message', 'search_display_page',
#                   'pagination_number', 'pagination_large_number',
#                   'req_expire_hrs', 'site_name', 'email_from', 'GTU_sum_up',
#                   'GTU', 'api_url')
# 
# 
Maël Kervella's avatar
Maël Kervella committed
274
# class ServiceOptionSerializer(NamespacedHMSerializer):
275
#     class Meta:
Maël Kervella's avatar
Maël Kervella committed
276
#         model = preferences.ServiceOption
277 278 279
#         fields = ('name', 'url', 'description', 'image', 'api_url')
# 
# 
Maël Kervella's avatar
Maël Kervella committed
280
# class AssoOptionSerializer(NamespacedHMSerializer):
281
#     class Meta:
Maël Kervella's avatar
Maël Kervella committed
282
#         model = preferences.AssoOption
283 284 285 286 287
#         fields = ('name', 'siret', 'adresse1', 'adresse2', 'contact',
#                   'telephone', 'pseudo', 'utilisateur_asso', 'payement',
#                   'payement_id', 'payement_pass', 'description', 'api_url')
# 
# 
Maël Kervella's avatar
Maël Kervella committed
288
# class HomeOptionSerializer(NamespacedHMSerializer):
289
#     class Meta:
Maël Kervella's avatar
Maël Kervella committed
290
#         model = preferences.HomeOption
291 292 293 294
#         fields = ('facebook_url', 'twitter_url', 'twitter_account_name',
#                   'api_url')
# 
# 
Maël Kervella's avatar
Maël Kervella committed
295
# class MailMessageOptionSerializer(NamespacedHMSerializer):
296
#     class Meta:
Maël Kervella's avatar
Maël Kervella committed
297
#         model = preferences.MailMessageOption
298 299 300
#         fields = ('welcome_mail_fr', 'welcome_mail_en', 'api_url')


Maël Kervella's avatar
Maël Kervella committed
301 302 303 304

# TOPOLOGIE APP


Maël Kervella's avatar
Maël Kervella committed
305
class StackSerializer(NamespacedHMSerializer):
Maël Kervella's avatar
Maël Kervella committed
306
    class Meta:
Maël Kervella's avatar
Maël Kervella committed
307
        model = topologie.Stack
Maël Kervella's avatar
Maël Kervella committed
308 309 310 311
        fields = ('name', 'stack_id', 'details', 'member_id_min',
                  'member_id_max', 'api_url')


Maël Kervella's avatar
Maël Kervella committed
312
class AccessPointSerializer(NamespacedHMSerializer):
Maël Kervella's avatar
Maël Kervella committed
313
    class Meta:
Maël Kervella's avatar
Maël Kervella committed
314
        model = topologie.AccessPoint
Maël Kervella's avatar
Maël Kervella committed
315 316 317
        fields = ('user', 'name', 'active', 'location', 'api_url')


Maël Kervella's avatar
Maël Kervella committed
318
class SwitchSerializer(NamespacedHMSerializer):
Maël Kervella's avatar
Maël Kervella committed
319 320
    port_amount = serializers.IntegerField(source='number')
    class Meta:
Maël Kervella's avatar
Maël Kervella committed
321
        model = topologie.Switch
Maël Kervella's avatar
Maël Kervella committed
322 323 324 325
        fields = ('port_amount', 'stack', 'stack_member_id', 'model',
                  'switchbay', 'api_url')


Maël Kervella's avatar
Maël Kervella committed
326
class ModelSwitchSerializer(NamespacedHMSerializer):
Maël Kervella's avatar
Maël Kervella committed
327
    class Meta:
Maël Kervella's avatar
Maël Kervella committed
328
        model = topologie.ModelSwitch
Maël Kervella's avatar
Maël Kervella committed
329 330 331
        fields = ('reference', 'constructor', 'api_url')


Maël Kervella's avatar
Maël Kervella committed
332
class ConstructorSwitchSerializer(NamespacedHMSerializer):
Maël Kervella's avatar
Maël Kervella committed
333
    class Meta:
Maël Kervella's avatar
Maël Kervella committed
334
        model = topologie.ConstructorSwitch
Maël Kervella's avatar
Maël Kervella committed
335 336 337
        fields = ('name', 'api_url')


Maël Kervella's avatar
Maël Kervella committed
338
class SwitchBaySerializer(NamespacedHMSerializer):
Maël Kervella's avatar
Maël Kervella committed
339
    class Meta:
Maël Kervella's avatar
Maël Kervella committed
340
        model = topologie.SwitchBay
Maël Kervella's avatar
Maël Kervella committed
341 342 343
        fields = ('name', 'building', 'info', 'api_url')


Maël Kervella's avatar
Maël Kervella committed
344
class BuildingSerializer(NamespacedHMSerializer):
Maël Kervella's avatar
Maël Kervella committed
345
    class Meta:
Maël Kervella's avatar
Maël Kervella committed
346
        model = topologie.Building
Maël Kervella's avatar
Maël Kervella committed
347 348 349
        fields = ('name', 'api_url')


Maël Kervella's avatar
Maël Kervella committed
350
class SwitchPortSerializer(NamespacedHMSerializer):
Maël Kervella's avatar
Maël Kervella committed
351
    class Meta:
Maël Kervella's avatar
Maël Kervella committed
352
        model = topologie.Port
Maël Kervella's avatar
Maël Kervella committed
353 354 355 356
        fields = ('switch', 'port', 'room', 'machine_interface', 'related',
                  'radius', 'vlan_force', 'details', 'api_url')


Maël Kervella's avatar
Maël Kervella committed
357
class RoomSerializer(NamespacedHMSerializer):
Maël Kervella's avatar
Maël Kervella committed
358
    class Meta:
Maël Kervella's avatar
Maël Kervella committed
359
        model = topologie.Room
Maël Kervella's avatar
Maël Kervella committed
360 361 362
        fields = ('name', 'details', 'api_url')


Maël Kervella's avatar
Maël Kervella committed
363
# USERS APP
364

Maël Kervella's avatar
Maël Kervella committed
365

Maël Kervella's avatar
Maël Kervella committed
366
class UserSerializer(NamespacedHMSerializer):
Maël Kervella's avatar
Maël Kervella committed
367 368
    access = serializers.BooleanField(source='has_access')
    uid = serializers.IntegerField(source='uid_number')
Maël Kervella's avatar
Maël Kervella committed
369 370

    class Meta:
Maël Kervella's avatar
Maël Kervella committed
371
        model = users.User
Maël Kervella's avatar
Maël Kervella committed
372 373 374
        fields = ('name', 'pseudo', 'email', 'school', 'shell', 'comment',
                  'state', 'registered', 'telephone', 'solde', #'room',
                  'access', 'end_access', 'uid', 'class_name', 'api_url')
Maël Kervella's avatar
Maël Kervella committed
375

Maël Kervella's avatar
Maël Kervella committed
376

Maël Kervella's avatar
Maël Kervella committed
377
class ClubSerializer(NamespacedHMSerializer):
Maël Kervella's avatar
Maël Kervella committed
378 379 380
    name = serializers.CharField(source='surname')
    access = serializers.BooleanField(source='has_access')
    uid = serializers.IntegerField(source='uid_number')
Maël Kervella's avatar
Maël Kervella committed
381 382

    class Meta:
Maël Kervella's avatar
Maël Kervella committed
383
        model = users.Club
Maël Kervella's avatar
Maël Kervella committed
384 385 386 387
        fields = ('name', 'pseudo', 'email', 'school', 'shell', 'comment',
                  'state', 'registered', 'telephone', 'solde', #'room',
                  'access', 'end_access', 'administrators', 'members',
                  'mailing', 'uid', 'api_url')
Maël Kervella's avatar
Maël Kervella committed
388 389


Maël Kervella's avatar
Maël Kervella committed
390
class AdherentSerializer(NamespacedHMSerializer):
Maël Kervella's avatar
Maël Kervella committed
391 392
    access = serializers.BooleanField(source='has_access')
    uid = serializers.IntegerField(source='uid_number')
Maël Kervella's avatar
Maël Kervella committed
393

Maël Kervella's avatar
Maël Kervella committed
394
    class Meta:
Maël Kervella's avatar
Maël Kervella committed
395
        model = users.Adherent
Maël Kervella's avatar
Maël Kervella committed
396 397 398
        fields = ('name', 'surname', 'pseudo', 'email', 'school', 'shell',
                  'comment', 'state', 'registered', 'telephone', #'room',
                  'solde', 'access', 'end_access', 'uid', 'api_url')
Maël Kervella's avatar
Maël Kervella committed
399 400


Maël Kervella's avatar
Maël Kervella committed
401
class ServiceUserSerializer(NamespacedHMSerializer):
Maël Kervella's avatar
Maël Kervella committed
402
    class Meta:
Maël Kervella's avatar
Maël Kervella committed
403
        model = users.ServiceUser
Maël Kervella's avatar
Maël Kervella committed
404
        fields = ('pseudo', 'access_group', 'comment', 'api_url')
Maël Kervella's avatar
Maël Kervella committed
405 406


Maël Kervella's avatar
Maël Kervella committed
407
class SchoolSerializer(NamespacedHMSerializer):
Maël Kervella's avatar
Maël Kervella committed
408
    class Meta:
Maël Kervella's avatar
Maël Kervella committed
409
        model = users.School
Maël Kervella's avatar
Maël Kervella committed
410
        fields = ('name', 'api_url')
Maël Kervella's avatar
Maël Kervella committed
411 412


Maël Kervella's avatar
Maël Kervella committed
413
class ListRightSerializer(NamespacedHMSerializer):
Maël Kervella's avatar
Maël Kervella committed
414
    class Meta:
Maël Kervella's avatar
Maël Kervella committed
415
        model = users.ListRight
Maël Kervella's avatar
Maël Kervella committed
416
        fields = ('unix_name', 'gid', 'critical', 'details', 'api_url')
Maël Kervella's avatar
Maël Kervella committed
417 418


Maël Kervella's avatar
Maël Kervella committed
419
class ShellSerializer(NamespacedHMSerializer):
Maël Kervella's avatar
Maël Kervella committed
420
    class Meta:
Maël Kervella's avatar
Maël Kervella committed
421
        model = users.ListShell
Maël Kervella's avatar
Maël Kervella committed
422
        fields = ('shell', 'api_url')
Maël Kervella's avatar
Maël Kervella committed
423 424


Maël Kervella's avatar
Maël Kervella committed
425
class BanSerializer(NamespacedHMSerializer):
Maël Kervella's avatar
Maël Kervella committed
426
    active = serializers.BooleanField(source='is_active')
Maël Kervella's avatar
Maël Kervella committed
427 428

    class Meta:
Maël Kervella's avatar
Maël Kervella committed
429
        model = users.Ban
Maël Kervella's avatar
Maël Kervella committed
430 431
        fields = ('user', 'raison', 'date_start', 'date_end', 'state',
                  'active', 'api_url')
Maël Kervella's avatar
Maël Kervella committed
432 433


Maël Kervella's avatar
Maël Kervella committed
434
class WhitelistSerializer(NamespacedHMSerializer):
Maël Kervella's avatar
Maël Kervella committed
435
    active = serializers.BooleanField(source='is_active')
Maël Kervella's avatar
Maël Kervella committed
436 437

    class Meta:
Maël Kervella's avatar
Maël Kervella committed
438
        model = users.Whitelist
Maël Kervella's avatar
Maël Kervella committed
439
        fields = ('user', 'raison', 'date_start', 'date_end', 'active', 'api_url')
Maël Kervella's avatar
Maël Kervella committed
440

Maël Kervella's avatar
Maël Kervella committed
441 442


Maël Kervella's avatar
Maël Kervella committed
443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846
# class ServiceLinkSerializer(serializers.ModelSerializer):
#     """ Serializer for the ServiceLink objects """
# 
#     name = serializers.CharField(source='service.service_type')
# 
#     class Meta:
#         model = Service_link
#         fields = ('name',)
# 
# 
# class MailingSerializer(serializers.ModelSerializer):
#     """ Serializer to build Mailing objects """
# 
#     name = serializers.CharField(source='pseudo')
# 
#     class Meta:
#         model = Club
#         fields = ('name',)
# 
# 
# class MailingMemberSerializer(serializers.ModelSerializer):
#     """ Serializer fot the Adherent objects (who belong to a
#     Mailing) """
# 
#     class Meta:
#         model = Adherent
#         fields = ('email',)
# 
# 
# class IpTypeField(serializers.RelatedField):
#     """ Serializer for an IpType object field """
# 
#     def to_representation(self, value):
#         return value.type
# 
#     def to_internal_value(self, data):
#         pass
# 
# 
# class IpListSerializer(serializers.ModelSerializer):
#     """ Serializer for an Ipv4List obejct using the IpType serialization """
# 
#     ip_type = IpTypeField(read_only=True)
# 
#     class Meta:
#         model = IpList
#         fields = ('ipv4', 'ip_type')
# 
# 
# class Ipv6ListSerializer(serializers.ModelSerializer):
#     """ Serializer for an Ipv6List object """
# 
#     class Meta:
#         model = Ipv6List
#         fields = ('ipv6', 'slaac_ip')
# 
# 
# class InterfaceSerializer(serializers.ModelSerializer):
#     """ Serializer for an Interface object. Use SerializerMethodField
#     to get ForeignKey values """
# 
#     ipv4 = IpListSerializer(read_only=True)
#     # TODO : use serializer.RelatedField to avoid duplicate code
#     mac_address = serializers.SerializerMethodField('get_macaddress')
#     domain = serializers.SerializerMethodField('get_dns')
#     extension = serializers.SerializerMethodField('get_interface_extension')
# 
#     class Meta:
#         model = Interface
#         fields = ('ipv4', 'mac_address', 'domain', 'extension')
# 
#     @staticmethod
#     def get_dns(obj):
#         """ The name of the associated  DNS object """
#         return obj.domain.name
# 
#     @staticmethod
#     def get_interface_extension(obj):
#         """ The name of the associated Interface object """
#         return obj.domain.extension.name
# 
#     @staticmethod
#     def get_macaddress(obj):
#         """ The string representation of the associated MAC address """
#         return str(obj.mac_address)
# 
# 
# class FullInterfaceSerializer(serializers.ModelSerializer):
#     """ Serializer for an Interface obejct. Use SerializerMethodField
#     to get ForeignKey values """
# 
#     ipv4 = IpListSerializer(read_only=True)
#     ipv6 = Ipv6ListSerializer(read_only=True, many=True)
#     # TODO : use serializer.RelatedField to avoid duplicate code
#     mac_address = serializers.SerializerMethodField('get_macaddress')
#     domain = serializers.SerializerMethodField('get_dns')
#     extension = serializers.SerializerMethodField('get_interface_extension')
# 
#     class Meta:
#         model = Interface
#         fields = ('ipv4', 'ipv6', 'mac_address', 'domain', 'extension')
# 
#     @staticmethod
#     def get_dns(obj):
#         """ The name of the associated DNS object """
#         return obj.domain.name
# 
#     @staticmethod
#     def get_interface_extension(obj):
#         """ The name of the associated Extension object """
#         return obj.domain.extension.name
# 
#     @staticmethod
#     def get_macaddress(obj):
#         """ The string representation of the associated MAC address """
#         return str(obj.mac_address)
# 
# 
# class ExtensionNameField(serializers.RelatedField):
#     """ Serializer for Extension object field """
# 
#     def to_representation(self, value):
#         return value.name
# 
#     def to_internal_value(self, data):
#         pass
# 
# 
# class TypeSerializer(serializers.ModelSerializer):
#     """ Serializer for an IpType object. Use SerializerMethodField to
#     get ForeignKey values """
# 
#     extension = ExtensionNameField(read_only=True)
#     ouverture_ports_tcp_in = serializers\
#         .SerializerMethodField('get_port_policy_input_tcp')
#     ouverture_ports_tcp_out = serializers\
#         .SerializerMethodField('get_port_policy_output_tcp')
#     ouverture_ports_udp_in = serializers\
#         .SerializerMethodField('get_port_policy_input_udp')
#     ouverture_ports_udp_out = serializers\
#         .SerializerMethodField('get_port_policy_output_udp')
# 
#     class Meta:
#         model = IpType
#         fields = ('type', 'extension', 'domaine_ip_start', 'domaine_ip_stop',
#                   'prefix_v6',
#                   'ouverture_ports_tcp_in', 'ouverture_ports_tcp_out',
#                   'ouverture_ports_udp_in', 'ouverture_ports_udp_out',)
# 
#     @staticmethod
#     def get_port_policy(obj, protocole, io):
#         """ Generic utility function to get the policy for a given
#         port, protocole and IN or OUT """
#         if obj.ouverture_ports is None:
#             return []
#         return map(
#             str,
#             obj.ouverture_ports.ouvertureport_set.filter(
#                 protocole=protocole
#             ).filter(io=io)
#         )
# 
#     def get_port_policy_input_tcp(self, obj):
#         """Renvoie la liste des ports ouverts en entrée tcp"""
#         return self.get_port_policy(obj, OuverturePort.TCP, OuverturePort.IN)
# 
#     def get_port_policy_output_tcp(self, obj):
#         """Renvoie la liste des ports ouverts en sortie tcp"""
#         return self.get_port_policy(obj, OuverturePort.TCP, OuverturePort.OUT)
# 
#     def get_port_policy_input_udp(self, obj):
#         """Renvoie la liste des ports ouverts en entrée udp"""
#         return self.get_port_policy(obj, OuverturePort.UDP, OuverturePort.IN)
# 
#     def get_port_policy_output_udp(self, obj):
#         """Renvoie la liste des ports ouverts en sortie udp"""
#         return self.get_port_policy(obj, OuverturePort.UDP, OuverturePort.OUT)
# 
# 
# class ExtensionSerializer(serializers.ModelSerializer):
#     """Serialisation d'une extension : origin_ip et la zone sont
#     des foreign_key donc evalués en get_..."""
#     origin = serializers.SerializerMethodField('get_origin_ip')
#     zone_entry = serializers.SerializerMethodField('get_zone_name')
#     soa = serializers.SerializerMethodField('get_soa_data')
# 
#     class Meta:
#         model = Extension
#         fields = ('name', 'origin', 'origin_v6', 'zone_entry', 'soa')
# 
#     @staticmethod
#     def get_origin_ip(obj):
#         """ The IP of the associated origin for the zone """
#         return obj.origin.ipv4
# 
#     @staticmethod
#     def get_zone_name(obj):
#         """ The name of the associated zone """
#         return str(obj.dns_entry)
# 
#     @staticmethod
#     def get_soa_data(obj):
#         """ The representation of the associated SOA """
#         return {'mail': obj.soa.dns_soa_mail, 'param': obj.soa.dns_soa_param}
# 
# 
# class MxSerializer(serializers.ModelSerializer):
#     """Serialisation d'un MX, evaluation du nom, de la zone
#     et du serveur cible, etant des foreign_key"""
#     name = serializers.SerializerMethodField('get_entry_name')
#     zone = serializers.SerializerMethodField('get_zone_name')
#     mx_entry = serializers.SerializerMethodField('get_mx_name')
# 
#     class Meta:
#         model = Mx
#         fields = ('zone', 'priority', 'name', 'mx_entry')
# 
#     @staticmethod
#     def get_entry_name(obj):
#         """ The name of the DNS MX entry """
#         return str(obj.name)
# 
#     @staticmethod
#     def get_zone_name(obj):
#         """ The name of the associated zone of the MX record """
#         return obj.zone.name
# 
#     @staticmethod
#     def get_mx_name(obj):
#         """ The string representation of the entry to add to the DNS """
#         return str(obj.dns_entry)
# 
# 
# class TxtSerializer(serializers.ModelSerializer):
#     """Serialisation d'un txt : zone cible et l'entrée txt
#     sont evaluées à part"""
#     zone = serializers.SerializerMethodField('get_zone_name')
#     txt_entry = serializers.SerializerMethodField('get_txt_name')
# 
#     class Meta:
#         model = Txt
#         fields = ('zone', 'txt_entry', 'field1', 'field2')
# 
#     @staticmethod
#     def get_zone_name(obj):
#         """ The name of the associated zone """
#         return str(obj.zone.name)
# 
#     @staticmethod
#     def get_txt_name(obj):
#         """ The string representation of the entry to add to the DNS """
#         return str(obj.dns_entry)
# 
# 
# class SrvSerializer(serializers.ModelSerializer):
#     """Serialisation d'un srv : zone cible et l'entrée txt"""
#     extension = serializers.SerializerMethodField('get_extension_name')
#     srv_entry = serializers.SerializerMethodField('get_srv_name')
# 
#     class Meta:
#         model = Srv
#         fields = (
#             'service',
#             'protocole',
#             'extension',
#             'ttl',
#             'priority',
#             'weight',
#             'port',
#             'target',
#             'srv_entry'
#         )
# 
#     @staticmethod
#     def get_extension_name(obj):
#         """ The name of the associated extension """
#         return str(obj.extension.name)
# 
#     @staticmethod
#     def get_srv_name(obj):
#         """ The string representation of the entry to add to the DNS """
#         return str(obj.dns_entry)
# 
# 
# class NsSerializer(serializers.ModelSerializer):
#     """Serialisation d'un NS : la zone, l'entrée ns complète et le serveur
#     ns sont évalués à part"""
#     zone = serializers.SerializerMethodField('get_zone_name')
#     ns = serializers.SerializerMethodField('get_domain_name')
#     ns_entry = serializers.SerializerMethodField('get_text_name')
# 
#     class Meta:
#         model = Ns
#         fields = ('zone', 'ns', 'ns_entry')
# 
#     @staticmethod
#     def get_zone_name(obj):
#         """ The name of the associated zone """
#         return obj.zone.name
# 
#     @staticmethod
#     def get_domain_name(obj):
#         """ The name of the associated NS target """
#         return str(obj.ns)
# 
#     @staticmethod
#     def get_text_name(obj):
#         """ The string representation of the entry to add to the DNS """
#         return str(obj.dns_entry)
# 
# 
# class DomainSerializer(serializers.ModelSerializer):
#     """Serialisation d'un domain, extension, cname sont des foreign_key,
#     et l'entrée complète, sont évalués à part"""
#     extension = serializers.SerializerMethodField('get_zone_name')
#     cname = serializers.SerializerMethodField('get_alias_name')
#     cname_entry = serializers.SerializerMethodField('get_cname_name')
# 
#     class Meta:
#         model = Domain
#         fields = ('name', 'extension', 'cname', 'cname_entry')
# 
#     @staticmethod
#     def get_zone_name(obj):
#         """ The name of the associated zone """
#         return obj.extension.name
# 
#     @staticmethod
#     def get_alias_name(obj):
#         """ The name of the associated alias """
#         return str(obj.cname)
# 
#     @staticmethod
#     def get_cname_name(obj):
#         """ The name of the associated CNAME target """
#         return str(obj.dns_entry)
# 
# 
# class ServicesSerializer(serializers.ModelSerializer):
#     """Evaluation d'un Service, et serialisation"""
#     server = serializers.SerializerMethodField('get_server_name')
#     service = serializers.SerializerMethodField('get_service_name')
#     need_regen = serializers.SerializerMethodField('get_regen_status')
# 
#     class Meta:
#         model = Service_link
#         fields = ('server', 'service', 'need_regen')
# 
#     @staticmethod
#     def get_server_name(obj):
#         """ The name of the associated server """
#         return str(obj.server.domain.name)
# 
#     @staticmethod
#     def get_service_name(obj):
#         """ The name of the service name """
#         return str(obj.service)
# 
#     @staticmethod
#     def get_regen_status(obj):
#         """ The string representation of the regen status """
#         return obj.need_regen()
# 
# 
# class OuverturePortsSerializer(serializers.Serializer):
#     """Serialisation de l'ouverture des ports"""
#     ipv4 = serializers.SerializerMethodField()
#     ipv6 = serializers.SerializerMethodField()
# 
#     def create(self, validated_data):
#         """ Creates a new object based on the un-serialized data.
#         Used to implement an abstract inherited method """
#         pass
# 
#     def update(self, instance, validated_data):
#         """ Updates an object based on the un-serialized data.
#         Used to implement an abstract inherited method """
#         pass
# 
#     @staticmethod
#     def get_ipv4():
#         """ The representation of the policy for the IPv4 addresses """
#         return {
#             i.ipv4.ipv4: {
#                 "tcp_in": [j.tcp_ports_in() for j in i.port_lists.all()],
#                 "tcp_out": [j.tcp_ports_out()for j in i.port_lists.all()],
#                 "udp_in": [j.udp_ports_in() for j in i.port_lists.all()],
#                 "udp_out": [j.udp_ports_out() for j in i.port_lists.all()],
#             }
#             for i in Interface.objects.all() if i.ipv4
#         }
# 
#     @staticmethod
#     def get_ipv6():
#         """ The representation of the policy for the IPv6 addresses """
#         return {
#             i.ipv6: {
#                 "tcp_in": [j.tcp_ports_in() for j in i.port_lists.all()],
#                 "tcp_out": [j.tcp_ports_out()for j in i.port_lists.all()],
#                 "udp_in": [j.udp_ports_in() for j in i.port_lists.all()],
#                 "udp_out": [j.udp_ports_out() for j in i.port_lists.all()],
#             }
#             for i in Interface.objects.all() if i.ipv6
#         }