001: package org.tigris.scarab.actions;
002:
003: /* ================================================================
004: * Copyright (c) 2000-2002 CollabNet. 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: // Turbine Stuff
050: import org.apache.turbine.TemplateContext;
051: import org.apache.turbine.RunData;
052:
053: import org.tigris.scarab.om.ScarabUser;
054: import org.tigris.scarab.screens.ModuleSwitchingLink;
055: import org.tigris.scarab.tools.ScarabRequestTool;
056: import org.tigris.scarab.tools.localization.L10NKeySet;
057: import org.tigris.scarab.util.AnonymousUserUtil;
058: import org.tigris.scarab.util.ScarabConstants;
059: import org.tigris.scarab.actions.base.ScarabTemplateAction;
060:
061: /**
062: * This class is responsible for Logging a user out of the system.
063: *
064: * @author <a href="mailto:jon@collab.net">Jon S. Stevens</a>
065: * @author <a href="mailto:dlr@finemaltcoding.com">Daniel Rall</a>
066: * @version $Id: Logout.java 9472 2005-03-16 00:35:52Z dabbous $
067: */
068: public class Logout extends ScarabTemplateAction {
069: /**
070: * Logs out the currently logged-in user. Only sets the confirmation
071: * message if there was a user previously logged in.
072: */
073: public void doLogout(RunData data, TemplateContext context)
074: throws Exception {
075: ScarabRequestTool scarabR = getScarabRequestTool(context);
076: boolean bWasLoggedIn = data.getUserFromSession() != null
077: && !((ScarabUser) data.getUserFromSession())
078: .isUserAnonymous();
079: scarabR.setCurrentModule(null);
080: data.getParameters().remove(ScarabConstants.CURRENT_MODULE);
081: data.setACL(null);
082: //data.setUser(TurbineSecurity.getAnonymousUser());
083: AnonymousUserUtil.anonymousLogin(data);
084: context.put("modulelink", new ModuleSwitchingLink(data));
085:
086: if (data.getUser() != null) {
087: data.save();
088: if (bWasLoggedIn) {
089: scarabR
090: .setConfirmMessage(L10NKeySet.YouHaveBeenLoggedOut);
091: }
092: }
093: setTarget(data, "Login.vm");
094: }
095:
096: /**
097: * @see #doLogout(RunData, TemplateContext)
098: */
099: public void doPerform(RunData data, TemplateContext context)
100: throws Exception {
101: doLogout(data, context);
102: }
103: }
|