Completed
Push — EZP-30968-count-reverse-relati... ( c55217 )
by
unknown
27:08 queued 08:53
created

DoctrineDatabase::countReverseRelations()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 35

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 35
c 0
b 0
f 0
cc 2
nc 2
nop 2
rs 9.36
1
<?php
2
3
/**
4
 * File containing the DoctrineDatabase Content Gateway class.
5
 *
6
 * @copyright Copyright (C) eZ Systems AS. All rights reserved.
7
 * @license For full copyright and license information view LICENSE file distributed with this source code.
8
 */
9
namespace eZ\Publish\Core\Persistence\Legacy\Content\Gateway;
10
11
use Doctrine\DBAL\Connection;
12
use Doctrine\DBAL\DBALException;
13
use Doctrine\DBAL\FetchMode;
14
use Doctrine\DBAL\ParameterType;
15
use Doctrine\DBAL\Query\QueryBuilder as DoctrineQueryBuilder;
16
use eZ\Publish\Core\Base\Exceptions\BadStateException;
17
use eZ\Publish\Core\Persistence\Legacy\Content\Gateway;
18
use eZ\Publish\Core\Persistence\Legacy\Content\Gateway\DoctrineDatabase\QueryBuilder;
19
use eZ\Publish\Core\Persistence\Database\DatabaseHandler;
20
use eZ\Publish\Core\Persistence\Database\UpdateQuery;
21
use eZ\Publish\Core\Persistence\Database\InsertQuery;
22
use eZ\Publish\Core\Persistence\Database\SelectQuery;
23
use eZ\Publish\Core\Persistence\Legacy\Content\StorageFieldValue;
24
use eZ\Publish\Core\Persistence\Legacy\Content\Language\MaskGenerator as LanguageMaskGenerator;
25
use eZ\Publish\SPI\Persistence\Content;
26
use eZ\Publish\SPI\Persistence\Content\CreateStruct;
27
use eZ\Publish\SPI\Persistence\Content\UpdateStruct;
28
use eZ\Publish\SPI\Persistence\Content\MetadataUpdateStruct;
29
use eZ\Publish\SPI\Persistence\Content\ContentInfo;
30
use eZ\Publish\SPI\Persistence\Content\VersionInfo;
31
use eZ\Publish\SPI\Persistence\Content\Field;
32
use eZ\Publish\SPI\Persistence\Content\Relation\CreateStruct as RelationCreateStruct;
33
use eZ\Publish\SPI\Persistence\Content\Language\Handler as LanguageHandler;
34
use eZ\Publish\Core\Base\Exceptions\NotFoundException as NotFound;
35
use eZ\Publish\API\Repository\Values\Content\VersionInfo as APIVersionInfo;
36
use DOMXPath;
37
use DOMDocument;
38
use PDO;
39
40
/**
41
 * Doctrine database based content gateway.
42
 */
