source: branches/2839_HiveProjectManagement/HeuristicLab.Clients.Hive.Administrator/3.3/Views/ResourcesView.cs @ 15792

#region License Information
/* HeuristicLab
 * Copyright (C) 2002-2017 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
 *
 * This file is part of HeuristicLab.
 *
 * HeuristicLab is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * HeuristicLab is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
 */
#endregion

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Drawing;
using System.Linq;
using System.Windows.Forms;
using HeuristicLab.Clients.Access;
using HeuristicLab.Clients.Hive.Views;
using HeuristicLab.Collections;
using HeuristicLab.Common.Resources;
using HeuristicLab.Core;
using HeuristicLab.Core.Views;
using HeuristicLab.MainForm;

namespace HeuristicLab.Clients.Hive.Administrator.Views {
  [View("Resources View")]
  [Content(typeof(IItemList<Resource>), false)]
  public partial class ResourcesView : ItemView, IDisposable {
    private const int slaveImageIndex = 0;
    private const int slaveGroupImageIndex = 1;
    public const string ungroupedGroupName = "UNGROUPED";
    public const string ungroupedGroupDescription = "Contains slaves that are not assigned to any group.";

    private readonly Color changedColor = Color.FromArgb(255, 87, 191, 193); // #57bfc1
    private readonly Color selectedColor = Color.FromArgb(255, 240, 194, 59); // #f0c23b
    private readonly Color calculatingColor = Color.FromArgb(255, 58, 114, 35); // #3a7223
    private readonly Color offlineColor = Color.FromArgb(255, 187, 36, 36); // #bb2424

    private Resource selectedResource = null;
    public Resource SelectedResource {
      get { return selectedResource; }
      set { if (selectedResource != value) ChangeSelectedResource(value); }
    }

    private readonly object locker = new object();

    public new IItemList<Resource> Content {
      get { return (IItemList<Resource>)base.Content; }
      set { base.Content = value; }
    }

    public ResourcesView() {
      InitializeComponent();

      treeView.ImageList.Images.Add(VSImageLibrary.MonitorLarge);
      treeView.ImageList.Images.Add(VSImageLibrary.NetworkCenterLarge);

      HiveAdminClient.Instance.Refreshing += HiveAdminClient_Instance_Refreshing;
      HiveAdminClient.Instance.Refreshed += HiveAdminClient_Instance_Refreshed;
      AccessClient.Instance.Refreshing += AccessClient_Instance_Refreshing;
      AccessClient.Instance.Refreshed += AccessClient_Instance_Refreshed;
    }

    #region Overrides
    protected override void OnClosing(FormClosingEventArgs e) {
      AccessClient.Instance.Refreshed -= AccessClient_Instance_Refreshed;
      AccessClient.Instance.Refreshing -= AccessClient_Instance_Refreshing;
      HiveAdminClient.Instance.Refreshed -= HiveAdminClient_Instance_Refreshed;
      HiveAdminClient.Instance.Refreshing -= HiveAdminClient_Instance_Refreshing;
      base.OnClosing(e);
    }

    protected override void RegisterContentEvents() {
      base.RegisterContentEvents();
      Content.ItemsAdded += Content_ItemsAdded;
      Content.ItemsRemoved += Content_ItemsRemoved;
    }

    protected override void DeregisterContentEvents() {
      Content.ItemsRemoved -= Content_ItemsRemoved;
      Content.ItemsAdded -= Content_ItemsAdded;
      base.DeregisterContentEvents();
    }

    protected override void OnContentChanged() {
      base.OnContentChanged();
      if (Content == null) {
        treeView.Nodes.Clear();
        viewHost.Content = null;
        scheduleView.Content = null;
      } else {
        BuildResourceTree(Content);
      }
    }

