ブログ表示（３）

2006/06/30

概要

利便性向上のためのおまけとして、 RSS フィードの出力と、 URL リライト・リダイレクトによる URL 短縮について説明します。すなわち、以下のうちの 4、5 を説明。

Web コントロール
XSLT
クエリ文字列
HTTP リクエストのリライト・リダイレクト
RSS の作成

「ブログ表示（２）」までの実装で、 BlogDate.aspx?year=2007&month=6&day=30 みたいな URL でリクエストを受けると、 2007年6月30日のブログを表示するようにできました。でも、この長ったらしいクエリ文字列つきの URL がうっとうしいので、 2007/06/30.aspx というような URL を受け取って、 BlogDate.aspx?year=2007&month=6&day=30 にリダイレクトなりリライトするような仕組みを実装しましょう。

リダイレクトとリライトですが、リダイレクトは要するに転送、リライトの方は URL はそのままで中身だけ書き換えです。例えば、2007/06/30.aspx というリクエストを受け取ったとき、それぞれの動作は以下のようなものです。

リダイレクト … クライアントに BlogDate.aspx?year=2007&month=6&day=30 にアクセスしなおしてもらう。
リライト … クライアント側には 2007/06/30.aspx という URL が表示されたまま、BlogDate.aspx?year=2007&month=6&day=30 の結果を返す。

Global.aspx を使ったリダイレクト/リライト

ASP.NET におけるリダイレクト/リライトの方法ですが、 Global.aspx 中の Application_BeginRequest イベントハンドラ内で、 Response.Redirect か Context.RewritePath メソッドを呼び出します。

URL の書き換えは、例えば、正規表現を使って以下のように行います。

protected void Application_BeginRequest(object sender, EventArgs e)
{
  string url = Request.Url.AbsolutePath;

  Regex lookFor = new Regex(@"(\d{4})/(\d{2})/(\d{2})\.aspx");
  string sendTo = "BlogDate.aspx?mode=date&y=$1&m=$2&d=$3";

  if (!lookFor.IsMatch(url))
    continue;

  string result = lookFor.Replace(url, sendTo);
  Response.Redirect(result);
}

protected void Application_BeginRequest(object sender, EventArgs e)
{
  string url = Request.Url.AbsolutePath;

  Regex lookFor = new Regex(@"(\d{4})/(\d{2})/(\d{2})\.aspx");
  string sendTo = "BlogDate.aspx?mode=date&y=$1&m=$2&d=$3";

  if (!lookFor.IsMatch(url))
    continue;

  string result = lookFor.Replace(url, sendTo);
  Context.RewritePath(result, false);
}

汎用性を持たせる

もう少し汎用性を持たせてみましょう。（元 URL, リダイレクト/リライト先 URL）のペアのリストを持っておいて、リスト中の項目を1つ1つチェックしていくようにしてみます。

以下の例では、 2007/06/30.aspx を 20070630.aspx にリダイレクト、 20070630.aspx を BlogDate.aspx&y=2007&m=06&d=30 にリライトします。

public struct RewriteRule
{
  public Regex LookFor;
  public string SendTo;

  public RewriteRule(string lookFor, string sendTo)
  {
    this.LookFor = new Regex(lookFor);
    this.SendTo = sendTo;
  }
}

static RewriteRule[] rewriteRules = new RewriteRule[]
  {
    new RewriteRule(@"(\d{4})(\d{2})(\d{2})(\d+)\.aspx",
      "BlogDate.aspx?mode=date&y=$1&m=$2&d=$3&n=$4"),
    new RewriteRule(@"(\d{4})(\d{2})(\d{2})\.aspx",
      "BlogDate.aspx?mode=date&y=$1&m=$2&d=$3"),
  };
static RewriteRule[] redirectRules = new RewriteRule[]
  {
    new RewriteRule(@"(\d{4})/(\d{2})/(\d{2})/(\d+)\.aspx",
      "$1$2$3$4.aspx"),
    new RewriteRule(@"(\d{4})/(\d{2})/(\d{2})\.aspx",
      "$1$2$3.aspx"),
  };

