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