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