Completed
Push — parallel_test_fork ( 458d25...5e34ca )
by
unknown
20:19 queued 02:09
created

DoctrineDatabase::setPublishedStatus()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 25

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 2
nc 2
nop 2
dl 0
loc 25
rs 9.52
c 0
b 0
f 0
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 View Code Duplication
        foreach ($fields as $field) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
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
    public function setPublishedStatus(int $contentId, int $versionNo): void
606
    {
607
        $query = $this->getSetVersionStatusQuery(
608
            $contentId,
609
            $versionNo,
610
            VersionInfo::STATUS_PUBLISHED
611
        );
612
613
        /* this part allows set status `published` only if there is no other published version of the content */
614
        $notExistPublishedVersion = <<< HEREDOC
615
            NOT EXISTS (
616
                SELECT 1 FROM (
617
                    SELECT 1 FROM ezcontentobject_version  WHERE contentobject_id = :contentId AND status = :status 
618
                ) as V
619
            )
620
HEREDOC;
621
622
        $query->andWhere($notExistPublishedVersion);
623
        if (0 === $query->execute()) {
624
            throw new BadStateException(
625
                '$contentId', "Someone just published another Version of the Content item {$contentId}"
626
            );
627
        }
628
        $this->markContentAsPublished($contentId, $versionNo);
629
    }
630
631
    private function getSetVersionStatusQuery(
632
        int $contentId,
633
        int $versionNo,
634
        int $versionStatus
635
    ): DoctrineQueryBuilder {
636
        $query = $this->connection->createQueryBuilder();
637
        $query
638
            ->update('ezcontentobject_version')
639
            ->set('status', ':status')
640
            ->set('modified', ':modified')
641
            ->where('contentobject_id = :contentId')
642
            ->andWhere('version = :versionNo')
643
            ->setParameter('status', $versionStatus, ParameterType::INTEGER)
644
            ->setParameter('modified', time(), ParameterType::INTEGER)
645
            ->setParameter('contentId', $contentId, ParameterType::INTEGER)
646
            ->setParameter('versionNo', $versionNo, ParameterType::INTEGER);
647
648
        return $query;
649
    }
650
651 View Code Duplication
    private function markContentAsPublished(int $contentId, int $versionNo): void
652
    {
653
        $query = $this->connection->createQueryBuilder();
654
        $query
655
            ->update('ezcontentobject')
656
            ->set('status', ':status')
657
            ->set('current_version', ':versionNo')
658
            ->where('id =:contentId')
659
            ->setParameter('status', ContentInfo::STATUS_PUBLISHED, ParameterType::INTEGER)
660
            ->setParameter('versionNo', $versionNo, ParameterType::INTEGER)
661
            ->setParameter('contentId', $contentId, ParameterType::INTEGER);
662
        $query->execute();
663
    }
664
665
    /**
666
     * Inserts a new field.
667
     *
668
     * Only used when a new field is created (i.e. a new object or a field in a
669
     * new language!). After that, field IDs need to stay the same, only the
670
     * version number changes.
671
     *
672
     * @param \eZ\Publish\SPI\Persistence\Content $content
673
     * @param \eZ\Publish\SPI\Persistence\Content\Field $field
674
     * @param \eZ\Publish\Core\Persistence\Legacy\Content\StorageFieldValue $value
675
     *
676
     * @return int ID
677
     */
678
    public function insertNewField(Content $content, Field $field, StorageFieldValue $value)
679
    {
680
        $q = $this->dbHandler->createInsertQuery();
681
682
        $this->setInsertFieldValues($q, $content, $field, $value);
683
684
        // Insert with auto increment ID
685
        $q->set(
686
            $this->dbHandler->quoteColumn('id'),
687
            $this->dbHandler->getAutoIncrementValue('ezcontentobject_attribute', 'id')
688
        );
689
690
        $q->prepare()->execute();
691
692
        return $this->dbHandler->lastInsertId(
693
            $this->dbHandler->getSequenceName('ezcontentobject_attribute', 'id')
694
        );
695
    }
696
697
    /**
698
     * Inserts an existing field.
699
     *
700
     * Used to insert a field with an exsting ID but a new version number.
701
     *
702
     * @param Content $content
703
     * @param Field $field
704
     * @param StorageFieldValue $value
705
     */
706
    public function insertExistingField(Content $content, Field $field, StorageFieldValue $value)
707
    {
708
        $q = $this->dbHandler->createInsertQuery();
709
710
        $this->setInsertFieldValues($q, $content, $field, $value);
711
712
        $q->set(
713
            $this->dbHandler->quoteColumn('id'),
714
            $q->bindValue($field->id, null, \PDO::PARAM_INT)
715
        );
716
717
        $q->prepare()->execute();
718
    }
719
720
    /**
721
     * Sets field (ezcontentobject_attribute) values to the given query.
722
     *
723
     * @param \eZ\Publish\Core\Persistence\Database\InsertQuery $q
724
     * @param Content $content
725
     * @param Field $field
726
     * @param StorageFieldValue $value
727
     */
728
    protected function setInsertFieldValues(InsertQuery $q, Content $content, Field $field, StorageFieldValue $value)
729
    {
730
        $q->insertInto(
731
            $this->dbHandler->quoteTable('ezcontentobject_attribute')
732
        )->set(
733
            $this->dbHandler->quoteColumn('contentobject_id'),
734
            $q->bindValue($content->versionInfo->contentInfo->id, null, \PDO::PARAM_INT)
735
        )->set(
736
            $this->dbHandler->quoteColumn('contentclassattribute_id'),
737
            $q->bindValue($field->fieldDefinitionId, null, \PDO::PARAM_INT)
738
        )->set(
739
            $this->dbHandler->quoteColumn('data_type_string'),
740
            $q->bindValue($field->type)
741
        )->set(
742
            $this->dbHandler->quoteColumn('language_code'),
743
            $q->bindValue($field->languageCode)
744
        )->set(
745
            $this->dbHandler->quoteColumn('version'),
746
            $q->bindValue($field->versionNo, null, \PDO::PARAM_INT)
747
        )->set(
748
            $this->dbHandler->quoteColumn('data_float'),
749
            $q->bindValue($value->dataFloat)
750
        )->set(
751
            $this->dbHandler->quoteColumn('data_int'),
752
            $q->bindValue($value->dataInt, null, \PDO::PARAM_INT)
753
        )->set(
754
            $this->dbHandler->quoteColumn('data_text'),
755
            $q->bindValue($value->dataText)
756
        )->set(
757
            $this->dbHandler->quoteColumn('sort_key_int'),
758
            $q->bindValue($value->sortKeyInt, null, \PDO::PARAM_INT)
759
        )->set(
760
            $this->dbHandler->quoteColumn('sort_key_string'),
761
            $q->bindValue(mb_substr($value->sortKeyString, 0, 255))
762
        )->set(
763
            $this->dbHandler->quoteColumn('language_id'),
764
            $q->bindValue(
765
                $this->languageMaskGenerator->generateLanguageIndicator(
766
                    $field->languageCode,
767
                    $this->isLanguageAlwaysAvailable($content, $field->languageCode)
768
                ),
769
                null,
770
                \PDO::PARAM_INT
771
            )
772
        );
773
    }
774
775
    /**
776
     * Checks if $languageCode is always available in $content.
777
     *
778
     * @param \eZ\Publish\SPI\Persistence\Content $content
779
     * @param string $languageCode
780
     *
781
     * @return bool
782
     */
783
    protected function isLanguageAlwaysAvailable(Content $content, $languageCode)
784
    {
785
        return
786
            $content->versionInfo->contentInfo->alwaysAvailable &&
787
            $content->versionInfo->contentInfo->mainLanguageCode === $languageCode
788
        ;
789
    }
790
791
    /**
792
     * Updates an existing field.
793
     *
794
     * @param Field $field
795
     * @param StorageFieldValue $value
796
     */
797
    public function updateField(Field $field, StorageFieldValue $value)
798
    {
799
        // Note, no need to care for language_id here, since Content->$alwaysAvailable
800
        // cannot change on update
801
        $q = $this->dbHandler->createUpdateQuery();
802
        $this->setFieldUpdateValues($q, $value);
803
        $q->where(
804
            $q->expr->lAnd(
805
                $q->expr->eq(
806
                    $this->dbHandler->quoteColumn('id'),
807
                    $q->bindValue($field->id, null, \PDO::PARAM_INT)
808
                ),
809
                $q->expr->eq(
810
                    $this->dbHandler->quoteColumn('version'),
811
                    $q->bindValue($field->versionNo, null, \PDO::PARAM_INT)
812
                )
813
            )
814
        );
815
        $q->prepare()->execute();
816
    }
