fixes igniterealtime#354: Allow text-search/indexing to be disabled.

This introduces a new system property, `conversation.search.index-enabled`, that, when set to 'false', disables the full-text search functionality and corresponding indexing tasks.

Disabling this functionality can save some resources on instances that do not use the feature, and have a large amount of messages in their database.

Author: guusdk

changelog.html

@@ -44,6 +44,16 @@ <h1>
 Monitoring Plugin Changelog
 </h1>
 
+<p><b>2.6.2</b> -- To be determined</p>
+<ul>
+    <li>[<a href='https://github.com/igniterealtime/openfire-monitoring-plugin/issues/354'>Issue #354</a>] - Allow full-text search / indexing to be disabled</li>
+</ul>
+
+<p><b>2.6.1</b> -- October 30, 2024</p>
+<ul>
+	<li>Future release will require Openfire 4.10</li>
+</ul>
+
 <p><b>2.6.1</b> -- October 30, 2024</p>
 <ul>
     <li>Explicitly denote that this version will not be compatible with Openfire 4.10.0 or later.</li>

plugin.xml

@@ -6,9 +6,9 @@
     <description>Monitors conversations and statistics of the server.</description>
     <author>Ignite Realtime</author>
     <version>${project.version}</version>
-    <date>2024-10-30</date>
+    <date>2024-12-10</date>
     <minServerVersion>4.8.0</minServerVersion>
-    <priorToServerVersion>4.10.0</priorToServerVersion>
+    <priorToServerVersion>5.0.0</priorToServerVersion>
     <databaseKey>monitoring</databaseKey>
     <databaseVersion>8</databaseVersion>
 

readme.html

@@ -116,5 +116,12 @@ <h2>Configuration</h2>
 Server --&gt; Archiving --&gt; Archiving Settings
 </p>
 
+<p>
+Since version 2.7.0, it is possibly to <em>disable</em> full-text search functionality by configuration. To do so, a
+system property named <tt>conversation.search.index-enabled</tt> must be defined, and should have the value
+<tt>false</tt>. The default setting is for this functionality to be <em>enabled</em>. Changes to this configuration
+require a restart for the new setting to be applied.
+</p>
+
 </body>
 </html>

src/i18n/monitoring_i18n.properties

@@ -83,6 +83,7 @@ archive.settings.max.retrievable = Retrievable Messages
 archive.settings.max.retrievable.description = The number of days worth of messages a user is allowed to retrieve.
 archive.settings.index.settings = Index Settings
 archive.settings.index.settings.description = View and/or rebuild the current Search Index.
+archive.settings.index.settings.disabled = Full Text Search functionality has been disabled by configuration.
 archive.settings.current.index = Current Search Index
 archive.settings.current.index.description = The current size of the message index.
 archive.settings.message.count = Archived Message Count

src/i18n/monitoringservice_i18n.properties

@@ -22,10 +22,11 @@ system_property.conversation.maxTime=The max number of minutes a conversation ca
 system_property.conversation.messageArchiving=Enable archiving of one-to-one messages
 system_property.conversation.metadataArchiving=Enable archiving of conversation metadata
 system_property.conversation.roomArchiving=Enable archiving of MUC messages
-system_property.conversation.roomArchiving.PMinPersonalArchive=Controls whether MUC PMs are stored in the Personal Archive for the purposes of Message Arrchiving (XEP-0313)
-system_property.conversation.roomArchiving.PMinRoomArchive=Controls whether MUC PMs are stored in the Room Archive for the purposes of Message Arrchiving (XEP-0313)
+system_property.conversation.roomArchiving.PMinPersonalArchive=Controls whether MUC PMs are stored in the Personal Archive for the purposes of Message Archiving (XEP-0313)
+system_property.conversation.roomArchiving.PMinRoomArchive=Controls whether MUC PMs are stored in the Room Archive for the purposes of Message Archiving (XEP-0313)
 system_property.conversation.roomArchivingStanzas=Enable storing of full stanzas when MUC messages are archived
 system_property.conversation.roomsArchived=List of MUC rooms in which to archive messages. When empty, all rooms are archived.
+system_property.conversation.search.index-enabled=Controls if the full-text search index (Lucene) is enabled.
 system_property.conversation.search.updateInterval=How often, in minutes, to update the search index
 system_property.monitoring.search.allow-unrecognized-fields=If 'true', silently ignores unrecognized search filters in queries, which otherwise result in error responses.
 system_property.stats.mock.viewer=Displays random stats in Monitoring plugin admin pages

src/i18n/monitoringservice_i18n_nl.properties

@@ -22,10 +22,11 @@ system_property.conversation.maxTime=Het maximaal aantal minuten dat een convers
 system_property.conversation.messageArchiving=Schakel archivering van een-op-een berichten in
 system_property.conversation.metadataArchiving=Schakel archivering van metadata van gesprekken in
 system_property.conversation.roomArchiving=Schakel archivering van MUC-berichten in
-system_property.conversation.roomArchiving.PMinPersonalArchive=Bepaald of MUC PMs worden opgeslagen in het Persoonlijk Archief als onderdeel van Message Archiving (XEP-0313)
-system_property.conversation.roomArchiving.PMinRoomArchive=Bepaald of MUC PMs worden opgeslagen in het Gespreksruimte Archief als onderdeel van Message Archiving (XEP-0313)
+system_property.conversation.roomArchiving.PMinPersonalArchive=Bepaalt of MUC PMs worden opgeslagen in het Persoonlijk Archief als onderdeel van Message Archiving (XEP-0313)
+system_property.conversation.roomArchiving.PMinRoomArchive=Bepaalt of MUC PMs worden opgeslagen in het Gespreksruimte Archief als onderdeel van Message Archiving (XEP-0313)
 system_property.conversation.roomArchivingStanzas=Schakel het opslaan van volledige stanzas in voor MUC berichten
 system_property.conversation.roomsArchived=Lijst van MUC ruimtes waar berichten voor worden gearchiveerd. Indien leeg, dan worden berichten van alle ruimtes gearchiveerd.
+system_property.conversation.search.index-enabled=Bepaalt of de full-text zoekindex (Lucene) actief is.
 system_property.conversation.search.updateInterval=Hoe vaak, in minuten, de zoekindex wordt bijgewerkt
 system_property.monitoring.search.allow-unrecognized-fields=Als 'true' dan worden niet herkende zoekfilters genegeerd in plaats van beantwoord met een foutmelding.
 system_property.stats.mock.viewer=Toon willekeurige statistieken in de administratiepagina's van de Monitoring plugin

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

@@ -9,6 +9,7 @@
 import org.dom4j.DocumentException;
 import org.jivesoftware.database.DbConnectionManager;
 import org.jivesoftware.openfire.archive.ConversationManager;
+import org.jivesoftware.openfire.index.LuceneIndexer;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.xmpp.packet.JID;
@@ -320,6 +321,9 @@ public Collection<ArchivedMessage> findMessages(Date startDate, Date endDate, JI
         List<ArchivedMessage> msgs = Collections.emptyList();
         int totalCount = 0;
         if ( query != null && !query.isEmpty() ) {
+            if (!LuceneIndexer.ENABLED.getValue()) {
+                throw new DataRetrievalException("Unable to process a search request that contains a text-based query, as the full-text index functionality has been disabled by configuration.");
+            }
             final PaginatedMessageLuceneQuery paginatedMessageLuceneQuery = new PaginatedMessageLuceneQuery( startDate, endDate, owner, with, query );
             Log.debug("Request for message archive of user '{}' resulted in the following query data: {}", owner, paginatedMessageLuceneQuery);
             totalCount = paginatedMessageLuceneQuery.getTotalCount();
@@ -377,6 +381,9 @@ public Collection<ArchivedMessage> findMessages(Date startDate, Date endDate, JI
             final List<ArchivedMessage> nextPage;
             if ( query != null && !query.isEmpty() )
             {
+                if (!LuceneIndexer.ENABLED.getValue()) {
+                    throw new DataRetrievalException("Unable to process a search request that contains a text-based query, as the full-text index functionality has been disabled by configuration.");
+                }
                 final PaginatedMessageLuceneQuery paginatedMessageLuceneQuery = new PaginatedMessageLuceneQuery(startDate, endDate, owner, with, query);
                 nextPage = paginatedMessageLuceneQuery.getPage(afterForNextPage, beforeForNextPage, 1, isPagingBackwards);
             }

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

@@ -11,6 +11,7 @@
 import org.jivesoftware.database.DbConnectionManager;
 import org.jivesoftware.openfire.XMPPServer;
 import org.jivesoftware.openfire.archive.MonitoringConstants;
+import org.jivesoftware.openfire.index.LuceneIndexer;
 import org.jivesoftware.openfire.muc.MUCRoom;
 import org.jivesoftware.openfire.muc.MultiUserChatManager;
 import org.jivesoftware.openfire.muc.MultiUserChatService;
@@ -80,6 +81,9 @@ public Collection<ArchivedMessage> findMessages(Date startDate, Date endDate, JI
         final List<ArchivedMessage> msgs;
         final int totalCount;
         if ( query != null && !query.isEmpty() ) {
+            if (!LuceneIndexer.ENABLED.getValue()) {
+                throw new DataRetrievalException("Unable to process a search request that contains a text-based query, as the full-text index functionality has been disabled by configuration.");
+            }
             // When there's a 'query' element, the search needs to go through a Lucene index (which takes care of text-search).
             if (USE_OPENFIRE_TABLES.getValue()) {
                 Log.debug("Using Openfire tables");
@@ -165,6 +169,9 @@ public Collection<ArchivedMessage> findMessages(Date startDate, Date endDate, JI
             final List<ArchivedMessage> nextPage;
             if ( query != null && !query.isEmpty() )
             {
+                if (!LuceneIndexer.ENABLED.getValue()) {
+                    throw new DataRetrievalException("Unable to process a search request that contains a text-based query, as the full-text index functionality has been disabled by configuration.");
+                }
                 final PaginatedMucMessageFromOpenfireLuceneQuery paginatedMucMessageLuceneQuery = new PaginatedMucMessageFromOpenfireLuceneQuery(startDate, endDate, room, with, query);
                 nextPage = paginatedMucMessageLuceneQuery.getPage(afterForNextPage, beforeForNextPage, 1, isPagingBackwards);
             }

src/java/com/reucon/openfire/plugin/archive/xep0313/IQQueryHandler.java

@@ -15,6 +15,7 @@
 import org.jivesoftware.openfire.container.Plugin;
 import org.jivesoftware.openfire.disco.ServerFeaturesProvider;
 import org.jivesoftware.openfire.forward.Forwarded;
+import org.jivesoftware.openfire.index.LuceneIndexer;
 import org.jivesoftware.openfire.muc.MUCRole;
 import org.jivesoftware.openfire.muc.MUCRoom;
 import org.jivesoftware.openfire.muc.MultiUserChatService;
@@ -602,7 +603,9 @@ private IQ buildSupportedFieldsResult(IQ packet) {
         form.addField("with", "Author of message", FormField.Type.jid_single);
         form.addField("start", "Message sent on or after timestamp.", FormField.Type.text_single);
         form.addField("end", "Message sent on or before timestamp.", FormField.Type.text_single);
-        form.addField("{urn:xmpp:fulltext:0}fulltext", "Free text search", FormField.Type.text_single);
+        if (LuceneIndexer.ENABLED.getValue()) {
+            form.addField("{urn:xmpp:fulltext:0}fulltext", "Free text search", FormField.Type.text_single);
+        }
 
         query.add(form.getElement());
 
@@ -617,14 +620,22 @@ private IQ buildSupportedFieldsResult(IQ packet) {
      * @return A list of fields. Never null.
      */
     private List<String> getSupportedFieldVariables() {
-        return Arrays.asList( "FORM_TYPE", "with", "start", "end", "{urn:xmpp:fulltext:0}fulltext", "withtext", "search");
+        final List<String> results = Arrays.asList("FORM_TYPE", "with", "start", "end");
+        if (LuceneIndexer.ENABLED.getValue()) {
+            results.add("{urn:xmpp:fulltext:0}fulltext");
+            results.add("withtext");
+            results.add("search");
+        }
+        return results;
     }
 
     @Override
     public Iterator<String> getFeatures() {
         final List<String> result = new ArrayList<>();
         result.add(NAMESPACE);
-        result.add("urn:xmpp:fulltext:0");
+        if (LuceneIndexer.ENABLED.getValue()) {
+            result.add("urn:xmpp:fulltext:0");
+        }
         return result.iterator();
     }
 

src/java/org/jivesoftware/openfire/index/LuceneIndexer.java

@@ -70,6 +70,13 @@ public abstract class LuceneIndexer
        .setPlugin(MonitoringConstants.PLUGIN_NAME)
        .build();
 
+    public static final SystemProperty<Boolean> ENABLED = SystemProperty.Builder.ofType( Boolean.class )
+        .setKey("conversation.search.index-enabled")
+        .setDefaultValue(true)
+        .setDynamic(false)
+        .setPlugin(MonitoringConstants.PLUGIN_NAME)
+        .build();
+
     public LuceneIndexer(TaskEngine taskEngine, Path searchDir, String logName, int schemaVersion)
     {
         this.taskEngine = taskEngine;
@@ -80,7 +87,13 @@ public LuceneIndexer(TaskEngine taskEngine, Path searchDir, String logName, int
 
     public void start()
     {
+        if (!ENABLED.getValue()) {
+            Log.debug("Unable to start: indexing is disabled by configuration.");
+            return;
+        }
+
         Log.debug("Starting...");
+
         if (!Files.exists(searchDir))
         {
             try {
@@ -231,7 +244,10 @@ public void stop()
     {
         Log.debug("Stopping...");
         stopped = true;
-        indexUpdater.cancel();
+        if (indexUpdater != null) {
+            indexUpdater.cancel();
+            indexUpdater = null;
+        }
         if ( searcher != null )
         {
             try
@@ -246,13 +262,16 @@ public void stop()
         }
         try
         {
-            directory.close();
+            if (directory != null) {
+                directory.close();
+            }
         }
         catch ( Exception e )
         {
             Log.error(e.getMessage(), e);
         }
         directory = null;
+
         indexProperties = null;
         searchDir = null;
         rebuildFuture = null;
@@ -287,6 +306,11 @@ public long getIndexSize()
      */
     public void updateIndex()
     {
+        if (!ENABLED.getValue()) {
+            Log.debug("Unable to update: indexing is disabled by configuration.");
+            return;
+        }
+
         // Immediately return if the service has been stopped.
         if (stopped) {
             return;
@@ -329,7 +353,13 @@ public void updateIndex()
      * @return a Future to indicate the status of rebuilding the index or <tt>null</tt> if
      *      rebuilding the index is not possible.
      */
-    public synchronized Future<Integer> rebuildIndex() {
+    public synchronized Future<Integer> rebuildIndex()
+    {
+        if (!ENABLED.getValue()) {
+            Log.debug("Unable to rebuild: indexing is disabled by configuration.");
+            return null;
+        }
+
         // Immediately return if the service has been stopped.
         if (stopped) {
             return null;
@@ -430,6 +460,11 @@ public Future<Integer> getIndexRebuildProgress()
      */
     public synchronized IndexSearcher getSearcher() throws IOException
     {
+        if (!ENABLED.getValue()) {
+            Log.debug("Unable to get index: indexing is disabled by configuration.");
+            return null;
+        }
+
         // If the searcher hasn't been instantiated, create it.
         if ( searcher == null )
         {

src/web/archive-search.jsp

@@ -12,6 +12,7 @@
 <%@ page import="org.slf4j.LoggerFactory" %>
 <%@ page import="org.jivesoftware.openfire.archive.*" %>
 <%@ page import="org.jivesoftware.openfire.cluster.ClusterManager" %>
+<%@ page import="org.jivesoftware.openfire.index.LuceneIndexer" %>
 
 <%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c" %>
 <%@ taglib uri="http://java.sun.com/jsp/jstl/fmt" prefix="fmt" %>
@@ -566,10 +567,9 @@
 
 
 </td>
-<td>
-    <td width="0" height="100%" valign="middle">
-        <div class="verticalrule"></div>
-    </td>
+<% if (LuceneIndexer.ENABLED.getValue()) { %>
+<td width="0" height="100%" valign="middle">
+    <div class="verticalrule"></div>
 </td>
 <td>
     <table>
@@ -593,6 +593,7 @@
         </tr>
     </table>
 </td>
+<% } %>
 </tr>
 </table>
 </div>

src/web/archiving-settings.jsp

@@ -16,6 +16,7 @@
 <%@ page import="com.reucon.openfire.plugin.archive.impl.MessageIndexer" %>
 <%@ page import="org.jivesoftware.openfire.archive.MonitoringConstants" %>
 <%@ page import="org.jivesoftware.openfire.cluster.ClusterManager" %>
+<%@ page import="org.jivesoftware.openfire.index.LuceneIndexer" %>
 
 <%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c" %>
 <%@ taglib uri="http://java.sun.com/jsp/jstl/fmt" prefix="fmt" %>
@@ -38,6 +39,7 @@
 <title><fmt:message key="archive.settings.title"/></title>
 <meta name="pageID" content="archiving-settings"/>
 <link rel="stylesheet" type="text/css" href="style/style.css">
+<% if (LuceneIndexer.ENABLED.getValue()) { %>
 <script type="text/javascript">
     // Calls a getBuildProgress
     function getBuildProgress() {
@@ -70,6 +72,7 @@
     
     //# sourceURL=archiving-settings.jsp 
 </script>
+<% } %>
 <style type="text/css">
     .small-label {
         font-size: 11px;
@@ -483,6 +486,7 @@
             </tr>
         </thead>
         <tbody>
+        <% if (LuceneIndexer.ENABLED.getValue()) { %>
            <tr>
                <td colspan="3" width="100%"><p><fmt:message key="archive.settings.index.settings.description"/></p></td>
            </tr>
@@ -507,18 +511,26 @@
                <% } %>
                <td></td>
            </tr>
+        <% } else { %>
+            <tr>
+                <td colspan="3" width="100%"><p><fmt:message key="archive.settings.index.settings.disabled"/></p></td>
+            </tr>
+            <% } %>
         </tbody>
     </table>
 
+    <% if (LuceneIndexer.ENABLED.getValue()) { %>
     <input type="submit" name="rebuild" value="<fmt:message key="archive.settings.rebuild" />"/>
     <span id="rebuildElement" style="display:none;" class="jive-description">Rebuilding is <span id="rebuildProgress"></span>% complete.</span>
-
-    <%} %>
+    <% } %>
+    <% } %>
 </form>
 
+<% if (LuceneIndexer.ENABLED.getValue()) { %>
 <script type="text/javascript">
     getBuildProgress();
 </script>
+<% } %>
 
 </body>
 </html>