[ADF-711] Drag and drop doesn't have the acceptedFilesType property (#3104)

* Added acceptedFilesType property for upload-drag-area component.
* Only those files will be uploaded which are included in acceptedFilesType.
This commit is contained in:
camorra-skk
2018-03-22 15:05:40 +05:30
committed by Eugenio Romano
parent 36625c1af6
commit 7358563b09
6 changed files with 166 additions and 98 deletions

View File

@@ -34,6 +34,7 @@ export class AppComponent {
| disabled | boolean | false | Toggle component disabled state | | disabled | boolean | false | Toggle component disabled state |
| parentId | string | '-root-' | The ID of the folder in which the files will be uploaded. | | parentId | string | '-root-' | The ID of the folder in which the files will be uploaded. |
| versioning | boolean | false | Versioning false is the default uploader behaviour and it renames the file using an integer suffix if there is a name clash. Versioning true to indicate that a major version should be created | | versioning | boolean | false | Versioning false is the default uploader behaviour and it renames the file using an integer suffix if there is a name clash. Versioning true to indicate that a major version should be created |
| acceptedFilesType | `string` | `'*'` | List of allowed file extensions, for example: ".jpg,.gif,.png,.svg". |
### Events ### Events

View File

@@ -0,0 +1,47 @@
/*!
* @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 { FileModel } from '@alfresco/adf-core';
import { Input } from '@angular/core';
export abstract class UploadBase {
@Input()
acceptedFilesType: string = '*';
constructor() {}
/**
* Checks if the given file is allowed by the extension filters
*
* @param file FileModel
*/
protected isFileAcceptable(file: FileModel): boolean {
if (this.acceptedFilesType === '*') {
return true;
}
const allowedExtensions = this.acceptedFilesType
.split(',')
.map(ext => ext.replace(/^\./, ''));
if (allowedExtensions.indexOf(file.extension) !== -1) {
return true;
}
return false;
}
}

View File

