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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
|
# Copyright 2022 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/>.
from pathlib import Path
from re import compile as re_compile
from tempfile import TemporaryDirectory
from typing import TypedDict
from vyos import version
from vyos.system import disk, grub
# Define variables
GRUB_DIR_MAIN: str = '/boot/grub'
GRUB_DIR_VYOS: str = f'{GRUB_DIR_MAIN}/grub.cfg.d'
CFG_VYOS_VARS: str = f'{GRUB_DIR_VYOS}/20-vyos-defaults-autoload.cfg'
GRUB_DIR_VYOS_VERS: str = f'{GRUB_DIR_VYOS}/vyos-versions'
# prepare regexes
REGEX_KERNEL_CMDLINE: str = r'^BOOT_IMAGE=/(?P<boot_type>boot|live)/((?P<image_version>.+)/)?vmlinuz.*$'
# structures definitions
class ImageDetails(TypedDict):
name: str
version: str
disk_ro: int
disk_rw: int
disk_total: int
class BootDetails(TypedDict):
image_default: str
image_running: str
images_available: list[str]
console_type: str
console_num: int
def bootmode_detect() -> str:
"""Detect system boot mode
Returns:
str: 'bios' or 'efi'
"""
if Path('/sys/firmware/efi/').exists():
return 'efi'
else:
return 'bios'
def get_version(image_name: str, root_dir: str) -> str:
"""Extract version name from rootfs based on image name
Args:
image_name (str): a name of image (from boot menu)
root_dir (str): a root directory of persistence storage
Returns:
str: version name
"""
squashfs_file: str = next(
Path(f'{root_dir}/boot/{image_name}').glob('*.squashfs')).as_posix()
with TemporaryDirectory() as squashfs_mounted:
disk.partition_mount(squashfs_file, squashfs_mounted, 'squashfs')
version_file: str = Path(
f'{squashfs_mounted}/opt/vyatta/etc/version').read_text()
disk.partition_umount(squashfs_file)
version_name: str = version_file.lstrip('Version: ').strip()
return version_name
def get_details(image_name: str, root_dir: str = '') -> ImageDetails:
"""Return information about image
Args:
image_name (str): a name of an image
root_dir (str, optional): an optional path to the root directory.
Defaults to ''.
Returns:
ImageDetails: a dictionary with details about an image (name, size)
"""
if not root_dir:
root_dir = disk.find_persistence()
image_version: str = get_version(image_name, root_dir)
image_path: Path = Path(f'{root_dir}/boot/{image_name}')
image_path_rw: Path = Path(f'{root_dir}/boot/{image_name}/rw')
image_disk_ro: int = int()
for item in image_path.iterdir():
if not item.is_symlink():
image_disk_ro += item.stat().st_size
image_disk_rw: int = int()
for item in image_path_rw.rglob('*'):
if not item.is_symlink():
image_disk_rw += item.stat().st_size
image_details: ImageDetails = {
'name': image_name,
'version': image_version,
'disk_ro': image_disk_ro,
'disk_rw': image_disk_rw,
'disk_total': image_disk_ro + image_disk_rw
}
return image_details
def get_running_image() -> str:
"""Find currently running image name
Returns:
str: image name
"""
running_image: str = ''
regex_filter = re_compile(REGEX_KERNEL_CMDLINE)
cmdline: str = Path('/proc/cmdline').read_text()
running_image_result = regex_filter.match(cmdline)
if running_image_result:
running_image: str = running_image_result.groupdict().get(
'image_version', '')
# we need to have a fallbak for live systems
if not running_image:
running_image: str = version.get_version()
return running_image
def get_default_image(root_dir: str = '') -> str:
"""Get default boot entry
Args:
root_dir (str, optional): an optional path to the root directory.
Defaults to empty.
Returns:
str: a version name
"""
if not root_dir:
root_dir = disk.find_persistence()
vars_file: str = f'{root_dir}/{CFG_VYOS_VARS}'
vars_current: dict[str, str] = grub.vars_read(vars_file)
default_uuid: str = vars_current.get('default', '')
if default_uuid:
images_list: list[str] = grub.version_list(root_dir)
for image_name in images_list:
if default_uuid == grub.gen_version_uuid(image_name):
return image_name
return ''
else:
return ''
def validate_name(image_name: str) -> bool:
"""Validate image name
Args:
image_name (str): suggested image name
Returns:
bool: validation result
"""
regex_filter = re_compile(r'^[\w\.+-]{1,32}$')
if regex_filter.match(image_name):
return True
return False
def is_live_boot() -> bool:
"""Detect live booted system
Returns:
bool: True if the system currently booted in live mode
"""
regex_filter = re_compile(REGEX_KERNEL_CMDLINE)
cmdline: str = Path('/proc/cmdline').read_text()
running_image_result = regex_filter.match(cmdline)
if running_image_result:
boot_type: str = running_image_result.groupdict().get('boot_type', '')
if boot_type == 'live':
return True
return False
|
