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