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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
|
# Copyright 2019 VyOS maintainers and contributors <maintainers@vyos.io>
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library 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
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library. If not, see <http://www.gnu.org/licenses/>.
import os
from vyos.util import debug, debug_msg
from vyos.util import popen, cmd
from vyos.ifconfig.register import Register
class Control(Register):
_command_get = {}
_command_set = {}
def __init__(self, **kargs):
# some commands (such as operation comands - show interfaces, etc.)
# need to query the interface statistics. If the interface
# code is used and the debugging is enabled, the screen output
# will include both the command but also the debugging for that command
# to prevent this, debugging can be explicitely disabled
# if debug is not explicitely disabled the the config, enable it
self.debug = ''
if kargs.get('debug', True):
self.debug = debug('ifconfig')
def _debug_msg (self, message):
return debug_msg(message, self.debug)
def _popen(self, command):
return popen(command, self.debug)
def _cmd(self, command):
return cmd(command, self.debug)
def _get_command(self, config, name):
"""
Using the defined names, set data write to sysfs.
"""
cmd = self._command_get[name]['shellcmd'].format(**config)
return self._command_get[name].get('format', lambda _: _)(self._cmd(cmd))
def _set_command(self, config, name, value):
"""
Using the defined names, set data write to sysfs.
"""
# the code can pass int as int
value = str(value)
validate = self._command_set[name].get('validate', None)
if validate:
try:
validate(value)
except Exception as e:
raise e.__class__(f'Could not set {name}. {e}')
convert = self._command_set[name].get('convert', None)
if convert:
value = convert(value)
possible = self._command_set[name].get('possible', None)
if possible and not possible(config['ifname'], value):
return False
config = {**config, **{'value': value}}
cmd = self._command_set[name]['shellcmd'].format(**config)
return self._command_set[name].get('format', lambda _: _)(self._cmd(cmd))
_sysfs_get = {}
_sysfs_set = {}
def _read_sysfs(self, filename):
"""
Provide a single primitive w/ error checking for reading from sysfs.
"""
value = None
with open(filename, 'r') as f:
value = f.read().rstrip('\n')
self._debug_msg("read '{}' < '{}'".format(value, filename))
return value
def _write_sysfs(self, filename, value):
"""
Provide a single primitive w/ error checking for writing to sysfs.
"""
self._debug_msg("write '{}' > '{}'".format(value, filename))
if os.path.isfile(filename):
with open(filename, 'w') as f:
f.write(str(value))
return True
return False
def _get_sysfs(self, config, name):
"""
Using the defined names, get data write from sysfs.
"""
filename = self._sysfs_get[name]['location'].format(**config)
if not filename:
return None
return self._read_sysfs(filename)
def _set_sysfs(self, config, name, value):
"""
Using the defined names, set data write to sysfs.
"""
# the code can pass int as int
value = str(value)
validate = self._sysfs_set[name].get('validate', None)
if validate:
validate(value)
config = {**config, **{'value': value}}
convert = self._sysfs_set[name].get('convert', None)
if convert:
value = convert(value)
commited = self._write_sysfs(
self._sysfs_set[name]['location'].format(**config), value)
if not commited:
errmsg = self._sysfs_set.get('errormsg', '')
if errmsg:
raise TypeError(errmsg.format(**config))
return commited
def get_interface(self, name):
if name in self._sysfs_get:
return self._get_sysfs(self.config, name)
if name in self._command_get:
return self._get_command(self.config, name)
raise KeyError(f'{name} is not a attribute of the interface we can get')
def set_interface(self, name, value):
if name in self._sysfs_set:
return self._set_sysfs(self.config, name, value)
if name in self._command_set:
return self._set_command(self.config, name, value)
raise KeyError(f'{name} is not a attribute of the interface we can set')
|
