email address api action, global search endpoint fix

application/Espo/Controllers/EmailAddress.php

@@ -29,52 +29,7 @@
 
 namespace Espo\Controllers;
 
-use Espo\Core\Exceptions\Forbidden;
-use Espo\Core\Exceptions\BadRequest;
-
-use Espo\Tools\Email\AddressService as Service;
-
-use Espo\Core\Api\Request;
 use Espo\Core\Controllers\RecordBase;
 
 class EmailAddress extends RecordBase
-{
-    private const ADDRESS_MAX_SIZE = 50;
-
-    /**
-     * @return array<int,array<string,mixed>>
-     * @throws Forbidden
-     * @throws BadRequest
-     */
-    public function actionSearchInAddressBook(Request $request): array
-    {
-        if (!$this->acl->checkScope('Email')) {
-            throw new Forbidden();
-        }
-
-        if (!$this->acl->checkScope('Email', 'create')) {
-            throw new Forbidden();
-        }
-
-        $q = $request->getQueryParam('q');
-
-        if ($q === null) {
-            throw new BadRequest("No `q` parameter.");
-        }
-
-        $maxSize = intval($request->getQueryParam('maxSize'));
-
-        if (!$maxSize || $maxSize > self::ADDRESS_MAX_SIZE) {
-            $maxSize = (int) $this->config->get('recordsPerPage');
-        }
-
-        $onlyActual = $request->getQueryParam('onlyActual') === 'true';
-
-        return $this->getEmailAddressService()->searchInAddressBook($q, $maxSize, $onlyActual);
-    }
-
-    private function getEmailAddressService(): Service
-    {
-        return $this->injectableFactory->create(Service::class);
-    }
-}
+{}

application/Espo/Resources/routes.json

@@ -82,7 +82,7 @@
         }
     },
     {
-        "route": "/GlobalSearch/:query",
+        "route": "/GlobalSearch",
         "method": "get",
         "actionClassName": "Espo\\Tools\\GlobalSearch\\Api\\Get"
     },
@@ -357,6 +357,16 @@
         "method": "get",
         "actionClassName": "Espo\\Tools\\Email\\Api\\GetInsertFieldData"
     },
