UoE/feat: show embargo badge on embargoed bitstreams in file section

UoE/feat: show embargo badge on embargoed bitstreams in file section

Author: milanmajchrak

src/app/core/data/access-status-data.service.ts

@@ -5,13 +5,14 @@ import { AccessStatusObject } from 'src/app/shared/object-collection/shared/badg
 import { RemoteDataBuildService } from '../cache/builders/remote-data-build.service';
 import { ObjectCacheService } from '../cache/object-cache.service';
 import { HALEndpointService } from '../shared/hal-endpoint.service';
+import { Bitstream } from '../shared/bitstream.model';
 import { Item } from '../shared/item.model';
 import { BaseDataService } from './base/base-data.service';
 import { RemoteData } from './remote-data';
 import { RequestService } from './request.service';
 
 /**
- * Data service responsible for retrieving the access status of Items
+ * Data service responsible for retrieving the access status of Items and Bitstreams
  */
 @Injectable({ providedIn: 'root' })
 export class AccessStatusDataService extends BaseDataService<AccessStatusObject> {
@@ -32,4 +33,12 @@ export class AccessStatusDataService extends BaseDataService<AccessStatusObject>
   findAccessStatusFor(item: Item): Observable<RemoteData<AccessStatusObject>> {
     return this.findByHref(item._links.accessStatus.href);
   }
+
+  /**
+   * Returns {@link RemoteData} of {@link AccessStatusObject} that is the access status of the given bitstream
+   * @param bitstream Bitstream we want the access status of
+   */
+  findAccessStatusForBitstream(bitstream: Bitstream): Observable<RemoteData<AccessStatusObject>> {
+    return this.findByHref(bitstream._links.accessStatus.href);
+  }
 }

src/app/core/shared/bitstream.model.ts

@@ -10,6 +10,8 @@ import {
   typedObject,
 } from '../cache/builders/build-decorators';
 import { RemoteData } from '../data/remote-data';
+import { AccessStatusObject } from '../../shared/object-collection/shared/badges/access-status-badge/access-status.model';
+import { ACCESS_STATUS } from '../../shared/object-collection/shared/badges/access-status-badge/access-status.resource-type';
 import { BITSTREAM } from './bitstream.resource-type';
 import { BitstreamFormat } from './bitstream-format.model';
 import { BITSTREAM_FORMAT } from './bitstream-format.resource-type';
@@ -52,6 +54,7 @@ export class Bitstream extends DSpaceObject implements ChildHALResource {
     format: HALLink;
     content: HALLink;
     thumbnail: HALLink;
+    accessStatus: HALLink;
   };
 
   /**
@@ -75,6 +78,13 @@ export class Bitstream extends DSpaceObject implements ChildHALResource {
   @link(BUNDLE)
   bundle?: Observable<RemoteData<Bundle>>;
 
+  /**
+   * The access status for this Bitstream
+   * Will be undefined unless the accessStatus {@link HALLink} has been resolved.
+   */
+  @link(ACCESS_STATUS, false, 'accessStatus')
+  accessStatus?: Observable<RemoteData<AccessStatusObject>>;
+
   getParentLinkKey(): keyof this['_links'] {
     return 'format';
   }

src/app/item-page/full/field-components/file-section/full-file-section.component.html

