/*
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 1999 The Apache Software Foundation.  All rights 
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer. 
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution, if
 *    any, must include the following acknowlegement:  
 *       "This product includes software developed by the 
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowlegement may appear in the software itself,
 *    if and wherever such third-party acknowlegements normally appear.
 *
 * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
 *    Foundation" must not be used to endorse or promote products derived
 *    from this software without prior written permission. For written 
 *    permission, please contact apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache"
 *    nor may "Apache" appear in their names without prior written
 *    permission of the Apache Group.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 *
 */ 

package javax.servlet.jsp.jstl.core;

import javax.servlet.ServletContext;
import javax.servlet.ServletRequest;
import javax.servlet.jsp.PageContext;
import javax.servlet.http.HttpSession;

/**
 * コンフィギュレーションデータへのアクセスをサポートするクラス
 * @author 
 */
public class Config {

    /*
     * I18N/Formatting アクション関係のコンフィギュレーションデータ
     */
    
    /**
     * アプリケーション・ベース（通常はブラウザ）のロケール(このロケールが優先されます）のコンフィギュレーション名
     */
    public static final String FMT_LOCALE
	= "javax.servlet.jsp.jstl.fmt.locale";

    /**
     * fallbackロケール（訳注　FMT_LOCALEが指定されていないときに使用するロケール）のコンフィギュレーション名
     */
    public static final String FMT_FALLBACK_LOCALE
	= "javax.servlet.jsp.jstl.fmt.fallbackLocale";

    /**
     * 国際化対応(i18n)地域化コンテキストのためのコンフィギュレーション名
     */
    public static final String FMT_LOCALIZATION_CONTEXT
	= "javax.servlet.jsp.jstl.fmt.localizationContext";

    /**
     * タイムゾーンのための地域化設定名
     */
    public static final String FMT_TIME_ZONE
	= "javax.servlet.jsp.jstl.fmt.timeZone";

    /*
     * SQLアクション関連のコンフィギュレーションデータ
     */

    /**
     * SQLデータソースのためのコンフィギュレーション名
     */
    public static final String SQL_DATA_SOURCE
	= "javax.servlet.jsp.jstl.sql.dataSource";

    /**
     * SQLクエリーの結果に含まれる行数の最大値を設定するためのコンフィギュレーション名
     */
    public static final String SQL_MAX_ROWS
	= "javax.servlet.jsp.jstl.sql.maxRows";
	
    /*
     * Private定数
     */
    private static final String PAGE_SCOPE_SUFFIX = ".page";
    private static final String REQUEST_SCOPE_SUFFIX = ".request";
    private static final String SESSION_SCOPE_SUFFIX = ".session";
    private static final String APPLICATION_SCOPE_SUFFIX = ".application";

    /**
     * 与えられたスコープで有効なコンフィギュレーション変数を取得します．
     *
     * <p> コンフィギュレーション変数の取得は，
     * それぞれのスコープが，それぞれの名前空間を持つかのように，実行されます．
     * つまり，あるスコープの同じコンフィギュレーション変数名は，
     * 他のスコープに保持されている変数を置き換えることはありません．
     *
     * @param pc 取得対象のコンフィギュレーション変数を含むページコンテキスト
     * @param name コンフィギュレーション変数名
     * @param scope 取得対象のコンフィギュレーション変数のスコープ
     *
     * @return コンフィグレーション変数を指す<tt>java.lang.Object</tt>，
     * または，変数が定義されていない場合は null
     */
    public static Object get(PageContext pc, String name, int scope) {
	switch (scope) {
	case PageContext.PAGE_SCOPE:
	    return pc.getAttribute(name + PAGE_SCOPE_SUFFIX, scope);
	case PageContext.REQUEST_SCOPE:
	    return pc.getAttribute(name + REQUEST_SCOPE_SUFFIX, scope);
	case PageContext.SESSION_SCOPE:
	    return pc.getAttribute(name + SESSION_SCOPE_SUFFIX, scope);
	case PageContext.APPLICATION_SCOPE:
	    return pc.getAttribute(name + APPLICATION_SCOPE_SUFFIX, scope);
	default:
	    throw new IllegalArgumentException("unknown scope");
	}
    }

    /**
     * "request" スコープのコンフィギュレーション変数を取得します．
     *
     * <p> コンフィギュレーション変数の取得は，
     * それぞれのスコープが，それぞれの名前空間を持つかのように，実行されます．
     * つまり，あるスコープの同じコンフィギュレーション変数名は，
     * 他のスコープに保持されている変数を置き換えることはありません．
     *
     * @param request 取得対象のコンフィギュレーション変数を含むRequestオブジェクト
     * @param name コンフィギュレーション変数名
     *
     * @return コンフィグレーション変数を指す<tt>java.lang.Object</tt>，
     * または，変数が定義されていない場合は null
     */
    public static Object get(ServletRequest request, String name) {
	return request.getAttribute(name + REQUEST_SCOPE_SUFFIX);
    }

