    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エンコードを行ってください。
    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 *     &lt;servlet&gt;
    060 *         &lt;servlet-name&gt;fileDownload&lt;/servlet-name&gt;
    061 *         &lt;servlet-class&gt;org.opengion.hayabusa.servlet.FileDownload&lt;/servlet-class&gt;
    062 *     &lt;/servlet&gt;
    063 *
    064 *     &lt;servlet-mapping&gt;
    065 *         &lt;servlet-name&gt;fileDownload&lt;/servlet-name&gt;
    066 *         &lt;url-pattern&gt;/jsp/fileDownload&lt;/url-pattern&gt;
    067 *     &lt;/servlet-mapping&gt;
    068 *
    069 * 一般には、http://:ポート/システムID/jsp/fileDownload?file=サーバー物理ファイル&amp;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         *
    155         * @param       request HttpServletRequestオブジェクト
    156         * @param       response        HttpServletResponseオブジェクト
    157         *
    158         * @throws ServletException サーブレット関係のエラーが発生した場合、throw されます。
    159         * @throws IOException 入出力エラーが発生したとき
    160         */
    161        @Override
    162        public void doPost( final HttpServletRequest request, final HttpServletResponse response )
    163                                                        throws ServletException, IOException {
    164                // 3.8.1.2 (2005/12/19) 半角カナ-全角カナ変換機能の追加
    165                boolean hanzenFlag = HybsSystem.sysBool( "USE_FILEDOWNLOAD_HAN_ZEN" );
    166
    167                String reqFilename = request.getParameter( "file" );
    168                String newFilename = request.getParameter( "name" );
    169
    170                // 5.10.9.0 (2019/03/01) クラウドとバケット名を指定するリクエストパラメータを追加。
    171                String storageType = request.getParameter( "storageType" );
    172                String bucketName = request.getParameter( "bucketName" );
    173
    174                String newFilenameEnc = null; // 5.9.28.1 (2018/01/19)
    175
    176                // 5.3.9.0 (2011/09/01) 引数にinline=trueを指定することで、インライン表示が出来るように対応
    177                boolean inline = StringUtil.nval( request.getParameter( "inline" ), false );
    178                String dipositionType = inline ? "inline" : "attachment";
    179
    180                // 5.8.1.0 (2014/11/07) エンコード変換対応
    181                boolean useStrCnv = StringUtil.nval( request.getParameter( "useStringConvert" ), true );
    182
    183                // クライアント側の文字エンコーディングをUTF-8に変換
    184                // 5.8.1.0 (2014/11/07) 条件追加
    185                if( useStrCnv ){
    186                        reqFilename = new String( reqFilename.getBytes("ISO-8859-1"), "UTF-8" );
    187                }
    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                newFilenameEnc = StringUtil.urlEncode( newFilename );  // 5.9.28.1 (2018/01/19)
    235
    236                // 5.7.1.2 (2013/12/20) 条件を反転させた上でIE11対応を行う
    237                // 5.9.27.2 (2017/12/15) EdgeもIE同様の処理にする
    238                if( request.getHeader( "User-Agent" ).indexOf( "MSIE" ) >= 0 || request.getHeader( "User-Agent" ).indexOf( "Trident" ) >= 0
    239                                || request.getHeader( "User-Agent" ).indexOf( "Edge" ) >= 0 ) {
    240                        newFilename = new String( newFilename.getBytes("Windows-31J"), "ISO-8859-1" );
    241                }
    242                else {
    243                        newFilename = MimeUtility.encodeWord( newFilename, "UTF-8", "B" );
    244                }
    245
    246                // ファイル名の送信( attachment部分をinlineに変更すればインライン表示 )
    247                // 5.3.9.0 (2011/09/01) 引数にinline=trueを指定することで、インライン表示が出来るように対応
    248//              response.setHeader( "Content-disposition", "inline; filename=\"" + newFilename + "\"" );
    249//              response.setHeader( "Content-disposition", "attachment; filename=\"" + newFilename + "\"" );
    250//              response.setHeader( "Content-disposition", dipositionType + "; filename=\"" + newFilename + "\"" );
    251                response.setHeader( "Content-disposition", dipositionType + "; filename=\"" + newFilename + "\"; "
    252                                + "filename*=UTF-8''" + newFilenameEnc ); // 5.9.28.1 (2018/01/19)　RFC6266方式を併記
    253
    254                // 5.3.4.0 (2011/04/01) IEでファイルが正しくダウンロードできないバグを修正
    255                response.setHeader( "Cache-Control", "public" );
    256
    257                // ファイル内容の出力
    258                FileInputStream     fin = null;
    259                ServletOutputStream out = null;
    260                // 2017/10/06 MODIFY bluemixのストレージ利用の処理を追加
    261                InputStream is = null;
    262                // 5.9.29.1 (2018/02/07) lengthのｸﾗｳﾄﾞ対応
    263                String filesize = null;
    264                try {
    265                        // 5.10.9.0 (2019/03/01) MODIFY
    266                        // FileOperation file = FileOperationFactory.newStorageOperation(reqFilename);
    267                        FileOperation file = HybsFileOperationFactory.create(storageType, bucketName, reqFilename);
    268                        is = file.read();
    269                        filesize = String.valueOf(file.length());
    270
    271//                      response.setHeader( "Content-Length", String.valueOf(fin.available()) ); // 5.9.27.0 (2017/12/01)
    272                        response.setHeader( "Content-Lnegth", filesize);        // クラウドのサイズ取得対応
    273
    274                        out = response.getOutputStream();
    275
    276                        // ファイル読み込み用バッファ
    277                        byte buffer[]  = new byte[4096];
    278                        int size;
    279                        while((size = is.read(buffer))!=-1) {
    280                                out.write(buffer,0, size);
    281                                out.flush();
    282                        }
    283
    284                }
    285                finally {
    286                        Closer.ioClose(is);             // 2017/10/06 ADD
    287                        Closer.ioClose( fin );          // 4.0.0 (2006/01/31) close 処理時の IOException を無視
    288                        Closer.ioClose( out );          // 4.0.0 (2006/01/31) close 処理時の IOException を無視
    289                }
    290        }
    291
    292        /**
    293         * アドレス名から拡張子を取り出します。
    294         *
    295         * アドレス名の後ろから、"." 以降を拡張子として切り取ります。
    296         * 拡張子が存在しない場合(指定のファイル名に "." が含まれない場合)は
    297         * ゼロ文字列("")を返します。
    298         *
    299         * @param       fileAddress     アドレス名
    300         *
    301         * @return      拡張子
    302         */
    303        private String getExtention( final String fileAddress ) {
    304                int idx = fileAddress.lastIndexOf('.');
    305                if( idx!=-1 ) { return fileAddress.substring( idx+1 ); }
    306                return "";
    307        }
    308
    309        /**
    310         * アドレス名からファイル名を取り出します。
    311         *
    312         * アドレス名の後ろから、ファイルセパレータ以降をファイル名として切り取ります。
    313         * ファイルセパレータが存在しない場合はアドレス名をそのまま返します。
    314         * ここでは、OS毎に異なるファイルセパレータを統一後に処理してください。
    315         *
    316         * @param       fileAddress     アドレス名
    317         *
    318         * @return      ファイル名
    319         */
    320        private String getFileName( final String fileAddress ) {
    321                int idx = fileAddress.lastIndexOf( HybsSystem.FS );
    322                if( idx!=-1 ) { return fileAddress.substring( idx+1 ); }
    323                return fileAddress;
    324        }
    325
    326        /**
    327         * アドレス名から対応するコンテンツタイプを取り出します。
    328         *
    329         * アドレス名から、ファイル拡張子を取り出し、対応するコンテンツタイプを返します。
    330         * コンテンツタイプは、CONTENT_TYPE_TABLE 配列に定義している中から検索して返します。
    331         * 存在しない場合は、"application/octet-stream" を返します。
    332         *
    333         * @param       fileAddress     アドレス名
    334         *
    335         * @return      コンテンツタイプ
    336         */
    337        private String getContentType( final String fileAddress ) {
    338                String extention = getExtention( fileAddress );
    339                for( int j=0; j<CONTENT_TYPE_TABLE.length; j++ ) {
    340                        if( CONTENT_TYPE_TABLE[j][EXTENTION].equalsIgnoreCase( extention ) ) {
    341                                return CONTENT_TYPE_TABLE[j][CONTENT_TYPE];
    342                        }
    343                }
    344                return "application/octet-stream";
    345        }
    346}