WinMFCRestoreDlg.cpp

// Windows restore dialog.
// This dialog lets the user choose a restore point/folder and then calls the
// shared restore engine to create RESTORED_FOLDER.

#include "stdafx.h"

#include "WinMFCApp.h"
#include "WinMFCRestoreDlg.h"
#include "WinMFCFolderDlg.h"
#include "Common.h"
#include "Help/map.h"


// #defines
// --------

#ifdef _DEBUG
#define new DEBUG_NEW
#undef THIS_FILE
static char THIS_FILE[] = __FILE__;
#endif


// Class Functions
// ---------------

// Constructs the Restore dialog.  The caller normally pre-populates
// RestoreFolder with the most recent restore point before showing the dialog.
CRestoreDlg::CRestoreDlg(CWnd *Parent)
	: CDialog(CRestoreDlg::IDD, Parent),
	  m_UpdatingRestoreDestination(FALSE),
	  m_RestoreDestinationWasChanged(FALSE)
{
}


// Destroys the Restore dialog.  The child controls and font member clean up
// through normal MFC ownership, so no explicit destructor work is needed.
CRestoreDlg::~CRestoreDlg()
{
}


// Binds dialog controls to member variables.
void CRestoreDlg::DoDataExchange(CDataExchange *DX)
{
	// Let the base dialog bind any inherited state first.
	CDialog::DoDataExchange(DX);

	// Restore folder input, explanatory text, and image buttons.
	DDX_Control(DX, IDC_RESTORE_FOLDER, m_RestoreFolder);
	DDX_Control(DX, IDC_RESTORE_DESTINATION, m_RestoreDestination);
	DDX_Control(DX, IDC_RESTORE_FOLDER_LABEL, m_RestoreFolderLabel);
	DDX_Control(DX, IDC_RESTORE_DESTINATION_LABEL, m_RestoreDestinationLabel);
	DDX_Control(DX, IDC_RESTORE_EXPLANATION, m_RestoreExplanation);
	DDX_Control(DX, IDC_RESTORE_EXPLANATION_2, m_RestoreExplanation2);
	DDX_Control(DX, IDC_START_RESTORE, m_StartRestoreButton);
	DDX_Control(DX, IDC_CANCEL, m_CancelButton);
	DDX_Control(DX, IDC_HELP_BUTTON, m_HelpButton);
	DDX_Control(DX, IDC_RESTORE_BROWSE, m_RestoreBrowseButton);
	DDX_Control(DX, IDC_RESTORE_DESTINATION_BROWSE, m_RestoreDestinationBrowseButton);
}


// Message Map
// -----------

BEGIN_MESSAGE_MAP(CRestoreDlg, CDialog)
	ON_WM_ERASEBKGND()
	ON_STN_CLICKED(IDC_START_RESTORE, &CRestoreDlg::OnBnClickedStartRestore)
	ON_STN_CLICKED(IDC_CANCEL, &CRestoreDlg::OnStnClickedCancel)
	ON_STN_CLICKED(IDC_HELP_BUTTON, &CRestoreDlg::OnStnClickedHelpButton)
	ON_STN_CLICKED(IDC_RESTORE_BROWSE, &CRestoreDlg::OnStnClickedRestoreBrowse)
	ON_STN_CLICKED(IDC_RESTORE_DESTINATION_BROWSE, &CRestoreDlg::OnStnClickedRestoreDestinationBrowse)
	ON_EN_CHANGE(IDC_RESTORE_FOLDER, &CRestoreDlg::OnEnChangeRestoreFolder)
	ON_EN_CHANGE(IDC_RESTORE_DESTINATION, &CRestoreDlg::OnEnChangeRestoreDestination)
END_MESSAGE_MAP()


