/* Copyright (c) Citrix Systems, Inc. * All rights reserved. * * Redistribution and use in source and binary forms, * with or without modification, are permitted provided * that the following conditions are met: * * * Redistributions of source code must retain the above * copyright notice, this list of conditions and the * following disclaimer. * * Redistributions in binary form must reproduce the above * copyright notice, this list of conditions and the * following disclaimer in the documentation and/or other * materials provided with the distribution. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. */ using System; using System.Collections.Generic; using System.ComponentModel; using System.Drawing; using System.IO; using System.Linq; using System.Reflection; using System.Threading; using log4net; using XenAdmin.Controls; using XenAdmin.Diagnostics.Problems; using XenAdmin.Dialogs; using XenAdmin.Wizards.PatchingWizard.PlanActions; using XenAPI; using XenAdmin.Actions; using XenAdmin.Core; namespace XenAdmin.Wizards.PatchingWizard { public partial class PatchingWizard_PatchingPage : XenTabPage { protected static readonly ILog log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType); public Dictionary LivePatchCodesByHost { get; set; } private bool _thisPageHasBeenCompleted = false; private BackgroundWorker actionsWorker = null; public PatchingWizard_PatchingPage() { InitializeComponent(); } #region Accessors public List SelectedMasters { private get; set; } public List SelectedServers { private get; set; } public List SelectedPools { private get; set; } public UpdateType SelectedUpdateType { private get; set; } public Pool_patch Patch { private get; set; } public Pool_update PoolUpdate { private get; set; } public string ManualTextInstructions { private get; set; } public bool IsAutomaticMode { private get; set; } public bool RemoveUpdateFile { private get; set; } public string SelectedNewPatch { private get; set; } public List ProblemsResolvedPreCheck { private get; set; } public Dictionary SuppPackVdis { private get; set; } #endregion public override string Text { get { return Messages.PATCHINGWIZARD_PATCHINGPAGE_TEXT; } } public override string PageTitle { get { return Messages.PATCHINGWIZARD_PATCHINGPAGE_TITLE; } } public override string HelpID { get { return "InstallUpdate"; } } public override bool EnablePrevious() { return false; } private bool _nextEnabled; public override bool EnableNext() { return _nextEnabled; } private bool _cancelEnabled; public override bool EnableCancel() { return _cancelEnabled; } protected override void PageLoadedCore(PageLoadedDirection direction) { if (_thisPageHasBeenCompleted) { actionsWorker = null; return; } if (!IsAutomaticMode) { textBoxLog.Text = ManualTextInstructions; List actions = new List(); if (SelectedUpdateType == UpdateType.ISO && PoolUpdate != null) { //Ely or greater: iso update format foreach (var server in SelectedServers) actions.Add(new ApplyUpdateAction(PoolUpdate, server)); } else { //legacy mode if (SelectedUpdateType != UpdateType.ISO) { foreach (var server in SelectedServers) actions.Add(new ApplyPatchAction(Patch, server)); } else actions.Add(new InstallSupplementalPackAction(SuppPackVdis, false)); } if (RemoveUpdateFile && SelectedUpdateType != UpdateType.ISO) { foreach (Pool pool in SelectedPools) { actions.Add(new PoolPatchCleanAction(pool, Patch, false)); } } using (var multipleAction = new MultipleAction(Connection, "", "", "", actions, true, true, true)) { multipleAction.Changed += action_Changed; multipleAction.Completed += action_Completed; multipleAction.RunAsync(); } return; } _nextEnabled = false; OnPageUpdated(); List planActions = new List(); foreach (Pool pool in SelectedPools) { var poolHosts = new List(pool.Connection.Cache.Hosts); Host master = SelectedServers.Find(host => host.IsMaster() && poolHosts.Contains(host)); //For Ely or greater: ISO updates only if (SelectedUpdateType == UpdateType.ISO && Helpers.ElyOrGreater(pool.Connection)) //updates for Ely (or higher) are always ISO { var poolUpdates = new List(pool.Connection.Cache.Pool_updates); var poolUpdate = poolUpdates.FirstOrDefault(u => u != null && string.Equals(u.uuid, PoolUpdate.uuid, StringComparison.OrdinalIgnoreCase)); //master first if (master != null && !poolUpdate.AppliedOn(master)) { planActions.AddRange(CompilePoolUpdateActionList(master, poolUpdate)); } //other hosts foreach (var host in SelectedServers.Where(s => poolHosts.Contains(s) && !s.IsMaster() && !poolUpdate.AppliedOn(s)).ToList()) { planActions.AddRange(CompilePoolUpdateActionList(host, poolUpdate)); } } // Legacy (pre-Ely) case: either ISO for supplemental packs (Pool_patch == null) or patch (Pool_patch != null) else { Pool_patch poolPatch = null; if (SelectedUpdateType != UpdateType.ISO) { List poolPatches = new List(pool.Connection.Cache.Pool_patches); poolPatch = poolPatches.Find(delegate(Pool_patch otherPatch) { if (Patch != null) return string.Equals(otherPatch.uuid, Patch.uuid, StringComparison.OrdinalIgnoreCase); return false; }); } //master first if (master != null && (poolPatch == null || poolPatch.AppliedOn(master) == DateTime.MaxValue)) planActions.AddRange(CompileActionList(master, poolPatch)); foreach (Host server in SelectedServers) { if (poolHosts.Contains(server)) { if (!server.IsMaster()) { // check patch isn't already applied here if (poolPatch == null || poolPatch.AppliedOn(server) == DateTime.MaxValue) planActions.AddRange(CompileActionList(server, poolPatch)); } } } if (RemoveUpdateFile) { planActions.Add(new RemoveUpdateFile(pool, poolPatch)); } } } //end pool in foreach planActions.Add(new UnwindProblemsAction(ProblemsResolvedPreCheck)); actionsWorker = new BackgroundWorker(); actionsWorker.DoWork += new DoWorkEventHandler(PatchingWizardAutomaticPatchWork); actionsWorker.WorkerReportsProgress = true; actionsWorker.ProgressChanged += new ProgressChangedEventHandler(actionsWorker_ProgressChanged); actionsWorker.RunWorkerCompleted += new RunWorkerCompletedEventHandler(actionsWorker_RunWorkerCompleted); actionsWorker.WorkerSupportsCancellation = true; actionsWorker.RunWorkerAsync(planActions); } #region manual_mode private void action_Completed(ActionBase sender) { _nextEnabled = true; _cancelEnabled = false; try { if (sender.Exception != null) { var multipleAction = sender as MultipleAction; var actionTitle = multipleAction != null ? multipleAction.SubActionTitle : sender.Title; Program.Invoke(Program.MainWindow, () => FinishedWithErrors(actionTitle, new Exception(actionTitle, sender.Exception))); } else Program.Invoke(Program.MainWindow, FinishedSuccessfully); } catch (Exception except) { Program.Invoke(Program.MainWindow, () => FinishedWithErrors(string.Empty, except)); } Program.Invoke(Program.MainWindow, OnPageUpdated); _thisPageHasBeenCompleted = true; } private void action_Changed(ActionBase sender) { AsyncAction action = (AsyncAction)sender; Program.Invoke(Program.MainWindow, delegate { progressBar.Value = action.PercentComplete; }); } #endregion #region automatic_mode private void actionsWorker_ProgressChanged(object sender, ProgressChangedEventArgs e) { if (!actionsWorker.CancellationPending) { PlanAction action = (PlanAction)e.UserState; if (e.ProgressPercentage == 0) textBoxLog.Text += action; else { textBoxLog.Text += string.Format("{0}\r\n", Messages.DONE); progressBar.Value += e.ProgressPercentage; } } } private void PatchingWizardAutomaticPatchWork(object obj, DoWorkEventArgs doWorkEventArgs) { List actionList = (List)doWorkEventArgs.Argument; foreach (PlanAction action in actionList) { try { if (actionsWorker.CancellationPending) { doWorkEventArgs.Cancel = true; return; } this.actionsWorker.ReportProgress(0, action); action.Run(); Thread.Sleep(1000); this.actionsWorker.ReportProgress((int)((1.0 / (double)actionList.Count) * 100), action); } catch (Exception e) { log.Error("Failed to carry out plan.", e); log.Debug(actionList); doWorkEventArgs.Result = new Exception(action.Title, e); break; } } } private void actionsWorker_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e) { if (!e.Cancelled) { Exception exception = e.Result as Exception; if (exception != null) { FinishedWithErrors(exception.Message, exception); // here exception.Message is the Title of the action that failed (see how doWorkEventArgs.Result is assigned above) } else { FinishedSuccessfully(); } progressBar.Value = 100; _cancelEnabled = false; _nextEnabled = true; } OnPageUpdated(); _thisPageHasBeenCompleted = true; } private List CompileActionList(Host host, Pool_patch patch) { if (SelectedUpdateType == UpdateType.ISO) return CompileSuppPackActionList(host); List actions = new List(); if (patch == null) return actions; actions.Add(new ApplyPatchPlanAction(host, patch)); if (patch.after_apply_guidance.Contains(after_apply_guidance.restartHost) && !(LivePatchCodesByHost != null && LivePatchCodesByHost.ContainsKey(host.uuid) && LivePatchCodesByHost[host.uuid] == livepatch_status.ok_livepatch_complete)) { actions.Add(new RestartHostPlanAction(host, host.GetRunningVMs())); } if (patch.after_apply_guidance.Contains(after_apply_guidance.restartXAPI)) { actions.Add(new RestartAgentPlanAction(host)); } if (patch.after_apply_guidance.Contains(after_apply_guidance.restartHVM)) { actions.Add(new RebootVMsPlanAction(host, host.GetRunningHvmVMs())); } if (patch.after_apply_guidance.Contains(after_apply_guidance.restartPV)) { actions.Add(new RebootVMsPlanAction(host, host.GetRunningPvVMs())); } return actions; } private List CompileSuppPackActionList(Host host) { List actions = new List(); if (SelectedUpdateType != UpdateType.ISO || SuppPackVdis == null || !SuppPackVdis.ContainsKey(host)) return actions; actions.Add(new InstallSupplementalPackPlanAction(host, SuppPackVdis[host])); // after_apply_guidance is restartHost actions.Add(new RestartHostPlanAction(host, host.GetRunningVMs())); return actions; } private List CompilePoolUpdateActionList(Host host, Pool_update poolUpdate) { List actions = new List(); if (SelectedUpdateType != UpdateType.ISO || poolUpdate == null) return actions; actions.Add(new ApplyPoolUpdatePlanAction(host, poolUpdate)); if (poolUpdate.after_apply_guidance.Contains(update_after_apply_guidance.restartHost) && !(LivePatchCodesByHost != null && LivePatchCodesByHost.ContainsKey(host.uuid) && LivePatchCodesByHost[host.uuid] == livepatch_status.ok_livepatch_complete)) { actions.Add(new RestartHostPlanAction(host, host.GetRunningVMs())); } if (poolUpdate.after_apply_guidance.Contains(update_after_apply_guidance.restartXAPI)) { actions.Add(new RestartAgentPlanAction(host)); } if (poolUpdate.after_apply_guidance.Contains(update_after_apply_guidance.restartHVM)) { actions.Add(new RebootVMsPlanAction(host, host.GetRunningHvmVMs())); } if (poolUpdate.after_apply_guidance.Contains(update_after_apply_guidance.restartPV)) { actions.Add(new RebootVMsPlanAction(host, host.GetRunningPvVMs())); } return actions; } #endregion private void FinishedWithErrors(string actionTitle, Exception exception) { labelTitle.Text = string.Format(Messages.UPDATE_WAS_NOT_COMPLETED, GetUpdateName()); string errorMessage = null; if (exception != null && exception.InnerException != null && exception.InnerException is Failure) { var innerEx = exception.InnerException as Failure; errorMessage = string.Format(Messages.STRING_SPACE_STRING, actionTitle, innerEx.Message); if (innerEx.ErrorDescription != null && innerEx.ErrorDescription.Count > 0) log.Error(string.Concat(innerEx.ErrorDescription.ToArray())); } labelError.Text = errorMessage ?? string.Format(Messages.PATCHING_WIZARD_ERROR, exception.Message); log.ErrorFormat("Error message displayed: {0}", labelError.Text); pictureBox1.Image = SystemIcons.Error.ToBitmap(); if (exception.InnerException is SupplementalPackInstallFailedException) { errorLinkLabel.Visible = true; errorLinkLabel.Tag = exception.InnerException; } panel1.Visible = true; } /// /// Live patching is attempted for a host if the LivePatchCodesByHost contains the LIVEPATCH_COMPLETE value for that host /// /// /// private bool LivePatchingAttemptedForHost(Host host) { return LivePatchCodesByHost != null && LivePatchCodesByHost.ContainsKey(host.uuid) && LivePatchCodesByHost[host.uuid] == livepatch_status.ok_livepatch_complete; } /// /// Returns true if has to be rebooted for this update /// private bool HostRequiresReboot(Host host) { return host.updates_requiring_reboot !=null && PoolUpdate != null && host.updates_requiring_reboot.Select(uRef => host.Connection.Resolve(uRef)).Any(u => u != null && u.uuid.Equals(PoolUpdate.uuid)); } private void FinishedSuccessfully() { labelTitle.Text = string.Format(Messages.UPDATE_WAS_SUCCESSFULLY_INSTALLED, GetUpdateName()); pictureBox1.Image = null; labelError.Text = Messages.CLOSE_WIZARD_CLICK_FINISH; // Live patching failed is per-host var livePatchingFailedHosts = new List(); foreach (var host in SelectedMasters) { if (LivePatchingAttemptedForHost(host) && HostRequiresReboot(host)) { livePatchingFailedHosts.Add(host); } } if (livePatchingFailedHosts.Count == 0) { return; } LivePatchingFailed(livePatchingFailedHosts); } private void LivePatchingFailed(IList hosts) { string dialogMessage; if (hosts.Count == 1) { dialogMessage = string.Format(Messages.LIVE_PATCHING_FAILED_ONE_HOST, hosts[0]); } else { dialogMessage = string.Format(Messages.LIVE_PATCHING_FAILED_MULTI_HOST, string.Join(Messages.LIST_SEPARATOR, hosts.Select(s => s.ToString().SurroundWith('\'')))); } using (var dlg = new ThreeButtonDialog( new ThreeButtonDialog.Details(SystemIcons.Warning, dialogMessage, Messages.XENCENTER), ThreeButtonDialog.ButtonOK)) { dlg.ShowDialog(Program.MainWindow); } } private string GetUpdateName() { if (Patch != null) return Patch.Name(); try { return new FileInfo(SelectedNewPatch).Name; } catch (Exception) { return SelectedNewPatch; } } private void errorLinkLabel_LinkClicked(object sender, System.Windows.Forms.LinkLabelLinkClickedEventArgs e) { if (errorLinkLabel.Tag is Exception) ShowMoreInfo(errorLinkLabel.Tag as Exception); } private void ShowMoreInfo(Exception exception) { if (!(exception is SupplementalPackInstallFailedException)) return; var msg = string.Format(Messages.SUPP_PACK_INSTALL_FAILED_MORE_INFO, exception.Message); using (var dlg = new ThreeButtonDialog(new ThreeButtonDialog.Details(SystemIcons.Error, msg))) { dlg.ShowDialog(this); } } } }