Initial commit

application/Espo/Core/Select/Bool/Applier.php

@@ -0,0 +1,124 @@
+<?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\Bool;
+
+use Espo\Core\Exceptions\BadRequest;
+use Espo\Core\Select\OrmSelectBuilder;
+use Espo\Core\Select\SelectManager;
+use Espo\Core\Select\Bool\FilterFactory as BoolFilterFactory;
+use Espo\ORM\Query\Select;
+use Espo\ORM\Query\SelectBuilder as QueryBuilder;
+use Espo\ORM\Query\Part\Where\OrGroupBuilder;
+use Espo\ORM\Query\Part\WhereClause;
+
+use Espo\Entities\User;
+
+class Applier
+{
+    public function __construct(
+        private string $entityType,
+        private User $user,
+        private BoolFilterFactory $boolFilterFactory,
+        private SelectManager $selectManager
+    ) {}
+
+    /**
+     * @param string[] $boolFilterNameList
+     * @throws BadRequest
+     */
+    public function apply(QueryBuilder $queryBuilder, array $boolFilterNameList): void
+    {
+        $orGroupBuilder = new OrGroupBuilder();
+
+        $isMultiple = count($boolFilterNameList) > 1;
+
+        if ($isMultiple) {
+            $queryBefore = $queryBuilder->build();
+        }
+
+        foreach ($boolFilterNameList as $filterName) {
+            $this->applyBoolFilter($queryBuilder, $orGroupBuilder, $filterName);
+        }
+
+        if ($isMultiple) {
+            $this->handleMultiple($queryBefore, $queryBuilder);
+        }
+
+        $queryBuilder->where(
+            $orGroupBuilder->build()
+        );
+    }
+
+    /**
+     * @throws BadRequest
+     */
+    private function applyBoolFilter(
+        QueryBuilder $queryBuilder,
+        OrGroupBuilder $orGroupBuilder,
+        string $filterName
+    ): void {
+
+        if ($this->boolFilterFactory->has($this->entityType, $filterName)) {
+            $filter = $this->boolFilterFactory->create($this->entityType, $this->user, $filterName);
+
+            $filter->apply($queryBuilder, $orGroupBuilder);
+
+            return;
+        }
+
+        // For backward compatibility.
+        if (
+            $this->selectManager->hasBoolFilter($filterName) &&
+            $queryBuilder instanceof OrmSelectBuilder
+        ) {
+            $rawWhereClause = $this->selectManager->applyBoolFilterToQueryBuilder($queryBuilder, $filterName);
+
+            $whereItem = WhereClause::fromRaw($rawWhereClause);
+
+            $orGroupBuilder->add($whereItem);
+
+            return;
+        }
+
+        throw new BadRequest("No bool filter '$filterName' for '$this->entityType'.");
+    }
+
+    private function handleMultiple(Select $queryBefore, QueryBuilder $queryBuilder): void
+    {
+        $queryAfter = $queryBuilder->build();
+
+        $joinCountBefore = count($queryBefore->getJoins());
+        $joinCountAfter = count($queryAfter->getJoins());
+
+        if ($joinCountBefore < $joinCountAfter) {
+            $queryBuilder->distinct();
+        }
+    }
+}

application/Espo/Core/Select/Bool/Filter.php

@@ -0,0 +1,41 @@
+<?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\Bool;
+
+use Espo\ORM\Query\Part\Where\OrGroupBuilder;
+use Espo\ORM\Query\SelectBuilder as QueryBuilder;
+
+/**
+ * Applies a bool filter. A where item should be added to OrGroupBuilder.
+ */
+interface Filter
+{
+    public function apply(QueryBuilder $queryBuilder, OrGroupBuilder $orGroupBuilder): void;
+}

application/Espo/Core/Select/Bool/FilterFactory.php

