feat(search): added experimental support for OpenSearch

Author: thorsten

CHANGELOG.md

@@ -17,7 +17,7 @@ This is a log of major user-visible changes in each phpMyFAQ release.
 - added experimental support for PDO (Thorsten)
 - added possibility to enable/disable admin session counter (Thorsten)
 - added Urdu translation (Thorsten)
-- WIP: added support for OpenSearch (Thorsten)
+- added experimental support for OpenSearch (Thorsten)
 - updated Spanish translation (Thorsten)
 - improved online update feature (Thorsten)
 - migrated from WYSIWYG editor from TinyMCE to Jodit Editor (Thorsten)

phpmyfaq/admin/assets/src/api/index.ts

@@ -11,6 +11,7 @@ export * from './instance';
 export * from './markdown';
 export * from './media-browser';
 export * from './news';
+export * from './opensearch';
 export * from './question';
 export * from './statistics';
 export * from './stop-words';

phpmyfaq/admin/assets/src/api/opensearch.ts

@@ -0,0 +1,52 @@
+/**
+ * Fetch data for OpenSearch configuration
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public License,
+ * v. 2.0. If a copy of the MPL was not distributed with this file, You can
+ * obtain one at https://mozilla.org/MPL/2.0/.
+ *
+ * @package   phpMyFAQ
+ * @author    Thorsten Rinne <[email protected]>
+ * @copyright 2025 phpMyFAQ Team
+ * @license   http://www.mozilla.org/MPL/2.0/ Mozilla Public License Version 2.0
+ * @link      https://www.phpmyfaq.de
+ * @since     2025-05-12
+ */
+
+import { ElasticsearchResponse, Response } from '../interfaces';
+
+export const fetchOpenSearchAction = async (action: string): Promise<Response> => {
+  try {
+    const response = await fetch(`./api/opensearch/${action}`, {
+      method: 'GET',
+      cache: 'no-cache',
+      headers: {
+        'Content-Type': 'application/json',
+      },
+      redirect: 'follow',
+      referrerPolicy: 'no-referrer',
+    });
+
+    return await response.json();
+  } catch (error) {
+    throw error;
+  }
+};
+
+export const fetchOpenSearchStatistics = async (): Promise<ElasticsearchResponse> => {
+  try {
+    const response = await fetch('./api/opensearch/statistics', {
+      method: 'GET',
+      cache: 'no-cache',
+      headers: {
+        'Content-Type': 'application/json',
+      },
+      redirect: 'follow',
+      referrerPolicy: 'no-referrer',
+    });
+
+    return await response.json();
+  } catch (error) {
+    throw error;
+  }
+};

phpmyfaq/admin/assets/src/configuration/elasticsearch.ts

@@ -14,7 +14,7 @@
  */
 
 import { pushErrorNotification, pushNotification } from '../../../../assets/src/utils';
-import { fetchElasticsearchAction, fetchElasticsearchStatistics } from '../api/elasticsearch';
+import { fetchElasticsearchAction, fetchElasticsearchStatistics } from '../api';
 import { ElasticsearchResponse, Response } from '../interfaces';
 import { formatBytes } from '../utils';
 

phpmyfaq/admin/assets/src/configuration/index.ts

@@ -2,5 +2,6 @@ export * from './configuration';
 export * from './elasticsearch';
 export * from './forms';
 export * from './instance';
+export * from './opensearch';
 export * from './stopwords';
 export * from './upgrade';

phpmyfaq/admin/assets/src/configuration/opensearch.ts

