[ADF-1443] Refactor Download directive (#4028)

* [ADF-1443] Refactor Download directive

* [ADF-1443] Node Download Directive now accepts single node and an array as input

* [ADF-1443] Fix Unit tests

* [ADF-1443] Fix unit test related to viewer component

lib/core/directives/directive.module.ts

@@ -26,6 +26,7 @@ import { NodeFavoriteDirective } from './node-favorite.directive';
 import { NodePermissionDirective } from './node-permission.directive';
 import { NodeRestoreDirective } from './node-restore.directive';
 import { UploadDirective } from './upload.directive';
+import { NodeDownloadDirective } from './node-download.directive';
 
 @NgModule({
     imports: [
@@ -39,6 +40,7 @@ import { UploadDirective } from './upload.directive';
         NodeFavoriteDirective,
         NodePermissionDirective,
         NodeRestoreDirective,
+        NodeDownloadDirective,
         UploadDirective
     ],
     exports: [
@@ -48,6 +50,7 @@ import { UploadDirective } from './upload.directive';
         NodeFavoriteDirective,
         NodePermissionDirective,
         NodeRestoreDirective,
+        NodeDownloadDirective,
         UploadDirective
     ]
 })

lib/core/directives/node-download.directive.spec.ts

@@ -0,0 +1,167 @@
+/*!
+ * @license
+ * Copyright 2016 Alfresco Software, Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { TestBed, ComponentFixture } from '@angular/core/testing';
+import { By } from '@angular/platform-browser';
+import { MatDialog } from '@angular/material';
+import { Component, DebugElement } from '@angular/core';
+import { setupTestBed } from '../testing/setupTestBed';
+import { CoreModule } from '../core.module';
+import { DialogModule } from '../dialogs/dialog.module';
+import { AlfrescoApiServiceMock } from '../mock/alfresco-api.service.mock';
+import { AlfrescoApiService } from '../services/alfresco-api.service';
+import { NodeDownloadDirective } from './node-download.directive';
+
+@Component({
+    template: '<div [adfNodeDownload]="selection"></div>'
+})
+class TestComponent {
+    selection;
+}
+
+describe('NodeDownloadDirective', () => {
+    let component: TestComponent;
+    let fixture: ComponentFixture<TestComponent>;
+    let element: DebugElement;
+    let dialog: MatDialog;
+    let apiService: AlfrescoApiService;
+    let contentService;
+    let dialogSpy;
+
+    setupTestBed({
+        imports: [
+            CoreModule.forRoot(),
+            DialogModule
+        ],
+        providers: [
+            { provide: AlfrescoApiService, useClass: AlfrescoApiServiceMock }
+        ],
+        declarations: [
+            TestComponent
+        ]
+    });
+
+    beforeEach(() => {
+        fixture = TestBed.createComponent(TestComponent);
+        component = fixture.componentInstance;
+        element = fixture.debugElement.query(By.directive(NodeDownloadDirective));
+        dialog = TestBed.get(MatDialog);
+        apiService = TestBed.get(AlfrescoApiService);
+        contentService = apiService.getInstance().content;
+        dialogSpy = spyOn(dialog, 'open');
+    });
+
+    it('should not download node when selection is empty', () => {
+        spyOn(apiService, 'getInstance');
+        component.selection = [];
+
+        fixture.detectChanges();
+        element.triggerEventHandler('click', null);
+
+        expect(apiService.getInstance).not.toHaveBeenCalled();
+    });
+
+    it('should not download zip when selection has no nodes', () => {
+        component.selection = [];
+
+        fixture.detectChanges();
+        element.triggerEventHandler('click', null);
+
+        expect(dialogSpy).not.toHaveBeenCalled();
+    });
+
+    it('should download selected node as file', () => {
+        spyOn(contentService, 'getContentUrl');
+        const node = { entry: { id: 'node-id', isFile: true } };
+        component.selection = [node];
+
+        fixture.detectChanges();
+        element.triggerEventHandler('click', null);
+
+        expect(contentService.getContentUrl).toHaveBeenCalledWith(node.entry.id, true);
+    });
+
+    it('should download selected shared node as file', () => {
+        spyOn(contentService, 'getContentUrl');
+        const node = { entry: { nodeId: 'shared-node-id', isFile: true } };
+        component.selection = [node];
+
+        fixture.detectChanges();
+        element.triggerEventHandler('click', null);
+
+        expect(contentService.getContentUrl).toHaveBeenCalledWith(node.entry.nodeId, true);
+    });
+
+    it('should download selected files nodes as zip', () => {
+        const node1 = { entry: { id: 'node-1' } };
+        const node2 = { entry: { id: 'node-2' } };
+        component.selection = [node1, node2];
+
+        fixture.detectChanges();
+        element.triggerEventHandler('click', null);
+
+        expect(dialogSpy.calls.argsFor(0)[1].data).toEqual({ nodeIds: [ 'node-1', 'node-2' ] });
+    });
+
+    it('should download selected shared files nodes as zip', () => {
+        const node1 = { entry: { nodeId: 'shared-node-1' } };
+        const node2 = { entry: { nodeId: 'shared-node-2' } };
+        component.selection = [node1, node2];
+
+        fixture.detectChanges();
+        element.triggerEventHandler('click', null);
+
+        expect(dialogSpy.calls.argsFor(0)[1].data).toEqual({ nodeIds: [ 'shared-node-1', 'shared-node-2' ] });
+    });
+
+    it('should download selected folder node as zip', () => {
+        const node = { entry: { isFolder: true, id: 'node-id' } };
+        component.selection = [node];
+
+        fixture.detectChanges();
+        element.triggerEventHandler('click', null);
+
+        expect(dialogSpy.calls.argsFor(0)[1].data).toEqual({ nodeIds: [ 'node-id' ] });
+    });
+
+    it('should create link element to download file node', () => {
+        const dummyLinkElement = {
+            download: null,
+            href: null,
+            click: () => null,
+            style: {
+                display: null
+            }
+        };
+
+        const node = { entry: { name: 'dummy', isFile: true, id: 'node-id' } };
+
+        spyOn(contentService, 'getContentUrl').and.returnValue('somewhere-over-the-rainbow');
+        spyOn(document, 'createElement').and.returnValue(dummyLinkElement);
+        spyOn(document.body, 'appendChild').and.stub();
+        spyOn(document.body, 'removeChild').and.stub();
+
+        component.selection = [node];
+
+        fixture.detectChanges();
+        element.triggerEventHandler('click', null);
+
+        expect(document.createElement).toHaveBeenCalled();
+        expect(dummyLinkElement.download).toBe('dummy');
+        expect(dummyLinkElement.href).toContain('somewhere-over-the-rainbow');
+    });
+});

lib/core/directives/node-download.directive.ts

@@ -0,0 +1,134 @@
+/*!
+ * @license
+ * Copyright 2016 Alfresco Software, Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { Directive, Input, HostListener } from '@angular/core';
+import { MatDialog } from '@angular/material';
+import { AlfrescoApiService } from '../services/alfresco-api.service';
+import { DownloadZipDialogComponent } from '../dialogs/download-zip.dialog';
+import { MinimalNodeEntity } from 'alfresco-js-api';
+
+@Directive({
+    selector: '[adfNodeDownload]'
+})
+export class NodeDownloadDirective {
+
+    /** Nodes to download. */
+    // tslint:disable-next-line:no-input-rename
+    @Input('adfNodeDownload')
+    nodes: MinimalNodeEntity | MinimalNodeEntity[];
+
+    @HostListener('click')
+    onClick() {
+        this.downloadNodes(this.nodes);
+    }
+
+    constructor(
+        private apiService: AlfrescoApiService,
+        private dialog: MatDialog) {
+    }
+
+    /**
+     * Downloads multiple selected nodes.
+     * Packs result into a .ZIP archive if there is more than one node selected.
+     * @param selection Multiple selected nodes to download
+     */
+    downloadNodes(selection: MinimalNodeEntity | Array<MinimalNodeEntity>) {
+
+        if (!this.isSelectionValid(selection)) {
+            return;
+        }
+        if (selection instanceof Array) {
+            if (selection.length === 1) {
+                this.downloadNode(selection[0]);
+            } else {
+                this.downloadZip(selection);
+            }
+        } else {
+            this.downloadNode(selection);
+        }
+    }
+
+    /**
+     * Downloads a single node.
+     * Packs result into a .ZIP archive is the node is a Folder.
+     * @param node Node to download
+     */
+    downloadNode(node: MinimalNodeEntity) {
+        if (node && node.entry) {
+            const entry = node.entry;
+
+            if (entry.isFile) {
+                this.downloadFile(node);
+            }
+
+            if (entry.isFolder) {
+                this.downloadZip([node]);
+            }
+
+            // Check if there's nodeId for Shared Files
+            if (!entry.isFile && !entry.isFolder && (<any> entry).nodeId) {
+                this.downloadFile(node);
+            }
+        }
+    }
+
+    private isSelectionValid(selection: MinimalNodeEntity | Array<MinimalNodeEntity>) {
+        return selection || (selection instanceof Array && selection.length > 0);
+    }
+
+    private downloadFile(node: MinimalNodeEntity) {
+        if (node && node.entry) {
+            const contentApi = this.apiService.getInstance().content;
+            // nodeId for Shared node
+            const id = (<any> node.entry).nodeId || node.entry.id;
+
+            const url = contentApi.getContentUrl(id, true);
+            const fileName = node.entry.name;
+
+            this.download(url, fileName);
+        }
+    }
+
+    private downloadZip(selection: Array<MinimalNodeEntity>) {
+        if (selection && selection.length > 0) {
+            // nodeId for Shared node
+            const nodeIds = selection.map((node: any) => (node.entry.nodeId || node.entry.id));
+
+            this.dialog.open(DownloadZipDialogComponent, {
+                width: '600px',
+                disableClose: true,
+                data: {
+                    nodeIds
+                }
+            });
+        }
+    }
+
+    private download(url: string, fileName: string) {
+        if (url && fileName) {
+            const link = document.createElement('a');
+
+            link.style.display = 'none';
+            link.download = fileName;
+            link.href = url;
+
+            document.body.appendChild(link);
+            link.click();
+            document.body.removeChild(link);
+        }
+    }
+}

lib/core/directives/public-api.ts

@@ -21,6 +21,7 @@ export * from './node-delete.directive';
 export * from './node-favorite.directive';
 export * from './node-permission.directive';
 export * from './node-restore.directive';
+export * from './node-download.directive';
 export * from './upload.directive';
 
 export * from './directive.module';