protected void Application_BeginRequest(object sender, EventArgs e)
{
  string url = Request.Url.AbsolutePath;
  string result;

  foreach (RewriteRule rule in rewriteRules)
  {
    if (!rule.LookFor.IsMatch(url))
      continue;

    result = rule.LookFor.Replace(url, rule.SendTo);
    Context.RewritePath(result, false);
    return;
  }

  foreach (RewriteRule rule in redirectRules)
  {
    if (!rule.LookFor.IsMatch(url))
      continue;

    result = rule.LookFor.Replace(url, rule.SendTo);
    Response.Redirect(result);
    return;
  }
}

まあ、さらに汎用性を持たせたければ、 URL の変換ルールをソース中に埋め込むのではなく、外部の設定ファイルに書いておくほうが望ましいです。

参考： ASP.NET での URL 書き換え。

HttpModule、HttpHandler

ここで説明したような、Global.aspx に処理を書く方法の他に、 HttpModule や HttpHandler を使う方法もあります。

参考： URLのリダイレクト。

注意点1: 元 URL

「アクセスログを取ろう」でも同じような話がありましたが、元 URL は ASP.NET エンジンを通して表示する物でなければなりません。（txt を ASP.NET を通して表示する設定にしていない限り） 2007/06/30.txt というような URL で BlogDate.aspx&y=2007&m=06&d=30 にリダイレクト/リライトはできません。

まあ、もし、例えば、2007/06/30 という URL をリダイレクト/リライトしたければ、 2007/06/30/ というフォルダを予め作った上で、その中に Default.aspx というダミー（中身が空の）ファイルを置いておくことで、リダイレクト/リライトをする事もできます。（いちいちフォルダを作るのは面倒ですが。）

あるいは、「アクセスログを取ろう」のときと同様に、サーバ上の設定で、仮想ディレクトリ中のありとあらゆるファイルを一度 ASP.NET エンジンを通してから表示するように設定するという手もあります。（多少、サーバに掛かる負荷が増える物の、その増加量は小さいそうです。）

注意点2: リライト時の rebase

URL のリライトをする際、1つ気をつけるべきことがあります。

例えば、2007/06/30.aspx を BlogDate.aspx&y=2007&m=06&d=30 にリライトする場合、クライアントは表示されているページを「2007/06 ディレクトリ中の 30.aspx というファイル」だと思っているわけです。ページ中に <img src="logo.jpg"/> と書かれていた場合、それは 2007/06/logo.jpg を意味します。

ところが、表示されているページは実際には、BlogDate.aspx なわけで、 BlogDate.aspx としては、<img src="logo.jpg"/> といわれれば、 BlogDate.aspx と同じディレクトリ内の log.jpg であって欲しいはずです。

（まあ、<img src="~/logo.jpg"/> と言うように絶対パスで書いておけばこんな問題も起きないんですが。どうしても絶対パス指定したくない場合には困る。）

こういう問題を回避するため、ASP.NET では、 2007/06/30.aspx が呼ばれたときには <img src="logo.jpg"/> の代わりに <img src="../../logo.jpg"/> を表示するような機構も持っています。この機構を働かせるためには、以下の2点を守る必要があります。

1つは、RewritePath メソッドを呼ぶ際に、 Context.RewritePath(result, false); と言うように、第2引数に false を指定すること。（この第2引数は、パスの rebase をするかどうかのフラグ。 true の時には、<img src="~/logo.jpg"/> といわれれば、 BlogDate.aspx では logo.jpg、 2007/06/30.aspx では 2007/06/logo.jpg だと思う。 false の時には、どちらの場合でも logo.jpg だと思う。）

もう1つは、 <img src="~/logo.jpg"/> などに runat="server" 属性を付けることです。（要するに、サーバ上で処理を掛けた物を表示する設定にする。）（HTML コントロールよりも、asp:Image などの ASP.NET Web コントロールを使うこと推奨。）

具体例を挙げてみましょう。まず、先ほど作った Global.aspx のリライトルールに以下の物を追加します。

static RewriteRule[] rewriteRules = new RewriteRule[]
  {
    new RewriteRule(@"Test/(RewriteTest.aspx)",
      "$1"),
    new RewriteRule(@"(\d{4})/(\d{2})/(\d{2})\.aspx",
      "BlogDate.aspx?mode=date&y=$1&m=$2&d=$3"),
  };

で、RewriteText.aspx という名前で、以下のような Web フォームページを作ります。

<%@ Page Language="C#" %>

<html>
<head runat="server">
  <title>リダイレクトのテスト</title>
