// 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.Page
{
    /// <summary>
    /// 構成ファイル内の pageConfiguration セクションを表します。
    /// </summary>
    /// <remarks>
    /// <see cref="ConfigurationSection"/> クラスを拡張した、pageConfiguration カスタム構成ハンドラです。
    /// 詳細については、<see cref="ConfigurationSection"/> を参照してください。
    /// </remarks>
    public class PageConfigurationSection : ConfigurationSection
    {
        /// <summary>
        /// pageConfiguration の要素名です。
        /// </summary>
        /// <remarks>
        /// この定数の値は "pageConfiguration" です。
        /// </remarks>
        private const string PAGE_CONFIGURAION_SECTION_NAME = "pageConfiguration";

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

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

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

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

        /// <summary>
        /// 外部設定ファイルの page セクション要素取得用 XPATH です。
        /// </summary>
        /// <remarks>
        /// この定数の値は "page:pageConfiguration" です。
        /// </remarks>
        private const string PAGE_SECTION_XPATH = XML_NAMESPACE_PREFIX + ":pageConfiguration";

        /// <summary>
        /// 外部設定ファイルの page 要素取得用 XPATH です。
        /// </summary>
        /// <remarks>
        /// この定数の値は "page:pageConfiguration/page:page" です。
        /// </remarks>
        private const string PAGE_ELEMENT_XPATH = PAGE_SECTION_XPATH + "/" + XML_NAMESPACE_PREFIX + ":page";

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

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

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

        /// <summary>
        /// pages 要素を取得します。
        /// </summary>
        /// <remarks>
        /// pageConfiguration セクションから、 <see cref="PagesCollection"/> を取得します。
        /// </remarks>
        [ConfigurationProperty(PAGE_ELEMENT_NAME, IsDefaultCollection = false, IsRequired = false)]
        public PagesCollection Pages
        {
            get
            {
                PagesCollection pagesCollection = (PagesCollection)base[PAGE_ELEMENT_NAME];
                return pagesCollection;
            }
        }

        /// <summary>
        /// files 要素の設定内容から page 要素を生成して pages 要素に追加します。
        /// </summary>
        /// <remarks>
        /// <para><see cref="MergeConfiguration"/> オブジェクトを生成し、外部設定ファイルの設定情報をマージします。</para>
        /// <para>マージした外部設定ファイルの内容から <see cref="PageElement"/> オブジェクトを生成し、
        /// <see cref="PagesCollection"/> コレクションに追加します。</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 CreatePageElements()
        {
            // 外部設定ファイルの設定内容をマージする
            MergeConfiguration mgConfig = new MergeConfiguration(XML_NAMESPACE, XML_NAMESPACE_PREFIX, PAGE_SCHEMA_NAME);
            mgConfig.LoadConfig(PAGE_CONFIGURAION_SECTION_NAME, Files);
            XmlDocument xmlDoc = mgConfig.MergeXmlDocument(PAGE_SECTION_XPATH, PAGE_ELEMENT_XPATH);

            // 設定内容をPagesプロパティに保持する
            AddPageElements(xmlDoc);

        }

        /// <summary>
        /// 外部設定ファイルの内容から page 要素を生成し、pages 要素に追加します。
        /// </summary>
        /// <param name="xmlDoc">外部設定ファイルの内容を保持する <see cref="System.Xml.XmlDocument" /> 。</param>
        private void AddPageElements(XmlDocument xmlDoc)
        {
            // PAGE識別子属性名
            const string NAME_ATTRIBUTE_NAME = "name";
            const string NAME_ATTRIBUTE_PATH = "path";
            const string NAME_ATTRIBUTE_PDS = "preventDoubleSubmit";
            const string NAME_ATTRIBUTE_SETTOKEN = "setToken";
            const string NAME_ATTRIBUTE_CHECKTOKEN = "checkToken";
            const string NAME_ATTRIBUTE_UPDATETOKEN = "updateToken";

            XmlNamespaceManager xmlNM = new XmlNamespaceManager(xmlDoc.NameTable);
            xmlNM.AddNamespace(XML_NAMESPACE_PREFIX, XML_NAMESPACE);
            XmlNodeList xmlNL = xmlDoc.SelectNodes(PAGE_ELEMENT_XPATH, xmlNM);

            foreach (XmlNode xmlNode in xmlNL)
            {
                string name = xmlNode.Attributes[NAME_ATTRIBUTE_NAME].InnerText;
                string path = xmlNode.Attributes[NAME_ATTRIBUTE_PATH].InnerText;
                string pds = xmlNode.Attributes[NAME_ATTRIBUTE_PDS].InnerText;
                string setToken = xmlNode.Attributes[NAME_ATTRIBUTE_SETTOKEN].InnerText;
                string checkToken = xmlNode.Attributes[NAME_ATTRIBUTE_CHECKTOKEN].InnerText;
                string updateToken = xmlNode.Attributes[NAME_ATTRIBUTE_UPDATETOKEN].InnerText;

                PageElement pageElement = new PageElement(name, path, pds, setToken, checkToken, updateToken);
                Pages.Add(pageElement);
            }
        }

    }
}
