C# & JavaScript

Blogger の 記事 一覧 を表示する ページ を作成します。 ここで紹介する方法では、ソート順（タイトル名、公開日付、更新日付）、表示方法（一覧、ラベル別）を任意に指定できます。 また、各要素に クラス名 が割り振られているので、好きな表示を簡単に実現できます。

とりあえず自分のブログで試したい方は デモページ（日本語） をご利用ください。

（…いくつかの ブログ で "記事一覧を表示する方法" が記載されていましたが、 個人的にしっくりこなかったので新しく作ってしまえ、という経緯です。。）

作成手順

1. Blogger の 左メニュー から [ページ] を選択します。

   

2. [新しいページ] を選択します。

   

3. 編集ページにおいて、以下の ソースコード を コピー して貼り付けます。

   <script type="text/javascript">
   var POSTSTOC_SETTINGS = {
       blogURL: 'garafu.blogspot.jp',  // Blogger の ドメイン を設定
       maxResults: Infinity,           // 最大受信記事数 を設定。Infinity ですべての記事を受信
       sort: {
           key: 'published',           // ソートキー [title, published, updated]
           order: 'default'            // ソート順 [default, asc, desc]
       },
       printby: 'title',               // 表示方法 [title, label, label.nameorder, label.contentsorder]
       newPost: {
           enabled: true,              // 新着記事アイコンを表示するかどうか
           symbol: 'NEW !',            // 新着記事の表示文字列
           term: 30                    // 新着記事判定する日数
       },
       thumbnail: {
           enabled: true,              // サムネイル表示するかどうか
           noImageURL: '//garafu.github.io/blogger.toc/release/0.0.5/noimage.png'
                                       // サムネイルが存在しないときに割り当てる画像
       },
       published: {
           enabled: true,              // 公開日を表示するかどうか
           format: 'yyyy/MM/dd'        // 公開日のフォーマット
       },
       updated: {
           enabled: true,              // 更新日を表示するかどうか
           format: 'yyyy/MM/dd'        // 更新日のフォーマット
       }
   };
   </script>
   <link rel="stylesheet" type="text/css" href="//garafu.github.io/blogger.toc/release/0.0.12/simple.css" />
   <script type="text/javascript" src="//garafu.github.io/blogger.toc/release/0.0.12/blogger.toc.min.js"></script>
   

4. 以下の設定を変更します。細かな設定に関しては後述の説明をご確認ください。

   blogURL	Blogger の ドメイン を設定します。
   sort.key	記事ソート順を [title, published, updated] から設定します。デフォルト published。 title ： 記事の名前をキーとしてソート published ： 投稿日をキーとしてソート updated ： 更新日をキーとしてソート
   printby	表示方法を [title, label, label.nameorder, label.contentsorder] から設定します。デフォルト label。 title ： 記事を一覧 label ： ラベル別に記事を一覧 label.nameorder ： ラベル別に記事を一覧。ラベルはラベル名の昇順にソート。 label.contentsorder ： ラベル別に記事を一覧。ラベルはラベルに含まれる記事が多い順にソート。
   thumbnail.enabled	サムネイルを表示するかどうか を設定します。デフォルト false 。
   published.enabled	公開日を表示するかどうか を設定します。デフォルト false 。
   updated.enabled	更新日を表示するかどうか を設定します。デフォルト false 。

5. 保存して公開します。

   

説明

とりあえず試したい方は デモページ(日本語) をご参照ください。 試した結果が出力されるので、そのコードをコピー&ペーストすると簡単に "Blogger 記事 の 一覧表示" を作成できます。

リスト出力設定

{
  blogURL: 'garafu.blogspot.com',
  maxResults: Infinity,
  keyword: 'JavaScript',
  sort: {
    key: 'published',
    order: 'default'
  },
  printby: 'label',
  newPost: {
    enabled: false,
    symbol: 'NEW !',
    term: 30,
    target: 'published'
  },
  thumbnail: {
    enabled: false,
    noImageURL: '//garafu.github.io/blogger.toc/release/0.0.5/noimage.png'
  },
  published: {
    enabled: false,
    format: 'yyyy/MM/dd HH:mm:ss'
  },
  updated: {
    enabled: false,
    format: 'yyyy/MM/dd HH:mm:ss'
  },
  target: undefined
}

(*1) 日付フォーマット

スタイルシート設定

スタイルシート

各要素に対してできるだけ クラス名 を割り振るよう作成されています。 あらかじめある スタイルシート で思うような表示ができていない場合、 <link /> を利用せず、自前で stylesheet を記述することができます。

不具合、ご要望等はこの記事にレスしていいただくか、こちら(Github garafu/blogger.toc Issues) までご連絡いただけると幸いです。

更新履歴

2018/10/08 v0.0.12

targetオプション追加。

2016/10/09 v0.0.11

keywordオプション追加。microdataの自動生成機能を追加。

2016/05/14 v0.0.10

https対応。

2016/05/14 v0.0.9

記事フィードが正しく受信できない不具合を修正。

2015/10/10 v0.0.8

新着記事にアイコンをつける機能を追加。手順の画面キャプチャを更新。説明欄の拡充。

2015/08/30 v0.0.7

ソートの降順、昇順を制御する機能を追加

2015/07/12 v0.0.6

公開日、更新日を制御する機能を追加

2015/07/12 v0.0.5

サムネイル表示機能を追加

2015/05/09 v0.0.4

一部のサイトで正しく表示されない不具合修正

2014/04/28 v0.0.3

ブログテンプレートの種類によりスクリプトが正しく動作しない不具合修正

2014/04/27 v0.0.2

ブログ記事をすべて読み込めるよう修正

参考記事

• Blogger ブログにサイトマップ - ラベル分類された投稿一覧を「ページ」に表示する方法
• [Blogger] カテゴリ別記事一覧をつけてみた

Blogger の フィード URL （RSS や Atom、JSON を受信する URL）を作成する Webアプリ です。 * は必須入力項目です。 必要事項を入力した後、「フィード URL 生成」で フィード URL が生成されます。

作りたいフィードの設定入力

生成されたフィード

Blogger の feed URL で利用可能な パラメタ― を一覧にしてまとめました。 RSS や json を利用しての2次利用で必要な情報になるかと思います。

（2013/07/10 Blogger の フィード URL 生成 ツール）

フィード URL の基本構成

• フィード URL の 基本構成

リソース

• 投稿（posts）
• コメント（comments）
• 投稿別コメント（POSTID/comments）
• ページ（pages）

ラベル

• ラベル別投稿（/-/LABELNAME）

クエリ パラメタ―

• 応答フォーマット（alt）
• 最大取得数（max-results）
• 取得開始番号（start-index）
• ソート順（orderby）
• 最小 or 最大 公開日付（published-min, published-max）
• 最小 or 最大 更新日付（updated-min, updated-max）
• 厳密性（strict）
• リダイレクト（redirect）
• コールバック関数（callback）

フィード URL の 基本構成

https://BLOG_NAME.blogspot.com/feeds/RESOURCE/RESPONSE[LABEL][?QUERY]

BLOG_NAME

ブログ名を指定します。[設定]-[基本]-[公開]の「ブログのアドレス」で指定されたブログ名です。

RESOURCE

取得するデータの種類を指定します。

• posts
• comments
• POSTID/comments
• pages

RESPONSE

取得するデータ量を指定します。

• default … 本文すべて取得します。
• summary … 本文を先頭のみ取得します。

LABEL

オプション。ラベルを指定して、取得するデータをフィルタします。

• /-/LABELNAME

QUERY

オプション。取得するデータに対してより細かな条件指定を行います。

• alt
• max-results
• start-index
• orderby
• published-min, published-max
• updated-min, updated-max
• strict
• redirect
• callback

posts

投稿した記事に対するフィードを取得します。

サンプルURL

