Introduce WebFormsTopicLookupService

The legacy **OnTopic Editor** relies on a `DefaultConfiguration` attribute—previously exposed on `AttributeDescriptor`—for type specific configuration values. This was removed in **OnTopic Library 4.0.0**. Instead, it's now available on the `ConfigurableAttributeDescriptor`, which is part of **OnTopic Web Forms 4.0.0**. That said, in order for topics to be reliable created as such, the `TopicFactory.TypeLookupService` needs to be replaced with a `TypeLookupService` that's aware of the `ConfigurableAttribtueDescriptor`. This is done using the `WebFormsTopicLookupService`. (_Note:_ The **OnTopic Web Forms 4.0.0** library contains such a service as well, but there's a bug in it making it unusable for our needs; that bug will be fixes in an upcoming hotfix, but for now this should satisfy its requirements.) In addition, because the `ContentTypeDescriptor.AttributeDescriptors` collection stores values as `AttributeDescriptor`s, they need to be cast back to `ConfigurableAttributeDescriptor` anytime the code needs to operate off of the `DefaultConfiguration` or related members (e.g., `GetConfigurationValue()`).

Author: JeremyCaney

OnTopic.Editor.Web.Host/Global.asax.cs

@@ -8,6 +8,7 @@
 using System.Web.Routing;
 using OnTopic.Data.Caching;
 using OnTopic.Data.Sql;
+using OnTopic.Web;
 
 namespace OnTopic.Editor.Web.Host {
 
@@ -28,6 +29,15 @@ public class Global : System.Web.HttpApplication {
     [Obsolete]
     protected void Application_Start(object sender, EventArgs e) {
 
+      /*------------------------------------------------------------------------------------------------------------------------
+      | ESTABLISH TOPIC LOOKUP SERVICE
+      >-------------------------------------------------------------------------------------------------------------------------
+      | This ensures that the TopicFactory is able to correctly create `ConfigurableAttributeDescriptor` topics as their
+      | strongly typed class, which is necessary to provide access to members which parse and query the DefaultConfiguration
+      | property.
+      \-----------------------------------------------------------------------------------------------------------------------*/
+      TopicFactory.TypeLookupService = new OnTopic.Editor.Web.WebFormsTopicLookupService();
+
       /*------------------------------------------------------------------------------------------------------------------------
       | CONFIGURE REPOSITORY
       \-----------------------------------------------------------------------------------------------------------------------*/

OnTopic.Editor.Web.Host/OnTopic.Editor.Web.Host.csproj

@@ -150,9 +150,9 @@
     <Folder Include="App_Data\" />
   </ItemGroup>
   <ItemGroup>
-    <ProjectReference Include="..\OnTopic.Web\OnTopic.Web.csproj">
-      <Project>{c98f7b48-a085-4394-b820-c244f23868ce}</Project>
-      <Name>OnTopic.Web</Name>
+    <ProjectReference Include="..\OnTopic.Editor.Web\OnTopic.Editor.Web.csproj">
+      <Project>{ed551277-df8a-4027-863f-7f8f72ca678c}</Project>
+      <Name>OnTopic.Editor.Web</Name>
     </ProjectReference>
   </ItemGroup>
   <PropertyGroup>

OnTopic.Editor.Web/Default.aspx.cs

@@ -31,7 +31,7 @@ public partial class TopicsEditorPage : TopicPage {
   | PRIVATE FIELDS
   \---------------------------------------------------------------------------------------------------------------------------*/
   private       ContentTypeDescriptor           _contentType            = null;
-  private       List<Ignia.Topics.AttributeDescriptor>    _contentTypeAttributes  = null;
+  private       List<ConfigurableAttributeDescriptor> _contentTypeAttributes  = null;
 
   /*============================================================================================================================
   | PUBLIC PROPERTIES
@@ -204,7 +204,7 @@ public ContentTypeDescriptor ContentType {
   ///   Automatically crawls up the ContentType hierarchy to add any Attributes inherited from parent ContentTypes; this
   ///   allows ContentTypes to be nested, thus deriving properties from their parents.
   /// </remarks>
-  public List<Ignia.Topics.AttributeDescriptor> ContentTypeAttributes {
+  public List<ConfigurableAttributeDescriptor> ContentTypeAttributes {
     get {
 
       /*------------------------------------------------------------------------------------------------------------------------
@@ -215,12 +215,12 @@ public List<Ignia.Topics.AttributeDescriptor> ContentTypeAttributes {
       /*------------------------------------------------------------------------------------------------------------------------
       | Look up Content Type Topic Attributes
       \-----------------------------------------------------------------------------------------------------------------------*/
-      _contentTypeAttributes    = new List<Ignia.Topics.AttributeDescriptor>();
+      _contentTypeAttributes    = new List<ConfigurableAttributeDescriptor>();
 
       if (ContentType != null) {
 
         // Get Attributes
-        _contentTypeAttributes  = ContentType.AttributeDescriptors.ToList();
+        _contentTypeAttributes  = ContentType.AttributeDescriptors.Cast<ConfigurableAttributeDescriptor>().ToList();
 
         // Set Order
         _contentTypeAttributes  = _contentTypeAttributes
@@ -323,7 +323,7 @@ public void AddAttributesToPage() {
     // Attributes are drawn based on the defined ContentType's Attributes, as opposed to the Attributes found in the current
     // Topic. As a result, any "ad hoc" attributes added programmatically or orphaned from a previous ContentType setting will
     // not be displayed.
-    foreach (Ignia.Topics.AttributeDescriptor contentTypeAttribute in ContentTypeAttributes) {
+    foreach (ConfigurableAttributeDescriptor contentTypeAttribute in ContentTypeAttributes) {
 
       /*------------------------------------------------------------------------------------------------------------------------
       | Ignore hidden Attributes

OnTopic.Editor.Web/Infrastructure/WebFormsTopicLookupService.cs

@@ -0,0 +1,42 @@
+/*==============================================================================================================================
+| Author        Ignia, LLC
+| Client        Ignia, LLC
+| Project       Topics Library
+\=============================================================================================================================*/
+using System;
+using System.Collections.Generic;
+using OnTopic.Web.Editor;
+
+namespace OnTopic.Editor.Web {
+
+  /*============================================================================================================================
+  | CLASS: TOPIC LOOKUP SERVICE (WEB FORMS)
+  \---------------------------------------------------------------------------------------------------------------------------*/
+  /// <summary>
+  ///   The <see cref="WebFormsTopicLookupService"/> provides access to all of the standard <see cref="Topic"/> types available
+  ///   in the <see cref="DefaultTopicLookupService"/>, as well as custom <see cref="Topic"/>s available for WebForms.
+  /// </summary>
+  public class WebFormsTopicLookupService: DefaultTopicLookupService {
+
+    /*==========================================================================================================================
+    | CONSTRUCTOR
+    \-------------------------------------------------------------------------------------------------------------------------*/
+    /// <summary>
+    ///   Establishes a new instance of a <see cref="WebFormsTopicLookupService"/>. Optionally accepts a list of <see
+    ///   cref="Type"/> instances and a default <see cref="Type"/> value.
+    /// </summary>
+    /// <remarks><inheritdoc /></remarks>
+    /// <param name="types"><inheritdoc /></param>
+    /// <param name="defaultType"><inheritdoc /></param>
+    public WebFormsTopicLookupService(IEnumerable<Type> types = null, Type defaultType = null) :
+      base(types, defaultType?? typeof(Topic)) {
+
+      /*------------------------------------------------------------------------------------------------------------------------
+      | Ensure editor types are accounted for
+      \-----------------------------------------------------------------------------------------------------------------------*/
+      if (!Contains(nameof(ConfigurableAttributeDescriptor)))   Add(typeof(ConfigurableAttributeDescriptor));
+
+    }
+
+  } //Class
+} //Namespace

OnTopic.Editor.Web/OnTopic.Editor.Web.csproj

@@ -1049,6 +1049,7 @@
       <DependentUpon>Default.aspx</DependentUpon>
       <SubType>ASPXCodeBehind</SubType>
     </Content>
+    <Compile Include="Infrastructure\WebFormsTopicLookupService.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
   </ItemGroup>
   <ItemGroup>