/*
 * Copyright (c) 2009 The openGion Project.
 *
 * 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.
 */
package org.opengion.fukurou.util;

import java.io.File;
import java.util.concurrent.ConcurrentMap;                                                      // 6.4.3.3 (2016/03/04)
import java.util.concurrent.ConcurrentHashMap;                          // 6.4.3.1 (2016/02/12) refactoring
import java.util.Locale ;
import java.util.Set;

import org.opengion.fukurou.system.ThrowUtil;                           // 6.4.2.0 (2016/01/29) package変更 fukurou.util → fukurou.system

/**
 * FileMap は、ファイルを読み取って、キー情報から、ファイルへのリンクを作成するための
 * 情報を返します。
 * ファイルそのものは、指定のディレクトリをすべて読み取り、拡張子以外の部分を、キーとして
 * 登録します。(キーは大文字に統一されます。)
 * 実際のファイルの拡張子は、リンク作成時の処理で付与されます。
 * 例えば、HELPファイルを、XXXX.html や、XXXX.htm、XXXX.pdf など、色々な形態で作成した
 * 場合でも、キーとしては、XXXX で存在チェックをかけることができるようになります。
 *
 * ファイルは、一旦すべて読み取ってメモリ上で管理されます。
 * ディレクトリの再読取が必要な場合は、オブジェクトを再作成する必要があります。
 *
 * @version  4.0
 * @author   Kazuhiko Hasegawa
 * @since    JDK5.0,
 */
public final class FileMap implements Cleanable {
        /** 6.4.3.1 (2016/02/12) PMD refactoring. HashMap → ConcurrentHashMap に置き換え。 */
        private final ConcurrentMap<String,String> fMap = new ConcurrentHashMap<>();                            // 6.4.3.1 (2016/02/12) 変数名も変えておきます。

        /**
         * デフォルトコンストラクター
         *
         * @og.rev 6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.
         */
        public FileMap() { super(); }           // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。

//      /**
//       * 読み取るディレクトリを指定して、ファイルマップを構築します。
//       *
//       * このディレクトリは、OSに対する物理アドレスになります。
//       *
//       * @og.rev 5.5.4.2 (2012/07/13) makeFileMap() を直接コンストラクターとして使用
//       * @og.rev 6.3.8.4 (2015/10/09) 別のコンストラクターを呼ぶようにします。
//       * @og.rev 6.3.8.5 (2015/10/16) コンストラクターで、Exception を throw しないようにします。
//       * @og.rev 6.3.9.0 (2015/11/06) コンストラクターを止めて、初期化メソッドに変更する。
//       * @og.rev 7.3.2.0 (2021/03/19) 廃止
//       *
//       * @param  dir ディレクトリ
//       */
//      public void init( final String dir ) {
//              init( dir , null , null );
//      }