https://garafu.blogspot.jp/feeds/posts/default?alt=rss

comments

コメントに対するフィードを取得します。

サンプルURL

https://garafu.blogspot.jp/feeds/comments/default?alt=rss

POSTID/comments

投稿記事を指定したコメントに対するフィードを取得します。 POSTIDは記事の編集画面を開いたとき URL 欄 に記載されています。

サンプルURL

https://garafu.blogspot.jp/feeds/1102748937110099330/comments/default?alt=rss

pages

作成されたページに対するフィードを取得します。

サンプルURL

https://garafu.blogspot.jp/feeds/pages/default?alt=rss

/-/LABELNAME

ラベル名で絞り込みを行います。 必ず /-/ を記述します。 ラベル名は URL エンコード を行ったものを記載します。 複数指定する場合は /-/label1/label2 のように記載していきます。

サンプルURL

https://garafu.blogspot.jp/feeds/posts/summary/-/JavaScript?alt=rss

[おまけ] URL エンコード

alt

Alternative representation type（代替表現型）。 応答フォーマットの種類を指定します。

引数

enum

応答フォーマットの種類を指定します。指定できる文字列は以下通りです。

• atom … デフォルト。Atom フィードを返します。
• rss … RSS 2.0 フィードを返します。
• json … JSON 形式で返します。
• atom-in-script … scriptタグ で囲まれた Atom フィードを返します。
• rss-in-script … scriptタグ で囲まれた RSS 2.0 フィードを返します。
• json-in-script … scriptタグ で囲まれた JSON 形式 のフィードを返します。
• atom-service … Atom サービスドキュメントを返します。

サンプルURL

https://garafu.blogspot.jp/feeds/posts/summary?alt=rss

max-results

取得するエントリーの最大数を指定します。 最大 500 まで指定できます。 500 以上を指定しても 500 までしか取得できません。

引数

number

最大取得数を指定します。デフォルトは 25。

サンプルURL

https://garafu.blogspot.jp/feeds/posts/summary?alt=rss&max-results=100

start-index

1 から始まるデータ取得開始番号を指定します。

引数

number

1 から始まる取得開始番号を指定します。デフォルトは 1。

サンプルURL

https://garafu.blogspot.jp/feeds/posts/summary?alt=rss&start-index=101&max-results=100

orderby

受信するフィードのソート順を指定します。

引数

enum

ソート順を指定します。指定できる文字列は以下の通りです。

• lastmodified … デフォルト。
• starttime … ？
• updated … 更新日付順に並び替えます。
• published … 投稿日付順に並び替えます。

サンプルURL

https://garafu.blogspot.jp/feeds/posts/summary?alt=rss&orderby=published

published-min, published-max

orderby=published と一緒に指定することで、取得する期間を制限します。

引数

W3C-DTF

開始日付または終了日付を指定します。

サンプルURL

https://garafu.blogspot.jp/feeds/posts/summary?alt=rss&orderby=published&published-min=2010-01-01T00:00:00+09:00published-max=2011-01-01T00:00:00+09:00

updated-min, updated-max

orderby=updated と一緒に指定することで、取得する期間を制限します。

引数

W3C-DTF

開始日付または終了日付を指定します。

サンプルURL

https://garafu.blogspot.jp/feeds/posts/summary?alt=rss&orderby=updated&updated-min=2010-01-01T00:00:00+09:updated-max=2011-01-01T00:00:00+09:00

strict

クエリ パラメタ― が正しく指定されているかどうか厳密にチェックを行うか指定します。

引数

boolean

厳密なチェックを行うかどうか指定します。デフォルト false。

サンプルURL

https://garafu.blogspot.jp/feeds/posts/summary?alt=json&strict=true

redirect

リダイレクトを許可するかどうか指定します。

引数

boolean

リダイレクトを許可するかどうか指定します。

サンプルURL

https://garafu.blogspot.jp/feeds/posts/summary?alt=rss&redirect=true

callback

alt=json-in-script を指定した際、読み込み完了時に呼び出すコールバック関数を指定します。

引数

string

コールバック関数を指定します。

サンプルURL

https://garafu.blogspot.jp/feeds/posts/summary?alt=json-in-script&callback=loadFeeds

今回、参考にしたサイトは以下の通りです。

• Parameters in Blogspot feed
• Blogger のフィード URL とパラメータ
• google developers - Reference Guide
• google developers - Protocol Reference
• google developers - Posts: list

そこに存在する SQL Server Express の データベース ファイル（拡張子 .mdf のファイル） を、黒猫 SQL Studio で開いて内容を見る方法です。 黒猫 SQL Studio は無料のツールでインストールが不要（配置のみで動作）なので、個人的には好んで使っています。 SQLコマンドはもちろん、デーブル内容の閲覧もできます。 以下では .mdf ファイル を 黒猫 SQL Studio で開くまでの手順を記載します。

黒猫ソフトウェア工房

1. 黒猫 SQL Studio メニュー
   [データベース]-[データベースに接続]を選択します。
   
2. データベース接続
   [新規追加]ボタンを押下します。
   
3. 接続文字列の編集
   接続文字列のオプションを選択します。
   
4. データ リンク プロパティ
   「プロバイダー」タブで「Microsoft OLE DB Provider for SQL Server」を選択して、[次へ]を選択します。
5. 「接続」タブで、以下の設定を行って、「OK」を選択します。 （必要であれば、接続テストします。）

   １：

   .\SQLEXPRESS（固定文字列）

   ２：

   Windows NT の統合セキュリティを使用する

   ３：

   データベース ファイルをデータベース名として添付する

   論理名：（任意文字列）

   ファイル名：（.mdfファイルへのパス）


6. 接続文字列の編集
   「接続名」を任意の名称に変更して、[OK]を選択します。
   
7. データベース接続
   先ほど作成した接続情報を選択して、[接続]を選択します。
   
8. 黒猫 SQL Studio データベース
   接続ができちるとデータベースの内容が表示されています。
   

そこに存在する SQL Server Express の データベース ファイル（拡張子 .mdf のファイル） を、Visual Studio で開いて内容を見る方法です。 あくまで "そこにある" なので、プロジェクトやソリューションに含まれている場合は除きます。 こうした状況で、具体的に データベース ファイル の内容を閲覧する手順を記載します。

1. Visual Studio メニュー
   [表示]-[サーバー エクスプローラー]を開きます。
   
2. サーバー エクスプローラー
   [データベースへの接続]ボタンを押下します。
   
3. データ ソースの選択
   データ ソースで「Micosoft SQL Server」を選択し、「続行」を押下します。
   
4. 接続の追加
   以下の設定を行って、「OK」を押下します。 （必要であれば、接続テストします。）

   サーバー名	.\SQLEXPRESS（固定文字列）
   サーバーにログオンする	Windows 認証を使用する
   データベースへの接続	データベース ファイルのアタッチ ファイル名：（.mdfファイルへのパス） 論理名：（任意文字列）

   
5. サーバー エクスプローラー
   データベースへ接続が完了しているので、任意の操作（テーブルの内容参照やデータ追加、削除等）を行います。
   

Google closure tools に含まれる closure compiler の使い方です。 closure library に含まれる closurebuilder.py を利用して、 複数の JavaScript ファイル を １つの JavaScript ファイル へ バッチ処理で コンパイル します。 ここでは、バッチ処理する前提となる「フォルダ構成」と「コンパイルバッチ」を記載します。

（※Windows で、Javaランタイム、Python が インストール 済み の環境を前提とします。）

フォルダ構成

 ROOT
├  lib
│ ├  closure-compiler
│ │ └  compiler.jar … コンパイラ本体
│ └  closure-library
│    └  closure
│       ├  bin
│       │ ├  build
│       │ │ └  closurebuilder.py … コンパイルで利用
│       │ ├  calcdeps.py
│       │ └  scopify.py
│       ├  css
│       └  goog
│          └  closure library の ソースコード
├  src
│ └  ソースコード … 自分が作成したソースコードの保存場所
└  build.bat … ビルドを実行するバッチファイル

