OF-2918: Expose numeric MUC room ID in events

guusdk · guusdk · commit 13fd36670383 · 2025-01-06T11:13:08.000+01:00
A MUC room of the same name (JID) can be created, destroyed and recreated again. The two rooms should be seen as two different rooms.

When using the JID of the rooms, there's no way to distinghuish between them. For that, Openfire's numeric ID can be used.

In this commit, the numeric ID is added to selected MUC events.
diff --git a/xmppserver/src/main/java/org/jivesoftware/openfire/muc/MUCEventDispatcher.java b/xmppserver/src/main/java/org/jivesoftware/openfire/muc/MUCEventDispatcher.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2005-2008 Jive Software, 2017-2024 Ignite Realtime Foundation. All rights reserved.
+ * Copyright (C) 2005-2008 Jive Software, 2017-2025 Ignite Realtime Foundation. All rights reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -102,32 +102,32 @@ public static void privateMessageRecieved(JID toJID, JID fromJID, Message messag
         }
     }
 
-    public static void roomCreated(JID roomJID) {
+    public static void roomCreated(long roomID, JID roomJID) {
         for (MUCEventListener listener : listeners) {
             try {
-                listener.roomCreated(roomJID);   
+                listener.roomCreated(roomID, roomJID);
             } catch (Exception e) {
-                Log.warn("An exception occurred while dispatching a 'roomCreated' event!", e);
+                Log.warn("An exception occurred while dispatching a 'roomCreated' event for room {} ({})!", roomJID, roomID, e);
             }
         }
     }
 
-    public static void roomDestroyed(JID roomJID) {
+    public static void roomDestroyed(long roomID, JID roomJID) {
         for (MUCEventListener listener : listeners) {
             try {
-                listener.roomDestroyed(roomJID);
+                listener.roomDestroyed(roomID, roomJID);
             } catch (Exception e) {
-                Log.warn("An exception occurred while dispatching a 'roomDestroyed' event!", e);
+                Log.warn("An exception occurred while dispatching a 'roomDestroyed' event for room {} ({})!", roomJID, roomID, e);
             }
         }
     }
 
-    public static void roomClearChatHistory(JID roomJID) {
+    public static void roomClearChatHistory(long roomID, JID roomJID) {
         for (MUCEventListener listener : listeners) {
             try {
-                listener.roomClearChatHistory(roomJID);
+                listener.roomClearChatHistory(roomID, roomJID);
             } catch (Exception e) {
-                Log.warn("An exception occurred while dispatching a 'roomClearChatHistory' event for room {}!", roomJID, e);
+                Log.warn("An exception occurred while dispatching a 'roomClearChatHistory' event for room {} ({})!",  roomJID, roomID, e);
             }
         }
     }
diff --git a/xmppserver/src/main/java/org/jivesoftware/openfire/muc/MUCEventListener.java b/xmppserver/src/main/java/org/jivesoftware/openfire/muc/MUCEventListener.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2005-2008 Jive Software, 2017-2024 Ignite Realtime Foundation. All rights reserved.
+ * Copyright (C) 2005-2008 Jive Software, 2017-2025 Ignite Realtime Foundation. All rights reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -19,6 +19,8 @@
 import org.xmpp.packet.JID;
 import org.xmpp.packet.Message;
 
+import javax.annotation.Nonnull;
+
 /**
  * Interface to listen for MUC events. Use the {@link MUCEventDispatcher#addListener(MUCEventListener)}
  * method to register for events.
@@ -32,21 +34,21 @@ public interface MUCEventListener {
      *
      * @param roomJID JID of the room that was created.
      */
-    void roomCreated(JID roomJID);
+    void roomCreated(final long roomID, final @Nonnull JID roomJID);
 
     /**
      * Event triggered when a room was destroyed.
      *
      * @param roomJID JID of the room that was destroyed.
      */
-    void roomDestroyed(JID roomJID);
+    void roomDestroyed(final long roomID, final @Nonnull JID roomJID);
 
     /**
      * Event triggered when a clear chat history command was issued.
      *
      * @param roomJID JID of the room to clear chat history.
      */
-    void roomClearChatHistory(JID roomJID);
+    void roomClearChatHistory(final long roomID, final @Nonnull JID roomJID);
 
     /**
      * Event triggered when a new occupant joins a room.
diff --git a/xmppserver/src/main/java/org/jivesoftware/openfire/muc/MUCRoom.java b/xmppserver/src/main/java/org/jivesoftware/openfire/muc/MUCRoom.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2004-2008 Jive Software, 2016-2024 Ignite Realtime Foundation. All rights reserved.
+ * Copyright (C) 2004-2008 Jive Software, 2016-2025 Ignite Realtime Foundation. All rights reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -1364,7 +1364,7 @@ public CompletableFuture<Void> clearChatHistory() {
             // Remove the history of the room from memory (preventing it to pop up in a new room by the same name).
             roomHistory.purge();
             // Fire event to clear chat room history
-            MUCEventDispatcher.roomClearChatHistory(getJID());
+            MUCEventDispatcher.roomClearChatHistory(getID(), getJID());
         });
     }
 
@@ -1446,10 +1446,10 @@ public void destroyRoom(JID alternateJID, String password, String reason) {
         roomHistory.purge();
         // If we are not preserving room history on deletion, fire event to clear chat room history
         if(!preserveHistOnRoomDeletion) {
-            MUCEventDispatcher.roomClearChatHistory(getJID());
+            MUCEventDispatcher.roomClearChatHistory(getID(), getJID());
         }
         // Fire event that the room has been destroyed
-        MUCEventDispatcher.roomDestroyed(getJID());
+        MUCEventDispatcher.roomDestroyed(getID(), getJID());
     }
 
     /**
diff --git a/xmppserver/src/main/java/org/jivesoftware/openfire/muc/spi/LocalMUCRoomManager.java b/xmppserver/src/main/java/org/jivesoftware/openfire/muc/spi/LocalMUCRoomManager.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2016-2024 Ignite Realtime Foundation. All rights reserved.
+ * Copyright (C) 2016-2025 Ignite Realtime Foundation. All rights reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -402,7 +402,8 @@ public void entryRemoved(@Nonnull String key, @Nullable MUCRoom oldValue, @Nonnu
                 localRooms.remove(key);
                 final MultiUserChatService service = XMPPServer.getInstance().getMultiUserChatManager().getMultiUserChatService(serviceName);
                 if (service != null) {
-                    service.getOccupantManager().roomDestroyed(new JID(key, service.getServiceDomain(), null));
+                    final long roomID = -1; // Unused by OccupantManager.
+                    service.getOccupantManager().roomDestroyed(roomID, new JID(key, service.getServiceDomain(), null));
                 }
             }
 
@@ -415,7 +416,8 @@ public void entryEvicted(@Nonnull String key, @Nullable MUCRoom oldValue, @Nonnu
                 localRooms.remove(key);
                 final MultiUserChatService service = XMPPServer.getInstance().getMultiUserChatManager().getMultiUserChatService(serviceName);
                 if (service != null) {
-                    service.getOccupantManager().roomDestroyed(new JID(key, service.getServiceDomain(), null));
+                    final long roomID = -1; // Unused by OccupantManager.
+                    service.getOccupantManager().roomDestroyed(roomID, new JID(key, service.getServiceDomain(), null));
                 }
             }
 
diff --git a/xmppserver/src/main/java/org/jivesoftware/openfire/muc/spi/MultiUserChatServiceImpl.java b/xmppserver/src/main/java/org/jivesoftware/openfire/muc/spi/MultiUserChatServiceImpl.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2004-2008 Jive Software, 2016-2024 Ignite Realtime Foundation. All rights reserved.
+ * Copyright (C) 2004-2008 Jive Software, 2016-2025 Ignite Realtime Foundation. All rights reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -1963,7 +1963,7 @@ public MUCRoom getChatRoom(@Nonnull final String roomName, @Nonnull final JID us
         }
         if (created) {
             // Fire event that a new room has been created
-            MUCEventDispatcher.roomCreated(room.getSelfRepresentation().getOccupantJID());
+            MUCEventDispatcher.roomCreated(room.getID(), room.getSelfRepresentation().getOccupantJID());
         }
         if (loaded || created) {
             // Initiate FMUC, when enabled.
@@ -3325,6 +3325,7 @@ public void leftCluster(byte[] nodeID)
                 Log.info("Room '{}' was lost from the data structure that's shared in the cluster (the cache). This room is now considered 'gone' for this cluster node. Occupants will be informed.", lostRoomName);
                 final Set<OccupantManager.Occupant> occupants = occupantManager.occupantsForRoomByNode(lostRoomName, XMPPServer.getInstance().getNodeID(), true);
                 final JID roomJID = new JID(lostRoomName, fullServiceName, null);
+                final long roomID = -1; // As this value is currently not used by OccupantManager, we can avoid the complexity in having it looked up.
                 for (final OccupantManager.Occupant occupant : occupants) {
                     try {
                         // Send a presence stanza of type "unavailable" to the occupant
@@ -3349,7 +3350,7 @@ public void leftCluster(byte[] nodeID)
                     }
                 }
                 // Clean up the locally maintained bookkeeping.
-                occupantManager.roomDestroyed(roomJID);
+                occupantManager.roomDestroyed(roomID, roomJID);
                 removeChatRoom(lostRoomName);
             } catch (Exception e) {
                 Log.warn("Unable to inform occupants on local cluster node that they are being removed from room '{}' because of a (cluster) error.", lostRoomName, e);
diff --git a/xmppserver/src/main/java/org/jivesoftware/openfire/muc/spi/OccupantManager.java b/xmppserver/src/main/java/org/jivesoftware/openfire/muc/spi/OccupantManager.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2021-2024 Ignite Realtime Foundation. All rights reserved.
+ * Copyright (C) 2021-2025 Ignite Realtime Foundation. All rights reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -937,12 +937,13 @@ public Map<Occupant, NodeID> getNodeByLocalOccupant()
     }
 
     @Override
-    public void roomCreated(JID roomJID) {
+    public void roomCreated(final long roomID, @Nonnull final JID roomJID) {
         // Not used.
     }
 
     @Override
-    public void roomDestroyed(@Nonnull final JID roomJID)
+    // Beware that the invocation does not properly initialize the first argument! Do not use it without fixing that!
+    public void roomDestroyed(final long unused, @Nonnull final JID roomJID)
     {
         // When a room is destroyed, remove all registered occupants for that room.
         mutex.writeLock().lock();
@@ -961,7 +962,7 @@ public void roomDestroyed(@Nonnull final JID roomJID)
     }
 
     @Override
-    public void roomClearChatHistory(JID roomJID) {
+    public void roomClearChatHistory(final long roomID, final @Nonnull JID roomJID) {
         // Not used.
     }
 

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*`
`2`		`- * Copyright (C) 2005-2008 Jive Software, 2017-2024 Ignite Realtime Foundation. All rights reserved.`
	`2`	`+ * Copyright (C) 2005-2008 Jive Software, 2017-2025 Ignite Realtime Foundation. All rights reserved.`
`3`	`3`	`*`
`4`	`4`	`* Licensed under the Apache License, Version 2.0 (the "License");`
`5`	`5`	`* you may not use this file except in compliance with the License.`
`@@ -102,32 +102,32 @@ public static void privateMessageRecieved(JID toJID, JID fromJID, Message messag`
`102`	`102`	`}`
`103`	`103`	`}`
`104`	`104`
`105`		`- public static void roomCreated(JID roomJID) {`
	`105`	`+ public static void roomCreated(long roomID, JID roomJID) {`
`106`	`106`	`for (MUCEventListener listener : listeners) {`
`107`	`107`	`try {`
`108`		`- listener.roomCreated(roomJID);`
	`108`	`+ listener.roomCreated(roomID, roomJID);`
`109`	`109`	`} catch (Exception e) {`
`110`		`- Log.warn("An exception occurred while dispatching a 'roomCreated' event!", e);`
	`110`	`+ Log.warn("An exception occurred while dispatching a 'roomCreated' event for room {} ({})!", roomJID, roomID, e);`
`111`	`111`	`}`
`112`	`112`	`}`
`113`	`113`	`}`
`114`	`114`
`115`		`- public static void roomDestroyed(JID roomJID) {`
	`115`	`+ public static void roomDestroyed(long roomID, JID roomJID) {`
`116`	`116`	`for (MUCEventListener listener : listeners) {`
`117`	`117`	`try {`
`118`		`- listener.roomDestroyed(roomJID);`
	`118`	`+ listener.roomDestroyed(roomID, roomJID);`
`119`	`119`	`} catch (Exception e) {`
`120`		`- Log.warn("An exception occurred while dispatching a 'roomDestroyed' event!", e);`
	`120`	`+ Log.warn("An exception occurred while dispatching a 'roomDestroyed' event for room {} ({})!", roomJID, roomID, e);`
`121`	`121`	`}`
`122`	`122`	`}`
`123`	`123`	`}`
`124`	`124`
`125`		`- public static void roomClearChatHistory(JID roomJID) {`
	`125`	`+ public static void roomClearChatHistory(long roomID, JID roomJID) {`
`126`	`126`	`for (MUCEventListener listener : listeners) {`
`127`	`127`	`try {`
`128`		`- listener.roomClearChatHistory(roomJID);`
	`128`	`+ listener.roomClearChatHistory(roomID, roomJID);`
`129`	`129`	`} catch (Exception e) {`
`130`		`- Log.warn("An exception occurred while dispatching a 'roomClearChatHistory' event for room {}!", roomJID, e);`
	`130`	`+ Log.warn("An exception occurred while dispatching a 'roomClearChatHistory' event for room {} ({})!", roomJID, roomID, e);`
`131`	`131`	`}`
`132`	`132`	`}`
`133`	`133`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*`
`2`		`- * Copyright (C) 2016-2024 Ignite Realtime Foundation. All rights reserved.`
	`2`	`+ * Copyright (C) 2016-2025 Ignite Realtime Foundation. All rights reserved.`
`3`	`3`	`*`
`4`	`4`	`* Licensed under the Apache License, Version 2.0 (the "License");`
`5`	`5`	`* you may not use this file except in compliance with the License.`
`@@ -402,7 +402,8 @@ public void entryRemoved(@Nonnull String key, @Nullable MUCRoom oldValue, @Nonnu`
`402`	`402`	`localRooms.remove(key);`
`403`	`403`	`final MultiUserChatService service = XMPPServer.getInstance().getMultiUserChatManager().getMultiUserChatService(serviceName);`
`404`	`404`	`if (service != null) {`
`405`		`- service.getOccupantManager().roomDestroyed(new JID(key, service.getServiceDomain(), null));`
	`405`	`+ final long roomID = -1; // Unused by OccupantManager.`
	`406`	`+ service.getOccupantManager().roomDestroyed(roomID, new JID(key, service.getServiceDomain(), null));`
`406`	`407`	`}`
`407`	`408`	`}`
`408`	`409`
`@@ -415,7 +416,8 @@ public void entryEvicted(@Nonnull String key, @Nullable MUCRoom oldValue, @Nonnu`
`415`	`416`	`localRooms.remove(key);`
`416`	`417`	`final MultiUserChatService service = XMPPServer.getInstance().getMultiUserChatManager().getMultiUserChatService(serviceName);`
`417`	`418`	`if (service != null) {`
`418`		`- service.getOccupantManager().roomDestroyed(new JID(key, service.getServiceDomain(), null));`
	`419`	`+ final long roomID = -1; // Unused by OccupantManager.`
	`420`	`+ service.getOccupantManager().roomDestroyed(roomID, new JID(key, service.getServiceDomain(), null));`
`419`	`421`	`}`
`420`	`422`	`}`
`421`	`423`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*`
`2`		`- * Copyright (C) 2021-2024 Ignite Realtime Foundation. All rights reserved.`
	`2`	`+ * Copyright (C) 2021-2025 Ignite Realtime Foundation. All rights reserved.`
`3`	`3`	`*`
`4`	`4`	`* Licensed under the Apache License, Version 2.0 (the "License");`
`5`	`5`	`* you may not use this file except in compliance with the License.`
`@@ -937,12 +937,13 @@ public Map<Occupant, NodeID> getNodeByLocalOccupant()`
`937`	`937`	`}`
`938`	`938`
`939`	`939`	`@Override`
`940`		`- public void roomCreated(JID roomJID) {`
	`940`	`+ public void roomCreated(final long roomID, @Nonnull final JID roomJID) {`
`941`	`941`	`// Not used.`
`942`	`942`	`}`
`943`	`943`
`944`	`944`	`@Override`
`945`		`- public void roomDestroyed(@Nonnull final JID roomJID)`
	`945`	`+ // Beware that the invocation does not properly initialize the first argument! Do not use it without fixing that!`
	`946`	`+ public void roomDestroyed(final long unused, @Nonnull final JID roomJID)`
`946`	`947`	`{`
`947`	`948`	`// When a room is destroyed, remove all registered occupants for that room.`
`948`	`949`	`mutex.writeLock().lock();`
`@@ -961,7 +962,7 @@ public void roomDestroyed(@Nonnull final JID roomJID)`
`961`	`962`	`}`
`962`	`963`
`963`	`964`	`@Override`
`964`		`- public void roomClearChatHistory(JID roomJID) {`
	`965`	`+ public void roomClearChatHistory(final long roomID, final @Nonnull JID roomJID) {`
`965`	`966`	`// Not used.`
`966`	`967`	`}`
`967`	`968`