/** * $RCSfile: MultiUserChatServerImpl.java,v $ * $Revision: 3036 $ * $Date: 2005-11-07 15:15:00 -0300 (Mon, 07 Nov 2005) $ * * Copyright (C) 2004 Jive Software. All rights reserved. * * This software is published under the terms of the GNU Public License (GPL), * a copy of which is included in this distribution. */ package org.jivesoftware.openfire.muc.spi; import org.dom4j.DocumentHelper; import org.dom4j.Element; import org.jivesoftware.openfire.*; import org.jivesoftware.openfire.auth.UnauthorizedException; import org.jivesoftware.openfire.cluster.ClusterEventListener; import org.jivesoftware.openfire.cluster.ClusterManager; import org.jivesoftware.openfire.container.BasicModule; import org.jivesoftware.openfire.disco.DiscoInfoProvider; import org.jivesoftware.openfire.disco.DiscoItemsProvider; import org.jivesoftware.openfire.disco.DiscoServerItem; import org.jivesoftware.openfire.disco.ServerItemsProvider; import org.jivesoftware.openfire.forms.DataForm; import org.jivesoftware.openfire.forms.FormField; import org.jivesoftware.openfire.forms.spi.XDataFormImpl; import org.jivesoftware.openfire.forms.spi.XFormFieldImpl; import org.jivesoftware.openfire.muc.*; import org.jivesoftware.openfire.muc.cluster.*; import org.jivesoftware.openfire.stats.Statistic; import org.jivesoftware.openfire.stats.StatisticsManager; import org.jivesoftware.util.*; import org.jivesoftware.util.cache.CacheFactory; import org.xmpp.component.ComponentManager; import org.xmpp.packet.*; import java.util.*; import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.ConcurrentLinkedQueue; import java.util.concurrent.CopyOnWriteArrayList; import java.util.concurrent.LinkedBlockingQueue; import java.util.concurrent.atomic.AtomicInteger; import java.util.concurrent.atomic.AtomicLong; /** * Implements the chat server as a cached memory resident chat server. The server is also * responsible for responding Multi-User Chat disco requests as well as removing inactive users from * the rooms after a period of time and to maintain a log of the conversation in the rooms that * require to log their conversations. The conversations log is saved to the database using a * separate process<p> * * Temporary rooms are held in memory as long as they have occupants. They will be destroyed after * the last occupant left the room. On the other hand, persistent rooms are always present in memory * even after the last occupant left the room. In order to keep memory clean of peristent rooms that * have been forgotten or abandonded this class includes a clean up process. The clean up process * will remove from memory rooms that haven't had occupants for a while. Moreover, forgotten or * abandoned rooms won't be loaded into memory when the Multi-User Chat service starts up. * * @author Gaston Dombiak */ public class MultiUserChatServerImpl extends BasicModule implements MultiUserChatServer, ServerItemsProvider, DiscoInfoProvider, DiscoItemsProvider, RoutableChannelHandler, ClusterEventListener { private static final FastDateFormat dateFormatter = FastDateFormat .getInstance(JiveConstants.XMPP_DELAY_DATETIME_FORMAT, TimeZone.getTimeZone("UTC")); /** * Statistics keys */ private static final String roomsStatKey = "muc_rooms"; private static final String occupantsStatKey = "muc_occupants"; private static final String usersStatKey = "muc_users"; private static final String incomingStatKey = "muc_incoming"; private static final String outgoingStatKey = "muc_outgoing"; private static final String trafficStatGroup = "muc_traffic"; /** * The time to elapse between clearing of idle chat users. */ private int user_timeout = 300000; /** * The number of milliseconds a user must be idle before he/she gets kicked from all the rooms. */ private int user_idle = -1; /** * Task that kicks idle users from the rooms. */ private UserTimeoutTask userTimeoutTask; /** * The time to elapse between logging the room conversations. */ private int log_timeout = 300000; /** * The number of messages to log on each run of the logging process. */ private int log_batch_size = 50; /** * Task that flushes room conversation logs to the database. */ private LogConversationTask logConversationTask; /** * the chat service's hostname */ private String chatServiceName = null; /** * chatrooms managed by this manager, table: key room name (String); value ChatRoom */ private Map<String, LocalMUCRoom> rooms = new ConcurrentHashMap<String, LocalMUCRoom>(); /** * Chat users managed by this manager. This includes only users connected to this JVM. * That means that when running inside of a cluster each node will have its own manager * that in turn will keep its own list of locally connected. * * table: key user jid (XMPPAddress); value ChatUser */ private Map<JID, LocalMUCUser> users = new ConcurrentHashMap<JID, LocalMUCUser>(); private HistoryStrategy historyStrategy; private RoutingTable routingTable = null; /** * The packet router for the server. */ private PacketRouter router = null; /** * The handler of packets with namespace jabber:iq:register for the server. */ private IQMUCRegisterHandler registerHandler = null; /** * The total time all agents took to chat * */ public long totalChatTime; /** * Timer to monitor chatroom participants. If they've been idle for too long, probe for * presence. */ private Timer timer = new Timer("MUC cleanup"); /** * Flag that indicates if the service should provide information about locked rooms when * handling service discovery requests. * Note: Setting this flag in false is not compliant with the spec. A user may try to join a * locked room thinking that the room doesn't exist because the user didn't discover it before. */ private boolean allowToDiscoverLockedRooms = true; /** * Returns the permission policy for creating rooms. A true value means that not anyone can * create a room, only the JIDs listed in <code>allowedToCreate</code> are allowed to create * rooms. */ private boolean roomCreationRestricted = false; /** * Bare jids of users that are allowed to create MUC rooms. An empty list means that anyone can * create a room. */ private List<String> allowedToCreate = new CopyOnWriteArrayList<String>(); /** * Bare jids of users that are system administrators of the MUC service. A sysadmin has the same * permissions as a room owner. */ private List<String> sysadmins = new CopyOnWriteArrayList<String>(); /** * Queue that holds the messages to log for the rooms that need to log their conversations. */ private Queue<ConversationLogEntry> logQueue = new LinkedBlockingQueue<ConversationLogEntry>(); /** * Max number of hours that a persistent room may be empty before the service removes the * room from memory. Unloaded rooms will exist in the database and may be loaded by a user * request. Default time limit is: 30 days. */ private long emptyLimit = 30 * 24; /** * Task that removes rooms from memory that have been without activity for a period of time. A * room is considered without activity when no occupants are present in the room for a while. */ private CleanupTask cleanupTask; /** * The time to elapse between each rooms cleanup. Default frequency is 60 minutes. */ private final long cleanup_frequency = 60 * 60 * 1000; /** * Total number of received messages in all rooms since the last reset. The counter * is reset each time the Statistic makes a sampling. */ private AtomicInteger inMessages = new AtomicInteger(0); /** * Total number of broadcasted messages in all rooms since the last reset. The counter * is reset each time the Statistic makes a sampling. */ private AtomicLong outMessages = new AtomicLong(0); /** * Flag that indicates if MUC service is enabled. */ private boolean serviceEnabled = true; Collection<MUCEventListener> listeners = new ConcurrentLinkedQueue<MUCEventListener>(); /** * Create a new group chat server. */ public MultiUserChatServerImpl() { super("Basic multi user chat server"); historyStrategy = new HistoryStrategy(null); } public String getDescription() { return null; } public void process(Packet packet) throws UnauthorizedException, PacketException { // TODO Remove this method when moving MUC as a component and removing module code processPacket(packet); } public void processPacket(Packet packet) { if (!isServiceEnabled()) { return; } // The MUC service will receive all the packets whose domain matches the domain of the MUC // service. This means that, for instance, a disco request should be responded by the // service itself instead of relying on the server to handle the request. try { // Check if the packet is a disco request or a packet with namespace iq:register if (packet instanceof IQ) { if (process((IQ)packet)) { return; } } // The packet is a normal packet that should possibly be sent to the room JID receipient = packet.getTo(); String roomName = receipient != null ? receipient.getNode() : null; getChatUser(packet.getFrom(), roomName).process(packet); } catch (Exception e) { Log.error(LocaleUtils.getLocalizedString("admin.error"), e); } } /** * Returns true if the IQ packet was processed. This method should only process disco packets * as well as jabber:iq:register packets sent to the MUC service. * * @param iq the IQ packet to process. * @return true if the IQ packet was processed. */ private boolean process(IQ iq) { Element childElement = iq.getChildElement(); String namespace = null; // Ignore IQs of type ERROR if (IQ.Type.error == iq.getType()) { return false; } if (iq.getTo().getResource() != null) { // Ignore IQ packets sent to room occupants return false; } if (childElement != null) { namespace = childElement.getNamespaceURI(); } if ("jabber:iq:register".equals(namespace)) { IQ reply = registerHandler.handleIQ(iq); router.route(reply); } else if ("http://jabber.org/protocol/disco#info".equals(namespace)) { // TODO MUC should have an IQDiscoInfoHandler of its own when MUC becomes // a component IQ reply = XMPPServer.getInstance().getIQDiscoInfoHandler().handleIQ(iq); router.route(reply); } else if ("http://jabber.org/protocol/disco#items".equals(namespace)) { // TODO MUC should have an IQDiscoItemsHandler of its own when MUC becomes // a component IQ reply = XMPPServer.getInstance().getIQDiscoItemsHandler().handleIQ(iq); router.route(reply); } else { return false; } return true; } public void initialize(JID jid, ComponentManager componentManager) { } public void shutdown() { } public String getServiceDomain() { return chatServiceName + "." + XMPPServer.getInstance().getServerInfo().getName(); } public JID getAddress() { return new JID(null, getServiceDomain(), null, true); } /** * Probes the presence of any user who's last packet was sent more than 5 minute ago. */ private class UserTimeoutTask extends TimerTask { /** * Remove any user that has been idle for longer than the user timeout time. */ public void run() { checkForTimedOutUsers(); } } private void checkForTimedOutUsers() { // Do nothing if this feature is disabled (i.e USER_IDLE equals -1) if (user_idle == -1) { return; } final long deadline = System.currentTimeMillis() - user_idle; for (LocalMUCUser user : users.values()) { try { if (user.getLastPacketTime() < deadline) { // If user is not present in any room then remove the user from // the list of users if (!user.isJoined()) { removeUser(user.getAddress()); continue; } // Kick the user from all the rooms that he/she had previuosly joined MUCRoom room; Presence kickedPresence; for (LocalMUCRole role : user.getRoles()) { room = role.getChatRoom(); try { kickedPresence = room.kickOccupant(user.getAddress(), null, null); // Send the updated presence to the room occupants room.send(kickedPresence); } catch (NotAllowedException e) { // Do nothing since we cannot kick owners or admins } } } } catch (Throwable e) { Log.error(LocaleUtils.getLocalizedString("admin.error"), e); } } } /** * Logs the conversation of the rooms that have this feature enabled. */ private class LogConversationTask extends TimerTask { public void run() { try { logConversation(); } catch (Throwable e) { Log.error(LocaleUtils.getLocalizedString("admin.error"), e); } } } private void logConversation() { ConversationLogEntry entry; boolean success; for (int index = 0; index <= log_batch_size && !logQueue.isEmpty(); index++) { entry = logQueue.poll(); if (entry != null) { success = MUCPersistenceManager.saveConversationLogEntry(entry); if (!success) { logQueue.add(entry); } } } } /** * Logs all the remaining conversation log entries to the database. Use this method to force * saving all the conversation log entries before the service becomes unavailable. */ private void logAllConversation() { ConversationLogEntry entry; while (!logQueue.isEmpty()) { entry = logQueue.poll(); if (entry != null) { MUCPersistenceManager.saveConversationLogEntry(entry); } } } /** * Removes from memory rooms that have been without activity for a period of time. A room is * considered without activity when no occupants are present in the room for a while. */ private class CleanupTask extends TimerTask { public void run() { if (ClusterManager.isClusteringStarted() && !ClusterManager.isSeniorClusterMember()) { // Do nothing if we are in a cluster and this JVM is not the senior cluster member return; } try { cleanupRooms(); } catch (Throwable e) { Log.error(LocaleUtils.getLocalizedString("admin.error"), e); } } } private void cleanupRooms() { for (MUCRoom room : rooms.values()) { if (room.getEmptyDate() != null && room.getEmptyDate().before(getCleanupDate())) { removeChatRoom(room.getName()); } } } public MUCRoom getChatRoom(String roomName, JID userjid) throws NotAllowedException { LocalMUCRoom room; boolean loaded = false; boolean created = false; synchronized (roomName.intern()) { room = rooms.get(roomName); if (room == null) { room = new LocalMUCRoom(this, roomName, router); // If the room is persistent load the configuration values from the DB try { // Try to load the room's configuration from the database (if the room is // persistent but was added to the DB after the server was started up or the // room may be an old room that was not present in memory) MUCPersistenceManager.loadFromDB((LocalMUCRoom) room); loaded = true; } catch (IllegalArgumentException e) { // The room does not exist so check for creation permissions // Room creation is always allowed for sysadmin if (isRoomCreationRestricted() && !sysadmins.contains(userjid.toBareJID())) { // The room creation is only allowed for certain JIDs if (!allowedToCreate.contains(userjid.toBareJID())) { // The user is not in the list of allowed JIDs to create a room so raise // an exception throw new NotAllowedException(); } } room.addFirstOwner(userjid.toBareJID()); created = true; } rooms.put(roomName, room); } } if (created) { // Fire event that a new room has been created for (MUCEventListener listener : listeners) { listener.roomCreated(room.getRole().getRoleAddress()); } } if (loaded || created) { // Notify other cluster nodes that a new room is available CacheFactory.doClusterTask(new RoomAvailableEvent(room)); for (MUCRole role : room.getOccupants()) { if (role instanceof LocalMUCRole) { CacheFactory.doClusterTask(new OccupantAddedEvent(room, role)); } } } return room; } public MUCRoom getChatRoom(String roomName) { boolean loaded = false; LocalMUCRoom room = rooms.get(roomName); if (room == null) { // Check if the room exists in the database and was not present in memory synchronized (roomName.intern()) { room = rooms.get(roomName); if (room == null) { room = new LocalMUCRoom(this, roomName, router); // If the room is persistent load the configuration values from the DB try { // Try to load the room's configuration from the database (if the room is // persistent but was added to the DB after the server was started up or the // room may be an old room that was not present in memory) MUCPersistenceManager.loadFromDB((LocalMUCRoom) room); loaded = true; rooms.put(roomName, room); } catch (IllegalArgumentException e) { // The room does not exist so do nothing room = null; } } } } if (loaded) { // Notify other cluster nodes that a new room is available CacheFactory.doClusterTask(new RoomAvailableEvent(room)); } return room; } public List<MUCRoom> getChatRooms() { return new ArrayList<MUCRoom>(rooms.values()); } public boolean hasChatRoom(String roomName) { return getChatRoom(roomName) != null; } public void removeChatRoom(String roomName) { removeChatRoom(roomName, true); } /** * Notification message indicating that the specified chat room was * removed from some other cluster member. * * @param roomName the name of the room removed from the cluster. */ public void chatRoomRemoved(String roomName) { removeChatRoom(roomName, false); } /** * Notification message indicating that a chat room has been created * in another cluster member. * * @param room the created room in another cluster node. */ public void chatRoomAdded(LocalMUCRoom room) { rooms.put(room.getName(), room); } private void removeChatRoom(String roomName, boolean notify) { MUCRoom room = rooms.remove(roomName); if (room != null) { totalChatTime += room.getChatLength(); if (notify) { // Notify other cluster nodes that a room has been removed CacheFactory.doClusterTask(new RoomRemovedEvent(roomName)); } } } public String getServiceName() { return chatServiceName; } public HistoryStrategy getHistoryStrategy() { return historyStrategy; } /** * Removes a user from all chat rooms. * * @param jabberID The user's normal jid, not the chat nickname jid. */ private void removeUser(JID jabberID) { LocalMUCUser user = users.remove(jabberID); if (user != null) { for (LocalMUCRole role : user.getRoles()) { try { role.getChatRoom().leaveRoom(role); } catch (Exception e) { Log.error(e); } } } } /** * Obtain a chat user by XMPPAddress. Only returns users that are connected to this JVM. * * @param userjid The XMPPAddress of the user. * @param roomName name of the room to receive the packet. * @return The chatuser corresponding to that XMPPAddress. */ private MUCUser getChatUser(JID userjid, String roomName) { if (router == null) { throw new IllegalStateException("Not initialized"); } LocalMUCUser user; synchronized (userjid.toString().intern()) { user = users.get(userjid); if (user == null) { if (roomName != null) { // Check if the JID belong to a user hosted in another cluster node LocalMUCRoom localMUCRoom = rooms.get(roomName); if (localMUCRoom != null) { MUCRole occupant = localMUCRoom.getOccupantByFullJID(userjid); if (occupant != null && !occupant.isLocal()) { return new RemoteMUCUser(userjid, localMUCRoom); } } } user = new LocalMUCUser(this, router, userjid); users.put(userjid, user); } } return user; } public void setServiceName(String name) { JiveGlobals.setProperty("xmpp.muc.service", name); } /** * Returns the limit date after which rooms whithout activity will be removed from memory. * * @return the limit date after which rooms whithout activity will be removed from memory. */ private Date getCleanupDate() { return new Date(System.currentTimeMillis() - (emptyLimit * 3600000)); } public void setKickIdleUsersTimeout(int timeout) { if (this.user_timeout == timeout) { return; } // Cancel the existing task because the timeout has changed if (userTimeoutTask != null) { userTimeoutTask.cancel(); } this.user_timeout = timeout; // Create a new task and schedule it with the new timeout userTimeoutTask = new UserTimeoutTask(); timer.schedule(userTimeoutTask, user_timeout, user_timeout); // Set the new property value JiveGlobals.setProperty("xmpp.muc.tasks.user.timeout", Integer.toString(timeout)); } public int getKickIdleUsersTimeout() { return user_timeout; } public void setUserIdleTime(int idleTime) { if (this.user_idle == idleTime) { return; } this.user_idle = idleTime; // Set the new property value JiveGlobals.setProperty("xmpp.muc.tasks.user.idle", Integer.toString(idleTime)); } public int getUserIdleTime() { return user_idle; } public void setLogConversationsTimeout(int timeout) { if (this.log_timeout == timeout) { return; } // Cancel the existing task because the timeout has changed if (logConversationTask != null) { logConversationTask.cancel(); } this.log_timeout = timeout; // Create a new task and schedule it with the new timeout logConversationTask = new LogConversationTask(); timer.schedule(logConversationTask, log_timeout, log_timeout); // Set the new property value JiveGlobals.setProperty("xmpp.muc.tasks.log.timeout", Integer.toString(timeout)); } public int getLogConversationsTimeout() { return log_timeout; } public void setLogConversationBatchSize(int size) { if (this.log_batch_size == size) { return; } this.log_batch_size = size; // Set the new property value JiveGlobals.setProperty("xmpp.muc.tasks.log.batchsize", Integer.toString(size)); } public int getLogConversationBatchSize() { return log_batch_size; } public Collection<String> getUsersAllowedToCreate() { return allowedToCreate; } public Collection<String> getSysadmins() { return sysadmins; } public void addSysadmin(String userJID) { sysadmins.add(userJID.trim().toLowerCase()); // CopyOnWriteArray does not allow sorting, so do sorting in temp list. ArrayList<String> tempList = new ArrayList<String>(sysadmins); Collections.sort(tempList); sysadmins = new CopyOnWriteArrayList<String>(tempList); // Update the config. String[] jids = new String[sysadmins.size()]; jids = sysadmins.toArray(jids); JiveGlobals.setProperty("xmpp.muc.sysadmin.jid", fromArray(jids)); } public void removeSysadmin(String userJID) { sysadmins.remove(userJID.trim().toLowerCase()); // Update the config. String[] jids = new String[sysadmins.size()]; jids = sysadmins.toArray(jids); JiveGlobals.setProperty("xmpp.muc.sysadmin.jid", fromArray(jids)); } /** * Returns the flag that indicates if the service should provide information about locked rooms * when handling service discovery requests. * * @return true if the service should provide information about locked rooms. */ public boolean isAllowToDiscoverLockedRooms() { return allowToDiscoverLockedRooms; } /** * Sets the flag that indicates if the service should provide information about locked rooms * when handling service discovery requests. * Note: Setting this flag in false is not compliant with the spec. A user may try to join a * locked room thinking that the room doesn't exist because the user didn't discover it before. * * @param allowToDiscoverLockedRooms if the service should provide information about locked * rooms. */ public void setAllowToDiscoverLockedRooms(boolean allowToDiscoverLockedRooms) { this.allowToDiscoverLockedRooms = allowToDiscoverLockedRooms; JiveGlobals.setProperty("xmpp.muc.discover.locked", Boolean.toString(allowToDiscoverLockedRooms)); } public boolean isRoomCreationRestricted() { return roomCreationRestricted; } public void setRoomCreationRestricted(boolean roomCreationRestricted) { this.roomCreationRestricted = roomCreationRestricted; JiveGlobals.setProperty("xmpp.muc.create.anyone", Boolean.toString(roomCreationRestricted)); } public void addUserAllowedToCreate(String userJID) { // Update the list of allowed JIDs to create MUC rooms. Since we are updating the instance // variable there is no need to restart the service allowedToCreate.add(userJID.trim().toLowerCase()); // CopyOnWriteArray does not allow sorting, so do sorting in temp list. ArrayList<String> tempList = new ArrayList<String>(allowedToCreate); Collections.sort(tempList); allowedToCreate = new CopyOnWriteArrayList<String>(tempList); // Update the config. String[] jids = new String[allowedToCreate.size()]; jids = allowedToCreate.toArray(jids); JiveGlobals.setProperty("xmpp.muc.create.jid", fromArray(jids)); } public void removeUserAllowedToCreate(String userJID) { // Update the list of allowed JIDs to create MUC rooms. Since we are updating the instance // variable there is no need to restart the service allowedToCreate.remove(userJID.trim().toLowerCase()); // Update the config. String[] jids = new String[allowedToCreate.size()]; jids = allowedToCreate.toArray(jids); JiveGlobals.setProperty("xmpp.muc.create.jid", fromArray(jids)); } public void initialize(XMPPServer server) { super.initialize(server); serviceEnabled = JiveGlobals.getBooleanProperty("xmpp.muc.enabled", true); chatServiceName = JiveGlobals.getProperty("xmpp.muc.service"); // Trigger the strategy to load itself from the context historyStrategy.setContext("xmpp.muc.history"); // Load the list of JIDs that are sysadmins of the MUC service String property = JiveGlobals.getProperty("xmpp.muc.sysadmin.jid"); String[] jids; if (property != null) { jids = property.split(","); for (String jid : jids) { sysadmins.add(jid.trim().toLowerCase()); } } allowToDiscoverLockedRooms = Boolean.parseBoolean(JiveGlobals.getProperty("xmpp.muc.discover.locked", "true")); roomCreationRestricted = Boolean.parseBoolean(JiveGlobals.getProperty("xmpp.muc.create.anyone", "false")); // Load the list of JIDs that are allowed to create a MUC room property = JiveGlobals.getProperty("xmpp.muc.create.jid"); if (property != null) { jids = property.split(","); for (String jid : jids) { allowedToCreate.add(jid.trim().toLowerCase()); } } String value = JiveGlobals.getProperty("xmpp.muc.tasks.user.timeout"); if (value != null) { try { user_timeout = Integer.parseInt(value); } catch (NumberFormatException e) { Log.error("Wrong number format of property xmpp.muc.tasks.user.timeout", e); } } value = JiveGlobals.getProperty("xmpp.muc.tasks.user.idle"); if (value != null) { try { user_idle = Integer.parseInt(value); } catch (NumberFormatException e) { Log.error("Wrong number format of property xmpp.muc.tasks.user.idle", e); } } value = JiveGlobals.getProperty("xmpp.muc.tasks.log.timeout"); if (value != null) { try { log_timeout = Integer.parseInt(value); } catch (NumberFormatException e) { Log.error("Wrong number format of property xmpp.muc.tasks.log.timeout", e); } } value = JiveGlobals.getProperty("xmpp.muc.tasks.log.batchsize"); if (value != null) { try { log_batch_size = Integer.parseInt(value); } catch (NumberFormatException e) { Log.error("Wrong number format of property xmpp.muc.tasks.log.batchsize", e); } } value = JiveGlobals.getProperty("xmpp.muc.unload.empty_days"); if (value != null) { try { emptyLimit = Integer.parseInt(value) * 24; } catch (NumberFormatException e) { Log.error("Wrong number format of property xmpp.muc.unload.empty_days", e); } } if (chatServiceName == null) { chatServiceName = "conference"; } // Run through the users every 5 minutes after a 5 minutes server startup delay (default // values) userTimeoutTask = new UserTimeoutTask(); timer.schedule(userTimeoutTask, user_timeout, user_timeout); // Log the room conversations every 5 minutes after a 5 minutes server startup delay // (default values) logConversationTask = new LogConversationTask(); timer.schedule(logConversationTask, log_timeout, log_timeout); // Remove unused rooms from memory cleanupTask = new CleanupTask(); timer.schedule(cleanupTask, cleanup_frequency, cleanup_frequency); routingTable = server.getRoutingTable(); router = server.getPacketRouter(); // Configure the handler of iq:register packets registerHandler = new IQMUCRegisterHandler(this); // Listen to cluster events ClusterManager.addListener(this); } public void start() { super.start(); // Add the route to this service routingTable.addComponentRoute(getAddress(), this); ArrayList<String> params = new ArrayList<String>(); params.clear(); params.add(getServiceDomain()); Log.info(LocaleUtils.getLocalizedString("startup.starting.muc", params)); // Load all the persistent rooms to memory for (LocalMUCRoom room : MUCPersistenceManager.loadRoomsFromDB(this, this.getCleanupDate(), router)) { rooms.put(room.getName().toLowerCase(), room); } // Add statistics addTotalRoomStats(); addTotalOccupantsStats(); addTotalConnectedUsers(); addNumberIncomingMessages(); addNumberOutgoingMessages(); } public void stop() { super.stop(); // Remove the route to this service routingTable.removeComponentRoute(getAddress()); timer.cancel(); logAllConversation(); // Remove the statistics. StatisticsManager.getInstance().removeStatistic(roomsStatKey); StatisticsManager.getInstance().removeStatistic(occupantsStatKey); StatisticsManager.getInstance().removeStatistic(usersStatKey); StatisticsManager.getInstance().removeStatistic(incomingStatKey); StatisticsManager.getInstance().removeStatistic(outgoingStatKey); } public void enableService(boolean enabled, boolean persistent) { if (isServiceEnabled() == enabled) { // Do nothing if the service status has not changed return; } XMPPServer server = XMPPServer.getInstance(); if (!enabled) { // Disable disco information server.getIQDiscoItemsHandler().removeServerItemsProvider(this); // Stop the service/module stop(); } if (persistent) { JiveGlobals.setProperty("xmpp.muc.enabled", Boolean.toString(enabled)); } serviceEnabled = enabled; if (enabled) { // Start the service/module start(); // Enable disco information server.getIQDiscoItemsHandler().addServerItemsProvider(this); } } public boolean isServiceEnabled() { return serviceEnabled; } public long getTotalChatTime() { return totalChatTime; } /** * Retuns the number of existing rooms in the server (i.e. persistent or not, * in memory or not). * * @return the number of existing rooms in the server. */ public int getNumberChatRooms() { return rooms.size(); } /** * Retuns the total number of occupants in all rooms in the server. * * @param onlyLocal true if only users connected to this JVM will be considered. Otherwise count cluster wise. * @return the number of existing rooms in the server. */ public int getNumberConnectedUsers(boolean onlyLocal) { int total = 0; for (LocalMUCUser user : users.values()) { if (user.isJoined()) { total = total + 1; } } // Add users from remote cluster nodes if (!onlyLocal) { Collection<Object> results = CacheFactory.doSynchronousClusterTask(new GetNumberConnectedUsers(), false); for (Object result : results) { if (result == null) { continue; } total = total + (Integer) result; } } return total; } /** * Retuns the total number of users that have joined in all rooms in the server. * * @return the number of existing rooms in the server. */ public int getNumberRoomOccupants() { int total = 0; for (MUCRoom room : rooms.values()) { total = total + room.getOccupantsCount(); } return total; } public void logConversation(MUCRoom room, Message message, JID sender) { // Only log messages that have a subject or body. Otherwise ignore it. if (message.getSubject() != null || message.getBody() != null) { logQueue.add(new ConversationLogEntry(new Date(), room, message, sender)); } } public void messageBroadcastedTo(int numOccupants) { // Increment counter of received messages that where broadcasted by one inMessages.incrementAndGet(); // Increment counter of outgoing messages with the number of room occupants // that received the message outMessages.addAndGet(numOccupants); } public void joinedCluster() { if (isServiceEnabled()) { if (!ClusterManager.isSeniorClusterMember()) { // Get transient rooms and persistent rooms with occupants from senior // cluster member and merge with local ones. If room configuration was // changed in both places then latest configuration will be kept List<RoomInfo> result = (List<RoomInfo>) CacheFactory.doSynchronousClusterTask( new SeniorMemberRoomsRequest(), ClusterManager.getSeniorClusterMember().toByteArray()); if (result != null) { for (RoomInfo roomInfo : result) { LocalMUCRoom remoteRoom = roomInfo.getRoom(); LocalMUCRoom localRoom = rooms.get(remoteRoom.getName()); if (localRoom == null) { // Create local room with remote information localRoom = remoteRoom; rooms.put(remoteRoom.getName(), localRoom); } else { // Update local room with remote information localRoom.updateConfiguration(remoteRoom); } // Add remote occupants to local room // TODO Handle conflict of nicknames for (OccupantAddedEvent event : roomInfo.getOccupants()) { event.setSendPresence(true); event.run(); } } } } } } public void joinedCluster(byte[] nodeID) { if (isServiceEnabled()) { List<RoomInfo> result = (List<RoomInfo>) CacheFactory.doSynchronousClusterTask(new GetNewMemberRoomsRequest(), nodeID); if (result != null) { for (RoomInfo roomInfo : result) { LocalMUCRoom remoteRoom = roomInfo.getRoom(); LocalMUCRoom localRoom = rooms.get(remoteRoom.getName()); if (localRoom == null) { // Create local room with remote information localRoom = remoteRoom; rooms.put(remoteRoom.getName(), localRoom); } // Add remote occupants to local room for (OccupantAddedEvent event : roomInfo.getOccupants()) { event.setSendPresence(true); event.run(); } } } } } public void leftCluster() { // Do nothing. An unavailable presence will be created for occupants hosted in other cluster nodes. } public void leftCluster(byte[] nodeID) { // Do nothing. An unavailable presence will be created for occupants hosted in the leaving cluster node. } public void markedAsSeniorClusterMember() { // Do nothing } public Iterator<DiscoServerItem> getItems() { // Check if the service is disabled. Info is not available when disabled. if (!isServiceEnabled()) { return null; } ArrayList<DiscoServerItem> items = new ArrayList<DiscoServerItem>(); items.add(new DiscoServerItem() { public String getJID() { return getServiceDomain(); } public String getName() { // Check if there is a system property that overrides the default value String serviceName = JiveGlobals.getProperty("muc.service-name"); if (serviceName != null && serviceName.trim().length() > 0) { return serviceName; } // Return the default service name based on the current locale return LocaleUtils.getLocalizedString("muc.service-name"); } public String getAction() { return null; } public String getNode() { return null; } public DiscoInfoProvider getDiscoInfoProvider() { return MultiUserChatServerImpl.this; } public DiscoItemsProvider getDiscoItemsProvider() { return MultiUserChatServerImpl.this; } }); return items.iterator(); } public Iterator<Element> getIdentities(String name, String node, JID senderJID) { ArrayList<Element> identities = new ArrayList<Element>(); if (name == null && node == null) { // Answer the identity of the MUC service Element identity = DocumentHelper.createElement("identity"); identity.addAttribute("category", "conference"); identity.addAttribute("name", "Public Chatrooms"); identity.addAttribute("type", "text"); identities.add(identity); } else if (name != null && node == null) { // Answer the identity of a given room MUCRoom room = getChatRoom(name); if (room != null && canDiscoverRoom(room)) { Element identity = DocumentHelper.createElement("identity"); identity.addAttribute("category", "conference"); identity.addAttribute("name", room.getNaturalLanguageName()); identity.addAttribute("type", "text"); identities.add(identity); } } else if (name != null && "x-roomuser-item".equals(node)) { // Answer reserved nickname for the sender of the disco request in the requested room MUCRoom room = getChatRoom(name); if (room != null) { String reservedNick = room.getReservedNickname(senderJID.toBareJID()); if (reservedNick != null) { Element identity = DocumentHelper.createElement("identity"); identity.addAttribute("category", "conference"); identity.addAttribute("name", reservedNick); identity.addAttribute("type", "text"); identities.add(identity); } } } return identities.iterator(); } public Iterator<String> getFeatures(String name, String node, JID senderJID) { ArrayList<String> features = new ArrayList<String>(); if (name == null && node == null) { // Answer the features of the MUC service features.add("http://jabber.org/protocol/muc"); features.add("http://jabber.org/protocol/disco#info"); features.add("http://jabber.org/protocol/disco#items"); } else if (name != null && node == null) { // Answer the features of a given room MUCRoom room = getChatRoom(name); if (room != null && canDiscoverRoom(room)) { features.add("http://jabber.org/protocol/muc"); // Always add public since only public rooms can be discovered features.add("muc_public"); if (room.isMembersOnly()) { features.add("muc_membersonly"); } else { features.add("muc_open"); } if (room.isModerated()) { features.add("muc_moderated"); } else { features.add("muc_unmoderated"); } if (room.canAnyoneDiscoverJID()) { features.add("muc_nonanonymous"); } else { features.add("muc_semianonymous"); } if (room.isPasswordProtected()) { features.add("muc_passwordprotected"); } else { features.add("muc_unsecured"); } if (room.isPersistent()) { features.add("muc_persistent"); } else { features.add("muc_temporary"); } } } return features.iterator(); } public XDataFormImpl getExtendedInfo(String name, String node, JID senderJID) { if (name != null && node == null) { // Answer the extended info of a given room MUCRoom room = getChatRoom(name); if (room != null && canDiscoverRoom(room)) { XDataFormImpl dataForm = new XDataFormImpl(DataForm.TYPE_RESULT); XFormFieldImpl field = new XFormFieldImpl("FORM_TYPE"); field.setType(FormField.TYPE_HIDDEN); field.addValue("http://jabber.org/protocol/muc#roominfo"); dataForm.addField(field); field = new XFormFieldImpl("muc#roominfo_description"); field.setLabel(LocaleUtils.getLocalizedString("muc.extended.info.desc")); field.addValue(room.getDescription()); dataForm.addField(field); field = new XFormFieldImpl("muc#roominfo_subject"); field.setLabel(LocaleUtils.getLocalizedString("muc.extended.info.subject")); field.addValue(room.getSubject()); dataForm.addField(field); field = new XFormFieldImpl("muc#roominfo_occupants"); field.setLabel(LocaleUtils.getLocalizedString("muc.extended.info.occupants")); field.addValue(Integer.toString(room.getOccupantsCount())); dataForm.addField(field); /*field = new XFormFieldImpl("muc#roominfo_lang"); field.setLabel(LocaleUtils.getLocalizedString("muc.extended.info.language")); field.addValue(room.getLanguage()); dataForm.addField(field);*/ field = new XFormFieldImpl("x-muc#roominfo_creationdate"); field.setLabel(LocaleUtils.getLocalizedString("muc.extended.info.creationdate")); field.addValue(dateFormatter.format(room.getCreationDate())); dataForm.addField(field); return dataForm; } } return null; } public boolean hasInfo(String name, String node, JID senderJID) { // Check if the service is disabled. Info is not available when disabled. if (!isServiceEnabled()) { return false; } if (name == null && node == null) { // We always have info about the MUC service return true; } else if (name != null && node == null) { // We only have info if the room exists return hasChatRoom(name); } else if (name != null && "x-roomuser-item".equals(node)) { // We always have info about reserved names as long as the room exists return hasChatRoom(name); } return false; } public Iterator<Element> getItems(String name, String node, JID senderJID) { // Check if the service is disabled. Info is not available when disabled. if (!isServiceEnabled()) { return null; } List<Element> answer = new ArrayList<Element>(); if (name == null && node == null) { Element item; // Answer all the public rooms as items for (MUCRoom room : rooms.values()) { if (canDiscoverRoom(room)) { item = DocumentHelper.createElement("item"); item.addAttribute("jid", room.getRole().getRoleAddress().toString()); item.addAttribute("name", room.getNaturalLanguageName()); answer.add(item); } } } else if (name != null && node == null) { // Answer the room occupants as items if that info is publicly available MUCRoom room = getChatRoom(name); if (room != null && canDiscoverRoom(room)) { Element item; for (MUCRole role : room.getOccupants()) { // TODO Should we filter occupants that are invisible (presence is not broadcasted)? item = DocumentHelper.createElement("item"); item.addAttribute("jid", role.getRoleAddress().toString()); answer.add(item); } } } return answer.iterator(); } private boolean canDiscoverRoom(MUCRoom room) { // Check if locked rooms may be discovered if (!allowToDiscoverLockedRooms && room.isLocked()) { return false; } return room.isPublicRoom(); } public void addListener(MUCEventListener listener) { listeners.add(listener); } public void removeListener(MUCEventListener listener) { listeners.remove(listener); } void fireOccupantJoined(JID roomJID, JID user, String nickname) { for (MUCEventListener listener : listeners) { listener.occupantJoined(roomJID, user, nickname); } } void fireOccupantLeft(JID roomJID, JID user) { for (MUCEventListener listener : listeners) { listener.occupantLeft(roomJID, user); } } void fireNicknameChanged(JID roomJID, JID user, String oldNickname, String newNickname) { for (MUCEventListener listener : listeners) { listener.nicknameChanged(roomJID, user, oldNickname, newNickname); } } void fireMessageReceived(JID roomJID, JID user, String nickname, Message message) { for (MUCEventListener listener : listeners) { listener.messageReceived(roomJID, user, nickname, message); } } void fireRoomDestroyed(JID roomJID) { for (MUCEventListener listener : listeners) { listener.roomDestroyed(roomJID); } } /** * Converts an array to a comma-delimitted String. * * @param array the array. * @return a comma delimtted String of the array values. */ private static String fromArray(String [] array) { StringBuilder buf = new StringBuilder(); for (int i=0; i<array.length; i++) { buf.append(array[i]); if (i != array.length-1) { buf.append(","); } } return buf.toString(); } /****************** Statistics code ************************/ private void addTotalRoomStats() { // Register a statistic. Statistic statistic = new Statistic() { public String getName() { return LocaleUtils.getLocalizedString("muc.stats.active_group_chats.name"); } public Type getStatType() { return Type.count; } public String getDescription() { return LocaleUtils.getLocalizedString("muc.stats.active_group_chats.desc"); } public String getUnits() { return LocaleUtils.getLocalizedString("muc.stats.active_group_chats.units"); } public double sample() { return getNumberChatRooms(); } public boolean isPartialSample() { return false; } }; StatisticsManager.getInstance().addStatistic(roomsStatKey, statistic); } private void addTotalOccupantsStats() { // Register a statistic. Statistic statistic = new Statistic() { public String getName() { return LocaleUtils.getLocalizedString("muc.stats.occupants.name"); } public Type getStatType() { return Type.count; } public String getDescription() { return LocaleUtils.getLocalizedString("muc.stats.occupants.description"); } public String getUnits() { return LocaleUtils.getLocalizedString("muc.stats.occupants.label"); } public double sample() { return getNumberRoomOccupants(); } public boolean isPartialSample() { return false; } }; StatisticsManager.getInstance().addStatistic(occupantsStatKey, statistic); } private void addTotalConnectedUsers() { // Register a statistic. Statistic statistic = new Statistic() { public String getName() { return LocaleUtils.getLocalizedString("muc.stats.users.name"); } public Type getStatType() { return Type.count; } public String getDescription() { return LocaleUtils.getLocalizedString("muc.stats.users.description"); } public String getUnits() { return LocaleUtils.getLocalizedString("muc.stats.users.label"); } public double sample() { return getNumberConnectedUsers(false); } public boolean isPartialSample() { return false; } }; StatisticsManager.getInstance().addStatistic(usersStatKey, statistic); } private void addNumberIncomingMessages() { // Register a statistic. Statistic statistic = new Statistic() { public String getName() { return LocaleUtils.getLocalizedString("muc.stats.incoming.name"); } public Type getStatType() { return Type.rate; } public String getDescription() { return LocaleUtils.getLocalizedString("muc.stats.incoming.description"); } public String getUnits() { return LocaleUtils.getLocalizedString("muc.stats.incoming.label"); } public double sample() { return inMessages.getAndSet(0); } public boolean isPartialSample() { // Get this value from the other cluster nodes return true; } }; StatisticsManager.getInstance().addMultiStatistic(incomingStatKey, trafficStatGroup, statistic); } private void addNumberOutgoingMessages() { // Register a statistic. Statistic statistic = new Statistic() { public String getName() { return LocaleUtils.getLocalizedString("muc.stats.outgoing.name"); } public Type getStatType() { return Type.rate; } public String getDescription() { return LocaleUtils.getLocalizedString("muc.stats.outgoing.description"); } public String getUnits() { return LocaleUtils.getLocalizedString("muc.stats.outgoing.label"); } public double sample() { return outMessages.getAndSet(0); } public boolean isPartialSample() { // Each cluster node knows the total across the cluster return false; } }; StatisticsManager.getInstance().addMultiStatistic(outgoingStatKey, trafficStatGroup, statistic); } }