001/*
002 * Copyright (c) 2009 The openGion Project.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
013 * either express or implied. See the License for the specific language
014 * governing permissions and limitations under the License.
015 */
016package org.opengion.hayabusa.taglib;
017
018import org.opengion.hayabusa.common.HybsSystem;
019import org.opengion.hayabusa.common.HybsSystemException;
020import org.opengion.hayabusa.db.DBTableModel;
021import org.opengion.hayabusa.db.DBTableModelSorter;
022import org.opengion.hayabusa.db.DBColumn;
023import org.opengion.hayabusa.db.DBTableModelUtil;
024import org.opengion.fukurou.system.DateSet;                                             // 6.4.2.0 (2016/01/29)
025import org.opengion.fukurou.util.StringUtil;
026import org.opengion.fukurou.util.ToString;                                              // 6.1.1.0 (2015/01/17)
027import org.opengion.fukurou.security.HybsCryptography ;                 // 5.7.4.3 (2014/03/28)
028import org.opengion.fukurou.model.POIUtil;                                              // 6.2.2.0 (2015/03/27)
029import org.opengion.fukurou.util.FileInfo;                                              // 6.2.2.0 (2015/03/27)
030import org.opengion.fukurou.util.FileUtil;                                              // 6.7.4.1 (2017/02/17)
031import org.opengion.fukurou.util.ArraySet;                                              // 6.4.3.4 (2016/03/11)
032import org.opengion.hayabusa.io.HybsFileOperationFactory;               // 8.0.0.1 (2021/10/08)
033
034import static org.opengion.fukurou.util.StringUtil.nval ;
035
036import java.util.Arrays;
037import java.io.File;
038import java.io.FileFilter;
039import java.io.IOException;
040
041/**
042 * ファイルを検索し、DBTableModel にセットするタグです。
043 *
044 * ファイルの検索結果は、[WRITABLE],LEVEL,FILE_TYPE,PARENT,NAME,LASTMODIFIED,FILE_LENGTH,RWH,[MD5],[TO_PARENT,TO_NAME],[・・・・]
045 * のカラムを持つ DBTableModel にセット されます。このカラムは、固定です。
046 * 並び替えについては、このタグで指定しますが、ファイルの選別(where 条件)は、
047 * BODY 部に記述する fileWhere タグで指定します。(複数指定可能))
048 *
049 * [カラム名]      検索するファイルの属性は、以下のカラム名で作成されます。
050 *     [WRITABLE]       useWritable=trueで、先頭カラムに、WRITABLE カラムが挿入されます。
051 *      LEVEL           ディレクトリを展開する場合のレベル。
052 *      FILE_TYPE       ファイル(F)かディレクトリ(D)であるか判定。
053 *      PARENT          この抽象パス名の親のパス名文字列を返します。
054 *      NAME            この抽象パス名が示すファイルまたはディレクトリの名前を返します。
055 *      LASTMODIFIED    最後に変更された時刻を返します。
056 *      FILE_LENGTH     ファイルの長さを返します。
057 *      RWH             読み込み、書き込み、隠し属性をそれぞれ、r,w,h で表します。
058 *     [MD5]            useMD5=trueで、MD5 というカラムを追加したうえで、ファイルのMD5計算を行います。
059 *     [TEXT]           useText=trueで、ファイルの内容を文字列にして、TEXTというカラムに設定します。
060 *     [TO_PARENT]      useUpdateClms=trueで、fileUpdateタグでCOPYやMOVEを行う時に使用する必須となるカラム(TO_PARENT,TO_NAME)を追加します。
061 *     [TO_NAME]        同上
062 *     [・・・・]           addClms属性で指定されたカラムを追加します。
063 *
064 * @og.formSample
065 * ●形式:<og:fileQuery from="…" multi="true/false" >
066 *             <og:fileWhere … />
067 *              …
068 *         </og:fileQuery>
069 * ●body:あり(EVAL_BODY_BUFFERED:BODYを評価し、{@XXXX} を解析します)
070 *
071 * ●Tag定義:
072 *   <og:fileQuery
073 *       from             ○【TAG】検索を開始するファイルまたはディレクトリを指定します(必須)。
074 *       multi              【TAG】多段階展開するか、1レベル展開するかどうか[true:多段階/false:1レベル]を指定します(初期値:false:1レベル)。
075 *       level              【TAG】多段階展開するレベルを指定します(初期値:100)。
076 *       orderBy            【TAG】ソートするカラム名を指定します(一つのみ)。
077 *       desc               【TAG】表示順を逆転するかどうか[true/false]を指定します(初期値:false)。
078 *       useWritable        【TAG】先頭カラムに、WRITABLE カラムを追加するかどうか[true/false]を指定します(初期値:false)。
079 *       useMD5             【TAG】MD5カラムを追加したうえで、MD5計算を行うかどうか[true/false]を指定します(初期値:false)。
080 *       useText            【TAG】TEXTカラムを追加したうえで、ファイルの内容を読み込むかどうか[true/false]を指定します(初期値:false)。
081 *       useUpdateClms      【TAG】TO_PARENT、TO_NAMEカラムを追加するかどうか[true/false]を指定します(初期値:false)。
082 *       addClms            【TAG】検索結果のカラム列に追加するカラム名を、CSV形式で指定します。
083 *       nameOnly           【TAG】ファイルの拡張子を除いた名前部分のみの値で行います。7.2.6.0 (2020/06/30)
084 *       fileType           【TAG】選択対象[FILE/DIR]を指定します。下位展開は考慮(multi 属性準拠)されます。
085 *       addFrom            【TAG】from属性で指定された基準ファイル/フォルダ自体をリストに追加するかどうか[true/false]を指定します(初期値:true)。
086 *       fromBase           【TAG】検索結果のPARENT列から、fromBase指定のパスを削除した相対パスを作成します。  (7.0.2.1 (2019/03/04))
087 *       command            【TAG】コマンド (NEW,RENEW)をセットします("NEW" と "RENEW" 時のみ実行する(初期値:NEW))。
088 *       maxRowCount        【TAG】(通常は使いません)データの最大読み込み件数を指定します (初期値:DB_MAX_ROW_COUNT[=1000])(0:[無制限])。
089 *       displayMsg         【TAG】検索結果を画面上に表示するメッセージリソースIDを指定します (初期値:VIEW_DISPLAY_MSG[=])
090 *       overflowMsg        【TAG】検索データが最大検索数をオーバーした場合に表示するメッセージリソースIDを指定します
091 *                                    (初期値:MSG0007[検索結果が、制限行数を超えましたので、残りはカットされました])。
092 *       notfoundMsg        【TAG】検索結果がゼロ件の場合に表示するメッセージリソースIDを指定します(初期値:MSG0077[対象データはありませんでした])。
093 *       stopZero           【TAG】検索結果が0件のとき処理を続行するかどうか[true/false]を指定します(初期値:false[続行する])
094 *       tableId            【TAG】(通常は使いません)結果のDBTableModelを、sessionに登録するときのキーを指定します
095 *       scope              【TAG】キャッシュする場合のスコープ[request/page/session/application]を指定します(初期値:session)。
096 *       useSLabel          【TAG】7.0.7.0 (2019/12/13) エラーメッセージにSLABELを利用するかどうか[true/false]を指定します(初期値:false)
097 *       useLocal           【TAG】システム定数でクラウド設定されていても、クラウド環境を使用しない場合、trueを指定します(初期値:false) 8.0.1.0 (2021/10/29)
098 *       caseKey            【TAG】このタグ自体を利用するかどうかの条件キーを指定します(初期値:null) 6.8.0.0 (2017/06/02)
099 *       caseVal            【TAG】このタグ自体を利用するかどうかの条件値を指定します(初期値:null) 6.8.0.0 (2017/06/02)
100 *       caseNN             【TAG】指定の値が、null/ゼロ文字列 でない場合(Not Null=NN)は、このタグは使用されます(初期値:判定しない) 6.8.0.0 (2017/06/02)
101 *       caseNull           【TAG】指定の値が、null/ゼロ文字列 の場合は、このタグは使用されます(初期値:判定しない) 6.8.0.0 (2017/06/02)
102 *       caseIf             【TAG】指定の値が、true/TRUE文字列の場合は、このタグは使用されます(初期値:判定しない) 6.8.0.0 (2017/06/02)
103 *       debug              【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false)。
104 *   >   ... Body ...
105 *   </og:fileQuery>
106 *
107 * ●使用例
108 *    ・一般的な属性でファイルの検索を行います。
109 *         <og:fileQuery
110 *                from    = "d:/webapps/dbdef/jsp/"
111 *                multi   = "true"
112 *                command = "{@command}"  >
113 *            <og:fileWhere endWith=".jsp" />
114 *      </og:fileQuery>
115 *
116 *    ・最終変更日で逆順ソートする。対象は、2002/10/01 以降に変更されたファイル。
117 *        <og:fileQuery
118 *                from    = "d:/webapps/dbdef/jsp/"
119 *                multi   = "true"
120 *                orderBy = "LASTMODIFIED"
121 *                desc    = "true"
122 *                command = "{@command}"  >
123 *            <og:fileWhere lastModified="20021001000000" />
124 *        </og:fileQuery>
125 *
126 * @og.rev 4.0.0.0 (2005/01/31) 内部ロジック改定
127 * @og.group その他入力
128 *
129 * @version  4.0
130 * @author       Kazuhiko Hasegawa
131 * @since    JDK5.0,
132 */
133public class FileQueryTag extends QueryTag {
134        /** このプログラムのVERSION文字列を設定します。 {@value} */
135        private static final String VERSION = "8.0.1.0 (2021/10/29)" ;
136        private static final long serialVersionUID = 801020211029L ;
137
138        // 6.4.3.4 (2016/03/11) String配列 から、Setに置き換えます。
139        private static final ArraySet<String> SELECT_SET = new ArraySet<>( "LEVEL","FILE_TYPE","PARENT","NAME","LASTMODIFIED","FILE_LENGTH","RWH" );
140
141        private static final String[] USE_UPDATE_CLM = { "TO_PARENT","TO_NAME" };       // 5.3.4.0 (2011/04/01)
142
143        private transient FileFilter filter     ;               // FileWhere で指定したフィルター
144
145        private boolean multi                   ;                       // 下位層展開フラグ
146        private int             level                   = 100;          // 展開レベル
147        private String  from                    = HybsSystem.sys( "FILE_URL" ); // 検索起点ファイル
148        private String  orderBy                 ;                       // 5.3.4.0 (2011/04/01) ソートカラム
149        private boolean desc                    ;                       // 5.3.4.0 (2011/04/01) ソートの方向(true:逆順)
150        private String[]        addClms         = new String[0];                                // 5.3.4.0 (2011/04/01) 追加カラム配列
151        private String[]        defClms         ;                       // 5.7.4.3 (2014/03/28) 初期値のカラム配列
152        private String  fileType                ;                       // 5.3.4.0 (2011/04/01) 選択対象を指定(FILE,DIR)
153        private boolean useWritable             ;                       // 5.7.4.3 (2014/03/28) 先頭カラムに、WRITABLE カラムを追加するかどうか[true/false](初期値:false)
154        private boolean useMD5                  ;                       // 5.7.4.3 (2014/03/28) MD5カラムを追加したうえで、MD5計算を行うかどうか[true/false](初期値:false)
155        private boolean useText                 ;                       // 6.2.2.0 (2015/03/27) TEXTカラムを追加したうえで、ファイルの内容を読み込むかどうか[true/false]を指定します(初期値:false)。
156        private boolean useUpdateClms   ;                       // 5.3.4.0 (2011/04/01) TO_PARENT、TO_NAMEカラムを追加(true:追加)
157        private boolean addFrom                 = true;         // 5.3.9.0 (2011/09/01) from属性で指定された基準ファイル/フォルダ自体をリストに追加するかどうか
158        private int             fromLen                 = -1;           // 7.0.2.1 (2019/03/04) fromBase の文字数をPARENTから削除するための数
159        private boolean nameOnly                ;                       // 7.2.6.0 (2020/06/30) ファイルの拡張子を除いた名前部分のみの値で行います。
160        private boolean useLocal                ;                       // 8.0.1.0 (2021/10/29) クラウド設定を使用しない場合は、true
161
162        /**
163         * デフォルトコンストラクター
164         *
165         * @og.rev 6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.
166         */
167        public FileQueryTag() { super(); }              // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。
168
169        /**
170         * Taglibのタグ本体を処理する doAfterBody() を オーバーライドします。
171         *
172         * タグ本体が空の場合は、呼ばれないので、従来の doAfterBody() 処理を、
173         * doEndTag() に持っていきます。
174         * よって、親クラスの doAfterBody() を実行させないため、このメソッドを用意しています。
175         *
176         * @og.rev 6.7.4.1 (2017/02/17) 親クラスの処理を、実行させない。
177         *
178         * @return      後続処理の指示(SKIP_BODY)
179         */
180        @Override
181        public int doAfterBody() {
182                return SKIP_BODY ;
183        }
184
185        /**
186         * Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
187         *
188         * タグ本体が空の場合は、呼ばれないので、従来の doAfterBody() 処理を、
189         * doEndTag() に持っていきます。
190         *
191         * @og.rev 6.7.4.1 (2017/02/17) 従来の doAfterBody() 処理を、doEndTag() に持ってくる。
192         * @og.rev 6.8.0.0 (2017/06/02) caseKey,caseVal,caseNN,caseNull 属性を追加
193         * @og.rev 8.0.0.1 (2021/10/08) cloud対応
194         *
195         * @return      後続処理の指示
196         */
197        @Override
198        public int doEndTag() {
199                if( !useTag() ) { return SKIP_BODY ; }  // 6.8.0.0 (2017/06/02)
200
201                executeCount = 0;
202
203                table = initDBTable();
204                if( maxRowCount < 0 ) {
205                        maxRowCount     = sysInt( "DB_MAX_ROW_COUNT" ) ;
206                }
207
208                // 5.3.5.0 (2011/05/01) 最初のファイルが存在する場合のみ、実行する。
209//              final File fin = new File( from );
210                final File fin = HybsFileOperationFactory.create( useLocal,from );              // 8.0.0.1 (2021/10/08)
211                if( fin.exists() ) {
212                        // 7.0.2.1 (2019/03/04) 検索結果のPARENT列から、from指定のパスを削除した相対パスを作成
213
214                        execute( fin,0 ) ;
215
216                        // 5.3.4.0 (2011/04/01) 指定カラムのソート処理
217                        if( orderBy != null ) {
218                                final int clmNo = table.getColumnNo( orderBy );
219                                final DBTableModelSorter temp = new DBTableModelSorter();
220                                temp.setModel( table );
221                                temp.sortByColumn( clmNo,!desc );       // 注意 desc の値と ソート正逆は、反対です。
222                                table = temp;
223                        }
224                }
225                return super.doEndTag();
226        }
227
228        /**
229         * タグリブオブジェクトをリリースします。
230         * キャッシュされて再利用されるので、フィールドの初期設定を行います。
231         *
232         * @og.rev 5.3.4.0 (2011/04/01) 指定カラムのソート処理機能、カラム追加機能、fileType追加
233         * @og.rev 5.3.9.0 (2011/09/01) addFrom属性追加
234         * @og.rev 5.7.4.3 (2014/03/28) useWritable,useMD5属性追加。valClms を defClms に置き換え。
235         * @og.rev 6.2.2.0 (2015/03/27) useText属性追加。
236         * @og.rev 7.0.2.1 (2019/03/04) fromBase属性追加に伴い、fromLen変数を用意。
237         * @og.rev 7.2.6.0 (2020/06/30) nameOnly 属性 を追加します。
238         * @og.rev 8.0.1.0 (2021/10/29) useLocal 属性を追加。
239         */
240        @Override
241        protected void release2() {
242                super.release2();
243                filter                  = null;
244                multi                   = false;
245                level                   = 100;
246                from                    = HybsSystem.sys( "FILE_URL" );
247                orderBy                 = null;                         // 5.3.4.0 (2011/04/01) ソートカラム
248                desc                    = false;                        // 5.3.4.0 (2011/04/01) 降順フラグ
249                addClms                 = new String[0];        // 5.3.4.0 (2011/04/01) 追加カラム配列
250                defClms                 = null;                         // 5.7.4.3 (2014/03/28) 初期値のカラム配列
251                fileType                = null;                         // 5.3.4.0 (2011/04/01) 選択対象を指定(FILE,DIR,ALL)
252                useWritable             = false;                        // 5.7.4.3 (2014/03/28) 先頭カラムに、WRITABLE カラムを追加するかどうか[true/false](初期値:false)
253                useMD5                  = false;                        // 5.7.4.3 (2014/03/28) MD5カラムを追加したうえで、MD5計算を行うかどうか[true/false](初期値:false)
254                useText                 = false;                        // 6.2.2.0 (2015/03/27) TEXTカラムを追加したうえで、ファイルの内容を読み込むかどうか[true/false]を指定します(初期値:false)。
255                useUpdateClms   = false;                        // 5.3.4.0 (2011/04/01) TO_PARENT、TO_NAMEカラムを追加(true:追加)
256                addFrom                 = true;                         // 5.3.9.0 (2011/09/01) addFrom属性追加
257                fromLen                 = -1;                           // 7.0.2.1 (2019/03/04) fromBase の文字数をPARENTから削除するための数
258                nameOnly                = false;                        // 7.2.6.0 (2020/06/30) ファイルの拡張子を除いた名前部分のみの値で行います。
259                useLocal                = false;                        // 8.0.1.0 (2021/10/29) クラウド設定を使用しない場合は、true
260        }
261
262        /**
263         * FileQuery を実行します。
264         *
265         * @og.rev 5.3.4.0 (2011/04/01) fileType の条件に合致する場合だけ、データを作成する。
266         * @og.rev 5.3.7.0 (2011/07/01) フォルダにアクセスできない場合は、null となるのでその対応
267         * @og.rev 7.0.2.1 (2019/03/04) fromBase属性追加に伴い、fromLen変数を用意。
268         *
269         * @param       fin     検索を開始するファイル/ディレクトリ
270         * @param       lvl     階層展開レベル
271         */
272        protected void execute( final File fin,final int lvl ) {
273                if( !multi && lvl > 1 || lvl > level ) { return; }                      // 階層展開する、しない   // 6.9.7.0 (2018/05/14) PMD Useless parentheses.
274                if( executeCount > maxRowCount ) { table.setOverflow( true ); return; }
275
276                final boolean isDIR = fin.isDirectory();
277
278                if(             fileType == null
279                        ||  isDIR &&  "DIR".equalsIgnoreCase( fileType )
280                        || !isDIR && "FILE".equalsIgnoreCase( fileType ) ) {
281                                // 6.0.2.4 (2014/10/17) RpC:条件テストを繰り返しています。
282                                if( addFrom || lvl > 0 ) {
283                                        addFileData( executeCount++,lvl,fin );
284                                }
285                }
286                if( isDIR ) {
287                        final File[] list = fin.listFiles( filter );
288                        // 5.3.7.0 (2011/07/01) フォルダにアクセスできない場合は、null となる。
289                        if( list != null ) {
290                                for( int i=0; i<list.length; i++ ) {
291                                        execute( list[i],lvl+1 );
292                                }
293                        }
294                }
295        }
296
297        /**
298         * 初期化された DBTableModel を返します。
299         *
300         * ここでは、useWritable、useMD5、useUpdateClms、addClms を加味した
301         * DBTableModel と初期値データ(defClms)を作成します。
302         * 以前は、TO_PARENT、TO_NAMEと、addClms 分のみ初期値を持っていましたが、
303         * 5.7.4.3 (2014/03/28)で、先頭カラムのWRITABLEの初期値を、DBColumn の初期値ではなく
304         * 手動設定する必要がある為、すべてのカラム列の初期値を持っておきます。
305         *
306         * @og.rev 5.3.4.0 (2011/04/01) 指定カラム追加機能追加
307         * @og.rev 5.7.4.3 (2014/03/28) useWritable,useMD5属性追加
308         * @og.rev 6.2.2.0 (2015/03/27) TEXTカラムを追加したうえで、ファイルの内容を読み込むかどうか[true/false]を指定します(初期値:false)。
309         * @og.rev 6.4.3.4 (2016/03/11) String配列 から、Setに置き換えます。
310         * @og.rev 7.0.2.1 (2019/03/04) 追加カラムの位置のアドレス指定が間違っていた。
311         *
312         * @return       テーブルモデル
313         */
314        private DBTableModel initDBTable() {
315                final DBTableModel tbl = DBTableModelUtil.newDBTable();
316
317                // 5.7.4.3 (2014/03/28) 以下の処理は、ほぼ全面見直し
318                int size = SELECT_SET.size() ;                                                  // 6.4.3.4 (2016/03/11) 基本カラムの数
319
320                if( useWritable   ) { size++ ; }                                                // WRITABLE カラムを追加
321                if( useMD5        ) { size++ ; }                                                // MD5 カラムを追加
322                if( useText       ) { size++ ; }                                                // 6.2.2.0 (2015/03/27) TEXT カラムを追加
323                if( useUpdateClms ) { size += USE_UPDATE_CLM.length; }  // TO_PARENT、TO_NAMEカラムを追加
324                size += addClms.length ;                                                                // addClms(追加カラム)数を追加
325
326                // DBTableModel の初期化と、初期値配列の確保
327                tbl.init( size );
328                defClms = new String[size];
329
330                int ad=0;
331                // 先頭は、WRITABLE
332                if( useWritable ) {
333                        final DBColumn dbColumn = getDBColumn( "WRITABLE" );
334                        defClms[ad] = "1";                                                                      // WRITABLE を設定するときは、とりあえず 書き込み許可
335                        tbl.setDBColumn( ad++,dbColumn );
336                }
337
338                // SELECT の 基本カラムの設定。(初期値は不要)
339                // 6.4.3.4 (2016/03/11) String配列 から、Setに置き換えます。
340                // オリジナルの forEach。カウンタ初期値とラムダ式を与えると、ラムダ式の引数に、カウンタと値が設定される。
341                SELECT_SET.forEach( ad , (i,v) -> {
342                        final DBColumn dbColumn = getDBColumn( v );
343                        tbl.setDBColumn( i,dbColumn );
344                } );
345
346                ad += SELECT_SET.size();                                                                // 7.0.2.1 (2019/03/04)
347
348                // MD5 カラムを追加。
349                if( useMD5 ) {
350                        final DBColumn dbColumn = getDBColumn( "MD5" );
351                        defClms[ad] = "";                                                                       // ディレクトリの場合は、MD5計算しません。
352                        tbl.setDBColumn( ad++,dbColumn );
353                }
354
355                // 6.2.2.0 (2015/03/27) TEXT カラムを追加
356                if( useText ) {
357                        final DBColumn dbColumn = getDBColumn( "TEXT" );
358                        defClms[ad] = "";                                                                       // ディレクトリの場合は、TEXT計算しません。
359                        tbl.setDBColumn( ad++,dbColumn );
360                }
361
362                // TO_PARENT、TO_NAMEカラムを追加
363                if( useUpdateClms ) {
364                        for( int i=0; i<USE_UPDATE_CLM.length; i++ ) {
365                                final DBColumn dbColumn = getDBColumn( USE_UPDATE_CLM[i] );
366                                defClms[ad] = dbColumn.getDefault();                    // 初期値を指定しておく
367                                tbl.setDBColumn( ad++,dbColumn );
368                        }
369                }
370
371                // 追加カラムのaddClmsカラムを追加
372                for( int i=0; i<addClms.length; i++ ) {
373                        final DBColumn dbColumn = getDBColumn( addClms[i] );
374                        defClms[ad] = dbColumn.getDefault();                                    // 初期値を指定しておく
375                        tbl.setDBColumn( ad++,dbColumn );
376                }
377
378                return tbl ;
379        }
380
381        /**
382         * DBTableModel に、ファイル情報をセットします。
383         * ファイル情報は、[WRITABLE],LEVEL,FILE_TYPE,PARENT,NAME,LASTMODIFIED,FILE_LENGTH,RWH,[MD5],[TO_PARENT,TO_NAME],[・・・・] です。
384         *
385         * useWritable=true の場合、先頭カラムに、WRITABLE カラムを追加します。
386         * useMD5=true の場合、MD5カラムを追加したうえで、MD5計算を行います(ファイルのみ計算します)。
387         * useUpdateClms=true の場合TO_PARENT、TO_NAMEカラムを追加します。
388         * addClms で指定されたカラムをその後ろに追加します。
389         *
390         * @og.rev 5.3.4.0 (2011/04/01) 指定カラム追加機能追加
391         * @og.rev 5.7.4.3 (2014/03/28) useWritable,useMD5属性追加
392         * @og.rev 6.2.2.0 (2015/03/27) TEXTカラムを追加したうえで、ファイルの内容を読み込むかどうか[true/false]を指定します(初期値:false)。
393         * @og.rev 6.2.3.0 (2015/05/01) POIUtil のメソッド名変更に伴う対応
394         * @og.rev 6.2.4.2 (2015/05/29) POIUtil#extractor の判定方法変更
395         * @og.rev 6.4.2.0 (2016/01/29) DateSet.getDate( String ) を利用するように修正します。
396         * @og.rev 7.0.2.1 (2019/03/04) fromLen属性追加。
397         * @og.rev 7.1.0.0 (2020/01/20) fromLen属性で、CanonicalFileで区切り文字'¥'が消えるため、そのため、PARENTに'¥'が残る現象の対応。
398         * @og.rev 7.2.6.0 (2020/06/30) nameOnly 属性 を追加します。
399         *
400         * @param       rowNo   セットする行番号
401         * @param       lvl     セットするレベル
402         * @param       fin             ファイル情報の元となるファイルオブジェクト
403         */
404        private void addFileData( final int rowNo,final int lvl,final File fin ) {
405                try {
406                        final File file = fin.getCanonicalFile();
407
408                        final String rwh = (    file.canRead()  ? "r" : "-" )
409                                                +       ( file.canWrite() ? "w" : "-" )
410                                                +       ( file.isHidden() ? "h" : "-" );
411
412                        final String lastModified = DateSet.getDate( file.lastModified(),"yyyyMMddHHmmss" );                            // 6.4.2.0 (2016/01/29)
413
414                        final boolean isF = file.isFile();                                                      // File=true,それ以外=false
415
416                        final int size = table.getColumnCount() ;
417                        String[] data = Arrays.copyOf( defClms,size );                          // JDK1.6
418
419                        int ad=0;
420                        if( useWritable ) { ad++ ; }            // 単にひとつ進める。初期値はセット済み。
421
422                        // SELECT の 基本カラムの設定
423                        data[ad++] = String.valueOf( lvl ) ;                                            // LEVEL
424                        data[ad++] = isF ? "F" : "D" ;                                                          // FILE_TYPE
425                        // 7.0.2.1 (2019/03/04) 検索結果のPARENT列から、from指定のパスを削除した相対パスを作成
426                        final String parent = file.getParent() ;                                                        // PARENTの元(正規パス)
427//                      data[ad++] = fromLen > 0 ? parent.substring( fromLen ) : parent ;       // PARENT
428                        data[ad++] = fromLen > 0 ? ( parent.length() < fromLen ? "" : parent.substring( fromLen ) ) : parent ;  // PARENT 7.1.0.0 (2020/01/20)
429
430                        // 7.2.6.0 (2020/06/30) nameOnly 属性 を追加します。
431                        String fname = file.getName() ;                                                         // NAME
432                        if( nameOnly ) {
433                                final int idx = fname.lastIndexOf( '.' );
434                                if( idx >= 0 ) { fname = fname.substring( 0,idx ); }
435                        }
436//                      data[ad++] = file.getName() ;                                                           // NAME
437                        data[ad++] = fname ;                                                                            // NAME
438                        data[ad++] = lastModified ;                                                                     // LASTMODIFIED
439                        data[ad++] = String.valueOf( FileUtil.length( file ) );         // FILE_LENGTH 6.7.4.1 (2017/02/17) DIRの容量も計算する
440                        data[ad++] = rwh ;                                                                                      // RWH
441
442                        // MD5 カラムを追加(ファイルの場合のみ計算します)
443                        if( useMD5 && isF ) {
444                                data[ad++] = HybsCryptography.getMD5( file );
445                        }
446
447                        // 6.2.2.0 (2015/03/27) TEXT カラムを追加(ファイルの場合のみ取り込みます)
448                        if( useText && isF ) {
449                                final String sufix = FileInfo.getSUFIX( file ) ;
450                                String val = "";
451                                try {
452                                        if( POIUtil.isPOI( file ) ) {                                           // 6.2.4.2 (2015/05/29)
453                                                val = POIUtil.extractor( file );
454                                        }
455                                        else if( "txt,jsp,java,xml,css,js".contains( sufix ) ) {
456                                                val = POIUtil.extractor( file , "UTF-8");                               // 6.2.3.0 (2015/05/01)
457                                        }
458                                        else {
459                                                val = POIUtil.extractor( file , "Windows-31J");                 // 6.2.3.0 (2015/05/01)
460                                        }
461                                }
462                                catch( final RuntimeException ex ) {
463                                        // 変換に失敗しても、処理は継続する。
464                                        final String errMsg = "ファイルのテキスト変換に失敗しました。[" + fin + "]"
465                                                                + " ROW=[" + rowNo + "]"
466                                                                + CR + ex.getMessage();
467                                        System.err.println( errMsg );
468                                }
469                                data[ad++] = val;
470                        }
471
472                        // useUpdateClms=true 時の TO_PARENT、TO_NAMEカラムや、addClmsの追加カラムは、初期値のみセット
473                        // 初期値セットは、Arrays.copyOf で、defClms のコピーで完了。
474
475                        table.addColumnValues( data );
476                }
477                catch( final IOException ex ) {
478                        final String errMsg = "正式なファイル名の取得に失敗しました。[" + fin + "]"
479                                                + " ROW=[" + rowNo + "]"
480                                                + CR + ex.getMessage();
481                        throw new HybsSystemException( errMsg,ex );
482                }
483        }
484
485        /**
486         * 【TAG】ファイルの検索元となるディレクトリを指定します
487         *              (初期値:FILE_URL[={@og.value SystemData#FILE_URL}])。
488         *
489         * @og.tag ファイルの検索元となるディレクトリを指定します。
490         *
491         * @og.rev 4.0.0.0 (2007/11/20) 指定されたディレクトリ名の最後が"\"or"/"で終わっていない場合に、"/"を付加する。
492         * @og.rev 6.4.2.1 (2016/02/05) URLの最後に、"/" を追加する処理を廃止。
493         * @og.rev 6.4.2.1 (2016/02/05) HybsSystem.url2dir に引数追加。
494         *
495         * @param       url ファイルの検索元となるディレクトリ
496         */
497        public void setFrom( final String url ) {
498                final String furl = nval( getRequestParameter( url ),null );
499                from = HybsSystem.url2dir( from,furl,"." );                     // 6.4.2.1 (2016/02/05)
500        }
501
502        /**
503         * 【TAG】多段階展開するか、1レベル展開するかどうか[true/false]を指定します(初期値:false)。
504         *
505         * @og.tag
506         * 初期値は、false (1レベル) です。
507         *
508         * @param       mlti 多段階展開するか [true:する/false:1レベル]
509         */
510        public void setMulti( final String mlti ) {
511                multi = nval( getRequestParameter( mlti ),multi );
512        }
513
514        /**
515         * 【TAG】多段階展開するレベルを指定します(初期値:100)。
516         *
517         * @og.tag
518         * 多段階展開するレベルを指定します(初期値:100)。
519         *
520         * @param       lvl 多段階展開するレベル
521         */
522        public void setLevel( final String lvl ) {
523                level = nval( getRequestParameter( lvl ),level );
524        }
525
526        /**
527         * 【TAG】ソートするカラム名を指定します(一つのみ)。
528         *
529         * @og.tag
530         * ソートするカラム名を、"LEVEL","FILE_TYPE","PARENT","NAME","LASTMODIFIED","FILE_LENGTH","RWH"
531         * から一つ選びます。
532         * これは、複数カラムでのソートはできません。
533         * 逆順にソートする場合は、desc属性を true にセットください。
534         * + をつけても、無効(カラム名がないということ)でエラーになります。
535         *
536         * @og.rev 5.3.4.0 (2011/04/01) 新規追加
537         * @og.rev 6.3.4.0 (2015/08/01) Arrays.toString から String.join に置き換え。
538         * @og.rev 6.4.3.4 (2016/03/11) String配列 から、Setに置き換えます。
539         *
540         * @param       clm ソートするカラム名 (一つのみ、逆順はマイナスを付ける)
541         * @see         #setDesc( String )
542         */
543        public void setOrderBy( final String clm ) {
544                orderBy = nval( getRequestParameter( clm ),orderBy );
545
546                if( orderBy != null && ! check( orderBy, SELECT_SET ) ) {
547                        final String errMsg = "指定の orderBy は、指定できません。" + CR
548                                                        + "orderBy=[" + orderBy + "] "                          + CR
549                                                        + "orderByList=" + String.join( ", " , SELECT_SET ) ;
550                        throw new HybsSystemException( errMsg );
551                }
552        }
553
554        /**
555         * 【TAG】表示順を逆転するかどうか[true/false]を指定します(初期値:false)。
556         *
557         * @og.tag
558         * orderBy 属性で指定した表示順を、逆順にするかどうかを指定できます。
559         * 初期値は、false (昇順) です。
560         *
561         * @og.rev 5.3.4.0 (2011/04/01) 新規追加
562         *
563         * @param       flag 表示順逆順 [逆順:true/正順:false]
564         * @see         #setOrderBy( String )
565         */
566        public void setDesc( final String flag ) {
567                desc = nval( getRequestParameter( flag ),desc );
568        }
569
570        /**
571         * 【TAG】先頭カラムに、WRITABLE カラムを追加するかどうか[true/false]を指定します(初期値:false)。
572         *
573         * @og.tag
574         * ファイル検索結果の1レコード単位に、書き込み許可/禁止属性を付けるには、
575         * カラム列の先頭に、WRITABLE カラムを追加する必要があります。
576         * 初期値は、false (追加しない) です。
577         *
578         * @og.rev 5.7.4.3 (2014/03/28) 新規追加
579         *
580         * @param       flag WRITABLEカラム追加 [true:する/false:しない]
581         */
582        public void setUseWritable( final String flag ) {
583                useWritable = nval( getRequestParameter( flag ),useWritable );
584        }
585
586        /**
587         * 【TAG】MD5カラムを追加したうえで、MD5計算を行うかどうか[true/false]を指定します(初期値:false)。
588         *
589         * @og.tag
590         * ファイルの改変等をチェックするには、ファイルのハッシュ値を拾う必要があります。
591         * タイムスタンプとサイズ(LASTMODIFIED,FILE_LENGTH)でも、類似の処理は可能ですが、
592         * より、厳密な一致をみるなら、MD5でハッシュした結果を突き合わせるのがベストです。
593         * useMD5=true に設定すると、MD5 というカラムを追加したうえで、MD5計算結果をセットします。
594         * 初期値は、false (追加しない) です。
595         *
596         * @og.rev 5.7.4.3 (2014/03/28) 新規追加
597         *
598         * @param       flag MD5カラム追加 [true:する/false:しない]
599         */
600        public void setUseMD5( final String flag ) {
601                useMD5 = nval( getRequestParameter( flag ),useMD5 );
602        }
603
604        /**
605         * 【TAG】TEXTカラムを追加したうえで、ファイルの内容を読み込むかどうか[true/false]を指定します(初期値:false)。
606         *
607         * @og.tag
608         * ファイルの内容を取得する場合に、true に設定します。
609         * 初期値は、false (追加しない) です。
610         *
611         * @og.rev 6.2.2.0 (2015/03/27) TEXTカラムを追加したうえで、ファイルの内容を読み込むかどうか[true/false]を指定します(初期値:false)。
612         *
613         * @param       flag TEXTカラム追加 [true:する/false:しない]
614         */
615        public void setUseText( final String flag ) {
616                useText = nval( getRequestParameter( flag ),useText );
617        }
618
619        /**
620         * 【TAG】TO_PARENT、TO_NAMEカラムを追加するかどうか[true/false]を指定します(初期値:false)。
621         *
622         * @og.tag
623         * fileUpdateタグでは、ファイルのCOPYやMOVEが出来ますが、そのコピー先、移動先の
624         * ファイルを行ごとに指定する場合、TO_PARENT、TO_NAMEカラムという固定名のカラムが
625         * 必要です。
626         * これを、addClms 属性で指定する代わりに、この属性で、true をセットすることで、
627         * 自動的に追加されます。
628         * 初期値は、false (追加しない) です。
629         *
630         * @og.rev 5.3.4.0 (2011/04/01) 新規追加
631         *
632         * @param       flag TO_PARENT、TO_NAMEカラム追加 [true:追加する/false:追加しない]
633         * @see         #setAddClms( String )
634         * @see         org.opengion.hayabusa.taglib.FileUpdateTag
635         */
636        public void setUseUpdateClms( final String flag ) {
637                useUpdateClms = nval( getRequestParameter( flag ),useUpdateClms );
638        }
639
640        /**
641         * 【TAG】検索結果のカラム列に追加するカラム名を、CSV形式で指定します。
642         *
643         * @og.tag
644         * デフォルトのカラム名、[WRITABLE],LEVEL,FILE_TYPE,PARENT,NAME,LASTMODIFIED,FILE_LENGTH,RWH,[MD5],[TO_PARENT,TO_NAME]
645         * 以外に、指定のカラム名を追加することが可能です。
646         * これは、ファイル検索結果以外の項目を追加して、データベースに書き込む場合に、利用できます。
647         * 並び順は、デフォルトカラムの後ろに、指定のカラムの順番で付きます。
648         * ここで追加したカラムには、カラムリソースの初期値がセットされます。
649         *
650         * @og.rev 5.3.4.0 (2011/04/01) 新規追加
651         *
652         * @param       clms 追加するカラム名(CSV形式)
653         * @see         #setUseUpdateClms( String )
654         */
655        public void setAddClms( final String clms ) {
656                final String tmpClms = nval( getRequestParameter( clms ),null );
657                if( tmpClms != null && tmpClms.length() > 0 ) {
658                        addClms = StringUtil.csv2Array( tmpClms );
659                }
660        }
661
662        /**
663         * 【TAG】ファイル名が、指定されたファイルタイプ[DIR/FILE]と一致した場合、スルー(選択)されます(初期値:null)。
664         * @og.tag
665         * 大文字小文字は区別しません。
666         * ファイルタイプ は、DIR,FILE が指定できます。
667         * DIR は、ディレクトリのみ検索します。(階層下がりも行います)
668         * FILEは、ファイルのみ検索します。(階層下がりも行います)
669         * 引数が null の場合は、追加しません。(つまり、すべてスルーされます。)
670         *
671         * @og.rev 5.3.4.0 (2011/04/01) fileType メソッドで選択対象指定の追加
672         *
673         * @param    str ファイルタイプ [null:スルー/DIR:ディレクトリのみ検索/FILE:ファイルのみ検索]
674         */
675        public void setFileType( final String str ) {
676                final String tmp = nval( getRequestParameter( str ),fileType );
677                if( tmp == null                                         ||
678                        "DIR".equalsIgnoreCase( tmp )   ||
679                        "FILE".equalsIgnoreCase( tmp ) ) {
680                                fileType = tmp;
681                }
682                else {
683                        // ファイルタイプに不正な値が設定された場合は、エラーになる。
684                        final String errMsg = "この、fileType 属性には、DIR,FILE 以外は指定できません。["
685                                                + tmp + "]";
686                        throw new HybsSystemException( errMsg );
687                }
688        }
689
690        /**
691         * 【TAG】from属性で指定された基準ファイル/フォルダ自体をリストに追加するかどうか[true/false]を指定します(初期値:true)。
692         * @og.tag
693         * 初期値はtrue(追加する)です。
694         *
695         * @og.rev 5.3.9.0 (2011/09/01) 新規作成
696         *
697         * @param    flag 基準をリストに追加するかどうか [true:追加する/false:追加しない]
698         */
699        public void setAddFrom( final String flag ) {
700                addFrom = nval( getRequestParameter( flag ),addFrom );
701        }
702
703        /**
704         * 【TAG】検索結果のPARENT列から、fromBase指定のパスを削除した相対パスを作成します。
705         * @og.tag
706         * 実ファイルをURL化する場合に、階層をスキャンしたPARENTから、fromBase分の文字列を削除します。
707         * PARENTに相対パスを指定することが可能になります。
708         * 元となるファイルパスは、getCanonicalFile() で作成した正規パス名になるため、
709         * fromBase のパスの文字数も、同様に正規パス名から作成します。
710         *
711         * @og.rev 7.0.2.1 (2019/03/04) fromBase属性追加に伴い、fromLen変数を用意。
712         * @og.rev 7.0.5.0 (2019/09/16) fromBase のパスの文字数も、正規パス名から作成。
713         * @og.rev 7.1.0.0 (2020/01/20) fromLen属性で、CanonicalFileで区切り文字'¥'が消えるため、そのため、PARENTに'¥'が残る現象の対応。
714         *
715         * @param    base PARENT列から、fromBase指定のパスを削除した相対パスを作成
716         */
717        public void setFromBase( final String base ) {
718                final String fromBase = nval( getRequestParameter( base ),null );
719                if( fromBase != null ) {
720                        // 7.0.5.0 (2019/09/16) fromBase のパスの文字数も、正規パス名から作成。
721//                      fromLen = fromBase.length();
722                        try {
723                                fromLen = new File(fromBase).getCanonicalPath().length();               // 7.0.5.0 (2019/09/16)
724                                // 7.1.0.0 (2020/01/20)
725                                final char ch = fromBase.charAt( fromBase.length()-1 );
726                                if( ch == '\\' || ch == '/' ) { fromLen++; }                                    // getCanonicalPathでは、最後の区切り記号が消える
727                        }
728                        catch( final IOException ex ) {
729                                final String errMsg = "fromBaseの正式なファイル名の取得に失敗しました。[" + base + "]"
730                                                        + CR + ex.getMessage();
731                                throw new HybsSystemException( errMsg,ex );
732                        }
733                }
734        }
735
736        /**
737         * 【TAG】ファイルの拡張子を除いた名前部分のみの値で行います(初期値:false)。
738         *
739         * @og.tag
740         * ファイル検索の値を、ファイルの拡張子を取り除いた値のみで、作成します。
741         * 初期値は、false (拡張子付きファイル名でリスト) です。
742         *
743         * @og.rev 7.2.6.0 (2020/06/30) nameOnly 属性 を追加します。
744         *
745         * @param       flag ファイルの拡張子を除いた名前部分のみで作成するかどうか [true:名前部分のみ/false:ファイル名]
746         */
747        public void setNameOnly( final String flag ) {
748                nameOnly = nval( getRequestParameter( flag ),nameOnly );
749        }
750
751        /**
752         * 【TAG】システム定数でクラウド設定されていても、クラウド環境を使用しない場合、trueを指定します(初期値:false)。
753         *
754         * @og.tag
755         * クラウド設定は、システム定数の『CLOUD_TARGET』と『CLOUD_BUCKET』の設定で自動的に使用しますが、
756         * どうしてもローカルでのみ使いたい場合は、この属性を true に設定します。
757         * 標準はfalse:設定どおりとなります。
758         *
759         * true/false以外を指定した場合はfalse扱いとします。
760         *
761         * @og.rev 8.0.1.0 (2021/10/29) useLocal 属性を追加。
762         *
763         * @param flag ローカル環境のみ [true:ローカルのみ/false:設定どおり]
764         */
765        public void setUseLocal( final String flag ) {
766                useLocal = nval( getRequestParameter( flag ),useLocal );
767        }
768
769        /**
770         * FileFilterオブジェクトをセットします。
771         * これは、BODY 部に登録した、FileWhereタグによって設定された
772         * ファイルフィルターです。
773         *
774         * @param       filter  オブジェクト
775         */
776        protected void setFileFilter( final FileFilter filter ) {
777                this.filter = filter;
778        }
779
780        /**
781         * このオブジェクトの文字列表現を返します。
782         * 基本的にデバッグ目的に使用します。
783         *
784         * @return このクラスの文字列表現
785         * @og.rtnNotNull
786         */
787        @Override
788        public String toString() {
789                return ToString.title( this.getClass().getName() )
790                                .println( "VERSION"                     ,VERSION                )
791                                .println( "multi"                       ,multi                  )
792                                .println( "level"                       ,level                  )
793                                .println( "from"                        ,from                   )
794                                .println( "orderBy"                     ,orderBy                )
795                                .println( "desc"                        ,desc                   )
796                                .println( "addClms"                     ,Arrays.toString( addClms )     )
797                                .println( "defClms"                     ,Arrays.toString( defClms )     )
798                                .println( "fileType"            ,fileType               )
799                                .println( "useWritable"         ,useWritable    )
800                                .println( "useMD5"              ,useMD5                 )
801                                .println( "useText"                     ,useText                )
802                                .println( "useUpdateClms"       ,useUpdateClms  )
803                                .println( "addFrom"                     ,addFrom                )
804                                .println( "filter"                      ,filter                 )                               // 6.8.0.0 (2017/06/02)
805                                .fixForm().toString()
806                        + CR
807                        + super.toString() ;
808        }
809}