// Copyright (c) 2008, NTT DATA Corporation.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

using System;
using System.Configuration;
using System.Xml;
using TERASOLUNA.Fw.Common.Configuration;

namespace TERASOLUNA.Fw.Web.Configuration.ExceptionTransition
{
    /// <summary>
    /// 構成ファイル内の exceptionTransitionConfiguration セクションを表します。
    /// </summary>
    /// <remarks>
    /// <see cref="ConfigurationSection"/> クラスを拡張した、exceptionTransitionConfiguration カスタム構成ハンドラです。
    /// 詳細については、<see cref="ConfigurationSection"/> を参照してください。
    /// </remarks>
    public class ExceptionTransitionConfigurationSection : ConfigurationSection
    {
        /// <summary>
        /// exceptionTransitionConfiguraiton の要素名です。
        /// </summary>
        /// <remarks>
        /// この定数の値は "exceptionTransitionConfiguration" です。
        /// </remarks>
        private const string SECTION_NAME = "exceptionTransitionConfiguration";

        /// <summary>
        /// mode 属性の属性名です。
        /// </summary>
        /// <remarks>
        /// この定数の値は "mode" です。
        /// </remarks>
        private const string MODE_ATTRIBUTE_NAME = "mode";

        /// <summary>
        /// logging 属性の属性名です。
        /// </summary>
        /// <remarks>
        /// この定数の値は "logging" です。
        /// </remarks>
        private const string LOGGING_ATTRIBUTE_NAME = "logging";

        /// <summary>
        /// <see cref="FilesCollection"/> の要素名です。
        /// </summary>
        /// <remarks>
        /// この定数の値は "files" です。
        /// </remarks>
        private const string FILES_ELEMENT_NAME = "files";

        /// <summary>
        /// <see cref="ExceptionTransitionCollection"/> の要素名です。
        /// </summary>
        /// <remarks>
        /// この定数の値は "exceptionTransitionConfiguration" です。 
        /// </remarks>
        private const string EXCEPTION_TRANSITION_CONFIGURATION_ELEMENT_NAME = "exceptionTransitionConfiguration";

        /// <summary>
        /// exceptionTransition 要素の exceptionType 属性名です。
        /// </summary>
        /// <remarks>
        /// この定数の値は "exceptionType" です。
        /// </remarks>
        private const string EXCEPTION_TYPE_ATTRIBUTE_NAME = "exceptionType";

        /// <summary>
        /// exceptionTransition 要素の nextPage 属性名です。
        /// </summary>
        /// <remarks>
        /// この定数の値は "nextPage" です。
        /// </remarks>
        private const string NEXT_PAGE_ATTRIBUTE_NAME = "nextPage";

        /// <summary>
        /// 外部設定ファイルの XML 名前空間です。
        /// </summary>
        /// <remarks>
        /// この定数の値は "http://www.terasoluna.jp/schema/ExceptionTransitionSchema.xsd" です。
        /// </remarks>
        private const string XML_NAMESPACE = "http://www.terasoluna.jp/schema/ExceptionTransitionSchema.xsd";

        /// <summary>
        /// 外部設定ファイルの XML 名前空間プレフィックス。
        /// </summary>
        /// <remarks>
        /// この定数の値は "ex" です。
        /// </remarks>
        private const string XML_NAMESPACE_PREFIX = "ex";

        /// <summary>
        /// 外部設定ファイルマージ処理で基準とする要素の XPATH です。
        /// </summary>
        /// <remarks>
        /// この定数の値は "ex:exceptionTransitionConfiguration" です。
        /// </remarks>s
        private const string SECTION_XPATH = XML_NAMESPACE_PREFIX + ":exceptionTransitionConfiguration";

        /// <summary>
        /// 外部設定ファイルマージ処理でマージする要素の XPATH です。
        /// </summary>
        /// <remarks>
        /// この定数の値は "ex:exceptionTransitionConfiguration/ex:exceptionTransition" です。
        /// </remarks>s
        private const string ELEMENT_XPATH = SECTION_XPATH + "/" + XML_NAMESPACE_PREFIX + ":exceptionTransition";

        /// <summary>
        /// XML スキーマファイルの完全名です。
        /// </summary>
        /// <remarks>
        /// この定数の値は "TERASOLUNA.Fw.Web.Configuration.ExceptionTransition.ExceptionTransitionConfiguration.xsd" です。
        /// </remarks>s
        private const string XML_SCHEMA_FILE_NAME = "TERASOLUNA.Fw.Web.Configuration.ExceptionTransition.ExceptionTransitionConfiguration.xsd";


        /// <summary>
        /// <see cref="ExceptionTransitionConfigurationSection"/> クラスの新しいインスタンスを初期化します。
        /// </summary>
        /// <remarks>
        /// デフォルトコンストラクタです。
        /// </remarks>

        public ExceptionTransitionConfigurationSection()
        {
        }

        /// <summary>
        /// mode 属性の設定値を取得します。
        /// </summary>
        /// <value>
        /// mode 属性の設定値。
        /// </value>
        [ConfigurationProperty(MODE_ATTRIBUTE_NAME, DefaultValue = "on")]
        public string Mode
        {
            get
            {
                return (string)base[MODE_ATTRIBUTE_NAME];
            }
        }

