IIS用レスポンスフィルタモジュールのつくり方メモ

.NET Frameworkでは、IHttpModuleを実装すると、IISを通過するリクエストやレスポンスを操作できるモジュールを作成できます。

たとえば、リクエストに合わせてレスポンス内容を変化させるなんてことも・・・
そう、いつも通り簡単にできるだろうと思っていました。

HttpResponse.OutputStreamの中にはレスポンスコンテンツが蓄えられるはずです。
これを読み取って、書き換えてしまえばよい、そう思っていました・・・

HttpResponse.OutputStreamは出力(書き込み)専用のStreamであり、読むことは不可能です。
即ち、レスポンス内容の一部の書き換えは不可能・・・

ハンドラでなければレスポンス書き換えできないのでしょうか。

んなわきゃありません。

IIS 7.0 における ASP.NET アプリケーションのライフサイクルの概要を参照しますと、HttpApplicationパイプラインの処理で
19. Filter プロパティが定義されている場合は、応答フィルタ処理を実行します。
とあるのを発見しました。

そうです、モジュールはフィルタではなかったわけです。

では、Filterとは何かというと、Streamなわけですが、これのつくり方もよくわかりませんでしたが、参考になるものが［ASP.NET］Webページに含まれるリンクを動的に変更するには？［C#、VB］にありましたので、活用します。

しかし、文字単位で書き換えるなどバッファの切れ目を考えなかったり、たとえばソースコードのコンパイルを動的に実行したい場合などには不向きです。
画像コンテンツなどバイナリの書き換えにも不向きです。

そこで、フィルタ用StreamクラスにMemoryStreamを1つ、バッファとして用意し、そこに書き込み、Flush時に実際に書き込みを実行します。

using System;
using System.Text;
using System.IO;
using System.Web;

namespace Sample
{
    public class SampleFilter : Stream
    {
        private HttpResponse response;
        private HttpResponse Response
        {
            get { return response; }
        }
        private Stream responseStream;
        private Stream ResponseStream
        {
            get { return responseStream; }
        }
        private MemoryStream buffer;
        private MemoryStream Buffer
        {
            get { return buffer; }
        }

        // コンストラクタ
        public SampleFilter(HttpContext context)
        {
            // レスポンスオブジェクト参照を取得
            this.response = context.Response;
            // レスポンスフィルタチェインを構築
            this.responseStream = context.Response.Filter;
            Response.Filter = this;
            // バッファを構築
            this.buffer = new MemoryStream();
        }

        public override void Write(byte[] buffer, int offset, int count)
        {
            if (Response.StatusCode == 200 && Response.ContentType.ToLower().Contains("text/html"))
            {
                // レスポンスをバッファに蓄える
                Buffer.Write(buffer, offset, count);
            }
            else
            {
                ResponseStream.Write(buffer, offset, count);
            }
        }

        public override void Flush()
        {
            // バッファをフラッシュ
            byte[] bb = Buffer.GetBuffer();
            if (bb != null && bb.Length > 0)
            {
                // 書き換え処理
                Encoding enc = Response.ContentEncoding;
                string content = enc.GetString(bb);
                content = content.Replace("書き換え前", "書き換え後");
                bb = enc.GetBytes(content);
                ResponseStream.Write(bb, 0, bb.Length);
            }
            ResponseStream.Flush();
        }

        #region Streamクラスで実装の必要なそのほかその他のメソッド／プロパティ
        public override int Read(byte[] buffer, int offset, int count)
        {
            throw new NotSupportedException();
        }

        public override bool CanRead
        {
            get { return false; }
        }

        public override bool CanSeek
        {
            get { return false; }
        }

        public override bool CanWrite
        {
            get { return true; }
        }

        public override long Length
        {
            get { throw new NotSupportedException(); }
        }

        public override long Position
        {
            get { throw new NotSupportedException(); }
            set { throw new NotSupportedException(); }
        }


        public override long Seek(long offset, SeekOrigin origin)
        {
            throw new NotSupportedException();
        }

        public override void SetLength(long value)
        {
            throw new NotSupportedException();
        }
        #endregion
    }
}

たとえば、上記のようなStreamフィルタをモジュールのBeginRequestなどでnewすれば、htmlコンテンツの文字列を書き換えることが可能になります。
＃Flush時MemoryStreamを解放すべきかも知れません。

注意すべきはFilterをチェイン化するところと、実際のレスポンスはHTTPヘッダ等も含めてBeginRequest時には確定していないという点です。
#PostRequestHandlerExecute時にはほぼ確定しているようですが、フィルタチェインによってはイベント時とは異なるConetent-Type等になる場合もありそうです(未確認)。

あとは、モジュールをサイトやアプリケーションに登録すれば、たとえ静的なコンテンツでも、意図したとおり、自由に書き換えることができるようになります。

そして、エンドツーエンドの拡張性を持つ Web サーバーソリューションを構築するにあるようなさらなる拡張性を持たせることができれば、より簡単に操作できると思われます。

日	月	火	水	木	金	土
			1	2	3	4
5	6	7	8	9	10	11
12	13	14	15	16	17	18
19	20	21	22	23	24	25
26	27	28	29	30	31

IIS用レスポンスフィルタモジュールのつくり方メモ

カテゴリ:

トラックバック(0)

コメントしちゃいなよ

サイトカウンタ

埋め込みツイッター

検索

このブログ記事について

カテゴリ

月別アーカイブ

ウェブページ

2024年5月

埋め込みQRコード

IIS用レスポンスフィルタモジュールのつくり方メモ

カテゴリ:

トラックバック(0)

コメントしちゃいなよ

サイトカウンタ

埋め込みツイッター

検索

このブログ記事について

カテゴリ

月別 アーカイブ

ウェブページ

2024年5月

埋め込みQRコード

月別アーカイブ