blob: 9713ab4539c3ba60d7bfe3f03bcf7e24d45c5258 [file] [log] [blame]
# Copyright 2017-present Open Networking Foundation
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import re
import socket
import random
from xos.exceptions import XOSValidationError, XOSProgrammingError, XOSPermissionDenied
from models_decl import RCORDService_decl, RCORDSubscriber_decl, RCORDIpAddress_decl
class RCORDService(RCORDService_decl):
class Meta:
proxy = True
class RCORDIpAddress(RCORDIpAddress_decl):
class Meta:
proxy = True
def save(self, *args, **kwargs):
try:
if ":" in self.ip:
# it's an IPv6 address
socket.inet_pton(socket.AF_INET6, self.ip)
else:
# it's an IPv4 address
socket.inet_pton(socket.AF_INET, self.ip)
except socket.error:
raise XOSValidationError("The IP specified is not valid: %s" % self.ip)
super(RCORDIpAddress, self).save(*args, **kwargs)
return
class RCORDSubscriber(RCORDSubscriber_decl):
class Meta:
proxy = True
def invalidate_related_objects(self):
# Dirty all vSGs related to this subscriber, so the vSG synchronizer
# will run.
# FIXME: This should be reimplemented when multiple-objects-per-synchronizer is implemented.
for link in self.subscribed_links.all():
outer_service_instance = link.provider_service_instance
# TODO: We may need to invalidate the vOLT too...
for link in outer_service_instance.subscribed_links.all():
inner_service_instance = link.provider_service_instance
inner_service_instance.save(update_fields=["updated"])
def generate_s_tag(self):
# NOTE what's the right way to generate an s_tag?
tag = random.randint(16, 4096)
return tag
def generate_c_tag(self):
# NOTE this method will loop if available c_tags are ended
tag = random.randint(16, 4096)
if tag in self.get_used_c_tags():
return self.generate_c_tag()
return tag
def get_used_c_tags(self):
# TODO add validation for no duplicate c_tag on the same s_tag
same_onu_subscribers = RCORDSubscriber.objects.filter(onu_device=self.onu_device)
same_onu_subscribers = [s for s in same_onu_subscribers if s.id != self.id]
used_tags = [s.c_tag for s in same_onu_subscribers]
return used_tags
def save(self, *args, **kwargs):
self.validate_unique_service_specific_id(none_okay=True)
# VSGServiceInstance will extract the creator from the Subscriber, as it needs a creator to create its
# Instance.
if not self.creator:
# If we weren't passed an explicit creator, then we will assume the caller is the creator.
if not getattr(self, "caller", None):
raise XOSProgrammingError("RCORDSubscriber's self.caller was not set")
self.creator = self.caller
# validate MAC Address
if hasattr(self, 'mac_address') and self.mac_address:
if not re.match("[0-9a-f]{2}([-:]?)[0-9a-f]{2}(\\1[0-9a-f]{2}){4}$", self.mac_address.lower()):
raise XOSValidationError("The MAC address specified is not valid: %s" % self.mac_address)
# validate c_tag
if hasattr(self, 'c_tag') and self.c_tag:
is_update_with_same_tag = False
if not self.is_new:
# if it is an update, but the tag is the same, skip validation
existing = RCORDSubscriber.objects.filter(c_tag=self.c_tag)
if len(existing) > 0 and existing[0].c_tag == self.c_tag and existing[0].id == self.id:
is_update_with_same_tag = True
if self.c_tag in self.get_used_c_tags() and not is_update_with_same_tag:
raise XOSValidationError("The c_tag you specified (%s) has already been used on device %s" % (self.c_tag, self.onu_device))
if not hasattr(self, "c_tag") or not self.c_tag:
self.c_tag = self.generate_c_tag()
if not hasattr(self, "s_tag") or not self.s_tag:
self.s_tag = self.generate_s_tag()
self.set_owner()
if self.status != "pre-provisioned" and hasattr(self.owner.leaf_model, "access") and self.owner.leaf_model.access == "voltha":
# if the access network is managed by voltha, validate that onu_device actually exist
volt_service = self.owner.provider_services[0].leaf_model # we assume RCORDService is connected only to the vOLTService
if not volt_service.has_access_device(self.onu_device):
raise XOSValidationError("The onu_device you specified (%s) does not exists" % self.onu_device)
super(RCORDSubscriber, self).save(*args, **kwargs)
self.invalidate_related_objects()
return