mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-06-02 17:35:08 +00:00
* refactor version 1 many todo
* split render from viewer
move alfresco render in content pack
* refactor part 2
* test fixed
* fix doc
* [AAE-10778] Fix lint issues
* [AAE-10778] Fix lint issue: remove duplicated declaration
* [AAE-10778] Fix lint issue: use flex shorthand rule
* [AAE-10778] Fix FormService and WidgetComponent imports
* [AAE-10778] Fix import FormModel, FormService, FormFieldModel from adf-core
* [AAE-10778] Implement missing oninit, onchanges and ondestroy
* [AAE-10778] Replace adf-viewer with adf-alfresco-viewer, update escape command to close the viewer
* [AAE-10778] Fix unit test: fix the class name to match the 'adf-viewer-render.image-viewer-scaling' get from the appConfigService
* [AAE-10778] Fix image-viewer unit tests: replace ContentService with UrlService
* [AAE-10778] Fix unit test 'should if the extension change extension Change event be fired': emit file extension when the filename extension change
* [AAE-10778] Fix unit test: expect for internalFileName value instead of display-name id because the display name logic has been moved to the alfresco-viewer.component
* [AAE-10778] Fix unit test: remove display name it because the unknown display name value is no longer handled after refactoring
* [AAE-10778] Fix e2e: [C260096] Should the Viewer able to accept a customToolbar
* [AAE-10778] Update selector to fix e2e: '[C362265] Should the Viewer be able to download a previous version of a file'
* [AAE-10778] Update selector to fix e2e: '[C260038] Should display first page, toolbar and pagination when opening a .pdf file'
* fix aftrer rebase
* fix unit test
* [AAE-10778] Add adf viewer component that is node agnostic, show adf-alfresco-viewer or adf-viewer into file-view-component if blob or node are set
* [AAE-10778] Update viewer export path
* [AAE-10778] Update selectors since have been updated in the viewer component
* [AAE-10778] Call adf-viewer from alfresco-viewer, project adf-alfresco-viewer content to adf-viewer
* [AAE-10778] Remove full screen unit tests from alfresco-viewer component becase that logic is handled in the viewer.component
* [AAE-10778] Export toolbar custom actions component
* [AAE-10778] Pass mimeType as input to adf-viewer to update mime icon
* [AAE-10778] Remove e2e because the custom name behaviour has been removed from the file-view.component (9f21b6dc69
\#diff-4b438dc59784dce9eb7634cfeca6d8db61362966343bd3d6895a3edafdf4cfd5L129)
* [AAE-10778] Use two-way binding for showViewer change to fix C260100
* [AAE-10778] Update prefix css selectors to adf-viewer because are related to the adf-viewer component
* [AAE-10778] Update prefix css selectors to adf-viewer in the unit tests because are related to the adf-viewer component
* [AAE-10778] Update the output name to showViewerChange to navigate to primary url after closing the viewer
* [AAE-10778] Pass right and left sidebar template context to viewer component (fix C362242)
* [AAE-10778] Add allowFullScreen input to disable/enable full screen behaviour
* [AAE-10778] Handle loading visualization only inside the viewer-render component
* [AAE-10778] PDF viewer: fix mat-progress-bar is not showed during the pdf loading, center progress bar
* [AAE-10778] Remove isLoading from unit tests because no longer exists
* [AAE-10778] Remove viewerType input from adf-viewer, viewerType will be handled by viewer-render
* [AAE-10778] Remove console.log
* [AAE-10778] Remove check full screen button is not displayed on the media file because is not needed anymore, we don't need to check for the fullscreen button in the viewer component
* [AAE-10778] Check for node rendtion before to assign to urlFileContent and mimeType
* [AAE-10778] Process Services Cloud: register file-viewer widget that uses adf-alfresco-viewer component to display content from ACS
* [AAE-10778] Core: rename file-viewer widget into base-viewer, base-viewer no longer accept nodeId, but will accept urlFile and blobFile
* [AAE-10778] Process Services: register file-viewer widget that uses adf-alfresco-viewer component to display content from ACS
* [AAE-10778] Base viewer widget: show viewer only if there's a file input
* [AAE-10778] Viewer component: check for fileName when urlFile is provided as Input
* [AAE-10778] Viewer component documentation
* [AAE-10778] Update upgrade guide with viewer changes
* [AAE-10778] Fix double quote lint issue after rebase
---------
Co-authored-by: Amedeo Lepore <amedeo.lepore@hyland.com>
Co-authored-by: Amedeo Lepore <amedeo.lepore85@gmail.com>
452 lines
14 KiB
TypeScript
452 lines
14 KiB
TypeScript
/*!
|
|
* @license
|
|
* Copyright 2019 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 {
|
|
ChangeDetectorRef,
|
|
Component,
|
|
ContentChild,
|
|
EventEmitter,
|
|
Input,
|
|
OnChanges,
|
|
OnDestroy,
|
|
OnInit,
|
|
Output,
|
|
TemplateRef,
|
|
ViewChild,
|
|
ViewEncapsulation
|
|
} from '@angular/core';
|
|
import {
|
|
AlfrescoApiService, ContentService,
|
|
FileModel,
|
|
LogService,
|
|
NodesApiService,
|
|
Track,
|
|
UploadService,
|
|
ViewerComponent,
|
|
ViewerMoreActionsComponent,
|
|
ViewerOpenWithComponent,
|
|
ViewerSidebarComponent,
|
|
ViewerToolbarActionsComponent,
|
|
ViewerToolbarComponent,
|
|
ViewUtilService
|
|
} from '@alfresco/adf-core';
|
|
import { Subject } from 'rxjs';
|
|
import {
|
|
ContentApi,
|
|
Node,
|
|
NodeEntry,
|
|
NodesApi,
|
|
RenditionEntry,
|
|
SharedlinksApi,
|
|
Version,
|
|
VersionEntry,
|
|
VersionsApi
|
|
} from '@alfresco/js-api';
|
|
import { RenditionViewerService } from '../services/rendition-viewer.service';
|
|
import { MatDialog } from '@angular/material/dialog';
|
|
import { filter, takeUntil } from 'rxjs/operators';
|
|
|
|
@Component({
|
|
selector: 'adf-alfresco-viewer',
|
|
templateUrl: './alfresco-viewer.component.html',
|
|
styleUrls: ['./alfresco-viewer.component.scss'],
|
|
host: {class: 'adf-alfresco-viewer'},
|
|
encapsulation: ViewEncapsulation.None,
|
|
providers: [ViewUtilService]
|
|
})
|
|
export class AlfrescoViewerComponent implements OnChanges, OnInit, OnDestroy {
|
|
|
|
@ViewChild('adfViewer')
|
|
adfViewer: ViewerComponent<{node: Node}>;
|
|
|
|
@ContentChild(ViewerToolbarComponent)
|
|
toolbar: ViewerToolbarComponent;
|
|
|
|
@ContentChild(ViewerSidebarComponent)
|
|
sidebar: ViewerSidebarComponent;
|
|
|
|
@ContentChild(ViewerToolbarActionsComponent)
|
|
toolbarActions: ViewerToolbarActionsComponent;
|
|
|
|
@ContentChild(ViewerMoreActionsComponent)
|
|
moreActions: ViewerMoreActionsComponent;
|
|
|
|
@ContentChild(ViewerOpenWithComponent)
|
|
openWith: ViewerOpenWithComponent;
|
|
|
|
/** Node Id of the file to load. */
|
|
@Input()
|
|
nodeId: string = null;
|
|
|
|
/** Version Id of the file to load. */
|
|
@Input()
|
|
versionId: string = null;
|
|
|
|
/** Shared link id (to display shared file). */
|
|
@Input()
|
|
sharedLinkId: string = null;
|
|
|
|
/** Hide or show the viewer */
|
|
@Input()
|
|
showViewer = true;
|
|
|
|
/** Number of times the Viewer will retry fetching content Rendition.
|
|
* There is a delay of at least one second between attempts.
|
|
*/
|
|
@Input()
|
|
maxRetries = 30;
|
|
|
|
/** Allows `back` navigation */
|
|
@Input()
|
|
allowGoBack = true;
|
|
|
|
/** Hide or show the toolbar */
|
|
@Input()
|
|
showToolbar = true;
|
|
|
|
/** If `true` then show the Viewer as a full page over the current content.
|
|
* Otherwise fit inside the parent div.
|
|
*/
|
|
@Input()
|
|
overlayMode = false;
|
|
|
|
/** Toggles before/next navigation. You can use the arrow buttons to navigate
|
|
* between documents in the collection.
|
|
*/
|
|
@Input()
|
|
allowNavigate = false;
|
|
|
|
/** Toggles the "before" ("<") button. Requires `allowNavigate` to be enabled. */
|
|
@Input()
|
|
canNavigateBefore = true;
|
|
|
|
/** Toggles the next (">") button. Requires `allowNavigate` to be enabled. */
|
|
@Input()
|
|
canNavigateNext = true;
|
|
|
|
/** Allow the left the sidebar. */
|
|
@Input()
|
|
allowLeftSidebar = false;
|
|
|
|
/** Allow the right sidebar. */
|
|
@Input()
|
|
allowRightSidebar = false;
|
|
|
|
/** Toggles right sidebar visibility. Requires `allowRightSidebar` to be set to `true`. */
|
|
@Input()
|
|
showRightSidebar = false;
|
|
|
|
/** Toggles left sidebar visibility. Requires `allowLeftSidebar` to be set to `true`. */
|
|
@Input()
|
|
showLeftSidebar = false;
|
|
|
|
/** Toggles downloading. */
|
|
@Input()
|
|
allowDownload = true;
|
|
|
|
/** Toggles printing. */
|
|
@Input()
|
|
allowPrint = false;
|
|
|
|
/** Toggles the 'Full Screen' feature. */
|
|
@Input()
|
|
allowFullScreen = true;
|
|
|
|
/** The template for the right sidebar. The template context contains the loaded node data. */
|
|
@Input()
|
|
sidebarRightTemplate: TemplateRef<any> = null;
|
|
|
|
/** The template for the left sidebar. The template context contains the loaded node data. */
|
|
@Input()
|
|
sidebarLeftTemplate: TemplateRef<any> = null;
|
|
|
|
/** Emitted when the shared link used is not valid. */
|
|
@Output()
|
|
invalidSharedLink = new EventEmitter();
|
|
|
|
/** Emitted when user clicks 'Navigate Before' ("<") button. */
|
|
@Output()
|
|
navigateBefore = new EventEmitter<MouseEvent | KeyboardEvent>();
|
|
|
|
/** Emitted when user clicks 'Navigate Next' (">") button. */
|
|
@Output()
|
|
navigateNext = new EventEmitter<MouseEvent | KeyboardEvent>();
|
|
|
|
/** Emitted when the viewer close */
|
|
@Output()
|
|
showViewerChange = new EventEmitter<boolean>();
|
|
|
|
private onDestroy$ = new Subject<boolean>();
|
|
|
|
private cacheBusterNumber: number;
|
|
|
|
versionEntry: VersionEntry;
|
|
urlFileContent: string;
|
|
fileName: string;
|
|
mimeType: string;
|
|
nodeEntry: NodeEntry;
|
|
tracks: Track[] = [];
|
|
readOnly: boolean = true;
|
|
|
|
sidebarRightTemplateContext: { node: Node } = {node: null};
|
|
sidebarLeftTemplateContext: { node: Node } = {node: null};
|
|
|
|
_sharedLinksApi: SharedlinksApi;
|
|
get sharedLinksApi(): SharedlinksApi {
|
|
this._sharedLinksApi = this._sharedLinksApi ?? new SharedlinksApi(this.apiService.getInstance());
|
|
return this._sharedLinksApi;
|
|
}
|
|
|
|
_versionsApi: VersionsApi;
|
|
get versionsApi(): VersionsApi {
|
|
this._versionsApi = this._versionsApi ?? new VersionsApi(this.apiService.getInstance());
|
|
return this._versionsApi;
|
|
}
|
|
|
|
_nodesApi: NodesApi;
|
|
get nodesApi(): NodesApi {
|
|
this._nodesApi = this._nodesApi ?? new NodesApi(this.apiService.getInstance());
|
|
return this._nodesApi;
|
|
}
|
|
|
|
_contentApi: ContentApi;
|
|
get contentApi(): ContentApi {
|
|
this._contentApi = this._contentApi ?? new ContentApi(this.apiService.getInstance());
|
|
return this._contentApi;
|
|
}
|
|
|
|
constructor(private apiService: AlfrescoApiService,
|
|
private nodesApiService: NodesApiService,
|
|
private renditionViewerService: RenditionViewerService,
|
|
private viewUtilService: ViewUtilService,
|
|
private logService: LogService,
|
|
private contentService: ContentService,
|
|
private uploadService: UploadService,
|
|
public dialog: MatDialog,
|
|
private cdr: ChangeDetectorRef) {
|
|
renditionViewerService.maxRetries = this.maxRetries;
|
|
|
|
}
|
|
|
|
ngOnInit() {
|
|
this.nodesApiService.nodeUpdated.pipe(
|
|
filter((node) => node && node.id === this.nodeId &&
|
|
(node.name !== this.fileName ||
|
|
this.getNodeVersionProperty(this.nodeEntry.entry) !== this.getNodeVersionProperty(node))),
|
|
takeUntil(this.onDestroy$)
|
|
).subscribe((node) => this.onNodeUpdated(node));
|
|
}
|
|
|
|
private async onNodeUpdated(node: Node) {
|
|
if (node && node.id === this.nodeId) {
|
|
this.generateCacheBusterNumber();
|
|
|
|
await this.setUpNodeFile(node);
|
|
}
|
|
}
|
|
|
|
private getNodeVersionProperty(node: Node): string {
|
|
return node?.properties['cm:versionLabel'] ?? '';
|
|
}
|
|
|
|
private async setupSharedLink() {
|
|
this.allowGoBack = false;
|
|
|
|
try {
|
|
const sharedLinkEntry = await this.sharedLinksApi.getSharedLink(this.sharedLinkId);
|
|
await this.setUpSharedLinkFile(sharedLinkEntry);
|
|
} catch (error) {
|
|
this.logService.error('This sharedLink does not exist');
|
|
this.invalidSharedLink.next();
|
|
this.mimeType = 'invalid-link';
|
|
this.urlFileContent = 'invalid-file';
|
|
}
|
|
}
|
|
|
|
private async setupNode() {
|
|
try {
|
|
this.nodeEntry = await this.nodesApi.getNode(this.nodeId, {include: ['allowableOperations']});
|
|
if (this.versionId) {
|
|
this.versionEntry = await this.versionsApi.getVersion(this.nodeId, this.versionId);
|
|
await this.setUpNodeFile(this.nodeEntry.entry, this.versionEntry.entry);
|
|
} else {
|
|
await this.setUpNodeFile(this.nodeEntry.entry);
|
|
this.cdr.detectChanges();
|
|
}
|
|
} catch (error) {
|
|
this.urlFileContent = 'invalid-node';
|
|
this.logService.error('This node does not exist');
|
|
}
|
|
}
|
|
|
|
private async setUpNodeFile(nodeData: Node, versionData?: Version): Promise<void> {
|
|
|
|
this.readOnly = !this.contentService.hasAllowableOperations(nodeData, 'update');
|
|
let mimeType;
|
|
let urlFileContent;
|
|
|
|
if (versionData && versionData.content) {
|
|
mimeType = versionData.content.mimeType;
|
|
} else if (nodeData.content) {
|
|
mimeType = nodeData.content.mimeType;
|
|
}
|
|
|
|
const currentFileVersion = this.nodeEntry?.entry?.properties && this.nodeEntry.entry.properties['cm:versionLabel'] ?
|
|
encodeURI(this.nodeEntry?.entry?.properties['cm:versionLabel']) : encodeURI('1.0');
|
|
|
|
urlFileContent = versionData ? this.contentApi.getVersionContentUrl(this.nodeId, versionData.id) :
|
|
this.contentApi.getContentUrl(this.nodeId);
|
|
urlFileContent = this.cacheBusterNumber ? urlFileContent + '&' + currentFileVersion + '&' + this.cacheBusterNumber :
|
|
urlFileContent + '&' + currentFileVersion;
|
|
|
|
const fileExtension = this.viewUtilService.getFileExtension(versionData ? versionData.name : nodeData.name);
|
|
this.fileName = versionData ? versionData.name : nodeData.name;
|
|
const viewerType = this.viewUtilService.getViewerType(fileExtension, mimeType);
|
|
|
|
if (viewerType === 'unknown') {
|
|
let nodeRendition;
|
|
if (versionData) {
|
|
nodeRendition = await this.renditionViewerService.getNodeRendition(nodeData.id, versionData.id);
|
|
} else {
|
|
nodeRendition = await this.renditionViewerService.getNodeRendition(nodeData.id);
|
|
}
|
|
if(nodeRendition){
|
|
urlFileContent = nodeRendition.url;
|
|
mimeType = nodeRendition.mimeType;
|
|
}
|
|
} else if (viewerType === 'media') {
|
|
this.tracks = await this.renditionViewerService.generateMediaTracksRendition(this.nodeId);
|
|
}
|
|
|
|
this.mimeType = mimeType;
|
|
this.urlFileContent = urlFileContent;
|
|
this.sidebarRightTemplateContext.node = nodeData;
|
|
this.sidebarLeftTemplateContext.node = nodeData;
|
|
}
|
|
|
|
private async setUpSharedLinkFile(details: any) {
|
|
let mimeType = details.entry.content.mimeType;
|
|
const fileExtension = this.viewUtilService.getFileExtension(details.entry.name);
|
|
this.fileName = details.entry.name;
|
|
let urlFileContent = this.contentApi.getSharedLinkContentUrl(this.sharedLinkId, false);
|
|
const viewerType = this.viewUtilService.getViewerType(fileExtension, mimeType);
|
|
|
|
if (viewerType === 'unknown') {
|
|
({
|
|
url: urlFileContent,
|
|
mimeType
|
|
} = await this.getSharedLinkRendition(this.sharedLinkId));
|
|
}
|
|
this.mimeType = mimeType;
|
|
this.urlFileContent = urlFileContent;
|
|
}
|
|
|
|
private async getSharedLinkRendition(sharedId: string): Promise<{ url: string; mimeType: string }> {
|
|
try {
|
|
const rendition: RenditionEntry = await this.sharedLinksApi.getSharedLinkRendition(sharedId, 'pdf');
|
|
if (rendition.entry.status.toString() === 'CREATED') {
|
|
const urlFileContent = this.contentApi.getSharedLinkRenditionUrl(sharedId, 'pdf');
|
|
return {url: urlFileContent, mimeType: 'application/pdf'};
|
|
}
|
|
} catch (error) {
|
|
this.logService.error(error);
|
|
try {
|
|
const rendition: RenditionEntry = await this.sharedLinksApi.getSharedLinkRendition(sharedId, 'imgpreview');
|
|
if (rendition.entry.status.toString() === 'CREATED') {
|
|
const urlFileContent = this.contentApi.getSharedLinkRenditionUrl(sharedId, 'imgpreview');
|
|
return {url: urlFileContent, mimeType: 'image/png'};
|
|
|
|
}
|
|
} catch (renditionError) {
|
|
this.logService.error(renditionError);
|
|
return null;
|
|
}
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
private generateCacheBusterNumber() {
|
|
this.cacheBusterNumber = Date.now();
|
|
}
|
|
|
|
/**
|
|
* close the viewer
|
|
*/
|
|
onClose() {
|
|
this.showViewerChange.emit(this.showViewer);
|
|
}
|
|
|
|
onPrintContent(event: MouseEvent) {
|
|
if (this.allowPrint) {
|
|
if (!event.defaultPrevented) {
|
|
this.renditionViewerService.printFileGeneric(this.nodeId, this.mimeType);
|
|
}
|
|
}
|
|
}
|
|
|
|
onSubmitFile(newImageBlob: Blob) {
|
|
if (this?.nodeEntry?.entry?.id && !this.readOnly) {
|
|
const newImageFile: File = new File([newImageBlob], this?.nodeEntry?.entry?.name, {type: this?.nodeEntry?.entry?.content?.mimeType});
|
|
const newFile = new FileModel(
|
|
newImageFile,
|
|
{
|
|
majorVersion: false,
|
|
newVersion: true,
|
|
parentId: this?.nodeEntry?.entry?.parentId,
|
|
nodeType: this?.nodeEntry?.entry?.content?.mimeType
|
|
},
|
|
this?.nodeEntry?.entry?.id
|
|
);
|
|
this.uploadService.addToQueue(...[newFile]);
|
|
this.uploadService.uploadFilesInTheQueue();
|
|
}
|
|
}
|
|
|
|
onNavigateBeforeClick(event: MouseEvent | KeyboardEvent) {
|
|
this.navigateBefore.next(event);
|
|
}
|
|
|
|
onNavigateNextClick(event: MouseEvent | KeyboardEvent) {
|
|
this.navigateNext.next(event);
|
|
}
|
|
|
|
isSourceDefined(): boolean {
|
|
return !!(this.nodeId || this.sharedLinkId);
|
|
}
|
|
|
|
ngOnChanges() {
|
|
if (this.showViewer) {
|
|
if (!this.isSourceDefined()) {
|
|
throw new Error('A content source attribute value is missing.');
|
|
}
|
|
|
|
if (this.nodeId) {
|
|
this.setupNode();
|
|
} else if (this.sharedLinkId) {
|
|
this.setupSharedLink();
|
|
}
|
|
}
|
|
}
|
|
|
|
ngOnDestroy() {
|
|
this.onDestroy$.next(true);
|
|
this.onDestroy$.complete();
|
|
}
|
|
|
|
}
|