Added ability to manually lock/unlock a room. JM-46

git-svn-id: http://svn.igniterealtime.org/svn/repos/messenger/trunk@723 b35dd754-fafc-0310-a699-88a17e54d16e

src/java/org/jivesoftware/messenger/muc/MUCRoom.java

@@ -381,6 +381,15 @@ public interface MUCRoom extends ChatDeliverer {
      */
     public boolean isLocked();
 
+    /**
+     * Returns true if the room is locked and it was locked by a room owner after the room was
+     * initially configured.
+     *
+     * @return true if the room is locked and it was locked by a room owner after the room was
+     *         initially configured.
+     */
+    public boolean isManuallyLocked();
+
     /**
      * An event callback fired whenever an occupant changes his nickname within the chatroom.
      *  
@@ -767,14 +776,24 @@ public interface MUCRoom extends ChatDeliverer {
      */
     public boolean canBroadcastPresence(String roleToBroadcast);
 
+    /**
+     * Locks the room so that users cannot join the room. Only the owner of the room can lock/unlock
+     * the room.
+     *
+     * @param senderRole the role of the occupant that locked the room.
+     * @throws ForbiddenException If the user is not an owner of the room.
+     */
+    public void lock(MUCRole senderRole) throws ForbiddenException;
+
     /**
      * Unlocks the room so that users can join the room. The room is locked when created and only
      * the owner of the room can unlock it by sending the configuration form to the Multi-User Chat
      * service.
      *
      * @param senderRole the role of the occupant that unlocked the room.
+     * @throws ForbiddenException If the user is not an owner of the room.
      */
-    public void unlockRoom(MUCRole senderRole);
+    public void unlock(MUCRole senderRole) throws ForbiddenException;
 
     /**
      * Sends an invitation to a user. The invitation will be sent as if the room is inviting the 

src/java/org/jivesoftware/messenger/muc/spi/IQOwnerHandler.java

@@ -309,8 +309,8 @@ public class IQOwnerHandler {
             }
             // If the room was locked, unlock it and send to the owner the "room is now unlocked"
             // message
-            if (room.isLocked()) {
-                room.unlockRoom(senderRole);
+            if (room.isLocked() && !room.isManuallyLocked()) {
+                room.unlock(senderRole);
             }
         }
     }

src/java/org/jivesoftware/messenger/muc/spi/MUCPersistenceManager.java

@@ -41,7 +41,7 @@ public class MUCPersistenceManager {
     private static final String GET_RESERVED_NAME =
         "SELECT nickname FROM mucMember WHERE roomID=? AND jid=?";
     private static final String LOAD_ROOM =
-        "SELECT roomID, creationDate, modificationDate, naturalName, description, " +
+        "SELECT roomID, creationDate, modificationDate, naturalName, description, lockedDate, " +
         "canChangeSubject, maxUsers, publicRoom, moderated, membersOnly, canInvite, " +
         "password, canDiscoverJID, logEnabled, subject, rolesToBroadcast " +
         "FROM mucRoom WHERE name=?";
@@ -54,7 +54,7 @@ public class MUCPersistenceManager {
         "WHERE time>? AND roomID=? AND (nickname != \"\" OR subject IS NOT NULL) ORDER BY time";
     private static final String LOAD_ALL_ROOMS =
         "SELECT roomID, creationDate, modificationDate, name, naturalName, description, " +
-        "canChangeSubject, maxUsers, publicRoom, moderated, membersOnly, canInvite, " +
+        "lockedDate, canChangeSubject, maxUsers, publicRoom, moderated, membersOnly, canInvite, " +
         "password, canDiscoverJID, logEnabled, subject, rolesToBroadcast " +
         "FROM mucRoom";
     private static final String LOAD_ALL_AFFILIATIONS =
@@ -71,11 +71,13 @@ public class MUCPersistenceManager {
         "WHERE roomID=?";
     private static final String ADD_ROOM = 
         "INSERT INTO mucRoom (roomID, creationDate, modificationDate, name, naturalName, " +
-        "description, canChangeSubject, maxUsers, publicRoom, moderated, membersOnly, " +
-        "canInvite, password, canDiscoverJID, logEnabled, subject, rolesToBroadcast)" +
-        "VALUES (?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?)";
+        "description, lockedDate, canChangeSubject, maxUsers, publicRoom, moderated, " +
+        "membersOnly, canInvite, password, canDiscoverJID, logEnabled, subject, rolesToBroadcast)" +
+        "VALUES (?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?)";
     private static final String UPDATE_SUBJECT =
         "UPDATE mucRoom SET subject=? WHERE roomID=?";
+    private static final String UPDATE_LOCK =
+        "UPDATE mucRoom SET lockedDate=? WHERE roomID=?";
     private static final String DELETE_ROOM =
         "DELETE FROM mucRoom WHERE roomID=?";
     private static final String DELETE_AFFILIATIONS =
@@ -139,7 +141,7 @@ public class MUCPersistenceManager {
      * 
      * @param room the room to load from the database if persistent
      */
-    public static void loadFromDB(MUCRoom room) {
+    public static void loadFromDB(MUCRoomImpl room) {
         Connection con = null;
         PreparedStatement pstmt = null;
         try {
@@ -155,18 +157,19 @@ public class MUCPersistenceManager {
             room.setModificationDate(new Date(Long.parseLong(rs.getString(3).trim()))); // modification date
             room.setNaturalLanguageName(rs.getString(4));
             room.setDescription(rs.getString(5));
-            room.setCanOccupantsChangeSubject(rs.getInt(6) == 1 ? true : false);
-            room.setMaxUsers(rs.getInt(7));
-            room.setPublicRoom(rs.getInt(8) == 1 ? true : false);
-            room.setModerated(rs.getInt(9) == 1 ? true : false);
-            room.setMembersOnly(rs.getInt(10) == 1 ? true : false);
-            room.setCanOccupantsInvite(rs.getInt(11) == 1 ? true : false);
-            room.setPassword(rs.getString(12));
-            room.setCanAnyoneDiscoverJID(rs.getInt(13) == 1 ? true : false);
-            room.setLogEnabled(rs.getInt(14) == 1 ? true : false);
-            room.setSubject(rs.getString(15));
+            room.setLockedDate(new Date(Long.parseLong(rs.getString(6).trim())));
+            room.setCanOccupantsChangeSubject(rs.getInt(7) == 1 ? true : false);
+            room.setMaxUsers(rs.getInt(8));
+            room.setPublicRoom(rs.getInt(9) == 1 ? true : false);
+            room.setModerated(rs.getInt(10) == 1 ? true : false);
+            room.setMembersOnly(rs.getInt(11) == 1 ? true : false);
+            room.setCanOccupantsInvite(rs.getInt(12) == 1 ? true : false);
+            room.setPassword(rs.getString(13));
+            room.setCanAnyoneDiscoverJID(rs.getInt(14) == 1 ? true : false);
+            room.setLogEnabled(rs.getInt(15) == 1 ? true : false);
+            room.setSubject(rs.getString(16));
             List<String> rolesToBroadcast = new ArrayList<String>();
-            String roles = Integer.toBinaryString(rs.getInt(16));
+            String roles = Integer.toBinaryString(rs.getInt(17));
             if (roles.charAt(0) == '1') {
                 rolesToBroadcast.add("moderator");
             }
@@ -269,7 +272,7 @@ public class MUCPersistenceManager {
      * 
      * @param room The room to save its configuration.
      */
-    public static void saveToDB(MUCRoom room) {
+    public static void saveToDB(MUCRoomImpl room) {
         Connection con = null;
         PreparedStatement pstmt = null;
         try {
@@ -300,17 +303,18 @@ public class MUCPersistenceManager {
                 pstmt.setString(4, room.getName());
                 pstmt.setString(5, room.getNaturalLanguageName());
                 pstmt.setString(6, room.getDescription());
-                pstmt.setInt(7, (room.canOccupantsChangeSubject() ? 1 : 0));
-                pstmt.setInt(8, room.getMaxUsers());
-                pstmt.setInt(9, (room.isPublicRoom() ? 1 : 0));
-                pstmt.setInt(10, (room.isModerated() ? 1 : 0));
-                pstmt.setInt(11, (room.isMembersOnly() ? 1 : 0));
-                pstmt.setInt(12, (room.canOccupantsInvite() ? 1 : 0));
-                pstmt.setString(13, room.getPassword());
-                pstmt.setInt(14, (room.canAnyoneDiscoverJID() ? 1 : 0));
-                pstmt.setInt(15, (room.isLogEnabled() ? 1 : 0));
-                pstmt.setString(16, room.getSubject());
-                pstmt.setInt(17, marshallRolesToBroadcast(room));
+                pstmt.setString(7, StringUtils.dateToMillis(room.getLockedDate()));
+                pstmt.setInt(8, (room.canOccupantsChangeSubject() ? 1 : 0));
+                pstmt.setInt(9, room.getMaxUsers());
+                pstmt.setInt(10, (room.isPublicRoom() ? 1 : 0));
+                pstmt.setInt(11, (room.isModerated() ? 1 : 0));
+                pstmt.setInt(12, (room.isMembersOnly() ? 1 : 0));
+                pstmt.setInt(13, (room.canOccupantsInvite() ? 1 : 0));
+                pstmt.setString(14, room.getPassword());
+                pstmt.setInt(15, (room.canAnyoneDiscoverJID() ? 1 : 0));
+                pstmt.setInt(16, (room.isLogEnabled() ? 1 : 0));
+                pstmt.setString(17, room.getSubject());
+                pstmt.setInt(18, marshallRolesToBroadcast(room));
                 pstmt.executeUpdate();
             }
         }
@@ -382,7 +386,7 @@ public class MUCPersistenceManager {
             con = DbConnectionManager.getConnection();
             pstmt = con.prepareStatement(LOAD_ALL_ROOMS);
             ResultSet rs = pstmt.executeQuery();
-            MUCRoom room = null;
+            MUCRoomImpl room = null;
             while (rs.next()) {
                 room = new MUCRoomImpl(chatserver, rs.getString(4), packetRouter);
                 room.setID(rs.getLong(1));
@@ -390,18 +394,19 @@ public class MUCPersistenceManager {
                 room.setModificationDate(new Date(Long.parseLong(rs.getString(3).trim()))); // modification date
                 room.setNaturalLanguageName(rs.getString(5));
                 room.setDescription(rs.getString(6));
-                room.setCanOccupantsChangeSubject(rs.getInt(7) == 1 ? true : false);
-                room.setMaxUsers(rs.getInt(8));
-                room.setPublicRoom(rs.getInt(9) == 1 ? true : false);
-                room.setModerated(rs.getInt(10) == 1 ? true : false);
-                room.setMembersOnly(rs.getInt(11) == 1 ? true : false);
-                room.setCanOccupantsInvite(rs.getInt(12) == 1 ? true : false);
-                room.setPassword(rs.getString(13));
-                room.setCanAnyoneDiscoverJID(rs.getInt(14) == 1 ? true : false);
-                room.setLogEnabled(rs.getInt(15) == 1 ? true : false);
-                room.setSubject(rs.getString(16));
+                room.setLockedDate(new Date(Long.parseLong(rs.getString(7).trim())));
+                room.setCanOccupantsChangeSubject(rs.getInt(8) == 1 ? true : false);
+                room.setMaxUsers(rs.getInt(9));
+                room.setPublicRoom(rs.getInt(10) == 1 ? true : false);
+                room.setModerated(rs.getInt(11) == 1 ? true : false);
+                room.setMembersOnly(rs.getInt(12) == 1 ? true : false);
+                room.setCanOccupantsInvite(rs.getInt(13) == 1 ? true : false);
+                room.setPassword(rs.getString(14));
+                room.setCanAnyoneDiscoverJID(rs.getInt(15) == 1 ? true : false);
+                room.setLogEnabled(rs.getInt(16) == 1 ? true : false);
+                room.setSubject(rs.getString(17));
                 List<String> rolesToBroadcast = new ArrayList<String>();
-                String roles = Integer.toBinaryString(rs.getInt(17));
+                String roles = Integer.toBinaryString(rs.getInt(18));
                 if (roles.charAt(0) == '1') {
                     rolesToBroadcast.add("moderator");
                 }
@@ -425,7 +430,7 @@ public class MUCPersistenceManager {
             // Load the rooms conversations from the last two days
             rs = pstmt.executeQuery();
             while (rs.next()) {
-                room = rooms.get(rs.getLong(1));
+                room = (MUCRoomImpl) rooms.get(rs.getLong(1));
                 // Skip to the next position if the room does not exist
                 if (room == null) {
                     continue;
@@ -463,7 +468,7 @@ public class MUCPersistenceManager {
             while (rs.next()) {
                 String jid = rs.getString(2);
                 int affiliation = rs.getInt(3);
-                room = rooms.get(rs.getLong(1));
+                room = (MUCRoomImpl) rooms.get(rs.getLong(1));
                 try {
                     switch (affiliation) {
                         case MUCRole.OWNER:
@@ -490,7 +495,7 @@ public class MUCPersistenceManager {
             pstmt = con.prepareStatement(LOAD_ALL_MEMBERS);
             rs = pstmt.executeQuery();
             while (rs.next()) {
-                room = rooms.get(rs.getLong(1));
+                room = (MUCRoomImpl) rooms.get(rs.getLong(1));
                 try {
                     room.addMember(rs.getString(2), rs.getString(3), room.getRole());
                 }
@@ -523,9 +528,8 @@ public class MUCPersistenceManager {
      * Updates the room's subject in the database. 
      * 
      * @param room the room to update its subject in the database.
-     * @param subject the new subject of the room.
      */
-    public static void updateRoomSubject(MUCRoom room, String subject) {
+    public static void updateRoomSubject(MUCRoom room) {
         if (!room.isPersistent() || !room.wasSavedToDB()) {
             return;
         }
@@ -535,7 +539,37 @@ public class MUCPersistenceManager {
         try {
             con = DbConnectionManager.getConnection();
             pstmt = con.prepareStatement(UPDATE_SUBJECT);
-            pstmt.setString(1, subject);
+            pstmt.setString(1, room.getSubject());
+            pstmt.setLong(2, room.getID());
+            pstmt.executeUpdate();
+        }
+        catch (SQLException sqle) {
+            Log.error(sqle);
+        }
+        finally {
+            try { if (pstmt != null) pstmt.close(); }
+            catch (Exception e) { Log.error(e); }
+            try { if (con != null) con.close(); }
+            catch (Exception e) { Log.error(e); }
+        }
+    }
+
+    /**
+     * Updates the room's lock status in the database.
+     *
+     * @param room the room to update its lock status in the database.
+     */
+    public static void updateRoomLock(MUCRoomImpl room) {
+        if (!room.isPersistent() || !room.wasSavedToDB()) {
+            return;
+        }
+
+        Connection con = null;
+        PreparedStatement pstmt = null;
+        try {
+            con = DbConnectionManager.getConnection();
+            pstmt = con.prepareStatement(UPDATE_LOCK);
+            pstmt.setString(1, StringUtils.dateToMillis(room.getLockedDate()));
             pstmt.setLong(2, room.getID());
             pstmt.executeUpdate();
         }

src/java/org/jivesoftware/messenger/muc/spi/MUCRoomImpl.java

@@ -36,14 +36,6 @@ import org.dom4j.Element;
  */
 public class MUCRoomImpl implements MUCRoom {
 
-    /**
-     * The timeout period to unlock a room. If the period expired the default means that the default
-     * configuration was accepted for the room.
-     */
-    // TODO Set this variable from a default configuration. Add setters and getters.
-    // Default value is 30 min ( 30(min) * 60(sec) * 1000(mill) )
-    public static long LOCK_TIMEOUT = 1800000;
-
     /**
      * The server hosting the room.
      */
@@ -108,14 +100,9 @@ public class MUCRoomImpl implements MUCRoom {
     private MUCRoomHistory roomHistory;
 
     /**
-     * Flag that indicates whether a room is locked or not.
-     */
-    private boolean roomLocked;
-
-    /**
-     * The time when the room was locked.
+     * Time when the room was locked. A value of zero means that the room is unlocked.
      */
-    long lockedTime;
+    private long lockedTime;
 
     /**
      * List of chatroom's owner. The list contains only bare jid.
@@ -273,7 +260,6 @@ public class MUCRoomImpl implements MUCRoom {
         this.iqOwnerHandler = new IQOwnerHandler(this, packetRouter);
         this.iqAdminHandler = new IQAdminHandler(this, packetRouter);
         // No one can join the room except the room's owner
-        this.roomLocked = true;
         this.lockedTime = startTime;
         // Set the default roles for which presence is broadcast
         rolesToBroadcastPresence.add("moderator");
@@ -394,7 +380,7 @@ public class MUCRoomImpl implements MUCRoom {
             }
             boolean isOwner = owners.contains(user.getAddress().toBareJID());
             // If the room is locked and this user is not an owner raise a RoomLocked exception
-            if (roomLocked) {
+            if (isLocked()) {
                 if (!isOwner) {
                     throw new RoomLockedException();
                 }
@@ -500,8 +486,8 @@ public class MUCRoomImpl implements MUCRoom {
         }
         if (joinRole != null) {
             // It is assumed that the room is new based on the fact that it's locked and
-            // it has only one occupants (the owner).
-            boolean isRoomNew = roomLocked && occupants.size() == 1;
+            // that it was locked when it was created.
+            boolean isRoomNew = isLocked() && creationDate.getTime() == lockedTime;
             try {
                 // Send the presence of this new occupant to existing occupants
                 Presence joinPresence = joinRole.getPresence().createCopy();
@@ -512,7 +498,6 @@ public class MUCRoomImpl implements MUCRoom {
                 }
                 joinPresence.setFrom(joinRole.getRoleAddress());
                 broadcastPresence(joinPresence);
-
             }
             catch (Exception e) {
                 Log.error(LocaleUtils.getLocalizedString("admin.error"), e);
@@ -520,6 +505,15 @@ public class MUCRoomImpl implements MUCRoom {
             // If the room has just been created send the "room locked until configuration is
             // confirmed" message
             if (isRoomNew) {
+                Message message = new Message();
+                message.setType(Message.Type.groupchat);
+                message.setBody(LocaleUtils.getLocalizedString("muc.new"));
+                message.setFrom(role.getRoleAddress());
+                message.setTo(user.getAddress());
+                router.route(message);
+            }
+            else if (isLocked()) {
+                // Warn the owner that the room is locked but it's not new
                 Message message = new Message();
                 message.setType(Message.Type.groupchat);
                 message.setBody(LocaleUtils.getLocalizedString("muc.locked"));
@@ -1231,11 +1225,11 @@ public class MUCRoomImpl implements MUCRoom {
     }
 
     public boolean isLocked() {
-        if (System.currentTimeMillis() - startTime > LOCK_TIMEOUT) {
-            // Unlock the room. The default configuration is assumed to be accepted by the owner.
-            roomLocked = false;
-        }
-        return roomLocked;
+        return lockedTime > 0;
+    }
+
+    public boolean isManuallyLocked() {
+        return lockedTime > 0 && creationDate.getTime() != lockedTime;
     }
 
     public void nicknameChanged(String oldNick, String newNick) {
@@ -1254,7 +1248,7 @@ public class MUCRoomImpl implements MUCRoom {
             }
             // Set the new subject to the room
             subject = packet.getSubject();
-            MUCPersistenceManager.updateRoomSubject(this, subject);
+            MUCPersistenceManager.updateRoomSubject(this);
             // Notify all the occupants that the subject has changed
             packet.setFrom(role.getRoleAddress());
             send(packet);
@@ -1578,11 +1572,6 @@ public class MUCRoomImpl implements MUCRoom {
     
     public void setSavedToDB(boolean saved) {
         this.savedToDB = saved;
-        if (saved) {
-            // Unlock the room now. This is necessary only when a persistent room has been
-            // retrieved from the database.
-            this.roomLocked = false;
-        }
     }
     
     public void setPersistent(boolean persistent) {
@@ -1609,7 +1598,7 @@ public class MUCRoomImpl implements MUCRoom {
 
     /**
      * Returns true if we need to check whether a presence could be sent or not.
-     * 
+     *
      * @return true if we need to check whether a presence could be sent or not.
      */
     private boolean hasToCheckRoleToBroadcastPresence() {
@@ -1621,9 +1610,35 @@ public class MUCRoomImpl implements MUCRoom {
         return "none".equals(roleToBroadcast) || rolesToBroadcastPresence.contains(roleToBroadcast);
     }
 
-    public void unlockRoom(MUCRole senderRole) {
-        roomLocked = false;
-        this.lockedTime = 0;
+    public void lock(MUCRole senderRole) throws ForbiddenException {
+        if (MUCRole.OWNER != senderRole.getAffiliation()) {
+            throw new ForbiddenException();
+        }
+        if (isLocked()) {
+            // Do nothing if the room was already locked
+            return;
+        }
+        setLocked(true);
+        if (senderRole.getChatUser() != null) {
+            // Send to the occupant that locked the room a message saying so
+            Message message = new Message();
+            message.setType(Message.Type.groupchat);
+            message.setBody(LocaleUtils.getLocalizedString("muc.locked"));
+            message.setFrom(getRole().getRoleAddress());
+            message.setTo(senderRole.getChatUser().getAddress());
+            router.route(message);
+        }
+    }
+
+    public void unlock(MUCRole senderRole) throws ForbiddenException {
+        if (MUCRole.OWNER != senderRole.getAffiliation()) {
+            throw new ForbiddenException();
+        }
+        if (!isLocked()) {
+            // Do nothing if the room was already unlocked
+            return;
+        }
+        setLocked(false);
         if (senderRole.getChatUser() != null) {
             // Send to the occupant that unlocked the room a message saying so
             Message message = new Message();
@@ -1635,6 +1650,40 @@ public class MUCRoomImpl implements MUCRoom {
         }
     }
 
+    private void setLocked(boolean locked) {
+        if (locked) {
+            this.lockedTime = System.currentTimeMillis();
+        }
+        else {
+            this.lockedTime = 0;
+        }
+        MUCPersistenceManager.updateRoomLock(this);
+    }
+
+    /**
+     * Sets the date when the room was locked. Initially when the room is created it is locked so
+     * the locked date is the creation date of the room. Afterwards, the room may be manually
+     * locked and unlocked so the locked date may be in these cases different than the creation
+     * date. A Date with time 0 means that the the room is unlocked.
+     *
+     * @param lockedTime the date when the room was locked.
+     */
+    void setLockedDate(Date lockedTime) {
+        this.lockedTime = lockedTime.getTime();
+    }
+
+    /**
+     * Returns the date when the room was locked. Initially when the room is created it is locked so
+     * the locked date is the creation date of the room. Afterwards, the room may be manually
+     * locked and unlocked so the locked date may be in these cases different than the creation
+     * date. When the room is unlocked a Date with time 0 is returned.
+     *
+     * @return the date when the room was locked.
+     */
+    Date getLockedDate() {
+        return new Date(lockedTime);
+    }
+
     public List<Presence> addAdmins(List<String> newAdmins, MUCRole senderRole)
             throws ForbiddenException, ConflictException {
         List<Presence> answer = new ArrayList<Presence>(newAdmins.size());

src/java/org/jivesoftware/messenger/muc/spi/MUCUserImpl.java

@@ -356,8 +356,8 @@ public class MUCUserImpl implements MUCUser {
                             roles.put(group, role);
                             // If the client that created the room is non-MUC compliant then
                             // unlock the room thus creating an "instant" room
-                            if (room.isLocked() && mucInfo == null) {
-                                room.unlockRoom(role);
+                            if (mucInfo == null && room.isLocked() && !room.isManuallyLocked()) {
+                                room.unlock(role);
                             }
                         }
                         catch (UnauthorizedException e) {

src/java/org/jivesoftware/messenger/muc/spi/MultiUserChatServerImpl.java

@@ -276,7 +276,7 @@ public class MultiUserChatServerImpl extends BasicModule implements MultiUserCha
                 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)
-                    MUCPersistenceManager.loadFromDB(room);
+                    MUCPersistenceManager.loadFromDB((MUCRoomImpl) room);
                 }
                 catch (IllegalArgumentException e) {
                     // The room does not exist so check for creation permissions