build.bat

@echo off

rem 実行ディレクトリをバッチファイルの場所へ移動。
cd /d "%~dp0"


rem 環境変数に Java と Python へのパスを追加。
set PATH=%PATH%;C:\Program Files\Java\jre7\bin
set PATH=%PATH%;C:\Python27


rem 各種変数を設定。
set CLOSUREBUILDERPY=.\lib\closure-library\closure\bin\build\closurebuilder.py
set CLOSURECOMPILERJAR=.\lib\closure-compiler\compiler.jar
set CLOSURE_LIBRARY_DIR=.\lib\closure-library\closure\goog
set CLOSERU_LIBRARY_THIRD_DIR=.\lib\closure-library\third_party\closure\goog
set SOURCE_CODE_DIR=.\src
set MAIN_CLASS_NAME=garafu.test
set OUTPUT_FILE=.\build\garafu.test.min.js


rem コンパイルの実行。
%CLOSUREBUILDERPY% ^
    --root=%CLOSURE_LIBRARY_DIR% ^
    --root=%CLOSERU_LIBRARY_THIRD_DIR% ^
    --root=%SOURCE_CODE_DIR% ^
    --namespace=%MAIN_CLASS_NAME% ^
    --output_mode=compiled ^
    --compiler_jar=%CLOSURECOMPILERJAR% ^
    --compiler_flags="--compilation_level=ADVANCED_OPTIMIZATIONS" ^
    --compiler_flags="--js_output_file=%OUTPUT_FILE%"

「各種編集の設定」（12 - 19 行）では build.bat からの相対パスを指定します。 フォルダ構成が上記と異なる場合、この部分を変更することになります。

%CLOSERU_LIBRARY_THIRD_DIR%
設定を行わないと場合により、次のようなエラーが発生します。 closure compiler は不要なファイル、コードを削ってくれるので、余分に見えても追加しておきます。 （不要なファイル、コードを削るのは ADVANCED_OPTIMIZATIONS に限りますが。。）

depstree.NamespaceNotFoundError: Namespace "goog.async.Deferred" never provided. Required in Source [JavaScript ファイル への パス]

%MAIN_CLASS_NAME%
最初に実行するクラス名を指定します。 基本的に、ここで指定するクラスは singleton で、 goog.addSingletonGetter([クラス名]); および [クラス名].getInstance(); の実装があるクラスを指定します。 この部分は作成しているプロジェクト環境に合わせて変更します。

%OUTPUT_FILE%
出力先のフォルダ、ファイル名を指定します。 ここでは、 build フォルダ以下にファイルを作成するようにしています。 この部分は作成しているプロジェクト環境に合わせて変更します。

今回、参考にしたサイトは以下の通りです。

• Using ClosureBuilder

Visual Studio で作成した SQL Server Express の データベース ファイル（拡張子 .mdf のファイル） を、Excel で開いて内容を見る方法です。 内容を閲覧、確認する"だけ"であれば Excel で可能でした。 ここでは、その具体的な手順を記載します。

1. Excel を起動します。
2. Excel リボン
   [データ]-[その他のデータ ソース]-[データ接続ウィザード]を選択します。
   
3. データ接続ウィザード
   「その他/詳細」を選択して、「次へ」を選択します。
   
4. データリンク プロパティ
   「プロバイダー」タブでは「Microsoft OLE DB Provider for SQL Server」を選択して、「次へ」を選択します。
   
5. 「接続」タブでは以下の設定を行います。
   • サーバー名を選択または入力：
     .\SQLEXPRESS
     （※固定文字列です。）
   • サーバーへのログオンに必要な情報を入力：
     Windows NT の統合セキュリティを使用する
   • データベース ファイルをデータベース名として添付する：
     [任意の名称]
     （※ここへ必ず何かしら文字列を入れます。入れないと接続できません。画像では「sample」。）
   • ファイル名を使用する：
     [.mdfファイルへのパス]
   
6. 「接続のテスト」を選択して、テストします。
   （※おそらくうまく接続できるハズです。）
   
7. 「OK」を選択して データリンクプロパティ を完了します。
   

8. エラーメッセージが出るので、「OK」を選択して閉じます。
   （※このエラーはなぜか必ず出ます…が、問題なさそうなので無視します。）
   
9. もう一度「OK」を選択して データリンクプロパティ を完了します。
   
10. データ接続ウィザード
    閲覧したいテーブルを選択して「完了」を選択します。
    
11. データを表示する場所を選択して「OK」を選択します。
    
12. Excel のシートに テーブル 内容が表示されます。
    （※画像ではデータがないので空行です。。）
    

Visual Studio の プロジェクト に追加された SQL Server データベース ファイル (mdf ファイル) を SqlConnection を用いて開いて利用する方法を見ていきます。 テーブル は サーバー エクスプローラー で 開いて GUI を使ってあらかじめ登録してあるものとします。 （サンプルコードでは Person テーブル が作られている前提の処理となっています。）

サンプルコード の ダウンロード

（※ SQL Server データベースの中身を見る or 操作するだけなら 黒猫 SQL Studio が個人的には好みです。）

サンプルコード（抜粋）

namespace DataBaseService.Controllers
{
    using System;
    using System.Collections.Generic;
    using System.Linq;
    using System.Web;
    using System.Web.Mvc;
    using System.Data.SqlClient;
    using System.Data;

    public class HomeController : Controller
    {
        //
        // GET: /Home/

        public ActionResult Index()
        {
            var connectionString = string.Empty;
            connectionString += @"Data Source=.\SQLEXPRESS;";
            connectionString += @"AttachDbFilename=";
            connectionString += this.Server.MapPath("./App_Data/Database.mdf");
            connectionString += @";";
            connectionString += @"Integrated Security=true;";
            connectionString += @"User Instance=true;";

            DataTable dataTable = new DataTable();

            using (SqlConnection connection = new SqlConnection())
            {
                var query = "SELECT * from Person";
                using (SqlCommand cmd = new SqlCommand(query, connection))
                {
                    connection.ConnectionString = connectionString;
                    connection.Open();
                    
                    SqlDataAdapter da = new SqlDataAdapter(cmd);
                    da.Fill(dataTable);

                    connection.Close();
                }
            }

            return View();
        }

    }
}

説明

上記サンプルコードの 21行目 はデータベースファイルへのパスなので、環境により変化します。

connectionString がなかなかうまくいかず、いろいろと試して上記コードでなんとかうまく動きました。

ASP.NET MVC （C#）でアプリケーションを作成していて、スタブとして .mdf ファイル のデータベースが利用できると作業効率もあがるのではないか… そんな考えで、SQL Server データベース ファイル の利用方法をまとめてみました。

IE8、IE9、IE10 の userAgent について、ブラウザモードによる違い、プラットフォームによる違いを調査してみました。 調査結果はダイジェスト（まとめ）と具体的な一覧にしてみました。

IE8 - IE10 まとめ

• ドキュメントモードを変更しても userAgent は変わらない。
• 互換表示の場合、MSIE 7.0 と Trident/x.0 が同時に存在する。
  • Trident/6.0 の場合、IE10
  • Trident/5.0 の場合、IE9
  • Trident/4.0 の場合、IE8
  • Trident がない場合、IE7
• ノートPCの場合、Tablet PC x.0 が存在する。
• 64bit OS で 32bit IE の場合、WOW64 が存在する。
• 64bit OS で 64bit IE の場合、Win64 が存在する。
• Windows NT x.xでプラットフォームが分かる。
  • Windows NT 6.1 の場合、Windows 7
  • Windows NT 6.0 の場合、Windows Vista
  • Windows NT 5.1 の場合、Windows XP