+    {
+        "route": "/EmailAddress/search",
+        "method": "get",
+        "actionClassName": "Espo\\Tools\\EmailAddress\\Api\\GetSearch"
+    },
+    {
+        "route": "/Email/insertFieldData",
+        "method": "get",
+        "actionClassName": "Espo\\Tools\\Email\\Api\\GetInsertFieldData"
+    },
     {
         "route": "/Oidc/authorizationData",
         "method": "get",

application/Espo/Tools/EmailAddress/Api/GetSearch.php

@@ -0,0 +1,88 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM - Open Source CRM application.
+ * Copyright (C) 2014-2023 Yurii Kuznietsov, Taras Machyshyn, Oleksii Avramenko
+ * Website: https://www.espocrm.com
+ *
+ * EspoCRM is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * EspoCRM is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with EspoCRM. If not, see http://www.gnu.org/licenses/.
+ *
+ * The interactive user interfaces in modified source and object code versions
+ * of this program must display Appropriate Legal Notices, as required under
+ * Section 5 of the GNU General Public License version 3.
+ *
+ * In accordance with Section 7(b) of the GNU General Public License version 3,
+ * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
+ ************************************************************************/
+
+namespace Espo\Tools\EmailAddress\Api;
+
+use Espo\Core\Acl;
+use Espo\Core\Api\Action;
+use Espo\Core\Api\Request;
+use Espo\Core\Api\Response;
+use Espo\Core\Api\ResponseComposer;
+use Espo\Core\Exceptions\BadRequest;
+use Espo\Core\Exceptions\Forbidden;
+use Espo\Core\Utils\Config;
+use Espo\Entities\Email;
+use Espo\Tools\Email\AddressService;
+
+/**
+ * Searches email addresses.
+ */
+class GetSearch implements Action
+{
+    private const ADDRESS_MAX_SIZE = 50;
+
+    public function __construct(
+        private AddressService $service,
+        private Acl $acl,
+        private Config $config
+    ) {}
+
+    public function process(Request $request): Response
+    {
+        if (!$this->acl->checkScope(Email::ENTITY_TYPE)) {
+            throw new Forbidden();
+        }
+
+        if (!$this->acl->checkScope(Email::ENTITY_TYPE, Acl\Table::ACTION_CREATE)) {
+            throw new Forbidden();
+        }
+
+        $q = $request->getQueryParam('q');
+
+        if (is_string($q)) {
+            $q = trim($q);
+        }
+
+        if (!$q) {
+            throw new BadRequest("No `q` parameter.");
+        }
+
+        $maxSize = intval($request->getQueryParam('maxSize'));
+
+        if (!$maxSize || $maxSize > self::ADDRESS_MAX_SIZE) {
+            $maxSize = (int) $this->config->get('recordsPerPage');
+        }
+
+        $onlyActual = $request->getQueryParam('onlyActual') === 'true';
+
+        $result = $this->service->searchInAddressBook($q, $maxSize, $onlyActual);
+
+        return ResponseComposer::json($result);
+    }
+}

application/Espo/Tools/GlobalSearch/Api/Get.php

@@ -46,10 +46,10 @@ class Get implements Action
 
     public function process(Request $request): Response
     {
-        $query = $request->getRouteParam('query');
+        $query = $request->getQueryParam('q');
 
         if ($query === null || $query === '') {
-            throw new BadRequest();
+            throw new BadRequest("No `q` parameter.");
         }
 
         $offset = intval($request->getQueryParam('offset'));

client/src/views/email/fields/email-address-varchar.js

@@ -206,9 +206,10 @@ function (Dep, From, EmailAddress) {
                 });
 
                 this.$input.autocomplete({
-                    serviceUrl: (q) => {
-                        return 'EmailAddress/action/searchInAddressBook?onlyActual=true&maxSize=' +
-                            this.getAutocompleteMaxCount();
+                    serviceUrl: () => {
+                        return `EmailAddress/search` +
+                            `?maxSize=${this.getAutocompleteMaxCount()}` +
+                            `&onlyActual=true`;
                     },
                     paramName: 'q',
                     minChars: 1,

client/src/views/email/fields/email-address.js

@@ -59,8 +59,8 @@ define('views/email/fields/email-address', ['views/fields/base'], function (Dep)
 
             this.$input.autocomplete({
                 serviceUrl: () => {
-                    return 'EmailAddress/action/searchInAddressBook?maxSize=' +
-                        this.getAutocompleteMaxCount();
+                    return `EmailAddress/search` +
+                        `?maxSize=${this.getAutocompleteMaxCount()}`
                 },
                 paramName: 'q',
                 minChars: 1,

client/src/views/fields/email.js

@@ -341,9 +341,9 @@ define('views/fields/email', ['views/fields/varchar'], function (Dep) {
 
             if (this.mode === this.MODE_SEARCH && this.getAcl().check('Email', 'create')) {
                 this.$element.autocomplete({
-                    serviceUrl: (q) => {
-                        return 'EmailAddress/action/searchInAddressBook?maxSize=' +
-                            this.getAutocompleteMaxCount();
+                    serviceUrl: () => {
+                        return `EmailAddress/search` +
+                            `?maxSize=${this.getAutocompleteMaxCount()}`
                     },
                     paramName: 'q',
                     minChars: 1,

client/src/views/global-search/global-search.js

@@ -78,7 +78,7 @@ define('views/global-search/global-search', ['view'], function (Dep) {
         },
 
         search: function (text) {
-            this.collection.url = this.collection.urlRoot =  'GlobalSearch/' + encodeURIComponent(text);
+            this.collection.url = this.collection.urlRoot =  'GlobalSearch?q=' + encodeURIComponent(text);
 
             this.showPanel();
         },