        /**
         * 読み取るディレクトリを指定して、ファイルマップを構築します。
         *
         * このディレクトリは、OSに対する物理アドレスになります。
         *
         * @og.rev 5.5.4.2 (2012/07/13) makeFileMap() を直接コンストラクターとして使用
         * @og.rev 6.3.8.4 (2015/10/09) 別のコンストラクターを呼ぶようにします。
         * @og.rev 6.3.8.5 (2015/10/16) コンストラクターで、Exception を throw しないようにします。
         * @og.rev 6.3.9.0 (2015/11/06) コンストラクターを止めて、初期化メソッドに変更する。
         *
         * @param  dir ディレクトリ
         * @param  path ファイル名に付与するパス文字列
         */
        public void init( final String dir , final String path ) {
                init( dir , path , null );
        }

//      /**
//       * すでに読み取った Set オブジェクトを指定して、ファイルマップを構築します。
//       *
//       * これは、ServletContext を利用した、META-INF/resources からの読み取り対応になります。
//       * 一覧を取得するのは、ServletContext 関連の実装が必要になるため、fukurou では
//       * java の一般的なオブジェクトである Set を処理するだけとします。
//       *
//       * ファイル名は、dir を削除した残りで構築します。フォルダ階層を含みます。
//       * Mapのキーは、フォルダ階層を含まない、ファイル名のみとします。
//       * つまり、フォルダ階層を持ってリソースを用意しておいても、キーとしては、
//       * ファイル名のみを使用します。
//       *
//       * @og.rev 5.5.4.2 (2012/07/13) 新規作成
//       * @og.rev 6.3.8.4 (2015/10/09) 別のコンストラクターを呼ぶようにします。
//       * @og.rev 6.3.8.5 (2015/10/16) コンストラクターで、Exception を throw しないようにします。
//       * @og.rev 6.3.9.0 (2015/11/06) コンストラクターを止めて、初期化メソッドに変更する。
//       * @og.rev 7.3.2.0 (2021/03/19) 廃止
//       *
//       * @param  dir ディレクトリ
//       * @param  resourcePaths リソースパス
//       */
//      public void init( final String dir , final Set<?> resourcePaths ) {
//              init( dir , null , resourcePaths );
//      }

        /**
         * すでに読み取った Set オブジェクトを指定して、ファイルマップを構築します。
         *
         * これは、ServletContext を利用した、META-INF/resources からの読み取り対応になります。
         * 一覧を取得するのは、ServletContext 関連の実装が必要になるため、fukurou では
         * java の一般的なオブジェクトである Set を処理するだけとします。
         *
         * ファイル名は、dir を削除した残りで構築します。フォルダ階層を含みます。
         * Mapのキーは、フォルダ階層を含まない、ファイル名のみとします。
         * つまり、フォルダ階層を持ってリソースを用意しておいても、キーとしては、
         * ファイル名のみを使用します。
         *
         * @og.rev 5.5.4.2 (2012/07/13) 新規作成
         * @og.rev 6.3.8.4 (2015/10/09) 別のコンストラクターを呼ぶようにします。
         * @og.rev 6.3.8.5 (2015/10/16) コンストラクターで、Exception を throw しないようにします。
         * @og.rev 6.3.9.0 (2015/11/06) null になっている可能性があるメソッドの戻り値のnullチェックを追加。
         * @og.rev 6.3.9.0 (2015/11/06) コンストラクターを止めて、初期化メソッドに変更する。
         * @og.rev 6.4.2.0 (2016/01/29) StringUtil にあったメソッドを移動するとともに、メソッド名を、ogThrowMsgPrint → ogThrowMsgPrint に変更。
         * @og.rev 6.4.3.2 (2016/02/19) 指定のフォルダが存在しない場合、作成します。
         * @og.rev 7.3.2.0 (2021/03/19) dir と path の nullﾁｪｯｸ(エラーでも止めない)
         * @og.rev 8.5.5.1 (2024/02/29) dir のみ nullﾁｪｯｸ(エラーで止める)
         *
         * @param  dir ディレクトリ
         * @param  path ファイル名に付与するパス文字列
         * @param  resourcePaths リソースパス
         */
//      public void init( final String dir , final String path , final Set<?> resourcePaths ) {
        public void init( final String dir , final String path , final Set<String> resourcePaths ) {
                // 7.3.2.0 (2021/03/19) dir と path の nullﾁｪｯｸ(エラーでも止めない)
//              if( dir == null || path == null ) {
//                      final String errMsg1 = "指定のディレクトリかパスが、nullです。dir=[" + dir + "] , path=[" + path + "]" ;
                if( dir == null ) {
                        final String errMsg1 = "指定のディレクトリが、nullです。path=[" + path + "]" ;
                        System.err.println( ThrowUtil.ogThrowMsg( errMsg1 ) );
                        return ;                        // 8.5.5.1 (2024/02/29) spotbugs NP_GUARANTEED_DEREF
                }

                if( resourcePaths == null ) {
                        final File directory = new File( dir );
                        if( ! directory.exists() ) {
                                final String errMsg = "指定のディレクトリは、存在しません。dir=[" + directory + "] , path=[" + path + "]" ;
                                // 6.3.8.5 (2015/10/16) コンストラクターで、Exception を throw しないようにします。
//                              System.out.println( errMsg );
                                System.err.println( ThrowUtil.ogThrowMsg( errMsg ) );           // 7.3.2.0 (2021/03/19) ﾌｫﾙﾀﾞなしは、積極的なエラーにする。
        //                      // 7.3.2.0 (2021/03/19) ﾌｫﾙﾀﾞを作成する必要はない。あくまでｲﾒｰｼﾞを用意しておいて利用するだけでよい。
        //                      // 6.4.3.2 (2016/02/19) 指定のフォルダが存在しない場合、作成します。
        //                      if( directory.mkdirs() ) {
        //                              final String errMsg2 = "指定のディレクトリを自動作成しました。[" + directory + "]";
        //                              System.out.println( errMsg2 );
        //                      }
        //                      else {
        //                              final String errMsg3 = "指定のディレクトリの自動作成に失敗しました。[" + directory + "]";
        //                              System.err.println( ThrowUtil.ogThrowMsg( errMsg3 ) );
        //                      }
                                return ;
                        }

                        if( ! directory.isDirectory() ) {
                                final String errMsg = "指定のキーは、ディレクトリではありません。[" + directory + "]";
                                // 6.3.8.5 (2015/10/16) コンストラクターで、Exception を throw しないようにします。
                                System.err.println( ThrowUtil.ogThrowMsg( errMsg ) );
                                return ;
                        }
                        // 6.3.8.4 (2015/10/09) ﾌｧｲﾙのみ取り込む
                        // 6.3.9.0 (2015/11/06) null になっている可能性があるメソッドの戻り値のnullチェックを追加。
                        final File[] files = directory.listFiles();
                        if( files != null ) {
                                for( final File file : files ) {
                                        if( file != null && file.isFile() ) {
                                                dataSet( file.getName() , path );
                                        }
                                }
                        }
                }
                else {
                        final int len = dir.length() ;
//                      for( final Object rpath : resourcePaths ) {
//                              final String fname = String.valueOf( rpath ).substring( len );  // ファイル名
//                              dataSet( fname , path );
//                      }
                        for( final String rpath : resourcePaths ) {                     // 7.3.2.0 (2021/03/19)
                                final String fname = rpath.substring( len );    // ファイル名
                                dataSet( fname , path );
                        }
                }
        }