43
class DoctrineDatabase extends Gateway
44
{
45
    /**
46
     * eZ Doctrine database handler.
47
     *
48
     * @var \eZ\Publish\Core\Persistence\Database\DatabaseHandler
49
     * @deprecated Start to use DBAL $connection instead.
50
     */
51
    protected $dbHandler;
52
53
    /**
54
     * The native Doctrine connection.
55
     *
56
     * Meant to be used to transition from eZ/Zeta interface to Doctrine.
57
     *
58
     * @var \Doctrine\DBAL\Connection
59
     */
60
    protected $connection;
61
62
    /**
63
     * Query builder.
64
     *
65
     * @var \eZ\Publish\Core\Persistence\Legacy\Content\Gateway\DoctrineDatabase\QueryBuilder
66
     */
67
    protected $queryBuilder;
68
69
    /**
70
     * Caching language handler.
71
     *
72
     * @var \eZ\Publish\Core\Persistence\Legacy\Content\Language\CachingHandler
73
     */
74
    protected $languageHandler;
75
76
    /**
77
     * Language mask generator.
78
     *
79
     * @var \eZ\Publish\Core\Persistence\Legacy\Content\Language\MaskGenerator
80
     */
81
    protected $languageMaskGenerator;
82
83
    /**
84
     * Creates a new gateway based on $db.
85
     *
86
     * @param \eZ\Publish\Core\Persistence\Database\DatabaseHandler $db
87
     * @param \Doctrine\DBAL\Connection $connection
88
     * @param \eZ\Publish\Core\Persistence\Legacy\Content\Gateway\DoctrineDatabase\QueryBuilder $queryBuilder
89
     * @param \eZ\Publish\SPI\Persistence\Content\Language\Handler $languageHandler
90
     * @param \eZ\Publish\Core\Persistence\Legacy\Content\Language\MaskGenerator $languageMaskGenerator
91
     */
92
    public function __construct(
93
        DatabaseHandler $db,
94
        Connection $connection,
95
        QueryBuilder $queryBuilder,
96
        LanguageHandler $languageHandler,
97
        LanguageMaskGenerator $languageMaskGenerator
98
    ) {
99
        $this->dbHandler = $db;
100
        $this->connection = $connection;
101
        $this->queryBuilder = $queryBuilder;
102
        $this->languageHandler = $languageHandler;
0 ignored issues
show
Documentation Bug introduced by
$languageHandler is of type object<eZ\Publish\SPI\Pe...ntent\Language\Handler>, but the property $languageHandler was declared to be of type object<eZ\Publish\Core\P...anguage\CachingHandler>. Are you sure that you always receive this specific sub-class here, or does it make sense to add an instanceof check?

Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a given class or a super-class is assigned to a property that is type hinted more strictly.

Either this assignment is in error or an instanceof check should be added for that assignment.

class Alien {}

class Dalek extends Alien {}

class Plot
{
    /** @var  Dalek */
    public $villain;
}

$alien = new Alien();
$plot = new Plot();
if ($alien instanceof Dalek) {
    $plot->villain = $alien;
}
Loading history...
103
        $this->languageMaskGenerator = $languageMaskGenerator;
104
    }
105
106
    /**
107
     * Get context definition for external storage layers.
108
     *
109
     * @return array
110
     */
111
    public function getContext()
112
    {
113
        return [
114
            'identifier' => 'LegacyStorage',
115
            'connection' => $this->dbHandler,
116
        ];
117
    }
118
119
    /**
120
     * Inserts a new content object.
121
     *
122
     * @param \eZ\Publish\SPI\Persistence\Content\CreateStruct $struct
123
     * @param mixed $currentVersionNo
124
     *
125
     * @return int ID
126
     */
127
    public function insertContentObject(CreateStruct $struct, $currentVersionNo = 1)
128
    {
129
        $initialLanguageId = !empty($struct->mainLanguageId) ? $struct->mainLanguageId : $struct->initialLanguageId;
130
        $initialLanguageCode = $this->languageHandler->load($initialLanguageId)->languageCode;
131
132
        if (isset($struct->name[$initialLanguageCode])) {
133
            $name = $struct->name[$initialLanguageCode];
134
        } else {
135
            $name = '';
136
        }
137
138
        $q = $this->dbHandler->createInsertQuery();
139
        $q->insertInto(
140
            $this->dbHandler->quoteTable('ezcontentobject')
141
        )->set(
142
            $this->dbHandler->quoteColumn('id'),
143
            $this->dbHandler->getAutoIncrementValue('ezcontentobject', 'id')
144
        )->set(
145
            $this->dbHandler->quoteColumn('current_version'),
146
            $q->bindValue($currentVersionNo, null, \PDO::PARAM_INT)
147
        )->set(
148
            $this->dbHandler->quoteColumn('name'),
149
            $q->bindValue($name, null, \PDO::PARAM_STR)
150
        )->set(
151
            $this->dbHandler->quoteColumn('contentclass_id'),
152
            $q->bindValue($struct->typeId, null, \PDO::PARAM_INT)
153
        )->set(
154
            $this->dbHandler->quoteColumn('section_id'),
155
            $q->bindValue($struct->sectionId, null, \PDO::PARAM_INT)
156
        )->set(
157
            $this->dbHandler->quoteColumn('owner_id'),
158
            $q->bindValue($struct->ownerId, null, \PDO::PARAM_INT)
159
        )->set(
160
            $this->dbHandler->quoteColumn('initial_language_id'),
161
            $q->bindValue($initialLanguageId, null, \PDO::PARAM_INT)
162
        )->set(
163
            $this->dbHandler->quoteColumn('remote_id'),
164
            $q->bindValue($struct->remoteId, null, \PDO::PARAM_STR)
165
        )->set(
166
            $this->dbHandler->quoteColumn('modified'),
167
            $q->bindValue(0, null, \PDO::PARAM_INT)
168
        )->set(
169
            $this->dbHandler->quoteColumn('published'),
170
            $q->bindValue(0, null, \PDO::PARAM_INT)
171
        )->set(
172
            $this->dbHandler->quoteColumn('status'),
173
            $q->bindValue(ContentInfo::STATUS_DRAFT, null, \PDO::PARAM_INT)
174
        )->set(
175
            $this->dbHandler->quoteColumn('language_mask'),
176
            $q->bindValue(
177
                $this->generateLanguageMask(
178
                    $struct->fields,
179
                    $initialLanguageCode,
180
                    $struct->alwaysAvailable
181
                ),
182
                null,
183
                \PDO::PARAM_INT
184
            )
185
        );
186
187
        $q->prepare()->execute();
188
189
        return $this->dbHandler->lastInsertId(
190
            $this->dbHandler->getSequenceName('ezcontentobject', 'id')
191
        );
192
    }
193
194
    /**
195
     * Generates a language mask for $fields.
196
     *
197
     * @param \eZ\Publish\SPI\Persistence\Content\Field[] $fields
198
     * @param string $initialLanguageCode
199
     * @param bool $isAlwaysAvailable
200
     *
201
     * @return int
202
     */
203
    protected function generateLanguageMask(array $fields, string $initialLanguageCode, bool $isAlwaysAvailable): int
204
    {
205
        $languages = [$initialLanguageCode => true];
206
        foreach ($fields as $field) {
207
            if (isset($languages[$field->languageCode])) {
208
                continue;
209
            }
210
211
            $languages[$field->languageCode] = true;
212
        }
213
214
        return $this->languageMaskGenerator->generateLanguageMaskFromLanguageCodes(array_keys($languages), $isAlwaysAvailable);
215
    }
216
217
    /**
218
     * Inserts a new version.
219
     *
220
     * @param \eZ\Publish\SPI\Persistence\Content\VersionInfo $versionInfo
221
     * @param \eZ\Publish\SPI\Persistence\Content\Field[] $fields
222
     *
223
     * @return int ID
224
     */
225
    public function insertVersion(VersionInfo $versionInfo, array $fields)
226
    {
227
        /** @var $q \eZ\Publish\Core\Persistence\Database\InsertQuery */
228
        $q = $this->dbHandler->createInsertQuery();
229
        $q->insertInto(
230
            $this->dbHandler->quoteTable('ezcontentobject_version')
231
        )->set(
232
            $this->dbHandler->quoteColumn('id'),
233
            $this->dbHandler->getAutoIncrementValue('ezcontentobject_version', 'id')
234
        )->set(
235
            $this->dbHandler->quoteColumn('version'),
236
            $q->bindValue($versionInfo->versionNo, null, \PDO::PARAM_INT)
237
        )->set(
238
            $this->dbHandler->quoteColumn('modified'),
239
            $q->bindValue($versionInfo->modificationDate, null, \PDO::PARAM_INT)
240
        )->set(
241
            $this->dbHandler->quoteColumn('creator_id'),
242
            $q->bindValue($versionInfo->creatorId, null, \PDO::PARAM_INT)
243
        )->set(
244
            $this->dbHandler->quoteColumn('created'),
245
            $q->bindValue($versionInfo->creationDate, null, \PDO::PARAM_INT)
246
        )->set(
247
            $this->dbHandler->quoteColumn('status'),
248
            $q->bindValue($versionInfo->status, null, \PDO::PARAM_INT)
249
        )->set(
250
            $this->dbHandler->quoteColumn('initial_language_id'),
251
            $q->bindValue(
252
                $this->languageHandler->loadByLanguageCode($versionInfo->initialLanguageCode)->id,
253
                null,
254
                \PDO::PARAM_INT
255
            )
256
        )->set(
257
            $this->dbHandler->quoteColumn('contentobject_id'),
258
            $q->bindValue($versionInfo->contentInfo->id, null, \PDO::PARAM_INT)
259
        )->set(
260
            // As described in field mapping document
261
            $this->dbHandler->quoteColumn('workflow_event_pos'),
262
            $q->bindValue(0, null, \PDO::PARAM_INT)
263
        )->set(
264
            $this->dbHandler->quoteColumn('language_mask'),
265
            $q->bindValue(
266
                $this->generateLanguageMask(
267
                    $fields,
268
                    $versionInfo->initialLanguageCode,
269
                    $versionInfo->contentInfo->alwaysAvailable
270
                ),
271
                null,
272
                \PDO::PARAM_INT
273
            )
274
        );
275
276
        $q->prepare()->execute();
277
278
        return $this->dbHandler->lastInsertId(
279
            $this->dbHandler->getSequenceName('ezcontentobject_version', 'id')
280
        );
281
    }
282
283
    /**
284
     * Updates an existing content identified by $contentId in respect to $struct.
285
     *
286
     * @param int $contentId
287
     * @param \eZ\Publish\SPI\Persistence\Content\MetadataUpdateStruct $struct
288
     * @param \eZ\Publish\SPI\Persistence\Content\VersionInfo $prePublishVersionInfo Provided on publish
289
     */
290
    public function updateContent($contentId, MetadataUpdateStruct $struct, VersionInfo $prePublishVersionInfo = null)
291
    {
292
        $q = $this->dbHandler->createUpdateQuery();
293
        $q->update($this->dbHandler->quoteTable('ezcontentobject'));
294
295
        if (isset($struct->name)) {
296
            $q->set(
297
                $this->dbHandler->quoteColumn('name'),
298
                $q->bindValue($struct->name, null, \PDO::PARAM_STR)
299
            );
300
        }
301
        if (isset($struct->mainLanguageId)) {
302
            $q->set(
303
                $this->dbHandler->quoteColumn('initial_language_id'),
304
                $q->bindValue($struct->mainLanguageId, null, \PDO::PARAM_INT)
305
            );
306
        }
307
        if (isset($struct->modificationDate)) {
308
            $q->set(
309
                $this->dbHandler->quoteColumn('modified'),
310
                $q->bindValue($struct->modificationDate, null, \PDO::PARAM_INT)
311
            );
312
        }
313
        if (isset($struct->ownerId)) {
314
            $q->set(
315
                $this->dbHandler->quoteColumn('owner_id'),
316
                $q->bindValue($struct->ownerId, null, \PDO::PARAM_INT)
317
            );
318
        }
319
        if (isset($struct->publicationDate)) {
320
            $q->set(
321
                $this->dbHandler->quoteColumn('published'),
322
                $q->bindValue($struct->publicationDate, null, \PDO::PARAM_INT)
323
            );
324
        }
325
        if (isset($struct->remoteId)) {
326
            $q->set(
327
                $this->dbHandler->quoteColumn('remote_id'),
328
                $q->bindValue($struct->remoteId, null, \PDO::PARAM_STR)
329
            );
330
        }
331
        if ($prePublishVersionInfo !== null) {
332
            $mask = $this->languageMaskGenerator->generateLanguageMaskFromLanguageCodes(
333
                $prePublishVersionInfo->languageCodes,
334
                $struct->alwaysAvailable ?? $prePublishVersionInfo->contentInfo->alwaysAvailable
335
            );
336
337
            $q->set(
338
                $this->dbHandler->quoteColumn('language_mask'),
339
                $q->bindValue($mask, null, \PDO::PARAM_INT)
340
            );
341
        }
342
        if (isset($struct->isHidden)) {
343
            $q->set(
344
                $this->dbHandler->quoteColumn('is_hidden'),
345
                $q->bindValue($struct->isHidden, null, \PDO::PARAM_BOOL)
346
            );
347
        }
348
        $q->where(
349
            $q->expr->eq(
350
                $this->dbHandler->quoteColumn('id'),
351
                $q->bindValue($contentId, null, \PDO::PARAM_INT)
352
            )
353
        );
354
        $q->prepare()->execute();
355
356
        // Handle alwaysAvailable flag update separately as it's a more complex task and has impact on several tables
357
        if (isset($struct->alwaysAvailable) || isset($struct->mainLanguageId)) {
358
            $this->updateAlwaysAvailableFlag($contentId, $struct->alwaysAvailable);
359
        }
360
    }
361
362
    /**
363
     * Updates version $versionNo for content identified by $contentId, in respect to $struct.
364
     *
365
     * @param int $contentId
366
     * @param int $versionNo
367
     * @param \eZ\Publish\SPI\Persistence\Content\UpdateStruct $struct
368
     */
369
    public function updateVersion($contentId, $versionNo, UpdateStruct $struct)
370
    {
371
        $q = $this->dbHandler->createUpdateQuery();
372
        $q->update(
373
            $this->dbHandler->quoteTable('ezcontentobject_version')
374
        )->set(
375
            $this->dbHandler->quoteColumn('creator_id'),
376
            $q->bindValue($struct->creatorId, null, \PDO::PARAM_INT)
377
        )->set(
378
            $this->dbHandler->quoteColumn('modified'),
379
            $q->bindValue($struct->modificationDate, null, \PDO::PARAM_INT)
380
        )->set(
381
            $this->dbHandler->quoteColumn('initial_language_id'),
382
            $q->bindValue($struct->initialLanguageId, null, \PDO::PARAM_INT)
383
        )->set(
384
            $this->dbHandler->quoteColumn('language_mask'),
385
            $q->expr->bitOr(
386
                $this->dbHandler->quoteColumn('language_mask'),
387
                $q->bindValue(
388
                    $this->generateLanguageMask(
389
                        $struct->fields,
390
                        $this->languageHandler->load($struct->initialLanguageId)->languageCode,
391
                        false
392
                    ),
393
                    null,
394
                    \PDO::PARAM_INT
395
                )
396
            )
397
        )->where(
398
            $q->expr->lAnd(
399
                $q->expr->eq(
400
                    $this->dbHandler->quoteColumn('contentobject_id'),
401
                    $q->bindValue($contentId, null, \PDO::PARAM_INT)
402
                ),
403
                $q->expr->eq(
404
                    $this->dbHandler->quoteColumn('version'),
405
                    $q->bindValue($versionNo, null, \PDO::PARAM_INT)
406
                )
407
            )
408
        );
409
        $q->prepare()->execute();
410
    }
411
412
    /**
413
     * Updates "always available" flag for Content identified by $contentId, in respect to
414
     * Content's current main language and optionally new $alwaysAvailable state.
415
     *
416
     * @param int $contentId
417
     * @param bool|null $alwaysAvailable New "always available" value or null if not defined
418
     */
419
    public function updateAlwaysAvailableFlag($contentId, $alwaysAvailable = null)
420
    {
421
        // We will need to know some info on the current language mask to update the flag
422
        // everywhere needed
423
        $contentInfoRow = $this->loadContentInfo($contentId);
424
        if (!isset($alwaysAvailable)) {
425
            $alwaysAvailable = (bool)$contentInfoRow['language_mask'] & 1;
426
        }
427
428
        /** @var $q \eZ\Publish\Core\Persistence\Database\UpdateQuery */
429
        $q = $this->dbHandler->createUpdateQuery();
430
        $q
431
            ->update($this->dbHandler->quoteTable('ezcontentobject'))
432
            ->set(
433
                $this->dbHandler->quoteColumn('language_mask'),
434
                $alwaysAvailable ?
435
                    $q->expr->bitOr($this->dbHandler->quoteColumn('language_mask'), 1) :
436
                    $q->expr->bitAnd($this->dbHandler->quoteColumn('language_mask'), -2)
437
            )
438
            ->where(
439
                $q->expr->eq(
440
                    $this->dbHandler->quoteColumn('id'),
441
                    $q->bindValue($contentId, null, \PDO::PARAM_INT)
442
                )
443
            );
444
        $q->prepare()->execute();
445
446
        // Now we need to update ezcontentobject_name
447
        /** @var $qName \eZ\Publish\Core\Persistence\Database\UpdateQuery */
448
        $qName = $this->dbHandler->createUpdateQuery();
449
        $qName
450
            ->update($this->dbHandler->quoteTable('ezcontentobject_name'))
451
            ->set(
452
                $this->dbHandler->quoteColumn('language_id'),
453
                $alwaysAvailable ?
454
                    $qName->expr->bitOr($this->dbHandler->quoteColumn('language_id'), 1) :
455
                    $qName->expr->bitAnd($this->dbHandler->quoteColumn('language_id'), -2)
456
            )
457
            ->where(
458
                $qName->expr->lAnd(
459
                    $qName->expr->eq(
460
                        $this->dbHandler->quoteColumn('contentobject_id'),
461
                        $qName->bindValue($contentId, null, \PDO::PARAM_INT)
462
                    ),
463
                    $qName->expr->eq(
464
                        $this->dbHandler->quoteColumn('content_version'),
465
                        $qName->bindValue(
466
                            $contentInfoRow['current_version'],
467
                            null,
468
                            \PDO::PARAM_INT
469
                        )
470
                    )
471
                )
472
            );
473
        $qName->prepare()->execute();
474
475
        // Now update ezcontentobject_attribute for current version
476
        // Create update query that will be reused
477
        /** @var $qAttr \eZ\Publish\Core\Persistence\Database\UpdateQuery */
478
        $qAttr = $this->dbHandler->createUpdateQuery();
479
        $qAttr
480
            ->update($this->dbHandler->quoteTable('ezcontentobject_attribute'))
481
            ->where(
482
                $qAttr->expr->lAnd(
483
                    $qAttr->expr->eq(
484
                        $this->dbHandler->quoteColumn('contentobject_id'),
485
                        $qAttr->bindValue($contentId, null, \PDO::PARAM_INT)
486
                    ),
487
                    $qAttr->expr->eq(
488
                        $this->dbHandler->quoteColumn('version'),
489
                        $qAttr->bindValue(
490
                            $contentInfoRow['current_version'],
491
                            null,
492
                            \PDO::PARAM_INT
493
                        )
494
                    )
495
                )
496
            );
497
498
        // If there is only a single language, update all fields and return
499
        if (!$this->languageMaskGenerator->isLanguageMaskComposite($contentInfoRow['language_mask'])) {
500
            $qAttr->set(
501
                $this->dbHandler->quoteColumn('language_id'),
502
                $alwaysAvailable ?
503
                    $qAttr->expr->bitOr($this->dbHandler->quoteColumn('language_id'), 1) :
504
                    $qAttr->expr->bitAnd($this->dbHandler->quoteColumn('language_id'), -2)
505
            );
506
            $qAttr->prepare()->execute();
507
508
            return;
509
        }
510
511
        // Otherwise:
512
        // 1. Remove always available flag on all fields
513
        $qAttr->set(
514
            $this->dbHandler->quoteColumn('language_id'),
515
            $qAttr->expr->bitAnd($this->dbHandler->quoteColumn('language_id'), -2)
516
        );
517
        $qAttr->prepare()->execute();
518
519
        // 2. If Content is always available set the flag only on fields in main language
520
        if ($alwaysAvailable) {
521
            $qAttr->set(
522
                $this->dbHandler->quoteColumn('language_id'),
523
                $qAttr->expr->bitOr($this->dbHandler->quoteColumn('language_id'), 1)
524
            );
525
            $qAttr->where(
526
                $qAttr->expr->gt(
527
                    $qAttr->expr->bitAnd(
528
                        $this->dbHandler->quoteColumn('language_id'),
529
                        $qAttr->bindValue($contentInfoRow['initial_language_id'], null, PDO::PARAM_INT)
530
                    ),
531
                    $qAttr->bindValue(0, null, PDO::PARAM_INT)
532
                )
533
            );
534
            $qAttr->prepare()->execute();
535
        }
536
    }
537
538
    /**
539
     * Sets the status of the version identified by $contentId and $version to $status.
540
     *
541
     * The $status can be one of STATUS_DRAFT, STATUS_PUBLISHED, STATUS_ARCHIVED
542
     *
543
     * @param int $contentId
544
     * @param int $version
545
     * @param int $status
546
     *
547
     * @return bool
548
     */
549
    public function setStatus($contentId, $version, $status)
550
    {
551
        $q = $this->dbHandler->createUpdateQuery();
552
        $q->update(
553
            $this->dbHandler->quoteTable('ezcontentobject_version')
554
        )->set(
555
            $this->dbHandler->quoteColumn('status'),
556
            $q->bindValue($status, null, \PDO::PARAM_INT)
557
        )->set(
558
            $this->dbHandler->quoteColumn('modified'),
559
            $q->bindValue(time(), null, \PDO::PARAM_INT)
560
        )->where(
561
            $q->expr->lAnd(
562
                $q->expr->eq(
563
                    $this->dbHandler->quoteColumn('contentobject_id'),
564
                    $q->bindValue($contentId, null, \PDO::PARAM_INT)
565
                ),
566
                $q->expr->eq(
567
                    $this->dbHandler->quoteColumn('version'),
568
                    $q->bindValue($version, null, \PDO::PARAM_INT)
569
                )
570
            )
571
        );
572
        $statement = $q->prepare();
573
        $statement->execute();
574
575
        if ((bool)$statement->rowCount() === false) {
576
            return false;
577
        }
578
579
        if ($status !== APIVersionInfo::STATUS_PUBLISHED) {
580
            return true;
581
        }
582
583
        // If the version's status is PUBLISHED, we set the content to published status as well
584
        $q = $this->dbHandler->createUpdateQuery();
585
        $q->update(
586
            $this->dbHandler->quoteTable('ezcontentobject')
587
        )->set(
588
            $this->dbHandler->quoteColumn('status'),
589
            $q->bindValue(ContentInfo::STATUS_PUBLISHED, null, \PDO::PARAM_INT)
590
        )->set(
591
            $this->dbHandler->quoteColumn('current_version'),
592
            $q->bindValue($version, null, \PDO::PARAM_INT)
593
        )->where(
594
            $q->expr->eq(
595
                $this->dbHandler->quoteColumn('id'),
596
                $q->bindValue($contentId, null, \PDO::PARAM_INT)
597
            )
598
        );
599
        $statement = $q->prepare();
600
        $statement->execute();
601
602
        return (bool)$statement->rowCount();
603
    }
604
605
    /**
606
     * Inserts a new field.
607
     *
608
     * Only used when a new field is created (i.e. a new object or a field in a
609
     * new language!). After that, field IDs need to stay the same, only the
610
     * version number changes.
611
     *
612
     * @param \eZ\Publish\SPI\Persistence\Content $content
613
     * @param \eZ\Publish\SPI\Persistence\Content\Field $field
614
     * @param \eZ\Publish\Core\Persistence\Legacy\Content\StorageFieldValue $value
615
     *
616
     * @return int ID
617
     */
618
    public function insertNewField(Content $content, Field $field, StorageFieldValue $value)
619
    {
620
        $q = $this->dbHandler->createInsertQuery();
621
622
        $this->setInsertFieldValues($q, $content, $field, $value);
623
624
        // Insert with auto increment ID
625
        $q->set(
626
            $this->dbHandler->quoteColumn('id'),
627
            $this->dbHandler->getAutoIncrementValue('ezcontentobject_attribute', 'id')
628
        );
629
630
        $q->prepare()->execute();
631
632
        return $this->dbHandler->lastInsertId(
633
            $this->dbHandler->getSequenceName('ezcontentobject_attribute', 'id')
634
        );
635
    }
636
637
    /**
638
     * Inserts an existing field.
639
     *
640
     * Used to insert a field with an exsting ID but a new version number.
641
     *
642
     * @param Content $content
643
     * @param Field $field
644
     * @param StorageFieldValue $value
645
     */
646
    public function insertExistingField(Content $content, Field $field, StorageFieldValue $value)
647
    {
648
        $q = $this->dbHandler->createInsertQuery();
649
650
        $this->setInsertFieldValues($q, $content, $field, $value);
651
652
        $q->set(
653
            $this->dbHandler->quoteColumn('id'),
654
            $q->bindValue($field->id, null, \PDO::PARAM_INT)
655
        );
656
657
        $q->prepare()->execute();
658
    }
659
660
    /**
661
     * Sets field (ezcontentobject_attribute) values to the given query.
662
     *
663
     * @param \eZ\Publish\Core\Persistence\Database\InsertQuery $q
664
     * @param Content $content
665
     * @param Field $field
666
     * @param StorageFieldValue $value
667
     */
668
    protected function setInsertFieldValues(InsertQuery $q, Content $content, Field $field, StorageFieldValue $value)
669
    {
670
        $q->insertInto(
671
            $this->dbHandler->quoteTable('ezcontentobject_attribute')
672
        )->set(
673
            $this->dbHandler->quoteColumn('contentobject_id'),
674
            $q->bindValue($content->versionInfo->contentInfo->id, null, \PDO::PARAM_INT)
675
        )->set(
676
            $this->dbHandler->quoteColumn('contentclassattribute_id'),
677
            $q->bindValue($field->fieldDefinitionId, null, \PDO::PARAM_INT)
678
        )->set(
679
            $this->dbHandler->quoteColumn('data_type_string'),
680
            $q->bindValue($field->type)
681
        )->set(
682
            $this->dbHandler->quoteColumn('language_code'),
683
            $q->bindValue($field->languageCode)
684
        )->set(
685
            $this->dbHandler->quoteColumn('version'),
686
            $q->bindValue($field->versionNo, null, \PDO::PARAM_INT)
687
        )->set(
688
            $this->dbHandler->quoteColumn('data_float'),
689
            $q->bindValue($value->dataFloat)
690
        )->set(
691
            $this->dbHandler->quoteColumn('data_int'),
692
            $q->bindValue($value->dataInt, null, \PDO::PARAM_INT)
693
        )->set(
694
            $this->dbHandler->quoteColumn('data_text'),
695
            $q->bindValue($value->dataText)
696
        )->set(
697
            $this->dbHandler->quoteColumn('sort_key_int'),
698
            $q->bindValue($value->sortKeyInt, null, \PDO::PARAM_INT)
699
        )->set(
700
            $this->dbHandler->quoteColumn('sort_key_string'),
701
            $q->bindValue(mb_substr($value->sortKeyString, 0, 255))
702
        )->set(
703
            $this->dbHandler->quoteColumn('language_id'),
704
            $q->bindValue(
705
                $this->languageMaskGenerator->generateLanguageIndicator(
706
                    $field->languageCode,
707
                    $this->isLanguageAlwaysAvailable($content, $field->languageCode)
708
                ),
709
                null,
710
                \PDO::PARAM_INT
711
            )
712
        );
713
    }
714
715
    /**
716
     * Checks if $languageCode is always available in $content.
717
     *
718
     * @param \eZ\Publish\SPI\Persistence\Content $content
719
     * @param string $languageCode
720
     *
721
     * @return bool
722
     */
723
    protected function isLanguageAlwaysAvailable(Content $content, $languageCode)
724
    {
725
        return
726
            $content->versionInfo->contentInfo->alwaysAvailable &&
727
            $content->versionInfo->contentInfo->mainLanguageCode === $languageCode
728
        ;
729
    }
730
731
    /**
732
     * Updates an existing field.
733
     *
734
     * @param Field $field
735
     * @param StorageFieldValue $value
736
     */
737
    public function updateField(Field $field, StorageFieldValue $value)
738
    {
739
        // Note, no need to care for language_id here, since Content->$alwaysAvailable
740
        // cannot change on update
741
        $q = $this->dbHandler->createUpdateQuery();
742
        $this->setFieldUpdateValues($q, $value);
743
        $q->where(
744
            $q->expr->lAnd(
745
                $q->expr->eq(
746
                    $this->dbHandler->quoteColumn('id'),
747
                    $q->bindValue($field->id, null, \PDO::PARAM_INT)
748
                ),
749
                $q->expr->eq(
750
                    $this->dbHandler->quoteColumn('version'),
751
                    $q->bindValue($field->versionNo, null, \PDO::PARAM_INT)
752
                )
753
            )
754
        );
755
        $q->prepare()->execute();
756
    }
757
758
    /**
759
     * Sets update fields for $value on $q.
760
     *
761
     * @param \eZ\Publish\Core\Persistence\Database\UpdateQuery $q
762
     * @param StorageFieldValue $value
763
     */
764
    protected function setFieldUpdateValues(UpdateQuery $q, StorageFieldValue $value)
765
    {
766
        $q->update(
767
            $this->dbHandler->quoteTable('ezcontentobject_attribute')
768
        )->set(
769
            $this->dbHandler->quoteColumn('data_float'),
770
            $q->bindValue($value->dataFloat)
771
        )->set(
772
            $this->dbHandler->quoteColumn('data_int'),
773
            $q->bindValue($value->dataInt, null, \PDO::PARAM_INT)
774
        )->set(
775
            $this->dbHandler->quoteColumn('data_text'),
776
            $q->bindValue($value->dataText)
777
        )->set(
778
            $this->dbHandler->quoteColumn('sort_key_int'),
779
            $q->bindValue($value->sortKeyInt, null, \PDO::PARAM_INT)
780
        )->set(
781
            $this->dbHandler->quoteColumn('sort_key_string'),
782
            $q->bindValue(mb_substr($value->sortKeyString, 0, 255))
783
        );
784
    }
785
786
    /**
787
     * Updates an existing, non-translatable field.
788
     *
789
     * @param \eZ\Publish\SPI\Persistence\Content\Field $field
790
     * @param \eZ\Publish\Core\Persistence\Legacy\Content\StorageFieldValue $value
791
     * @param int $contentId
792
     */
793
    public function updateNonTranslatableField(
794
        Field $field,
795
        StorageFieldValue $value,
796
        $contentId
797
    ) {
798
        // Note, no need to care for language_id here, since Content->$alwaysAvailable
799
        // cannot change on update
800
        $q = $this->dbHandler->createUpdateQuery();
801
        $this->setFieldUpdateValues($q, $value);
802
        $q->where(
803
            $q->expr->lAnd(
804
                $q->expr->eq(
805
                    $this->dbHandler->quoteColumn('contentclassattribute_id'),
806
                    $q->bindValue($field->fieldDefinitionId, null, \PDO::PARAM_INT)
807
                ),
808
                $q->expr->eq(
809
                    $this->dbHandler->quoteColumn('contentobject_id'),
810
                    $q->bindValue($contentId, null, \PDO::PARAM_INT)
811
                ),
812
                $q->expr->eq(
813
                    $this->dbHandler->quoteColumn('version'),
814
                    $q->bindValue($field->versionNo, null, \PDO::PARAM_INT)
815
                )
816
            )
817
        );
818
        $q->prepare()->execute();
819
    }
820
821
    /**
822
     * {@inheritdoc}
823
     */
824
    public function load($contentId, $version = null, array $translations = null)
825
    {
826
        return $this->internalLoadContent([$contentId], $version, $translations);
0 ignored issues
show
Bug introduced by
It seems like $translations defined by parameter $translations on line 824 can also be of type array; however, eZ\Publish\Core\Persiste...::internalLoadContent() does only seem to accept null|array<integer,string>, maybe add an additional type check?

This check looks at variables that have been passed in as parameters and are passed out again to other methods.

If the outgoing method call has stricter type requirements than the method itself, an issue is raised.

An additional type check may prevent trouble.

Loading history...
827
    }
828
829
    /**
830
     * {@inheritdoc}
831
     */
832
    public function loadContentList(array $contentIds, array $translations = null): array
833
    {
834
        return $this->internalLoadContent($contentIds, null, $translations);
0 ignored issues
show
Bug introduced by
It seems like $translations defined by parameter $translations on line 832 can also be of type array; however, eZ\Publish\Core\Persiste...::internalLoadContent() does only seem to accept null|array<integer,string>, maybe add an additional type check?

This check looks at variables that have been passed in as parameters and are passed out again to other methods.

If the outgoing method call has stricter type requirements than the method itself, an issue is raised.

An additional type check may prevent trouble.

Loading history...
835
    }
836
837
    /**
838
     * @see load(), loadContentList()
839
     *
840
     * @param array $contentIds
841
     * @param int|null $version
842
     * @param string[]|null $translations
843
     *
844
     * @return array
845
     */
846
    private function internalLoadContent(array $contentIds, int $version = null, array $translations = null): array
847
    {
848
        $queryBuilder = $this->connection->createQueryBuilder();
849
        $expr = $queryBuilder->expr();
850
        $queryBuilder
851
            ->select(
852
                'c.id AS ezcontentobject_id',
853
                'c.contentclass_id AS ezcontentobject_contentclass_id',
854
                'c.section_id AS ezcontentobject_section_id',
855
                'c.owner_id AS ezcontentobject_owner_id',
856
                'c.remote_id AS ezcontentobject_remote_id',
857
                'c.current_version AS ezcontentobject_current_version',
858
                'c.initial_language_id AS ezcontentobject_initial_language_id',
859
                'c.modified AS ezcontentobject_modified',
860
                'c.published AS ezcontentobject_published',
861
                'c.status AS ezcontentobject_status',
862
                'c.name AS ezcontentobject_name',
863
                'c.language_mask AS ezcontentobject_language_mask',
864
                'c.is_hidden AS ezcontentobject_is_hidden',
865
                'v.id AS ezcontentobject_version_id',
866
                'v.version AS ezcontentobject_version_version',
867
                'v.modified AS ezcontentobject_version_modified',
868
                'v.creator_id AS ezcontentobject_version_creator_id',
869
                'v.created AS ezcontentobject_version_created',
870
                'v.status AS ezcontentobject_version_status',
871
                'v.language_mask AS ezcontentobject_version_language_mask',
872
                'v.initial_language_id AS ezcontentobject_version_initial_language_id',
873
                'a.id AS ezcontentobject_attribute_id',
874
                'a.contentclassattribute_id AS ezcontentobject_attribute_contentclassattribute_id',
875
                'a.data_type_string AS ezcontentobject_attribute_data_type_string',
876
                'a.language_code AS ezcontentobject_attribute_language_code',
877
                'a.language_id AS ezcontentobject_attribute_language_id',
878
                'a.data_float AS ezcontentobject_attribute_data_float',
879
                'a.data_int AS ezcontentobject_attribute_data_int',
880
                'a.data_text AS ezcontentobject_attribute_data_text',
881
                'a.sort_key_int AS ezcontentobject_attribute_sort_key_int',
882
                'a.sort_key_string AS ezcontentobject_attribute_sort_key_string',
883
                't.main_node_id AS ezcontentobject_tree_main_node_id'
884
            )
885
            ->from('ezcontentobject', 'c')
886
            ->innerJoin(
887
                'c',
888
                'ezcontentobject_version',
889
                'v',
890
                $expr->andX(
891
                    $expr->eq('c.id', 'v.contentobject_id'),
892
                    $expr->eq('v.version', $version ?? 'c.current_version')
893
                )
894
            )
895
            ->innerJoin(
896
                'v',
897
                'ezcontentobject_attribute',
898
                'a',
899
                $expr->andX(
900
                    $expr->eq('v.contentobject_id', 'a.contentobject_id'),
901
                    $expr->eq('v.version', 'a.version')
902
                )
903
            )
904
            ->leftJoin(
905
                'c',
906
                'ezcontentobject_tree',
907
                't',
908
                $expr->andX(
909
                    $expr->eq('c.id', 't.contentobject_id'),
910
                    $expr->eq('t.node_id', 't.main_node_id')
911
                )
912
            );
913
914
        $queryBuilder->where(
915
            $expr->in(
916
                'c.id',
917
                $queryBuilder->createNamedParameter($contentIds, Connection::PARAM_INT_ARRAY)
918
            )
919
        );
920
921
        if (!empty($translations)) {
922
            $queryBuilder->andWhere(
923
                $expr->in(
924
                    'a.language_code',
925
                    $queryBuilder->createNamedParameter($translations, Connection::PARAM_STR_ARRAY)
926
                )
927
            );
928
        }
929
930
        return $queryBuilder->execute()->fetchAll(FetchMode::ASSOCIATIVE);
931
    }
932
933
    /**
934
     * Get query builder to load Content Info data.
935
     *
936
     * @see loadContentInfo(), loadContentInfoByRemoteId(), loadContentInfoList(), loadContentInfoByLocationId()
937
     *
938
     * @param bool $joinMainLocation
939
     *
940
     * @return \Doctrine\DBAL\Query\QueryBuilder
941
     */
942
    private function createLoadContentInfoQueryBuilder(bool $joinMainLocation = true): DoctrineQueryBuilder
943
    {
944
        $queryBuilder = $this->connection->createQueryBuilder();
945
        $expr = $queryBuilder->expr();
946
947
        $joinCondition = $expr->eq('c.id', 't.contentobject_id');
948
        if ($joinMainLocation) {
949
            // wrap join condition with AND operator and join by a Main Location
950
            $joinCondition = $expr->andX(
951
                $joinCondition,
952
                $expr->eq('t.node_id', 't.main_node_id')
953
            );
954
        }
955
956
        $queryBuilder
957
            ->select('c.*', 't.main_node_id AS ezcontentobject_tree_main_node_id')
958
            ->from('ezcontentobject', 'c')
959
            ->leftJoin(
960
                'c',
961
                'ezcontentobject_tree',
962
                't',
963
                $joinCondition
0 ignored issues
show
Bug introduced by
It seems like $joinCondition defined by $expr->andX($joinConditi...id', 't.main_node_id')) on line 950 can also be of type object<Doctrine\DBAL\Que...on\CompositeExpression>; however, Doctrine\DBAL\Query\QueryBuilder::leftJoin() does only seem to accept string|null, maybe add an additional type check?

If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:

/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.

Loading history...
964
            );
965
966
        return $queryBuilder;
967
    }
968
969
    /**
970
     * Loads info for content identified by $contentId.
971
     * Will basically return a hash containing all field values for ezcontentobject table plus some additional keys:
972
     *  - always_available => Boolean indicating if content's language mask contains alwaysAvailable bit field
973
     *  - main_language_code => Language code for main (initial) language. E.g. "eng-GB".
974
     *
975
     * @param int $contentId
976
     *
977
     * @throws \eZ\Publish\Core\Base\Exceptions\NotFoundException
978
     *
979
     * @return array
980
     */
981
    public function loadContentInfo($contentId)
982
    {
983
        $queryBuilder = $this->createLoadContentInfoQueryBuilder();
984
        $queryBuilder
985
            ->where('c.id = :id')
986
            ->setParameter('id', $contentId, ParameterType::INTEGER);
987
988
        $results = $queryBuilder->execute()->fetchAll(FetchMode::ASSOCIATIVE);
989
        if (empty($results)) {
990
            throw new NotFound('content', "id: $contentId");
991
        }
992
993
        return $results[0];
994
    }
995
996
    public function loadContentInfoList(array $contentIds)
997
    {
998
        $queryBuilder = $this->createLoadContentInfoQueryBuilder();
999
        $queryBuilder
1000
            ->where('c.id IN (:ids)')
1001
            ->setParameter('ids', $contentIds, Connection::PARAM_INT_ARRAY);
1002
1003
        return $queryBuilder->execute()->fetchAll(FetchMode::ASSOCIATIVE);
1004
    }
1005
1006
    /**
1007
     * Loads info for a content object identified by its remote ID.
1008
     *
1009
     * Returns an array with the relevant data.
1010
     *
1011
     * @param mixed $remoteId
1012
     *
1013
     * @throws \eZ\Publish\Core\Base\Exceptions\NotFoundException
1014
     *
1015
     * @return array
1016
     */
1017
    public function loadContentInfoByRemoteId($remoteId)
1018
    {
1019
        $queryBuilder = $this->createLoadContentInfoQueryBuilder();
1020
        $queryBuilder
1021
            ->where('c.remote_id = :id')
1022
            ->setParameter('id', $remoteId, ParameterType::STRING);
1023
1024
        $results = $queryBuilder->execute()->fetchAll(FetchMode::ASSOCIATIVE);
1025
        if (empty($results)) {
1026
            throw new NotFound('content', "remote_id: $remoteId");
1027
        }
1028
1029
        return $results[0];
1030
    }
1031
1032
    /**
1033
     * Loads info for a content object identified by its location ID (node ID).
1034
     *
1035
     * Returns an array with the relevant data.
1036
     *
1037
     * @param int $locationId
1038
     *
1039
     * @throws \eZ\Publish\Core\Base\Exceptions\NotFoundException
1040
     *
1041
     * @return array
1042
     */
1043
    public function loadContentInfoByLocationId($locationId)
1044
    {
1045
        $queryBuilder = $this->createLoadContentInfoQueryBuilder(false);
1046
        $queryBuilder
1047
            ->where('t.node_id = :id')
1048
            ->setParameter('id', $locationId, ParameterType::INTEGER);
1049
1050
        $results = $queryBuilder->execute()->fetchAll(FetchMode::ASSOCIATIVE);
1051
        if (empty($results)) {
1052
            throw new NotFound('content', "node_id: $locationId");
1053
        }
1054
1055
        return $results[0];
1056
    }
1057
1058
    /**
1059
     * Loads version info for content identified by $contentId and $versionNo.
1060
     * Will basically return a hash containing all field values from ezcontentobject_version table plus following keys:
1061
     *  - names => Hash of content object names. Key is the language code, value is the name.
1062
     *  - languages => Hash of language ids. Key is the language code (e.g. "eng-GB"), value is the language numeric id without the always available bit.
1063
     *  - initial_language_code => Language code for initial language in this version.
1064
     *
1065
     * @param int $contentId
1066
     * @param int|null $versionNo
1067
     *
1068
     * @return array
1069
     */
1070
    public function loadVersionInfo($contentId, $versionNo = null)
1071
    {
1072
        $queryBuilder = $this->queryBuilder->createVersionInfoQueryBuilder($versionNo);
1073
        $queryBuilder->where(
1074
            $queryBuilder->expr()->eq(
1075
                'c.id',
1076
                $queryBuilder->createNamedParameter($contentId, PDO::PARAM_INT)
1077
            )
1078
        );
1079
1080
        return $queryBuilder->execute()->fetchAll(PDO::FETCH_ASSOC);
1081
    }
1082
1083
    /**
1084
     * Returns data for all versions with given status created by the given $userId.
1085
     *
1086
     * @param int $userId
1087
     * @param int $status
1088
     *
1089
     * @return string[][]
1090
     */
1091
    public function listVersionsForUser($userId, $status = VersionInfo::STATUS_DRAFT)
1092
    {
1093
        $query = $this->queryBuilder->createVersionInfoFindQuery();
0 ignored issues
show
Deprecated Code introduced by
The method eZ\Publish\Core\Persiste...eVersionInfoFindQuery() has been deprecated with message: Move to Doctrine based query builder {@see createVersionInfoQueryBuilder}.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead.

Loading history...
1094
        $query->where(
1095
            $query->expr->lAnd(
1096
                $query->expr->eq(
1097
                    $this->dbHandler->quoteColumn('status', 'ezcontentobject_version'),
1098
                    $query->bindValue($status, null, \PDO::PARAM_INT)
1099
                ),
1100
                $query->expr->eq(
1101
                    $this->dbHandler->quoteColumn('creator_id', 'ezcontentobject_version'),
1102
                    $query->bindValue($userId, null, \PDO::PARAM_INT)
1103
                )
1104
            )
1105
        );
1106
1107
        return $this->listVersionsHelper($query);
1108
    }
1109
1110
    /**
1111
     * Returns all version data for the given $contentId, optionally filtered by status.
1112
     *
1113
     * Result is returned with oldest version first (using version id as it has index and is auto increment).
1114
     *
1115
     * @param mixed $contentId
1116
     * @param mixed|null $status Optional argument to filter versions by status, like {@see VersionInfo::STATUS_ARCHIVED}.
1117
     * @param int $limit Limit for items returned, -1 means none.
1118
     *
1119
     * @return string[][]
1120
     */
1121
    public function listVersions($contentId, $status = null, $limit = -1)
1122
    {
1123
        $query = $this->queryBuilder->createVersionInfoFindQuery();
0 ignored issues
show
Deprecated Code introduced by
The method eZ\Publish\Core\Persiste...eVersionInfoFindQuery() has been deprecated with message: Move to Doctrine based query builder {@see createVersionInfoQueryBuilder}.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead.

Loading history...
1124
1125
        $filter = $query->expr->eq(
1126
            $this->dbHandler->quoteColumn('contentobject_id', 'ezcontentobject_version'),
1127
            $query->bindValue($contentId, null, \PDO::PARAM_INT)
1128
        );
1129
1130
        if ($status !== null) {
1131
            $filter = $query->expr->lAnd(
1132
                $filter,
1133
                $query->expr->eq(
1134
                    $this->dbHandler->quoteColumn('status', 'ezcontentobject_version'),
1135
                    $query->bindValue($status, null, \PDO::PARAM_INT)
1136
                )
1137
            );
1138
        }
1139
1140
        $query->where($filter);
1141
1142
        if ($limit > 0) {
1143
            $query->limit($limit);
1144
        }
1145
1146
        return $this->listVersionsHelper($query);
1147
    }
1148
1149
    /**
1150
     * Helper for {@see listVersions()} and {@see listVersionsForUser()} that filters duplicates
1151
     * that are the result of the cartesian product performed by createVersionInfoFindQuery().
1152
     *
1153
     * @param \eZ\Publish\Core\Persistence\Database\SelectQuery $query
1154
     *
1155
     * @return string[][]
1156
     */
1157
    private function listVersionsHelper(SelectQuery $query)
1158
    {
1159
        $query->orderBy(
1160
            $this->dbHandler->quoteColumn('id', 'ezcontentobject_version')
1161
        );
1162
1163
        $statement = $query->prepare();
1164
        $statement->execute();
1165
1166
        $results = [];
1167
        $previousId = null;
1168
        foreach ($statement->fetchAll(\PDO::FETCH_ASSOC) as $row) {
1169
            if ($row['ezcontentobject_version_id'] == $previousId) {
1170
                continue;
1171
            }
1172
1173
            $previousId = $row['ezcontentobject_version_id'];
1174
            $results[] = $row;
1175
        }
1176
1177
        return $results;
1178
    }
1179
1180
    /**
1181
     * Returns all version numbers for the given $contentId.
1182
     *
1183
     * @param mixed $contentId
1184
     *
1185
     * @return int[]
1186
     */
1187
    public function listVersionNumbers($contentId)
1188
    {
1189
        $query = $this->dbHandler->createSelectQuery();
1190
        $query->selectDistinct(
1191
            $this->dbHandler->quoteColumn('version')
1192
        )->from(
1193
            $this->dbHandler->quoteTable('ezcontentobject_version')
1194
        )->where(
1195
            $query->expr->eq(
1196
                $this->dbHandler->quoteColumn('contentobject_id'),
1197
                $query->bindValue($contentId, null, \PDO::PARAM_INT)
1198
            )
1199
        );
1200
1201
        $statement = $query->prepare();
1202
        $statement->execute();
1203
1204
        return $statement->fetchAll(\PDO::FETCH_COLUMN);
1205
    }
1206
1207
    /**
1208
     * Returns last version number for content identified by $contentId.
1209
     *
1210
     * @param int $contentId
1211
     *
1212
     * @return int
1213
     */
1214
    public function getLastVersionNumber($contentId)
1215
    {
1216
        $query = $this->dbHandler->createSelectQuery();
1217
        $query->select(
1218
            $query->expr->max($this->dbHandler->quoteColumn('version'))
1219
        )->from(
1220
            $this->dbHandler->quoteTable('ezcontentobject_version')
1221
        )->where(
1222
            $query->expr->eq(
1223
                $this->dbHandler->quoteColumn('contentobject_id'),
1224
                $query->bindValue($contentId, null, \PDO::PARAM_INT)
1225
            )
1226
        );
1227
1228
        $statement = $query->prepare();
1229
        $statement->execute();
1230
1231
        return (int)$statement->fetchColumn();
1232
    }
1233
1234
    /**
1235
     * Returns all IDs for locations that refer to $contentId.
1236
     *
1237
     * @param int $contentId
1238
     *
1239
     * @return int[]
1240
     */
1241
    public function getAllLocationIds($contentId)
1242
    {
1243
        $query = $this->dbHandler->createSelectQuery();
1244
        $query->select(
1245
            $this->dbHandler->quoteColumn('node_id')
1246
        )->from(
1247
            $this->dbHandler->quoteTable('ezcontentobject_tree')
1248
        )->where(
1249
            $query->expr->eq(
1250
                $this->dbHandler->quoteColumn('contentobject_id'),
1251
                $query->bindValue($contentId, null, \PDO::PARAM_INT)
1252
            )
1253
        );
1254
1255
        $statement = $query->prepare();
1256
        $statement->execute();
1257
1258
        return $statement->fetchAll(\PDO::FETCH_COLUMN);
1259
    }
1260
1261
    /**
1262
     * Returns all field IDs of $contentId grouped by their type.
1263
     * If $versionNo is set only field IDs for that version are returned.
1264
     * If $languageCode is set, only field IDs for that language are returned.
1265
     *
1266
     * @param int $contentId
1267
     * @param int|null $versionNo
1268
     * @param string|null $languageCode
1269
     *
1270
     * @return int[][]
1271
     */
1272
    public function getFieldIdsByType($contentId, $versionNo = null, $languageCode = null)
1273
    {
1274
        $query = $this->dbHandler->createSelectQuery();
1275
        $query->select(
1276
            $this->dbHandler->quoteColumn('id'),
1277
            $this->dbHandler->quoteColumn('data_type_string')
1278
        )->from(
1279
            $this->dbHandler->quoteTable('ezcontentobject_attribute')
1280
        )->where(
1281
            $query->expr->eq(
1282
                $this->dbHandler->quoteColumn('contentobject_id'),
1283
                $query->bindValue($contentId, null, \PDO::PARAM_INT)
1284
            )
1285
        );
1286
1287
        if (isset($versionNo)) {
1288
            $query->where(
1289
                $query->expr->eq(
1290
                    $this->dbHandler->quoteColumn('version'),
1291
                    $query->bindValue($versionNo, null, \PDO::PARAM_INT)
1292
                )
1293
            );
1294
        }
1295
1296
        if (isset($languageCode)) {
1297
            $query->where(
1298
                $query->expr->eq(
1299
                    $this->dbHandler->quoteColumn('language_code'),
1300
                    $query->bindValue($languageCode, null, \PDO::PARAM_STR)
1301
                )
1302
            );
1303
        }
1304
1305
        $statement = $query->prepare();
1306
        $statement->execute();
1307
1308
        $result = [];
1309
        foreach ($statement->fetchAll() as $row) {
1310
            if (!isset($result[$row['data_type_string']])) {
1311
                $result[$row['data_type_string']] = [];
1312
            }
1313
            $result[$row['data_type_string']][] = (int)$row['id'];
1314
        }
1315
1316
        return $result;
1317
    }
1318
1319
    /**
1320
     * Deletes relations to and from $contentId.
1321
     * If $versionNo is set only relations for that version are deleted.
1322
     *
1323
     * @param int $contentId
1324
     * @param int|null $versionNo
1325
     */
1326
    public function deleteRelations($contentId, $versionNo = null)
1327
    {
1328
        $query = $this->dbHandler->createDeleteQuery();
1329
        $query->deleteFrom(
1330
            $this->dbHandler->quoteTable('ezcontentobject_link')
1331
        );
1332
1333
        if (isset($versionNo)) {
1334
            $query->where(
1335
                $query->expr->lAnd(
1336
                    $query->expr->eq(
1337
                        $this->dbHandler->quoteColumn('from_contentobject_id'),
1338
                        $query->bindValue($contentId, null, \PDO::PARAM_INT)
1339
                    ),
1340
                    $query->expr->eq(
1341
                        $this->dbHandler->quoteColumn('from_contentobject_version'),
1342
                        $query->bindValue($versionNo, null, \PDO::PARAM_INT)
1343
                    )
1344
                )
1345
            );
1346
        } else {
1347
            $query->where(
1348
                $query->expr->lOr(
1349
                    $query->expr->eq(
1350
                        $this->dbHandler->quoteColumn('from_contentobject_id'),
1351
                        $query->bindValue($contentId, null, \PDO::PARAM_INT)
1352
                    ),
1353
                    $query->expr->eq(
1354
                        $this->dbHandler->quoteColumn('to_contentobject_id'),
1355
                        $query->bindValue($contentId, null, \PDO::PARAM_INT)
1356
                    )
1357
                )
1358
            );
1359
        }
1360
1361
        $query->prepare()->execute();
1362
    }
1363
1364
    /**
1365
     * Removes relations to Content with $contentId from Relation and RelationList field type fields.
1366
     *
1367
     * @param int $contentId
1368
     */
1369
    public function removeReverseFieldRelations($contentId)
1370
    {
1371
        $query = $this->dbHandler->createSelectQuery();
1372
        $query
1373
            ->select('ezcontentobject_attribute.*')
1374
            ->from('ezcontentobject_attribute')
1375
            ->innerJoin(
1376
                'ezcontentobject_link',
1377
                $query->expr->lAnd(
1378
                    $query->expr->eq(
1379
                        $this->dbHandler->quoteColumn('from_contentobject_id', 'ezcontentobject_link'),
1380
                        $this->dbHandler->quoteColumn('contentobject_id', 'ezcontentobject_attribute')
1381
                    ),
1382
                    $query->expr->eq(
1383
                        $this->dbHandler->quoteColumn('from_contentobject_version', 'ezcontentobject_link'),
1384
                        $this->dbHandler->quoteColumn('version', 'ezcontentobject_attribute')
1385
                    ),
1386
                    $query->expr->eq(
1387
                        $this->dbHandler->quoteColumn('contentclassattribute_id', 'ezcontentobject_link'),
1388
                        $this->dbHandler->quoteColumn('contentclassattribute_id', 'ezcontentobject_attribute')
1389
                    )
1390
                )
1391
            )
1392
            ->where(
1393
                $query->expr->eq(
1394
                    $this->dbHandler->quoteColumn('to_contentobject_id', 'ezcontentobject_link'),
1395
                    $query->bindValue($contentId, null, PDO::PARAM_INT)
1396
                ),
1397
                $query->expr->gt(
1398
                    $query->expr->bitAnd(
1399
                        $this->dbHandler->quoteColumn('relation_type', 'ezcontentobject_link'),
1400
                        $query->bindValue(8, null, PDO::PARAM_INT)
1401
                    ),
1402
                    0
1403
                )
1404
            );
1405
1406
        $statement = $query->prepare();
1407
        $statement->execute();
1408
1409
        while ($row = $statement->fetch(PDO::FETCH_ASSOC)) {
1410
            if ($row['data_type_string'] === 'ezobjectrelation') {
1411
                $this->removeRelationFromRelationField($row);
1412
            }
1413
1414
            if ($row['data_type_string'] === 'ezobjectrelationlist') {
1415
                $this->removeRelationFromRelationListField($contentId, $row);
1416
            }
1417
        }
1418
    }
1419
1420
    /**
1421
     * Updates field value of RelationList field type identified by given $row data,
1422
     * removing relations toward given $contentId.
1423
     *
1424
     * @param int $contentId
1425
     * @param array $row
1426
     */
1427
    protected function removeRelationFromRelationListField($contentId, array $row)
1428
    {
1429
        $document = new DOMDocument('1.0', 'utf-8');
1430
        $document->loadXML($row['data_text']);
1431
1432
        $xpath = new DOMXPath($document);
1433
        $xpathExpression = "//related-objects/relation-list/relation-item[@contentobject-id='{$contentId}']";
1434
1435
        $relationItems = $xpath->query($xpathExpression);
1436
        foreach ($relationItems as $relationItem) {
1437
            $relationItem->parentNode->removeChild($relationItem);
1438
        }
1439
1440
        $query = $this->dbHandler->createUpdateQuery();
1441
        $query
1442
            ->update('ezcontentobject_attribute')
1443
            ->set(
1444
                'data_text',
1445
                $query->bindValue($document->saveXML(), null, PDO::PARAM_STR)
1446
            )
1447
            ->where(
1448
                $query->expr->lAnd(
1449
                    $query->expr->eq(
1450
                        $this->dbHandler->quoteColumn('id'),
1451
                        $query->bindValue($row['id'], null, PDO::PARAM_INT)
1452
                    ),
1453
                    $query->expr->eq(
1454
                        $this->dbHandler->quoteColumn('version'),
1455
                        $query->bindValue($row['version'], null, PDO::PARAM_INT)
1456
                    )
1457
                )
1458
            );
1459
1460
        $query->prepare()->execute();
1461
    }
1462
1463
    /**
1464
     * Updates field value of Relation field type identified by given $row data,
1465
     * removing relation data.
1466
     *
1467
     * @param array $row
1468
     */
1469
    protected function removeRelationFromRelationField(array $row)
1470
    {
1471
        $query = $this->dbHandler->createUpdateQuery();
1472
        $query
1473
            ->update('ezcontentobject_attribute')
1474
            ->set('data_int', $query->bindValue(null, null, PDO::PARAM_INT))
1475
            ->set('sort_key_int', $query->bindValue(0, null, PDO::PARAM_INT))
1476
            ->where(
1477
                $query->expr->lAnd(
1478
                    $query->expr->eq(
1479
                        $this->dbHandler->quoteColumn('id'),
1480
                        $query->bindValue($row['id'], null, PDO::PARAM_INT)
1481
                    ),
1482
                    $query->expr->eq(
1483
                        $this->dbHandler->quoteColumn('version'),
1484
                        $query->bindValue($row['version'], null, PDO::PARAM_INT)
1485
                    )
1486
                )
1487
            );
1488
1489
        $query->prepare()->execute();
1490
    }
1491
1492
    /**
1493
     * Deletes the field with the given $fieldId.
1494
     *
1495
     * @param int $fieldId
1496
     */
1497
    public function deleteField($fieldId)
1498
    {
1499
        $query = $this->dbHandler->createDeleteQuery();
1500
        $query->deleteFrom(
1501
            $this->dbHandler->quoteTable('ezcontentobject_attribute')
1502
        )->where(
1503
            $query->expr->eq(
1504
                $this->dbHandler->quoteColumn('id'),
1505
                $query->bindValue($fieldId, null, \PDO::PARAM_INT)
1506
            )
1507
        );
1508
1509
        $query->prepare()->execute();
1510
    }
1511
1512
    /**
1513
     * Deletes all fields of $contentId in all versions.
1514
     * If $versionNo is set only fields for that version are deleted.
1515
     *
1516
     * @param int $contentId
1517
     * @param int|null $versionNo
1518
     */
1519
    public function deleteFields($contentId, $versionNo = null)
1520
    {
1521
        $query = $this->dbHandler->createDeleteQuery();
1522
        $query->deleteFrom('ezcontentobject_attribute')
1523
            ->where(
1524
                $query->expr->eq(
1525
                    $this->dbHandler->quoteColumn('contentobject_id'),
1526
                    $query->bindValue($contentId, null, \PDO::PARAM_INT)
1527
                )
1528
            );
1529
1530
        if (isset($versionNo)) {
1531
            $query->where(
1532
                $query->expr->eq(
1533
                    $this->dbHandler->quoteColumn('version'),
1534
                    $query->bindValue($versionNo, null, \PDO::PARAM_INT)
1535
                )
1536
            );
1537
        }
1538
1539
        $query->prepare()->execute();
1540
    }
1541
1542
    /**
1543
     * Deletes all versions of $contentId.
1544
     * If $versionNo is set only that version is deleted.
1545
     *
1546
     * @param int $contentId
1547
     * @param int|null $versionNo
1548
     */
1549
    public function deleteVersions($contentId, $versionNo = null)
1550
    {
1551
        $query = $this->dbHandler->createDeleteQuery();
1552
        $query->deleteFrom('ezcontentobject_version')
1553
            ->where(
1554
                $query->expr->eq(
1555
                    $this->dbHandler->quoteColumn('contentobject_id'),
1556
                    $query->bindValue($contentId, null, \PDO::PARAM_INT)
1557
                )
1558
            );
1559
1560
        if (isset($versionNo)) {
1561
            $query->where(
1562
                $query->expr->eq(
1563
                    $this->dbHandler->quoteColumn('version'),
1564
                    $query->bindValue($versionNo, null, \PDO::PARAM_INT)
1565
                )
1566
            );
1567
        }
1568
1569
        $query->prepare()->execute();
1570
    }
1571
1572
    /**
1573
     * Deletes all names of $contentId.
1574
     * If $versionNo is set only names for that version are deleted.
1575
     *
1576
     * @param int $contentId
1577
     * @param int|null $versionNo
1578
     */
1579
    public function deleteNames($contentId, $versionNo = null)
1580
    {
1581
        $query = $this->dbHandler->createDeleteQuery();
1582
        $query->deleteFrom('ezcontentobject_name')
1583
            ->where(
1584
                $query->expr->eq(
1585
                    $this->dbHandler->quoteColumn('contentobject_id'),
1586
                    $query->bindValue($contentId, null, \PDO::PARAM_INT)
1587
                )
1588
            );
1589
1590
        if (isset($versionNo)) {
1591
            $query->where(
1592
                $query->expr->eq(
1593
                    $this->dbHandler->quoteColumn('content_version'),
1594
                    $query->bindValue($versionNo, null, \PDO::PARAM_INT)
1595
                )
1596
            );
1597
        }
1598
1599
        $query->prepare()->execute();
1600
    }
1601
1602
    /**
1603
     * Sets the name for Content $contentId in version $version to $name in $language.
1604
     *
1605
     * @param int $contentId
1606
     * @param int $version
1607
     * @param string $name
1608
     * @param string $language
1609
     */
1610
    public function setName($contentId, $version, $name, $language)
1611
    {
1612
        $language = $this->languageHandler->loadByLanguageCode($language);
1613
1614
        // Is it an insert or an update ?
1615
        $qSelect = $this->dbHandler->createSelectQuery();
1616
        $qSelect
1617
            ->select(
1618
                $qSelect->alias($qSelect->expr->count('*'), 'count')
1619
            )
1620
            ->from($this->dbHandler->quoteTable('ezcontentobject_name'))
1621
            ->where(
1622
                $qSelect->expr->lAnd(
1623
                    $qSelect->expr->eq($this->dbHandler->quoteColumn('contentobject_id'), $qSelect->bindValue($contentId)),
1624
                    $qSelect->expr->eq($this->dbHandler->quoteColumn('content_version'), $qSelect->bindValue($version)),
1625
                    $qSelect->expr->eq($this->dbHandler->quoteColumn('content_translation'), $qSelect->bindValue($language->languageCode))
1626
                )
1627
            );
1628
        $stmt = $qSelect->prepare();
1629
        $stmt->execute();
1630
        $res = $stmt->fetchAll(\PDO::FETCH_ASSOC);
1631
1632
        $insert = $res[0]['count'] == 0;
1633
        if ($insert) {
1634
            $q = $this->dbHandler->createInsertQuery();
1635
            $q->insertInto($this->dbHandler->quoteTable('ezcontentobject_name'));
1636
        } else {
1637
            $q = $this->dbHandler->createUpdateQuery();
1638
            $q->update($this->dbHandler->quoteTable('ezcontentobject_name'))
1639
                ->where(
1640
                    $q->expr->lAnd(
1641
                        $q->expr->eq($this->dbHandler->quoteColumn('contentobject_id'), $q->bindValue($contentId)),
1642
                        $q->expr->eq($this->dbHandler->quoteColumn('content_version'), $q->bindValue($version)),
1643
                        $q->expr->eq($this->dbHandler->quoteColumn('content_translation'), $q->bindValue($language->languageCode))
1644
                    )
1645
                );
1646
        }
1647
1648
        $q->set(
1649
            $this->dbHandler->quoteColumn('contentobject_id'),
1650
            $q->bindValue($contentId, null, \PDO::PARAM_INT)
1651
        )->set(
1652
            $this->dbHandler->quoteColumn('content_version'),
1653
            $q->bindValue($version, null, \PDO::PARAM_INT)
1654
        )->set(
1655
            $this->dbHandler->quoteColumn('language_id'),
1656
            '(' . $this->getLanguageQuery()->getQuery() . ')'
1657
        )->set(
1658
            $this->dbHandler->quoteColumn('content_translation'),
1659
            $q->bindValue($language->languageCode)
1660
        )->set(
1661
            $this->dbHandler->quoteColumn('real_translation'),
1662
            $q->bindValue($language->languageCode)
1663
        )->set(
1664
            $this->dbHandler->quoteColumn('name'),
1665
            $q->bindValue($name)
1666
        );
1667
        $q->bindValue($language->id, ':languageId', \PDO::PARAM_INT);
1668
        $q->bindValue($contentId, ':contentId', \PDO::PARAM_INT);
1669
        $q->prepare()->execute();
1670
    }
1671
1672
    /**
1673
     * Returns a language sub select query for setName.
1674
     *
1675
     * Return sub select query which gets proper language mask for alwaysAvailable Content.
1676
     *
1677
     * @return \eZ\Publish\Core\Persistence\Database\SelectQuery
1678
     */
1679
    private function getLanguageQuery()
1680
    {
1681
        $languageQuery = $this->dbHandler->createSelectQuery();
1682
        $languageQuery
1683
            ->select(
1684
                $languageQuery->expr->searchedCase(
1685
                    [
1686
                        $languageQuery->expr->lAnd(
1687
                            $languageQuery->expr->eq(
1688
                                $this->dbHandler->quoteColumn('initial_language_id'),
1689
                                ':languageId'
1690
                            ),
1691
                            // wrap bitwise check into another "neq" to provide cross-DBMS compatibility
1692
                            $languageQuery->expr->neq(
1693
                                $languageQuery->expr->bitAnd(
1694
                                    $this->dbHandler->quoteColumn('language_mask'),
1695
                                    ':languageId'
1696
                                ),
1697
                                0
1698
                            )
1699
                        ),
1700
                        $languageQuery->expr->bitOr(
1701
                            ':languageId',
1702
                            1
1703
                        ),
1704
                    ],
1705
                    ':languageId'
1706
                )
1707
            )
1708
            ->from('ezcontentobject')
1709
            ->where(
1710
                $languageQuery->expr->eq(
1711
                    'id',
1712
                    ':contentId'
1713
                )
1714
            );
1715
1716
        return $languageQuery;
1717
    }
1718
1719
    /**
1720
     * Deletes the actual content object referred to by $contentId.
1721
     *
1722
     * @param int $contentId
1723
     */
1724
    public function deleteContent($contentId)
1725
    {
1726
        $query = $this->dbHandler->createDeleteQuery();
1727
        $query->deleteFrom('ezcontentobject')
1728
            ->where(
1729
                $query->expr->eq(
1730
                    $this->dbHandler->quoteColumn('id'),
1731
                    $query->bindValue($contentId, null, \PDO::PARAM_INT)
1732
                )
1733
            );
1734
1735
        $query->prepare()->execute();
1736
    }
1737
1738
    /**
1739
     * Loads relations from $contentId to published content, optionally only from $contentVersionNo.
1740
     *
1741
     * $relationType can also be filtered.
1742
     *
1743
     * @param int $contentId
1744
     * @param int $contentVersionNo
1745
     * @param int $relationType
1746
     *
1747
     * @return string[][] array of relation data
1748
     */
1749
    public function loadRelations($contentId, $contentVersionNo = null, $relationType = null)
1750
    {
1751
        $query = $this->queryBuilder->createRelationFindQuery();
1752
        $query->innerJoin(
1753
            $query->alias(
1754
                $this->dbHandler->quoteTable('ezcontentobject'),
1755
                'ezcontentobject_to'
1756
            ),
1757
            $query->expr->lAnd(
1758
                $query->expr->eq(
1759
                    $this->dbHandler->quoteColumn('to_contentobject_id', 'ezcontentobject_link'),
1760
                    $this->dbHandler->quoteColumn('id', 'ezcontentobject_to')
1761
                ),
1762
                $query->expr->eq(
1763
                    $this->dbHandler->quoteColumn('status', 'ezcontentobject_to'),
1764
                    $query->bindValue(1, null, \PDO::PARAM_INT)
1765
                )
1766
            )
1767
        )->where(
1768
            $query->expr->eq(
1769
                $this->dbHandler->quoteColumn('from_contentobject_id', 'ezcontentobject_link'),
1770
                $query->bindValue($contentId, null, \PDO::PARAM_INT)
1771
            )
1772
        );
1773
1774
        // source version number
1775
        if (isset($contentVersionNo)) {
1776
            $query->where(
1777
                $query->expr->eq(
1778
                    $this->dbHandler->quoteColumn('from_contentobject_version', 'ezcontentobject_link'),
1779
                    $query->bindValue($contentVersionNo, null, \PDO::PARAM_INT)
1780
                )
1781
            );
1782
        } else { // from published version only
1783
            $query->from(
1784
                $this->dbHandler->quoteTable('ezcontentobject')
1785
            )->where(
1786
                $query->expr->lAnd(
1787
                    $query->expr->eq(
1788
                        $this->dbHandler->quoteColumn('id', 'ezcontentobject'),
1789
                        $this->dbHandler->quoteColumn('from_contentobject_id', 'ezcontentobject_link')
1790
                    ),
1791
                    $query->expr->eq(
1792
                        $this->dbHandler->quoteColumn('current_version', 'ezcontentobject'),
1793
                        $this->dbHandler->quoteColumn('from_contentobject_version', 'ezcontentobject_link')
1794
                    )
1795
                )
1796
            );
1797
        }
1798
1799
        // relation type
1800
        if (isset($relationType)) {
1801
            $query->where(
1802
                $query->expr->gt(
1803
                    $query->expr->bitAnd(
1804
                        $this->dbHandler->quoteColumn('relation_type', 'ezcontentobject_link'),
1805
                        $query->bindValue($relationType, null, \PDO::PARAM_INT)
1806
                    ),
1807
                    0
1808
                )
1809
            );
1810
        }
1811
1812
        $statement = $query->prepare();
1813
        $statement->execute();
1814
1815
        return $statement->fetchAll(\PDO::FETCH_ASSOC);
1816
    }
1817
1818
    /**
1819
     * {@inheritdoc}
1820
     */
1821
    public function countReverseRelations(int $toContentId, ?int $relationType = null): int
1822
    {
1823
        $platform = $this->connection->getDatabasePlatform();
1824
        $query = $this->connection->createQueryBuilder();
1825
        $expr = $query->expr();
1826
        $query
1827
            ->select($platform->getCountExpression('l.id'))
1828
            ->from('ezcontentobject_link', 'l')
1829
            ->innerJoin(
1830
                'l',
1831
                'ezcontentobject',
1832
                'c',
1833
                $expr->andX(
1834
                    $expr->eq('l.from_contentobject_id', 'c.id'),
1835
                    $expr->eq('l.from_contentobject_version', 'c.current_version'),
1836
                    $expr->eq('c.status', 1)
1837
                )
1838
            )
1839
            ->where(
1840
                $expr->eq('l.to_contentobject_id', ':to_content_id')
1841
            )
1842
            ->setParameter(':to_content_id', $toContentId, \PDO::PARAM_INT);
1843
1844
        // relation type
1845
        if ($relationType !== null) {
1846
            $query->andWhere(
1847
                $expr->gt(
1848
                    $platform->getBitAndComparisonExpression('l.relation_type', $relationType),
1849
                    0
1850
                )
1851
            );
1852
        }
1853
1854
        return (int) $query->execute()->fetchColumn();
1855
    }
1856
1857
    /**
1858
     * Loads data that related to $toContentId.
1859
     *
1860
     * @param int $toContentId
1861
     * @param int $relationType
1862
     *
1863
     * @return mixed[][] Content data, array structured like {@see \eZ\Publish\Core\Persistence\Legacy\Content\Gateway::load()}
1864
     */
1865
    public function loadReverseRelations($toContentId, $relationType = null)
1866
    {
1867
        $query = $this->queryBuilder->createRelationFindQuery();
1868
        $query->where(
1869
            $query->expr->eq(
1870
                $this->dbHandler->quoteColumn('to_contentobject_id', 'ezcontentobject_link'),
1871
                $query->bindValue($toContentId, null, \PDO::PARAM_INT)
1872
            )
1873
        );
1874
1875
        // ezcontentobject join
1876
        $query->from(
1877
            $this->dbHandler->quoteTable('ezcontentobject')
1878
        )->where(
1879
            $query->expr->lAnd(
1880
                $query->expr->eq(
1881
                    $this->dbHandler->quoteColumn('id', 'ezcontentobject'),
1882
                    $this->dbHandler->quoteColumn('from_contentobject_id', 'ezcontentobject_link')
1883
                ),
1884
                $query->expr->eq(
1885
                    $this->dbHandler->quoteColumn('current_version', 'ezcontentobject'),
1886
                    $this->dbHandler->quoteColumn('from_contentobject_version', 'ezcontentobject_link')
1887
                ),
1888
                $query->expr->eq(
1889
                    $this->dbHandler->quoteColumn('status', 'ezcontentobject'),
1890
                    $query->bindValue(1, null, \PDO::PARAM_INT)
1891
                )
1892
            )
1893
        );
1894
1895
        // relation type
1896
        if (isset($relationType)) {
1897
            $query->where(
1898
                $query->expr->gt(
1899
                    $query->expr->bitAnd(
1900
                        $this->dbHandler->quoteColumn('relation_type', 'ezcontentobject_link'),
1901
                        $query->bindValue($relationType, null, \PDO::PARAM_INT)
1902
                    ),
1903
                    0
1904
                )
1905
            );
1906
        }
1907
1908
        $statement = $query->prepare();
1909
1910
        $statement->execute();
1911
1912
        return $statement->fetchAll(\PDO::FETCH_ASSOC);
1913
    }
1914
1915
    /**
1916
     * Inserts a new relation database record.
1917
     *
1918
     * @param \eZ\Publish\SPI\Persistence\Content\Relation\CreateStruct $createStruct
1919
     *
1920
     * @return int ID the inserted ID
1921
     */
1922
    public function insertRelation(RelationCreateStruct $createStruct)
1923
    {
1924
        $q = $this->dbHandler->createInsertQuery();
1925
        $q->insertInto(
1926
            $this->dbHandler->quoteTable('ezcontentobject_link')
1927
        )->set(
1928
            $this->dbHandler->quoteColumn('id'),
1929
            $this->dbHandler->getAutoIncrementValue('ezcontentobject_link', 'id')
1930
        )->set(
1931
            $this->dbHandler->quoteColumn('contentclassattribute_id'),
1932
            $q->bindValue((int)$createStruct->sourceFieldDefinitionId, null, \PDO::PARAM_INT)
1933
        )->set(
1934
            $this->dbHandler->quoteColumn('from_contentobject_id'),
1935
            $q->bindValue($createStruct->sourceContentId, null, \PDO::PARAM_INT)
1936
        )->set(
1937
            $this->dbHandler->quoteColumn('from_contentobject_version'),
1938
            $q->bindValue($createStruct->sourceContentVersionNo, null, \PDO::PARAM_INT)
1939
        )->set(
1940
            $this->dbHandler->quoteColumn('relation_type'),
1941
            $q->bindValue($createStruct->type, null, \PDO::PARAM_INT)
1942
        )->set(
1943
            $this->dbHandler->quoteColumn('to_contentobject_id'),
1944
            $q->bindValue($createStruct->destinationContentId, null, \PDO::PARAM_INT)
1945
        );
1946
1947
        $q->prepare()->execute();
1948
1949
        return $this->dbHandler->lastInsertId(
1950
            $this->dbHandler->getSequenceName('ezcontentobject_link', 'id')
1951
        );
1952
    }
1953
1954
    /**
1955
     * Deletes the relation with the given $relationId.
1956
     *
1957
     * @param int $relationId
1958
     * @param int $type {@see \eZ\Publish\API\Repository\Values\Content\Relation::COMMON,
1959
     *                 \eZ\Publish\API\Repository\Values\Content\Relation::EMBED,
1960
     *                 \eZ\Publish\API\Repository\Values\Content\Relation::LINK,
1961
     *                 \eZ\Publish\API\Repository\Values\Content\Relation::FIELD}
1962
     */
1963
    public function deleteRelation($relationId, $type)
1964
    {
1965
        // Legacy Storage stores COMMON, LINK and EMBED types using bitmask, therefore first load
1966
        // existing relation type by given $relationId for comparison
1967
        /** @var $query \eZ\Publish\Core\Persistence\Database\SelectQuery */
1968
        $query = $this->dbHandler->createSelectQuery();
1969
        $query->select(
1970
            $this->dbHandler->quoteColumn('relation_type')
1971
        )->from(
1972
            $this->dbHandler->quoteTable('ezcontentobject_link')
1973
        )->where(
1974
            $query->expr->eq(
1975
                $this->dbHandler->quoteColumn('id'),
1976
                $query->bindValue($relationId, null, \PDO::PARAM_INT)
1977
            )
1978
        );
1979
1980
        $statement = $query->prepare();
1981
        $statement->execute();
1982
        $loadedRelationType = $statement->fetchColumn();
1983
1984
        if (!$loadedRelationType) {
1985
            return;
1986
        }
1987
1988
        // If relation type matches then delete
1989
        if ($loadedRelationType == $type) {
1990
            /** @var $query \eZ\Publish\Core\Persistence\Database\DeleteQuery */
1991
            $query = $this->dbHandler->createDeleteQuery();
1992
            $query->deleteFrom(
1993
                'ezcontentobject_link'
1994
            )->where(
1995
                $query->expr->eq(
1996
                    $this->dbHandler->quoteColumn('id'),
1997
                    $query->bindValue($relationId, null, \PDO::PARAM_INT)
1998
                )
1999
            );
2000
2001
            $query->prepare()->execute();
2002
        } elseif ($loadedRelationType & $type) { // If relation type is composite update bitmask
2003
            /** @var $query \eZ\Publish\Core\Persistence\Database\UpdateQuery */
2004
            $query = $this->dbHandler->createUpdateQuery();
2005
            $query->update(
2006
                $this->dbHandler->quoteTable('ezcontentobject_link')
2007
            )->set(
2008
                $this->dbHandler->quoteColumn('relation_type'),
2009
                $query->expr->bitAnd(
2010
                    $this->dbHandler->quoteColumn('relation_type'),
2011
                    $query->bindValue(~$type, null, \PDO::PARAM_INT)
2012
                )
2013
            )->where(
2014
                $query->expr->eq(
2015
                    $this->dbHandler->quoteColumn('id'),
2016
                    $query->bindValue($relationId, null, \PDO::PARAM_INT)
2017
                )
2018
            );
2019
2020
            $query->prepare()->execute();
2021
        } else {
2022
            // No match, do nothing
2023
        }
2024
    }
2025
2026
    /**
2027
     * Returns all Content IDs for a given $contentTypeId.
2028
     *
2029
     * @param int $contentTypeId
2030
     *
2031
     * @return int[]
2032
     */
2033
    public function getContentIdsByContentTypeId($contentTypeId)
2034
    {
2035
        $query = $this->dbHandler->createSelectQuery();
2036
        $query
2037
            ->select($this->dbHandler->quoteColumn('id'))
2038
            ->from($this->dbHandler->quoteTable('ezcontentobject'))
2039
            ->where(
2040
                $query->expr->eq(
2041
                    $this->dbHandler->quoteColumn('contentclass_id'),
2042
                    $query->bindValue($contentTypeId, null, PDO::PARAM_INT)
2043
                )
2044
            );
2045
2046
        $statement = $query->prepare();
2047
        $statement->execute();
2048
2049
        return $statement->fetchAll(PDO::FETCH_COLUMN);
2050
    }
2051
2052
    /**
2053
     * Load name data for set of content id's and corresponding version number.
2054
     *
2055
     * @param array[] $rows array of hashes with 'id' and 'version' to load names for
2056
     *
2057
     * @return array
2058
     */
2059
    public function loadVersionedNameData($rows)
2060
    {
2061
        $query = $this->queryBuilder->createNamesQuery();
2062
        $conditions = [];
2063
        foreach ($rows as $row) {
2064
            $conditions[] = $query->expr->lAnd(
2065
                $query->expr->eq(
2066
                    $this->dbHandler->quoteColumn('contentobject_id'),
2067
                    $query->bindValue($row['id'], null, \PDO::PARAM_INT)
2068
                ),
2069
                $query->expr->eq(
2070
                    $this->dbHandler->quoteColumn('content_version'),
2071
                    $query->bindValue($row['version'], null, \PDO::PARAM_INT)
2072
                )
2073
            );
2074
        }
2075
2076
        $query->where($query->expr->lOr($conditions));
2077
        $stmt = $query->prepare();
2078
        $stmt->execute();
2079
2080
        return $stmt->fetchAll(\PDO::FETCH_ASSOC);
2081
    }
2082
2083
    /**
2084
     * Batch method for copying all relation meta data for copied Content object.
2085
     *
2086
     * {@inheritdoc}
2087
     *
2088
     * @param int $originalContentId
2089
     * @param int $copiedContentId
2090
     * @param int|null $versionNo If specified only copy for a given version number, otherwise all.
2091
     */
2092
    public function copyRelations($originalContentId, $copiedContentId, $versionNo = null)
2093
    {
2094
        // Given we can retain all columns, we just create copies with new `from_contentobject_id` using INSERT INTO SELECT
2095
        $sql = 'INSERT INTO ezcontentobject_link ( contentclassattribute_id, from_contentobject_id, from_contentobject_version, relation_type, to_contentobject_id )
2096
                SELECT  L2.contentclassattribute_id, :copied_id, L2.from_contentobject_version, L2.relation_type, L2.to_contentobject_id
2097
                FROM    ezcontentobject_link AS L2
2098
                WHERE   L2.from_contentobject_id = :original_id';
2099
2100
        if ($versionNo) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $versionNo of type integer|null is loosely compared to true; this is ambiguous if the integer can be zero. You might want to explicitly use !== null instead.

In PHP, under loose comparison (like ==, or !=, or switch conditions), values of different types might be equal.

For integer values, zero is a special case, in particular the following results might be unexpected:

0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
Loading history...
2101
            $stmt = $this->connection->prepare($sql . ' AND L2.from_contentobject_version = :version');
2102
            $stmt->bindValue('version', $versionNo, PDO::PARAM_INT);
2103
        } else {
2104
            $stmt = $this->connection->prepare($sql);
2105
        }
2106
2107
        $stmt->bindValue('original_id', $originalContentId, PDO::PARAM_INT);
2108
        $stmt->bindValue('copied_id', $copiedContentId, PDO::PARAM_INT);
2109
2110
        $stmt->execute();
2111
    }
2112
2113
    /**
2114
     * Remove the specified translation from the Content Object Version.
2115
     *
2116
     * @param int $contentId
2117
     * @param string $languageCode language code of the translation
2118
     * @throws \Doctrine\DBAL\DBALException
2119
     */
2120
    public function deleteTranslationFromContent($contentId, $languageCode)
2121
    {
2122
        $language = $this->languageHandler->loadByLanguageCode($languageCode);
2123
2124
        $this->connection->beginTransaction();
2125
        try {
2126
            $this->deleteTranslationFromContentVersions($contentId, $language->id);
2127
            $this->deleteTranslationFromContentNames($contentId, $languageCode);
2128
            $this->deleteTranslationFromContentObject($contentId, $language->id);
2129
2130
            $this->connection->commit();
2131
        } catch (DBALException $e) {
2132
            $this->connection->rollBack();
2133
            throw $e;
2134
        }
2135
    }
2136
2137
    /**
2138
     * Delete Content fields (attributes) for the given Translation.
2139
     * If $versionNo is given, fields for that Version only will be deleted.
2140
     *
2141
     * @param string $languageCode
2142
     * @param int $contentId
2143
     * @param int $versionNo (optional) filter by versionNo
2144
     */
2145
    public function deleteTranslatedFields($languageCode, $contentId, $versionNo = null)
2146
    {
2147
        $query = $this->connection->createQueryBuilder();
2148
        $query
2149
            ->delete('ezcontentobject_attribute')
2150
            ->where('contentobject_id = :contentId')
2151
            ->andWhere('language_code = :languageCode')
2152
            ->setParameters(
2153
                [
2154
                    ':contentId' => $contentId,
2155
                    ':languageCode' => $languageCode,
2156
                ]
2157
            )
2158
        ;
2159
2160
        if (null !== $versionNo) {
2161
            $query
2162
                ->andWhere('version = :versionNo')
2163
                ->setParameter(':versionNo', $versionNo)
2164
            ;
2165
        }
2166
2167
        $query->execute();
2168
    }
2169
2170
    /**
2171
     * Delete the specified Translation from the given Version.
2172
     *
2173
     * @param int $contentId
2174
     * @param int $versionNo
2175
     * @param string $languageCode
2176
     * @throws \Doctrine\DBAL\DBALException
2177
     */
2178
    public function deleteTranslationFromVersion($contentId, $versionNo, $languageCode)
2179
    {
2180
        $language = $this->languageHandler->loadByLanguageCode($languageCode);
2181
2182
        $this->connection->beginTransaction();
2183
        try {
2184
            $this->deleteTranslationFromContentVersions($contentId, $language->id, $versionNo);
2185
            $this->deleteTranslationFromContentNames($contentId, $languageCode, $versionNo);
2186
2187
            $this->connection->commit();
2188
        } catch (DBALException $e) {
2189
            $this->connection->rollBack();
2190
            throw $e;
2191
        }
2192
    }
2193
2194
    /**
2195
     * Delete translation from the ezcontentobject_name table.
2196
     *
2197
     * @param int $contentId
2198
     * @param string $languageCode
2199
     * @param int $versionNo optional, if specified, apply to this Version only.
2200
     */
2201
    private function deleteTranslationFromContentNames($contentId, $languageCode, $versionNo = null)
2202
    {
2203
        $query = $this->connection->createQueryBuilder();
2204
        $query
2205
            ->delete('ezcontentobject_name')
2206
            ->where('contentobject_id=:contentId')
2207
            ->andWhere('real_translation=:languageCode')
2208
            ->setParameters(
2209
                [
2210
                    ':languageCode' => $languageCode,
2211
                    ':contentId' => $contentId,
2212
                ]
2213
            )
2214
        ;
2215
2216
        if (null !== $versionNo) {
2217
            $query
2218
                ->andWhere('content_version = :versionNo')
2219
                ->setParameter(':versionNo', $versionNo)
2220
            ;
2221
        }
2222
2223
        $query->execute();
2224
    }
2225
2226
    /**
2227
     * Remove language from language_mask of ezcontentobject.
2228
     *
2229
     * @param int $contentId
2230
     * @param int $languageId
2231
     * @throws \eZ\Publish\Core\Base\Exceptions\BadStateException
2232
     */
2233
    private function deleteTranslationFromContentObject($contentId, $languageId)
2234
    {
2235
        $query = $this->connection->createQueryBuilder();
2236
        $query->update('ezcontentobject')
2237
            // parameter for bitwise operation has to be placed verbatim (w/o binding) for this to work cross-DBMS
2238
            ->set('language_mask', 'language_mask & ~ ' . $languageId)
2239
            ->set('modified', ':now')
2240
            ->where('id = :contentId')
2241
            ->andWhere(
2242
            // make sure removed translation is not the last one (incl. alwaysAvailable)
2243
                $query->expr()->andX(
2244
                    'language_mask & ~ ' . $languageId . ' <> 0',
2245
                    'language_mask & ~ ' . $languageId . ' <> 1'
2246
                )
2247
            )
2248
            ->setParameter(':now', time())
2249
            ->setParameter(':contentId', $contentId)
2250
        ;
2251
2252
        $rowCount = $query->execute();
2253
2254
        // no rows updated means that most likely somehow it was the last remaining translation
2255
        if ($rowCount === 0) {
2256
            throw new BadStateException(
2257
                '$languageCode',
2258
                'Specified translation is the only one Content Object Version has'
2259
            );
2260
        }
2261
    }
2262
2263
    /**
2264
     * Remove language from language_mask of ezcontentobject_version and update initialLanguageId
2265
     * if it matches the removed one.
2266
     *
2267
     * @param int $contentId
2268
     * @param int $languageId
2269
     * @param int $versionNo optional, if specified, apply to this Version only.
2270
     * @throws \eZ\Publish\Core\Base\Exceptions\BadStateException
2271
     */
2272
    private function deleteTranslationFromContentVersions($contentId, $languageId, $versionNo = null)
2273
    {
2274
        $query = $this->connection->createQueryBuilder();
2275
        $query->update('ezcontentobject_version')
2276
            // parameter for bitwise operation has to be placed verbatim (w/o binding) for this to work cross-DBMS
2277
            ->set('language_mask', 'language_mask & ~ ' . $languageId)
2278
            ->set('modified', ':now')
2279
            // update initial_language_id only if it matches removed translation languageId
2280
            ->set(
2281
                'initial_language_id',
2282
                'CASE WHEN initial_language_id = :languageId ' .
2283
                'THEN (SELECT initial_language_id AS main_language_id FROM ezcontentobject c WHERE c.id = :contentId) ' .
2284
                'ELSE initial_language_id END'
2285
            )
2286
            ->where('contentobject_id = :contentId')
2287
            ->andWhere(
2288
            // make sure removed translation is not the last one (incl. alwaysAvailable)
2289
                $query->expr()->andX(
2290
                    'language_mask & ~ ' . $languageId . ' <> 0',
2291
                    'language_mask & ~ ' . $languageId . ' <> 1'
2292
                )
2293
            )
2294
            ->setParameter(':now', time())
2295
            ->setParameter(':contentId', $contentId)
2296
            ->setParameter(':languageId', $languageId)
2297
        ;
2298
2299
        if (null !== $versionNo) {
2300
            $query
2301
                ->andWhere('version = :versionNo')
2302
                ->setParameter(':versionNo', $versionNo)
2303
            ;
2304
        }
2305
2306
        $rowCount = $query->execute();
2307
2308
        // no rows updated means that most likely somehow it was the last remaining translation
2309
        if ($rowCount === 0) {
2310
            throw new BadStateException(
2311
                '$languageCode',
2312
                'Specified translation is the only one Content Object Version has'
2313
            );
2314
        }
2315
    }
2316
}
2317