817
818
    /**
819
     * Sets update fields for $value on $q.
820
     *
821
     * @param \eZ\Publish\Core\Persistence\Database\UpdateQuery $q
822
     * @param StorageFieldValue $value
823
     */
824
    protected function setFieldUpdateValues(UpdateQuery $q, StorageFieldValue $value)
825
    {
826
        $q->update(
827
            $this->dbHandler->quoteTable('ezcontentobject_attribute')
828
        )->set(
829
            $this->dbHandler->quoteColumn('data_float'),
830
            $q->bindValue($value->dataFloat)
831
        )->set(
832
            $this->dbHandler->quoteColumn('data_int'),
833
            $q->bindValue($value->dataInt, null, \PDO::PARAM_INT)
834
        )->set(
835
            $this->dbHandler->quoteColumn('data_text'),
836
            $q->bindValue($value->dataText)
837
        )->set(
838
            $this->dbHandler->quoteColumn('sort_key_int'),
839
            $q->bindValue($value->sortKeyInt, null, \PDO::PARAM_INT)
840
        )->set(
841
            $this->dbHandler->quoteColumn('sort_key_string'),
842
            $q->bindValue(mb_substr($value->sortKeyString, 0, 255))
843
        );
844
    }
845
846
    /**
847
     * Updates an existing, non-translatable field.
848
     *
849
     * @param \eZ\Publish\SPI\Persistence\Content\Field $field
850
     * @param \eZ\Publish\Core\Persistence\Legacy\Content\StorageFieldValue $value
851
     * @param int $contentId
852
     */
853
    public function updateNonTranslatableField(
854
        Field $field,
855
        StorageFieldValue $value,
856
        $contentId
857
    ) {
858
        // Note, no need to care for language_id here, since Content->$alwaysAvailable
859
        // cannot change on update
860
        $q = $this->dbHandler->createUpdateQuery();
861
        $this->setFieldUpdateValues($q, $value);
862
        $q->where(
863
            $q->expr->lAnd(
864
                $q->expr->eq(
865
                    $this->dbHandler->quoteColumn('contentclassattribute_id'),
866
                    $q->bindValue($field->fieldDefinitionId, null, \PDO::PARAM_INT)
867
                ),
868
                $q->expr->eq(
869
                    $this->dbHandler->quoteColumn('contentobject_id'),
870
                    $q->bindValue($contentId, null, \PDO::PARAM_INT)
871
                ),
872
                $q->expr->eq(
873
                    $this->dbHandler->quoteColumn('version'),
874
                    $q->bindValue($field->versionNo, null, \PDO::PARAM_INT)
875
                )
876
            )
877
        );
878
        $q->prepare()->execute();
879
    }
880
881
    /**
882
     * {@inheritdoc}
883
     */
884
    public function load($contentId, $version = null, array $translations = null)
885
    {
886
        return $this->internalLoadContent([$contentId], $version, $translations);
0 ignored issues
show
Bug introduced by
It seems like $translations defined by parameter $translations on line 884 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...
887
    }
888
889
    /**
890
     * {@inheritdoc}
891
     */
892
    public function loadContentList(array $contentIds, array $translations = null): array
893
    {
894
        return $this->internalLoadContent($contentIds, null, $translations);
0 ignored issues
show
Bug introduced by
It seems like $translations defined by parameter $translations on line 892 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...
895
    }
896
897
    /**
898
     * @see load(), loadContentList()
899
     *
900
     * @param array $contentIds
901
     * @param int|null $version
902
     * @param string[]|null $translations
903
     *
904
     * @return array
905
     */
906
    private function internalLoadContent(array $contentIds, int $version = null, array $translations = null): array
907
    {
908
        $queryBuilder = $this->connection->createQueryBuilder();
909
        $expr = $queryBuilder->expr();
910
        $queryBuilder
911
            ->select(
912
                'c.id AS ezcontentobject_id',
913
                'c.contentclass_id AS ezcontentobject_contentclass_id',
914
                'c.section_id AS ezcontentobject_section_id',
915
                'c.owner_id AS ezcontentobject_owner_id',
916
                'c.remote_id AS ezcontentobject_remote_id',
917
                'c.current_version AS ezcontentobject_current_version',
918
                'c.initial_language_id AS ezcontentobject_initial_language_id',
919
                'c.modified AS ezcontentobject_modified',
920
                'c.published AS ezcontentobject_published',
921
                'c.status AS ezcontentobject_status',
922
                'c.name AS ezcontentobject_name',
923
                'c.language_mask AS ezcontentobject_language_mask',
924
                'c.is_hidden AS ezcontentobject_is_hidden',
925
                'v.id AS ezcontentobject_version_id',
926
                'v.version AS ezcontentobject_version_version',
927
                'v.modified AS ezcontentobject_version_modified',
928
                'v.creator_id AS ezcontentobject_version_creator_id',
929
                'v.created AS ezcontentobject_version_created',
930
                'v.status AS ezcontentobject_version_status',
931
                'v.language_mask AS ezcontentobject_version_language_mask',
932
                'v.initial_language_id AS ezcontentobject_version_initial_language_id',
933
                'a.id AS ezcontentobject_attribute_id',
934
                'a.contentclassattribute_id AS ezcontentobject_attribute_contentclassattribute_id',
935
                'a.data_type_string AS ezcontentobject_attribute_data_type_string',
936
                'a.language_code AS ezcontentobject_attribute_language_code',
937
                'a.language_id AS ezcontentobject_attribute_language_id',
938
                'a.data_float AS ezcontentobject_attribute_data_float',
939
                'a.data_int AS ezcontentobject_attribute_data_int',
940
                'a.data_text AS ezcontentobject_attribute_data_text',
941
                'a.sort_key_int AS ezcontentobject_attribute_sort_key_int',
942
                'a.sort_key_string AS ezcontentobject_attribute_sort_key_string',
943
                't.main_node_id AS ezcontentobject_tree_main_node_id'
944
            )
945
            ->from('ezcontentobject', 'c')
946
            ->innerJoin(
947
                'c',
948
                'ezcontentobject_version',
949
                'v',
950
                $expr->andX(
951
                    $expr->eq('c.id', 'v.contentobject_id'),
952
                    $expr->eq('v.version', $version ?? 'c.current_version')
953
                )
954
            )
955
            ->innerJoin(
956
                'v',
957
                'ezcontentobject_attribute',
958
                'a',
959
                $expr->andX(
960
                    $expr->eq('v.contentobject_id', 'a.contentobject_id'),
961
                    $expr->eq('v.version', 'a.version')
962
                )
963
            )
964
            ->leftJoin(
965
                'c',
966
                'ezcontentobject_tree',
967
                't',
968
                $expr->andX(
969
                    $expr->eq('c.id', 't.contentobject_id'),
970
                    $expr->eq('t.node_id', 't.main_node_id')
971
                )
972
            );
973
974
        $queryBuilder->where(
975
            $expr->in(
976
                'c.id',
977
                $queryBuilder->createNamedParameter($contentIds, Connection::PARAM_INT_ARRAY)
978
            )
979
        );
980
981
        if (!empty($translations)) {
982
            $queryBuilder->andWhere(
983
                $expr->in(
984
                    'a.language_code',
985
                    $queryBuilder->createNamedParameter($translations, Connection::PARAM_STR_ARRAY)
986
                )
987
            );
988
        }
989
990
        return $queryBuilder->execute()->fetchAll(FetchMode::ASSOCIATIVE);
991
    }
992
993
    /**
994
     * Get query builder to load Content Info data.
995
     *
996
     * @see loadContentInfo(), loadContentInfoByRemoteId(), loadContentInfoList(), loadContentInfoByLocationId()
997
     *
998
     * @param bool $joinMainLocation
999
     *
1000
     * @return \Doctrine\DBAL\Query\QueryBuilder
1001
     */
1002
    private function createLoadContentInfoQueryBuilder(bool $joinMainLocation = true): DoctrineQueryBuilder
