function materializeLatest($scheduledBackup = false)
{
global $config;
// Validate
if ($scheduledBackup === false || !is_object($scheduledBackup)) {
throw new Exception('materializedSnapshotManager->materializeLatest: ' . "Error: Expected a scheduledBackup object to be passed as a parameter, but did not get one.");
}
// Find the latest backup snapshot for the scheduledBackup
$snapshotGroups = $scheduledBackup->getSnapshotGroupsNewestToOldest();
if (sizeOf($snapshotGroups) == 0) {
throw new Exception('materializedSnapshotManager->materializeLatest: ' . "Error: Expected to find at least one snapshot group for the scheduledBackup, but got none.");
}
// Get the latest snapshot and its info..
$latestSnapshot = $snapshotGroups[0]->getMostRecentCompletedBackupSnapshot();
$latestSnapInfo = $latestSnapshot->getInfo();
$latestSnapPath = $latestSnapshot->getPath();
// Attempt to get the materialized snapshot for the scheduled Backup into "prevMaterialized"
$prevMaterialized = $scheduledBackup->getMostRecentCompletedMaterializedSnapshot();
// if we DO get one then we need to create a new materializedSnapshot
if ($prevMaterialized != false) {
// Set state to UPDATING
$prevMaterialized->setStatus('UPDATING');
// Get the backup snapshot that the prevMaterialized is linked to
$prevSnapshot = $prevMaterialized->getBackupSnapshot();
// and its info..
$prevSnapInfo = $prevSnapshot->getInfo();
$prevSnapPath = $prevSnapshot->getPath();
// if the materialized is already the latest
if ($latestSnapshot->id == $prevSnapshot->id) {
// Just exit - nothing to do.
return true;
}
// otherwise proceed - initialize a new materializedSnapshot
$newMaterialized = new materializedSnapshot();
$newMaterialized->setLogStream($this->log);
try {
$newMaterialized->init($scheduledBackup, $latestSnapshot);
$materialPath = $newMaterialized->getPath();
// Is the group for the materializedSnapshot the same as the latest snapshot?
if ($latestSnapInfo['snapshot_group_num'] == $prevSnapInfo['snapshot_group_num']) {
// if yes - is the backupSnapshot the prevMaterialized is linked to a SEED?
if ($prevSnapInfo['type'] == 'SEED') {
// if yes then --
// we need to copy that seed to the new path first
$copyCommand = 'cp -R ' . $prevSnapPath . '/* ' . $materialPath . '/';
exec($copyCommand, $output, $returnVar);
if ($returnVar != 0) {
throw new Exception('materializedSnapshotManager->materializeLatest: ' . "Error: Failed to copy from {$prevSnapPath} to path {$materialPath} using command: {$copyCommand} -- Got output:\n" . implode("\n", $output));
}
} else {
// If the prevSnapshot is not a SEED then we need to move it to $materialPath
if (!rename($prevMaterialized->getPath(), $materialPath)) {
throw new Exception('materializedSnapshotManager->materializeLatest: ' . "Error: Failed to move {$prevSnapPath} to {$materialPath}.");
}
}
// now just roll forward, applying deltas step by step until we reach the current backup
$xbBinary = $scheduledBackup->getXtraBackupBinary();
$snapshotMerger = new backupSnapshotMerger();
$parentSnapshot = $prevSnapshot;
do {
$deltaSnapshot = $parentSnapshot->getChild();
$deltaPath = $deltaSnapshot->getPath();
$this->infolog->write('Merging incremental snapshot deltas from ' . $deltaPath . ' into path ' . $materialPath, XBM_LOG_INFO);
try {
$snapshotMerger->mergePaths($materialPath, $deltaPath, $xbBinary);
} catch (MergeException $mergeEx) {
// This snapshot merge failed during materialize
// We should remove the bad snapshot and it's children
// Get the group for the delta that just failed
$group = $deltaSnapshot->getSnapshotGroup();
// Get the snaps in the group from newest to oldest
$snapshotsForGroup = $group->getAllSnapshotsNewestToOldest();
// Iterate over them newest to oldest, destroying them, until we meet the one that failed
foreach ($snapshotsForGroup as $snap) {
$snap->destroy();
if ($snap->id == $deltaSnapshot->id) {
break;
}
}
throw new Exception('materializedSnapshotManager->materializeLatest: ' . "Error: An error occurred while trying to materialze the latest snapshot. A set of deltas" . " could not be merged successfully.\nThe offending incremental backup and any other backup snapshots that depend upon it have been deleted.\n" . $mergeEx->getErrorMessage());
}
$this->infolog->write('Done merging.', XBM_LOG_INFO);
$parentSnapshot = $deltaSnapshot;
} while ($deltaSnapshot->id != $latestSnapshot->id);
} else {
// if groups for snapshot differ, is the backupSnapshot that we need to update to a SEED?
if ($latestSnapInfo['type'] == 'SEED') {
// if yes, just create the symlink
$newMaterialized->symlinkToSnapshot($latestSnapshot);
} else {
// if no, copy the SEED for the snapshotGroup of the new snapshot to the new path, then apply deltas
$backupRestorer = new backupRestorer();
$backupRestorer->setInfoLogStream($this->infolog);
$backupRestorer->setLogStream($this->log);
try {
$backupRestorer->restoreLocal($latestSnap, $materialPath);
} catch (MergeException $mergeEx) {
// This snapshot merge failed during materialize
// We should remove the bad snapshot and it's children
$failSnap = $mergeEx->getFailedSnapshot();
// Get the group for the delta that just failed
$group = $failSnap->getSnapshotGroup();
// Get the snaps in the group from newest to oldest
$snapshotsForGroup = $group->getAllSnapshotsNewestToOldest();
// Iterate over them newest to oldest, destroying them, until we meet the one that failed
foreach ($snapshotsForGroup as $snap) {
$snap->destroy();
if ($snap->id == $failSnap->id) {
break;
}
}
throw new Exception('materializedSnapshotManager->materializeLatest: ' . "Error: An error occurred while trying to materialze the latest snapshot. A set of deltas" . " could not be merged successfully.\nThe offending incremental backup and any other backup snapshots that depend upon it have been deleted.\n" . $mergeEx->getErrorMessage());
}
}
}
// destroy the old snapshot
$prevMaterialized->destroy();
} catch (Exception $e) {
$prevMaterialized->destroy();
$newMaterialized->setStatus('FAILED');
if ($config['SYSTEM']['cleanup_on_failure'] == true) {
$newMaterialized->deleteFiles();
}
throw $e;
}
} else {
// If no previous materialized snapshot exists at all..
// Initialize a new materialized snapshot
$newMaterialized = new materializedSnapshot();
$newMaterialized->setLogStream($this->log);
try {
$newMaterialized->init($scheduledBackup, $latestSnapshot);
$materialPath = $newMaterialized->getPath();
// if we do not get one then check if the snapshot is a SEED
if ($latestSnapInfo['type'] == 'SEED') {
// if yes - just create a symlink to it
$newMaterialized->symlinkToSnapshot($latestSnapshot);
} else {
// if no - use the regular restore function to restore it to the target path
$backupRestorer = new backupRestorer();
$backupRestorer->setInfoLogStream($this->infolog);
$backupRestorer->setLogStream($this->log);
try {
$backupRestorer->restoreLocal($latestSnapshot, $materialPath);
} catch (MergeException $mergeEx) {
// This snapshot merge failed during materialize
// We should remove the bad snapshot and it's children
$failSnap = $mergeEx->getFailedSnapshot();
// Get the group for the delta that just failed
$group = $failSnap->getSnapshotGroup();
// Get the snaps in the group from newest to oldest
$snapshotsForGroup = $group->getAllSnapshotsNewestToOldest();
// Iterate over them newest to oldest, destroying them, until we meet the one that failed
foreach ($snapshotsForGroup as $snap) {
$snap->destroy();
if ($snap->id == $failSnap->id) {
break;
}
}
throw new Exception('materializedSnapshotManager->materializeLatest: ' . "Error: An error occurred while trying to materialze the latest snapshot. A set of deltas" . " could not be merged successfully.\nThe offending incremental backup and any other backup snapshots that depend upon it have been deleted.\n" . $mergeEx->getErrorMessage());
}
}
} catch (Exception $e) {
$newMaterialized->setStatus('FAILED');
if ($config['SYSTEM']['cleanup_on_failure'] == true) {
$newMaterialized->deleteFiles();
}
throw $e;
}
}
$newMaterialized->setStatus('COMPLETED');
}
function handleRestore($snapshot, $path)
{
global $config;
// Collect info regardless of class type
$scheduledBackup = $snapshot->getScheduledBackup();
$sbInfo = $scheduledBackup->getInfo();
$host = $scheduledBackup->getHost();
$hostInfo = $host->getInfo();
switch (get_class($snapshot)) {
// Handle regular backup snapshot
case 'backupSnapshot':
throw new Exception("dont handle regular snapshots yet");
break;
// Handle materialized snapshot
// Handle materialized snapshot
case 'materializedSnapshot':
$snapInfo = $snapshot->getInfo();
$backupSnapshot = $snapshot->getBackupSnapshot();
$bsInfo = $backupSnapshot->getInfo();
echo " -- Restoring --\n\n";
echo " About to restore the following snapshot:\n\n";
echo " Host: " . $hostInfo['hostname'] . " Backup Name: " . $sbInfo['name'] . " Snapshot ID: m" . $snapInfo['materialized_snapshot_id'] . " Snapshot Time: " . $bsInfo['snapshot_time'] . "\n\n";
break;
default:
throw new ProcessingException("Error: Encountered an unrecognized class of snapshot when restoring: " . get_class($snapshot));
break;
}
echo " To the following target path: {$path}\n\n";
// Confirm action...
$inputReader = new inputReader();
$input = $inputReader->readline("Are you sure? - Please type 'YES' to confirm: ");
if ($input != 'YES') {
echo "No 'YES' confirmation received, exiting...\n\n";
} else {
echo "\n\n";
// Check the file/dir exists
if (file_exists($path)) {
// If it is not a directory throw an error
if (!is_dir($path)) {
throw new ProcessingException("Error: A file already exists at the specified path that is not a directory.");
}
// If it is not writable throw an error
if (!is_writable($path)) {
throw new ProcessingException("Error: The specified path exists, but is not writable. Please check permissions and try again.");
}
// Proceed with restore here...
echo " Proceeding with restore. Please wait...\n\n";
$backupRestorer = new backupRestorer();
$backupRestorer->setLogStream($this->log);
$infolog = new logStream($config['LOGS']['logdir'] . '/hosts/' . $hostInfo['hostname'] . '.log', false, $config['LOGS']['level']);
$backupRestorer->setInfoLogStream($infolog);
$backupRestorer->restoreLocal($snapshot, $path);
} else {
// If path doesnt exist throw an error
throw new ProcessingException("Error: The specified path does not exist, please create it first.");
}
}
return;
}