@@ -0,0 +1,127 @@
+<?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\Bool;
+
+use Espo\Core\InjectableFactory;
+use Espo\Core\Select\Helpers\FieldHelper;
+use Espo\Core\Utils\Metadata;
+use Espo\Core\Binding\BindingContainer;
+use Espo\Core\Binding\Binder;
+use Espo\Core\Binding\BindingData;
+use Espo\Entities\User;
+
+use RuntimeException;
+
+class FilterFactory
+{
+    public function __construct(
+        private InjectableFactory $injectableFactory,
+        private Metadata $metadata
+    ) {}
+
+    public function create(string $entityType, User $user, string $name): Filter
+    {
+        $className = $this->getClassName($entityType, $name);
+
+        if (!$className) {
+            throw new RuntimeException("Bool filter '$name' for '$entityType' does not exist.");
+        }
+
+        $bindingData = new BindingData();
+
+        $binder = new Binder($bindingData);
+
+        $binder
+            ->bindInstance(User::class, $user)
+            ->for($className)
+            ->bindValue('$entityType', $entityType);
+
+        $binder
+            ->for(FieldHelper::class)
+            ->bindValue('$entityType', $entityType);
+
+        $bindingContainer = new BindingContainer($bindingData);
+
+        return $this->injectableFactory->createWithBinding($className, $bindingContainer);
+    }
+
+    public function has(string $entityType, string $name): bool
+    {
+        return (bool) $this->getClassName($entityType, $name);
+    }
+
+    /**
+     * @return ?class-string<Filter>
+     */
+    protected function getClassName(string $entityType, string $name): ?string
+    {
+        if (!$name) {
+            throw new RuntimeException("Empty bool filter name.");
+        }
+
+        $className = $this->metadata->get(
+            [
+                'selectDefs',
+                $entityType,
+                'boolFilterClassNameMap',
+                $name,
+            ]
+        );
+
+        if ($className) {
+            /** @var ?class-string<Filter> */
+            return $className;
+        }
+
+        return $this->getDefaultClassName($name);
+    }
+
+    /**
+     * @return ?class-string<Filter>
+     */
+    protected function getDefaultClassName(string $name): ?string
+    {
+        $className1 = $this->metadata->get(['app', 'select', 'boolFilterClassNameMap', $name]);
+
+        if ($className1) {
+            /** @var class-string<Filter> */
+            return $className1;
+        }
+
+        $className = 'Espo\\Core\\Select\\Bool\\Filters\\' . ucfirst($name);
+
+        if (!class_exists($className)) {
+            return null;
+        }
+
+        /** @var class-string<Filter> */
+        return $className;
+    }
+}

application/Espo/Core/Select/Bool/Filters/Followed.php

@@ -0,0 +1,65 @@
+<?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\Bool\Filters;
+
+use Espo\Core\Select\Bool\Filter;
+use Espo\Entities\StreamSubscription;
+use Espo\Entities\User;
+use Espo\ORM\Name\Attribute;
+use Espo\ORM\Query\Part\Where\OrGroupBuilder;
+use Espo\ORM\Query\Part\WhereClause;
+use Espo\ORM\Query\SelectBuilder as QueryBuilder;
+
+class Followed implements Filter
+{
+    public function __construct(private string $entityType, private User $user)
+    {}
+
+    public function apply(QueryBuilder $queryBuilder, OrGroupBuilder $orGroupBuilder): void
+    {
+        $alias = 'subscriptionFollowedBoolFilter';
+
+        $queryBuilder->leftJoin(
+            StreamSubscription::ENTITY_TYPE,
+            $alias,
+            [
+                $alias . '.entityType' => $this->entityType,
+                $alias . '.entityId=:' => Attribute::ID,
+                $alias . '.userId' => $this->user->getId(),
+            ]
+        );
+
+        $orGroupBuilder->add(
+            WhereClause::fromRaw([
+                $alias . '.id!=' => null,
+            ])
+        );
+    }
+}

application/Espo/Core/Select/Bool/Filters/OnlyMy.php