    /**
     * "session" スコープのコンフィギュレーション変数を取得します．
     *
     * <p> コンフィギュレーション変数の取得は，
     * それぞれのスコープが，それぞれの名前空間を持つかのように，実行されます．
     * つまり，あるスコープの同じコンフィギュレーション変数名は，
     * 他のスコープに保持されている変数を置き換えることはありません．
     *
     * @param session 取得対象のコンフィギュレーション変数を含むSessionオブジェクト
     * @param name コンフィギュレーション変数名
     *
     * @return コンフィグレーション変数を指す<tt>java.lang.Object</tt>，
     * または，変数が定義されていない場合は null
     */
    public static Object get(HttpSession session, String name) {
	return session.getAttribute(name + SESSION_SCOPE_SUFFIX);
    }

    /**
     * "application" スコープのコンフィギュレーション変数を取得します．
     *
     * <p> コンフィギュレーション変数の取得は，
     * それぞれのスコープが，それぞれの名前空間を持つかのように，実行されます．
     * つまり，あるスコープの同じコンフィギュレーション変数名は，
     * 他のスコープに保持されている変数を置き換えることはありません．
     *
     * @param context 取得対象のコンフィギュレーション変数を含むServletコンテキスト
     * @param name コンフィギュレーション変数名
     *
     * @return コンフィグレーション変数を指す<tt>java.lang.Object</tt>，
     * または，変数が定義されていない場合は null
     */
    public static Object get(ServletContext context, String name) {
	return context.getAttribute(name + APPLICATION_SCOPE_SUFFIX);
    }

    /**
     * 指定されたスコープのコンフィギュレーション変数の値を設定します．
     *
     * <p> コンフィギュレーション変数の設定は，
     * それぞれのスコープが，それぞれの名前空間を持つかのように，実行されます．
     * つまり，あるスコープの同じコンフィギュレーション変数名は，
     * 他のスコープに保持されている変数を置き換えることはありません．
     *
     * @param pc 設定をするコンフィギュレーション変数を含むPageコンテキスト
     * @param name コンフィギュレーション変数名
     * @param value コンフィギュレーション変数値
     * @param scope 設定をするコンフィギュレーション変数のスコープ
     */
    public static void set(PageContext pc, String name, Object value,
			   int scope) {
	switch (scope) {
	case PageContext.PAGE_SCOPE:
	    pc.setAttribute(name + PAGE_SCOPE_SUFFIX, value, scope);
	    break;
	case PageContext.REQUEST_SCOPE:
	    pc.setAttribute(name + REQUEST_SCOPE_SUFFIX, value, scope);
	    break;
	case PageContext.SESSION_SCOPE:
	    pc.setAttribute(name + SESSION_SCOPE_SUFFIX, value, scope);
	    break;
	case PageContext.APPLICATION_SCOPE:
	    pc.setAttribute(name + APPLICATION_SCOPE_SUFFIX, value, scope);
	    break;
	default:
	    throw new IllegalArgumentException("unknown scope");
	}
    }

    /**
     * "request" スコープのコンフィギュレーション変数の値を設定します．
     *
     * <p> コンフィギュレーション変数の設定は，
     * それぞれのスコープが，それぞれの名前空間を持つかのように，実行されます．
     * つまり，あるスコープの同じコンフィギュレーション変数名は，
     * 他のスコープに保持されている変数を置き換えることはありません．
     *
     * @param request 設定をするコンフィギュレーション変数を含むRequestオブジェクト
     * @param name コンフィギュレーション変数名
     * @param value コンフィギュレーション変数値
     */
    public static void set(ServletRequest request, String name, Object value) {
	request.setAttribute(name + REQUEST_SCOPE_SUFFIX, value);
    }

    /**
     * "session" スコープのコンフィギュレーション変数の値を設定します．
     *
     * <p> コンフィギュレーション変数の設定は，
     * それぞれのスコープが，それぞれの名前空間を持つかのように，実行されます．
     * つまり，あるスコープの同じコンフィギュレーション変数名は，
     * 他のスコープに保持されている変数を置き換えることはありません．
     *
     * @param session 設定をするコンフィギュレーション変数を含むSessionオブジェクト
     * @param name コンフィギュレーション変数名
     * @param value コンフィギュレーション変数値
     */
    public static void set(HttpSession session, String name, Object value) {
	session.setAttribute(name + SESSION_SCOPE_SUFFIX, value);
    }

    /**
     * "application" スコープのコンフィギュレーション変数の値を設定します．
     *
     * <p> コンフィギュレーション変数の設定は，
     * それぞれのスコープが，それぞれの名前空間を持つかのように，実行されます．
     * つまり，あるスコープの同じコンフィギュレーション変数名は，
     * 他のスコープに保持されている変数を置き換えることはありません．
     *
     * @param context 設定をするコンフィギュレーション変数を含むServletコンテキスト
     * @param name コンフィギュレーション変数名
     * @param value コンフィギュレーション変数値
     */
    public static void set(ServletContext context, String name, Object value) {
	context.setAttribute(name + APPLICATION_SCOPE_SUFFIX, value);
    }
 