1003
    {
1004
        $queryBuilder = $this->connection->createQueryBuilder();
1005
        $expr = $queryBuilder->expr();
1006
1007
        $joinCondition = $expr->eq('c.id', 't.contentobject_id');
1008
        if ($joinMainLocation) {
1009
            // wrap join condition with AND operator and join by a Main Location
1010
            $joinCondition = $expr->andX(
1011
                $joinCondition,
1012
                $expr->eq('t.node_id', 't.main_node_id')
1013
            );
1014
        }
1015
1016
        $queryBuilder
1017
            ->select('c.*', 't.main_node_id AS ezcontentobject_tree_main_node_id')
1018
            ->from('ezcontentobject', 'c')
1019
            ->leftJoin(
1020
                'c',
1021
                'ezcontentobject_tree',
1022
                't',
1023
                $joinCondition
0 ignored issues
show
Bug introduced by
It seems like $joinCondition defined by $expr->andX($joinConditi...id', 't.main_node_id')) on line 1010 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...
1024
            );
1025
1026
        return $queryBuilder;
1027
    }
1028
1029
    /**
1030
     * Loads info for content identified by $contentId.
1031
     * Will basically return a hash containing all field values for ezcontentobject table plus some additional keys:
1032
     *  - always_available => Boolean indicating if content's language mask contains alwaysAvailable bit field
1033
     *  - main_language_code => Language code for main (initial) language. E.g. "eng-GB".
1034
     *
1035
     * @param int $contentId
1036
     *
1037
     * @throws \eZ\Publish\Core\Base\Exceptions\NotFoundException
1038
     *
1039
     * @return array
1040
     */
1041 View Code Duplication
    public function loadContentInfo($contentId)
1042
    {
1043
        $queryBuilder = $this->createLoadContentInfoQueryBuilder();
1044
        $queryBuilder
1045
            ->where('c.id = :id')
1046
            ->setParameter('id', $contentId, ParameterType::INTEGER);
1047
1048
        $results = $queryBuilder->execute()->fetchAll(FetchMode::ASSOCIATIVE);
1049
        if (empty($results)) {
1050
            throw new NotFound('content', "id: $contentId");
1051
        }
1052
1053
        return $results[0];
1054
    }
1055
1056
    public function loadContentInfoList(array $contentIds)
1057
    {
1058
        $queryBuilder = $this->createLoadContentInfoQueryBuilder();
1059
        $queryBuilder
1060
            ->where('c.id IN (:ids)')
1061
            ->setParameter('ids', $contentIds, Connection::PARAM_INT_ARRAY);
1062
1063
        return $queryBuilder->execute()->fetchAll(FetchMode::ASSOCIATIVE);
1064
    }
1065
1066
    /**
1067
     * Loads info for a content object identified by its remote ID.
1068
     *
1069
     * Returns an array with the relevant data.
1070
     *
1071
     * @param mixed $remoteId
1072
     *
1073
     * @throws \eZ\Publish\Core\Base\Exceptions\NotFoundException
1074
     *
1075
     * @return array
1076
     */
1077 View Code Duplication
    public function loadContentInfoByRemoteId($remoteId)
1078
    {
1079
        $queryBuilder = $this->createLoadContentInfoQueryBuilder();
1080
        $queryBuilder
1081
            ->where('c.remote_id = :id')
1082
            ->setParameter('id', $remoteId, ParameterType::STRING);
1083
1084
        $results = $queryBuilder->execute()->fetchAll(FetchMode::ASSOCIATIVE);
1085
        if (empty($results)) {
1086
            throw new NotFound('content', "remote_id: $remoteId");
1087
        }
1088
1089
        return $results[0];
1090
    }
1091
1092
    /**
1093
     * Loads info for a content object identified by its location ID (node ID).
1094
     *
1095
     * Returns an array with the relevant data.
1096
     *
1097
     * @param int $locationId
1098
     *
1099
     * @throws \eZ\Publish\Core\Base\Exceptions\NotFoundException
1100
     *
1101
     * @return array
1102
     */
1103 View Code Duplication
    public function loadContentInfoByLocationId($locationId)
1104
    {
1105
        $queryBuilder = $this->createLoadContentInfoQueryBuilder(false);
1106
        $queryBuilder
1107
            ->where('t.node_id = :id')
1108
            ->setParameter('id', $locationId, ParameterType::INTEGER);
1109
1110
        $results = $queryBuilder->execute()->fetchAll(FetchMode::ASSOCIATIVE);
1111
        if (empty($results)) {
1112
            throw new NotFound('content', "node_id: $locationId");
1113
        }
1114
1115
        return $results[0];
1116
    }
1117
1118
    /**
1119
     * Loads version info for content identified by $contentId and $versionNo.
1120
     * Will basically return a hash containing all field values from ezcontentobject_version table plus following keys:
1121
     *  - names => Hash of content object names. Key is the language code, value is the name.
1122
     *  - 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.
1123
     *  - initial_language_code => Language code for initial language in this version.
1124
     *
1125
     * @param int $contentId
1126
     * @param int $versionNo
1127
     *
1128
     * @return array
1129
     */
1130 View Code Duplication
    public function loadVersionInfo($contentId, $versionNo)
1131
    {
1132
        $query = $this->queryBuilder->createVersionInfoFindQuery();
1133
        $query->where(
1134
            $query->expr->lAnd(
1135
                $query->expr->eq(
1136
                    $this->dbHandler->quoteColumn('contentobject_id', 'ezcontentobject_version'),
1137
                    $query->bindValue($contentId, null, \PDO::PARAM_INT)
1138
                ),
1139
                $query->expr->eq(
1140
                    $this->dbHandler->quoteColumn('version', 'ezcontentobject_version'),
1141
                    $query->bindValue($versionNo, null, \PDO::PARAM_INT)
1142
                )
1143
            )
1144
        );
1145
        $statement = $query->prepare();
1146
        $statement->execute();
1147
1148
        return $statement->fetchAll(\PDO::FETCH_ASSOC);
1149
    }
1150
1151
    /**
1152
     * Returns data for all versions with given status created by the given $userId.
1153
     *
1154
     * @param int $userId
1155
     * @param int $status
1156
     *
1157
     * @return string[][]
1158
     */
1159
    public function listVersionsForUser($userId, $status = VersionInfo::STATUS_DRAFT)
1160
    {
1161
        $query = $this->queryBuilder->createVersionInfoFindQuery();
1162
        $query->where(
1163
            $query->expr->lAnd(
1164
                $query->expr->eq(
1165
                    $this->dbHandler->quoteColumn('status', 'ezcontentobject_version'),
1166
                    $query->bindValue($status, null, \PDO::PARAM_INT)
1167
                ),
1168
                $query->expr->eq(
1169
                    $this->dbHandler->quoteColumn('creator_id', 'ezcontentobject_version'),
1170
                    $query->bindValue($userId, null, \PDO::PARAM_INT)
1171
                )
1172
            )
1173
        );
1174
1175
        return $this->listVersionsHelper($query);
1176
    }
1177
1178
    /**
1179
     * Returns all version data for the given $contentId, optionally filtered by status.
1180
     *
1181
     * Result is returned with oldest version first (using version id as it has index and is auto increment).
1182
     *
1183
     * @param mixed $contentId
1184
     * @param mixed|null $status Optional argument to filter versions by status, like {@see VersionInfo::STATUS_ARCHIVED}.
1185
     * @param int $limit Limit for items returned, -1 means none.
1186
     *
1187
     * @return string[][]
1188
     */
1189
    public function listVersions($contentId, $status = null, $limit = -1)
1190
    {
1191
        $query = $this->queryBuilder->createVersionInfoFindQuery();
1192
1193
        $filter = $query->expr->eq(
1194
            $this->dbHandler->quoteColumn('contentobject_id', 'ezcontentobject_version'),
1195
            $query->bindValue($contentId, null, \PDO::PARAM_INT)
1196
        );
1197
1198
        if ($status !== null) {
1199
            $filter = $query->expr->lAnd(
1200
                $filter,
1201
                $query->expr->eq(
1202
                    $this->dbHandler->quoteColumn('status', 'ezcontentobject_version'),
1203
                    $query->bindValue($status, null, \PDO::PARAM_INT)
1204
                )
1205
            );
1206
        }
1207
1208
        $query->where($filter);
1209
1210
        if ($limit > 0) {
1211
            $query->limit($limit);
1212
        }
1213
1214
        return $this->listVersionsHelper($query);
1215
    }
1216
1217
    /**
1218
     * Helper for {@see listVersions()} and {@see listVersionsForUser()} that filters duplicates
1219
     * that are the result of the cartesian product performed by createVersionInfoFindQuery().
1220
     *
1221
     * @param \eZ\Publish\Core\Persistence\Database\SelectQuery $query
1222
     *
1223
     * @return string[][]
1224
     */
1225
    private function listVersionsHelper(SelectQuery $query)
1226
    {
1227
        $query->orderBy(
1228
            $this->dbHandler->quoteColumn('id', 'ezcontentobject_version')
1229
        );
1230
1231
        $statement = $query->prepare();
1232
        $statement->execute();
1233
1234
        $results = [];
1235
        $previousId = null;
1236
        foreach ($statement->fetchAll(\PDO::FETCH_ASSOC) as $row) {
1237
            if ($row['ezcontentobject_version_id'] == $previousId) {
1238
                continue;
1239
            }
1240
1241
            $previousId = $row['ezcontentobject_version_id'];
1242
            $results[] = $row;
1243
        }
1244
1245
        return $results;
1246
    }
1247
1248
    /**
1249
     * Returns all version numbers for the given $contentId.
1250
     *
1251
     * @param mixed $contentId
1252
     *
1253
     * @return int[]
1254
     */
1255 View Code Duplication
    public function listVersionNumbers($contentId)
1256
    {
1257
        $query = $this->dbHandler->createSelectQuery();
1258
        $query->selectDistinct(
1259
            $this->dbHandler->quoteColumn('version')
1260
        )->from(
1261
            $this->dbHandler->quoteTable('ezcontentobject_version')
1262
        )->where(
1263
            $query->expr->eq(
1264
                $this->dbHandler->quoteColumn('contentobject_id'),
1265
                $query->bindValue($contentId, null, \PDO::PARAM_INT)
1266
            )
1267
        );
1268
1269
        $statement = $query->prepare();
1270
        $statement->execute();
1271
1272
        return $statement->fetchAll(\PDO::FETCH_COLUMN);
1273
    }
1274
1275
    /**
1276
     * Returns last version number for content identified by $contentId.
1277
     *
1278
     * @param int $contentId
1279
     *
1280
     * @return int
1281
     */
1282 View Code Duplication
    public function getLastVersionNumber($contentId)
1283
    {
1284
        $query = $this->dbHandler->createSelectQuery();
1285
        $query->select(
1286
            $query->expr->max($this->dbHandler->quoteColumn('version'))
1287
        )->from(
1288
            $this->dbHandler->quoteTable('ezcontentobject_version')
1289
        )->where(
1290
            $query->expr->eq(
1291
                $this->dbHandler->quoteColumn('contentobject_id'),
1292
                $query->bindValue($contentId, null, \PDO::PARAM_INT)
1293
            )
1294
        );
1295
1296
        $statement = $query->prepare();
1297
        $statement->execute();
1298
1299
        return (int)$statement->fetchColumn();
1300
    }
1301
1302
    /**
1303
     * Returns all IDs for locations that refer to $contentId.
1304
     *
1305
     * @param int $contentId
1306
     *
1307
     * @return int[]
1308
     */
1309 View Code Duplication
    public function getAllLocationIds($contentId)
1310
    {
1311
        $query = $this->dbHandler->createSelectQuery();
1312
        $query->select(
1313
            $this->dbHandler->quoteColumn('node_id')
1314
        )->from(
1315
            $this->dbHandler->quoteTable('ezcontentobject_tree')
1316
        )->where(
1317
            $query->expr->eq(
1318
                $this->dbHandler->quoteColumn('contentobject_id'),
1319
                $query->bindValue($contentId, null, \PDO::PARAM_INT)
1320
            )
1321
        );
1322
1323
        $statement = $query->prepare();
1324
        $statement->execute();
1325
1326
        return $statement->fetchAll(\PDO::FETCH_COLUMN);
1327
    }
1328
1329
    /**
1330
     * Returns all field IDs of $contentId grouped by their type.
1331
     * If $versionNo is set only field IDs for that version are returned.
1332
     * If $languageCode is set, only field IDs for that language are returned.
1333
     *
1334
     * @param int $contentId
1335
     * @param int|null $versionNo
1336
     * @param string|null $languageCode
1337
     *
1338
     * @return int[][]
1339
     */
1340
    public function getFieldIdsByType($contentId, $versionNo = null, $languageCode = null)
1341
    {
1342
        $query = $this->dbHandler->createSelectQuery();
1343
        $query->select(
1344
            $this->dbHandler->quoteColumn('id'),
1345
            $this->dbHandler->quoteColumn('data_type_string')
1346
        )->from(
1347
            $this->dbHandler->quoteTable('ezcontentobject_attribute')
1348
        )->where(
1349
            $query->expr->eq(
1350
                $this->dbHandler->quoteColumn('contentobject_id'),
1351
                $query->bindValue($contentId, null, \PDO::PARAM_INT)
1352
            )
1353
        );
1354
1355
        if (isset($versionNo)) {
1356
            $query->where(
1357
                $query->expr->eq(
1358
                    $this->dbHandler->quoteColumn('version'),
1359
                    $query->bindValue($versionNo, null, \PDO::PARAM_INT)
1360
                )
1361
            );
1362
        }
1363
1364
        if (isset($languageCode)) {
1365
            $query->where(
1366
                $query->expr->eq(
1367
                    $this->dbHandler->quoteColumn('language_code'),
1368
                    $query->bindValue($languageCode, null, \PDO::PARAM_STR)
1369
                )
1370
            );
1371
        }
1372
1373
        $statement = $query->prepare();
1374
        $statement->execute();
1375
1376
        $result = [];
1377
        foreach ($statement->fetchAll() as $row) {
1378
            if (!isset($result[$row['data_type_string']])) {
1379
                $result[$row['data_type_string']] = [];
1380
            }
1381
            $result[$row['data_type_string']][] = (int)$row['id'];
1382
        }
1383
1384
        return $result;
1385
    }
1386
1387
    /**
1388
     * Deletes relations to and from $contentId.
1389
     * If $versionNo is set only relations for that version are deleted.
1390
     *
1391
     * @param int $contentId
1392
     * @param int|null $versionNo
1393
     */
1394
    public function deleteRelations($contentId, $versionNo = null)
1395
    {
1396
        $query = $this->dbHandler->createDeleteQuery();
1397
        $query->deleteFrom(
1398
            $this->dbHandler->quoteTable('ezcontentobject_link')
1399
        );
1400
1401
        if (isset($versionNo)) {
1402
            $query->where(
1403
                $query->expr->lAnd(
1404
                    $query->expr->eq(
1405
                        $this->dbHandler->quoteColumn('from_contentobject_id'),
1406
                        $query->bindValue($contentId, null, \PDO::PARAM_INT)
1407
                    ),
1408
                    $query->expr->eq(
1409
                        $this->dbHandler->quoteColumn('from_contentobject_version'),
1410
                        $query->bindValue($versionNo, null, \PDO::PARAM_INT)
1411
                    )
1412
                )
1413
            );
1414 View Code Duplication
        } else {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
1415
            $query->where(
1416
                $query->expr->lOr(
1417
                    $query->expr->eq(
1418
                        $this->dbHandler->quoteColumn('from_contentobject_id'),
1419
                        $query->bindValue($contentId, null, \PDO::PARAM_INT)
1420
                    ),
1421
                    $query->expr->eq(
1422
                        $this->dbHandler->quoteColumn('to_contentobject_id'),
1423
                        $query->bindValue($contentId, null, \PDO::PARAM_INT)
1424
                    )
1425
                )
1426
            );
1427
        }
1428
1429
        $query->prepare()->execute();
1430
    }
1431
1432
    /**
1433
     * Removes relations to Content with $contentId from Relation and RelationList field type fields.
1434
     *
1435
     * @param int $contentId
1436
     */
1437
    public function removeReverseFieldRelations($contentId)
1438
    {
1439
        $query = $this->dbHandler->createSelectQuery();
1440
        $query
1441
            ->select('ezcontentobject_attribute.*')
1442
            ->from('ezcontentobject_attribute')
1443
            ->innerJoin(
1444
                'ezcontentobject_link',
1445
                $query->expr->lAnd(
1446
                    $query->expr->eq(
1447
                        $this->dbHandler->quoteColumn('from_contentobject_id', 'ezcontentobject_link'),
1448
                        $this->dbHandler->quoteColumn('contentobject_id', 'ezcontentobject_attribute')
1449
                    ),
1450
                    $query->expr->eq(
1451
                        $this->dbHandler->quoteColumn('from_contentobject_version', 'ezcontentobject_link'),
1452
                        $this->dbHandler->quoteColumn('version', 'ezcontentobject_attribute')
1453
                    ),
1454
                    $query->expr->eq(
1455
                        $this->dbHandler->quoteColumn('contentclassattribute_id', 'ezcontentobject_link'),
1456
                        $this->dbHandler->quoteColumn('contentclassattribute_id', 'ezcontentobject_attribute')
1457
                    )
1458
                )
1459
            )
1460
            ->where(
1461
                $query->expr->eq(
1462
                    $this->dbHandler->quoteColumn('to_contentobject_id', 'ezcontentobject_link'),
1463
                    $query->bindValue($contentId, null, PDO::PARAM_INT)
1464
                ),
1465
                $query->expr->gt(
1466
                    $query->expr->bitAnd(
1467
                        $this->dbHandler->quoteColumn('relation_type', 'ezcontentobject_link'),
1468
                        $query->bindValue(8, null, PDO::PARAM_INT)
1469
                    ),
1470
                    0
1471
                )
1472
            );
1473
1474
        $statement = $query->prepare();
1475
        $statement->execute();
1476
1477
        while ($row = $statement->fetch(PDO::FETCH_ASSOC)) {
1478
            if ($row['data_type_string'] === 'ezobjectrelation') {
1479
                $this->removeRelationFromRelationField($row);
1480
            }
1481
1482
            if ($row['data_type_string'] === 'ezobjectrelationlist') {
1483
                $this->removeRelationFromRelationListField($contentId, $row);
1484
            }
1485
        }
1486
    }
1487
1488
    /**
1489
     * Updates field value of RelationList field type identified by given $row data,
1490
     * removing relations toward given $contentId.
1491
     *
1492
     * @param int $contentId
1493
     * @param array $row
1494
     */
1495
    protected function removeRelationFromRelationListField($contentId, array $row)
1496
    {
1497
        $document = new DOMDocument('1.0', 'utf-8');
1498
        $document->loadXML($row['data_text']);
1499
1500
        $xpath = new DOMXPath($document);
1501
        $xpathExpression = "//related-objects/relation-list/relation-item[@contentobject-id='{$contentId}']";
1502
1503
        $relationItems = $xpath->query($xpathExpression);
1504
        foreach ($relationItems as $relationItem) {
1505
            $relationItem->parentNode->removeChild($relationItem);
1506
        }
1507
1508
        $query = $this->dbHandler->createUpdateQuery();
1509
        $query
1510
            ->update('ezcontentobject_attribute')
1511
            ->set(
1512
                'data_text',
1513
                $query->bindValue($document->saveXML(), null, PDO::PARAM_STR)
1514
            )
1515
            ->where(
1516
                $query->expr->lAnd(
1517
                    $query->expr->eq(
1518
                        $this->dbHandler->quoteColumn('id'),
1519
                        $query->bindValue($row['id'], null, PDO::PARAM_INT)
1520
                    ),
1521
                    $query->expr->eq(
1522
                        $this->dbHandler->quoteColumn('version'),
1523
                        $query->bindValue($row['version'], null, PDO::PARAM_INT)
1524
                    )
1525
                )
1526
            );
1527
1528
        $query->prepare()->execute();
1529
    }
1530
1531
    /**
1532
     * Updates field value of Relation field type identified by given $row data,
1533
     * removing relation data.
1534
     *
1535
     * @param array $row
1536
     */
1537
    protected function removeRelationFromRelationField(array $row)
1538
    {
1539
        $query = $this->dbHandler->createUpdateQuery();
1540
        $query
1541
            ->update('ezcontentobject_attribute')
1542
            ->set('data_int', $query->bindValue(null, null, PDO::PARAM_INT))
1543
            ->set('sort_key_int', $query->bindValue(0, null, PDO::PARAM_INT))
1544
            ->where(
1545
                $query->expr->lAnd(
1546
                    $query->expr->eq(
1547
                        $this->dbHandler->quoteColumn('id'),
1548
                        $query->bindValue($row['id'], null, PDO::PARAM_INT)
1549
                    ),
1550
                    $query->expr->eq(
1551
                        $this->dbHandler->quoteColumn('version'),
1552
                        $query->bindValue($row['version'], null, PDO::PARAM_INT)
1553
                    )
1554
                )
1555
            );
1556
1557
        $query->prepare()->execute();
1558
    }
1559
1560
    /**
1561
     * Deletes the field with the given $fieldId.
1562
     *
1563
     * @param int $fieldId
1564
     */
1565 View Code Duplication
    public function deleteField($fieldId)
1566
    {
1567
        $query = $this->dbHandler->createDeleteQuery();
1568
        $query->deleteFrom(
1569
            $this->dbHandler->quoteTable('ezcontentobject_attribute')
1570
        )->where(
1571
            $query->expr->eq(
1572
                $this->dbHandler->quoteColumn('id'),
1573
                $query->bindValue($fieldId, null, \PDO::PARAM_INT)
1574
            )
1575
        );
1576
1577
        $query->prepare()->execute();
1578
    }
1579
1580
    /**
1581
     * Deletes all fields of $contentId in all versions.
1582
     * If $versionNo is set only fields for that version are deleted.
1583
     *
1584
     * @param int $contentId
1585
     * @param int|null $versionNo
1586
     */
1587 View Code Duplication
    public function deleteFields($contentId, $versionNo = null)
1588
    {
1589
        $query = $this->dbHandler->createDeleteQuery();
1590
        $query->deleteFrom('ezcontentobject_attribute')
1591
            ->where(
1592
                $query->expr->eq(
1593
                    $this->dbHandler->quoteColumn('contentobject_id'),
1594
                    $query->bindValue($contentId, null, \PDO::PARAM_INT)
1595
                )
1596
            );
1597
1598
        if (isset($versionNo)) {
1599
            $query->where(
1600
                $query->expr->eq(
1601
                    $this->dbHandler->quoteColumn('version'),
1602
                    $query->bindValue($versionNo, null, \PDO::PARAM_INT)
1603
                )
1604
            );
1605
        }
1606
1607
        $query->prepare()->execute();
1608
    }
1609
1610
    /**
1611
     * Deletes all versions of $contentId.
1612
     * If $versionNo is set only that version is deleted.
1613
     *
1614
     * @param int $contentId
1615
     * @param int|null $versionNo
1616
     */
1617 View Code Duplication
    public function deleteVersions($contentId, $versionNo = null)
1618
    {
1619
        $query = $this->dbHandler->createDeleteQuery();
1620
        $query->deleteFrom('ezcontentobject_version')
1621
            ->where(
1622
                $query->expr->eq(
1623
                    $this->dbHandler->quoteColumn('contentobject_id'),
1624
                    $query->bindValue($contentId, null, \PDO::PARAM_INT)
1625
                )
1626
            );
1627
1628
        if (isset($versionNo)) {
1629
            $query->where(
1630
                $query->expr->eq(
1631
                    $this->dbHandler->quoteColumn('version'),
1632
                    $query->bindValue($versionNo, null, \PDO::PARAM_INT)
1633
                )
1634
            );
1635
        }
1636
1637
        $query->prepare()->execute();
1638
    }
1639
1640
    /**
1641
     * Deletes all names of $contentId.
1642
     * If $versionNo is set only names for that version are deleted.
1643
     *
1644
     * @param int $contentId
1645
     * @param int|null $versionNo
1646
     */
1647 View Code Duplication
    public function deleteNames($contentId, $versionNo = null)
1648
    {
1649
        $query = $this->dbHandler->createDeleteQuery();
1650
        $query->deleteFrom('ezcontentobject_name')
1651
            ->where(
1652
                $query->expr->eq(
1653
                    $this->dbHandler->quoteColumn('contentobject_id'),
1654
                    $query->bindValue($contentId, null, \PDO::PARAM_INT)
1655
                )
1656
            );
1657
1658
        if (isset($versionNo)) {
1659
            $query->where(
1660
                $query->expr->eq(
1661
                    $this->dbHandler->quoteColumn('content_version'),
1662
                    $query->bindValue($versionNo, null, \PDO::PARAM_INT)
1663
                )
1664
            );
1665
        }
1666
1667
        $query->prepare()->execute();
1668
    }
1669
1670
    /**
1671
     * Sets the name for Content $contentId in version $version to $name in $language.
1672
     *
1673
     * @param int $contentId
1674
     * @param int $version
1675
     * @param string $name
1676
     * @param string $language
1677
     */
1678
    public function setName($contentId, $version, $name, $language)
1679
    {
1680
        $language = $this->languageHandler->loadByLanguageCode($language);
1681
1682
        // Is it an insert or an update ?
1683
        $qSelect = $this->dbHandler->createSelectQuery();
1684
        $qSelect
1685
            ->select(
1686
                $qSelect->alias($qSelect->expr->count('*'), 'count')
1687
            )
1688
            ->from($this->dbHandler->quoteTable('ezcontentobject_name'))
1689
            ->where(
1690
                $qSelect->expr->lAnd(
1691
                    $qSelect->expr->eq($this->dbHandler->quoteColumn('contentobject_id'), $qSelect->bindValue($contentId)),
1692
                    $qSelect->expr->eq($this->dbHandler->quoteColumn('content_version'), $qSelect->bindValue($version)),
1693
                    $qSelect->expr->eq($this->dbHandler->quoteColumn('content_translation'), $qSelect->bindValue($language->languageCode))
1694
                )
1695
            );
1696
        $stmt = $qSelect->prepare();
1697
        $stmt->execute();
1698
        $res = $stmt->fetchAll(\PDO::FETCH_ASSOC);
1699
1700
        $insert = $res[0]['count'] == 0;
1701
        if ($insert) {
1702
            $q = $this->dbHandler->createInsertQuery();
1703
            $q->insertInto($this->dbHandler->quoteTable('ezcontentobject_name'));
1704
        } else {
1705
            $q = $this->dbHandler->createUpdateQuery();
1706
            $q->update($this->dbHandler->quoteTable('ezcontentobject_name'))
1707
                ->where(
1708
                    $q->expr->lAnd(
1709
                        $q->expr->eq($this->dbHandler->quoteColumn('contentobject_id'), $q->bindValue($contentId)),
1710
                        $q->expr->eq($this->dbHandler->quoteColumn('content_version'), $q->bindValue($version)),
1711
                        $q->expr->eq($this->dbHandler->quoteColumn('content_translation'), $q->bindValue($language->languageCode))
1712
                    )
1713
                );
1714
        }
1715
1716
        $q->set(
1717
            $this->dbHandler->quoteColumn('contentobject_id'),
1718
            $q->bindValue($contentId, null, \PDO::PARAM_INT)
1719
        )->set(
1720
            $this->dbHandler->quoteColumn('content_version'),
1721
            $q->bindValue($version, null, \PDO::PARAM_INT)
1722
        )->set(
1723
            $this->dbHandler->quoteColumn('language_id'),
1724
            '(' . $this->getLanguageQuery()->getQuery() . ')'
1725
        )->set(
1726
            $this->dbHandler->quoteColumn('content_translation'),
1727
            $q->bindValue($language->languageCode)
1728
        )->set(
1729
            $this->dbHandler->quoteColumn('real_translation'),
1730
            $q->bindValue($language->languageCode)
1731
        )->set(
1732
            $this->dbHandler->quoteColumn('name'),
1733
            $q->bindValue($name)
1734
        );
1735
        $q->bindValue($language->id, ':languageId', \PDO::PARAM_INT);
1736
        $q->bindValue($contentId, ':contentId', \PDO::PARAM_INT);
1737
        $q->prepare()->execute();
1738
    }
1739
1740
    /**
1741
     * Returns a language sub select query for setName.
1742
     *
1743
     * Return sub select query which gets proper language mask for alwaysAvailable Content.
1744
     *
1745
     * @return \eZ\Publish\Core\Persistence\Database\SelectQuery
1746
     */
1747
    private function getLanguageQuery()
1748
    {
1749
        $languageQuery = $this->dbHandler->createSelectQuery();
1750
        $languageQuery
1751
            ->select(
1752
                $languageQuery->expr->searchedCase(
1753
                    [
1754
                        $languageQuery->expr->lAnd(
1755
                            $languageQuery->expr->eq(
1756
                                $this->dbHandler->quoteColumn('initial_language_id'),
1757
                                ':languageId'
1758
                            ),
1759
                            // wrap bitwise check into another "neq" to provide cross-DBMS compatibility
1760
                            $languageQuery->expr->neq(
1761
                                $languageQuery->expr->bitAnd(
1762
                                    $this->dbHandler->quoteColumn('language_mask'),
1763
                                    ':languageId'
1764
                                ),
1765
                                0
1766
                            )
1767
                        ),
1768
                        $languageQuery->expr->bitOr(
1769
                            ':languageId',
1770
                            1
1771
                        ),
1772
                    ],
1773
                    ':languageId'
1774
                )
1775
            )
1776
            ->from('ezcontentobject')
1777
            ->where(
1778
                $languageQuery->expr->eq(
1779
                    'id',
1780
                    ':contentId'
1781
                )
1782
            );
1783
1784
        return $languageQuery;
1785
    }
1786
1787
    /**
1788
     * Deletes the actual content object referred to by $contentId.
1789
     *
1790
     * @param int $contentId
1791
     */
1792 View Code Duplication
    public function deleteContent($contentId)
1793
    {
1794
        $query = $this->dbHandler->createDeleteQuery();
1795
        $query->deleteFrom('ezcontentobject')
1796
            ->where(
1797
                $query->expr->eq(
1798
                    $this->dbHandler->quoteColumn('id'),
1799
                    $query->bindValue($contentId, null, \PDO::PARAM_INT)
1800
                )
1801
            );
1802
1803
        $query->prepare()->execute();
1804
    }
1805
1806
    /**
1807
     * Loads relations from $contentId to published content, optionally only from $contentVersionNo.
1808
     *
1809
     * $relationType can also be filtered.
1810
     *
1811
     * @param int $contentId
1812
     * @param int $contentVersionNo
1813
     * @param int $relationType
1814
     *
1815
     * @return string[][] array of relation data
1816
     */
1817
    public function loadRelations($contentId, $contentVersionNo = null, $relationType = null)
1818
    {
1819
        $query = $this->queryBuilder->createRelationFindQuery();
1820
        $query->innerJoin(
1821
            $query->alias(
1822
                $this->dbHandler->quoteTable('ezcontentobject'),
1823
                'ezcontentobject_to'
1824
            ),
1825
            $query->expr->lAnd(
1826
                $query->expr->eq(
1827
                    $this->dbHandler->quoteColumn('to_contentobject_id', 'ezcontentobject_link'),
1828
                    $this->dbHandler->quoteColumn('id', 'ezcontentobject_to')
1829
                ),
1830
                $query->expr->eq(
1831
                    $this->dbHandler->quoteColumn('status', 'ezcontentobject_to'),
1832
                    $query->bindValue(1, null, \PDO::PARAM_INT)
1833
                )
1834
            )
1835
        )->where(
1836
            $query->expr->eq(
1837
                $this->dbHandler->quoteColumn('from_contentobject_id', 'ezcontentobject_link'),
1838
                $query->bindValue($contentId, null, \PDO::PARAM_INT)
1839
            )
1840
        );
1841
1842
        // source version number
1843
        if (isset($contentVersionNo)) {
1844
            $query->where(
1845
                $query->expr->eq(
1846
                    $this->dbHandler->quoteColumn('from_contentobject_version', 'ezcontentobject_link'),
1847
                    $query->bindValue($contentVersionNo, null, \PDO::PARAM_INT)
1848
                )
1849
            );
1850
        } else { // from published version only
1851
            $query->from(
1852
                $this->dbHandler->quoteTable('ezcontentobject')
1853
            )->where(
1854
                $query->expr->lAnd(
1855
                    $query->expr->eq(
1856
                        $this->dbHandler->quoteColumn('id', 'ezcontentobject'),
1857
                        $this->dbHandler->quoteColumn('from_contentobject_id', 'ezcontentobject_link')
1858
                    ),
1859
                    $query->expr->eq(
1860
                        $this->dbHandler->quoteColumn('current_version', 'ezcontentobject'),
1861
                        $this->dbHandler->quoteColumn('from_contentobject_version', 'ezcontentobject_link')
1862
                    )
1863
                )
1864
            );
1865
        }
1866
1867
        // relation type
1868 View Code Duplication
        if (isset($relationType)) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
1869
            $query->where(
1870
                $query->expr->gt(
1871
                    $query->expr->bitAnd(
1872
                        $this->dbHandler->quoteColumn('relation_type', 'ezcontentobject_link'),
1873
                        $query->bindValue($relationType, null, \PDO::PARAM_INT)
1874
                    ),
1875
                    0
1876
                )
1877
            );
1878
        }
1879
1880
        $statement = $query->prepare();
1881
        $statement->execute();
1882
1883
        return $statement->fetchAll(\PDO::FETCH_ASSOC);
1884
    }
