From 322fa58e850a1f6ee0f48601d8a3ad575aaddb97 Mon Sep 17 00:00:00 2001
From: Guus der Kinderen <guus.der.kinderen@gmail.com>
Date: Tue, 1 Nov 2022 12:35:44 +0100
Subject: [PATCH] for #159: Add logging

---
 .../rest/controller/MUCRoomController.java    | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/src/java/org/jivesoftware/openfire/plugin/rest/controller/MUCRoomController.java b/src/java/org/jivesoftware/openfire/plugin/rest/controller/MUCRoomController.java
index 0e5372f8f..34b893e95 100644
--- a/src/java/org/jivesoftware/openfire/plugin/rest/controller/MUCRoomController.java
+++ b/src/java/org/jivesoftware/openfire/plugin/rest/controller/MUCRoomController.java
@@ -93,6 +93,12 @@ public static void log(String logMessage) {
         }
     }
 
+    public static void log(String logMessage, Throwable t) {
+        if (JiveGlobals.getBooleanProperty(RESTServicePlugin.SERVICE_LOGGING_ENABLED, false)) {
+            LOG.info(logMessage, t);
+        }
+    }
+
     /**
      * Returns the chat room instance for the provided name.
      *
@@ -261,9 +267,11 @@ public RoomCreationResultEntities createMultipleChatRooms(String serviceName, MU
                 result.setResultType(RoomCreationResultEntity.RoomCreationResultType.Success);
                 result.setMessage("Room was successfully created");
             } catch (AlreadyExistsException e) {
+                log("Already exists exception thrown while trying to create room: " + roomToCreate.getRoomName(), e);
                 result.setResultType(RoomCreationResultEntity.RoomCreationResultType.Success);
                 result.setMessage("Room already existed and therefore not created again");
             } catch (NotAllowedException | ForbiddenException | ConflictException e) {
+                log("Failed to create room: " + roomToCreate.getRoomName(), e);
                 result.setResultType(RoomCreationResultEntity.RoomCreationResultType.Failure);
                 result.setMessage("Room creation failed due to " + e.getClass().getSimpleName() + ": " + e.getMessage());
             }
@@ -298,10 +306,13 @@ public void updateChatRoom(String roomName, String serviceName, MUCRoomEntity mu
             }
             createRoom(mucRoomEntity, serviceName, sendInvitations);
         } catch (NotAllowedException | ForbiddenException e) {
+            log("Failed to update room: " + mucRoomEntity.getRoomName(), e);
             throw new ServiceException("Could not update the channel", roomName, ExceptionType.NOT_ALLOWED, Response.Status.FORBIDDEN, e);
         } catch (ConflictException e) {
+            log("Failed to update room: " + mucRoomEntity.getRoomName(), e);
             throw new ServiceException("Could not update the channel", roomName, ExceptionType.NOT_ALLOWED, Response.Status.CONFLICT, e);
         } catch (AlreadyExistsException e) {
+            log("Already exists exception thrown while trying to update room: " + mucRoomEntity.getRoomName(), e);
             throw new ServiceException("Could not update the channel", mucRoomEntity.getRoomName(),
                     ExceptionType.ALREADY_EXISTS, Response.Status.CONFLICT, e);
         }
@@ -342,9 +353,11 @@ private void createRoom(MUCRoomEntity mucRoomEntity, String serviceName, boolean
         //	Check if chat service is available, if not create a new one
         boolean serviceRegistered = XMPPServer.getInstance().getMultiUserChatManager().isServiceRegistered(serviceName);
         if(!serviceRegistered) {
+            log("Creating a new service for the chat room that is being created: " + serviceName);
             XMPPServer.getInstance().getMultiUserChatManager().createMultiUserChatService(serviceName, serviceName, false);
         }
 
+        log("Setting initial values for room that is being created: " + mucRoomEntity.getRoomName());
         MUCRoom room = MUCServiceController.getService(serviceName).getChatRoom(mucRoomEntity.getRoomName(), owner);
 
         // Set values
@@ -375,6 +388,7 @@ private void createRoom(MUCRoomEntity mucRoomEntity, String serviceName, boolean
         }
 
         // Set all roles
+        log("Setting roles for room that is being created: " + mucRoomEntity.getRoomName());
         Collection<JID> allUsersWithNewAffiliations = null;
         if (!equalToAffiliations(room, mucRoomEntity)) {
             allUsersWithNewAffiliations = setRoles(room, mucRoomEntity);
@@ -395,18 +409,23 @@ private void createRoom(MUCRoomEntity mucRoomEntity, String serviceName, boolean
         }
 
         // Unlock the room, because the default configuration lock the room.  		
+        log("Unlocking room that is being created: " + mucRoomEntity.getRoomName());
         room.unlock(room.getRole());
 
         // Save the room to the DB if the room should be persistent
         if (room.isPersistent()) {
+            log("Persisting room that is being created: " + mucRoomEntity.getRoomName());
             room.saveToDB();
         }
 
+        log("Syncing room that is being created: " + mucRoomEntity.getRoomName());
         MUCServiceController.getService(serviceName).syncChatRoom(room);
 
         if (sendInvitations && allUsersWithNewAffiliations != null) {
+            log("Sending invitations for room that is being created: " + mucRoomEntity.getRoomName());
             sendInvitationsFromRoom(room, null, allUsersWithNewAffiliations, null, true);
         }
+        log("Done creating room: " + mucRoomEntity.getRoomName());
     }
 
     private boolean equalToAffiliations(MUCRoom room, MUCRoomEntity mucRoomEntity) {