/*
 * Copyright (c) 2009 The openGion Project.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied. See the License for the specific language
 * governing permissions and limitations under the License.
 */
package org.opengion.hayabusa.filter;

import java.io.File;							// 5.7.3.2 (2014/02/28) Tomcat8 対応
import java.io.BufferedReader;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.PrintWriter;
import java.io.UnsupportedEncodingException;

import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletRequest;

import org.opengion.fukurou.security.HybsCryptography;
import org.opengion.fukurou.util.Closer;
import org.opengion.fukurou.util.StringUtil;
import org.opengion.hayabusa.common.HybsSystem;

/**
 * URLCheckFilter は、Filter インターフェースを継承した URLチェッククラスです。
 * web.xml で filter 設定することにより、該当のリソースに対して、og:linkタグで、
 * useURLCheck="true"が指定されたリンクURL以外を拒否することができます。
 * また、og:linkタグを経由した場合でも、リンクの有効期限を設定することで、
 * リンクURLの漏洩に対しても、一定時間の経過を持って、アクセスを拒否することができます。
 * また、リンク時にユーザー情報も埋め込んでいますので(初期値は、ログインユーザー)、
 * リンクアドレスが他のユーザーに知られた場合でも、アクセスを拒否することができます。
 * 
 * システムリソースの「URL_CHECK_CRYPT」で暗号復号化のキーを指定可能です。
 * 指定しない場合はデフォルトのキーが利用されます。
 * キーの形式はHybsCryptographyに従います。
 *
 * フィルターに対してweb.xml でパラメータを設定します。
 *   ・debug	:標準出力に状況を表示します(true/false)
 *   ・filename :停止時メッセージ表示ファイル名
 *   ・ignoreURL:暗号化されたURLのうち空白に置き換える接頭文字列を指定します。
 *   			外部からアクセスしたURLがロードバランサで内部向けURLに変換されてチェックが動作しないような場合に
 *   			利用します。https://wwwX.のように指定します。通常は設定しません。
 *   ・ommitURL :正規表現で、URLチェックを行わないパターンを記載します
 *   ・ommitReferer:ドメイン(ホスト名)を指定すると、このRefererを持つものはURLチェックを行いません。
 *              内部の遷移はチェックを行わず、外部からのリンクのみチェックを行う場合に利用します。
 *   ・ignoreRelative:trueにすると暗号化されたURLのうち、相対パスの箇所(../)を削除して評価します。 
 *
 * 【WEB-INF/web.xml】
 *     &lt;filter&gt;
 *         &lt;filter-name&gt;URLCheckFilter&lt;/filter-name&gt;
 *         &lt;filter-class&gt;org.opengion.hayabusa.filter.URLCheckFilter&lt;/filter-class&gt;
 *         &lt;init-param&gt;
 *             &lt;param-name&gt;filename&lt;/param-name&gt;
 *             &lt;param-value&gt;jsp/custom/refuseAccess.html&lt;/param-value&gt;
 *         &lt;/init-param&gt;
 *     &lt;/filter&gt;
 *
 *     &lt;filter-mapping&gt;
 *         &lt;filter-name&gt;URLCheckFilter&lt;/filter-name&gt;
 *         &lt;url-pattern&gt;/jsp/*&lt;/url-pattern&gt;
 *     &lt;/filter-mapping&gt;
 *
 * @og.group フィルター処理
 *
 * @version  4.0
 * @author   Hiroki Nakamura
 * @since    JDK5.0,
 */
public final class URLCheckFilter implements Filter {

//	private static final HybsCryptography HYBS_CRYPTOGRAPHY = new HybsCryptography(); // 4.3.7.0 (2009/06/01)
	private static final HybsCryptography HYBS_CRYPTOGRAPHY 
						= new HybsCryptography( HybsSystem.sys( "URL_CHECK_CRYPT" ) ); // 5.8.8.0 (2015/06/05)
	