1885
1886
    /**
1887
     * Loads data that related to $toContentId.
1888
     *
1889
     * @param int $toContentId
1890
     * @param int $relationType
1891
     *
1892
     * @return mixed[][] Content data, array structured like {@see \eZ\Publish\Core\Persistence\Legacy\Content\Gateway::load()}
1893
     */
1894
    public function loadReverseRelations($toContentId, $relationType = null)
1895
    {
1896
        $query = $this->queryBuilder->createRelationFindQuery();
1897
        $query->where(
1898
            $query->expr->eq(
1899
                $this->dbHandler->quoteColumn('to_contentobject_id', 'ezcontentobject_link'),
1900
                $query->bindValue($toContentId, null, \PDO::PARAM_INT)
1901
            )
1902
        );
1903
1904
        // ezcontentobject join
1905
        $query->from(
1906
            $this->dbHandler->quoteTable('ezcontentobject')
1907
        )->where(
1908
            $query->expr->lAnd(
1909
                $query->expr->eq(
1910
                    $this->dbHandler->quoteColumn('id', 'ezcontentobject'),
1911
                    $this->dbHandler->quoteColumn('from_contentobject_id', 'ezcontentobject_link')
1912
                ),
1913
                $query->expr->eq(
1914
                    $this->dbHandler->quoteColumn('current_version', 'ezcontentobject'),
1915
                    $this->dbHandler->quoteColumn('from_contentobject_version', 'ezcontentobject_link')
1916
                ),
1917
                $query->expr->eq(
1918
                    $this->dbHandler->quoteColumn('status', 'ezcontentobject'),
1919
                    $query->bindValue(1, null, \PDO::PARAM_INT)
1920
                )
1921
            )
1922
        );
1923
1924
        // relation type
1925 View Code Duplication
        if (isset($relationType)) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
1926
            $query->where(
1927
                $query->expr->gt(
1928
                    $query->expr->bitAnd(
1929
                        $this->dbHandler->quoteColumn('relation_type', 'ezcontentobject_link'),
1930
                        $query->bindValue($relationType, null, \PDO::PARAM_INT)
1931
                    ),
1932
                    0
1933
                )
1934
            );
1935
        }
