summaryrefslogtreecommitdiff
path: root/src/conf_mode/interfaces-wirelessmodem.py
blob: bce3405d0d8e532e52a9da01a398efb6808bb40e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
#!/usr/bin/env python3
#
# Copyright (C) 2020 VyOS maintainers and contributors
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 2 or later as
# published by the Free Software Foundation.
#
# 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, see <http://www.gnu.org/licenses/>.

import os

from sys import exit

from vyos.config import Config
from vyos.configdict import get_interface_dict
from vyos.configverify import verify_vrf
from vyos.template import render
from vyos.util import call
from vyos.util import check_kmod
from vyos.util import find_device_file
from vyos import ConfigError
from vyos import airbag
airbag.enable()

k_mod = ['option', 'usb_wwan', 'usbserial']

def get_config(config=None):
    """
    Retrive CLI config as dictionary. Dictionary can never be empty, as at least the
    interface name will be added or a deleted flag
    """
    if config:
        conf = config
    else:
        conf = Config()
    base = ['interfaces', 'wirelessmodem']
    wwan = get_interface_dict(conf, base)

    return wwan

def verify(wwan):
    if 'deleted' in wwan:
        return None

    if not 'apn' in wwan:
        raise ConfigError('No APN configured for "{ifname}"'.format(**wwan))

    if not 'device' in wwan:
        raise ConfigError('Physical "device" must be configured')

    # we can not use isfile() here as Linux device files are no regular files
    # thus the check will return False
    dev_path = find_device_file(wwan['device'])
    if dev_path is None or not os.path.exists(dev_path):
        raise ConfigError('Device "{device}" does not exist'.format(**wwan))

    verify_vrf(wwan)

    return None

def generate(wwan):
    # set up configuration file path variables where our templates will be
    # rendered into
    ifname = wwan['ifname']
    config_wwan = f'/etc/ppp/peers/{ifname}'
    config_wwan_chat = f'/etc/ppp/peers/chat.{ifname}'
    script_wwan_pre_up = f'/etc/ppp/ip-pre-up.d/1010-vyos-wwan-{ifname}'
    script_wwan_ip_up = f'/etc/ppp/ip-up.d/1010-vyos-wwan-{ifname}'
    script_wwan_ip_down = f'/etc/ppp/ip-down.d/1010-vyos-wwan-{ifname}'

    config_files = [config_wwan, config_wwan_chat, script_wwan_pre_up,
                    script_wwan_ip_up, script_wwan_ip_down]

    # Always hang-up WWAN connection prior generating new configuration file
    call(f'systemctl stop ppp@{ifname}.service')

    if 'deleted' in wwan:
        # Delete PPP configuration files
        for file in config_files:
            if os.path.exists(file):
                os.unlink(file)

    else:
        wwan['device'] = find_device_file(wwan['device'])

        # Create PPP configuration files
        render(config_wwan, 'wwan/peer.tmpl', wwan, trim_blocks=True)
        # Create PPP chat script
        render(config_wwan_chat, 'wwan/chat.tmpl', wwan, trim_blocks=True)

        # generated script file must be executable

        # Create script for ip-pre-up.d
        render(script_wwan_pre_up, 'wwan/ip-pre-up.script.tmpl',
               wwan, trim_blocks=True, permission=0o755)
        # Create script for ip-up.d
        render(script_wwan_ip_up, 'wwan/ip-up.script.tmpl',
               wwan, trim_blocks=True, permission=0o755)
        # Create script for ip-down.d
        render(script_wwan_ip_down, 'wwan/ip-down.script.tmpl',
               wwan, trim_blocks=True, permission=0o755)

    return None

def apply(wwan):
    if 'deleted' in wwan:
        # bail out early
        return None

    if not 'disable' in wwan:
        # "dial" WWAN connection
        call('systemctl start ppp@{ifname}.service'.format(**wwan))

    return None

if __name__ == '__main__':
    try:
        check_kmod(k_mod)
        c = get_config()
        verify(c)
        generate(c)
        apply(c)
    except ConfigError as e:
        print(e)
        exit(1)