djing

mikrotik web python3 networking django bootstrap3 billing

18 KiB

Raw Blame History

Перед началом обязательно, хотя бы поверхностно, ознакомиться с документацией к Django.

Содержание

Добавление свича
Свой сервис для API
Дополнительная инфа в устройствах

Добавление поддерживаемого устройства (Свича)

Для того чтобы добавить новый тип устройства с которым потом сможет работать биллинг, нужно открыть файл devapp/dev_types.py и переопределить 2 интерфейса. Первый это BasePort для порта свича, а второй DevBase для самого свича соответственно.

Разберём этот процесс на примере готовой реализации для Eltex.

class EltexPort(BasePort):

    def __init__(self, snmpWorker, *args, **kwargs):
        BasePort.__init__(self, *args, **kwargs)
        if not issubclass(snmpWorker.__class__, SNMPBaseWorker):
            raise TypeError
        self.snmp_worker = snmpWorker

    # выключаем этот порт
    def disable(self):
        self.snmp_worker.set_int_value(
            "%s.%d" % ('.1.3.6.1.2.1.2.2.1.7', self.num),
            2
        )

    # включаем этот порт
    def enable(self):
        self.snmp_worker.set_int_value(
            "%s.%d" % ('.1.3.6.1.2.1.2.2.1.7', self.num),
            1
        )

Тут в иницииализации мы передаём все базовые параметры базовому конструктору, и дополнительный аргумент snmpWorker для работы по SNMP. snmpWorker это объект реализованного интерфейса SNMPBaseWorker, далее я опишу где мы его реализуем. Для порта надо переопределить 2 метода: disable и enable понятно для чего, чтоб включать и отключать порт.

Шаблон реализации можно даже не менять, просто укажите вместо строки .1.3.6.1.2.1.2.2.1.7 нужный SNMP OID для включения порта. К этой строке будет добавляться номер порта который нужно включить. Или, все же, переопределите этот метод если вы хотите, например, реализовать включение/выключение по telnet или ssh. Для отключения так-же по аналогии.

Теперь реализация для свича:

class EltexSwitch(DLinkDevice):
    has_attachable_to_subscriber = False
    description = _('Eltex switch')
    is_use_device_port = False
    tech_code = 'eltex_sw'

    def get_ports(self):
        for i, n in enumerate(range(49, 77), 1):
            speed = self.get_item('.1.3.6.1.2.1.2.2.1.5.%d' % n)
            yield EltexPort(self,
                num=i,
                name=self.get_item('.1.3.6.1.2.1.31.1.1.1.18.%d' % n),
                status=self.get_item('.1.3.6.1.2.1.2.2.1.8.%d' % n),
                mac=self.get_item('.1.3.6.1.2.1.2.2.1.6.%d' % n),
                speed=int(speed or 0)
            )

    def get_device_name(self):
        return self.get_item('.1.3.6.1.2.1.1.5.0')

    def uptime(self):
        uptimestamp = safe_int(self.get_item('.1.3.6.1.2.1.1.3.0'))
        tm = RuTimedelta(timedelta(seconds=uptimestamp/100)) or RuTimedelta(timedelta())
        return tm
    
    def monitoring_template(self, *args, **kwargs) -> Optional[str]:
        """
        Рендерит отрывок конфига для системы мониторинга.
        При вызове agent/downloader.py генерируется конфиг для Nagios, вызывая
        для каждого устройства конфиг возовом метода monitoring_template.
        """
    
    def register_device(self):
        """
        Вызывается при сохранении устройства, может быть использовано для
        обновления конфига в различных сервисах.
        """

Свойство @description Просто отображает человекопонятное название вашего устройства в биллинге. Заметьте, что строка на английском и заключена в процедуру _ (это ugettext_lazy, см. в импорте вверху файла), это локализация для текущего языка. Про локализацию можно почитать в соответствующем разделе документации Django django translation.

Метод @get_ports чаще всего редко изменяется по алгоритму, так что вам, в большенстве случаев, достаточно добавить нужные SNMP OID в соответствующие места процедуры. Но вы вольны реализовать ваш метод получения портов как вам угодно, главное чтоб возвращался список объектов определённого выше класса порта для этого свича. В данном случае возвращается генератор объектов EltexPort. На самом деле не обязательно генератор, можете вернуть кортеж или список, что-то итерируемое.