1936
1937
        $statement = $query->prepare();
1938
1939
        $statement->execute();
1940
1941
        return $statement->fetchAll(\PDO::FETCH_ASSOC);
1942
    }
1943
1944
    /**
1945
     * Inserts a new relation database record.
1946
     *
1947
     * @param \eZ\Publish\SPI\Persistence\Content\Relation\CreateStruct $createStruct
1948
     *
1949
     * @return int ID the inserted ID
1950
     */
1951
    public function insertRelation(RelationCreateStruct $createStruct)
1952
    {
1953
        $q = $this->dbHandler->createInsertQuery();
1954
        $q->insertInto(
1955
            $this->dbHandler->quoteTable('ezcontentobject_link')
1956
        )->set(
1957
            $this->dbHandler->quoteColumn('id'),
1958
            $this->dbHandler->getAutoIncrementValue('ezcontentobject_link', 'id')
1959
        )->set(
1960
            $this->dbHandler->quoteColumn('contentclassattribute_id'),
1961
            $q->bindValue((int)$createStruct->sourceFieldDefinitionId, null, \PDO::PARAM_INT)
1962
        )->set(
1963
            $this->dbHandler->quoteColumn('from_contentobject_id'),
1964
            $q->bindValue($createStruct->sourceContentId, null, \PDO::PARAM_INT)
1965
        )->set(
1966
            $this->dbHandler->quoteColumn('from_contentobject_version'),
1967
            $q->bindValue($createStruct->sourceContentVersionNo, null, \PDO::PARAM_INT)
1968
        )->set(
1969
            $this->dbHandler->quoteColumn('relation_type'),
1970
            $q->bindValue($createStruct->type, null, \PDO::PARAM_INT)
1971
        )->set(
1972
            $this->dbHandler->quoteColumn('to_contentobject_id'),
1973
            $q->bindValue($createStruct->destinationContentId, null, \PDO::PARAM_INT)
1974
        );
1975
1976
        $q->prepare()->execute();
1977
1978
        return $this->dbHandler->lastInsertId(
1979
            $this->dbHandler->getSequenceName('ezcontentobject_link', 'id')
1980
        );
1981
    }
