models.py 13.9 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
44
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

50
from machines.models import Machine, Interface, regen
51
from re2o.mixins import AclMixin, RevMixin
chirac's avatar
chirac committed
52

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

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

70 71 72 73
    def __str__(self):
        return " ".join([self.name, self.stack_id])

    def save(self, *args, **kwargs):
74
        self.clean()
75 76 77 78 79
        if not self.name:
            self.name = self.stack_id
        super(Stack, self).save(*args, **kwargs)

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

chirac's avatar
chirac committed
85

86
class AccessPoint(AclMixin, Machine):
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101
    """Define a wireless AP. Inherit from machines.interfaces
    
    Definition pour une borne wifi , hérite de machines.interfaces
    """
    PRETTY_NAME = "Borne WiFi"

    location = models.CharField(    
        max_length=255,
        help_text="Détails sur la localisation de l'AP",
        blank=True,
        null=True
    )

    class Meta:
        permissions = (
102
            ("view_accesspoint", "Peut voir une borne"),
103 104
        )

105 106 107
    def __str__(self):
        return str(self.interface_set.first())

108

109
class Switch(AclMixin, Machine):
110
    """ Definition d'un switch. Contient un nombre de ports (number),
111 112 113
    un emplacement (location), un stack parent (optionnel, stack)
    et un id de membre dans le stack (stack_member_id)
    relié en onetoone à une interface
114
    Pourquoi ne pas avoir fait hériter switch de interface ?
115 116
    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
117 118 119 120
    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"""
121 122
    PRETTY_NAME = "Switch / Commutateur"

123

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

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

152
    def clean(self):
Gabriel Detraz's avatar
Gabriel Detraz committed
153 154 155
        """ Verifie que l'id stack est dans le bon range
        Appelle également le clean de la classe parente"""
        super(Switch, self).clean()
156 157
        if self.stack is not None:
            if self.stack_member_id is not None:
158
                if (self.stack_member_id > self.stack.member_id_max) or\
chirac's avatar
chirac committed
159 160 161 162 163
                        (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"}
                        )
164
            else:
165 166
                raise ValidationError({'stack_member_id': "L'id dans la stack\
                    ne peut être nul"})
167

168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193
    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.")
194

195 196 197
    def main_interface(self):
        return self.interface_set.first()

198
    def __str__(self):
199
        return str(self.main_interface())
200

chirac's avatar
chirac committed
201

202
class ModelSwitch(AclMixin, RevMixin, models.Model):
203
    """Un modèle (au sens constructeur) de switch"""
Gabriel Detraz's avatar
Gabriel Detraz committed
204
    PRETTY_NAME = "Modèle de switch"
205 206 207 208 209 210
    reference = models.CharField(max_length=255)
    constructor = models.ForeignKey(
        'topologie.ConstructorSwitch',
        on_delete=models.PROTECT
    )

211 212 213 214 215
    class Meta:
        permissions = (
            ("view_modelswitch", "Peut voir un objet modelswitch"),
        )

216
    def __str__(self):
217
        return str(self.constructor) + ' ' + self.reference
218 219


220
class ConstructorSwitch(AclMixin, RevMixin, models.Model):
221
    """Un constructeur de switch"""
Gabriel Detraz's avatar
Gabriel Detraz committed
222
    PRETTY_NAME = "Constructeur de switch"
223 224
    name = models.CharField(max_length=255)

225 226 227 228 229
    class Meta:
        permissions = (
            ("view_constructorswitch", "Peut voir un objet constructorswitch"),
        )

230
    def __str__(self):
231
        return self.name
232 233


234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271
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


272
class Port(AclMixin, RevMixin, models.Model):
273
    """ Definition d'un port. Relié à un switch(foreign_key),
274 275 276 277
    un port peut etre relié de manière exclusive à :
    - une chambre (room)
    - une machine (serveur etc) (machine_interface)
    - un autre port (uplink) (related)
278
    Champs supplémentaires :
279
    - RADIUS (mode STRICT : connexion sur port uniquement si machine
280 281
    d'un adhérent à jour de cotisation et que la chambre est également à
    jour de cotisation
282 283 284 285
    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
286
    de forcer un port sur un vlan particulier. S'additionne à la politique
287
    RADIUS"""
