Initial commit

application/Espo/Core/Select/Text/FullTextSearch/Data.php

@@ -0,0 +1,92 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM – Open Source CRM application.
+ * Copyright (C) 2014-2025 EspoCRM, Inc.
+ * Website: https://www.espocrm.com
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://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 Affero General Public License version 3.
+ *
+ * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
+ * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
+ ************************************************************************/
+
+namespace Espo\Core\Select\Text\FullTextSearch;
+
+use Espo\ORM\Query\Part\Expression;
+
+use InvalidArgumentException;
+
+/**
+ * Immutable.
+ */
+class Data
+{
+    /** @var string[] */
+    private array $fieldList;
+    /** @var string[] */
+    private array $columnList;
+    /** @var Mode::* $mode */
+    private string $mode;
+
+    /**
+     * @param string[] $fieldList
+     * @param string[] $columnList
+     * @param Mode::* $mode
+     */
+    public function __construct(private Expression $expression, array $fieldList, array $columnList, string $mode)
+    {
+        $this->fieldList = $fieldList;
+        $this->columnList = $columnList;
+        $this->mode = $mode;
+
+        if (!in_array($mode, [Mode::NATURAL_LANGUAGE, Mode::BOOLEAN])) {
+            throw new InvalidArgumentException("Bad mode.");
+        }
+    }
+
+    public function getExpression(): Expression
+    {
+        return $this->expression;
+    }
+
+    /**
+     * @return string[]
+     */
+    public function getFieldList(): array
+    {
+        return $this->fieldList;
+    }
+
+    /**
+     * @return string[]
+     */
+    public function getColumnList(): array
+    {
+        return $this->columnList;
+    }
+
+    /**
+     * @return Mode::*
+     */
+    public function getMode(): string
+    {
+        return $this->mode;
+    }
+}

application/Espo/Core/Select/Text/FullTextSearch/DataComposer.php

@@ -0,0 +1,37 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM – Open Source CRM application.
+ * Copyright (C) 2014-2025 EspoCRM, Inc.
+ * Website: https://www.espocrm.com
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://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 Affero General Public License version 3.
+ *
+ * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
+ * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
+ ************************************************************************/
+
+namespace Espo\Core\Select\Text\FullTextSearch;
+
+use Espo\Core\Select\Text\FullTextSearch\DataComposer\Params;
+
+interface DataComposer
+{
+    public function compose(string $filter, Params $params): ?Data;
+}

application/Espo/Core/Select/Text/FullTextSearch/DataComposer/Params.php

@@ -0,0 +1,43 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM – Open Source CRM application.
+ * Copyright (C) 2014-2025 EspoCRM, Inc.
+ * Website: https://www.espocrm.com
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://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 Affero General Public License version 3.
+ *
+ * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
+ * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
+ ************************************************************************/
+
+namespace Espo\Core\Select\Text\FullTextSearch\DataComposer;
+
+/**
+ * Immutable.
+ */
+class Params
+{
+    private function __construct() {}
+
+    public static function create(): self
+    {
+        return new self();
+    }
+}

application/Espo/Core/Select/Text/FullTextSearch/DataComposerFactory.php

@@ -0,0 +1,62 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM – Open Source CRM application.
+ * Copyright (C) 2014-2025 EspoCRM, Inc.
+ * Website: https://www.espocrm.com
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://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 Affero General Public License version 3.
+ *
+ * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
+ * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
+ ************************************************************************/
+
+namespace Espo\Core\Select\Text\FullTextSearch;
+
+use Espo\Core\InjectableFactory;
+use Espo\Core\Utils\Metadata;
+
+class DataComposerFactory
+{
+    public function __construct(
+        private InjectableFactory $injectableFactory,
+        private Metadata $metadata
+    ) {}
+
+    public function create(string $entityType): DataComposer
+    {
+        $className = $this->getClassName($entityType);
+
+        return $this->injectableFactory->createWith($className, [
+            'entityType' => $entityType,
+        ]);
+    }
+
+    /**
+     * @return class-string<DataComposer>
+     */
+    private function getClassName(string $entityType): string
+    {
+        return
+            $this->metadata->get([
+                'selectDefs', $entityType, 'fullTextSearchDataComposerClassName'
+            ]) ??
+            DefaultDataComposer::class;
+    }
+}

application/Espo/Core/Select/Text/FullTextSearch/DefaultDataComposer.php

