SEBSERV-587 User Account sync improvements

SafeExamBrowser · Oct 1, 2024 · 5996604 · 5996604
1 parent bdda9e2
commit 5996604
Show file tree

Hide file tree

Showing 8 changed files with 63 additions and 41 deletions.
diff --git a/...z/seb/sebserver/webservice/servicelayer/authorization/impl/TeacherAccountServiceImpl.java b/...z/seb/sebserver/webservice/servicelayer/authorization/impl/TeacherAccountServiceImpl.java
@@ -23,7 +23,6 @@
 import ch.ethz.seb.sebserver.webservice.servicelayer.authorization.AdHocAccountData;
 import ch.ethz.seb.sebserver.webservice.servicelayer.authorization.TeacherAccountService;
 import ch.ethz.seb.sebserver.webservice.servicelayer.dao.ExamDAO;
-import ch.ethz.seb.sebserver.webservice.servicelayer.dao.FilterMap;
 import ch.ethz.seb.sebserver.webservice.servicelayer.dao.UserDAO;
 import ch.ethz.seb.sebserver.webservice.servicelayer.session.ScreenProctoringService;
 import ch.ethz.seb.sebserver.webservice.weblayer.oauth.AdminAPIClientDetails;
@@ -188,8 +187,14 @@ public Result<TokenLoginInfo> verifyOneTimeTokenForTeacherAccount(final String l
     public void deleteAllFromLMS(final Long lmsId) {
             userDAO
                     .deleteAdHocAccountsForLMS(AD_HOC_TEACHER_ID_PREFIX, lmsId)
+                    .map(this::deleteAccountsOnSPS)
                     .onError(error -> log.error("Failed to delete all teacher accounts for LMS with id: {}", lmsId, error));
     }
+
+    private Collection<EntityKey> deleteAccountsOnSPS(final Collection<EntityKey> keys) {
+        keys.forEach(key -> this.screenProctoringService.deleteSPSUser(key.modelId) );
+        return keys;
+    }
 
     private UserInfo handleAccountDoesNotExistYet(
             final boolean createIfNotExists,

diff --git a/...main/java/ch/ethz/seb/sebserver/webservice/servicelayer/dao/ScreenProctoringGroupDAO.java b/...main/java/ch/ethz/seb/sebserver/webservice/servicelayer/dao/ScreenProctoringGroupDAO.java
@@ -70,7 +70,7 @@ public interface ScreenProctoringGroupDAO {
      *
      * @param pk the group identifier (PK)
      * @return Result refer to the entity key of the former group record or to an error when happened */
-    Result<EntityKey> deleteRoom(Long pk);
+    Result<EntityKey> deleteGroup(Long pk);
 
     /** Delete all groups records for a given exam.
      *

diff --git a/.../ch/ethz/seb/sebserver/webservice/servicelayer/dao/impl/ScreenProctoringGroupDAOImpl.java b/.../ch/ethz/seb/sebserver/webservice/servicelayer/dao/impl/ScreenProctoringGroupDAOImpl.java
@@ -190,7 +190,7 @@ public Result<ScreenProctoringGroup> createNewGroup(final ScreenProctoringGroup
 
     @Override
     @Transactional
-    public Result<EntityKey> deleteRoom(final Long pk) {
+    public Result<EntityKey> deleteGroup(final Long pk) {
         return Result.tryCatch(() -> {
 
             this.screenProctoringGroopRecordMapper

diff --git a/...a/ch/ethz/seb/sebserver/webservice/servicelayer/exam/impl/ProctoringAdminServiceImpl.java b/...a/ch/ethz/seb/sebserver/webservice/servicelayer/exam/impl/ProctoringAdminServiceImpl.java
@@ -103,22 +103,6 @@ public Result<ScreenProctoringSettings> getScreenProctoringSettings(final Entity
             return this.proctoringSettingsDAO
                     .getScreenProctoringSettings(parentEntityKey)
                     .getOrThrow();
-
-//            if (this.screenProctoringServiceBundle.bundled) {
-//                settings = new ScreenProctoringSettings(
-//                        settings.examId,
-//                        settings.enableScreenProctoring,
-//                        this.screenProctoringServiceBundle.serviceURL,
-//                        this.screenProctoringServiceBundle.clientId,
-//                        null,
-//                        this.screenProctoringServiceBundle.apiAccountName,
-//                        null,
-//                        settings.collectingStrategy,
-//                        settings.collectingGroupSize,
-//                        true);
-//            }
-//
-//            return settings;
         });
     }
 

diff --git a/...n/java/ch/ethz/seb/sebserver/webservice/servicelayer/session/ScreenProctoringService.java b/...n/java/ch/ethz/seb/sebserver/webservice/servicelayer/session/ScreenProctoringService.java
@@ -34,9 +34,9 @@ default void processSessionUpdateTask() {
         updateClientConnections();
         updateActiveGroups();
     }
-
+    
     boolean isScreenProctoringEnabled(Long examId);
-
+    
     /** This is testing the given ScreenProctoringSettings on integrity and if we can
      * connect to the given SEB screen proctoring service.
      *

diff --git a/...sebserver/webservice/servicelayer/session/impl/proctoring/ScreenProctoringAPIBinding.java b/...sebserver/webservice/servicelayer/session/impl/proctoring/ScreenProctoringAPIBinding.java
@@ -72,7 +72,7 @@ class ScreenProctoringAPIBinding {
 
     private static final String SEB_SERVER_SCREEN_PROCTORING_SEB_ACCESS_PREFIX = "SEBServer_SEB_Access_";
 
-    static interface SPS_API {
+    interface SPS_API {
 
         enum SPSUserRole {
             ADMIN,
@@ -86,7 +86,7 @@ enum SPSUserRole {
 
         String USER_ACCOUNT_ENDPOINT = "/admin-api/v1/useraccount/";
         String USERSYNC_SEBSERVER_ENDPOINT = USER_ACCOUNT_ENDPOINT + "usersync/sebserver";
-        String ENTITY_PRIVILEGES_ENDPOINT =  USER_ACCOUNT_ENDPOINT + "entityprivilege";
+//        String ENTITY_PRIVILEGES_ENDPOINT =  USER_ACCOUNT_ENDPOINT + "entityprivilege";
         String EXAM_ENDPOINT = "/admin-api/v1/exam";
         String EXAM_DELETE_REQUEST_ENDPOINT = "/request";
         String SEB_ACCESS_ENDPOINT = "/admin-api/v1/clientaccess";
@@ -96,19 +96,19 @@ enum SPSUserRole {
         String INACTIVE_PATH_SEGMENT = "/inactive";
 
 
-        interface ENTITY_PRIVILEGE {
-            String ATTR_ENTITY_TYPE = "entityType";
-            String ATTR_ENTITY_ID = "entityId";
-            String ATTR_USER_UUID = "userUuid";
-            String ATTR_USERNAME = "username";
-            String ATTR_PRIVILEGES = "privileges";
-        }
-
-        interface PRIVILEGE_FLAGS {
-            String READ = "r";
-            String MODIFY = "m";
-            String WRITE = "w";
-        }
+//        interface ENTITY_PRIVILEGE {
+//            String ATTR_ENTITY_TYPE = "entityType";
+//            String ATTR_ENTITY_ID = "entityId";
+//            String ATTR_USER_UUID = "userUuid";
+//            String ATTR_USERNAME = "username";
+//            String ATTR_PRIVILEGES = "privileges";
+//        }
+//
+//        interface PRIVILEGE_FLAGS {
+//            String READ = "r";
+//            String MODIFY = "m";
+//            String WRITE = "w";
+//        }
 
         /** The screen proctoring service client-access API attribute names */
         interface SEB_ACCESS {
@@ -435,6 +435,8 @@ void deleteSPSUser(final String userUUID) {
 
             if (exchange.getStatusCode() == HttpStatus.OK) {
                 log.info("Successfully deleted User Account on SPS for user: {}", userUUID);
+            } else if (exchange.getStatusCode() == HttpStatus.NOT_FOUND) {
+                log.info("SPS User with uuid {} not found on SPS site.", userUUID);
             } else {
                 log.error("Failed to delete user account on SPS for user: {} response: {}", userUUID, exchange);
             }
@@ -664,7 +666,6 @@ Collection<ScreenProctoringGroup> reinitializeScreenProctoring(final Exam exam)
             log.error("Failed to re-initialize Screen Proctoring: ", e);
             return Collections.emptyList();
         }
-
     }
 
     Result<ScreenProctoringGroup> createGroup(
@@ -930,7 +931,7 @@ private Collection<ScreenProctoringGroup> initializeGroups(
             boolean applyRollback) {
 
         try {
-
+            
             final ScreenProctoringSettings settings = this.proctoringSettingsDAO
                     .getScreenProctoringSettings(new EntityKey(exam.id, EntityType.EXAM))
                     .getOrThrow();

diff --git a/...ebserver/webservice/servicelayer/session/impl/proctoring/ScreenProctoringServiceImpl.java b/...ebserver/webservice/servicelayer/session/impl/proctoring/ScreenProctoringServiceImpl.java
@@ -11,6 +11,8 @@
 import static ch.ethz.seb.sebserver.gbl.model.session.ClientInstruction.SEB_INSTRUCTION_ATTRIBUTES.SEB_SCREEN_PROCTORING.*;
 
 import java.util.*;
+import java.util.function.Function;
+import java.util.stream.Collectors;
 
 import ch.ethz.seb.sebserver.gbl.async.AsyncServiceSpringConfig;
 import ch.ethz.seb.sebserver.gbl.model.Activatable;
@@ -56,6 +58,8 @@
 public class ScreenProctoringServiceImpl implements ScreenProctoringService {
 
     private static final Logger log = LoggerFactory.getLogger(ScreenProctoringServiceImpl.class);
+    public static final Logger INIT_LOGGER = LoggerFactory.getLogger("ch.ethz.seb.SEB_SERVER_INIT");
+
     private final Cryptor cryptor;
     private final ScreenProctoringAPIBinding screenProctoringAPIBinding;
     private final ScreenProctoringGroupDAO screenProctoringGroupDAO;
@@ -185,8 +189,8 @@ public Result<Exam> applyScreenProctoringForExam(final EntityKey entityKey) {
                                         "Failed to apply screen proctoring for exam: {}",
                                         exam,
                                         error))
-                                .getOrThrow()
-                                .forEach(newGroup -> createNewLocalGroup(exam, newGroup));
+                                .map(groups -> createExamGroups(exam, groups))
+                                .getOrThrow();
 
                         this.examDAO.markUpdate(exam.id);
 
@@ -204,6 +208,34 @@ public Result<Exam> applyScreenProctoringForExam(final EntityKey entityKey) {
                     return exam;
                 });
     }
+
+    private Exam createExamGroups(final Exam exam, final Collection<ScreenProctoringGroup> groups) {
+
+        final Map<String, ScreenProctoringGroup> existingGroups = this.screenProctoringGroupDAO
+                .getCollectingGroups(exam.id)
+                .onError(error -> log.error("Failed to get existing groups to check integrity: ", error))
+                .getOr(Collections.emptyList())
+                .stream().collect(Collectors.toMap( g -> g.name, Function.identity()));
+
+        groups.forEach(newGroup ->
+                {
+                    if (existingGroups.containsKey(newGroup.name)) {
+                        final ScreenProctoringGroup screenProctoringGroup = existingGroups.get(newGroup.name);
+
+                        log.warn(
+                                "There exists already a local screen proctoring group with the name: {}. This is deleted due to the fact that a new one is going to be created with the same name. Groups {}",
+                                screenProctoringGroup.name,
+                                screenProctoringGroup);
+
+                        this.screenProctoringGroupDAO.deleteGroup(screenProctoringGroup.id)
+                                .onError(error -> log.error("Failed to delete screen proctoring group due to group mismatch", error));
+                    }
+
+                    createNewLocalGroup(exam, newGroup);
+                });
+
+        return exam;
+    }
 
     @Override
     public Result<Collection<ScreenProctoringGroup>> getCollectingGroups(final Long examId) {
@@ -460,7 +492,6 @@ private ScreenProctoringGroup applySEBConnectionToGroup(
                 return applyToDefaultGroup(ccRecord.getId(), ccRecord.getConnectionToken(), exam);
             }
         }
-
     }
 
     private ScreenProctoringGroup applyToDefaultGroup(

diff --git a/src/main/java/ch/ethz/seb/sebserver/webservice/weblayer/api/UserAccountController.java b/src/main/java/ch/ethz/seb/sebserver/webservice/weblayer/api/UserAccountController.java
@@ -42,6 +42,7 @@
 import ch.ethz.seb.sebserver.webservice.servicelayer.session.ScreenProctoringService;
 import ch.ethz.seb.sebserver.webservice.servicelayer.validation.BeanValidationService;
 import ch.ethz.seb.sebserver.webservice.weblayer.oauth.RevokeTokenEndpoint;
+import com.sun.xml.bind.v2.TODO;
 import org.mybatis.dynamic.sql.SqlTable;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;