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 static org.opengion.fukurou.util.StringUtil.nval;
019
020import java.io.File;
021import java.io.IOException;
022import java.util.List;
023import java.util.ArrayList;
024
025import javax.servlet.http.HttpServletRequest;
026
027import org.opengion.fukurou.util.StringUtil;
028import org.opengion.hayabusa.common.HybsSystem;
029import org.opengion.hayabusa.common.HybsSystemException;
030import org.opengion.hayabusa.db.DBColumn;
031import org.opengion.hayabusa.db.DBTableModel;
032import org.opengion.hayabusa.db.DBTableModelUtil;
033import org.opengion.hayabusa.servlet.MultipartRequest;
034import org.opengion.hayabusa.servlet.UploadedFile;
035
036/**
037 * クライアントのファイルをサーバーにアップロードするタグです。
038 *
039 * アップロード後の属性は、DBTableModel に格納することにより、通常のデータと
040 * 同様の取り出し方が可能です。
041 * また、通常のファイルアップロード時の、form で使用する、enctype="multipart/form-data"
042 * を指定した場合の、他のリクエスト情報も、{@XXXX} 変数で取り出すことが可能です。
043 *
044 * この upload タグでは、アップロード後に、指定のファイル名に変更する機能があります。
045 * file 登録ダイアログで指定した name に、"_NEW" という名称を付けたリクエスト値を
046 * ファイルのアップロードと同時に送信することで、この名前にファイルを付け替えます。
047 * また、アップロード後のファイル名は、name 指定の名称で、取り出せます。
048 * クライアントから登録したオリジナルのファイル名は、name に、"_ORG" という名称
049 * で取り出すことが可能です。
050 *
051 * 通常では、これらのパラメータを、RequestAttribute 変数にセットしますので、{@XXXX}で
052 * 取り出すことが可能になります。さらに、"KEY","VALUE","ISFILE" のカラムを持った、
053 * DBTableModel にセットします。
054 *
055 * 新機能として、columns を指定する事で、columns のカラムを持つ DBTableModel にセットします。
056 * その場合は、カラム名_01 ~ カラム名_99 のように、アンダーバーで列データとなるキーを定義してください。
057 * アンダーバーがない場合は、カラムだけ作成されます。カラム名と同じリクエストがあれば、
058 * すべてのレコードに同じ値がセットされます。
059 *
060 * 新ファイル名に拡張子が設定されていない場合は、オリジナルファイル名の拡張子をセットします。
061 *
062 * HTML5 の type="file" 時の multiple 属性(アップロードファイルの複数選択機能)に対応します。(5.7.1.1 (2013/12/13))
063 * その場合は、新しいファイル名への変更はできません。オリジナルのファイル名でアップロードされます
064 *
065 * 5.7.1.2 (2013/12/20) zip 対応
066 * filename 属性に、".zip" の拡張子のファイル名を指定した場合は、アップロードされた一連のファイルを
067 * ZIP圧縮します。これは、アップロード後の処理になります。
068 * ZIP圧縮のオリジナルファイルは、そのまま残ります。
069 * なお、ZIPファイルは、useBackup属性を true に設定しても、無関係に、上書きされます。
070 *
071 * 5.7.4.3 (2014/03/28) filename 属性のリクエスト変数対応
072 * filename 属性のみ、{@XXXX} のリクエスト変数が使えるようにします。
073 * 他のパラメータでは使えません。
074 * これは、multipart/form-data のリクエストでは、パートの分解処理をしないと、リクエスト変数が
075 * 拾えない為、リクエスト変数は、この、upload タグ以降でのみ利用可能でした。
076 * zip対応と関連付けて、filename 属性のみ、利用できるように、MultipartRequest 側の処理に組み込みます。
077 *
078 * 5.7.6.3 (2014/05/23) アップロードファイルのCSVセット
079 * 個々に指定したアップロードファイル名は、XXX_NEW や XXX_ORG で取得できますが、
080 * HTML5 の multiple 属性使用時や、アップロードされたファイルを一連で処理したい場合に
081 * ファイル名を、CSV形式で取り出せるようにします。
082 * キーは、共通で、UPLOAD_FILES とします。
083 *
084 * @og.formSample
085 * ●形式:<og:upload fileURL="…" maxPostSize="…" />
086 * ●body:なし
087 *
088 * ●Tag定義:
089 *   <og:upload
090 *       fileURL            【TAG】ファイルをアップロードするディレクトリを指定します (初期値:FILE_URL[=filetemp/])
091 *       filename           【TAG】(通常使いません)ファイルを作成するときのファイル名をセットします
092 *       maxPostSize        【TAG】最大転送サイズ(Byte)を指定します(初期値:10485760) 0,またはマイナスで無制限です。
093 *       scope              【TAG】キャッシュする場合のスコープ[request/page/session/applicaton]を指定します(初期値:session)
094 *       tableId            【TAG】(通常使いません)sessionから所得する DBTableModelオブジェクトの ID
095 *       columns            【TAG】DBTableModel作成時に、指定のカラムの"_01"~"_99"の添え字をレコードとして作成します。
096 *       useBackup          【TAG】ファイルアップロード時に、すでに同名のファイルが存在した場合に、バックアップ処理(renameTo)するかどうか[true/false]を指定します(初期値:false)
097 *       language           【TAG】タグ内部で使用する言語コード[ja/en/zh/…]を指定します
098 *       debug              【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false)
099 *   />
100 *
101 * ●使用例 :
102 * 【query.jsp】
103 *       <form method="POST" action="result.jsp" enctype="multipart/form-data" target="RESULT">
104 *       <table summary="layout" >
105 *       <tr><og:input type="text" name="submitter" value="{@USER.JNAME}" size="20" lbl="MSG0014" /></tr>
106 *       <tr>
107 *           <og:input type="file" name="file_01"      size="30" lbl="MSG0015" />
108 *           <og:input             name="file_01_NEW"  size="10" lbl="FILENAME" />
109 *       </tr><tr>
110 *           <og:input type="file" name="file_02"      size="30" lbl="MSG0015" />
111 *           <og:input             name="file_02_NEW"  size="10" lbl="FILENAME" />
112 *       </tr><tr>
113 *           <og:input type="file" name="file_03"      size="30" lbl="MSG0015" />
114 *           <og:input             name="file_03_NEW"  size="10" lbl="FILENAME" />
115 *       </tr><tr>
116 *           <og:column name="writable"     value="false"  />
117 *       </tr>
118 *       </table>
119 *
120 * 【result.jsp】
121 *       <og:upload
122 *           fileURL     = "{@USER.ID}"
123 *       />
124 *       <br />
125 *       <og:message lbl="MSG0003" comment="ファイルの登録が完了しました。" />
126 *
127 *       <og:view
128 *           command      = "NEW"
129 *           viewFormType = "HTMLTable"
130 *           writable     = "{@writable}"
131 *       />
132 *
133 *       <table>
134 *       <tr><og:input name="submitter"   value="{@submitter}"   /></tr>
135 *       <tr><og:input name="writable"    value="{@writable}"    /></tr>
136 *       <tr><og:input name="directory"   value="{@directory}"   /></tr>
137 *       <tr><og:input name="file_01"     value="{@file_01}"     /></tr>
138 *       <tr><og:input name="file_01_NEW" value="{@file_01_NEW}" /></tr>
139 *       <tr><og:input name="file_01_ORG" value="{@file_01_ORG}" /></tr>
140 *       <tr><og:input name="file_02"     value="{@file_02}"     /></tr>
141 *       <tr><og:input name="file_02_NEW" value="{@file_02_NEW}" /></tr>
142 *       <tr><og:input name="file_02_ORG" value="{@file_02_ORG}" /></tr>
143 *       <tr><og:input name="file_03"     value="{@file_03}"     /></tr>
144 *       <tr><og:input name="file_03_NEW" value="{@file_03_NEW}" /></tr>
145 *       <tr><og:input name="file_03_ORG" value="{@file_03_ORG}" /></tr>
146 *       </table>
147 *
148 * 【result.jsp】
149 *       <og:upload
150 *           fileURL     = "{@USER.ID}"
151 *           columns     = "submitter,file"
152 *       />
153 *       <br />
154 *       <og:message lbl="MSG0003" comment="ファイルの登録が完了しました。" />
155 *
156 *       <og:view
157 *           command      = "NEW"
158 *           viewFormType = "HTMLTable"
159 *           writable     = "{@writable}"
160 *       />
161 *
162 * @og.group ファイル入力
163 *
164 * @version  4.0
165 * @author       Kazuhiko Hasegawa
166 * @since    JDK5.0,
167 */
168public class FileUploadTag extends CommonTagSupport {
169        //* このプログラムのVERSION文字列を設定します。   {@value} */
170        private static final String VERSION = "5.7.6.3 (2014/05/23)" ;
171
172        private static final long serialVersionUID = 576320140523L ;
173
174        /** 5.7.6.3 (2014/05/23) アップロードファイルのCSVセットのキー */
175        public static final String UPLOAD_FILES = "UPLOAD_FILES" ;
176
177        // 3.5.2.0 (2003/10/20) カラム名に、ISFILEを追加。
178        private static final String[] names = new String[] { "KEY","VALUE","ISFILE" };
179        private static final String   ENCODE = "UTF-8";                 // 3.5.2.0 (2003/10/20) 廃止
180        private String  fileURL         = HybsSystem.sys( "FILE_URL" );
181        private String  filename    = null;                                             // 3.5.4.2 (2003/12/15)
182
183        private int     maxPostSize = 10*1024*1024;                             // 最大ファイル容量  10MB
184        private String  tableId         = HybsSystem.TBL_MDL_KEY ;
185
186        // 5.6.5.2 (2013/06/21) DBTableModel作成時に、指定のカラムの"_01"~"_99"の添え字をレコードとして作成します。
187        private String          columns         = null;
188        // 5.6.5.3 (2013/06/28) ファイルアップロード時に、すでに同名のファイルが存在した場合に、バックアップ処理(renameTo)するかどうか[true/false]を指定します(初期値:false)
189        private boolean useBackup       = false;
190
191        /**
192         * Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
193         *
194         * @og.rev 2.2.0.0 (2002/12/17) 中国語(国際化)対応 エンコードの取得方法変更
195         * @og.rev 3.1.1.2 (2003/04/04) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。
196         * @og.rev 3.1.3.0 (2003/04/10) UTF-8 決め打ちのエンコード情報を取得する。
197         * @og.rev 3.5.2.0 (2003/10/20) scope 属性を追加。
198         * @og.rev 3.5.4.2 (2003/12/15) ファイル名を指定できるようにします。
199         * @og.rev 3.6.0.8 (2004/11/19) DBTableModel をセーブする時に、トランザクションチェックを行います。
200         * @og.rev 3.7.1.1 (2005/05/23) フォルダがない場合は、複数階層分のフォルダを自動で作成します。
201         * @og.rev 3.8.1.3A (2006/01/30) 新ファイル名にオリジナルファイル名の拡張子をセットします
202         * @og.rev 5.3.7.0 (2011/07/01) エラーメッセージ内容変更
203         * @og.rev 5.6.5.2 (2013/06/21) columns 属性の追加
204         * @og.rev 5.6.5.3 (2013/06/28) useBackup 属性の追加
205         *
206         * @return      後続処理の指示
207         */
208        @Override
209        public int doEndTag() {
210                debugPrint();           // 4.0.0 (2005/02/28)
211                startQueryTransaction( tableId );               // 3.6.0.8 (2004/11/19)
212                HttpServletRequest request = (HttpServletRequest)getRequest();
213
214                try {
215                        String directory = HybsSystem.url2dir( fileURL );
216                        File dir = new File(directory);
217                        if( ! dir.exists() && ! dir.mkdirs() ) {
218                                String errMsg = "ディレクトリの作成に失敗しました。[" + directory + "]";
219                                throw new HybsSystemException( errMsg );
220                        }
221
222                        // 3.8.1.3A (2006/01/30) 新ファイル名にオリジナルファイル名の拡張子をセットします
223                        // 5.6.5.3 (2013/06/28) useBackup 属性の追加
224                        MultipartRequest multi = new MultipartRequest( request,directory,maxPostSize,ENCODE,filename,useBackup );
225                        // 5.6.5.2 (2013/06/21) columns 属性の追加
226                        DBTableModel table = null;
227                        if( columns == null ) {                                         // 5.6.5.2 (2013/06/21) columns 属性の追加
228                                table = makeDBTable( multi );
229                        }
230                        else {
231                                table = makeDBTableFromClms( multi );
232                        }
233
234                        // 3.5.2.0 (2003/10/20) scope 属性を追加。
235                        // 3.6.0.8 (2004/11/19) トランザクションチェックを行います。
236                        if( ! commitTableObject( tableId, table ) ) {
237                                jspPrint( "FileUploadTag Query処理が割り込まれました。DBTableModel は登録しません。" );
238                                return SKIP_PAGE;
239                        }
240
241                } catch(IOException ex) {
242                        String errMsg = "ファイル登録エラー!"
243                                + ex.getMessage() + HybsSystem.CR       // 5.3.7.0 (2011/07/01) errMsg 修正
244                                + "(" + toString() + HybsSystem.CR
245                                + "FileURL=" + fileURL + ")";
246                        throw new HybsSystemException( errMsg,ex );             // 3.5.5.4 (2004/04/15) 引数の並び順変更
247                }
248
249                return EVAL_PAGE ;
250        }
251
252        /**
253         * タグリブオブジェクトをリリースします。
254         * キャッシュされて再利用されるので、フィールドの初期設定を行います。
255         *
256         * @og.rev 2.0.0.4 (2002/09/27) カスタムタグの release() メソッドを、追加
257         * @og.rev 3.0.1.1 (2003/03/06) columns を廃止
258         * @og.rev 3.1.1.2 (2003/04/04) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。
259         * @og.rev 3.5.4.2 (2003/12/15) ファイル名を指定できるようにします。
260         * @og.rev 5.6.5.2 (2013/06/21) columns 属性の追加
261         * @og.rev 5.6.5.2 (2013/06/21) useBackup 属性の追加
262         *
263         */
264        @Override
265        protected void release2() {
266                super.release2();
267                fileURL                 = HybsSystem.sys( "FILE_URL" );
268                maxPostSize             = 10*1024*1024;                         // 最大ファイル容量  10MB
269                tableId                 = HybsSystem.TBL_MDL_KEY ;
270                filename                = null;                                         // 3.5.4.2 (2003/12/15)
271                columns                 = null;                                         // 5.6.5.2 (2013/06/21)
272                useBackup               = false;                                        // 5.6.5.3 (2013/06/28) 
273        }
274
275        /**
276         * ファイルアップロードの実行結果を DBTableModel に記述します。
277         *
278         * ここでは、"KEY","VALUE","ISFILE" のカラムに対して、値を設定していきます。
279         * 同時に、RequestAttribute 変数に、これらの値をセットすることで、
280         * {@XXXX} で値が取り出せる様にしています。
281         *
282         * @og.rev 2.2.0.0 (2002/12/17) 中国語(国際化)対応 エンコードの取得方法変更
283         * @og.rev 3.0.1.1 (2003/03/06) request 情報から{@XXXX} で値が取り出せる様に修正。
284         * @og.rev 3.5.2.0 (2003/10/20) カラム名(KEY,VALUE)に ISFILE を追加
285         * @og.rev 3.5.6.5 (2004/08/09) MultipartRequest 変更に伴なう修正(Enum変更、元ファイル名取得)
286         * @og.rev 3.5.6.6 (2004/08/23) 上記変更時のバグ修正。
287         * @og.rev 3.5.6.6 (2004/08/23) 元ファイルのキーを、XXXX_ORG にします。
288         * @og.rev 4.0.0.0 (2007/10/12) テーブルモデルの登録方法を変更
289         * @og.rev 5.3.2.0 (2011/02/01) チェック行のパラメーターはint配列側に変換して復元する。パラメーター名を保存する。
290         * @og.rev 5.4.4.2 (2012/02/03) CommonTagSupportと同様のチェックボックス判定を行う
291         * @og.rev 5.7.1.1 (2013/12/13) HTML5 ファイルアップロードの複数選択(multiple)対応
292         * @og.rev 5.7.1.2 (2013/12/20) 5.7.1.2 (2013/12/20) zip対応で、UploadedFile のメソッド変更
293         * @og.rev 5.7.3.0 (2014/02/07) zip対応の修正で、取得ファイル名が異なっていた。
294         * @og.rev 5.7.6.3 (2014/05/23) アップロードファイルのCSVセット
295         *
296         * @param        multi     MultipartRequestオブジェクト
297         *
298         * @return       テーブルモデル
299         */
300        private DBTableModel makeDBTable( final MultipartRequest multi ) {
301
302                DBTableModel table = DBTableModelUtil.newDBTable();
303
304                table.init( names.length );
305
306                for( int i=0; i<names.length; i++ ) {
307                        DBColumn dbColumn = getDBColumn( names[i] );
308                        table.setDBColumn( i,dbColumn );
309                }
310
311                String[] values ;               // 4.0.0.0 (2007/10/12)
312                List<String> prmNames = new ArrayList<String>();
313
314                // 5.7.6.3 (2014/05/23) アップロードファイルのCSVセット
315                StringBuilder buf = new StringBuilder();
316
317                // 5.7.1.1 (2013/12/13) HTML5 ファイルアップロードの複数選択(multiple)対応
318                UploadedFile[] files = multi.getUploadedFile();
319                for( int i=0; i<files.length; i++ ) {
320                        String name = files[i].getName();                                       // multiple対応では、キーがかぶることがある。
321                        String val  = files[i].getUploadFile().getName();       // 5.7.3.0 (2014/02/07) 取得ファイル名が異なっていた。
322
323                        // 5.7.6.3 (2014/05/23) アップロードファイルのCSVセット
324                        if( i==0 ) { buf.append( val ); }
325                        else { buf.append( "," ).append( val ); }                       // カンマ結合で、最初だけ結合しない。
326
327                        // "KEY","VALUE","ISFILE" の順にデータを作成します。
328                        values = new String[] { name, val, "1" };
329                        table.addColumnValues( values );
330                        setRequestAttribute( name,val );
331                        prmNames.add( name );                           // 5.7.1.1 (2013/12/13) List に設定する。
332
333                        String orgName = name + "_ORG" ;
334                        val  = files[i].getOriginalFileName();  // 注意:取得は、送信名
335
336                        // "KEY","VALUE","ISFILE" の順にデータを作成します。
337                        values = new String[] { orgName, val, "2" };
338                        table.addColumnValues( values );
339                        setRequestAttribute( orgName,val );
340                }
341
342                // 5.7.6.3 (2014/05/23) アップロードファイルのCSVセット
343                setRequestAttribute( UPLOAD_FILES,buf.toString() );
344
345                // "KEY","VALUE","ISFILE" の順にデータを作成します。
346                values = new String[] { "directory", fileURL, "0" };
347                table.addColumnValues( values );
348                setRequestAttribute( "directory",fileURL );
349
350                String[] params = multi.getParameterNames();
351                for( int i=0; i<params.length; i++ ) {
352                        String name = params[i];
353                        // 5.3.2.0 (2011/02/01) チェック行のパラメーターはint配列側に変換
354                        if ( HybsSystem.ROW_SEL_KEY.equals( name ) ) {
355                                setRequestAttribute( name,multi.getIntParameters(name) );
356                        }
357                        else {
358                                // 5.6.5.2 (2013/06/21) チェックボックス配列の値取得を考慮した、MultipartRequest のパラメータ値取得
359                                String val = getParamVal( name,multi );
360
361                                values = new String[] { name, val, "0" };
362                                table.addColumnValues( values );
363                                setRequestAttribute( name,val );
364                                prmNames.add( name );                           // 5.7.1.1 (2013/12/13) List に設定する。
365                        }
366                }
367
368                // 5.3.2.0 (2011/02/01) パラメーター名を保存する。
369                // 5.7.1.1 (2013/12/13) List に設定する。
370            setParameterNames( prmNames.toArray( new String[prmNames.size()] ) );
371
372                return table ;
373        }
374
375        /**
376         * ファイルアップロードの実行結果を 横持の DBTableModel に記述します。
377         * 
378         * この処理は、columns 属性を設定した場合のみとします。
379         * 
380         * DBTableModel作成時に、指定のカラムの"_01"~"_99"の添え字をレコードとして作成します。
381         * 現状は、"KEY","VALUE","ISFILE" のカラムに、データを縦持ちで作成しています。
382         * これを、横持で作成しますが、カラムの末尾に、"_01"~"_99" までの添え字を
383         * 持つ場合は、これをレコードと認識させます。
384         * 添え字がない場合は、カラムだけ作成されます。カラム名と同じリクエストがあれば、
385         * すべてのレコードに同じ値がセットされます。
386         *
387         * @og.rev 5.6.5.2 (2013/06/21) 新規作成
388         * @og.rev 5.6.6.1 (2013/07/12) 添え字がない場合の処理の見直し
389         * @og.rev 5.7.1.2 (2013/12/20) zip対応で、UploadedFile のメソッド変更
390         * @og.rev 5.7.3.0 (2014/02/07) zip対応の修正で、取得ファイル名が異なっていた。
391         * @og.rev 5.7.6.3 (2014/05/23) アップロードファイルのCSVセット
392         *
393         * @param        multi     MultipartRequestオブジェクト
394         *
395         * @return       テーブルモデル
396         */
397        private DBTableModel makeDBTableFromClms( final MultipartRequest multi ) {
398
399                DBTableModel table = DBTableModelUtil.newDBTable();
400
401                String[] clmNames = columns.split( "," );
402
403                table.init( clmNames.length );
404
405                // 値配列(1行分)
406                String[] rowVal = new String[clmNames.length];
407
408                // 5.7.1.1 (2013/12/13) HTML5 ファイルアップロードの複数選択(multiple)対応
409                UploadedFile[] files = multi.getUploadedFile();
410
411                List<String> prmNames = new ArrayList<String>();
412
413                for( int i=0; i<clmNames.length; i++ ) {
414                        String clm = clmNames[i] ;
415                        DBColumn dbColumn = getDBColumn( clm );
416                        table.setDBColumn( i,dbColumn );
417
418                        // 先に、カラム名と一致するパラメータを初期値としてセットしておきます。
419                        String val = getParamVal( clm,multi );
420
421                        // 5.6.6.1 (2013/07/12) ファイル名も同様に、あれば初期値セットしておきます。
422                        if( val == null ) {
423                                // 5.7.1.1 (2013/12/13) HTML5 ファイルアップロードの複数選択(multiple)対応
424                                for( int j=0; j<files.length; j++ ) {
425                                        String nm = files[j].getName();
426                                        if( clm.equalsIgnoreCase( nm ) ) {
427                                                val = files[i].getUploadFile().getName();       // 5.7.3.0 (2014/02/07) 取得ファイル名が異なっていた。
428                                                break;                                                                          // 5.7.6.3 (2014/05/23) たぶん有ったほうが良い。
429                                        }
430                                }
431                        }
432                        // 5.7.1.1 (2013/12/13) getFilesystemName() の中に、newFile が null の場合は、original を返す処理がある。
433                        rowVal[i] = ( val == null ) ? "" : val ;
434                }
435
436                // 5.7.6.3 (2014/05/23) アップロードファイルのCSVセット
437                StringBuilder buf = new StringBuilder();
438
439                for( int i=0; i<files.length; i++ ) {
440                        String name = files[i].getName();
441                        // 5.6.6.1 (2013/07/12) 添え字がない場合の処理の見直し。先にレコードを作成
442                        String[] values = new String[clmNames.length];
443                        System.arraycopy( rowVal,0,values,0,values.length );            // 行にセットするに当たり、rowVal を values にコピーしておく。
444
445                        // ファイル名を Attribute で使えるようにセットしておく。
446                        String fval = files[i].getUploadFile().getName();       // 5.7.3.0 (2014/02/07) 取得ファイル名が異なっていた。
447                        setRequestAttribute( name,fval );
448                        prmNames.add( name );                                                           // 5.7.1.1 (2013/12/13) List に設定する。
449
450                        // 5.7.6.3 (2014/05/23) アップロードファイルのCSVセット
451                        if( i==0 ) { buf.append( fval ); }
452                        else { buf.append( "," ).append( fval ); }                      // カンマ結合で、最初だけ結合しない。
453
454                        String orgName = name + "_ORG" ;
455                        String oval  = files[i].getOriginalFileName();  // 注意:取得は、送信名
456                        setRequestAttribute( orgName,oval );
457
458                        // ファイルのキーを元に、添え字を検索します。
459                        int adrs = name.lastIndexOf( '_' );             // 添え字は、'_' で区切られます。
460                        // 5.6.6.1 (2013/07/12) 添え字がない場合の処理の見直し。後続処理を行う。
461                        if( adrs > 0 ) {
462                                String fnm = name.substring( 0,adrs );  // ファイル名(分割後)
463                                String sub = name.substring( adrs );    // 添え字(アンダーバー含む)
464
465                                // カラム名で検索しながら、レコード単位になるようにセットしていきます。
466                                for( int j=0; j<clmNames.length; j++ ) {
467                                        String clm = clmNames[j] ;
468                                        String nm  = null;
469                                        String val = null;
470
471                                        if( fnm.equalsIgnoreCase( clm ) ) {             // ファイル名カラム(_NEWファイル名も、この値にすでに変わっている)
472                                                val = fval;
473                                        }
474                                        else if( ( fnm + "_ORG" ).equalsIgnoreCase( clm ) ) {           // 元ファイル名カラム
475                                                val  = oval;
476                                        }
477                                        else if( ( fnm + "_NEW" ).equalsIgnoreCase( clm ) ) {           // 新ファイル名カラム
478                                                nm   = name + "_NEW" ;
479                                                val  = multi.getParameter( nm );
480                                        }
481                                        else {
482                                                nm  = clmNames[j] + sub;                                        // sub は、アンダーバー含む添え字
483                                                // 5.6.5.2 (2013/06/21) チェックボックス配列の値取得を考慮した、MultipartRequest のパラメータ値取得
484                                                val = getParamVal( nm,multi );
485                                        }
486                                        if( val != null ) { values[j] = val ; }         // val が null でないときのみセットします。
487                                }
488                        }
489                        table.addColumnValues( values );
490                }
491                // 5.7.6.3 (2014/05/23) アップロードファイルのCSVセット
492                setRequestAttribute( UPLOAD_FILES,buf.toString() );
493
494                // Attribute で使えるようにセットしておく。
495                setRequestAttribute( "directory",fileURL );
496
497                // Attribute で使えるようにセットしておく。
498                String[] params = multi.getParameterNames();
499                for( int i=0; i<params.length; i++ ) {
500                        String name = params[i];
501                        // 5.3.2.0 (2011/02/01) チェック行のパラメーターはint配列側に変換
502                        if ( HybsSystem.ROW_SEL_KEY.equals( name ) ) {
503                                setRequestAttribute( name,multi.getIntParameters(name) );
504                        }
505                        else {
506                                // 5.6.5.2 (2013/06/21) チェックボックス配列の値取得を考慮した、MultipartRequest のパラメータ値取得
507                                String val = getParamVal( name,multi );
508                                setRequestAttribute( name,val );
509                                prmNames.add( name );                           // 5.7.1.1 (2013/12/13) List に設定する。
510                        }
511                }
512
513                // 5.3.2.0 (2011/02/01) パラメーター名を保存する。
514                // 5.7.1.1 (2013/12/13) List に設定する。
515            setParameterNames( prmNames.toArray( new String[prmNames.size()] ) );
516
517                return table ;
518        }
519
520        /**
521         * チェックボックス配列の値取得を考慮した、MultipartRequest のパラメータ値取得
522         * 
523         * ここでは、、MultipartRequest のパラメータ値を取得します。
524         * 値の取得で、チェックボックス配列の場合は、取得した値が、"0" の場合のみ
525         * 配列でパラメータを取得し直し、"1" がないかどうか再度検索します。
526         * チェックボックスでは、チェック時の "1" と、チェックされなかった場合の、
527         * hidden の "0" の両方の値が配列としてリクエストされるケースがある為です。
528         *
529         * @og.rev 5.6.5.2 (2013/06/21) 新規作成
530         *
531         * @param        key       MultipartRequest のパラメータ取得のためのキー
532         * @param        multi     MultipartRequestオブジェクト
533         *
534         * @return       チェックボックス配列を考慮したパラメータ値
535         */
536        private String getParamVal( final String key , final MultipartRequest multi ) {
537                String val = multi.getParameter( key );
538
539                if( "0".equals(val) ){ // 5.4.4.2 チェックボックス配列対応。
540                        String[] vals = multi.getParameters( key );
541                        if( vals != null && vals.length > 1 ) {
542                                for( int j=0; j<vals.length; j++ ) {
543                                        if( "1".equals( vals[j] ) ) {
544                                                val = "1";
545                                                break;
546                                        }
547                                }
548                        }
549                }
550                return val ;
551        }
552
553        /**
554         * 【TAG】ファイルをアップロードするディレクトリを指定します
555         *              (初期値:FILE_URL[={@og.value org.opengion.hayabusa.common.SystemData#FILE_URL}])。
556         *
557         * @og.tag
558         * この属性で指定されるディレクトリに、アップロードされたファイルをセーブします。
559         * 指定方法は、通常の fileURL 属性と同様に、先頭が、'/' (UNIX) または、2文字目が、
560         * ":" (Windows)の場合は、指定のURLそのままのディレクトリに、そうでない場合は、
561         * fileURL = "{&#064;USER.ID}" と指定すると、FILE_URL 属性で指定のフォルダの下に、
562         * さらに、各個人ID別のフォルダを作成して、そこにセーブします。
563         * (初期値:システム定数のFILE_URL[={@og.value org.opengion.hayabusa.common.SystemData#FILE_URL}])。
564         *
565         * @og.rev 4.0.0.0 (2005/01/31) StringUtil.urlAppend メソッドの利用
566         * @og.rev 4.0.0.0 (2007/11/20) 指定されたディレクトリ名の最後が"\"or"/"で終わっていない場合に、"/"を付加する。
567         * @og.rev 5.7.1.1 (2013/12/13) リクエスト変数が使えないエラーを表示する。
568         * @og.rev 5.7.4.3 (2014/03/28) リクエスト変数が使えない事のチェックを行う。
569         *
570         * @param       url ファイルURL
571         * @see         org.opengion.hayabusa.common.SystemData#FILE_URL
572         */
573        public void setFileURL( final String url ) {
574                String furl = nval( getRequestParameter( url ),null );
575                if( furl != null ) {
576                        char ch = furl.charAt( furl.length()-1 );
577                        if( ch != '/' && ch != '\\' ) { furl = furl + "/"; }
578                        fileURL = StringUtil.urlAppend( fileURL,furl );
579                }
580                else {
581                        chckReqParam( url,"fileURL" );          // 5.7.4.3 (2014/03/28) リクエスト変数が使えない事のチェック
582                }
583        }
584
585        /**
586         * 【TAG】最大転送サイズ(Byte)を指定します(初期値:10485760)。
587         *
588         * @og.tag
589         * 最大転送サイズを指定します。初期値は、10*1024*1024 = 10MB です。
590         * 指定は、Byte 単位で指定します。
591         * 0,またはマイナスを指定することで、制限チェックを外す(=無制限)事ができます。
592         *
593         * @og.rev 3.0.1.1 (2003/03/06) maxPostSize の設定バグ修正。
594         * @og.rev 5.6.5.3 (2013/06/28) コメント追加(0,またはマイナスで無制限)
595         * @og.rev 5.7.4.3 (2014/03/28) リクエスト変数が使えない事のチェックを行う。
596         *
597         * @param       maxPS 最大転送サイズ
598         */
599        public void setMaxPostSize( final String maxPS ) {
600                maxPostSize = nval( getRequestParameter( maxPS ),maxPostSize );
601
602                chckReqParam( maxPS,"maxPostSize" );            // 5.7.4.3 (2014/03/28) リクエスト変数が使えない事のチェック
603        }
604
605        /**
606         * 【TAG】(通常は使いません)結果のDBTableModelを、sessionに登録するときのキーを指定します
607         *              (初期値:HybsSystem#TBL_MDL_KEY[={@og.value org.opengion.hayabusa.common.HybsSystem#TBL_MDL_KEY}])。
608         *
609         * @og.tag
610         * 検索結果より、DBTableModelオブジェクトを作成します。これを、下流のviewタグ等に
611         * 渡す場合に、通常は、session を利用します。その場合の登録キーです。
612         * query タグを同時に実行して、結果を求める場合、同一メモリに配置される為、
613         * この tableId 属性を利用して、メモリ空間を分けます。
614         *              (初期値:HybsSystem#TBL_MDL_KEY[={@og.value org.opengion.hayabusa.common.HybsSystem#TBL_MDL_KEY}])。
615         *
616         * @og.rev 5.7.4.3 (2014/03/28) リクエスト変数が使えない事のチェックを行う。
617         *
618         * @param       id sessionに登録する時の ID
619         */
620        public void setTableId( final String id ) {
621                tableId = nval( getRequestParameter( id ),tableId );
622
623                chckReqParam( id,"tableId" );           // 5.7.4.3 (2014/03/28) リクエスト変数が使えない事のチェック
624        }
625
626        /**
627         * 【TAG】(通常使いません)ファイルを作成するときのファイル名をセットします。
628         *
629         * @og.tag
630         * ファイルを作成するときのファイル名をセットします。
631         * これは、複数同時にアップロードファイル名を変更する時に使用できません。
632         * 通常、アップロードされたファイル名を指定する場合、アップロードするinput タグの
633         * name 属性に指定する名称 + "_NEW" というリクエスト値を同時に送信すれば、
634         * 内部的に関連付けて、ファイル名を更新します。
635         * その場合、クライアントより指定したファイル名は、name属性+"_ORG" という
636         * リクエスト値として取得することが可能になります。
637         * name属性 には、最終的に設定されたファイル名がセットされています。
638         * いずれの値も、{&#064;name属性+"_ORG"} や、{&#064;name属性+"_NEW"}として、
639         * アップロードのオリジナルと変更後のファイル名を取得することが出来ます。
640         *
641         * 5.7.1.2 (2013/12/20) zip 対応
642         * filename 属性に、".zip" の拡張子のファイル名を指定した場合は、アップロードされた一連のファイルを
643         * ZIP圧縮します。これは、アップロード後の処理になります。
644         * ZIP圧縮のオリジナルファイルは、そのまま残ります。
645         * なお、ZIPファイルは、useBackup属性を true に設定しても、無関係に、上書きされます。
646         *
647         * 5.7.4.3 (2014/03/28) filename 属性のリクエスト変数対応
648         * filename 属性のみ、{&#064;XXXX} のリクエスト変数が使えるようにします。
649         * 他のパラメータでは使えません。
650         * これは、multipart/form-data のリクエストでは、パートの分解処理をしないと、リクエスト変数が
651         * 拾えない為、リクエスト変数は、この、upload タグ以降でのみ利用可能でした。
652         * zip対応と関連付けて、filename 属性のみ、利用できるように、MultipartRequest 側の処理に組み込みます。
653         *
654         * @og.rev 3.5.4.2 (2003/12/15) ファイル名を指定できるようにします。
655         * @og.rev 5.7.1.1 (2013/12/13) リクエスト変数が使えないエラーを表示する。
656         * @og.rev 5.7.4.3 (2014/03/28) リクエスト変数を使えるようにします。
657         *
658         * @param   fname ファイル名
659         */
660        public void setFilename( final String fname ) {
661                filename = nval( getReservedParameter( fname ),null );          // 予約語のみ処理をします。
662        }
663
664        /**
665         * 【TAG】DBTableModel作成時に、指定のカラムの"_01"~"_99"の添え字をレコードとして作成します。
666         *
667         * @og.tag
668         * 現状は、"KEY","VALUE","ISFILE" のカラムに、データを縦持ちで作成しています。
669         * これを、横持で作成しますが、カラムの末尾に、"_01"~"_99" までの添え字を
670         * 持つ場合は、これをレコードと認識させます。
671         * アンダーバーがない場合は、カラムだけ作成されます。カラム名と同じリクエストがあれば、
672         * すべてのレコードに同じ値がセットされます。
673         * この処理は、columns 属性を設定した場合のみとします。
674         *
675         * @og.rev 5.6.5.2 (2013/06/21) 新規作成
676         * @og.rev 5.7.4.3 (2014/03/28) リクエスト変数が使えない事のチェックを行う。
677         *
678         * @param   clms DBTableModel作成時のカラム列(カンマ区切り文字)
679         */
680        public void setColumns( final String clms ) {
681                columns = nval( getRequestParameter( clms ),columns );
682
683                chckReqParam( clms,"columns" );         // 5.7.4.3 (2014/03/28) リクエスト変数が使えない事のチェック
684        }
685
686        /**
687         * 【TAG】ファイルアップロード時に、すでに同名のファイルが存在した場合に、バックアップ処理(renameTo)するかどうか[true/false]を指定します(初期値:false)。
688         *
689         * @og.tag
690         * ファイルアップロード時に、アップロード先に、同名のファイルが存在した場合は、既存機能は、そのまま
691         * 置き換えていましたが、簡易バージョンアップ機能として、useBackup="true" を指定すると、既存のファイルを
692         * リネームして、バックアップファイルを作成します。
693         * バックアップファイルは、アップロードフォルダを基準として、_backup/ファイル名.拡張子_処理時刻のlong値.拡張子 になります。
694         * オリジナルのファイル名(拡張子付)を残したまま、"_処理時刻のlong値" を追加し、さらに、オリジナルの拡張子を追加します。
695         * バックアップファイルの形式は指定できません。
696         * 
697         * 初期値は、互換性を持たせるため、false です。
698         *
699         * @og.rev 5.6.5.3 (2013/06/28) 新規作成
700         * @og.rev 5.7.4.3 (2014/03/28) リクエスト変数が使えない事のチェックを行う。
701         *
702         * @param   flag ファイルアップロード時に、バックアップ処理(renameTo)するかどうか[true/false]を指定
703         */
704        public void setUseBackup( final String flag ) {
705                useBackup = nval( getRequestParameter( flag ),useBackup );
706
707                chckReqParam( flag,"useBackup" );               // 5.7.4.3 (2014/03/28) リクエスト変数が使えない事のチェック
708        }
709
710        /**
711         * リクエスト変数が使えない事のチェックを行います。
712         *
713         * upload では、enctype="multipart/form-data" のため、{&#064;XXXX}形式のパラメータが使えません。
714         * 5.7.4.3 (2014/03/28) から、filename のみ利用可能としたことで、同様に利用できると
715         * 勘違いするケースに対応する為、すべてのパラメータについてチェックを行います。
716         * ここでは、getRequestParameter( String ) の実行後、すぐに、isNull() 判定を行う事で、
717         * リクエスト変数の存在チェックを行う事にしています。
718         *
719         * @og.rev 5.7.4.3 (2014/03/28) リクエスト変数が使えない事のチェックを行う。
720         *
721         * @param   org 引数のオリジナル値
722         * @param   key エラーの発生した変数名
723         * @throws      HybsSystemException     パラメータが使用されていた場合
724         */
725        private void chckReqParam( final String org,final String key ) {
726                if( isNull() && org != null && org.contains( "{@" ) ) {
727                        String errMsg = "upload では、enctype=\"multipart/form-data\" のため、{@XXXX}形式のパラメータが使えません。"
728                                                                + HybsSystem.CR
729                                                                + "    " + key + "=[" + org + "]" ;
730                        throw new HybsSystemException( errMsg );                // リクエスト変数が使えないエラー
731                }
732        }
733
734        /**
735         * タグの名称を、返します。
736         * 自分自身のクラス名より、自動的に取り出せないため、このメソッドをオーバーライドします。
737         *
738         * @og.rev 4.0.0.0 (2005/01/31) 新規追加
739         *
740         * @return  タグの名称
741         */
742        @Override
743        protected String getTagName() {
744                return "upload" ;
745        }
746
747        /**
748         * このオブジェクトの文字列表現を返します。
749         * 基本的にデバッグ目的に使用します。
750         *
751         * @return このクラスの文字列表現
752         */
753        @Override
754        public String toString() {
755                return org.opengion.fukurou.util.ToString.title( this.getClass().getName() )
756                                .println( "VERSION"             ,VERSION        )
757                                .println( "names"               ,names          )
758                                .println( "ENCODE"              ,ENCODE         )
759                                .println( "fileURL"     ,fileURL        )
760                                .println( "filename"    ,filename       )
761                                .println( "maxPostSize" ,maxPostSize)
762                                .println( "tableId"     ,tableId        )
763                                .println( "columns"     ,columns        )                               // 5.6.5.2 (2013/06/21)
764                                .println( "useBackup"   ,useBackup      )                               // 5.6.5.3 (2013/06/28)
765                                .println( "Other..."    ,getAttributes().getAttribute() )
766                                .fixForm().toString() ;
767        }
768}