@@ -0,0 +1,168 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM – Open Source CRM application.
+ * Copyright (C) 2014-2025 EspoCRM, Inc.
+ * Website: https://www.espocrm.com
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://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 Affero General Public License version 3.
+ *
+ * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
+ * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
+ ************************************************************************/
+
+namespace Espo\Core\Select\Text\FullTextSearch;
+
+use Espo\Core\Utils\Config;
+use Espo\Core\Select\Text\MetadataProvider;
+use Espo\Core\Select\Text\FullTextSearch\DataComposer\Params;
+use Espo\ORM\Query\Part\Expression\Util as ExpressionUtil;
+use Espo\ORM\Query\Part\Expression;
+
+class DefaultDataComposer implements DataComposer
+{
+    /** @var array<Mode::*, string>*/
+    private array $functionMap = [
+        Mode::BOOLEAN => 'MATCH_BOOLEAN',
+        Mode::NATURAL_LANGUAGE => 'MATCH_NATURAL_LANGUAGE',
+    ];
+
+    public function __construct(
+        private string $entityType,
+        private Config $config,
+        private MetadataProvider $metadataProvider
+    ) {}
+
+    public function compose(string $filter, Params $params): ?Data
+    {
+        if ($this->config->get('fullTextSearchDisabled')) {
+            return null;
+        }
+
+        $columnList = $this->metadataProvider->getFullTextSearchColumnList($this->entityType) ?? [];
+
+        if (!count($columnList)) {
+            return null;
+        }
+
+        $fieldList = [];
+
+        foreach ($this->getTextFilterFieldList() as $field) {
+            if (str_contains($field, '.')) {
+                continue;
+            }
+
+            if ($this->metadataProvider->isFieldNotStorable($this->entityType, $field)) {
+                continue;
+            }
+
+            if (!$this->metadataProvider->isFullTextSearchSupportedForField($this->entityType, $field)) {
+                continue;
+            }
+
+            $fieldList[] = $field;
+        }
+
+        if (!count($fieldList)) {
+            return null;
+        }
+
+        $preparedFilter = $this->prepareFilter($filter, $params);
+
+        $mode = Mode::BOOLEAN;
+
+        if (
+            mb_strpos($preparedFilter, ' ') === false &&
+            mb_strpos($preparedFilter, '+') === false &&
+            mb_strpos($preparedFilter, ' -') === false &&
+            mb_strpos($preparedFilter, '-') !== 0 &&
+            mb_strpos($preparedFilter, '*') === false
+        ) {
+            $mode = Mode::NATURAL_LANGUAGE;
+        }
+
+        if ($mode === Mode::BOOLEAN) {
+            $preparedFilter = str_replace('@', '*', $preparedFilter);
+        }
+
+        $argumentList = array_merge(
+            array_map(fn ($item) => Expression::column($item), $columnList),
+            [$preparedFilter]
+        );
+
+        $function = $this->functionMap[$mode];
+
+        $expression = ExpressionUtil::composeFunction($function, ...$argumentList);
+
+        return new Data(
+            $expression,
+            $fieldList,
+            $columnList,
+            $mode
+        );
+    }
+
+    private function prepareFilter(string $filter, Params $params): string
+    {
+        $filter = str_replace('%', '*', $filter);
+        $filter = str_replace(['(', ')'], '', $filter);
+        $filter = str_replace('"*', '"', $filter);
+        $filter = str_replace('*"', '"', $filter);
+
+        while (str_contains($filter, '**')) {
+            $filter = trim(
+                str_replace('**', '*', $filter)
+            );
+        }
+
+        while (mb_substr($filter, -2) === ' *') {
+            $filter = trim(
+                mb_substr($filter, 0, mb_strlen($filter) - 2)
+            );
+        }
+
+        $filter = str_replace(['+-', '--', '-+', '++', '+*', '-*'], '', $filter);
+
+        while (str_contains($filter, '+ ')) {
+            $filter = str_replace('+ ', '', $filter);
+        }
+
+        while (str_contains($filter, '- ')) {
+            $filter = str_replace('- ', '', $filter);
+        }
+
+        while (in_array(substr($filter, -1), ['-', '+'])) {
+            $filter = substr($filter, 0, -1);
+        }
+
+        if ($filter === '*') {
+            $filter = '';
+        }
+
+        return $filter;
+    }
+
+    /**
+     * @return string[]
+     */
+    private function getTextFilterFieldList(): array
+    {
+        return $this->metadataProvider->getTextFilterAttributeList($this->entityType) ?? ['name'];
+    }
+}

application/Espo/Core/Select/Text/FullTextSearch/Mode.php

@@ -0,0 +1,36 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM – Open Source CRM application.
+ * Copyright (C) 2014-2025 EspoCRM, Inc.
+ * Website: https://www.espocrm.com
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://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 Affero General Public License version 3.
+ *
+ * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
+ * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
+ ************************************************************************/
+
+namespace Espo\Core\Select\Text\FullTextSearch;
+
+class Mode
+{
+    public const NATURAL_LANGUAGE = 'NATURAL_LANGUAGE';
+    public const BOOLEAN = 'BOOLEAN';
+}