//****************************************************************************************************** // WebPageController.cs - Gbtc // // Copyright © 2016, Grid Protection Alliance. All Rights Reserved. // // Licensed to the Grid Protection Alliance (GPA) under one or more contributor license agreements. See // the NOTICE file distributed with this work for additional information regarding copyright ownership. // The GPA licenses this file to you under the MIT License (MIT), the "License"; you may not use this // file except in compliance with the License. You may obtain a copy of the License at: // // http://opensource.org/licenses/MIT // // Unless agreed to in writing, the subject software distributed under the License is distributed on an // "AS-IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. Refer to the // License for the specific language governing permissions and limitations. // // Code Modification History: // ---------------------------------------------------------------------------------------------------- // 01/12/2016 - Ritchie Carroll // Generated original version of source code. // //****************************************************************************************************** using System; using System.Collections.Generic; using System.Net.Http; using System.Threading; using System.Threading.Tasks; using System.Web.Http; using System.Web.Http.Dependencies; using GSF.Data; using GSF.Web.Model; namespace GSF.Web.Hosting { /// /// Defines a mini-web server with Razor support using the self-hosted API controller. /// public class WebPageController : ApiController { #region [ Members ] // Nested Types // Web page controller dependency resolver private sealed class WebPageControllerResolver : IDependencyResolver { private readonly WebServer m_webServer; private readonly string m_defaultWebPage; private readonly object m_model; private readonly Type m_modelType; private readonly AdoDataConnection m_database; public WebPageControllerResolver(WebServer webServer, string defaultWebPage, object model, Type modelType, AdoDataConnection database) { m_webServer = webServer; m_defaultWebPage = defaultWebPage; m_model = model; m_modelType = modelType; m_database = database; } void IDisposable.Dispose() { } public object GetService(Type serviceType) { if (serviceType == typeof(WebPageController)) return new WebPageController(m_webServer) { DefaultWebPage = m_defaultWebPage, Model = m_model, ModelType = m_modelType, Database = m_database }; return null; } public IEnumerable GetServices(Type serviceType) { if (serviceType == typeof(WebPageController)) return new[] { new WebPageController(m_webServer) { DefaultWebPage = m_defaultWebPage, Model = m_model, ModelType = m_modelType, Database = m_database } }; return new List(); } public IDependencyScope BeginScope() => this; } // Fields private readonly WebServer m_webServer; #endregion #region [ Constructors ] /// /// Creates a new using the default configured instance. /// public WebPageController() : this(null) { } /// /// Creates a new using specified . /// /// instance to use for controller; uses default instance if not provided. public WebPageController(WebServer webServer) { m_webServer = webServer ?? WebServer.Default; DefaultWebPage = "Index.html"; } #endregion #region [ Properties ] /// /// Gets or sets default web page to use for this . /// public string DefaultWebPage { get; set; } /// /// Gets or sets the model instance for this , if any. /// public object Model { get; set; } /// /// Gets or sets the model for this , if any. /// public Type ModelType { get; set; } /// /// Gets or sets database connection to provide to instances in this , if any. /// public AdoDataConnection Database { get; set; } /// /// Gets the instance used by this . /// public WebServer WebServer => m_webServer; #endregion #region [ Methods ] /// /// Default page request handler. /// /// Propagates notification from client that operations should be canceled. /// Rendered page result for given page. [Route, HttpGet] public Task GetPage(CancellationToken cancellationToken) { return GetPage(DefaultWebPage, cancellationToken); } /// /// Common page request handler. /// /// Page name to render. /// Propagates notification from client that operations should be canceled. /// Rendered page result for given page. [Route("{pageName}"), HttpGet] public Task GetPage(string pageName, CancellationToken cancellationToken) { return m_webServer.RenderResponse(Request, pageName, false, cancellationToken, Model, ModelType, Database); } /// /// Common post request handler. /// /// Page name to render. /// Propagates notification from client that operations should be canceled. /// Rendered page result for given page. [Route("{pageName}"), HttpPost] public Task PostPage(string pageName, CancellationToken cancellationToken) { return m_webServer.RenderResponse(Request, pageName, true, cancellationToken, Model, ModelType, Database); } #region [ Sub-folder Handlers ] /// /// Sub-folder request handler - depth 1. /// /// First folder. /// Page name to render. /// Propagates notification from client that operations should be canceled. /// Rendered page result for given page and path. [Route("{folder1}/{pageName}"), HttpGet] public Task GetPage(string folder1, string pageName, CancellationToken cancellationToken) { return GetPage($"{folder1}/{pageName}", cancellationToken); } /// /// // Sub-folder post handler - depth 1. /// /// First folder. /// Page name to render. /// Propagates notification from client that operations should be canceled. /// Rendered page result for given page and path. [Route("{folder1}/{pageName}"), HttpPost] public Task PostPage(string folder1, string pageName, CancellationToken cancellationToken) { return PostPage($"{folder1}/{pageName}", cancellationToken); } /// /// Sub-folder request handler - depth 2. /// /// First folder. /// Second folder. /// Page name to render. /// Propagates notification from client that operations should be canceled. /// Rendered page result for given page and path. [Route("{folder1}/{folder2}/{pageName}"), HttpGet] public Task GetPage(string folder1, string folder2, string pageName, CancellationToken cancellationToken) { return GetPage($"{folder1}/{folder2}/{pageName}", cancellationToken); } /// /// Sub-folder post handler - depth 2. /// /// First folder. /// Second folder. /// Page name to render. /// Propagates notification from client that operations should be canceled. /// Rendered page result for given page and path. [Route("{folder1}/{folder2}/{pageName}"), HttpPost] public Task PostPage(string folder1, string folder2, string pageName, CancellationToken cancellationToken) { return PostPage($"{folder1}/{folder2}/{pageName}", cancellationToken); } /// /// Sub-folder request handler - depth 3. /// /// First folder. /// Second folder. /// Third folder. /// Page name to render. /// Propagates notification from client that operations should be canceled. /// Rendered page result for given page and path. [Route("{folder1}/{folder2}/{folder3}/{pageName}"), HttpGet] public Task GetPage(string folder1, string folder2, string folder3, string pageName, CancellationToken cancellationToken) { return GetPage($"{folder1}/{folder2}/{folder3}/{pageName}", cancellationToken); } /// /// Sub-folder post handler - depth 3. /// /// First folder. /// Second folder. /// Third folder. /// Page name to render. /// Propagates notification from client that operations should be canceled. /// Rendered page result for given page and path. [Route("{folder1}/{folder2}/{folder3}/{pageName}"), HttpPost] public Task PostPage(string folder1, string folder2, string folder3, string pageName, CancellationToken cancellationToken) { return PostPage($"{folder1}/{folder2}/{folder3}/{pageName}", cancellationToken); } /// /// Sub-folder request handler - depth 4. /// /// First folder. /// Second folder. /// Third folder. /// Fourth folder. /// Page name to render. /// Propagates notification from client that operations should be canceled. /// Rendered page result for given page and path. [Route("{folder1}/{folder2}/{folder3}/{folder4}/{pageName}"), HttpGet] public Task GetPage(string folder1, string folder2, string folder3, string folder4, string pageName, CancellationToken cancellationToken) { return GetPage($"{folder1}/{folder2}/{folder3}/{folder4}/{pageName}", cancellationToken); } /// /// Sub-folder post handler - depth 4. /// /// First folder. /// Second folder. /// Third folder. /// Fourth folder. /// Page name to render. /// Propagates notification from client that operations should be canceled. /// Rendered page result for given page and path. [Route("{folder1}/{folder2}/{folder3}/{folder4}/{pageName}"), HttpPost] public Task PostPage(string folder1, string folder2, string folder3, string folder4, string pageName, CancellationToken cancellationToken) { return PostPage($"{folder1}/{folder2}/{folder3}/{folder4}/{pageName}", cancellationToken); } /// /// Sub-folder request handler - depth 5. /// /// First folder. /// Second folder. /// Third folder. /// Fourth folder. /// Fifth folder. /// Page name to render. /// Propagates notification from client that operations should be canceled. /// Rendered page result for given page and path. [Route("{folder1}/{folder2}/{folder3}/{folder4}/{folder5}/{pageName}"), HttpGet] public Task GetPage(string folder1, string folder2, string folder3, string folder4, string folder5, string pageName, CancellationToken cancellationToken) { return GetPage($"{folder1}/{folder2}/{folder3}/{folder4}/{folder5}/{pageName}", cancellationToken); } /// /// Sub-folder post handler - depth 5. /// /// First folder. /// Second folder. /// Third folder. /// Fourth folder. /// Fifth folder. /// Page name to render. /// Propagates notification from client that operations should be canceled. /// Rendered page result for given page and path. [Route("{folder1}/{folder2}/{folder3}/{folder4}/{folder5}/{pageName}"), HttpPost] public Task PostPage(string folder1, string folder2, string folder3, string folder4, string folder5, string pageName, CancellationToken cancellationToken) { return PostPage($"{folder1}/{folder2}/{folder3}/{folder4}/{folder5}/{pageName}", cancellationToken); } /// /// Sub-folder request handler - depth 6. /// /// First folder. /// Second folder. /// Third folder. /// Fourth folder. /// Fifth folder. /// Sixth folder. /// Page name to render. /// Propagates notification from client that operations should be canceled. /// Rendered page result for given page and path. [Route("{folder1}/{folder2}/{folder3}/{folder4}/{folder5}/{folder6}/{pageName}"), HttpGet] public Task GetPage(string folder1, string folder2, string folder3, string folder4, string folder5, string folder6, string pageName, CancellationToken cancellationToken) { return GetPage($"{folder1}/{folder2}/{folder3}/{folder4}/{folder5}/{folder6}/{pageName}", cancellationToken); } /// /// Sub-folder post handler - depth 6. /// /// First folder. /// Second folder. /// Third folder. /// Fourth folder. /// Fifth folder. /// Sixth folder. /// Page name to render. /// Propagates notification from client that operations should be canceled. /// Rendered page result for given page and path. [Route("{folder1}/{folder2}/{folder3}/{folder4}/{folder5}/{folder6}/{pageName}"), HttpPost] public Task PostPage(string folder1, string folder2, string folder3, string folder4, string folder5, string folder6, string pageName, CancellationToken cancellationToken) { return PostPage($"{folder1}/{folder2}/{folder3}/{folder4}/{folder5}/{folder6}/{pageName}", cancellationToken); } /// /// Sub-folder request handler - depth 7. /// /// First folder. /// Second folder. /// Third folder. /// Fourth folder. /// Fifth folder. /// Sixth folder. /// Seventh folder. /// Page name to render. /// Propagates notification from client that operations should be canceled. /// Rendered page result for given page and path. [Route("{folder1}/{folder2}/{folder3}/{folder4}/{folder5}/{folder6}/{folder7}/{pageName}"), HttpGet] public Task GetPage(string folder1, string folder2, string folder3, string folder4, string folder5, string folder6, string folder7, string pageName, CancellationToken cancellationToken) { return GetPage($"{folder1}/{folder2}/{folder3}/{folder4}/{folder5}/{folder6}/{folder7}/{pageName}", cancellationToken); } /// /// Sub-folder post handler - depth 7. /// /// First folder. /// Second folder. /// Third folder. /// Fourth folder. /// Fifth folder. /// Sixth folder. /// Seventh folder. /// Page name to render. /// Propagates notification from client that operations should be canceled. /// Rendered page result for given page and path. [Route("{folder1}/{folder2}/{folder3}/{folder4}/{folder5}/{folder6}/{folder7}/{pageName}"), HttpPost] public Task PostPage(string folder1, string folder2, string folder3, string folder4, string folder5, string folder6, string folder7, string pageName, CancellationToken cancellationToken) { return PostPage($"{folder1}/{folder2}/{folder3}/{folder4}/{folder5}/{folder6}/{folder7}/{pageName}", cancellationToken); } /// /// Sub-folder request handler - depth 8. /// /// First folder. /// Second folder. /// Third folder. /// Fourth folder. /// Fifth folder. /// Sixth folder. /// Seventh folder. /// Eighth folder. /// Page name to render. /// Propagates notification from client that operations should be canceled. /// Rendered page result for given page and path. [Route("{folder1}/{folder2}/{folder3}/{folder4}/{folder5}/{folder6}/{folder7}/{folder8}/{pageName}"), HttpGet] public Task GetPage(string folder1, string folder2, string folder3, string folder4, string folder5, string folder6, string folder7, string folder8, string pageName, CancellationToken cancellationToken) { return GetPage($"{folder1}/{folder2}/{folder3}/{folder4}/{folder5}/{folder6}/{folder7}/{folder8}/{pageName}", cancellationToken); } /// /// Sub-folder post handler - depth 8. /// /// First folder. /// Second folder. /// Third folder. /// Fourth folder. /// Fifth folder. /// Sixth folder. /// Seventh folder. /// Eighth folder. /// Page name to render. /// Propagates notification from client that operations should be canceled. /// Rendered page result for given page and path. [Route("{folder1}/{folder2}/{folder3}/{folder4}/{folder5}/{folder6}/{folder7}/{folder8}/{pageName}"), HttpPost] public Task PostPage(string folder1, string folder2, string folder3, string folder4, string folder5, string folder6, string folder7, string folder8, string pageName, CancellationToken cancellationToken) { return PostPage($"{folder1}/{folder2}/{folder3}/{folder4}/{folder5}/{folder6}/{folder7}/{folder8}/{pageName}", cancellationToken); } /// /// Sub-folder request handler - depth 9. /// /// First folder. /// Second folder. /// Third folder. /// Fourth folder. /// Fifth folder. /// Sixth folder. /// Seventh folder. /// Eighth folder. /// Ninth folder. /// Page name to render. /// Propagates notification from client that operations should be canceled. /// Rendered page result for given page and path. [Route("{folder1}/{folder2}/{folder3}/{folder4}/{folder5}/{folder6}/{folder7}/{folder8}/{folder9}/{pageName}"), HttpGet] public Task GetPage(string folder1, string folder2, string folder3, string folder4, string folder5, string folder6, string folder7, string folder8, string folder9, string pageName, CancellationToken cancellationToken) { return GetPage($"{folder1}/{folder2}/{folder3}/{folder4}/{folder5}/{folder6}/{folder7}/{folder8}/{folder9}/{pageName}", cancellationToken); } /// /// Sub-folder post handler - depth 9. /// /// First folder. /// Second folder. /// Third folder. /// Fourth folder. /// Fifth folder. /// Sixth folder. /// Seventh folder. /// Eighth folder. /// Ninth folder. /// Page name to render. /// Propagates notification from client that operations should be canceled. /// Rendered page result for given page and path. [Route("{folder1}/{folder2}/{folder3}/{folder4}/{folder5}/{folder6}/{folder7}/{folder8}/{folder9}/{pageName}"), HttpPost] public Task PostPage(string folder1, string folder2, string folder3, string folder4, string folder5, string folder6, string folder7, string folder8, string folder9, string pageName, CancellationToken cancellationToken) { return PostPage($"{folder1}/{folder2}/{folder3}/{folder4}/{folder5}/{folder6}/{folder7}/{folder8}/{folder9}/{pageName}", cancellationToken); } /// /// Sub-folder request handler - depth 10. /// /// First folder. /// Second folder. /// Third folder. /// Fourth folder. /// Fifth folder. /// Sixth folder. /// Seventh folder. /// Eighth folder. /// Ninth folder. /// Tenth folder. /// Page name to render. /// Propagates notification from client that operations should be canceled. /// Rendered page result for given page and path. [Route("{folder1}/{folder2}/{folder3}/{folder4}/{folder5}/{folder6}/{folder7}/{folder8}/{folder9}/{folder10}/{pageName}"), HttpGet] public Task GetPage(string folder1, string folder2, string folder3, string folder4, string folder5, string folder6, string folder7, string folder8, string folder9, string folder10, string pageName, CancellationToken cancellationToken) { return GetPage($"{folder1}/{folder2}/{folder3}/{folder4}/{folder5}/{folder6}/{folder7}/{folder8}/{folder9}/{folder10}/{pageName}", cancellationToken); } /// /// Sub-folder post handler - depth 10. /// /// First folder. /// Second folder. /// Third folder. /// Fourth folder. /// Fifth folder. /// Sixth folder. /// Seventh folder. /// Eighth folder. /// Ninth folder. /// Tenth folder. /// Page name to render. /// Propagates notification from client that operations should be canceled. /// Rendered page result for given page and path. [Route("{folder1}/{folder2}/{folder3}/{folder4}/{folder5}/{folder6}/{folder7}/{folder8}/{folder9}/{folder10}/{pageName}"), HttpPost] public Task PostPage(string folder1, string folder2, string folder3, string folder4, string folder5, string folder6, string folder7, string folder8, string folder9, string folder10, string pageName, CancellationToken cancellationToken) { return PostPage($"{folder1}/{folder2}/{folder3}/{folder4}/{folder5}/{folder6}/{folder7}/{folder8}/{folder9}/{folder10}/{pageName}", cancellationToken); } #endregion #endregion #region [ Static ] // Static Methods /// /// Gets a dependency resolver. /// /// instance to use for controller; uses default instance if not provided. /// Default web page name to use for controller; uses "index.html" if not provided. /// Reference to model to use when rendering Razor templates, if any. /// Type of , if any. /// to use, if any. /// Dependency resolver for the specified parameters. public static IDependencyResolver GetDependencyResolver(WebServer webServer, string defaultWebPage = null, object model = null, Type modelType = null, AdoDataConnection connection = null) { return new WebPageControllerResolver(webServer, defaultWebPage, model, modelType, connection); } #endregion } }