Ce serveur Gitlab sera éteint le 30 juin 2020, pensez à migrer vos projets vers les serveurs gitlab-research.centralesupelec.fr et gitlab-student.centralesupelec.fr !

models.py 18.8 KB
Newer Older
1
# -*- mode: python; coding: utf-8 -*-
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
# 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 © 2017  Gabriel Détraz
# Copyright © 2017  Goulven Kermarec
# Copyright © 2017  Augustin Lemesle
#
# 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.
23 24 25 26 27 28 29 30 31 32 33 34 35 36
"""
Definition des modèles de l'application topologie.

On défini les models suivants :

- stack (id, id_min, id_max et nom) regrouppant les switches
- switch : nom, nombre de port, et interface
machine correspondante (mac, ip, etc) (voir machines.models.interface)
- Port: relié à un switch parent par foreign_key, numero du port,
relié de façon exclusive à un autre port, une machine
(serveur ou borne) ou une prise murale
- room : liste des prises murales, nom et commentaire de l'état de
la prise
"""
37

38 39
from __future__ import unicode_literals

40 41
import itertools

chirac's avatar
chirac committed
42
from django.db import models
43 44
from django.db.models.signals import post_delete
from django.dispatch import receiver
45
from django.core.exceptions import ValidationError
46 47 48
from django.db import IntegrityError
from django.db import transaction
from reversion import revisions as reversion
chirac's avatar
chirac committed
49

chirac's avatar
chirac committed
50

51
class Stack(models.Model):
52 53
    """Un objet stack. Regrouppe des switchs en foreign key
    ,contient une id de stack, un switch id min et max dans
54
    le stack"""
55 56 57 58 59
    PRETTY_NAME = "Stack de switchs"

    name = models.CharField(max_length=32, blank=True, null=True)
    stack_id = models.CharField(max_length=32, unique=True)
    details = models.CharField(max_length=255, blank=True, null=True)
60 61
    member_id_min = models.PositiveIntegerField()
    member_id_max = models.PositiveIntegerField()
62

63 64 65 66 67
    class Meta:
        permissions = (
            ("view_stack", "Peut voir un objet stack"),
        )

68 69 70 71
    def get_instance(stack_id, *args, **kwargs):
        return Stack.objects.get(pk=stack_id)

    def can_create(user_request, *args, **kwargs):
72
        return user_request.has_perm('topologie.add_stack') , u"Vous n'avez pas le droit\
73 74 75
            de créer un stack"

    def can_edit(self, user_request, *args, **kwargs):
76
        if not user_request.has_perm('topologie.change_stack'):
77 78 79
            return False, u"Vous n'avez pas le droit d'éditer des stack"
        return True, None

80
    def can_delete(self, user_request, *args, **kwargs):
81
        if not user_request.has_perm('topologie.delete_stack'):
82 83
            return False, u"Vous n'avez pas le droit de supprimer une stack"
        return True, None
84 85

    def can_view_all(user_request, *args, **kwargs):
86
        if not user_request.has_perm('topologie.view_stack'):
87 88 89 90
            return False, u"Vous n'avez pas le droit de voir une stack"
        return True, None

    def can_view(self, user_request, *args, **kwargs):
91
        if not user_request.has_perm('topologie.view_stack'):
92 93 94
            return False, u"Vous n'avez pas le droit de voir une stack"
        return True, None

95 96 97 98
    def __str__(self):
        return " ".join([self.name, self.stack_id])

    def save(self, *args, **kwargs):
99
        self.clean()
100 101 102 103 104
        if not self.name:
            self.name = self.stack_id
        super(Stack, self).save(*args, **kwargs)

    def clean(self):
105
        """ Verification que l'id_max < id_min"""
106
        if self.member_id_max < self.member_id_min:
chirac's avatar
chirac committed
107
            raise ValidationError({'member_id_max': "L'id maximale est\
108
                inférieure à l'id minimale"})
109

chirac's avatar
chirac committed
110

chirac's avatar
chirac committed
111
class Switch(models.Model):
112
    """ Definition d'un switch. Contient un nombre de ports (number),
113 114 115
    un emplacement (location), un stack parent (optionnel, stack)
    et un id de membre dans le stack (stack_member_id)
    relié en onetoone à une interface
116
    Pourquoi ne pas avoir fait hériter switch de interface ?
117 118
    Principalement par méconnaissance de la puissance de cette façon de faire.
    Ceci étant entendu, django crée en interne un onetoone, ce qui a un
119 120 121 122
    effet identique avec ce que l'on fait ici

    Validation au save que l'id du stack est bien dans le range id_min
    id_max de la stack parente"""
123 124
    PRETTY_NAME = "Switch / Commutateur"

125 126 127 128
    switch_interface = models.OneToOneField(
        'machines.Interface',
        on_delete=models.CASCADE
        )
chirac's avatar
chirac committed
129
    location = models.CharField(max_length=255)
130
    number = models.PositiveIntegerField()
chirac's avatar
chirac committed
131
    details = models.CharField(max_length=255, blank=True)
132
    stack = models.ForeignKey(
133
        'topologie.Stack',
134 135 136 137
        blank=True,
        null=True,
        on_delete=models.SET_NULL
        )
138
    stack_member_id = models.PositiveIntegerField(blank=True, null=True)
139 140 141 142 143 144
    model = models.ForeignKey(
        'topologie.ModelSwitch',
        blank=True,
        null=True,
        on_delete=models.SET_NULL
    )
145 146

    class Meta:
147
        unique_together = ('stack', 'stack_member_id')
148 149 150
        permissions = (
            ("view_switch", "Peut voir un objet switch"),
        )
chirac's avatar
chirac committed
151

152 153 154 155
    def get_instance(switch_id, *args, **kwargs):
        return Switch.objects.get(pk=switch_id)

    def can_create(user_request, *args, **kwargs):
156
        return user_request.has_perm('topologie.add_switch') , u"Vous n'avez pas le droit\
157 158 159
            de créer un switch"

    def can_edit(self, user_request, *args, **kwargs):
160
        if not user_request.has_perm('topologie.change_switch'):
161 162 163
            return False, u"Vous n'avez pas le droit d'éditer des switch"
        return True, None

164
    def can_delete(self, user_request, *args, **kwargs):
165
        if not user_request.has_perm('topologie.delete_switch'):
166 167
            return False, u"Vous n'avez pas le droit de supprimer un switch"
        return True, None
168 169

    def can_view_all(user_request, *args, **kwargs):
170
        if not user_request.has_perm('topologie.view_switch'):
171 172 173 174
            return False, u"Vous n'avez pas le droit de coir les switch"
        return True, None

    def can_view(self, user_request, *args, **kwargs):
175
        if not user_request.has_perm('topologie.view_switch'):
176 177
            return False, u"Vous n'avez pas le droit de coir les switch"
        return True, None
178
 
chirac's avatar
chirac committed
179
    def __str__(self):
180
        return self.location + ' ' + str(self.switch_interface)
chirac's avatar
chirac committed
181

182
    def clean(self):
183
        """ Verifie que l'id stack est dans le bon range"""
184 185
        if self.stack is not None:
            if self.stack_member_id is not None:
186
                if (self.stack_member_id > self.stack.member_id_max) or\
chirac's avatar
chirac committed
187 188 189 190 191
                        (self.stack_member_id < self.stack.member_id_min):
                    raise ValidationError(
                        {'stack_member_id': "L'id de ce switch est en\
                            dehors des bornes permises pas la stack"}
                        )
192
            else:
193 194
                raise ValidationError({'stack_member_id': "L'id dans la stack\
                    ne peut être nul"})
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220
    def create_ports(self, begin, end):
        """ Crée les ports de begin à end si les valeurs données sont cohérentes. """

        s_begin = s_end = 0
        nb_ports = self.ports.count()
        if nb_ports > 0:
            ports = self.ports.order_by('port').values('port')
            s_begin = ports.first().get('port')
            s_end = ports.last().get('port')

        if end < begin:
            raise ValidationError("Port de fin inférieur au port de début !")
        if end - begin > self.number:
            raise ValidationError("Ce switch ne peut avoir autant de ports.")
        begin_range = range(begin, s_begin)
        end_range = range(s_end+1, end+1)
        for i in itertools.chain(begin_range, end_range):
            port = Port()
            port.switch = self
            port.port = i
            try:
                with transaction.atomic(), reversion.create_revision():
                    port.save()
                    reversion.set_comment("Création")
            except IntegrityError:
                ValidationError("Création d'un port existant.")
221

chirac's avatar
chirac committed
222

223 224
class ModelSwitch(models.Model):
    """Un modèle (au sens constructeur) de switch"""
Gabriel Detraz's avatar
Gabriel Detraz committed
225
    PRETTY_NAME = "Modèle de switch"
226 227 228 229 230 231
    reference = models.CharField(max_length=255)
    constructor = models.ForeignKey(
        'topologie.ConstructorSwitch',
        on_delete=models.PROTECT
    )

232 233 234 235 236
    class Meta:
        permissions = (
            ("view_modelswitch", "Peut voir un objet modelswitch"),
        )

237 238 239 240
    def get_instance(model_switch_id, *args, **kwargs):
        return ModelSwitch.objects.get(pk=model_switch_id)

    def can_create(user_request, *args, **kwargs):
241
        return user_request.has_perm('topologie.add_modelswitch') , u"Vous n'avez pas le droit\
242 243 244
            de créer un modèle de switch"

    def can_edit(self, user_request, *args, **kwargs):
245
        if not user_request.has_perm('topologie.change_modelswitch'):
246 247 248
            return False, u"Vous n'avez pas le droit d'éditer des modèle de switchs"
        return True, None

249
    def can_delete(self, user_request, *args, **kwargs):
250
        if not user_request.has_perm('topologie.delete_modelswitch'):
251 252
            return False, u"Vous n'avez pas le droit de supprimer un modèle switch"
        return True, None
253 254

    def can_view(self, user_request, *args, **kwargs):
255
        if not user_request.has_perm('topologie.view_modelswitch'):
256 257 258 259
            return False, u"Vous n'avez pas le droit de voir un modèle switch"
        return True, None

    def can_view_all(user_request, *args, **kwargs):
260
        if not user_request.has_perm('topologie.view_modelswitch'):
261 262
            return False, u"Vous n'avez pas le droit de voir un modèle switch"
        return True, None
263
   
264
    def __str__(self):
265
        return str(self.constructor) + ' ' + self.reference
266 267 268 269


class ConstructorSwitch(models.Model):
    """Un constructeur de switch"""
Gabriel Detraz's avatar
Gabriel Detraz committed
270
    PRETTY_NAME = "Constructeur de switch"
271 272
    name = models.CharField(max_length=255)

273 274 275 276 277
    class Meta:
        permissions = (
            ("view_constructorswitch", "Peut voir un objet constructorswitch"),
        )

278 279 280 281
    def get_instance(constructor_switch_id, *args, **kwargs):
        return ConstructorSwitch.objects.get(pk=constructor_switch_id)

    def can_create(user_request, *args, **kwargs):
282
        return user_request.has_perm('topologie.add_constructorswitch') , u"Vous n'avez pas le droit\
283 284 285
            de créer un constructeur de switch"

    def can_edit(self, user_request, *args, **kwargs):
286
        if not user_request.has_perm('topologie.change_constructorswitch'):
287 288 289 290
            return False, u"Vous n'avez pas le droit d'éditer des\
                constructeurs de switchs"
        return True, None

291
    def can_delete(self, user_request, *args, **kwargs):
292
        if not user_request.has_perm('topologie.delete_constructorswitch'):
293 294
            return False, u"Vous n'avez pas le droit de supprimer un constructeur"
        return True, None
295 296

    def can_view_all(user_request, *args, **kwargs):
297
        if not user_request.has_perm('topologie.view_constructorswitch'):
298 299 300 301
            return False, u"Vous n'avez pas le droit de voir un constructeur"
        return True, None

    def can_view(self, user_request, *args, **kwargs):
302
        if not user_request.has_perm('topologie.view_constructorswitch'):
303 304
            return False, u"Vous n'avez pas le droit de voir un constructeur"
        return True, None
305
    
306
    def __str__(self):
307
        return self.name
308 309


chirac's avatar
chirac committed
310
class Port(models.Model):
311
    """ Definition d'un port. Relié à un switch(foreign_key),
312 313 314 315
    un port peut etre relié de manière exclusive à :
    - une chambre (room)
    - une machine (serveur etc) (machine_interface)
    - un autre port (uplink) (related)
316
    Champs supplémentaires :
317
    - RADIUS (mode STRICT : connexion sur port uniquement si machine
318 319
    d'un adhérent à jour de cotisation et que la chambre est également à
    jour de cotisation
320 321 322 323
    mode COMMON : vérification uniquement du statut de la machine
    mode NO : accepte toute demande venant du port et place sur le vlan normal
    mode BLOQ : rejet de toute authentification
    - vlan_force : override la politique générale de placement vlan, permet
324
    de forcer un port sur un vlan particulier. S'additionne à la politique
325
    RADIUS"""
326
    PRETTY_NAME = "Port de switch"
327
    STATES = (
328 329 330 331 332 333
        ('NO', 'NO'),
        ('STRICT', 'STRICT'),
        ('BLOQ', 'BLOQ'),
        ('COMMON', 'COMMON'),
        )

334 335 336 337 338
    switch = models.ForeignKey(
        'Switch',
        related_name="ports",
        on_delete=models.CASCADE
    )
339
    port = models.PositiveIntegerField()
340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357
    room = models.ForeignKey(
        'Room',
        on_delete=models.PROTECT,
        blank=True,
        null=True
        )
    machine_interface = models.ForeignKey(
        'machines.Interface',
        on_delete=models.SET_NULL,
        blank=True,
        null=True
        )
    related = models.OneToOneField(
        'self',
        null=True,
        blank=True,
        related_name='related_port'
        )
Gabriel Detraz's avatar
Gabriel Detraz committed
358
    radius = models.CharField(max_length=32, choices=STATES, default='NO')
359 360 361 362 363 364
    vlan_force = models.ForeignKey(
        'machines.Vlan',
        on_delete=models.SET_NULL,
        blank=True,
        null=True
        )
Dalahro's avatar
Dalahro committed
365
    details = models.CharField(max_length=255, blank=True)
chirac's avatar
chirac committed
366 367

    class Meta:
368
        unique_together = ('switch', 'port')
369 370 371
        permissions = (
            ("view_port", "Peut voir un objet port"),
        )
372

373
    def get_instance(port_id, *args, **kwargs):
374 375 376 377 378 379 380
        return Port.objects\
            .select_related('switch__switch_interface__domain__extension')\
            .select_related('machine_interface__domain__extension')\
            .select_related('machine_interface__switch')\
            .select_related('room')\
            .select_related('related')\
            .get(pk=port_id)
381 382

    def can_create(user_request, *args, **kwargs):
383
        return user_request.has_perm('topologie.add_port') , u"Vous n'avez pas le droit\
384 385 386
            de créer un port"

    def can_edit(self, user_request, *args, **kwargs):
387
        if not user_request.has_perm('topologie.change_port'):
388 389 390
            return False, u"Vous n'avez pas le droit d'éditer des ports"
        return True, None

391
    def can_delete(self, user_request, *args, **kwargs):
392
        if not user_request.has_perm('topologie.delete_port'):
393 394
            return False, u"Vous n'avez pas le droit de supprimer un port"
        return True, None
395 396

    def can_view_all(user_request, *args, **kwargs):
397
        if not user_request.has_perm('topologie.view_port'):
398 399 400 401
            return False, u"Vous n'avez pas le droit de voir les ports"
        return True, None

    def can_view(self, user_request, *args, **kwargs):
402
        if not user_request.has_perm('topologie.view_port'):
403 404
            return False, u"Vous n'avez pas le droit de voir les ports"
        return True, None
405
   
406 407 408 409 410
    def make_port_related(self):
        """ Synchronise le port distant sur self"""
        related_port = self.related
        related_port.related = self
        related_port.save()
411

412 413 414 415 416 417
    def clean_port_related(self):
        """ Supprime la relation related sur self"""
        related_port = self.related_port
        related_port.related = None
        related_port.save()

418
    def clean(self):
419 420 421 422
        """ Verifie que un seul de chambre, interface_parent et related_port
        est rempli. Verifie que le related n'est pas le port lui-même....
        Verifie que le related n'est pas déjà occupé par une machine ou une
        chambre. Si ce n'est pas le cas, applique la relation related
423
        Si un port related point vers self, on nettoie la relation
424 425 426
        A priori pas d'autre solution que de faire ça à la main. A priori
        tout cela est dans un bloc transaction, donc pas de problème de
        cohérence"""
lhark's avatar
lhark committed
427 428
        if hasattr(self, 'switch'):
            if self.port > self.switch.number:
chirac's avatar
chirac committed
429 430
                raise ValidationError("Ce port ne peut exister,\
                    numero trop élevé")
431
        if self.room and self.machine_interface or self.room and\
chirac's avatar
chirac committed
432
                self.related or self.machine_interface and self.related:
433 434 435
            raise ValidationError("Chambre, interface et related_port sont\
                mutuellement exclusifs")
        if self.related == self:
436 437 438
            raise ValidationError("On ne peut relier un port à lui même")
        if self.related and not self.related.related:
            if self.related.machine_interface or self.related.room:
439 440
                raise ValidationError("Le port relié est déjà occupé, veuillez\
                    le libérer avant de créer une relation")
441
            else:
442
                self.make_port_related()
443
        elif hasattr(self, 'related_port'):
444
            self.clean_port_related()
chirac's avatar
chirac committed
445 446

    def __str__(self):
chirac's avatar
chirac committed
447
        return str(self.switch) + " - " + str(self.port)
chirac's avatar
chirac committed
448

chirac's avatar
chirac committed
449

chirac's avatar
chirac committed
450
class Room(models.Model):
451
    """Une chambre/local contenant une prise murale"""
452 453
    PRETTY_NAME = "Chambre/ Prise murale"

lhark's avatar
lhark committed
454
    name = models.CharField(max_length=255, unique=True)
chirac's avatar
chirac committed
455
    details = models.CharField(max_length=255, blank=True)
chirac's avatar
chirac committed
456

457 458
    class Meta:
        ordering = ['name']
459 460 461
        permissions = (
            ("view_room", "Peut voir un objet chambre"),
        )
462

463 464 465 466
    def get_instance(room_id, *args, **kwargs):
        return Room.objects.get(pk=room_id)

    def can_create(user_request, *args, **kwargs):
467
        return user_request.has_perm('topologie.add_room') , u"Vous n'avez pas le droit\
468 469 470
            de créer une chambre"

    def can_edit(self, user_request, *args, **kwargs):
471
        if not user_request.has_perm('topologie.change_room'):
472 473 474
            return False, u"Vous n'avez pas le droit d'éditer une chambre"
        return True, None

475
    def can_delete(self, user_request, *args, **kwargs):
476
        if not user_request.has_perm('topologie.delete_room'):
477 478 479
            return False, u"Vous n'avez pas le droit de supprimer une chambre"
        return True, None

480
    def can_view_all(user_request, *args, **kwargs):
481
        if not user_request.has_perm('topologie.view_room'):
482 483 484 485
            return False, u"Vous n'avez pas le droit de voir les chambres"
        return True, None

    def can_view(self, user_request, *args, **kwargs):
486
        if not user_request.has_perm('topologie.view_room'):
487 488 489
            return False, u"Vous n'avez pas le droit de voir les chambres"
        return True, None

chirac's avatar
chirac committed
490
    def __str__(self):
491
        return self.name
chirac's avatar
chirac committed
492

chirac's avatar
chirac committed
493

494 495
@receiver(post_delete, sender=Stack)
def stack_post_delete(sender, **kwargs):
496 497
    """Vide les id des switches membres d'une stack supprimée"""
    Switch.objects.filter(stack=None).update(stack_member_id=None)