yv01p/Umbraco-CMS
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Revert "Ensure package view path is generated with consideration the current section (#14268)" (#14508)

Browse Source 
This reverts commit 5382820e58.
This commit is contained in:
Andreas Zerbst
2023-07-05 13:38:02 +02:00
committed by GitHub
parent 5382820e58
commit c61e6c4901
10 changed files with 38 additions and 71 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
src/Umbraco.Web.BackOffice/Controllers/BackOfficeServerVariables.cs
View File

@@ -704,9 +704,6 @@ namespace Umbraco.Cms.Web.BackOffice.Controllers
[DataMember(Name = "packageFolder")]
public string? PackageFolder { get; set; }
[DataMember(Name = "sectionAlias")]
public string? SectionAlias { get; set; }
}
private IEnumerable<PluginTree> GetPluginTrees()
@@ -738,7 +735,7 @@ namespace Umbraco.Cms.Web.BackOffice.Controllers
continue;
}
yield return new PluginTree { Alias = tree.TreeAlias, PackageFolder = pluginController.AreaName, SectionAlias = tree.SectionAlias };
yield return new PluginTree { Alias = tree.TreeAlias, PackageFolder = pluginController.AreaName };
}
}

2
src/Umbraco.Web.BackOffice/Trees/ApplicationTreeController.cs
View File

@@ -360,7 +360,7 @@ public class ApplicationTreeController : UmbracoAuthorizedApiController
ControllerActionDescriptor? actionDescriptor = _actionDescriptorCollectionProvider.ActionDescriptors.Items
.Cast<ControllerActionDescriptor>()
.First(x =>
(x.ControllerTypeInfo.FullName ?? string.Empty).Equals(controllerType.FullName) &&
x.ControllerName.Equals(controllerName) &&
x.ActionName == action);
var actionContext = new ActionContext(HttpContext, routeData, actionDescriptor);

2
src/Umbraco.Web.BackOffice/Trees/ScriptsTreeController.cs
View File

@@ -3,12 +3,10 @@ using Umbraco.Cms.Core.Events;
using Umbraco.Cms.Core.IO;
using Umbraco.Cms.Core.Services;
using Umbraco.Cms.Core.Trees;
using Umbraco.Cms.Web.Common.Attributes;
namespace Umbraco.Cms.Web.BackOffice.Trees;
[CoreTree]
[PluginController(Constants.Web.Mvc.BackOfficeTreeArea)]
[Tree(Constants.Applications.Settings, Constants.Trees.Scripts, TreeTitle = "Scripts", SortOrder = 10, TreeGroup = Constants.Trees.Groups.Templating)]
public class ScriptsTreeController : FileSystemTreeController
{

2
src/Umbraco.Web.BackOffice/Trees/StylesheetsTreeController.cs
View File

@@ -3,12 +3,10 @@ using Umbraco.Cms.Core.Events;
using Umbraco.Cms.Core.IO;
using Umbraco.Cms.Core.Services;
using Umbraco.Cms.Core.Trees;
using Umbraco.Cms.Web.Common.Attributes;
namespace Umbraco.Cms.Web.BackOffice.Trees;
[CoreTree]
[PluginController(Constants.Web.Mvc.BackOfficeTreeArea)]
[Tree(Constants.Applications.Settings, Constants.Trees.Stylesheets, TreeTitle = "Stylesheets", SortOrder = 9, TreeGroup = Constants.Trees.Groups.Templating)]
public class StylesheetsTreeController : FileSystemTreeController
{

39
src/Umbraco.Web.BackOffice/Trees/UrlHelperExtensions.cs
View File

@@ -47,15 +47,14 @@ public static class UrlHelperExtensions
string nodeId,
FormCollection? queryStrings)
{
var actionName = "GetNodes";
var actionUrl = urlHelper.GetUmbracoApiService(umbracoApiControllerTypeCollection, actionName, treeType);
actionUrl = StartOrContinueQueryString(actionUrl, actionName);
// Now we need to append the query strings
// Always ignore the custom start node id when generating URLs for tree nodes since this is a custom once-only parameter
// that should only ever be used when requesting a tree to render (root), not a tree node
actionUrl += "id=" + nodeId.EnsureEndsWith('&') + queryStrings?.ToQueryString("id", TreeQueryStringParameters.StartNodeId);
var actionUrl = urlHelper.GetUmbracoApiService(umbracoApiControllerTypeCollection, "GetNodes", treeType)?
.EnsureEndsWith('?');
//now we need to append the query strings
actionUrl += "id=" + nodeId.EnsureEndsWith('&') + queryStrings?.ToQueryString("id",
//Always ignore the custom start node id when generating URLs for tree nodes since this is a custom once-only parameter
// that should only ever be used when requesting a tree to render (root), not a tree node
TreeQueryStringParameters.StartNodeId);
return actionUrl;
}
@@ -66,29 +65,11 @@ public static class UrlHelperExtensions
string nodeId,
FormCollection? queryStrings)
{
var actionName = "GetMenu";
var actionUrl = urlHelper.GetUmbracoApiService(umbracoApiControllerTypeCollection, actionName, treeType);
actionUrl = StartOrContinueQueryString(actionUrl, actionName);
var actionUrl = urlHelper.GetUmbracoApiService(umbracoApiControllerTypeCollection, "GetMenu", treeType)?
.EnsureEndsWith('?');
// now we need to append the query strings
//now we need to append the query strings
actionUrl += "id=" + nodeId.EnsureEndsWith('&') + queryStrings?.ToQueryString("id");
return actionUrl;
}
/// <summary>
/// Check the provided string already includes a querystring fragment
/// If so, result has "&amp;" appended, else has "?" appended.
/// </summary>
/// <param name="actionUrl"></param>
/// <param name="delimiter"></param>
/// <returns></returns>
private static string? StartOrContinueQueryString(string? actionUrl, string? delimiter)
{
if (actionUrl is null)
{
return actionUrl;
}
return actionUrl.EnsureEndsWith(actionUrl.Contains($"{delimiter}?") ? "&" : "?");
}
}

