cmscoresession.java

内容管理

/*
* File   : $Source: /usr/local/cvs/opencms/src/com/opencms/core/CmsCoreSession.java,v $
* Date   : $Date: 2003/01/20 17:57:49 $
* Version: $Revision: 1.10 $
*
* This library is part of OpenCms -
* the Open Source Content Mananagement System
*
* Copyright (C) 2001  The OpenCms Group
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
* Lesser General Public License for more details.
*
* For further information about OpenCms, please see the
* OpenCms Website: http://www.opencms.org
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

package com.opencms.core;

import java.util.Enumeration;
import java.util.Hashtable;
import java.util.Vector;

/**
 * This class implements a session storage which is mainly used to count the
 * currently logged in OpenCms users.<p> 
 * 
 * It is required for user authentification of OpenCms. 
 * For each active user, its name and other additional information 
 * (like the current user group) are stored in a hashtable, useing the session 
 * Id as key to them.<p>
 *
 * When the session gets destroyed, the user will removed from the storage.<p>
 *
 * One of the main purposes of this stored user session list is the 
 * <code>sendBroadcastMessage()</code> method.
 *
 * @author Michael Emmerich
 * 
 * @version $Revision: 1.10 $ $Date: 2003/01/20 17:57:49 $
 * 
 * @see #sendBroadcastMessage(String message)
 */
public class CmsCoreSession implements I_CmsConstants {

    /**
     * Hashtable storage to store all active users.
     */
    private Hashtable m_sessions;

    /**
     * Constructor, creates a new CmsCoreSession object.
     */
    public CmsCoreSession() {
        m_sessions = new Hashtable();
    }

    /**
     * Removes a user from the session storage.
     * This is done when the session of the User is destroyed.
     *
     * @param sessionID The actual session Id.
     */
    public void deleteUser(String sessionId) {
        m_sessions.remove(sessionId);
    }

    /**
     * Gets the current usergroup of a user from the session storage.
     *
     * @param sessionID The actual session Id.
     * @return The name of the current group of the user or the default guest group;
     */
    public String getCurrentGroup(String sessionId) {
        Hashtable userinfo = null;
        String currentGroup = C_GROUP_GUEST;
        userinfo = getUser(sessionId);

        // this user does exist, so get his current Group.
        if(userinfo != null) {
            currentGroup = (String)userinfo.get(C_SESSION_CURRENTGROUP);
            if(currentGroup == null) {
                currentGroup = C_GROUP_GUEST;
            }
        }
        return currentGroup;
    }

    /**
     * Gets the current project of a user from the session storage.
     *
     * @param sessionID The actual session Id.
     * @return The name of the project of the user or the default project;
     */
    public Integer getCurrentProject(String sessionId) {
        Hashtable userinfo = null;
        Integer currentProject = new Integer(C_PROJECT_ONLINE_ID);
        userinfo = getUser(sessionId);

        // this user does exist, so get his current Project.
        if(userinfo != null) {
            currentProject = (Integer)userinfo.get(C_SESSION_PROJECT);
            if(currentProject == null) {
                currentProject = new Integer(C_PROJECT_ONLINE_ID);
            }
        }
        return currentProject;
    }

    /**
     * Gets the complete user information of a user from the session storage.
     *
     * @param sessionId A currently valid session id.
     * @return table with user information or null
     */
    public Hashtable getUser(String sessionId) {
        Hashtable userinfo = null;
        userinfo = (Hashtable)m_sessions.get(sessionId);
        return userinfo;
    }

    /**
     * Gets the username of a user from the session storage.
     *
     * @param sessionId A currently valid session id.
     * @return The name of the requested user or null.
     */
    public String getUserName(String sessionId) {
        Hashtable userinfo = null;
        String username = null;
        userinfo = getUser(sessionId);

        // this user does exist, so get his name.
        if(userinfo != null) {
            username = (String)userinfo.get(C_SESSION_USERNAME);
        }
        return username;
    }

