fixes #139: refactoring: repurposing 'with' in MUC context

When processing an archived message in MAM context, using the 'with' attribute (that would otherwise go unused) to reflect the nickname of the sender of the message allows us to avoid unneeded stanza parsing.

Author: guusdk

src/java/com/reucon/openfire/plugin/archive/impl/MucMamPersistenceManager.java

@@ -226,21 +226,13 @@ public static ArchivedMessage getArchivedMessage( long messageId, MUCRoom room )
     }
 
     static protected ArchivedMessage asArchivedMessage(JID roomJID, String senderJID, String nickname, Date sentDate, String subject, String body, String stanza, long id) throws DocumentException {
-        if (stanza == null) {
-            Message message = new Message();
-            message.setType(Message.Type.groupchat);
-            message.setSubject(subject);
-            message.setBody(body);
-            // Set the sender of the message
-            if (nickname != null && nickname.trim().length() > 0) {
-                // Recreate the sender address based on the nickname and room's JID
-                message.setFrom(new JID(roomJID.getNode(), roomJID.getDomain(), nickname, true));
-            }
-            else {
-                // Set the room as the sender of the message
-                message.setFrom(roomJID);
-            }
-            stanza = message.toString();
+        final JID with;
+        if (nickname != null && nickname.trim().length() > 0) {
+            // Recreate the sender address based on the nickname and room's JID
+            with = new JID(roomJID.getNode(), roomJID.getDomain(), nickname, true);
+        }
+        else {
+            with = roomJID;
         }
 
         String sid;
@@ -257,7 +249,7 @@ static protected ArchivedMessage asArchivedMessage(JID roomJID, String senderJID
             sid = null;
         }
 
-        final ArchivedMessage archivedMessage = new ArchivedMessage(id, sentDate, ArchivedMessage.Direction.from, null, sid, body, stanza);
+        final ArchivedMessage archivedMessage = new ArchivedMessage(id, sentDate, ArchivedMessage.Direction.from, with, sid, body, stanza);
         return archivedMessage;
     }
 

src/java/com/reucon/openfire/plugin/archive/model/ArchivedMessage.java

@@ -63,7 +63,7 @@ public static Direction getDirection(@Nonnull final JID owner, @Nonnull final JI
     @Nullable
     private final String body;
 
-    @Nullable
+    @Nonnull
     private final JID with;
 
     @Nullable
@@ -72,7 +72,7 @@ public static Direction getDirection(@Nonnull final JID owner, @Nonnull final JI
     @Nullable
     private final String stableId;
 
-    public ArchivedMessage(@Nullable final Long id, @Nonnull final Date time, @Nonnull final Direction direction, @Nullable final JID with, @Nullable final String stableId, @Nullable final String body, @Nullable final String stanza) throws DocumentException {
+    public ArchivedMessage(@Nullable final Long id, @Nonnull final Date time, @Nonnull final Direction direction, @Nonnull final JID with, @Nullable final String stableId, @Nullable final String body, @Nullable final String stanza) throws DocumentException {
         this.id = id;
         this.time = time;
         this.direction = direction;
@@ -154,12 +154,12 @@ public Message getStanza() {
      * The message peer (the 'other side' of the conversation), in respect to the owner of the archive that this message
      * is part of.
      *
-     * This value will only have meaning when the original message was sent in a one-to-one conversation. When the
-     * archived message was originally shared in a group chat, this value can be null.
+     * When the archived message was originally shared in a group chat, this value will reference the in-room address
+     * of the participant that sent the message (eg: room@service/nickname).
      *
      * @return The conversation peer.
      */
-    @Nullable
+    @Nonnull
     public JID getWith() {
         return with;
     }
@@ -224,8 +224,8 @@ public static Message recreateStanza( @Nonnull final ArchivedMessage archivedMes
             from = archivedMessage.getWith();
         }
 
-        final boolean isMuc = (to != null && XMPPServer.getInstance().getMultiUserChatManager().getMultiUserChatService( to ) != null)
-            || (from != null && XMPPServer.getInstance().getMultiUserChatManager().getMultiUserChatService( from ) != null);
+        final boolean isMuc = XMPPServer.getInstance().getMultiUserChatManager().getMultiUserChatService( to ) != null
+            || XMPPServer.getInstance().getMultiUserChatManager().getMultiUserChatService( from ) != null;
 
         final Message result = new Message();
         result.setFrom(from);

src/java/com/reucon/openfire/plugin/archive/xep0136/IQRetrieveHandler.java

@@ -122,9 +122,7 @@ private Element addMessageElement(Element parentElement,
         messageElement = parentElement.addElement(message.getDirection()
                 .toString());
         messageElement.addAttribute("secs", Long.toString(secs));
-        if (message.getWith() != null) {
-            messageElement.addAttribute("jid", message.getWith().toBareJID());
-        }
+        messageElement.addAttribute("jid", message.getWith().toBareJID());
         messageElement.addElement("body").setText(message.getBody());
 
         return messageElement;