xenadmin/XenModel/Actions/SR/SrAction.cs

/* Copyright (c) Cloud Software Group, Inc. 
 * 
 * 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.Collections.Generic;
using XenAdmin.Core;
using XenAPI;


namespace XenAdmin.Actions
{
    public enum SrActionKind { SetAsDefault, Detach, Forget, Destroy, UnplugAndDestroyPBDs };

    public class SrAction : AsyncAction
    {
        private static readonly log4net.ILog log = log4net.LogManager.GetLogger(System.Reflection.MethodBase.GetCurrentMethod().DeclaringType);

        private readonly SrActionKind kind;

        public SrAction(SrActionKind kind, SR sr)
            : base(sr.Connection, GetTitle(kind, sr))
        {
            this.kind = kind;
            SR = sr;
            Pool pool = Helpers.GetPoolOfOne(sr.Connection);
            if (pool != null)
                Pool = pool;
            Host host = sr.GetStorageHost();
            if (host != null)
                Host = host;

            switch (kind)
            {
                case SrActionKind.Detach:
                    ApiMethodsToRoleCheck.Add("PBD.async_unplug");
                    break;
                case SrActionKind.Destroy:
                    ApiMethodsToRoleCheck.Add("SR.async_destroy");
                    break;
                case SrActionKind.Forget:
                    ApiMethodsToRoleCheck.Add("SR.async_forget");
                    break;
                case SrActionKind.SetAsDefault:
                    ApiMethodsToRoleCheck.AddRange(
                        "pool.set_crash_dump_SR",
                        "pool.set_default_SR",
                        "pool.set_suspend_image_SR");
                    break;
                case SrActionKind.UnplugAndDestroyPBDs:
                    ApiMethodsToRoleCheck.AddRange("PBD.async_unplug", "SR.async_destroy");
                break;
            }
        }

        private static string GetTitle(SrActionKind kind, SR sr)
        {
            switch (kind)
            {
                case SrActionKind.SetAsDefault:
                    return string.Format(Messages.ACTION_SR_SETTING_DEFAULT,
                        sr.Name(), Helpers.GetName(sr.Connection));

                case SrActionKind.Detach:
                case SrActionKind.UnplugAndDestroyPBDs:
                    return string.Format(Messages.ACTION_SR_DETACHING,
                        sr.Name(), Helpers.GetName(sr.Connection));

                case SrActionKind.Destroy:
                    return string.Format(Messages.ACTION_SR_DESTROYING,
                        sr.Name(), Helpers.GetName(sr.Connection));

                case SrActionKind.Forget:
                    return string.Format(Messages.ACTION_SR_FORGETTING,
                        sr.Name(), Helpers.GetName(sr.Connection));
            }

            return "";
        }

        protected override void Run()
        {
            log.DebugFormat("Running SrActionKind.{0}", kind.ToString());

            int inc = SR.PBDs.Count > 0 ? 100 / (SR.PBDs.Count * 2) : 0;

            switch (kind)
            {
                case SrActionKind.Detach:
                    UnplugPBDs(ref inc);
                    Description = string.Format(Messages.ACTION_SR_DETACH_SUCCESSFUL, SR.NameWithoutHost());
                    break;

                case SrActionKind.Destroy:
                    RelatedTask = SR.async_destroy(Session, SR.opaque_ref);
                    PollToCompletion(50, 100);
                    Description = Messages.ACTION_SR_DESTROY_SUCCESSFUL;
                    break;

                case SrActionKind.Forget:
                    Description = string.Format(Messages.FORGETTING_SR_0, SR.NameWithoutHost());
                    if (!SR.allowed_operations.Contains(storage_operations.forget))
                    {
                        Description = Messages.ERROR_DIALOG_FORGET_SR_TITLE;
                        break;
                    }
                        
                    RelatedTask = SR.async_forget(Session, SR.opaque_ref);
                    PollToCompletion();
                    Description = string.Format(Messages.SR_FORGOTTEN_0, SR.NameWithoutHost());
                    break;

                case SrActionKind.SetAsDefault:
                    XenRef<SR> srRef = new XenRef<SR>(SR);
                    Pool = Helpers.GetPoolOfOne(Connection);

                    if (Pool != null)
                    {
                        Description = string.Format(Messages.ACTION_SR_SETTING_DEFAULT, SR, Pool);
                        Pool poolCopy = (Pool)Pool.Clone();
                        poolCopy.crash_dump_SR = srRef;
                        poolCopy.default_SR = srRef;
                        poolCopy.suspend_image_SR = srRef;

                        try
                        {
                            Pool.Locked = true;
                            poolCopy.SaveChanges(Session);
                        }
                        finally
                        {
                            Pool.Locked = false;
                        }
                    }

                    Description = Messages.ACTION_SR_SET_DEFAULT_SUCCESSFUL;
                    break;

                case SrActionKind.UnplugAndDestroyPBDs:
                    UnplugPBDs(ref inc);
                    DestroyPBDs(ref inc);
                    Description = string.Format(Messages.ACTION_SR_DETACH_SUCCESSFUL, SR.NameWithoutHost());
                    break;

            }
        }

        private void UnplugPBDs(ref int inc)
        {
            if (SR.PBDs.Count < 1)
                return;

            //CA-176935, CA-173497 - we need to run Unplug for the coordinator last - creating a new list of hosts where the coordinator is always the last
            var allPBDRefsToNonCoordinator = new List<XenRef<PBD>>();
            var allPBDRefsToCoordinator = new List<XenRef<PBD>>();

            var coordinator = Helpers.GetCoordinator(Connection);

            foreach (var pbdRef in SR.PBDs)
            {
                var pbd = Connection.Resolve(pbdRef);
                if (pbd != null)
                {
                    if (pbd.host != null)
                    {
                        var host = Connection.Resolve(pbd.host);
                        if (coordinator != null && host != null && host.uuid == coordinator.uuid)
                        {
                            allPBDRefsToCoordinator.Add(pbdRef);
                        }
                        else
                        {
                            allPBDRefsToNonCoordinator.Add(pbdRef);
                        }
                    }
                }
            }

            var allPBDRefs = new List<XenRef<PBD>>();
            allPBDRefs.AddRange(allPBDRefsToNonCoordinator);
            allPBDRefs.AddRange(allPBDRefsToCoordinator);

            foreach (XenRef<PBD> pbd in allPBDRefs)
            {
                RelatedTask = PBD.async_unplug(Session, pbd.opaque_ref);
                PollToCompletion(PercentComplete, PercentComplete + inc);
            }
        }

        private void DestroyPBDs(ref int inc)
        {
            if (SR.PBDs.Count < 1)
                return;

            foreach (XenRef<PBD> pbd in SR.PBDs)
            {
                RelatedTask = PBD.async_destroy(Session, pbd.opaque_ref);
                PollToCompletion(PercentComplete, PercentComplete + inc);
            }
        }
    }
}