Track partitions and images associated to a restore
operation through a cache.json file located in the
cache partition.
cache.json example contents:
{
'images': [
{
'name': 'xxx.img',
'disk': 1,
'partition': 2
},
{
'name': 'xxx.img',
'disk': 1,
'partition': 3
}
]
}
Add class CacheDataFile to handle the cache.json
file.
Add an entry to the 'images' array each time a
restore operation is executed successfuly,
replace entries with the same disk/partition.
Remove entry to the 'images' array with image delete
operations.
Add image info to kiosk configuration. This enables
image restore operations. This information is not
retroactive, only newly restored images will enable
the restore button in Kiosk.
show IP, MAC, link speed and hostname in the top left of the Kiosk
boot view.
Adjust boot view layout to better fit the new widget.
Add get_mac_from_interface() to net.py
Add Kiosk project as a subtree of ogClient. Kiosk is
an interactive GUI featuring basic functionality to
monitor and operate ogClient withing the client through a
graphical interface written in PyQt6.
Right after ogClient launches in live mode it performs a
fork() call to launch Kiosk as an external process to
prevent Kiosk backtraces to affect ogClient.
A pair of sockets are created through socket.socketpair()
and each process is assigned one of them to leverage the
inter process communication.
API Kiosk -> ogClient:
- Poweroff: request client poweroff
{"command": "poweroff"}
- Reboot: request client reboot
{"command": "reboot"}
- Restore: restore image into a partition
{"command": "restore", "image": "windows.img", "disk": 1, "partition": 2}
- Boot: request an OS boot
{"command": "boot", "disk": 1, "partition": 2}
API ogClient -> Kiosk:
- Busy: inform about ogClient thread status
{"command": "busy", "status": True}
- Refresh: reload the theme.
{"command": "refresh"}
- close: request Kiosk termination.
{"command": "close"}
Add internationalization documentation in README
Add "CACHE" mode in image restore to only restore images
available in the cache partition.
Use set_state() function in OgRest to define the idle or busy
status and notify Kiosk about the status change.
Log as warning when efibootmgr fails to update the NVRAM.
Raise an exception when the command is not available or when
there are not enough permissions to execute. Provide contextual
information in the error message.
The GRUB entry is always set as the second boot option, assuming
PXE is first. This is not always true, as disabled entries before
PXE IPv4 can make it the first valid but not the first defined
entry in the boot order.
Move every disabled boot entry at the end of boot order.
otherwise, _get_os_entries() fails when it finds a swap partition:
(2025-01-23 17:44:30) ogClient: [ERROR] - Error generating /mnt/nvme0n1p4/EFI/grub/Boot/grub.cfg: Unable to mount /dev/nvme0n1p3 into /mnt/nvme0n1p3
Reduce interdependency between imports by checking the correct OS for
copy_windows_efi_bootloader() from the code invoking the operation.
Break circular dependency where:
probe.py imports from winreg.py
winreg.py imports from uefi.py
uefi.py imports from probe.py
Add support for both lshw -json return formats.
The json structure may follow one of the following.
output:list flag enabled:
[{content}]
output:list flag disabled:
{content}
The output:list flag was defined in the commit 2b1c730 of
https://ezix.org/src/pkg/lshw
Remove usage of hivexget as a subprocess and use Python hivex to
inspect the Windows Registry.
Use registry path constants defined in src.utils.winreg
Remove windows_is64bit() funcion as the code to identify the
architecture relies on a broken Registry query. Fixing the query
proved to be a challenge and the only implication is the removal
of the string "64 bits" at the end of the listed Windows OS
installed in each partition.
Use utility function in src.utils.winreg to make the software
inventory code more compact.
Rewrite onliner in _fill_package_set function and parse the
registry with a for loop.
Add update_live_cache() implementing the legacy script
updateBootCache()
Copy the ogvmlinuz and oginitrd.img files into cache after
a partition and format command with an available cache partition.
Translate old legacy grub scripts into grub.py
Implement ogGrubInstallMbr as install_main_grub() and
ogGrubInstallPartition as install_linux_grub().
Add grub configuration file generator through the classes
GrubConfig and MenuEntry.
Ensure EFI tree structure compatibility with legacy code.
The structure of the created folders in the ESP is non-standard,
efi binaries are usually located in the folder below the EFI/
directory.
Structure used by ogClient:
EFI/
├── grub/
│ └── Boot/
│ ├── BOOTX64.CSV
│ ├── grub.cfg
│ ├── mmx64.efi
│ ├── shimx64.efi
│ ├── BOOTX64.EFI
│ ├── grubx64.efi
│ └── ogloader.efi
...
The function _mangle_efi_folder handles the folder structure after
grub-install to comply with the location expected by ogLive.
install_linux_grub() installs a grub local to each Linux install
to enable chainloading, each grub is located in EFI/Part-xx-yy/ in
UEFI. The local linux BIOS grub in legacy scripts is unreliable,
grub-install reports a failure during the install process.
install_main_grub() installs a global grub in EFI/grub/ to show a
grub menu when the pxe boot fails. The global grub contains entries
to every installed os. No global grub is installed for BIOS
systems, a Boot partition would be required to store the grub
configuration.
python-libfdisk does not close file descriptor until the cxt
object goes out of scope.
Define get_partition_data and get_disk_data functions to isolate
the python-libfdisk logic and return the data as an object.
Improve error handling of libfdisk operaions in refresh.
Mount cache in image_create() image_restore() and cache_fetch().
Remove init_cache() and ensure /opt/opengnsys/images/ exists
within the cache mountpoint if it does not exists in cache_mount().
Add compute_md5 function in src/utils/fs.py
Remove identical md5 functions from src/live/ogOperations.py and
src/utils/tiptorrent.py
Move error checks from ogOperations.py into compute_md5 function in
src/utils/fs.py
Mount the system partition in readonly mode and check for the
hiberfil.sys file if the target system is a Windows.
Fail the image creation process if the target system is hibernated.
Reuse os_probe() function from probe.py and change the fallback
case to "unknown" to prevent OS id mismatch in ogserver.
The OS id mismatch causes the images to stop being associated with
partitions after the /refresh command.
Add python implementation of the legacy ogWindowsRegisterPartition
function.
This function configures the system partition to be considered the
new C drive after a Windows image restore.
The drive letter configuration is stored in the SYSTEM hive of
the windows registry. The node MountedDevices contains all the
configuration as key-value pairs.
The C drive key \DosDevices\C: contains a different value based on
the partitioning type.
GPT
the value is DMIO:ID: followed by the 16 byte GUID of the
partition.
Example: DMIO:ID:\xc9\xfc\x1c\x86\x13\x11O\t\xa2\x9c{/\xf1\xdf\xe4)
MBR
The value is a little endian byte sequence with 2 parts.
The first 4 bytes correspond to the disk id. The second part is
the byte offset start of the partition in that disk.
Example: \xe1\\\x9cP\x00\x00\x10j\x18\x00\x00\x00
If we format the MBR value in a more readable way we get
e1 5c 9c 50 00 00 10 6a 18 00 00 00
In this case the disk ID is 509c5ce1.
The partition offset is 186a100000.
This patch adds the following helper functions to:
- get_disk_id_bytes(): to obtain the disk identifier.
- get_part_id_bytes(): to obtain a partition identifier as UUID
for MBR or DMIO:ID format for GPT.
- get_sector_size(): to query the sector size of a specific disk.
Read /sys/class/block/{device_name}/queue/hw_sector_size to obtain the value.
This is MBR specific.
- get_partition_start_offset(): to query the start sector of a specific
partition and disk. Use sfdisk with the -J argument to get fdisk data in
json format. This is MBR specific.
Implement configure_fstab() as a replacement of ogConfigureFstab.
Create src/utils/fstab.py to implement the main fstab
configuration functions. Define two fstab helper classes,
FstabBuilder and FstabEntry.
FstabEntry
Represents each line in the fstab file.
Has the values: device, mountpoint, fstype, options, dump_code
and pass_code.
FstabBuilder
Contains a list of FstabEntry. Handles loading of a
preexisting fstab file and the serialization of multiple
FstabEntry into a file.
The fstab configuration has 3 main steps:
Root partition:
- Update the device field with the device where
the new system is installed.
Swap partition:
- Preserve all the swapfile entries in every case.
- If the filesystem has a swap partition: update the device field
in the first fstab swap entry and remove the rest swap entries
pointing to a swap partition. Only one swap partition is supported.
Create a new fstab entry if no preexisting swap entry exists.
- If the system has no swap partition remove every swap partition
entry.
EFI partition:
- Update the device field of the EFI fstab entry if it exists.
Create a new fstab entry if no preexisting EFI entry exists.
Add get_filesystem_id to disk.py to obtain the UUID.
Define every device field as a UUID. That method is more robust
than a plain device path as it works after disks being added or
removed.
instead of
Checking partition "Microsoft Basic Data"...
Checking partition "EFI System"...
show
Searching EFI partition...
EFI partition found at /dev/sda1
and refer to EFI partition consistently in logs.
Alejandro Sirgo Rica
OpenGnSys Support Team