/* 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 XenAPI; using XenAdmin.Diagnostics.Problems; using XenAdmin.Core; using System.IO; using XenAdmin.Diagnostics.Problems.HostProblem; using System.Text.RegularExpressions; using System.Xml; using System.Collections.Generic; using XenAdmin.Actions; namespace XenAdmin.Diagnostics.Checks { class PatchPrecheckCheck : Check { private readonly Pool_patch _patch; private static Regex PrecheckErrorRegex = new Regex("()"); public PatchPrecheckCheck(Host host, Pool_patch patch) : base(host) { _patch = patch; } public override Problem RunCheck() { if (!Host.IsLive) return new HostNotLiveWarning(this, Host); if (!Host.Connection.IsConnected) throw new EndOfStreamException(Helpers.GetName(Host.Connection)); Session session = Host.Connection.DuplicateSession(); // // Check patch isn't already applied here // if (Patch.AppliedOn(Host) != DateTime.MaxValue) { return new PatchAlreadyApplied(this, Host); } try { return FindProblem(Pool_patch.precheck(session, Patch.opaque_ref, Host.opaque_ref)); } catch (Failure f) { log.Error(f.ToString()); if(f.ErrorDescription.Count>0) log.Error(f.ErrorDescription[0]); if (f.ErrorDescription.Count > 1) log.Error(f.ErrorDescription[1]); if (f.ErrorDescription.Count > 2) log.Error(f.ErrorDescription[2]); if (f.ErrorDescription.Count > 3) log.Error(f.ErrorDescription[3]); // try and find problem from the xapi failure Problem problem = FindProblem(f); return problem ?? new PrecheckFailed(this, Host, f); } } public override string Description { get { return Messages.SERVER_SIDE_CHECK_DESCRIPTION; } } public Pool_patch Patch { get { return _patch; } } private static readonly log4net.ILog log = log4net.LogManager.GetLogger(System.Reflection.MethodBase.GetCurrentMethod().DeclaringType); /// /// Find problem from xml result /// /// xml result, as returned by Pool_patch.precheck() call. /// E.g.: /// /// 2049859584 /// 10000000000 /// /// /// Problem or null, if no problem found private Problem FindProblem(string result) { if (!PrecheckErrorRegex.IsMatch(result.Replace("\n", ""))) return null; Match m = PrecheckErrorRegex.Match(result.Replace("\n", "")); XmlDocument doc = new XmlDocument(); doc.LoadXml(m.ToString()); log.Error(m.ToString()); XmlNode errorNode = doc.FirstChild; string errorcode = errorNode.Attributes != null && errorNode.Attributes["errorcode"] != null ? errorNode.Attributes["errorcode"].Value : string.Empty; if (errorcode == "") return null; var found = ""; var required = ""; foreach (XmlNode node in errorNode.ChildNodes) { if (node.Name == "found") found = node.InnerXml; else if (node.Name == "required") required = node.InnerXml; } var problem = FindProblem(errorcode, found, required); return problem ?? new PrecheckFailed(this, Host, new Failure(errorcode)); } /// /// Find problem from xapi Failure /// /// Xapi failure, thrown by Pool_patch.precheck() call. /// E.g.: failure.ErrorDescription.Count = 4 /// ErrorDescription[0] = "PATCH_PRECHECK_FAILED_WRONG_SERVER_VERSION" /// ErrorDescription[1] = "OpaqueRef:612b5eee-03dc-bbf5-3385-6905fdc9b079" /// ErrorDescription[2] = "6.5.0" /// ErrorDescription[3] = "^6\\.2\\.0$" /// E.g.: failure.ErrorDescription.Count = 2 /// ErrorDescription[0] = "OUT_OF_SPACE" /// ErrorDescription[1] = "/var/patch" /// /// Problem or null, if no problem found private Problem FindProblem(Failure failure) { if (failure.ErrorDescription.Count == 0) return null; var errorcode = failure.ErrorDescription[0]; var found = ""; var required = ""; if (failure.ErrorDescription.Count > 2) found = failure.ErrorDescription[2]; if (failure.ErrorDescription.Count > 3) required = failure.ErrorDescription[3]; return FindProblem(errorcode, found, required); } private Problem FindProblem(string errorcode, string found, string required) { switch (errorcode) { case "PATCH_PRECHECK_FAILED_WRONG_SERVER_VERSION": return new WrongServerVersion(this, required, Host); case "PATCH_PRECHECK_FAILED_OUT_OF_SPACE": System.Diagnostics.Trace.Assert(Helpers.CreamOrGreater(Host.Connection)); // If not Cream or greater, we shouldn't get this error long requiredSpace = 0; long foundSpace = 0; long.TryParse(found, out foundSpace); long.TryParse(required, out requiredSpace); // get reclaimable disk space (excluding current patch) long reclaimableDiskSpace = 0; try { var args = new Dictionary { { "exclude", Patch.uuid } }; var resultReclaimable = Host.call_plugin(Host.Connection.Session, Host.opaque_ref, "disk-space", "get_reclaimable_disk_space", args); reclaimableDiskSpace = Convert.ToInt64(resultReclaimable); } catch (Failure failure) { log.WarnFormat("Plugin call disk-space.get_reclaimable_disk_space on {0} failed with {1}", Host.Name, failure.Message); } var diskSpaceReq = new DiskSpaceRequirements(DiskSpaceRequirements.OperationTypes.install, Host, Patch.Name, requiredSpace, foundSpace, reclaimableDiskSpace); return new HostOutOfSpaceProblem(this, Host, Patch, diskSpaceReq); case "OUT_OF_SPACE": if (Helpers.CreamOrGreater(Host.Connection)) { var action = new GetDiskSpaceRequirementsAction(Host, Patch, true); try { action.RunExternal(action.Session); } catch { log.WarnFormat("Could not get disk space requirements"); } if (action.Succeeded) return new HostOutOfSpaceProblem(this, Host, Patch, action.DiskSpaceRequirements); } break; } return null; } } }