Integrated code lifecycle: Add access log for repositories

src/main/java/de/tum/in/www1/artemis/domain/VcsAccessLog.java

@@ -0,0 +1,54 @@
+package de.tum.in.www1.artemis.domain;
+
+import java.time.ZonedDateTime;
+
+import jakarta.persistence.Column;
+import jakarta.persistence.Entity;
+import jakarta.persistence.ManyToOne;
+import jakarta.persistence.Table;
+
+import org.hibernate.annotations.Cache;
+import org.hibernate.annotations.CacheConcurrencyStrategy;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+
+import de.tum.in.www1.artemis.domain.participation.Participation;
+
+/**
+ * A Result.
+ */
+@Entity
+@Table(name = "vcs_access_log")
+@Cache(usage = CacheConcurrencyStrategy.NONSTRICT_READ_WRITE)
+@JsonInclude(JsonInclude.Include.NON_EMPTY)
+public class VcsAccessLog extends DomainObject {
+
+    @ManyToOne
+    private User student;
+
+    @ManyToOne
+    private Participation participation;
+
+    @Column(name = "operation")
+    private String operation;
+
+    @Column(name = "mechanism")
+    private String mechanism;
+
+    @Column(name = "ipAddress")
+    private String ipAddress;
+
+    @Column(name = "timestamp")
+    private ZonedDateTime timestamp;
+
+    public VcsAccessLog(User user, Participation participation, String operation, String mechanism, String ipAddress) {
+        this.student = user;
+        this.participation = (Participation) participation;
+        this.operation = operation;
+        this.mechanism = mechanism;
+        this.ipAddress = ipAddress;
+    }
+
+    public VcsAccessLog() {
+    }
+}

src/main/java/de/tum/in/www1/artemis/repository/VcsAccessLogRepository.java

@@ -0,0 +1,23 @@
+package de.tum.in.www1.artemis.repository;
+
+import static de.tum.in.www1.artemis.config.Constants.PROFILE_CORE;
+
+import org.springframework.context.annotation.Profile;
+import org.springframework.stereotype.Repository;
+
+import de.tum.in.www1.artemis.domain.VcsAccessLog;
+import de.tum.in.www1.artemis.repository.base.ArtemisJpaRepository;
+
+/**
+ * Spring Data JPA repository for the User entity.<br>
+ * <br>
+ * <p>
+ * <b>Note</b>: Please keep in mind that the User entities are soft-deleted when adding new queries to this repository.
+ * If you don't need deleted user entities, add `WHERE user.isDeleted = FALSE` to your query.
+ * </p>
+ */
+@Profile(PROFILE_CORE)
+@Repository
+public interface VcsAccessLogRepository extends ArtemisJpaRepository<VcsAccessLog, Long> {
+
+}

src/main/java/de/tum/in/www1/artemis/service/VcsAccessLogService.java

@@ -0,0 +1,36 @@
+package de.tum.in.www1.artemis.service;
+
+import static de.tum.in.www1.artemis.config.Constants.PROFILE_LOCALVC;
+
+import jakarta.servlet.http.HttpServletRequest;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.context.annotation.Profile;
+import org.springframework.stereotype.Service;
+
+import de.tum.in.www1.artemis.domain.User;
+import de.tum.in.www1.artemis.domain.VcsAccessLog;
+import de.tum.in.www1.artemis.domain.participation.Participation;
+import de.tum.in.www1.artemis.domain.participation.ProgrammingExerciseParticipation;
+import de.tum.in.www1.artemis.repository.VcsAccessLogRepository;
+
+@Profile(PROFILE_LOCALVC)
+@Service
+public class VcsAccessLogService {
+
+    private static final Logger log = LoggerFactory.getLogger(VcsAccessLogService.class);
+
+    private final VcsAccessLogRepository vcsAccessLogRepository;
+
+    VcsAccessLogService(VcsAccessLogRepository vcsAccessLogRepository) {
+        this.vcsAccessLogRepository = vcsAccessLogRepository;
+    }
+
+    public void storeOperation(User user, ProgrammingExerciseParticipation participation, String requestURI, String authenticationMechanism, HttpServletRequest request) {
+        log.debug("Storing access operation for user {}", user);
+
+        VcsAccessLog accessLogEntry = new VcsAccessLog(user, (Participation) participation, "op", "mec", "ip");
+        vcsAccessLogRepository.save(accessLogEntry);
+    }
+}

src/main/java/de/tum/in/www1/artemis/service/connectors/localvc/LocalVCServletService.java

@@ -48,6 +48,7 @@
 import de.tum.in.www1.artemis.repository.UserRepository;
 import de.tum.in.www1.artemis.security.SecurityUtils;
 import de.tum.in.www1.artemis.service.AuthorizationCheckService;
+import de.tum.in.www1.artemis.service.VcsAccessLogService;
 import de.tum.in.www1.artemis.service.connectors.ci.ContinuousIntegrationTriggerService;
 import de.tum.in.www1.artemis.service.programming.AuxiliaryRepositoryService;
 import de.tum.in.www1.artemis.service.programming.ProgrammingExerciseParticipationService;