    protected override void SetEnabledStateOfControls() {
      base.SetEnabledStateOfControls();
      bool enabled = Content != null && !Locked && !ReadOnly && IsAdmin();
      btnAddGroup.Enabled = enabled;
      btnRemoveGroup.Enabled = enabled;
      btnSave.Enabled = enabled;
      scheduleView.SetEnabledStateOfSchedule(enabled && IsAdmin());
    }
    #endregion

    #region Event Handlers
    private void Content_ItemsAdded(object sender, CollectionItemsChangedEventArgs<IndexedItem<Resource>> e) {
      if (InvokeRequired) Invoke((Action<object, CollectionItemsChangedEventArgs<IndexedItem<Resource>>>)Content_ItemsAdded, sender, e);
      else {
        OnContentChanged();
      }
    }

    private void Content_ItemsRemoved(object sender, CollectionItemsChangedEventArgs<IndexedItem<Resource>> e) {
      if (InvokeRequired) Invoke((Action<object, CollectionItemsChangedEventArgs<IndexedItem<Resource>>>)Content_ItemsRemoved, sender, e);
      else {
        OnContentChanged();
      }
    }

    private void SlaveViewContent_PropertyChanged(object sender, PropertyChangedEventArgs e) {
      if (InvokeRequired) Invoke((Action<object, PropertyChangedEventArgs>)SlaveViewContent_PropertyChanged, sender, e);
      else {
        OnContentChanged();
        if (e.PropertyName == "HbInterval") {
          UpdateChildHbIntervall((Resource)viewHost.Content);
        }
      }
    }

    private void HiveAdminClient_Instance_Refreshing(object sender, EventArgs e) {
      if (InvokeRequired) Invoke((Action<object, EventArgs>)HiveAdminClient_Instance_Refreshing, sender, e);
      else {
        var mainForm = MainFormManager.GetMainForm<MainForm.WindowsForms.MainForm>();
        mainForm.AddOperationProgressToView(this, "Refreshing ...");
        SetEnabledStateOfControls();
      }
    }

    private void HiveAdminClient_Instance_Refreshed(object sender, EventArgs e) {
      if (InvokeRequired) Invoke((Action<object, EventArgs>)HiveAdminClient_Instance_Refreshed, sender, e);
      else {
        var mainForm = MainFormManager.GetMainForm<MainForm.WindowsForms.MainForm>();
        mainForm.RemoveOperationProgressFromView(this);
        SetEnabledStateOfControls();
      }
    }

    private void AccessClient_Instance_Refreshing(object sender, EventArgs e) {
      if (InvokeRequired) Invoke((Action<object, EventArgs>)AccessClient_Instance_Refreshing, sender, e);
      else {
        var mainForm = MainFormManager.GetMainForm<MainForm.WindowsForms.MainForm>();
        mainForm.AddOperationProgressToView(this, "Refreshing ...");
        SetEnabledStateOfControls();
      }
    }

    private void AccessClient_Instance_Refreshed(object sender, EventArgs e) {
      if (InvokeRequired) Invoke((Action<object, EventArgs>)AccessClient_Instance_Refreshed, sender, e);
      else {
        var mainForm = MainFormManager.GetMainForm<MainForm.WindowsForms.MainForm>();
        mainForm.RemoveOperationProgressFromView(this);
        SetEnabledStateOfControls();
      }
    }

    private async void ResourcesView_Load(object sender, EventArgs e) {
      await SecurityExceptionUtil.TryAsyncAndReportSecurityExceptions(
        action: () => UpdateResources());
    }

    private async void btnRefresh_Click(object sender, EventArgs e) {
      lock (locker) {
        if (!btnRefresh.Enabled) return;
        btnRefresh.Enabled = false;
      }

      await SecurityExceptionUtil.TryAsyncAndReportSecurityExceptions(
        action: () => UpdateResources(),
        finallyCallback: () => btnRefresh.Enabled = true);
    }