        /**
         * ファイルマップを構築する内部処理。
         *
         * これは、ServletContext を利用した、META-INF/resources からの読み取り対応と、
         * 通常のフォルダスキャンの読み取りの共通処理をまとめた目疎度です。
         *
         * @og.rev 6.3.8.4 (2015/10/09) 新規作成
         * @og.rev 6.4.3.1 (2016/02/12) PMD refactoring. HashMap → ConcurrentHashMap に置き換え。変数名も変えておきます。
         *
         * @param  fname ファイル名
         * @param  path  ファイル名に付与するパス文字列
         */
        private void dataSet( final String fname , final String path ) {
                final String upkey = fname.toUpperCase( Locale.JAPAN ) ;
                String tmpName = fname;

                // path が、nullやゼロ文字列以外の場合は、最後の文字を判定して、ファイル名に連結します。
                if( path != null && !path.isEmpty() ) {
                        final char ch = path.charAt( path.length()-1 ) ;
                        if( ch == '/' || ch == '\\' ) {
                                tmpName = path + fname;
                        }
                        else {
                                tmpName = path + '/' + fname;
                        }
                }

                // 6.4.3.1 (2016/02/12) PMD refactoring. HashMap → ConcurrentHashMap に置き換え。変数名も変えておきます。
                final int idx = upkey.lastIndexOf( '.' );
                if( idx >= 0 ) {
                        fMap.put( upkey.substring( 0,idx ), tmpName );
                }
                else {
                        fMap.put( upkey, tmpName );
                }
        }

