Initial commit

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

@@ -0,0 +1,72 @@
+<?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\Primary;
+
+use Espo\Core\Exceptions\BadRequest;
+use Espo\Core\Select\SelectManager;
+use Espo\Core\Select\OrmSelectBuilder;
+use Espo\ORM\Query\SelectBuilder as QueryBuilder;
+use Espo\Entities\User;
+
+class Applier
+{
+    public function __construct(
+        private string $entityType,
+        private User $user,
+        private FilterFactory $primaryFilterFactory,
+        private SelectManager $selectManager
+    ) {}
+
+    /**
+     * @throws BadRequest
+     */
+    public function apply(QueryBuilder $queryBuilder, string $filterName): void
+    {
+        if ($this->primaryFilterFactory->has($this->entityType, $filterName)) {
+            $filter = $this->primaryFilterFactory->create($this->entityType, $this->user, $filterName);
+
+            $filter->apply($queryBuilder);
+
+            return;
+        }
+
+        // For backward compatibility.
+        if (
+            $this->selectManager->hasPrimaryFilter($filterName) &&
+            $queryBuilder instanceof OrmSelectBuilder
+        ) {
+            $this->selectManager->applyPrimaryFilterToQueryBuilder($queryBuilder, $filterName);
+
+            return;
+        }
+
+        throw new BadRequest("No primary filter '$filterName' for '$this->entityType'.");
+    }
+}

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

@@ -0,0 +1,40 @@
+<?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\Primary;
+
+use Espo\ORM\Query\SelectBuilder as QueryBuilder;
+
+/**
+ * A primary filter.
+ */
+interface Filter
+{
+    public function apply(QueryBuilder $queryBuilder): void;
+}

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

@@ -0,0 +1,118 @@
+<?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\Primary;
+
+use Espo\Core\Binding\Binder;
+use Espo\Core\Binding\BindingContainer;
+use Espo\Core\Binding\BindingData;
+use Espo\Core\InjectableFactory;
+use Espo\Core\Select\Helpers\FieldHelper;
+use Espo\Core\Utils\Metadata;
+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("Primary filter '{$name}' for '{$entityType}' does not exist.");
+        }
+
+        $bindingData = new BindingData();
+
+        $binder = new Binder($bindingData);
+
+        $binder
+            ->bindInstance(User::class, $user)
+            ->for($className)
+            ->bindValue('$entityType', $entityType)
+            ->bindValue('$name', $name);
+
+        $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 primary filter name.");
+        }
+
+        $className = $this->metadata->get(
+            [
+                'selectDefs',
+                $entityType,
+                'primaryFilterClassNameMap',
+                $name,
+            ]
+        );
+
+        if ($className) {
+            return $className;
+        }
+
+        return $this->getDefaultClassName($name);
+    }
+
+    /**
+     * @return ?class-string<Filter>
+     */
+    protected function getDefaultClassName(string $name): ?string
+    {
+        $className = 'Espo\\Core\\Select\\Primary\\Filters\\' . ucfirst($name);
+
+        if (!class_exists($className)) {
+            return null;
+        }
+
+        /** @var class-string<Filter> */
+        return $className;
+    }
+}

application/Espo/Core/Select/Primary/Filters/All.php

@@ -0,0 +1,48 @@
+<?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\Primary\Filters;
+
+use Espo\Core\Select\Primary\Filter;
+use Espo\ORM\Query\SelectBuilder as QueryBuilder;
+
+/**
+ * A dummy filter 'all'. Can be detected in a custom AdditionalApplier to instruct that the filter needs to be
+ * bypassed. Use this filter for special cases from code. Users can pass this filter too. Do not rely on this filter
+ * when dealing with access control logic.
+ *
+ * @since 9.2.0
+ */
+class All implements Filter
+{
+    public const NAME = 'all';
+
+    public function apply(QueryBuilder $queryBuilder): void
+    {}
+}

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

@@ -0,0 +1,57 @@
+<?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\Primary\Filters;
+
+use Espo\Core\Select\Primary\Filter;
+use Espo\Entities\StreamSubscription;
+use Espo\Entities\User;
+use Espo\ORM\Name\Attribute;
+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): void
+    {
+        $alias = 'subscriptionFollowedPrimaryFilter';
+
+        $queryBuilder->join(
+            StreamSubscription::ENTITY_TYPE,
+            $alias,
+            [
+                $alias . '.entityType' => $this->entityType,
+                $alias . '.entityId=:' => Attribute::ID,
+                $alias . '.userId' => $this->user->getId(),
+            ]
+        );
+    }
+}

application/Espo/Core/Select/Primary/Filters/One.php

@@ -0,0 +1,45 @@
+<?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\Primary\Filters;
+
+use Espo\Core\Select\Primary\Filter;
+use Espo\ORM\Query\SelectBuilder as QueryBuilder;
+
+/**
+ * A dummy filter 'one'. Applied only when reading a single record (from the detail view).
+ * Can be detected in a custom AdditionalApplier to distinguish a read request from a find request.
+ */
+class One implements Filter
+{
+    public const NAME = 'one';
+
+    public function apply(QueryBuilder $queryBuilder): void
+    {}
+}

application/Espo/Core/Select/Primary/Filters/Starred.php

@@ -0,0 +1,60 @@
+<?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\Primary\Filters;
+
+use Espo\Core\Select\Primary\Filter;
+use Espo\Entities\StarSubscription;
+use Espo\Entities\User;
+use Espo\ORM\Name\Attribute;
+use Espo\ORM\Query\SelectBuilder as QueryBuilder;
+
+/**
+ * @noinspection PhpUnused
+ */
+class Starred implements Filter
+{
+    public function __construct(private string $entityType, private User $user)
+    {}
+
+    public function apply(QueryBuilder $queryBuilder): void
+    {
+        $alias = 'starredPrimaryFilter';
+
+        $queryBuilder->join(
+            StarSubscription::ENTITY_TYPE,
+            $alias,
+            [
+                "$alias.entityType" => $this->entityType,
+                "$alias.entityId=:" => Attribute::ID,
+                "$alias.userId" => $this->user->getId(),
+            ]
+        );
+    }
+}