[DSC-395] add configuration to open bitstreams in new tabs

Author: Andrea Barbasso

config/config.example.yml

@@ -410,6 +410,8 @@ item:
     pageSize: 5
     # Show the bitstream access status label on the item page
     showAccessStatuses: false
+    # Open bitstream download links in a new browser tab by default
+    openDownloadLinksInNewTab: true
   # The maximum number of metadata values to add to the metatag list of the item page
   metatagLimit: 20
   # The maximum number of values for repeatable metadata to show in the full item

src/app/cris-layout/cris-layout-matrix/cris-layout-box-container/boxes/metadata/rendering-types/advanced-attachment/bitstream-attachment/attachment-render/types/file-download-button/file-download-button.component.html

@@ -1,18 +1,21 @@
 @if (!hasNoDownload) {
   @if (bitstreamPath$ | async; as bitstreamLink) {
     @if (canDownload$ | async) {
-      <button [routerLink]="bitstreamLink?.routerLink" [queryParams]="bitstreamLink?.queryParams" class="btn btn-outline-primary"
+      <a [routerLink]="bitstreamLink?.routerLink" [queryParams]="bitstreamLink?.queryParams"
+        [target]="isBlank ? '_blank' : '_self'"
+        class="btn btn-outline-primary"
         data-test="download">
         <i class="fas fa-download"></i> {{ 'cris-layout.advanced-attachment.download' | translate }}
-      </button>
+      </a>
     } @else {
-      <button [routerLink]="bitstreamLink?.routerLink"
+      <a [routerLink]="bitstreamLink?.routerLink"
         [queryParams]="bitstreamLink?.queryParams"
+        [target]="isBlank ? '_blank' : '_self'"
         [dsBtnDisabled]="(canRequestItemCopy$ | async) !== true"
         class="btn btn-outline-primary"
         data-test="requestACopy">
         {{ 'cris-layout.advanced-attachment.requestACopy' | translate }}
-      </button>
+      </a>
     }
   }
 }

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

@@ -15,7 +15,10 @@ import {
   getTestScheduler,
 } from 'jasmine-marbles';
 import { of } from 'rxjs';
-import { APP_DATA_SERVICES_MAP } from 'src/config/app-config.interface';
+import {
+  APP_CONFIG,
+  APP_DATA_SERVICES_MAP,
+} from 'src/config/app-config.interface';
 
 import { getBitstreamModuleRoute } from '../../app-routing-paths';
 import { ConfigurationDataService } from '../../core/data/configuration-data.service';
@@ -44,6 +47,14 @@ describe('FileDownloadLinkComponent', () => {
   let configurationDataService: ConfigurationDataService;
   let storeMock: any;
 
+  const mockAppConfig = {
+    item: {
+      bitstream: {
+        openDownloadLinksInNewTab: true,
+      },
+    },
+  };
+
   const itemRequestStub = Object.assign(new ItemRequest(), {
     token: 'item-request-token',
     requestName: 'requester name',
@@ -95,6 +106,7 @@ describe('FileDownloadLinkComponent', () => {
         { provide: ActivatedRoute, useValue: activatedRoute },
         { provide: Store, useValue: storeMock },
         { provide: APP_DATA_SERVICES_MAP, useValue: {} },
+        { provide: APP_CONFIG, useValue: mockAppConfig },
         { provide: ConfigurationDataService, useValue: configurationDataService },
       ],
     })
@@ -135,9 +147,19 @@ describe('FileDownloadLinkComponent', () => {
           fixture.detectChanges();
           const link = fixture.debugElement.query(By.css('a'));
           expect(link.injector.get(RouterLinkDirectiveStub).routerLink).toContain(new URLCombiner(getBitstreamModuleRoute(), bitstream.uuid, 'download').toString());
+          expect(link.nativeElement.getAttribute('target')).toBe('_blank');
           const lock = fixture.debugElement.query(By.css('.fa-lock'));
           expect(lock).toBeNull();
         });
+
+        it('should keep an explicit isBlank input over the config default', () => {
+          component.isBlank = false;
+          component.ngOnInit();
+          scheduler.flush();
+          fixture.detectChanges();
+          const link = fixture.debugElement.query(By.css('a'));
+          expect(link.nativeElement.getAttribute('target')).toBe('_self');
+        });
       });
 
       describe('when the user has no download rights but has the right to request a copy', () => {

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

@@ -5,8 +5,10 @@ import {
 } from '@angular/common';
 import {
   Component,
+  Inject,
   Input,
   OnInit,
+  Optional,
 } from '@angular/core';
 import {
   ActivatedRoute,
@@ -27,6 +29,10 @@ import {
   shareReplay,
 } from 'rxjs/operators';
 
+import {
+  APP_CONFIG,
+  AppConfig,
+} from '../../../config/app-config.interface';
 import {
   getBitstreamDownloadRoute,
   getBitstreamDownloadWithAccessTokenRoute,
@@ -85,7 +91,7 @@ export class FileDownloadLinkComponent implements OnInit {
   /**
    * A boolean representing if link is shown in same tab or in a new one.
    */
-  @Input() isBlank = false;
+  @Input() isBlank: boolean;
 
   @Input() enableRequestACopy = true;
 
@@ -122,10 +128,13 @@ export class FileDownloadLinkComponent implements OnInit {
     public dsoNameService: DSONameService,
     private route: ActivatedRoute,
     private translateService: TranslateService,
+    @Optional() @Inject(APP_CONFIG) private appConfig?: AppConfig,
   ) {
   }
 
   ngOnInit() {
+    this.isBlank = this.isBlank ?? this.appConfig?.item?.bitstream?.openDownloadLinksInNewTab ?? true;
+
     if (this.enableRequestACopy) {
       // Obtain item request data from the route snapshot
       this.itemRequest = this.route.snapshot.data.itemRequest;

src/config/default-app-config.ts

@@ -418,6 +418,8 @@ export class DefaultAppConfig implements AppConfig {
       pageSize: 5,
       // Show the bitstream access status label
       showAccessStatuses: false,
+      // Open bitstream download links in a new browser tab by default
+      openDownloadLinksInNewTab: true,
     },
     // The maximum number of metadata values to add to the metatag list of the item page
     metatagLimit: 20,

src/config/item-config.interface.ts

@@ -14,6 +14,8 @@ export interface ItemConfig extends Config {
     pageSize: number;
     // Show the bitstream access status label
     showAccessStatuses: boolean;
+    // Open bitstream download links in a new browser tab by default
+    openDownloadLinksInNewTab?: boolean;
   }
 
   // The maximum number of metadata values to add to the metatag list of the item page