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