Lookup and redirect by uuid and handle

resources/i18n/en.json5

@@ -204,6 +204,7 @@
   "error.collection": "Error fetching collection",
   "error.collections": "Error fetching collections",
   "error.community": "Error fetching community",
+  "error.identifier": "No item found for the identifier",
   "error.default": "Error",
   "error.item": "Error fetching item",
   "error.items": "Error fetching items",

src/app/+lookup-by-id/lookup-by-id-routing.module.ts

@@ -0,0 +1,41 @@
+import { LookupGuard } from './lookup-guard';
+import { NgModule } from '@angular/core';
+import { RouterModule, UrlSegment } from '@angular/router';
+import { ObjectNotFoundComponent } from './objectnotfound/objectnotfound.component';
+import { hasValue, isNotEmpty } from '../shared/empty.util';
+
+@NgModule({
+  imports: [
+    RouterModule.forChild([
+      {
+        matcher: (url) => {
+          // The expected path is :idType/:id
+          const idType = url[0].path;
+          // Allow for handles that are delimited with a forward slash.
+          const id = url
+            .slice(1)
+            .map((us: UrlSegment) => us.path)
+            .join('/');
+          if (isNotEmpty(idType) && isNotEmpty(id)) {
+            return {
+              consumed: url,
+              posParams: {
+                idType: new UrlSegment(idType, {}),
+                id: new UrlSegment(id, {})
+              }
+            };
+          }
+          return null;
+        },
+        canActivate: [LookupGuard],
+        component: ObjectNotFoundComponent  }
+    ])
+  ],
+  providers: [
+    LookupGuard
+  ]
+})
+
+export class LookupRoutingModule {
+
+}

src/app/+lookup-by-id/lookup-by-id.module.ts

@@ -0,0 +1,23 @@
+import { NgModule } from '@angular/core';
+import { CommonModule } from '@angular/common';
+import { SharedModule } from '../shared/shared.module';
+import { LookupRoutingModule } from './lookup-by-id-routing.module';
+import { ObjectNotFoundComponent } from './objectnotfound/objectnotfound.component';
+import { DsoRedirectDataService } from '../core/data/dso-redirect-data.service';
+
+@NgModule({
+  imports: [
+    LookupRoutingModule,
+    CommonModule,
+    SharedModule,
+  ],
+  declarations: [
+    ObjectNotFoundComponent
+  ],
+  providers: [
+    DsoRedirectDataService
+  ]
+})
+export class LookupIdModule {
+
+}

src/app/+lookup-by-id/lookup-guard.spec.ts

@@ -0,0 +1,50 @@
+import { LookupGuard } from './lookup-guard';
+import { of as observableOf } from 'rxjs';
+import { IdentifierType } from '../core/data/request.models';
+
+describe('LookupGuard', () => {
+  let dsoService: any;
+  let guard: any;
+
+  beforeEach(() => {
+    dsoService = {
+      findById: jasmine.createSpy('findById').and.returnValue(observableOf({ hasFailed: false,
+        hasSucceeded: true }))
+    };
+    guard = new LookupGuard(dsoService);
+  });
+
+  it('should call findById with handle params', () => {
+    const scopedRoute = {
+      params: {
+        id: '1234',
+        idType: '123456789'
+      }
+    };
+    guard.canActivate(scopedRoute as any, undefined);
+    expect(dsoService.findById).toHaveBeenCalledWith('123456789/1234', IdentifierType.HANDLE)
+  });
+
+  it('should call findById with handle params', () => {
+    const scopedRoute = {
+      params: {
+        id: '123456789%2F1234',
+        idType: 'handle'
+      }
+    };
+    guard.canActivate(scopedRoute as any, undefined);
+    expect(dsoService.findById).toHaveBeenCalledWith('123456789%2F1234', IdentifierType.HANDLE)
+  });
+
+  it('should call findById with UUID params', () => {
+    const scopedRoute = {
+      params: {
+        id: '34cfed7c-f597-49ef-9cbe-ea351f0023c2',
+        idType: 'uuid'
+      }
+    };
+    guard.canActivate(scopedRoute as any, undefined);
+    expect(dsoService.findById).toHaveBeenCalledWith('34cfed7c-f597-49ef-9cbe-ea351f0023c2', IdentifierType.UUID)
+  });
+
+});

src/app/+lookup-by-id/lookup-guard.ts

