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 16 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
from django.db.models.signals import post_save, post_delete
Gabriel Detraz's avatar
Gabriel Detraz committed
44
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 54
from re2o.mixins import AclMixin, RevMixin


chirac's avatar
chirac committed
55

56

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

69 70 71 72 73
    class Meta:
        permissions = (
            ("view_stack", "Peut voir un objet stack"),
        )

74 75 76 77
    def __str__(self):
        return " ".join([self.name, self.stack_id])

    def save(self, *args, **kwargs):
78
        self.clean()
79 80 81 82 83
        if not self.name:
            self.name = self.stack_id
        super(Stack, self).save(*args, **kwargs)

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

chirac's avatar
chirac committed
89

90
class AccessPoint(AclMixin, Machine):
91
    """Define a wireless AP. Inherit from machines.interfaces
92

93 94 95 96
    Definition pour une borne wifi , hérite de machines.interfaces
    """
    PRETTY_NAME = "Borne WiFi"

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

    class Meta:
        permissions = (
106
            ("view_accesspoint", "Peut voir une borne"),
107 108
        )

109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124
    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)

125 126 127 128 129
    @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)

130 131 132
    def __str__(self):
        return str(self.interface_set.first())

133

134
class Server(Machine):
135 136 137 138 139
    """Dummy class, to retrieve servers of a building, or get switch of a server"""

    class Meta:
        proxy = True

140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155
    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)

156 157 158 159 160 161 162 163
    @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)

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

164

165
class Switch(AclMixin, Machine):
166
    """ Definition d'un switch. Contient un nombre de ports (number),
167 168 169
    un emplacement (location), un stack parent (optionnel, stack)
    et un id de membre dans le stack (stack_member_id)
    relié en onetoone à une interface
170
    Pourquoi ne pas avoir fait hériter switch de interface ?
171 172
    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
173 174 175 176
    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"""
177 178
    PRETTY_NAME = "Switch / Commutateur"

Gabriel Detraz's avatar
Gabriel Detraz committed
179 180 181
    number = models.PositiveIntegerField(
        help_text="Nombre de ports"
    )
182
    stack = models.ForeignKey(
183
        'topologie.Stack',
184 185 186 187
        blank=True,
        null=True,
        on_delete=models.SET_NULL
        )
Gabriel Detraz's avatar
Gabriel Detraz committed
188 189 190 191 192
    stack_member_id = models.PositiveIntegerField(
        blank=True,
        null=True,
        help_text="Baie de brassage du switch"
    )
193 194 195 196
    model = models.ForeignKey(
        'topologie.ModelSwitch',
        blank=True,
        null=True,
Gabriel Detraz's avatar
Gabriel Detraz committed
197 198
        on_delete=models.SET_NULL,
        help_text="Modèle du switch"
199
    )
200 201 202 203
    switchbay = models.ForeignKey(
        'topologie.SwitchBay',
        blank=True,
        null=True,
Gabriel Detraz's avatar
Gabriel Detraz committed
204 205
        on_delete=models.SET_NULL,
        help_text="Baie de brassage du switch"
206
    )
207 208

    class Meta:
209
        unique_together = ('stack', 'stack_member_id')
210
        permissions = (
Gabriel Detraz's avatar
Gabriel Detraz committed
211
            ("view_switch", "Peut voir un objet switch"),
212
        )
chirac's avatar
chirac committed
213

214
    def clean(self):
Gabriel Detraz's avatar
Gabriel Detraz committed
215 216 217
        """ Verifie que l'id stack est dans le bon range
        Appelle également le clean de la classe parente"""
        super(Switch, self).clean()
218 219
        if self.stack is not None:
            if self.stack_member_id is not None:
220
                if (self.stack_member_id > self.stack.member_id_max) or\
chirac's avatar
chirac committed
221 222 223 224 225
                        (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"}
                        )
226
            else:
227 228
                raise ValidationError({'stack_member_id': "L'id dans la stack\
                    ne peut être nul"})
229

230
    def create_ports(self, begin, end):
231 232
        """ Crée les ports de begin à end si les valeurs données
        sont cohérentes. """
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256

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

258
    def main_interface(self):
259
        """ Returns the 'main' interface of the switch """
260 261
        return self.interface_set.first()

262
    def __str__(self):
263
        return str(self.main_interface())
264

chirac's avatar
chirac committed
265

266
class ModelSwitch(AclMixin, RevMixin, models.Model):
267
    """Un modèle (au sens constructeur) de switch"""
Gabriel Detraz's avatar
Gabriel Detraz committed
268
    PRETTY_NAME = "Modèle de switch"
269 270 271 272 273 274
    reference = models.CharField(max_length=255)
    constructor = models.ForeignKey(
        'topologie.ConstructorSwitch',
        on_delete=models.PROTECT
    )

275 276 277 278 279
    class Meta:
        permissions = (
            ("view_modelswitch", "Peut voir un objet modelswitch"),
        )

