// 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.Collections;
using System.Collections.Generic;
using System.Configuration;
using System.Globalization;
using System.Resources;
using TERASOLUNA.Fw.Common.Logging;

namespace TERASOLUNA.Fw.Common
{
    /// <summary>
    /// 他アセンブリに格納した複数のメッセージリソースを利用するためのユーティリティクラスです。
    /// </summary>
    public class MessageManager
    {
        /// <summary>
        /// アプリケーション構成ファイルからリソースの型を取得する際のキーのプレフィックスです。
        /// </summary>
        /// <remarks>
        /// この定数の値は "MessageResources." です。
        /// </remarks>
        protected static readonly string RESOURCE_NAME_PREFIX = "MessageResource.";

        /// <summary>
        /// アプリケーション構成ファイルから <see cref="MessageManager"/> クラスの型を取得する際のキー名です。
        /// </summary>
        /// <remarks>
        /// この定数の値は "MessageManagerTypeName" です。
        /// </remarks>
        protected static readonly string MESSAGE_MANAGER_TYPE_NAME = "MessageManagerTypeName";

        /// <summary>
        /// <see cref="ILog"/> 実装クラスのインスタンスです。
        /// </summary>
        /// <remarks>
        /// ログ出力に利用します。
        /// </remarks>
        private static ILog _log = LogFactory.GetLogger(typeof(MessageManager));

        /// <summary>
        /// ロック用のオブジェクトです。
        /// </summary>
        /// <remarks>
        /// 本クラスのロックオブジェクト。
        /// </remarks>
        private static object _syncRoot = new Object();

        /// <summary>
        /// <see cref="MessageManager"/> のインスタンスのキャッシュです。
        /// </summary>
        /// <remarks>
        /// デフォルトの値は、 null です。
        /// </remarks>
        private static volatile MessageManager _instance = null;

        /// <summary>
        /// メッセージに適用するカルチャです。
        /// </summary>
        /// <remarks>
        /// デフォルトの値は、 <seealso cref="CultureInfo.CurrentCulture"/> です。
        /// </remarks>
        private CultureInfo _resourceCulture = CultureInfo.CurrentCulture;

        /// <summary>
        /// <see cref="ResourceManager"/> のリストです。
        /// </summary>
        private IList<ResourceManager> _resourceManagerList = new List<ResourceManager>();

        /// <summary>
        /// メッセージ取得時に利用するカルチャ情報を取得または設定します。
        /// </summary>
        /// <value>
        /// カルチャ情報。
        /// </value>
        /// <remarks>
        /// デフォルトの値は、 <seealso cref="CultureInfo.CurrentCulture"/> です。
        /// </remarks>
        public static CultureInfo Culture
        {
            get
            {
                return Instance.ResourceCulture;
            }
            set
            {
                Instance.ResourceCulture = value;
            }
        }

        /// <summary>
        /// 内部で保持する <see cref="MessageManager"/> クラスのインスタンスのキャッシュを取得します。
        /// </summary>
        /// <remarks>
        /// <para>
        /// このプロパティに初めてアクセスするとき、 <see cref="MessageManager"/> はアプリケーション
        /// 構成ファイルから <seealso cref="MESSAGE_MANAGER_TYPE_NAME"/> をキーとしたエントリを探し、存在した場合、
        /// 取得した値を型名として <see cref="MessageManager"/> またはそのサブクラスのインスタンスの
        /// 生成を試みます。成功した場合、そのインスタンスをキャッシュし、返します。アプリケーション
        /// 構成ファイルに該当するエントリがない場合、<see cref="MessageManager"/> クラスのインスタンス
        /// を生成し、キャッシュして返します。この動作はスレッドセーフです。</para>
        /// </remarks>
        /// <exception cref="InvalidOperationException">
        /// アプリケーション構成ファイルに <seealso cref="RESOURCE_NAME_PREFIX"/> をプレフィックスとした
        /// キーを持つエントリが存在しません。
        /// </exception>
        /// <exception cref="TerasolunaException">
        /// 以下のような場合に例外をスローします。
        /// <list type="bullet">
        /// <item>
        /// <seealso cref="RESOURCE_NAME_PREFIX"/> をプレフィックスとしたキーとする構成ファイルの appSettings 要素の value 属性値は空文字です。
        /// </item>
        /// <item>
        /// <seealso cref="RESOURCE_NAME_PREFIX"/> をプレフィックスとしたキーとする構成ファイルの appSettings 要素の value 属性値の型を取得できません。
        /// </item>
        /// <item>
        /// <see cref="MessageManager"/> 派生クラスのインスタンスを生成できません。
        /// </item>
        /// </list>
        /// </exception>
        /// <exception cref="ConfigurationErrorsException">
        /// アプリケーション設定データを格納した NameValueCollection オブジェクトを取得できません。
        /// </exception>
        protected static MessageManager Instance
        {
            get
            {
                if (_instance == null)
                {
                    lock (_syncRoot)
                    {
                        if (_instance == null)
                        {
                            _instance = ClassUtil.CreateInstanceFromAppSettings<MessageManager>(MESSAGE_MANAGER_TYPE_NAME, typeof(MessageManager));
                            _instance.Init();
                        }
                    }
                }
                return _instance;
            }
        }


