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