    /**
     * Puts a new user into the sesstion storage.<p>
     * 
     * A user is stored with its current
     * session id after a positive authentification.
     *
     * @param sessionId  A currently valid session id.
     * @param username The name of the user to be stored.
     */
    public void putUser(String sessionId, String username) {
        Hashtable userinfo = new Hashtable();
        userinfo.put(C_SESSION_USERNAME, username);
        putUser(sessionId, userinfo);
    }

    /**
     * Puts a new user into the sesstion storage.<p>
     * 
     * A user is stored with its current
     * session id after a positive authentification.
     *
     * @param sessionId  A currently valid session id.
     * @param username The name of the user to be stored.
     * @param group The name of the users current group.
     * @param project The id of the users current project.
     */
    public void putUser(String sessionId, String username, String group, Integer project) {
        Hashtable userinfo = new Hashtable();
        userinfo.put(C_SESSION_USERNAME, username);
        userinfo.put(C_SESSION_CURRENTGROUP, group);
        userinfo.put(C_SESSION_PROJECT, project);
        putUser(sessionId, userinfo);
    }

    /**
     * Puts a new user into the sesstion storage, 
     * this method also stores a complete hashtable with additional 
     * user information.<p>
     * 
     * A user is stored with its current
     * session id after a positive authentification.
     *
     * @param session  A currently valid session id.
     * @param userinfo A Hashtable containing information (including the name) about the user.
     */
    public void putUser(String sessionId, Hashtable userinfo) {
        m_sessions.put(sessionId, userinfo);
    }

    /**
     * Returns the number of current sessions in the system.
     *
     * @return the number of current sessions in the system
     */
    public int size() {
        return m_sessions.size();
    }

    /**
     * Returns a string-representation for this object which
     * can be used for debugging.
     *
     * @return string-representation for this object.
     */
    public String toString() {
        StringBuffer output = new StringBuffer();
        String key;
        Hashtable value;
        String name;
        Enumeration enu = m_sessions.keys();
        output.append("[CmsCoreSessions]:\n");
        while(enu.hasMoreElements()) {
            key = (String)enu.nextElement();
            output.append(key + " : ");
            value = (Hashtable)m_sessions.get(key);
            name = (String)value.get(C_SESSION_USERNAME);
            output.append(name + "\n");
        }
        return output.toString();
    }

    /**
     * Returns a Vector with all currently logged in users.<p>
     * 
     * The Vector elements are <code>Hashtables</code> with the users name, 
     * the current project, the current group a Boolean if current messages
     * are pending.
     *
     * @return a Vector with all currently logged in users
     */
    public Vector getLoggedInUsers() {
        Vector output = new Vector();
        String key;
        Hashtable value;

        // Hastable to return in the vector for one user-entry
        Hashtable userentry;

        Enumeration enu = m_sessions.keys();
        while(enu.hasMoreElements()) {
            userentry = new Hashtable(4);
            key = (String)enu.nextElement();
            value = (Hashtable)m_sessions.get(key);
            userentry.put(C_SESSION_USERNAME, value.get(C_SESSION_USERNAME));
            userentry.put(C_SESSION_PROJECT, value.get(C_SESSION_PROJECT));
            userentry.put(C_SESSION_CURRENTGROUP, value.get(C_SESSION_CURRENTGROUP));
            userentry.put(C_SESSION_MESSAGEPENDING, new Boolean( ((Hashtable)value.get(C_SESSION_DATA)).containsKey(C_SESSION_BROADCASTMESSAGE) ));

            output.addElement(userentry);
        }
        return output;
    }

    /**
     * Sends a broadcast message to all logged in users.
     * 
     * @param message the message to send to all users.
     */
    public void sendBroadcastMessage(String message) {
        String key;
        Hashtable value;

        Hashtable session_data;
        String session_message;

        Enumeration enu = m_sessions.keys();
        while(enu.hasMoreElements()) {
            key = (String)enu.nextElement();
            value = (Hashtable)m_sessions.get(key);
            session_data = (Hashtable)value.get(C_SESSION_DATA);
            session_message = (String)session_data.get(C_SESSION_BROADCASTMESSAGE);
            if(session_message == null) {
                session_message = "";
            }
            session_message += message;
            session_data.put(C_SESSION_BROADCASTMESSAGE, session_message);
        }
    }
}