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.filter;
017
018import javax.servlet.ServletRequest;
019import javax.servlet.http.HttpServletRequest;
020import javax.servlet.ServletResponse;
021import javax.servlet.ServletException;
022import javax.servlet.Filter;
023import javax.servlet.FilterChain;
024import javax.servlet.FilterConfig;
025
026import java.io.File;                                                                                            // 5.7.3.2 (2014/02/28) Tomcat8 対応
027import java.io.PrintWriter;
028import java.io.BufferedReader;
029import java.io.IOException;
030import java.io.UnsupportedEncodingException;
031import java.nio.charset.CharacterCodingException;                                       // 6.3.1.0 (2015/06/28)
032
033import org.opengion.fukurou.system.OgRuntimeException ;                         // 6.4.2.0 (2016/01/29)
034import org.opengion.fukurou.system.OgCharacterException ;                       // 6.5.0.1 (2016/10/21)
035import org.opengion.fukurou.system.DateSet;                                                     // 6.4.2.0 (2016/01/29)
036import org.opengion.fukurou.system.Closer;
037import org.opengion.fukurou.util.FileUtil;                                                      // 6.2.0.0 (2015/02/27)
038import org.opengion.fukurou.util.StringUtil;                                            // 6.3.8.0 (2015/09/11)
039import static org.opengion.fukurou.system.HybsConst.BUFFER_MIDDLE;      // 6.1.0.0 (2014/12/26) refactoring
040import static org.opengion.fukurou.system.HybsConst.CR;                         // 6.3.1.0 (2015/06/28)
041import org.opengion.hayabusa.common.HybsSystem;                                         // 6.2.4.1 (2015/05/22)
042
043/**
044 * AccessStopFilter は、Filter インターフェースを継承した アクセス制御クラスです。
045 * web.xml で filter 設定することにより、Webアプリケーションへのアクセスを制御できます。
046 * また、SYSTEM ユーザーは、このフィルターを常に通過します。
047 *
048 * フィルターに対してweb.xml でパラメータを設定します。
049 *   ・startTime:停止開始時刻 (初期値:230000)
050 *   ・stopTime :停止終了時刻 (初期値:070000)
051 *   ・filename :停止時メッセージ表示ファイル名 (初期値:jsp/custom/stopFile.html)
052 *   ・passUsers:停止中でもアクセス可能なユーザーID (初期値:SYSTEM,ADMIN)
053 *   ・addUsers :停止中でもアクセス可能な追加ユーザーID (初期値:null)
054 *
055 * 【WEB-INF/web.xml】
056 *     <filter>
057 *         <filter-name>AccessStopFilter</filter-name>
058 *         <filter-class>org.opengion.hayabusa.filter.AccessStopFilter</filter-class>
059 *         <init-param>
060 *             <param-name>startTime</param-name>
061 *             <param-value>070000</param-value>
062 *         </init-param>
063 *         <init-param>
064 *             <param-name>stopTime</param-name>
065 *             <param-value>070000</param-value>
066 *         </init-param>
067 *         <init-param>
068 *             <param-name>filename</param-name>
069 *             <param-value>jsp/custom/stopFile.html</param-value>
070 *         </init-param>
071 *     </filter>
072 *
073 *     <filter-mapping>
074 *         <filter-name>AccessStopFilter</filter-name>
075 *         <url-pattern>/jsp/*</url-pattern>
076 *     </filter-mapping>
077 *
078 * @og.group フィルター処理
079 *
080 * @version  4.0
081 * @author   Kazuhiko Hasegawa
082 * @since    JDK5.0,
083 */
084public final class AccessStopFilter implements Filter {
085
086        private static boolean useFilter = true ;               // 6.3.8.3 (2015/10/03)
087
088        private String startTime        = "230000";             // 停止開始時刻
089        private String stopTime         = "070000";             // 停止終了時刻
090        private String filename         = "jsp/custom/stopFile.html";   // 6.3.8.0 (2015/09/11) 停止時メッセージ表示ファイル名
091        private String passUsers        = "SYSTEM,admin";                               // 6.3.8.0 (2015/09/11) 停止中でもアクセス可能なユーザーID
092        private int    startStop        ;
093
094        /**
095         * フィルター処理本体のメソッドです。
096         *
097         * @og.rev 3.1.3.0 (2003/04/10) UTF-8 決め打ちで、stopFile.html を返送する。
098         * @og.rev 3.1.8.0 (2003/05/16) 文字エンコードが、UTF-8 になっていないのを修正。
099         * @og.rev 6.2.0.0 (2015/02/27) new BufferedReader … を、FileUtil.getBufferedReader … に変更。
100         * @og.rev 6.3.1.0 (2015/06/28) nioを使用すると UTF-8とShuft-JISで、エラーになる。
101         * @og.rev 6.3.8.3 (2015/10/03) フィルターの停止処理。
102         * @og.rev 6.5.0.1 (2016/10/21) CharacterCodingException は、OgCharacterException に変換する。
103         *
104         * @param       request         ServletRequestオブジェクト
105         * @param       response        ServletResponseオブジェクト
106         * @param       chain           FilterChainオブジェクト
107         * @throws IOException 入出力エラーが発生した場合、throw されます。
108         * @throws ServletException サーブレット関係のエラーが発生した場合、throw されます。
109         */
110        public void doFilter( final ServletRequest request,
111                                                        final ServletResponse response,
112                                                        final FilterChain chain) throws IOException, ServletException {
113
114                if( useFilter && isStop( request ) ) {                          // 6.3.8.3 (2015/10/03) フィルターの停止処理
115                        BufferedReader in = null ;
116                        try {
117                                response.setContentType( "text/html; charset=UTF-8" );
118                                final PrintWriter out = response.getWriter();
119                                in = FileUtil.getBufferedReader( new File( filename ), "UTF-8" );               // 6.2.0.0 (2015/02/27)
120                                String str ;
121                                while( (str = in.readLine()) != null ) {
122                                        out.println( str );
123                                }
124                                out.flush();
125                        }
126                        catch( final UnsupportedEncodingException ex ) {
127                                final String errMsg = "指定されたエンコーディングがサポートされていません。[UTF-8]" ;
128                                throw new OgRuntimeException( errMsg,ex );
129                        }
130                        // 6.3.1.0 (2015/06/28) nioを使用すると UTF-8とShuft-JISで、エラーになる。
131                        catch( final CharacterCodingException ex ) {
132                                final String errMsg = "文字のエンコード・エラーが発生しました。" + CR
133                                                                        +       "  ファイルのエンコードが指定のエンコードと異なります。" + CR
134                                                                        +       " [" + filename + "] , Encode=[UTF-8]" ;
135                                throw new OgCharacterException( errMsg,ex );    // 6.5.0.1 (2016/10/21)
136                        }
137                        catch( final IOException ex ) {
138                                final String errMsg = "ストリームがオープン出来ませんでした。[" + filename + "]" ;
139                                throw new OgRuntimeException( errMsg,ex );
140                        }
141                        finally {
142                                Closer.ioClose( in );
143                        }
144                        return;
145                }
146
147                chain.doFilter(request, response);
148        }
149
150        /**
151         * フィルターの初期処理メソッドです。
152         *
153         * フィルターに対してweb.xml で初期パラメータを設定します。
154         *   ・startTime:停止開始時刻 (初期値:230000)
155         *   ・stopTime :停止終了時刻 (初期値:070000)
156         *   ・filename :停止時メッセージ表示ファイル名 (初期値:jsp/custom/stopFile.html)
157         *   ・passUsers:停止中でもアクセス可能なユーザーID (初期値:SYSTEM,admin)
158         *   ・addUsers :停止中でもアクセス可能な追加ユーザーID (初期値:null)
159         *
160         * @og.rev 5.7.3.2 (2014/02/28) Tomcat8 対応。getRealPath( "/" ) の互換性のための修正。
161         * @og.rev 6.2.4.1 (2015/05/22) REAL_PATH 対応。realPath は、HybsSystem経由で、取得する。
162         * @og.rev 6.3.8.0 (2015/09/11) パラメータの初期値設定と、passUsers、addUsers 属性追加
163         *
164         * @param       filterConfig    FilterConfigオブジェクト
165         */
166        public void init( final FilterConfig filterConfig ) {
167                // 6.3.8.0 (2015/09/11) パラメータの初期値設定と、passUsers、addUsers 属性追加
168                startTime = StringUtil.nval( filterConfig.getInitParameter( "startTime" ) , startTime );
169                stopTime  = StringUtil.nval( filterConfig.getInitParameter( "stopTime"  ) , stopTime  );
170                filename  = HybsSystem.getRealPath()
171                                                + StringUtil.nval( filterConfig.getInitParameter( "filename" ) , filename );
172                passUsers = StringUtil.nval( filterConfig.getInitParameter( "passUsers"  ) , passUsers  )       // 6.3.8.0 (2015/09/11) 新規
173                                                + ',' + filterConfig.getInitParameter( "addUsers" ) ;
174
175                if( startTime == null || stopTime == null ) {
176                        startStop = 0;
177                }
178                else {
179                        startStop = startTime.compareTo( stopTime );
180                }
181        }
182
183        /**
184         * フィルターの終了処理メソッドです。
185         *
186         */
187        public void destroy() {
188                // ここでは処理を行いません。
189        }
190
191        /**
192         * フィルターの内部状態をチェックするメソッドです。
193         * 内部のフラグをもとに、停止/許可を求めます。
194         *
195         * @og.rev 3.1.8.0 (2003/05/16) 開始時刻と終了時刻を同一にしていると、画面からの制御が効かないバグを修正。
196         * @og.rev 5.5.3.2 (2012/06/08) 通過させるユーザーに、admin を追加します。
197         * @og.rev 5.5.7.2 (2012/10/09) HybsDateUtil を利用するように修正します。
198         * @og.rev 6.3.8.0 (2015/09/11) パラメータの初期値設定と、passUsers、addUsers 属性追加
199         * @og.rev 6.3.8.3 (2015/10/03) フィルターの停止処理。判定をdoFilterメソッドに移動。
200         *
201         * @param request ServletRequestオブジェクト
202         *
203         * @return      (true:停止  false:実行許可)
204         */
205        private boolean isStop( final ServletRequest request ) {
206                final String userID = ((HttpServletRequest)request).getRemoteUser() ;
207                // 5.5.3.2 (2012/06/08) 通過させるユーザーに、admin を追加
208                // 6.3.8.0 (2015/09/11) パラメータの初期値設定と、passUsers、addUsers 属性追加
209                if( passUsers.contains( userID ) ) { return false; }
210
211                // 4.0.0 (2005/01/31)
212                final String time = DateSet.getDate( "HHmmss" );                // 5.5.7.2 (2012/10/09) HybsDateUtil を利用
213
214                return  startStop < 0 && startTime.compareTo( time ) < 0 && time.compareTo( stopTime ) < 0 ||
215                                startStop > 0 && ( startTime.compareTo( time ) < 0 || time.compareTo( stopTime ) < 0 ) ;
216
217 //             boolean rtnFlag = stopFilter;
218 //             if( startStop < 0 ) {
219 //                     if( startTime.compareTo( time ) < 0 &&
220 //                             time.compareTo( stopTime )  < 0 ) {
221 //                                     rtnFlag = true;
222 //                     }
223 //             }
224 //             else if( startStop > 0 ) {
225 //                     if( startTime.compareTo( time ) < 0 ||
226 //                             time.compareTo( stopTime )  < 0 ) {
227 //                                     rtnFlag = true;
228 //                             }
229 //             }
230 //             return rtnFlag;
231        }
232
233        /**
234         * フィルターの実行/停止を設定するメソッドです。
235         *
236         * 初期値は、true:実行 です。
237         *
238         * @og.rev 4.0.0.0 (2005/01/31) synchronized の廃止
239         * @og.rev 6.3.8.3 (2015/10/03) フィルターの停止処理。メソッド名変更、引数の意味反転。
240         *
241         * @param flag (true:実行  false:停止)
242         */
243        public static void setUseFilter( final boolean flag ) {
244                useFilter = flag;
245        }
246
247        /**
248         * フィルターの内部状態(強制停止/解除)を取得するメソッドです。
249         * これは、現在、アクセス制限がどうなっているかという状態ではなく、
250         * 強制停止されているかどうかの確認メソッドです。
251         *
252         * @og.rev 4.0.0.0 (2007/11/29) getStopFilter() ⇒ isStopFilter() に変更
253         * @og.rev 6.3.8.3 (2015/10/03) フィルターの停止処理。メソッド名変更、戻り値の意味反転。
254         *
255         * @return      (true:実行  false:停止)
256         */
257        public static boolean isUseFilter() {
258                return useFilter;
259        }
260
261        /**
262         * 内部状態を文字列で返します。
263         *
264         * @return      このクラスの文字列表示
265         * @og.rtnNotNull
266         */
267        @Override
268        public String toString() {
269                final StringBuilder sb = new StringBuilder( BUFFER_MIDDLE )
270                        .append( "AccessStopFilter" )
271                        .append( '[' ).append( startTime ).append( "],")                // 6.0.2.5 (2014/10/31) char を append する。
272                        .append( '[' ).append( stopTime  ).append( "],")
273                        .append( '[' ).append( filename  ).append( "],");
274                return sb.toString();
275        }
276}