@@ -0,0 +1,53 @@
+import { ActivatedRouteSnapshot, CanActivate, Router, RouterStateSnapshot } from '@angular/router';
+import { Injectable } from '@angular/core';
+import { IdentifierType } from '../core/data/request.models';
+import { Observable } from 'rxjs';
+import { map } from 'rxjs/operators';
+import { RemoteData } from '../core/data/remote-data';
+import { FindByIDRequest } from '../core/data/request.models';
+import { DsoRedirectDataService } from '../core/data/dso-redirect-data.service';
+
+interface LookupParams {
+  type: IdentifierType;
+  id: string;
+}
+
+@Injectable()
+export class LookupGuard implements CanActivate {
+
+  constructor(private dsoService: DsoRedirectDataService) {
+  }
+
+  canActivate(route: ActivatedRouteSnapshot, state:RouterStateSnapshot): Observable<boolean>  {
+    const params = this.getLookupParams(route);
+    return this.dsoService.findById(params.id, params.type).pipe(
+      map((response: RemoteData<FindByIDRequest>) => response.hasFailed)
+    );
+  }
+
+  private getLookupParams(route: ActivatedRouteSnapshot): LookupParams {
+    let type;
+    let id;
+    const idType = route.params.idType;
+
+    // If the idType is not recognized, assume a legacy handle request (handle/prefix/id)
+    if (idType !== IdentifierType.HANDLE && idType !== IdentifierType.UUID) {
+      type = IdentifierType.HANDLE;
+      const prefix = route.params.idType;
+      const handleId = route.params.id;
+      id = `${prefix}/${handleId}`;
+
+    } else if (route.params.idType === IdentifierType.HANDLE) {
+      type = IdentifierType.HANDLE;
+      id = route.params.id;
+
+    } else {
+      type = IdentifierType.UUID;
+      id = route.params.id;
+    }
+    return {
+      type: type,
+      id: id
+    };
+  }
+}

src/app/+lookup-by-id/objectnotfound/objectnotfound.component.html

@@ -0,0 +1,8 @@
+<div class="object-not-found container">
+  <h1>{{"error.identifier" | translate}}</h1>
+  <h2><small><em>{{missingItem}}</em></small></h2>
+  <br />
+  <p class="text-center">
+    <a routerLink="/home" class="btn btn-primary">{{"404.link.home-page" | translate}}</a>
+  </p>
+</div>

src/app/+lookup-by-id/objectnotfound/objectnotfound.component.spec.ts

@@ -0,0 +1,79 @@
+import { NO_ERRORS_SCHEMA } from '@angular/core';
+import { async, ComponentFixture, TestBed } from '@angular/core/testing';
+import { TranslateModule } from '@ngx-translate/core';
+
+import { ObjectNotFoundComponent } from './objectnotfound.component';
+import { ActivatedRouteStub } from '../../shared/testing/active-router-stub';
+import { of as observableOf } from 'rxjs';
+import { ActivatedRoute } from '@angular/router';
+
+describe('ObjectNotFoundComponent', () => {
+  let comp: ObjectNotFoundComponent;
+  let fixture: ComponentFixture<ObjectNotFoundComponent>;
+  const testUUID = '34cfed7c-f597-49ef-9cbe-ea351f0023c2';
+  const uuidType = 'uuid';
+  const handlePrefix = '123456789';
+  const handleId = '22';
+  const activatedRouteStub = Object.assign(new ActivatedRouteStub(), {
+    params: observableOf({id: testUUID, idType: uuidType})
+  });
+  const activatedRouteStubHandle = Object.assign(new ActivatedRouteStub(), {
+    params: observableOf({id: handleId, idType: handlePrefix})
+  });
+  describe('uuid request', () => {
+    beforeEach(async(() => {
+      TestBed.configureTestingModule({
+        imports: [
+          TranslateModule.forRoot()
+        ], providers: [
+          {provide: ActivatedRoute, useValue: activatedRouteStub}
+        ],
+        declarations: [ObjectNotFoundComponent],
+        schemas: [NO_ERRORS_SCHEMA]
+      }).compileComponents();
+    }));
+
+    beforeEach(() => {
+      fixture = TestBed.createComponent(ObjectNotFoundComponent);
+      comp = fixture.componentInstance;
+      fixture.detectChanges();
+    });
+
+    it('should create instance', () => {
+      expect(comp).toBeDefined()
+    });
+
+    it('should have id and idType', () => {
+      expect(comp.id).toEqual(testUUID);
+      expect(comp.idType).toEqual(uuidType);
+      expect(comp.missingItem).toEqual('uuid: ' + testUUID);
+    });
+  });
+
+  describe( 'legacy handle request', () => {
+    beforeEach(async(() => {
+      TestBed.configureTestingModule({
+        imports: [
+          TranslateModule.forRoot()
+        ], providers: [
+          {provide: ActivatedRoute, useValue: activatedRouteStubHandle}
+        ],
+        declarations: [ObjectNotFoundComponent],
+        schemas: [NO_ERRORS_SCHEMA]
+      }).compileComponents();
+    }));
+
+    beforeEach(() => {
+      fixture = TestBed.createComponent(ObjectNotFoundComponent);
+      comp = fixture.componentInstance;
+      fixture.detectChanges();
+    });
+
+    it('should have handle prefix and id', () => {
+      expect(comp.id).toEqual(handleId);
+      expect(comp.idType).toEqual(handlePrefix);
+      expect(comp.missingItem).toEqual('handle: ' + handlePrefix + '/' + handleId);
+    });
+  });
+
+});

