@sapui5/sap.fe.core 1.99.0 → 1.100.0

package/src/sap/fe/core/controllerextensions/Share.ts

@@ -0,0 +1,231 @@
+import ObjectPath from "sap/base/util/ObjectPath";
+import extend from "sap/base/util/extend";
+import Log from "sap/base/Log";
+import XMLTemplateProcessor from "sap/ui/core/XMLTemplateProcessor";
+import XMLPreprocessor from "sap/ui/core/util/XMLPreprocessor";
+import Fragment from "sap/ui/core/Fragment";
+import JSONModel from "sap/ui/model/json/JSONModel";
+import ControllerExtension from "sap/ui/core/mvc/ControllerExtension";
+import OverrideExecution from "sap/ui/core/mvc/OverrideExecution";
+import HashChanger from "sap/ui/core/routing/HashChanger";
+import library from "sap/m/library";
+import { Extensible, Final, Public, UI5Class } from "sap/fe/core/helpers/ClassSupport";
+import ControllerExtensionMetadata from "sap/fe/core/controllerextensions/ControllerExtensionMetadata";
+import Control from "sap/ui/core/Control";
+import ActionSheet from "sap/m/ActionSheet";
+import ResourceBundle from "sap/base/i18n/ResourceBundle";
+import Dialog from "sap/m/Dialog";
+import PageController from "../PageController";
+
+let oLastFocusedControl: Control;
+
+/**
+ * A controller extension offering hooks into the routing flow of the application
+ *
+ * @hideconstructor
+ * @public
+ * @since 1.86.0
+ */
+@UI5Class("sap.fe.core.controllerextensions.Share", ControllerExtensionMetadata)
+class ShareUtils extends ControllerExtension {
+	private base!: PageController;
+
+	/**
+	 * Opens the share sheet.
+	 *
+	 * @function
+	 * @param {object} oControl The control to which the ActionSheet is opened.
+	 * @alias sap.fe.core.controllerextensions.Share#openShareSheet
+	 * @public
+	 * @since 1.93.0
+	 */
+	@Public
+	@Final
+	openShareSheet(oControl: object) {
+		this._openShareSheetImpl(oControl);
+	}
+	/**
+	 * Adapts the metadata used while sharing the page URL via 'Send Email', 'Share in SAP Jam', and 'Save as Tile'.
+	 *
+	 * @function
+	 * @param {object} oShareMetadata Object containing the share metadata.
+	 * @param {string} oShareMetadata.url Default URL that will be used via 'Send Email', 'Share in SAP Jam', and 'Save as Tile'
+	 * @param {string} oShareMetadata.title Default title that will be used as 'email subject' in 'Send Email', 'share text' in 'Share in SAP Jam' and 'title' in 'Save as Tile'
+	 * @param {object} oShareMetadata.email Email-specific metadata.
+	 * @param {string} oShareMetadata.email.url URL that will be used specifically for 'Send Email'. This takes precedence over oShareMetadata.url.
+	 * @param {string} oShareMetadata.email.title Title that will be used as "email subject" in 'Send Email'. This takes precedence over oShareMetadata.title.
+	 * @param {object} oShareMetadata.jam SAP Jam-specific metadata.
+	 * @param {string} oShareMetadata.jam.url URL that will be used specifically for 'Share in SAP Jam'. This takes precedence over oShareMetadata.url.
+	 * @param {string} oShareMetadata.jam.title Title that will be used as 'share text' in 'Share in SAP Jam'. This takes precedence over oShareMetadata.title.
+	 * @param {object} oShareMetadata.tile Save as Tile-specific metadata.
+	 * @param {string} oShareMetadata.tile.url URL that will be used specifically for 'Save as Tile'. This takes precedence over oShareMetadata.url.
+	 * @param {string} oShareMetadata.tile.title Title to be used for the tile. This takes precedence over oShareMetadata.title.
+	 * @param {string} oShareMetadata.tile.subtitle Subtitle to be used for the tile.
+	 * @param {string} oShareMetadata.tile.icon Icon to be used for the tile.
+	 * @param {string} oShareMetadata.tile.queryUrl Query URL of an OData service from which data for a dynamic tile is read.
+	 * @returns {object | Promise<object>} Share Metadata or a Promise resolving the Share Metadata
+	 * @alias sap.fe.core.controllerextensions.Share#adaptShareMetadata
+	 * @public
+	 * @since 1.93.0
+	 */
+	@Public
+	@Extensible(OverrideExecution.After)
+	adaptShareMetadata(oShareMetadata: {
+		url: string;
+		title: string;
+		email?: { url: string; title: string };
+		jam?: { url: string; title: string };
+		tile?: { url: string; title: string; subtitle: string; icon: string; queryUrl: string };
+	}): object | Promise<object> {
+		return oShareMetadata;
+	}
+	_openShareSheetImpl(by: any) {
+		let oShareActionSheet: ActionSheet, fragmentController: any;
+		const sHash = HashChanger.getInstance().getHash(),
+			sBasePath = (HashChanger.getInstance() as any).hrefForAppSpecificHash
+				? (HashChanger.getInstance() as any).hrefForAppSpecificHash("")
+				: "",
+			oShareMetadata = {
+				url: sHash ? sBasePath + sHash : window.location.hash,
+				title: document.title,
+				email: {
+					url: "",
+					title: ""
+				},
+				jam: {
+					url: "",
+					title: ""
+				},
+				tile: {
+					url: "",
+					title: "",
+					subtitle: "",
+					icon: "",
+					queryUrl: ""
+				}
+			};
+		oLastFocusedControl = by;
+
+		const setShareEmailData = function(oShareActionSheet: any, oModelData: any) {
+			const oShareMailModel = oShareActionSheet.getModel("shareData");
+			const oNewMailData = extend(oShareMailModel.getData(), oModelData);
+			oShareMailModel.setData(oNewMailData);
+		};
+		return Promise.resolve(this.adaptShareMetadata(oShareMetadata))
+			.then((oModelData: any) => {
+				fragmentController = {
+					shareEmailPressed: function() {
+						const oMailModel = oShareActionSheet.getModel("shareData") as JSONModel;
+						const oMailData = oMailModel.getData() as any;
+						const oResource = sap.ui.getCore().getLibraryResourceBundle("sap.fe.core") as ResourceBundle;
+						const sEmailSubject = oMailData.email.title
+							? oMailData.email.title
+							: oResource.getText("T_SHARE_UTIL_HELPER_SAPFE_EMAIL_SUBJECT", [oMailData.title]);
+						library.URLHelper.triggerEmail(undefined, sEmailSubject, oMailData.email.url ? oMailData.email.url : oMailData.url);
+					},
+					onSaveTilePress: function() {
+						// TODO it seems that the press event is executed before the dialog is available - adding a timeout is a cheap workaround
+						setTimeout(function() {
+							(sap.ui.getCore().byId("bookmarkDialog") as Dialog)?.attachAfterClose(function() {
+								oLastFocusedControl.focus();
+							});
+						}, 0);
+					},
+					shareJamPressed() {
+						this._doOpenJamShareDialog(
+							oModelData.jam.title ? oModelData.jam.title : oModelData.title,
+							oModelData.jam.url ? oModelData.jam.url : window.location.origin + window.location.pathname + oModelData.url
+						);
+					}
+				};
+
+				fragmentController.onCancelPressed = function() {
+					oShareActionSheet.close();
+				};
+
+				fragmentController.setShareSheet = function(oShareSheet: any) {
+					by.shareSheet = oShareSheet;
+				};
+
+				const oThis = new JSONModel({}),
+					oPreprocessorSettings = {
+						bindingContexts: {
+							"this": oThis.createBindingContext("/")
+						},
+						models: {
+							"this": oThis
+						}
+					};
+				const oTileData = {
+					title: oModelData.tile.title ? oModelData.tile.title : oModelData.title,
+					subtitle: oModelData.tile.subtitle,
+					icon: oModelData.tile.icon,
+					url: oModelData.tile.url ? oModelData.tile.url : oModelData.url,
+					queryUrl: oModelData.tile.queryUrl
+				};
+				if (by.shareSheet) {
+					oShareActionSheet = by.shareSheet;
+
+					const oShareModel = oShareActionSheet.getModel("share") as JSONModel;
+					this._setStaticShareData(oShareModel);
+					const oNewData = extend(oShareModel.getData(), oTileData);
+					oShareModel.setData(oNewData);
+					setShareEmailData(oShareActionSheet, oModelData);
+					oShareActionSheet.openBy(by);
+				} else {
+					const sFragmentName = "sap.fe.macros.share.ShareSheet",
+						oPopoverFragment = XMLTemplateProcessor.loadTemplate(sFragmentName, "fragment");
+
+					Promise.resolve(XMLPreprocessor.process(oPopoverFragment, { name: sFragmentName }, oPreprocessorSettings))
+						.then(function(oFragment: any) {
+							return Fragment.load({ definition: oFragment, controller: fragmentController });
+						})
+						.then((oActionSheet: any) => {
+							oShareActionSheet = oActionSheet;
+
+							oShareActionSheet.setModel(new JSONModel(oTileData || {}), "share");
+							const oShareModel = oShareActionSheet.getModel("share") as JSONModel;
+							this._setStaticShareData(oShareModel);
+							const oNewData = extend(oShareModel.getData(), oTileData);
+							oShareModel.setData(oNewData);
+
+							oShareActionSheet.setModel(new JSONModel(oModelData || {}), "shareData");
+							setShareEmailData(oShareActionSheet, oModelData);
+
+							by.addDependent(oShareActionSheet);
+							oShareActionSheet.openBy(by);
+							fragmentController.setShareSheet(oShareActionSheet);
+						})
+						.catch(function(oError: any) {
+							Log.error("Error while opening the share fragment", oError);
+						});
+				}
+			})
+			.catch(function(oError: any) {
+				Log.error("Error while fetching the share model data", oError);
+			});
+	}
+	_setStaticShareData(shareModel: any) {
+		const oResource = sap.ui.getCore().getLibraryResourceBundle("sap.fe.core") as ResourceBundle;
+		shareModel.setProperty("/jamButtonText", oResource.getText("T_COMMON_SAPFE_SHARE_JAM"));
+		shareModel.setProperty("/emailButtonText", oResource.getText("T_SEMANTIC_CONTROL_SEND_EMAIL"));
+		const fnGetUser = ObjectPath.get("sap.ushell.Container.getUser");
+		shareModel.setProperty("/jamVisible", !!fnGetUser && fnGetUser().isJamActive());
+		shareModel.setProperty("/saveAsTileVisible", !!(sap && sap.ushell && sap.ushell.Container));
+	}
+	//the actual opening of the JAM share dialog
+	_doOpenJamShareDialog(text: any, sUrl?: any) {
+		const oShareDialog = sap.ui.getCore().createComponent({
+			name: "sap.collaboration.components.fiori.sharing.dialog",
+			settings: {
+				object: {
+					id: sUrl,
+					share: text
+				}
+			}
+		});
+		oShareDialog.open();
+	}
+}
+
+export default ShareUtils;