// // Copyright (c) Microsoft. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. // using System; using System.Linq; using System.Data.Common; using System.Data.SqlClient; using System.Threading.Tasks; using Microsoft.SqlServer.Management.Common; using Microsoft.SqlServer.Management.Smo; using Microsoft.SqlTools.ServiceLayer.Connection; using Microsoft.SqlTools.ServiceLayer.Connection.ReliableConnection; using Microsoft.SqlTools.ServiceLayer.DisasterRecovery.Contracts; using Microsoft.SqlTools.ServiceLayer.TaskServices; using Microsoft.SqlTools.Utility; using System.Collections.Concurrent; using Microsoft.SqlTools.ServiceLayer.Utility; namespace Microsoft.SqlTools.ServiceLayer.DisasterRecovery.RestoreOperation { /// /// Includes method to all restore operations /// public class RestoreDatabaseHelper { public const string LastBackupTaken = "lastBackupTaken"; private ConcurrentDictionary sessions = new ConcurrentDictionary(); /// /// Create a backup task for execution and cancellation /// /// /// internal async Task RestoreTaskAsync(SqlTask sqlTask) { sqlTask.AddMessage(SR.TaskInProgress, SqlTaskStatus.InProgress, true); RestoreDatabaseTaskDataObject restoreDataObject = sqlTask.TaskMetadata.Data as RestoreDatabaseTaskDataObject; TaskResult taskResult = null; if (restoreDataObject != null) { // Create a task to perform backup return await Task.Factory.StartNew(() => { TaskResult result = new TaskResult(); try { if (restoreDataObject.IsValid) { ExecuteRestore(restoreDataObject, sqlTask); result.TaskStatus = SqlTaskStatus.Succeeded; } else { result.TaskStatus = SqlTaskStatus.Failed; if (restoreDataObject.ActiveException != null) { result.ErrorMessage = restoreDataObject.ActiveException.Message; } else { result.ErrorMessage = SR.RestoreNotSupported; } } } catch (Exception ex) { result.TaskStatus = SqlTaskStatus.Failed; result.ErrorMessage = ex.Message; if (ex.InnerException != null) { result.ErrorMessage += Environment.NewLine + ex.InnerException.Message; } if (restoreDataObject != null && restoreDataObject.ActiveException != null) { result.ErrorMessage += Environment.NewLine + restoreDataObject.ActiveException.Message; } } return result; }); } else { taskResult = new TaskResult(); taskResult.TaskStatus = SqlTaskStatus.Failed; } return taskResult; } /// /// Async task to cancel restore /// public async Task CancelTaskAsync(SqlTask sqlTask) { RestoreDatabaseTaskDataObject restoreDataObject = sqlTask.TaskMetadata.Data as RestoreDatabaseTaskDataObject; TaskResult taskResult = null; if (restoreDataObject != null && restoreDataObject.IsValid) { // Create a task for backup cancellation request return await Task.Factory.StartNew(() => { foreach (Restore restore in restoreDataObject.RestorePlan.RestoreOperations) { restore.Abort(); } return new TaskResult { TaskStatus = SqlTaskStatus.Canceled }; }); } else { taskResult = new TaskResult(); taskResult.TaskStatus = SqlTaskStatus.Failed; } return taskResult; } /// /// Creates response which includes information about the server given to restore (default data location, db names with backupsets) /// public RestoreConfigInfoResponse CreateConfigInfoResponse(RestoreConfigInfoRequestParams restoreConfigInfoRequest) { RestoreConfigInfoResponse response = new RestoreConfigInfoResponse(); RestoreDatabaseTaskDataObject restoreTaskObject = CreateRestoreForNewSession(restoreConfigInfoRequest.OwnerUri); if (restoreTaskObject != null) { // Default Data folder path in the target server response.ConfigInfo.Add(RestoreOptionsHelper.DataFileFolder, restoreTaskObject.DefaultDataFileFolder); // Default log folder path in the target server response.ConfigInfo.Add(RestoreOptionsHelper.LogFileFolder, restoreTaskObject.DefaultLogFileFolder); // The db names with backup set response.ConfigInfo.Add(RestoreOptionsHelper.SourceDatabaseNamesWithBackupSets, restoreTaskObject.GetDatabaseNamesWithBackupSets()); } return response; } /// /// Creates a restore plan, The result includes the information about the backup set, /// the files and the database to restore to /// /// Restore requests /// Restore plan public RestorePlanResponse CreateRestorePlanResponse(RestoreDatabaseTaskDataObject restoreDataObject) { RestorePlanResponse response = new RestorePlanResponse() { DatabaseName = restoreDataObject.RestoreParams.TargetDatabaseName, PlanDetails = new System.Collections.Generic.Dictionary() }; try { if (restoreDataObject != null && restoreDataObject.IsValid) { UpdateRestorePlan(restoreDataObject); if (restoreDataObject != null && restoreDataObject.IsValid) { response.SessionId = restoreDataObject.SessionId; response.DatabaseName = restoreDataObject.TargetDatabase; response.PlanDetails.Add(RestoreOptionsHelper.TargetDatabaseName, RestorePlanDetailInfo.Create( name: RestoreOptionsHelper.TargetDatabaseName, currentValue: restoreDataObject.TargetDatabase, isReadOnly: !CanChangeTargetDatabase(restoreDataObject))); response.PlanDetails.Add(RestoreOptionsHelper.SourceDatabaseName, RestorePlanDetailInfo.Create( name: RestoreOptionsHelper.SourceDatabaseName, currentValue: restoreDataObject.RestorePlanner.DatabaseName)); response.PlanDetails.Add(RestoreOptionsHelper.ReadHeaderFromMedia, RestorePlanDetailInfo.Create( name: RestoreOptionsHelper.ReadHeaderFromMedia, currentValue: restoreDataObject.RestorePlanner.ReadHeaderFromMedia)); response.DbFiles = restoreDataObject.DbFiles.Select(x => new RestoreDatabaseFileInfo { FileType = x.DbFileType, LogicalFileName = x.LogicalName, OriginalFileName = x.PhysicalName, RestoreAsFileName = x.PhysicalNameRelocate }); response.CanRestore = CanRestore(restoreDataObject); if (!response.CanRestore) { response.ErrorMessage = SR.RestoreNotSupported; } response.PlanDetails.Add(LastBackupTaken, RestorePlanDetailInfo.Create(name: LastBackupTaken, currentValue: restoreDataObject.GetLastBackupTaken(), isReadOnly: true)); response.BackupSetsToRestore = restoreDataObject.GetSelectedBakupSets(); var dbNames = restoreDataObject.GetPossibleTargerDbNames(); response.DatabaseNamesFromBackupSets = dbNames == null ? new string[] { } : dbNames.ToArray(); RestoreOptionsHelper.AddOptions(response, restoreDataObject); } else { if (restoreDataObject.ActiveException != null) { response.ErrorMessage = restoreDataObject.ActiveException.Message; } else { response.ErrorMessage = SR.RestorePlanFailed; } response.CanRestore = false; } } else { response.ErrorMessage = SR.RestorePlanFailed; } } catch(Exception ex) { response.ErrorMessage = ex.Message; if (ex.InnerException != null) { response.ErrorMessage += Environment.NewLine; response.ErrorMessage += ex.InnerException.Message; } } return response; } /// /// Returns true if the restoring the restoreDataObject is supported in the service /// private static bool CanRestore(RestoreDatabaseTaskDataObject restoreDataObject) { return restoreDataObject != null && restoreDataObject.RestorePlan != null && restoreDataObject.RestorePlan.RestoreOperations != null && restoreDataObject.RestorePlan.RestoreOperations.Count > 0; } /// /// Creates anew restore task object to do the restore operations /// /// Restore request parameters /// Restore task object public RestoreDatabaseTaskDataObject CreateRestoreDatabaseTaskDataObject(RestoreParams restoreParams) { RestoreDatabaseTaskDataObject restoreTaskObject = null; string sessionId = string.IsNullOrWhiteSpace(restoreParams.SessionId) ? Guid.NewGuid().ToString() : restoreParams.SessionId; if (!sessions.TryGetValue(sessionId, out restoreTaskObject)) { restoreTaskObject = CreateRestoreForNewSession(restoreParams.OwnerUri, restoreParams.TargetDatabaseName); } restoreTaskObject.SessionId = sessionId; restoreTaskObject.RestoreParams = restoreParams; restoreTaskObject.TargetDatabase = restoreParams.TargetDatabaseName; restoreTaskObject.RestorePlanner.DatabaseName = restoreParams.TargetDatabaseName; return restoreTaskObject; } private RestoreDatabaseTaskDataObject CreateRestoreForNewSession(string ownerUri, string targetDatabaseName = null) { ConnectionInfo connInfo; DisasterRecoveryService.ConnectionServiceInstance.TryFindConnection( ownerUri, out connInfo); if (connInfo != null) { SqlConnection connection; DbConnection dbConnection = connInfo.AllConnections.First(); ReliableSqlConnection reliableSqlConnection = dbConnection as ReliableSqlConnection; SqlConnection sqlConnection = dbConnection as SqlConnection; if (reliableSqlConnection != null) { connection = reliableSqlConnection.GetUnderlyingConnection(); } else if (sqlConnection != null) { connection = sqlConnection; } else { Logger.Write(LogLevel.Warning, "Cannot find any sql connection for restore operation"); return null; } Server server = new Server(new ServerConnection(connection)); RestoreDatabaseTaskDataObject restoreDataObject = new RestoreDatabaseTaskDataObject(server, targetDatabaseName); return restoreDataObject; } return null; } /// /// Create a restore data object that includes the plan to do the restore operation /// /// /// private void UpdateRestorePlan(RestoreDatabaseTaskDataObject restoreDataObject) { if (!string.IsNullOrEmpty(restoreDataObject.RestoreParams.BackupFilePaths)) { restoreDataObject.AddFiles(restoreDataObject.RestoreParams.BackupFilePaths); } restoreDataObject.RestorePlanner.ReadHeaderFromMedia = restoreDataObject.RestoreParams.ReadHeaderFromMedia; if (string.IsNullOrWhiteSpace(restoreDataObject.RestoreParams.SourceDatabaseName)) { restoreDataObject.RestorePlanner.DatabaseName = restoreDataObject.DefaultDbName; } else { restoreDataObject.RestorePlanner.DatabaseName = restoreDataObject.RestoreParams.SourceDatabaseName; } if (CanChangeTargetDatabase(restoreDataObject)) { restoreDataObject.TargetDatabase = restoreDataObject.RestoreParams.TargetDatabaseName; } else { restoreDataObject.TargetDatabase = restoreDataObject.Server.ConnectionContext.DatabaseName; } restoreDataObject.UpdateRestorePlan(); } private bool CanChangeTargetDatabase(RestoreDatabaseTaskDataObject restoreDataObject) { return DatabaseUtils.IsSystemDatabaseConnection(restoreDataObject.Server.ConnectionContext.DatabaseName); } /// /// Executes the restore operation /// /// public void ExecuteRestore(RestoreDatabaseTaskDataObject restoreDataObject, SqlTask sqlTask = null) { // Restore Plan should be already created and updated at this point UpdateRestorePlan(restoreDataObject); if (restoreDataObject != null && CanRestore(restoreDataObject)) { try { restoreDataObject.SqlTask = sqlTask; restoreDataObject.Execute(); } catch(Exception ex) { throw ex; } } else { throw new InvalidOperationException(SR.RestoreNotSupported); } } } }