</head>
<body>
  <form id="form1" runat="server">
  <p>
    <a href="Default.aspx">html &lt;a&gt; tag</a>
  </p>
  <p>
    <asp:HyperLink runat="server"
      NavigateUrl="Default.aspx">
      asp:HyperLink
      </asp:HyperLink>
  </p>
  </form>
</body>
</html>

このファイルの表示結果なんですが、まず、RewriteText.aspx で表示した場合には、 <body> の中身には以下のような HTML が生成されます。

  <p>
    <a href="Default.aspx">html &lt;a&gt; tag</a>
  </p>
  <p>
    <a href="Default.aspx">asp:HyperLink</a>
  </p>

これに対して、Test/RewriteText.aspx という URL で要求を受けて、リライトした場合には、以下のような HTML になります。

  <p>
    <a href="Default.aspx">html &lt;a&gt; tag</a>
  </p>
  <p>
    <a href="../Default.aspx">asp:HyperLink</a>
  </p>

runat="server" なしの a タグの方では、 href 内のパスの修正が掛かっていない状態になります。（意図して修正が掛からないようにしているならいいけども、そうでない場合は注意。）

ということで、2007/06/30.aspx というような URL から BlogDate.aspx にリライト処理するなら、「メールフォーム」で作った「マスタページ」も、以下のように書き換える必要があります。

<%@ Master Language="C#" AutoEventWireup="true"
  CodeBehind="Site.master.cs" Inherits="WebsiteSample.Site" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">

  <link rel="stylesheet" type="text/css" href="main.css" />

  <title>無題のページ</title>
</head>
<body>

<form id="form1" runat="server">

  <p class="head">
  <asp:Image runat="server" ImageUrl="logo.jpg"
    Width="320" Height="80" AlternateText="site logo" />
  </p>
  <div class="menu">
    <span class="menuItem">
      <asp:HyperLink runat="server"
        NavigateUrl="Default.aspx">TOP</asp:HyperLink>
    </span>
    <span class="menuItem">
      <asp:HyperLink runat="server"
        NavigateUrl="Mail.aspx">メール</asp:HyperLink>
    </span>
    <span class="menuItem">
      <asp:HyperLink runat="server"
        NavigateUrl="BlogLatest.aspx">日記</asp:HyperLink>
    </span>
    <span class="menuItem">
      <asp:HyperLink runat="server"
        NavigateUrl="Rss.aspx">RSS</asp:HyperLink>
    </span>
  </div>

  <p class="counter">
    総アクセス数: <%= Session["count"] %>
  </p>

  <div class="content">
    <asp:ContentPlaceHolder ID="ContentPlaceHolder1" runat="server">
    </asp:ContentPlaceHolder>
  </div>

  <div class="foot">
  <p>
    このサイトへのリンクはご自由にどうぞ
  </p>
  </div>
</form>

</body>
</html>

RSS

最後に、RSS フィードを生成してみます。

＠IT の記事「サイトの更新情報を提供する標準言語RSS」あたりを参考に。汎用性を持たせるために、RSS を出力する部分だけ独立させて、クラス化してみました → RssWriter.cs

この RssWriter クラスは、以下のように使います。

RssWriter writer = new RssWriter();
this.writer.SiteName = "My Site";
this.writer.AdministratorName = "admin name";
this.writer.Url = "http://my.domain.net/";

this.writer.Add(pageUrl, title, new DateTime(year, month, day), digest);

this.writer.Write(Request.Url.AbsoluteUri, Response.OutputStream);

このクラスを使って、「ブログ表示（２）」で作ったブログもどきの RSS フィードを作ってみましょう。まず、「画像カウンタ」のときと同じく、 .aspx ファイルは空っぽで、コードビハインド（.aspx.cs）のみの Web フォームを作ります。名前は Rss.aspx にしておきます。

そして、コードビハインドファイル（Rss.aspx.cs）の内容は以下のような感じ。

using System;
using System.Web;
using System.IO;
using System.Xml;
using System.Text.RegularExpressions;

namespace WebsiteSample
{
  public partial class Rss : System.Web.UI.Page
  {
    RssWriter writer = new RssWriter();

    protected void Page_Load(object sender, EventArgs e)
    {
      Response.ContentType = "application/xml";
      Response.ContentEncoding = System.Text.Encoding.UTF8;

      this.writer.Write(Request.Url.AbsoluteUri, Response.OutputStream);
    }

