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