    private void btnAddGroup_Click(object sender, EventArgs e) {
      Guid? parentResourceId = null;
      if(!IsAdmin()) {
        MessageBox.Show(
          "You have no permission to add a resource group.",
          "HeuristicLab Hive Administrator",
          MessageBoxButtons.OK,
          MessageBoxIcon.Information);
        return;
      } else if(selectedResource != null && selectedResource.Id == Guid.Empty) {
        MessageBox.Show(
          "You cannot add a resource group to a not yet stored group.",
          "HeuristicLab Hive Administrator",
          MessageBoxButtons.OK,
          MessageBoxIcon.Information);
        return;
      }
      
      if (selectedResource != null && selectedResource is SlaveGroup) parentResourceId = selectedResource.Id;
      var group = new SlaveGroup {
        Name = "New Group",
        OwnerUserId = UserInformation.Instance.User.Id,
        ParentResourceId = parentResourceId
      };

      HiveAdminClient.Instance.UpdateResourceGenealogy(Content);
      SelectedResource = group;
      Content.Add(group);
    }

    private async void btnRemoveGroup_Click(object sender, EventArgs e) {
      if (selectedResource == null) return;

      lock (locker) {
        if (!btnRemoveGroup.Enabled) return;
        btnRemoveGroup.Enabled = false;
      }

      if (!IsAdmin()) {
        MessageBox.Show(
          "You have no permission to delete resources.",
          "HeuristicLab Hive Administrator",
          MessageBoxButtons.OK,
          MessageBoxIcon.Information);
        return;
      }

      if (Content.Any(x => x.ParentResourceId == selectedResource.Id)) {
        MessageBox.Show(
          "Only empty resources can be deleted.",
          "HeuristicLab Hive Administrator",
          MessageBoxButtons.OK,
          MessageBoxIcon.Error);
        return;
      }

      var result = MessageBox.Show(
        "Do you really want to delete " + selectedResource.Name + "?",
        "HeuristicLab Hive Administrator",
        MessageBoxButtons.YesNo,
        MessageBoxIcon.Question);
      if (result == DialogResult.Yes) {
        await SecurityExceptionUtil.TryAsyncAndReportSecurityExceptions(
          action: () => {
            RemoveResource(selectedResource);
          },
          finallyCallback: () => { 
            btnRemoveGroup.Enabled = true;
          });
      } 
    }

    private async void btnSave_Click(object sender, EventArgs e) {
      lock (locker) {
        if (!btnSave.Enabled) return;
        btnSave.Enabled = false;
      }

      await SecurityExceptionUtil.TryAsyncAndReportSecurityExceptions(
        action: () => {
          var resourcesToSave = Content.Where(x => x.Id == Guid.Empty || x.Modified);
          foreach (var resource in resourcesToSave)
            resource.Store();
          UpdateResources();
        },
        finallyCallback: () => btnSave.Enabled = true);

      OnContentChanged();
    }

    private void treeSlaveGroup_MouseDown(object sender, MouseEventArgs e) {
      var node = treeView.GetNodeAt(e.Location);
      if(node != null && !node.Text.StartsWith(ungroupedGroupName)) ChangeSelectedResourceNode(node);
    }

    private void treeSlaveGroup_BeforeSelect(object sender, TreeViewCancelEventArgs e) {
      e.Cancel = true;
    }

    private void treeSlaveGroup_DragDrop(object sender, DragEventArgs e) {
      if (e.Effect == DragDropEffects.None) return;

      var sourceNode = (TreeNode)e.Data.GetData(typeof(TreeNode));
      if (sourceNode == null) return;
      var sourceResource = ((Resource)sourceNode.Tag);
      if (sourceResource == null) return;

      var treeView = (TreeView)sender;
      if (sourceNode.TreeView != treeView) return;

      var targetPoint = treeView.PointToClient(new Point(e.X, e.Y));
      var targetNode = treeView.GetNodeAt(targetPoint);

      var targetResource = (targetNode != null) ? (Resource)targetNode.Tag : null;

      if(!HiveAdminClient.Instance.CheckParentChange(sourceResource, targetResource)) {
        MessageBox.Show(
          "You cannot drag resources to this group.",
          "HeuristicLab Hive Administrator",
          MessageBoxButtons.OK,
          MessageBoxIcon.Information);
        return;
      }

      if (sourceNode.Parent == null)
        treeView.Nodes.Remove(sourceNode);
      else {
        sourceNode.Parent.Nodes.Remove(sourceNode);
        sourceResource.ParentResourceId = null;
      }

      if (targetNode == null) {
        treeView.Nodes.Add(sourceNode);
      } else if(targetResource.Id != Guid.Empty) {
        targetNode.Nodes.Add(sourceNode);
        sourceResource.ParentResourceId = targetResource.Id;
      }

      HiveAdminClient.Instance.UpdateResourceGenealogy(Content);
      SelectedResource = sourceResource;
      OnContentChanged();
    }