@@ -0,0 +1,73 @@
+/**
+ * Admin OpenSearch configuration
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public License,
+ * v. 2.0. If a copy of the MPL was not distributed with this file, You can
+ * obtain one at https://mozilla.org/MPL/2.0/.
+ *
+ * @package   phpMyFAQ
+ * @author    Thorsten Rinne
+ * @copyright 2025 phpMyFAQ Team
+ * @license   https://www.mozilla.org/MPL/2.0/ Mozilla Public License Version 2.0
+ * @link      https://www.phpmyfaq.de
+ * @since     2025-05-12
+ */
+
+import { pushErrorNotification, pushNotification } from '../../../../assets/src/utils';
+import { fetchOpenSearchAction, fetchOpenSearchStatistics } from '../api';
+import { ElasticsearchResponse, Response } from '../interfaces';
+import { formatBytes } from '../utils';
+
+export const handleOpenSearch = async (): Promise<void> => {
+  const buttons: NodeListOf<HTMLButtonElement> = document.querySelectorAll('button.pmf-opensearch');
+
+  if (buttons) {
+    buttons.forEach((element: HTMLButtonElement): void => {
+      element.addEventListener('click', async (event: Event): Promise<void> => {
+        event.preventDefault();
+
+        const action = (event.target as HTMLButtonElement).getAttribute('data-action') as string;
+
+        try {
+          const response = (await fetchOpenSearchAction(action)) as unknown as Response;
+
+          if (typeof response.success !== 'undefined') {
+            pushNotification(response.success);
+            setInterval(openSearchStats, 5000);
+          } else {
+            pushErrorNotification(response.error as string);
+          }
+        } catch (error) {
+          pushErrorNotification(error as string);
+        }
+      });
+
+      const openSearchStats = async (): Promise<void> => {
+        const div = document.getElementById('pmf-opensearch-stats') as HTMLElement;
+        if (div) {
+          div.innerHTML = '';
+
+          try {
+            const response = (await fetchOpenSearchStatistics()) as unknown as ElasticsearchResponse;
+
+            if (response.index) {
+              const indexName = response.index as string;
+              const stats = response.stats;
+              const count: number = stats.indices[indexName].total.docs.count ?? 0;
+              const sizeInBytes: number = stats.indices[indexName].total.store.size_in_bytes ?? 0;
+              let html: string = '<dl class="row">';
+              html += `<dt class="col-sm-3">Documents</dt><dd class="col-sm-9">${count ?? 0}</dd>`;
+              html += `<dt class="col-sm-3">Storage size</dt><dd class="col-sm-9">${formatBytes(sizeInBytes ?? 0)}</dd>`;
+              html += '</dl>';
+              div.innerHTML = html;
+            }
+          } catch (error) {
+            pushErrorNotification(error as string);
+          }
+        }
+      };
+
+      openSearchStats();
+    });
+  }
+};

phpmyfaq/admin/assets/src/index.ts

