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.servlet; 017 018// import java.io.FileInputStream; 019import java.io.IOException; 020import java.io.InputStream; 021 022// import jakarta.mail.internet.MimeUtility; 023import jakarta.servlet.ServletException; 024import jakarta.servlet.ServletOutputStream; 025import jakarta.servlet.http.HttpServlet; 026import jakarta.servlet.http.HttpServletRequest; 027import jakarta.servlet.http.HttpServletResponse; 028 // import jakarta.servlet.http.HttpSession; // 2017/10/06 ADD bluemixのストレージに保存する場合 029 030import jakarta.servlet.annotation.WebServlet; // 7.3.0.0 (2021/01/06) 031 032import org.opengion.fukurou.security.HybsCryptography; 033import org.opengion.fukurou.system.Closer; 034import org.opengion.fukurou.util.KanaFilter; 035import org.opengion.fukurou.util.StringUtil; 036import org.opengion.hayabusa.common.HybsSystem; 037import org.opengion.hayabusa.common.HybsSystemException; 038import static org.opengion.fukurou.system.HybsConst.FS; // 6.1.0.0 (2014/12/26) refactoring 039 // import org.opengion.hayabusa.io.StorageAPI; // 5.9.25.0 (2017/10/06) クラウドストレージ対応 040 // import org.opengion.hayabusa.io.StorageAPIFactory; // 5.9.25.0 (2017/10/06) クラウドストレージ対応 041 042import org.opengion.fukurou.model.FileOperation; // 8.0.0.0 (2021/09/30) 043import org.opengion.hayabusa.io.HybsFileOperationFactory; // 8.0.0.0 (2021/09/30) 044 045/** 046 * サーバー管理ファイルをダウンロードする場合に使用する、サーブレットです。 047 * 048 * 引数(URL)に指定のファイルをサーバーからクライアントにダウンロードさせます。 049 * file には、サーバーファイルの物理アドレスを指定します。相対パスを使用する場合は、 050 * コンテキストルート(通常、Tomcatでは、G:\webapps\dbdef2\ など)からのパスと判断します。 051 * name には、クライアントに送信するファイル名を指定します。ファイル名を指定しない場合は、 052 * サーバーの物理ファイルのファイル名が代わりに使用されます。 053 * 日本語ファイル名は、すべて UTF-8化して処理します。指定するファイルに日本語が含まれる 054 * 場合は、URLエンコードを行ってください。変換前エンコードはリクエスト変数requestEncodingで指定可能で、標準はISO-8859-1です。 055 * 基本的にはContent-disposition属性として"attachment"が指定されます。 056 * 但し、引数に inline=true を指定することで、Content-disposition属性に"inline"が指定されます。 057 * また、システムリソースのUSE_FILEDOWNLOAD_CHECKKEYをtrueに指定することで、簡易的なチェックを 058 * 行うことができます。 059 * 具体的には、これを有効にすると、file属性の値から計算されるMD5チェックサムと、"key"という 060 * パラメーターに指定された値が一致した場合のみダウンロードが許可され、keyが指定されていない、 061 * または値が異なる場合はダウンロードエラーとなります。 062 * 063 * 一般的なサーブレットと同様に、デプロイメント・ディスクリプタ WEB-INF/web.xml に、 064 * servlet 要素と そのマッピング(servlet-mapping)を定義する必要があります。 065 * 066 * <servlet> 067 * <servlet-name>fileDownload</servlet-name> 068 * <servlet-class>org.opengion.hayabusa.servlet.FileDownload</servlet-class> 069 * </servlet> 070 * 071 * <servlet-mapping> 072 * <servlet-name>fileDownload</servlet-name> 073 * <url-pattern>/jsp/fileDownload</url-pattern> 074 * </servlet-mapping> 075 * 076 * 一般には、http://:ポート/システムID/jsp/fileDownload?file=サーバー物理ファイル&name=ファイル名 077 * 形式のURL でアクセスします。 078 * 079 * 5.9.25.0 (2017/10/06) 080 * クラウド上のPaaSでオブジェクトストレージを利用する際は以下のシステムリソースを設定してください。 081 * CLOUD_TARGET,CLOUD_BUCKET 082 * plugin/cloud内のクラスを利用してファイルアップロード(FileUploadタグ)、ダウンロード(FileDownloadサーブレット)をAPI経由で行います。 083 * プラグインが利用するjarファイルの配置は必要です。 084 * サーブレットに対して引数でstorage,bucketを与える事も可能です。 085 * 086 * 5.8.1.0 (2014/11/07) 087 * forwardでアクセスする場合はファイル名の文字コード変換が不要なため、useStringConvert=falseの 088 * 引数を与えてください。(falseとしない場合は日本語ファイル名等でエラーが発生します) 089 * 090 * 5.10.9.0 (2019/03/01) クラウドとバケット名を指定するリクエストパラメータを追加。 091 * 8.0.1.0 (2021/10/29) storageType → storage 、bucketName → bucket に変更 092 * storage (初期値:システムリソースのCLOUD_TARGET) 093 * bucket (初期値:システムリソースのCLOUD_BUCKET) 094 * 初期値は、システムリソース上のパラメータで初期値を指定できます。 095 * 強制的にローカルファイルにアクセスする場合は、"LOCAL" を指定してください。 096 * 097 * 7.2.7.0 (2020/08/07) 相対パスの場合の基準フォルダ 098 * 互換性確保のため、useBase リクエスト変数を true で飛ばすと、処理を実行します。 099 * 100 * 8.0.0.1 (2021/10/08) 101 * useStringConvert (エンコード変換対応のON/OFF指定)を廃止。 102 * 漢字ファイルのエンコードを指定すると、文字化けするので、何も行わない。 103 * RequestEncoding パラメータも、使用しません。 104 * 105 * @og.rev 3.8.1.1 (2005/11/21) 新規追加 106 * @og.rev 5.9.25.0 (2017/10/06) クラウド対応 107 * @og.rev 5.9.29.1 (2018/02/07) Azure対応追加 108 * @og.rev 5.10.9.0 (2019/03/01) oota クラウドストレージ対応を追加。(Fileクラスを拡張) 109 * @og.group その他機能 110 * 111 * @version 0.9.0 2000/10/17 112 * @author Kazuhiko Hasegawa 113 * @since JDK1.1, 114 */ 115@WebServlet( "/jsp/fileDownload" ) 116public class FileDownload extends HttpServlet { 117 private static final long serialVersionUID = 539020110901L ; 118 119 // 拡張子contentType対応テーブル 120 private static final String CONTENT_TYPE_TABLE[][] = { 121 {"jpg", "image/pjpeg" }, 122 {"gif", "image/gif" }, 123 {"txt", "text/plain" }, 124 // OpenDocument追加 125 {"xls", "application/vnd.ms-excel"}, 126 {"odp", "application/vnd.oasis.opendocument.presentation"}, // 4.3.5.5 (2008/03/08) 127 {"ods", "application/vnd.oasis.opendocument.spreadsheet"}, // 4.3.5.5 (2008/03/08) 128 {"odt", "application/vnd.oasis.opendocument.text"} // 4.3.5.5 (2008/03/08) 129 }; 130 private static final int EXTENTION = 0; 131 private static final int CONTENT_TYPE= 1; 132 133 private static final String KEY_STORAGE = "storage"; // 8.0.1.0 (2021/10/29) クラウドを指定するリクエストパラメータのキー 134 private static final String KEY_BUCKET = "bucket"; // 8.0.1.0 (2021/10/29) バケット名を指定するリクエストパラメータのキー 135 136 private final String fileURL = HybsSystem.sys( "FILE_URL" ); // 7.2.7.0 (2020/08/07) 相対パスの場合の基準フォルダ 137 138 /** 139 * デフォルトコンストラクター 140 * 141 * @og.rev 6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor. 142 */ 143 public FileDownload() { super(); } // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。 144 145 /** 146 * GET メソッドが呼ばれたときに実行します。 147 * 148 * 処理は、doPost へ振りなおしています。 149 * 150 * @param request HttpServletRequestオブジェクト 151 * @param response HttpServletResponseオブジェクト 152 * 153 * @og.rev 3.8.1.2 (2005/12/19) 半角カナ-全角カナ変換機能の追加 154 * 155 * @throws ServletException サーブレット関係のエラーが発生した場合、throw されます。 156 * @throws IOException 入出力エラーが発生したとき 157 */ 158 @Override 159 public void doGet( final HttpServletRequest request, final HttpServletResponse response ) 160 throws ServletException, IOException { 161 doPost( request,response ); 162 } 163 164 /** 165 * POST メソッドが呼ばれたときに実行します。 166 * 167 * file 引数の サーバー物理ファイルを、クライアントにストリーム化して返します。 168 * name 引数があれば、その名前のファイル名でクライアントがファイルセーブできるように 169 * します。name 引数がなければ、そのまま物理ファイル名が使用されます。 170 * サーバー物理ファイル名が、相対パスの場合、コンテキストルートに対する相対パスになります。 171 * (例:G:\webapps\dbdef2\ など) 172 * 173 * @og.rev 5.3.2.0 (2011/02/01) 日本語ファイル名が正しく処理できないバグを修正 174 * @og.rev 5.3.4.0 (2011/04/01) IEでファイルが正しくダウンロードできないバグを修正 175 * @og.rev 5.3.5.0 (2011/05/01) ファイルダウンロードチェックキー対応 176 * @og.rev 5.3.6.0 (2011/06/01) ファイルダウンロードはattachmentに変更(ダウンロードダイアログを出す) 177 * @og.rev 5.3.8.0 (2011/08/01) ファイル名指定でIEの場合、URLエンコードすると途中で切れるため(IE7のバグ)、Shift_JIS(WIndows-31J)で直接指定する。 178 * @og.rev 5.3.9.0 (2011/09/01) 引数にinline=trueを指定することで、インライン表示が出来るように対応 179 * @og.rev 5.7.1.2 (2013/12/20) 日本語ファイルのIE11対応(UA変更),msg ⇒ errMsg 変更 180 * @og.rev 5.8.1.0 (2014/11/07) forward時の文字コード変換不要対応 181 * @og.rev 5.9.25.0 (2017/10/06) クラウドストレージからダウンロード処理を追加対応 182 * @og.rev 5.9.27.0 (2017/12/01) Content-Lengthをhttpヘッダに追加しておく 183 * @og.rev 5.9.27.2 (2017/12/15) Edgeの日本語ファイル名対応 184 * @og.rev 6.8.4.2 (2017/12/25) エンコード変換対応のキー(fileDownloadサーブレットでエンコードをON/OFF指定に利用) 185 * @og.rev 5.9.28.1 (2018/01/19) safariの日本語ファイル名対応(RFC6266方式を併記) 186 * @og.rev 6.9.4.1 (2018/04/09) 日本語ファイル名で、旧方式を入れておくと、文字化けするので、はずします。 187 * @og.rev 5.10.12.4 (2019/06/21) エンコーディングを外部から指定可能にする 188 * @og.rev 7.2.7.0 (2020/08/07) 相対パスの場合の基準フォルダ(FILE_URL) 考慮 189 * @og.rev 8.0.0.1 (2021/10/08) USE_STR_CONV_KEY 廃止 190 * 191 * @param request HttpServletRequestオブジェクト 192 * @param response HttpServletResponseオブジェクト 193 * 194 * @throws ServletException サーブレット関係のエラーが発生した場合、throw されます。 195 * @throws IOException 入出力エラーが発生したとき 196 */ 197 @Override 198 public void doPost( final HttpServletRequest request, final HttpServletResponse response ) 199 throws ServletException, IOException { 200 201 // 2017/10/06 ADD 202 // クラウドストレージ指定 203 // final String storage = HybsSystem.sys( "CLOUD_TARGET"); 204 // クラウドストレージ指定フラグ 205 // final boolean cloudFlag = storage != null && storage.length() > 0; 206 207// // 8.0.0.1 (2021/10/08) cloud対応 … USE_STR_CONV_KEY 廃止 208// // 5.8.1.0 (2014/11/07) エンコード変換対応 209// // 6.8.4.2 (2017/12/25) エンコード変換対応で、Attribute も確認します。 210// // ややこしくなってますが、どちらかのキーワードで、"false" が指定された場合のみ、false になります。 211// final boolean useStrCnv = StringUtil.nval( request.getParameter( HybsSystem.USE_STR_CONV_KEY ), true ) && 212// StringUtil.nval( (String)request.getAttribute( HybsSystem.USE_STR_CONV_KEY ), true ) ; 213 214// // 5.10.12.4 (2019/06/21) 215// final String requestEncode = StringUtil.nval( (String)request.getAttribute( "RequestEncoding" ), "ISO-8859-1" ); 216 217 // クライアント側の文字エンコーディングをUTF-8に変換 218 // 5.8.1.0 (2014/11/07) 条件追加 219 String reqFilename = request.getParameter( "file" ); // 6.4.1.1 (2016/01/16) PMD refactoring. 220// // 8.0.0.1 (2021/10/08) cloud対応 … USE_STR_CONV_KEY 廃止 221// if( useStrCnv ){ 222// // reqFilename = new String( reqFilename.getBytes("ISO-8859-1"), "UTF-8" ); 223// reqFilename = new String( reqFilename.getBytes(requestEncode), "UTF-8" ); 224// } 225 226 // 2017/10/06 ADD reqFilenameの保存 227 // final String cloudFilename = reqFilename; 228 229 // 5.3.5.0 (2011/05/01) ファイルダウンロードチェックキー対応 230 final boolean useCheck = HybsSystem.sysBool( "USE_FILEDOWNLOAD_CHECKKEY" ); 231 if( useCheck ) { 232 final String checkKey = request.getParameter( "key" ); 233 if( checkKey == null || !checkKey.equals( HybsCryptography.getMD5( reqFilename ) ) ) { 234 final String errMsg = "アクセスが拒否されました。(URLチェック)"; 235 throw new HybsSystemException( errMsg ); // 5.7.1.2 (2013/12/20) msg ⇒ errMsg 変更 236 } 237 } 238 239 // ※ useCheck の前か後か? とりあえず後ろに入れておきます。 240 // 7.2.7.0 (2020/08/07) 相対パスの場合の基準フォルダ(FILE_URL) 考慮。互換性の関係で、useBase で制御します。 241 final boolean useBase = StringUtil.nval( request.getParameter( "useBase" ), false ); 242 if( useBase ) { 243 reqFilename = StringUtil.urlAppend( fileURL,reqFilename ); 244 } 245 246 // 相対パスを絶対パスに変換。ファイルセパレータも正規化されています。 247 reqFilename = HybsSystem.url2dir( reqFilename ); 248 249 // 拡張子からcontentTypeを獲得 250 final String contentType = getContentType( reqFilename ); 251 // contentTypeを出力 252 response.setContentType( contentType ); 253 254 // 表示ファイル名の指定 255 String newFilename = request.getParameter( "name" ); // 6.4.1.1 (2016/01/16) PMD refactoring. 256 if( newFilename == null || newFilename.isEmpty() ) { 257 newFilename = getFileName( reqFilename ); 258 } 259// // 8.0.0.1 (2021/10/08) cloud対応 … USE_STR_CONV_KEY 廃止 260// else if( useStrCnv ){ // 5.8.1.0 (2014/11/07) 条件追加 261// // newFilename = new String( newFilename.getBytes("ISO-8859-1"), "UTF-8" ); 262// newFilename = new String( newFilename.getBytes(requestEncode), "UTF-8" ); 263// } 264 265 // 6.4.1.1 (2016/01/16) PMD refactoring. Avoid declaring a variable if it is unreferenced before a possible exit point. 266 // 3.8.1.2 (2005/12/19) 半角カナを全角カナに置き換えます。ファイルダイアログの文字化け仮対応 267 if( HybsSystem.sysBool( "USE_FILEDOWNLOAD_HAN_ZEN" ) ) { 268 newFilename = KanaFilter.han2zen( newFilename ); 269 } 270 271 // 6.9.4.1 (2018/04/09) 日本語ファイル名で、旧方式を入れておくと、文字化けするので、はずします。(StringUtil.urlEncodeだけでよい。) 272 // // 5.7.1.2 (2013/12/20) 条件を反転させた上でIE11対応を行う 273 // final String reqHeader = request.getHeader( "User-Agent" ); 274 // // 5.9.27.2 (2017/12/15) EdgeもIE同様の処理にする 275 // if( reqHeader.indexOf( "MSIE" ) >= 0 || reqHeader.indexOf( "Trident" ) >= 0 || reqHeader.indexOf( "Edge" ) >= 0 ) { 276 // newFilename = new String( newFilename.getBytes("Windows-31J"), "ISO-8859-1" ); 277 // } 278 // else { 279 // newFilename = MimeUtility.encodeWord( newFilename, "UTF-8", "B" ); 280 // } 281 282 // 5.3.9.0 (2011/09/01) 引数にinline=trueを指定することで、インライン表示が出来るように対応 283 // 6.4.1.1 (2016/01/16) PMD refactoring. Avoid declaring a variable if it is unreferenced before a possible exit point. 284 final boolean inline = StringUtil.nval( request.getParameter( "inline" ), false ); 285 final String dipositionType = inline ? "inline" : "attachment"; 286 287 final String newFilenameEnc = StringUtil.urlEncode( newFilename ); // 5.9.28.1 (2018/01/19) 288 289 // ファイル名の送信( attachment部分をinlineに変更すればインライン表示 ) 290 // 5.3.9.0 (2011/09/01) 引数にinline=trueを指定することで、インライン表示が出来るように対応 291// response.setHeader( "Content-disposition", dipositionType + "; filename=\"" + newFilename + "\"" ); 292 response.setHeader( "Content-disposition", dipositionType + "; filename=\"" + newFilename + "\"; " 293 + "filename*=UTF-8''" + newFilenameEnc ); // 5.9.28.1 (2018/01/19) RFC6266方式を併記 294 295 // 5.3.4.0 (2011/04/01) IEでファイルが正しくダウンロードできないバグを修正 296 response.setHeader( "Cache-Control", "public" ); 297 298 // ファイル内容の出力 299// FileInputStream fin = null; 300 ServletOutputStream out = null; 301 // 2017/10/06 MODIFY bluemixのストレージ利用の処理を追加 302 InputStream is = null; 303 // 5.9.29.1 (2018/02/07) lengthのクラウド対応 304 String filesize = null; 305 try { 306 // 2017/10/06 ADD bluemixのストレージに保存する場合の処理を追加 307 // if(cloudFlag){ 308 // HttpSession hsession = request.getSession(true); 309 // StorageAPI storageApi = StorageAPIFactory.newStorageAPI(storage, HybsSystem.sys("CLOUD_TARGET_CONTAINER"), hsession); 310 // // ストリームの取得 311 // is = storageApi.get(cloudFilename, hsession); 312 // 313 // // ファイルサイズを取得 314 // Map<String,String> map = storageApi.getInfo(cloudFilename, hsession); 315 // filesize = map.get(StorageAPI.FILEINFO_SIZE); 316 // }else{ 317 // // 標準のファイル保存 318 // fin = new FileInputStream( reqFilename ); 319 // is = fin; 320 321 // 8.0.0.0 (2021/09/30) クラウド対応 322 // 5.10.9.0 (2019/03/01) クラウドとバケット名を指定するリクエストパラメータを追加。 323 final String storage = request.getParameter( KEY_STORAGE ); 324 final String bucket = request.getParameter( KEY_BUCKET ); 325 326 // 5.10.9.0 (2019/03/01) MODIFY 327 final FileOperation file = HybsFileOperationFactory.create( storage, bucket, reqFilename ); 328 is = file.read(); 329 330// filesize = String.valueOf(fin.available()); 331 filesize = String.valueOf(is.available()); 332 // } 333// response.setHeader( "Content-Length", String.valueOf(fin.available()) ); // 5.9.27.0 (2017/12/01) 334 response.setHeader( "Content-Lnegth", filesize); // クラウドのサイズ取得対応 335 out = response.getOutputStream(); 336 337 // ファイル読み込み用バッファ 338 final byte buffer[] = new byte[4096]; 339 int size; 340 // while((size = fin.read(buffer))!=-1) { 341 while((size = is.read(buffer))!=-1) { 342 out.write(buffer,0, size); 343 out.flush(); 344 } 345 } 346 finally { 347 Closer.ioClose(is); // 2017/10/06 ADD 348// Closer.ioClose( fin ); // 4.0.0 (2006/01/31) close 処理時の IOException を無視 349 Closer.ioClose( out ); // 4.0.0 (2006/01/31) close 処理時の IOException を無視 350 } 351 } 352 353 /** 354 * アドレス名から拡張子を取り出します。 355 * 356 * アドレス名の後ろから、"." 以降を拡張子として切り取ります。 357 * 拡張子が存在しない場合(指定のファイル名に "." が含まれない場合)は 358 * ゼロ文字列("")を返します。 359 * 360 * @param fileAddress アドレス名 361 * 362 * @return 拡張子 363 * @og.rtnNotNull 364 */ 365 private String getExtention( final String fileAddress ) { 366 final int idx = fileAddress.lastIndexOf( '.' ); 367 368 return idx >= 0 ? fileAddress.substring( idx+1 ) : ""; // 6.1.1.0 (2015/01/17) refactoring 369 } 370 371 /** 372 * アドレス名からファイル名を取り出します。 373 * 374 * アドレス名の後ろから、ファイルセパレータ以降をファイル名として切り取ります。 375 * ファイルセパレータが存在しない場合はアドレス名をそのまま返します。 376 * ここでは、OS毎に異なるファイルセパレータを統一後に処理してください。 377 * 378 * @param fileAddress アドレス名 379 * 380 * @return ファイル名 381 */ 382 private String getFileName( final String fileAddress ) { 383 final int idx = fileAddress.lastIndexOf( FS ); 384 385 // 6.4.1.1 (2016/01/16) PMD refactoring. A method should have only one exit point, and that should be the last statement in the method 386// // 条件変更(反転)注意 387// return idx < 0 ? fileAddress : fileAddress.substring( idx+1 ); 388 return idx >= 0 ? fileAddress.substring( idx+1 ) : fileAddress; 389 } 390 391 /** 392 * アドレス名から対応するコンテンツタイプを取り出します。 393 * 394 * アドレス名から、ファイル拡張子を取り出し、対応するコンテンツタイプを返します。 395 * コンテンツタイプは、CONTENT_TYPE_TABLE 配列に定義している中から検索して返します。 396 * 存在しない場合は、"application/octet-stream" を返します。 397 * 398 * @param fileAddress アドレス名 399 * 400 * @return コンテンツタイプ 401 */ 402 private String getContentType( final String fileAddress ) { 403 final String extention = getExtention( fileAddress ); 404 for( int j=0; j<CONTENT_TYPE_TABLE.length; j++ ) { 405 if( CONTENT_TYPE_TABLE[j][EXTENTION].equalsIgnoreCase( extention ) ) { 406 return CONTENT_TYPE_TABLE[j][CONTENT_TYPE]; 407 } 408 } 409 return "application/octet-stream"; 410 } 411}