調査結果 一覧

表は横にスクロールしてご確認ください。

調査環境は Windows 7 32bit ノートPC（IE8-10）、Windows 8.1 64bit ノートPC（IE11） です。

Mozilla/5.0 (compatible; MSIE 10.0; Windows NT 6.1; Trident/6.0; SLCC2; .NET CLR 2.0.50727; .NET CLR 3.5.30729; .NET CLR 3.0.30729; Media Center PC 6.0; InfoPath.2; .NET4.0C; .NET4.0E; Tablet PC 2.0)

Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 6.1; Trident/6.0; SLCC2; .NET CLR 2.0.50727; .NET CLR 3.5.30729; .NET CLR 3.0.30729; Media Center PC 6.0; InfoPath.2; .NET4.0C; .NET4.0E; Tablet PC 2.0)

Mozilla/5.0 (compatible; MSIE 9.0; Windows NT 6.1; Trident/5.0; Tablet PC 2.0)

Mozilla/4.0 (compatible; MSIE 8.0; Windows NT 6.1; Trident/4.0; SLCC2; .NET CLR 2.0.50727; .NET CLR 3.5.30729; .NET CLR 3.0.30729; Media Center PC 6.0; InfoPath.2; .NET4.0C; .NET4.0E; Tablet PC 2.0)

Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 6.1; SLCC2; .NET CLR 2.0.50727; .NET CLR 3.5.30729; .NET CLR 3.0.30729; Media Center PC 6.0; InfoPath.2; .NET4.0C; .NET4.0E; Tablet PC 2.0)

Mozilla/5.0 (compatible; MSIE 9.0; Windows NT 6.1; Trident/5.0; Tablet PC 2.0)

Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 6.1; Trident/5.0; SLCC2; .NET CLR 2.0.50727; .NET CLR 3.5.30729; .NET CLR 3.0.30729; Media Center PC 6.0; .NET4.0C; .NET4.0E; Tablet PC 2.0)

Mozilla/4.0 (compatible; MSIE 8.0; Windows NT 6.1; Trident/4.0; SLCC2; .NET CLR 2.0.50727; .NET CLR 3.5.30729; .NET CLR 3.0.30729; Media Center PC 6.0; .NET4.0C; .NET4.0E; Tablet PC 2.0)

Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 6.1; SLCC2; .NET CLR 2.0.50727; .NET CLR 3.5.30729; .NET CLR 3.0.30729; Media Center PC 6.0; .NET4.0C; .NET4.0E; Tablet PC 2.0)

Mozilla/4.0 (compatible; MSIE 8.0; Windows NT 6.1; Trident/4.0; SLCC2; .NET CLR 2.0.50727; .NET CLR 3.5.30729; .NET CLR 3.0.30729; Media Center PC 6.0; .NET4.0C; .NET4.0E; Tablet PC 2.0)

Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 6.1; Trident/4.0; SLCC2; .NET CLR 2.0.50727; .NET CLR 3.5.30729; .NET CLR 3.0.30729; Media Center PC 6.0; .NET4.0C; .NET4.0E; Tablet PC 2.0)

Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 6.1; SLCC2; .NET CLR 2.0.50727; .NET CLR 3.5.30729; .NET CLR 3.0.30729; Media Center PC 6.0; .NET4.0C; .NET4.0E; Tablet PC 2.0)

参考記事

• ユーザー エージェント文字列を理解する
• Internet Explorer 10 のユーザー エージェント文字列
• 64bit Windows (XP、Vista、7)のUserAgentを調べてみた

Windows Installer XML (WiX) toolset を 利用して、Internet Explorer 向け アドオン の インストーラー を開発します。 開発した アドオン を エンドユーザー に利用してもらうために必要な処理 ──「コンポーネントの配置」「レジストリ登録」── を実行する インストーラー を作成します。 今回は以前書いた "IE の アドオン 開発" の続編になります。

サンプルコードのダウンロード
（※2013/06/26 WiX3.5 だとコンパイルエラーが起こりました。WiX3.7 以上でお試しください。）

1. 概要
2. セットアップ プロジェクト の作成
3. インストーラー の実装
4. コンパイル
5. テスト

※WiX をまだインストールされていない場合は、以下のサイトからダウンロード & インストールをお願いいたします。
→ WiX Toolset - Download

概要

以前書いた記事 だと、IE 上で動作する ActiveX は作成、検証まではできています。 アドオンはちゃんとできているし動いているけれど、インストーラーを作ることで、次のようなことを提供できるようにしようと思います。

• エンドユーザーが利用できる環境を作る（配置とレジストリ登録）
• [ツール]-[アドオンの管理] に作成したアドオンを表示する

今回のインストーラーでは最低限の機能を提供するにとどめているため、 インストーラーは英語のままだったり、プログラムの追加と削除にアイコンがなかったり、製品名や会社名の表記が不完全だったりする部分があります。 これらはまた時間があるときに…。。

セットアップ プロジェクト の 作成

1. [ファイル]-[新規作成]-[プロジェクト]を選択
   
2. 「Windows Installer XML」 の 「Setup Project」を選択
   以下の項目を入力して「OK」を選択
   
   • 名前
   • 場所
   • ソリューション名
   
3. 「ソリューションエクスプローラー」から「References」を右クリック-[参照の追加]を選択
   
4. 「参照」タブで次のファイルを追加
   
   ※標準設定で WiX toolset を インストール している場合、"C:\Program Files\WiX Toolset v3.7\bin"にあります。
   • WixNetFxExtension.dll
   • WixUIExtension.dll
   

ソリューション/プロジェクトを作成しただけだと、.NET Framework のチェック および 画面付きのインストーラーが作れないため、参照設定を追加しています。 WixNetFxExtension.dll の参照で、 .NET Framework のインストール状況のチェックを行えるようにする拡張機能が利用できるようになります。 WixUIExtension.dll の参照で、画面付きインストーラーが作れるようになります。

インストーラー の 実装

ソースコードは Product.wxs と Components.wxs の2ファイルだけです。

Product.wxs はソリューション作成時にあるファイルの修正を行います。 インストーラーの画面構成、.NET Frameworkインストール状況のチェック、インストール構成（完全 or カスタム or オヌヌメ）、インストールディレクトリ構成を設定します。

Components.wxs は WiX toolset に付属するツールを利用して自動生成したものを修正します。 実際にインストールするファイル、登録するレジストリ情報を設定します。

Product.wxs

修正前

<?xml version="1.0" encoding="UTF-8"?>
<Wix xmlns="http://schemas.microsoft.com/wix/2006/wi">
  <Product Id="*" Name="SetupProject" Language="1033" Version="1.0.0.0" Manufacturer="" UpgradeCode="a08f60e3-67db-4b13-bc5c-195124554fb1">
    <Package InstallerVersion="200" Compressed="yes" InstallScope="perMachine" />

    <MajorUpgrade DowngradeErrorMessage="A newer version of [ProductName] is already installed." />
    <MediaTemplate />

    <Feature Id="ProductFeature" Title="SetupProject" Level="1">
      <ComponentGroupRef Id="ProductComponents" />
    </Feature>
  </Product>

  <Fragment>
    <Directory Id="TARGETDIR" Name="SourceDir">
      <Directory Id="ProgramFilesFolder">
        <Directory Id="INSTALLFOLDER" Name="SetupProject" />
      </Directory>
    </Directory>
  </Fragment>

  <Fragment>
    <ComponentGroup Id="ProductComponents" Directory="INSTALLFOLDER">
      <!-- TODO: Remove the comments around this Component element and the ComponentRef below in order to add resources to this installer. -->
      <!-- <Component Id="ProductComponent"> -->
      <!-- TODO: Insert files, registry keys, and other resources here. -->
      <!-- </Component> -->
    </ComponentGroup>
  </Fragment>
