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