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