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 17.2 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
grisel-davy's avatar
grisel-davy committed
43 44
from django.db.models.signals import pre_save, post_save, post_delete
from django.utils.functional import cached_property
45
from django.dispatch import receiver
46
from django.core.exceptions import ValidationError
47 48 49
from django.db import IntegrityError
from django.db import transaction
from reversion import revisions as reversion
chirac's avatar
chirac committed
50

51
from machines.models import Machine, regen
52 53
from re2o.mixins import AclMixin, RevMixin

grisel-davy's avatar
grisel-davy committed
54 55 56 57 58
from os.path import isfile 
from os import remove



59

60
class Stack(AclMixin, RevMixin, models.Model):
61 62
    """Un objet stack. Regrouppe des switchs en foreign key
    ,contient une id de stack, un switch id min et max dans
63
    le stack"""
64 65 66 67 68
    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)
69 70
    member_id_min = models.PositiveIntegerField()
    member_id_max = models.PositiveIntegerField()
71

72 73 74 75 76
    class Meta:
        permissions = (
            ("view_stack", "Peut voir un objet stack"),
        )

77 78 79 80
    def __str__(self):
        return " ".join([self.name, self.stack_id])

    def save(self, *args, **kwargs):
81
        self.clean()
82 83 84 85 86
        if not self.name:
            self.name = self.stack_id
        super(Stack, self).save(*args, **kwargs)

    def clean(self):
87
        """ Verification que l'id_max < id_min"""
88
        if self.member_id_max < self.member_id_min:
chirac's avatar
chirac committed
89
            raise ValidationError({'member_id_max': "L'id maximale est\
90
                inférieure à l'id minimale"})
91

chirac's avatar
chirac committed
92

93
class AccessPoint(AclMixin, Machine):
94
    """Define a wireless AP. Inherit from machines.interfaces
95

96 97 98 99
    Definition pour une borne wifi , hérite de machines.interfaces
    """
    PRETTY_NAME = "Borne WiFi"

100
    location = models.CharField(
101 102 103 104 105 106 107 108
        max_length=255,
        help_text="Détails sur la localisation de l'AP",
        blank=True,
        null=True
    )

    class Meta:
        permissions = (
109
            ("view_accesspoint", "Peut voir une borne"),
110 111
        )

grisel-davy's avatar
grisel-davy committed
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
    def port(self):
        """Return the queryset of ports for this device"""
        return Port.objects.filter(
            machine_interface__machine=self
        )

    def switch(self):
        """Return the switch where this is plugged"""
        return Switch.objects.filter(
            ports__machine_interface__machine=self
        )

    def building(self):
        """Return the building of the AP/Server (building of the switchs connected to...)"""
        return Building.objects.filter(
            switchbay__switch=self.switch()
        )

    @cached_property
    def short_name(self):
        return str(self.interface_set.first().domain.name)

    @classmethod
    def all_ap_in(cls, building_instance):
        """Get a building as argument, returns all ap of a building"""
        return cls.objects.filter(interface__port__switch__switchbay__building=building_instance)

    def __str__(self):
        return str(self.interface_set.first())


class Server(Machine):
    """Dummy class, to retrieve servers of a building, or get switch of a server"""

    class Meta:
        proxy = True

    def port(self):
        """Return the queryset of ports for this device"""
        return Port.objects.filter(
            machine_interface__machine=self
        )

    def switch(self):
        """Return the switch where this is plugged"""
        return Switch.objects.filter(
            ports__machine_interface__machine=self
        )

    def building(self):
        """Return the building of the AP/Server (building of the switchs connected to...)"""
        return Building.objects.filter(
            switchbay__switch=self.switch()
        )

    @cached_property
    def short_name(self):
        return str(self.interface_set.first().domain.name)

    @classmethod
    def all_server_in(cls, building_instance):
        """Get a building as argument, returns all server of a building"""
        return cls.objects.filter(interface__port__switch__switchbay__building=building_instance).exclude(accesspoint__isnull=False)

176 177 178
    def __str__(self):
        return str(self.interface_set.first())

179

180
class Switch(AclMixin, Machine):
181
    """ Definition d'un switch. Contient un nombre de ports (number),
182 183 184
    un emplacement (location), un stack parent (optionnel, stack)
    et un id de membre dans le stack (stack_member_id)
    relié en onetoone à une interface
185
    Pourquoi ne pas avoir fait hériter switch de interface ?
186 187
    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
188 189 190 191
    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"""
192 193
    PRETTY_NAME = "Switch / Commutateur"

Gabriel Detraz's avatar
Gabriel Detraz committed
194 195 196
    number = models.PositiveIntegerField(
        help_text="Nombre de ports"
    )
197
    stack = models.ForeignKey(
198
        'topologie.Stack',
199 200 201 202
        blank=True,
        null=True,
        on_delete=models.SET_NULL
        )
Gabriel Detraz's avatar
Gabriel Detraz committed
203 204 205 206 207
    stack_member_id = models.PositiveIntegerField(
        blank=True,
        null=True,
        help_text="Baie de brassage du switch"
    )
208 209 210 211
    model = models.ForeignKey(
        'topologie.ModelSwitch',
        blank=True,
        null=True,
Gabriel Detraz's avatar
Gabriel Detraz committed
212 213
        on_delete=models.SET_NULL,
        help_text="Modèle du switch"
214
    )
215 216 217 218
    switchbay = models.ForeignKey(
        'topologie.SwitchBay',
        blank=True,
        null=True,
Gabriel Detraz's avatar
Gabriel Detraz committed
219 220
        on_delete=models.SET_NULL,
        help_text="Baie de brassage du switch"
221
    )
222 223

    class Meta:
224
        unique_together = ('stack', 'stack_member_id')
225
        permissions = (
Gabriel Detraz's avatar
Gabriel Detraz committed
226
            ("view_switch", "Peut voir un objet switch"),
227
        )
chirac's avatar
chirac committed
228

229
    def clean(self):
Gabriel Detraz's avatar
Gabriel Detraz committed
230 231 232
        """ Verifie que l'id stack est dans le bon range
        Appelle également le clean de la classe parente"""
        super(Switch, self).clean()
233 234
        if self.stack is not None:
            if self.stack_member_id is not None:
235
                if (self.stack_member_id > self.stack.member_id_max) or\
chirac's avatar
chirac committed
236 237 238 239 240
                        (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"}
                        )
241
            else:
242 243
                raise ValidationError({'stack_member_id': "L'id dans la stack\
                    ne peut être nul"})
244

245
    def create_ports(self, begin, end):
246 247
        """ Crée les ports de begin à end si les valeurs données
        sont cohérentes. """
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271

        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.")
272

273
    def main_interface(self):
274
        """ Returns the 'main' interface of the switch """
275 276
        return self.interface_set.first()

277
    def __str__(self):
278
        return str(self.main_interface())
279

chirac's avatar
chirac committed
280

281
class ModelSwitch(AclMixin, RevMixin, models.Model):
282
    """Un modèle (au sens constructeur) de switch"""
Gabriel Detraz's avatar
Gabriel Detraz committed
283
    PRETTY_NAME = "Modèle de switch"
284 285 286 287 288 289
    reference = models.CharField(max_length=255)
    constructor = models.ForeignKey(
        'topologie.ConstructorSwitch',
        on_delete=models.PROTECT
    )

290 291 292 293 294
    class Meta:
        permissions = (
            ("view_modelswitch", "Peut voir un objet modelswitch"),
        )

295
    def __str__(self):
296
        return str(self.constructor) + ' ' + self.reference
297 298


299
class ConstructorSwitch(AclMixin, RevMixin, models.Model):
300
    """Un constructeur de switch"""
Gabriel Detraz's avatar
Gabriel Detraz committed
301
    PRETTY_NAME = "Constructeur de switch"
302 303
    name = models.CharField(max_length=255)

304 305 306 307 308
    class Meta:
        permissions = (
            ("view_constructorswitch", "Peut voir un objet constructorswitch"),
        )

309
    def __str__(self):
310
        return self.name
311 312


313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350
class SwitchBay(AclMixin, RevMixin, models.Model):
    """Une baie de brassage"""
    PRETTY_NAME = "Baie de brassage"
    name = models.CharField(max_length=255)
    building = models.ForeignKey(
        'Building',
        on_delete=models.PROTECT
    )
    info = models.CharField(
        max_length=255,
        blank=True,
        null=True,
        help_text="Informations particulières"
    )

    class Meta:
        permissions = (
            ("view_switchbay", "Peut voir un objet baie de brassage"),
        )

    def __str__(self):
        return self.name


class Building(AclMixin, RevMixin, models.Model):
    """Un batiment"""
    PRETTY_NAME = "Batiment"
    name = models.CharField(max_length=255)

    class Meta:
        permissions = (
            ("view_building", "Peut voir un objet batiment"),
        )

    def __str__(self):
        return self.name


351
class Port(AclMixin, RevMixin, models.Model):
352
    """ Definition d'un port. Relié à un switch(foreign_key),
353 354 355 356
    un port peut etre relié de manière exclusive à :
    - une chambre (room)
    - une machine (serveur etc) (machine_interface)
    - un autre port (uplink) (related)
357
    Champs supplémentaires :
358
    - RADIUS (mode STRICT : connexion sur port uniquement si machine
359 360
    d'un adhérent à jour de cotisation et que la chambre est également à
    jour de cotisation
361 362 363 364
    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
365
    de forcer un port sur un vlan particulier. S'additionne à la politique
366
    RADIUS"""
367
    PRETTY_NAME = "Port de switch"
368
    STATES = (
369 370 371 372 373 374
        ('NO', 'NO'),
        ('STRICT', 'STRICT'),
        ('BLOQ', 'BLOQ'),
        ('COMMON', 'COMMON'),
        )

375 376 377 378 379
    switch = models.ForeignKey(
        'Switch',
        related_name="ports",
        on_delete=models.CASCADE
    )
380
    port = models.PositiveIntegerField()
381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
    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
399
    radius = models.CharField(max_length=32, choices=STATES, default='NO')
400 401 402 403 404 405
    vlan_force = models.ForeignKey(
        'machines.Vlan',
        on_delete=models.SET_NULL,
        blank=True,
        null=True
        )
Dalahro's avatar
Dalahro committed
406
    details = models.CharField(max_length=255, blank=True)
chirac's avatar
chirac committed
407 408

    class Meta:
409
        unique_together = ('switch', 'port')
410 411 412
        permissions = (
            ("view_port", "Peut voir un objet port"),
        )
413

414 415 416 417 418 419 420 421 422
    @classmethod
    def get_instance(cls, portid, *_args, **kwargs):
        return (cls.objects
                .select_related('machine_interface__domain__extension')
                .select_related('machine_interface__machine__switch')
                .select_related('room')
                .select_related('related')
                .prefetch_related('switch__interface_set__domain__extension')
                .get(pk=portid))
423

424 425 426 427 428
    def make_port_related(self):
        """ Synchronise le port distant sur self"""
        related_port = self.related
        related_port.related = self
        related_port.save()
429

430 431 432 433 434 435
    def clean_port_related(self):
        """ Supprime la relation related sur self"""
        related_port = self.related_port
        related_port.related = None
        related_port.save()

436
    def clean(self):
437 438 439 440
        """ 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
441
        Si un port related point vers self, on nettoie la relation
442 443 444
        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
445 446
        if hasattr(self, 'switch'):
            if self.port > self.switch.number:
447 448 449 450 451 452 453 454 455 456
                raise ValidationError(
                    "Ce port ne peut exister, numero trop élevé"
                )
        if (self.room and self.machine_interface or
                self.room and self.related or
                self.machine_interface and self.related):
            raise ValidationError(
                "Chambre, interface et related_port sont mutuellement "
                "exclusifs"
            )
457
        if self.related == self:
458 459 460
            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:
461 462 463 464
                raise ValidationError(
                    "Le port relié est déjà occupé, veuillez le libérer "
                    "avant de créer une relation"
                )
465
            else:
466
                self.make_port_related()
467
        elif hasattr(self, 'related_port'):
468
            self.clean_port_related()
chirac's avatar
chirac committed
469 470

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

chirac's avatar
chirac committed
473

474
class Room(AclMixin, RevMixin, models.Model):
475
    """Une chambre/local contenant une prise murale"""
476 477
    PRETTY_NAME = "Chambre/ Prise murale"

lhark's avatar
lhark committed
478
    name = models.CharField(max_length=255, unique=True)
chirac's avatar
chirac committed
479
    details = models.CharField(max_length=255, blank=True)
chirac's avatar
chirac committed
480

481 482
    class Meta:
        ordering = ['name']
483 484 485
        permissions = (
            ("view_room", "Peut voir un objet chambre"),
        )
486

chirac's avatar
chirac committed
487
    def __str__(self):
488
        return self.name
chirac's avatar
chirac committed
489

chirac's avatar
chirac committed
490

491
@receiver(post_save, sender=AccessPoint)
492
def ap_post_save(**_kwargs):
493 494
    """Regeneration des noms des bornes vers le controleur"""
    regen('unifi-ap-names')
grisel-davy's avatar
grisel-davy committed
495
    regen("graph_topo")
496 497

@receiver(post_delete, sender=AccessPoint)
498
def ap_post_delete(**_kwargs):
499 500
    """Regeneration des noms des bornes vers le controleur"""
    regen('unifi-ap-names')
grisel-davy's avatar
grisel-davy committed
501
    regen("graph_topo")
502

503
@receiver(post_delete, sender=Stack)
504
def stack_post_delete(**_kwargs):
505 506
    """Vide les id des switches membres d'une stack supprimée"""
    Switch.objects.filter(stack=None).update(stack_member_id=None)
grisel-davy's avatar
grisel-davy committed
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

@receiver(post_save, sender=Port)
def port_post_save(**_kwargs):
    regen("graph_topo")

@receiver(post_delete, sender=Port)
def port_post_delete(**_kwargs):
    regen("graph_topo")

@receiver(post_save, sender=ModelSwitch)
def modelswitch_post_save(**_kwargs):
    regen("graph_topo")

@receiver(post_delete, sender=ModelSwitch)
def modelswitch_post_delete(**_kwargs):
    regen("graph_topo")

@receiver(post_save, sender=Building)
def building_post_save(**_kwargs):
    regen("graph_topo")

@receiver(post_delete, sender=Building)
def building_post_delete(**_kwargs):
    regen("graph_topo")

@receiver(post_save, sender=Switch)
def switch_post_save(**_kwargs):
    regen("graph_topo")

@receiver(post_delete, sender=Switch)
def switch_post_delete(**_kwargs):
    regen("graph_topo")