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