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