288
    PRETTY_NAME = "Port de switch"
289
    STATES = (
290 291 292 293 294 295
        ('NO', 'NO'),
        ('STRICT', 'STRICT'),
        ('BLOQ', 'BLOQ'),
        ('COMMON', 'COMMON'),
        )

296 297 298 299 300
    switch = models.ForeignKey(
        'Switch',
        related_name="ports",
        on_delete=models.CASCADE
    )
301
    port = models.PositiveIntegerField()
302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319
    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
320
    radius = models.CharField(max_length=32, choices=STATES, default='NO')
321 322 323 324 325 326
    vlan_force = models.ForeignKey(
        'machines.Vlan',
        on_delete=models.SET_NULL,
        blank=True,
        null=True
        )
Dalahro's avatar
Dalahro committed
327
    details = models.CharField(max_length=255, blank=True)
chirac's avatar
chirac committed
328 329

    class Meta:
330
        unique_together = ('switch', 'port')
331 332 333
        permissions = (
            ("view_port", "Peut voir un objet port"),
        )
334

335
    def get_instance(portid, *args, **kwargs):
336 337
        return Port.objects\
            .select_related('machine_interface__domain__extension')\
338
            .select_related('machine_interface__machine__switch')\
339 340
            .select_related('room')\
            .select_related('related')\
341
            .prefetch_related('switch__interface_set__domain__extension')\
342
            .get(pk=portid)
343

344 345 346 347 348
    def make_port_related(self):
        """ Synchronise le port distant sur self"""
        related_port = self.related
        related_port.related = self
        related_port.save()
349

350 351 352 353 354 355
    def clean_port_related(self):
        """ Supprime la relation related sur self"""
        related_port = self.related_port
        related_port.related = None
        related_port.save()

356
    def clean(self):
357 358 359 360
        """ 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
361
        Si un port related point vers self, on nettoie la relation
362 363 364
        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
365 366
        if hasattr(self, 'switch'):
            if self.port > self.switch.number:
chirac's avatar
chirac committed
367 368
                raise ValidationError("Ce port ne peut exister,\
                    numero trop élevé")
369
        if self.room and self.machine_interface or self.room and\
chirac's avatar
chirac committed
370
                self.related or self.machine_interface and self.related:
371 372 373
            raise ValidationError("Chambre, interface et related_port sont\
                mutuellement exclusifs")
        if self.related == self:
374 375 376
            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:
377 378
                raise ValidationError("Le port relié est déjà occupé, veuillez\
                    le libérer avant de créer une relation")
379
            else:
380
                self.make_port_related()
381
        elif hasattr(self, 'related_port'):
382
            self.clean_port_related()
chirac's avatar
chirac committed
383 384

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

chirac's avatar
chirac committed
387

388
class Room(AclMixin, RevMixin, models.Model):
389
    """Une chambre/local contenant une prise murale"""
390 391
    PRETTY_NAME = "Chambre/ Prise murale"

lhark's avatar
lhark committed
392
    name = models.CharField(max_length=255, unique=True)
chirac's avatar
chirac committed
393
    details = models.CharField(max_length=255, blank=True)
chirac's avatar
chirac committed
394

395 396
    class Meta:
        ordering = ['name']
397 398 399
        permissions = (
            ("view_room", "Peut voir un objet chambre"),
        )
400

chirac's avatar
chirac committed
401
    def __str__(self):
402
        return self.name
chirac's avatar
chirac committed
403

chirac's avatar
chirac committed
404

405 406 407 408 409 410 411 412 413 414 415 416
@receiver(post_save, sender=AccessPoint)
def ap_post_save(sender, **kwargs):
    """Regeneration des noms des bornes vers le controleur"""
    regen('unifi-ap-names')


@receiver(post_delete, sender=AccessPoint)
def ap_post_delete(sender, **kwargs):
    """Regeneration des noms des bornes vers le controleur"""
    regen('unifi-ap-names')


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