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