// Initialises colours, fonts, button images, and the starting restore folder.
// The dialog is positioned over the main dialog's folder area so the restore
// workflow visually replaces the normal From/To fields.
BOOL CRestoreDlg::OnInitDialog()
{
	CWnd *Parent;
	CWnd *ParentFromFolder;
	int Length;

	// Let MFC create and bind all controls before configuring them.
	CDialog::OnInitDialog();

	// Match static text backgrounds to the grey dialog background, and make the
	// explanatory text secondary.
	m_RestoreFolderLabel.SetBkColor(RGB(231, 231, 231));
	m_RestoreDestinationLabel.SetBkColor(RGB(231, 231, 231));
	m_RestoreExplanation.SetBkColor(RGB(231, 231, 231));
	m_RestoreExplanation2.SetBkColor(RGB(231, 231, 231));
	m_RestoreExplanation.SetTextColor(RGB(70, 70, 70));
	m_RestoreExplanation2.SetTextColor(RGB(70, 70, 70));

	// Keep the restore folder input styled like the main From/To folder fields.
	m_RestoreFolder.SetBkColor(RGB(255, 255, 255));
	m_RestoreFolder.SetEnabledColor(RGB(255, 255, 255));
	m_RestoreFolder.SetDisabledColor(RGB(223, 223, 223));
	m_RestoreFolderFont.CreatePointFont(120, L"Arial");
	m_RestoreFolder.SetFont(&m_RestoreFolderFont);
	m_RestoreDestination.SetBkColor(RGB(255, 255, 255));
	m_RestoreDestination.SetEnabledColor(RGB(255, 255, 255));
	m_RestoreDestination.SetDisabledColor(RGB(223, 223, 223));
	m_RestoreDestination.SetFont(&m_RestoreFolderFont);

	// Attach the bitmap images and hand cursor to the dialog buttons.
	m_StartRestoreButton.SetImages(IDB_START_RESTORE_ENABLED, IDB_START_RESTORE_ENABLED, MP_HAND);
	m_CancelButton.SetImages(IDB_CANCEL_RESTORE_ENABLED, IDB_CANCEL_RESTORE_ENABLED, MP_HAND);
	m_HelpButton.SetImages(IDB_HELP_RESTORE_ENABLED, IDB_HELP_RESTORE_ENABLED, MP_HAND);
	m_RestoreBrowseButton.SetImages(IDB_BROWSE_ENABLED, IDB_BROWSE_ENABLED, MP_HAND);
	m_RestoreDestinationBrowseButton.SetImages(IDB_BROWSE_ENABLED, IDB_BROWSE_ENABLED, MP_HAND);

	// Show the initial restore folder chosen by the caller.
	SetDlgItemText(IDC_RESTORE_FOLDER, (WVBString)RestoreFolder);
	SetDefaultRestoreDestination();

	// Prefer the parent window; fall back to the owner if this dialog was opened
	// through a slightly different MFC ownership path.
	Parent = GetParent();
	if (Parent == NULL) Parent = GetOwner();
	ParentFromFolder = Parent ? Parent->GetDlgItem(IDC_FROM_FOLDER) : NULL;

	// The Restore dialog is meant to sit over the main From/To folder controls,
	// not in the visual middle of the window.  Aligning the two edit controls
	// keeps the dialog in a predictable place even if the main window moves.
	if (Parent != NULL && ParentFromFolder != NULL && ::IsWindow(ParentFromFolder->GetSafeHwnd()))
	{
		CRect ParentRect;
		CRect DialogRect;
		CRect ParentFromRect;
		CRect RestoreFolderRect;
		int Top;

		Parent->GetWindowRect(&ParentRect);
		GetWindowRect(&DialogRect);
		ParentFromFolder->GetWindowRect(&ParentFromRect);
		m_RestoreFolder.GetWindowRect(&RestoreFolderRect);

		Top = ParentFromRect.top - (RestoreFolderRect.top - DialogRect.top);
		SetWindowPos(NULL, ParentRect.left, Top, ParentRect.Width(), DialogRect.Height(), SWP_NOZORDER | SWP_NOACTIVATE);
	}
	else
	{
		// If the expected parent controls are unavailable, fall back to normal
		// modal dialog centring.
		CenterWindow();
	}

	// Put the caret at the end of the restore folder.
	m_RestoreFolder.SetFocus();
	Length = m_RestoreFolder.LineLength();
	m_RestoreFolder.SetSel(Length, Length);

	// Focus was set explicitly.
	return FALSE;
}


// Paints the custom grey background used by the Restore dialog.
BOOL CRestoreDlg::OnEraseBkgnd(CDC *DC)
{
	CRect Rect;
	CBrush BackgroundBrush(RGB(231, 231, 231));
	CBrush *OldBrush;
	BOOL Result;

	// Fill the whole dialog with the same grey used by the custom labels.
	GetClientRect(&Rect);
	OldBrush = DC->SelectObject(&BackgroundBrush);
	Result = DC->PatBlt(0, 0, Rect.Width(), Rect.Height(), PATCOPY);

	// Restore the caller's brush before returning.
	DC->SelectObject(OldBrush);
	return Result;
}


// Appends the fixed output folder name to a selected parent without producing
// a doubled separator at a drive or folder boundary.
WVBString CRestoreDlg::AppendRestoredFolder(WVBString Parent)
{
	while (Parent.Length > 0 && Parent.Right(1) == L"\\"
		&& !(Parent.Length == 3 && Parent.Buffer[1] == L':'))
		Parent = Parent.Left(Parent.Length - 1);
	if (Parent.Right(1) == L"\\")
		return Parent + L"RESTORED_FOLDER";
	return Parent + L"\\RESTORED_FOLDER";
}