    private void treeSlaveGroup_ItemDrag(object sender, ItemDragEventArgs e) {
      TreeNode sourceNode = (TreeNode)e.Item;
      if (IsAdmin())
        DoDragDrop(sourceNode, DragDropEffects.All);
    }

    private void treeSlaveGroup_DragEnterOver(object sender, DragEventArgs e) {
      e.Effect = DragDropEffects.Move;

      var sourceNode = (TreeNode)e.Data.GetData(typeof(TreeNode));
      var sourceResource = ((Resource)sourceNode.Tag);

      var targetPoint = treeView.PointToClient(new Point(e.X, e.Y));
      var targetNode = treeView.GetNodeAt(targetPoint);
      var targetResource = (targetNode != null) ? (Resource)targetNode.Tag : null;

      if(!IsAdmin() 
        || sourceNode == null 
        || sourceResource == null 
        || sourceNode == targetNode
        || !HiveAdminClient.Instance.CheckParentChange(sourceResource, targetResource)
        || (targetNode != null && (targetNode.Text.StartsWith(ungroupedGroupName) || targetNode.Parent != null && targetNode.Parent.Text.StartsWith(ungroupedGroupName)))) {
        e.Effect = DragDropEffects.None;
      }
    }

    private void treeSlaveGroup_QueryContinueDrag(object sender, QueryContinueDragEventArgs e) {
      e.Action = DragAction.Continue;
    }
    #endregion