1982
1983
    /**
1984
     * Deletes the relation with the given $relationId.
1985
     *
1986
     * @param int $relationId
1987
     * @param int $type {@see \eZ\Publish\API\Repository\Values\Content\Relation::COMMON,
1988
     *                 \eZ\Publish\API\Repository\Values\Content\Relation::EMBED,
1989
     *                 \eZ\Publish\API\Repository\Values\Content\Relation::LINK,
1990
     *                 \eZ\Publish\API\Repository\Values\Content\Relation::FIELD}
1991
     */
1992
    public function deleteRelation($relationId, $type)
1993
    {
1994
        // Legacy Storage stores COMMON, LINK and EMBED types using bitmask, therefore first load
1995
        // existing relation type by given $relationId for comparison
1996
        /** @var $query \eZ\Publish\Core\Persistence\Database\SelectQuery */
1997
        $query = $this->dbHandler->createSelectQuery();
1998
        $query->select(
1999
            $this->dbHandler->quoteColumn('relation_type')
2000
        )->from(
2001
            $this->dbHandler->quoteTable('ezcontentobject_link')
2002
        )->where(
2003
            $query->expr->eq(
2004
                $this->dbHandler->quoteColumn('id'),
2005
                $query->bindValue($relationId, null, \PDO::PARAM_INT)
2006
            )
2007
        );
2008
2009
        $statement = $query->prepare();
2010
        $statement->execute();
2011
        $loadedRelationType = $statement->fetchColumn();
2012
2013
        if (!$loadedRelationType) {
2014
            return;
2015
        }
2016
2017
        // If relation type matches then delete
2018
        if ($loadedRelationType == $type) {
2019
            /** @var $query \eZ\Publish\Core\Persistence\Database\DeleteQuery */
2020
            $query = $this->dbHandler->createDeleteQuery();
2021
            $query->deleteFrom(
2022
                'ezcontentobject_link'
2023
            )->where(
2024
                $query->expr->eq(
2025
                    $this->dbHandler->quoteColumn('id'),
2026
                    $query->bindValue($relationId, null, \PDO::PARAM_INT)
2027
                )
2028
            );
2029
2030
            $query->prepare()->execute();
2031
        } elseif ($loadedRelationType & $type) { // If relation type is composite update bitmask
2032
            /** @var $query \eZ\Publish\Core\Persistence\Database\UpdateQuery */
2033
            $query = $this->dbHandler->createUpdateQuery();
2034
            $query->update(
2035
                $this->dbHandler->quoteTable('ezcontentobject_link')
2036
            )->set(
2037
                $this->dbHandler->quoteColumn('relation_type'),
2038
                $query->expr->bitAnd(
2039
                    $this->dbHandler->quoteColumn('relation_type'),
2040
                    $query->bindValue(~$type, null, \PDO::PARAM_INT)
2041
                )
2042
            )->where(
2043
                $query->expr->eq(
2044
                    $this->dbHandler->quoteColumn('id'),
2045
                    $query->bindValue($relationId, null, \PDO::PARAM_INT)
2046
                )
2047
            );
2048
2049
            $query->prepare()->execute();
2050
        } else {
2051
            // No match, do nothing
2052
        }
2053
    }