@@ -33,7 +33,7 @@ <h3 class="h5 simple-view-element-header">{{"item.page.filesection.original.bund
                         </dl>
                     </div>
                     <div class="col-2">
-                        <ds-file-download-link [bitstream]="file" [item]="item">
+                        <ds-file-download-link [bitstream]="file" [item]="item" [showAccessStatusBadge]="true">
                             {{"item.page.filesection.download" | translate}}
                         </ds-file-download-link>
                     </div>

src/app/item-page/simple/field-components/file-section/file-section.component.html

@@ -1,7 +1,7 @@
 <ng-container *ngVar="(bitstreams$ | async) as bitstreams">
   <ds-metadata-field-wrapper *ngIf="bitstreams?.length > 0" [label]="label | translate">
     <div class="file-section">
-      <ds-file-download-link *ngFor="let file of bitstreams; let last=last;" [bitstream]="file" [item]="item">
+      <ds-file-download-link *ngFor="let file of bitstreams; let last=last;" [bitstream]="file" [item]="item" [showAccessStatusBadge]="true">
         <span>
           <span *ngIf="primaryBitsreamId === file.id" class="badge badge-primary">{{ 'item.page.bitstreams.primary' | translate }}</span> 
           {{ dsoNameService.getName(file) }}

src/app/shared/file-download-link/file-download-link.component.html

@@ -1,11 +1,14 @@
+@if (showAccessStatusBadge) {
+  <ds-access-status-badge [object]="bitstream"></ds-access-status-badge>
+}
 <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)"
    role="link"
    tabindex="0">
-  <span role="img" *ngIf="(canDownload$ |async) !== true" [attr.aria-label]="'file-download-link.restricted' | translate" class="pr-1"><i class="fas fa-lock"></i></span>
+  <span role="img" *ngIf="(canDownload$ |async) !== true" [attr.aria-label]="'file-download-link.restricted' | translate" class="pl-1"><i class="fas fa-lock"></i></span>
   <ng-container *ngTemplateOutlet="content"></ng-container>
 </a>
 

src/app/shared/file-download-link/file-download-link.component.ts

@@ -31,13 +31,14 @@ import {
   hasValue,
   isNotEmpty,
 } from '../empty.util';
+import { ThemedAccessStatusBadgeComponent } from '../object-collection/shared/badges/access-status-badge/themed-access-status-badge.component';
 
 @Component({
   selector: 'ds-base-file-download-link',
   templateUrl: './file-download-link.component.html',
   styleUrls: ['./file-download-link.component.scss'],
   standalone: true,
-  imports: [RouterLink, NgClass, NgIf, NgTemplateOutlet, AsyncPipe, TranslateModule],
+  imports: [RouterLink, NgClass, NgIf, NgTemplateOutlet, AsyncPipe, TranslateModule, ThemedAccessStatusBadgeComponent],
 })
 /**
  * Component displaying a download link
@@ -65,6 +66,11 @@ export class FileDownloadLinkComponent implements OnInit {
 
   @Input() enableRequestACopy = true;
 
+  /**
+   * A boolean indicating whether the access status badge is displayed
+   */
+  @Input() showAccessStatusBadge = true;
+
   bitstreamPath$: Observable<{
     routerLink: string,
     queryParams: any,

src/app/shared/file-download-link/themed-file-download-link.component.ts

@@ -27,7 +27,9 @@ export class ThemedFileDownloadLinkComponent extends ThemedComponent<FileDownloa
 
   @Input() enableRequestACopy: boolean;
 
-  protected inAndOutputNames: (keyof FileDownloadLinkComponent & keyof this)[] = ['bitstream', 'item', 'cssClasses', 'isBlank', 'enableRequestACopy'];
+  @Input() showAccessStatusBadge: boolean;
+
+  protected inAndOutputNames: (keyof FileDownloadLinkComponent & keyof this)[] = ['bitstream', 'item', 'cssClasses', 'isBlank', 'enableRequestACopy', 'showAccessStatusBadge'];
 
   protected getComponentName(): string {
     return 'FileDownloadLinkComponent';

src/app/shared/object-collection/shared/badges/access-status-badge/access-status-badge.component.html

@@ -1,9 +1,9 @@
-<ng-container *ngIf="showAccessStatus">
-  <span *ngIf="accessStatus$ | async as accessStatus">
-    <span [class]="'badge badge-secondary access-status-list-element-badge ' + accessStatusClass">
+@if (showAccessStatus) {
+  @if ((accessStatus$ | async); as status) {
+    <span [class]="'badge badge-secondary dont-break-out access-status-list-element-badge ' + accessStatusClass">
       <span class="sr-only">{{ 'listelement.badge.access-status' | translate }}</span>
-      {{ accessStatus | translate }}
+      {{ status | translate: { date: (embargoDate$ | async) } }}
       <span class="sr-only">, </span>
     </span>
-  </span>
-</ng-container>
+  }
+}

src/app/shared/object-collection/shared/badges/access-status-badge/access-status-badge.component.scss

@@ -1 +1,35 @@
+span {
+  white-space: normal;
+}
+
+:host {
+  ::ng-deep .access-status-list-element-badge {
+    margin-right: 0.35rem;
+  }
+
+  // Embargo — DataShare blue with white text
+  ::ng-deep .access-status-embargo-listelement-badge,
+  ::ng-deep .embargo-listelement-badge {
+    background-color: #004f71 !important;
+    color: #fff !important;
+  }
+
+  // Open access — DataShare success green
+  ::ng-deep .access-status-open-access-listelement-badge {
+    background-color: #5cb85c !important;
+    color: #fff !important;
+  }
+
+  // Restricted — DataShare darker blue
+  ::ng-deep .access-status-restricted-listelement-badge {
+    background-color: #002b3e !important;
+    color: #fff !important;
+  }
+
+  // Metadata only — DataShare muted
+  ::ng-deep .access-status-metadata-only-listelement-badge {
+    background-color: #495057 !important;
+    color: #fff !important;
+  }
+}
 

src/app/shared/object-collection/shared/badges/access-status-badge/access-status-badge.component.spec.ts

@@ -8,7 +8,7 @@ import { By } from '@angular/platform-browser';
 import { TranslateModule } from '@ngx-translate/core';
 import { environment } from 'src/environments/environment';
 
-import { AccessStatusDataService } from '../../../../../core/data/access-status-data.service';
+import { LinkService } from '../../../../../core/cache/builders/link.service';
 import { Item } from '../../../../../core/shared/item.model';
 import { createSuccessfulRemoteDataObject$ } from '../../../../remote-data.utils';
 import { TruncatePipe } from '../../../../utils/truncate.pipe';
@@ -25,7 +25,7 @@ describe('ItemAccessStatusBadgeComponent', () => {
   let embargoStatus: AccessStatusObject;
   let restrictedStatus: AccessStatusObject;
 
-  let accessStatusDataService: AccessStatusDataService;
+  let linkService: LinkService;
 
   let item: Item;
 
@@ -50,13 +50,14 @@ describe('ItemAccessStatusBadgeComponent', () => {
       status: 'restricted',
     });
 
-    accessStatusDataService = jasmine.createSpyObj('accessStatusDataService', {
-      findAccessStatusFor: createSuccessfulRemoteDataObject$(unknownStatus),
+    linkService = jasmine.createSpyObj('linkService', {
+      resolveLink: {},
     });
 
     item = Object.assign(new Item(), {
       uuid: 'item-uuid',
       type: 'item',
+      accessStatus: createSuccessfulRemoteDataObject$(unknownStatus),
     });
   }
 
@@ -65,7 +66,7 @@ describe('ItemAccessStatusBadgeComponent', () => {
       imports: [TranslateModule.forRoot(), AccessStatusBadgeComponent, TruncatePipe],
       schemas: [NO_ERRORS_SCHEMA],
       providers: [
-        { provide: AccessStatusDataService, useValue: accessStatusDataService },
+        { provide: LinkService, useValue: linkService },
       ],
     }).compileComponents();
   }
@@ -113,7 +114,7 @@ describe('ItemAccessStatusBadgeComponent', () => {
   describe('When the findAccessStatusFor method returns metadata.only', () => {
     beforeEach(waitForAsync(() => {
       init();
-      (accessStatusDataService.findAccessStatusFor as jasmine.Spy).and.returnValue(createSuccessfulRemoteDataObject$(metadataOnlyStatus));
+      item.accessStatus = createSuccessfulRemoteDataObject$(metadataOnlyStatus);
       initTestBed();
     }));
     beforeEach(() => {
@@ -127,7 +128,7 @@ describe('ItemAccessStatusBadgeComponent', () => {
   describe('When the findAccessStatusFor method returns open.access', () => {
     beforeEach(waitForAsync(() => {
       init();
-      (accessStatusDataService.findAccessStatusFor as jasmine.Spy).and.returnValue(createSuccessfulRemoteDataObject$(openAccessStatus));
+      item.accessStatus = createSuccessfulRemoteDataObject$(openAccessStatus);
       initTestBed();
     }));
     beforeEach(() => {
@@ -141,7 +142,7 @@ describe('ItemAccessStatusBadgeComponent', () => {
   describe('When the findAccessStatusFor method returns embargo', () => {
     beforeEach(waitForAsync(() => {
       init();
-      (accessStatusDataService.findAccessStatusFor as jasmine.Spy).and.returnValue(createSuccessfulRemoteDataObject$(embargoStatus));
+      item.accessStatus = createSuccessfulRemoteDataObject$(embargoStatus);
       initTestBed();
     }));
     beforeEach(() => {
@@ -155,7 +156,7 @@ describe('ItemAccessStatusBadgeComponent', () => {
   describe('When the findAccessStatusFor method returns restricted', () => {
     beforeEach(waitForAsync(() => {
       init();
-      (accessStatusDataService.findAccessStatusFor as jasmine.Spy).and.returnValue(createSuccessfulRemoteDataObject$(restrictedStatus));
+      item.accessStatus = createSuccessfulRemoteDataObject$(restrictedStatus);
       initTestBed();
     }));
     beforeEach(() => {