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