// 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="BinaryFileUploadCommunicator{TResult}"/> を使用してサーバと通信を行います。
    /// </remarks>
    /// <typeparam name="TResult">
    /// 受信XMLデータを <paramref name="TResult"/> 型の型付データセットに読み込みます。
    /// </typeparam>
    public class BinaryFileUploadBLogic<TResult> : CommunicateBLogicBase<string>
        where TResult : DataSet, new()
    {
        /// <summary>
        /// <see cref="ILog"/> 実装クラスのインスタンスです。
        /// </summary>
        /// <remarks>
        /// ログ出力に利用します。
        /// </remarks>
        private static ILog _log = LogFactory.GetLogger(typeof(BinaryFileUploadBLogic<TResult>));

        /// <summary>
        /// アップロードファイルパスを <see cref="DataSet"/> から取得する際にキーとして利用するテーブル名です。
        /// </summary>
        /// <remarks>この定数の値は "File" です。</remarks>
        protected static readonly string BINARY_FILE_TABLE_NAME = "File";

        /// <summary>
        /// アップロードファイルパスを <see cref="DataSet"/> から取得する際にキーとして利用するカラム名です。
        /// </summary>
        /// <remarks>この定数の値は "FilePath" です。</remarks>
        protected static readonly string BINARY_FILE_COLUMN_NAME = "FilePath";

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

        /// <summary>
        /// ファイルの送信、XMLデータの受信を行う <see cref="ICommunicator{DataSet}"/> を生成します。
        /// </summary>
        /// <remarks>
        /// 既定では <see cref="BinaryFileUploadCommunicator{TResult}"/> を生成します。
        /// </remarks>
        /// <returns>
        /// ファイルの送信、XMLデータの受信を行う <see cref="ICommunicator{DataSet}"/>。
        /// </returns>
        protected override ICommunicator<string> CreateCommunicator()
        {
            return new BinaryFileUploadCommunicator<TResult>();
        }

        /// <summary>
        /// ファイル送信、XMLデータの受信を実行します。
        /// </summary>
        /// <remarks>
        /// <para>
        /// 入力データの <paramref name="communicateBLogicParam"/> に格納されたデータセットの <see cref="BINARY_FILE_TABLE_NAME"/> 
        /// テーブルの <see cref="BINARY_FILE_COLUMN_NAME"/> カラムの 1 行目からアップロードするファイルのパスを取得します。
        /// <see cref="ICommunicator{String}"/> の <see cref="ICommunicator{String}.Communicate"/> にファイルパスを
        /// 渡してアップロードを実行します。
        /// 受信データは <paramref name="TResult"/> 型の型付データセットに読み込みます。
        /// </para>
        /// <para>
        /// 通信クラスとして、既定では <see cref="BinaryFileUploadCommunicator{TResult}"/> を利用します。
        /// </para>
        /// </remarks>
        /// <param name="communicateBLogicParam">
        /// 送信するファイルのパスを設定した <see cref="BLogicParam"/>。
        /// </param>
        /// <param name="requestHeaders">
        /// リクエストのヘッダを構成する名前と値のペアを格納している <see cref="IDictionary{String, String}"/>。
        /// </param>
        /// <returns>
        /// 通信結果を格納した <see cref="CommunicationResult"/>。
        /// </returns>
        /// <exception cref="ArgumentNullException">
        /// <paramref name="paramData"/> が null 参照です。
        /// </exception>
        /// <exception cref="ArgumentException">
        /// 以下のような場合に例外をスローします。
        /// <list type="bullet">
        /// <item>
        /// <paramref name="communicateBLogicParam"/> に <see cref="BINARY_FILE_TABLE_NAME"/> テーブルがありません。
        /// </item>
        /// <item>
        /// <paramref name="communicateBLogicParam"/> の <see cref="BINARY_FILE_TABLE_NAME"/> テーブルに <see cref="BINARY_FILE_COLUMN_NAME"/> カラムがありません。
        /// </item>
        /// <item>
        /// <paramref name="communicateBLogicParam"/> に <see cref="BINARY_FILE_TABLE_NAME"/> テーブルにレコードがありません。
        /// </item>
        /// <item>
        /// 通信処理で必要なデータが不正です。
        /// </item>
        /// </list>
        /// </exception>
        /// <exception cref="ServerException">
        /// サーバアプリケーションで想定しない例外が発生しました。
        /// </exception>
        /// <exception cref="CommunicationException">
        /// データの送受信中にエラーが発生しました。
        /// </exception>
        protected override CommunicationResult Communicate(BLogicParam communicateBLogicParam, 
                                                           IDictionary<string, string> requestHeaders)
        {
            DataTable fileTable = communicateBLogicParam.ParamData.Tables[BINARY_FILE_TABLE_NAME];

            if (fileTable == null)
            {
                throw new ArgumentException(string.Format(
                    Properties.Resources.E_BLOGIC_TABLE_NOT_FOUND, 
                    communicateBLogicParam.ParamData.GetType().FullName));
            }

            if (fileTable.Rows.Count == 0)
            {
                throw new ArgumentException(string.Format(
                    Properties.Resources.E_BLOGIC_RECORD_NOT_FOUND, 
                    communicateBLogicParam.ParamData.GetType().FullName));
            }

            if (!fileTable.Columns.Contains(BINARY_FILE_COLUMN_NAME))
            {
                throw new ArgumentException(string.Format(
                    Properties.Resources.E_BLOGIC_COLUMN_NOT_FOUND, 
                    communicateBLogicParam.ParamData.GetType().FullName));
            }

            // アップロードファイルパスの取得
            string filePath = fileTable.Rows[0][BINARY_FILE_COLUMN_NAME] as string;
            if (string.IsNullOrEmpty(filePath))
            {
                string message = string.Format(Properties.Resources.E_BLOGIC_INVALID_DTOTABLE,
                                               BINARY_FILE_TABLE_NAME, BINARY_FILE_COLUMN_NAME);
                throw new ArgumentException(message);
            }

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

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

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

            return result;
        }
    }
}
