UoE/datashare: add "Keep embargo policies" option to the move-item screen

UoE/datashare: add "Keep embargo policies" option to the move-item screen

Author: milanmajchrak

src/app/core/data/item-data.service.spec.ts

@@ -133,6 +133,27 @@ describe('ItemDataService', () => {
     });
   });
 
+  describe('getMoveItemEndpoint', () => {
+    beforeEach(() => {
+      service = initTestService();
+    });
+
+    it('should append keepEmbargoPolicies when inheriting policies', (done) => {
+      service.getMoveItemEndpoint('item-id', true, false).subscribe((href) => {
+        expect(href).toContain('item-id/owningCollection?inheritPolicies=true&keepEmbargoPolicies=false');
+        done();
+      });
+    });
+
+    it('should omit keepEmbargoPolicies when not inheriting policies', (done) => {
+      service.getMoveItemEndpoint('item-id', false, true).subscribe((href) => {
+        expect(href).toContain('item-id/owningCollection?inheritPolicies=false');
+        expect(href).not.toContain('keepEmbargoPolicies');
+        done();
+      });
+    });
+  });
+
   describe('removeMappingFromCollection', () => {
     let result;
 

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

@@ -272,27 +272,40 @@ export abstract class BaseItemDataService extends IdentifiableDataService<Item>
   /**
    * Get the endpoint to move the item
    * @param itemId
+   * @param inheritPolicies whether to inherit the destination collection's default policies
+   * @param keepEmbargoPolicies when inheriting, keep an existing embargo instead of letting it be lifted
    */
-  public getMoveItemEndpoint(itemId: string, inheritPolicies: boolean): Observable<string> {
+  public getMoveItemEndpoint(itemId: string, inheritPolicies: boolean, keepEmbargoPolicies = true): Observable<string> {
     return this.halService.getEndpoint(this.linkPath).pipe(
       map((endpoint: string) => this.getIDHref(endpoint, itemId)),
-      map((endpoint: string) => `${endpoint}/owningCollection?inheritPolicies=${inheritPolicies}`),
+      map((endpoint: string) => {
+        let href = `${endpoint}/owningCollection?inheritPolicies=${inheritPolicies}`;
+        // Only relevant when inheriting.
+        if (inheritPolicies) {
+          href += `&keepEmbargoPolicies=${keepEmbargoPolicies}`;
+        }
+        return href;
+      }),
     );
   }
 
   /**
    * Move the item to a different owning collection
    * @param itemId
    * @param collection
+   * @param inheritPolicies whether to inherit the destination collection's default policies
+   * @param keepEmbargoPolicies when inheriting, whether to keep an existing embargo
    */
-  public moveToCollection(itemId: string, collection: Collection, inheritPolicies: boolean): Observable<RemoteData<any>> {
+  public moveToCollection(
+    itemId: string, collection: Collection, inheritPolicies: boolean, keepEmbargoPolicies = true,
+  ): Observable<RemoteData<any>> {
     const options: HttpOptions = Object.create({});
     let headers = new HttpHeaders();
     headers = headers.append('Content-Type', 'text/uri-list');
     options.headers = headers;
 
     const requestId = this.requestService.generateRequestId();
-    const hrefObs = this.getMoveItemEndpoint(itemId, inheritPolicies);
+    const hrefObs = this.getMoveItemEndpoint(itemId, inheritPolicies, keepEmbargoPolicies);
 
     hrefObs.pipe(
       find((href: string) => hasValue(href)),

src/app/item-page/edit-item-page/item-move/item-move.component.html

@@ -32,6 +32,19 @@ <h1>{{'item.edit.move.head' | translate: {id: (itemRD$ | async)?.payload?.handle
                     <p>
                         {{'item.edit.move.inheritpolicies.description' | translate}}
                     </p>
+                    <p *ngIf="inheritPolicies">
+                      <label for="keepEmbargoPoliciesCheckbox">
+                        <ng-template #keepEmbargoTooltipContent>
+                          {{ 'item.edit.move.keepembargopolicies.tooltip' | translate }}
+                        </ng-template>
+                        <input type="checkbox" name="keepEmbargo" [(ngModel)]="keepEmbargoPolicies" id="keepEmbargoPoliciesCheckbox" [ngbTooltip]="keepEmbargoTooltipContent"
+                        >
+                        {{'item.edit.move.keepembargopolicies.checkbox' | translate}}
+                      </label>
+                    </p>
+                    <p *ngIf="inheritPolicies">
+                        {{'item.edit.move.keepembargopolicies.description' | translate}}
+                    </p>
                 </div>
             </div>
 

src/app/item-page/edit-item-page/item-move/item-move.component.spec.ts

@@ -150,7 +150,20 @@ describe('ItemMoveComponent', () => {
         comp.inheritPolicies = false;
         comp.moveToCollection();
 
-        expect(itemDataService.moveToCollection).toHaveBeenCalledWith('item-id', collection1, false);
+        // keepEmbargoPolicies defaults to true; it is only sent on the request URL when inheriting
+        expect(itemDataService.moveToCollection).toHaveBeenCalledWith('item-id', collection1, false, true);
+      });
+      it('should pass keepEmbargoPolicies through when inheriting policies', () => {
+        comp.item = Object.assign(new Item(), {
+          id: 'item-id',
+          uuid: 'item-id',
+        });
+        comp.selectedCollection = collection1;
+        comp.inheritPolicies = true;
+        comp.keepEmbargoPolicies = false;
+        comp.moveToCollection();
+
+        expect(itemDataService.moveToCollection).toHaveBeenCalledWith('item-id', collection1, true, false);
       });
       it('should call notificationsService success message on success', () => {
         comp.moveToCollection();

src/app/item-page/edit-item-page/item-move/item-move.component.ts

@@ -72,7 +72,10 @@ export class ItemMoveComponent implements OnInit {
 
   selectorType = DSpaceObjectType.COLLECTION;
 
-  inheritPolicies = false;
+  inheritPolicies = true;
+
+  /** When inheriting, keep an existing embargo instead of letting the inherited default read lift it. */
+  keepEmbargoPolicies = true;
   itemRD$: Observable<RemoteData<Item>>;
   originalCollection: Collection;
 
@@ -145,8 +148,9 @@ export class ItemMoveComponent implements OnInit {
    */
   moveToCollection() {
     this.processing = true;
-    const move$ = this.itemDataService.moveToCollection(this.item.id, this.selectedCollection, this.inheritPolicies)
-      .pipe(getFirstCompletedRemoteData());
+    const move$ = this.itemDataService.moveToCollection(
+      this.item.id, this.selectedCollection, this.inheritPolicies, this.keepEmbargoPolicies,
+    ).pipe(getFirstCompletedRemoteData());
 
     move$.subscribe((response: RemoteData<any>) => {
       if (response.hasSucceeded) {

src/assets/i18n/en.json5

@@ -2554,6 +2554,12 @@
 
   "item.edit.move.inheritpolicies.tooltip": "Warning: When enabled, the read access policy for the item and any files associated with the item will be replaced by the default read access policy of the collection. This cannot be undone.",
 
+  "item.edit.move.keepembargopolicies.checkbox": "Keep this item's current embargo",
+
+  "item.edit.move.keepembargopolicies.description": "The item keeps the embargo it already has (its files stay embargoed until their original lift date). Everything else is inherited from the destination collection.",
+
+  "item.edit.move.keepembargopolicies.tooltip": "This is about the embargo already on this item, not the destination collection's. When enabled, the item's existing embargo (and its original lift date) is preserved and only the non-embargo access is inherited. When disabled, the destination collection's default read access replaces it and the embargo is lifted immediately.",
+
   "item.edit.move.move": "Move",
 
   "item.edit.move.processing": "Moving...",