2054
2055
    /**
2056
     * Returns all Content IDs for a given $contentTypeId.
2057
     *
2058
     * @param int $contentTypeId
2059
     *
2060
     * @return int[]
2061
     */
2062 View Code Duplication
    public function getContentIdsByContentTypeId($contentTypeId)
2063
    {
2064
        $query = $this->dbHandler->createSelectQuery();
2065
        $query
2066
            ->select($this->dbHandler->quoteColumn('id'))
2067
            ->from($this->dbHandler->quoteTable('ezcontentobject'))
2068
            ->where(
2069
                $query->expr->eq(
2070
                    $this->dbHandler->quoteColumn('contentclass_id'),
2071
                    $query->bindValue($contentTypeId, null, PDO::PARAM_INT)
2072
                )
2073
            );
2074
2075
        $statement = $query->prepare();
2076
        $statement->execute();
2077
2078
        return $statement->fetchAll(PDO::FETCH_COLUMN);
2079
    }
2080
2081
    /**
2082
     * Load name data for set of content id's and corresponding version number.
2083
     *
2084
     * @param array[] $rows array of hashes with 'id' and 'version' to load names for
2085
     *
2086
     * @return array
2087
     */
2088
    public function loadVersionedNameData($rows)
2089
    {
2090
        $query = $this->queryBuilder->createNamesQuery();
2091
        $conditions = [];
2092
        foreach ($rows as $row) {
2093
            $conditions[] = $query->expr->lAnd(
2094
                $query->expr->eq(
2095
                    $this->dbHandler->quoteColumn('contentobject_id'),
2096
                    $query->bindValue($row['id'], null, \PDO::PARAM_INT)
2097
                ),
2098
                $query->expr->eq(
2099
                    $this->dbHandler->quoteColumn('content_version'),
2100
                    $query->bindValue($row['version'], null, \PDO::PARAM_INT)
2101
                )
2102
            );
2103
        }
2104
2105
        $query->where($query->expr->lOr($conditions));
2106
        $stmt = $query->prepare();
2107
        $stmt->execute();
2108
2109
        return $stmt->fetchAll(\PDO::FETCH_ASSOC);
2110
    }
2111
2112
    /**
2113
     * Batch method for copying all relation meta data for copied Content object.
2114
     *
2115
     * {@inheritdoc}
2116
     *
2117
     * @param int $originalContentId
2118
     * @param int $copiedContentId
2119
     * @param int|null $versionNo If specified only copy for a given version number, otherwise all.
2120
     */
2121
    public function copyRelations($originalContentId, $copiedContentId, $versionNo = null)