        /// <summary>
        /// logging 属性の設定値を取得します。
        /// </summary>
        /// <value>
        /// logging 属性の設定値。
        /// </value>
        [ConfigurationProperty(LOGGING_ATTRIBUTE_NAME, DefaultValue = "off")]
        public string Logging
        {
            get
            {
                return (string)base[LOGGING_ATTRIBUTE_NAME];
            }
        }

        /// <summary>
        /// files 要素を取得します。
        /// </summary>
        /// <remarks>
        /// exceptionTransitionConfiguration セクションから <see cref="FilesCollection"/> クラスのインスタンスを取得します。
        /// </remarks>
        [ConfigurationProperty(FILES_ELEMENT_NAME, IsDefaultCollection = false, IsRequired = true)]
        public FilesCollection Files
        {
            get
            {
                FilesCollection filesCollection = (FilesCollection)base[FILES_ELEMENT_NAME];
                return filesCollection;
            }
        }

        /// <summary>
        /// exceptionTransitionConfiguration 要素を取得します。
        /// </summary>
        ///<remarks>
        /// exceptionTransitionConfiguration セクションから <see cref="ExceptionTransitionCollection"/> クラスのインスタンスを取得します。
        /// </remarks>
        [ConfigurationProperty(EXCEPTION_TRANSITION_CONFIGURATION_ELEMENT_NAME, IsDefaultCollection = false)]
        public ExceptionTransitionCollection ExceptionTransitionCollection
        {
            get
            {
                ExceptionTransitionCollection exceptionTransitionCollection = (ExceptionTransitionCollection)base[EXCEPTION_TRANSITION_CONFIGURATION_ELEMENT_NAME];
                return exceptionTransitionCollection;
            }
        }

        /// <summary>
        /// files 要素の設定内容から exceptionTransition 要素を生成して exceptionTransitionConfiguration 要素に追加します。
        /// </summary>
        /// <remarks>
        /// <para><see cref="MergeConfiguration"/> オブジェクトを生成し、外部設定ファイルの設定情報をマージします。</para>
        /// <para>マージした外部設定ファイルの内容から <see cref="ExceptionTransitionElement"/> オブジェクトを生成し、
        /// <see cref="ExceptionTransitionCollection"/> に追加します。</para>
        /// </remarks>
        /// <exception cref="ArgumentException">
        /// 次のような場合に例外をスローします。
        /// <list type="bullet">
        /// <item>
        /// 外部設定ファイルマージ処理で基準とする要素の XPATH が不正です。
        /// </item>
        /// <item>
        /// 外部設定ファイルマージ処理でマージする要素の XPATH が不正です。
        /// </item>
        /// </list>
        /// </exception>
        /// <exception cref="ConfigurationErrorsException">
        /// 次のような場合に例外をスローします。
        /// <list type="bullet">
        /// <item>
        /// 構成ファイルの外部設定ファイルマージ処理で基準とする要素の XPATH の設定情報が不正です。
        /// </item>
        /// <item>
        /// ファイルの読み込み失敗です。
        /// </item>
        /// <item>
        /// 外部設定ファイルマージ処理で基準とする要素の XPATH が XML スキーマ検証エラーです。
        /// </item>
        /// <item>
        /// 外部設定ファイルマージ処理で基準とする要素の XPATH に 外部設定ファイルマージ処理でマージする要素の XPATH をマージ後に、XML スキーマ検証エラーです。
        /// </item>
        /// </list>
        /// </exception>
        public virtual void CreateExceptionTransitionElements()
        {
            // 外部設定ファイルの設定情報をマージする
            MergeConfiguration mgConfig = new MergeConfiguration(XML_NAMESPACE, XML_NAMESPACE_PREFIX, XML_SCHEMA_FILE_NAME);
            mgConfig.LoadConfig(SECTION_NAME, Files);
            XmlDocument xmlDoc = mgConfig.MergeXmlDocument(SECTION_XPATH, ELEMENT_XPATH);

            // 外部設定ファイルの設定情報をexceptionTransitionConfiguration要素に追加する
            AddExceptionTransitionElements(xmlDoc);
        }

        /// <summary>
        /// 外部設定ファイルの内容から exceptionTransition 要素を生成し、exceptionTransitionConfiguration 要素に追加します。
        /// </summary>
        /// <param name="xmlDoc">外部設定ファイルの内容を保持する <see cref="XmlDocument" /> 。</param>
        private void AddExceptionTransitionElements(XmlDocument xmlDoc)
        {
            XmlNodeList list = xmlDoc.DocumentElement.ChildNodes;

            foreach (XmlNode node in list)
            {
                if (node is XmlElement)
                {
                    string exceptionType = node.Attributes[EXCEPTION_TYPE_ATTRIBUTE_NAME].InnerText;
                    string nextPage = node.Attributes[NEXT_PAGE_ATTRIBUTE_NAME].InnerText;
                    ExceptionTransitionElement element = new ExceptionTransitionElement(exceptionType, nextPage);
                    ExceptionTransitionCollection.Add(element);
                }
            }
        }
    }
}
