Skip to content

Open-source eCommerce platform for C# and ASP.NET Core 10 with MongoDB. Build multi-store shops and multi-vendor marketplaces with B2B/B2C, REST API, plugins, Vue 3 and Docker.

Refactor plugin path handling to use IWebHostEnvironment

KrzysztofPajakc0a5b27f5ce0
diff --git a/src/Core/Grand.Infrastructure/Plugins/PluginManager.cs b/src/Core/Grand.Infrastructure/Plugins/PluginManager.cs
index 7c46c8153..6901d824b 100644
--- a/src/Core/Grand.Infrastructure/Plugins/PluginManager.cs
+++ b/src/Core/Grand.Infrastructure/Plugins/PluginManager.cs
@@ -1,5 +1,6 @@
using Grand.Infrastructure.Configuration;
using Grand.SharedKernel.Extensions;
+using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.Mvc.ApplicationParts;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
@@ -22,6 +23,8 @@ public static class PluginManager
private static readonly object _synLock = new();
+ private static string PluginsFolder = "Plugins";
+
#endregion
#region Fields
@@ -45,7 +48,7 @@ public static class PluginManager
/// Load plugins
/// </summary>
[MethodImpl(MethodImplOptions.NoInlining)]
- public static void Load(IMvcCoreBuilder mvcCoreBuilder, IConfiguration configuration)
+ public static void Load(IMvcCoreBuilder mvcCoreBuilder, IConfiguration configuration, IWebHostEnvironment hostEnvironment)
{
_config = new ExtensionsConfig();
configuration.GetSection("Extensions").Bind(_config);
@@ -58,9 +61,9 @@ public static class PluginManager
_logger = mvcCoreBuilder.Services.BuildServiceProvider().GetService<ILoggerFactory>()
.CreateLogger("PluginManager");
- _pluginFolder = new DirectoryInfo(CommonPath.PluginsPath);
- _copyFolder = new DirectoryInfo(CommonPath.PluginsCopyPath);
-
+ _pluginFolder = new DirectoryInfo(Path.Combine(hostEnvironment.ContentRootPath, CommonPath.Plugins));
+ _copyFolder = new DirectoryInfo(Path.Combine(hostEnvironment.ContentRootPath, CommonPath.Plugins, "bin"));
+
var referencedPlugins = new List<PluginInfo>();
try
{
diff --git a/src/Core/Grand.Infrastructure/StartupBase.cs b/src/Core/Grand.Infrastructure/StartupBase.cs
index 6cfca7b40..1a32870d1 100644
--- a/src/Core/Grand.Infrastructure/StartupBase.cs
+++ b/src/Core/Grand.Infrastructure/StartupBase.cs
@@ -125,10 +125,10 @@ public static class StartupBase
/// </summary>
/// <param name="mvcCoreBuilder"></param>
/// <param name="configuration"></param>
- private static void RegisterExtensions(IMvcCoreBuilder mvcCoreBuilder, IConfiguration configuration)
+ private static void RegisterExtensions(IMvcCoreBuilder mvcCoreBuilder, IConfiguration configuration, IWebHostEnvironment hostEnvironment)
{
- //Load plugins
- PluginManager.Load(mvcCoreBuilder, configuration);
+ //Load plugins
+ PluginManager.Load(mvcCoreBuilder, configuration, hostEnvironment);
//Load CTX scripts
RoslynCompiler.Load(mvcCoreBuilder.PartManager, configuration);
@@ -191,8 +191,7 @@ public static class StartupBase
/// <param name="services">Collection of service descriptors</param>
/// <param name="configuration">Configuration</param>
/// <param name="typeSearcher">Type searcher</param>
- private static IMvcCoreBuilder RegisterApplication(IServiceCollection services, IConfiguration configuration,
- ITypeSearcher typeSearcher)
+ private static IMvcCoreBuilder RegisterApplication(IServiceCollection services, IConfiguration configuration, IWebHostEnvironment hostingEnvironment, ITypeSearcher typeSearcher)
{
//add accessor to HttpContext
services.AddHttpContextAccessor();
@@ -202,15 +201,15 @@ public static class StartupBase
InitDatabase(services, configuration);
//set base application path
- var provider = services.BuildServiceProvider();
- var hostingEnvironment = provider.GetRequiredService<IWebHostEnvironment>();
var param = configuration["Directory"];
if (!string.IsNullOrEmpty(param))
CommonPath.Param = param;
CommonPath.WebHostEnvironment = hostingEnvironment.WebRootPath;
CommonPath.BaseDirectory = hostingEnvironment.ContentRootPath;
+
services.AddTransient<ValidationFilter>();
+
var mvcCoreBuilder = services.AddMvcCore(options =>
{
options.Filters.AddService<ValidationFilter>();
@@ -273,11 +272,14 @@ public static class StartupBase
var typeSearcher = new TypeSearcher();
services.AddSingleton<ITypeSearcher>(typeSearcher);
+ var provider = services.BuildServiceProvider();
+ var hostingEnvironment = provider.GetRequiredService<IWebHostEnvironment>();
+
//register application
- var mvcBuilder = RegisterApplication(services, configuration, typeSearcher);
+ var mvcBuilder = RegisterApplication(services, configuration, hostingEnvironment, typeSearcher);
//register extensions
- RegisterExtensions(mvcBuilder, configuration);
+ RegisterExtensions(mvcBuilder, configuration, hostingEnvironment);
var startupConfigurations = typeSearcher.ClassesOfType<IStartupApplication>();
diff --git a/src/Core/Grand.SharedKernel/Extensions/CommonPath.cs b/src/Core/Grand.SharedKernel/Extensions/CommonPath.cs
index 82a976a85..9f70aaa5a 100644
--- a/src/Core/Grand.SharedKernel/Extensions/CommonPath.cs
+++ b/src/Core/Grand.SharedKernel/Extensions/CommonPath.cs
@@ -4,6 +4,8 @@ public static class CommonPath
{
public static string AppData => "App_Data";
+ public static string Plugins => "Plugins";
+
/// <summary>
/// Extra parameter to path
/// </summary>
@@ -14,12 +16,6 @@ public static class CommonPath
/// </summary>
/// <returns>The physical path.</returns>
public static string SettingsPath => Path.Combine(BaseDirectory, AppData, Param, "Settings.cfg");
-
- /// <summary>
- /// Maps a theme path to a physical disk path.
- /// </summary>
- /// <returns>The physical path.</returns>
- public static string PluginsPath => Path.Combine(BaseDirectory, "Plugins");
/// <summary>
/// Maps a installled plugins path to a physical disk path.
@@ -27,13 +23,7 @@ public static class CommonPath
/// <returns>The physical path.</returns>
public static string InstalledPluginsFilePath =>
Path.Combine(BaseDirectory, AppData, Param, "InstalledPlugins.cfg");
-
- /// <summary>
- /// Maps a installled plugins path to a physical disk path.
- /// </summary>
- /// <returns>The physical path.</returns>
- public static string PluginsCopyPath => Path.Combine(BaseDirectory, PluginsPath, "bin");
-
+
/// <summary>
/// Maps a temp upload path to a physical disk path.
/// </summary>
diff --git a/src/Web/Grand.Web.Admin/Controllers/PluginController.cs b/src/Web/Grand.Web.Admin/Controllers/PluginController.cs
index 455b64ef1..42b024c7c 100644
--- a/src/Web/Grand.Web.Admin/Controllers/PluginController.cs
+++ b/src/Web/Grand.Web.Admin/Controllers/PluginController.cs
@@ -8,9 +8,9 @@ using Grand.Web.Admin.Extensions;
using Grand.Web.Admin.Extensions.Mapping;
using Grand.Web.Admin.Models.Plugins;
using Grand.Web.Common.DataSource;
-using Grand.Web.Common.Extensions;
using Grand.Web.Common.Localization;
using Grand.Web.Common.Security.Authorization;
+using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Hosting;
@@ -28,17 +28,10 @@ public class PluginController(
IWorkContext workContext,
IServiceProvider serviceProvider,
IEnumTranslationService enumTranslationService,
+ IWebHostEnvironment webHostEnvironment,
ExtensionsConfig extConfig)
: BaseAdminController
{
- #region Fields
-
- #endregion
-
- #region Constructors
-
- #endregion
-
#region Utilities
[NonAction]
@@ -232,7 +225,7 @@ public class PluginController(
//No plugin found with the specified id
return RedirectToAction("List");
- var pluginsPath = CommonPath.PluginsPath;
+ var pluginsPath = "Plugins";
foreach (var folder in Directory.GetDirectories(pluginsPath))
if (Path.GetFileName(folder) != "bin" && Directory.GetFiles(folder).Select(x => Path.GetFileName(x))
@@ -322,7 +315,7 @@ public class PluginController(
private void Upload(string archivePath)
{
- var pluginsDirectory = CommonPath.PluginsPath;
+ var pluginsPath = Path.Combine(webHostEnvironment.ContentRootPath, CommonPath.Plugins);
var uploadedItemDirectoryName = "";
PluginInfo _pluginInfo = null;
using (var archive = ZipFile.Open(archivePath, ZipArchiveMode.Update))
@@ -393,7 +386,7 @@ public class PluginController(
if (string.IsNullOrEmpty(uploadedItemDirectoryName))
throw new Exception("Cannot get the plugin directory name");
- var pathToUpload = Path.Combine(pluginsDirectory, uploadedItemDirectoryName);
+ var pathToUpload = Path.Combine(pluginsPath, uploadedItemDirectoryName);
try
{
@@ -402,7 +395,7 @@ public class PluginController(
}
catch { }
- ZipFile.ExtractToDirectory(archivePath, pluginsDirectory);
+ ZipFile.ExtractToDirectory(archivePath, pluginsPath);
}
#endregion
diff --git a/src/Web/Grand.Web.Common/Infrastructure/ApplicationBuilderExtensions.cs b/src/Web/Grand.Web.Common/Infrastructure/ApplicationBuilderExtensions.cs
index a0264f1ba..20dc168cf 100644
--- a/src/Web/Grand.Web.Common/Infrastructure/ApplicationBuilderExtensions.cs
+++ b/src/Web/Grand.Web.Common/Infrastructure/ApplicationBuilderExtensions.cs
@@ -185,12 +185,14 @@ public static class ApplicationBuilderExtensions
ctx.Context.Response.Headers.Append(HeaderNames.CacheControl, appConfig.StaticFilesCacheControl);
}
});
+ var webHostEnvironment = application.ApplicationServices.GetRequiredService<IWebHostEnvironment>();
+ var pluginsPath = Path.Combine(webHostEnvironment.ContentRootPath, CommonPath.Plugins);
//plugins
- if (Directory.Exists(CommonPath.PluginsPath))
+ if (Directory.Exists(pluginsPath))
application.UseStaticFiles(new StaticFileOptions {
- FileProvider = new PhysicalFileProvider(CommonPath.PluginsPath),
- RequestPath = new PathString("/Plugins"),
+ FileProvider = new PhysicalFileProvider(pluginsPath),
+ RequestPath = new PathString($"/{CommonPath.Plugins}"),
OnPrepareResponse = ctx =>
{
if (!string.IsNullOrEmpty(appConfig.StaticFilesCacheControl))