	private static final String  USERID_HEADER = HybsSystem.sys( "USERID_HEADER_NAME" ); // 5.10.18.0 (2019/11/29)

	private String	filename  = null;			// アクセス拒否時メッセージ表示ファイル名
//	private int		maxInterval = 3600;			// リンクの有効期限
	private boolean  isDebug	 = false;
	private boolean  isDecode	 = true;		// 5.4.5.0(2012/02/28) URIDecodeするかどうか
	
	private String		ignoreURL	= null; //5.8.6.1 (2015/04/17) 飛んできたcheckURLから取り除くURL文字列
	private String		ignoreRelative = "false"; // 5.10.18.1 (2019/12/09) 相対パスの../を無視する
	private String		ommitURL	= null; // 5.10.11.0 (2019/05/03) URLチェックを行わないURLの正規表現
	private String		ommitReferer	= null; // 5.10.11.0 (2019/05/03) URLチェックを行わないドメイン
	
	private String encoding = "utf-8";	// 5.10.12.4 (2019/06/21) 日本語対応

	/**
	 * フィルター処理本体のメソッドです。
	 * 
	 * @og.rev 5.10.12.4 (2019/06/21) 日本語対応(encoding指定)
	 * @og.rev 5.10.16.1 (2019/10/11) デバッグ追加
	 *
	 * @param	request		ServletRequestオブジェクト
	 * @param	response	ServletResponseオブジェクト
	 * @param	chain		FilterChainオブジェクト
	 * @throws ServletException サーブレット関係のエラーが発生した場合、throw されます。
	 */
	public void doFilter( final ServletRequest request, final ServletResponse response, final FilterChain chain ) throws IOException, ServletException {
		request.setCharacterEncoding(encoding); // 5.10.12.1 (2019/06/21)
		
		if( !isValidAccess( request ) ) {
			if( isDebug ) {
				System.out.println( "  check NG... " ); // 5.10.16.1 
			}
			BufferedReader in = null ;
			try {
				response.setContentType( "text/html; charset=UTF-8" );
				PrintWriter out = response.getWriter();
				in = new BufferedReader( new InputStreamReader(
								new FileInputStream( filename ) ,"UTF-8" ) );
				String str ;
				while( (str = in.readLine()) != null ) {
					out.println( str );
				}
				out.flush();
			}
			catch( UnsupportedEncodingException ex ) {
				String errMsg = "指定されたエンコーディングがサポートされていません。[UTF-8]" ;
				throw new RuntimeException( errMsg,ex );
			}
			catch( IOException ex ) {
				String errMsg = "ストリームがオープン出来ませんでした。[" + filename + "]" ;
				throw new RuntimeException( errMsg,ex );
			}
			finally {
				Closer.ioClose( in );
			}
			return;
		}
		
		request.setAttribute( "RequestEncoding", encoding ); // 5.10.12.1 (2019/06/21) リクエスト変数で送信しておく

		chain.doFilter(request, response);
	}