@@ -93,6 +94,8 @@ public class LocalVCServletService {
 
     private final ProgrammingTriggerService programmingTriggerService;
 
+    private final VcsAccessLogService vcsAccessLogService;
+
     private static URL localVCBaseUrl;
 
     @Value("${artemis.version-control.url}")
@@ -122,7 +125,7 @@ public LocalVCServletService(AuthenticationManager authenticationManager, UserRe
             RepositoryAccessService repositoryAccessService, AuthorizationCheckService authorizationCheckService,
             ProgrammingExerciseParticipationService programmingExerciseParticipationService, AuxiliaryRepositoryService auxiliaryRepositoryService,
             ContinuousIntegrationTriggerService ciTriggerService, ProgrammingSubmissionService programmingSubmissionService,
-            ProgrammingMessagingService programmingMessagingService, ProgrammingTriggerService programmingTriggerService) {
+            ProgrammingMessagingService programmingMessagingService, ProgrammingTriggerService programmingTriggerService, VcsAccessLogService vcsAccessLogService) {
         this.authenticationManager = authenticationManager;
         this.userRepository = userRepository;
         this.programmingExerciseRepository = programmingExerciseRepository;
@@ -134,6 +137,7 @@ public LocalVCServletService(AuthenticationManager authenticationManager, UserRe
         this.programmingSubmissionService = programmingSubmissionService;
         this.programmingMessagingService = programmingMessagingService;
         this.programmingTriggerService = programmingTriggerService;
+        this.vcsAccessLogService = vcsAccessLogService;
     }
 
     /**
@@ -204,7 +208,7 @@ public void authenticateAndAuthorizeGitRequest(HttpServletRequest request, Repos
                 return;
             }
         }
-
+        String authenticationMechanism = ""; // todo get actual authentication mechanism here: Password / Participation Token / User token
         User user = authenticateUser(authorizationHeader);
 
         // Optimization.
@@ -232,6 +236,10 @@ public void authenticateAndAuthorizeGitRequest(HttpServletRequest request, Repos
 
         request.setAttribute("user", user);
 
+        // Storing the access to the repository in the VCS access log
+        ProgrammingExerciseParticipation participation = null; // Todo get actual participation
+        vcsAccessLogService.storeOperation(user, participation, request.getRequestURI(), authenticationMechanism, request);
+
         log.debug("Authorizing user {} for repository {} took {}", user.getLogin(), localVCRepositoryUri, TimeLogUtil.formatDurationFrom(timeNanoStart));
     }
 

src/main/resources/config/liquibase/changelog/20240804144500_changelog.xml

@@ -0,0 +1,47 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<databaseChangeLog xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
+                   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+                   xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog https://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-latest.xsd">
+    <changeSet id="20240804144500" author="entholzer">
+        <!--
+            Change Set for creating a new table for storing the JOL values of the competencies
+        -->
+        <createTable tableName="vcs_access_log">
+            <column autoIncrement="true" name="id" type="bigint">
+                <constraints nullable="false" primaryKey="true" primaryKeyName="vcs_access_logPK"/>
+            </column>
+            <column name="user_id" type="bigint">
+                <constraints nullable="false"/>
+            </column>
+            <column name="participation_id" type="bigint">
+                <constraints nullable="false"/>
+            </column>
+            <column name="operation" type="varchar(5)">
+                <constraints nullable="false"/>
+            </column>
+            <column name="mechanism" type="varchar(3)">
+                <constraints nullable="false"/>
+            </column>
+            <column name="ip_address" type="varchar(45)">
+                <constraints nullable="true"/>
+            </column>
+            <column defaultValueComputed="CURRENT_TIMESTAMP" name="timestamp" type="timestamp">
+                <constraints nullable="false"/>
+            </column>
+        </createTable>
+        <addForeignKeyConstraint baseColumnNames="user_id"
+                                 baseTableName="vcs_access_log"
+                                 constraintName="FK_vcs_access_log_user"
+                                 referencedColumnNames="id"
+                                 referencedTableName="jhi_user"/>
+        <addForeignKeyConstraint baseColumnNames="participation_id"
+                                 baseTableName="vcs_access_log"
+                                 constraintName="FK_vcs_access_log_participation"
+                                 referencedColumnNames="id"
+                                 referencedTableName="participation"/>
+        <createIndex indexName="idx_vcs_access_log_user_participation" tableName="vcs_access_log">
+            <column name="user_id"/>
+            <column name="participation_id"/>
+        </createIndex>
+    </changeSet>
+</databaseChangeLog>

src/main/resources/config/liquibase/master.xml

@@ -19,6 +19,8 @@
     <include file="classpath:config/liquibase/changelog/20240614140000_changelog.xml" relativeToChangelogFile="false"/>
     <include file="classpath:config/liquibase/changelog/20240620150000_changelog.xml" relativeToChangelogFile="false"/>
     <include file="classpath:config/liquibase/changelog/20240708144500_changelog.xml" relativeToChangelogFile="false"/>
+    <include file="classpath:config/liquibase/changelog/20240804144500_changelog.xml" relativeToChangelogFile="false"/>
+
     <!-- NOTE: please use the format "YYYYMMDDhhmmss_changelog.xml", i.e. year month day hour minutes seconds and not something else! -->
     <!-- we should also stay in a chronological order! -->
     <!-- you can use the command 'date '+%Y%m%d%H%M%S'' to get the current date and time in the correct format -->