Improve configuration file handling logic (#1317)

Author: pakrym

src/AspNetCoreModuleV2/AspNetCore/AspNetCore.vcxproj

@@ -231,7 +231,7 @@
     <ClInclude Include="applicationinfo.h" />
     <ClInclude Include="AppOfflineApplication.h" />
     <ClInclude Include="AppOfflineHandler.h" />
-    <ClInclude Include="aspnetcore_shim_config.h" />
+    <ClInclude Include="ShimOptions.h" />
     <ClInclude Include="globalmodule.h" />
     <ClInclude Include="applicationmanager.h" />
     <ClInclude Include="HandlerResolver.h" />
@@ -246,7 +246,7 @@
     <ClCompile Include="applicationmanager.cpp" />
     <ClCompile Include="AppOfflineApplication.cpp" />
     <ClCompile Include="AppOfflineHandler.cpp" />
-    <ClCompile Include="aspnetcore_shim_config.cpp" />
+    <ClCompile Include="ShimOptions.cpp" />
     <ClCompile Include="dllmain.cpp" />
     <ClCompile Include="globalmodule.cpp" />
     <ClCompile Include="HandlerResolver.cpp" />

src/AspNetCoreModuleV2/AspNetCore/HandlerResolver.cpp

@@ -12,6 +12,8 @@
 #include "file_utility.h"
 #include "LoggingHelpers.h"
 #include "resources.h"
+#include "ConfigurationLoadException.h"
+#include "WebConfigConfigurationSource.h"
 
 const PCWSTR HandlerResolver::s_pwzAspnetcoreInProcessRequestHandlerName = L"aspnetcorev2_inprocess.dll";
 const PCWSTR HandlerResolver::s_pwzAspnetcoreOutOfProcessRequestHandlerName = L"aspnetcorev2_outofprocess.dll";
@@ -25,7 +27,7 @@ HandlerResolver::HandlerResolver(HMODULE hModule, IHttpServer &pServer)
 }
 
 HRESULT
