// 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.Generic;
using System.Data;
using TERASOLUNA.Fw.Client.Communication;
using TERASOLUNA.Fw.Common.BLogic;
using TERASOLUNA.Fw.Common.Logging;

namespace TERASOLUNA.Fw.Client.BLogic
{
    /// <summary>
    /// マルチパートデータの送信、XMLの受信を行うビジネスロジッククラスです。
    /// </summary>
    /// <remarks>
    /// <see cref="MultipartUploadCommunicator{TResult}"/> を使用してサーバと通信を行います。
    /// </remarks>
    /// <typeparam name="TResult">
    /// 受信XMLデータを <paramref name="TResult"/> 型の型付データセットに読み込みます。
    /// </typeparam>
    public class MultipartUploadBLogic<TResult> : CommunicateBLogicBase<IList<MultipartElement>>
        where TResult : DataSet , new()
    {
        /// <summary>
        /// <see cref="ILog"/> 実装クラスのインスタンスです。
        /// </summary>
        /// <remarks>
        /// ログ出力に利用します。
        /// </remarks>
        private ILog _log = LogFactory.GetLogger(typeof(MultipartUploadBLogic<TResult>));

        /// <summary>
        /// マルチパート送信を行うテキスト情報を保持している <see cref="DataSet"/> のテーブル名です。
        /// </summary>
        /// <remarks>この定数の値は "Text" です。</remarks>
        public static readonly string TEXT_TABLE_NAME = "Text";

        /// <summary>
        /// マルチパート送信を行うファイル情報を保持している <see cref="DataSet"/> のテーブル名です。
        /// </summary>
        /// <remarks>この定数の値は "File" です。</remarks>
        public static readonly string FILE_TABLE_NAME = "File";

        /// <summary>
        /// マルチパート送信を行うエレメント要素名を保持している <see cref="DataTable"/> のカラム名です。
        /// </summary>
        /// <remarks>この定数の値は "Name" です。</remarks>
        public static readonly string ELEMENT_NAME = "Name";

        /// <summary>
        /// マルチパート送信を行うファイルパスを保持している <see cref="DataTable"/> のカラム名です。
        /// </summary>
        /// <remarks>この定数の値は "FilePath" です。</remarks>
        public static readonly string FILE_PATH = "FilePath";

        /// <summary>
        /// マルチパート送信を行うテキストの値を保持している <see cref="DataTable"/> のカラム名です。
        /// </summary>
        /// <remarks>この定数の値は "Value" です。</remarks>
        public static readonly string TEXT_VALUE = "Value";

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

        /// <summary>
        /// マルチパートデータの送信、XMLデータの受信を行う <see cref="ICommunicator{IList}"/> を生成します。
        /// </summary>
        /// <remarks>
        /// 既定では <see cref="MultipartUploadCommunicator{TResult}"/> を生成します。
        /// </remarks>
        /// <returns>
        /// マルチパートデータの送信、XMLデータの受信を行う <see cref="ICommunicator{IList}"/>。
        /// </returns>
        protected override ICommunicator<IList<MultipartElement>> CreateCommunicator()
        {
            return new MultipartUploadCommunicator<TResult>();
        }

        /// <summary>
        /// マルチパート通信を実行します。
        /// </summary>
        /// <remarks>
        /// <para>
        /// <paramref name="communicateBlogicParam"/> に格納されたデータセットから、
        /// マルチパート情報(マルチパートの要素名、ファイルパス名、テキスト値)を取得します。
        /// 設定したマルチパート情報から <see cref="MultipartElement"/> を作成し、
        /// マルチパート送信します。受信処理はXML通信で行います。
        /// </para>
        /// <para>
        /// 以下の表に、<paramref name="communicateBlogicParam"/> に格納されたデータセットに
        /// 用意しておくべきテーブルとカラムを示します。
        /// </para>
        /// <table border="4" align="center">
        /// <caption>【<paramref name="paramData"/> に必要なテーブルとカラム】</caption>
        /// <tr bgcolor="#cccccc">
        /// <th>テーブル名</th>
        /// <th>カラム名</th>
        /// <th>詳細</th>
        /// </tr>
        /// <tr align="center">
        /// <td rowspan="2">Text</td>
        /// <td>Name</td>
        /// <td>テキスト値の要素名</td>
        /// </tr>
        /// <tr align="center">
        /// <td>Value</td>
        /// <td>テキスト値</td>
        /// </tr>
        /// <tr align="center">
        /// <td rowspan="2">File</td>
        /// <td>Name</td>
        /// <td>ファイルの要素名</td>
        /// </tr>
        /// <tr align="center">
        /// <td>FilePath</td>
        /// <td>ファイルのファイルパス</td>
        /// </tr>
        /// </table>
        /// </remarks>
        /// <param name="communicateBlogicParam">送信するデータを格納した <see cref="BLogicParam"/>。</param>
        /// <param name="requestHeaders">
        /// リクエストのヘッダを構成する名前と値のペアを格納している <see cref="IDictionary{String, String}"/>。
        /// </param>
        /// <returns>
        /// 通信結果を格納した <see cref="CommunicationResult"/>。
        /// </returns>
        /// <exception cref="ArgumentException">
        /// 通信処理で必要なデータが不正です。
        /// </exception>
        /// <exception cref="ServerException">
        /// サーバアプリケーションで想定しない例外が発生しました。
        /// </exception>
        /// <exception cref="CommunicationException">
        /// データの送受信中にエラーが発生しました。
        /// </exception>
        protected override CommunicationResult Communicate(BLogicParam communicateBlogicParam,
                                                           IDictionary<string, string> requestHeaders)
        {
            IList<MultipartElement> multipartElementList = CreateMultipartElementList(communicateBlogicParam.ParamData);

            if (_log.IsDebugEnabled)
            {
                _log.Debug(string.Format(
                    Properties.Resources.D_BEGIN_COMMUNICATOR_FUNCTION, Communicator.GetType().FullName));
            }

            CommunicationResult result = Communicator.Communicate(multipartElementList, requestHeaders);

            if (_log.IsDebugEnabled)
            {
                _log.Debug(string.Format(
                    Properties.Resources.D_END_COMMUNICATOR_FUNCTION, Communicator.GetType().FullName));
            }

            return result;
        }

        /// <summary>
        /// <paramref name="paramData"/> からマルチパートデータを取得し、
        /// <see cref="MultipartElement"/> の <see cref="IList{MultipartElement}"/> を作成します。
        /// </summary>
        /// <param name="paramData">
        /// 送信するデータを格納した <see cref="DataSet"/>。
        /// </param>
        /// <returns>
        /// <see cref="MultipartElement"/> を格納した <see cref="IList{MultipartElement}"/>。
        /// </returns>
        /// <exception cref="ArgumentException">
        /// <list type="bullet">
        /// <item>
        /// テーブルに必要なカラムが存在しません。
        /// </item>
        /// <item>
        /// テーブルが不正です。カラムに値が設定されていません。
        /// </item>
        /// </list>
        /// </exception>
        protected virtual IList<MultipartElement> CreateMultipartElementList(DataSet paramData)
        {
            IList<MultipartElement> multipartElementList = new List<MultipartElement>();

            // テキストマルチパートデータの生成
            if (paramData.Tables.Contains(TEXT_TABLE_NAME))
            {
                DataTable valueTable = paramData.Tables[TEXT_TABLE_NAME];

                if (!valueTable.Columns.Contains(ELEMENT_NAME))
                {
                    string message = string.Format(Properties.Resources.E_COLUMN_NOT_FOUND, TEXT_TABLE_NAME, ELEMENT_NAME);
                    throw new ArgumentException(message);
                }

                if (!valueTable.Columns.Contains(TEXT_VALUE))
                {
                    string message = string.Format(Properties.Resources.E_COLUMN_NOT_FOUND, TEXT_TABLE_NAME, TEXT_VALUE);
                    throw new ArgumentException(message);
                }

                if (0 < valueTable.Rows.Count)
                {
                    foreach (DataRow row in valueTable.Rows)
                    {
                        string elementName = row[ELEMENT_NAME] as string;
                        if (string.IsNullOrEmpty(elementName))
                        {
                            string message = string.Format(Properties.Resources.E_BLOGIC_INVALID_DTOTABLE, TEXT_TABLE_NAME, ELEMENT_NAME);
                            throw new ArgumentException(message);
                        }

                        string textValue = row[TEXT_VALUE] as string;
                        if (textValue == null)
                        {
                            string message = string.Format(Properties.Resources.E_BLOGIC_INVALID_DTOTABLE, TEXT_TABLE_NAME, TEXT_VALUE);
                            throw new ArgumentException(message);
                        }

                        MultipartValueElement element
                           = new MultipartValueElement(elementName);
                        element.Value = textValue;
                        multipartElementList.Add(element);
                    }
                }
            }

            // ファイルマルチパートデータの生成
            if (paramData.Tables.Contains(FILE_TABLE_NAME))
            {
                DataTable fileTable = paramData.Tables[FILE_TABLE_NAME];

                if (!fileTable.Columns.Contains(ELEMENT_NAME))
                {
                    string message = string.Format(Properties.Resources.E_COLUMN_NOT_FOUND, FILE_TABLE_NAME, ELEMENT_NAME);
                    throw new ArgumentException(message);
                }

                if (!fileTable.Columns.Contains(FILE_PATH))
                {
                    string message = string.Format(Properties.Resources.E_COLUMN_NOT_FOUND, FILE_TABLE_NAME, FILE_PATH);
                    throw new ArgumentException(message);
                }

                if (0 < fileTable.Rows.Count)
                {
                    foreach (DataRow row in paramData.Tables[FILE_TABLE_NAME].Rows)
                    {
                        string elementName = row[ELEMENT_NAME] as string;
                        if (string.IsNullOrEmpty(elementName))
                        {
                            string message = string.Format(Properties.Resources.E_BLOGIC_INVALID_DTOTABLE, FILE_TABLE_NAME, ELEMENT_NAME);
                            throw new ArgumentException(message);
                        }

                        string filePath = row[FILE_PATH] as string;
                        if (string.IsNullOrEmpty(filePath))
                        {
                            string message = string.Format(Properties.Resources.E_BLOGIC_INVALID_DTOTABLE, FILE_TABLE_NAME, FILE_PATH);
                            throw new ArgumentException(message);
                        }

                        MultipartFileElement element
                            = new MultipartFileElement(elementName);
                        element.UploadFilePath = filePath;
                        multipartElementList.Add(element);
                    }
                }
            }

            return multipartElementList;
        }
    }
}