@@ -41,6 +41,7 @@ import { Observable } from 'rxjs/Observable';
import { Subject } from 'rxjs/Subject'; import { Subject } from 'rxjs/Subject';
import { PermissionModel } from '../../document-list/models/permissions.model'; import { PermissionModel } from '../../document-list/models/permissions.model';
import 'rxjs/add/observable/throw'; import 'rxjs/add/observable/throw';
import { UploadBase } from './base-upload/upload-base';
@Component({ @Component({
selector: 'adf-upload-button', selector: 'adf-upload-button',
@@ -51,7 +52,7 @@ import 'rxjs/add/observable/throw';
], ],
encapsulation: ViewEncapsulation.None encapsulation: ViewEncapsulation.None
}) })
export class UploadButtonComponent implements OnInit, OnChanges, NodePermissionSubject { export class UploadButtonComponent extends UploadBase implements OnInit, OnChanges, NodePermissionSubject {
/** Toggles component disabled state (if there is no node permission checking). */ /** Toggles component disabled state (if there is no node permission checking). */
@Input() @Input()
@@ -69,10 +70,6 @@ export class UploadButtonComponent implements OnInit, OnChanges, NodePermissionS
@Input() @Input()
versioning: boolean = false; versioning: boolean = false;
/** List of allowed file extensions, for example: ".jpg,.gif,.png,.svg". */
@Input()
acceptedFilesType: string = '*';
/** Sets a limit on the maximum size (in bytes) of a file to be uploaded. /** Sets a limit on the maximum size (in bytes) of a file to be uploaded.
* Has no effect if undefined. * Has no effect if undefined.
*/ */
@@ -118,6 +115,7 @@ export class UploadButtonComponent implements OnInit, OnChanges, NodePermissionS
protected translateService: TranslationService, protected translateService: TranslationService,
protected logService: LogService protected logService: LogService
) { ) {
super();
} }
ngOnInit() { ngOnInit() {
@@ -190,27 +188,6 @@ export class UploadButtonComponent implements OnInit, OnChanges, NodePermissionS
}); });
} }
/**
* Checks if the given file is allowed by the extension filters
*
* @param file FileModel
*/
protected isFileAcceptable(file: FileModel): boolean {
if (this.acceptedFilesType === '*') {
return true;
}
const allowedExtensions = this.acceptedFilesType
.split(',')
.map(ext => ext.replace(/^\./, ''));
if (allowedExtensions.indexOf(file.extension) !== -1) {
return true;
}
return false;
}
/** /**
* Checks if the given file is an acceptable size * Checks if the given file is an acceptable size
* *

View File

@@ -178,65 +178,111 @@ describe('UploadDragAreaComponent', () => {
}); });
}); });
it('should upload the list of files dropped', (done) => { describe('Upload Files', () => {
component.success = null; let addToQueueSpy;
uploadService.uploadFilesInTheQueue = jasmine.createSpy('uploadFilesInTheQueue');
fixture.detectChanges(); beforeEach(async(() => {
const file = <File> { name: 'fake-name-1', size: 10, webkitRelativePath: 'fake-folder1/fake-name-1.json' }; addToQueueSpy = spyOn(uploadService, 'addToQueue');
let filesList = [file]; }));
spyOn(uploadService, 'addToQueue').and.callFake((f: FileModel) => { it('should upload the list of files dropped', async(() => {
expect(f.file).toBe(file); component.success = null;
done(); uploadService.uploadFilesInTheQueue = jasmine.createSpy('uploadFilesInTheQueue');
}); fixture.detectChanges();
const file = <File> { name: 'fake-name-1', size: 10, webkitRelativePath: 'fake-folder1/fake-name-1.json' };
let filesList = [file];
fixture.detectChanges();
fixture.whenStable().then(() => {
addToQueueSpy.and.callFake((f: FileModel) => {
expect(f.file).toBe(file);
});
component.onFilesDropped(filesList);
});
}));
component.onFilesDropped(filesList); it('should only upload those files whose fileTypes are in acceptedFilesType', async(() => {
}); spyOn(uploadService, 'uploadFilesInTheQueue');
component.success = null;
component.acceptedFilesType = '.jpg,.pdf';
fixture.detectChanges();
const files: File[] = [
<File> { name: 'phobos.jpg' },
<File> { name: 'deimos.pdf' },
<File> { name: 'ganymede.bmp' }
];
component.onFilesDropped(files);
fixture.whenStable().then(() => {
expect(uploadService.uploadFilesInTheQueue).toHaveBeenCalledWith(null);
const filesCalledWith = addToQueueSpy.calls.mostRecent().args;
expect(filesCalledWith.length).toBe(2, 'Files should contain two elements');
expect(filesCalledWith[0].name).toBe('phobos.jpg');
expect(filesCalledWith[1].name).toBe('deimos.pdf');
});
}));
it('should upload a file when dropped', () => { it('should upload a file if fileType is in acceptedFilesType', async(() => {
component.success = null; spyOn(uploadService, 'uploadFilesInTheQueue');
component.success = null;
component.acceptedFilesType = '.png';
fixture.detectChanges();
let itemEntity = {
fullPath: '/folder-fake/file-fake.png',
isDirectory: false,
isFile: true,
name: 'file-fake.png',
file: (callbackFile) => {
let fileFake = new File(['fakefake'], 'file-fake.png', {type: 'image/png'});
callbackFile(fileFake);
}
};
fixture.whenStable().then(() => {
component.onFilesEntityDropped(itemEntity);
expect(uploadService.uploadFilesInTheQueue).toHaveBeenCalledWith(null);
});
}));
fixture.detectChanges(); it('should not upload a file if fileType is not in acceptedFilesType', async(() => {
spyOn(uploadService, 'uploadFilesInTheQueue'); component.success = null;
component.acceptedFilesType = '.pdf';
fixture.detectChanges();
spyOn(uploadService, 'uploadFilesInTheQueue');
let itemEntity = { let itemEntity = {
fullPath: '/folder-fake/file-fake.png', fullPath: '/folder-fake/file-fake.png',
isDirectory: false, isDirectory: false,
isFile: true, isFile: true,
name: 'file-fake.png', name: 'file-fake.png',
file: (callbackFile) => { file: (callbackFile) => {
let fileFake = new File(['fakefake'], 'file-fake.png', { type: 'image/png' }); let fileFake = new File(['fakefake'], 'file-fake.png', {type: 'image/png'});
callbackFile(fileFake); callbackFile(fileFake);
} }
}; };
fixture.whenStable().then(() => {
component.onFilesEntityDropped(itemEntity);
expect(uploadService.uploadFilesInTheQueue).not.toHaveBeenCalledWith(null);
});
}));
component.onFilesEntityDropped(itemEntity); it('should upload a file with a custom root folder ID when dropped', async(() => {
expect(uploadService.uploadFilesInTheQueue).toHaveBeenCalledWith(null); component.success = null;
}); fixture.detectChanges();
spyOn(uploadService, 'uploadFilesInTheQueue');
it('should upload a file with a custom root folder ID when dropped', () => { let itemEntity = {
component.success = null; fullPath: '/folder-fake/file-fake.png',
isDirectory: false,
isFile: true,
name: 'file-fake.png',
file: (callbackFile) => {
let fileFake = new File(['fakefake'], 'file-fake.png', {type: 'image/png'});
callbackFile(fileFake);
}
};
component.onFilesEntityDropped(itemEntity);
expect(uploadService.uploadFilesInTheQueue).toHaveBeenCalledWith(null);
}));
fixture.detectChanges(); it('should upload a file when user has create permission on target folder', async(() => {
spyOn(uploadService, 'uploadFilesInTheQueue');
let itemEntity = {
fullPath: '/folder-fake/file-fake.png',
isDirectory: false,
isFile: true,
name: 'file-fake.png',
file: (callbackFile) => {
let fileFake = new File(['fakefake'], 'file-fake.png', { type: 'image/png' });
callbackFile(fileFake);
}
};
component.onFilesEntityDropped(itemEntity);
expect(uploadService.uploadFilesInTheQueue).toHaveBeenCalledWith(null);
});
it('should upload a file when user has create permission on target folder', async(() => {
let fakeItem = { let fakeItem = {
fullPath: '/folder-fake/file-fake.png', fullPath: '/folder-fake/file-fake.png',
isDirectory: false, isDirectory: false,
@@ -248,22 +294,16 @@ describe('UploadDragAreaComponent', () => {
} }
}; };
fixture.detectChanges();
spyOn(uploadService, 'uploadFilesInTheQueue').and.returnValue(Promise.resolve(fakeItem));
component.success.subscribe((val) => {
expect(val).not.toBeNull();
});
let fakeCustomEvent: CustomEvent = new CustomEvent('CustomEvent', { let fakeCustomEvent: CustomEvent = new CustomEvent('CustomEvent', {
detail: { detail: {
data: getFakeShareDataRow(), data: getFakeShareDataRow(),
files: [fakeItem] files: [fakeItem]
} }
}); });
component.onUploadFiles(fakeCustomEvent); component.onUploadFiles(fakeCustomEvent);
})); }));
});
describe('Events', () => { describe('Events', () => {
it('should raise an error if upload a file goes wrong', (done) => { it('should raise an error if upload a file goes wrong', (done) => {
let fakeItem = { let fakeItem = {

View File

@@ -26,6 +26,7 @@ import {
UploadService UploadService
} from '@alfresco/adf-core'; } from '@alfresco/adf-core';
import { Component, EventEmitter, forwardRef, Input, Output, ViewEncapsulation } from '@angular/core'; import { Component, EventEmitter, forwardRef, Input, Output, ViewEncapsulation } from '@angular/core';
import { UploadBase } from './base-upload/upload-base';
@Component({ @Component({
selector: 'adf-upload-drag-area', selector: 'adf-upload-drag-area',
@@ -36,7 +37,7 @@ import { Component, EventEmitter, forwardRef, Input, Output, ViewEncapsulation }
], ],
encapsulation: ViewEncapsulation.None encapsulation: ViewEncapsulation.None
}) })
export class UploadDragAreaComponent implements NodePermissionSubject { export class UploadDragAreaComponent extends UploadBase implements NodePermissionSubject {
/** Toggle component disabled state. */ /** Toggle component disabled state. */
@Input() @Input()
@@ -63,6 +64,7 @@ export class UploadDragAreaComponent implements NodePermissionSubject {
constructor(private uploadService: UploadService, constructor(private uploadService: UploadService,
private translateService: TranslationService, private translateService: TranslationService,
private notificationService: NotificationService) { private notificationService: NotificationService) {
super();
} }
/** /**
@@ -76,9 +78,8 @@ export class UploadDragAreaComponent implements NodePermissionSubject {
newVersion: this.versioning, newVersion: this.versioning,
path: '/', path: '/',
parentId: this.parentId parentId: this.parentId
})); })).filter(this.isFileAcceptable.bind(this));
this.uploadService.addToQueue(...fileModels); this.addNodeInUploadQueue(fileModels);
this.uploadService.uploadFilesInTheQueue(this.success);
} }
} }
@@ -95,8 +96,9 @@ export class UploadDragAreaComponent implements NodePermissionSubject {
parentId: this.parentId, parentId: this.parentId,
path: item.fullPath.replace(item.name, '') path: item.fullPath.replace(item.name, '')
}); });
if (this.isFileAcceptable(fileModel)) {
this.addNodeInUploadQueue([fileModel]); this.addNodeInUploadQueue([fileModel]);
}
}); });
} }
} }
@@ -115,8 +117,7 @@ export class UploadDragAreaComponent implements NodePermissionSubject {
parentId: this.parentId, parentId: this.parentId,
path: entry.relativeFolder path: entry.relativeFolder
}); });
}); }).filter(this.isFileAcceptable.bind(this));
this.addNodeInUploadQueue(files); this.addNodeInUploadQueue(files);
}); });
} }
@@ -128,7 +129,7 @@ export class UploadDragAreaComponent implements NodePermissionSubject {
this.uploadService.uploadFilesInTheQueue(this.success); this.uploadService.uploadFilesInTheQueue(this.success);
this.uploadService.fileUploadError.subscribe((error) => { this.uploadService.fileUploadError.subscribe((error) => {
this.error.emit(error); this.error.emit(error);
}); });
} }
} }
@@ -172,7 +173,7 @@ export class UploadDragAreaComponent implements NodePermissionSubject {
newVersion: this.versioning, newVersion: this.versioning,
path: fileInfo.relativeFolder, path: fileInfo.relativeFolder,
parentId: parentId parentId: parentId
})); })).filter(this.isFileAcceptable.bind(this));
this.addNodeInUploadQueue(fileModels); this.addNodeInUploadQueue(fileModels);
} }
} }

View File

@@ -23,3 +23,5 @@ export * from './components/file-uploading-list.component';
export * from './components/file-uploading-list-row.component'; export * from './components/file-uploading-list-row.component';
export * from './directives/file-draggable.directive'; export * from './directives/file-draggable.directive';
export * from './components/base-upload/upload-base';