280
    def __str__(self):
281
        return str(self.constructor) + ' ' + self.reference
282 283


284
class ConstructorSwitch(AclMixin, RevMixin, models.Model):
285
    """Un constructeur de switch"""
Gabriel Detraz's avatar
Gabriel Detraz committed
286
    PRETTY_NAME = "Constructeur de switch"
287 288
    name = models.CharField(max_length=255)

289 290 291 292 293
    class Meta:
        permissions = (
            ("view_constructorswitch", "Peut voir un objet constructorswitch"),
        )

294
    def __str__(self):
295
        return self.name
296 297


298 299 300 301 302 303 304 305 306 307 308 309 310 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
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


336
class Port(AclMixin, RevMixin, models.Model):
337
    """ Definition d'un port. Relié à un switch(foreign_key),
338 339 340 341
    un port peut etre relié de manière exclusive à :
    - une chambre (room)
    - une machine (serveur etc) (machine_interface)
    - un autre port (uplink) (related)
342
    Champs supplémentaires :
343
    - RADIUS (mode STRICT : connexion sur port uniquement si machine
344 345
    d'un adhérent à jour de cotisation et que la chambre est également à
    jour de cotisation
346 347 348 349
    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
350
    de forcer un port sur un vlan particulier. S'additionne à la politique
351
    RADIUS"""
352
    PRETTY_NAME = "Port de switch"
353
    STATES = (
354 355 356 357 358 359
        ('NO', 'NO'),
        ('STRICT', 'STRICT'),
        ('BLOQ', 'BLOQ'),
        ('COMMON', 'COMMON'),
        )

360 361 362 363 364
    switch = models.ForeignKey(
        'Switch',
        related_name="ports",
        on_delete=models.CASCADE
    )
365
    port = models.PositiveIntegerField()
366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383
    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
384
    radius = models.CharField(max_length=32, choices=STATES, default='NO')
385 386 387 388 389 390
    vlan_force = models.ForeignKey(
        'machines.Vlan',
        on_delete=models.SET_NULL,
        blank=True,
        null=True
        )
Dalahro's avatar
Dalahro committed
391
    details = models.CharField(max_length=255, blank=True)
chirac's avatar
chirac committed
392 393

    class Meta:
394
        unique_together = ('switch', 'port')
395 396 397
        permissions = (
            ("view_port", "Peut voir un objet port"),
        )
398

399 400 401 402 403 404 405 406 407
    @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))
408

409 410 411 412 413
    def make_port_related(self):
        """ Synchronise le port distant sur self"""
        related_port = self.related
        related_port.related = self
        related_port.save()
414

415 416 417 418 419 420
    def clean_port_related(self):
        """ Supprime la relation related sur self"""
        related_port = self.related_port
        related_port.related = None
        related_port.save()

421
    def clean(self):
422 423 424 425
        """ 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
426
        Si un port related point vers self, on nettoie la relation
427 428 429
        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
430 431
        if hasattr(self, 'switch'):
            if self.port > self.switch.number:
432 433 434 435 436 437 438 439 440 441
                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"
            )
442
        if self.related == self:
443 444 445
            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:
446 447 448 449
                raise ValidationError(
                    "Le port relié est déjà occupé, veuillez le libérer "
                    "avant de créer une relation"
                )
450
            else:
451
                self.make_port_related()
452
        elif hasattr(self, 'related_port'):
453
            self.clean_port_related()
chirac's avatar
chirac committed
454 455

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

chirac's avatar
chirac committed
458

459
class Room(AclMixin, RevMixin, models.Model):
460
    """Une chambre/local contenant une prise murale"""
461 462
    PRETTY_NAME = "Chambre/ Prise murale"

lhark's avatar
lhark committed
463
    name = models.CharField(max_length=255, unique=True)
chirac's avatar
chirac committed
464
    details = models.CharField(max_length=255, blank=True)
chirac's avatar
chirac committed
465

466 467
    class Meta:
        ordering = ['name']
468 469 470
        permissions = (
            ("view_room", "Peut voir un objet chambre"),
        )
471

chirac's avatar
chirac committed
472
    def __str__(self):
473
        return self.name
chirac's avatar
chirac committed
474

chirac's avatar
chirac committed
475

476
@receiver(post_save, sender=AccessPoint)
477
def ap_post_save(**_kwargs):
478 479 480 481 482
    """Regeneration des noms des bornes vers le controleur"""
    regen('unifi-ap-names')


@receiver(post_delete, sender=AccessPoint)
483
def ap_post_delete(**_kwargs):
484 485 486 487
    """Regeneration des noms des bornes vers le controleur"""
    regen('unifi-ap-names')


488
@receiver(post_delete, sender=Stack)
489
def stack_post_delete(**_kwargs):
490 491
    """Vide les id des switches membres d'une stack supprimée"""
    Switch.objects.filter(stack=None).update(stack_member_id=None)