Changeset 13805 for branches/WebJobManager/HeuristicLab.Clients.Hive.WebJobManager/Hubs/CalendarHub.cs

Timestamp:

04/27/16 16:48:35 (8 years ago)

Author:

jlodewyc

Message:

#2582 Bugfixing, email setup password and code commenting

File:

• branches/WebJobManager/HeuristicLab.Clients.Hive.WebJobManager/Hubs/CalendarHub.cs (modified) (15 diffs)

branches/WebJobManager/HeuristicLab.Clients.Hive.WebJobManager/Hubs/CalendarHub.cs

@@ -12 +12 @@
 namespace HeuristicLab.Clients.Hive.WebJobManager.Hubs
 {
+    /// <summary>
+    /// SignalR Hub that manages all resource management. 
+    /// </summary>
     public class CalendarHub : Hub
     {
@@ -19 +22 @@
         private HiveServiceLocatorWeb servloc;
         private AccessAdministrationClient accessClient;
+        /// <summary>
+        /// Loads up the services for the client (Instance is only created upon a call from a client)
+        /// </summary>
         private void loader()
         {
@@ -35 +41 @@
             }
         }
+        /// <summary>
+        /// Initial client request for all user, group and resource information
+        /// </summary>
         public void requestInfo()
         {
@@ -40 +49 @@
             adminClient.Refresh();
             UserViewModel vm = new UserViewModel(accessClient).refreshAll();
+
             var users = JsonConvert.SerializeObject(vm.users);
             var groups = JsonConvert.SerializeObject(vm.ugroups);
@@ -45 +55 @@
             Clients.Caller.processData(res, users, groups);
         }
+        /// <summary>
+        /// Request for the downtimes of a specific resource
+        /// </summary>
+        /// <param name="id">Resource ID</param>
         public void requestDownTime(string id)
         {
@@ -50 +64 @@
             adminClient.Refresh();
             Guid t = Guid.Parse(id);
+
+            //Loads up the downtimes for the set resource ID
             adminClient.DowntimeForResourceId = t;
             adminClient.RefreshCalendar();
+            
             var down = JsonConvert.SerializeObject(adminClient.Downtimes);
             Clients.Caller.processDowntime(id, down);
         }
+        /// <summary>
+        /// Request for permissions of a specific resource (refreshable by recall)
+        /// </summary>
+        /// <param name="id">Resource ID</param>
         public void requestPermissions(string id)
         {
@@ -63 +84 @@
         }
 
+        /// <summary>
+        /// Edit permissions for a resource
+        /// </summary>
+        /// <param name="perms">Permissions ID's</param>
+        /// <param name="idresource">Resource ID</param>
         public void changePermissions(string[] perms, string idresource)
         {
             loader();
             var res = Guid.Parse(idresource);
+
+            //Collect current permissions
             var exist = servloc.CallHiveService(x => x.GetResourcePermissions(res));
+
+            //Separate list for new and to remove permissions
             List<Guid> newPerms = new List<Guid>();
             List<Guid> revokePerms = new List<Guid>();
+
             for (var i = 0; i < perms.Length; i++)
             {
@@ -75 +106 @@
                 var elemid = exist.FindIndex(x => x.GrantedUserId == p);
                 if (elemid != -1)
-                {
+                {//If it already exists => Scramble up Guid (checked further)
                     exist[elemid].GrantedUserId = Guid.Empty;
                 }
                 else
-                {
+                {//If it's not in the list, add to new permissions
                     newPerms.Add(p);
                 }
             }
+            //Adds the new permissions to the resource
             servloc.CallHiveService(x => x.GrantResourcePermissions(res, newPerms));
             foreach (var ex in exist)
-            {
+            {//Checks for intact ID's and adds them to the revoke list
                 if(ex.GrantedUserId != Guid.Empty)
                 {
@@ -91 +123 @@
                 }
             }
+            //Revokes all permissions that were deselected by the user
             servloc.CallHiveService(x => x.RevokeResourcePermissions(res, revokePerms));
+            //Live reload the view for the resource
             requestPermissions(idresource);
         }
+        /// <summary>
+        /// Toggles the disposable setting for a resource
+        /// </summary>
+        /// <param name="id">Resource ID</param>
         public void toggleDisposable(string id)
         {
@@ -100 +138 @@
             Guid c = Guid.Parse(id);
             var obj = adminClient.Resources.ToList().Find(x => x.Id == c);
+
+            //Toggle
             ((Slave)(obj)).IsDisposable = !((Slave)(obj)).IsDisposable;
+
             adminClient.Store(obj, CancellationToken.None);
+
+            //Notify client of successful saving
             Clients.Caller.processDispose( ((Slave)(obj)).IsDisposable);
 
         }
+        /// <summary>
+        /// Saves changes to a resource calendar
+        /// </summary>
+        /// <param name="id">Resource id</param>
+        /// <param name="del">To delete downtimes</param>
+        /// <param name="add">New downtimes</param>
+        /// <param name="upd">Downtimes to update</param>
+        /// <param name="fresh">Check if refresh should be sent (Save all current graph or Save current graph)</param>
+        /// <param name="last">Check for last request (Save all)</param>
         public void saveCalendar(string id, string[] del, string[][] add, string[][] upd, bool fresh, bool last)
         {
             loader();
             var calid = Guid.Parse(id);
+            
+            //Load up calendar
             adminClient.Refresh();
             adminClient.DowntimeForResourceId = calid;
             adminClient.RefreshCalendar();
+
             var downlist = adminClient.Downtimes.ToList();
             foreach(var s in del)
-            {
+            {//Deletes downtimes
                 var gu = Guid.Parse(s);
                 var el = downlist.Find(x => x.Id == gu);
@@ -120 +175 @@
             }
             foreach (var s in add)
-            {
+            {//Adds new downtimes
+                //init
                 var obj = new Downtime();
                 obj.Id = Guid.Empty;
@@ -134 +190 @@
                     obj.AllDayEvent = false;
                 obj.ResourceId = Guid.Parse(s[4]);
+
+                //Recurrency check
                 if (s[5] == "true")
-                {
+                {//Recurrency set
                     obj.Recurring = true;
                     if (s[6] == "0")
-                    {
+                    {//new Recur
                         var dayarr = s[9].Split(',');
                         var start = (new DateTime(1970, 1, 1)).AddMilliseconds(double.Parse(s[7]));
                         var end = (new DateTime(1970, 1, 1)).AddMilliseconds(double.Parse(s[8]));
-                        loopAddDowns(start, end, dayarr, obj);    
+                        loopAddDowns(start, end, dayarr, obj);//Loop creation of recurrency. Start to end date
                     }
                     else
-                    {
+                    {//Existing recurrency (only edits current element, client handles the creation of the other events)
                         obj.RecurringId = Guid.Parse(s[6]);
                         adminClient.Store(obj, CancellationToken.None);
                     }
                 }
-                else { 
+                else { //No recurrency
                     obj.Recurring = false;
                     adminClient.Store(obj, CancellationToken.None);
@@ -158 +216 @@
             }
             foreach(var s in upd)
-            {
+            {//Update existing downtime
                  var obj = downlist.Find(x => x.Id == Guid.Parse(s[0]));
                 if (s[1] == "Unavailable")
@@ -171 +229 @@
                     obj.AllDayEvent = false;
                 if (s[5] == "true" && !obj.Recurring)
-                {
+                {//Recurrence set
                     obj.Recurring = true;
                     if (s[6] == "00000000-0000-0000-0000-000000000000")
-                    {
+                    {//Creates new recurrence
                         var dayarr = s[9].Split(',');
                         var start = (new DateTime(1970, 1, 1)).AddMilliseconds(double.Parse(s[7]));
                         var end = (new DateTime(1970, 1, 1)).AddMilliseconds(double.Parse(s[8]));
-                        //loopAddDowns(start, end, dayarr, obj);
+                        loopAddDowns(start, end, dayarr, obj);
+                        adminClient.Delete(obj);
+                        //Delete needed to prevent doubles in the creation of the recurrency
+                        //Why: event could be on not included day of the week => loop cannot find that. 
                     }
                     else
@@ -194 +255 @@
             }
             if( last)
-            {
+            {//Last element from save all => Notify client
                 Clients.Caller.savingAllDone();
             }
             else if (fresh)
-            {
+            {//Refresh for graph needed 
                 Clients.Caller.savingCurrentDone();
             }
         }
+        /// <summary>
+        /// Creates downtimes for a new recurrency
+        /// </summary>
+        /// <param name="start">Start date</param>
+        /// <param name="end">End date</param>
+        /// <param name="dayarr">Boolean day array (sun = 0,...)</param>
+        /// <param name="obj">Downtime to recur</param>
         private void loopAddDowns(DateTime start, DateTime end, string[] dayarr, Downtime obj)
         {
             var rid = Guid.NewGuid();
-            for (; start < end;)
+            while (start < end)
             {
                 if (dayarr[(int)(start.DayOfWeek)] == "true")
-                {
+                {//Check for day of the week
+                    //Set setting for the downtime to add
                     var temp = new Downtime();
-                    temp.StartDate = start.AddHours(obj.StartDate.Hour - start.Hour).AddMinutes(obj.StartDate.Minute - start.Minute);
-                    temp.EndDate = start.AddHours(obj.EndDate.Hour - start.Hour).AddMinutes(obj.EndDate.Minute - start.Minute);
-                    temp.Id = obj.Id;
+                    temp.StartDate = start.AddHours(obj.StartDate.Hour - start.Hour)
+                        .AddMinutes(obj.StartDate.Minute - start.Minute);
+                    temp.EndDate = start.AddHours(obj.EndDate.Hour - start.Hour)
+                        .AddMinutes(obj.EndDate.Minute - start.Minute);
+                    temp.Id = Guid.Empty;
                     temp.DowntimeType = obj.DowntimeType;
                     temp.AllDayEvent = obj.AllDayEvent;