</Wix>

修正後

<?xml version="1.0" encoding="UTF-8"?>
<Wix xmlns="http://schemas.microsoft.com/wix/2006/wi">
  <Product Id="*" Name="Sample Product" Language="1033" Version="1.0.0.0" Manufacturer="Sample Co. Ltd." UpgradeCode="a08f60e3-67db-4b13-bc5c-195124554fb1">
    <Package InstallerVersion="200" Compressed="yes" InstallScope="perMachine" />

    <MajorUpgrade DowngradeErrorMessage="A newer version of [ProductName] is already installed." />
    <MediaTemplate />

    <Feature Id="ProductFeature" Title="SetupProject" Level="1">
      <ComponentGroupRef Id="ProductComponents" />
    </Feature>

    <UIRef Id="WixUI_Mondo" />
    <PropertyRef Id="NETFRAMEWORK35" />
    <Condition Message="This application requires .NET Framework X.Y.">Installed OR NETFRAMEWORK35</Condition>
  </Product>

  <Fragment>
    <Directory Id="TARGETDIR" Name="SourceDir">
      <Directory Id="ProgramFilesFolder">
        <Directory Id="INSTALLFOLDER" Name="SetupProject" />
      </Directory>
    </Directory>
  </Fragment>
</Wix>

"修正前" の XML に対して、以下のような修正を行います。 （すべての修正を行った結果が "修正後" になります。）

• [修正] //WiX/Product/@Name
  Product要素のName属性を実際の 製品名 に修正します。
• [修正] //WiX/Product/@Manufacture
  Product要素のManufacture属性に 会社名 を記載します。
• [追加] //WiX/Product/UIRef
  以下の要素を追加します。 これにより、インストール時によく見かける画面を追加することができます。 また、この機能を利用するために WixUIExtension.dll を参照設定しています。

  <UIRef Id="WixUI_Mondo" />
  

• [追加] //WiX/Product/PropertyRef
  [追加] //WiX/Product/Condition
  以下の要素を追加します。 これにより、インストール時に .NET Framework 3.5 が入っていないとエラーメッセージがでるようになります。 また、この機能を利用するために WixNetFxExtension.dll を参照設定しています。

  <PropertyRef Id="NETFRAMEWORK35" />
  <Condition Message="This application requires .NET Framework X.Y.">Installed OR NETFRAMEWORK35</Condition>
  

• [削除] //WiX/Fragment[name(child)="ComponentGroup"]
  子要素が ComponentGroup である Fragment要素を削除します。 （この要素の内容は Components.wxs ファイルへ記載します。）

Components.wxs

自動生成結果

<?xml version="1.0" encoding="utf-8"?>
<Wix xmlns="http://schemas.microsoft.com/wix/2006/wi">
  <Fragment>
    <DirectoryRef Id="TARGETDIR">
      <Directory Id="dir4DBD5D1D35BB67517C2CB9713EA6BB0E" Name="WiX" />
    </DirectoryRef>
  </Fragment>
  <Fragment>
    <DirectoryRef Id="dir4DBD5D1D35BB67517C2CB9713EA6BB0E">
      <Component Id="cmpDB54D4524917C8B707E5BBF38A699D28" Guid="PUT-GUID-HERE">
        <Class Id="{234E6679-2F92-368C-ABD4-89F063D07579}" Context="InprocServer32" Description="Sample.ActiveXPlugIn.IObjectSafetyTLB" ThreadingModel="both" ForeignServer="mscoree.dll">
          <ProgId Id="Sample.ActiveXPlugIn.IObjectSafetyTLB" Description="Sample.ActiveXPlugIn.IObjectSafetyTLB" />
        </Class>
        <Class Id="{273737CB-CA7D-45C5-84F6-EF4D5A3D8C79}" Context="InprocServer32" Description="Sample.ActiveXPlugIn.MyForm" ThreadingModel="both" ForeignServer="mscoree.dll">
          <ProgId Id="Sample.ActiveXPlugIn.MyForm" Description="Sample.ActiveXPlugIn.MyForm" />
        </Class>
        <Class Id="{EBD6E54B-8223-313B-A575-110E1BA8D32C}" Context="InprocServer32" Description="Sample.ActiveXPlugIn.Form1" ThreadingModel="both" ForeignServer="mscoree.dll">
          <ProgId Id="Sample.ActiveXPlugIn.Form1" Description="Sample.ActiveXPlugIn.Form1" />
        </Class>
        <File Id="filCC77BD2DCA029040BCFF7EBD663B08E2" KeyPath="yes" Source="SourceDir\WiX\SampleActiveXPlugIn.dll" />
        <RegistryValue Root="HKCR" Key="CLSID\{234E6679-2F92-368C-ABD4-89F063D07579}\Implemented Categories\{62C8FE65-4EBB-45e7-B440-6E39B2CDBF29}" Value="" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{234E6679-2F92-368C-ABD4-89F063D07579}\InprocServer32\1.0.0.0" Name="Class" Value="Sample.ActiveXPlugIn.IObjectSafetyTLB" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{234E6679-2F92-368C-ABD4-89F063D07579}\InprocServer32\1.0.0.0" Name="Assembly" Value="SampleActiveXPlugIn, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{234E6679-2F92-368C-ABD4-89F063D07579}\InprocServer32\1.0.0.0" Name="RuntimeVersion" Value="v4.0.30319" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{234E6679-2F92-368C-ABD4-89F063D07579}\InprocServer32\1.0.0.0" Name="CodeBase" Value="file:///[#filCC77BD2DCA029040BCFF7EBD663B08E2]" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{234E6679-2F92-368C-ABD4-89F063D07579}\InprocServer32" Name="Class" Value="Sample.ActiveXPlugIn.IObjectSafetyTLB" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{234E6679-2F92-368C-ABD4-89F063D07579}\InprocServer32" Name="Assembly" Value="SampleActiveXPlugIn, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{234E6679-2F92-368C-ABD4-89F063D07579}\InprocServer32" Name="RuntimeVersion" Value="v4.0.30319" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{234E6679-2F92-368C-ABD4-89F063D07579}\InprocServer32" Name="CodeBase" Value="file:///[#filCC77BD2DCA029040BCFF7EBD663B08E2]" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{273737CB-CA7D-45C5-84F6-EF4D5A3D8C79}\Implemented Categories\{62C8FE65-4EBB-45e7-B440-6E39B2CDBF29}" Value="" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{273737CB-CA7D-45C5-84F6-EF4D5A3D8C79}\InprocServer32\1.0.0.0" Name="Class" Value="Sample.ActiveXPlugIn.MyForm" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{273737CB-CA7D-45C5-84F6-EF4D5A3D8C79}\InprocServer32\1.0.0.0" Name="Assembly" Value="SampleActiveXPlugIn, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{273737CB-CA7D-45C5-84F6-EF4D5A3D8C79}\InprocServer32\1.0.0.0" Name="RuntimeVersion" Value="v4.0.30319" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{273737CB-CA7D-45C5-84F6-EF4D5A3D8C79}\InprocServer32\1.0.0.0" Name="CodeBase" Value="file:///[#filCC77BD2DCA029040BCFF7EBD663B08E2]" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{273737CB-CA7D-45C5-84F6-EF4D5A3D8C79}\InprocServer32" Name="Class" Value="Sample.ActiveXPlugIn.MyForm" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{273737CB-CA7D-45C5-84F6-EF4D5A3D8C79}\InprocServer32" Name="Assembly" Value="SampleActiveXPlugIn, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{273737CB-CA7D-45C5-84F6-EF4D5A3D8C79}\InprocServer32" Name="RuntimeVersion" Value="v4.0.30319" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{273737CB-CA7D-45C5-84F6-EF4D5A3D8C79}\InprocServer32" Name="CodeBase" Value="file:///[#filCC77BD2DCA029040BCFF7EBD663B08E2]" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{EBD6E54B-8223-313B-A575-110E1BA8D32C}\Implemented Categories\{62C8FE65-4EBB-45e7-B440-6E39B2CDBF29}" Value="" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{EBD6E54B-8223-313B-A575-110E1BA8D32C}\InprocServer32\1.0.0.0" Name="Class" Value="Sample.ActiveXPlugIn.Form1" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{EBD6E54B-8223-313B-A575-110E1BA8D32C}\InprocServer32\1.0.0.0" Name="Assembly" Value="SampleActiveXPlugIn, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{EBD6E54B-8223-313B-A575-110E1BA8D32C}\InprocServer32\1.0.0.0" Name="RuntimeVersion" Value="v4.0.30319" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{EBD6E54B-8223-313B-A575-110E1BA8D32C}\InprocServer32\1.0.0.0" Name="CodeBase" Value="file:///[#filCC77BD2DCA029040BCFF7EBD663B08E2]" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{EBD6E54B-8223-313B-A575-110E1BA8D32C}\InprocServer32" Name="Class" Value="Sample.ActiveXPlugIn.Form1" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{EBD6E54B-8223-313B-A575-110E1BA8D32C}\InprocServer32" Name="Assembly" Value="SampleActiveXPlugIn, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{EBD6E54B-8223-313B-A575-110E1BA8D32C}\InprocServer32" Name="RuntimeVersion" Value="v4.0.30319" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{EBD6E54B-8223-313B-A575-110E1BA8D32C}\InprocServer32" Name="CodeBase" Value="file:///[#filCC77BD2DCA029040BCFF7EBD663B08E2]" Type="string" Action="write" />
      </Component>
    </DirectoryRef>
  </Fragment>