-HandlerResolver::LoadRequestHandlerAssembly(IHttpApplication &pApplication, ASPNETCORE_SHIM_CONFIG& pConfiguration, std::unique_ptr<ApplicationFactory>& pApplicationFactory)
+HandlerResolver::LoadRequestHandlerAssembly(IHttpApplication &pApplication, ShimOptions& pConfiguration, std::unique_ptr<ApplicationFactory>& pApplicationFactory)
 {
     HRESULT hr;
     PCWSTR              pstrHandlerDllName;
@@ -65,7 +67,7 @@ HandlerResolver::LoadRequestHandlerAssembly(IHttpApplication &pApplication, ASPN
             RETURN_IF_FAILED(LoggingHelpers::CreateLoggingProvider(
                 pConfiguration.QueryStdoutLogEnabled(),
                 !m_pServer.IsCommandLineLaunch(),
-                pConfiguration.QueryStdoutLogFile()->QueryStr(),
+                pConfiguration.QueryStdoutLogFile().c_str(),
                 pApplication.GetApplicationPhysicalPath(),
                 outputManager));
 
@@ -129,20 +131,20 @@ HandlerResolver::GetApplicationFactory(IHttpApplication &pApplication, std::uniq
 {
     try
     {
-        ASPNETCORE_SHIM_CONFIG pConfiguration;
-        RETURN_IF_FAILED(pConfiguration.Populate(&m_pServer, &pApplication));
+        const WebConfigConfigurationSource configurationSource(m_pServer.GetAdminManager(), pApplication);
+        ShimOptions options(configurationSource);
 
         SRWExclusiveLock lock(m_requestHandlerLoadLock);
         if (m_loadedApplicationHostingModel != HOSTING_UNKNOWN)
         {
             // Mixed hosting models
-            if (m_loadedApplicationHostingModel != pConfiguration.QueryHostingModel())
+            if (m_loadedApplicationHostingModel != options.QueryHostingModel())
             {
                 EventLog::Error(
                     ASPNETCORE_EVENT_MIXED_HOSTING_MODEL_ERROR,
                     ASPNETCORE_EVENT_MIXED_HOSTING_MODEL_ERROR_MSG,
                     pApplication.GetApplicationId(),
-                    pConfiguration.QueryHostingModel());
+                    options.QueryHostingModel());
 
                 return E_FAIL;
             }
@@ -158,11 +160,20 @@ HandlerResolver::GetApplicationFactory(IHttpApplication &pApplication, std::uniq
             }
         }
 
-        m_loadedApplicationHostingModel = pConfiguration.QueryHostingModel();
+        m_loadedApplicationHostingModel = options.QueryHostingModel();
         m_loadedApplicationId = pApplication.GetApplicationId();
-        RETURN_IF_FAILED(LoadRequestHandlerAssembly(pApplication, pConfiguration, pApplicationFactory));
+        RETURN_IF_FAILED(LoadRequestHandlerAssembly(pApplication, options, pApplicationFactory));
 
     }
+    catch(ConfigurationLoadException &ex)
+    {
+        EventLog::Error(
+            ASPNETCORE_CONFIGURATION_LOAD_ERROR,
+            ASPNETCORE_CONFIGURATION_LOAD_ERROR_MSG,
+            ex.get_message().c_str());
+
+        RETURN_HR(E_FAIL);
+    }
     CATCH_RETURN();
 
     return S_OK;
@@ -178,7 +189,7 @@ void HandlerResolver::ResetHostingModel()
 
 HRESULT
 HandlerResolver::FindNativeAssemblyFromGlobalLocation(
-    ASPNETCORE_SHIM_CONFIG& pConfiguration,
+    ShimOptions& pConfiguration,
     PCWSTR pstrHandlerDllName,
     std::wstring& handlerDllPath
 )

src/AspNetCoreModuleV2/AspNetCore/HandlerResolver.h

@@ -2,10 +2,10 @@
 // Licensed under the MIT License. See License.txt in the project root for license information.
 
 #pragma once
-#include "aspnetcore_shim_config.h"
 
 #include <memory>
 #include <string>
+#include "ShimOptions.h"
 #include "hostfxroptions.h"
 #include "HandleWrapper.h"
 #include "ApplicationFactory.h"
@@ -18,8 +18,8 @@ class HandlerResolver
     void ResetHostingModel();
 
 private:
-    HRESULT LoadRequestHandlerAssembly(IHttpApplication &pApplication, ASPNETCORE_SHIM_CONFIG& pConfiguration, std::unique_ptr<ApplicationFactory>& pApplicationFactory);
-    HRESULT FindNativeAssemblyFromGlobalLocation(ASPNETCORE_SHIM_CONFIG& pConfiguration, PCWSTR libraryName, std::wstring& handlerDllPath);
+    HRESULT LoadRequestHandlerAssembly(IHttpApplication &pApplication, ShimOptions& pConfiguration, std::unique_ptr<ApplicationFactory>& pApplicationFactory);
+    HRESULT FindNativeAssemblyFromGlobalLocation(ShimOptions& pConfiguration, PCWSTR libraryName, std::wstring& handlerDllPath);
     HRESULT FindNativeAssemblyFromHostfxr(HOSTFXR_OPTIONS& hostfxrOptions, PCWSTR libraryName, std::wstring& handlerDllPath);
 
     HMODULE m_hModule;

src/AspNetCoreModuleV2/AspNetCore/PollingAppOfflineApplication.h

@@ -15,7 +15,7 @@ class PollingAppOfflineApplication: public APPLICATION
 {
 public:
     PollingAppOfflineApplication(IHttpApplication& pApplication, PollingAppOfflineApplicationMode mode)
-        :
+        : APPLICATION(pApplication),
         m_ulLastCheckTime(0),
         m_appOfflineLocation(GetAppOfflineLocation(pApplication)),
         m_fAppOfflineFound(false),

src/AspNetCoreModuleV2/AspNetCore/ShimOptions.cpp

@@ -0,0 +1,43 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the MIT License. See License.txt in the project root for license information.
+
+#include "ShimOptions.h"
+
+#include "StringHelpers.h"
+#include "ConfigurationLoadException.h"
+
+#define CS_ASPNETCORE_HANDLER_VERSION                    L"handlerVersion"
+
+ShimOptions::ShimOptions(const ConfigurationSource &configurationSource) :
+        m_hostingModel(HOSTING_UNKNOWN),
+        m_fStdoutLogEnabled(false)
+{
+    auto const section = configurationSource.GetRequiredSection(CS_ASPNETCORE_SECTION);
+    auto hostingModel = section->GetString(CS_ASPNETCORE_HOSTING_MODEL).value_or(L"");
+
+    if (hostingModel.empty() || equals_ignore_case(hostingModel, CS_ASPNETCORE_HOSTING_MODEL_OUTOFPROCESS))
+    {
+        m_hostingModel = HOSTING_OUT_PROCESS;
+    }
+    else if (equals_ignore_case(hostingModel, CS_ASPNETCORE_HOSTING_MODEL_INPROCESS))
+    {
+        m_hostingModel = HOSTING_IN_PROCESS;
+    }
+    else
+    {
+        throw ConfigurationLoadException(format(
+            L"Unknown hosting model '%s'. Please specify either hostingModel=\"inprocess\" "
+            "or hostingModel=\"outofprocess\" in the web.config file.", hostingModel.c_str()));
+    }
+
+    if (m_hostingModel == HOSTING_OUT_PROCESS)
+    {
+        const auto handlerSettings = section->GetKeyValuePairs(CS_ASPNETCORE_HANDLER_SETTINGS);
+        m_strHandlerVersion = find_element(handlerSettings, CS_ASPNETCORE_HANDLER_VERSION).value_or(std::wstring());
+    }
+
+    m_strProcessPath = section->GetRequiredString(CS_ASPNETCORE_PROCESS_EXE_PATH);
+    m_strArguments = section->GetString(CS_ASPNETCORE_PROCESS_ARGUMENTS).value_or(CS_ASPNETCORE_PROCESS_ARGUMENTS_DEFAULT);
+    m_fStdoutLogEnabled = section->GetRequiredBool(CS_ASPNETCORE_STDOUT_LOG_ENABLED);
+    m_struStdoutLogFile = section->GetRequiredString(CS_ASPNETCORE_STDOUT_LOG_FILE);
+}

src/AspNetCoreModuleV2/AspNetCore/ShimOptions.h

@@ -0,0 +1,65 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the MIT License. See License.txt in the project root for license information.
+
+#pragma once
+
+#include <string>
+#include "ConfigurationSource.h"
+#include "exceptions.h"
+
+enum APP_HOSTING_MODEL
+{
+    HOSTING_UNKNOWN = 0,
+    HOSTING_IN_PROCESS,
+    HOSTING_OUT_PROCESS
+};
+
+class ShimOptions: NonCopyable
+{
+public:
+    const std::wstring&
+    QueryProcessPath() const
+    {
+        return m_strProcessPath;
+    }
+
+    const std::wstring&
+    QueryArguments() const
+    {
+        return m_strArguments;
+    }
+
+    APP_HOSTING_MODEL
+    QueryHostingModel() const
+    {
+        return m_hostingModel;
+    }
+
+    const std::wstring&
+    QueryHandlerVersion() const
+    {
+        return m_strHandlerVersion;
+    }
+
+    BOOL
+    QueryStdoutLogEnabled() const
+    {
+        return m_fStdoutLogEnabled;
+    }
+
+    const std::wstring&
+    QueryStdoutLogFile() const
+    {
+        return m_struStdoutLogFile;
+    }
+
+    ShimOptions(const ConfigurationSource &configurationSource);
+
+private:
+    std::wstring                   m_strArguments;
+    std::wstring                   m_strProcessPath;
+    APP_HOSTING_MODEL              m_hostingModel;
+    std::wstring                   m_strHandlerVersion;
+    std::wstring                   m_struStdoutLogFile;
+    bool                           m_fStdoutLogEnabled;
+};

src/AspNetCoreModuleV2/AspNetCore/applicationinfo.h

@@ -4,7 +4,6 @@
 #pragma once
 
 #include "hostfxroptions.h"
-#include "aspnetcore_shim_config.h"
 #include "iapplication.h"
 #include "SRWSharedLock.h"
 #include "HandlerResolver.h"