@sapui5/sap.ui.export 1.94.0 → 1.97.0

package/src/sap/ui/export/PortableDocument.js

@@ -0,0 +1,371 @@
+/*!
+ * SAPUI5
+ * (c) Copyright 2009-2021 SAP SE. All rights reserved.
+ */
+
+sap.ui.define([
+	'sap/base/Log',
+	'sap/ui/core/Core',
+	'sap/ui/export/ExportBase',
+	'sap/ui/export/ExportUtils',
+	'sap/ui/model/odata/v4/ODataModel'
+], function(Log, Core, ExportBase, ExportUtils, ODataModel) {
+	'use strict';
+
+	/**
+	 * @constructor The <code>sap.ui.export.PortableDocument</code> class allows you to export table data from a UI5 application to a Portable Document Format (*.PDF) file.
+	 *
+	 * @author SAP SE
+	 * @version 1.97.0
+	 *
+	 * @since 1.96
+	 * @name sap.ui.export.PortableDocument
+	 * @extends sap.ui.base.ExportBase
+	 * @private
+	 */
+	var PortableDocument = ExportBase.extend('sap.ui.export.PortableDocument', {
+
+		constructor: function(mSettings) {
+			ExportBase.call(this, mSettings);
+		}
+	});
+
+	/**
+	 * Sets the data source configuration that will be used for exporting the data. If the passed parameter is null,
+	 * the call will be ignored.
+	 *
+	 * @param {Object|sap.ui.model.ListBinding|sap.ui.model.TreeBinding} oDataSource Possible types are a data
+	 * source configuration, a <code>sap.ui.model.ListBinding</code> or <code>sap.ui.model.TreeBinding</code>
+	 * @returns {Object|null} - Valid dataSource object or null in case the dataSource configuration is not supported
+	 *
+	 * @since 1.96
+	 * @public
+	 */
+	PortableDocument.prototype.processDataSource = function(oDataSource) {
+		var mDataSource = null;
+		var sDataSourceType = typeof oDataSource;
+
+		if (!oDataSource) {
+			return null;
+		}
+
+		if (sDataSourceType != 'object') {
+			Log.error('Spreadsheet#processDataSource: Unable to apply data source of type ' + sDataSourceType);
+
+			return null;
+		}
+
+		if (oDataSource.dataUrl && oDataSource.serviceUrl) {
+			mDataSource = oDataSource;
+		}
+
+		if (oDataSource.isA && oDataSource.isA(['sap.ui.model.ListBinding', 'sap.ui.model.TreeBinding'])) {
+			mDataSource = this.createDataSourceFromBinding(oDataSource);
+		}
+
+		return mDataSource;
+	};
+
+	/**
+	 * Creates a valid dataSource configuration
+	 *
+	 * @param {sap.ui.model.ListBinding|sap.ui.model.TreeBinding} oBinding - A subclass of <code>sap.ui.model.ListBinding</code> or <code>sap.ui.model.TreeBinding</code>
+	 * @returns {Object} - Valid data source configuration built upon the ListBinding
+	 */
+	 PortableDocument.prototype.createDataSourceFromBinding = function(oBinding) {
+
+		/**
+		 * Use empty array as default in case of <code>ListBinding</code> is not of type
+		 * ClientListBinding and does not provide a getDownloadUrl function
+		 */
+		var oDataSource = null;
+
+		/**
+		 * If <code>ClientListBinding</code>, we use the binding path to receive the data from the underlying model
+		 */
+		if (oBinding.isA('sap.ui.model.ClientListBinding')) {
+			Log.error('Unable to create dataSource configuration due to not supported Binding: ' + oBinding.getMetadata().getName());
+		}
+
+		if (oBinding.isA('sap.ui.model.ClientTreeBinding')) {
+			Log.error('Unable to create dataSource configuration due to not supported Binding: ' + oBinding.getMetadata().getName());
+		}
+
+		/**
+		 * All other <code>Bindings</code> need to provide a downloadUrl
+		 */
+		if (typeof oBinding.getDownloadUrl === 'function') {
+			var oModel = oBinding.getModel(),
+				sDataUrl = ExportUtils.interceptUrl(oBinding.getDownloadUrl('pdf')),
+				sServiceUrl = ExportUtils.interceptUrl(oModel.sServiceUrl),
+				bV4ODataModel = oModel.isA('sap.ui.model.odata.v4.ODataModel');
+
+			var oDataUrl = new URL(sDataUrl, document.baseURI);
+			oDataUrl.hash = '';
+
+			// Reference the Model for later use
+			this._oModel = oModel;
+			this._oModel.setUseBatch(false);
+
+			/* Remove $format system query option because it would overwrite the "Accept" header */
+			oDataUrl.search = oDataUrl.search.split('&').filter(function(val) {
+				return val.indexOf('$format') == -1;
+			}).join('&');
+
+			oDataSource = {
+				type: 'odata',
+				version: bV4ODataModel ? 4 : 2,
+				dataUrl: oDataUrl.toString(),
+				serviceUrl: sServiceUrl.split('/').slice(0, -5).join('/') + '/default/iwbep/common/0001/', // Requires the serviceUrl to end with a /
+				headers: bV4ODataModel ?  oModel.getHttpHeaders(true) : oModel.getHeaders()
+			};
+		}
+
+		return oDataSource;
+	};
+
+	/**
+	 * Creates the DocumentDescription based on the given export
+	 * settings and assigns a unique Id to it.
+	 *
+	 * @param {Object} oWorkbook Workbook settings of the export configuration
+	 * @returns {Object} DocumentDescription object that contains all relevant export settings
+	 * @private
+	 */
+	PortableDocument.prototype._createDocumentDescription = function(oWorkbook) {
+		var oDocumentDescription, oMetaInfo;
+
+		oDocumentDescription = {
+			"Title": oWorkbook.context.title,
+			"Format": {
+				"PaperSize": "DIN_A4",
+				"Orientation": "LANDSCAPE",
+				"FontSize": 12
+			},
+			"Signature": {
+				"DoSign": true,
+				"Reason": ""
+			},
+			"CoverPage": [],
+			"TableColumns": []
+		};
+
+		oMetaInfo = oWorkbook.context.metaInfo;
+
+		/* Add metaInfo to CoverPage */
+		if (oMetaInfo instanceof Array) {
+			oMetaInfo.forEach(function(oGroup) {
+				var oCoverPageGroup = {
+					"Title": oGroup.name,
+					"Content": []
+				};
+
+				oGroup.items.forEach(function(oItem) {
+					oCoverPageGroup["Content"].push({
+						"Name": oItem.key,
+						"Value": oItem.value
+					});
+				});
+				oDocumentDescription["CoverPage"].push(oCoverPageGroup);
+			});
+		}
+
+		/* Add columns */
+		oWorkbook.columns.forEach(function(oColumn){
+			oDocumentDescription["TableColumns"].push({
+				"Name": Array.isArray(oColumn.property) ? oColumn.property[0] : oColumn.property,
+				"Header": oColumn.label
+			});
+		});
+
+		return oDocumentDescription;
+	};
+
+	/**
+	 * Returns the name of the EntitySet that is being used with the given OData version.
+	 *
+	 * @param {Object} mDataSource DataSource object containing information about OData version
+	 * @returns {string} Name of the EntitySet according to the OData version
+	 */
+	PortableDocument.prototype._getEntitySetName = function(mDataSource) {
+		var version = mDataSource && mDataSource.version || 2; // Use OData V2 by default
+
+		return version == 4 ? 'MyDocumentDescriptions' : 'SAP__MyDocumentDescriptions';
+	};
+
+	/**
+	 * Returns the specific ODataModel that is being used for binding to the DocumentDescription EntitySet
+	 *
+	 * @param {Object} oDataSource DataSource settings of the export configuration
+	 * @returns {ODataModel} ODataModel, either V2 or V4.
+	 */
+	PortableDocument.prototype._getModel = function(oDataSource) {
+		var version = oDataSource.version || 2;
+
+		return version === 4 ? new ODataModel({
+			serviceUrl: oDataSource.serviceUrl,
+			synchronizationMode: 'None'
+		}) : this._oModel;
+	};
+
+	/**
+	 * Applies default settings to the export configuration.
+	 *
+	 * @param {Object} mSettings Export configuration object
+	 * @returns {Promise} Promise that gets resolved when the default settings have been applied
+	 */
+	PortableDocument.prototype.setDefaultExportSettings = function(mSettings) {
+		var oContext = mSettings && mSettings.workbook && mSettings.workbook.context;
+
+		if (!(oContext instanceof Object)) {
+			oContext = mSettings.workbook.context = {};
+		}
+
+		if (typeof oContext.title === 'string') {
+			return Promise.resolve();
+		}
+
+		return Core.getLibraryResourceBundle('sap.ui.export', true).then(function(oResourceBundle) {
+			oContext.title = oResourceBundle.getText('XLSX_DEFAULT_TITLE');
+		});
+	};
+
+	/**
+	 * Sends a POST request to the GW service which creates the
+	 * DocumentDescription. The corresponding Id is assigned by
+	 * the backend and passed to the event handler functions.
+	 *
+	 * @param {Object} oDocumentDescription DocumentDescription instance that is being created
+	 * @param {Object} oDataSource DataSource settings of the export configuration
+	 * @param {function} fnSuccess Success handler function
+	 * @param {function} fnError Error handler function
+	 */
+	PortableDocument.prototype.postDocumentDescription = function(oDocumentDescription, oDataSource, fnSuccess, fnError) {
+		var oBinding, oModel, sPath;
+
+		oModel = this._getModel(oDataSource);
+		sPath = '/' + this._getEntitySetName(oDataSource);
+
+		if (!oModel || !oModel.isA(['sap.ui.model.odata.v4.ODataModel', 'sap.ui.model.odata.v2.ODataModel'])) {
+			fnError('Unsupported Model');
+		}
+
+		if (oModel.isA('sap.ui.model.odata.v4.ODataModel')) {
+			oBinding = oModel.bindList(sPath);
+
+			oBinding.attachCreateCompleted(function(oEvent) {
+				var success = oEvent.getParameter('success');
+
+				if (success) {
+					fnSuccess(oEvent.getParameter('context').getObject()['Id']);
+				} else {
+					fnError();
+				}
+			});
+
+			oBinding.create(oDocumentDescription);
+		} else {
+			oModel.create(sPath, oDocumentDescription, {
+				success: function(oData) {
+					fnSuccess(oData['Id']);
+				},
+				error: fnError
+			});
+		}
+	};
+
+	/**
+	 * Triggers the export process and returns a Promise the
+	 * gets resolved as soon as the export is finished.
+	 *
+	 * @param {Object} mSettings Export settings
+	 * @returns {Promise} Promise that is being resolved as soon as the PDF export is finished
+	 */
+	PortableDocument.prototype.createBuildPromise = function(mSettings) {
+		var that = this;
+
+		return new Promise(function(fnResolve, fnReject) {
+			var oDocumentDescription;
+
+			oDocumentDescription = that._createDocumentDescription(mSettings.workbook);
+			that.postDocumentDescription(oDocumentDescription, mSettings.dataSource, fnResolve, fnReject);
+
+		}).then(function(sDocumentDescriptionId) {
+			return that.sendRequest(mSettings.dataSource.dataUrl, sDocumentDescriptionId).then(function(response) {
+				ExportUtils.saveAsFile(response, mSettings.fileName);
+			});
+		});
+	};
+
+	/**
+	 * Requests the generated PDF via HTTP GET from the OData service.
+	 *
+	 * @param {string} sUrl Absolute data URL of the OData entity that should be exported as PDF
+	 * @param {string} sDocumentDescriptionId GUID of the DocumentDescription that should be used for creating the PDF
+	 * @returns {Promise} A Promise that gets resolved after the XHR request
+	 */
+	PortableDocument.prototype.sendRequest = function(sUrl, sDocumentDescriptionId) {
+		return new Promise(function(fnResolve, fnReject) {
+			var oXHR = this.request = new XMLHttpRequest();
+
+			/* Send GET request to receive PDF file */
+			oXHR.open('GET', sUrl);
+			oXHR.responseType = 'blob';
+			oXHR.setRequestHeader("Accept", "application/pdf");
+			oXHR.setRequestHeader("SAP-Document-Description-Id", sDocumentDescriptionId);
+
+			oXHR.addEventListener('abort', function() {
+				fnReject('Request aborted');
+			});
+
+			oXHR.addEventListener('error', function() {
+				fnReject('Error occured while requesting data');
+			});
+
+			oXHR.addEventListener('load', function() {
+				var status = oXHR.status;
+
+				if (status >= 200 && status <= 400) {
+					fnResolve(oXHR.response);
+				} else {
+					fnReject(oXHR.response);
+				}
+			});
+
+			oXHR.send();
+		}.bind(this));
+	};
+
+	/**
+	 * Cancels the active request. If the request has not been sent
+	 * or the response has been received already, this function has
+	 * no effect.
+	 *
+	 * @function
+	 * @name sap.ui.export.PortableDocument#cancel
+	 * @since 1.96
+	 * @public
+	 */
+	PortableDocument.prototype.cancel = function() {
+		if (this.request && this.request.readyState != XMLHttpRequest.DONE) {
+			this.request.abort();
+			this.request = null;
+		}
+	};
+
+	/**
+	 * Cleans up the internal structures and removes all event handlers.
+	 *
+	 * The object must not be used anymore after destroy was called.
+	 *
+	 * @see sap.ui.export.ExportBase#destroy
+	 * @public
+	 */
+	PortableDocument.prototype.destroy = function() {
+		ExportBase.prototype.destroy.apply(this, arguments);
+
+		this._oModel = null;
+	};
+
+	return PortableDocument;
+});