Integrated code lifecycle: Let users generate personal access tokens

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

@@ -765,6 +765,17 @@ default Page<User> findAllWithGroupsByIsDeletedIsFalse(Pageable pageable) {
             """)
     void updateUserSshPublicKeyHash(@Param("userId") long userId, @Param("sshPublicKeyHash") String sshPublicKeyHash, @Param("sshPublicKey") String sshPublicKey);
 
+    @Modifying
+    @Transactional // ok because of modifying query
+    @Query("""
+            UPDATE User user
+            SET user.vcsAccessToken = :vcsAccessToken,
+                user.vcsAccessTokenExpiryDate = :vcsAccessTokenExpiryDate
+            WHERE user.id = :userId
+            """)
+    void updateUserVcsAccessToken(@Param("userId") long userId, @Param("vcsAccessToken") String vcsAccessToken,
+            @Param("vcsAccessTokenExpiryDate") ZonedDateTime vcsAccessTokenExpiryDate);
+
     @Modifying
     @Transactional // ok because of modifying query
     @Query("""

src/main/java/de/tum/in/www1/artemis/service/dto/UserDTO.java

@@ -74,6 +74,8 @@ public class UserDTO extends AuditingEntityDTO {
 
     private String vcsAccessToken;
 
+    private ZonedDateTime vcsAccessTokenExpiryDate;
+
     private String sshPublicKey;
 
     private ZonedDateTime irisAccepted;
@@ -250,6 +252,14 @@ public void setVcsAccessToken(String vcsAccessToken) {
         this.vcsAccessToken = vcsAccessToken;
     }
 
+    public void setVcsAccessTokenExpiryDate(ZonedDateTime zoneDateTime) {
+        this.vcsAccessTokenExpiryDate = zoneDateTime;
+    }
+
+    public ZonedDateTime getVcsAccessTokenExpiryDate() {
+        return vcsAccessTokenExpiryDate;
+    }
+
     public String getSshPublicKey() {
         return sshPublicKey;
     }

src/main/java/de/tum/in/www1/artemis/web/rest/UserResource.java

@@ -225,4 +225,41 @@ public ResponseEntity<Void> deleteSshPublicKey() {
         log.debug("Successfully deleted SSH key of user {}", user.getLogin());
         return ResponseEntity.ok().build();
     }
+
+    /**
+     * PUT users/vcsAccessToken : creates a vcsAccessToken for a user
+     *
+     * @return the ResponseEntity with a userDTO containing the token: with status 200 (OK), with status 404 (Not Found), or with status 400 (Bad Request)
+     */
+    @PutMapping("users/vcsAccessToken")
+    @EnforceAtLeastStudent
+    public ResponseEntity<UserDTO> createVcsAccessToken() {
+        User user = userRepository.getUser();
+        log.debug("REST request to create a new VCS access token for user {}", user.getLogin());
+
+        // TODO add token generation here -> depends on https://github.com/ls1intum/Artemis/pull/8929
+        userRepository.updateUserVcsAccessToken(user.getId(), "vcpat-nsevT9FJUOK4uTbLFqC6DZMtWv9OZzVAU2Wbtzbt4WYO", ZonedDateTime.now().plusMonths(3));
+        log.debug("Successfully created a VCS access token for user {}", user.getLogin());
+        user = userRepository.getUser();
+        UserDTO userDTO = new UserDTO();
+        userDTO.setLogin(user.getLogin());
+        userDTO.setVcsAccessToken(user.getVcsAccessToken() + "abcde");
+        userDTO.setVcsAccessTokenExpiryDate(user.getVcsAccessTokenExpiryDate());
+        return ResponseEntity.ok(userDTO);
+    }
+
+    /**
+     * DELETE users/vcsAccessToken : deletes the vcsAccessToken of a user
+     *
+     * @return the ResponseEntity with status 200 (OK), with status 404 (Not Found), or with status 400 (Bad Request)
+     */
+    @DeleteMapping("users/vcsAccessToken")
+    @EnforceAtLeastStudent
+    public ResponseEntity<Void> deleteVcsAccessToken() {
+        User user = userRepository.getUser();
+        log.debug("REST request to remove VCS access token key of user {}", user.getLogin());
+        userRepository.updateUserVcsAccessToken(user.getId(), null, null);
+        log.debug("Successfully deleted VCS access token of user {}", user.getLogin());
+        return ResponseEntity.ok().build();
+    }
 }

src/main/java/de/tum/in/www1/artemis/web/rest/open/PublicAccountResource.java

@@ -165,6 +165,7 @@ public ResponseEntity<UserDTO> getAccount() {
         UserDTO userDTO = new UserDTO(user);
         // we set this value on purpose here: the user can only fetch their own information, make the token available for constructing the token-based clone-URL
         userDTO.setVcsAccessToken(user.getVcsAccessToken());
+        userDTO.setVcsAccessTokenExpiryDate(user.getVcsAccessTokenExpiryDate());
         userDTO.setSshPublicKey(user.getSshPublicKey());
         log.info("GET /account {} took {}ms", user.getLogin(), System.currentTimeMillis() - start);
         return ResponseEntity.ok(userDTO);

src/main/webapp/app/core/auth/account.service.ts

@@ -13,6 +13,7 @@ import { Exercise, getCourseFromExercise } from 'app/entities/exercise.model';
 import { Authority } from 'app/shared/constants/authority.constants';
 import { TranslateService } from '@ngx-translate/core';
 import { ProfileService } from 'app/shared/layouts/profiles/profile.service';
+import { EntityResponseType } from 'app/complaints/complaint.service';
 
 export interface IAccountService {
     save: (account: any) => Observable<HttpResponse<any>>;
@@ -348,4 +349,18 @@ export class AccountService implements IAccountService {
         }
         return this.http.delete<void>('api/users/sshpublickey');
     }
+
+    /**
+     * Sends a request to the server to delete the user's current vcsAccessToken
+     */
+    deleteUserVcsAccessToken(): Observable<void> {
+        return this.http.delete<void>('api/users/vcsAccessToken');
+    }
+
+    /**
+     * Sends a request to the server to delete the user's current vcsAccessToken
+     */
+    addNewVcsAccessToken(): Observable<EntityResponseType> {
+        return this.http.put<User>('api/users/vcsAccessToken', null, { observe: 'response' });
+    }
 }

src/main/webapp/app/core/user/user.model.ts

@@ -14,6 +14,7 @@ export class User extends Account {
     public visibleRegistrationNumber?: string;
     public password?: string;
     public vcsAccessToken?: string;
+    public vcsAccessTokenExpiryDate?: string;
     public sshPublicKey?: string;
     public irisAccepted?: dayjs.Dayjs;
 
@@ -35,6 +36,7 @@ export class User extends Account {
         password?: string,
         imageUrl?: string,
         vcsAccessToken?: string,
+        vcsAccessTokenExpiryDate?: string,
         sshPublicKey?: string,
         irisAccepted?: dayjs.Dayjs,
     ) {
@@ -48,6 +50,7 @@ export class User extends Account {
         this.lastNotificationRead = lastNotificationRead;
         this.password = password;
         this.vcsAccessToken = vcsAccessToken;
+        this.vcsAccessTokenExpiryDate = vcsAccessTokenExpiryDate;
         this.sshPublicKey = sshPublicKey;
         this.irisAccepted = irisAccepted;
     }

src/main/webapp/app/shared/user-settings/user-settings-container/user-settings-container.component.html

@@ -33,9 +33,16 @@
                     {{ 'artemisApp.userSettings.scienceSettings' | artemisTranslate }}
                 </a>
                 @if (localVCEnabled) {
-                    <a class="list-group-item btn btn-outline-primary" routerLink="sshSettings" routerLinkActive="active">
-                        <!--Account Information-->
-                        {{ 'artemisApp.userSettings.sshSettings' | artemisTranslate }}
+                    <a class="list-group-item btn btn-outline-primary" routerLink="sshSettings" routerLinkActive="active" jhiTranslate="artemisApp.userSettings.sshSettings">
+                        <!--SSH Settings-->
+                    </a>
+                    <a
+                        class="list-group-item btn btn-outline-primary"
+                        routerLink="vcsAccessTokensSettings"
+                        routerLinkActive="active"
+                        jhiTranslate="artemisApp.userSettings.vcsAccessTokenSettings"
+                    >
+                        <!--VCS Access Token Settings-->
                     </a>
                 }
             </section>

src/main/webapp/app/shared/user-settings/user-settings.module.ts

@@ -8,9 +8,18 @@ import { userSettingsState } from 'app/shared/user-settings/user-settings.route'
 import { ScienceSettingsComponent } from 'app/shared/user-settings/science-settings/science-settings.component';
 import { SshUserSettingsComponent } from 'app/shared/user-settings/ssh-settings/ssh-user-settings.component';
 import { ArtemisSharedComponentModule } from 'app/shared/components/shared-component.module';
+import { VcsAccessTokensSettingsComponent } from 'app/shared/user-settings/vcs-access-tokens-settings/vcs-access-tokens-settings.component';
+import { ClipboardModule } from '@angular/cdk/clipboard';
 
 @NgModule({
-    imports: [RouterModule.forChild(userSettingsState), ArtemisSharedModule, ArtemisSharedComponentModule],
-    declarations: [UserSettingsContainerComponent, AccountInformationComponent, NotificationSettingsComponent, ScienceSettingsComponent, SshUserSettingsComponent],
+    imports: [RouterModule.forChild(userSettingsState), ArtemisSharedModule, ArtemisSharedComponentModule, ClipboardModule],
+    declarations: [
+        UserSettingsContainerComponent,
+        AccountInformationComponent,
+        NotificationSettingsComponent,
+        ScienceSettingsComponent,
+        SshUserSettingsComponent,
+        VcsAccessTokensSettingsComponent,
+    ],
 })
 export class UserSettingsModule {}

src/main/webapp/app/shared/user-settings/user-settings.route.ts

@@ -6,6 +6,7 @@ import { UserRouteAccessService } from 'app/core/auth/user-route-access-service'
 import { Authority } from 'app/shared/constants/authority.constants';
 import { ScienceSettingsComponent } from 'app/shared/user-settings/science-settings/science-settings.component';
 import { SshUserSettingsComponent } from 'app/shared/user-settings/ssh-settings/ssh-user-settings.component';
+import { VcsAccessTokensSettingsComponent } from 'app/shared/user-settings/vcs-access-tokens-settings/vcs-access-tokens-settings.component';
 
 export const userSettingsState: Routes = [
     {
@@ -50,6 +51,13 @@ export const userSettingsState: Routes = [
                     pageTitle: 'artemisApp.userSettings.categories.SSH_SETTINGS',
                 },
             },
+            {
+                path: 'vcsAccessTokensSettings',
+                component: VcsAccessTokensSettingsComponent,
+                data: {
+                    pageTitle: 'artemisApp.userSettings.categories.VCS_ACCESS_TOKENS_SETTINGS',
+                },
+            },
         ],
     },
 ];

src/main/webapp/app/shared/user-settings/vcs-access-tokens-settings/vcs-access-tokens-settings.component.ts

@@ -0,0 +1,102 @@
+import { Component, OnDestroy, OnInit } from '@angular/core';
+import { User } from 'app/core/user/user.model';
+import { AccountService } from 'app/core/auth/account.service';
+import { Subject, Subscription, tap } from 'rxjs';
+import { ProfileService } from 'app/shared/layouts/profiles/profile.service';
+import { PROFILE_LOCALVC } from 'app/app.constants';
+import { faCopy, faEdit, faSave, faTrash } from '@fortawesome/free-solid-svg-icons';
+import { ButtonSize, ButtonType } from 'app/shared/components/button.component';
+import { AlertService } from 'app/core/util/alert.service';
+
+@Component({
+    selector: 'jhi-account-information',
+    templateUrl: './vcs-access-tokens-settings.html',
+    styleUrls: ['../user-settings.scss'],
+})
+export class VcsAccessTokensSettingsComponent implements OnInit, OnDestroy {
+    currentUser?: User;
+    localVCEnabled = false;
+
+    readonly faEdit = faEdit;
+    readonly faSave = faSave;
+    readonly faTrash = faTrash;
+    readonly faCopy = faCopy;
+    private authStateSubscription: Subscription;
+    wasCopied = false;
+
+    private dialogErrorSource = new Subject<string>();
+
+    dialogError$ = this.dialogErrorSource.asObservable();
+
+    protected readonly ButtonType = ButtonType;
+    protected readonly ButtonSize = ButtonSize;
+
+    constructor(
+        private accountService: AccountService,
+        private profileService: ProfileService,
+        private alertService: AlertService,
+    ) {}
+
+    ngOnInit() {
+        this.profileService.getProfileInfo().subscribe((profileInfo) => {
+            this.localVCEnabled = profileInfo.activeProfiles.includes(PROFILE_LOCALVC);
+        });
+
+        this.authStateSubscription = this.accountService
+            .getAuthenticationState()
+            .pipe(
+                tap((user: User) => {
+                    this.currentUser = user;
+                    return this.currentUser;
+                }),
+            )
+            .subscribe();
+    }
+
+    ngOnDestroy(): void {
+        this.authStateSubscription.unsubscribe();
+    }
+
+    deleteVcsAccessToken() {
+        this.accountService.deleteUserVcsAccessToken().subscribe({
+            next: () => {
+                if (this.currentUser) {
+                    this.currentUser.vcsAccessTokenExpiryDate = undefined;
+                    this.currentUser.vcsAccessToken = undefined;
+                }
+                this.alertService.success('artemisApp.userSettings.vcsAccessTokensSettingsPage.deleteSuccess');
+            },
+            error: () => {
+                this.alertService.error('artemisApp.userSettings.vcsAccessTokensSettingsPage.deleteFailure');
+            },
+        });
+        this.dialogErrorSource.next('');
+    }
+
+    addNewVcsAccessToken() {
+        this.accountService.addNewVcsAccessToken().subscribe({
+            next: (res) => {
+                if (this.currentUser) {
+                    const user = res.body as User;
+                    this.currentUser.vcsAccessToken = user.vcsAccessToken;
+                    this.currentUser.vcsAccessTokenExpiryDate = user.vcsAccessTokenExpiryDate;
+                }
+                this.alertService.success('artemisApp.userSettings.vcsAccessTokensSettingsPage.addSuccess');
+            },
+            error: () => {
+                this.alertService.error('artemisApp.userSettings.vcsAccessTokensSettingsPage.addFailure');
+            },
+        });
+    }
+    /**
+     * set wasCopied for 3 seconds on success
+     */
+    onCopyFinished(successful: boolean) {
+        if (successful) {
+            this.wasCopied = true;
+            setTimeout(() => {
+                this.wasCopied = false;
+            }, 3000);
+        }
+    }
+}

src/main/webapp/app/shared/user-settings/vcs-access-tokens-settings/vcs-access-tokens-settings.html

@@ -0,0 +1,83 @@
+<h1 jhiTranslate="artemisApp.userSettings.vcsAccessTokenSettings">
+    <!--VCS access token Settings-->
+</h1>
+@if (currentUser) {
+<div class="list-group d-block">
+    <div class="list-group-item">
+        <dt>
+            <span jhiTranslate="artemisApp.userSettings.vcsAccessTokensSettingsPage.infoText"></span>
+        </dt>
+    </div>
+    <div class="list-group-item">
+        <dt>
+            @if (this.currentUser?.vcsAccessToken) {
+            <table class="table table-striped flex">
+                <thead class="thead-dark">
+                    <tr>
+                        <th class="col-2">
+                            <span jhiTranslate="artemisApp.userSettings.vcsAccessTokensSettingsPage.vcsAccessToken"></span>
+                        </th>
+                        <th class="col-1"></th>
+                        <th class="col-4">
+                            <span jhiTranslate="artemisApp.userSettings.vcsAccessTokensSettingsPage.expiryDate"></span>
+                        </th>
+                        <th class="col-4">
+                            <span jhiTranslate="artemisApp.userSettings.vcsAccessTokensSettingsPage.actions"></span>
+                        </th>
+                    </tr>
+                </thead>
+
+                <tbody>
+                    <tr>
+                        <td>***************</td>
+                        <td>
+                            <button
+                                [cdkCopyToClipboard]="currentUser!.vcsAccessToken || ''"
+                                (cdkCopyToClipboardCopied)="onCopyFinished($event)"
+                                [class.btn-success]="wasCopied"
+                                class="btn btn-secondary btn-sm me-2"
+                                type="button"
+                            >
+                                <fa-icon [icon]="faCopy"></fa-icon>
+                            </button>
+                        </td>
+                        <td>{{ this.currentUser?.vcsAccessTokenExpiryDate | artemisDate }}</td>
+                        <td>
+                            <button
+                                class="btn btn-md flex-grow-1 d-flex align-items-center"
+                                jhiDeleteButton
+                                [renderButtonText]="false"
+                                (delete)="deleteVcsAccessToken()"
+                                deleteQuestion="artemisApp.userSettings.vcsAccessTokensSettingsPage.deleteVcsAccessTokenQuestion"
+                                [dialogError]="dialogError$"
+                            >
+                                <fa-icon [icon]="faTrash" />
+                                <div jhiTranslate="artemisApp.userSettings.vcsAccessTokensSettingsPage.deleteVcsAccessToken" class="ms-2"></div>
+                            </button>
+                        </td>
+                    </tr>
+                </tbody>
+            </table>
+            } @else {
+            <div jhiTranslate="artemisApp.userSettings.vcsAccessTokensSettingsPage.noTokenSet"></div>
+            }
+        </dt>
+    </div>
+    @if (!this.currentUser?.vcsAccessToken) {
+    <div class="list-group-item">
+        <dt>
+            <div class="btn-group" role="group" aria-label="Actions">
+                <jhi-button
+                    class="d-flex"
+                    [btnType]="ButtonType.PRIMARY"
+                    [btnSize]="ButtonSize.SMALL"
+                    [icon]="faEdit"
+                    [title]="'artemisApp.userSettings.vcsAccessTokensSettingsPage.addToken'"
+                    (onClick)="addNewVcsAccessToken()"
+                />
+            </div>
+        </dt>
+    </div>
+    }
+</div>
+}