/*
============================================================================
The Apache Software License, Version 1.1
============================================================================
Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved.
Redistribution and use in source and binary forms, with or without modifica-
tion, 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 acknowledgment: "This product includes software
developed by the Apache Software Foundation (http://www.apache.org/)."
Alternately, this acknowledgment may appear in the software itself, if
and wherever such third-party acknowledgments normally appear.
4. The names "Apache Cocoon" 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 name, without prior written permission of the
Apache Software Foundation.
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 (INCLU-
DING, 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 and was originally created by
Stefano Mazzocchi <stefano@apache.org>. For more information on the Apache
Software Foundation, please see <http://www.apache.org/>.
*/
package org.apache.cocoon.acting;
import java.util.HashMap;
import java.util.Locale;
import java.util.Map;
import org.apache.avalon.framework.configuration.Configurable;
import org.apache.avalon.framework.configuration.Configuration;
import org.apache.avalon.framework.configuration.ConfigurationException;
import org.apache.avalon.framework.parameters.Parameters;
import org.apache.avalon.framework.thread.ThreadSafe;
import org.apache.cocoon.environment.Cookie;
import org.apache.cocoon.environment.ObjectModelHelper;
import org.apache.cocoon.environment.Redirector;
import org.apache.cocoon.environment.Request;
import org.apache.cocoon.environment.Response;
import org.apache.cocoon.environment.Session;
import org.apache.cocoon.environment.SourceResolver;
import org.apache.cocoon.i18n.I18nUtils;
/**
* LocaleAction is a class which obtains the request's locale information
* (language, country, variant) and makes it available to the
* sitemap/pipeline.
*
* Definition in sitemap:
* <pre>
* <map:actions>
* <map:action name="locale" src="org.apache.cocoon.acting.LocaleAction"/>
* </map:actions>
* </pre>
*
* Examples:
*
* <pre>
* <map:match pattern="file">
* <map:act type="locale">
* <map:generate src="file_{lang}{country}{variant}.xml"/>
* </map:act>
* </map:match>
* </pre>
*
* or
*
* <pre>
* <map:match pattern="file">
* <map:act type="locale">
* <map:generate src="file.xml?locale={locale}"/>
* </map:act>
* </map:match>
* </pre>
*
* <br>
*
* The variables <code>lang</code>, <code>country</code>,
* <code>variant</code>, and <code>locale</code> are all available. Note that
* <code>country</code> and <code>variant</code> can be empty, however
* <code>lang</code> and <code>locale</code> will always contain a valid value.
*
* <br>
*
* The following search criteria are used in order when ascertaining locale
* values:
*
* <ol>
* <li>Request CGI parameter <i>locale</i></li>
* <li>Session attribute <i>locale</i></li>
* <li>First matching Cookie parameter <i>locale</i>
* within each cookie sent with the current request</li>
* <li>Locale setting of the requesting object</li>
* </ol>
*
* (in the case of language, if the above cases do not yield a valid value
* the locale value of the server is used)
*
* <br>
*
* The attribute names can be configured/customized at action definition
* using the configuration paramters
* {language,country,variant,locale}-attribute.
*
* eg.
*
* <pre>
* <map:action name="locale" src="org.apache.cocoon.acting.LocaleAction">
* <language-attribute>lg</language-attribute>
* </map:action>
* </pre>
*
* or:
*
* <center>Code originated from org.apache.cocoon.acting.LangSelect</center>
*
* @author <a href="mailto:Marcus.Crafter@osa.de">Marcus Crafter</a>
* @author <a href="mailto:kpiroumian@flagship.ru">Konstantin Piroumian</a>
* @author <a href="mailto:lassi.immonen@valkeus.com">Lassi Immonen</a>
* @version CVS $Id: LocaleAction.java,v 1.2 2003/10/15 20:47:14 cziegeler Exp $
*/
public class LocaleAction extends ServiceableAction implements ThreadSafe, Configurable {
/**
* Constant representing the language parameter
*/
public static final String LANG = "lang";
/**
* Constant representing the country parameter
*/
public static final String COUNTRY = "country";
/**
* Constant representing the variant parameter
*/
public static final String VARIANT = "variant";
/**
* Constant representing the locale parameter
*/
public static final String LOCALE = "locale";
/**
* Constant representing the language configuration attribute
*/
public static final String LANG_ATTR = "language-attribute";
/**
* Constant representing the country configuration attribute
*/
public static final String COUNTRY_ATTR = "country-attribute";
/**
* Constant representing the variant configuration attribute
*/
public static final String VARIANT_ATTR = "variant-attribute";
/**
* Constant representing the locale configuration attribute
*/
public static final String LOCALE_ATTR = "locale-attribute";
/**
* Constant representing the request storage configuration attribute
*/
public static final String STORE_REQUEST = "store-in-request";
/**
* Constant representing the session creation configuration attribute
*/
public static final String CREATE_SESSION = "create-session";
/**
* Constant representing the session storage configuration attribute
*/
public static final String STORE_SESSION = "store-in-session";
/**
* Constant representing the cookie storage configuration attribute
*/
public static final String STORE_COOKIE = "store-in-cookie";
// Store the lang in request. Default is not to do this.
private boolean storeInRequest = false;
// Store the lang in session, if available. Default is not to do this.
private boolean storeInSession = false;
// Should we create a session if needed. Default is not to do this.
private boolean createSession = false;
// Should we add a cookie with the lang. Default is not to do this.
private boolean storeInCookie = false;
// Configuration attributes.
private String langAttr;
private String countryAttr;
private String variantAttr;
private String localeAttr;
/**
* Configure this action.
*
* @param conf configuration information (if any)
*/
public void configure(Configuration conf)
throws ConfigurationException {
Configuration child = conf.getChild(STORE_REQUEST);
storeInRequest = child.getValueAsBoolean(false);
if (getLogger().isDebugEnabled()) {
getLogger().debug((storeInRequest ? "will" : "won't") + " set values in request");
}
child = conf.getChild(CREATE_SESSION);
createSession = child.getValueAsBoolean(false);
if (getLogger().isDebugEnabled()) {
getLogger().debug((createSession ? "will" : "won't") + " create session");
}
child = conf.getChild(STORE_SESSION);
storeInSession = child.getValueAsBoolean(false);
if (getLogger().isDebugEnabled()) {
getLogger().debug((storeInSession ? "will" : "won't") + " set values in session");
}
child = conf.getChild(STORE_COOKIE);
storeInCookie = child.getValueAsBoolean(false);
if (getLogger().isDebugEnabled()) {
getLogger().debug((storeInCookie ? "will" : "won't") + " set values in cookies");
}
child = conf.getChild(LANG_ATTR);
langAttr = child.getValue(LANG);
if (getLogger().isDebugEnabled()) {
getLogger().debug("global language attribute name is " + langAttr);
}
child = conf.getChild(COUNTRY_ATTR);
countryAttr = child.getValue(COUNTRY);
if (getLogger().isDebugEnabled()) {
getLogger().debug("global country attribute name is " + countryAttr);
}
child = conf.getChild(VARIANT_ATTR);
variantAttr = child.getValue(VARIANT);
if (getLogger().isDebugEnabled()) {
getLogger().debug("global variant attribute name is " + variantAttr);
}
child = conf.getChild(LOCALE_ATTR);
localeAttr = child.getValue(LOCALE);
if (getLogger().isDebugEnabled()) {
getLogger().debug("global locale attribute name is " + localeAttr);
}
}
/**
* Action which obtains the current environments locale information, and
* places it in the objectModel (and optionally in a session/cookie).
*/
public Map act(
Redirector redirector,
SourceResolver resolver,
Map objectModel,
String source,
Parameters par
) throws Exception {
// obtain locale information from params, session or cookies
String lc = getLocaleAttribute(objectModel, localeAttr);
Locale locale = I18nUtils.parseLocale(lc);
if (getLogger().isDebugEnabled()) {
getLogger().debug("obtained locale information, locale = " + lc);
checkParams(par);
}
if (storeInRequest) {
Request request = ObjectModelHelper.getRequest(objectModel);
request.setAttribute(localeAttr, lc);
if (getLogger().isDebugEnabled()) {
getLogger().debug("updated request");
}
}
// store in session if so configured
if (storeInSession) {
Request request = ObjectModelHelper.getRequest(objectModel);
Session session = request.getSession(createSession);
if (session != null) {
session.setAttribute(localeAttr, lc);
if (getLogger().isDebugEnabled()) {
getLogger().debug("updated session");
}
}
}
// store in a cookie if so configured
if (storeInCookie) {
Response response = ObjectModelHelper.getResponse(objectModel);
response.addCookie(response.createCookie(localeAttr, lc));
if (getLogger().isDebugEnabled()) {
getLogger().debug("created cookies");
}
}
// set up a map for sitemap parameters
Map map = new HashMap();
map.put(langAttr, locale.getLanguage());
map.put(countryAttr, locale.getCountry());
map.put(variantAttr, locale.getVariant());
map.put(localeAttr, lc);
return map;
}
/**
* Helper method to retreive the attribute value containing locale
* information. See class documentation for locale determination algorythm.
*
* @param objectModel requesting object's environment
* @return locale value or <code>null</null> if no locale was found
*/
public static String getLocaleAttribute(Map objectModel,
String localeAttrName) {
String ret_val;
Request request = ObjectModelHelper.getRequest(objectModel);
// 1. Request CGI parameter 'locale'
if ((ret_val = request.getParameter(localeAttrName)) != null)
return ret_val;
// 2. Session attribute 'locale'
Session session = request.getSession(false);
if (session != null &&
((ret_val = (String) session.getAttribute(localeAttrName)) != null))
return ret_val;
// 3. First matching cookie parameter 'locale' within each cookie sent
Cookie[] cookies = request.getCookies();
if (cookies != null) {
for (int i = 0; i < cookies.length; ++i) {
Cookie cookie = cookies[i];
if (cookie.getName().equals(localeAttrName))
return cookie.getValue();
}
}
// 4. Locale setting of the requesting object/server
return request.getLocale().toString();
}
/**
* Method to check <map:act type="locale"/> invocations for local
* customisation.
*
* eg.
*
* <pre>
* <map:act type="locale">
* <map:parameter name="language-attribute" value="lg"/>
* </map:act>
* </pre>
*/
private void checkParams(Parameters par) {
langAttr = par.getParameter(LANG_ATTR, langAttr);
countryAttr = par.getParameter(COUNTRY_ATTR, countryAttr);
variantAttr = par.getParameter(VARIANT_ATTR, variantAttr);
localeAttr = par.getParameter(LOCALE_ATTR, localeAttr);
storeInRequest = par.getParameterAsBoolean(STORE_REQUEST, storeInRequest);
storeInSession = par.getParameterAsBoolean(STORE_SESSION, storeInSession);
createSession = par.getParameterAsBoolean(CREATE_SESSION, createSession);
storeInCookie = par.getParameterAsBoolean(STORE_COOKIE, storeInCookie);
getLogger().debug("checking for local overrides:\n" +
" " + LANG_ATTR + " = " + langAttr + ",\n" +
" " + COUNTRY_ATTR + " = " + countryAttr + ",\n" +
" " + VARIANT_ATTR + " = " + variantAttr + ",\n" +
" " + LOCALE_ATTR + " = " + localeAttr + ",\n" +
" " + STORE_REQUEST + " = " + storeInRequest + ",\n" +
" " + STORE_SESSION + " = " + storeInSession + ",\n" +
" " + CREATE_SESSION + " = " + createSession + ",\n" +
" " + STORE_COOKIE + " = " + storeInCookie + "\n"
);
}
}