@sapui5/sap.fe.core 1.93.3 → 1.96.2

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

@@ -38,143 +38,6 @@ sap.ui.define(
 		ModelHelper
 	) {
 		"use strict";
-
-		//////////////////////////////////////////////
-		// Helper functions for semantic keys
-		//////////////////////////////////////////////
-
-		/**
-		 * Creates the filter to retrieve a context corresponding to a semantic path.
-		 *
-		 * @param {string} sSemanticPath The semantic path
-		 * @param {Array} aSemanticKeys The semantic keys for the path
-		 * @returns {sap.ui.model.Filter} The filter
-		 *
-		 * @ui5-restricted
-		 */
-		function createFilterFromSemanticPath(sSemanticPath, aSemanticKeys) {
-			var aKeyValues = sSemanticPath.substring(sSemanticPath.indexOf("(") + 1, sSemanticPath.length - 1).split(","),
-				aFilters;
-
-			if (aSemanticKeys.length != aKeyValues.length) {
-				return null;
-			}
-
-			if (aSemanticKeys.length === 1) {
-				// Take the first key value
-				var sKeyValue = aKeyValues[0];
-				if (sKeyValue.indexOf("'") === 0 && sKeyValue.lastIndexOf("'") === sKeyValue.length - 1) {
-					// Remove the quotes from the value and decode special chars
-					sKeyValue = decodeURIComponent(sKeyValue.substring(1, sKeyValue.length - 1));
-				}
-				aFilters = [new Filter(aSemanticKeys[0].$PropertyPath, FilterOperator.EQ, sKeyValue)];
-			} else {
-				var mKeyValues = {};
-				// Create a map of all key values
-				aKeyValues.forEach(function(sKeyAssignment) {
-					var aParts = sKeyAssignment.split("="),
-						sKeyValue = aParts[1];
-
-					if (sKeyValue.indexOf("'") === 0 && sKeyValue.lastIndexOf("'") === sKeyValue.length - 1) {
-						// Remove the quotes from the value and decode special chars
-						sKeyValue = decodeURIComponent(sKeyValue.substring(1, sKeyValue.length - 1));
-					}
-
-					mKeyValues[aParts[0]] = sKeyValue;
-				});
-
-				var bFailed = false;
-				aFilters = aSemanticKeys.map(function(oSemanticKey) {
-					var sKey = oSemanticKey.$PropertyPath,
-						sValue = mKeyValues[sKey];
-
-					if (sValue !== undefined) {
-						return new Filter(sKey, FilterOperator.EQ, sValue);
-					} else {
-						bFailed = true;
-						return "XX";
-					}
-				});
-
-				if (bFailed) {
-					return null;
-				}
-			}
-
-			// Add a draft filter to make sure we take the draft entity if there is one
-			// Or the active entity otherwise
-			var oDraftFilter = new Filter({
-				filters: [new Filter("IsActiveEntity", "EQ", false), new Filter("SiblingEntity/IsActiveEntity", "EQ", null)],
-				and: false
-			});
-			aFilters.push(oDraftFilter);
-
-			var oCombinedFilter = new Filter(aFilters, true);
-			return oCombinedFilter;
-		}
-
-		/**
-		 * Converts a path with semantic keys to a path with technical keys.
-		 *
-		 * @param {string} sSemanticPath The path with semantic keys
-		 * @param {sap.ui.model.odata.v4.ODataModel} oModel The model for the path
-		 * @param {Array} aSemanticKeys The semantic keys for the path
-		 * @returns {Promise} A Promise containing the path with technical keys if sSemanticPath could be interpreted as a semantic path, null otherwise
-		 *
-		 * @ui5-restricted
-		 */
-		function getTechnicalPathFromSemanticPath(sSemanticPath, oModel, aSemanticKeys) {
-			var oMetaModel = oModel.getMetaModel(),
-				sEntitySetName = oMetaModel.getMetaContext(sSemanticPath).getPath();
-
-			if (!aSemanticKeys || aSemanticKeys.length === 0) {
-				// No semantic keys
-				return Promise.resolve(null);
-			}
-
-			// Create a set of filters corresponding to all keys
-			var oFilter = createFilterFromSemanticPath(sSemanticPath, aSemanticKeys);
-			if (oFilter === null) {
-				// Couldn't interpret the path as a semantic one
-				return Promise.resolve(null);
-			}
-
-			// Load the corresponding object
-			var oListBinding = oModel.bindList("/" + sEntitySetName, undefined, undefined, oFilter, { "$$groupId": "$auto.Heroes" });
-
-			return oListBinding.requestContexts(0, 2).then(function(oContexts) {
-				if (oContexts && oContexts.length) {
-					return oContexts[0].getPath();
-				} else {
-					// No data could be loaded
-					return null;
-				}
-			});
-		}
-
-		/**
-		 * Checks if a path is eligible for semantic bookmarking.
-		 *
-		 * @param {string} sPath The path to test
-		 * @param {sap.ui.model.odata.v4.ODataMetaModel} oMetaModel The associated metadata model
-		 * @returns {boolean} `true` is the path is eligible
-		 *
-		 * @ui5-restricted
-		 */
-		function checkPathForSemanticBookmarking(sPath, oMetaModel) {
-			// Only path on root objects allow semantic bookmarking, i.e. sPath = xxx(yyy)
-			var aMatches = /^[\/]?(\w+)\([^\/]+\)$/.exec(sPath);
-			if (!aMatches) {
-				return false;
-			}
-			// Get the entitySet name
-			var sEntitySetPath = "/" + aMatches[1];
-			// Check the entity set supports draft (otherwise we don't support semantic bookmarking)
-			var oDraftRoot = oMetaModel.getObject(sEntitySetPath + "@com.sap.vocabularies.Common.v1.DraftRoot");
-			var oDraftNode = oMetaModel.getObject(sEntitySetPath + "@com.sap.vocabularies.Common.v1.DraftNode");
-			return oDraftRoot || oDraftNode ? true : false;
-		}
-
 		/**
 		 * {@link sap.ui.core.mvc.ControllerExtension Controller extension}
 		 *
@@ -241,12 +104,14 @@ sap.ui.define(
 
 				/**
 				 * Navigates to the specified navigation target.
+				 *
 				 * @param {sap.ui.model.odata.v4.Context} oContext Context instance
 				 * @param {string} sNavigationTargetName Navigation target name
-				 * @param oSemanticObject
+				 * @param {object} oSemanticObject Semantic object
+				 * @param {boolean} bPreserveHistory True to force the new URL to be added at the end of the browser history (no replace)
 				 * @ui5-restricted
 				 */
-				navigateToTarget: function(oContext, sNavigationTargetName, oSemanticObject) {
+				navigateToTarget: function(oContext, sNavigationTargetName, oSemanticObject, bPreserveHistory) {
 					var oNavigationConfiguration =
 						this._oPageComponent &&
 						this._oPageComponent.getNavigationConfiguration &&
@@ -255,9 +120,9 @@ sap.ui.define(
 						var oDetailRoute = oNavigationConfiguration.detail;
 						var sRouteName = oDetailRoute.route;
 						var mParameterMapping = oDetailRoute.parameters;
-						this._oRoutingService.navigateTo(oContext, sRouteName, mParameterMapping, true, oSemanticObject);
+						this._oRoutingService.navigateTo(oContext, sRouteName, mParameterMapping, bPreserveHistory, oSemanticObject);
 					} else {
-						this._oRoutingService.navigateTo(oContext, null, null, true);
+						this._oRoutingService.navigateTo(oContext, null, null, bPreserveHistory);
 					}
 					this._oView.getViewData();
 				},
@@ -455,11 +320,12 @@ sap.ui.define(
 
 					this.onRouteMatched();
 
-					var oOut;
+					var oModel = this._oView.getModel(),
+						oOut;
 					if (bDeferred) {
 						oOut = this._bindDeferred(sTarget, oNavigationParameters);
 					} else {
-						oOut = this._bindPage(sTarget, oNavigationParameters);
+						oOut = this._bindPage(sTarget, oModel, oNavigationParameters);
 					}
 					var that = this;
 					// eslint-disable-next-line promise/catch-or-return
@@ -510,19 +376,20 @@ sap.ui.define(
 				 * Sets the binding context of the page from a path.
 				 *
 				 * @param {string} sTargetPath The path to the context
+				 * @param {sap.ui.model.odata.v4.ODataModel} oModel The OData model
 				 * @param {object} oNavigationParameters Navigation parameters
 				 * @returns {Promise}
 				 * @ui5-restricted
 				 */
-				_bindPage: function(sTargetPath, oNavigationParameters) {
+				_bindPage: function(sTargetPath, oModel, oNavigationParameters) {
 					var that = this;
 
 					if (sTargetPath === "") {
-						return Promise.resolve(this._bindPageToContext(null, oNavigationParameters));
+						return Promise.resolve(this._bindPageToContext(null, oModel, oNavigationParameters));
 					} else {
-						return this._resolveSemanticPath(sTargetPath)
+						return this._resolveSemanticPath(sTargetPath, oModel)
 							.then(function(sTechnicalPath) {
-								that._bindPageToPath(sTechnicalPath, oNavigationParameters);
+								that._bindPageToPath(sTechnicalPath, oModel, oNavigationParameters);
 							})
 							.catch(function(oError) {
 								// Error handling for erroneous metadata request
@@ -537,16 +404,163 @@ sap.ui.define(
 				},
 
 				/**
-				 * Builds a path with semantic keys from a path with technical keys.
+				 * Creates the filter to retrieve a context corresponding to a semantic path.
+				 *
+				 * @param {string} sSemanticPath The semantic path
+				 * @param {Array} aSemanticKeys The semantic keys for the path
+				 * @param {object} oMetaModel The instance of the meta model
+				 * @returns {sap.ui.model.Filter} The filter
 				 *
+				 * @ui5-restricted
+				 */
+				_createFilterFromSemanticPath: function(sSemanticPath, aSemanticKeys, oMetaModel) {
+					var aKeyValues = sSemanticPath.substring(sSemanticPath.indexOf("(") + 1, sSemanticPath.length - 1).split(","),
+						aFilters;
+
+					if (aSemanticKeys.length != aKeyValues.length) {
+						return null;
+					}
+
+					var bFilteringCaseSensitive = ModelHelper.isFilteringCaseSensitive(oMetaModel);
+
+					if (aSemanticKeys.length === 1) {
+						// Take the first key value
+						var sKeyValue = aKeyValues[0];
+						if (sKeyValue.indexOf("'") === 0 && sKeyValue.lastIndexOf("'") === sKeyValue.length - 1) {
+							// Remove the quotes from the value and decode special chars
+							sKeyValue = decodeURIComponent(sKeyValue.substring(1, sKeyValue.length - 1));
+						}
+						aFilters = [
+							new Filter({
+								path: aSemanticKeys[0].$PropertyPath,
+								operator: FilterOperator.EQ,
+								value1: sKeyValue,
+								caseSensitive: bFilteringCaseSensitive
+							})
+						];
+					} else {
+						var mKeyValues = {};
+						// Create a map of all key values
+						aKeyValues.forEach(function(sKeyAssignment) {
+							var aParts = sKeyAssignment.split("="),
+								sKeyValue = aParts[1];
+
+							if (sKeyValue.indexOf("'") === 0 && sKeyValue.lastIndexOf("'") === sKeyValue.length - 1) {
+								// Remove the quotes from the value and decode special chars
+								sKeyValue = decodeURIComponent(sKeyValue.substring(1, sKeyValue.length - 1));
+							}
+
+							mKeyValues[aParts[0]] = sKeyValue;
+						});
+
+						var bFailed = false;
+						aFilters = aSemanticKeys.map(function(oSemanticKey) {
+							var sKey = oSemanticKey.$PropertyPath,
+								sValue = mKeyValues[sKey];
+
+							if (sValue !== undefined) {
+								return new Filter({
+									path: sKey,
+									operator: FilterOperator.EQ,
+									value1: sValue,
+									caseSensitive: bFilteringCaseSensitive
+								});
+							} else {
+								bFailed = true;
+								return "XX";
+							}
+						});
+
+						if (bFailed) {
+							return null;
+						}
+					}
+
+					// Add a draft filter to make sure we take the draft entity if there is one
+					// Or the active entity otherwise
+					var oDraftFilter = new Filter({
+						filters: [new Filter("IsActiveEntity", "EQ", false), new Filter("SiblingEntity/IsActiveEntity", "EQ", null)],
+						and: false
+					});
+					aFilters.push(oDraftFilter);
+
+					var oCombinedFilter = new Filter(aFilters, true);
+					return oCombinedFilter;
+				},
+
+				/**
+				 * Converts a path with semantic keys to a path with technical keys.
+				 *
+				 * @param {string} sSemanticPath The path with semantic keys
+				 * @param {sap.ui.model.odata.v4.ODataModel} oModel The model for the path
+				 * @param {Array} aSemanticKeys The semantic keys for the path
+				 * @returns {Promise} A Promise containing the path with technical keys if sSemanticPath could be interpreted as a semantic path, null otherwise
+				 *
+				 * @ui5-restricted
+				 */
+				_getTechnicalPathFromSemanticPath: function(sSemanticPath, oModel, aSemanticKeys) {
+					var oMetaModel = oModel.getMetaModel(),
+						sEntitySetName = oMetaModel.getMetaContext(sSemanticPath).getPath();
+
+					if (!aSemanticKeys || aSemanticKeys.length === 0) {
+						// No semantic keys
+						return Promise.resolve(null);
+					}
+
+					// Create a set of filters corresponding to all keys
+					var oFilter = this._createFilterFromSemanticPath(sSemanticPath, aSemanticKeys, oMetaModel);
+					if (oFilter === null) {
+						// Couldn't interpret the path as a semantic one
+						return Promise.resolve(null);
+					}
+
+					// Load the corresponding object
+					var oListBinding = oModel.bindList("/" + sEntitySetName, undefined, undefined, oFilter, {
+						"$$groupId": "$auto.Heroes"
+					});
+
+					return oListBinding.requestContexts(0, 2).then(function(oContexts) {
+						if (oContexts && oContexts.length) {
+							return oContexts[0].getPath();
+						} else {
+							// No data could be loaded
+							return null;
+						}
+					});
+				},
+
+				/**
+				 * Checks if a path is eligible for semantic bookmarking.
+				 *
+				 * @param {string} sPath The path to test
+				 * @param {sap.ui.model.odata.v4.ODataMetaModel} oMetaModel The associated metadata model
+				 * @returns {boolean} `true` if the path is eligible
+				 *
+				 * @ui5-restricted
+				 */
+				_checkPathForSemanticBookmarking: function(sPath, oMetaModel) {
+					// Only path on root objects allow semantic bookmarking, i.e. sPath = xxx(yyy)
+					var aMatches = /^[\/]?(\w+)\([^\/]+\)$/.exec(sPath);
+					if (!aMatches) {
+						return false;
+					}
+					// Get the entitySet name
+					var sEntitySetPath = "/" + aMatches[1];
+					// Check the entity set supports draft (otherwise we don't support semantic bookmarking)
+					var oDraftRoot = oMetaModel.getObject(sEntitySetPath + "@com.sap.vocabularies.Common.v1.DraftRoot");
+					var oDraftNode = oMetaModel.getObject(sEntitySetPath + "@com.sap.vocabularies.Common.v1.DraftNode");
+					return oDraftRoot || oDraftNode ? true : false;
+				},
+
+				/**
+				 * Builds a path with semantic keys from a path with technical keys.
 				 * @param {string} sPathToResolve The path to be transformed
+				 * @param oModel
 				 * @returns {Promise} String promise for the new path. If sPathToResolved couldn't be interpreted as a semantic path, it is returned as is.
-				 *
 				 * @ui5-restricted
 				 */
-				_resolveSemanticPath: function(sPathToResolve) {
-					var oModel = this._oView.getModel(),
-						oMetaModel = oModel.getMetaModel(),
+				_resolveSemanticPath: function(sPathToResolve, oModel) {
+					var oMetaModel = oModel.getMetaModel(),
 						oLastSemanticMapping = this._oRoutingService.getLastSemanticMapping(),
 						sCurrentHashNoParams = this._oRouter
 							.getHashChanger()
@@ -563,7 +577,7 @@ sap.ui.define(
 					if (sRootEntityName.indexOf("/") === 0) {
 						sRootEntityName = sRootEntityName.substring(1);
 					}
-					var bAllowSemanticBookmark = checkPathForSemanticBookmarking(sCurrentHashNoParams, oMetaModel),
+					var bAllowSemanticBookmark = this._checkPathForSemanticBookmarking(sCurrentHashNoParams, oMetaModel),
 						aSemanticKeys = bAllowSemanticBookmark && SemanticKeyHelper.getSemanticKeys(oMetaModel, sRootEntityName);
 					if (!aSemanticKeys) {
 						// No semantic keys available --> use the path as is
@@ -573,7 +587,9 @@ sap.ui.define(
 						return Promise.resolve(oLastSemanticMapping.technicalPath);
 					} else {
 						// We need resolve the semantic path to get the technical keys
-						return getTechnicalPathFromSemanticPath(sCurrentHashNoParams, oModel, aSemanticKeys).then(function(sTechnicalPath) {
+						return this._getTechnicalPathFromSemanticPath(sCurrentHashNoParams, oModel, aSemanticKeys).then(function(
+							sTechnicalPath
+						) {
 							if (sTechnicalPath && sTechnicalPath !== sPathToResolve) {
 								// The semantic path was resolved (otherwise keep the original value for target)
 								that._oRoutingService.setLastSemanticMapping({
@@ -592,11 +608,12 @@ sap.ui.define(
 				 * Sets the binding context of the page from a path.
 				 *
 				 * @param {string} sTargetPath The path to build the context. Needs to contain technical keys only.
+				 * @param {sap.ui.model.odata.v4.ODataModel} oModel The OData model
 				 * @param {object} oNavigationParameters Navigation parameters
 				 *
 				 * @ui5-restricted
 				 */
-				_bindPageToPath: function(sTargetPath, oNavigationParameters) {
+				_bindPageToPath: function(sTargetPath, oModel, oNavigationParameters) {
 					var oCurrentContext = this._getBindingContext(),
 						sCurrentPath = oCurrentContext && oCurrentContext.getPath(),
 						oUseContext = oNavigationParameters.useContext;
@@ -610,10 +627,10 @@ sap.ui.define(
 							oTargetContext = oUseContext;
 						} else {
 							// Otherwise we need to create it from sTargetPath
-							oTargetContext = this._createBindingContext(sTargetPath);
+							oTargetContext = this._createBindingContext(sTargetPath, oModel);
 						}
 						if (oTargetContext !== oCurrentContext) {
-							this._bindPageToContext(oTargetContext, oNavigationParameters);
+							this._bindPageToContext(oTargetContext, oModel, oNavigationParameters);
 						}
 					} else if (!oNavigationParameters.bReasonIsIappState && EditState.isEditStateDirty()) {
 						this._refreshBindingContext(oCurrentContext);
@@ -624,11 +641,12 @@ sap.ui.define(
 				 * Binds the page to a context.
 				 *
 				 * @param {sap.ui.model.odata.v4.Context} oContext Context to be bound
+				 * @param {sap.ui.model.odata.v4.ODataModel} oModel The OData model
 				 * @param {object} oNavigationParameters Navigation parameters
 				 *
 				 * @ui5-restricted
 				 */
-				_bindPageToContext: function(oContext, oNavigationParameters) {
+				_bindPageToContext: function(oContext, oModel, oNavigationParameters) {
 					var that = this;
 					if (!oContext) {
 						this.onBeforeBinding(null);
@@ -638,7 +656,7 @@ sap.ui.define(
 
 						if (!oContext.getBinding() || oContext.getBinding().isA("sap.ui.model.odata.v4.ODataListBinding")) {
 							// We need to recreate the context otherwise we get errors
-							oContext = this._createBindingContext(oContext.getPath());
+							oContext = this._createBindingContext(oContext.getPath(), oModel);
 							if (EditState.isEditStateDirty()) {
 								// TODO: as a workaround we invalidate the model cache while the app is dirty
 								// as the manage model sets the parent in an async task and the request side effects
@@ -654,7 +672,8 @@ sap.ui.define(
 							editable: oNavigationParameters.bTargetEditable,
 							listBinding: oParentListBinding,
 							bPersistOPScroll: oNavigationParameters.bPersistOPScroll,
-							bDraftNavigation: oNavigationParameters.bDraftNavigation
+							bDraftNavigation: oNavigationParameters.bDraftNavigation,
+							showPlaceholder: oNavigationParameters.bShowPlaceholder
 						});
 
 						this._setBindingContext(oContext);
@@ -666,17 +685,17 @@ sap.ui.define(
 				 * Creates a binding context from a path.
 				 *
 				 * @param {string} sPath The path
+				 * @param {sap.ui.model.odata.v4.ODataModel} oModel The OData model
 				 * @returns {sap.ui.model.odata.v4.Context} Created context
 				 *
 				 * @ui5-restricted
 				 */
-				_createBindingContext: function(sPath) {
+				_createBindingContext: function(sPath, oModel) {
 					var oPageComponent = this._oPageComponent,
 						sEntitySet = oPageComponent && oPageComponent.getEntitySet && oPageComponent.getEntitySet(),
 						sContextPath =
 							(oPageComponent && oPageComponent.getContextPath && oPageComponent.getContextPath()) ||
 							(sEntitySet && "/" + sEntitySet),
-						oModel = this._oView.getModel(),
 						oMetaModel = oModel.getMetaModel(),
 						that = this,
 						mParameters = {
@@ -686,7 +705,7 @@ sap.ui.define(
 						};
 
 					if (sEntitySet) {
-						var sMessagesPath = oMetaModel.getProperty(sContextPath + "/@com.sap.vocabularies.Common.v1.Messages/$Path");
+						var sMessagesPath = oMetaModel.getObject(sContextPath + "/@com.sap.vocabularies.Common.v1.Messages/$Path");
 						if (sMessagesPath) {
 							mParameters.$select = sMessagesPath;
 						}
@@ -795,7 +814,7 @@ sap.ui.define(
 					}
 
 					if (sContextPath) {
-						sMessagesPath = oMetaModel.getProperty(sContextPath + "/@com.sap.vocabularies.Common.v1.Messages/$Path");
+						sMessagesPath = oMetaModel.getObject(sContextPath + "/@com.sap.vocabularies.Common.v1.Messages/$Path");
 					}
 
 					// binding of the context must have $$PatchWithoutSideEffects true, this bound context may be needed to be fetched from the dependent binding