xenadmin/XenAdmin/Controls/MultipleDvdIsoList.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;
using System.Collections.Generic;
using System.ComponentModel;
using System.Drawing;
using System.Linq;
using System.Windows.Forms;
using XenAPI;
using XenAdmin.Actions;
using XenAdmin.Dialogs;
using XenAdmin.Network;


namespace XenAdmin.Controls
{
    public partial class MultipleDvdIsoList : UserControl
    {
        private bool _inRefresh;

        public MultipleDvdIsoList()
        {
            InitializeComponent();
        }
        
        [Browsable(false)]
        [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
        public VM VM
        {
            set
            {
                DeregisterEvents();
                cdChanger1.VM = value;
                if (value != null)
                    cdChanger1.VM.PropertyChanged += vm_PropertyChanged;
                RefreshDrives();
            }
            get => cdChanger1.VM;
        }

        #region Designer browsable properties

        [Browsable(true)]
        [Category("Appearance")]
        public Color LabelSingleDvdForeColor
        {
            get => labelSingleDvd.ForeColor;
            set => labelSingleDvd.ForeColor = value;
        }

        [Browsable(true)]
        [Category("Appearance")]
        public Color LabelNewCdForeColor
        {
            get => newCDLabel.ForeColor;
            set => newCDLabel.ForeColor = value;
        }

        [Browsable(true)]
        [Category("Appearance")]
        public Color LinkLabelLinkColor
        {
            get => linkLabelEject.LinkColor;
            set => linkLabelEject.LinkColor = value;
        }

        #endregion

        internal virtual void DeregisterEvents()
        {
            if (VM == null)
                return;

            // remove VM listeners
            VM.PropertyChanged -= vm_PropertyChanged;

            // remove cache listener
            VM.Connection.CachePopulated -= CachePopulatedMethod;

            // remove VBD listeners
            var vbds = VM.Connection.ResolveAll(VM.VBDs);
                
            foreach (var vbd in vbds.Where(vbd => vbd.IsCDROM() || vbd.IsFloppyDrive()))
            {
                vbd.PropertyChanged -= vbd_PropertyChanged;
            }
            cdChanger1.DeregisterEvents();
        }

        private void vm_PropertyChanged(object sender, PropertyChangedEventArgs e)
        {
            if (e.PropertyName == "VBDs")
                RefreshDrives();
        }

        private void RefreshDrives()
        {
            VbdCombiItem prevSelection = comboBoxDrive.SelectedItem as VbdCombiItem;
            _inRefresh = true;

            foreach (object o in comboBoxDrive.Items)
            {
                if (o is VbdCombiItem v)
                    v.Vbd.PropertyChanged -= vbd_PropertyChanged;
            }

            comboBoxDrive.Items.Clear();

            if (VM != null && !VM.is_control_domain)
            {
                List<VBD> vbds = VM.Connection.ResolveAll(VM.VBDs);
                if (vbds == null)
                {
                    // let's come back when the cache is populated
                    VM.Connection.CachePopulated += CachePopulatedMethod;
                    return;
                }

                vbds.RemoveAll(vbd => !vbd.IsCDROM() && !vbd.IsFloppyDrive());
                vbds.Sort();

                int dvdCount = 0;
                int floppyCount = 0;

                foreach (VBD vbd in vbds)
                {
                    vbd.PropertyChanged += vbd_PropertyChanged;
                    VbdCombiItem item;

                    if (vbd.IsCDROM())
                    {
                        dvdCount++;
                        item = new VbdCombiItem(string.Format(Messages.DVD_DRIVE_LABEL_NUMBERED, dvdCount), vbd);
                    }
                    else
                    {
                        floppyCount++;
                        item = new VbdCombiItem(string.Format(Messages.FLOPPY_DRIVE_LABEL_NUMBERED, floppyCount), vbd);
                    }
                    comboBoxDrive.Items.Add(item);
                }
            }

            labelSingleDvd.Visible = comboBoxDrive.Items.Count == 1;
            if (labelSingleDvd.Visible)
                labelSingleDvd.Text = comboBoxDrive.Items[0].ToString();

            comboBoxDrive.Visible = comboBoxDrive.Items.Count > 1;
            cdChanger1.Visible = comboBoxDrive.Items.Count > 0;
            linkLabelEject.Visible = comboBoxDrive.Items.Count > 0;
            newCDLabel.Visible = comboBoxDrive.Items.Count == 0 && VM != null && !VM.is_control_domain;

            _inRefresh = false;

            // Restore prev selection or select the top item by default
            if (prevSelection != null)
            {
                foreach (object o in comboBoxDrive.Items)
                {
                    if (o is VbdCombiItem v && v.Vbd.uuid == prevSelection.Vbd.uuid)
                    {
                        comboBoxDrive.SelectedItem = o;
                        return;
                    }
                }
            }

            comboBoxDrive.SelectedItem = comboBoxDrive.Items.Count == 0 ? null : comboBoxDrive.Items[0];
        }

        private void vbd_PropertyChanged(object sender, PropertyChangedEventArgs e)
        {
            RefreshDrives();
        }

        private void CachePopulatedMethod(IXenConnection conn)
        {
            VM.Connection.CachePopulated -= CachePopulatedMethod;
            RefreshDrives();
        }

        private class VbdCombiItem
        {
            public string Name { get; }
            public VBD Vbd { get; }

            public VbdCombiItem(string name, VBD vbd)
            {
                Name = name;
                Vbd = vbd;
            }

            public override string ToString()
            {
                return Name;
            }
        }

        private void comboBoxDrive_SelectedIndexChanged(object sender, EventArgs e)
        {
            if (_inRefresh)
                return;

            cdChanger1.Drive = (comboBoxDrive.SelectedItem as VbdCombiItem)?.Vbd;
        }

        private void newCDLabel_Click(object sender, EventArgs e)
        {
            if (VM == null)
                return;

            if (VM.IsHVM())
            {
                using (var dialog = new WarningDialog(
                           string.Format(Messages.NEW_DVD_DRIVE_CREATE_CONFIRMATION, VM.Name()),
                           new ThreeButtonDialog.TBDButton(Messages.NEW_DVD_DRIVE_CREATE_YES_BUTTON, DialogResult.Yes, ThreeButtonDialog.ButtonType.ACCEPT, true),
                           ThreeButtonDialog.ButtonNo))
                    if (dialog.ShowDialog(Program.MainWindow) != DialogResult.Yes)
                        return;
            }

            var createDriveAction = new CreateCdDriveAction(VM);
            createDriveAction.ShowUserInstruction += CreateDriveAction_ShowUserInstruction;

            using (var dlg = new ActionProgressDialog(createDriveAction, ProgressBarStyle.Marquee))
                dlg.ShowDialog(this);
        }

        private void CreateDriveAction_ShowUserInstruction(string message)
        {
            Program.Invoke(Program.MainWindow, () =>
            {
                if (!Program.RunInAutomatedTestMode)
                {
                    using (var dlg = new InformationDialog(message))
                        dlg.ShowDialog(Program.MainWindow);
                }
            });
        }

        private void linkLabelEject_LinkClicked(object sender, LinkLabelLinkClickedEventArgs e)
        {
            if (cdChanger1.Drive != null)
                cdChanger1.ChangeCD(null);
        }
    }
}