Метод @get_device_name получает по SNMP имя устройства, просто укажите в вашей реализации нужный OID.

Метод @uptime, понятно что возвращает, укажите нужный OID. Вернётся тип RuTimedelta, это переопределённый тип timedelta, я его реализовал для локализации временного промежутка на русский.

Свойство @has_attachable_to_subscriber возвращает правду если это устройство можно привязать к абоненту. Например у Dlink стоит True потому что Dlink стоит во многих местах на доступе, и его порты принадлежат абонентам при авторизации.

Свойство @is_use_device_port используется в DHCP чтоб понять что мы используем для привязки к абоненту всё устройство или только порт устройства. Например, если у устройства только 1 порт абонента (PON ONU), и мы привязываем этого абонента ко всему устройству а не к порту, то нужно указать False, На обычных свичах где мы авторизуем абонента на порту возвращаем True.

Реализация SNMPBaseWorker по сути не нужна, класс абстрактных методов не имеет. Потому, когда наследуемся от DevBase то в базовые классы добавим и SNMPBaseWorker, как это сделано в DLinkDevice:

class DLinkDevice(DevBase, SNMPBaseWorker):

    def __init__(self, ip, snmp_community, ver=2):
        DevBase.__init__(self)
        SNMPBaseWorker.__init__(self, ip, snmp_community, ver)

А далее просто передадим параметры для конструкторов обоих базовых классов.

Вы, наверное, обратили внимание, что EltexSwitch наследован от DLinkDevice, это потому что некоторые методы идентичны, и реализация для обоих свичей похожа.

Реализация своего NAS

Сейчас биллинг работает с несколькими Mikrotik в роли устройства для доступа абонентов в интернет. Как можно реализовать такой-же для вашего роутера, например на GNU/Linux.

Создадим файл gw_app/nas_managers/mod_linux.py и реализуем потомка для интерфейса BaseTransmitter. Методы вашего класса будут вызываться биллингом для взаимодействия с сервером доступа абонентов в интернет(NAS).

from .core import BaseTransmitter, NasFailedResult, NasNetworkError

class LinuxTransmitter(BaseTransmitter):

    @abstractmethod
    def add_user_range(self, user_list: VectorAbon):
        """добавляем список абонентов в NAS"""

    @abstractmethod
    def remove_user_range(self, users: VectorAbon):
        """удаляем список абонентов"""

    @abstractmethod
    def add_user(self, user: AbonStruct, *args):
        """добавляем абонента"""

    @abstractmethod
    def remove_user(self, user: AbonStruct):
        """удаляем абонента"""

    @abstractmethod
    def update_user(self, user: AbonStruct, *args):
        """чтоб обновить абонента можно изменить всё кроме его uid, по uid абонент будет найден"""

    @abstractmethod
    def add_tariff_range(self, tariff_list: VectorTariff):
        """
        Пока не используется, зарезервировано.
        Добавляет список тарифов в NAS
        """

    @abstractmethod
    def remove_tariff_range(self, tariff_list: VectorTariff):
        """
        Пока не используется, зарезервировано.
        Удаляем список тарифов по уникальным идентификаторам
        """

    @abstractmethod
    def add_tariff(self, tariff: TariffStruct):
        """
        Пока не используется, зарезервировано.
        Добавляет тариф
        """

    @abstractmethod
    def update_tariff(self, tariff: TariffStruct):
        """
        Пока не используется, зарезервировано.
        Чтоб обновить тариф надо изменить всё кроме его tid, по tid тариф будет найден
        """

    @abstractmethod
    def remove_tariff(self, tid: int):
        """
        :param tid: id тарифа в среде NAS сервера чтоб удалить по этому номеру
        Пока не используется, зарезервировано.
        """

    @abstractmethod
    def ping(self, host: str, count=10):
        """
        :param host: ip адрес в текстовом виде, например '192.168.0.1'
        :param count: количество пингов
        :return: None если не пингуется, иначе кортеж, в котором (сколько вернулось, сколько было отправлено)
        """

    @abstractmethod
    def read_users(self):
        """
        Читаем пользователей с NAS
        :return: список AbonStruct
        """