2
src/Umbraco.Web.UI.Client/src/common/mocks/umbraco.servervariables.js
View File

@@ -32,7 +32,7 @@ Umbraco.Sys.ServerVariables = {
},
umbracoPlugins: {
trees: [
{ alias: "myTree", packageFolder: "MyPackage", sectionAlias: "myPackageSectionAlias" }
{ alias: "myTree", packageFolder: "MyPackage" }
]
},
isDebuggingEnabled: true,

7
src/Umbraco.Web.UI.Client/src/common/services/navigation.service.js
View File

@@ -616,7 +616,7 @@ function navigationService($routeParams, $location, $q, $injector, eventsService
if (!treeAlias) {
throw "Could not get tree alias for node " + args.node.id;
}
templateUrl = this.getTreeTemplateUrl(treeAlias, args.action.alias, args.node.section);
templateUrl = this.getTreeTemplateUrl(treeAlias, args.action.alias);
}
setMode("dialog");
@@ -633,7 +633,6 @@ function navigationService($routeParams, $location, $q, $injector, eventsService
*
* @param {string} treeAlias the alias of the tree to look up
* @param {string} action the view file name
* @param {string} sectionAlias the alias of the current section
* @description
* creates the templateUrl based on treeAlias and action
* by convention we will look into the /views/{treetype}/{action}.html
@@ -641,8 +640,8 @@ function navigationService($routeParams, $location, $q, $injector, eventsService
* we will also check for a 'packageName' for the current tree, if it exists then the convention will be:
* for example: /App_Plugins/{mypackage}/backoffice/{treetype}/create.html
*/
getTreeTemplateUrl: function (treeAlias, action, sectionAlias) {
var packageTreeFolder = treeService.getTreePackageFolder(treeAlias, sectionAlias);
getTreeTemplateUrl: function (treeAlias, action) {
var packageTreeFolder = treeService.getTreePackageFolder(treeAlias);
if (packageTreeFolder) {
return (Umbraco.Sys.ServerVariables.umbracoSettings.appPluginsPath +
"/" + packageTreeFolder +

28
src/Umbraco.Web.UI.Client/src/common/services/tree.service.js
View File

@@ -166,27 +166,23 @@ function treeService($q, treeResource, iconHelper, notificationsService, eventsS
*
* @description
* Determines if the current tree is a plugin tree and if so returns the package folder it has declared
* so we know where to find its views, otherwise it will just return undefined.
* so we know where to find it's views, otherwise it will just return undefined.
*
* @param {String} treeAlias The tree alias to check
* @param {String} sectionAlias The current section
*/
getTreePackageFolder: function (treeAlias, sectionAlias) {
getTreePackageFolder: function (treeAlias) {
//we determine this based on the server variables
if (!Umbraco.Sys.ServerVariables.umbracoPlugins || !Utilities.isArray(Umbraco.Sys.ServerVariables.umbracoPlugins.trees)) {
return undefined;
}
if (Umbraco.Sys.ServerVariables.umbracoPlugins &&
Umbraco.Sys.ServerVariables.umbracoPlugins.trees &&
Utilities.isArray(Umbraco.Sys.ServerVariables.umbracoPlugins.trees)) {
let found;
if (sectionAlias !== undefined) {
found = Umbraco.Sys.ServerVariables.umbracoPlugins.trees.find(item =>
invariantEquals(item.alias, treeAlias) && invariantEquals(item.sectionAlias, sectionAlias));
} else {
found = Umbraco.Sys.ServerVariables.umbracoPlugins.trees.find(item =>
invariantEquals(item.alias, treeAlias));
}
var found = _.find(Umbraco.Sys.ServerVariables.umbracoPlugins.trees, function (item) {
return invariantEquals(item.alias, treeAlias);
});
return found ? found.packageFolder : undefined;
return found ? found.packageFolder : undefined;
}
return undefined;
},
/**
@@ -872,7 +868,7 @@ function treeService($q, treeResource, iconHelper, notificationsService, eventsS
//start
var wrappedPromise = doSync();
//then wrap it
//then wrap it
wrappedPromise.then(function (args) {
deferred.resolve(args);
}, function (args) {

18
src/Umbraco.Web.UI.Client/src/routes.js
View File

@@ -1,5 +1,5 @@
window.app.config(function ($routeProvider) {
/**
* This determines if the route can continue depending on authentication and initialization requirements
* @param {boolean} authRequired If true, it checks if the user is authenticated and will resolve successfully
@@ -117,9 +117,9 @@ window.app.config(function ($routeProvider) {
template: "<div ng-include='templateUrl'></div>",
//This controller will execute for this route, then we can execute some code in order to set the template Url
controller: function ($scope, $route, $routeParams, $location, sectionService) {
//We are going to check the currently loaded sections for the user and if the section we are navigating
//to has a custom route path we'll use that
//to has a custom route path we'll use that
sectionService.getSectionsForUser().then(function(sections) {
//find the one we're requesting
var found = _.find(sections, function(s) {
@@ -175,9 +175,8 @@ window.app.config(function ($routeProvider) {
if ($routeParams.section.toLowerCase() === "users" && $routeParams.tree.toLowerCase() === "users" && usersPages.indexOf($routeParams.method.toLowerCase()) === -1) {
$scope.templateUrl = "views/users/overview.html";
return;
}
$scope.templateUrl = navigationService.getTreeTemplateUrl($routeParams.tree, $routeParams.method, $routeParams.section);
}
$scope.templateUrl = navigationService.getTreeTemplateUrl($routeParams.tree, $routeParams.method);
},
reloadOnSearch: false,
resolve: canRoute(true)
@@ -191,9 +190,8 @@ window.app.config(function ($routeProvider) {
if (!$routeParams.tree || !$routeParams.method) {
$scope.templateUrl = "views/common/dashboard.html";
return;
}
$scope.templateUrl = navigationService.getTreeTemplateUrl($routeParams.tree, $routeParams.method, $routeParams.section);
}
$scope.templateUrl = navigationService.getTreeTemplateUrl($routeParams.tree, $routeParams.method);
},
reloadOnSearch: false,
reloadOnUrl: false,
@@ -201,7 +199,7 @@ window.app.config(function ($routeProvider) {
})
.otherwise({ redirectTo: '/login' });
}).config(function ($locationProvider) {
$locationProvider.html5Mode(false); //turn html5 mode off
$locationProvider.hashPrefix('');
});

4
src/Umbraco.Web.UI.Client/test/unit/common/services/tree-service.spec.js
View File

@@ -298,13 +298,13 @@ describe('tree service tests', function () {
it('can find a plugin based tree', function () {
//we know this exists in the mock umbraco server vars
var found = treeService.getTreePackageFolder("myTree", "MyPackageSectionAlias");
var found = treeService.getTreePackageFolder("myTree");
expect(found).toBe("MyPackage");
});
it('returns undefined for a not found tree', function () {
//we know this does not exist in the mock umbraco server vars
var found = treeService.getTreePackageFolder("asdfasdf", "fdsafdsa");
var found = treeService.getTreePackageFolder("asdfasdf");
expect(found).not.toBeDefined();
});