Curation Tool: Move hardcoded curator group to settings #2268

Author: geofranzi

Components/DLM/BExIS.Dlm.Entities/Curation/CurationEntry.cs

@@ -65,9 +65,10 @@ public CurationEntry(string topic, CurationEntryType type, Dataset dataset, stri
         public virtual bool IsApproved { get; set; }
         public virtual DateTime LastChangeDatetime_User { get; set; }
         public virtual DateTime LastChangeDatetime_Curator { get; set; }
-        public static CurationUserType GetCurationUserType(User user)
+
+        public static CurationUserType GetCurationUserType(User user, string curationGroupName)
         {
-            if (user.Groups.Any(g => g.Name.Equals("curator", StringComparison.CurrentCultureIgnoreCase)))
+            if (user.Groups.Any(g => g.Name.Equals(curationGroupName, StringComparison.CurrentCultureIgnoreCase)))
             {
                 return CurationUserType.Curator;
             }

Components/DLM/BExIS.Dlm.Entities/Curation/CurationNote.cs

@@ -29,10 +29,10 @@ public CurationNote(int id, CurationUserType userType, DateTime creationDate, st
             User = user;
         }
 
-        public CurationNote(User user, string comment)
+        public CurationNote(User user, string comment, CurationUserType userType)
         {
             Id = 0;
-            UserType = CurationEntry.GetCurationUserType(user);
+            UserType = userType;
             CreationDate = DateTime.Now;
             Comment = comment;
             User = user;

Components/DLM/BExIS.Dlm.Services/Curation/CurationManager.cs

@@ -53,7 +53,7 @@ private static void FixPositions(IEnumerable<CurationEntry> entries, CurationEnt
             }
         }
 
-        public CurationEntry Create(string topic, CurationEntryType type, long datasetId, string name, string description, string solution, int position, string source, IEnumerable<CurationNote> notes, bool userIsDone, bool isApproved, User user)
+        public CurationEntry Create(string topic, CurationEntryType type, long datasetId, string name, string description, string solution, int position, string source, IEnumerable<CurationNote> notes, bool userIsDone, bool isApproved, User user, bool userIsCurator)
         {
             if (string.IsNullOrEmpty(name)) throw new ArgumentNullException(nameof(name), "name is empty but is required.");
             if (string.IsNullOrEmpty(source)) throw new ArgumentNullException(nameof(source), "source is empty but is required.");
@@ -72,7 +72,7 @@ public CurationEntry Create(string topic, CurationEntryType type, long datasetId
                 var _ = loadedUser.Groups.Count;
 
                 // set last change date time
-                if (CurationEntry.GetCurationUserType(loadedUser) != CurationUserType.Curator)
+                if (!userIsCurator)
                     throw new UnauthorizedAccessException("Only curators are allowed to create curation entries.");
 
                 var dataset = repoDataset.Get(datasetId);
@@ -113,8 +113,7 @@ public CurationEntry Create(string topic, CurationEntryType type, long datasetId
                 return curationEntry;
             }
         }
-
-        public CurationEntry Update(long id, string topic, CurationEntryType type, string name, string description, string solution, int position, string source, IEnumerable<CurationNote> notes, bool userIsDone, bool isApproved, User user)
+        public CurationEntry Update(long id, string topic, CurationEntryType type, string name, string description, string solution, int position, string source, IEnumerable<CurationNote> notes, bool userIsDone, bool isApproved, User user, bool userIsCurator)
         {
             if (id <= 0) throw new ArgumentException("id must be greater than 0.");
 
@@ -132,15 +131,19 @@ public CurationEntry Update(long id, string topic, CurationEntryType type, strin
                 // Force loading of Groups collection
                 var _ = loadedUser.Groups.Count;
 
-                var isCurator = CurationEntry.GetCurationUserType(loadedUser) == CurationUserType.Curator;
-
                 var merged = repoEntries.Get(id);
 
                 var currentNotes = merged.Notes.ToList();
 
                 var incomingIds = new HashSet<long>(notes.Select(n => n.Id));
                 incomingIds.Remove(0);
                 var deletedNotes = merged.Notes.Where(n => !incomingIds.Contains(n.Id)).ToList();
+
+                var userType = CurationUserType.User;
+                if (userIsCurator)
+                    userType = CurationUserType.Curator;
+
+
                 foreach (var note in deletedNotes)
                 {
                     if (loadedUser.Id != note.User.Id) continue; // do not delete notes from other users
@@ -153,7 +156,7 @@ public CurationEntry Update(long id, string topic, CurationEntryType type, strin
                     var existingNote = currentNotes.FirstOrDefault(n => n.Id == incomingNote.Id);
                     if (incomingNote.Id == 0 || existingNote == null)
                     {
-                        var newNote = new CurationNote(loadedUser, incomingNote.Comment);
+                        var newNote = new CurationNote(loadedUser, incomingNote.Comment, userType);
                         currentNotes.Add(newNote);
                     }
                     else
@@ -167,7 +170,7 @@ public CurationEntry Update(long id, string topic, CurationEntryType type, strin
 
                 var changed = false;
 
-                if (isCurator)
+                if (userIsCurator)
                 {
                     changed = topic != merged.Topic ||
                               type != merged.Type ||

Console/BExIS.Web.Shell/Areas/DCM/BExIS.Modules.Dcm.UI/Controllers/API/CurationEntryController.cs

@@ -34,7 +34,7 @@ private class AnonymizedCuration
 
             public AnonymizedCuration(IEnumerable<CurationEntry> curationEntries, User user)
             {
-                bool userIsCurator = CurationEntry.GetCurationUserType(user).Equals(CurationUserType.Curator);
+                bool userIsCurator = CurationEntry.GetCurationUserType(user, GetCurationGroupName()).Equals(CurationUserType.Curator);
 
                 // requesting user gets added to the set of seen users
                 var userSet = new HashSet<long>() { user.Id };
@@ -88,7 +88,7 @@ public AnonymizedCuration(IEnumerable<CurationEntry> curationEntries, User user)
 
                 // convert the user list to new userIds from 1 to n
                 var userMap = new Dictionary<long, CurationUserModel>();
-                for (var i = 0; i < sortedUsers.Count; i++) userMap.Add(sortedUsers[i].Id, new CurationUserModel(sortedUsers[i], i + 1));
+                for (var i = 0; i < sortedUsers.Count; i++) userMap.Add(sortedUsers[i].Id, new CurationUserModel(sortedUsers[i], i + 1, GetCurationUserType(sortedUsers[i])));
 
                 // replace original userIds with the anonymized ones
                 foreach (var curationEntry in AnonymizedCurationEntries)
@@ -139,6 +139,26 @@ private static List<CurationLabel> GetCurationLabels()
             return curationLabels == null ? new List<CurationLabel>() : curationLabels;
         }
 
+        private static String GetCurationGroupName()
+        {
+            var groupName = ModuleManager.GetModuleSettings("DDM").GetValueByKey<string>("curatorsGroupName");
+            if (string.IsNullOrEmpty(groupName))
+            {
+                return "curator";
+            }
+            return groupName;
+        }
+
+        public static CurationUserType GetCurationUserType(User user)
+        {
+            var curationGroupName = GetCurationGroupName();
+            if (user.Groups.Any(g => g.Name.Equals(curationGroupName, StringComparison.CurrentCultureIgnoreCase)))
+            {
+                return CurationUserType.Curator;
+            }
+            return CurationUserType.User;
+        }
+
         private static IEnumerable<CurationTemplateModel> GetGreetingTemplates()
         {
             // this should be replaced by a configuration or derived from other source in the future
@@ -216,7 +236,7 @@ public async Task<HttpResponseMessage> Get(long datasetid)
                 var greetingTemplates = GetGreetingTemplates();
                 var taskListTemplates = GetTaskListTemplates();
 
-                bool userIsCurator = CurationEntry.GetCurationUserType(userWithGroups).Equals(CurationUserType.Curator);
+                bool userIsCurator = CurationEntry.GetCurationUserType(userWithGroups, GetCurationGroupName()).Equals(CurationUserType.Curator);
 
                 curationModel = new CurationModel(
                     datasetid,
@@ -337,6 +357,7 @@ public async Task<HttpResponseMessage> Put(CurationEntryModel curationEntryModel
                 // check if user has rights to access the dataset
                 //if (!(userRights(user.Id, c.Dataset.Id) > 0))
                 //    return Request.CreateErrorResponse(HttpStatusCode.PreconditionFailed, "User has no rights to access the dataset");
+                bool userIsCurator = CurationEntry.GetCurationUserType(userWithGroups, GetCurationGroupName()).Equals(CurationUserType.Curator);
 
                 var newCurationEntry = curationManager.Update(
                         curationEntryModel.Id,
@@ -350,7 +371,8 @@ public async Task<HttpResponseMessage> Put(CurationEntryModel curationEntryModel
                         notes,
                         curationEntryModel.UserIsDone,
                         curationEntryModel.IsApproved,
-                        userWithGroups
+                        userWithGroups,
+                        userIsCurator
                 );
 
                 var response = AnonymizeCurationEntryModel(curationEntryModel, newCurationEntry, userWithGroups);
@@ -385,15 +407,18 @@ public async Task<HttpResponseMessage> Post(CurationEntryModel curationEntryMode
                     .Where(u => u.Id == user.Id)
                     .Fetch(u => u.Groups)
                     .SingleOrDefault();
+                
+                var userIsCurator = CurationEntry.GetCurationUserType(userWithGroups, GetCurationGroupName()).Equals(CurationUserType.Curator);
 
-                if (!CurationEntry.GetCurationUserType(userWithGroups).Equals(CurationUserType.Curator))
+                if (!CurationEntry.GetCurationUserType(userWithGroups, GetCurationGroupName()).Equals(CurationUserType.Curator))
                     return Request.CreateErrorResponse(HttpStatusCode.PreconditionFailed, "User not permitted to create curation entries");
 
                 List<CurationNote> notes;
                 if (curationEntryModel.Notes == null || !curationEntryModel.Notes.Any())
                     notes = new List<CurationNote>();
                 else
-                    notes = curationEntryModel.Notes.Select(n => new CurationNote(userWithGroups, n.Comment)).ToList(); // all notes will be created for the current user
+
+                notes = curationEntryModel.Notes.Select(n => new CurationNote(userWithGroups, n.Comment, GetCurationUserType(userWithGroups))).ToList(); // all notes will be created for the current user
 
                 if (curationEntryModel.Type == CurationEntryType.StatusEntryItem)
                 {
@@ -419,7 +444,8 @@ public async Task<HttpResponseMessage> Post(CurationEntryModel curationEntryMode
                         notes,
                         curationEntryModel.UserIsDone,
                         curationEntryModel.IsApproved,
-                        userWithGroups
+                        userWithGroups,
+                        userIsCurator
                     );
 
                 var response = AnonymizeCurationEntryModel(curationEntryModel, newCurationEntry, userWithGroups);

Console/BExIS.Web.Shell/Areas/DCM/BExIS.Modules.Dcm.UI/Models/Curation/Curation.cs

@@ -123,11 +123,11 @@ public CurationUserModel(long id, string displayName, CurationUserType curationU
             CurationUserType = curationUserType;
         }
 
-        public CurationUserModel(User user, long id)
+        public CurationUserModel(User user, long id, CurationUserType curationUserType)
         {
             Id = id;
             DisplayName = user.DisplayName;
-            CurationUserType = CurationEntry.GetCurationUserType(user);
+            CurationUserType = curationUserType;
         }
     }
 

Console/BExIS.Web.Shell/Areas/DDM/BExIS.Modules.Ddm.UI/Ddm.Settings.json

@@ -72,6 +72,13 @@
         "downloadCitationFormats": [ "Text", "APA", "RIS", "BibTex" ]
       }
     },
+    {
+      "key": "curatorsGroupName",
+      "title": "Group name for curators",
+      "value": "curator",
+      "type": "String",
+      "description": "Group name all curators assigned to. This is needed for the curation tool to know who is curator."
+    },
     {
         "key": "curation",
         "title": "Configuration Settings for Curation",