        /**
         * 指定のキーのファイルが存在しているかどうかを返します。
         * 存在している場合は、true , 存在していない場合は、false になります。
         *
         * @og.rev 6.3.8.5 (2015/10/16) Exception を throw しないようにします。
         * @og.rev 6.4.3.1 (2016/02/12) PMD refactoring. HashMap → ConcurrentHashMap に置き換え。
         *
         * @param   key 指定のキー
         *
         * @return      存在しているかどうか(true:存在する/false:存在しない)
         */
        public boolean exists( final String key ) {
                // 6.4.3.1 (2016/02/12) PMD refactoring. HashMap → ConcurrentHashMap に置き換え。変数名も変えておきます。
                return key != null && fMap.containsKey( key.toUpperCase( Locale.JAPAN ) );
        }

        /**
         * キーに対応したファイル名を返します。
         * 指定のキーに対するファイル名が存在しない場合は、null を返します。
         *
         * 引数を可変長引数にして、前から順番にMapを調べます。最初に、null でない
         * 値を返します。最後まで一致しなければ、null を返します。
         * 引数のキーが、nullや、ゼロ配列の場合も、nullになります。
         *
         * @og.rev 6.3.8.4 (2015/10/09) FileMap のコンストラクタ変更に伴う対応。
         * @og.rev 6.4.3.1 (2016/02/12) PMD refactoring. HashMap → ConcurrentHashMap に置き換え。
         *
         * @param   keys 指定のキー配列(可変長引数)
         *
         * @return      ファイル名(ディレクトリパスは含まず)、存在しない場合は、null
         */
        public String getFilename( final String... keys ) {
                // 8.5.5.1 (2024/02/29) PMD 7.0.0 OnlyOneReturn メソッドには終了ポイントが 1 つだけ必要
                String rtn = null;
                if( keys != null ) {
                        for( final String key : keys ) {
                                // 6.3.8.4 (2015/10/09) 最初に見つけた値を返す。
                                if( key != null ) {
                                        // 6.4.3.1 (2016/02/12) PMD refactoring. HashMap → ConcurrentHashMap に置き換え。変数名も変えておきます。
//                                      final String rtn = fMap.get( key.toUpperCase( Locale.JAPAN ) );
//                                      if( rtn != null ) { return rtn; }
                                        rtn = fMap.get( key.toUpperCase( Locale.JAPAN ) );
                                        if( rtn != null ) { break; }
                                }
                        }
                }
//              return null;
                return rtn;
        }

        /**
         * 初期化が完了しているかどうかを、返します。
         * 完了している場合は、true を返します。未完了、または、clear() 実行後は、falseです。
         *
         * インスタンスは、init処理が完了するまでは、false が返る為、簡易的な同期処理は
         * 行われています。
         * (内部のMapへの書き込みは、init処理でのみ行われます。)
         *
         * @og.rev 6.3.9.0 (2015/11/06) 新規作成。
         * @og.rev 6.4.3.2 (2016/02/19) initFlagを廃止し、直接 Mapが空かどうかで判定します。
         *
         * @return      初期化が完了していればtrue
         */
        public boolean isInit() { return !fMap.isEmpty(); }

        /**
         * 初期化(クリア)します。
         *
         * @og.rev 6.3.9.0 (2015/11/06) 新規作成。
         * @og.rev 6.4.3.1 (2016/02/12) PMD refactoring. HashMap → ConcurrentHashMap に置き換え。
         */
        @Override       // Cleanable
        public void clear() {
                // 6.4.3.1 (2016/02/12) PMD refactoring. HashMap → ConcurrentHashMap に置き換え。変数名も変えておきます。
                fMap.clear();
        }
}