Merged in DSC-1484-create-utility-functions-to-handle-internal-and-external-links (pull request DSpace#1272)

DSC-1484 create utility functions to handle internal and external links

Approved-by: Davide Negretti

Author: vNovski

src/app/core/services/internal-link.service.spec.ts

@@ -0,0 +1,70 @@
+import { TestBed, waitForAsync } from '@angular/core/testing';
+import { InternalLinkService } from './internal-link.service';
+import { NativeWindowService } from './window.service';
+
+describe('InternalLinkService', () => {
+  let service: InternalLinkService;
+
+  beforeEach(waitForAsync(() => {
+    return TestBed.configureTestingModule({
+      providers: [
+        InternalLinkService,
+        { provide: NativeWindowService, useValue: { nativeWindow: { location: { origin: 'https://currentdomain' } } } },
+    ],
+    }).compileComponents();
+  }));
+
+  beforeEach(() => {
+    service = TestBed.inject(InternalLinkService);
+  });
+
+  describe('isLinkInternal', () => {
+    it('should return true for internal link starting with "/"', () => {
+      const result = service.isLinkInternal('/my-link');
+      expect(result).toBe(true);
+    });
+
+    it('should return true for internal link starting with currentURL', () => {
+      const result = service.isLinkInternal('https://currentdomain/my-link');
+      expect(result).toBe(true);
+    });
+
+    it('should return true for internal link starting with "currentdomain"', () => {
+      const result = service.isLinkInternal('currentdomain/my-link');
+      expect(result).toBe(true);
+    });
+
+    it('should return false for external link', () => {
+      const result = service.isLinkInternal('https://externaldomain/my-link');
+      expect(result).toBe(false);
+    });
+
+    it('should return true for internal link without leading "/"', () => {
+      const result = service.isLinkInternal('my-link');
+      expect(result).toBe(true);
+    });
+  });
+
+  describe('transformInternalLink', () => {
+    it('should transform internal link by removing currentURL', () => {
+      const result = service.getRelativePath('https://currentdomain/my-link');
+      expect(result).toBe('/my-link');
+    });
+
+    it('should transform internal link by adding leading "/" if missing', () => {
+      const result = service.getRelativePath('currentdomain/my-link');
+      expect(result).toBe('/my-link');
+    });
+
+    it('should return unchanged link for external link', () => {
+      const result = service.getRelativePath('https://externalDomain/my-link');
+      expect(result).toBe('https://externalDomain/my-link');
+    });
+
+    it('should return unchanged link for internal link with leading "/"', () => {
+      const result = service.getRelativePath('/my-link');
+      expect(result).toBe('/my-link');
+    });
+  });
+
+});

src/app/core/services/internal-link.service.ts

@@ -0,0 +1,57 @@
+import { Inject, Injectable } from '@angular/core';
+import { NativeWindowRef, NativeWindowService } from './window.service';
+
+/**
+ * LinkService provides utility functions for working with links, such as checking if a link is internal
+ * and transforming internal links based on the current URL.
+ */
+@Injectable()
+export class InternalLinkService {
+  currentURL = this._window.nativeWindow.location.origin;
+
+  constructor(
+    @Inject(NativeWindowService) protected _window: NativeWindowRef,
+  ) {
+
+  }
+
+  /**
+   * Check if the provided link is internal, i.e., it starts with a '/' or matches the current URL.
+   *
+   * @param link The link to be checked.
+   * @returns A boolean indicating whether the link is internal.
+   */
+  public isLinkInternal(link: string): boolean {
+    // Create a Domain object for the provided link
+    const currentDomain = new URL(this.currentURL).hostname;
+
+    return link.startsWith('/')
+      || link.startsWith(this.currentURL)
+      || link.startsWith(currentDomain)
+      || link === currentDomain
+      || !link.includes('://');
+  }
+
+  /**
+   * Get the relative path for an internal link based on the current URL.
+   *
+   * @param link The internal link to be transformed.
+   * @returns The relative path for the given internal link.
+   */
+  public getRelativePath(link: string): string {
+    // Create a Domain object for the provided link
+    const currentDomain = new URL(this.currentURL).hostname;
+
+    if (link.startsWith(this.currentURL)) {
+      const currentSegments = link.substring(this.currentURL.length);
+      return currentSegments.startsWith('/') ? currentSegments : `/${currentSegments}`;
+    }
+
+    if (link.startsWith(currentDomain)) {
+      const currentSegments = link.substring(currentDomain.length);
+      return currentSegments.startsWith('/') ? currentSegments : `/${currentSegments}`;
+    }
+
+    return link;
+  }
+}