    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
    022// import 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        // import javax.servlet.http.HttpSession;                               // 2017/10/06 ADD bluemixのストレージに保存する場合
    029
    030import org.opengion.fukurou.security.HybsCryptography;
    031import org.opengion.fukurou.system.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 static org.opengion.fukurou.system.HybsConst.FS;         // 6.1.0.0 (2014/12/26) refactoring
    037        // import org.opengion.hayabusa.io.StorageAPI;                          // 5.9.25.0 (2017/10/06) クラウドストレージ対応
    038        // import org.opengion.hayabusa.io.StorageAPIFactory;           // 5.9.25.0 (2017/10/06) クラウドストレージ対応
    039
    040/**
    041 * サーバー管理ファイルをダウンロードする場合に使用する、サーブレットです。
    042 *
    043 * 引数(URL)に指定のファイルをサーバーからクライアントにダウンロードさせます。
    044 * file には、サーバーファイルの物理アドレスを指定します。相対パスを使用する場合は、
    045 * コンテキストルート(通常、Tomcatでは、G:\webapps\dbdef2\ など)からのパスと判断します。
    046 * name には、クライアントに送信するファイル名を指定します。ファイル名を指定しない場合は、
    047 * サーバーの物理ファイルのファイル名が代わりに使用されます。
    048 * 日本語ファイル名は、すべて UTF-8化して処理します。指定するファイルに日本語が含まれる
    049 * 場合は、URLエンコードを行ってください。
    050 * 基本的にはContent-disposition属性として"attachment"が指定されます。
    051 * 但し、引数に inline=true を指定することで、Content-disposition属性に"inline"が指定されます。
    052 * また、システムリソースのUSE_FILEDOWNLOAD_CHECKKEYをtrueに指定することで、簡易的なチェックを
    053 * 行うことができます。
    054 * 具体的には、これを有効にすると、file属性の値から計算されるMD5チェックサムと、"key"という
    055 * パラメーターに指定された値が一致した場合のみダウンロードが許可され、keyが指定されていない、
    056 * または値が異なる場合はダウンロードエラーとなります。
    057 *
    058 * 一般的なサーブレットと同様に、デプロイメント・ディスクリプタ WEB-INF/web.xml に、
    059 * servlet 要素と そのマッピング(servlet-mapping)を定義する必要があります。
    060 *
    061 *     &lt;servlet&gt;
    062 *         &lt;servlet-name&gt;fileDownload&lt;/servlet-name&gt;
    063 *         &lt;servlet-class&gt;org.opengion.hayabusa.servlet.FileDownload&lt;/servlet-class&gt;
    064 *     &lt;/servlet&gt;
    065 *
    066 *     &lt;servlet-mapping&gt;
    067 *         &lt;servlet-name&gt;fileDownload&lt;/servlet-name&gt;
    068 *         &lt;url-pattern&gt;/jsp/fileDownload&lt;/url-pattern&gt;
    069 *     &lt;/servlet-mapping&gt;
    070 *
    071 * 一般には、http://:ポート/システムID/jsp/fileDownload?file=サーバー物理ファイル&amp;name=ファイル名
    072 * 形式のURL でアクセスします。
    073 *
    074 * 5.9.25.0 (2017/10/06)
    075 * クラウド上のPaaSでオブジェクトストレージを利用する際は以下のシステムリソースを設定してください。
    076 * CLOUD_STORAGE,CLOUD_STORAGE_CONTAINER
    077 * plugin/cloud内のクラスを利用してファイルアップロード(FileUploadタグ)、ダウンロード(FileDownloadサーブレット)をAPI経由で行います。
    078 * プラグインが利用するjarファイルの配置は必要です。
    079 *
    080 * 5.8.1.0 (2014/11/07)
    081 * forwardでアクセスする場合はファイル名の文字コード変換が不要なため、useStringConvert=falseの
    082 * 引数を与えてください。（falseとしない場合は日本語ファイル名等でエラーが発生します）
    083 *
    084 * @og.rev 3.8.1.1 (2005/11/21) 新規追加
    085 * @og.rev 5.9.25.0 (2017/10/06) クラウド対応
    086 * @og.rev 5.9.29.1 (2018/02/07) Azure対応追加
    087 * @og.group その他機能
    088 *
    089 * @version  0.9.0  2000/10/17
    090 * @author   Kazuhiko Hasegawa
    091 * @since    JDK1.1,
    092 */
    093public class FileDownload extends HttpServlet {
    094        private static final long serialVersionUID = 539020110901L ;
    095
    096        // 拡張子contentType対応テーブル
    097        private static final String CONTENT_TYPE_TABLE[][] = {
    098                {"jpg", "image/pjpeg"   },
    099                {"gif", "image/gif"             },
    100                {"txt", "text/plain"    },
    101                // OpenDocument追加
    102                {"xls", "application/vnd.ms-excel"},
    103                {"odp", "application/vnd.oasis.opendocument.presentation"}, // 4.3.5.5 (2008/03/08)
    104                {"ods", "application/vnd.oasis.opendocument.spreadsheet"}, // 4.3.5.5 (2008/03/08)
    105                {"odt", "application/vnd.oasis.opendocument.text"} // 4.3.5.5 (2008/03/08)
    106        };
    107        private static final int EXTENTION       = 0;
    108        private static final int CONTENT_TYPE= 1;
    109
    110        /**
    111         * デフォルトコンストラクター
    112         *
    113         * @og.rev 6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.
    114         */
    115        public FileDownload() { super(); }              // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。
    116
    117        /**
    118         * GET メソッドが呼ばれたときに実行します。
    119         *
    120         * 処理は、doPost へ振りなおしています。
    121         *
    122         * @param       request HttpServletRequestオブジェクト
    123         * @param       response        HttpServletResponseオブジェクト
    124         *
    125         * @og.rev 3.8.1.2 (2005/12/19) 半角カナ-全角カナ変換機能の追加
    126         *
    127         * @throws ServletException サーブレット関係のエラーが発生した場合、throw されます。
    128         * @throws IOException 入出力エラーが発生したとき
    129         */
    130        @Override
    131        public void doGet( final HttpServletRequest request, final HttpServletResponse response )
    132                                                        throws ServletException, IOException {
    133                doPost( request,response );
    134        }
    135
    136        /**
    137         * POST メソッドが呼ばれたときに実行します。
    138         *
    139         * file 引数の サーバー物理ファイルを、クライアントにストリーム化して返します。
    140         * name 引数があれば、その名前のファイル名でクライアントがファイルセーブできるように
    141         * します。name 引数がなければ、そのまま物理ファイル名が使用されます。
    142         * サーバー物理ファイル名が、相対パスの場合、コンテキストルートに対する相対パスになります。
    143         * (例：G:\webapps\dbdef2\ など)
    144         *
    145         * @og.rev 5.3.2.0 (2011/02/01) 日本語ファイル名が正しく処理できないバグを修正
    146         * @og.rev 5.3.4.0 (2011/04/01) IEでファイルが正しくダウンロードできないバグを修正
    147         * @og.rev 5.3.5.0 (2011/05/01) ファイルダウンロードチェックキー対応
    148         * @og.rev 5.3.6.0 (2011/06/01) ファイルダウンロードはattachmentに変更(ダウンロードダイアログを出す)
    149         * @og.rev 5.3.8.0 (2011/08/01) ファイル名指定でIEの場合、URLエンコードすると途中で切れるため(IE7のバグ)、Shift_JIS(WIndows-31J)で直接指定する。
    150         * @og.rev 5.3.9.0 (2011/09/01) 引数にinline=trueを指定することで、インライン表示が出来るように対応
    151         * @og.rev 5.7.1.2 (2013/12/20) 日本語ファイルのIE11対応（UA変更）,msg ⇒ errMsg 変更
    152         * @og.rev 5.8.1.0 (2014/11/07) forward時の文字コード変換不要対応
    153         * @og.rev 5.9.25.0 (2017/10/06) ｸﾗｳﾄﾞｽﾄﾚｰｼﾞからﾀﾞｳﾝﾛｰﾄﾞ処理を追加対応
    154         * @og.rev 5.9.27.0 (2017/12/01) Content-Lengthをhttpヘッダに追加しておく
    155         * @og.rev 5.9.27.2 (2017/12/15) Edgeの日本語ファイル名対応
    156         * @og.rev 6.8.4.2 (2017/12/25) エンコード変換対応のキー(fileDownloadサーブレットでエンコードをON/OFF指定に利用)
    157         * @og.rev 5.9.28.1 (2018/01/19) safariの日本語ファイル名対応(RFC6266方式を併記）
    158         * @og.rev 6.9.4.1 (2018/04/09) 日本語ファイル名で、旧方式を入れておくと、文字化けするので、はずします。
    159         *
    160         * @param       request HttpServletRequestオブジェクト
    161         * @param       response        HttpServletResponseオブジェクト
    162         *
    163         * @throws ServletException サーブレット関係のエラーが発生した場合、throw されます。
    164         * @throws IOException 入出力エラーが発生したとき
    165         */
    166        @Override
    167        public void doPost( final HttpServletRequest request, final HttpServletResponse response )
    168                                                        throws ServletException, IOException {
    169
    170                // 2017/10/06 ADD
    171                // ｸﾗｳﾄﾞｽﾄﾚｰｼﾞ指定
    172        //      final String storage = HybsSystem.sys( "CLOUD_STORAGE");
    173                // ｸﾗｳﾄﾞｽﾄﾚｰｼﾞ指定ﾌﾗｸﾞ
    174        //      final boolean cloudFlag = storage != null && storage.length() > 0;
    175
    176                // 5.8.1.0 (2014/11/07) エンコード変換対応
    177                // 6.8.4.2 (2017/12/25) エンコード変換対応で、Attribute も確認します。
    178                // ややこしくなってますが、どちらかのキーワードで、"false" が指定された場合のみ、false になります。
    179                final boolean useStrCnv = StringUtil.nval(         request.getParameter( HybsSystem.USE_STR_CONV_KEY ), true ) &&
    180                                                                  StringUtil.nval( (String)request.getAttribute( HybsSystem.USE_STR_CONV_KEY ), true ) ;
    181
    182                // クライアント側の文字エンコーディングをUTF-8に変換
    183                // 5.8.1.0 (2014/11/07) 条件追加
    184                String reqFilename = request.getParameter( "file" );            // 6.4.1.1 (2016/01/16) PMD refactoring.
    185                if( useStrCnv ){
    186                        reqFilename = new String( reqFilename.getBytes("ISO-8859-1"), "UTF-8" );
    187                }
    188
    189                // 2017/10/06 ADD reqFilenameの保存
    190        //      final String cloudFilename = reqFilename;
    191
    192                // 5.3.5.0 (2011/05/01) ファイルダウンロードチェックキー対応
    193                final boolean useCheck = HybsSystem.sysBool( "USE_FILEDOWNLOAD_CHECKKEY" );
    194                if( useCheck ) {
    195                        final String checkKey = request.getParameter( "key" );
    196                        if( checkKey == null || !checkKey.equals( HybsCryptography.getMD5( reqFilename ) ) ) {
    197                                final String errMsg = "アクセスが拒否されました。(URLチェック)";
    198                                throw new HybsSystemException( errMsg );        // 5.7.1.2 (2013/12/20) msg ⇒ errMsg 変更
    199                        }
    200                }
    201
    202                // 相対パスを絶対パスに変換。ファイルセパレータも正規化されています。
    203                reqFilename = HybsSystem.url2dir( reqFilename );
    204
    205                // 拡張子からcontentTypeを獲得
    206                final String contentType = getContentType( reqFilename );
    207                // contentTypeを出力
    208                response.setContentType( contentType );
    209
    210                // 表示ファイル名の指定
    211                String newFilename = request.getParameter( "name" );            // 6.4.1.1 (2016/01/16) PMD refactoring.
    212                if( newFilename == null || newFilename.isEmpty() ) {
    213                        newFilename = getFileName( reqFilename );
    214                }
    215                else if( useStrCnv ){           // 5.8.1.0 (2014/11/07) 条件追加
    216                        newFilename = new String( newFilename.getBytes("ISO-8859-1"), "UTF-8" );
    217                }
    218
    219                // 6.4.1.1 (2016/01/16) PMD refactoring. Avoid declaring a variable if it is unreferenced before a possible exit point.
    220                // 3.8.1.2 (2005/12/19) 半角カナを全角カナに置き換えます。ファイルダイアログの文字化け仮対応
    221                if( HybsSystem.sysBool( "USE_FILEDOWNLOAD_HAN_ZEN" ) ) {
    222                        newFilename = KanaFilter.han2zen( newFilename );
    223                }
    224
    225                // 6.9.4.1 (2018/04/09) 日本語ファイル名で、旧方式を入れておくと、文字化けするので、はずします。(StringUtil.urlEncodeだけでよい。)
    226        //      // 5.7.1.2 (2013/12/20) 条件を反転させた上でIE11対応を行う
    227        //      final String reqHeader = request.getHeader( "User-Agent" );
    228        //      // 5.9.27.2 (2017/12/15) EdgeもIE同様の処理にする
    229        //      if( reqHeader.indexOf( "MSIE" ) >= 0 || reqHeader.indexOf( "Trident" ) >= 0 || reqHeader.indexOf( "Edge" ) >= 0 ) {
    230        //              newFilename = new String( newFilename.getBytes("Windows-31J"), "ISO-8859-1" );
    231        //      }
    232        //      else {
    233        //              newFilename = MimeUtility.encodeWord( newFilename, "UTF-8", "B" );
    234        //      }
    235
    236                // 5.3.9.0 (2011/09/01) 引数にinline=trueを指定することで、インライン表示が出来るように対応
    237                // 6.4.1.1 (2016/01/16) PMD refactoring. Avoid declaring a variable if it is unreferenced before a possible exit point.
    238                final boolean inline = StringUtil.nval( request.getParameter( "inline" ), false );
    239                final String dipositionType = inline ? "inline" : "attachment";
    240
    241                final String newFilenameEnc = StringUtil.urlEncode( newFilename );  // 5.9.28.1 (2018/01/19)
    242
    243                // ファイル名の送信( attachment部分をinlineに変更すればインライン表示 )
    244                // 5.3.9.0 (2011/09/01) 引数にinline=trueを指定することで、インライン表示が出来るように対応
    245//              response.setHeader( "Content-disposition", dipositionType + "; filename=\"" + newFilename + "\"" );
    246                response.setHeader( "Content-disposition", dipositionType + "; filename=\"" + newFilename + "\"; "
    247                                + "filename*=UTF-8''" + newFilenameEnc ); // 5.9.28.1 (2018/01/19)　RFC6266方式を併記
    248
    249                // 5.3.4.0 (2011/04/01) IEでファイルが正しくダウンロードできないバグを修正
    250                response.setHeader( "Cache-Control", "public" );
    251
    252                // ファイル内容の出力
    253                FileInputStream     fin = null;
    254                ServletOutputStream out = null;
    255                // 2017/10/06 MODIFY bluemixのストレージ利用の処理を追加
    256                InputStream is = null;
    257                // 5.9.29.1 (2018/02/07) lengthのｸﾗｳﾄﾞ対応
    258                String filesize = null;
    259                try {
    260                        // 2017/10/06 ADD bluemixのストレージに保存する場合の処理を追加
    261        //              if(cloudFlag){
    262        //                      HttpSession hsession = request.getSession(true);
    263        //                      StorageAPI storageApi = StorageAPIFactory.newStorageAPI(storage, HybsSystem.sys("CLOUD_STORAGE_CONTAINER"), hsession);
    264        //                      // ストリームの取得
    265        //                      is = storageApi.get(cloudFilename, hsession);
    266        //
    267        //                      // ファイルサイズを取得
    268        //                      Map<String,String> map = storageApi.getInfo(cloudFilename, hsession);
    269        //                      filesize = map.get(StorageAPI.FILEINFO_SIZE);
    270        //              }else{
    271        //              // 標準のファイル保存
    272                                fin = new FileInputStream( reqFilename );
    273                                is = fin;
    274                                filesize = String.valueOf(fin.available());
    275        //              }
    276//                      response.setHeader( "Content-Length", String.valueOf(fin.available()) );        // 5.9.27.0 (2017/12/01)
    277                        response.setHeader( "Content-Lnegth", filesize);        // クラウドのサイズ取得対応
    278                        out = response.getOutputStream();
    279
    280                        // ファイル読み込み用バッファ
    281                        final byte buffer[]  = new byte[4096];
    282                        int size;
    283        //              while((size = fin.read(buffer))!=-1) {
    284                        while((size = is.read(buffer))!=-1) {
    285                                out.write(buffer,0, size);
    286                                out.flush();
    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         * @og.rtnNotNull
    307         */
    308        private String getExtention( final String fileAddress ) {
    309                final int idx = fileAddress.lastIndexOf( '.' );
    310
    311                return idx >= 0 ? fileAddress.substring( idx+1 ) : "";          // 6.1.1.0 (2015/01/17) refactoring
    312        }
    313
    314        /**
    315         * アドレス名からファイル名を取り出します。
    316         *
    317         * アドレス名の後ろから、ファイルセパレータ以降をファイル名として切り取ります。
    318         * ファイルセパレータが存在しない場合はアドレス名をそのまま返します。
    319         * ここでは、OS毎に異なるファイルセパレータを統一後に処理してください。
    320         *
    321         * @param       fileAddress     アドレス名
    322         *
    323         * @return      ファイル名
    324         */
    325        private String getFileName( final String fileAddress ) {
    326                final int idx = fileAddress.lastIndexOf( FS );
    327
    328                // 6.4.1.1 (2016/01/16) PMD refactoring. A method should have only one exit point, and that should be the last statement in the method
    329//              // 条件変更(反転)注意
    330//              return idx < 0 ? fileAddress : fileAddress.substring( idx+1 );
    331                return idx >= 0 ? fileAddress.substring( idx+1 ) : fileAddress;
    332        }
    333
    334        /**
    335         * アドレス名から対応するコンテンツタイプを取り出します。
    336         *
    337         * アドレス名から、ファイル拡張子を取り出し、対応するコンテンツタイプを返します。
    338         * コンテンツタイプは、CONTENT_TYPE_TABLE 配列に定義している中から検索して返します。
    339         * 存在しない場合は、"application/octet-stream" を返します。
    340         *
    341         * @param       fileAddress     アドレス名
    342         *
    343         * @return      コンテンツタイプ
    344         */
    345        private String getContentType( final String fileAddress ) {
    346                final String extention = getExtention( fileAddress );
    347                for( int j=0; j<CONTENT_TYPE_TABLE.length; j++ ) {
    348                        if( CONTENT_TYPE_TABLE[j][EXTENTION].equalsIgnoreCase( extention ) ) {
    349                                return CONTENT_TYPE_TABLE[j][CONTENT_TYPE];
    350                        }
    351                }
    352                return "application/octet-stream";
    353        }
    354}