protected override void ProcessRecord()
{
var psPath = SessionState.Path.GetUnresolvedProviderPathFromPSPath(UnattendFile, out _, out _);
var details = ServiceControlNewInstance.Load(psPath);
details.ServiceAccount = ServiceAccount;
details.ServiceAccountPwd = Password;
var zipfolder = Path.GetDirectoryName(MyInvocation.MyCommand.Module.Path);
var logger = new PSLogger(Host);
var installer = new UnattendServiceControlInstaller(logger, zipfolder);
try
{
logger.Info("Installing Service Control instance...");
if (installer.Add(details, PromptToProceed))
{
var instance = InstanceFinder.FindServiceControlInstance(details.Name);
if (instance != null)
{
WriteObject(PsServiceControl.FromInstance(instance));
}
else
{
throw new Exception("Unknown error creating instance");
}
}
}
catch (Exception ex)
{
ThrowTerminatingError(new ErrorRecord(ex, null, ErrorCategory.NotSpecified, null));
}
}
protected override void ProcessRecord()
{
var details = new ServiceControlNewInstance
{
InstallPath = InstallPath,
LogPath = LogPath,
DBPath = DBPath,
Name = Name,
DisplayName = string.IsNullOrWhiteSpace(DisplayName) ? Name : DisplayName,
ServiceDescription = Description,
ServiceAccount = ServiceAccount,
ServiceAccountPwd = ServiceAccountPassword,
HostName = HostName,
Port = Port,
DatabaseMaintenancePort = DatabaseMaintenancePort,
VirtualDirectory = VirtualDirectory,
AuditQueue = AuditQueue,
ErrorQueue = ErrorQueue,
AuditLogQueue = string.IsNullOrWhiteSpace(AuditLogQueue) ? null : AuditLogQueue,
ErrorLogQueue = string.IsNullOrWhiteSpace(ErrorLogQueue) ? null : ErrorLogQueue,
ForwardAuditMessages = ForwardAuditMessages.ToBool(),
ForwardErrorMessages = ForwardErrorMessages.ToBool(),
AuditRetentionPeriod = AuditRetentionPeriod,
ErrorRetentionPeriod = ErrorRetentionPeriod,
ConnectionString = ConnectionString,
TransportPackage = ServiceControlCoreTransports.All.First(t => t.Matches(Transport)),
SkipQueueCreation = SkipQueueCreation
};
var zipfolder = Path.GetDirectoryName(MyInvocation.MyCommand.Module.Path);
var logger = new PSLogger(Host);
var installer = new UnattendServiceControlInstaller(logger, zipfolder);
try
{
logger.Info("Installing Service Control instance...");
if (installer.Add(details, PromptToProceed))
{
var instance = InstanceFinder.FindServiceControlInstance(details.Name);
if (instance != null)
{
WriteObject(PsServiceControl.FromInstance(instance));
}
else
{
throw new Exception("Unknown error creating instance");
}
}
}
catch (Exception ex)
{
ThrowTerminatingError(new ErrorRecord(ex, null, ErrorCategory.NotSpecified, null));
}
}
protected override void ProcessRecord()
{
var logger = new PSLogger(Host);
var zipFolder = Path.GetDirectoryName(MyInvocation.MyCommand.Module.Path);
var installer = new UnattendServiceControlInstaller(logger, zipFolder);
foreach (var name in Name)
{
var options = new ServiceControlUpgradeOptions {
AuditRetentionPeriod = AuditRetentionPeriod, ErrorRetentionPeriod = ErrorRetentionPeriod, OverrideEnableErrorForwarding = ForwardErrorMessages, SkipQueueCreation = SkipQueueCreation
};
var instance = InstanceFinder.FindServiceControlInstance(name);
if (instance == null)
{
WriteWarning($"No action taken. An instance called {name} was not found");
break;
}
options.OverrideEnableErrorForwarding = ForwardErrorMessages;
// Migrate Value
if (!options.AuditRetentionPeriod.HasValue)
{
if (instance.AppConfig.AppSettingExists(SettingsList.HoursToKeepMessagesBeforeExpiring.Name))
{
var i = instance.AppConfig.Read(SettingsList.HoursToKeepMessagesBeforeExpiring.Name, -1);
if (i != -1)
{
options.AuditRetentionPeriod = TimeSpan.FromHours(i);
}
}
}
if (!options.OverrideEnableErrorForwarding.HasValue & !instance.AppConfig.AppSettingExists(SettingsList.ForwardErrorMessages.Name))
{
ThrowTerminatingError(new ErrorRecord(new Exception($"Upgrade of {instance.Name} aborted. ForwardErrorMessages parameter must be set to true or false because the configuration file has no setting for ForwardErrorMessages. This setting is mandatory as of version 1.12"), "UpgradeFailure", ErrorCategory.InvalidArgument, null));
}
if (!options.ErrorRetentionPeriod.HasValue & !instance.AppConfig.AppSettingExists(SettingsList.ErrorRetentionPeriod.Name))
{
ThrowTerminatingError(new ErrorRecord(new Exception($"Upgrade of {instance.Name} aborted. ErrorRetentionPeriod parameter must be set to timespan because the configuration file has no setting for ErrorRetentionPeriod. This setting is mandatory as of version 1.13"), "UpgradeFailure", ErrorCategory.InvalidArgument, null));
}
if (!options.AuditRetentionPeriod.HasValue & !instance.AppConfig.AppSettingExists(SettingsList.AuditRetentionPeriod.Name))
{
ThrowTerminatingError(new ErrorRecord(new Exception($"Upgrade of {instance.Name} aborted. AuditRetentionPeriod parameter must be set to timespan because the configuration file has no setting for AuditRetentionPeriod. This setting is mandatory as of version 1.13"), "UpgradeFailure", ErrorCategory.InvalidArgument, null));
}
if (!installer.Upgrade(instance, options))
{
ThrowTerminatingError(new ErrorRecord(new Exception($"Upgrade of {instance.Name} failed"), "UpgradeFailure", ErrorCategory.InvalidResult, null));
}
}
}
// ReSharper disable once UnusedMethodReturnValue.Global
public bool Delete(string instanceName, bool removeDB, bool removeLogs)
{
var instance = InstanceFinder.FindServiceControlInstance(instanceName);
instance.ReportCard = new ReportCard();
if (!instance.TryStopService())
{
logger.Error("Service failed to stop");
return(false);
}
try
{
instance.BackupAppConfig();
instance.Service.SetStartupMode("Disabled");
instance.Service.Delete();
instance.RemoveUrlAcl();
instance.RemoveBinFolder();
if (removeLogs)
{
instance.RemoveLogsFolder();
}
if (removeDB)
{
instance.RemoveDataBaseFolder();
}
foreach (var warning in instance.ReportCard.Warnings)
{
logger.Warn(warning);
}
if (instance.ReportCard.HasErrors)
{
foreach (var error in instance.ReportCard.Errors)
{
logger.Error(error);
}
return(false);
}
}
catch (Exception ex)
{
logger.Error(ex.Message);
return(false);
}
return(true);
}
internal ReportCard Delete(string instanceName, bool removeDB, bool removeLogs, IProgress <ProgressDetails> progress = null)
{
progress = progress ?? new Progress <ProgressDetails>();
progress.Report(0, 7, "Stopping instance...");
var instance = InstanceFinder.FindServiceControlInstance(instanceName);
instance.ReportCard = new ReportCard();
if (!instance.TryStopService())
{
return(new ReportCard
{
Errors = { "Service failed to stop" },
Status = Status.Failed
});
}
instance.BackupAppConfig();
progress.Report(1, 7, "Disabling startup...");
instance.Service.SetStartupMode("Disabled");
progress.Report(2, 7, "Deleting service...");
instance.Service.Delete();
progress.Report(3, 7, "Removing URL ACL...");
instance.RemoveUrlAcl();
progress.Report(4, 7, "Deleting install...");
instance.RemoveBinFolder();
if (removeLogs)
{
progress.Report(5, 7, "Deleting logs...");
instance.RemoveLogsFolder();
}
if (removeDB)
{
progress.Report(6, 7, "Deleting database...");
instance.RemoveDataBaseFolder();
}
progress.Report(new ProgressDetails());
instance.ReportCard.SetStatus();
return(instance.ReportCard);
}
internal ReportCard Upgrade(string instanceName, ServiceControlUpgradeOptions upgradeOptions, IProgress <ProgressDetails> progress = null)
{
progress = progress ?? new Progress <ProgressDetails>();
var instance = InstanceFinder.FindServiceControlInstance(instanceName);
instance.ReportCard = new ReportCard();
ZipInfo.ValidateZip();
progress.Report(0, 7, "Stopping instance...");
if (!instance.TryStopService())
{
return(new ReportCard
{
Errors = { "Service failed to stop" },
Status = Status.Failed
});
}
progress.Report(1, 7, "Backing up app.config...");
var backupFile = instance.BackupAppConfig();
try
{
progress.Report(2, 7, "Upgrading Files...");
instance.UpgradeFiles(ZipInfo.FilePath);
}
finally
{
progress.Report(3, 7, "Restoring app.config...");
instance.RestoreAppConfig(backupFile);
}
upgradeOptions.ApplyChangesToInstance(instance);
progress.Report(4, 6, "Removing database indexes...");
instance.RemoveDatabaseIndexes();
progress.Report(4, 6, "Updating Database...");
instance.UpdateDatabase(msg => progress.Report(5, 7, $"Updating Database...{Environment.NewLine}{msg}"));
progress.Report(6, 7, "Running Queue Creation...");
instance.SetupInstance();
instance.ReportCard.SetStatus();
return(instance.ReportCard);
}
protected override void ProcessRecord()
{
var logger = new PSLogger(Host);
var zipfolder = Path.GetDirectoryName(MyInvocation.MyCommand.Module.Path);
var installer = new UnattendServiceControlInstaller(logger, zipfolder);
foreach (var name in Name)
{
var instance = InstanceFinder.FindServiceControlInstance(name);
if (instance == null)
{
WriteWarning($"No action taken. An instance called {name} was not found");
break;
}
WriteObject(installer.Delete(instance.Name, RemoveDB.ToBool(), RemoveLogs.ToBool()));
}
}
internal ReportCard Add(ServiceControlNewInstance details, IProgress <ProgressDetails> progress, Func <PathInfo, bool> promptToProceed)
{
ZipInfo.ValidateZip();
var instanceInstaller = details;
instanceInstaller.ReportCard = new ReportCard();
//Validation
instanceInstaller.Validate(promptToProceed);
if (instanceInstaller.ReportCard.HasErrors || instanceInstaller.ReportCard.CancelRequested)
{
instanceInstaller.ReportCard.Status = Status.FailedValidation;
return(instanceInstaller.ReportCard);
}
progress.Report(3, 9, "Copying files...");
instanceInstaller.CopyFiles(ZipInfo.FilePath);
progress.Report(4, 9, "Writing configurations...");
instanceInstaller.WriteConfigurationFile();
progress.Report(5, 9, "Registering URL ACLs...");
instanceInstaller.RegisterUrlAcl();
progress.Report(6, 9, "Creating queues...");
instanceInstaller.SetupInstance();
if (!instanceInstaller.ReportCard.HasErrors)
{
progress.Report(7, 9, "Registering service...");
instanceInstaller.RegisterService();
//Post Installation
progress.Report(8, 9, "Starting service...");
var instance = InstanceFinder.FindServiceControlInstance(instanceInstaller.Name);
if (!instance.TryStartService())
{
instanceInstaller.ReportCard.Warnings.Add($"New instance did not startup - please check configuration for {instance.Name}");
}
}
instanceInstaller.ReportCard.SetStatus();
return(instanceInstaller.ReportCard);
}
protected override void ProcessRecord()
{
var logger = new PSLogger(Host);
var zipFolder = Path.GetDirectoryName(MyInvocation.MyCommand.Module.Path);
var installer = new UnattendAuditInstaller(logger, zipFolder);
foreach (var name in Name)
{
var instance = InstanceFinder.FindServiceControlInstance(name);
if (instance == null)
{
WriteWarning($"No action taken. An instance called {name} was not found");
break;
}
instance.SkipQueueCreation = SkipQueueCreation;
if (!installer.Upgrade(instance))
{
ThrowTerminatingError(new ErrorRecord(new Exception($"Upgrade of {instance.Name} failed"), "UpgradeFailure", ErrorCategory.InvalidResult, null));
}
}
}
public bool Add(ServiceControlAuditNewInstance details, Func <PathInfo, bool> promptToProceed)
{
ZipInfo.ValidateZip();
var checkLicenseResult = CheckLicenseIsValid();
if (!checkLicenseResult.Valid)
{
logger.Error($"Install aborted - {checkLicenseResult.Message}");
return(false);
}
var instanceInstaller = details;
instanceInstaller.ReportCard = new ReportCard();
instanceInstaller.Version = ZipInfo.Version;
//Validation
instanceInstaller.Validate(promptToProceed);
if (instanceInstaller.ReportCard.HasErrors)
{
foreach (var error in instanceInstaller.ReportCard.Errors)
{
logger.Error(error);
}
return(false);
}
try
{
instanceInstaller.CopyFiles(ZipInfo.FilePath);
instanceInstaller.WriteConfigurationFile();
instanceInstaller.RegisterUrlAcl();
instanceInstaller.SetupInstance();
instanceInstaller.RegisterService();
foreach (var warning in instanceInstaller.ReportCard.Warnings)
{
logger.Warn(warning);
}
if (instanceInstaller.ReportCard.HasErrors)
{
foreach (var error in instanceInstaller.ReportCard.Errors)
{
logger.Error(error);
}
return(false);
}
}
catch (Exception ex)
{
logger.Error(ex.Message);
return(false);
}
//Post Installation
var instance = InstanceFinder.FindServiceControlInstance(instanceInstaller.Name);
if (!instance.TryStartService())
{
logger.Warn("The service failed to start");
}
return(true);
}
public override async Task ExecuteAsync(InstanceDetailsViewModel model)
{
if (LicenseChecks)
{
var licenseCheckResult = installer.CheckLicenseIsValid();
if (!licenseCheckResult.Valid)
{
windowManager.ShowMessage("LICENSE ERROR", $"Upgrade could not continue due to an issue with the current license. {licenseCheckResult.Message}. Contact [email protected]", hideCancel: true);
return;
}
}
var instance = InstanceFinder.FindServiceControlInstance(model.Name);
instance.Service.Refresh();
var upgradeOptions = new ServiceControlUpgradeOptions();
if (!instance.AppConfig.AppSettingExists(SettingsList.ForwardErrorMessages.Name))
{
var result = windowManager.ShowYesNoCancelDialog("UPGRADE QUESTION - DISABLE ERROR FORWARDING", "Error messages can be forwarded to a secondary error queue known as the Error Forwarding Queue. This queue exists to allow external tools to receive error messages. If you do not have a tool processing messages from the Error Forwarding Queue this setting should be disabled.", "So what do you want to do ?", "Do NOT forward", "Yes I want to forward");
if (!result.HasValue)
{
//Dialog was cancelled
eventAggregator.PublishOnUIThread(new RefreshInstances());
return;
}
upgradeOptions.OverrideEnableErrorForwarding = !result.Value;
}
//Grab old setting if it exists
if (!instance.AppConfig.AppSettingExists(SettingsList.AuditRetentionPeriod.Name))
{
if (instance.AppConfig.AppSettingExists(SettingsList.HoursToKeepMessagesBeforeExpiring.Name))
{
var i = instance.AppConfig.Read(SettingsList.HoursToKeepMessagesBeforeExpiring.Name, -1);
if (i != -1)
{
upgradeOptions.AuditRetentionPeriod = TimeSpan.FromHours(i);
}
}
// No setting to migrate so display dialog
if (!upgradeOptions.AuditRetentionPeriod.HasValue)
{
var viewModel = new SliderDialogViewModel("UPGRADE QUESTION - DATABASE RETENTION",
"Service Control periodically purges audit messages from the database.",
"AUDIT RETENTION PERIOD",
"Please specify the age at which these records should be removed",
TimeSpanUnits.Hours,
SettingConstants.AuditRetentionPeriodMinInHours,
SettingConstants.AuditRetentionPeriodMaxInHours,
1,
24,
SettingConstants.AuditRetentionPeriodDefaultInHoursForUI);
if (windowManager.ShowSliderDialog(viewModel))
{
upgradeOptions.AuditRetentionPeriod = viewModel.Period;
}
else
{
//Dialog was cancelled
eventAggregator.PublishOnUIThread(new RefreshInstances());
return;
}
}
}
if (!instance.AppConfig.AppSettingExists(SettingsList.ErrorRetentionPeriod.Name))
{
var viewModel = new SliderDialogViewModel("UPGRADE QUESTION - DATABASE RETENTION",
"Service Control periodically purges resolved and archived error messages from the database.",
"ERROR RETENTION PERIOD",
"Please specify the age at which these records should be removed",
TimeSpanUnits.Days,
SettingConstants.ErrorRetentionPeriodMinInDays,
SettingConstants.ErrorRetentionPeriodMaxInDays,
1,
1,
SettingConstants.ErrorRetentionPeriodDefaultInDaysForUI);
if (windowManager.ShowSliderDialog(viewModel))
{
upgradeOptions.ErrorRetentionPeriod = viewModel.Period;
}
else
{
//Dialog was cancelled
eventAggregator.PublishOnUIThread(new RefreshInstances());
return;
}
}
var confirm = instance.Service.Status == ServiceControllerStatus.Stopped ||
windowManager.ShowYesNoDialog($"STOP INSTANCE AND UPGRADE TO {installer.ZipInfo.Version}", $"{model.Name} needs to be stopped in order to upgrade to version {installer.ZipInfo.Version}.", "Do you want to proceed?", "Yes I want to proceed", "No");
if (confirm)
{
using (var progress = model.GetProgressObject($"UPGRADING {model.Name}"))
{
var reportCard = new ReportCard();
var restartAgain = model.IsRunning;
var stopped = await model.StopService(progress);
if (!stopped)
{
eventAggregator.PublishOnUIThread(new RefreshInstances());
reportCard.Errors.Add("Failed to stop the service");
reportCard.SetStatus();
windowManager.ShowActionReport(reportCard, "ISSUES UPGRADING INSTANCE", "Could not upgrade instance because of the following errors:");
return;
}
reportCard = await Task.Run(() => installer.Upgrade(model.Name, upgradeOptions, progress));
if (reportCard.HasErrors || reportCard.HasWarnings)
{
windowManager.ShowActionReport(reportCard, "ISSUES UPGRADING INSTANCE", "Could not upgrade instance because of the following errors:", "There were some warnings while upgrading the instance:");
}
else
{
if (restartAgain)
{
var serviceStarted = await model.StartService(progress);
if (!serviceStarted)
{
reportCard.Errors.Add("The Service failed to start. Please consult the service control logs for this instance");
windowManager.ShowActionReport(reportCard, "UPGRADE FAILURE", "Instance reported this error after upgrade:");
}
}
}
}
eventAggregator.PublishOnUIThread(new RefreshInstances());
}
}
public override async Task ExecuteAsync(InstanceDetailsViewModel model)
{
if (LicenseChecks)
{
var licenseCheckResult = installer.CheckLicenseIsValid();
if (!licenseCheckResult.Valid)
{
windowManager.ShowMessage("LICENSE ERROR", $"Upgrade could not continue due to an issue with the current license. {licenseCheckResult.Message}. Contact [email protected]", hideCancel: true);
return;
}
}
var instance = InstanceFinder.FindServiceControlInstance(model.Name);
instance.Service.Refresh();
var upgradeOptions = new ServiceControlUpgradeOptions();
if (!instance.AppConfig.AppSettingExists(SettingsList.ForwardErrorMessages.Name))
{
var result = windowManager.ShowYesNoCancelDialog("UPGRADE QUESTION - DISABLE ERROR FORWARDING", "Error messages can be forwarded to a secondary error queue known as the Error Forwarding Queue. This queue exists to allow external tools to receive error messages. If you do not have a tool processing messages from the Error Forwarding Queue this setting should be disabled.", "So what do you want to do ?", "Do NOT forward", "Yes I want to forward");
if (!result.HasValue)
{
//Dialog was cancelled
eventAggregator.PublishOnUIThread(new RefreshInstances());
return;
}
upgradeOptions.OverrideEnableErrorForwarding = !result.Value;
}
//Grab old setting if it exists
if (!instance.AppConfig.AppSettingExists(SettingsList.AuditRetentionPeriod.Name))
{
if (instance.AppConfig.AppSettingExists(SettingsList.HoursToKeepMessagesBeforeExpiring.Name))
{
var i = instance.AppConfig.Read(SettingsList.HoursToKeepMessagesBeforeExpiring.Name, -1);
if (i != -1)
{
upgradeOptions.AuditRetentionPeriod = TimeSpan.FromHours(i);
}
}
// No setting to migrate so display dialog
if (!upgradeOptions.AuditRetentionPeriod.HasValue)
{
var viewModel = new SliderDialogViewModel("UPGRADE QUESTION - DATABASE RETENTION",
"Service Control periodically purges audit messages from the database.",
"AUDIT RETENTION PERIOD",
"Please specify the age at which these records should be removed",
TimeSpanUnits.Hours,
SettingConstants.AuditRetentionPeriodMinInHours,
SettingConstants.AuditRetentionPeriodMaxInHours,
1,
24,
SettingConstants.AuditRetentionPeriodDefaultInHoursForUI);
if (windowManager.ShowSliderDialog(viewModel))
{
upgradeOptions.AuditRetentionPeriod = viewModel.Period;
}
else
{
//Dialog was cancelled
eventAggregator.PublishOnUIThread(new RefreshInstances());
return;
}
}
}
if (!instance.AppConfig.AppSettingExists(SettingsList.ErrorRetentionPeriod.Name))
{
var viewModel = new SliderDialogViewModel("UPGRADE QUESTION - DATABASE RETENTION",
"Service Control periodically purges resolved and archived error messages from the database.",
"ERROR RETENTION PERIOD",
"Please specify the age at which these records should be removed",
TimeSpanUnits.Days,
SettingConstants.ErrorRetentionPeriodMinInDays,
SettingConstants.ErrorRetentionPeriodMaxInDays,
1,
1,
SettingConstants.ErrorRetentionPeriodDefaultInDaysForUI);
if (windowManager.ShowSliderDialog(viewModel))
{
upgradeOptions.ErrorRetentionPeriod = viewModel.Period;
}
else
{
//Dialog was cancelled
eventAggregator.PublishOnUIThread(new RefreshInstances());
return;
}
}
if (!instance.AppConfig.AppSettingExists(SettingsList.DatabaseMaintenancePort.Name))
{
var viewModel = new TextBoxDialogViewModel("UPGRADE QUESTION - MAINTENANCE PORT",
"When in the maintenance mode Service Control exposes the RavenDB database on a specified port.",
"MAINTENANCE PORT",
"", new MaintenancePortValidator());
if (windowManager.ShowTextBoxDialog(viewModel))
{
upgradeOptions.MaintenancePort = int.Parse(viewModel.Value);
}
else
{
//Dialog was cancelled
eventAggregator.PublishOnUIThread(new RefreshInstances());
return;
}
}
if (instance.Version.Major != installer.ZipInfo.Version.Major) //Upgrade to different major -> recommend DB backup
{
if (!windowManager.ShowYesNoDialog($"STOP INSTANCE AND UPGRADE TO {installer.ZipInfo.Version}",
$"{model.Name} is going to be upgraded to version {installer.ZipInfo.Version} which uses a different storage format. Database migration will be conducted "
+ " as part of the upgrade. It is recommended that you back up the database before upgrading. To read more about the back up process "
+ " see https://docs.particular.net/servicecontrol/backup-sc-database.",
"Do you want to proceed?",
"Yes I backed up the database and I want to proceed", "No"))
{
return;
}
var dbSize = instance.GetDatabaseSizeInGb();
if (dbSize >= 100) // 100GB
{
if (!windowManager.ShowYesNoDialog($"MIGRATE LARGE DATABASE", $"The database being upgraded is {dbSize.ToString("N0")} GB. Migrating this much data could take a long "
+ "time and ServiceControl will be stopped for that entire duration. It is recommended that you consider one of the other upgrade approaches instead.",
"Are you sure you want to migrate this database?", "Yes", "No"))
{
return;
}
}
}
else
{
if (instance.Service.Status != ServiceControllerStatus.Stopped &&
!windowManager.ShowYesNoDialog($"STOP INSTANCE AND UPGRADE TO {installer.ZipInfo.Version}",
$"{model.Name} needs to be stopped in order to upgrade to version {installer.ZipInfo.Version}.",
"Do you want to proceed?",
"Yes I want to proceed", "No"))
{
return;
}
}
using (var progress = model.GetProgressObject($"UPGRADING {model.Name}"))
{
var reportCard = new ReportCard();
var restartAgain = model.IsRunning;
var stopped = await model.StopService(progress);
if (!stopped)
{
eventAggregator.PublishOnUIThread(new RefreshInstances());
reportCard.Errors.Add("Failed to stop the service");
reportCard.SetStatus();
windowManager.ShowActionReport(reportCard, "ISSUES UPGRADING INSTANCE", "Could not upgrade instance because of the following errors:");
return;
}
reportCard = await Task.Run(() => installer.Upgrade(model.Name, upgradeOptions, progress));
if (reportCard.HasErrors || reportCard.HasWarnings)
{
windowManager.ShowActionReport(reportCard, "ISSUES UPGRADING INSTANCE", "Could not upgrade instance because of the following errors:", "There were some warnings while upgrading the instance:");
}
else
{
if (restartAgain)
{
var serviceStarted = await model.StartService(progress);
if (!serviceStarted)
{
reportCard.Errors.Add("The Service failed to start. Please consult the service control logs for this instance");
windowManager.ShowActionReport(reportCard, "UPGRADE FAILURE", "Instance reported this error after upgrade:");
}
}
}
}
eventAggregator.PublishOnUIThread(new RefreshInstances());
}
public override async Task ExecuteAsync(InstanceDetailsViewModel model)
{
if (LicenseChecks)
{
var licenseCheckResult = installer.CheckLicenseIsValid();
if (!licenseCheckResult.Valid)
{
windowManager.ShowMessage("LICENSE ERROR", $"Upgrade could not continue due to an issue with the current license. {licenseCheckResult.Message}. Contact [email protected]", hideCancel: true);
return;
}
}
var instance = InstanceFinder.FindServiceControlInstance(model.Name);
instance.Service.Refresh();
var upgradeInfo = UpgradeControl.GetUpgradeInfoForTargetVersion(installer.ZipInfo.Version, instance.Version);
var upgradeOptions = new ServiceControlUpgradeOptions {
UpgradeInfo = upgradeInfo
};
if (instance.Version < upgradeInfo.CurrentMinimumVersion)
{
windowManager.ShowMessage("VERSION UPGRADE INCOMPATIBLE",
"<Section xmlns=\"http://schemas.microsoft.com/winfx/2006/xaml/presentation\" xml:space=\"preserve\" TextAlignment=\"Left\" LineHeight=\"Auto\" IsHyphenationEnabled=\"False\" xml:lang=\"en-us\">\r\n" +
$"<Paragraph>You must upgrade to version {upgradeInfo.RecommendedUpgradeVersion} before upgrading to version {installer.ZipInfo.Version}:</Paragraph>\r\n" +
"<List MarkerStyle=\"Decimal\" Margin=\"0,0,0,0\" Padding=\"0,0,0,0\">\r\n" +
$"<ListItem Margin=\"48,0,0,0\"><Paragraph>Uninstall version {installer.ZipInfo.Version}.</Paragraph></ListItem>\r\n" +
$"<ListItem Margin=\"48,0,0,0\"><Paragraph>Download and install version {upgradeInfo.RecommendedUpgradeVersion} from https://github.com/Particular/ServiceControl/releases/tag/{upgradeInfo.RecommendedUpgradeVersion}</Paragraph></ListItem>" +
$"<ListItem Margin=\"48,0,0,0\"><Paragraph>Upgrade this instance to version {upgradeInfo.RecommendedUpgradeVersion}.</Paragraph></ListItem>\r\n" +
"<ListItem Margin=\"48,0,0,0\"><Paragraph>Download and install the latest version from https://particular.net/start-servicecontrol-download</Paragraph></ListItem>\r\n" +
"<ListItem Margin=\"48,0,0,0\"><Paragraph>Upgrade this instance to the latest version of ServiceControl.</Paragraph></ListItem>\r\n" +
"</List>\r\n" +
"</Section>",
hideCancel: true);
return;
}
if (!instance.AppConfig.AppSettingExists(SettingsList.ForwardErrorMessages.Name))
{
var result = windowManager.ShowYesNoCancelDialog("UPGRADE QUESTION - DISABLE ERROR FORWARDING", "Error messages can be forwarded to a secondary error queue known as the Error Forwarding Queue. This queue exists to allow external tools to receive error messages. If you do not have a tool processing messages from the Error Forwarding Queue this setting should be disabled.", "So what do you want to do ?", "Do NOT forward", "Yes I want to forward");
if (!result.HasValue)
{
//Dialog was cancelled
eventAggregator.PublishOnUIThread(new RefreshInstances());
return;
}
upgradeOptions.OverrideEnableErrorForwarding = !result.Value;
}
//Grab old setting if it exists
if (!instance.AppConfig.AppSettingExists(SettingsList.AuditRetentionPeriod.Name))
{
if (instance.AppConfig.AppSettingExists(SettingsList.HoursToKeepMessagesBeforeExpiring.Name))
{
var i = instance.AppConfig.Read(SettingsList.HoursToKeepMessagesBeforeExpiring.Name, -1);
if (i != -1)
{
upgradeOptions.AuditRetentionPeriod = TimeSpan.FromHours(i);
}
}
// No setting to migrate so display dialog
if (!upgradeOptions.AuditRetentionPeriod.HasValue)
{
var viewModel = new SliderDialogViewModel("INPUT REQUIRED - DATABASE RETENTION",
"Service Control periodically purges audit messages from the database.",
"AUDIT RETENTION PERIOD",
"Please specify the age at which these records should be removed",
TimeSpanUnits.Hours,
SettingConstants.AuditRetentionPeriodMinInHours,
SettingConstants.AuditRetentionPeriodMaxInHours,
1,
24,
SettingConstants.AuditRetentionPeriodDefaultInHoursForUI);
if (windowManager.ShowSliderDialog(viewModel))
{
upgradeOptions.AuditRetentionPeriod = viewModel.Period;
}
else
{
//Dialog was cancelled
eventAggregator.PublishOnUIThread(new RefreshInstances());
return;
}
}
}
if (!instance.AppConfig.AppSettingExists(SettingsList.ErrorRetentionPeriod.Name))
{
var viewModel = new SliderDialogViewModel("INPUT REQUIRED - DATABASE RETENTION",
"Service Control periodically purges resolved and archived error messages from the database.",
"ERROR RETENTION PERIOD",
"Please specify the age at which these records should be removed",
TimeSpanUnits.Days,
SettingConstants.ErrorRetentionPeriodMinInDays,
SettingConstants.ErrorRetentionPeriodMaxInDays,
1,
1,
SettingConstants.ErrorRetentionPeriodDefaultInDaysForUI);
if (windowManager.ShowSliderDialog(viewModel))
{
upgradeOptions.ErrorRetentionPeriod = viewModel.Period;
}
else
{
//Dialog was cancelled
eventAggregator.PublishOnUIThread(new RefreshInstances());
return;
}
}
if (!instance.AppConfig.AppSettingExists(SettingsList.DatabaseMaintenancePort.Name))
{
var viewModel = new TextBoxDialogViewModel("INPUT REQUIRED - MAINTENANCE PORT",
"When Service Control is set to maintenance mode it requires a prereserved port on which it exposes the RavenDB database.",
"MAINTENANCE PORT",
"Please specify an open port that will be used as the maintenance port",
new MaintenancePortValidator());
if (windowManager.ShowTextBoxDialog(viewModel))
{
upgradeOptions.MaintenancePort = int.Parse(viewModel.Value);
}
else
{
//Dialog was cancelled
eventAggregator.PublishOnUIThread(new RefreshInstances());
return;
}
}
if (upgradeInfo.DataBaseUpdate) //Database is being updated -> recommend DB backup
{
if (!windowManager.ShowYesNoDialog($"STOP INSTANCE AND UPGRADE TO {installer.ZipInfo.Version}",
$"{model.Name} is going to be upgraded to version {installer.ZipInfo.Version} which uses a different storage format. Database migration will be conducted "
+ " as part of the upgrade. It is recommended that you back up the database before upgrading. To read more about the back up process "
+ " see https://docs.particular.net/servicecontrol/backup-sc-database.",
"Do you want to proceed?",
"Yes I backed up the database and I want to proceed", "No"))
{
return;
}
var dbSize = instance.GetDatabaseSizeInGb();
if (dbSize >= 100) // 100GB
{
if (!windowManager.ShowYesNoDialog("MIGRATE LARGE DATABASE", $"The database being upgraded is {dbSize.ToString("N0")} GB. Migrating this much data could take a long "
+ "time and ServiceControl will be stopped for that entire duration. It is recommended that you consider one of the other upgrade approaches instead.",
"Are you sure you want to migrate this database?", "Yes", "No"))
{
return;
}
}
}
else
{
if (instance.Service.Status != ServiceControllerStatus.Stopped &&
!windowManager.ShowYesNoDialog($"STOP INSTANCE AND UPGRADE TO {installer.ZipInfo.Version}",
$"{model.Name} needs to be stopped in order to upgrade to version {installer.ZipInfo.Version}.",
"Do you want to proceed?",
"Yes I want to proceed", "No"))
{
return;
}
}
using (var progress = model.GetProgressObject($"UPGRADING {model.Name}"))
{
var reportCard = new ReportCard();
var restartAgain = model.IsRunning;
var stopped = await model.StopService(progress);
if (!stopped)
{
eventAggregator.PublishOnUIThread(new RefreshInstances());
reportCard.Errors.Add("Failed to stop the service");
reportCard.SetStatus();
windowManager.ShowActionReport(reportCard, "ISSUES UPGRADING INSTANCE", "Could not upgrade instance because of the following errors:");
return;
}
reportCard = await Task.Run(() => installer.Upgrade(instance, upgradeOptions, progress));
if (reportCard.HasErrors || reportCard.HasWarnings)
{
windowManager.ShowActionReport(reportCard, "ISSUES UPGRADING INSTANCE", "Could not upgrade instance because of the following errors:", "There were some warnings while upgrading the instance:");
}
else
{
if (restartAgain)
{
var serviceStarted = await model.StartService(progress);
if (!serviceStarted)
{
reportCard.Errors.Add("The Service failed to start. Please consult the service control logs for this instance");
windowManager.ShowActionReport(reportCard, "UPGRADE FAILURE", "Instance reported this error after upgrade:");
}
}
}
}
eventAggregator.PublishOnUIThread(new RefreshInstances());
}
