diff --git a/src/main/java/de/tum/cit/aet/artemis/core/web/CourseResource.java b/src/main/java/de/tum/cit/aet/artemis/core/web/CourseResource.java index cc2589f5321c..e26daca9ce8e 100644 --- a/src/main/java/de/tum/cit/aet/artemis/core/web/CourseResource.java +++ b/src/main/java/de/tum/cit/aet/artemis/core/web/CourseResource.java @@ -785,6 +785,25 @@ public ResponseEntity getCourseWithExercises(@PathVariable Long courseId return ResponseEntity.ok(course); } + /** + * GET /courses/:courseId : get the "id" course. + * + * @param courseId the id of the course to retrieve + * @return the ResponseEntity with status 200 (OK) and with body the course, or with status 404 (Not Found) + */ + @GetMapping("courses/{courseId}/with-exercises-lectures-competencies") + @EnforceAtLeastTutor + public ResponseEntity getCourseWithExercisesAndLecturesAndCompetencies(@PathVariable Long courseId) { + log.debug("REST request to get course {} for tutors", courseId); + Optional courseOptional = courseRepository.findWithEagerExercisesAndLecturesAndLectureUnitsAndCompetenciesById(courseId); + if (courseOptional.isEmpty()) { + return ResponseEntity.notFound().build(); + } + Course course = courseOptional.get(); + authCheckService.checkHasAtLeastRoleInCourseElseThrow(Role.TEACHING_ASSISTANT, course, null); + return ResponseEntity.ok(course); + } + /** * GET /courses/:courseId/with-organizations Get a course by id with eagerly loaded organizations * diff --git a/src/main/java/de/tum/cit/aet/artemis/lti/domain/LtiResourceLaunch.java b/src/main/java/de/tum/cit/aet/artemis/lti/domain/LtiResourceLaunch.java index 830f27870ad2..ccbbe71b8a8d 100644 --- a/src/main/java/de/tum/cit/aet/artemis/lti/domain/LtiResourceLaunch.java +++ b/src/main/java/de/tum/cit/aet/artemis/lti/domain/LtiResourceLaunch.java @@ -35,7 +35,6 @@ public class LtiResourceLaunch extends DomainObject { @ManyToOne private User user; - @NotNull @ManyToOne private Exercise exercise; diff --git a/src/main/java/de/tum/cit/aet/artemis/lti/service/DeepLinkingType.java b/src/main/java/de/tum/cit/aet/artemis/lti/service/DeepLinkingType.java new file mode 100644 index 000000000000..dc51b95724f9 --- /dev/null +++ b/src/main/java/de/tum/cit/aet/artemis/lti/service/DeepLinkingType.java @@ -0,0 +1,22 @@ +package de.tum.cit.aet.artemis.lti.service; + +public enum DeepLinkingType { + + EXERCISE, LECTURE, COMPETENCY, LEARNING_PATH, IRIS; + + /** + * Get the enum value from a string. + * + * @param type The string representation of the deep linking type. + * @return The corresponding DeepLinkingType. + * @throws IllegalArgumentException if the type does not match any enum value. + */ + public static DeepLinkingType fromString(String type) { + for (DeepLinkingType deepLinkingType : values()) { + if (deepLinkingType.name().equalsIgnoreCase(type)) { + return deepLinkingType; + } + } + throw new IllegalArgumentException("Invalid deep linking type: " + type); + } +} diff --git a/src/main/java/de/tum/cit/aet/artemis/lti/service/Lti13Service.java b/src/main/java/de/tum/cit/aet/artemis/lti/service/Lti13Service.java index 8b645aa4aaef..3168cc1947d7 100644 --- a/src/main/java/de/tum/cit/aet/artemis/lti/service/Lti13Service.java +++ b/src/main/java/de/tum/cit/aet/artemis/lti/service/Lti13Service.java @@ -45,6 +45,8 @@ import de.tum.cit.aet.artemis.exercise.domain.Exercise; import de.tum.cit.aet.artemis.exercise.domain.participation.StudentParticipation; import de.tum.cit.aet.artemis.exercise.repository.ExerciseRepository; +import de.tum.cit.aet.artemis.lecture.domain.Lecture; +import de.tum.cit.aet.artemis.lecture.repository.LectureRepository; import de.tum.cit.aet.artemis.lti.config.Lti13TokenRetriever; import de.tum.cit.aet.artemis.lti.domain.LtiPlatformConfiguration; import de.tum.cit.aet.artemis.lti.domain.LtiResourceLaunch; @@ -62,12 +64,24 @@ public class Lti13Service { private static final String EXERCISE_PATH_PATTERN = "/courses/{courseId}/exercises/{exerciseId}"; + private static final String LECTURE_PATH_PATTERN = "/courses/{courseId}/lectures/{lectureId}"; + + private static final String COMPETENCY_PATH_PATTERN = "/courses/{courseId}/competencies"; + + private static final String IRIS_PATH_PATTERN = "/about-iris"; + + private static final String LEARNING_PATH_PATH_PATTERN = "/courses/{courseId}/learning-path"; + + private static final String COURSE_PATH_PATTERN = "/courses/{courseId}"; + private static final Logger log = LoggerFactory.getLogger(Lti13Service.class); private final UserRepository userRepository; private final ExerciseRepository exerciseRepository; + private final LectureRepository lectureRepository; + private final CourseRepository courseRepository; private final Lti13ResourceLaunchRepository launchRepository; @@ -86,11 +100,13 @@ public class Lti13Service { private final RestTemplate restTemplate; - public Lti13Service(UserRepository userRepository, ExerciseRepository exerciseRepository, CourseRepository courseRepository, Lti13ResourceLaunchRepository launchRepository, - LtiService ltiService, ResultRepository resultRepository, Lti13TokenRetriever tokenRetriever, OnlineCourseConfigurationService onlineCourseConfigurationService, - RestTemplate restTemplate, ArtemisAuthenticationProvider artemisAuthenticationProvider, LtiPlatformConfigurationRepository ltiPlatformConfigurationRepository) { + public Lti13Service(UserRepository userRepository, ExerciseRepository exerciseRepository, LectureRepository lectureRepository, CourseRepository courseRepository, + Lti13ResourceLaunchRepository launchRepository, LtiService ltiService, ResultRepository resultRepository, Lti13TokenRetriever tokenRetriever, + OnlineCourseConfigurationService onlineCourseConfigurationService, RestTemplate restTemplate, ArtemisAuthenticationProvider artemisAuthenticationProvider, + LtiPlatformConfigurationRepository ltiPlatformConfigurationRepository) { this.userRepository = userRepository; this.exerciseRepository = exerciseRepository; + this.lectureRepository = lectureRepository; this.courseRepository = courseRepository; this.ltiService = ltiService; this.launchRepository = launchRepository; @@ -109,20 +125,23 @@ public Lti13Service(UserRepository userRepository, ExerciseRepository exerciseRe * @param ltiIdToken the id token for the user launching the request * @param clientRegistrationId the clientRegistrationId of the source LMS */ + // TODO implement Iris support public void performLaunch(OidcIdToken ltiIdToken, String clientRegistrationId) { String targetLinkUrl = ltiIdToken.getClaim(Claims.TARGET_LINK_URI); Optional targetExercise = getExerciseFromTargetLink(targetLinkUrl); - if (targetExercise.isEmpty()) { - String message = "No exercise to launch at " + targetLinkUrl; + Optional targetLecture = getLectureFromTargetLink(targetLinkUrl); + Optional targetCourse = getCourseFromTargetLink(targetLinkUrl); + + if (targetCourse.isEmpty()) { + String message = "No course to launch at " + targetLinkUrl; log.error(message); - throw new BadRequestAlertException("Exercise not found", "LTI", "ltiExerciseNotFound"); + throw new BadRequestAlertException("Course not found", "LTI", "ltiCourseNotFound"); } - Exercise exercise = targetExercise.get(); - Course course = courseRepository.findByIdWithEagerOnlineCourseConfigurationElseThrow(exercise.getCourseViaExerciseGroupOrCourseMember().getId()); - OnlineCourseConfiguration onlineCourseConfiguration = course.getOnlineCourseConfiguration(); + Course course = targetCourse.get(); + OnlineCourseConfiguration onlineCourseConfiguration = courseRepository.findWithEagerOnlineCourseConfigurationById(course.getId()).getOnlineCourseConfiguration(); if (onlineCourseConfiguration == null) { - String message = "Exercise is not related to course for target link url: " + targetLinkUrl; + String message = "LTI is not configured for course with target link URL: " + targetLinkUrl; log.error(message); throw new BadRequestAlertException("LTI is not configured for this course", "LTI", "ltiNotConfigured"); } @@ -133,18 +152,24 @@ public void performLaunch(OidcIdToken ltiIdToken, String clientRegistrationId) { if (!onlineCourseConfiguration.isRequireExistingUser() && optionalUsername.isEmpty()) { SecurityContextHolder.getContext().setAuthentication(ltiService.createNewUserFromLaunchRequest(ltiIdToken.getEmail(), createUsernameFromLaunchRequest(ltiIdToken, onlineCourseConfiguration), ltiIdToken.getGivenName(), ltiIdToken.getFamilyName())); - } String username = optionalUsername.orElseGet(() -> createUsernameFromLaunchRequest(ltiIdToken, onlineCourseConfiguration)); User user = userRepository.findOneWithGroupsAndAuthoritiesByLogin(username).orElseThrow(); - ltiService.onSuccessfulLtiAuthentication(user, targetExercise.get()); Lti13LaunchRequest launchRequest = launchRequestFrom(ltiIdToken, clientRegistrationId); - createOrUpdateResourceLaunch(launchRequest, user, targetExercise.get()); - - ltiService.authenticateLtiUser(ltiIdToken.getEmail(), createUsernameFromLaunchRequest(ltiIdToken, onlineCourseConfiguration), ltiIdToken.getGivenName(), - ltiIdToken.getFamilyName(), onlineCourseConfiguration.isRequireExistingUser()); + if (targetExercise.isPresent()) { + Exercise exercise = targetExercise.get(); + handleLaunchRequest(launchRequest, user, exercise, ltiIdToken, onlineCourseConfiguration); + } + else if (getCompetencyFromTargetLink(targetLinkUrl) || getLearningPathFromTargetLink(targetLinkUrl) || targetLecture.isPresent()) { + handleLaunchRequest(launchRequest, user, null, ltiIdToken, onlineCourseConfiguration); + } + else { + String message = "No exercise or competency to launch at " + targetLinkUrl; + log.error(message); + throw new BadRequestAlertException("Exercise not found", "LTI", "ltiExerciseNotFound"); + } } /** @@ -311,6 +336,141 @@ private Optional getExerciseFromTargetLink(String targetLinkUrl) { return exerciseOpt; } + /** + * Returns an Optional of a Lecture that was referenced by targetLinkUrl. + * + * @param targetLinkUrl to retrieve a Lecture + * @return the Lecture or nothing otherwise + */ + private Optional getLectureFromTargetLink(String targetLinkUrl) { + AntPathMatcher matcher = new AntPathMatcher(); + + String targetLinkPath; + try { + targetLinkPath = new URI(targetLinkUrl).getPath(); + } + catch (URISyntaxException ex) { + log.info("Malformed target link url: {}", targetLinkUrl); + return Optional.empty(); + } + + if (!matcher.match(LECTURE_PATH_PATTERN, targetLinkPath)) { + log.info("Could not extract lecture from target link: {}", targetLinkUrl); + return Optional.empty(); + } + + Map pathVariables = matcher.extractUriTemplateVariables(LECTURE_PATH_PATTERN, targetLinkPath); + + String lectureId = pathVariables.get("lectureId"); + + Optional lectureOpt = lectureRepository.findById(Long.valueOf(lectureId)); + + if (lectureOpt.isEmpty()) { + log.info("Could not find lecture for target link url: {}", targetLinkUrl); + return Optional.empty(); + } + + return lectureOpt; + } + + /** + * Returns an Optional of a Course that was referenced by targetLinkUrl. + * + * @param targetLinkUrl the target link URL to retrieve a Course + * @return the Course or nothing otherwise + */ + public Optional getCourseFromTargetLink(String targetLinkUrl) { + AntPathMatcher matcher = new AntPathMatcher(); + + String targetLinkPath; + try { + targetLinkPath = new URI(targetLinkUrl).getPath(); + } + catch (URISyntaxException ex) { + log.info("Malformed target link url: {}", targetLinkUrl); + return Optional.empty(); + } + + Map pathVariables = null; + if (matcher.match(COURSE_PATH_PATTERN, targetLinkPath)) { + pathVariables = matcher.extractUriTemplateVariables(COURSE_PATH_PATTERN, targetLinkPath); + } + else if (matcher.match(COMPETENCY_PATH_PATTERN, targetLinkPath)) { + pathVariables = matcher.extractUriTemplateVariables(COMPETENCY_PATH_PATTERN, targetLinkPath); + } + else if (matcher.match(EXERCISE_PATH_PATTERN, targetLinkPath)) { + pathVariables = matcher.extractUriTemplateVariables(EXERCISE_PATH_PATTERN, targetLinkPath); + } + else if (matcher.match(LEARNING_PATH_PATH_PATTERN, targetLinkPath)) { + pathVariables = matcher.extractUriTemplateVariables(LEARNING_PATH_PATH_PATTERN, targetLinkPath); + } + else if (matcher.match(LECTURE_PATH_PATTERN, targetLinkPath)) { + pathVariables = matcher.extractUriTemplateVariables(LECTURE_PATH_PATTERN, targetLinkPath); + } + + if (pathVariables == null || !pathVariables.containsKey("courseId")) { + log.info("Could not extract courseId from target link: {}", targetLinkUrl); + return Optional.empty(); + } + + String courseId = pathVariables.get("courseId"); + return courseRepository.findById(Long.valueOf(courseId)); + } + + /** + * Checks if the target link URL references a competency. + * + * @param targetLinkUrl the target link URL + * @return true if the target link URL references a competency, false otherwise + */ + private boolean getCompetencyFromTargetLink(String targetLinkUrl) { + AntPathMatcher matcher = new AntPathMatcher(); + + String targetLinkPath; + try { + targetLinkPath = new URI(targetLinkUrl).getPath(); + } + catch (URISyntaxException ex) { + log.info("Malformed target link url: {}", targetLinkUrl); + return false; + } + + if (!matcher.match(COMPETENCY_PATH_PATTERN, targetLinkPath)) { + log.info("Could not extract competency from target link: {}", targetLinkUrl); + return false; + } + + log.info("Competency link detected: {}", targetLinkUrl); + return true; + } + + /** + * Checks if the target link URL references a learning path. + * + * @param targetLinkUrl the target link URL + * @return true if the target link URL references a learning path, false otherwise + */ + private boolean getLearningPathFromTargetLink(String targetLinkUrl) { + AntPathMatcher matcher = new AntPathMatcher(); + + String targetLinkPath; + try { + targetLinkPath = new URI(targetLinkUrl).getPath(); + } + catch (URISyntaxException ex) { + log.info("Malformed target link URL: {}", targetLinkUrl); + return false; + } + + if (!matcher.match(LEARNING_PATH_PATH_PATTERN, targetLinkPath)) { + log.info("Could not extract learning path from target link: {}", targetLinkUrl); + return false; + } + + log.info("Learning path link detected: {}", targetLinkUrl); + return true; + } + private void createOrUpdateResourceLaunch(Lti13LaunchRequest launchRequest, User user, Exercise exercise) { Optional launchOpt = launchRepository.findByIssAndSubAndDeploymentIdAndResourceLinkId(launchRequest.iss(), launchRequest.sub(), launchRequest.deploymentId(), launchRequest.resourceLinkId()); @@ -332,6 +492,17 @@ private void createOrUpdateResourceLaunch(Lti13LaunchRequest launchRequest, User launchRepository.save(launch); } + private void handleLaunchRequest(Lti13LaunchRequest launchRequest, User user, Exercise exercise, OidcIdToken ltiIdToken, OnlineCourseConfiguration onlineCourseConfiguration) { + createOrUpdateResourceLaunch(launchRequest, user, exercise); + + ltiService.authenticateLtiUser(ltiIdToken.getEmail(), createUsernameFromLaunchRequest(ltiIdToken, onlineCourseConfiguration), ltiIdToken.getGivenName(), + ltiIdToken.getFamilyName(), onlineCourseConfiguration.isRequireExistingUser()); + + if (exercise != null) { + ltiService.onSuccessfulLtiAuthentication(user, exercise); + } + } + /** * Build the response for the LTI launch. * diff --git a/src/main/java/de/tum/cit/aet/artemis/lti/service/LtiDeepLinkingService.java b/src/main/java/de/tum/cit/aet/artemis/lti/service/LtiDeepLinkingService.java index 7bd84f9c49c2..014cea88c55f 100644 --- a/src/main/java/de/tum/cit/aet/artemis/lti/service/LtiDeepLinkingService.java +++ b/src/main/java/de/tum/cit/aet/artemis/lti/service/LtiDeepLinkingService.java @@ -4,6 +4,7 @@ import java.util.ArrayList; import java.util.HashMap; +import java.util.List; import java.util.Map; import java.util.Optional; import java.util.Set; @@ -15,10 +16,14 @@ import org.springframework.stereotype.Service; import org.springframework.web.util.UriComponentsBuilder; +import de.tum.cit.aet.artemis.atlas.domain.competency.Competency; import de.tum.cit.aet.artemis.core.exception.BadRequestAlertException; +import de.tum.cit.aet.artemis.core.repository.CourseRepository; import de.tum.cit.aet.artemis.exercise.domain.Exercise; import de.tum.cit.aet.artemis.exercise.domain.IncludedInOverallScore; import de.tum.cit.aet.artemis.exercise.repository.ExerciseRepository; +import de.tum.cit.aet.artemis.lecture.domain.Lecture; +import de.tum.cit.aet.artemis.lecture.repository.LectureRepository; import de.tum.cit.aet.artemis.lti.config.Lti13TokenRetriever; import de.tum.cit.aet.artemis.lti.dto.Lti13DeepLinkingResponse; @@ -34,8 +39,12 @@ public class LtiDeepLinkingService { private static final double DEFAULT_SCORE_MAXIMUM = 100D; + private final CourseRepository courseRepository; + private final ExerciseRepository exerciseRepository; + private final LectureRepository lectureRepository; + private final Lti13TokenRetriever tokenRetriever; /** @@ -44,8 +53,11 @@ public class LtiDeepLinkingService { * @param exerciseRepository The repository for exercises. * @param tokenRetriever The LTI 1.3 token retriever. */ - public LtiDeepLinkingService(ExerciseRepository exerciseRepository, Lti13TokenRetriever tokenRetriever) { + public LtiDeepLinkingService(CourseRepository courseRepository, ExerciseRepository exerciseRepository, LectureRepository lectureRepository, + Lti13TokenRetriever tokenRetriever) { + this.courseRepository = courseRepository; this.exerciseRepository = exerciseRepository; + this.lectureRepository = lectureRepository; this.tokenRetriever = tokenRetriever; } @@ -55,15 +67,32 @@ public LtiDeepLinkingService(ExerciseRepository exerciseRepository, Lti13TokenRe * @param ltiIdToken OIDC ID token with the user's authentication claims. * @param clientRegistrationId Client registration ID for the LTI tool. * @param courseId ID of the course for deep linking. - * @param exerciseIds Set of IDs of the exercises for deep linking. + * @param unitIds Set of IDs of the exercises/lectures for deep linking. * @return Constructed deep linking response URL. * @throws BadRequestAlertException if there are issues with the OIDC ID token claims. */ - public String performDeepLinking(OidcIdToken ltiIdToken, String clientRegistrationId, Long courseId, Set exerciseIds) { + public String performDeepLinking(OidcIdToken ltiIdToken, String clientRegistrationId, Long courseId, Set unitIds, DeepLinkingType type) { // Initialize DeepLinkingResponse Lti13DeepLinkingResponse lti13DeepLinkingResponse = Lti13DeepLinkingResponse.from(ltiIdToken, clientRegistrationId); - // Fill selected exercise link into content items - ArrayList> contentItems = this.populateContentItems(String.valueOf(courseId), exerciseIds); + // Dynamically populate content items based on the type + ArrayList> contentItems = switch (type) { + case EXERCISE -> { + if (unitIds == null || unitIds.isEmpty()) { + throw new BadRequestAlertException("No exercise IDs provided for deep linking", "LTI", "noExerciseIds"); + } + yield populateExerciseContentItems(String.valueOf(courseId), unitIds); + } + case LECTURE -> { + if (unitIds == null || unitIds.isEmpty()) { + throw new BadRequestAlertException("No lecture IDs provided for deep linking", "LTI", "noLectureIds"); + } + yield populateLectureContentItems(String.valueOf(courseId), unitIds); + } + case COMPETENCY -> populateCompetencyContentItems(String.valueOf(courseId)); + case IRIS -> populateIrisContentItems(String.valueOf(courseId)); + case LEARNING_PATH -> populateLearningPathsContentItems(String.valueOf(courseId)); + default -> throw new BadRequestAlertException("Invalid deep linking type provided", "LTI", "invalidType"); + }; lti13DeepLinkingResponse = lti13DeepLinkingResponse.setContentItems(contentItems); // Prepare return url with jwt and id parameters @@ -98,23 +127,94 @@ private String buildLtiDeepLinkResponse(String clientRegistrationId, Lti13DeepLi * @param courseId The course ID. * @param exerciseIds The set of exercise IDs. */ - private ArrayList> populateContentItems(String courseId, Set exerciseIds) { + private ArrayList> populateExerciseContentItems(String courseId, Set exerciseIds) { ArrayList> contentItems = new ArrayList<>(); for (Long exerciseId : exerciseIds) { - Map item = setContentItem(courseId, String.valueOf(exerciseId)); + Map item = setExerciseContentItem(courseId, String.valueOf(exerciseId)); contentItems.add(item); } + return contentItems; + } + /** + * Populate content items for deep linking response with lectures. + * + * @param courseId The course ID. + * @param lectureIds The set of lecture IDs. + */ + private ArrayList> populateLectureContentItems(String courseId, Set lectureIds) { + ArrayList> contentItems = new ArrayList<>(); + for (Long lectureId : lectureIds) { + Map item = setLectureContentItem(courseId, String.valueOf(lectureId)); + contentItems.add(item); + + } return contentItems; } - private Map setContentItem(String courseId, String exerciseId) { + /** + * Populate content items for deep linking response with competencies. + * + * @param courseId The course ID. + */ + private ArrayList> populateCompetencyContentItems(String courseId) { + return new ArrayList<>(List.of(setCompetencyContentItem(courseId))); + } + + /** + * Populate content items for deep linking response with Iris. + * + * @param courseId The course ID. + */ + private ArrayList> populateIrisContentItems(String courseId) { + return new ArrayList<>(List.of(setIrisContentItem(courseId))); + } + + /** + * Populate content items for deep linking response with learning paths. + * + * @param courseId The course ID. + */ + private ArrayList> populateLearningPathsContentItems(String courseId) { + return new ArrayList<>(List.of(setLearningPathContentItem(courseId))); + } + + private Map setExerciseContentItem(String courseId, String exerciseId) { Optional exerciseOpt = exerciseRepository.findById(Long.valueOf(exerciseId)); String launchUrl = String.format(artemisServerUrl + "/courses/%s/exercises/%s", courseId, exerciseId); - return exerciseOpt.map(exercise -> createContentItem(exerciseOpt.get(), launchUrl)).orElse(null); + return exerciseOpt.map(exercise -> createExerciseContentItem(exerciseOpt.get(), launchUrl)).orElse(null); } - private Map createContentItem(Exercise exercise, String url) { + private Map setLectureContentItem(String courseId, String lectureId) { + Optional lectureOpt = lectureRepository.findById(Long.valueOf(lectureId)); + String launchUrl = String.format(artemisServerUrl + "/courses/%s/lectures/%s", courseId, lectureId); + return lectureOpt.map(lecture -> createLectureContentItem(lectureOpt.get(), launchUrl)).orElse(null); + } + + private Map setCompetencyContentItem(String courseId) { + Optional competencyOpt = courseRepository.findWithEagerCompetenciesAndPrerequisitesById(Long.parseLong(courseId)) + .flatMap(course -> course.getCompetencies().stream().findFirst()); + String launchUrl = String.format(artemisServerUrl + "/courses/%s/competencies", courseId); + return competencyOpt.map(competency -> createSingleUnitContentItem(launchUrl)).orElse(null); + } + + private Map setLearningPathContentItem(String courseId) { + boolean hasLearningPaths = courseRepository.findWithEagerLearningPathsAndLearningPathCompetenciesByIdElseThrow(Long.parseLong(courseId)).getLearningPathsEnabled(); + if (hasLearningPaths) { + String launchUrl = String.format(artemisServerUrl + "/courses/%s/learning-path", courseId); + return createSingleUnitContentItem(launchUrl); + } + else + return null; + } + + private Map setIrisContentItem(String courseId) { + // TODO Iris optional + URL + String launchUrl = String.format(artemisServerUrl + "/about-iris", courseId); + return createSingleUnitContentItem(launchUrl); + } + + private Map createExerciseContentItem(Exercise exercise, String url) { Map item = new HashMap<>(); item.put("type", "ltiResourceLink"); @@ -125,6 +225,26 @@ private Map createContentItem(Exercise exercise, String url) { return item; } + private Map createLectureContentItem(Lecture lecture, String url) { + + Map item = new HashMap<>(); + item.put("type", "ltiResourceLink"); + item.put("title", lecture.getTitle()); + item.put("url", url); + + return item; + } + + private Map createSingleUnitContentItem(String url) { + + Map item = new HashMap<>(); + item.put("type", "ltiResourceLink"); + item.put("title", "competency"); + item.put("url", url); + + return item; + } + private void validateDeepLinkingResponseSettings(String returnURL, String jwt, String deploymentId) { if (isEmptyString(jwt)) { throw new BadRequestAlertException("Deep linking response cannot be created", "LTI", "deepLinkingResponseFailed"); diff --git a/src/main/java/de/tum/cit/aet/artemis/lti/web/LtiResource.java b/src/main/java/de/tum/cit/aet/artemis/lti/web/LtiResource.java index cb27da1cf735..6b2f28b19a3a 100644 --- a/src/main/java/de/tum/cit/aet/artemis/lti/web/LtiResource.java +++ b/src/main/java/de/tum/cit/aet/artemis/lti/web/LtiResource.java @@ -39,6 +39,7 @@ import de.tum.cit.aet.artemis.lti.domain.LtiPlatformConfiguration; import de.tum.cit.aet.artemis.lti.domain.OnlineCourseConfiguration; import de.tum.cit.aet.artemis.lti.repository.LtiPlatformConfigurationRepository; +import de.tum.cit.aet.artemis.lti.service.DeepLinkingType; import de.tum.cit.aet.artemis.lti.service.LtiDeepLinkingService; import de.tum.cit.aet.artemis.lti.service.OnlineCourseConfigurationService; import tech.jhipster.web.util.PaginationUtil; @@ -131,10 +132,14 @@ public ResponseEntity updateOnlineCourseConfiguration * @param clientRegistrationId The identifier online of the course configuration. * @return A ResponseEntity containing a JSON object with the 'targetLinkUri' property set to the deep linking response target link. */ + // TODO Deep Linking 1 @PostMapping("lti13/deep-linking/{courseId}") @EnforceAtLeastInstructor - public ResponseEntity lti13DeepLinking(@PathVariable Long courseId, @RequestParam(name = "exerciseIds") Set exerciseIds, + public ResponseEntity lti13DeepLinking(@PathVariable Long courseId, @RequestParam(name = "exerciseIds", required = false) Set exerciseIds, + @RequestParam(name = "lectureIds", required = false) Set lectureIds, @RequestParam(name = "competency", required = false) boolean competency, + @RequestParam(name = "learningPath", required = false) boolean learningPath, @RequestParam(name = "iris", required = false) boolean iris, @RequestParam(name = "ltiIdToken") String ltiIdToken, @RequestParam(name = "clientRegistrationId") String clientRegistrationId) throws ParseException { + // TODO update message log.info("LTI 1.3 Deep Linking request received for course {} with exercises {} for registrationId {}", courseId, exerciseIds, clientRegistrationId); Course course = courseRepository.findByIdWithEagerOnlineCourseConfigurationElseThrow(courseId); @@ -146,7 +151,26 @@ public ResponseEntity lti13DeepLinking(@PathVariable Long courseId, @Req OidcIdToken idToken = new OidcIdToken(ltiIdToken, null, null, SignedJWT.parse(ltiIdToken).getJWTClaimsSet().getClaims()); - String targetLink = ltiDeepLinkingService.performDeepLinking(idToken, clientRegistrationId, courseId, exerciseIds); + String targetLink; + + if (exerciseIds != null) { + targetLink = ltiDeepLinkingService.performDeepLinking(idToken, clientRegistrationId, courseId, exerciseIds, DeepLinkingType.EXERCISE); + } + else if (lectureIds != null) { + targetLink = ltiDeepLinkingService.performDeepLinking(idToken, clientRegistrationId, courseId, lectureIds, DeepLinkingType.LECTURE); + } + else if (competency) { + targetLink = ltiDeepLinkingService.performDeepLinking(idToken, clientRegistrationId, courseId, null, DeepLinkingType.COMPETENCY); + } + else if (learningPath) { + targetLink = ltiDeepLinkingService.performDeepLinking(idToken, clientRegistrationId, courseId, null, DeepLinkingType.LEARNING_PATH); + } + else if (iris) { + targetLink = ltiDeepLinkingService.performDeepLinking(idToken, clientRegistrationId, courseId, null, DeepLinkingType.IRIS); + } + else { + throw new BadRequestAlertException("No valid deep linking type provided", "LTI", "invalidDeepLinkingType"); + } ObjectNode json = new ObjectMapper().createObjectNode(); json.put("targetLinkUri", targetLink); diff --git a/src/main/java/de/tum/cit/aet/artemis/lti/web/open/PublicLtiResource.java b/src/main/java/de/tum/cit/aet/artemis/lti/web/open/PublicLtiResource.java index c0594b5ba1ca..a94bd5ee6498 100644 --- a/src/main/java/de/tum/cit/aet/artemis/lti/web/open/PublicLtiResource.java +++ b/src/main/java/de/tum/cit/aet/artemis/lti/web/open/PublicLtiResource.java @@ -54,6 +54,7 @@ public class PublicLtiResource { @EnforceNothing public ResponseEntity lti13LaunchRedirect(HttpServletRequest request, HttpServletResponse response) throws IOException { String state = request.getParameter("state"); + if (state == null) { errorOnMissingParameter(response, "state"); return ResponseEntity.ok().build(); diff --git a/src/main/resources/config/liquibase/changelog/20250114140000_changelog.xml b/src/main/resources/config/liquibase/changelog/20250114140000_changelog.xml new file mode 100644 index 000000000000..22d2f6f7c756 --- /dev/null +++ b/src/main/resources/config/liquibase/changelog/20250114140000_changelog.xml @@ -0,0 +1,9 @@ + + + + + + + \ No newline at end of file diff --git a/src/main/resources/config/liquibase/master.xml b/src/main/resources/config/liquibase/master.xml index 02ac0209b9d1..3f3c84362612 100644 --- a/src/main/resources/config/liquibase/master.xml +++ b/src/main/resources/config/liquibase/master.xml @@ -45,6 +45,7 @@ + diff --git a/src/main/webapp/app/course/manage/course-management.service.ts b/src/main/webapp/app/course/manage/course-management.service.ts index 895d180db81a..2609e4150620 100644 --- a/src/main/webapp/app/course/manage/course-management.service.ts +++ b/src/main/webapp/app/course/manage/course-management.service.ts @@ -137,6 +137,16 @@ export class CourseManagementService { .pipe(map((res: EntityResponseType) => this.processCourseEntityResponseType(res))); } + /** + * finds the course with the provided unique identifier together with its exercises + * @param courseId - the id of the course to be found + */ + findWithExercisesAndLecturesAndCompetencies(courseId: number): Observable { + return this.http + .get(`${this.resourceUrl}/${courseId}/with-exercises-lectures-competencies`, { observe: 'response' }) + .pipe(map((res: EntityResponseType) => this.processCourseEntityResponseType(res))); + } + /** * finds a course with the given id and eagerly loaded organizations * @param courseId the id of the course to be found diff --git a/src/main/webapp/app/lti/lti13-deep-linking.component.html b/src/main/webapp/app/lti/lti13-deep-linking.component.html index a3964e4ac713..331bb0d0281a 100644 --- a/src/main/webapp/app/lti/lti13-deep-linking.component.html +++ b/src/main/webapp/app/lti/lti13-deep-linking.component.html @@ -8,74 +8,147 @@

-
- - - - - - - - - - - - - - - - @for (exercise of exercises; track exercise) { - - - - - - - - - - - - } - -
- id - - - {{ 'artemisApp.exercise.type' | artemisTranslate }} - - - {{ 'artemisApp.exercise.title' | artemisTranslate }} - - - {{ 'artemisApp.exercise.releaseDate' | artemisTranslate }} - - - {{ 'artemisApp.exercise.startDate' | artemisTranslate }} - - - {{ 'artemisApp.exercise.dueDate' | artemisTranslate }} - - - {{ 'artemisApp.exercise.assessmentDueDate' | artemisTranslate }} - - - {{ 'artemisApp.exercise.includedInOverallScore' | artemisTranslate }} - -
- - {{ exercise.id ? exercise.id : '' }}{{ exercise.type ? exercise.type : '' }}{{ exercise.title ? exercise.title : '' }}{{ exercise.releaseDate | artemisDate }}{{ exercise.startDate | artemisDate }}{{ exercise.dueDate | artemisDate }}{{ exercise.assessmentDueDate | artemisDate }} - {{ - exercise.includedInOverallScore === 'NOT_INCLUDED' - ? ('artemisApp.exercise.no' | artemisTranslate) - : ('artemisApp.exercise.yes' | artemisTranslate) - }} -
+
+ +
+ + +
+
+ + + + + + + + + + + + + @for (exercise of exercises; track exercise) { + + + + + + + + + } + +
+ id + + + {{ 'artemisApp.exercise.type' | artemisTranslate }} + + + {{ 'artemisApp.exercise.title' | artemisTranslate }} + + + {{ 'artemisApp.exercise.includedInOverallScore' | artemisTranslate }} + +
+ + {{ exercise.id ? exercise.id : '' }}{{ exercise.type ? exercise.type : '' }}{{ exercise.title ? exercise.title : '' }} + {{ + exercise.includedInOverallScore === 'NOT_INCLUDED' + ? ('artemisApp.exercise.no' | artemisTranslate) + : ('artemisApp.exercise.yes' | artemisTranslate) + }} +
+
+
+
+ + +
+ + +
+
+ + + + + + + + + + @for (lecture of lectures; track lecture) { + + + + + + } + +
+ id + + + {{ 'artemisApp.lecture.title' | artemisTranslate }} + +
+ + {{ lecture.id ? lecture.id : '' }}{{ lecture.title ? lecture.title : '' }}
+
+
+
+ +
+

+ + +
+ +
+

+ + +
+ +
+

+ + +
+
- @if (selectedExercises?.size) { + @if (selectedExercises?.size || isCompetencySelected) { diff --git a/src/main/webapp/app/lti/lti13-deep-linking.component.ts b/src/main/webapp/app/lti/lti13-deep-linking.component.ts index 51a5a42ebf3f..4c0e72c7333b 100644 --- a/src/main/webapp/app/lti/lti13-deep-linking.component.ts +++ b/src/main/webapp/app/lti/lti13-deep-linking.component.ts @@ -17,6 +17,7 @@ import { ArtemisSharedComponentModule } from '../shared/components/shared-compon import { ArtemisSharedCommonModule } from '../shared/shared-common.module'; import { FaIconComponent } from '@fortawesome/angular-fontawesome'; import { FormsModule } from '@angular/forms'; +import { Lecture } from 'app/entities/lecture.model'; @Component({ selector: 'jhi-deep-linking', @@ -44,7 +45,12 @@ export class Lti13DeepLinkingComponent implements OnInit { courseId: number; exercises: Exercise[]; + lectures: Lecture[]; selectedExercises?: Set = new Set(); + selectedLectures?: Set = new Set(); + isCompetencySelected = false; + isLearningPathSelected = false; + isIrisSelected = false; course: Course; predicate = 'type'; @@ -77,10 +83,15 @@ export class Lti13DeepLinkingComponent implements OnInit { this.accountService.identity().then((user) => { if (user) { - this.courseManagementService.findWithExercises(this.courseId).subscribe((findWithExercisesResult) => { - if (findWithExercisesResult?.body?.exercises) { + this.courseManagementService.findWithExercisesAndLecturesAndCompetencies(this.courseId).subscribe((findWithExercisesResult) => { + if (findWithExercisesResult?.body) { this.course = findWithExercisesResult.body; - this.exercises = findWithExercisesResult.body.exercises; + if (findWithExercisesResult?.body?.exercises) { + this.exercises = findWithExercisesResult.body.exercises; + } + if (findWithExercisesResult?.body?.lectures) { + this.lectures = findWithExercisesResult.body.lectures; + } } }); } else { @@ -134,45 +145,107 @@ export class Lti13DeepLinkingComponent implements OnInit { /** * Checks if the given exercise is currently selected. * - * @param exercise The exercise to check. * @returns True if the exercise is selected, false otherwise. + * @param exerciseId */ isExerciseSelected(exerciseId: number | undefined) { return exerciseId !== undefined && this.selectedExercises?.has(exerciseId); } + selectLecture(lectureId: number | undefined) { + if (lectureId !== undefined) { + if (this.selectedLectures?.has(lectureId)) { + this.selectedExercises?.delete(lectureId); + } else { + this.selectedExercises?.add(lectureId); + } + } + } + + isLectureSelected(lectureId: number | undefined) { + return lectureId !== undefined && this.selectedExercises?.has(lectureId); + } + + enableCompetency() { + if (!this.isCompetencySelected) { + this.isCompetencySelected = true; + this.isIrisSelected = false; + this.isLearningPathSelected = false; + } + } + + enableLearningPath() { + if (!this.isLearningPathSelected) { + this.isLearningPathSelected = true; + this.isIrisSelected = false; + this.isCompetencySelected = false; + } + } + + enableIris() { + if (!this.isIrisSelected) { + this.isIrisSelected = true; + this.isLearningPathSelected = false; + this.isCompetencySelected = false; + } + } + /** * Sends a deep link request for the selected exercise. - * If an exercise is selected, it sends a POST request to initiate deep linking. + * If an exercise, lecture, competency, learning path or Iris is selected, it sends a POST request to initiate deep linking. */ sendDeepLinkRequest() { - if (this.selectedExercises?.size) { + if (this.selectedExercises?.size || this.selectedLectures?.size || this.isCompetencySelected || this.isLearningPathSelected || this.isCompetencySelected) { const ltiIdToken = this.sessionStorageService.retrieve('ltiIdToken') ?? ''; const clientRegistrationId = this.sessionStorageService.retrieve('clientRegistrationId') ?? ''; - const exerciseIds = Array.from(this.selectedExercises).join(','); - - const httpParams = new HttpParams().set('exerciseIds', exerciseIds).set('ltiIdToken', ltiIdToken!).set('clientRegistrationId', clientRegistrationId!); type DeepLinkingResponse = { targetLinkUri: string; }; - this.http.post(`api/lti13/deep-linking/${this.courseId}`, null, { observe: 'response', params: httpParams }).subscribe({ - next: (response) => { - if (response.status === 200) { - if (response.body) { - const targetLink = response.body.targetLinkUri; - window.location.replace(targetLink); - } - } else { - this.isLinking = false; - this.alertService.error('artemisApp.lti13.deepLinking.unknownError'); - } - }, - error: (error) => { - this.isLinking = false; - onError(this.alertService, error); - }, - }); + + let httpParams; + + if (this.selectedExercises?.size) { + const exerciseIds = Array.from(this.selectedExercises).join(','); + + httpParams = new HttpParams().set('exerciseIds', exerciseIds).set('ltiIdToken', ltiIdToken!).set('clientRegistrationId', clientRegistrationId!); + } else if (this.selectedLectures?.size) { + const lectureIds = Array.from(this.selectedLectures).join(','); + + httpParams = new HttpParams().set('lectureIds', lectureIds).set('ltiIdToken', ltiIdToken!).set('clientRegistrationId', clientRegistrationId!); + } else if (this.isCompetencySelected) { + httpParams = new HttpParams().set('competency', true).set('ltiIdToken', ltiIdToken!).set('clientRegistrationId', clientRegistrationId!); + } else if (this.isLearningPathSelected) { + httpParams = new HttpParams().set('learningPath', true).set('ltiIdToken', ltiIdToken!).set('clientRegistrationId', clientRegistrationId!); + } else if (this.isIrisSelected) { + httpParams = new HttpParams().set('iris', true).set('ltiIdToken', ltiIdToken!).set('clientRegistrationId', clientRegistrationId!); + } + if (httpParams) { + this.http + .post(`api/lti13/deep-linking/${this.courseId}`, null, { + observe: 'response', + params: httpParams, + }) + .subscribe({ + next: (response) => { + if (response.status === 200) { + if (response.body) { + const targetLink = response.body.targetLinkUri; + window.location.replace(targetLink); + } + } else { + this.isLinking = false; + this.alertService.error('artemisApp.lti13.deepLinking.unknownError'); + } + }, + error: (error) => { + this.isLinking = false; + onError(this.alertService, error); + }, + }); + } else { + this.alertService.error('artemisApp.lti13.deepLinking.parameterError'); + } } else { this.alertService.error('artemisApp.lti13.deepLinking.selectToLink'); } diff --git a/src/main/webapp/i18n/de/lti.json b/src/main/webapp/i18n/de/lti.json index 3d004f52d5e9..23cd408cdb14 100644 --- a/src/main/webapp/i18n/de/lti.json +++ b/src/main/webapp/i18n/de/lti.json @@ -4,6 +4,22 @@ "home": { "title": "LTI-Konfiguration" }, + "contentSelectionTable": { + "exercises": "Übungen", + "lectures": "Vorlesungen", + "competencies": { + "header": "Kompetenzen hinzufügen", + "selector": "Bestätigen sie, ob sie eine Verknüpfung zu den Kompetenzen ihres Kurses hinzufügen wollen" + }, + "learningPaths": { + "header": "Lernpfade hinzufügen", + "selector": "Bestätigen sie, ob sie eine Verknüpfung zu den Lernpfaden ihres Kurses hinzufügen wollen" + }, + "iris": { + "header": "Iris hinzufügen", + "selector": "Bestätigen sie, ob sie eine Verknüpfung zu Iris hinzufügen wollen" + } + }, "initializationError": "Die Initialisierung deines Benutzers wurde gestartet aber dein LTI-Konto wurde möglicherweise nicht korrekt erstellt. Bitte benachrichtige deine Übungsleitung, falls du dein Artemis-Passwort bisher nicht erhalten hast.", "initialization": { "header": "LTI Benutzer Initialisierung", @@ -90,7 +106,8 @@ "selectToLink": "Übungen zum Verlinken auswählen", "unknownError": "Aufgrund eines unbekannten Fehlers nicht erfolgreich. Bitte kontaktiere einen Admin!", "noCoursesError": "Keiner deiner Artemis-Kurse hat LTI aktiviert. Bitte fahre mit der Konfiguration mindestens eines Kurses fort.", - "learnMore": "Erfahre mehr über die Einrichtung von LTI in einem Kurs.." + "learnMore": "Erfahre mehr über die Einrichtung von LTI in einem Kurs..", + "parameterError": "Es gab einen fehler beim verarbeiten der Parameter" }, "missingConfigurationWarning": "Fehlende Werte in der LTI1.3-Konfiguration. Starts werden nicht funktionieren. Bitte wende dich für die Konfiguration an den Administrator.", "selectContentFromCourse": "Wähle Inhalte aus dem Kurs {{ title }} aus", diff --git a/src/main/webapp/i18n/en/lti.json b/src/main/webapp/i18n/en/lti.json index 94d21201708b..4a1a0c5191c0 100644 --- a/src/main/webapp/i18n/en/lti.json +++ b/src/main/webapp/i18n/en/lti.json @@ -4,6 +4,22 @@ "home": { "title": "LTI Configuration" }, + "contentSelectionTable": { + "exercises": "Exercises", + "lectures": "Lectures", + "competencies": { + "header": "Add competencies", + "selector": "Confirm whether you want to add a link to the competencies of your course" + }, + "learningPaths": { + "header": "Add learning paths", + "selector": "Confirm whether you want to add a link to the learning paths of your course" + }, + "iris": { + "header": "Add Iris", + "selector": "Confirm whether you want to add a link to Iris" + } + }, "initializationError": "Your user initialization process was started but your LTI account was possible created with issues. Please ask your instructor for help if you didn't receive your Artemis password yet.", "initialization": { "header": "LTI User Initialization", @@ -90,7 +106,8 @@ "selectToLink": "Select exercises to link", "unknownError": "Unsuccessful due to an unknown error. Please contact an admin!", "noCoursesError": "You do not have any LTI-enabled courses in Artemis yet. Please configure at least one course to use this feature.", - "learnMore": "Learn more about enabling LTI in your course.." + "learnMore": "Learn more about enabling LTI in your course..", + "parameterError": "There was an error when processing the parameters" }, "missingConfigurationWarning": "Missing values in the LTI1.3 configuration. Launches will not work. Please contact the administrator for configuration.", "selectContentFromCourse": "Select content from course {{ title }}", diff --git a/src/test/java/de/tum/cit/aet/artemis/lti/Lti13ServiceTest.java b/src/test/java/de/tum/cit/aet/artemis/lti/Lti13ServiceTest.java index 4ddb939b2ecb..3d330e2b5c1d 100644 --- a/src/test/java/de/tum/cit/aet/artemis/lti/Lti13ServiceTest.java +++ b/src/test/java/de/tum/cit/aet/artemis/lti/Lti13ServiceTest.java @@ -56,6 +56,7 @@ import de.tum.cit.aet.artemis.exercise.domain.Exercise; import de.tum.cit.aet.artemis.exercise.domain.participation.StudentParticipation; import de.tum.cit.aet.artemis.exercise.repository.ExerciseTestRepository; +import de.tum.cit.aet.artemis.lecture.repository.LectureRepository; import de.tum.cit.aet.artemis.lti.config.Lti13TokenRetriever; import de.tum.cit.aet.artemis.lti.domain.LtiPlatformConfiguration; import de.tum.cit.aet.artemis.lti.domain.LtiResourceLaunch; @@ -80,6 +81,9 @@ class Lti13ServiceTest { @Mock private ExerciseTestRepository exerciseRepository; + @Mock + private LectureRepository lectureRepository; + @Mock private CourseTestRepository courseRepository; @@ -120,7 +124,7 @@ class Lti13ServiceTest { @BeforeEach void init() { closeable = MockitoAnnotations.openMocks(this); - lti13Service = new Lti13Service(userRepository, exerciseRepository, courseRepository, launchRepository, ltiService, resultRepository, tokenRetriever, + lti13Service = new Lti13Service(userRepository, exerciseRepository, lectureRepository, courseRepository, launchRepository, ltiService, resultRepository, tokenRetriever, onlineCourseConfigurationService, restTemplate, artemisAuthenticationProvider, ltiPlatformConfigurationRepository); clientRegistrationId = "clientId"; onlineCourseConfiguration = new OnlineCourseConfiguration(); @@ -209,19 +213,10 @@ void performLaunch_invalidPath(String invalidPath) { @Test void performLaunch_courseNotFound() { - long exerciseId = 134; - Exercise exercise = new TextExercise(); - exercise.setId(exerciseId); - Course course = new Course(); - course.setId(1000L); - exercise.setCourse(course); + this.prepareForPerformLaunch(1000L, 123L); - doReturn(Optional.of(exercise)).when(exerciseRepository).findById(any()); doThrow(EntityNotFoundException.class).when(courseRepository).findByIdWithEagerOnlineCourseConfigurationElseThrow(1000L); - - OidcIdToken oidcIdToken = mock(OidcIdToken.class); - String target = "https://some-artemis-domain.org/courses/12/exercises/123"; - doReturn(target).when(oidcIdToken).getClaim(Claims.TARGET_LINK_URI); + doThrow(EntityNotFoundException.class).when(courseRepository).findById(1000L); assertThatExceptionOfType(EntityNotFoundException.class).isThrownBy(() -> lti13Service.performLaunch(oidcIdToken, clientRegistrationId)); } @@ -498,6 +493,66 @@ void startDeepLinkingPlatformNotFound() { assertThatExceptionOfType(BadRequestAlertException.class).isThrownBy(() -> lti13Service.startDeepLinking(oidcIdToken, clientRegistrationId)); } + @Test + void getCourseFromTargetLink_validCoursePath() { + String targetLinkUrl = "https://some-artemis-domain.org/courses/123"; + Course mockCourse = new Course(); + mockCourse.setId(123L); + + when(courseRepository.findById(123L)).thenReturn(Optional.of(mockCourse)); + + Optional course = lti13Service.getCourseFromTargetLink(targetLinkUrl); + + assertThat(course).isPresent(); + assertThat(course.get().getId()).isEqualTo(123L); + verify(courseRepository).findById(123L); + } + + @Test + void getCourseFromTargetLink_malformedUrl() { + String targetLinkUrl = "invalid-url"; + + Optional course = lti13Service.getCourseFromTargetLink(targetLinkUrl); + + assertThat(course).isEmpty(); + verifyNoInteractions(courseRepository); + } + + @Test + void getCourseFromTargetLink_missingCourseId() { + String targetLinkUrl = "https://some-artemis-domain.org/with/invalid/path"; + + Optional course = lti13Service.getCourseFromTargetLink(targetLinkUrl); + + assertThat(course).isEmpty(); + verifyNoInteractions(courseRepository); + } + + @Test + void getCourseFromTargetLink_noMatchingPath() { + String targetLinkUrl = "https://some-artemis-domain.org/lectures/567"; + + Optional course = lti13Service.getCourseFromTargetLink(targetLinkUrl); + + assertThat(course).isEmpty(); + verifyNoInteractions(courseRepository); + } + + @Test + void getCourseFromTargetLink_validCompetencyPath() { + String targetLinkUrl = "https://some-artemis-domain.org/courses/456/competencies"; + Course mockCourse = new Course(); + mockCourse.setId(456L); + + when(courseRepository.findById(456L)).thenReturn(Optional.of(mockCourse)); + + Optional course = lti13Service.getCourseFromTargetLink(targetLinkUrl); + + assertThat(course).isPresent(); + assertThat(course.get().getId()).isEqualTo(456L); + verify(courseRepository).findById(456L); + } + private State getValidStateForNewResult(Result result) { User user = new User(); user.setLogin("someone"); @@ -550,6 +605,14 @@ private MockExercise getMockExercise(boolean isOnlineCourse) { return new MockExercise(exerciseId, courseId); } + private Course getMockCourse(long courseId) { + Course course = new Course(); + course.setId(courseId); + course.setOnlineCourseConfiguration(new OnlineCourseConfiguration()); + + return course; + } + private record MockExercise(long exerciseId, long courseId) { } @@ -559,6 +622,10 @@ private void prepareForPerformLaunch(long courseId, long exerciseId) { Optional user = Optional.of(new User()); doReturn(user).when(userRepository).findOneWithGroupsAndAuthoritiesByLogin(any()); + + doReturn(Optional.of(getMockCourse(courseId))).when(courseRepository).findById(courseId); + doReturn(getMockCourse(courseId)).when(courseRepository).findWithEagerOnlineCourseConfigurationById(courseId); + doNothing().when(ltiService).authenticateLtiUser(any(), any(), any(), any(), anyBoolean()); doNothing().when(ltiService).onSuccessfulLtiAuthentication(any(), any()); } diff --git a/src/test/java/de/tum/cit/aet/artemis/lti/service/LtiDeepLinkingServiceTest.java b/src/test/java/de/tum/cit/aet/artemis/lti/service/LtiDeepLinkingServiceTest.java index 9c597bbc1cbd..0866d54a067e 100644 --- a/src/test/java/de/tum/cit/aet/artemis/lti/service/LtiDeepLinkingServiceTest.java +++ b/src/test/java/de/tum/cit/aet/artemis/lti/service/LtiDeepLinkingServiceTest.java @@ -34,8 +34,10 @@ import de.tum.cit.aet.artemis.core.domain.Course; import de.tum.cit.aet.artemis.core.exception.BadRequestAlertException; +import de.tum.cit.aet.artemis.core.repository.CourseRepository; import de.tum.cit.aet.artemis.exercise.domain.Exercise; import de.tum.cit.aet.artemis.exercise.repository.ExerciseTestRepository; +import de.tum.cit.aet.artemis.lecture.repository.LectureRepository; import de.tum.cit.aet.artemis.lti.config.Lti13TokenRetriever; import de.tum.cit.aet.artemis.lti.domain.OnlineCourseConfiguration; import de.tum.cit.aet.artemis.text.domain.TextExercise; @@ -43,9 +45,15 @@ class LtiDeepLinkingServiceTest { + @Mock + private CourseRepository courseRepository; + @Mock private ExerciseTestRepository exerciseRepository; + @Mock + LectureRepository lectureRepository; + @Mock private Lti13TokenRetriever tokenRetriever; @@ -60,7 +68,7 @@ void setUp() { closeable = MockitoAnnotations.openMocks(this); oidcIdToken = mock(OidcIdToken.class); SecurityContextHolder.clearContext(); - ltiDeepLinkingService = new LtiDeepLinkingService(exerciseRepository, tokenRetriever); + ltiDeepLinkingService = new LtiDeepLinkingService(courseRepository, exerciseRepository, lectureRepository, tokenRetriever); ReflectionTestUtils.setField(ltiDeepLinkingService, "artemisServerUrl", "http://artemis.com"); } @@ -77,7 +85,7 @@ void testPerformDeepLinking() throws MalformedURLException, URISyntaxException { when(tokenRetriever.createDeepLinkingJWT(anyString(), anyMap())).thenReturn("test_jwt"); DeepLinkCourseExercises result = createTestExercisesForDeepLinking(); - String deepLinkResponse = ltiDeepLinkingService.performDeepLinking(oidcIdToken, "test_registration_id", result.courseId(), result.exerciseSet()); + String deepLinkResponse = ltiDeepLinkingService.performDeepLinking(oidcIdToken, "test_registration_id", result.courseId(), result.exerciseSet(), DeepLinkingType.EXERCISE); assertThat(deepLinkResponse).isNotNull(); assertThat(deepLinkResponse).contains("test_jwt"); @@ -90,7 +98,7 @@ void testEmptyJwtBuildLtiDeepLinkResponse() throws MalformedURLException, URISyn DeepLinkCourseExercises result = createTestExercisesForDeepLinking(); assertThatExceptionOfType(BadRequestAlertException.class) - .isThrownBy(() -> ltiDeepLinkingService.performDeepLinking(oidcIdToken, "test_registration_id", result.courseId, result.exerciseSet)) + .isThrownBy(() -> ltiDeepLinkingService.performDeepLinking(oidcIdToken, "test_registration_id", result.courseId, result.exerciseSet, DeepLinkingType.EXERCISE)) .withMessage("Deep linking response cannot be created") .matches(exception -> "LTI".equals(exception.getEntityName()) && "deepLinkingResponseFailed".equals(exception.getErrorKey())); } @@ -129,7 +137,7 @@ void testEmptyReturnUrlBuildLtiDeepLinkResponse() throws JsonProcessingException DeepLinkCourseExercises result = createTestExercisesForDeepLinking(); assertThatExceptionOfType(BadRequestAlertException.class) - .isThrownBy(() -> ltiDeepLinkingService.performDeepLinking(oidcIdToken, "test_registration_id", result.courseId, result.exerciseSet)) + .isThrownBy(() -> ltiDeepLinkingService.performDeepLinking(oidcIdToken, "test_registration_id", result.courseId, result.exerciseSet, DeepLinkingType.EXERCISE)) .withMessage("Cannot find platform return URL") .matches(exception -> "LTI".equals(exception.getEntityName()) && "deepLinkReturnURLEmpty".equals(exception.getErrorKey())); } @@ -142,7 +150,7 @@ void testEmptyDeploymentIdBuildLtiDeepLinkResponse() throws MalformedURLExceptio DeepLinkCourseExercises result = createTestExercisesForDeepLinking(); assertThatExceptionOfType(IllegalArgumentException.class) - .isThrownBy(() -> ltiDeepLinkingService.performDeepLinking(oidcIdToken, "test_registration_id", result.courseId, result.exerciseSet)) + .isThrownBy(() -> ltiDeepLinkingService.performDeepLinking(oidcIdToken, "test_registration_id", result.courseId, result.exerciseSet, DeepLinkingType.EXERCISE)) .withMessage("Missing claim: " + Claims.LTI_DEPLOYMENT_ID); } diff --git a/src/test/javascript/spec/component/lti/lti13-deep-linking.component.spec.ts b/src/test/javascript/spec/component/lti/lti13-deep-linking.component.spec.ts index ba86523db1ac..e86aef4db06d 100644 --- a/src/test/javascript/spec/component/lti/lti13-deep-linking.component.spec.ts +++ b/src/test/javascript/spec/component/lti/lti13-deep-linking.component.spec.ts @@ -26,7 +26,7 @@ describe('Lti13DeepLinkingComponent', () => { const routerMock = { navigate: jest.fn() }; const httpMock = { post: jest.fn() }; - const courseManagementServiceMock = { findWithExercises: jest.fn() }; + const courseManagementServiceMock = { findWithExercisesAndLecturesAndCompetencies: jest.fn() }; const accountServiceMock = { identity: jest.fn(), getAuthenticationState: jest.fn() }; const sortServiceMock = { sortByProperty: jest.fn() }; const alertServiceMock = { error: jest.fn(), addAlert: jest.fn() }; @@ -77,13 +77,13 @@ describe('Lti13DeepLinkingComponent', () => { it('should retrieve course details and exercises on init when user is authenticated', fakeAsync(() => { const loggedInUserUser: User = { id: 3, login: 'lti_user', firstName: 'TestUser', lastName: 'Moodle' } as User; accountServiceMock.identity.mockReturnValue(Promise.resolve(loggedInUserUser)); - courseManagementServiceMock.findWithExercises.mockReturnValue(of(new HttpResponse({ body: course }))); + courseManagementServiceMock.findWithExercisesAndLecturesAndCompetencies.mockReturnValue(of(new HttpResponse({ body: course }))); component.ngOnInit(); tick(1000); expect(accountServiceMock.identity).toHaveBeenCalled(); - expect(courseManagementServiceMock.findWithExercises).toHaveBeenCalledWith(course.id); + expect(courseManagementServiceMock.findWithExercisesAndLecturesAndCompetencies).toHaveBeenCalledWith(course.id); expect(component.courseId).toBe(123); expect(component.course).toEqual(course); expect(component.exercises).toContainAllValues(course.exercises!); @@ -125,7 +125,7 @@ describe('Lti13DeepLinkingComponent', () => { expect(component.isLinking).toBeFalse(); expect(accountServiceMock.identity).not.toHaveBeenCalled(); - expect(courseManagementServiceMock.findWithExercises).not.toHaveBeenCalled(); + expect(courseManagementServiceMock.findWithExercisesAndLecturesAndCompetencies).not.toHaveBeenCalled(); expect(component.courseId).toBeNaN(); }));