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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
|
#!/usr/bin/env python3
#
# Copyright (C) 2024-2025 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 re
import sys
import json
import glob
from argparse import ArgumentParser
from os.path import join
from os.path import abspath
from os.path import dirname
from xml.etree import ElementTree as ET
from xml.etree.ElementTree import Element
from typing import TypeAlias
from typing import Optional
_here = dirname(__file__)
sys.path.append(join(_here, '..'))
from defaults import directories
from op_definition import PathData
xml_op_cache_json = 'xml_op_cache.json'
xml_op_tmp = join('/tmp', xml_op_cache_json)
op_ref_cache = abspath(join(_here, 'op_cache.py'))
OptElement: TypeAlias = Optional[Element]
DEBUG = False
def translate_exec(s: str) -> str:
s = s.replace('${vyos_op_scripts_dir}', directories['op_mode'])
s = s.replace('${vyos_libexec_dir}', directories['base'])
return s
def translate_position(s: str, pos: list[str]) -> str:
pos = pos.copy()
pat: re.Pattern = re.compile(r'(?:\")?\${?([0-9]+)}?(?:\")?')
t: str = pat.sub(r'_place_holder_\1_', s)
# preferred to .format(*list) to avoid collisions with braces
for i, p in enumerate(pos):
t = t.replace(f'_place_holder_{i+1}_', p)
return t
def translate_command(s: str, pos: list[str]) -> str:
s = translate_exec(s)
s = translate_position(s, pos)
return s
def translate_op_script(s: str) -> str:
s = s.replace('${vyos_completion_dir}', directories['completion_dir'])
s = s.replace('${vyos_op_scripts_dir}', directories['op_mode'])
return s
def insert_node(n: Element, l: list[PathData], path=None) -> None:
# pylint: disable=too-many-locals,too-many-branches
prop: OptElement = n.find('properties')
children: OptElement = n.find('children')
command: OptElement = n.find('command')
# name is not None as required by schema
name: str = n.get('name', 'schema_error')
node_type: str = n.tag
if path is None:
path = []
path.append(name)
if node_type == 'tagNode':
path.append(f'{name}-tag_value')
help_prop: OptElement = None if prop is None else prop.find('help')
help_text = None if help_prop is None else help_prop.text
command_text = None if command is None else command.text
if command_text is not None:
command_text = translate_command(command_text, path)
comp_help = {}
if prop is not None:
che = prop.findall('completionHelp')
for c in che:
comp_list_els = c.findall('list')
comp_path_els = c.findall('path')
comp_script_els = c.findall('script')
comp_lists = []
for i in comp_list_els:
comp_lists.append(i.text)
comp_paths = []
for i in comp_path_els:
comp_paths.append(i.text)
comp_scripts = []
for i in comp_script_els:
comp_script_str = translate_op_script(i.text)
comp_scripts.append(comp_script_str)
if comp_lists:
comp_help['list'] = comp_lists
if comp_paths:
comp_help['path'] = comp_paths
if comp_scripts:
comp_help['script'] = comp_scripts
cur_node_dict = {}
cur_node_dict['name'] = name
cur_node_dict['type'] = node_type
cur_node_dict['comp_help'] = comp_help
cur_node_dict['help'] = help_text
cur_node_dict['command'] = command_text
cur_node_dict['path'] = path
cur_node_dict['children'] = []
l.append(cur_node_dict)
if children is not None:
inner_nodes = children.iterfind('*')
for inner_n in inner_nodes:
inner_path = path[:]
insert_node(inner_n, cur_node_dict['children'], inner_path)
def parse_file(file_path, l):
tree = ET.parse(file_path)
root = tree.getroot()
for n in root.iterfind('*'):
insert_node(n, l)
def main():
parser = ArgumentParser(description='generate dict from xml defintions')
parser.add_argument(
'--xml-dir',
type=str,
required=True,
help='transcluded xml op-mode-definition file',
)
args = vars(parser.parse_args())
xml_dir = abspath(args['xml_dir'])
l = []
for fname in glob.glob(f'{xml_dir}/*.xml'):
parse_file(fname, l)
with open(xml_op_tmp, 'w') as f:
json.dump(l, f, indent=2)
with open(op_ref_cache, 'w') as f:
f.write(f'op_reference = {str(l)}')
if __name__ == '__main__':
main()
|