        /// <summary>
        /// インスタンスが保持するリソースマネージャのリストを取得します。
        /// </summary>
        protected IList<ResourceManager> ResourceManagerList
        {
            get
            {
                return _resourceManagerList;
            }
        }

        /// <summary>
        /// メッセージ取得時に利用するカルチャ情報を取得または設定します。
        /// </summary>
        protected CultureInfo ResourceCulture
        {
            get
            {
                return _resourceCulture;
            }

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

        /// <summary>
        /// 指定したメッセージ ID を利用してリソースから文字列を取得します。
        /// </summary>
        /// <remarks>
        /// <para>
        /// 内部で保持したリソース型のコレクションから、指定したキーに合致するメッセージ
        /// 文字列を取得します。利用するカルチャは <seealso cref="MessageManager.ResourceCulture"/>
        /// で指定します。
        /// </para>
        /// <para>
        /// 取得したメッセージ文字列に書式文字列が指定されている場合、
        /// 引数 <paramref name="args"/> に置換文字列を与えることでフォーマットを行う
        /// ことができます。このとき、取得したメッセージ文字列に指定された書式文字列と
        /// 置換文字列の数が合致しない場合、例外がスローされます。
        /// </para>
        /// </remarks>
        /// <param name="messageId">リソースからメッセージを取得する際に利用する ID 。</param>
        /// <param name="args">プレースホルダに適用する可変長引数。</param>
        /// <returns>リソースから取得されたメッセージ文字列。</returns>
        /// <exception cref="ArgumentNullException">
        /// 以下のような場合に例外をスローします。
        /// <list type="bullet">
        /// <item>
        /// <paramref name="messageId"/> が null 参照です。
        /// </item>
        /// <item>
        /// <paramref name="args"/> が null 参照です。
        /// </item>
        /// </list>
        /// </exception>
        /// <exception cref="ArgumentException">
        /// <paramref name="messageId"/> が空文字列です。
        /// </exception>
        /// <exception cref="InvalidOperationException">
        /// アプリケーション構成ファイルに <seealso cref="RESOURCE_NAME_PREFIX"/> をプレフィックスとした
        /// キーを持つエントリが存在しません。
        /// </exception>
        /// <exception cref="TerasolunaException">
        /// 以下のような場合に例外をスローします。
        /// <list type="bullet">
        /// <item>
        /// <seealso cref="RESOURCE_NAME_PREFIX"/> をプレフィックスとしたキーとする構成ファイルの appSettings 要素の value 属性値は空文字です。
        /// </item>
        /// <item>
        /// <seealso cref="RESOURCE_NAME_PREFIX"/> をプレフィックスとしたキーとする構成ファイルの appSettings 要素の value 属性値の型を取得できません。
        /// </item>
        /// <item>
        /// <see cref="MessageManager"/> 派生クラスのインスタンスを生成できません。
        /// </item>
        /// <item>
        /// 構成ファイルの <seealso cref="RESOURCE_NAME_PREFIX"/> をキーとして取得するvalue値から生成できるリソース型で、
        /// 使用できるリソースのセットを見つけることができません。
        /// </item>
        /// <item>
        /// 構成ファイルの <seealso cref="RESOURCE_NAME_PREFIX"/> をキーとして取得するvalue値から生成できるリソース型に、
        /// 文字列以外のリソースが保存されています。
        /// </item>
        /// </list>
        /// </exception>
        /// <exception cref="ConfigurationErrorsException">
        /// 構成ファイルが不正です。
        /// </exception>
        /// <exception cref="FormatException">
        /// format が無効です。または書式設定する引数を示す数が 0 より小さいか、
        /// 書式設定する指定されたオブジェクトの数以上です。 
        /// </exception>
        public static string GetMessage(string messageId, params object[] args)
        {
            if (messageId == null)
            {
                ArgumentNullException exception = new ArgumentNullException("messageId");
                if (_log.IsErrorEnabled)
                {
                    _log.Error(string.Format(Properties.Resources.E_NULL_ARGUMENT, "messageId"), exception);
                }
                throw exception;
            }

            if (messageId.Length == 0)
            {
                string message = string.Format(Properties.Resources.E_EMPTY_STRING, "messageId");
                ArgumentException exception = new ArgumentException(message);
                if (_log.IsErrorEnabled)
                {
                    _log.Error(message, exception);
                }
                throw exception;
            }

            if (args == null)
            {
                ArgumentNullException exception = new ArgumentNullException("args");
                if (_log.IsErrorEnabled)
                {
                    _log.Error(string.Format(Properties.Resources.E_NULL_ARGUMENT, "args"), exception);
                }
                throw exception;
            }

            return Instance.GetString(messageId, args);
        }

        /// <summary>
        /// <see cref="MessageManager"/> インスタンスを初期化します。
        /// </summary>
        /// <remarks>
        /// <para>アプリケーション構成ファイルから、<seealso cref="RESOURCE_NAME_PREFIX"/> をプレフィックスとした
        ///  AppSettings エントリを取得し、<see cref="ResourceManager"/>のリストを初期化します。</para>
        /// <para><seealso cref="RESOURCE_NAME_PREFIX"/> をプレフィックスとしたエントリには、メッセージを格納した
        /// リソースの型をアセンブリ修飾名で記述する必要が有ります。</para>
        /// <para>リストはキー名でソートされます。リストの並びは、メッセージの検索に影響します。</para>
        /// </remarks>
        /// <exception cref="InvalidOperationException">
        /// アプリケーション構成ファイルに <seealso cref="RESOURCE_NAME_PREFIX"/> をプレフィックスとした
        /// キーを持つエントリが存在しません。
        /// </exception>
        /// <exception cref="TerasolunaException">
        /// 以下のような場合に例外をスローします。
        /// <list type="bullet">
        /// <item>
        /// <seealso cref="RESOURCE_NAME_PREFIX"/> をプレフィックスとしたキーとする構成ファイルの appSettings 要素の value 属性
        /// 値は空文字です。
        /// </item>
        /// <item>
        /// <seealso cref="RESOURCE_NAME_PREFIX"/> をプレフィックスとしたキーとする構成ファイルの appSettings 要素の value 属性
        /// 値の型を取得できません。
        /// </item>
        /// </list>
        /// </exception>
        /// <exception cref="ConfigurationErrorsException">
        /// 構成ファイルが不正です。
        /// </exception>
        protected virtual void Init()
        {
            // アプリケーション構成ファイルから、
            // アセンブリ名、型名を取得する
            string[] allKeys = ConfigurationManager.AppSettings.AllKeys;

            List<string> keys = new List<string>();
            foreach (string key in allKeys)
            {
                if (key != null && key.StartsWith(RESOURCE_NAME_PREFIX))
                {
                    keys.Add(key);
                }
            }

            if (keys.Count == 0)
            {
                InvalidOperationException exception = new InvalidOperationException(Properties.Resources.E_MESSAGE_RESOURCE_NOT_DEFINED);
                if (_log.IsErrorEnabled)
                {
                    _log.Error(exception.Message, exception);
                }
                throw exception;
            }

            keys.Sort(); // 昇順でソート

            for (int i = 0; i < keys.Count; i++)
            {
                string typeName = ConfigurationManager.AppSettings[keys[i]];
                if (string.IsNullOrEmpty(typeName))
                {
                    string message = string.Format(Properties.Resources.E_EMPTY_TYPE_NAME, keys[i]);
                    TerasolunaException exception = new TerasolunaException(message);
                    if (_log.IsErrorEnabled)
                    {
                        _log.Error(message, exception);
                    }
                    throw exception;
                }
                Type t = ClassUtil.GetType(typeName);
                ICollection collection = (ICollection)_resourceManagerList;
                lock (collection.SyncRoot)
                {
                    _resourceManagerList.Add(new ResourceManager(t));
                }
                if (_log.IsDebugEnabled)
                {
                    _log.Debug(string.Format(Properties.Resources.D_LOAD_RESOURCE_TYPE, t.FullName));
                }
            }
        }

        /// <summary>
        /// 指定したメッセージ ID を利用してリソースから文字列を取得します。
        /// </summary>
        /// <param name="messageId">リソースからメッセージを取得する際に利用する ID 。</param>
        /// <param name="args">プレースホルダに適用する可変長引数。</param>
        /// <returns>リソースから取得されたメッセージ文字列。</returns>
        /// <exception cref="ArgumentNullException">
        /// 以下のような場合に例外をスローします。
        /// <list type="bullet">
        /// <item>
        /// <paramref name="messageId"/> が null 参照です。
        /// </item>
        /// <item>
        /// <paramref name="args"/> が null 参照です。
        /// </item>
        /// </list>
        /// </exception>
        /// <exception cref="TerasolunaException">
        /// 以下のような場合に例外をスローします。
        /// <list type="bullet">
        /// <item>
        /// 構成ファイルの <seealso cref="RESOURCE_NAME_PREFIX"/> をキーとして取得するvalue値から生成できるリソース型で、
        /// 使用できるリソースのセットを見つけることができません。
        /// </item>
        /// <item>
        /// 構成ファイルの <seealso cref="RESOURCE_NAME_PREFIX"/> をキーとして取得するvalue値から生成できるリソース型に、
        /// 文字列以外のリソースが保存されています。
        /// </item>
        /// </list>
        /// </exception>
        /// <exception cref="FormatException">
        /// format が無効です。または書式設定する引数を示す数が 0 より小さいか、
        /// 書式設定する指定されたオブジェクトの数以上です。 
        /// </exception>
        protected virtual string GetString(string messageId, params object[] args)
        {
            CultureInfo culInfo = ResourceCulture; // ループ中で変わらないようにキャッシュ
            string result = null;

            foreach (ResourceManager man in ResourceManagerList)
            {
                try
                {
                    result = man.GetString(messageId, culInfo);
                }
                catch (InvalidOperationException ex)
                {
                    string message = string.Format(Properties.Resources.E_MESSAGE_NOT_STRING, messageId, culInfo);
                    TerasolunaException exception = new TerasolunaException(message, ex);
                    if (_log.IsErrorEnabled)
                    {
                        _log.Error(message, exception);
                    }
                    throw exception;
                }
                catch (MissingManifestResourceException ex)
                {
                    string message = string.Format(Properties.Resources.E_MESSAGE_RESOURCE_NOT_FOUND, man.BaseName);
                    TerasolunaException exception = new TerasolunaException(message, ex);
                    if (_log.IsErrorEnabled)
                    {
                        _log.Error(message, exception);
                    }
                    throw exception;
                }
                if (result != null)
                {
                    break;
                }
            }

            if (!string.IsNullOrEmpty(result) && args.Length != 0)
            {
                result = string.Format(culInfo, result, args);
            }

            return result;
        }
    }
}
