fixes igniterealtime#146: Add option to choose between database used for MUC archive

The archived MUC messages are persisted to the database more than once: Openfire stores them in ofMucConversationLog, the Monitoring plugin in ofMessageArchive.

This commit introduces a configuration option to switch between the two: conversation.database.use-openfire-tables

The default for this new option is to use the database table provided by the Monitoring plugin, which is a change from the behavior prior to this commit.

Author: guusdk

changelog.html

@@ -52,6 +52,9 @@ <h1>
     <li>[<a href='https://github.com/igniterealtime/openfire-monitoring-plugin/issues/138'>Issue #138</a>] - Stanzas not always stored for one-to-one messages whilst clustered</li>
     <li>[<a href='https://github.com/igniterealtime/openfire-monitoring-plugin/issues/139'>Issue #139</a>] - Reduce code complexity</li>
     <li>[<a href='https://github.com/igniterealtime/openfire-monitoring-plugin/issues/141'>Issue #141</a>] - Make Archiver configuration configurable</li>
+    <li>[<a href='https://github.com/igniterealtime/openfire-monitoring-plugin/issues/142'>Issue #142</a>] - Do not require plugin restart after config change</li>
+    <li>[<a href='https://github.com/igniterealtime/openfire-monitoring-plugin/issues/145'>Issue #145</a>] - Replace deprecated API usage</li>
+    <li>[<a href='https://github.com/igniterealtime/openfire-monitoring-plugin/issues/146'>Issue #146</a>] - Allow database used for MUC MAM to be configurable</li>
 </ul>
 
 <p><b>2.1.0</b> -- September 10, 2020</p>

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

@@ -13,6 +13,7 @@
 import org.jivesoftware.openfire.muc.MUCRoom;
 import org.jivesoftware.openfire.muc.MultiUserChatManager;
 import org.jivesoftware.openfire.muc.MultiUserChatService;
+import org.jivesoftware.util.JiveGlobals;
 import org.jivesoftware.util.NotFoundException;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -32,9 +33,6 @@
 /**
  * A persistence provider that facilitates the implementation of Message Archive Management (XEP-0313) for MUC rooms.
  *
- * Note that this implementation primarily makes use of the database tables that are provided by Openfire (core), and
- * not of the database tables that are provided by the Monitoring plugin.
- *
  * Created by dwd on 25/07/16.
  */
 public class MucMamPersistenceManager implements PersistenceManager {
@@ -85,13 +83,24 @@ public Collection<ArchivedMessage> findMessages(Date startDate, Date endDate, JI
                 msgs = paginatedMucMessageLuceneQuery.getPage(after, before, maxResults, isPagingBackwards);
             }
         } else {
-            final PaginatedMucMessageDatabaseQuery paginatedMucMessageDatabaseQuery = new PaginatedMucMessageDatabaseQuery(startDate, endDate, room, with );
-            Log.debug("Request for message archive of room '{}' resulted in the following query data: {}", room.getJID(), paginatedMucMessageDatabaseQuery);
-            totalCount = paginatedMucMessageDatabaseQuery.getTotalCount();
-            if ( totalCount == 0 ) {
-                msgs = Collections.emptyList();
+            if (JiveGlobals.getBooleanProperty("conversation.database.use-openfire-tables", false ) ) {
+                final PaginatedMucMessageDatabaseQuery paginatedMucMessageDatabaseQuery = new PaginatedMucMessageDatabaseQuery(startDate, endDate, room, with);
+                Log.debug("Request for message archive of room '{}' resulted in the following query data: {}", room.getJID(), paginatedMucMessageDatabaseQuery);
+                totalCount = paginatedMucMessageDatabaseQuery.getTotalCount();
+                if (totalCount == 0) {
+                    msgs = Collections.emptyList();
+                } else {
+                    msgs = paginatedMucMessageDatabaseQuery.getPage(after, before, maxResults, isPagingBackwards);
+                }
             } else {
-                msgs = paginatedMucMessageDatabaseQuery.getPage(after, before, maxResults, isPagingBackwards);
+                final PaginatedMessageDatabaseQuery paginatedMessageDatabaseQuery = new PaginatedMessageDatabaseQuery(startDate, endDate, room.getJID(), with);
+                Log.debug("Request for message archive of room '{}' resulted in the following query data: {}", room.getJID(), paginatedMessageDatabaseQuery);
+                totalCount = paginatedMessageDatabaseQuery.getTotalCount();
+                if (totalCount == 0) {
+                    msgs = Collections.emptyList();
+                } else {
+                    msgs = paginatedMessageDatabaseQuery.getPage(after, before, maxResults, isPagingBackwards);
+                }
             }
         }
 
@@ -138,8 +147,13 @@ public Collection<ArchivedMessage> findMessages(Date startDate, Date endDate, JI
             }
             else
             {
-                final PaginatedMucMessageDatabaseQuery paginatedMucMessageDatabaseQuery = new PaginatedMucMessageDatabaseQuery(startDate, endDate, room, with);
-                nextPage = paginatedMucMessageDatabaseQuery.getPage(afterForNextPage, beforeForNextPage, 1, isPagingBackwards);
+                if (JiveGlobals.getBooleanProperty("conversation.database.use-openfire-tables", false ) ) {
+                    final PaginatedMucMessageDatabaseQuery paginatedMucMessageDatabaseQuery = new PaginatedMucMessageDatabaseQuery(startDate, endDate, room, with);
+                    nextPage = paginatedMucMessageDatabaseQuery.getPage(afterForNextPage, beforeForNextPage, 1, isPagingBackwards);
+                } else {
+                    final PaginatedMessageDatabaseQuery paginatedMessageDatabaseQuery = new PaginatedMessageDatabaseQuery(startDate, endDate, room.getJID(), with);
+                    nextPage = paginatedMessageDatabaseQuery.getPage(afterForNextPage, beforeForNextPage, 1, isPagingBackwards);
+                }
             }
             Log.debug("Found results for 'next page': {} (based on after: {} before: {} isPagingBackwards: {})", !nextPage.isEmpty(), afterForNextPage, beforeForNextPage, isPagingBackwards);
             xmppResultSet.setComplete(nextPage.isEmpty());

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

@@ -21,6 +21,7 @@
 import org.slf4j.LoggerFactory;
 import org.xmpp.packet.JID;
 
+import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
 import java.sql.Connection;
 import java.sql.PreparedStatement;
@@ -32,42 +33,69 @@
 
 /**
  * Encapsulates responsibility of creating a database query that retrieves a specific subset (page) of archived messages
- * from a specific owner
+ * from a specific owner.
+ *
+ * Note that an 'owner' can be an end-user entity (when the archive that's queried is considered to be a
+ * 'personal archive') or a chatroom (in which case the archive that's queried is considered to be a group chat archive).
  *
  * @author Guus der Kinderen, [email protected]
  */
 public class PaginatedMessageDatabaseQuery
 {
     private static final Logger Log = LoggerFactory.getLogger(PaginatedMessageDatabaseQuery.class );
 
+    @Nonnull
     private final Date startDate;
+
+    @Nonnull
     private final Date endDate;
+
+    @Nonnull
     private final JID owner;
+
+    @Nullable
     private final JID with;
 
-    public PaginatedMessageDatabaseQuery( Date startDate, Date endDate, JID owner, JID with )
+    /**
+     * Creates a query for messages from a message archive.
+     *
+     * The semantics of the 'with' arguments are slightly different, depending on the nature of the owner of the
+     * archive. When the archive owner is an end-user ('personal archive'), then all messages sent 'to' or 'from' the
+     * 'with' entity are returned. When the archive is a group chat archive and the 'with' argument is provided, then
+     * the results will be limited to messages sent by the 'with' entity.
+     *
+     * @param startDate Start (inclusive) of period for which to return messages. EPOCH will be used if no value is provided.
+     * @param endDate End (inclusive) of period for which to return messages. 'now' will be used if no value is provided.
+     * @param owner The message archive owner.
+     * @param with An optional converstation partner (or message author, in case of MUC).
+     */
+    public PaginatedMessageDatabaseQuery(@Nullable final Date startDate, @Nullable final Date endDate, @Nonnull final JID owner, @Nullable final JID with)
     {
         this.startDate = startDate == null ? new Date( 0L ) : startDate ;
         this.endDate = endDate == null ? new Date() : endDate;
         this.owner = owner;
         this.with = with;
     }
 
+    @Nonnull
     public Date getStartDate()
     {
         return startDate;
     }
 
+    @Nonnull
     public Date getEndDate()
     {
         return endDate;
     }
 
+    @Nonnull
     public JID getOwner()
     {
         return owner;
     }
 
+    @Nullable
     public JID getWith()
     {
         return with;
@@ -84,7 +112,7 @@ public String toString()
             '}';
     }
 
-    protected List<ArchivedMessage> getPage( final Long after, final Long before, final int maxResults, final boolean isPagingBackwards )
+    protected List<ArchivedMessage> getPage( @Nullable final Long after, @Nullable final Long before, final int maxResults, final boolean isPagingBackwards )
     {
         Log.trace( "Getting page of archived messages. After: {}, Before: {}, Max results: {}, Paging backwards: {}", after, before, maxResults, isPagingBackwards );
 
@@ -106,11 +134,14 @@ protected List<ArchivedMessage> getPage( final Long after, final Long before, fi
             pstmt = connection.prepareStatement( query );
             pstmt.setLong( 1, dateToMillis( startDate ) );
             pstmt.setLong( 2, dateToMillis( endDate ) );
+
+            // TODO Optimize this for the MUC use-case. Unlike personal archives, the owner of the MUC archive is guaranteed to be in the 'tojid' column. For MUC, there's no need to look in both columns.
             pstmt.setString( 3, owner.toBareJID() );
             pstmt.setString( 4, owner.toBareJID() );
             int pos = 4;
 
             if ( with != null ) {
+                // TODO Optimize this for the MUC use-case. Unlike personal archives, the relevant 'with' value (sender of the message) of the MUC archive is guaranteed to be in the 'fromJid' columns. For MUC, there's no need to look in both columns.
                 if (with.getResource() == null) {
                     pstmt.setString( ++pos, with.toString() );
                     pstmt.setString( ++pos, with.toString() );
@@ -147,11 +178,7 @@ protected List<ArchivedMessage> getPage( final Long after, final Long before, fi
         return archivedMessages;
     }
 
-    private Date millisToDate(Long millis) {
-        return millis == null ? null : new Date(millis);
-    }
-
-    private Long dateToMillis(Date date) {
+    private Long dateToMillis(@Nullable final Date date) {
         return date == null ? null : date.getTime();
     }