</Wix>

修正後

<?xml version="1.0" encoding="utf-8"?>
<Wix xmlns="http://schemas.microsoft.com/wix/2006/wi">
  <Fragment>
    <ComponentGroup Id="ProductComponents" Directory="INSTALLFOLDER">
      <Component Id="cmpDB54D4524917C8B707E5BBF38A699D28" Guid="C8BA8C74-F2A4-4A53-9FC4-92CDC7897287">
        <Class Id="{234E6679-2F92-368C-ABD4-89F063D07579}" Context="InprocServer32" Description="Sample.ActiveXPlugIn.IObjectSafetyTLB" ThreadingModel="both" ForeignServer="mscoree.dll">
          <ProgId Id="Sample.ActiveXPlugIn.IObjectSafetyTLB" Description="Sample.ActiveXPlugIn.IObjectSafetyTLB" />
        </Class>
        <Class Id="{273737CB-CA7D-45C5-84F6-EF4D5A3D8C79}" Context="InprocServer32" Description="Sample.ActiveXPlugIn.MyForm" ThreadingModel="both" ForeignServer="mscoree.dll">
          <ProgId Id="Sample.ActiveXPlugIn.MyForm" Description="Sample.ActiveXPlugIn.MyForm" />
        </Class>
        <Class Id="{EBD6E54B-8223-313B-A575-110E1BA8D32C}" Context="InprocServer32" Description="Sample.ActiveXPlugIn.Form1" ThreadingModel="both" ForeignServer="mscoree.dll">
          <ProgId Id="Sample.ActiveXPlugIn.Form1" Description="Sample.ActiveXPlugIn.Form1" />
        </Class>
        <File Id="filCC77BD2DCA029040BCFF7EBD663B08E2" KeyPath="yes" Source=".\SourceDir\SampleActiveXPlugIn.dll" />
        <RegistryValue Root="HKLM" Key="SOFTWARE\Microsoft\Windows\CurrentVersion\Ext\PreApproved\{273737CB-CA7D-45C5-84F6-EF4D5A3D8C79}" Value="" Type="string"  Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{234E6679-2F92-368C-ABD4-89F063D07579}\Implemented Categories\{62C8FE65-4EBB-45e7-B440-6E39B2CDBF29}" Value="" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{234E6679-2F92-368C-ABD4-89F063D07579}\InprocServer32\1.0.0.0" Name="Class" Value="Sample.ActiveXPlugIn.IObjectSafetyTLB" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{234E6679-2F92-368C-ABD4-89F063D07579}\InprocServer32\1.0.0.0" Name="Assembly" Value="SampleActiveXPlugIn, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{234E6679-2F92-368C-ABD4-89F063D07579}\InprocServer32\1.0.0.0" Name="RuntimeVersion" Value="v4.0.30319" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{234E6679-2F92-368C-ABD4-89F063D07579}\InprocServer32\1.0.0.0" Name="CodeBase" Value="file:///[#filCC77BD2DCA029040BCFF7EBD663B08E2]" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{234E6679-2F92-368C-ABD4-89F063D07579}\InprocServer32" Name="Class" Value="Sample.ActiveXPlugIn.IObjectSafetyTLB" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{234E6679-2F92-368C-ABD4-89F063D07579}\InprocServer32" Name="Assembly" Value="SampleActiveXPlugIn, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{234E6679-2F92-368C-ABD4-89F063D07579}\InprocServer32" Name="RuntimeVersion" Value="v4.0.30319" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{234E6679-2F92-368C-ABD4-89F063D07579}\InprocServer32" Name="CodeBase" Value="file:///[#filCC77BD2DCA029040BCFF7EBD663B08E2]" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{273737CB-CA7D-45C5-84F6-EF4D5A3D8C79}\Implemented Categories\{62C8FE65-4EBB-45e7-B440-6E39B2CDBF29}" Value="" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{273737CB-CA7D-45C5-84F6-EF4D5A3D8C79}\Implemented Categories\{7DD95801-9882-11CF-9FA9-00AA006C42C4}" Value="" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{273737CB-CA7D-45C5-84F6-EF4D5A3D8C79}\Implemented Categories\{7DD95802-9882-11CF-9FA9-00AA006C42C4}" Value="" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{273737CB-CA7D-45C5-84F6-EF4D5A3D8C79}\InprocServer32\1.0.0.0" Name="Class" Value="Sample.ActiveXPlugIn.MyForm" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{273737CB-CA7D-45C5-84F6-EF4D5A3D8C79}\InprocServer32\1.0.0.0" Name="Assembly" Value="SampleActiveXPlugIn, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{273737CB-CA7D-45C5-84F6-EF4D5A3D8C79}\InprocServer32\1.0.0.0" Name="RuntimeVersion" Value="v4.0.30319" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{273737CB-CA7D-45C5-84F6-EF4D5A3D8C79}\InprocServer32\1.0.0.0" Name="CodeBase" Value="file:///[#filCC77BD2DCA029040BCFF7EBD663B08E2]" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{273737CB-CA7D-45C5-84F6-EF4D5A3D8C79}\InprocServer32" Name="Class" Value="Sample.ActiveXPlugIn.MyForm" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{273737CB-CA7D-45C5-84F6-EF4D5A3D8C79}\InprocServer32" Name="Assembly" Value="SampleActiveXPlugIn, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{273737CB-CA7D-45C5-84F6-EF4D5A3D8C79}\InprocServer32" Name="RuntimeVersion" Value="v4.0.30319" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{273737CB-CA7D-45C5-84F6-EF4D5A3D8C79}\InprocServer32" Name="CodeBase" Value="file:///[#filCC77BD2DCA029040BCFF7EBD663B08E2]" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{EBD6E54B-8223-313B-A575-110E1BA8D32C}\Implemented Categories\{62C8FE65-4EBB-45e7-B440-6E39B2CDBF29}" Value="" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{EBD6E54B-8223-313B-A575-110E1BA8D32C}\InprocServer32\1.0.0.0" Name="Class" Value="Sample.ActiveXPlugIn.Form1" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{EBD6E54B-8223-313B-A575-110E1BA8D32C}\InprocServer32\1.0.0.0" Name="Assembly" Value="SampleActiveXPlugIn, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{EBD6E54B-8223-313B-A575-110E1BA8D32C}\InprocServer32\1.0.0.0" Name="RuntimeVersion" Value="v4.0.30319" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{EBD6E54B-8223-313B-A575-110E1BA8D32C}\InprocServer32\1.0.0.0" Name="CodeBase" Value="file:///[#filCC77BD2DCA029040BCFF7EBD663B08E2]" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{EBD6E54B-8223-313B-A575-110E1BA8D32C}\InprocServer32" Name="Class" Value="Sample.ActiveXPlugIn.Form1" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{EBD6E54B-8223-313B-A575-110E1BA8D32C}\InprocServer32" Name="Assembly" Value="SampleActiveXPlugIn, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{EBD6E54B-8223-313B-A575-110E1BA8D32C}\InprocServer32" Name="RuntimeVersion" Value="v4.0.30319" Type="string" Action="write" />
        <RegistryValue Root="HKCR" Key="CLSID\{EBD6E54B-8223-313B-A575-110E1BA8D32C}\InprocServer32" Name="CodeBase" Value="file:///[#filCC77BD2DCA029040BCFF7EBD663B08E2]" Type="string" Action="write" />
      </Component>
    </ComponentGroup>
  </Fragment>
