@sapui5/sap.fe.core 1.97.0 → 1.99.1

package/src/sap/fe/core/controllerextensions/IntentBasedNavigation.js

@@ -1,6 +1,7 @@
 /*!
- * SAPUI5
- * (c) Copyright 2009-2021 SAP SE. All rights reserved.
+ * SAP UI development toolkit for HTML5 (SAPUI5)
+        (c) Copyright 2009-2021 SAP SE. All rights reserved
+    
  */
 sap.ui.define(["sap/ui/core/mvc/ControllerExtension", "sap/ui/core/mvc/OverrideExecution"], function(
 	ControllerExtension,

package/src/sap/fe/core/controllerextensions/InternalEditFlow.js

@@ -1,6 +1,7 @@
 /*!
- * SAPUI5
- * (c) Copyright 2009-2021 SAP SE. All rights reserved.
+ * SAP UI development toolkit for HTML5 (SAPUI5)
+        (c) Copyright 2009-2021 SAP SE. All rights reserved
+    
  */
 sap.ui.define(
 	[
@@ -12,7 +13,10 @@ sap.ui.define(
 		"sap/fe/core/CommonUtils",
 		"sap/fe/core/BusyLocker",
 		"sap/fe/core/library",
-		"sap/fe/core/helpers/EditState"
+		"sap/fe/core/helpers/EditState",
+		"sap/m/Button",
+		"sap/m/Dialog",
+		"sap/fe/core/actions/sticky"
 	],
 	function(
 		ControllerExtension,
@@ -23,15 +27,117 @@ sap.ui.define(
 		CommonUtils,
 		BusyLocker,
 		FELibrary,
-		EditState
+		EditState,
+		Button,
+		Dialog,
+		sticky
 	) {
 		"use strict";
 
 		var ProgrammingModel = FELibrary.ProgrammingModel,
 			DraftStatus = FELibrary.DraftStatus,
-			EditMode = FELibrary.EditMode;
+			EditMode = FELibrary.EditMode,
+			CreationMode = FELibrary.CreationMode;
+
+		function _registerDirtyStateProvider(oContext, oAppComponent, oInternalModel, sHashTracker) {
+			function fnDirtyStateProvider(oNavigationContext) {
+				var sTargetHash = oNavigationContext.innerAppRoute,
+					oRouterProxy = oAppComponent.getRouterProxy(),
+					bDirty,
+					bSessionON = oInternalModel.getProperty("/sessionOn");
+
+				if (!bSessionON) {
+					// If the sticky session was terminated before hand.
+					// Eexample in case of navigating away from application using IBN.
+					return undefined;
+				}
+
+				if (!oRouterProxy.isNavigationFinalized()) {
+					// If navigation is currently happening in RouterProxy, it's a transient state
+					// (not dirty)
+					bDirty = false;
+					sHashTracker = sTargetHash;
+				} else if (sHashTracker === sTargetHash) {
+					// the hash didn't change so either the user attempts to refresh or to leave the app
+					bDirty = true;
+				} else if (oRouterProxy.checkHashWithGuard(sTargetHash) || oRouterProxy.isGuardCrossAllowedByUser()) {
+					// the user attempts to navigate within the root object
+					// or crossing the guard has already been allowed by the RouterProxy
+					sHashTracker = sTargetHash;
+					bDirty = false;
+				} else {
+					// the user attempts to navigate within the app, for example back to the list report
+					bDirty = true;
+				}
+
+				if (bDirty) {
+					// the FLP doesn't call the dirty state provider anymore once it's dirty, as they can't
+					// change this due to compatibility reasons we set it back to not-dirty
+					setTimeout(function() {
+						oAppComponent.getShellServices().setDirtyFlag(false);
+					}, 0);
+				}
+
+				return bDirty;
+			}
+
+			oContext.fnDirtyStateProvider = fnDirtyStateProvider;
+			oAppComponent.getShellServices().registerDirtyStateProvider(oContext.fnDirtyStateProvider);
+		}
+
+		function _attachSessionTimeout(oContext, i18nModel) {
+			var that = oContext;
+
+			function fnHandleSessionTimeout() {
+				// remove transient messages since we will showing our own message
+				that.getMessageHandler().removeTransitionMessages();
+
+				var oDialog = new Dialog({
+					title: "{sap.fe.i18n>C_EDITFLOW_OBJECT_PAGE_SESSION_EXPIRED_DIALOG_TITLE}",
+					state: "Warning",
+					content: new Text({ text: "{sap.fe.i18n>C_EDITFLOW_OBJECT_PAGE_SESSION_EXPIRED_DIALOG_MESSAGE}" }),
+					beginButton: new Button({
+						text: "{sap.fe.i18n>C_COMMON_DIALOG_OK}",
+						type: "Emphasized",
+						press: function() {
+							// remove sticky handling after navigation since session has already been terminated
+							that.handleStickyOff();
+							that.getRoutingListener().navigateBackFromContext(oContext);
+						}
+					}),
+					afterClose: function() {
+						oDialog.destroy();
+					}
+				});
+				oDialog.addStyleClass("sapUiContentPadding");
+				oDialog.setModel(i18nModel, "sap.fe.i18n");
+				that.getView().addDependent(oDialog);
+				oDialog.open();
+			}
 
-		var Extension = ControllerExtension.extend("sap.fe.core.controllerextensions.InternalEditFlow", {
+			// handle session timeout
+			that.fnHandleSessionTimeout = fnHandleSessionTimeout;
+			that.getView()
+				.getModel()
+				.attachSessionTimeout(that.fnHandleSessionTimeout);
+		}
+
+		function _attachRouteMatched(oFnContext, oContext, oAppComponent) {
+			var that = oFnContext;
+
+			function fnStickyDiscardAfterNavigation() {
+				var sCurrentHash = oAppComponent.getRouterProxy().getHash();
+				// either current hash is empty so the user left the app or he navigated away from the object
+				if (!sCurrentHash || !oAppComponent.getRouterProxy().checkHashWithGuard(sCurrentHash)) {
+					that.discardStickySession(oContext);
+				}
+			}
+
+			that.fnStickyDiscardAfterNavigation = fnStickyDiscardAfterNavigation;
+			oAppComponent.getRoutingService().attachRouteMatched(that.fnStickyDiscardAfterNavigation);
+		}
+
+		return ControllerExtension.extend("sap.fe.core.controllerextensions.InternalEditFlow", {
 			metadata: {
 				methods: {
 					createMultipleDocuments: { "public": true, "final": true },
@@ -52,7 +158,9 @@ sap.ui.define(
 					deleteCurrentActionPromise: { "public": true, "final": true },
 					getActionResponseDataAndKeys: { "public": true, "final": true },
 					setCreationMode: { "public": false, "final": false, "overrideExecution": OverrideExecution.After },
-					getMessageHandler: { "public": true, "final": true }
+					getMessageHandler: { "public": true, "final": true },
+					handleStickyOn: { "public": true, "final": true },
+					handleStickyOff: { "public": true, "final": true }
 				}
 			},
 
@@ -67,7 +175,7 @@ sap.ui.define(
 				// to be overridden
 			},
 
-			createMultipleDocuments: function(oListBinding, aData, bCreateAtEnd, bFromCopyPaste) {
+			createMultipleDocuments: function(oListBinding, aData, bCreateAtEnd, bFromCopyPaste, beforeCreateCallBack) {
 				var that = this,
 					transactionHelper = this.getTransactionHelper(),
 					oLockObject = this.getGlobalUIModel(),
@@ -75,6 +183,12 @@ sap.ui.define(
 
 				BusyLocker.lock(oLockObject);
 				return this.syncTask()
+					.then(function() {
+						var onBeforeCreatePromise = beforeCreateCallBack
+							? beforeCreateCallBack({ contextPath: oListBinding && oListBinding.getPath() })
+							: Promise.resolve();
+						return onBeforeCreatePromise;
+					})
 					.then(function() {
 						var oModel = oListBinding.getModel(),
 							oMetaModel = oModel.getMetaModel(),
@@ -94,7 +208,7 @@ sap.ui.define(
 
 							mParameters.keepTransientContextOnFailed = false; // currently not fully supported
 							mParameters.busyMode = "None";
-							mParameters.creationMode = "CreationRow";
+							mParameters.creationMode = CreationMode.CreationRow;
 							mParameters.parentControl = that.getView();
 							mParameters.createAtEnd = bCreateAtEnd;
 
@@ -111,7 +225,8 @@ sap.ui.define(
 								mParameters,
 								oResourceBundle,
 								that.getMessageHandler(),
-								bFromCopyPaste
+								bFromCopyPaste,
+								that.getView()
 							);
 						});
 
@@ -200,6 +315,9 @@ sap.ui.define(
 
 						return oResult;
 					})
+					.catch(function(oError) {
+						Log.error("Error while deleting the document(s)", oError);
+					})
 					.finally(function() {
 						BusyLocker.unlock(oLockObject);
 					});
@@ -216,7 +334,8 @@ sap.ui.define(
 			 */
 
 			computeEditMode: function(oContext) {
-				var that = this;
+				var that = this,
+					sCustomAction = that.getInternalModel().getProperty("/sCustomAction");
 
 				return Promise.resolve(
 					(function() {
@@ -243,6 +362,19 @@ sap.ui.define(
 									Log.error("Error while determining the editMode for draft", oError);
 									throw oError;
 								});
+						} else if (sProgrammingModel === ProgrammingModel.Sticky) {
+							if (
+								sCustomAction &&
+								sCustomAction !== "" &&
+								that._hasNewActionForSticky(oContext, that.getView(), sCustomAction)
+							) {
+								that.getTransactionHelper()._bCreateMode = true;
+								that.getTransactionHelper().handleDocumentModifications();
+								that.setEditMode(EditMode.Editable, true);
+								EditState.setEditStateDirty();
+								that.handleStickyOn(oContext);
+								that.getInternalModel().setProperty("/sCustomAction", "");
+							}
 						}
 					})()
 				);
@@ -363,6 +495,9 @@ sap.ui.define(
 					)
 					.then(function() {
 						that.getInternalModel().setProperty("/sessionOn", false);
+					})
+					.catch(function(oError) {
+						return Promise.reject(oError);
 					});
 			},
 
@@ -499,9 +634,149 @@ sap.ui.define(
 				onInit: function() {
 					this._oAppComponent = this.base.getAppComponent();
 				}
+			},
+
+			handleStickyOn: function(oContext) {
+				var that = this,
+					oAppComponent = CommonUtils.getAppComponent(this.getView());
+
+				try {
+					if (oAppComponent === undefined || oContext === undefined) {
+						throw new Error("undefined AppComponent or Context for function handleStickyOn");
+					}
+
+					if (!oAppComponent.getRouterProxy().hasNavigationGuard()) {
+						var sHashTracker = oAppComponent.getRouterProxy().getHash(),
+							oInternalModel = this.getInternalModel();
+
+						// Set a guard in the RouterProxy
+						// A timeout is necessary, as with deferred creation the hashChanger is not updated yet with
+						// the new hash, and the guard cannot be found in the managed history of the router proxy
+						setTimeout(function() {
+							oAppComponent.getRouterProxy().setNavigationGuard();
+						}, 0);
+
+						// Setting back navigation on shell service, to get the dicard message box in case of sticky
+						oAppComponent.getShellServices().setBackNavigation(that.onBackNavigationInSession.bind(that));
+
+						_registerDirtyStateProvider(that, oAppComponent, oInternalModel, sHashTracker);
+
+						var i18nModel = this.getView().getModel("sap.fe.i18n");
+						_attachSessionTimeout(that, i18nModel);
+
+						_attachRouteMatched(that, oContext, oAppComponent);
+					}
+				} catch (error) {
+					Log.info(error);
+					return undefined;
+				}
+				return true;
+			},
+
+			handleStickyOff: function() {
+				var oAppComponent = CommonUtils.getAppComponent(this.getView());
+				try {
+					if (oAppComponent === undefined) {
+						throw new Error("undefined AppComponent for function handleStickyOff");
+					}
+
+					if (oAppComponent && oAppComponent.getRouterProxy) {
+						// If we have exited from the app, CommonUtils.getAppComponent doesn't return a
+						// sap.fe.core.AppComponent, hence the 'if' above
+						oAppComponent.getRouterProxy().discardNavigationGuard();
+					}
+
+					if (this.fnDirtyStateProvider) {
+						oAppComponent.getShellServices().deregisterDirtyStateProvider(this.fnDirtyStateProvider);
+						this.fnDirtyStateProvider = null;
+					}
+
+					if (this.getView().getModel() && this.fnHandleSessionTimeout) {
+						this.getView()
+							.getModel()
+							.detachSessionTimeout(this.fnHandleSessionTimeout);
+					}
+
+					oAppComponent.getRoutingService().detachRouteMatched(this.fnStickyDiscardAfterNavigation);
+					this.fnStickyDiscardAfterNavigation = null;
+
+					this.getTransactionHelper()._bCreateMode = false;
+					this.setEditMode(EditMode.Display, false);
+
+					if (oAppComponent) {
+						// If we have exited from the app, CommonUtils.getAppComponent doesn't return a
+						// sap.fe.core.AppComponent, hence the 'if' above
+						oAppComponent.getShellServices().setBackNavigation();
+					}
+				} catch (error) {
+					Log.info(error);
+					return undefined;
+				}
+				return true;
+			},
+
+			/**
+			 * @description Method to display a 'discard' popover when exiting a sticky session.
+			 *
+			 * @function
+			 * @name onBackNavigationInSession
+			 * @memberof sap.fe.core.controllerextensions.InternalEditFlow
+			 */
+			onBackNavigationInSession: function() {
+				var that = this,
+					oView = that.getView(),
+					oAppComponent = CommonUtils.getAppComponent(oView),
+					oRouterProxy = oAppComponent.getRouterProxy();
+
+				if (oRouterProxy.checkIfBackIsOutOfGuard()) {
+					var oBindingContext = oView && oView.getBindingContext();
+
+					CommonUtils.processDataLossConfirmation(
+						function() {
+							that.discardStickySession(oBindingContext);
+							history.back();
+						},
+						oView,
+						that.getProgrammingModel(oBindingContext)
+					);
+
+					return;
+				}
+				history.back();
+			},
+
+			discardStickySession: function(oContext) {
+				sticky.discardDocument(oContext);
+				this.handleStickyOff();
+			},
+
+			_hasNewActionForSticky: function(oContext, oView, sCustomAction) {
+				try {
+					if (oContext === undefined || oView === undefined) {
+						throw new Error("Invalid input parameters for function _hasNewActionForSticky");
+					}
+
+					var oMetaModel = oView.getModel().getMetaModel(),
+						sMetaPath = oContext.getPath().substring(0, oContext.getPath().indexOf("(")),
+						oStickySession = oMetaModel.getObject(sMetaPath + "@com.sap.vocabularies.Session.v1.StickySessionSupported");
+
+					if (oStickySession && oStickySession.NewAction && oStickySession.NewAction === sCustomAction) {
+						return true;
+					} else if (oStickySession && oStickySession.AdditionalNewActions) {
+						return sCustomAction ===
+							oStickySession.AdditionalNewActions.find(function(sAdditionalAction) {
+								return sAdditionalAction === sCustomAction;
+							})
+							? true
+							: false;
+					} else {
+						return false;
+					}
+				} catch (error) {
+					Log.info(error);
+					return undefined;
+				}
 			}
 		});
-
-		return Extension;
 	}
 );

package/src/sap/fe/core/controllerextensions/InternalIntentBasedNavigation.js

@@ -1,6 +1,7 @@
 /*!
- * SAPUI5
- * (c) Copyright 2009-2021 SAP SE. All rights reserved.
+ * SAP UI development toolkit for HTML5 (SAPUI5)
+        (c) Copyright 2009-2021 SAP SE. All rights reserved
+    
  */
 sap.ui.define(
 	[
@@ -260,6 +261,14 @@ sap.ui.define(
 			 * @returns {object} Object of prepared attributes for external navigation and no conflict properties.
 			 */
 			prepareContextForExternalNavigation: function(oSemanticAttributes, oContext) {
+				// 1. Find all distinct keys in the object SemanticAttributes
+				// Store meta path for each occurence of the key
+				var oDistinctKeys = {},
+					sContextPath = oContext.getPath(),
+					oMetaModel = oContext.getModel().getMetaModel(),
+					sMetaPath = oMetaModel.getMetaPath(sContextPath),
+					aMetaPathParts = sMetaPath.split("/").filter(Boolean);
+
 				function _findDistinctKeysInObject(LookUpObject, sLookUpObjectMetaPath) {
 					for (var sKey in LookUpObject) {
 						// null case??
@@ -277,13 +286,7 @@ sap.ui.define(
 						}
 					}
 				}
-				// 1. Find all distinct keys in the object SemanticAttributes
-				// Store meta path for each occurence of the key
-				var oDistinctKeys = {},
-					sContextPath = oContext.getPath(),
-					oMetaModel = oContext.getModel().getMetaModel(),
-					sMetaPath = oMetaModel.getMetaPath(sContextPath),
-					aMetaPathParts = sMetaPath.split("/").filter(Boolean);
+
 				_findDistinctKeysInObject(oSemanticAttributes, sMetaPath);
 
 				// 2. Determine distinct key value and add conflicted paths to semantic attributes
@@ -371,7 +374,11 @@ sap.ui.define(
 			 * @returns {object} Object of prepared filter conditions for external navigation and no conflict filters.
 			 */
 			prepareFiltersForExternalNavigation: function(oFilterBarConditions, sRootPath, aParameters) {
-				function _findDistinctKeysInObject(LookUpObject, sLookUpObjectMetaPath) {
+				var oDistinctKeys = {};
+				var oFilterConditionsWithoutConflict = {};
+				var sMainEntityValuePath, sCurrentValuePath, sFullContextPath, sWinnerValuePath, sPathInContext;
+				function _findDistinctKeysInObject(LookUpObject) {
+					var sLookUpObjectMetaPath;
 					for (var sKey in LookUpObject) {
 						if (LookUpObject[sKey]) {
 							if (sKey.includes("/")) {
@@ -391,11 +398,8 @@ sap.ui.define(
 						}
 					}
 				}
-				var oDistinctKeys = {};
 
-				_findDistinctKeysInObject(oFilterBarConditions, sRootPath);
-				var oFilterConditionsWithoutConflict = {};
-				var sMainEntityValuePath, sCurrentValuePath, sFullContextPath, sWinnerValuePath, sPathInContext;
+				_findDistinctKeysInObject(oFilterBarConditions);
 				for (var sDistinctKey in oDistinctKeys) {
 					var aConflictingPaths = oDistinctKeys[sDistinctKey];
 
@@ -457,21 +461,21 @@ sap.ui.define(
 			 * @returns {string}
 			 */
 			getNavigationMode: function() {
-				return "inplace";
+				return undefined;
 			},
 			/**
-			 * Allows for Navigation to a given Intent(SemanticObject-Action) with the provided context with a dialog showing the contexts which cannot be passed
-			 * If Semantic Object mapping is provided that is also applied to the Selection Variant after adaptation by a consumer.
-			 * This takes care of removing any technical parameters and determines if an explace or inplace navigation should take place.
+			 * Allows for navigation to a given intent (SemanticObject-Action) with the provided context, using a dialog that shows the contexts which cannot be passed
+			 * If semantic object mapping is provided, this setting is also applied to the selection variant after adaptation by a consumer.
+			 * This setting also removes any technical parameters and determines if an inplace or explace navigation should take place.
 			 *
-			 * @param {string} sSemanticObject Semantic Object for the target app
+			 * @param {string} sSemanticObject Semantic object for the target app
 			 * @param {string} sAction  Action for the target app
 			 * @param {object} [mNavigationParameters] Optional parameters to be passed to the external navigation
-			 * @param {Array|object} [mNavigationParameters.navigationContexts] Single instance or multiple instances of {@link sap.ui.model.odata.v4.Context} or alternatively an object or array of objects to be passed to intent.
-			 * @param {Array|object} [mNavigationParameters.applicableContexts] Single instance or multiple instances of {@link sap.ui.model.odata.v4.Context} or alternatively an object or array of objects to be passed to intent and for which the IBN button is enabled
-			 * @param {Array|object} [mNavigationParameters.notApplicableContexts] Single instance or multiple instances of {@link sap.ui.model.odata.v4.Context} or alternatively an object or array of objects which cannot be passed to the intent.
+			 * @param {Array|object} [mNavigationParameters.navigationContexts] Single instance or multiple instances of {@link sap.ui.model.odata.v4.Context}, or alternatively an object or array of objects, to be passed to the intent.
+			 * @param {Array|object} [mNavigationParameters.applicableContexts] Single instance or multiple instances of {@link sap.ui.model.odata.v4.Context}, or alternatively an object or array of objects, to be passed to the intent and for which the IBN button is enabled
+			 * @param {Array|object} [mNavigationParameters.notApplicableContexts] Single instance or multiple instances of {@link sap.ui.model.odata.v4.Context}, or alternatively an object or array of objects, which cannot be passed to the intent.
 			 *		  if an array of contexts is passed the context is used to determine the meta path and accordingly remove the sensitive data
-			 *		  if an array of objects is passed the following format is expected :
+			 *		  If an array of objects is passed, the following format is expected:
 			 *		  {
 			 *			data: {
 			 *	 			ProductID: 7634,