// Returns the parent of an output path, preserving a drive root such as E:\.
WVBString CRestoreDlg::GetRestoreParentFolder(WVBString Path)
{
	int i;

	while (Path.Length > 3 && Path.Right(1) == L"\\")
		Path = Path.Left(Path.Length - 1);
	for (i = Path.Length; i > 0; i--)
	{
		if (Path.Buffer[i - 1] == L'\\')
		{
			if (i == 3 && Path.Buffer[1] == L':')
				return Path.Left(3);
			return Path.Left(i - 1);
		}
	}
	return L"";
}


// Builds the default output shown to the user from the selected restore point.
WVBString CRestoreDlg::GetDefaultRestoreOutput()
{
	CString Value;
	WVBString Folder;

	GetDlgItemText(IDC_RESTORE_FOLDER, Value);
	Folder = (WVBString)Trim(VBString(Value));
	if (Folder == L"")
		return L"";
	return AppendRestoredFolder(Folder);
}


// Updates the destination while it is still following the restore-point field.
// Programmatic text changes are guarded so EN_CHANGE does not mark them manual.
void CRestoreDlg::SetDefaultRestoreDestination()
{
	WVBString Output;

	if (m_RestoreDestinationWasChanged)
		return;
	Output = GetDefaultRestoreOutput();
	m_UpdatingRestoreDestination = TRUE;
	SetDlgItemText(IDC_RESTORE_DESTINATION, Output);
	m_UpdatingRestoreDestination = FALSE;
}


// Keeps the automatic destination aligned with restore-point edits until the
// user explicitly changes or browses for another destination.
void CRestoreDlg::OnEnChangeRestoreFolder()
{
	SetDefaultRestoreDestination();
}


// Once the user edits the destination, later restore-point changes must not
// overwrite that choice.
void CRestoreDlg::OnEnChangeRestoreDestination()
{
	if (!m_UpdatingRestoreDestination)
		m_RestoreDestinationWasChanged = TRUE;
}


// Validates the selected restore folder and closes the dialog successfully.
// The actual restore work is started by the main dialog after this returns.
void CRestoreDlg::OnBnClickedStartRestore()
{
	CString Value, DestinationValue;
	WVBString DefaultOutput, DestinationOutput, DestinationParent;

	// Read the current edit-box text into the public RestoreFolder field.
	GetDlgItemText(IDC_RESTORE_FOLDER, Value);
	RestoreFolder = Trim(VBString(Value));

	// A restore needs an explicit existing restore point/folder.
	if (RestoreFolder == "")
	{
		AfxMessageBox(L"Please select the folder to restore.", MB_OK | MB_ICONINFORMATION);
		return;
	}
	if (!DirectoryExists(RestoreFolder))
	{
		AfxMessageBox(L"The selected restore folder does not exist.", MB_OK | MB_ICONEXCLAMATION);
		return;
	}

	// The text box shows the actual output.  Browse-generated paths end in the
	// fixed RESTORED_FOLDER name; a manually entered existing folder is treated
	// as a parent and receives that name automatically.
	GetDlgItemText(IDC_RESTORE_DESTINATION, DestinationValue);
	DestinationOutput = (WVBString)Trim(VBString(DestinationValue));
	if (DestinationOutput == L"")
	{
		AfxMessageBox(L"Please select the restore destination.", MB_OK | MB_ICONINFORMATION);
		return;
	}
	DefaultOutput = AppendRestoredFolder((WVBString)RestoreFolder);
	if (DestinationOutput.EqualsNoCase(DefaultOutput))
	{
		RestoreDestinationParent = "";
		RestoreOutputFolder = WVBStringToVBString(DefaultOutput);
	}
	else
	{
		if (DestinationOutput.Right(16).EqualsNoCase(L"\\RESTORED_FOLDER"))
			DestinationParent = GetRestoreParentFolder(DestinationOutput);
		else
		{
			DestinationParent = DestinationOutput;
			DestinationOutput = AppendRestoredFolder(DestinationParent);
		}

		if (!DirectoryExists(DestinationParent))
		{
			AfxMessageBox(L"The selected restore destination folder does not exist.", MB_OK | MB_ICONEXCLAMATION);
			return;
		}
		if (!RestoreDestinationIsOnDifferentDrive((WVBString)RestoreFolder, DestinationParent))
		{
			AfxMessageBox(L"An alternative restore destination must be on a different drive from the backup.", MB_OK | MB_ICONEXCLAMATION);
			return;
		}
		RestoreDestinationParent = WVBStringToVBString(DestinationParent);
		RestoreOutputFolder = WVBStringToVBString(DestinationOutput);
	}

	if (DirectoryExists((WVBString)RestoreOutputFolder) || FileExists((WVBString)RestoreOutputFolder))
	{
		AfxMessageBox(L"RESTORED_FOLDER already exists at the selected destination. Please rename or remove it before restoring.", MB_OK | MB_ICONEXCLAMATION);
		return;
	}

	// Restoring the complete restore point can consume substantial time and
	// disk space, so require a deliberate confirmation.  Ordinary subfolder
	// restores start immediately from the explicitly labelled button.
	if (RestoreSelectionIsWholeRestorePoint((WVBString)RestoreFolder))
	{
		if (AfxMessageBox(
			L"Restore the entire backup?\n\nThis may take a long time and require substantial disk space.",
			MB_YESNO | MB_ICONQUESTION | MB_DEFBUTTON2) != IDYES)
			return;
	}

	// Let the caller start the restore with the validated folder.
	CDialog::OnOK();
}