</Wix>

まず、以下の手順でレジストリ登録すべき情報を抽出します。 現状はファイルが1つなので手作業で行うことも不可能ではないですが… ファイル数が多くなると手作業では難しくなるので以下の手順で自動生成がオススメです。

コマンド例

set PATH=%PATH%;C:\Program Files\WiX Toolset v3.7\bin
heat file SampleActiveXPlugIn.dll -out Components.wxs

構文

heat file [dllファイル名] -out [出力ファイル名]

自動生成したファイルに対して以下の修正を行います。 すべての修正を行った結果が "修正後" になります。

• [削除] //WiX/Fragment[DirectoryRef@Id="TARGET"]
  Id属性 が TARGET である DirectoryRef 要素を子要素に持つ Fragment 要素を削除します。
• [修正] //WiX/Fragment/DirectoryRef[@Id="dir4DBD5D1D35BB67517C2CB9713EA6BB0E"]
  Id が "dir4DBD5D1D35BB67517C2CB9713EA6BB0E"（GUIDを利用しているので実際は異なる場合があります) の DirectoryRef要素 を ComponentGroup要素に置き換えます。 その際、Id 属性は Product.wxs の "//WiX/Product/Feature/ComponentGroupRef/@Id" 属性値を参照し、 Directory 属性 は Product.wxs の "//WiX/Fragment/Directory/Directory/Directory/@Id" 属性値を参照します。

  <ComponentGroup Id="ProductComponents" Direcory="INSTALLFOLDER">
      ｜…
  </ComponentGroup>
  

• [修正] //WiX/Fragment/DirectoryRef/Component/@Guid
  新しい GUID を発行して記載します。
• [修正] //WiX/Fragment/DirectoryRef/Component/File/@Source
  プロジェクトディレクトリから見た dll ファイルへのパスに修正します。 ソリューションが同じであれば本当は良いのですが… そうもいかないので、プロジェクト内に "SourceDir" ディレクトリを作成、インストールするファイルをコピーして配置し、そこへの参照としました。
• [追加] //WiX/Fragment/DirectoryRef/Component/RegistryValue
  以下のレジストリキーを追加します。 このキーを追加することで、IE の "アドオンの管理" へ項目を追加することができます。 また、このキーは IE に安全なアドオンとして登録ができ、警告を抑止することができます。 このレジストリに関する詳細は こちら をご参照ください。
  ※GUID部分（{273737CB-CA7D-45C5-84F6-EF4D5A3D8C79}）は実際のGUIDへ書き換えてください。

  <RegistryValue Root="HKLM" Key="SOFTWARE\Microsoft\Windows\CurrentVersion\Ext\PreApproved\{273737CB-CA7D-45C5-84F6-EF4D5A3D8C79}" Value="" Type="string"  Action="write" />
  

• [追加] //WiX/Fragment/DirectoryRef/Component/RegistryValue
  以下のレジストリキーを追加します。 このキーを追加することで、IE はこのアドオンが安全であると認識するようになります。 このレジストリに関する詳細は こちら をご参照ください。
  ※GUID部分（{273737CB-CA7D-45C5-84F6-EF4D5A3D8C79}）は実際のGUIDへ書き換えてください。

  <RegistryValue Root="HKCR" Key="CLSID\{273737CB-CA7D-45C5-84F6-EF4D5A3D8C79}\Implemented Categories\{7DD95801-9882-11CF-9FA9-00AA006C42C4}" Value="" Type="string" Action="write" />
  <RegistryValue Root="HKCR" Key="CLSID\{273737CB-CA7D-45C5-84F6-EF4D5A3D8C79}\Implemented Categories\{7DD95802-9882-11CF-9FA9-00AA006C42C4}" Value="" Type="string" Action="write" />
  

コンパイル

Visual Studio を利用している場合、以下の手順でコンパイルできます。 出力先は設定によりますが… デフォルト だと bin\Debug または bin\Release の下になります。

1. ソリューション エクスプローラー から セットアップ プロジェクト を選択
2. 右クリック-[ビルド] を選択

テスト

テスト実行する前に、regedit でインストールされる予定のレジストリ情報を削除しておきます。

レジストリの削除が終わると、いざテスト実行です。 [Next] を押していって、作成した アドオン を インストール します。

インストールが完了した後、以下の2点の動作確認を行います。

• テストページが実行可能であること。
  
• Internet Explorer の "アドオン の管理" に追加されていること。
  

ブラウザでどのようにページ遷移が行われたかを簡単に記録するためのフィルターを作成します。

このフィルターを利用することで「不適切なページ遷移を拒否できる」とか「ブラウザの戻る機能の無効化」 ができるようになることを目指します。

• ソースコード
• 説明
• 使用例

ソースコード

閲覧履歴をセッションに残すフィルターを作成します。 ここでは Filters フォルダ & 名前空間を１つ掘って実装しています。

BrowsingHistoryAttribute.cs

namespace SampleMvcApplication.Filters
{
    using System;
    using System.Collections.Generic;
    using System.Linq;
    using System.Web;
    using System.Web.Mvc;

    /// <summary>
    /// 閲覧履歴をセッションに記録するフィルター属性を表します。
    /// </summary>
    public class BrowsingHistoryAttribute : FilterAttribute, IActionFilter
    {
        /// <summary>
        /// 直前に閲覧したURLをセッションに保存するキー文字列
        /// </summary>
        public static string PREVIOUS_URL = "PREVIOUS_URL";

        /// <summary>
        /// 現在要求されたURLをセッションに保存するキー文字列
        /// </summary>
        public static string CURRENT_URL = "CURRENT_URL";

        /// <summary>
        /// アクション結果の実行後に ASP.NET MVC フレームワークによって呼び出されます。
        /// </summary>
        /// <param name="filterContext">フィルター コンテキスト</param>
        public void OnActionExecuted(ActionExecutedContext filterContext)
        {
        }

        /// <summary>
        /// アクション結果の実行前に ASP.NET MVC フレームワークによって呼び出されます。
        /// </summary>
        /// <param name="filterContext">フィルター コンテキスト</param>
        public void OnActionExecuting(ActionExecutingContext filterContext)
        {
            // 必要な変数を取得
            var httpContext = filterContext.HttpContext;
            var session = httpContext.Session;
            var request = httpContext.Request;

            // POST と Ajax リクエスト は記録しない
            if (request.HttpMethod == "POST" || request.IsAjaxRequest())
            {
                return;
            }

            // リクエストURL を正規化
            var url = this.GetNormalizedRequestUrl(httpContext);

            // 閲覧履歴を更新
            session[PREVIOUS_URL] = session[CURRENT_URL];
            session[CURRENT_URL] = url;
        }

