Development: Attendance checker modern iPad endpoint
#11419
+529
−24
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,155 @@ | ||
| package de.tum.cit.aet.artemis.exam.dto.room; | ||
|
|
||
| import java.time.ZonedDateTime; | ||
| import java.util.List; | ||
| import java.util.Set; | ||
| import java.util.stream.Collectors; | ||
|
|
||
| import jakarta.annotation.Nullable; | ||
| import jakarta.validation.constraints.Email; | ||
| import jakarta.validation.constraints.NotBlank; | ||
| import jakarta.validation.constraints.NotEmpty; | ||
| import jakarta.validation.constraints.NotNull; | ||
| import jakarta.validation.constraints.Size; | ||
|
|
||
| import org.springframework.util.StringUtils; | ||
|
|
||
| import com.fasterxml.jackson.annotation.JsonInclude; | ||
|
|
||
| import de.tum.cit.aet.artemis.exam.domain.Exam; | ||
| import de.tum.cit.aet.artemis.exam.domain.ExamUser; | ||
| import de.tum.cit.aet.artemis.exam.domain.room.ExamRoom; | ||
|
|
||
| // @formatter:off | ||
| @JsonInclude(JsonInclude.Include.NON_EMPTY) | ||
| record ExamRoomForAttendanceCheckerDTO( | ||
| @NotNull long id, | ||
SamuelRoettgermann marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| @NotBlank String roomNumber, | ||
| @Nullable String alternativeRoomNumber, | ||
| @NotBlank String name, | ||
| @Nullable String alternativeName, | ||
| @NotBlank String building, | ||
| @NotNull List<ExamSeatDTO> seats | ||
|
Contributor
There was a problem hiding this comment. Could
Contributor
Author
There was a problem hiding this comment. As of right now it's TECHNICALLY still possible for a room to have zero seats, so I wouldn't want to exchange that just yet, but it's definitely something that can be adjusted in the future when the room parser rejects rooms without seats. |
||
| ) { | ||
| static ExamRoomForAttendanceCheckerDTO from(ExamRoom examRoom) { | ||
| return new ExamRoomForAttendanceCheckerDTO( | ||
| examRoom.getId(), | ||
| examRoom.getRoomNumber(), | ||
| examRoom.getAlternativeRoomNumber(), | ||
| examRoom.getName(), | ||
| examRoom.getAlternativeName(), | ||
| examRoom.getBuilding(), | ||
| examRoom.getSeats() | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| @JsonInclude(JsonInclude.Include.NON_EMPTY) | ||
| record ExamUserLocationDTO( | ||
| @Nullable Long roomId, // null if legacy version | ||
| @NotBlank String roomNumber, // examUser.plannedRoom if legacy version | ||
| @NotBlank String seatName // examUser.plannedSeat if legacy version | ||
| ) { | ||
| static ExamUserLocationDTO plannedFrom(ExamUser examUser) { | ||
| final boolean isLegacy = examUser.getPlannedRoomTransient() == null || examUser.getPlannedSeatTransient() == null; | ||
|
|
||
| return new ExamUserLocationDTO( | ||
| isLegacy ? null : examUser.getPlannedRoomTransient().getId(), | ||
| isLegacy ? examUser.getPlannedRoom() : examUser.getPlannedRoomTransient().getRoomNumber(), | ||
| isLegacy ? examUser.getPlannedSeat() : examUser.getPlannedSeatTransient().name() | ||
| ); | ||
| } | ||
SamuelRoettgermann marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| static ExamUserLocationDTO actualFrom(ExamUser examUser) { | ||
| if (examUser.getActualRoom() == null || examUser.getActualSeat() == null) { | ||
| // examUser has not been moved | ||
| return null; | ||
| } | ||
|
|
||
| final boolean useLegacyFields = examUser.getActualRoomTransient() == null || examUser.getActualSeatTransient() == null; | ||
|
|
||
| return new ExamUserLocationDTO( | ||
| useLegacyFields ? null : examUser.getActualRoomTransient().getId(), | ||
| useLegacyFields ? examUser.getActualRoom() : examUser.getActualRoomTransient().getRoomNumber(), | ||
| useLegacyFields ? examUser.getActualSeat() : examUser.getActualSeatTransient().name() | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| @JsonInclude(JsonInclude.Include.NON_EMPTY) | ||
| record ExamUserWithExamRoomAndSeatDTO ( | ||
| @NotBlank @Size(max = 50) String login, | ||
| // Names are nullable because not everyone has a first and/or last name | ||
| @Nullable @Size(max = 50) String firstName, | ||
| @Nullable @Size(max = 50) String lastName, | ||
| @NotBlank @Size(max = 10) String registrationNumber, | ||
| @Nullable @Email @Size(max = 100) String email, | ||
| @Nullable String imageUrl, | ||
| @NotNull boolean didCheckImage, | ||
| @NotNull boolean didCheckName, | ||
| @NotNull boolean didCheckRegistrationNumber, | ||
| @NotNull boolean didCheckLogin, | ||
SamuelRoettgermann marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| @Nullable String signingImagePath, | ||
| @NotNull ExamUserLocationDTO plannedLocation, | ||
| @Nullable ExamUserLocationDTO actualLocation | ||
| ) { | ||
| static ExamUserWithExamRoomAndSeatDTO from(ExamUser examUser) { | ||
| return new ExamUserWithExamRoomAndSeatDTO( | ||
| examUser.getUser().getLogin(), | ||
| examUser.getUser().getFirstName(), | ||
| examUser.getUser().getLastName(), | ||
| examUser.getUser().getRegistrationNumber(), | ||
| examUser.getUser().getEmail(), | ||
| examUser.getUser().getImageUrl(), | ||
|
Member
There was a problem hiding this comment. Just as a note so we don't forget, we will need to add the actual exam user image here as this would show the profile picture the user has set
Contributor
Author
There was a problem hiding this comment. very simple fix, just exchanged the
Member
There was a problem hiding this comment. Adding it as a TODO here, so we don't forget: When we have tested everything and it all works, we need to replace this with the image from TUMonline instead of the profile picture, otherwise students can "fake" their image |
||
| examUser.getDidCheckImage(), | ||
| examUser.getDidCheckName(), | ||
| examUser.getDidCheckRegistrationNumber(), | ||
| examUser.getDidCheckLogin(), | ||
| examUser.getSigningImagePath(), | ||
| ExamUserLocationDTO.plannedFrom(examUser), | ||
| ExamUserLocationDTO.actualFrom(examUser) | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * DTO containing all relevant information for the attendance checker app | ||
| */ | ||
| @JsonInclude(JsonInclude.Include.NON_EMPTY) | ||
| public record AttendanceCheckerAppExamInformationDTO( | ||
| @NotNull long examId, | ||
SamuelRoettgermann marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| @NotBlank String examTitle, | ||
| @NotNull ZonedDateTime startDate, | ||
| @NotNull ZonedDateTime endDate, | ||
| @NotNull boolean isTestExam, | ||
| @NotNull long courseId, | ||
SamuelRoettgermann marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| @NotBlank String courseTitle, | ||
| @NotNull Set<ExamRoomForAttendanceCheckerDTO> examRoomsUsedInExam, // empty if legacy version | ||
| @NotEmpty Set<ExamUserWithExamRoomAndSeatDTO> examUsersWithExamRoomAndSeat | ||
| ) { | ||
| /** | ||
| * Create an AttendanceCheckerAppExamInformationDTO from the given exam and its rooms | ||
| * | ||
| * @param exam the exam | ||
| * @param examRooms the rooms used in the exam | ||
| * @return information for the attendance checker app | ||
| */ | ||
| public static AttendanceCheckerAppExamInformationDTO from(Exam exam, Set<ExamRoom> examRooms) { | ||
| Set<ExamUser> examUsersWhoHaveBeenDistributed = exam.getExamUsers().stream() | ||
| .filter(examUser -> StringUtils.hasText(examUser.getPlannedRoom()) && StringUtils.hasText(examUser.getPlannedSeat())) | ||
| .collect(Collectors.toSet()); | ||
|
Contributor
There was a problem hiding this comment. We can just use
Contributor
Author
There was a problem hiding this comment. Not sure if you're using a different Java than me, but that should not be possible: https://bugs.openjdk.org/browse/JDK-8306888 |
||
|
|
||
| return new AttendanceCheckerAppExamInformationDTO( | ||
| exam.getId(), | ||
| exam.getTitle(), | ||
| exam.getStartDate(), | ||
| exam.getEndDate(), | ||
| exam.isTestExam(), | ||
| exam.getCourse().getId(), | ||
| exam.getCourse().getTitle(), | ||
| examRooms.stream().map(ExamRoomForAttendanceCheckerDTO::from).collect(Collectors.toSet()), | ||
| examUsersWhoHaveBeenDistributed.stream().map(ExamUserWithExamRoomAndSeatDTO::from).collect(Collectors.toSet()) | ||
|
Comment on lines
+151
to
+152
Contributor
There was a problem hiding this comment. here we can also just use
Contributor
Author
There was a problem hiding this comment. Same answer as above: https://bugs.openjdk.org/browse/JDK-8306888 |
||
| ); | ||
| } | ||
| } | ||
| // @formatter:on | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.