    protected override void OnInit(EventArgs e)
    {
      base.OnInit(e);

      this.writer.SiteName = "My Site";
      this.writer.AdministratorName = "admin name";
      this.writer.Url = URL;
      this.ReadItems();
    }

    const int DEFAULT_NUM = 15;
    const int DEFAULT_DIGEST_LENGTH = 128;

    const string URL = "http://my.domain.net/";

    static readonly Regex regYyyyMmDd =
      new Regex(@"(?<y>\d\d\d\d)(?<m>\d\d)(?<d>\d\d)",
      RegexOptions.Compiled);
    static readonly Regex regCDATA =
      new Regex(@"\<!\[CDATA\[.*?\]\]\>",
      RegexOptions.Compiled);
    static readonly Regex regTags =
     new Regex(@"\<.*?\>",
     RegexOptions.Compiled);

    /// <summary>
    /// データを読み出して、RssWriter に項目を追加。
    /// </summary>
    void ReadItems()
    {
      int num, digestLen;
      if (!int.TryParse(Request.QueryString["num"], out num))
        num = DEFAULT_NUM;
      if (!int.TryParse(Request.QueryString["len"], out digestLen))
        digestLen = DEFAULT_DIGEST_LENGTH;

      string PATH = Server.MapPath(@"~/App_Data");

      DirectoryInfo dataDir = new DirectoryInfo(PATH);
      FileInfo[] files = dataDir.GetFiles("*.xml");

      Array.Sort(files,
        delegate(FileInfo a, FileInfo b)
        {
          return b.Name.CompareTo(a.Name);
        });

      foreach (FileInfo file in files)
      {
        Match m = regYyyyMmDd.Match(file.Name);
        if (!m.Success)
          continue;
        int year = int.Parse(m.Groups["y"].Value);
        int month = int.Parse(m.Groups["m"].Value);
        int day = int.Parse(m.Groups["d"].Value);

        XmlDocument doc = new XmlDocument();
        using (Stream stream = new FileStream(
          file.FullName, FileMode.Open,
          FileAccess.Read, FileShare.ReadWrite))
        {
          doc.Load(stream);
        }

        XmlNodeList list = doc.GetElementsByTagName("blog");
        foreach (XmlNode node in list)
        {
          string pageUrl = URL +
            string.Format("{0}/{1:00}/{2:00}.aspx",
            year, month, day);

          XmlAttribute att;
          string title = string.Empty;
          att = node.Attributes["title"];
          if (att != null) title = att.Value;
          att = node.Attributes["category"];
          if (att != null)
          {
            title += " [" + att.Value + "]";
          }

          string digest = Digest(node.InnerXml, digestLen);

          this.writer.Add(
            pageUrl, title,
            new DateTime(year, month, day), digest);
        }

        if (this.writer.Count >= num) break;
      }
    }

    /// <summary>
    /// XML のダイジェストを作る。
    /// XML のタグを取り除いて、テキストのみにして、最初の num 文字だけを返す。
    /// </summary>
    /// <param name="xml">XML 文字列</param>
    /// <param name="num">最初何文字を返すか</param>
    /// <returns>タグを取り除いた結果</returns>
    static string Digest(string xml, int num)
    {
      xml = xml.Replace("\n", "");
      xml = xml.Replace("\r", "");

      string digest;
      digest = regCDATA.Replace(xml, "");
      digest = regTags.Replace(xml, "");

      if (num >= digest.Length)
        return digest;

      digest = digest.Substring(0, num);
      return digest + " …";
    }
  }
}

更新履歴

2024/08/31

型の分割定義 (partial)

[C#]

2024/07/13

更新：C# 13.0 の新機能

[C#]

2024/06/22

更新：ref構造体

[C#]

2023/10/24

コレクション式

[C#]

2023/09/20

[雑記] InlineArray

[C#]

ブログ

2024/04/04

ブログ表示（３）

目次

概要

リライト・リダイレクト

Global.aspx を使ったリダイレクト/リライト

汎用性を持たせる

HttpModule、HttpHandler

注意点1: 元 URL

注意点2: リライト時の rebase

RSS

更新履歴

型の分割定義 (partial)

更新：C# 13.0 の新機能

更新：ref構造体

コレクション式

[雑記] InlineArray

ブログ

ref/ref struct 変数を非同期メソッド中で使えるように

Lock クラス

Extensions (拡張型)

C# 13 でのコレクション式 - ディクショナリ式

C# 13 でのコレクション式 - 制限の緩和の話