@@ -0,0 +1,116 @@
+<?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\Bool\Filters;
+
+use Espo\Core\Name\Field;
+use Espo\Core\Select\Bool\Filter;
+use Espo\Core\Select\Helpers\FieldHelper;
+use Espo\Entities\User;
+use Espo\ORM\Defs;
+use Espo\ORM\Name\Attribute;
+use Espo\ORM\Query\Part\Condition as Cond;
+use Espo\ORM\Query\Part\Where\OrGroupBuilder;
+use Espo\ORM\Query\SelectBuilder as QueryBuilder;
+
+/**
+ * @noinspection PhpUnused
+ */
+class OnlyMy implements Filter
+{
+    public const NAME = 'onlyMy';
+
+    public function __construct(
+        private string $entityType,
+        private User $user,
+        private FieldHelper $fieldHelper,
+        private Defs $defs
+    ) {}
+
+    public function apply(QueryBuilder $queryBuilder, OrGroupBuilder $orGroupBuilder): void
+    {
+        if ($this->user->isPortal()) {
+            $orGroupBuilder->add(
+                Cond::equal(
+                    Cond::column('createdById'),
+                    $this->user->getId()
+                )
+            );
+
+            return;
+        }
+
+        if ($this->fieldHelper->hasAssignedUsersField()) {
+            $relationDefs = $this->defs
+                ->getEntity($this->entityType)
+                ->getRelation(Field::ASSIGNED_USERS);
+
+            $middleEntityType = ucfirst($relationDefs->getRelationshipName());
+            $key1 = $relationDefs->getMidKey();
+            $key2 = $relationDefs->getForeignMidKey();
+
+            $subQuery = QueryBuilder::create()
+                ->select(Attribute::ID)
+                ->from($this->entityType)
+                ->leftJoin($middleEntityType, 'assignedUsersMiddle', [
+                    "assignedUsersMiddle.$key1:" => Attribute::ID,
+                    'assignedUsersMiddle.deleted' => false,
+                ])
+                ->where(["assignedUsersMiddle.$key2" => $this->user->getId()])
+                ->build();
+
+            $orGroupBuilder->add(
+                Cond::in(
+                    Cond::column(Attribute::ID),
+                    $subQuery
+                )
+            );
+
+            return;
+        }
+
+        if ($this->fieldHelper->hasAssignedUserField()) {
+            $orGroupBuilder->add(
+                Cond::equal(
+                    Cond::column('assignedUserId'),
+                    $this->user->getId()
+                )
+            );
+
+            return;
+        }
+
+        $orGroupBuilder->add(
+            Cond::equal(
+                Cond::column('createdById'),
+                $this->user->getId()
+            )
+        );
+    }
+}

application/Espo/Core/Select/Bool/Filters/Shared.php

@@ -0,0 +1,87 @@
+<?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\Bool\Filters;
+
+use Espo\Core\Name\Field;
+use Espo\Core\Select\Bool\Filter;
+use Espo\Core\Select\Helpers\FieldHelper;
+use Espo\Entities\User;
+use Espo\ORM\Defs;
+use Espo\ORM\Name\Attribute;
+use Espo\ORM\Query\Part\Condition as Cond;
+use Espo\ORM\Query\Part\Where\OrGroupBuilder;
+use Espo\ORM\Query\SelectBuilder as QueryBuilder;
+
+/**
+ * @noinspection PhpUnused
+ */
+class Shared implements Filter
+{
+    public const NAME = 'shared';
+
+    public function __construct(
+        private string $entityType,
+        private User $user,
+        private FieldHelper $fieldHelper,
+        private Defs $defs
+    ) {}
+
+    public function apply(QueryBuilder $queryBuilder, OrGroupBuilder $orGroupBuilder): void
+    {
+        if (!$this->fieldHelper->hasCollaboratorsField()) {
+            return;
+        }
+
+        $relationDefs = $this->defs
+            ->getEntity($this->entityType)
+            ->getRelation(Field::COLLABORATORS);
+
+        $middleEntityType = ucfirst($relationDefs->getRelationshipName());
+        $key1 = $relationDefs->getMidKey();
+        $key2 = $relationDefs->getForeignMidKey();
+
+        $subQuery = QueryBuilder::create()
+            ->select(Attribute::ID)
+            ->from($this->entityType)
+            ->leftJoin($middleEntityType, 'collaboratorsMiddle', [
+                "collaboratorsMiddle.$key1:" => Attribute::ID,
+                'collaboratorsMiddle.deleted' => false,
+            ])
+            ->where(["collaboratorsMiddle.$key2" => $this->user->getId()])
+            ->build();
+
+        $orGroupBuilder->add(
+            Cond::in(
+                Cond::column('id'),
+                $subQuery
+            )
+        );
+    }
+}