    /**
     * 指定されたスコープからコンフィギュレーション変数を削除します．
     *
     * <p> コンフィギュレーション変数の削除は，
     * それぞれのスコープが，それぞれの名前空間を持つかのように，実行されます．
     * つまり，あるスコープの同じコンフィギュレーション変数名は，
     * 他のスコープに保持されている変数を置き換えることはありません．
     *
     * @param pc 削除するコンフィギュレーション変数を含むPageコンテキスト
     * @param name コンフィギュレーション変数名
     * @param scope 削除するコンフィギュレーション変数のスコープ
     */
    public static void remove(PageContext pc, String name, int scope) {
	switch (scope) {
	case PageContext.PAGE_SCOPE:
	    pc.removeAttribute(name + PAGE_SCOPE_SUFFIX, scope);
	    break;
	case PageContext.REQUEST_SCOPE:
	    pc.removeAttribute(name + REQUEST_SCOPE_SUFFIX, scope);
	    break;
	case PageContext.SESSION_SCOPE:
	    pc.removeAttribute(name + SESSION_SCOPE_SUFFIX, scope);
	    break;
	case PageContext.APPLICATION_SCOPE:
	    pc.removeAttribute(name + APPLICATION_SCOPE_SUFFIX, scope);
	    break;
	default:
	    throw new IllegalArgumentException("unknown scope");
	}
    }

    /**
     * "request" スコープからコンフィギュレーション変数を削除します．
     *
     * <p> コンフィギュレーション変数の削除は，
     * それぞれのスコープが，それぞれの名前空間を持つかのように，実行されます．
     * つまり，あるスコープの同じコンフィギュレーション変数名は，
     * 他のスコープに保持されている変数を置き換えることはありません．
     * 
     * @param request 削除するコンフィギュレーション変数を含むRequestオブジェクト
     * @param name コンフィギュレーション変数名
     */
    public static void remove(ServletRequest request, String name) {
	request.removeAttribute(name + REQUEST_SCOPE_SUFFIX);
    }

    /**
     * "session" スコープからコンフィギュレーション変数を削除します．
     *
     * <p> コンフィギュレーション変数の削除は，
     * それぞれのスコープが，それぞれの名前空間を持つかのように，実行されます．
     * つまり，あるスコープの同じコンフィギュレーション変数名は，
     * 他のスコープに保持されている変数を置き換えることはありません．
     *
     * @param session 削除するコンフィギュレーション変数を含むSessionオブジェクト
     * @param name コンフィギュレーション変数名
     */
    public static void remove(HttpSession session, String name) {
	session.removeAttribute(name + SESSION_SCOPE_SUFFIX);
    }

    /**
     * "application" スコープからコンフィギュレーション変数を削除します．
     *
     * <p> コンフィギュレーション変数の削除は，
     * それぞれのスコープが，それぞれの名前空間を持つかのように，実行されます．
     * つまり，あるスコープの同じコンフィギュレーション変数名は，
     * 他のスコープに保持されている変数を置き換えることはありません．
     *
     * @param context 削除するコンフィギュレーション変数を含むServletコンテキスト
     * @param name コンフィギュレーション変数名
     */
    public static void remove(ServletContext context, String name) {
	context.removeAttribute(name + APPLICATION_SCOPE_SUFFIX);
    }
 
    /**
     * コンテキスト初期化パラメータ名によって識別される特別なコンフィギュレーション設定
     * と関連した値を見つけます．
     *
     * <p> JSP スコープ (page, request, session, application) それぞれについて,
     * <tt>get</tt>メソッドを用いて，
     * <tt>名(name)</tt>によって識別されるコンフィギュレーション変数の値を取得します．
     * nullでない値を発見した時点で値を返します．
     * もし値を発見できなかった場合は<tt>名(name)</tt>によって識別される
     * コンテキスト初期化パラメータの値を取得します．
     *
     * @param pc 探索をするコンフィギュレーション設定を含むPageコンテキスト
     * @param name コンフィギュレーション設定のコンテキスト初期化パラメータ名
     * 
     * @return <tt>名(name)</tt>によって識別されるコンフィグレーション設定を指す<tt>java.lang.Object</tt>，
     * または，変数が定義されていない場合は null
     */
    public static Object find(PageContext pc, String name) {
	Object ret = get(pc, name, PageContext.PAGE_SCOPE);
	if (ret == null) {
	    ret = get(pc, name, PageContext.REQUEST_SCOPE);
	    if (ret == null) {
		if (pc.getSession() != null) {
		    // check session only if a session is present
		    ret = get(pc, name, PageContext.SESSION_SCOPE);
		}
		if (ret == null) {
		    ret = get(pc, name, PageContext.APPLICATION_SCOPE);
		    if (ret == null) {
			ret = pc.getServletContext().getInitParameter(name);
		    }
		}
	    }
	}

	return ret;
    }
}