    #region Helpers
    private void BuildResourceTree(IEnumerable<Resource> resources) {
      treeView.Nodes.Clear();
      if (!resources.Any()) return;

      var mainResources = new HashSet<Resource>(resources.OfType<SlaveGroup>()
        .Where(x => x.ParentResourceId == null));
      var parentedMainResources = new HashSet<Resource>(resources.OfType<SlaveGroup>()
        .Where(x => x.ParentResourceId.HasValue && !resources.Select(y => y.Id).Contains(x.ParentResourceId.Value)));
      mainResources.UnionWith(parentedMainResources);
      var subResources = new HashSet<Resource>(resources.Except(mainResources).OrderByDescending(x => x.Name));

      var stack = new Stack<Resource>(mainResources.OrderByDescending(x => x.Name));
      if (selectedResource != null) SelectedResource = resources.Where(x => x.Id == selectedResource.Id).FirstOrDefault();
      bool nodeSelected = false;

      TreeNode currentNode = null;
      Resource currentResource = null;

      while (stack.Any()) {
        var newResource = stack.Pop();
        var newNode = new TreeNode(newResource.Name) { Tag = newResource };
        StyleTreeNode(newNode, newResource, resources);

        if (selectedResource == null) {
          SelectedResource = newResource;
        }
        if (newResource.Id == selectedResource.Id && !nodeSelected) {
          newNode.BackColor = selectedColor;
          newNode.Text += " [selected]";
          nodeSelected = true;
        }

        // search for parent node of newNode and save in currentNode
        // necessary since newNodes (stack top items) might be siblings
        // or grand..grandparents of previous node (currentNode)
        while (currentNode != null && newResource.ParentResourceId != currentResource.Id) {
          currentNode = currentNode.Parent;
          currentResource = currentNode == null ? null : (Resource)currentNode.Tag;
        }

        if (currentNode == null) {
          treeView.Nodes.Add(newNode);
        } else {
          currentNode.Nodes.Add(newNode);
        }

        if (newResource is SlaveGroup) {
          var childResources = subResources.Where(x => x.ParentResourceId == newResource.Id);
          if (childResources.Any()) {
            foreach (var resource in childResources.OrderByDescending(x => x.Name)) {
              subResources.Remove(resource);
              stack.Push(resource);
            }
            currentNode = newNode;
            currentResource = newResource;
          }
        }
        newNode.SelectedImageIndex = newNode.ImageIndex;
      }

      var ungroupedNode = new TreeNode(ungroupedGroupName) {
        ForeColor = SystemColors.GrayText,
        Tag = new SlaveGroup() {
          Name = ungroupedGroupName,
          Description = ungroupedGroupDescription
        }
      };

      int ungroupedSlavesCount = 0;
      foreach (var slave in subResources.OfType<Slave>().OrderBy(x => x.Name)) {
        var slaveNode = new TreeNode(slave.Name) { Tag = slave };
        StyleTreeNode(slaveNode, slave, resources);
        ungroupedNode.Nodes.Add(slaveNode);
        ungroupedSlavesCount++;
        if (selectedResource == null) {
          SelectedResource = slave;
        }

        if (slave.Id == selectedResource.Id && !nodeSelected) {
          slaveNode.BackColor = selectedColor;
          slaveNode.Text += " [selected]";
          nodeSelected = true;
        }
      }

      if (ungroupedSlavesCount > 0)
        ungroupedNode.Text += " [" + ungroupedSlavesCount.ToString() + "]";
      treeView.Nodes.Add(ungroupedNode);
      treeView.ExpandAll();
      
    }

    private void UpdateChildHbIntervall(Resource resource) {
      foreach (Resource r in Content.Where(x => x.ParentResourceId == resource.Id)) {
        r.HbInterval = resource.HbInterval;
        if (r is SlaveGroup) {
          UpdateChildHbIntervall(r);
        }
      }
    }

    private void UpdateResources() {
      try {
        HiveAdminClient.Instance.Refresh();
        Content = HiveAdminClient.Instance.Resources;
      } catch(AnonymousUserException) {
        ShowHiveInformationDialog();
      }
    }

    private void RemoveResource(Resource resource) {
      if (resource == null) return;

      try {
        if (resource.Id != Guid.Empty) {
          var resourcesToSave = Content.Where(x => x.Id == Guid.Empty || x.Modified);
          foreach (var r in resourcesToSave)
            r.Store();
          HiveAdminClient.Delete(resource);
          UpdateResources();
        } else {
          Content.Remove(selectedResource);
        }
      } catch(AnonymousUserException) {
        ShowHiveInformationDialog();
      }
    }

    private void UpdateSchedule() {
      try {
        HiveAdminClient.Instance.RefreshCalendar();
      } catch (AnonymousUserException) {
        ShowHiveInformationDialog();
      }
    }

    private bool IsAdmin() {
      return HiveRoles.CheckAdminUserPermissions();
    }

