/
AssetRepository.php
412 lines (373 loc) · 14.3 KB
/
AssetRepository.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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
<?php
declare(strict_types=1);
namespace Neos\Media\Domain\Repository;
/*
* This file is part of the Neos.Media package.
*
* (c) Contributors of the Neos Project - www.neos.io
*
* This package is Open Source Software. For the full copyright and license
* information, please view the LICENSE file which was distributed with this
* source code.
*/
use Doctrine\ORM\Internal\Hydration\IterableResult;
use Doctrine\ORM\NonUniqueResultException;
use Doctrine\ORM\Query\ResultSetMapping;
use Neos\Flow\Annotations as Flow;
use Neos\Flow\Persistence\Doctrine\Query;
use Neos\Flow\Persistence\Doctrine\Mapping\Driver\FlowAnnotationDriver;
use Neos\Flow\Persistence\Exception\IllegalObjectTypeException;
use Neos\Flow\Persistence\Exception\InvalidQueryException;
use Neos\Flow\Persistence\QueryInterface;
use Neos\Flow\Persistence\QueryResultInterface;
use Neos\Flow\Persistence\Repository;
use Neos\Flow\Reflection\ReflectionService;
use Neos\Media\Domain\Model\Asset;
use Neos\Media\Domain\Model\AssetCollection;
use Neos\Media\Domain\Model\AssetInterface;
use Neos\Media\Domain\Model\AssetVariantInterface;
use Neos\Media\Domain\Model\Tag;
use Neos\Media\Domain\Service\AssetService;
use Neos\Media\Exception\AssetServiceException;
/**
* A repository for Assets
*
* @Flow\Scope("singleton")
*/
class AssetRepository extends Repository
{
/**
* Doctrine's Entity Manager.
*
* @Flow\Inject
* @var \Doctrine\ORM\EntityManagerInterface
*/
protected $entityManager;
/**
* @var array
*/
protected $defaultOrderings = ['lastModified' => QueryInterface::ORDER_DESCENDING];
/**
* @Flow\Inject
* @var AssetService
*/
protected $assetService;
/**
* @Flow\Inject
* @var ReflectionService
*/
protected $reflectionService;
/**
* Find assets by title or given tags
*
* @param string $searchTerm
* @param array $tags
* @param AssetCollection $assetCollection
* @return QueryResultInterface
* @throws InvalidQueryException
*/
public function findBySearchTermOrTags($searchTerm, array $tags = [], AssetCollection $assetCollection = null): QueryResultInterface
{
$query = $this->createQuery();
$constraints = [
$query->like('title', '%' . $searchTerm . '%'),
$query->like('resource.filename', '%' . $searchTerm . '%'),
$query->like('caption', '%' . $searchTerm . '%')
];
foreach ($tags as $tag) {
$constraints[] = $query->contains('tags', $tag);
}
$query->matching($query->logicalOr($constraints));
$this->addAssetVariantToQueryConstraints($query);
$this->addAssetCollectionToQueryConstraints($query, $assetCollection);
return $query->execute();
}
/**
* Find Assets with the given Tag assigned
*
* @param Tag $tag
* @param AssetCollection $assetCollection
* @return QueryResultInterface
* @throws InvalidQueryException
*/
public function findByTag(Tag $tag, AssetCollection $assetCollection = null): QueryResultInterface
{
$query = $this->createQuery();
$query->matching($query->contains('tags', $tag));
$this->addAssetVariantToQueryConstraints($query);
$this->addAssetCollectionToQueryConstraints($query, $assetCollection);
return $query->execute();
}
/**
* Counts Assets with the given Tag assigned
*
* @param Tag $tag
* @param AssetCollection $assetCollection
* @return integer
*/
public function countByTag(Tag $tag, AssetCollection $assetCollection = null): int
{
$rsm = new ResultSetMapping();
$rsm->addScalarResult('c', 'c');
if ($assetCollection === null) {
$queryString = 'SELECT count(a.persistence_object_identifier) c FROM neos_media_domain_model_asset a LEFT JOIN neos_media_domain_model_asset_tags_join tagmm ON a.persistence_object_identifier = tagmm.media_asset WHERE tagmm.media_tag = ? AND ' . $this->getAssetVariantFilterClauseForDql('a');
} else {
$queryString = 'SELECT count(a.persistence_object_identifier) c FROM neos_media_domain_model_asset a LEFT JOIN neos_media_domain_model_asset_tags_join tagmm ON a.persistence_object_identifier = tagmm.media_asset LEFT JOIN neos_media_domain_model_assetcollection_assets_join collectionmm ON a.persistence_object_identifier = collectionmm.media_asset WHERE tagmm.media_tag = ? AND collectionmm.media_assetcollection = ? AND ' . $this->getAssetVariantFilterClauseForDql('a');
}
$query = $this->entityManager->createNativeQuery($queryString, $rsm);
$query->setParameter(1, $tag);
if ($assetCollection !== null) {
$query->setParameter(2, $assetCollection);
}
try {
return (int)$query->getSingleScalarResult();
} catch (NonUniqueResultException $e) {
return 0;
}
}
/**
* @param AssetCollection|null $assetCollection
* @return QueryResultInterface
* @throws InvalidQueryException
*/
public function findAll(AssetCollection $assetCollection = null): QueryResultInterface
{
$query = $this->createQuery();
$this->addAssetVariantToQueryConstraints($query);
$this->addAssetCollectionToQueryConstraints($query, $assetCollection);
return $query->execute();
}
/**
* @return integer
*/
public function countAll(): int
{
$rsm = new ResultSetMapping();
$rsm->addScalarResult('c', 'c');
if ($this->entityClassName === Asset::class) {
$queryString = 'SELECT count(a.persistence_object_identifier) c FROM neos_media_domain_model_asset a WHERE ' . $this->getAssetVariantFilterClauseForDql('a');
} else {
$queryString = sprintf(
"SELECT count(persistence_object_identifier) c FROM neos_media_domain_model_asset WHERE dtype = '%s'",
strtolower(str_replace('Domain_Model_', '', str_replace('\\', '_', $this->entityClassName)))
);
}
$query = $this->entityManager->createNativeQuery($queryString, $rsm);
try {
return (int)$query->getSingleScalarResult();
} catch (NonUniqueResultException $e) {
return 0;
}
}
/**
* Find Assets without any tag
*
* @param AssetCollection $assetCollection
* @return QueryResultInterface
* @throws InvalidQueryException
*/
public function findUntagged(AssetCollection $assetCollection = null): QueryResultInterface
{
$query = $this->createQuery();
$query->matching($query->isEmpty('tags'));
$this->addAssetVariantToQueryConstraints($query);
$this->addAssetCollectionToQueryConstraints($query, $assetCollection);
return $query->execute();
}
/**
* Counts Assets without any tag
*
* @param AssetCollection $assetCollection
* @return integer
*/
public function countUntagged(AssetCollection $assetCollection = null): int
{
$rsm = new ResultSetMapping();
$rsm->addScalarResult('c', 'c');
if ($assetCollection === null) {
$queryString = 'SELECT count(a.persistence_object_identifier) c FROM neos_media_domain_model_asset a LEFT JOIN neos_media_domain_model_asset_tags_join tagmm ON a.persistence_object_identifier = tagmm.media_asset WHERE tagmm.media_asset IS NULL AND ' . $this->getAssetVariantFilterClauseForDql('a');
} else {
$queryString = 'SELECT count(a.persistence_object_identifier) c FROM neos_media_domain_model_asset a LEFT JOIN neos_media_domain_model_asset_tags_join tagmm ON a.persistence_object_identifier = tagmm.media_asset LEFT JOIN neos_media_domain_model_assetcollection_assets_join collectionmm ON a.persistence_object_identifier = collectionmm.media_asset WHERE tagmm.media_asset IS NULL AND collectionmm.media_assetcollection = ? AND ' . $this->getAssetVariantFilterClauseForDql('a');
}
$query = $this->entityManager->createNativeQuery($queryString, $rsm);
if ($assetCollection !== null) {
$query->setParameter(1, $assetCollection);
}
try {
return (int)$query->getSingleScalarResult();
} catch (NonUniqueResultException $e) {
return 0;
}
}
/**
* @param AssetCollection $assetCollection
* @return QueryResultInterface
* @throws InvalidQueryException
*/
public function findByAssetCollection(AssetCollection $assetCollection): QueryResultInterface
{
$query = $this->createQuery();
$this->addAssetVariantToQueryConstraints($query);
$this->addAssetCollectionToQueryConstraints($query, $assetCollection);
return $query->execute();
}
/**
* Count assets by asset collection
*
* @param AssetCollection $assetCollection
* @return integer
*/
public function countByAssetCollection(AssetCollection $assetCollection): int
{
$rsm = new ResultSetMapping();
$rsm->addScalarResult('c', 'c');
$queryString = 'SELECT count(a.persistence_object_identifier) c FROM neos_media_domain_model_asset a LEFT JOIN neos_media_domain_model_assetcollection_assets_join collectionmm ON a.persistence_object_identifier = collectionmm.media_asset WHERE collectionmm.media_assetcollection = ? AND ' . $this->getAssetVariantFilterClauseForDql('a');
$query = $this->entityManager->createNativeQuery($queryString, $rsm);
$query->setParameter(1, $assetCollection);
try {
return (int)$query->getSingleScalarResult();
} catch (NonUniqueResultException $e) {
return 0;
}
}
/**
* @param QueryInterface $query
* @param AssetCollection $assetCollection
* @return void
* @throws InvalidQueryException
*/
protected function addAssetCollectionToQueryConstraints(QueryInterface $query, AssetCollection $assetCollection = null): void
{
if ($assetCollection === null) {
return;
}
$constraints = $query->getConstraint();
$query->matching($query->logicalAnd([$constraints, $query->contains('assetCollections', $assetCollection)]));
}
/**
* Adds conditions filtering any implementation of AssetVariantInterface
*
* @param Query $query
* @return void
*/
protected function addAssetVariantToQueryConstraints(QueryInterface $query): void
{
$variantsConstraints = [];
$variantClassNames = $this->reflectionService->getAllImplementationClassNamesForInterface(AssetVariantInterface::class);
foreach ($variantClassNames as $variantClassName) {
$variantsConstraints[] = 'e NOT INSTANCE OF ' . $variantClassName;
}
$constraints = $query->getConstraint();
$query->matching($query->logicalAnd([$constraints, $query->logicalAnd($variantsConstraints)]));
}
/**
* Returns a DQL clause filtering any implementation of AssetVariantInterface
*
* @return string
* @var string $alias
*/
protected function getAssetVariantFilterClauseForDql(string $alias): string
{
$variantClassNames = $this->reflectionService->getAllImplementationClassNamesForInterface(AssetVariantInterface::class);
$discriminatorTypes = array_map(
[FlowAnnotationDriver::class, 'inferDiscriminatorTypeFromClassName'],
$variantClassNames
);
return sprintf(
"%s.dtype NOT IN('%s')",
$alias,
implode("','", $discriminatorTypes)
);
}
/**
* @param string $sha1
* @return AssetInterface|NULL
*/
public function findOneByResourceSha1($sha1): ?AssetInterface
{
$query = $this->createQuery();
$query->matching($query->equals('resource.sha1', $sha1))->setLimit(1);
return $query->execute()->getFirst();
}
/**
* Iterate over an IterableResult and return a Generator
*
* This method is useful for batch processing huge result set as it clears the object
* manager and detaches the current object on each iteration.
*
* @param IterableResult $iterator
* @param callable $callback
* @return \Generator
*/
public function iterate(IterableResult $iterator, callable $callback = null): ?\Generator
{
$iteration = 0;
foreach ($iterator as $object) {
$object = current($object);
yield $object;
if ($callback !== null) {
$callback($iteration, $object);
}
$iteration++;
}
}
/**
* Find all objects and return an IterableResult
*
* @return IterableResult
*/
public function findAllIterator(): IterableResult
{
/** @var Query $query */
$query = $this->createQuery();
$this->addAssetVariantToQueryConstraints($query);
return $query->getQueryBuilder()->getQuery()->iterate();
}
/**
* Remove an asset while first validating if the object can be removed or
* if removal is blocked because the asset is still in use.
*
* @param AssetInterface $object
* @return void
* @throws IllegalObjectTypeException
* @throws AssetServiceException
*/
public function remove($object): void
{
$this->assetService->validateRemoval($object);
parent::remove($object);
$this->assetService->emitAssetRemoved($object);
}
/**
* Remove the asset even if it is still in use. Use with care, it is probably
* better to first make sure the asset is not used anymore and then use
* the remove() method for removal.
*
* @param AssetInterface $object
* @return void
* @throws IllegalObjectTypeException
*/
public function removeWithoutUsageChecks($object): void
{
parent::remove($object);
$this->assetService->emitAssetRemoved($object);
}
/**
* @param AssetInterface $object
* @throws IllegalObjectTypeException
*/
public function add($object): void
{
parent::add($object);
$this->assetService->emitAssetCreated($object);
}
/**
* @param AssetInterface $object
* @throws IllegalObjectTypeException
*/
public function update($object): void
{
parent::update($object);
$this->assetService->emitAssetUpdated($object);
}
}