/
Finder.php
182 lines (154 loc) · 5.08 KB
/
Finder.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
<?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\Core\Duplicate;
use Espo\Core\Exceptions\BadRequest;
use Espo\Core\Exceptions\Error;
use Espo\Core\Exceptions\Forbidden;
use Espo\Core\Select\SelectBuilderFactory;
use Espo\ORM\Collection;
use Espo\ORM\Entity;
use Espo\ORM\EntityManager;
use Espo\ORM\Query\Part\Condition as Cond;
use Espo\ORM\Query\Part\WhereItem;
use RuntimeException;
class Finder
{
private const LIMIT = 10;
/** @var array<string, ?WhereBuilder<Entity>> */
private array $whereBuilderMap = [];
public function __construct(
private EntityManager $entityManager,
private SelectBuilderFactory $selectBuilderFactory,
private WhereBuilderFactory $whereBuilderFactory
) {}
/**
* Check whether an entity has a duplicate.
*/
public function check(Entity $entity): bool
{
$where = $this->getWhere($entity);
if (!$where) {
return false;
}
return $this->checkByWhere($entity, $where);
}
/**
* Find entity duplicates.
*
* @return ?Collection<Entity>
*/
public function find(Entity $entity): ?Collection
{
$where = $this->getWhere($entity);
if (!$where) {
return null;
}
return $this->findByWhere($entity, $where);
}
/**
* The method is public for backward compatibility.
*/
public function checkByWhere(Entity $entity, WhereItem $where): bool
{
$entityType = $entity->getEntityType();
if ($entity->hasId()) {
$where = Cond::and(
$where,
Cond::notEqual(
Cond::column('id'),
$entity->getId()
)
);
}
$duplicate = $this->entityManager
->getRDBRepository($entityType)
->where($where)
->select('id')
->findOne();
return (bool) $duplicate;
}
/**
* The method is public for backward compatibility.
*
* @return ?Collection<Entity>
*/
public function findByWhere(Entity $entity, WhereItem $where): ?Collection
{
$entityType = $entity->getEntityType();
if ($entity->hasId()) {
$where = Cond::and(
$where,
Cond::notEqual(
Cond::column('id'),
$entity->getId()
)
);
}
try {
$query = $this->selectBuilderFactory
->create()
->from($entityType)
->withStrictAccessControl()
->buildQueryBuilder()
->where($where)
->select(['id'])
->limit(0, self::LIMIT)
->build();
}
catch (Error|Forbidden|BadRequest $e) {
throw new RuntimeException($e->getMessage(), 0, $e);
}
$builder = $this->entityManager
->getRDBRepository($entityType)
->clone($query);
if (!$builder->findOne()) {
return null;
}
return $builder->select(['*'])->find();
}
private function getWhere(Entity $entity): ?WhereItem
{
$entityType = $entity->getEntityType();
if (!array_key_exists($entityType, $this->whereBuilderMap)) {
$this->whereBuilderMap[$entityType] = $this->loadWhereBuilder($entityType);
}
$builder = $this->whereBuilderMap[$entityType];
return $builder?->build($entity);
}
/**
* @return ?WhereBuilder<Entity>
*/
private function loadWhereBuilder(string $entityType): ?WhereBuilder
{
if (!$this->whereBuilderFactory->has($entityType)) {
return null;
}
return $this->whereBuilderFactory->create($entityType);
}
}