    private void StyleTreeNode(TreeNode n, Resource r, IEnumerable<Resource> resources) {
      n.Text = r.Name;
      n.BackColor = Color.Transparent;
      n.ForeColor = Color.Black;

      // slave count
      int childSlavesCount = 0;
      if (r.Id != Guid.Empty && r is SlaveGroup) {
        var descendants = HiveAdminClient.Instance.ResourceDescendants;
        if (descendants.ContainsKey(r.Id)) {
          childSlavesCount = resources
            .OfType<Slave>()
            .Where(x => descendants[r.Id].Select(y => y.Id)
            .Contains(x.Id))
            .Count();
        }
      } else if(r.Name.StartsWith(ungroupedGroupName)) {
        childSlavesCount = resources
          .OfType<Slave>()
          .Where(x => x.ParentResourceId == null 
            || (x.ParentResourceId.HasValue && x.ParentResourceId.Value == Guid.Empty))
          .Count();
      }
      if (childSlavesCount > 0)
        n.Text += " [" + childSlavesCount.ToString() + "]";

      // slave image index, state, utilization
      if (r is Slave) {
        n.ImageIndex = slaveImageIndex;
        var s = r as Slave;
        if (s.SlaveState == SlaveState.Calculating) {
          n.ForeColor = calculatingColor;
          n.Text += " [" + s.CpuUtilization.ToString("N2") + "%]";
        } else if (s.SlaveState == SlaveState.Offline) {
          n.ForeColor = offlineColor;
          if (s.LastHeartbeat.HasValue)
            n.Text += " [" + s.LastHeartbeat?.ToString("g") + "]";
        }
      } else {
        n.ImageIndex = slaveGroupImageIndex;
      }

      // not stored (i.e. new), changed
      if (r.Id == Guid.Empty && !r.Name.StartsWith(ungroupedGroupName)) {
        n.Text += " [not stored]";
      } else if (r.Modified && !r.Name.StartsWith(ungroupedGroupName)) {
        n.Text += " [changes not stored]";
      }

      // ungrouped
      if(r.Name.StartsWith(ungroupedGroupName)) {
        n.ForeColor = ForeColor = SystemColors.GrayText;
      }
    }

    private void ResetTreeNodes(TreeNodeCollection nodes, IEnumerable<Resource> resources) {
      foreach (TreeNode n in nodes) {
        StyleTreeNode(n, (Resource)n.Tag, resources);
        if (n.Nodes.Count > 0) {
          ResetTreeNodes(n.Nodes, resources);
        }
      }
    }

    private async void ChangeSelectedResource(Resource resource) {
      selectedResource = resource;
      viewHost.Content = selectedResource;
      HiveAdminClient.Instance.DowntimeForResourceId = selectedResource != null ? selectedResource.Id : Guid.Empty;
      await SecurityExceptionUtil.TryAsyncAndReportSecurityExceptions(
        action: () => UpdateSchedule(),
        finallyCallback: () => scheduleView.Content = HiveAdminClient.Instance.Downtimes);

      bool locked = !IsAdmin() || resource == null;
      bool scheduleLocked = locked || (resource != null && resource.Id == Guid.Empty);
      bool addLocked = locked || (resource != null && resource.Id == Guid.Empty) || resource is Slave;

      btnAddGroup.Enabled = !addLocked;
      btnRemoveGroup.Enabled = !locked;
      btnSave.Enabled = !locked;
      viewHost.Locked = locked;
      scheduleView.Locked = locked;
      scheduleView.SetEnabledStateOfSchedule(!scheduleLocked);
    }

    private void ChangeSelectedResourceNode(TreeNode resourceNode) {
      if (resourceNode == null) return;
      SelectedResource = (Resource)resourceNode.Tag;
      ResetTreeNodes(treeView.Nodes, Content);
      resourceNode.BackColor = selectedColor;
      resourceNode.Text += " [selected]";
    }

    private void ShowHiveInformationDialog() {
      if (InvokeRequired) Invoke((Action)ShowHiveInformationDialog);
      else {
        using (HiveInformationDialog dialog = new HiveInformationDialog()) {
          dialog.ShowDialog(this);
        }
      }
    }

    private void ResetView() {
      if (InvokeRequired) Invoke((Action)ResetView);
      else {
        treeView.Nodes.Clear();

        if (viewHost.Content != null && viewHost.Content is SlaveGroup) {
          ((SlaveGroup)viewHost.Content).PropertyChanged -= SlaveViewContent_PropertyChanged;
        }

        viewHost.Content = null;
        if (scheduleView.Content != null) {
          scheduleView.Content.Clear();
        }

        HiveAdminClient.Instance.ResetDowntime();
      }
    }

    #endregion
  }
}