@@ -34,6 +34,7 @@ import {
   handleSaveConfiguration,
   handleFormEdit,
   handleFormTranslations,
+  handleOpenSearch,
 } from './configuration';
 import {
   handleAttachmentUploads,
@@ -157,8 +158,9 @@ document.addEventListener('DOMContentLoaded', async (): Promise<void> => {
   // Configuration → Online Update
   handleCheckForUpdates();
 
-  // Configuration → Elasticsearch configuration
+  // Configuration → Elasticsearch / OpenSearch configuration
   await handleElasticsearch();
+  await handleOpenSearch();
 
   // Import & Export → Import Records
   await handleUploadCSVForm();

phpmyfaq/src/Bootstrap.php

@@ -218,7 +218,7 @@
     require PMF_CONFIG_DIR . '/constants_opensearch.php';
     $openSearchConfig = new OpenSearchConfiguration(PMF_CONFIG_DIR . '/opensearch.php');
     $client = (new SymfonyClientFactory())->create([
-        'base_uri' => $openSearchConfig->getHosts(),
+        'base_uri' => $openSearchConfig->getHosts()[0],
         'verify_peer' => false,
     ]);
     $faqConfig->setOpenSearch($client);

phpmyfaq/src/phpMyFAQ/Category.php

@@ -622,6 +622,7 @@ public function getPath(
         $description = [];
         $breadcrumb = [];
 
+
         for ($i = 0; $i < $num; ++$i) {
             $lineCategory = $this->getLineCategory($ids[$i]);
             if (array_key_exists($lineCategory, $this->treeTab)) {

phpmyfaq/src/phpMyFAQ/Configuration.php

@@ -475,7 +475,9 @@ public function update(array $newConfigs): bool
             'core.ldapServer', // Ldap
             'core.ldapConfig', // $LDAP
             'core.elasticsearch', // Elasticsearch\Client
+            'core.opensearch', // OpenSearch\Client
             'core.elasticsearchConfig', // $ES
+            'core.openSearchConfig', // $OS
             'core.pluginManager', // PluginManager
         ];
 

phpmyfaq/src/phpMyFAQ/Controller/Administration/AbstractAdministrationController.php

@@ -327,6 +327,7 @@ private function getPageFlags(Request $request): array
                 break;
             case 'admin.configuration':
             case 'admin.elasticsearch':
+            case 'admin.opensearch':
             case 'admin.forms':
             case 'admin.instance.edit':
             case 'admin.instance.update':

phpmyfaq/src/phpMyFAQ/Controller/Administration/Api/OpenSearchController.php

@@ -1,9 +1,117 @@
 <?php
 
+/**
+ * The Admin OpenSearch Controller
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public License,
+ * v. 2.0. If a copy of the MPL was not distributed with this file, You can
+ * obtain one at https://mozilla.org/MPL/2.0/.
+ *
+ * @package   phpMyFAQ
+ * @author    Thorsten Rinne <[email protected]>
+ * @copyright 2025 phpMyFAQ Team
+ * @license   https://www.mozilla.org/MPL/2.0/ Mozilla Public License Version 2.0
+ * @link      https://www.phpmyfaq.de
+ * @since     2025-05-12
+ */
+
 namespace phpMyFAQ\Controller\Administration\Api;
 
 use phpMyFAQ\Controller\AbstractController;
+use phpMyFAQ\Core\Exception;
+use phpMyFAQ\Enums\PermissionType;
+use phpMyFAQ\Instance\OpenSearch;
+use phpMyFAQ\Translation;
+use Symfony\Component\HttpFoundation\JsonResponse;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Routing\Annotation\Route;
 
 class OpenSearchController extends AbstractController
 {
+    /**
+     * @throws \Exception
+     */
+    #[Route('./admin/api/opensearch/create', name: 'admin.api.opensearch.create', methods: ['POST'])]
+    public function create(): JsonResponse
+    {
+        $this->userHasPermission(PermissionType::CONFIGURATION_EDIT);
+
+        $openSearch = new OpenSearch($this->configuration);
+
+        try {
+            $openSearch->createIndex();
+            return $this->json(
+                ['success' => Translation::get('msgAdminOpenSearchCreateIndex_success')],
+                Response::HTTP_OK
+            );
+        } catch (Exception | \Exception $exception) {
+            return $this->json(['error' => $exception->getMessage()], Response::HTTP_CONFLICT);
+        }
+    }
+
+    /**
+     * @throws \Exception
+     */
+    #[Route('./admin/api/opensearch/drop', name: 'admin.api.opensearch.drop', methods: ['DELETE'])]
+    public function drop(): JsonResponse
+    {
+        $this->userHasPermission(PermissionType::CONFIGURATION_EDIT);
+
+        $openSearch = new OpenSearch($this->configuration);
+
+        try {
+            $openSearch->dropIndex();
+            return $this->json(
+                ['success' => Translation::get('msgAdminOpenSearchDropIndex_success')],
+                Response::HTTP_OK
+            );
+        } catch (Exception $exception) {
+            return $this->json(['error' => $exception->getMessage()], Response::HTTP_CONFLICT);
+        }
+    }
+
+    /**
+     * @throws \Exception
+     */
+    #[Route('./admin/api/opensearch/import', name: 'admin.api.opensearch.import', methods: ['POST'])]
+    public function import(): JsonResponse
+    {
+        $this->userHasPermission(PermissionType::CONFIGURATION_EDIT);
+
+        $openSearch = new OpenSearch($this->configuration);
+        $faq = $this->container->get('phpmyfaq.faq');
+        $faq->getAllFaqs();
+
+        $bulkIndexResult = $openSearch->bulkIndex($faq->faqRecords);
+        if (isset($bulkIndexResult['success'])) {
+            return $this->json(['success' => Translation::get('ad_os_create_import_success')], Response::HTTP_OK);
+        } else {
+            return $this->json(['error' => $bulkIndexResult], Response::HTTP_BAD_REQUEST);
+        }
+    }
+
+    /**
+     * @throws Exception
+     * @throws \Exception
+     */
+    #[Route('./admin/api/opensearch/statistics', name: 'admin.api.opensearch.statistics', methods: ['GET'])]
+    public function statistics(): JsonResponse
+    {
+        $this->userIsAuthenticated();
+
+        $openSearchConfig = $this->configuration->getOpenSearchConfig();
+
+        $indexName = $openSearchConfig->getIndex();
+
+        return $this->json(
+            [
+                'index' => $indexName,
+                'stats' => $this->configuration
+                    ->getOpenSearch()
+                    ->indices()
+                    ->stats(['index' => $indexName])
+            ],
+            Response::HTTP_OK
+        );
+    }
 }