Request-a-copy: Use wrapped ItemWithSupp.. and base item comps, except download link

Author: kshepherd

src/app/core/auth/access-token.resolver.ts

@@ -17,6 +17,15 @@ import {
 } from '../shared/operators';
 import { AuthService } from './auth.service';
 
+/**
+ * Resolve an ItemRequest based on the accessToken in the query params
+ * Used in item-page-routes.ts to resolve the item request for all Item page components
+ * @param route
+ * @param state
+ * @param router
+ * @param authService
+ * @param itemRequestDataService
+ */
 export const accessTokenResolver: ResolveFn<ItemRequest> = (
   route,
   state,
@@ -25,21 +34,23 @@ export const accessTokenResolver: ResolveFn<ItemRequest> = (
   itemRequestDataService: ItemRequestDataService = inject(ItemRequestDataService),
 ): Observable<ItemRequest> => {
   const accessToken = route.queryParams.accessToken;
+  // Set null object if accesstoken is empty
   if ( !hasValue(accessToken) ) {
     return null;
   }
-  // Get
+  // Get the item request from the server
   return itemRequestDataService.getSanitizedRequestByAccessToken(accessToken).pipe(
     getFirstCompletedRemoteData(),
+    // Handle authorization errors, not found errors and forbidden errors as normal
     redirectOn4xx(router, authService),
+    // Get payload of the item request
     getFirstSucceededRemoteDataPayload(),
     tap(request => {
       if (!hasValue(request)) {
-        console.dir('no request found for access token', accessToken);
+        // If the request is not found, redirect to 403 Forbidden
         router.navigateByUrl(getForbiddenRoute());
       }
-      console.dir('found request: ', request);
-      console.dir(request);
+      // Return the resolved item request object
       return request;
     }),
   );

src/app/core/shared/item-with-supplementary-data.model.ts

@@ -0,0 +1,20 @@
+import { Item } from './item.model';
+import { ItemRequest } from './item-request.model';
+
+/**
+ * This model represents an item with supplementary data, e.g. an ItemRequest object
+ * to help components determine how the Item or its data/bitstream should be delivered
+ * and presented to the users, but not part of the actual database model.
+ */
+export class ItemWithSupplementaryData extends Item {
+  /**
+   * An item request. This is used to determine how the item should be delivered.
+   * A valid accessToken is resolved to this object in the accessTokenResolver
+   */
+  itemRequest: ItemRequest;
+
+  constructor(itemRequest: ItemRequest) {
+    super();
+    this.itemRequest = itemRequest;
+  }
+}

src/app/core/shared/media-viewer-item.model.ts

@@ -23,4 +23,9 @@ export class MediaViewerItem {
    * Incoming Bitsream thumbnail
    */
   thumbnail: string;
+
+  /**
+   * Access token, if accessed via a Request-a-Copy link
+   */
+  accessToken: string;
 }

src/app/item-page/access-by-token/field-components/file-download-link/item-secure-file-download-link.component.html

@@ -1,4 +1,8 @@
-<a [routerLink]="(bitstreamPath$| async)?.routerLink" class="dont-break-out" [queryParams]="(bitstreamPath$| async)?.queryParams" [target]="isBlank ? '_blank': '_self'" [ngClass]="cssClasses">
+<a [routerLink]="(bitstreamPath$| async)?.routerLink" class="dont-break-out"
+   [queryParams]="(bitstreamPath$| async)?.queryParams"
+   [target]="isBlank ? '_blank': '_self'"
+   [ngClass]="cssClasses"
+   [attr.aria-label]="('file-download-link.download' | translate) + dsoNameService.getName(bitstream)">
   <!-- If the user cannot download the file by auth or token, show a lock icon -->
   <span role="img" *ngIf="(canDownload$ | async) === false && (canDownloadWithToken$ | async) === false" [attr.aria-label]="'file-download-link.restricted' | translate" class="pr-1"><i class="fas fa-lock"></i></span>
   <!-- If the user can download the file by token, and NOT normally show a lock open icon -->

src/app/item-page/access-by-token/field-components/file-download-link/item-secure-file-download-link.component.ts

@@ -23,11 +23,13 @@ import {
   getBitstreamDownloadWithAccessTokenRoute,
   getBitstreamRequestACopyRoute,
 } from '../../../../app-routing-paths';
+import { DSONameService } from '../../../../core/breadcrumbs/dso-name.service';
 import { AuthorizationDataService } from '../../../../core/data/feature-authorization/authorization-data.service';
 import { FeatureID } from '../../../../core/data/feature-authorization/feature-id';
 import { Bitstream } from '../../../../core/shared/bitstream.model';
 import { Item } from '../../../../core/shared/item.model';
 import { ItemRequest } from '../../../../core/shared/item-request.model';
+import { ItemWithSupplementaryData } from '../../../../core/shared/item-with-supplementary-data.model';
 import {
   hasValue,
   isNotEmpty,
@@ -54,6 +56,9 @@ export class ItemSecureFileDownloadLinkComponent implements OnInit {
    */
   @Input() bitstream: Bitstream;
 
+  /**
+   * Item that owns the linked bitstream
+   */
   @Input() item: Item;
 
   /**
@@ -66,15 +71,14 @@ export class ItemSecureFileDownloadLinkComponent implements OnInit {
    */
   @Input() isBlank = false;
 
-  @Input() itemRequest: ItemRequest;
-
   @Input() enableRequestACopy = true;
 
   bitstreamPath$: Observable<{
     routerLink: string,
     queryParams: any,
   }>;
-
+  // ItemRequest object with access token, expiry, etc.
+  itemRequest: ItemRequest;
   // authorized to download normally
   canDownload$: Observable<boolean>;
   // authorized to download with token
@@ -84,6 +88,7 @@ export class ItemSecureFileDownloadLinkComponent implements OnInit {
 
   constructor(
     private authorizationService: AuthorizationDataService,
+    protected dsoNameService: DSONameService,
   ) {
   }
 
@@ -92,6 +97,9 @@ export class ItemSecureFileDownloadLinkComponent implements OnInit {
    * (for a given bitstream), and ability to request a copy of a bitstream.
    */
   ngOnInit() {
+    if (this.item instanceof ItemWithSupplementaryData) {
+      this.itemRequest = this.item.itemRequest;
+    }
     this.canDownload$ = this.authorizationService.isAuthorized(FeatureID.CanDownload, isNotEmpty(this.bitstream) ? this.bitstream.self : undefined);
     this.canDownloadWithToken$ = observableOf(this.itemRequest ? (this.itemRequest.allfiles !== false || this.itemRequest.bitstreamId === this.bitstream.uuid) : false);
     this.canRequestACopy$ = this.authorizationService.isAuthorized(FeatureID.CanRequestACopy, isNotEmpty(this.bitstream) ? this.bitstream.self : undefined);