def test_partclone_parsing_dd_img(self):
partclone_info_output_dd_image = """Partclone v0.3.13 http://partclone.org
Showing info of image (-)
This is not partclone image.
Partclone fail, please check /var/log/partclone.log !"""
partclone_info_dict = Partclone.parse_partclone_info_output(partclone_info_output_dd_image)
self.assertDictEqual({}, partclone_info_dict)
def test_partclone_info_parsing(self):
partclone_info_output = """Partclone v0.3.13 http://partclone.org
Showing info of image (-)
File system: NTFS
Device size: 113.2 MB = 27647 Blocks
Space in use: 2.6 MB = 625 Blocks
Free Space: 110.7 MB = 27022 Blocks
Block size: 4096 Byte
image format: 0001
created on a: n/a
with partclone: n/a
bitmap mode: BYTE
checksum algo: CRC32_0001
checksum size: 4
blocks/checksum: 1
reseed checksum: no
"""
partclone_info_dict = Partclone.parse_partclone_info_output(
partclone_info_output)
expected_partclone_info_dict = {
'filesystem': "NTFS",
'size': {
'enduser_readable': "113.2 MB",
'blocks': 27647,
'bytes': 113242112
},
'used_space': {
'enduser_readable': "2.6 MB",
'blocks': 625,
'bytes': 2560000
},
'free_space': {
'enduser_readable': "110.7 MB",
'blocks': 27022,
'bytes': 110682112
},
'block_size': 4096,
'image_format': "0001",
"created": "n/a",
"with_partclone": "n/a",
"bitmap_mode": "BYTE",
"checksum_algo": "CRC32_0001",
"checksum_size": 4,
"blocks/checksum": 1,
"reseed_checksum": "False",
}
# pp = pprint.PrettyPrinter(indent=4)
# pp.pprint(partclone_info_dict)
self.assertDictEqual(expected_partclone_info_dict, partclone_info_dict)
def test_partclone_restore_parsing_short(self):
partclone_restore_example_contents = """Partclone v0.3.13 http://partclone.org
Starting to restore image (-) to device (/dev/sdh5)
Calculating bitmap... Please wait...
done!
File system: EXTFS
Device size: 52.4 MB = 12800 Blocks
Space in use: 5.9 MB = 1437 Blocks
Free Space: 46.5 MB = 11363 Blocks
Block size: 4096 Byte
Elapsed: 00:00:02, Remaining: 00:00:00, Completed: 100.00%, Rate: 176.58MB/min,
current block: 1437, total block: 12800, Complete: 100.00%
Total Time: 00:00:02, Ave. Rate: 176.6MB/min, 100.00% completed!
Syncing... OK!
Partclone successfully restored the image (-) to the device (/dev/sdh5)
Cloned successfully."""
for line in partclone_restore_example_contents.splitlines():
partclone_dict = Partclone.parse_partclone_output(line)
if len(partclone_dict) != 0:
print(partclone_dict)
def test_partclone_restore_parsing_long(self):
partclone_example_contents = """
Partclone v0.3.13 http://partclone.org
Starting to restore image (-) to device (/dev/sdc5)
Calculating bitmap... Please wait...
done!
File system: NTFS
Device size: 983.6 MB = 240127 Blocks
Space in use: 5.4 MB = 1320 Blocks
Free Space: 978.2 MB = 238807 Blocks
Block size: 4096 Byte
Elapsed: 00:00:01, Remaining: 00:01:39, Completed: 1.00%, 0.00byte/min,
Elapsed: 00:00:02, Remaining: 00:03:18, Completed: 1.00%, 0.00byte/min,
Elapsed: 00:00:04, Remaining: 00:06:36, Completed: 1.00%, 0.00byte/min,
Elapsed: 00:00:06, Remaining: 00:09:54, Completed: 1.00%, 0.00byte/min,
Elapsed: 00:00:08, Remaining: 00:13:12, Completed: 1.00%, 0.00byte/min,
Elapsed: 00:00:10, Remaining: 00:16:30, Completed: 1.00%, 0.00byte/min,
Elapsed: 00:00:12, Remaining: 00:19:48, Completed: 1.00%, 0.00byte/min,
Elapsed: 00:00:14, Remaining: 00:23:06, Completed: 1.00%, 0.00byte/min,
Elapsed: 00:00:16, Remaining: 00:26:24, Completed: 1.00%, 0.00byte/min,
Elapsed: 00:00:18, Remaining: 00:29:42, Completed: 1.00%, 0.00byte/min,
Elapsed: 00:00:20, Remaining: 00:33:00, Completed: 1.00%, 0.00byte/min,
Elapsed: 00:00:22, Remaining: 00:01:31, Completed: 19.39%, 2.86MB/min,
Elapsed: 00:00:24, Remaining: 00:01:39, Completed: 19.39%, 2.62MB/min,
Elapsed: 00:00:26, Remaining: 00:01:48, Completed: 19.39%, 2.42MB/min,
Elapsed: 00:00:28, Remaining: 00:01:56, Completed: 19.39%, 2.25MB/min,
Elapsed: 00:00:30, Remaining: 00:02:04, Completed: 19.39%, 2.10MB/min,
Elapsed: 00:00:32, Remaining: 00:02:13, Completed: 19.39%, 1.97MB/min,
Elapsed: 00:00:34, Remaining: 00:02:21, Completed: 19.39%, 1.85MB/min,
Elapsed: 00:00:36, Remaining: 00:02:29, Completed: 19.39%, 1.75MB/min,
Elapsed: 00:00:38, Remaining: 00:02:37, Completed: 19.39%, 1.66MB/min,
Elapsed: 00:00:40, Remaining: 00:02:46, Completed: 19.39%, 1.57MB/min,
Elapsed: 00:00:42, Remaining: 00:01:06, Completed: 38.79%, 3.00MB/min,
Elapsed: 00:00:44, Remaining: 00:01:09, Completed: 38.79%, 2.86MB/min,
Elapsed: 00:00:46, Remaining: 00:01:12, Completed: 38.79%, 2.74MB/min,
Elapsed: 00:00:48, Remaining: 00:01:15, Completed: 38.79%, 2.62MB/min,
Elapsed: 00:00:50, Remaining: 00:01:18, Completed: 38.79%, 2.52MB/min,
Elapsed: 00:00:52, Remaining: 00:01:22, Completed: 38.79%, 2.42MB/min,
Elapsed: 00:00:54, Remaining: 00:01:25, Completed: 38.79%, 2.33MB/min,
Elapsed: 00:00:56, Remaining: 00:01:28, Completed: 38.79%, 2.25MB/min,
Elapsed: 00:00:58, Remaining: 00:01:31, Completed: 38.79%, 2.17MB/min,
Elapsed: 00:01:00, Remaining: 00:01:34, Completed: 38.79%, 2.10MB/min,
Elapsed: 00:01:02, Remaining: 00:00:44, Completed: 58.18%, 3.04MB/min,
Elapsed: 00:01:04, Remaining: 00:00:46, Completed: 58.18%, 2.95MB/min,
Elapsed: 00:01:06, Remaining: 00:00:47, Completed: 58.18%, 2.86MB/min,
Elapsed: 00:01:08, Remaining: 00:00:48, Completed: 58.18%, 2.78MB/min,
Elapsed: 00:01:10, Remaining: 00:00:50, Completed: 58.18%, 2.70MB/min,
Elapsed: 00:01:12, Remaining: 00:00:51, Completed: 58.18%, 2.62MB/min,
Elapsed: 00:01:14, Remaining: 00:00:53, Completed: 58.18%, 2.55MB/min,
Elapsed: 00:01:16, Remaining: 00:00:54, Completed: 58.18%, 2.48MB/min,
Elapsed: 00:01:18, Remaining: 00:00:56, Completed: 58.18%, 2.42MB/min,
Elapsed: 00:01:20, Remaining: 00:00:57, Completed: 58.18%, 2.36MB/min,
Elapsed: 00:01:22, Remaining: 00:00:23, Completed: 77.58%, 3.07MB/min,
Elapsed: 00:01:24, Remaining: 00:00:24, Completed: 77.58%, 3.00MB/min,
Elapsed: 00:01:26, Remaining: 00:00:24, Completed: 77.58%, 2.93MB/min,
Elapsed: 00:01:28, Remaining: 00:00:25, Completed: 77.58%, 2.86MB/min,
Elapsed: 00:01:30, Remaining: 00:00:26, Completed: 77.58%, 2.80MB/min,
Elapsed: 00:01:32, Remaining: 00:00:26, Completed: 77.58%, 2.74MB/min,
Elapsed: 00:01:34, Remaining: 00:00:27, Completed: 77.58%, 2.68MB/min,
Elapsed: 00:01:36, Remaining: 00:00:27, Completed: 77.58%, 2.62MB/min,
Elapsed: 00:01:38, Remaining: 00:00:28, Completed: 77.58%, 2.57MB/min,
Elapsed: 00:01:40, Remaining: 00:00:28, Completed: 77.58%, 2.52MB/min,
Elapsed: 00:01:42, Remaining: 00:00:29, Completed: 77.58%, 2.47MB/min,
Elapsed: 00:01:44, Remaining: 00:00:03, Completed: 96.97%, 3.02MB/min,
Elapsed: 00:01:46, Remaining: 00:00:00, Completed: 100.00%, Rate: 3.06MB/min
current block: 121264, total block: 240127, Complete: 100.00%
Total Time: 00:01:46, Ave. Rate: 3.1MB/min, 100.00% completed!
Syncing... OK!
Partclone successfully restored the image (-) to the device (/dev/sdc5)
Cloned successfully.
"""
for line in partclone_example_contents.splitlines():
partclone_dict = Partclone.parse_partclone_output(line)
if len(partclone_dict) != 0:
print(partclone_dict)
def __init__(self, absolute_path, enduser_filename, filename):
# Redo Backup images never need decryption
self.is_needs_decryption = False
# Path to ".backup" file
self.absolute_path = absolute_path
self.enduser_filename = enduser_filename
self.proc = collections.OrderedDict()
env = Utility.get_env_C_locale()
print("Reading backup : " + absolute_path)
dirname = os.path.dirname(absolute_path)
self.warning_dict = {}
if filename.endswith(".backup"):
prefix = filename.split(".backup")[0]
print("prefix: " + prefix)
else:
raise ValueError("Expected Rescuezilla backup to end with .backup: " + absolute_path)
rescuezilla_version_abs_path = os.path.join(dirname, prefix + ".rescuezilla.backup_version")
if not os.path.exists(rescuezilla_version_abs_path):
self.image_format = "REDOBACKUP_0.9.8_1.0.4_FORMAT"
else:
self.image_format = "RESCUEZILLA_1.5_FORMAT"
self.rescuezilla_version = Utility.read_file_into_string(rescuezilla_version_abs_path).strip()
print("Backup originally created with Rescuezilla version: " + self.rescuezilla_version)
self.last_modified_timestamp = str(time.ctime(os.stat(absolute_path).st_mtime))
print("Last modified timestamp " + self.last_modified_timestamp)
self.short_device_node_partition_list = Utility.read_linebreak_delimited_file_into_list(absolute_path)
print("Source_partitions: " + str(self.short_device_node_partition_list))
self.backup_version = Utility.read_file_into_string(absolute_path).strip()
print("Backup version: " + str(self.backup_version))
self.size_bytes = int(Utility.read_file_into_string(os.path.join(dirname, prefix + ".size").strip()))
print("Size: " + str(self.size_bytes))
# Covert size in bytes to KB/MB/GB/TB as relevant
self.enduser_readable_size = size(int(self.size_bytes), system=alternative)
self.mbr_absolute_path = os.path.join(dirname, prefix + ".mbr")
# Get the size of the MBR image because a Sourceforge user named chcatzsf released two unofficial
# German-language Redo Backup and Recovery update based on Ubuntu 13.10 and Ubuntu 14.04. These two versions
# incorrectly created 512 byte Master Boot Record backup images. More information [1].
#
# [1] https://github.com/rescuezilla/rescuezilla/wiki/Bugs-in-unofficial-Redo-Backup-updates#bugs-in-chcatzsfs-ubuntu-1310-and-1404-releases-german-language-only
self.mbr_size = int(os.stat(self.mbr_absolute_path).st_size)
if self.mbr_size == 512:
# Explain the situation to users with this issue and link to further information about how the GRUB boot
# loader can be regenerated, and confirm whether they wish to proceed.
truncated_bootloader_bug_url = "https://github.com/rescuezilla/rescuezilla/wiki/Bugs-in-unofficial-Redo-Backup-updates#bugs-in-chcatzsfs-ubuntu-1310-and-1404-releases-german-language-only";
# Context for translators: Two popular unofficial Redo Backup v1.0.4 updates by Sourceforge user chcatzsf
# have major bugs where bootloaders like GRUB are not not fully backed up, so Linux-based operating
# cannot boot after a restore. This bug only affected those two updates (German-language only) and the
# problem can be fixed with careful manual intervention. Translating this message into languages other
# than English and German is not required. Full details in:
# https://github.com/rescuezilla/rescuezilla/wiki/Bugs-in-unofficial-Redo-Backup-updates#bugs-in
# -chcatzsfs-ubuntu-1310-and-1404-releases-german-language-only
self.warning_dict[absolute_path] = _("The backup's bootloader data is shorter than expected. This happens with backups created by an unofficial Redo Backup update. If the backup contained certain bootloaders like GRUB, the restored hard drive will not boot correctly without a manual fix. All data is still fully recoverable but manual intervention may required to restore the bootloader. Please consult {url} for information and assistance. The destination drive has not yet been modified. Do you wish to continue with the restore?").format(url=truncated_bootloader_bug_url)
self.sfdisk_absolute_path = os.path.join(dirname, prefix + ".sfdisk")
sfdisk_string = Utility.read_file_into_string(self.sfdisk_absolute_path).strip()
print("sfdisk: " + str(sfdisk_string))
self.sfdisk_dict = {}
# Louvetch's English and French Redo Backup and Recovery update based on Ubuntu 16.04 (Xenial) creates empty
# sfdisk partition table file for both MBR and GPT disks. More information [1]
# [1] https://github.com/rescuezilla/rescuezilla/wiki/Bugs-in-unofficial-Redo-Backup-updates#bugs-in-louvetchs-ubuntu-1604-releases
if sfdisk_string == "":
empty_sfdisk_bug_url = "https://github.com/rescuezilla/rescuezilla/wiki/Bugs-in-unofficial-Redo-Backup-updates#bugs-in-louvetchs-ubuntu-1604-releases"
# Context for translators: The two popular unofficial updates of Redo Backup v1.0.4 by Sourceforge user louvetch have a major bug.
# This major bug affected both the English language and French language versions of this unofficial update. All data can be restored with careful
# manual intervention. Given the popularity of those unofficial updates, translating this error message is still important.
self.warning_dict[absolute_path] = _("The backup's extended partition information is empty or missing. This happens with incomplete backups created by an unofficial Redo Backup update. If the backup contains extended partitions, these will not restore correctly. All data is still fully recoverable but manual intervention is required to fully restore the extended partitions. Please consult {url} for information and assistance. The destination drive has not yet been modified. Do you wish to continue with the restore?").format(url=empty_sfdisk_bug_url)
else:
self.sfdisk_dict = Sfdisk.parse_sfdisk_dump_output(sfdisk_string)
# Cannot rely on sfdisk drive name due to some Redo Backup versions not populating this file correctly.
if 'device' in self.sfdisk_dict.keys():
self.short_device_node_disk_list = [self.sfdisk_dict['device']]
else:
self.short_device_node_disk_list = ["unknown"]
# The NVMe drive handling on Rescuezilla v1.0.5.1+ set the drive name in the .backup file start with "sdz" to
# preserve the ability to restore with older versions of Rescuezilla (which read the source drive). Since v2.0,
# this string is used as a key into sfdisk partitions, so the ".backup" partition list such containing elements
# like "sdz3" needs to be renamed to eg, "nvme0n1p3" here to preserve full backwards compatibility.
if 'partitions' in self.sfdisk_dict.keys() and len(self.sfdisk_dict['partitions'].keys()) > 1:
# Long drive node extracted from sfdisk dictionary
sfdisk_long_drive_node = list(self.sfdisk_dict['partitions'].keys())[0]
actual_base_device_node, first_partition_number = Utility.split_device_string(sfdisk_long_drive_node)
for i in range(len(self.short_device_node_partition_list)):
node_to_potentially_rename = self.short_device_node_partition_list[i]
if node_to_potentially_rename.startswith("sdz") and actual_base_device_node != "sdz":
# This node is renamed, and the list is updated.
fake_base_device_node, actual_partition_number = Utility.split_device_string(node_to_potentially_rename)
corrected_long_device_node = Utility.join_device_string(actual_base_device_node, actual_partition_number)
corrected_short_device_node = re.sub('/dev/', '', corrected_long_device_node)
self.short_device_node_partition_list[i] = corrected_short_device_node
self.partition_restore_command_dict = collections.OrderedDict()
self.partclone_info_dict = collections.OrderedDict([])
for short_device_node in self.short_device_node_partition_list:
base_device_node, partition_number = Utility.split_device_string(short_device_node)
image_match_string = os.path.join(dirname, prefix + "_part" + str(partition_number) + ".*")
# Get absolute path partition images. Eg, [/path/to/20200813_part3.000, /path/to/20200813_part3.001 etc]
abs_partclone_image_list = glob.glob(image_match_string)
# Sort by alphabetical sort. Lexical sort not required here because fixed number of digits (so no risk
# of "1, 10, 2, 3" issues)
abs_partclone_image_list.sort()
if len(abs_partclone_image_list) == 0:
raise Exception("Unable to match any partclone images associated with " + short_device_node + ": " + image_match_string)
self.partition_restore_command_dict[partition_number] = {'abs_image_glob': abs_partclone_image_list}
command = "partclone"
# Rescuezilla v1.0.5 format creates partition to filesystem mapping files
command_filepath = os.path.join(dirname, prefix + ".partclone.command.part" + str(partition_number))
if os.path.isfile(command_filepath):
command = Utility.read_file_into_string(command_filepath).strip()
print(str(short_device_node) + ": " + command)
self.partition_restore_command_dict[partition_number]['restore_binary'] = command
# Get partclone.info
cat_cmd_list = ["cat"] + abs_partclone_image_list
pigz_cmd_list = ["pigz", "--decompress", "--stdout"]
partclone_info_cmd_list = ["partclone.info", "--source", "-"]
Utility.print_cli_friendly("partclone ", [cat_cmd_list, pigz_cmd_list, partclone_info_cmd_list])
self.proc['cat_partclone' + short_device_node] = subprocess.Popen(cat_cmd_list, stdout=subprocess.PIPE, env=env,
encoding='utf-8')
self.proc['pigz' + short_device_node] = subprocess.Popen(pigz_cmd_list,
stdin=self.proc['cat_partclone' + short_device_node].stdout,
stdout=subprocess.PIPE, env=env, encoding='utf-8')
self.proc['partclone_info' + short_device_node] = subprocess.Popen(partclone_info_cmd_list,
stdin=self.proc['pigz' + short_device_node].stdout,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE, env=env,
encoding='utf-8')
self.proc['cat_partclone' + short_device_node].stdout.close() # Allow p1 to receive a SIGPIPE if p2 exits.
self.proc['pigz' + short_device_node].stdout.close() # Allow p1 to receive a SIGPIPE if p2 exits.
output, err = self.proc['partclone_info' + short_device_node].communicate()
print("partclone_info: Exit output " + str(output) + "stderr " + str(err))
self.partclone_info_dict[partition_number] = Partclone.parse_partclone_info_output(err)
if len(self.partclone_info_dict[partition_number]) == 0:
# If unable to read the partclone.info output, treat this as a dd image (see unit test for
# partclone.info example output for this case).
print(self.absolute_path + ": Could not read partclone info dict for " + short_device_node + ". Treating it as a dd image.")
self.partclone_info_dict[partition_number] = {'filesystem': "dd"}
def do_verify(self):
self.requested_stop = False
# Clear proc dictionary
self.proc.clear()
self.summary_message_lock = threading.Lock()
self.summary_message = ""
env = Utility.get_env_C_locale()
self.logger = Logger("/tmp/rescuezilla.log." +
datetime.now().strftime("%Y%m%dT%H%M%S") + ".txt")
GLib.idle_add(self.update_progress_bar, 0)
# Calculate the size across all selected images
all_images_total_size_estimate = 0
all_images_num_partitions = 0
for image in self.image_list:
if not isinstance(image, FsArchiverImage):
# Determine the size of all partition across all images. This is used for the weighted progress bar.
all_images_total_size_estimate += image.size_bytes
all_images_num_partitions += len(
image.image_format_dict_dict.keys())
cumulative_bytes = 0
image_number = 0
total_partition_number = 0
for image in self.image_list:
image_number += 1
image_verify_message = _("Verifying {image_name}").format(
image_name=image.absolute_path)
self.logger.write(image_verify_message)
GLib.idle_add(self.display_status, image_verify_message,
image_verify_message)
if self.requested_stop:
GLib.idle_add(self.completed_verify, False,
_("User requested operation to stop."))
return
with self.summary_message_lock:
self.summary_message += image.absolute_path + "\n"
if isinstance(image, FsArchiverImage):
with self.summary_message_lock:
self.summary_message += _(
"⚠"
) + " " + "Verifying FsArchiver images not yet supported\n"
continue
if isinstance(image, MetadataOnlyImage):
with self.summary_message_lock:
self.summary_message += _(
"⚠") + " " + "Verifying VM images not yet supported\n"
continue
if image.is_needs_decryption:
with self.summary_message_lock:
self.summary_message += _(
"⚠"
) + " " + "Verifying encrypted images not supported. Carefully decrypting on the command-line may be a temporary workaround.\n"
continue
if image.has_partition_table():
mbr_path = image.get_absolute_mbr_path()
mbr_size = int(os.stat(mbr_path).st_size)
# Some image formats (like Clonezilla) have post MBR gap separate from the actual MBR
post_mbr_size = 0
if 'absolute_path' in image.post_mbr_gap_dict.keys():
post_mbr_size += int(
os.stat(
image.post_mbr_gap_dict['absolute_path']).st_size)
if (mbr_size + post_mbr_size) <= 512:
if Sfdisk.has_dos_partition_table(
image.normalized_sfdisk_dict):
self.summary_message += _("❌") + " " + _(
"The backup's bootloader data is shorter than expected. If the backup contained certain bootloaders like GRUB, during a restore operation Rescuezilla will try and re-install the bootloader."
) + "\n"
else:
self.summary_message += _("✔") + " " + _(
"MBR backup appears correct.") + "\n"
else:
self.summary_message += _("No partition table found.") + "\n"
if image.normalized_sfdisk_dict['file_length'] == 0:
self.summary_message += _("❌") + " " + _(
"Sfdisk partition table file is empty or missing.") + "\n"
else:
self.summary_message += _("✔") + " " + _(
"Sfdisk partition table file is present.") + "\n"
for partition_key in image.image_format_dict_dict.keys():
total_partition_number += 1
if self.requested_stop:
GLib.idle_add(self.completed_verify, False,
_("User requested operation to stop."))
return
if 'estimated_size_bytes' in image.image_format_dict_dict[
partition_key].keys():
partition_estimated_size_bytes = image.image_format_dict_dict[
partition_key]['estimated_size_bytes']
elif 'absolute_filename_glob_list' in image.image_format_dict_dict[
partition_key].keys():
# TODO: Move this to the image scanning step.
print("Calculating estimated size from file size")
partition_estimated_size_bytes = Utility.count_total_size_of_files_on_disk(
image.image_format_dict_dict[partition_key]
['absolute_filename_glob_list'], "uncompressed")
else:
partition_estimated_size_bytes = 0
filesystem_verify_message = _("Partition {partition}").format(
partition=partition_key)
self.logger.write(image_verify_message)
GLib.idle_add(
self.display_status,
image_verify_message + " " + filesystem_verify_message,
filesystem_verify_message)
total_progress_float = Utility.calculate_progress_ratio(
current_partition_completed_percentage=0,
current_partition_bytes=partition_estimated_size_bytes,
cumulative_bytes=cumulative_bytes,
total_bytes=all_images_total_size_estimate,
image_number=total_partition_number,
num_partitions=all_images_num_partitions)
GLib.idle_add(self.update_progress_bar, total_progress_float)
if 'type' in image.image_format_dict_dict[partition_key].keys(
):
image_type = image.image_format_dict_dict[partition_key][
'type']
if image_type == 'swap':
self.summary_message += _(
"⚠"
) + " " + partition_key + ": verifying swap partition images not yet supported.\n"
cumulative_bytes += partition_estimated_size_bytes
continue
if image_type == 'missing':
self.summary_message += _(
"❌"
) + " " + partition_key + ": partition is missing.\n"
cumulative_bytes += partition_estimated_size_bytes
continue
if 'dd' == image_type or image.image_format_dict_dict[
partition_key]['binary'] == "partclone.dd":
self.summary_message += _(
"⚠"
) + " " + partition_key + ": verifying raw dd images not yet supported.\n"
cumulative_bytes += partition_estimated_size_bytes
continue
elif 'partclone' == image_type:
cat_cmd_list = ["cat"] + image.image_format_dict_dict[
partition_key]['absolute_filename_glob_list']
decompression_cmd_list = Utility.get_decompression_command_list(
image.image_format_dict_dict[partition_key]
['compression'])
verify_command_list = [
"partclone.chkimg", "--source", "-"
]
elif 'partimage' == image_type:
self.summary_message += _(
"⚠"
) + " " + partition_key + ": verifying PartImage images not yet supported.\n"
cumulative_bytes += partition_estimated_size_bytes
continue
elif 'ntfsclone' == image_type:
self.summary_message += _(
"⚠"
) + " " + partition_key + ": Verifying NTFSclone images not yet supported.\n"
cumulative_bytes += partition_estimated_size_bytes
continue
elif "unknown" != image_type:
self.summary_message += _(
"❌"
) + " " + partition_key + ": unknown image type.\n"
cumulative_bytes += partition_estimated_size_bytes
continue
else:
message = "Unhandled type" + image_type + " from " + partition_key
self.logger.write(message)
with self.summary_message_lock:
self.summary_message += message + "\n"
cumulative_bytes += partition_estimated_size_bytes
continue
flat_command_string = Utility.print_cli_friendly(
image_type + " command ", [
cat_cmd_list, decompression_cmd_list,
verify_command_list
])
verify_cat_proc_key = 'cat_' + partition_key
self.proc[verify_cat_proc_key] = subprocess.Popen(
cat_cmd_list,
stdout=subprocess.PIPE,
env=env,
encoding='utf-8')
verify_decompression_proc_key = 'decompression_' + image.absolute_path + "_" + partition_key
self.proc[
verify_decompression_proc_key] = subprocess.Popen(
decompression_cmd_list,
stdin=self.proc[verify_cat_proc_key].stdout,
stdout=subprocess.PIPE,
env=env,
encoding='utf-8')
verify_chkimg_proc_key = image_type + '_verify_' + image.absolute_path + "_" + partition_key
self.proc[verify_chkimg_proc_key] = subprocess.Popen(
verify_command_list,
stdin=self.proc[verify_decompression_proc_key].stdout,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
env=env,
encoding='utf-8')
# Process partclone output. Partclone outputs an update every 3 seconds, so processing the data
# on the current thread, for simplicity.
# Poll process.stdout to show stdout live
proc_stdout = ""
proc_stderr = ""
while True:
if self.requested_stop:
GLib.idle_add(
self.completed_verify, False,
_("User requested operation to stop."))
return False, _(
"User requested operation to stop.")
output = self.proc[
verify_chkimg_proc_key].stderr.readline()
proc_stderr += output
if self.proc[verify_chkimg_proc_key].poll(
) is not None:
break
if output and ("partclone" == image_type
or "dd" == image_type):
temp_dict = Partclone.parse_partclone_output(
output)
if 'completed' in temp_dict.keys():
total_progress_float = Utility.calculate_progress_ratio(
current_partition_completed_percentage=
temp_dict['completed'] / 100.0,
current_partition_bytes=
partition_estimated_size_bytes,
cumulative_bytes=cumulative_bytes,
total_bytes=all_images_total_size_estimate,
image_number=total_partition_number,
num_partitions=len(
image.image_format_dict_dict[
partition_key].keys()))
GLib.idle_add(self.update_progress_bar,
total_progress_float)
if 'remaining' in temp_dict.keys():
GLib.idle_add(
self.update_verify_progress_status,
filesystem_verify_message + "\n\n" +
output)
elif "partimage" == image_type:
self.display_status(
"partimage: " + filesystem_verify_message, "")
elif "ntfsclone" == image_type:
self.display_status(
"ntfsclone: " + filesystem_verify_message, "")
rc = self.proc[verify_chkimg_proc_key].poll()
self.proc[verify_cat_proc_key].stdout.close(
) # Allow p1 to receive a SIGPIPE if p2 exits.
if "unknown" != image_type:
self.proc[verify_decompression_proc_key].stdout.close(
) # Allow p2 to receive a SIGPIPE if p3 exits.
stdout, stderr = self.proc[
verify_chkimg_proc_key].communicate()
rc = self.proc[verify_chkimg_proc_key].returncode
proc_stdout += stdout
proc_stderr += stderr
self.logger.write("Exit output " + str(rc) + ": " +
str(proc_stdout) + "stderr " +
str(proc_stderr))
if self.proc[verify_chkimg_proc_key].returncode != 0:
partition_summary = _("❌") + " " + _(
"Unable to verify.") + _(
"Partition {partition_number}").format(
partition_number=partition_key) + "\n"
extra_info = "\nThe command used internally was:\n\n" + flat_command_string + "\n\n" + "The output of the command was: " + str(
proc_stdout) + "\n\n" + str(proc_stderr)
decompression_stderr = self.proc[
verify_decompression_proc_key].stderr
if decompression_stderr is not None and decompression_stderr != "":
extra_info += "\n\n" + decompression_cmd_list[
0] + " stderr: " + decompression_stderr
GLib.idle_add(
ErrorMessageModalPopup.
display_nonfatal_warning_message, self.builder,
partition_summary + extra_info)
with self.summary_message_lock:
self.summary_message += partition_summary
cumulative_bytes += partition_estimated_size_bytes
continue
else:
self.summary_message += _("✔") + _(
"{partition}: filesystem image successfully verified."
).format(partition=partition_key) + "\n"
cumulative_bytes += partition_estimated_size_bytes
continue
cumulative_bytes += partition_estimated_size_bytes
with self.summary_message_lock:
self.summary_message += "\n\n"
GLib.idle_add(self.completed_verify, True, "")
return
def __init__(self, absolute_fogproject_img_path, enduser_filename,
filename):
self.image_format = "FOGPROJECT_FORMAT"
self.absolute_path = absolute_fogproject_img_path
self.enduser_filename = enduser_filename
self.user_notes = ""
self.warning_dict = {}
# Clonezilla format
self.ebr_dict = {}
self.efi_nvram_dat_absolute_path = None
self.short_device_node_partition_list = []
self.short_device_node_disk_list = []
self.lvm_vg_dev_dict = {}
self.lvm_logical_volume_dict = {}
self.sfdisk_chs_dict = None
self.dev_fs_dict = {}
self.size_bytes = 0
self.enduser_readable_size = ""
self.is_needs_decryption = False
self.normalized_sfdisk_dict = {
'absolute_path': None,
'sfdisk_dict': {
'partitions': {}
},
'file_length': 0
}
self.parted_dict = {'partitions': {}}
self.post_mbr_gap_dict = {}
if filename.endswith(".partitions") and not filename.endswith(
".minimum.partitions"):
prefix = filename.split(".partitions")[0]
print("prefix: " + prefix)
else:
raise ValueError(
"Expected FOG Project backup to end with .partition: " +
absolute_fogproject_img_path)
statbuf = os.stat(self.absolute_path)
self.last_modified_timestamp = format_datetime(
datetime.fromtimestamp(statbuf.st_mtime))
print("Last modified timestamp " + self.last_modified_timestamp)
dir = Path(absolute_fogproject_img_path).parent.as_posix()
print("FOG Project directory : " + dir)
dirname = os.path.dirname(absolute_fogproject_img_path)
# FogProject has its main sfdisk file named eg, 'd1.partitions', but it may also have an unmodified sfdisk
# file named eg, "d1.minimum.partitions). This approach is apparently used to support restoring to disks
# smaller than the original. Rescuezilla intends to implement something similar [1], but for now we always
# use the original, unmodified file (which may be "d1.partitions" if the FOG Project's resize checkbox was not
# ticked during backup).
#
# [1] https://github.com/rescuezilla/rescuezilla/issues/18
minimum_partitions_sfdisk_path = os.path.join(
dir, prefix + ".minimum.partitions")
if os.path.exists(minimum_partitions_sfdisk_path):
# TODO: Implement FOG Project's intelligent partition resizing. [1] Rescuezilla has growing filesystems,
# TODO: but not yet modifying partitions.
# [1] https://github.com/rescuezilla/rescuezilla/issues/18
print(
"Found minimum partitions, but ignoring until partition resize implemented"
)
sfdisk_absolute_path = absolute_fogproject_img_path
self.normalized_sfdisk_dict = Sfdisk.generate_normalized_sfdisk_dict(
sfdisk_absolute_path, self)
# FOG Project images sometimes contains a file named eg, "d1.original.fstypes" which contains the association
# between partition numbers with filesystems considered resizable, and their associated device nodes.
self.original_fstypes_dict = {}
original_fstypes_filepath = os.path.join(dir,
prefix + ".original.fstypes")
if isfile(original_fstypes_filepath):
self.original_fstypes_dict = FogProjectImage.parse_original_fstypes_output(
Utility.read_file_into_string(original_fstypes_filepath))
# FOG Project images sometimes contains a file named eg, "d1.fixed_sized_partitions" which is a colon separated
# list of the partition numbers that *cannot* be resized.
self.fixed_size_partitions = []
fixed_sized_partitions_path = os.path.join(
dir, prefix + ".fixed_sized_partitions")
if os.path.exists(fixed_sized_partitions_path):
fixed_sized_partitions_string = Utility.read_file_into_string(
fixed_sized_partitions_path).strip()
self.fixed_size_partitions = fixed_sized_partitions_string.split(
":")
# Convert every element to from a string to an int
self.fixed_size_partitions = list(
map(int, self.fixed_size_partitions))
# FOG Project images sometimes contains a file named eg, "d1.original.swapuuids" which contains the association
# between a partition number and the UUID of the Linux swap partition that resides on there.
self.original_swapuuids_dict = {}
original_swapuuids_filepath = os.path.join(
dir, prefix + ".original.swapuuids")
if isfile(original_swapuuids_filepath):
self.original_swapuuids_dict = FogProjectImage.parse_original_swapuuids_output(
Utility.read_file_into_string(original_swapuuids_filepath))
if 'device' in self.normalized_sfdisk_dict['sfdisk_dict'].keys():
self.long_device_node_disk_list = [
self.normalized_sfdisk_dict['sfdisk_dict']['device']
]
# FOG Project images sometimes has a file named eg, ".size" that contains the drive size in bytes.
size_path = os.path.join(dir, prefix + ".size")
if os.path.exists(size_path):
# When the file exists, use it.
size_string = Utility.read_file_into_string(size_path).strip()
# TODO: split smarter
split = size_string.split(":")
self.size_bytes = int(split[1])
self._mbr_absolute_path = None
mbr_path_string = os.path.join(dirname, prefix + ".mbr")
if os.path.exists(mbr_path_string):
self._mbr_absolute_path = mbr_path_string
else:
self.warning_dict[self.normalized_sfdisk_dict['sfdisk_dict']
['device']] = "Missing MBR"
self.has_grub = False
has_grub_path_string = os.path.join(dirname, prefix + "has_grub")
if os.path.exists(has_grub_path_string):
self.has_grub = True
if 'device' in self.normalized_sfdisk_dict['sfdisk_dict'].keys():
self.short_device_node_disk_list = [
self.normalized_sfdisk_dict['sfdisk_dict']['device']
]
self.partclone_info_dict_dict = collections.OrderedDict([])
self.image_format_dict_dict = collections.OrderedDict([])
for long_device_node in self.normalized_sfdisk_dict['sfdisk_dict'][
'partitions'].keys():
if self.normalized_sfdisk_dict['sfdisk_dict']['partitions'][
long_device_node]['type'] == "27":
# TODO populate
continue
base_device_node, partition_number = Utility.split_device_string(
long_device_node)
if partition_number in self.original_swapuuids_dict.keys():
# Swap handled below
continue
# The partclone image FOG Project creates can be compressed as either gzip or zstd, can be split
# into multiple files, depending on the settings the user configures. The compression format is not encoded
# in the filename.
#
# Split: d1p3.img (may or may not be compressed)
# No split: d1p3.img.001 (may or may not be compressed)
image_match_string = prefix + "p" + str(partition_number) + ".img*"
image_match_path_string = os.path.join(dirname, image_match_string)
print(image_match_path_string)
# Get absolute path partition images. Eg, [/path/to/dlp3.img.001, /path/to/dlp3.img.002 etc]
abs_image_list = glob.glob(image_match_path_string)
# Sort by alphabetical sort. Lexical sort not required here because fixed number of digits (so no risk of
# "1, 10, 2, 3" issues), and partclone manages this when the number of digits is no longer fixed (see
# above)
abs_image_list.sort()
if len(abs_image_list) == 0:
self.warning_dict[long_device_node] = _(
"Cannot find partition's associated partclone image"
) + "\n " + image_match_string
continue
detected_compression = Utility.detect_compression(abs_image_list)
# May be PartImage image.
self.partclone_info_dict_dict[
long_device_node] = Partclone.get_partclone_info_dict(
abs_image_list, long_device_node, detected_compression)
filesystem = self.partclone_info_dict_dict[long_device_node][
'filesystem'].lower()
print(str(self.partclone_info_dict_dict))
if filesystem != "<unknown>" and filesystem != "raw":
self.image_format_dict_dict[long_device_node] = {
'type': "partclone",
'absolute_filename_glob_list': abs_image_list,
'compression': detected_compression,
'filesystem': filesystem,
'binary': "partclone." + filesystem,
"prefix": prefix,
'is_lvm_logical_volume': False
}
else:
self.image_format_dict_dict[long_device_node] = {
'type': "dd",
'absolute_filename_glob_list': abs_image_list,
'compression': detected_compression,
'filesystem': filesystem,
'binary': "partclone.dd",
"prefix": prefix,
'is_lvm_logical_volume': False
}
for swapuuid_key in self.original_swapuuids_dict.keys():
# The key to the Swap UUID is the partition number, but long_device_node is much more convenient
long_device_node = Utility.join_device_string(
self.short_device_node_disk_list[0], swapuuid_key)
print("Converting swap partition number " + str(swapuuid_key) +
" to key " + long_device_node)
self.image_format_dict_dict[long_device_node] = {
'type': "swap",
'uuid': self.original_swapuuids_dict[swapuuid_key],
'label': "",
'filesystem': "swap",
"prefix": prefix,
'is_lvm_logical_volume': False
}
if self.size_bytes == 0:
# When the file doesn't exist, estimate drive capacity from sfdisk partition table backup
last_partition_key, last_partition_final_byte = Sfdisk.get_highest_offset_partition(
self.normalized_sfdisk_dict)
self.size_bytes = last_partition_final_byte
# Covert size in bytes to KB/MB/GB/TB as relevant
self.enduser_readable_size = Utility.human_readable_filesize(
int(self.size_bytes))
self.is_needs_decryption = False
def __init__(self, absolute_path, enduser_filename, filename):
# Redo Backup images never need decryption
self.is_needs_decryption = False
self.absolute_path = absolute_path
self.enduser_filename = enduser_filename
print("Reading backup : " + absolute_path)
dirname = os.path.dirname(absolute_path)
self.user_notes = ""
self.warning_dict = {}
# Clonezilla format
self.ebr_dict = {}
self.short_device_node_partition_list = []
self.short_device_node_disk_list = []
self.lvm_vg_dev_dict = {}
self.lvm_logical_volume_dict = {}
self.dev_fs_dict = {}
self.size_bytes = 0
self.enduser_readable_size = ""
self.is_needs_decryption = False
self.normalized_sfdisk_dict = {'absolute_path': None, 'sfdisk_dict': {'partitions': {}}, 'file_length': 0}
self.parted_dict = {'partitions': {}}
self.post_mbr_gap_absolute_path = {}
self.compression = "gzip"
if filename.endswith(".redo"):
prefix = filename.split(".redo")[0]
print("prefix: " + prefix)
self.compression = "uncompressed"
self.image_format = "REDOBACKUP_0.9.2_FORMAT"
elif filename.endswith(".backup"):
prefix = filename.split(".backup")[0]
print("prefix: " + prefix)
rescuezilla_version_abs_path = os.path.join(dirname, prefix + ".rescuezilla.backup_version")
if not os.path.exists(rescuezilla_version_abs_path):
self.image_format = "REDOBACKUP_0.9.3_1.0.4_FORMAT"
else:
self.image_format = "RESCUEZILLA_1.0.5_FORMAT"
self.rescuezilla_version = Utility.read_file_into_string(rescuezilla_version_abs_path).strip()
print("Backup originally created with Rescuezilla version: " + self.rescuezilla_version)
else:
raise ValueError("Expected Rescuezilla backup to end with .backup: " + absolute_path)
self.last_modified_timestamp = format_datetime(os.stat(absolute_path).st_mtime)
print("Last modified timestamp " + self.last_modified_timestamp)
self.short_device_node_partition_list = Utility.read_linebreak_delimited_file_into_list(absolute_path)
print("Source_partitions: " + str(self.short_device_node_partition_list))
self.size_bytes = int(Utility.read_file_into_string(os.path.join(dirname, prefix + ".size").strip()))
print("Size: " + str(self.size_bytes))
# Covert size in bytes to KB/MB/GB/TB as relevant
self.enduser_readable_size = Utility.human_readable_filesize(int(self.size_bytes))
self._mbr_absolute_path = os.path.join(dirname, prefix + ".mbr")
# Get the size of the MBR image because a Sourceforge user named chcatzsf released two unofficial
# German-language Redo Backup and Recovery update based on Ubuntu 13.10 and Ubuntu 14.04. These two versions
# incorrectly created 512 byte Master Boot Record backup images. More information [1].
#
# [1] https://github.com/rescuezilla/rescuezilla/wiki/Bugs-in-unofficial-Redo-Backup-updates#bugs-in-chcatzsfs-ubuntu-1310-and-1404-releases-german-language-only
self.mbr_size = int(os.stat(self._mbr_absolute_path).st_size)
if self.mbr_size == 512:
# Explain the situation to users with this issue and link to further information about how the GRUB boot
# loader can be regenerated, and confirm whether they wish to proceed.
truncated_bootloader_bug_url = "https://github.com/rescuezilla/rescuezilla/wiki/Bugs-in-unofficial-Redo-Backup-updates#bugs-in-chcatzsfs-ubuntu-1310-and-1404-releases-german-language-only";
# Context for translators: Two popular unofficial Redo Backup v1.0.4 updates by Sourceforge user chcatzsf
# have major bugs where bootloaders like GRUB are not not fully backed up, so Linux-based operating
# cannot boot after a restore. This bug only affected those two updates (German-language only) and the
# problem can be fixed with careful manual intervention. Translating this message into languages other
# than English and German is not required. Full details in:
# https://github.com/rescuezilla/rescuezilla/wiki/Bugs-in-unofficial-Redo-Backup-updates#bugs-in
# -chcatzsfs-ubuntu-1310-and-1404-releases-german-language-only
self.warning_dict[enduser_filename] = _("The backup's bootloader data is shorter than expected. This happens with backups created by an unofficial Redo Backup update. If the backup contained certain bootloaders like GRUB, the restored hard drive will not boot correctly without a manual fix. All data is still fully recoverable but manual intervention may required to restore the bootloader. Please consult {url} for information and assistance. The destination drive has not yet been modified. Do you wish to continue with the restore?").format(url=truncated_bootloader_bug_url)
sfdisk_absolute_path = os.path.join(dirname, prefix + ".sfdisk")
self.normalized_sfdisk_dict = Sfdisk.generate_normalized_sfdisk_dict(sfdisk_absolute_path, self)
if not self.image_format == "RESCUEZILLA_1.0.5_FORMAT":
self.normalized_sfdisk_dict['prefer_old_sfdisk_binary'] = True
# Cannot rely on sfdisk drive name due to some Redo Backup versions not populating this file correctly.
if 'device' in self.normalized_sfdisk_dict['sfdisk_dict'].keys():
self.short_device_node_disk_list = [self.normalized_sfdisk_dict['sfdisk_dict']['device']]
else:
self.short_device_node_disk_list = ["unknown"]
# The NVMe drive handling on Rescuezilla v1.0.5.1+ set the drive name in the .backup file start with "sdz" to
# preserve the ability to restore with older versions of Rescuezilla (which read the source drive). Since v2.0,
# this string is used as a key into sfdisk partitions, so the ".backup" partition list such containing elements
# like "sdz3" needs to be renamed to eg, "nvme0n1p3" here to preserve full backwards compatibility.
if 'partitions' in self.normalized_sfdisk_dict['sfdisk_dict'].keys() and len(self.normalized_sfdisk_dict['sfdisk_dict']['partitions'].keys()) > 1:
# Long drive node extracted from sfdisk dictionary
sfdisk_long_drive_node = list(self.normalized_sfdisk_dict['sfdisk_dict']['partitions'].keys())[0]
actual_base_device_node, first_partition_number = Utility.split_device_string(sfdisk_long_drive_node)
for i in range(len(self.short_device_node_partition_list)):
node_to_potentially_rename = self.short_device_node_partition_list[i]
if node_to_potentially_rename.startswith("sdz") and actual_base_device_node != "sdz":
# This node is renamed, and the list is updated.
fake_base_device_node, actual_partition_number = Utility.split_device_string(node_to_potentially_rename)
corrected_long_device_node = Utility.join_device_string(actual_base_device_node, actual_partition_number)
corrected_short_device_node = re.sub('/dev/', '', corrected_long_device_node)
self.short_device_node_partition_list[i] = corrected_short_device_node
self.partclone_info_dict_dict = collections.OrderedDict([])
self.image_format_dict_dict = collections.OrderedDict([])
# All Rescuezilla v1.0.5 and Redo Backup and Recovery images use gzip compression EXCEPT the uncompressed v0.9.2
compression = "gzip"
for short_device_node in self.short_device_node_partition_list:
base_device_node, partition_number = Utility.split_device_string(short_device_node)
if self.image_format == "REDOBACKUP_0.9.2_FORMAT":
# Redo Backup v0.9.2 are *not* split
image_match_string = os.path.join(dirname, prefix + "_part" + str(partition_number))
# ... and not compressed
compression = "uncompressed"
else:
# Redo Backup v0.9.3-v1.0.4 and Rescuezilla v1.0.5 images are split up, eg "20200901_part2.000".
# However need to be careful because Rescuezilla's backup directory contains a log files
# eg, "20200901_part2_partclone.log", so the dot character before the asterisk is important. It prevents
# the underscore from matching.
image_match_string = os.path.join(dirname, prefix + "_part" + str(partition_number) + ".*")
# Get absolute path partition images. Eg, [/path/to/20200813_part3.000, /path/to/20200813_part3.001 etc]
abs_partclone_image_list = glob.glob(image_match_string)
# Sort by alphabetical sort. Lexical sort not required here because fixed number of digits (so no risk
# of "1, 10, 2, 3" issues)
abs_partclone_image_list.sort()
if len(abs_partclone_image_list) == 0:
# The legacy Redo Backup and Recovery format cannot distinguish between failed partclone backup and a
# user who chose not to backup a partition
self.warning_dict[short_device_node] = _("Cannot find partition's associated partclone image")
continue
self.image_format_dict_dict[short_device_node] = {'abs_image_glob': abs_partclone_image_list}
command = "partclone"
filesystem = "<unknown>"
# Rescuezilla v1.0.5 format creates partition to filesystem mapping files
command_filepath = os.path.join(dirname, prefix + ".partclone.command.part" + str(partition_number))
if os.path.isfile(command_filepath):
command = Utility.read_file_into_string(command_filepath).strip()
print(str(short_device_node) + ": " + command)
restore_binary = command
filesystem = re.sub('partclone.', '', restore_binary)
use_old_partclone = False
# Use partclone.info to extract filesystem and size information from the image files. This is a time
# consuming operation but Redo 0.9.3-1.0.4 images benefit from this.
# Rescuezilla 1.0.5 format has a backup of the filesystem (from the restore_command files), and the size (
# from sfdisk)
if self.image_format == "REDOBACKUP_0.9.3_1.0.4_FORMAT" or self.image_format == "REDOBACKUP_0.9.2_FORMAT":
use_old_partclone = True
self.partclone_info_dict_dict[short_device_node] = Partclone.get_partclone_info_dict(abs_partclone_image_list, short_device_node, compression)
filesystem = self.partclone_info_dict_dict[short_device_node]['filesystem']
print(str(self.partclone_info_dict_dict))
if filesystem != "<unknown>" and filesystem != "raw":
self.image_format_dict_dict[short_device_node] = {'type': "partclone",
'absolute_filename_glob_list': abs_partclone_image_list,
'compression': compression,
'filesystem': filesystem,
'binary': "partclone." + filesystem,
"prefix": prefix,
'use_old_partclone': use_old_partclone,
'is_lvm_logical_volume': False}
else:
self.image_format_dict_dict[short_device_node] = {'type': "dd",
'absolute_filename_glob_list': abs_partclone_image_list,
'compression': compression,
'binary': "partclone.dd",
'filesystem': filesystem,
"prefix": prefix,
'use_old_partclone': use_old_partclone,
'is_lvm_logical_volume': False}
# Compute the partition size estimate, and save it to avoid recomputing.
self.image_format_dict_dict[short_device_node]['estimated_size_bytes'] = self._compute_partition_size_byte_estimate(short_device_node)
def __init__(self, absolute_clonezilla_img_path, enduser_filename, dir,
ecryptfs_info_dict, is_needs_decryption,
short_disk_device_node, short_device_node_partition_list,
is_display_multidisk, enduser_drive_number):
self.absolute_path = absolute_clonezilla_img_path
self.ecryptfs_info_dict = ecryptfs_info_dict
self.is_needs_decryption = is_needs_decryption
self.short_disk_device_node = short_disk_device_node
self.is_display_multidisk = is_display_multidisk
self.enduser_drive_number = enduser_drive_number
self.user_notes = ""
self.warning_dict = {}
notes_filepath = os.path.join(dir, "rescuezilla.description.txt")
if os.path.exists(notes_filepath):
self.user_notes = Utility.read_file_into_string(notes_filepath)
if is_display_multidisk:
multidisk_desc = _("Drive {drive_number}".format(
drive_number=str(self.enduser_drive_number)))
self.enduser_filename = enduser_filename + " (" + multidisk_desc + ")"
else:
self.enduser_filename = enduser_filename
statbuf = os.stat(self.absolute_path)
self.last_modified_timestamp = format_datetime(
datetime.fromtimestamp(statbuf.st_mtime))
print("Last modified timestamp " + self.last_modified_timestamp)
self.image_format = "CLONEZILLA_FORMAT"
self.short_device_node_partition_list = short_device_node_partition_list
self.short_device_node_disk_list = [short_disk_device_node]
self.ebr_dict = {}
self.lvm_vg_dev_dict = {}
self.lvm_logical_volume_dict = {}
self.dev_fs_dict = {}
if not self.is_needs_decryption:
# The 'dev-fs.list' file contains the association between device nodes and the filesystems
# (eg '/dev/sda2 ext4'). The filesystems are a combination of several sources, so the values may differ from
# `blkid` and `parted`. Given newer versions of Clonezilla create this file, it makes sense to process it.
dev_fs_list_filepath = os.path.join(dir, "dev-fs.list")
if isfile(dev_fs_list_filepath):
self.dev_fs_dict = ClonezillaImage.parse_dev_fs_list_output(
Utility.read_file_into_string(dev_fs_list_filepath))
else:
# Not raising exception because older Clonezilla images don't have this file.
print("Unable to locate " + dev_fs_list_filepath)
# The 'blkid.list' file provides a snapshot of the partitions on the system at the time of backup. This data
# is not particularly relevant during a restore operation, except potentially for eg, UUID.
#
# Danger: Do not mistake this structure for the current system's 'blkid' information.
# TODO: Re-evaluate the need to parse this file. The risk of mistaken usage may outweigh its usefulness.
self.blkid_dict = {}
blkid_list_filepath = os.path.join(dir, "blkid.list")
if isfile(blkid_list_filepath):
self.blkid_dict = Blkid.parse_blkid_output(
Utility.read_file_into_string(
os.path.join(dir, blkid_list_filepath)))
else:
# Not raising exception because older Clonezilla images don't have this file.
print("Unable to locate " + blkid_list_filepath)
# The 'lvm_vg_dev.list' file contains the association between an LVM VG (Logical Volume Manager volume group)
# with a name eg 'vgtest', the LVM PV (physical volume) with a UUID name, and the device node that the physical
# volume resides on eg, /dev/sdb.
lvm_vg_dev_list_filepath = os.path.join(dir, "lvm_vg_dev.list")
if isfile(
lvm_vg_dev_list_filepath) and not self.is_needs_decryption:
self.lvm_vg_dev_dict = Lvm.parse_volume_group_device_list_string(
Utility.read_file_into_string(lvm_vg_dev_list_filepath))
else:
print("No LVM volume group to device file detected in image")
# The 'lvm_logv.list' file contains the association between device nodes and the filesystems (eg '/dev/sda2 ext4')
lvm_logv_list_filepath = os.path.join(dir, "lvm_logv.list")
if isfile(lvm_logv_list_filepath) and not self.is_needs_decryption:
self.lvm_logical_volume_dict = Lvm.parse_logical_volume_device_list_string(
Utility.read_file_into_string(lvm_logv_list_filepath))
else:
print("No LVM logical volume file detected in image")
self.parted_dict = {}
self._mbr_absolute_path = {}
self.post_mbr_gap_dict = {}
self.size_bytes = 0
self.enduser_readable_size = "unknown"
self.size_bytes = 0
# Clonezilla -pt.parted file lists size in sectors, rather than bytes (or end-user readable KB/MB/GB/TB as
# Clonezilla's -pt.parted.compact file)
parted_filepath = os.path.join(dir,
short_disk_device_node + "-pt.parted")
if isfile(parted_filepath) and not self.is_needs_decryption:
self.parted_dict = Parted.parse_parted_output(
Utility.read_file_into_string(parted_filepath))
if 'capacity' in self.parted_dict and 'logical_sector_size' in \
self.parted_dict:
self.size_bytes = self.parted_dict['capacity'] * \
self.parted_dict['logical_sector_size']
else:
raise Exception("Unable to calculate disk capacity using " +
parted_filepath + ": " + str(self.parted_dict))
else:
# Do not raise exception because parted partition table is not present when using 'saveparts'
print("Unable to locate " + parted_filepath +
" or file is encrypted")
if self.ecryptfs_info_dict is not None and 'size' in self.ecryptfs_info_dict.keys(
):
self.enduser_readable_size = self.ecryptfs_info_dict['size'].strip(
"_")
self.normalized_sfdisk_dict = {
'absolute_path': None,
'sfdisk_dict': {
'partitions': {}
},
'file_length': 0
}
if not is_needs_decryption:
sfdisk_absolute_path = os.path.join(
dir, short_disk_device_node + "-pt.sf")
self.normalized_sfdisk_dict = Sfdisk.generate_normalized_sfdisk_dict(
sfdisk_absolute_path, self)
self.sfdisk_chs_dict = None
if not is_needs_decryption:
sfdisk_chs_absolute_path = os.path.join(
dir, short_disk_device_node + "-chs.sf")
if isfile(sfdisk_chs_absolute_path):
self.sfdisk_chs_dict = ClonezillaImage.parse_chs_sf_output(
sfdisk_chs_absolute_path)
# There is a maximum of 1 MBR per drive (there can be many drives). Master Boot Record (MBR) is never
# listed in 'parts' list.
self._mbr_absolute_path = None
mbr_glob_list = glob.glob(
os.path.join(dir, short_disk_device_node) + "-mbr")
for absolute_mbr_filepath in mbr_glob_list:
self._mbr_absolute_path = absolute_mbr_filepath
# There is a maximum of 1 post-MBR gap per drive (there can be many drives). The post MBR gap is never
# listed in 'parts' list. Note the asterisk wildcard in the glob, to get the notes.txt file (see below)
post_mbr_gap_glob_list = glob.glob(
os.path.join(dir, short_disk_device_node) +
"-hidden-data-after-mbr*")
for absolute_post_mbr_gap_filepath in post_mbr_gap_glob_list:
if absolute_post_mbr_gap_filepath.endswith(
".notes.txt") and not isfile(
os.path.join(dir, short_disk_device_node) +
"-hidden-data-after-mbr"):
# When the post-MBR gap is not created by Clonezilla due to >1024 MB gap between MBR and first partition
# there is a "notes.txt" file created which explains this. To maximize compatibility, in this
# situation Rescuezilla v2.1+ creates a 1MB post-MBR gap backup *and* a notes.txt file.
self.warning_dict[
short_disk_device_node +
"mbr"] = "Backup is missing the \"post-MBR gap\" backup, most likely due to Clonezilla detecting a >1024MB gap between the MBR partition table and the first partition. Any GRUB bootloaders present will not restore correctly. In order to boot after restoring this backup, Clonezilla happens to workaround this situation by automatically re-installing GRUB, but current version of Rescuezilla does not implement this (but will in a future version). Clonezilla is available from within the Rescuezilla live environment by running `clonezilla` in a Terminal. See the following link for more information: https://github.com/rescuezilla/rescuezilla/issues/146"
else:
self.post_mbr_gap_dict = {
'absolute_path': absolute_post_mbr_gap_filepath
}
# There is a maximum of 1 EBR per drive (there can be many drives). Extended Boot Record (EBR) is never
# listed in 'parts' list. The asterisk is needed here because unlike the MBR case, the ebr file is eg,
# sda4-ebr. In otherwords the EBR is associated with a partition not the base device node.
ebr_glob_list = glob.glob(
os.path.join(dir, short_disk_device_node) + "*-ebr")
for absolute_ebr_filepath in ebr_glob_list:
short_ebr_device_node = basename(absolute_ebr_filepath).split(
"-ebr")[0]
self.ebr_dict = {
'short_device_node': short_ebr_device_node,
'absolute_path': absolute_ebr_filepath
}
# There is a maximum of 1 EFI NVRAM backup per computer
self.efi_nvram_dat_absolute_path = None
efi_nvram_dat_filepath = os.path.join(dir, "efi-nvram.dat")
if isfile(efi_nvram_dat_filepath):
self.efi_nvram_dat_absolute_path = efi_nvram_dat_filepath
else:
# Non-EFI Clonezilla images don't have this file
print("Unable to locate " + efi_nvram_dat_filepath)
# Scan for Clonezilla's RAID information files (currently not used by Clonezilla or Rescuezilla)
self.proc_mdstat_dict = {}
proc_mdstat_filepath = os.path.join(dir, "mdstat.txt")
if isfile(proc_mdstat_filepath):
self.proc_mdstat_dict = ProcMdstat.parse_proc_mdstat_string(
Utility.read_file_into_string(proc_mdstat_filepath))
for raid_key in self.proc_mdstat_dict.keys():
expected_raid_file = raid_key + ".txt"
if isfile(expected_raid_file):
print("Found: " + expected_raid_file)
else:
print("Missing: " + expected_raid_file)
self.proc_mdadm_conf_filepath = None
mdadm_conf_filepath = os.path.join(dir, "mdadm.conf")
if isfile(mdadm_conf_filepath):
print("Found" + mdadm_conf_filepath)
self.proc_mdadm_conf_filepath = mdadm_conf_filepath
self.partclone_info_dict_dict = collections.OrderedDict([])
self.image_format_dict_dict = collections.OrderedDict([])
# Loops over the partitions listed in the 'parts' file
for short_partition_device_node in self.short_device_node_partition_list:
has_found_atleast_one_associated_image = False
# For standard MBR and GPT partitions, the partition key listed in the 'parts' file has a directly
# associated backup image, so check for this.
image_format_dict = ClonezillaImage.scan_backup_image(
dir, short_partition_device_node, self.is_needs_decryption)
# If no match found check the LVM (Logical Volume Manager)
if len(image_format_dict) == 0:
# Loop over all the volume groups (if any)
for vg_name in self.lvm_vg_dev_dict.keys():
# TODO: Evalulate if there are Linux multipath device nodes that hold LVM Physical Volumes.
# TODO: May need to adjust for multipath device node by replacing "/" with "-" for this node.
pv_short_device_node = re.sub(
'/dev/', '',
self.lvm_vg_dev_dict[vg_name]['device_node'])
# Check if there is an associated LVM Physical Volume (PV) present
if short_partition_device_node == pv_short_device_node:
# Yes, the partition being analysed is associated with an LVM physical volume that contains
# an LVM Volume Group. Now determine all backup images associated to Logical Volumes that
# reside within this Volume Group.
for lv_path in self.lvm_logical_volume_dict.keys():
candidate_lv_path_prefix = "/dev/" + vg_name + "/"
# Eg, "/dev/cl/root".startswith("/dev/cl")
if lv_path.startswith(candidate_lv_path_prefix):
# Found a logical volume. Note: There may be more than one LV associated with an VG
# Set the scan prefix for the backup image to eg "cl-root"
logical_volume_scan_key = re.sub(
'/', '-', re.sub('/dev/', '', lv_path))
image_format_dict = ClonezillaImage.scan_backup_image(
dir, logical_volume_scan_key,
self.is_needs_decryption)
if len(image_format_dict) != 0:
image_format_dict[
'is_lvm_logical_volume'] = True
image_format_dict[
'volume_group_name'] = vg_name
image_format_dict['physical_volume_long_device_node'] = \
self.lvm_vg_dev_dict[vg_name]['device_node']
image_format_dict[
'logical_volume_long_device_node'] = lv_path
self.image_format_dict_dict[
logical_volume_scan_key] = image_format_dict
has_found_atleast_one_associated_image = True
else:
has_found_atleast_one_associated_image = True
self.image_format_dict_dict[
short_partition_device_node] = image_format_dict
if not self.has_partition_table(
) and image_format_dict['type'] == 'partclone':
# Both Clonezilla's savedisk and saveparts will generally contain the partition table, except in
# the case of saveparts made of the filesystem-directly-on-disk case. For this case (which could
# be a dd image), scan using partclone.info. Scanning is slow, but due to lack of partition
# table, it will only ever be a single filesystem.
self.partclone_info_dict_dict[
self.
short_disk_device_node] = Partclone.get_partclone_info_dict(
abs_partclone_image_list=self.
image_format_dict_dict[short_partition_device_node]
['absolute_filename_glob_list'],
image_key=short_partition_device_node,
compression=self.image_format_dict_dict[
short_partition_device_node]['compression'])
if not has_found_atleast_one_associated_image:
self.image_format_dict_dict[short_partition_device_node] = {
'type': "missing",
'prefix': short_partition_device_node,
'is_lvm_logical_volume': False
}
# TODO: Improve conversion between /dev/ nodes to short dev node.
long_partition_key = "/dev/" + short_partition_device_node
if long_partition_key in self.dev_fs_dict.keys():
# Annotate have filesystem information from dev-fs.list file. This case is expected when during a
# backup Clonezilla or Rescuezilla failed to successfully image the filesystem, but may have
# succeeded for other filesystems.
fs = self.dev_fs_dict[long_partition_key]['filesystem']
self.image_format_dict_dict[short_partition_device_node][
'filesystem'] = fs
# TODO: Consider removing warning_dict as image_format_dict is sufficient.
self.warning_dict[short_partition_device_node] = fs
elif self.is_needs_decryption:
self.warning_dict[short_partition_device_node] = _(
"Needs decryption")
else:
self.warning_dict[short_partition_device_node] = _(
"Unknown filesystem")
# Unfortunately swap partitions are not listed in the 'parts' file. There does not appear to be any alternative
# but scanning for the swap partitions and add them to the existing partitions, taking care to avoid duplicates
# by rescanning what has already been scanned due to listing as an LVM logical volume.
swap_partition_info_glob_list = glob.glob(
os.path.join(dir, "swappt-*.info"))
for swap_partition_info_glob in swap_partition_info_glob_list:
key = Swappt.get_short_device_from_swappt_info_filename(
swap_partition_info_glob)
already_scanned = False
for image_format_dict_key in self.image_format_dict_dict.keys():
if key == self.image_format_dict_dict[image_format_dict_key][
"prefix"]:
already_scanned = True
break
if not already_scanned and not self.is_needs_decryption:
self.image_format_dict_dict[key] = Swappt.parse_swappt_info(
Utility.read_file_into_string(swap_partition_info_glob))
self.image_format_dict_dict[key]['type'] = "swap"
self.image_format_dict_dict[key]['prefix'] = key
self.image_format_dict_dict[key][
'is_lvm_logical_volume'] = False
total_size_estimate = 0
# Now we have all the images, compute the partition size estimates, and save it to avoid recomputing.
for image_format_dict_key in self.image_format_dict_dict.keys():
# Try to find the short_disk_key for the image. This key is used to access the parted and sfdisk
# partition table backups. It's not guaranteed there is a direct association between the backup image and
# the partition table (for example, Logical Volume Manager logical volumes).
associated_short_disk_key = ""
for short_disk_key in self.short_device_node_disk_list:
if image_format_dict_key.startswith(short_disk_key):
associated_short_disk_key = short_disk_key
estimated_size_bytes = self._compute_partition_size_byte_estimate(
associated_short_disk_key, image_format_dict_key)
self.image_format_dict_dict[image_format_dict_key][
'estimated_size_bytes'] = estimated_size_bytes
total_size_estimate += estimated_size_bytes
if self.size_bytes == 0:
# For md RAID devices, Clonezilla doesn't have a parted of sfdisk partition table containing the hard drive
# size, so in that situation, summing the image sizes provides some kind of size estimate.
self.size_bytes = total_size_estimate
# Covert size in bytes to KB/MB/GB/TB as relevant
self.enduser_readable_size = Utility.human_readable_filesize(
int(self.size_bytes))
pp = pprint.PrettyPrinter(indent=4)
pp.pprint(self.image_format_dict_dict)
def do_backup(self):
self.at_least_one_non_fatal_error = False
self.requested_stop = False
# Clear proc dictionary
self.proc.clear()
self.summary_message_lock = threading.Lock()
self.summary_message = ""
env = Utility.get_env_C_locale()
print("mkdir " + self.dest_dir)
os.mkdir(self.dest_dir)
short_selected_device_node = re.sub('/dev/', '',
self.selected_drive_key)
enduser_date = datetime.today().strftime('%Y-%m-%d-%H%M')
clonezilla_img_filepath = os.path.join(self.dest_dir, "clonezilla-img")
with open(clonezilla_img_filepath, 'w') as filehandle:
try:
output = "This image was saved by Rescuezilla at " + enduser_date + "\nSaved by " + self.human_readable_version + "\nThe log during saving:\n----------------------------------------------------------\n\n"
filehandle.write(output)
except:
tb = traceback.format_exc()
traceback.print_exc()
error_message = _(
"Failed to write destination file. Please confirm it is valid to create the provided file path, and try again."
) + "\n\n" + tb
GLib.idle_add(self.completed_backup, False, error_message)
return
self.logger = Logger(clonezilla_img_filepath)
GLib.idle_add(self.update_backup_progress_bar, 0)
process, flat_command_string, failed_message = Utility.run(
"Saving blkdev.list", [
"lsblk", "-oKNAME,NAME,SIZE,TYPE,FSTYPE,MOUNTPOINT,MODEL",
self.selected_drive_key
],
use_c_locale=True,
output_filepath=os.path.join(self.dest_dir, "blkdev.list"),
logger=self.logger)
if process.returncode != 0:
with self.summary_message_lock:
self.summary_message += failed_message
GLib.idle_add(self.completed_backup, False, failed_message)
return
blkid_cmd_list = ["blkid"]
sort_cmd_list = ["sort", "-V"]
Utility.print_cli_friendly("blkid ", [blkid_cmd_list, sort_cmd_list])
self.proc['blkid'] = subprocess.Popen(blkid_cmd_list,
stdout=subprocess.PIPE,
env=env,
encoding='utf-8')
process, flat_command_string, failed_message = Utility.run(
"Saving blkid.list", ["blkid"],
use_c_locale=True,
output_filepath=os.path.join(self.dest_dir, "blkid.list"),
logger=self.logger)
if process.returncode != 0:
with self.summary_message_lock:
self.summary_message += failed_message
GLib.idle_add(self.completed_backup, False, failed_message)
return
process, flat_command_string, failed_message = Utility.run(
"Saving Info-lshw.txt", ["lshw"],
use_c_locale=True,
output_filepath=os.path.join(self.dest_dir, "Info-lshw.txt"),
logger=self.logger)
if process.returncode != 0:
with self.summary_message_lock:
self.summary_message += failed_message
GLib.idle_add(self.completed_backup, False, failed_message)
return
info_dmi_txt_filepath = os.path.join(self.dest_dir, "Info-dmi.txt")
with open(info_dmi_txt_filepath, 'w') as filehandle:
filehandle.write(
"# This image was saved from this machine with DMI info at " +
enduser_date + ":\n")
filehandle.flush()
process, flat_command_string, failed_message = Utility.run(
"Saving Info-dmi.txt", ["dmidecode"],
use_c_locale=True,
output_filepath=info_dmi_txt_filepath,
logger=self.logger)
if process.returncode != 0:
with self.summary_message_lock:
self.summary_message += failed_message
GLib.idle_add(self.completed_backup, False, failed_message)
return
info_lspci_filepath = os.path.join(self.dest_dir, "Info-lspci.txt")
with open(info_lspci_filepath, 'w') as filehandle:
# TODO: Improve datetime format string.
filehandle.write(
"This image was saved from this machine with PCI info at " +
enduser_date + "\n")
filehandle.write("'lspci' results:\n")
filehandle.flush()
process, flat_command_string, failed_message = Utility.run(
"Appending `lspci` output to Info-lspci.txt", ["lspci"],
use_c_locale=True,
output_filepath=info_lspci_filepath,
logger=self.logger)
if process.returncode != 0:
with self.summary_message_lock:
self.summary_message += failed_message
GLib.idle_add(self.completed_backup, False, failed_message)
return
msg_delimiter_star_line = "*****************************************************."
with open(info_lspci_filepath, 'a+') as filehandle:
filehandle.write(msg_delimiter_star_line + "\n")
filehandle.write("'lspci -n' results:\n")
filehandle.flush()
# Show PCI vendor and device codes as numbers instead of looking them up in the PCI ID list.
process, flat_command_string, failed_message = Utility.run(
"Appending `lspci -n` output to Info-lspci.txt", ["lspci", "-n"],
use_c_locale=True,
output_filepath=info_lspci_filepath,
logger=self.logger)
if process.returncode != 0:
with self.summary_message_lock:
self.summary_message += failed_message
GLib.idle_add(self.completed_backup, False, failed_message)
return
info_smart_filepath = os.path.join(self.dest_dir, "Info-smart.txt")
with open(info_smart_filepath, 'w') as filehandle:
filehandle.write(
"This image was saved from this machine with hard drive S.M.A.R.T. info at "
+ enduser_date + "\n")
filehandle.write(msg_delimiter_star_line + "\n")
filehandle.write("For the drive: " + self.selected_drive_key +
"\n")
filehandle.flush()
# VirtualBox doesn't support smart, so ignoring the exit code here.
# FIXME: Improve this.
process, flat_command_string, failed_message = Utility.run(
"Saving Info-smart.txt",
["smartctl", "--all", self.selected_drive_key],
use_c_locale=True,
output_filepath=info_smart_filepath,
logger=self.logger)
filepath = os.path.join(self.dest_dir, "Info-packages.txt")
# Save Debian package informtion
if shutil.which("dpkg") is not None:
rescuezilla_package_list = ["rescuezilla", "util-linux", "gdisk"]
with open(filepath, 'w') as filehandle:
filehandle.write(
"Image was saved by these Rescuezilla-related packages:\n "
)
for pkg in rescuezilla_package_list:
dpkg_process = subprocess.run(['dpkg', "--status", pkg],
capture_output=True,
encoding="UTF-8")
if dpkg_process.returncode != 0:
continue
for line in dpkg_process.stdout.split("\n"):
if re.search("^Version: ", line):
version = line[len("Version: "):]
filehandle.write(pkg + "-" + version + " ")
filehandle.write("\nSaved by " + self.human_readable_version +
".\n")
# TODO: Clonezilla creates a file named "Info-saved-by-cmd.txt" file, to allow users to re-run the exact
# command again without going through the wizard. The proposed Rescuezilla approach to this feature is
# discussed here: https://github.com/rescuezilla/rescuezilla/issues/106
filepath = os.path.join(self.dest_dir, "parts")
with open(filepath, 'w') as filehandle:
i = 0
for partition_key in self.partitions_to_backup:
short_partition_key = re.sub('/dev/', '', partition_key)
to_backup_dict = self.partitions_to_backup[partition_key]
is_swap = False
if 'filesystem' in to_backup_dict.keys(
) and to_backup_dict['filesystem'] == "swap":
is_swap = True
if 'type' not in to_backup_dict.keys(
) or 'type' in to_backup_dict.keys(
) and 'extended' != to_backup_dict['type'] and not is_swap:
# Clonezilla does not write the extended partition node into the parts file,
# nor does it write swap partition node
filehandle.write('%s' % short_partition_key)
# Ensure no trailing space on final iteration (to match Clonezilla format exactly)
if i + 1 != len(self.partitions_to_backup.keys()):
filehandle.write(' ')
i += 1
filehandle.write('\n')
filepath = os.path.join(self.dest_dir, "disk")
with open(filepath, 'w') as filehandle:
filehandle.write('%s\n' % short_selected_device_node)
compact_parted_filename = short_selected_device_node + "-pt.parted.compact"
# Parted drive information with human-readable "compact" units: KB/MB/GB rather than sectors.
process, flat_command_string, failed_message = Utility.run(
"Saving " + compact_parted_filename, [
"parted", "--script", self.selected_drive_key, "unit",
"compact", "print"
],
use_c_locale=True,
output_filepath=os.path.join(self.dest_dir,
compact_parted_filename),
logger=self.logger)
if process.returncode != 0:
with self.summary_message_lock:
self.summary_message += failed_message
GLib.idle_add(self.completed_backup, False, failed_message)
return
# Parted drive information with standard sector units. Clonezilla doesn't output easily parsable output using
# the --machine flag, so for maximum Clonezilla compatibility neither does Rescuezilla.
parted_filename = short_selected_device_node + "-pt.parted"
parted_process, flat_command_string, failed_message = Utility.run(
"Saving " + parted_filename, [
"parted", "--script", self.selected_drive_key, "unit", "s",
"print"
],
use_c_locale=True,
output_filepath=os.path.join(self.dest_dir, parted_filename),
logger=self.logger)
if process.returncode != 0:
with self.summary_message_lock:
self.summary_message += failed_message
GLib.idle_add(self.completed_backup, False, failed_message)
return
parted_dict = Parted.parse_parted_output(parted_process.stdout)
partition_table = parted_dict['partition_table']
# Save MBR for both msdos and GPT disks
if "gpt" == partition_table or "msdos" == partition_table:
filepath = os.path.join(self.dest_dir,
short_selected_device_node + "-mbr")
process, flat_command_string, failed_message = Utility.run(
"Saving " + filepath, [
"dd", "if=" + self.selected_drive_key, "of=" + filepath,
"bs=512", "count=1"
],
use_c_locale=False,
logger=self.logger)
if process.returncode != 0:
with self.summary_message_lock:
self.summary_message += failed_message
GLib.idle_add(self.completed_backup, False, failed_message)
return
if "gpt" == partition_table:
first_gpt_filename = short_selected_device_node + "-gpt-1st"
dd_process, flat_command_string, failed_message = Utility.run(
"Saving " + first_gpt_filename, [
"dd", "if=" + self.selected_drive_key,
"of=" + os.path.join(self.dest_dir, first_gpt_filename),
"bs=512", "count=34"
],
use_c_locale=False,
logger=self.logger)
if process.returncode != 0:
with self.summary_message_lock:
self.summary_message += failed_message
GLib.idle_add(self.completed_backup, False, failed_message)
return
# From Clonezilla's scripts/sbin/ocs-functions:
# We need to get the total size of disk so that we can skip and dump the last block:
# The output of 'parted -s /dev/sda unit s print' is like:
# --------------------
# Disk /dev/hda: 16777215s
# Sector size (logical/physical): 512B/512B
# Partition Table: gpt
#
# Number Start End Size File system Name Flags
# 1 34s 409640s 409607s fat32 primary msftres
# 2 409641s 4316406s 3906766s ext2 primary
# 3 4316407s 15625000s 11308594s reiserfs primary
# --------------------
# to_seek = "$((${src_disk_size_sec}-33+1))"
to_skip = parted_dict['capacity'] - 32
second_gpt_filename = short_selected_device_node + "-gpt-2nd"
process, flat_command_string, failed_message = Utility.run(
"Saving " + second_gpt_filename, [
"dd", "if=" + self.selected_drive_key,
"of=" + os.path.join(self.dest_dir, second_gpt_filename),
"skip=" + str(to_skip), "bs=512", "count=33"
],
use_c_locale=False,
logger=self.logger)
if process.returncode != 0:
with self.summary_message_lock:
self.summary_message += failed_message
GLib.idle_add(self.completed_backup, False, failed_message)
return
# LC_ALL=C sgdisk -b $target_dir_fullpath/$(to_filename ${ihd})-gpt.gdisk /dev/$ihd | tee --append ${OCS_LOGFILE}
gdisk_filename = short_selected_device_node + "-gpt.gdisk"
process, flat_command_string, failed_message = Utility.run(
"Saving " + gdisk_filename, [
"sgdisk", "--backup",
os.path.join(self.dest_dir, gdisk_filename),
self.selected_drive_key
],
use_c_locale=True,
logger=self.logger)
if process.returncode != 0:
with self.summary_message_lock:
self.summary_message += failed_message
GLib.idle_add(self.completed_backup, False, failed_message)
return
sgdisk_filename = short_selected_device_node + "-gpt.sgdisk"
process, flat_command_string, failed_message = Utility.run(
"Saving " + sgdisk_filename,
["sgdisk", "--print", self.selected_drive_key],
use_c_locale=True,
output_filepath=os.path.join(self.dest_dir, sgdisk_filename),
logger=self.logger)
if process.returncode != 0:
with self.summary_message_lock:
self.summary_message += failed_message
GLib.idle_add(self.completed_backup, False, failed_message)
return
elif "msdos" == partition_table:
# image_save
first_partition_key, first_partition_offset_bytes = CombinedDriveState.get_first_partition(
self.partitions_to_backup)
# Maximum hidden data to backup is 1024MB
hidden_data_after_mbr_limit = 1024 * 1024 * 1024
if first_partition_offset_bytes > hidden_data_after_mbr_limit:
self.logger.write(
"Calculated very large hidden data after MBR size. Skipping"
)
else:
first_partition_offset_sectors = int(
first_partition_offset_bytes / 512)
hidden_mbr_data_filename = short_selected_device_node + "-hidden-data-after-mbr"
# FIXME: Appears one sector too large.
process, flat_command_string, failed_message = Utility.run(
"Saving " + hidden_mbr_data_filename, [
"dd", "if=" + self.selected_drive_key, "of=" +
os.path.join(self.dest_dir, hidden_mbr_data_filename),
"skip=1", "bs=512",
"count=" + str(first_partition_offset_sectors)
],
use_c_locale=False,
logger=self.logger)
if process.returncode != 0:
with self.summary_message_lock:
self.summary_message += failed_message
GLib.idle_add(self.completed_backup, False, failed_message)
return
else:
self.logger.write("Partition table is: " + partition_table)
# Parted sees drives with direct filesystem applied as loop partition table.
if partition_table is not None and partition_table != "loop":
sfdisk_filename = short_selected_device_node + "-pt.sf"
process, flat_command_string, failed_message = Utility.run(
"Saving " + sfdisk_filename,
["sfdisk", "--dump", self.selected_drive_key],
output_filepath=os.path.join(self.dest_dir, sfdisk_filename),
use_c_locale=True,
logger=self.logger)
if process.returncode != 0:
with self.summary_message_lock:
self.summary_message += failed_message
GLib.idle_add(self.completed_backup, False, failed_message)
return
process, flat_command_string, failed_message = Utility.run(
"Retreiving disk geometry with sfdisk ",
["sfdisk", "--show-geometry", self.selected_drive_key],
use_c_locale=True,
logger=self.logger)
if process.returncode != 0:
with self.summary_message_lock:
self.summary_message += failed_message
GLib.idle_add(self.completed_backup, False, failed_message)
return
geometry_dict = Sfdisk.parse_sfdisk_show_geometry(process.stdout)
filepath = os.path.join(self.dest_dir,
short_selected_device_node + "-chs.sf")
with open(filepath, 'w') as filehandle:
for key in geometry_dict.keys():
output = key + "=" + str(geometry_dict[key])
self.logger.write(output)
filehandle.write('%s\n' % output)
# Query all Physical Volumes (PV), Volume Group (VG) and Logical Volume (LV). See unit test for a worked example.
# TODO: In the Rescuezilla application architecture, this LVM information is best extracted during the drive
# TODO: query step, and then integrated into the "combined drive state" dictionary. Doing it during the backup
# TODO: process matches how Clonezilla does it, which is sufficient for now.
# FIXME: This section is duplicated in partitions_to_restore.py.
# Start the Logical Volume Manager (LVM). Caller raises Exception on failure
Lvm.start_lvm2(self.logger)
relevant_vg_name_dict = {}
vg_state_dict = Lvm.get_volume_group_state_dict(self.logger)
for partition_key in list(self.partitions_to_backup.keys()):
for report_dict in vg_state_dict['report']:
for vg_dict in report_dict['vg']:
if 'pv_name' in vg_dict.keys(
) and partition_key == vg_dict['pv_name']:
if 'vg_name' in vg_dict.keys():
vg_name = vg_dict['vg_name']
else:
GLib.idle_add(
ErrorMessageModalPopup.
display_nonfatal_warning_message, self.builder,
"Could not find volume group name vg_name in "
+ str(vg_dict))
# TODO: Re-evaluate how exactly Clonezilla uses /NOT_FOUND and whether introducing it here
# TODO: could improve Rescuezilla/Clonezilla interoperability.
continue
if 'pv_uuid' in vg_dict.keys():
pv_uuid = vg_dict['pv_uuid']
else:
GLib.idle_add(
ErrorMessageModalPopup.
display_nonfatal_warning_message, self.builder,
"Could not find physical volume UUID pv_uuid in "
+ str(vg_dict))
continue
relevant_vg_name_dict[vg_name] = partition_key
lvm_vg_dev_list_filepath = os.path.join(
self.dest_dir, "lvm_vg_dev.list")
with open(lvm_vg_dev_list_filepath,
'a+') as filehandle:
filehandle.write(vg_name + " " + partition_key +
" " + pv_uuid + "\n")
lv_state_dict = Lvm.get_logical_volume_state_dict(self.logger)
for report_dict in lv_state_dict['report']:
for lv_dict in report_dict['lv']:
# Only consider VGs that match the partitions to backup list
if 'vg_name' in lv_dict.keys(
) and lv_dict['vg_name'] in relevant_vg_name_dict.keys():
vg_name = lv_dict['vg_name']
if 'lv_path' in lv_dict.keys():
lv_path = lv_dict['lv_path']
else:
GLib.idle_add(
ErrorMessageModalPopup.
display_nonfatal_warning_message, self.builder,
"Could not find lv_path name in " + str(lv_dict))
continue
file_command_process, flat_command_string, failed_message = Utility.run(
"logical volume file info",
["file", "--dereference", "--special-files", lv_path],
use_c_locale=True,
logger=self.logger)
if file_command_process.returncode != 0:
with self.summary_message_lock:
self.summary_message += failed_message
GLib.idle_add(self.completed_backup, False,
failed_message)
return
output = file_command_process.stdout.split(
" ", maxsplit=1)[1].strip()
lvm_logv_list_filepath = os.path.join(
self.dest_dir, "lvm_logv.list")
# Append to file
with open(lvm_logv_list_filepath, 'a+') as filehandle:
filehandle.write(lv_path + " " + output + "\n")
if 'lv_dm_path' in lv_dict.keys():
# Device mapper path, eg /dev/mapper/vgtest-lvtest
lv_dm_path = lv_dict['lv_dm_path']
else:
GLib.idle_add(
self.completed_backup, False,
"Could not find lv_dm_path name in " +
str(lv_dict))
return
if lv_dm_path in self.drive_state.keys(
) and 'partitions' in self.drive_state[lv_dm_path].keys():
# Remove the partition key associated with the volume group that contains this LVM logical volume
# eg, /dev/sdc1 with detected filesystem, and replace it with the logical volume filesystem.
# In other words, don't backup both the /dev/sdc1 device node AND the /dev/mapper node.
long_partition_key = relevant_vg_name_dict[
lv_dict['vg_name']]
self.partitions_to_backup.pop(long_partition_key, None)
for logical_volume in self.drive_state[lv_dm_path][
'partitions'].keys():
# Use the system drive state to get the exact filesystem for this /dev/mapper/ node,
# as derived from multiple sources (parted, lsblk etc) like how Clonezilla does it.
self.partitions_to_backup[
lv_path] = self.drive_state[lv_dm_path][
'partitions'][logical_volume]
self.partitions_to_backup[lv_path]['type'] = 'part'
lvm_vgname_filepath = os.path.join(
self.dest_dir, "lvm_" + vg_name + ".conf")
# TODO: Evaluate the Clonezilla message from 2013 message that this command won't work on NFS
# TODO: due to a vgcfgbackup file lock issue.
vgcfgbackup_process, flat_command_string, failed_message = Utility.run(
"Saving LVM VG config " + lvm_vgname_filepath, [
"vgcfgbackup", "--file", lvm_vgname_filepath,
vg_name
],
use_c_locale=True,
logger=self.logger)
if vgcfgbackup_process.returncode != 0:
with self.summary_message_lock:
self.summary_message += failed_message
GLib.idle_add(self.completed_backup, False,
failed_message)
return
filepath = os.path.join(self.dest_dir, "dev-fs.list")
with open(filepath, 'w') as filehandle:
filehandle.write('# <Device name> <File system>\n')
filehandle.write(
'# The file systems detected below are a combination of several sources. The values may differ from `blkid` and `parted`.\n'
)
for partition_key in self.partitions_to_backup.keys():
filesystem = self.partitions_to_backup[partition_key][
'filesystem']
filehandle.write('%s %s\n' % (partition_key, filesystem))
partition_number = 0
for partition_key in self.partitions_to_backup.keys():
partition_number += 1
total_progress_float = Utility.calculate_progress_ratio(
0, partition_number, len(self.partitions_to_backup.keys()))
GLib.idle_add(self.update_backup_progress_bar,
total_progress_float)
is_unmounted, message = Utility.umount_warn_on_busy(partition_key)
if not is_unmounted:
self.logger.write(message)
with self.summary_message_lock:
self.summary_message += message + "\n"
GLib.idle_add(self.completed_backup, False, message)
short_device_node = re.sub('/dev/', '', partition_key)
short_device_node = re.sub('/', '-', short_device_node)
filesystem = self.partitions_to_backup[partition_key]['filesystem']
if 'type' in self.partitions_to_backup[partition_key].keys() and 'extended' in \
self.partitions_to_backup[partition_key]['type']:
self.logger.write("Detected " + partition_key +
" as extended partition. Backing up EBR")
filepath = os.path.join(self.dest_dir,
short_device_node + "-ebr")
process, flat_command_string, failed_message = Utility.run(
"Saving " + filepath, [
"dd", "if=" + partition_key, "of=" + filepath,
"bs=512", "count=1"
],
use_c_locale=False,
logger=self.logger)
if process.returncode != 0:
with self.summary_message_lock:
self.summary_message += failed_message
GLib.idle_add(self.completed_backup, False, failed_message)
return
if filesystem == 'swap':
filepath = os.path.join(
self.dest_dir, "swappt-" + short_device_node + ".info")
with open(filepath, 'w') as filehandle:
uuid = ""
label = ""
if 'uuid' in self.partitions_to_backup[partition_key].keys(
):
uuid = self.partitions_to_backup[partition_key]['uuid']
if 'label' in self.partitions_to_backup[
partition_key].keys():
label = self.partitions_to_backup[partition_key][
'label']
filehandle.write('UUID="%s"\n' % uuid)
filehandle.write('LABEL="%s"\n' % label)
with self.summary_message_lock:
self.summary_message += _(
"Successful backup of swap partition {partition_name}"
).format(partition_name=partition_key) + "\n"
continue
# Clonezilla uses -q2 priority by default (partclone > partimage > dd).
# PartImage does not appear to be maintained software, so for simplicity, Rescuezilla is using a
# partclone > partclone.dd priority
# [1] https://clonezilla.org/clonezilla-live/doc/01_Save_disk_image/advanced/09-advanced-param.php
# Expand upon Clonezilla's ocs-get-comp-suffix() function
compression_suffix = "gz"
split_size = "4GB"
# Partclone dd blocksize (16MB)
partclone_dd_bs = "16777216"
# TODO: Re-enable APFS support -- currently partclone Apple Filesystem is not used because it's too unstable [1]
# [1] https://github.com/rescuezilla/rescuezilla/issues/65
if shutil.which("partclone." +
filesystem) is not None and filesystem != "apfs":
partclone_cmd_list = [
"partclone." + filesystem, "--logfile",
"/var/log/partclone.log", "--clone", "--source",
partition_key, "--output", "-"
]
filepath = os.path.join(
self.dest_dir, short_device_node + "." + filesystem +
"-ptcl-img." + compression_suffix + ".")
split_cmd_list = [
"split", "--suffix-length=2", "--bytes=" + split_size, "-",
filepath
]
elif shutil.which("partclone.dd") is not None:
partclone_cmd_list = [
"partclone.dd", "--buffer_size=" + partclone_dd_bs,
"--logfile", "/var/log/partclone.log", "--source",
partition_key, "--output", "-"
]
filepath = os.path.join(
self.dest_dir, short_device_node + ".dd-ptcl-img." +
compression_suffix + ".")
split_cmd_list = [
"split", "--suffix-length=2", "--bytes=" + split_size, "-",
filepath
]
else:
GLib.idle_add(self.completed_backup, False,
"Partclone not found.")
return
filesystem_backup_message = _(
"Backup {partition_name} containing filesystem {filesystem} to {destination}"
).format(partition_name=partition_key,
filesystem=filesystem,
destination=filepath)
GLib.idle_add(self.update_main_statusbar,
filesystem_backup_message)
self.logger.write(filesystem_backup_message)
gzip_cmd_list = ["gzip", "--stdout"]
self.proc['partclone_backup_' + partition_key] = subprocess.Popen(
partclone_cmd_list,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
env=env,
encoding='utf-8')
self.proc['gzip_' + partition_key] = subprocess.Popen(
gzip_cmd_list,
stdin=self.proc['partclone_backup_' + partition_key].stdout,
stdout=subprocess.PIPE,
env=env,
encoding='utf-8')
self.proc['split_' + partition_key] = subprocess.Popen(
split_cmd_list,
stdin=self.proc['gzip_' + partition_key].stdout,
stdout=subprocess.PIPE,
env=env,
encoding='utf-8')
# Process partclone output. Partclone outputs an update every 3 seconds, so processing the data
# on the current thread, for simplicity.
# Poll process.stdout to show stdout live
while True:
if self.requested_stop:
return
output = self.proc['partclone_backup_' +
partition_key].stderr.readline()
if self.proc['partclone_backup_' +
partition_key].poll() is not None:
break
if output:
temp_dict = Partclone.parse_partclone_output(output)
if 'completed' in temp_dict.keys():
total_progress_float = Utility.calculate_progress_ratio(
temp_dict['completed'] / 100.0, partition_number,
len(self.partitions_to_backup.keys()))
GLib.idle_add(self.update_backup_progress_bar,
total_progress_float)
if 'remaining' in temp_dict.keys():
GLib.idle_add(
self.update_backup_progress_status,
filesystem_backup_message + "\n\n" + output)
rc = self.proc['partclone_backup_' + partition_key].poll()
self.proc['partclone_backup_' + partition_key].stdout.close(
) # Allow p1 to receive a SIGPIPE if p2 exits.
self.proc['gzip_' + partition_key].stdout.close(
) # Allow p2 to receive a SIGPIPE if p3 exits.
output, err = self.proc['partclone_backup_' +
partition_key].communicate()
self.logger.write("Exit output " + str(output) + "stderr " +
str(err))
if self.proc['partclone_backup_' + partition_key].returncode != 0:
partition_summary = _(
"<b>Failed to backup partition</b> {partition_name}"
).format(partition_name=partition_key) + "\n"
with self.summary_message_lock:
self.summary_message += partition_summary
self.at_least_one_non_fatal_error = True
proc_stdout = self.proc['partclone_backup_' +
partition_key].stdout
proc_stderr = self.proc['partclone_backup_' +
partition_key].stderr
extra_info = "\nThe command used internally was:\n\n" + flat_command_string + "\n\n" + "The output of the command was: " + str(
proc_stdout) + "\n\n" + str(proc_stderr)
compression_stderr = self.proc['gzip_' + partition_key].stderr
if compression_stderr is not None and compression_stderr != "":
extra_info += "\n\n" + str(
gzip_cmd_list) + " stderr: " + compression_stderr
# TODO: Try to backup again, but using partclone.dd
GLib.idle_add(
ErrorMessageModalPopup.display_nonfatal_warning_message,
self.builder, partition_summary + extra_info)
else:
with self.summary_message_lock:
self.summary_message += _(
"Successful backup of partition {partition_name}"
).format(partition_name=partition_key) + "\n"
# GLib.idle_add(self.update_progress_bar, (i + 1) / len(self.restore_mapping_dict.keys()))
if self.requested_stop:
return
progress_ratio = i / len(self.partitions_to_backup.keys())
i += 1
# Display 100% progress for user
GLib.idle_add(self.update_backup_progress_bar, progress_ratio)
sleep(1.0)
"""
partclone_cmd_list = ["partclone", "--logfile", "/tmp/rescuezilla_logfile.txt", "--overwrite", "/dev/"]
if [ "$fs_p" != "dd" ]; then
cmd_partclone="partclone.${fs_p} $PARTCLONE_SAVE_OPT -L $partclone_img_info_tmp -c -s $source_dev --output - | $compress_prog_opt"
else
# Some parameters for partclone.dd are not required. Here "-c" is not provided by partclone.dd when saving.
cmd_partclone="partclone.${fs_p} $PARTCLONE_SAVE_OPT --buffer_size ${partclone_dd_bs} -L $partclone_img_info_tmp -s $source_dev --output - | $compress_prog_opt"
fi
case "$VOL_LIMIT" in
[1-9]*)
# $tgt_dir/${tgt_file}.${fs_pre}-img. is prefix, the last "." is necessary make the output file is like hda1.${fs_pre}-img.aa, hda1.${fs_pre}-img.ab. We do not add -d to make it like hda1.${fs_pre}-img.00, hda1.${fs_pre}-img.01, since it will confuse people that it looks like created by partimage (hda1.${fs_pre}-img.000, hda1.${fs_pre}-img.001)
cmd_partclone="${cmd_partclone} | split -a $split_suf_len -b ${VOL_LIMIT}MB - $tgt_dir/$(to_filename ${tgt_file}).${fs_pre}-img.${comp_suf}. 2> $split_error"
;;
*)
cmd_partclone="${cmd_partclone} > $tgt_dir/$(to_filename ${tgt_file}).${fs_pre}-img.${comp_suf} 2> $split_error"
;;
esac
echo "Run partclone: $cmd_partclone" | tee --append ${OCS_LOGFILE}
LC_ALL=C eval "(${cmd_partclone} && exit \${PIPESTATUS[0]})"
cmd_partimage = "partimage $DEFAULT_PARTIMAGE_SAVE_OPT $PARTIMAGE_SAVE_OPT -B gui=no save $source_dev stdout | $compress_prog_opt"
#case
#"$VOL_LIMIT" in
#[1 - 9] *)
# "$tgt_dir/${tgt_file}." is prefix, the last "." is necessary
# make the output file is like hda1.aa, hda1.ab.
# We do not add -d to make it like hda1.00, hda1.01, since it will confuse people that it looks like created by partimage (hda1.000, hda1.001)
cmd_partimage = "${cmd_partimage} | split -a $split_suf_len -b ${VOL_LIMIT}MB - $tgt_dir/${tgt_file}."
"""
# Do checksum
# IMG_ID=$(LC_ALL=C sha512sum $img_dir/clonezilla-img | awk -F" " '{print $1}')" >> $img_dir/Info-img-id.txt
GLib.idle_add(self.completed_backup, True, "")
