Config reorganization

General refactor

Step.Database/Controllers/FunctionsAccessController.cs

@@ -1,8 +1,8 @@
-using System;
+using Step.Model.DatabaseModels;
+using Step.Model.DTOModels;
+using System;
 using System.Collections.Generic;
 using System.Linq;
-using Step.Model.DatabaseModels;
-using Step.Model.DTOModels;
 using static CMS_CORE_Library.DataStructures;
 
 namespace Step.Database.Controllers
@@ -47,12 +47,12 @@ namespace Step.Database.Controllers
                 .ToList();
         }
 
-        public List<DTORuntimeFunctionAccessModel> GetFunctionsMappedWithPlc(List<FunctionalityModel> functionalityList)
+        public List<DTORuntimeFunctionalityModel> GetFunctionsMappedWithPlc(List<FunctionalityModel> functionalityList)
         {
             return dbCtx
                 .FunctionsAccess
                 .ToList() // Find all function access
-                .Select(f => new DTORuntimeFunctionAccessModel()
+                .Select(f => new DTORuntimeFunctionalityModel()
                 {
                     Id = f.FunctionAccessId,
                     Name = f.Name,
@@ -71,4 +71,4 @@ namespace Step.Database.Controllers
             return functionalityList[id - 1].IsActive;
         }
     }
-}
+}

Step.Database/Controllers/MachinesController.cs

@@ -39,14 +39,16 @@ namespace Step.Database.Controllers
 
         public MachineModel Create(string uniqueId)
         {
+            // Create database machine model
             MachineModel machine = new MachineModel()
             {
                 MachineId = 1,
                 Model = NcConfig.NcName,
                 UniqueId = uniqueId
             };
-
+            // Add to database
             dbCtx.Machines.Add(machine);
+            // Commit changes
             dbCtx.SaveChanges();
 
             return machine;
@@ -54,12 +56,14 @@ namespace Step.Database.Controllers
 
         public void UpdateMachineName(int id, string name)
         {
+            // Find machine by id
             MachineModel machine = FindById(id);
-            if(machine != null)
+            if (machine != null)
             {
+                // Update machine name
                 machine.Model = name;
                 dbCtx.SaveChanges();
             }
         }
     }
-}
+}

Step.Database/Controllers/MachinesUsersController.cs

@@ -1,10 +1,7 @@
 using Step.Model.DatabaseModels;
 using Step.Model.DTOModels;
 using System;
-using System.Collections.Generic;
 using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
 
 namespace Step.Database.Controllers
 {
@@ -37,20 +34,26 @@ namespace Step.Database.Controllers
         {
             return dbCtx
                 .MachinesUsers
-                .Include("Role")
+                .Include("Role") // Join with Role, Machine, User
                 .Include("Machine")
                 .Include("User")
                 .Where(x => x.MachineUserId == id)
                 .FirstOrDefault();
-
         }
 
         public MachineUserModel Create(int machineId, int userId, int roleId)
         {
-            MachineUserModel machine = new MachineUserModel() { MachineId = machineId, UserId = userId, RoleId = roleId };
+            // Create database model
+            MachineUserModel machine = new MachineUserModel() {
+                MachineId = machineId,
+                UserId = userId,
+                RoleId = roleId
+            };
+            // Add into database
             dbCtx.MachinesUsers.Add(
                 machine
             );
+            // Commit changes
             dbCtx.SaveChanges();
 
             return machine;
@@ -61,7 +64,7 @@ namespace Step.Database.Controllers
             RoleModel role = dbCtx
                 .MachinesUsers
                 .Include("Role")
-                .Where(x => x.MachineId == machineId && x.UserId == userId)
+                .Where(x => x.MachineId == machineId && x.UserId == userId) // Find by machine id and user id, joining with role
                 .FirstOrDefault().Role;
 
             return new DTORoleModel()
@@ -71,4 +74,4 @@ namespace Step.Database.Controllers
             };
         }
     }
-}
+}

Step.Database/Controllers/SessionsController.cs

@@ -1,9 +1,6 @@
 using Step.Model.DatabaseModels;
 using System;
-using System.Collections.Generic;
 using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
 
 namespace Step.Database.Controllers
 {
@@ -38,7 +35,7 @@ namespace Step.Database.Controllers
                 .RemoveRange( // Delete rows
                     dbCtx
                     .Sessions
-                    .Where(x => x.MachineUserId == machineUserId) // Find all the session with matching machineUserId 
+                    .Where(x => x.MachineUserId == machineUserId) // Find all the session with matching machineUserId
                 );
             // Commit changes
             dbCtx.SaveChanges();
@@ -70,4 +67,4 @@ namespace Step.Database.Controllers
             dbCtx.SaveChanges();
         }
     }
-}
+}

Step.Database/Controllers/UsersController.cs

@@ -1,10 +1,9 @@
-using System;
-using System.Data.Entity.Migrations;
+using Step.Model.DatabaseModels;
+using Step.Model.DTOModels;
+using System;
 using System.Globalization;
 using System.Linq;
 using System.Web.Helpers;
-using Step.Model.DatabaseModels;
-using Step.Model.DTOModels;
 using static Step.Config.ServerConfig;
 
 namespace Step.Database.Controllers
@@ -48,6 +47,7 @@ namespace Step.Database.Controllers
                 Language = language
             };
         }
+
         public static UserModel CreateUserModel(string username, string password, string firstName, string lastName, CultureInfo language)
         {
             return CreateUserModel(0, username, password, firstName, lastName, language);
@@ -59,12 +59,13 @@ namespace Step.Database.Controllers
             UserModel userDatabaseModel = dbCtx.Users.Where(u => u.UserId == userId).FirstOrDefault();
             DTORoleModel roleModel = null;
 
+            // Find user role through machineUser table
             using (MachinesUsersController machinesUsersControler = new MachinesUsersController())
             {
                 roleModel = machinesUsersControler.GetUserRole(MachineConfig.MachineId, userId);
             }
 
-            return new DTOUserModel()
+            return new DTOUserModel() // Return DTOUserModel
             {
                 Id = userDatabaseModel.UserId,
                 Username = userDatabaseModel.Username,
@@ -106,9 +107,11 @@ namespace Step.Database.Controllers
 
         public void CreateCmsDefaultUserIfNotExists(int machineId)
         {
+            // Find if there is a cms standard user
             UserModel user = FindByUsername("cms");
             if (user == null)
             {
+                // If not exist add new user
                 user = dbCtx.Users.Add(
                     CreateUserModel("cms", "cms", "cms", "cms", new CultureInfo("en"))
                 );
@@ -116,7 +119,7 @@ namespace Step.Database.Controllers
                 // Commit changes
                 dbCtx.SaveChanges();
             }
-
+            // Add user to local machine users if not exists
             using (MachinesUsersController machinesUsersController = new MachinesUsersController())
             {
                 MachineUserModel machineUser = machinesUsersController.FindByUserId(machineId, user.UserId);
@@ -130,11 +133,11 @@ namespace Step.Database.Controllers
         {
             UserModel user = FindById(userId);
 
-            if(user != null)
+            if (user != null)
             {
                 user.Language = newLanguage;
                 dbCtx.SaveChanges();
             }
         }
     }
-}
+}