001: package org.tigris.scarab.pipeline;
002:
003: /* ================================================================
004: * Copyright (c) 2001 Collab.Net. All rights reserved.
005: *
006: * Redistribution and use in source and binary forms, with or without
007: * modification, are permitted provided that the following conditions are
008: * met:
009: *
010: * 1. Redistributions of source code must retain the above copyright
011: * notice, this list of conditions and the following disclaimer.
012: *
013: * 2. Redistributions in binary form must reproduce the above copyright
014: * notice, this list of conditions and the following disclaimer in the
015: * documentation and/or other materials provided with the distribution.
016: *
017: * 3. The end-user documentation included with the redistribution, if
018: * any, must include the following acknowlegement: "This product includes
019: * software developed by Collab.Net <http://www.Collab.Net/>."
020: * Alternately, this acknowlegement may appear in the software itself, if
021: * and wherever such third-party acknowlegements normally appear.
022: *
023: * 4. The hosted project names must not be used to endorse or promote
024: * products derived from this software without prior written
025: * permission. For written permission, please contact info@collab.net.
026: *
027: * 5. Products derived from this software may not use the "Tigris" or
028: * "Scarab" names nor may "Tigris" or "Scarab" appear in their names without
029: * prior written permission of Collab.Net.
030: *
031: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
032: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
033: * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
034: * IN NO EVENT SHALL COLLAB.NET OR ITS CONTRIBUTORS BE LIABLE FOR ANY
035: * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
036: * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
037: * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
038: * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
039: * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
040: * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
041: * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
042: *
043: * ====================================================================
044: *
045: * This software consists of voluntary contributions made by many
046: * individuals on behalf of Collab.Net.
047: */
048:
049: import java.io.IOException;
050: import java.util.Locale;
051:
052: import javax.servlet.http.HttpServletRequest;
053:
054: import org.apache.fulcrum.localization.Localization;
055: import org.apache.fulcrum.localization.LocalizationService;
056: import org.apache.log4j.Logger;
057: import org.apache.turbine.RunData;
058: import org.apache.turbine.TurbineException;
059: import org.apache.turbine.pipeline.AbstractValve;
060: import org.apache.turbine.ValveContext;
061: import org.tigris.scarab.om.ScarabUser;
062: import org.tigris.scarab.om.UserPreference;
063: import org.tigris.scarab.om.UserPreferenceManager;
064:
065: /**
066: * This valve checks for changes in the browser locale preference settings.
067: * Every time the user changes their locale settings, Scarab will update
068: * its internal database to reflect these changes. From then on the user
069: * gets their emails in the new preferred language.
070: * @author <a href="mailto:dabbous@saxess.com">Hussayn Dabbous</a>
071: */
072: public class SetLocaleValve extends AbstractValve {
073: private static final Logger LOG = Logger
074: .getLogger(SetLocaleValve.class);
075:
076: /**
077: * @see org.apache.turbine.Valve#invoke(RunData, ValveContext)
078: */
079: public void invoke(RunData data, ValveContext context)
080: throws IOException, TurbineException {
081: ScarabUser user = (ScarabUser) data.getUser();
082:
083: // Ensure we only deal with exsiting users
084: if (user != null && user.getUserId() != null) {
085: try {
086: String acceptLanguage = LocalizationService.ACCEPT_LANGUAGE;
087: HttpServletRequest request = data.getRequest();
088: String browserLocaleAsString = request
089: .getHeader(acceptLanguage);
090:
091: Locale userLocale = user.getLocale();
092: Locale browserLocale = Localization
093: .getLocale(browserLocaleAsString);
094:
095: if (!userLocale.equals(browserLocale)) {
096: storePreferredLocale(user, browserLocaleAsString);
097: }
098: } catch (Exception e) {
099: LOG.warn("Could not set locale info for user ["
100: + user.getName() + "]");
101: }
102: }
103: // Pass control to the next Valve in the Pipeline
104: context.invokeNext(data);
105: }
106:
107: /**
108: * Store the locale settings as received from browser into the
109: * database.
110: * @param user
111: * @param localeAsString
112: * @throws Exception
113: */
114: private void storePreferredLocale(ScarabUser user,
115: String localeAsString) throws Exception {
116: // Change the settings in the database
117: UserPreference pref = UserPreferenceManager.getInstance(user
118: .getUserId());
119: pref.setLocale(localeAsString);
120: pref.save();
121:
122: // The internal user caches the current locale,
123: // hence we need to modify the user's locale now.
124: Locale locale = Localization.getLocale(localeAsString);
125: user.setLocale(locale);
126: }
127: }
|