src/app/+lookup-by-id/objectnotfound/objectnotfound.component.ts

@@ -0,0 +1,43 @@
+
+import { Component, ChangeDetectionStrategy, OnInit } from '@angular/core';
+import { ActivatedRoute } from '@angular/router';
+
+/**
+ * This component representing the `PageNotFound` DSpace page.
+ */
+@Component({
+  selector: 'ds-objnotfound',
+  styleUrls: ['./objectnotfound.component.scss'],
+  templateUrl: './objectnotfound.component.html',
+  changeDetection: ChangeDetectionStrategy.Default
+})
+export class ObjectNotFoundComponent implements OnInit {
+
+  idType: string;
+
+  id: string;
+
+  missingItem: string;
+
+  /**
+   * Initialize instance variables
+   *
+   * @param {AuthService} authservice
+   * @param {ServerResponseService} responseService
+   */
+  constructor(private route: ActivatedRoute) {
+    route.params.subscribe((params) => {
+      this.idType = params.idType;
+      this.id = params.id;
+    })
+  }
+
+  ngOnInit(): void {
+    if (this.idType.startsWith('handle') || this.idType.startsWith('uuid')) {
+      this.missingItem = this.idType + ': ' + this.id;
+    } else {
+      this.missingItem = 'handle: ' + this.idType + '/' + this.id;
+    }
+  }
+
+}

src/app/app-routing.module.ts

@@ -27,6 +27,8 @@ export function getAdminModulePath() {
     RouterModule.forRoot([
       { path: '', redirectTo: '/home', pathMatch: 'full' },
       { path: 'home', loadChildren: './+home-page/home-page.module#HomePageModule' },
+      { path: 'id', loadChildren: './+lookup-by-id/lookup-by-id.module#LookupIdModule' },
+      { path: 'handle', loadChildren: './+lookup-by-id/lookup-by-id.module#LookupIdModule' },
       { path: COMMUNITY_MODULE_PATH, loadChildren: './+community-page/community-page.module#CommunityPageModule' },
       { path: COLLECTION_MODULE_PATH, loadChildren: './+collection-page/collection-page.module#CollectionPageModule' },
       { path: ITEM_MODULE_PATH, loadChildren: './+item-page/item-page.module#ItemPageModule' },

src/app/app.module.ts

@@ -128,7 +128,7 @@ const EXPORTS = [
     ...PROVIDERS
   ],
   declarations: [
-    ...DECLARATIONS,
+    ...DECLARATIONS
   ],
   exports: [
     ...EXPORTS

src/app/core/cache/object-cache.reducer.ts

@@ -44,6 +44,7 @@ export abstract class TypedObject {
  */
 export class CacheableObject extends TypedObject {
   uuid?: string;
+  handle?: string;
   self: string;
   // isNew: boolean;
   // dirtyType: DirtyType;

src/app/core/cache/object-cache.service.ts

@@ -4,7 +4,7 @@ import { applyPatch, Operation } from 'fast-json-patch';
 import { combineLatest as observableCombineLatest, Observable } from 'rxjs';
 
 import { distinctUntilChanged, filter, map, mergeMap, take, } from 'rxjs/operators';
-import { hasNoValue, hasValue, isNotEmpty } from '../../shared/empty.util';
+import { hasNoValue, isNotEmpty } from '../../shared/empty.util';
 import { CoreState } from '../core.reducers';
 import { coreSelector } from '../core.selectors';
 import { RestRequestMethod } from '../data/rest-request-method';
@@ -80,7 +80,8 @@ export class ObjectCacheService {
    * @return Observable<NormalizedObject<T>>
    *    An observable of the requested object in normalized form
    */
-  getObjectByUUID<T extends CacheableObject>(uuid: string): Observable<NormalizedObject<T>> {
+  getObjectByUUID<T extends CacheableObject>(uuid: string):
+    Observable<NormalizedObject<T>> {
     return this.store.pipe(
       select(selfLinkFromUuidSelector(uuid)),
       mergeMap((selfLink: string) => this.getObjectBySelfLink(selfLink)

src/app/core/data/data.service.ts

@@ -147,8 +147,9 @@ export abstract class DataService<T extends CacheableObject> {
   }
 
   findById(id: string): Observable<RemoteData<T>> {
+
     const hrefObs = this.halService.getEndpoint(this.linkPath).pipe(
-      map((endpoint: string) => this.getIDHref(endpoint, id)));
+        map((endpoint: string) => this.getIDHref(endpoint, encodeURIComponent(id))));
 
     hrefObs.pipe(
       find((href: string) => hasValue(href)))