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 @og.rev 5.9.25.0 (2017/10/06) クラウドストレージからダウンロード処理を追加対応 146 * 147 * @param request HttpServletRequestオブジェクト 148 * @param response HttpServletResponseオブジェクト 149 * 150 * @throws ServletException サーブレット関係のエラーが発生した場合、throw されます。 151 * @throws IOException 入出力エラーが発生したとき 152 */ 153 @Override 154 public void doPost( final HttpServletRequest request, final HttpServletResponse response ) 155 throws ServletException, IOException { 156 157 // 3.8.1.2 (2005/12/19) 半角カナ-全角カナ変換機能の追加 158 boolean hanzenFlag = HybsSystem.sysBool( "USE_FILEDOWNLOAD_HAN_ZEN" ); 159 // 2017/10/06 ADD 160 // クラウドストレージ指定 161 String storage = HybsSystem.sys( "CLOUD_STORAGE"); 162 // クラウドストレージ指定フラグ 163 boolean cloudFlag = false; 164 if(storage != null && storage.length() > 0){ 165 cloudFlag = true; 166 } 167 168 String reqFilename = request.getParameter( "file" ); 169 String newFilename = request.getParameter( "name" ); 170 171 // 5.3.9.0 (2011/09/01) 引数にinline=trueを指定することで、インライン表示が出来るように対応 172 boolean inline = StringUtil.nval( request.getParameter( "inline" ), false ); 173 String dipositionType = inline ? "inline" : "attachment"; 174 175 // 5.8.1.0 (2014/11/07) エンコード変換対応 176 boolean useStrCnv = StringUtil.nval( request.getParameter( "useStringConvert" ), true ); 177 178 // クライアント側の文字エンコーディングをUTF-8に変換 179 // 5.8.1.0 (2014/11/07) 条件追加 180 if( useStrCnv ){ 181 reqFilename = new String( reqFilename.getBytes("ISO-8859-1"), "UTF-8" ); 182 } 183 184 // 2017/10/06 ADD reqFilenameの保存 185 String cloudFilename = reqFilename; 186 187 // 5.3.5.0 (2011/05/01) ファイルダウンロードチェックキー対応 188 boolean useCheck = HybsSystem.sysBool( "USE_FILEDOWNLOAD_CHECKKEY" ); 189 if( useCheck ) { 190 String checkKey = request.getParameter( "key" ); 191 if( checkKey == null || !checkKey.equals( HybsCryptography.getMD5( reqFilename ) ) ) { 192// String msg = "アクセスが拒否されました。(URLチェック)"; 193// throw new HybsSystemException( msg ); 194 String errMsg = "アクセスが拒否されました。(URLチェック)"; 195 throw new HybsSystemException( errMsg ); // 5.7.1.2 (2013/12/20) msg ⇒ errMsg 変更 196 } 197 } 198 199 // 相対パスを絶対パスに変換。ファイルセパレータも正規化されています。 200 reqFilename = HybsSystem.url2dir( reqFilename ); 201 202 // 拡張子からcontentTypeを獲得 203 String contentType = getContentType( reqFilename ); 204 // contentTypeを出力 205 response.setContentType( contentType ); 206 207 // 表示ファイル名の指定 208 if( newFilename == null || newFilename.length() == 0 ) { 209 newFilename = getFileName( reqFilename ); 210 } 211// else { 212 else if( useStrCnv ){ // 5.8.1.0 (2014/11/07) 条件追加 213 newFilename = new String( newFilename.getBytes("ISO-8859-1"), "UTF-8" ); 214 } 215 216 // 3.8.1.2 (2005/12/19) 半角カナを全角カナに置き換えます。ファイルダイアログの文字化け仮対応 217 if( hanzenFlag ) { 218 newFilename = KanaFilter.han2zen( newFilename ); 219 } 220 221 // 5.3.2.0 (2011/02/01) 日本語ファイル名が正しく処理できないバグを修正 222//// newFilename = StringUtil.urlEncode( newFilename ); 223// if( request.getHeader( "User-Agent" ).indexOf( "MSIE" ) == -1 ) { 224// newFilename = MimeUtility.encodeWord( newFilename, "UTF-8", "B" ); 225// } 226// else { 227// // 5.3.8.0 (2011/08/01) IEの場合、URLエンコードすると途中で切れるため(IE7のバグ)、Shift_JIS(WIndows-31J)で直接指定する。 228//// newFilename = StringUtil.urlEncode( newFilename ); 229// newFilename = new String( newFilename.getBytes("Windows-31J"), "ISO-8859-1" ); 230// } 231 232 // 5.7.1.2 (2013/12/20) 条件を反転させた上でIE11対応を行う 233 if( request.getHeader( "User-Agent" ).indexOf( "MSIE" ) >= 0 || request.getHeader( "User-Agent" ).indexOf( "Trident" ) >= 0 ) { 234 newFilename = new String( newFilename.getBytes("Windows-31J"), "ISO-8859-1" ); 235 } 236 else { 237 newFilename = MimeUtility.encodeWord( newFilename, "UTF-8", "B" ); 238 } 239 240 // ファイル名の送信( attachment部分をinlineに変更すればインライン表示 ) 241 // 5.3.9.0 (2011/09/01) 引数にinline=trueを指定することで、インライン表示が出来るように対応 242// response.setHeader( "Content-disposition", "inline; filename=\"" + newFilename + "\"" ); 243// response.setHeader( "Content-disposition", "attachment; filename=\"" + newFilename + "\"" ); 244 response.setHeader( "Content-disposition", dipositionType + "; filename=\"" + newFilename + "\"" ); 245 246 // 5.3.4.0 (2011/04/01) IEでファイルが正しくダウンロードできないバグを修正 247 response.setHeader( "Cache-Control", "public" ); 248 249 // ファイル内容の出力 250 FileInputStream fin = null; 251 ServletOutputStream out = null; 252 // 2017/10/06 MODIFY bluemixのストレージ利用の処理を追加 253 InputStream is = null; 254 try { 255 // 2017/10/06 ADD bluemixのストレージに保存する場合の処理を追加 256 if(cloudFlag){ 257 HttpSession hsession = request.getSession(true); 258 StorageAPI storageApi = StorageAPIFactory.newStorageAPI(storage, HybsSystem.sys("CLOUD_STORAGE_CONTAINER"), hsession); 259 is = storageApi.get(cloudFilename, hsession); 260 }else{ 261 // 標準のファイル保存 262 fin = new FileInputStream( reqFilename ); 263 is = fin; 264 } 265 266 out = response.getOutputStream(); 267 268 // ファイル読み込み用バッファ 269 byte buffer[] = new byte[4096]; 270 int size; 271 while((size = is.read(buffer))!=-1) { 272 out.write(buffer,0, size); 273 out.flush(); 274 } 275 276 } 277 finally { 278 Closer.ioClose(is); // 2017/10/06 ADD 279 Closer.ioClose( fin ); // 4.0.0 (2006/01/31) close 処理時の IOException を無視 280 Closer.ioClose( out ); // 4.0.0 (2006/01/31) close 処理時の IOException を無視 281 } 282 } 283 284 /** 285 * アドレス名から拡張子を取り出します。 286 * 287 * アドレス名の後ろから、"." 以降を拡張子として切り取ります。 288 * 拡張子が存在しない場合(指定のファイル名に "." が含まれない場合)は 289 * ゼロ文字列("")を返します。 290 * 291 * @param fileAddress アドレス名 292 * 293 * @return 拡張子 294 */ 295 private String getExtention( final String fileAddress ) { 296 int idx = fileAddress.lastIndexOf('.'); 297 if( idx!=-1 ) { return fileAddress.substring( idx+1 ); } 298 return ""; 299 } 300 301 /** 302 * アドレス名からファイル名を取り出します。 303 * 304 * アドレス名の後ろから、ファイルセパレータ以降をファイル名として切り取ります。 305 * ファイルセパレータが存在しない場合はアドレス名をそのまま返します。 306 * ここでは、OS毎に異なるファイルセパレータを統一後に処理してください。 307 * 308 * @param fileAddress アドレス名 309 * 310 * @return ファイル名 311 */ 312 private String getFileName( final String fileAddress ) { 313 int idx = fileAddress.lastIndexOf( HybsSystem.FS ); 314 if( idx!=-1 ) { return fileAddress.substring( idx+1 ); } 315 return fileAddress; 316 } 317 318 /** 319 * アドレス名から対応するコンテンツタイプを取り出します。 320 * 321 * アドレス名から、ファイル拡張子を取り出し、対応するコンテンツタイプを返します。 322 * コンテンツタイプは、CONTENT_TYPE_TABLE 配列に定義している中から検索して返します。 323 * 存在しない場合は、"application/octet-stream" を返します。 324 * 325 * @param fileAddress アドレス名 326 * 327 * @return コンテンツタイプ 328 */ 329 private String getContentType( final String fileAddress ) { 330 String extention = getExtention( fileAddress ); 331 for( int j=0; j<CONTENT_TYPE_TABLE.length; j++ ) { 332 if( CONTENT_TYPE_TABLE[j][EXTENTION].equalsIgnoreCase( extention ) ) { 333 return CONTENT_TYPE_TABLE[j][CONTENT_TYPE]; 334 } 335 } 336 return "application/octet-stream"; 337 } 338}