2122
    {
2123
        // Given we can retain all columns, we just create copies with new `from_contentobject_id` using INSERT INTO SELECT
2124
        $sql = 'INSERT INTO ezcontentobject_link ( contentclassattribute_id, from_contentobject_id, from_contentobject_version, relation_type, to_contentobject_id )
2125
                SELECT  L2.contentclassattribute_id, :copied_id, L2.from_contentobject_version, L2.relation_type, L2.to_contentobject_id
2126
                FROM    ezcontentobject_link AS L2
2127
                WHERE   L2.from_contentobject_id = :original_id';
2128
2129
        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...
2130
            $stmt = $this->connection->prepare($sql . ' AND L2.from_contentobject_version = :version');
2131
            $stmt->bindValue('version', $versionNo, PDO::PARAM_INT);
2132
        } else {
2133
            $stmt = $this->connection->prepare($sql);
2134
        }
2135
2136
        $stmt->bindValue('original_id', $originalContentId, PDO::PARAM_INT);
2137
        $stmt->bindValue('copied_id', $copiedContentId, PDO::PARAM_INT);
2138
2139
        $stmt->execute();
2140
    }
2141
2142
    /**
2143
     * Remove the specified translation from the Content Object Version.
2144
     *
2145
     * @param int $contentId
2146
     * @param string $languageCode language code of the translation
2147
     * @throws \Doctrine\DBAL\DBALException
2148
     */
2149 View Code Duplication
    public function deleteTranslationFromContent($contentId, $languageCode)
2150
    {
2151
        $language = $this->languageHandler->loadByLanguageCode($languageCode);
2152
2153
        $this->connection->beginTransaction();
2154
        try {
2155
            $this->deleteTranslationFromContentVersions($contentId, $language->id);
2156
            $this->deleteTranslationFromContentNames($contentId, $languageCode);
2157
            $this->deleteTranslationFromContentObject($contentId, $language->id);
2158
2159
            $this->connection->commit();
2160
        } catch (DBALException $e) {
2161
            $this->connection->rollBack();
2162
            throw $e;
2163
        }
2164
    }
2165
2166
    /**
2167
     * Delete Content fields (attributes) for the given Translation.
2168
     * If $versionNo is given, fields for that Version only will be deleted.
2169
     *
2170
     * @param string $languageCode
2171
     * @param int $contentId
2172
     * @param int $versionNo (optional) filter by versionNo
2173
     */
2174 View Code Duplication
    public function deleteTranslatedFields($languageCode, $contentId, $versionNo = null)
2175
    {
2176
        $query = $this->connection->createQueryBuilder();
2177
        $query
2178
            ->delete('ezcontentobject_attribute')
2179
            ->where('contentobject_id = :contentId')
2180
            ->andWhere('language_code = :languageCode')
2181
            ->setParameters(
2182
                [
2183
                    ':contentId' => $contentId,
2184
                    ':languageCode' => $languageCode,
2185
                ]
2186
            )
2187
        ;
2188
2189
        if (null !== $versionNo) {
2190
            $query
2191
                ->andWhere('version = :versionNo')
2192
                ->setParameter(':versionNo', $versionNo)
2193
            ;
2194
        }
2195
2196
        $query->execute();
2197
    }
2198
2199
    /**
2200
     * Delete the specified Translation from the given Version.
2201
     *
2202
     * @param int $contentId
2203
     * @param int $versionNo
2204
     * @param string $languageCode
2205
     * @throws \Doctrine\DBAL\DBALException
2206
     */
2207 View Code Duplication
    public function deleteTranslationFromVersion($contentId, $versionNo, $languageCode)
2208
    {
2209
        $language = $this->languageHandler->loadByLanguageCode($languageCode);
2210
2211
        $this->connection->beginTransaction();
2212
        try {
2213
            $this->deleteTranslationFromContentVersions($contentId, $language->id, $versionNo);
2214
            $this->deleteTranslationFromContentNames($contentId, $languageCode, $versionNo);
2215
2216
            $this->connection->commit();
2217
        } catch (DBALException $e) {
2218
            $this->connection->rollBack();
2219
            throw $e;
2220
        }
2221
    }
2222
2223
    /**
2224
     * Delete translation from the ezcontentobject_name table.
2225
     *
2226
     * @param int $contentId
2227
     * @param string $languageCode
2228
     * @param int $versionNo optional, if specified, apply to this Version only.
2229
     */
2230 View Code Duplication
    private function deleteTranslationFromContentNames($contentId, $languageCode, $versionNo = null)
2231
    {
2232
        $query = $this->connection->createQueryBuilder();
2233
        $query
2234
            ->delete('ezcontentobject_name')
2235
            ->where('contentobject_id=:contentId')
2236
            ->andWhere('real_translation=:languageCode')
2237
            ->setParameters(
2238
                [
2239
                    ':languageCode' => $languageCode,
2240
                    ':contentId' => $contentId,
2241
                ]
2242
            )
2243
        ;
2244
2245
        if (null !== $versionNo) {
2246
            $query
2247
                ->andWhere('content_version = :versionNo')
2248
                ->setParameter(':versionNo', $versionNo)
2249
            ;
2250
        }
2251
2252
        $query->execute();
2253
    }
2254
2255
    /**
2256
     * Remove language from language_mask of ezcontentobject.
2257
     *
2258
     * @param int $contentId
2259
     * @param int $languageId
2260
     * @throws \eZ\Publish\Core\Base\Exceptions\BadStateException
2261
     */
2262
    private function deleteTranslationFromContentObject($contentId, $languageId)
2263
    {
2264
        $query = $this->connection->createQueryBuilder();
2265
        $query->update('ezcontentobject')
2266
            // parameter for bitwise operation has to be placed verbatim (w/o binding) for this to work cross-DBMS
2267
            ->set('language_mask', 'language_mask & ~ ' . $languageId)
2268
            ->set('modified', ':now')
2269
            ->where('id = :contentId')
2270
            ->andWhere(
2271
            // make sure removed translation is not the last one (incl. alwaysAvailable)
2272
                $query->expr()->andX(
2273
                    'language_mask & ~ ' . $languageId . ' <> 0',
2274
                    'language_mask & ~ ' . $languageId . ' <> 1'
2275
                )
2276
            )
2277
            ->setParameter(':now', time())
2278
            ->setParameter(':contentId', $contentId)
2279
        ;
2280
2281
        $rowCount = $query->execute();
2282
2283
        // no rows updated means that most likely somehow it was the last remaining translation
2284
        if ($rowCount === 0) {
2285
            throw new BadStateException(
2286
                '$languageCode',
2287
                'Specified translation is the only one Content Object Version has'
2288
            );
2289
        }
2290
    }
2291
2292
    /**
2293
     * Remove language from language_mask of ezcontentobject_version and update initialLanguageId
2294
     * if it matches the removed one.
2295
     *
2296
     * @param int $contentId
2297
     * @param int $languageId
2298
     * @param int $versionNo optional, if specified, apply to this Version only.
2299
     * @throws \eZ\Publish\Core\Base\Exceptions\BadStateException
2300
     */
2301
    private function deleteTranslationFromContentVersions($contentId, $languageId, $versionNo = null)
2302
    {
2303
        $query = $this->connection->createQueryBuilder();
2304
        $query->update('ezcontentobject_version')
2305
            // parameter for bitwise operation has to be placed verbatim (w/o binding) for this to work cross-DBMS
2306
            ->set('language_mask', 'language_mask & ~ ' . $languageId)
2307
            ->set('modified', ':now')
2308
            // update initial_language_id only if it matches removed translation languageId
2309
            ->set(
2310
                'initial_language_id',
2311
                'CASE WHEN initial_language_id = :languageId ' .
2312
                'THEN (SELECT initial_language_id AS main_language_id FROM ezcontentobject c WHERE c.id = :contentId) ' .
2313
                'ELSE initial_language_id END'
2314
            )
2315
            ->where('contentobject_id = :contentId')
2316
            ->andWhere(
2317
            // make sure removed translation is not the last one (incl. alwaysAvailable)
2318
                $query->expr()->andX(
2319
                    'language_mask & ~ ' . $languageId . ' <> 0',
2320
                    'language_mask & ~ ' . $languageId . ' <> 1'
2321
                )
2322
            )
2323
            ->setParameter(':now', time())
2324
            ->setParameter(':contentId', $contentId)
2325
            ->setParameter(':languageId', $languageId)
2326
        ;
2327
2328
        if (null !== $versionNo) {
2329
            $query
2330
                ->andWhere('version = :versionNo')
2331
                ->setParameter(':versionNo', $versionNo)
2332
            ;
2333
        }
2334
2335
        $rowCount = $query->execute();
2336
2337
        // no rows updated means that most likely somehow it was the last remaining translation
2338
        if ($rowCount === 0) {
2339
            throw new BadStateException(
2340
                '$languageCode',
2341
                'Specified translation is the only one Content Object Version has'
2342
            );
2343
        }
2344
    }
2345
}
2346