// Treat Enter like clicking the explicitly labelled default Start Restore
// button, including all validation and whole-restore confirmation.
void CRestoreDlg::OnOK()
{
	OnBnClickedStartRestore();
}


// Closes the Restore dialog without starting a restore.
void CRestoreDlg::OnStnClickedCancel()
{
	CDialog::OnCancel();
}


// Opens the help page for restoring files.
void CRestoreDlg::OnStnClickedHelpButton()
{
	ShowFastBackupHelp(GetSafeHwnd(), RESTORE);
}


// Lets the user browse for the restore folder and stores it in the edit box.
void CRestoreDlg::OnStnClickedRestoreBrowse()
{
	CString Value;
	VBString SelectedFolder;
	CEdit *Edit;
	int Length;
	LPCTSTR Title = _T("Select the folder to restore:");
	UINT Flags = BIF_RETURNONLYFSDIRS | BIF_USENEWUI | BIF_VALIDATE | BIF_NONEWFOLDERBUTTON;

	// Focus the edit box that will receive the selected path.
	Edit = (CEdit *)GetDlgItem(IDC_RESTORE_FOLDER);
	Edit->SetFocus();

	// Start from the current edit-box path, or from the dialog's initial
	// RestoreFolder value if the edit box is blank.
	Edit->GetWindowText(Value);
	SelectedFolder = Trim(VBString(Value));
	if (SelectedFolder == "") SelectedFolder = RestoreFolder;

	// Show the modern folder picker through the compatibility wrapper.
	CFolderDialog FolderDialog(Title, (WVBString)SelectedFolder, this, Flags);
	if (FolderDialog.DoModal() != IDOK) return;

	// Store the selected path in the edit box.
	SelectedFolder = FolderDialog.GetFolderPath();
	Edit->SetWindowText((WVBString)SelectedFolder);

	// Move the caret to the end of the selected folder.
	Length = Edit->LineLength();
	Edit->SetSel(Length, Length);
}


// Lets the user choose an existing parent folder for an alternative restore.
// The text box always shows the actual RESTORED_FOLDER that will be created.
void CRestoreDlg::OnStnClickedRestoreDestinationBrowse()
{
	CString Value;
	VBString SelectedFolder;
	WVBString CurrentOutput, Parent, Output;
	CEdit *Edit;
	int Length;
	LPCTSTR Title = _T("Select the parent folder for RESTORED_FOLDER:");
	UINT Flags = BIF_RETURNONLYFSDIRS | BIF_USENEWUI | BIF_VALIDATE | BIF_NONEWFOLDERBUTTON;

	Edit = (CEdit *)GetDlgItem(IDC_RESTORE_DESTINATION);
	Edit->SetFocus();
	Edit->GetWindowText(Value);
	CurrentOutput = (WVBString)Trim(VBString(Value));
	Parent = GetRestoreParentFolder(CurrentOutput);
	if (Parent == L"" || !DirectoryExists(Parent))
		Parent = CurrentOutput;

	SelectedFolder = WVBStringToVBString(Parent);
	CFolderDialog FolderDialog(Title, (WVBString)SelectedFolder, this, Flags);
	if (FolderDialog.DoModal() != IDOK) return;

	SelectedFolder = FolderDialog.GetFolderPath();
	Output = AppendRestoredFolder((WVBString)SelectedFolder);
	m_RestoreDestinationWasChanged = TRUE;
	m_UpdatingRestoreDestination = TRUE;
	Edit->SetWindowText(Output);
	m_UpdatingRestoreDestination = FALSE;

	Length = Edit->LineLength();
	Edit->SetSel(Length, Length);
}