	/**
	 * フィルターの初期処理メソッドです。
	 *
	 * フィルターに対してweb.xml で初期パラメータを設定します。
	 *   ・maxInterval:リンクの有効期限
	 *   ・filename   :停止時メッセージ表示ファイル名
	 *   ・decode     :URLデコードを行ってチェックするか(初期true)
	 *
	 * @og.rev 5.4.5.0 (2102/02/28)
	 * @og.rev 5.7.3.2 (2014/02/28) Tomcat8 対応。getRealPath( "/" ) の互換性のための修正。
	 * @og.rev 5.8.6.1 (2015/04/17) DMZのURL変換対応
	 * @og.rev 5.10.11.0 (2019/05/03) ommitURL,ommitReferer
	 * @og.rev 5.10.12.4 (2019/06/21) encoding
	 * @og.rev 5.10.18.1 (2019/12/09) 相対パス対応
	 *
	 * @param filterConfig FilterConfigオブジェクト
	 */
	public void init(final FilterConfig filterConfig) {
		ServletContext context = filterConfig.getServletContext();
//		String realPath = context.getRealPath( "/" );
		String realPath = context.getRealPath( "" ) + File.separator;		// 5.7.3.2 (2014/02/28) Tomcat8 対応

//		maxInterval = StringUtil.nval( filterConfig.getInitParameter("maxInterval"), maxInterval );
		filename  = realPath + filterConfig.getInitParameter("filename");
		isDebug = StringUtil.nval( filterConfig.getInitParameter("debug"), false );
		isDecode = StringUtil.nval( filterConfig.getInitParameter("decode"), true ); // 5.4.5.0(2012/02/28)
		ignoreURL = filterConfig.getInitParameter("ignoreURL");	// 5.8.6.1 (2015/04/17)
		ignoreRelative = filterConfig.getInitParameter("ignoreRelative"); // 5.10.18.1 (2019/12/09)
		ommitURL = filterConfig.getInitParameter("ommitURL"); // 5.10.11.0 (2019/05/03)	
		ommitReferer = filterConfig.getInitParameter("ommitReferer"); // 5.10.11.0 (2019/05/03)	
		encoding = StringUtil.nval( filterConfig.getInitParameter("encoding"), encoding ); // 5.10.12.4 (2019/06/21)
	}

	/**
	 * フィルターの終了処理メソッドです。
	 *
	 */
	public void destroy() {
		// ここでは処理を行いません。
	}

