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