        /// <summary>
        /// リクエストURLを正規化します
        /// </summary>
        /// <param name="httpContext">HTTP コンテキスト</param>
        /// <returns>正規化された リクエストURL</returns>
        private string GetNormalizedRequestUrl(HttpContextBase httpContext)
        {
            var routeData = System.Web.Routing.RouteTable.Routes.GetRouteData(httpContext);
            var controllerName = routeData.Values["controller"].ToString().ToLower();
            var actionName = routeData.Values["action"].ToString().ToLower();
            var queryString = httpContext.Request.QueryString.ToString();

            if (string.IsNullOrEmpty(queryString))
            {
                return string.Format("{0}/{1}", controllerName, actionName);
            }
            else
            {
                return string.Format("{0}/{1}?{2}", controllerName, actionName, queryString);
            }
        }
    }
}

説明

フィルターなので FilterAttributeクラス の継承を行います。 今回のフィルターはできるだけ早いタイミングで実施したいので、IActionFilterインターフェース の実装を行っています。

.OnActionExecuting で セッション に対して閲覧履歴を更新しにかかります。 POST と Ajax リクエストは保存しないように処理されています。

.OnActionExecuted は特に必要な処理がないので何も記述しない空のメソッドになります。

リクエストURLはショートカットされる場合（MapPathに登録されていたり、IndexのようにIISに登録されていたりする場合）があるので、 .GetNormalizedRequestUrl 関数を利用してキチンとしたURLへ再マッピングしなおしています。 この関数にかんする詳細は こちら の記事をご参照ください。

使用例

上記ソースコードで記述した属性を利用してみます。 以下のサンプルコードでハイライトされた部分が利用例となります。 Controller クラス に対して属性をつけることで、そのクラスのメソッドすべてに対して履歴を取るようにしています。

サンプルコード

namespace SampleMvcApplication.Controllers
{
    using System;
    using System.Collections.Generic;
    using System.Linq;
    using System.Web;
    using System.Web.Mvc;
    using SampleMvcApplication.Filters;

    [BrowsingHistory]
    public class HomeController : Controller
    {
        public ActionResult Index()
        {
            return this.View();
        }

        public ActionResult Login()
        {
            return this.View();
        }

        public ActionResult Index2()
        {
            return this.View();
        }
    }
}

アプリケーションルートURL（ベースURL？基本URL？…どういう呼び方が正しいかよく分かりません。。） は IIS へホストされた状況によって変化します。 そのような状況でも確実に ルートURL を取得する方法です。

サンプルコード

var scheme = httpContext.Request.Url.Scheme;
var authority = httpContext.Request.Url.Authority;
var path = HttpRuntime.AppDomainAppVirtualPath;

// ルートURL の生成
var baseUrl = string.Format("{0}://{1}{2}", scheme, authority, path);

説明

Request.Url.Scheme では、http または https を取得します。
Request.Url.Authority では、ホスト名 または IPアドレス と ポート番号 の組み合わせを取得します。
HttpRuntime.AppDomainAppVirtualPath では、現在のアプリケーション ドメインでホストされる、アプリケーションを格納するディレクトリの仮想パスを取得します。 AppDomainAppVirtualPath は static プロパティ なので、HttpRuntimeクラス から 直接取得します。

※上記サンプルコード中の httpContext に対して何もありませんが、現在実行中の HttpContextBase を指定します。

今回、参考にしたサイトは以下の通りです。

• How can I get my webapp's base URL in ASP.NET MVC?
• HttpRuntime クラス

RouteData を利用して、リクエストされた コントローラー名 および アクション名 を取得する方法です。

• コントローラー名、アクション名 を 取得する方法の基本
• コントローラー内で取得するサンプルコード
• ヘルパークラス内で取得するサンプルコード
• カスタムフィルター内で取得するサンプルコード

コントローラー名、アクション名 を 取得する方法の基本

サンプルコード

var routeData = System.Web.Routing.RouteTable.Routes.GetRouteData(httpContext);
var controllerName = routeData.Values["controller"].ToString();
var actionName = routeData.Values["action"].ToString();

説明

RouteDataインスタンス の Values プロパティ はハッシュ配列になっています。 このハッシュ配列において、"controller" キーの値が コントローラー名、"action" キーの値が アクション名となっています。 （"controller" および "action" の文字列は固定文字列のようです。）

リクエストされたコントローラー名、アクション名の取得は、RouteDataクラス の インスタンス をいかに取得するかがポイントになります。 以下のサンプルコードでは、状況に応じて RouteData インスタンス の取得方法が変わっています。

※上記サンプルコードでは "httpContext" に対して何も記述がありませんが、現在実行中の "HttpContextBase" を指定します。

コントローラー の アクションメソッド内 で 取得 する サンプルコード

サンプルコード

public class HomeController : Controller
{
    //
    // GET: /Home/Index
    public ActionResult Index()
    {
        // コントローラー名、アクション名の取得
        var controllerName = this.RouteData.Values["controller"].ToString();
        var actionName = this.RouteData.Values["action"].ToString();

        return View();
    }
}

説明

Controller クラスを継承したクラス内で利用する場合、RouteDataインスタンス がプロパティに既に存在しているので、そのまま利用します。

ヘルパークラス の 拡張メソッド内 で 取得 する サンプルコード

サンプルコード

public static class SampleExtensions
{
    public static string GetNormalizedRequestUrl(this HtmlHelper helper)
    {
        // HttpContextBase インスタンス の取得
        var httpContext = helper.ViewContext.HttpContext;

        // RouteData および コントローラー名、アクション名、クエリ文字列 の取得
        var routeData = helper.RouteCollection.GetRouteData(httpContext);
        var controllerName = routeData.Values["controller"].ToString();
        var actionName = routeData.Values["action"].ToString();
        var queryString = httpContext.Request.QueryString.ToString();

        // クエリ有無によってURL生成方法を変更
        if (string.IsNullOrEmpty(queryString))
        {
            return string.Format("{0}/{1}", controllerName, actionName);
        }
        else
        {
            return string.Format("{0}/{1}?{2}", controllerName, actionName, queryString);
        }
    }
}

説明

ヘルパークラス では RouteDataインスタンス が直接利用できないため、取得してくる必要があります。 HttpContextBaseインスタンス を利用して RouteCollection.GetRouteData( HttpContextBase httpContext ) を利用して RouteDataインスタンス 取得します。

カスタムフィルター の メソッド内 で 取得 する サンプルコード

サンプルコード

public class SampleAttribute: FilterAttribute, IActionFilter
{
    public void OnActionExecuted(ActionExecutedContext filterContext)
    {
        // RouteData および コントローラー名、アクション名 の 取得
        ////var routeData = System.Web.Routing.RouteTable.Routes.GetRouteData(filterContext.HttpContext);
        var routeData = filterContext.RouteData;
        var controllerName = routeData.Values["controller"].ToString();
        var actionName = routeData.Values["action"].ToString();
    }

    public void OnActionExecuting(ActionExecutingContext filterContext)
    {
    }
}

説明

カスタムフィルター では RouteDataインスタンス が直接利用できないため、取得してくる必要があります。 まず、RouteTableクラス の Routes static プロパティ から RouteCollection を取得します。 次に、RouteCollection.GetRouteData( HttpContextBase httpContext ) を利用して RouteDataインスタンス 取得します。
ActionExecutedContext のプロパティに RouteData が存在しているのでそちらをそのまま利用します。(2013/06/25 修正)

今回、参考にしたサイトは以下の通りです。

• ASP.NET-MVC . How to get the controller name from an url?
• RouteData クラス
• RouteCollection クラス
• RouteTable クラス