Для того чтоб биллинг знал о вашем классе надо указать его в gw_app/nas_managers/__init__.py. Добавьте в кортеж NAS_TYPES ещё один кортеж из двух элементов, в котором первый будет код реализации в БД, максимум 4 символа. А второй будет классом вашей реализации.

Получится примерно такое содержимое:

from gw_app.nas_managers.mod_mikrotik import MikrotikTransmitter
from gw_app.nas_managers.mod_linux import LinuxTransmitter
from gw_app.nas_managers.core import NasNetworkError, NasFailedResult
from gw_app.nas_managers.structs import SubnetQueue

# Указываем какие реализации шлюзов у нас есть, это будет использоваться в
# web интерфейсе
NAS_TYPES = (
    ('mktk', MikrotikTransmitter),
    ('linx', NasNetworkError),
)

Для примера, как вы наверное уже догадались, можно посмотреть реализацию для Mikrotik в файле gw_app/nas_managers/mod_mikrotik.py

Чтобы выводить в биллинге различные сообщения об ошибках есть 2 типа исключений: NasFailedResult и NasNetworkError. NasNetworkError, как понятно из названия, вызывается при проблемах в сети. А NasFailedResult при ошибочных кодах возврата из модуля на сервере NAS.

Биллинг прослушивает эти исключения при выполнении, и при возбуждении этих исключений отображает текст ошибки на экране пользователя.

Кстати, не все методы обязательно реализовывать, некоторые из них зарезервированы на будущие цели, в комментариях к их прототипам в интерфейсе BaseTransmitter это сказано. Поэтому просто переопределите эти зарезервированные методы как пустые, я имею ввиду pass в реализации.

Отправляем оповещения

Для того чтоб оправить важное сообщение работнику через все возможные настроенные системы(смс, телеграм, браузер) мы можем воспользоваться одной процедурой из модуля chatbot.

from chatbot.send_func import send_notify

send_notify(msg_text='Text message',account=employee_profile, tag='apptag')

Процедура send_notify принимает 3 параметра. 2 первых обязательны а последний не обязаелен.

msg_text - Текст сообщения

account - Учётка работника которому отправляем сообщение

tag - Тэг сообщения, это поле предназначено для фильтрации ваших сообщений в вашем приложении. Каждое приложение в пределах своих вызовов использует один и тот жеж уникальный тэг. Для примера приложение личных сообщений видит сообщения только для себя с помощью тега msgapp, и вы не спутаете ваши сообщения с сообщениями из модуля, например, задач который использует тэг taskap.

Свой сервис для API

Сервисы общаются с биллингом через http запросы и могут быть самыми разными, но все они должны уметь одинаково расчитывать хеш сумму для проведения транзакци, иначе web сервер биллинга просто вернёт 403. Код расчёта хеш суммы находится в djing/lib/init.py в функции check_sign и calc_hash, они рядом, там увидите. И используются они декоратором hash_auth_view в djing/lib/decorators.py и примесью(Mixin) HashAuthView в файле djing/global_base_views.py.

Смысл в том, чтобы

Дополнительная инфа в устройствах

При редактировании некоторых устройтв вы можете заметить кнопку Техническая информация. При клике на ней откроется модальное окно с текстовым полем, туда можно вписывать собственные данные в формате JSON. Нужно это, в основном, для модулей и внутренних скриптов. Так например для OLT ZTE техническая информация должна выглядеть примерно так:

{
  "telnet": {
    "password": "password for access to telnet",
    "prompt": "console prompt on device",
    "login": "login for access to telnet"
  },
  "default_vid": 100
}

Тут в секции telnet находятся данные для доступа к устройствам ZTE-C320 для возможности настроить ONU устройства по шаблону при поможи кнопки Зарегистрировать устройство рядом с кнопкой Техническая информация. Знчение default_vid это влан который будет использован в шаблоне настройки ONU для ZTE.

18 KiB Raw Blame History