本文探討: IIS 擴充點 建置回應修改模組 新增 IIS 管理員設定 部署模組

本文使用技術: IIS 7.0、.NET Framework

 目錄

擴充 Web 伺服器
回應修改模組
擴充設定
回應修改設定
強型別的設定類別
擴充 IIS 管理員
建立服務
建立模組頁面
部署擴充功能
整合一切
自己動手操作

 Figure 2 回應篩選條件

public void OnPreRequestHandlerExecute(Object source, EventArgs e)
{
  HttpApplication app = (HttpApplication)source;
  HttpContext context = app.Context;

  // Read configuration 
  ResponseModificationConfigurationSection config;
  
  ...

  // Get the list of filters
  ResponseFilterList filters = GetApplicableFilters(context, config);

  // Create the filter and wire it up
  if (null != filters && filters.Count > 0)
  {
    context.Response.Filter = 
      new ChainedBufferedStringResponseFilter(
        context, filters);
  }
}

 Figure 3 回應修改設定結構描述

<configSchema>
  <sectionSchema name="responseModification">
    <attribute name="enabled" type="bool" defaultValue="false" />
    <collection addElement="add" clearElement="clear" 
      removeElement="remove">
      <attribute name="name" type="string" required="true" 
        isUniqueKey="true" validationType="nonEmptyString" />
      <attribute name="conditionType" type="string" required="false" />
      <attribute name="condition" type="string" required="false" />
      <attribute name="replaceType" type="string" required="true" 
        validationType="nonEmptyString" />
      <attribute name="replace" type="string" required="false" />
      <attribute name="replaceWith" type="string" required="false" />
      <attribute name="options" type="string" required="false" />
    </collection>
  </sectionSchema>
</configSchema>

 Figure 4 強型別的設定區段包裝函式

class ResponseModificationSection : ConfigurationSection
{
  public bool Enabled
  {
    get { return (bool)this["enabled"]; }
    set { this["enabled"] = value; }
  }

  public ResponseModificationRuleCollection FilterRules
  {
    get 
    { 
      return (ResponseModificationRuleCollection)
        GetCollection(typeof(ResponseModificationRuleCollection)); 
    }
  }
}

 Figure 5 模組提供者類別

public sealed class ResponseModificationModuleProvider : 
  ConfigurationModuleProvider
{
  public override Type ServiceType
  {
    get { return typeof(ResponseModificationModuleService); }
  }

  public override ModuleDefinition 
    GetModuleDefinition(IManagementContext context)
  {
    return new ModuleDefinition(Name,
      "Mvolo.ResponseModification.UI.Client.ResponseModificationModule,"+
      "Mvolo.ResponseModificationUI.Client," +
      "Version=1.0.0.0, Culture=neutral," +
      "PublicKeyToken=309ac0e1b5482072");
  }

  protected override string ConfigurationSectionName
  {
    get { return "responseModification"; }
  }
}

 Figure 6 模組服務類別

public sealed class ResponseModificationModuleService : ModuleService
{
  [ModuleServiceMethod]
  public ArrayList GetFilterRules()
  {
    ArrayList items = new ArrayList();

    ResponseModificationSection section = 
      (ResponseModificationSection)ManagementUnit.Configuration
        .GetSection("responseModification",
          typeof(ResponseModificationSection));

    foreach (ResponseModificationRuleElement rule in section.Rules)
    {
      items.Add(GetPropertyBag(rule));
    }

  return items;
  }
  ...
}  

 Figure 7 模組類別

public sealed class ResponseModificationModule : Module
{
  protected override void Initialize(IServiceProvider serviceProvider, 
    ModuleInfo moduleInfo)
  {
    base.Initialize(serviceProvider, moduleInfo);

    IControlPanel controlPanel =
      (IControlPanel)GetService(typeof(IControlPanel));

    controlPanel.RegisterPage(
      new ModulePageInfo(this,
      typeof(ResponseModificationModulePage),
      Resources.PageTitle,
      Resources.PageDescription,
      null,
      null,
      Resources.PageText
      ));
  }
}

 Figure 9 IIS 管理員擴充功能設定

<moduleProviders>
  ...

  <!-- Mvolo ResponseModification -->
  <add name="ResponseModification" 
    type="Mvolo.ResponseModification.UI.Server
        .ResponseModificationModuleProvider, 
      Mvolo.ResponseModificationUI.Server, 
      Version=1.0.0.0, Culture=neutral, 
      PublicKeyToken=895e90205a14f2aa, 
      processorArchitecture=MSIL" />
</moduleProviders>

<!-- For all Sites -->
<location path=".">
  <modules>
    ...
    <add name="ResponseModification" />
  </modules>
</location>

 Figure 10 啟用頁首與頁尾

<responseModification enabled="true">
  <add name="Header" 
    conditionType=
      "Mvolo.ResponseModification.Conditions.ContentTypeCondition"
    condition="text/html" 
    replaceType="Mvolo.ResponseModification.Filters.RegExReplace" 
    replace="&lt;body([^>]*)>" 
    replaceWith="&lt;body$1>&lt;h1 align=&quot;center&quot;>
      Welcome to my gallery!&lt;/h1>" 
    options="IgnoreCase" />
  
  <add name="Footer" 
    conditionType=
      "Mvolo.ResponseModification.Conditions.ContentTypeCondition"
    condition="text/html" 
    replaceType="Mvolo.ResponseModification.Filters.RegExReplace" 
    replace="&lt;/body>" 
    replaceWith="&lt;h3 align=&quot;center&quot;>
      Copyright mvolo 2007&lt;/h3>&lt;/body>" 
    options="IgnoreCase"  />
 </responseModification>