	/**
	 * フィルターの内部状態をチェックするメソッドです。
	 *
	 * @og.rev 5.4.5.0 (2012/02/28) Decode
	 * @og.rev 5.8.8.2 (2015/07/17) マルチバイト対応追加
	 * @og.rev 5.10.16 (2019/10/11) デバッグ追加
	 * @og.rev 5.10.18.0 (2019/11/29) ヘッダ認証 
	 * @og.rev 5.10.18.1 (2019/12/09) 相対パス対応
	 *
	 * @param request ServletRequestオブジェクト
	 *
	 * @return	(true:許可  false:拒否)
	 */
	private boolean isValidAccess( final ServletRequest request ) {
		String checkKey = request.getParameter( HybsSystem.URL_CHECK_KEY );
		// 5.10.11.0 (2019/05/03) データ取得位置変更
		String queryStr = ((HttpServletRequest)request).getQueryString();
		String reqStr =  ((HttpServletRequest)request).getRequestURL().toString();
		String referer = ((HttpServletRequest)request).getHeader("REFERER");
		
		// 5.10.11.0 referer判定追加
		// 入っている場合はtrueにする。
		if(referer != null && ommitReferer != null && referer.indexOf( ommitReferer ) >= 0 ) {
			if( isDebug ) {
				System.out.println("URLCheck ommitRef"+reqStr);
			}
			return true;
		}
		
		// リクエスト変数をURLに追加
		reqStr = reqStr + (queryStr != null ? "?" + queryStr : "");
		
		// 5.10.11.0 ommitURL追加
		// ommitに合致する場合はtrueにする。
		if(ommitURL != null && reqStr.matches( ommitURL )) {
			if( isDebug ) {
				System.out.println("URLCheck ommitURL"+reqStr);
			}
			return true;
		}
		
		if( checkKey == null || checkKey.length() == 0 ) {
			if( isDebug ) {
				System.out.println( "  check NG [ No Check Key ] = " + reqStr ); // 5.10.16.1 (2019/10/11) reqStr追加
			}
			return false;
		}

		boolean rtn = false;
		try {
			checkKey = HYBS_CRYPTOGRAPHY.decrypt( checkKey ).replace( "&amp;", "&" );

			if( isDebug ) {
				System.out.println( "checkKey=" + checkKey );
			}

			String url = checkKey.substring( 0 , checkKey.lastIndexOf( ",time=") );
			long time = Long.parseLong( checkKey.substring( checkKey.lastIndexOf( ",time=") + 6, checkKey.lastIndexOf( ",userid=" ) ) );
			String userid = checkKey.substring( checkKey.lastIndexOf( ",userid=") + 8 );
			// 4.3.8.0 (2009/08/01)
			String[] userArr = StringUtil.csv2Array( userid );
			
			// 5.8.6.1 (2015/04/17)ignoreURL対応
			if( ignoreURL!=null && ignoreURL.length()>0 && url.indexOf( ignoreURL ) == 0 ){
				url = url.substring( ignoreURL.length() );
			}
			
			// 5.10.18.1 (2019/12/09) ../を削除
			if ( "true".equals( ignoreRelative ) ) {
				url = url.replaceAll( "\\.\\./", "" ); 
			}
			

			if( isDebug ) {
				System.out.println( " [ignoreURL]=" + ignoreURL ); // 2015/04/17 (2015/04/17)
				System.out.println( " [ignoreRelative]=" + ignoreRelative );
				System.out.println( " [url]    =" + url );
				System.out.println( " [vtime]  =" + time );
				System.out.println( " [userid] =" + userid );
			}

			
			// 5.4.5.0 (2012/02/28) URLDecodeを行う
			if(isDecode){
				if( isDebug ) {
					System.out.println( "[BeforeURIDecode]="+reqStr );
				}
				reqStr = StringUtil.urlDecode( reqStr );
				url = StringUtil.urlDecode( url ); // 5.8.8.2 (2015/07/17)
			}
			reqStr = reqStr.substring( 0, reqStr.lastIndexOf( HybsSystem.URL_CHECK_KEY ) -1 );
			//	String reqStr =  ((HttpServletRequest)request).getRequestURL().toString();
			// String reqUser = ((HttpServletRequest)request).getRemoteUser();
			String reqUser = ((HttpServletRequest)request).getRemoteUser() ; // 5.10.18.0 (2019/11/29)
			if( USERID_HEADER != null && USERID_HEADER.length() > 0 && ( reqUser == null || reqUser.length() == 0) ) {
				reqUser = ((HttpServletRequest)request).getHeader( USERID_HEADER );
			}
			

			if( isDebug ) {
				System.out.println( " [reqURL] =" + reqStr );
				System.out.println( " [ctime]  =" + System.currentTimeMillis() );
				System.out.println( " [reqUser]=" + reqUser );
				System.out.println( " endWith=" + reqStr.endsWith( url ) );
				System.out.println( " times=" + (System.currentTimeMillis() - time) );
				System.out.println( " [userArr.length]=" + userArr.length );
			}

			if( reqStr.endsWith( url )
//					&& System.currentTimeMillis() - time < maxInterval * 1000
					&& System.currentTimeMillis() - time < 0
//					&& userid.equals( reqUser ) ) {
					&& userArr != null && userArr.length > 0 ) {

				// 4.3.8.0 (2009/08/01)
				for( int i=0; i<userArr.length; i++ ) {
					if( isDebug ) {
						System.out.println( " [userArr] =" + userArr[i] ); // 5.10.16.1 
					}
					if( "*".equals( userArr[i] ) || reqUser.equals( userArr[i] ) ) {
						rtn = true;
						if( isDebug ) {
							System.out.println( "  check OK" );
						}
						break;
					}
				}
			}
		}
		catch( RuntimeException ex ) {
			if( isDebug ) {
				String errMsg = "チェックエラー。 "
							+ " checkKey=" + checkKey
							+ " " + ex.getMessage();			// 5.1.8.0 (2010/07/01) errMsg 修正
				System.out.println( errMsg );
				ex.printStackTrace();
			}
			rtn = false;
		}
		return rtn;
	}

	/**
	 * 内部状態を文字列で返します。
	 *
	 * @return	このクラスの文字列表示
	 */
	@Override
	public String toString() {
		StringBuilder sb = new StringBuilder();
		sb.append( "UrlCheckFilter" );
//		sb.append( "[" ).append( maxInterval ).append( "],");
		sb.append( "[" ).append( filename  ).append( "],");
		return (sb.toString());
	}
}
