Completed
Push — master ( 5acaba...f6e111 )
by Łukasz
31:51
created

DoctrineDatabase::updateContent()   F

Complexity

Conditions 11
Paths 512

Size

Total Lines 71

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 71
c 0
b 0
f 0
cc 11
nc 512
nop 3
rs 3.6949

How to fix   Long Method    Complexity   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

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

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

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

An additional type check may prevent trouble.

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

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

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

An additional type check may prevent trouble.

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

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

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

    return array();
}

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

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

Loading history...
964
            );
965
966
        return $queryBuilder;
967
    }
968
969
    /**
970
     * Loads info for content identified by $contentId.
971
     * Will basically return a hash containing all field values for ezcontentobject table plus some additional keys:
972
     *  - always_available => Boolean indicating if content's language mask contains alwaysAvailable bit field
973
     *  - main_language_code => Language code for main (initial) language. E.g. "eng-GB".
974
     *
975
     * @param int $contentId
976
     *
977
     * @throws \eZ\Publish\Core\Base\Exceptions\NotFoundException
978
     *
979
     * @return array
980
     */
981 View Code Duplication
    public function loadContentInfo($contentId)
982
    {
983
        $queryBuilder = $this->createLoadContentInfoQueryBuilder();
984
        $queryBuilder
985
            ->where('c.id = :id')
986
            ->setParameter('id', $contentId, ParameterType::INTEGER);
987
988
        $results = $queryBuilder->execute()->fetchAll(FetchMode::ASSOCIATIVE);
989
        if (empty($results)) {
990
            throw new NotFound('content', "id: $contentId");
991
        }
992
993
        return $results[0];
994
    }
995
996
    public function loadContentInfoList(array $contentIds)
997
    {
998
        $queryBuilder = $this->createLoadContentInfoQueryBuilder();
999
        $queryBuilder
1000
            ->where('c.id IN (:ids)')
1001
            ->setParameter('ids', $contentIds, Connection::PARAM_INT_ARRAY);
1002
1003
        return $queryBuilder->execute()->fetchAll(FetchMode::ASSOCIATIVE);
1004
    }
1005
1006
    /**
1007
     * Loads info for a content object identified by its remote ID.
1008
     *
1009
     * Returns an array with the relevant data.
1010
     *
1011
     * @param mixed $remoteId
1012
     *
1013
     * @throws \eZ\Publish\Core\Base\Exceptions\NotFoundException
1014
     *
1015
     * @return array
1016
     */
1017 View Code Duplication
    public function loadContentInfoByRemoteId($remoteId)
1018
    {
1019
        $queryBuilder = $this->createLoadContentInfoQueryBuilder();
1020
        $queryBuilder
1021
            ->where('c.remote_id = :id')
1022
            ->setParameter('id', $remoteId, ParameterType::STRING);
1023
1024
        $results = $queryBuilder->execute()->fetchAll(FetchMode::ASSOCIATIVE);
1025
        if (empty($results)) {
1026
            throw new NotFound('content', "remote_id: $remoteId");
1027
        }
1028
1029
        return $results[0];
1030
    }
1031
1032
    /**
1033
     * Loads info for a content object identified by its location ID (node ID).
1034
     *
1035
     * Returns an array with the relevant data.
1036
     *
1037
     * @param int $locationId
1038
     *
1039
     * @throws \eZ\Publish\Core\Base\Exceptions\NotFoundException
1040
     *
1041
     * @return array
1042
     */
1043 View Code Duplication
    public function loadContentInfoByLocationId($locationId)
1044
    {
1045
        $queryBuilder = $this->createLoadContentInfoQueryBuilder(false);
1046
        $queryBuilder
1047
            ->where('t.node_id = :id')
1048
            ->setParameter('id', $locationId, ParameterType::INTEGER);
1049
1050
        $results = $queryBuilder->execute()->fetchAll(FetchMode::ASSOCIATIVE);
1051
        if (empty($results)) {
1052
            throw new NotFound('content', "node_id: $locationId");
1053
        }
1054
1055
        return $results[0];
1056
    }
1057
1058
    /**
1059
     * Loads version info for content identified by $contentId and $versionNo.
1060
     * Will basically return a hash containing all field values from ezcontentobject_version table plus following keys:
1061
     *  - names => Hash of content object names. Key is the language code, value is the name.
1062
     *  - languages => Hash of language ids. Key is the language code (e.g. "eng-GB"), value is the language numeric id without the always available bit.
1063
     *  - initial_language_code => Language code for initial language in this version.
1064
     *
1065
     * @param int $contentId
1066
     * @param int $versionNo
1067
     *
1068
     * @return array
1069
     */
1070 View Code Duplication
    public function loadVersionInfo($contentId, $versionNo)
1071
    {
1072
        $query = $this->queryBuilder->createVersionInfoFindQuery();
1073
        $query->where(
1074
            $query->expr->lAnd(
1075
                $query->expr->eq(
1076
                    $this->dbHandler->quoteColumn('contentobject_id', 'ezcontentobject_version'),
1077
                    $query->bindValue($contentId, null, \PDO::PARAM_INT)
1078
                ),
1079
                $query->expr->eq(
1080
                    $this->dbHandler->quoteColumn('version', 'ezcontentobject_version'),
1081
                    $query->bindValue($versionNo, null, \PDO::PARAM_INT)
1082
                )
1083
            )
1084
        );
1085
        $statement = $query->prepare();
1086
        $statement->execute();
1087
1088
        return $statement->fetchAll(\PDO::FETCH_ASSOC);
1089
    }
1090
1091
    /**
1092
     * Returns data for all versions with given status created by the given $userId.
1093
     *
1094
     * @param int $userId
1095
     * @param int $status
1096
     *
1097
     * @return string[][]
1098
     */
1099
    public function listVersionsForUser($userId, $status = VersionInfo::STATUS_DRAFT)
1100
    {
1101
        $query = $this->queryBuilder->createVersionInfoFindQuery();
1102
        $query->where(
1103
            $query->expr->lAnd(
1104
                $query->expr->eq(
1105
                    $this->dbHandler->quoteColumn('status', 'ezcontentobject_version'),
1106
                    $query->bindValue($status, null, \PDO::PARAM_INT)
1107
                ),
1108
                $query->expr->eq(
1109
                    $this->dbHandler->quoteColumn('creator_id', 'ezcontentobject_version'),
1110
                    $query->bindValue($userId, null, \PDO::PARAM_INT)
1111
                )
1112
            )
1113
        );
1114
1115
        return $this->listVersionsHelper($query);
1116
    }
1117
1118
    /**
1119
     * Returns all version data for the given $contentId, optionally filtered by status.
1120
     *
1121
     * Result is returned with oldest version first (using version id as it has index and is auto increment).
1122
     *
1123
     * @param mixed $contentId
1124
     * @param mixed|null $status Optional argument to filter versions by status, like {@see VersionInfo::STATUS_ARCHIVED}.
1125
     * @param int $limit Limit for items returned, -1 means none.
1126
     *
1127
     * @return string[][]
1128
     */
1129
    public function listVersions($contentId, $status = null, $limit = -1)
1130
    {
1131
        $query = $this->queryBuilder->createVersionInfoFindQuery();
1132
1133
        $filter = $query->expr->eq(
1134
            $this->dbHandler->quoteColumn('contentobject_id', 'ezcontentobject_version'),
1135
            $query->bindValue($contentId, null, \PDO::PARAM_INT)
1136
        );
1137
1138
        if ($status !== null) {
1139
            $filter = $query->expr->lAnd(
1140
                $filter,
1141
                $query->expr->eq(
1142
                    $this->dbHandler->quoteColumn('status', 'ezcontentobject_version'),
1143
                    $query->bindValue($status, null, \PDO::PARAM_INT)
1144
                )
1145
            );
1146
        }
1147
1148
        $query->where($filter);
1149
1150
        if ($limit > 0) {
1151
            $query->limit($limit);
1152
        }
1153
1154
        return $this->listVersionsHelper($query);
1155
    }
1156
1157
    /**
1158
     * Helper for {@see listVersions()} and {@see listVersionsForUser()} that filters duplicates
1159
     * that are the result of the cartesian product performed by createVersionInfoFindQuery().
1160
     *
1161
     * @param \eZ\Publish\Core\Persistence\Database\SelectQuery $query
1162
     *
1163
     * @return string[][]
1164
     */
1165
    private function listVersionsHelper(SelectQuery $query)
1166
    {
1167
        $query->orderBy(
1168
            $this->dbHandler->quoteColumn('id', 'ezcontentobject_version')
1169
        );
1170
1171
        $statement = $query->prepare();
1172
        $statement->execute();
1173
1174
        $results = array();
1175
        $previousId = null;
1176
        foreach ($statement->fetchAll(\PDO::FETCH_ASSOC) as $row) {
1177
            if ($row['ezcontentobject_version_id'] == $previousId) {
1178
                continue;
1179
            }
1180
1181
            $previousId = $row['ezcontentobject_version_id'];
1182
            $results[] = $row;
1183
        }
1184
1185
        return $results;
1186
    }
1187
1188
    /**
1189
     * Returns all version numbers for the given $contentId.
1190
     *
1191
     * @param mixed $contentId
1192
     *
1193
     * @return int[]
1194
     */
1195
    public function listVersionNumbers($contentId)
1196
    {
1197
        $query = $this->dbHandler->createSelectQuery();
1198
        $query->selectDistinct(
1199
            $this->dbHandler->quoteColumn('version')
1200
        )->from(
1201
            $this->dbHandler->quoteTable('ezcontentobject_version')
1202
        )->where(
1203
            $query->expr->eq(
1204
                $this->dbHandler->quoteColumn('contentobject_id'),
1205
                $query->bindValue($contentId, null, \PDO::PARAM_INT)
1206
            )
1207
        );
1208
1209
        $statement = $query->prepare();
1210
        $statement->execute();
1211
1212
        return $statement->fetchAll(\PDO::FETCH_COLUMN);
1213
    }
1214
1215
    /**
1216
     * Returns last version number for content identified by $contentId.
1217
     *
1218
     * @param int $contentId
1219
     *
1220
     * @return int
1221
     */
1222
    public function getLastVersionNumber($contentId)
1223
    {
1224
        $query = $this->dbHandler->createSelectQuery();
1225
        $query->select(
1226
            $query->expr->max($this->dbHandler->quoteColumn('version'))
1227
        )->from(
1228
            $this->dbHandler->quoteTable('ezcontentobject_version')
1229
        )->where(
1230
            $query->expr->eq(
1231
                $this->dbHandler->quoteColumn('contentobject_id'),
1232
                $query->bindValue($contentId, null, \PDO::PARAM_INT)
1233
            )
1234
        );
1235
1236
        $statement = $query->prepare();
1237
        $statement->execute();
1238
1239
        return (int)$statement->fetchColumn();
1240
    }
1241
1242
    /**
1243
     * Returns all IDs for locations that refer to $contentId.
1244
     *
1245
     * @param int $contentId
1246
     *
1247
     * @return int[]
1248
     */
1249
    public function getAllLocationIds($contentId)
1250
    {
1251
        $query = $this->dbHandler->createSelectQuery();
1252
        $query->select(
1253
            $this->dbHandler->quoteColumn('node_id')
1254
        )->from(
1255
            $this->dbHandler->quoteTable('ezcontentobject_tree')
1256
        )->where(
1257
            $query->expr->eq(
1258
                $this->dbHandler->quoteColumn('contentobject_id'),
1259
                $query->bindValue($contentId, null, \PDO::PARAM_INT)
1260
            )
1261
        );
1262
1263
        $statement = $query->prepare();
1264
        $statement->execute();
1265
1266
        return $statement->fetchAll(\PDO::FETCH_COLUMN);
1267
    }
1268
1269
    /**
1270
     * Returns all field IDs of $contentId grouped by their type.
1271
     * If $versionNo is set only field IDs for that version are returned.
1272
     * If $languageCode is set, only field IDs for that language are returned.
1273
     *
1274
     * @param int $contentId
1275
     * @param int|null $versionNo
1276
     * @param string|null $languageCode
1277
     *
1278
     * @return int[][]
1279
     */
1280
    public function getFieldIdsByType($contentId, $versionNo = null, $languageCode = null)
1281
    {
1282
        $query = $this->dbHandler->createSelectQuery();
1283
        $query->select(
1284
            $this->dbHandler->quoteColumn('id'),
1285
            $this->dbHandler->quoteColumn('data_type_string')
1286
        )->from(
1287
            $this->dbHandler->quoteTable('ezcontentobject_attribute')
1288
        )->where(
1289
            $query->expr->eq(
1290
                $this->dbHandler->quoteColumn('contentobject_id'),
1291
                $query->bindValue($contentId, null, \PDO::PARAM_INT)
1292
            )
1293
        );
1294
1295
        if (isset($versionNo)) {
1296
            $query->where(
1297
                $query->expr->eq(
1298
                    $this->dbHandler->quoteColumn('version'),
1299
                    $query->bindValue($versionNo, null, \PDO::PARAM_INT)
1300
                )
1301
            );
1302
        }
1303
1304
        if (isset($languageCode)) {
1305
            $query->where(
1306
                $query->expr->eq(
1307
                    $this->dbHandler->quoteColumn('language_code'),
1308
                    $query->bindValue($languageCode, null, \PDO::PARAM_STR)
1309
                )
1310
            );
1311
        }
1312
1313
        $statement = $query->prepare();
1314
        $statement->execute();
1315
1316
        $result = array();
1317
        foreach ($statement->fetchAll() as $row) {
1318
            if (!isset($result[$row['data_type_string']])) {
1319
                $result[$row['data_type_string']] = array();
1320
            }
1321
            $result[$row['data_type_string']][] = (int)$row['id'];
1322
        }
1323
1324
        return $result;
1325
    }
1326
1327
    /**
1328
     * Deletes relations to and from $contentId.
1329
     * If $versionNo is set only relations for that version are deleted.
1330
     *
1331
     * @param int $contentId
1332
     * @param int|null $versionNo
1333
     */
1334
    public function deleteRelations($contentId, $versionNo = null)
1335
    {
1336
        $query = $this->dbHandler->createDeleteQuery();
1337
        $query->deleteFrom(
1338
            $this->dbHandler->quoteTable('ezcontentobject_link')
1339
        );
1340
1341
        if (isset($versionNo)) {
1342
            $query->where(
1343
                $query->expr->lAnd(
1344
                    $query->expr->eq(
1345
                        $this->dbHandler->quoteColumn('from_contentobject_id'),
1346
                        $query->bindValue($contentId, null, \PDO::PARAM_INT)
1347
                    ),
1348
                    $query->expr->eq(
1349
                        $this->dbHandler->quoteColumn('from_contentobject_version'),
1350
                        $query->bindValue($versionNo, null, \PDO::PARAM_INT)
1351
                    )
1352
                )
1353
            );
1354
        } else {
1355
            $query->where(
1356
                $query->expr->lOr(
1357
                    $query->expr->eq(
1358
                        $this->dbHandler->quoteColumn('from_contentobject_id'),
1359
                        $query->bindValue($contentId, null, \PDO::PARAM_INT)
1360
                    ),
1361
                    $query->expr->eq(
1362
                        $this->dbHandler->quoteColumn('to_contentobject_id'),
1363
                        $query->bindValue($contentId, null, \PDO::PARAM_INT)
1364
                    )
1365
                )
1366
            );
1367
        }
1368
1369
        $query->prepare()->execute();
1370
    }
1371
1372
    /**
1373
     * Removes relations to Content with $contentId from Relation and RelationList field type fields.
1374
     *
1375
     * @param int $contentId
1376
     */
1377
    public function removeReverseFieldRelations($contentId)
1378
    {
1379
        $query = $this->dbHandler->createSelectQuery();
1380
        $query
1381
            ->select('ezcontentobject_attribute.*')
1382
            ->from('ezcontentobject_attribute')
1383
            ->innerJoin(
1384
                'ezcontentobject_link',
1385
                $query->expr->lAnd(
1386
                    $query->expr->eq(
1387
                        $this->dbHandler->quoteColumn('from_contentobject_id', 'ezcontentobject_link'),
1388
                        $this->dbHandler->quoteColumn('contentobject_id', 'ezcontentobject_attribute')
1389
                    ),
1390
                    $query->expr->eq(
1391
                        $this->dbHandler->quoteColumn('from_contentobject_version', 'ezcontentobject_link'),
1392
                        $this->dbHandler->quoteColumn('version', 'ezcontentobject_attribute')
1393
                    ),
1394
                    $query->expr->eq(
1395
                        $this->dbHandler->quoteColumn('contentclassattribute_id', 'ezcontentobject_link'),
1396
                        $this->dbHandler->quoteColumn('contentclassattribute_id', 'ezcontentobject_attribute')
1397
                    )
1398
                )
1399
            )
1400
            ->where(
1401
                $query->expr->eq(
1402
                    $this->dbHandler->quoteColumn('to_contentobject_id', 'ezcontentobject_link'),
1403
                    $query->bindValue($contentId, null, PDO::PARAM_INT)
1404
                ),
1405
                $query->expr->gt(
1406
                    $query->expr->bitAnd(
1407
                        $this->dbHandler->quoteColumn('relation_type', 'ezcontentobject_link'),
1408
                        $query->bindValue(8, null, PDO::PARAM_INT)
1409
                    ),
1410
                    0
1411
                )
1412
            );
1413
1414
        $statement = $query->prepare();
1415
        $statement->execute();
1416
1417
        while ($row = $statement->fetch(PDO::FETCH_ASSOC)) {
1418
            if ($row['data_type_string'] === 'ezobjectrelation') {
1419
                $this->removeRelationFromRelationField($row);
1420
            }
1421
1422
            if ($row['data_type_string'] === 'ezobjectrelationlist') {
1423
                $this->removeRelationFromRelationListField($contentId, $row);
1424
            }
1425
        }
1426
    }
1427
1428
    /**
1429
     * Updates field value of RelationList field type identified by given $row data,
1430
     * removing relations toward given $contentId.
1431
     *
1432
     * @param int $contentId
1433
     * @param array $row
1434
     */
1435
    protected function removeRelationFromRelationListField($contentId, array $row)
1436
    {
1437
        $document = new DOMDocument('1.0', 'utf-8');
1438
        $document->loadXML($row['data_text']);
1439
1440
        $xpath = new DOMXPath($document);
1441
        $xpathExpression = "//related-objects/relation-list/relation-item[@contentobject-id='{$contentId}']";
1442
1443
        $relationItems = $xpath->query($xpathExpression);
1444
        foreach ($relationItems as $relationItem) {
1445
            $relationItem->parentNode->removeChild($relationItem);
1446
        }
1447
1448
        $query = $this->dbHandler->createUpdateQuery();
1449
        $query
1450
            ->update('ezcontentobject_attribute')
1451
            ->set(
1452
                'data_text',
1453
                $query->bindValue($document->saveXML(), null, PDO::PARAM_STR)
1454
            )
1455
            ->where(
1456
                $query->expr->lAnd(
1457
                    $query->expr->eq(
1458
                        $this->dbHandler->quoteColumn('id'),
1459
                        $query->bindValue($row['id'], null, PDO::PARAM_INT)
1460
                    ),
1461
                    $query->expr->eq(
1462
                        $this->dbHandler->quoteColumn('version'),
1463
                        $query->bindValue($row['version'], null, PDO::PARAM_INT)
1464
                    )
1465
                )
1466
            );
1467
1468
        $query->prepare()->execute();
1469
    }
1470
1471
    /**
1472
     * Updates field value of Relation field type identified by given $row data,
1473
     * removing relation data.
1474
     *
1475
     * @param array $row
1476
     */
1477
    protected function removeRelationFromRelationField(array $row)
1478
    {
1479
        $query = $this->dbHandler->createUpdateQuery();
1480
        $query
1481
            ->update('ezcontentobject_attribute')
1482
            ->set('data_int', $query->bindValue(null, null, PDO::PARAM_INT))
1483
            ->set('sort_key_int', $query->bindValue(0, null, PDO::PARAM_INT))
1484
            ->where(
1485
                $query->expr->lAnd(
1486
                    $query->expr->eq(
1487
                        $this->dbHandler->quoteColumn('id'),
1488
                        $query->bindValue($row['id'], null, PDO::PARAM_INT)
1489
                    ),
1490
                    $query->expr->eq(
1491
                        $this->dbHandler->quoteColumn('version'),
1492
                        $query->bindValue($row['version'], null, PDO::PARAM_INT)
1493
                    )
1494
                )
1495
            );
1496
1497
        $query->prepare()->execute();
1498
    }
1499
1500
    /**
1501
     * Deletes the field with the given $fieldId.
1502
     *
1503
     * @param int $fieldId
1504
     */
1505
    public function deleteField($fieldId)
1506
    {
1507
        $query = $this->dbHandler->createDeleteQuery();
1508
        $query->deleteFrom(
1509
            $this->dbHandler->quoteTable('ezcontentobject_attribute')
1510
        )->where(
1511
            $query->expr->eq(
1512
                $this->dbHandler->quoteColumn('id'),
1513
                $query->bindValue($fieldId, null, \PDO::PARAM_INT)
1514
            )
1515
        );
1516
1517
        $query->prepare()->execute();
1518
    }
1519
1520
    /**
1521
     * Deletes all fields of $contentId in all versions.
1522
     * If $versionNo is set only fields for that version are deleted.
1523
     *
1524
     * @param int $contentId
1525
     * @param int|null $versionNo
1526
     */
1527
    public function deleteFields($contentId, $versionNo = null)
1528
    {
1529
        $query = $this->dbHandler->createDeleteQuery();
1530
        $query->deleteFrom('ezcontentobject_attribute')
1531
            ->where(
1532
                $query->expr->eq(
1533
                    $this->dbHandler->quoteColumn('contentobject_id'),
1534
                    $query->bindValue($contentId, null, \PDO::PARAM_INT)
1535
                )
1536
            );
1537
1538
        if (isset($versionNo)) {
1539
            $query->where(
1540
                $query->expr->eq(
1541
                    $this->dbHandler->quoteColumn('version'),
1542
                    $query->bindValue($versionNo, null, \PDO::PARAM_INT)
1543
                )
1544
            );
1545
        }
1546
1547
        $query->prepare()->execute();
1548
    }
1549
1550
    /**
1551
     * Deletes all versions of $contentId.
1552
     * If $versionNo is set only that version is deleted.
1553
     *
1554
     * @param int $contentId
1555
     * @param int|null $versionNo
1556
     */
1557
    public function deleteVersions($contentId, $versionNo = null)
1558
    {
1559
        $query = $this->dbHandler->createDeleteQuery();
1560
        $query->deleteFrom('ezcontentobject_version')
1561
            ->where(
1562
                $query->expr->eq(
1563
                    $this->dbHandler->quoteColumn('contentobject_id'),
1564
                    $query->bindValue($contentId, null, \PDO::PARAM_INT)
1565
                )
1566
            );
1567
1568
        if (isset($versionNo)) {
1569
            $query->where(
1570
                $query->expr->eq(
1571
                    $this->dbHandler->quoteColumn('version'),
1572
                    $query->bindValue($versionNo, null, \PDO::PARAM_INT)
1573
                )
1574
            );
1575
        }
1576
1577
        $query->prepare()->execute();
1578
    }
1579
1580
    /**
1581
     * Deletes all names of $contentId.
1582
     * If $versionNo is set only names for that version are deleted.
1583
     *
1584
     * @param int $contentId
1585
     * @param int|null $versionNo
1586
     */
1587
    public function deleteNames($contentId, $versionNo = null)
1588
    {
1589
        $query = $this->dbHandler->createDeleteQuery();
1590
        $query->deleteFrom('ezcontentobject_name')
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('content_version'),
1602
                    $query->bindValue($versionNo, null, \PDO::PARAM_INT)
1603
                )
1604
            );
1605
        }
1606
1607
        $query->prepare()->execute();
1608
    }
1609
1610
    /**
1611
     * Sets the name for Content $contentId in version $version to $name in $language.
1612
     *
1613
     * @param int $contentId
1614
     * @param int $version
1615
     * @param string $name
1616
     * @param string $language
1617
     */
1618
    public function setName($contentId, $version, $name, $language)
1619
    {
1620
        $language = $this->languageHandler->loadByLanguageCode($language);
1621
1622
        // Is it an insert or an update ?
1623
        $qSelect = $this->dbHandler->createSelectQuery();
1624
        $qSelect
1625
            ->select(
1626
                $qSelect->alias($qSelect->expr->count('*'), 'count')
1627
            )
1628
            ->from($this->dbHandler->quoteTable('ezcontentobject_name'))
1629
            ->where(
1630
                $qSelect->expr->lAnd(
1631
                    $qSelect->expr->eq($this->dbHandler->quoteColumn('contentobject_id'), $qSelect->bindValue($contentId)),
1632
                    $qSelect->expr->eq($this->dbHandler->quoteColumn('content_version'), $qSelect->bindValue($version)),
1633
                    $qSelect->expr->eq($this->dbHandler->quoteColumn('content_translation'), $qSelect->bindValue($language->languageCode))
1634
                )
1635
            );
1636
        $stmt = $qSelect->prepare();
1637
        $stmt->execute();
1638
        $res = $stmt->fetchAll(\PDO::FETCH_ASSOC);
1639
1640
        $insert = $res[0]['count'] == 0;
1641
        if ($insert) {
1642
            $q = $this->dbHandler->createInsertQuery();
1643
            $q->insertInto($this->dbHandler->quoteTable('ezcontentobject_name'));
1644
        } else {
1645
            $q = $this->dbHandler->createUpdateQuery();
1646
            $q->update($this->dbHandler->quoteTable('ezcontentobject_name'))
1647
                ->where(
1648
                    $q->expr->lAnd(
1649
                        $q->expr->eq($this->dbHandler->quoteColumn('contentobject_id'), $q->bindValue($contentId)),
1650
                        $q->expr->eq($this->dbHandler->quoteColumn('content_version'), $q->bindValue($version)),
1651
                        $q->expr->eq($this->dbHandler->quoteColumn('content_translation'), $q->bindValue($language->languageCode))
1652
                    )
1653
                );
1654
        }
1655
1656
        $q->set(
1657
            $this->dbHandler->quoteColumn('contentobject_id'),
1658
            $q->bindValue($contentId, null, \PDO::PARAM_INT)
1659
        )->set(
1660
            $this->dbHandler->quoteColumn('content_version'),
1661
            $q->bindValue($version, null, \PDO::PARAM_INT)
1662
        )->set(
1663
            $this->dbHandler->quoteColumn('language_id'),
1664
            '(' . $this->getLanguageQuery()->getQuery() . ')'
1665
        )->set(
1666
            $this->dbHandler->quoteColumn('content_translation'),
1667
            $q->bindValue($language->languageCode)
1668
        )->set(
1669
            $this->dbHandler->quoteColumn('real_translation'),
1670
            $q->bindValue($language->languageCode)
1671
        )->set(
1672
            $this->dbHandler->quoteColumn('name'),
1673
            $q->bindValue($name)
1674
        );
1675
        $q->bindValue($language->id, ':languageId', \PDO::PARAM_INT);
1676
        $q->bindValue($contentId, ':contentId', \PDO::PARAM_INT);
1677
        $q->prepare()->execute();
1678
    }
1679
1680
    /**
1681
     * Returns a language sub select query for setName.
1682
     *
1683
     * Return sub select query which gets proper language mask for alwaysAvailable Content.
1684
     *
1685
     * @return \eZ\Publish\Core\Persistence\Database\SelectQuery
1686
     */
1687
    private function getLanguageQuery()
1688
    {
1689
        $languageQuery = $this->dbHandler->createSelectQuery();
1690
        $languageQuery
1691
            ->select(
1692
                $languageQuery->expr->searchedCase(
1693
                    [
1694
                        $languageQuery->expr->lAnd(
1695
                            $languageQuery->expr->eq(
1696
                                $this->dbHandler->quoteColumn('initial_language_id'),
1697
                                ':languageId'
1698
                            ),
1699
                            // wrap bitwise check into another "neq" to provide cross-DBMS compatibility
1700
                            $languageQuery->expr->neq(
1701
                                $languageQuery->expr->bitAnd(
1702
                                    $this->dbHandler->quoteColumn('language_mask'),
1703
                                    ':languageId'
1704
                                ),
1705
                                0
1706
                            )
1707
                        ),
1708
                        $languageQuery->expr->bitOr(
1709
                            ':languageId',
1710
                            1
1711
                        ),
1712
                    ],
1713
                    ':languageId'
1714
                )
1715
            )
1716
            ->from('ezcontentobject')
1717
            ->where(
1718
                $languageQuery->expr->eq(
1719
                    'id',
1720
                    ':contentId'
1721
                )
1722
            );
1723
1724
        return $languageQuery;
1725
    }
1726
1727
    /**
1728
     * Deletes the actual content object referred to by $contentId.
1729
     *
1730
     * @param int $contentId
1731
     */
1732
    public function deleteContent($contentId)
1733
    {
1734
        $query = $this->dbHandler->createDeleteQuery();
1735
        $query->deleteFrom('ezcontentobject')
1736
            ->where(
1737
                $query->expr->eq(
1738
                    $this->dbHandler->quoteColumn('id'),
1739
                    $query->bindValue($contentId, null, \PDO::PARAM_INT)
1740
                )
1741
            );
1742
1743
        $query->prepare()->execute();
1744
    }
1745
1746
    /**
1747
     * Loads relations from $contentId to published content, optionally only from $contentVersionNo.
1748
     *
1749
     * $relationType can also be filtered.
1750
     *
1751
     * @param int $contentId
1752
     * @param int $contentVersionNo
1753
     * @param int $relationType
1754
     *
1755
     * @return string[][] array of relation data
1756
     */
1757
    public function loadRelations($contentId, $contentVersionNo = null, $relationType = null)
1758
    {
1759
        $query = $this->queryBuilder->createRelationFindQuery();
1760
        $query->innerJoin(
1761
            $query->alias(
1762
                $this->dbHandler->quoteTable('ezcontentobject'),
1763
                'ezcontentobject_to'
1764
            ),
1765
            $query->expr->lAnd(
1766
                $query->expr->eq(
1767
                    $this->dbHandler->quoteColumn('to_contentobject_id', 'ezcontentobject_link'),
1768
                    $this->dbHandler->quoteColumn('id', 'ezcontentobject_to')
1769
                ),
1770
                $query->expr->eq(
1771
                    $this->dbHandler->quoteColumn('status', 'ezcontentobject_to'),
1772
                    $query->bindValue(1, null, \PDO::PARAM_INT)
1773
                )
1774
            )
1775
        )->where(
1776
            $query->expr->eq(
1777
                $this->dbHandler->quoteColumn('from_contentobject_id', 'ezcontentobject_link'),
1778
                $query->bindValue($contentId, null, \PDO::PARAM_INT)
1779
            )
1780
        );
1781
1782
        // source version number
1783
        if (isset($contentVersionNo)) {
1784
            $query->where(
1785
                $query->expr->eq(
1786
                    $this->dbHandler->quoteColumn('from_contentobject_version', 'ezcontentobject_link'),
1787
                    $query->bindValue($contentVersionNo, null, \PDO::PARAM_INT)
1788
                )
1789
            );
1790
        } else { // from published version only
1791
            $query->from(
1792
                $this->dbHandler->quoteTable('ezcontentobject')
1793
            )->where(
1794
                $query->expr->lAnd(
1795
                    $query->expr->eq(
1796
                        $this->dbHandler->quoteColumn('id', 'ezcontentobject'),
1797
                        $this->dbHandler->quoteColumn('from_contentobject_id', 'ezcontentobject_link')
1798
                    ),
1799
                    $query->expr->eq(
1800
                        $this->dbHandler->quoteColumn('current_version', 'ezcontentobject'),
1801
                        $this->dbHandler->quoteColumn('from_contentobject_version', 'ezcontentobject_link')
1802
                    )
1803
                )
1804
            );
1805
        }
1806
1807
        // relation type
1808 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...
1809
            $query->where(
1810
                $query->expr->gt(
1811
                    $query->expr->bitAnd(
1812
                        $this->dbHandler->quoteColumn('relation_type', 'ezcontentobject_link'),
1813
                        $query->bindValue($relationType, null, \PDO::PARAM_INT)
1814
                    ),
1815
                    0
1816
                )
1817
            );
1818
        }
1819
1820
        $statement = $query->prepare();
1821
        $statement->execute();
1822
1823
        return $statement->fetchAll(\PDO::FETCH_ASSOC);
1824
    }
1825
1826
    /**
1827
     * Loads data that related to $toContentId.
1828
     *
1829
     * @param int $toContentId
1830
     * @param int $relationType
1831
     *
1832
     * @return mixed[][] Content data, array structured like {@see \eZ\Publish\Core\Persistence\Legacy\Content\Gateway::load()}
1833
     */
1834
    public function loadReverseRelations($toContentId, $relationType = null)
1835
    {
1836
        $query = $this->queryBuilder->createRelationFindQuery();
1837
        $query->where(
1838
            $query->expr->eq(
1839
                $this->dbHandler->quoteColumn('to_contentobject_id', 'ezcontentobject_link'),
1840
                $query->bindValue($toContentId, null, \PDO::PARAM_INT)
1841
            )
1842
        );
1843
1844
        // ezcontentobject join
1845
        $query->from(
1846
            $this->dbHandler->quoteTable('ezcontentobject')
1847
        )->where(
1848
            $query->expr->lAnd(
1849
                $query->expr->eq(
1850
                    $this->dbHandler->quoteColumn('id', 'ezcontentobject'),
1851
                    $this->dbHandler->quoteColumn('from_contentobject_id', 'ezcontentobject_link')
1852
                ),
1853
                $query->expr->eq(
1854
                    $this->dbHandler->quoteColumn('current_version', 'ezcontentobject'),
1855
                    $this->dbHandler->quoteColumn('from_contentobject_version', 'ezcontentobject_link')
1856
                ),
1857
                $query->expr->eq(
1858
                    $this->dbHandler->quoteColumn('status', 'ezcontentobject'),
1859
                    $query->bindValue(1, null, \PDO::PARAM_INT)
1860
                )
1861
            )
1862
        );
1863
1864
        // relation type
1865 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...
1866
            $query->where(
1867
                $query->expr->gt(
1868
                    $query->expr->bitAnd(
1869
                        $this->dbHandler->quoteColumn('relation_type', 'ezcontentobject_link'),
1870
                        $query->bindValue($relationType, null, \PDO::PARAM_INT)
1871
                    ),
1872
                    0
1873
                )
1874
            );
1875
        }
1876
1877
        $statement = $query->prepare();
1878
1879
        $statement->execute();
1880
1881
        return $statement->fetchAll(\PDO::FETCH_ASSOC);
1882
    }
1883
1884
    /**
1885
     * Inserts a new relation database record.
1886
     *
1887
     * @param \eZ\Publish\SPI\Persistence\Content\Relation\CreateStruct $createStruct
1888
     *
1889
     * @return int ID the inserted ID
1890
     */
1891 View Code Duplication
    public function insertRelation(RelationCreateStruct $createStruct)
1892
    {
1893
        $q = $this->dbHandler->createInsertQuery();
1894
        $q->insertInto(
1895
            $this->dbHandler->quoteTable('ezcontentobject_link')
1896
        )->set(
1897
            $this->dbHandler->quoteColumn('id'),
1898
            $this->dbHandler->getAutoIncrementValue('ezcontentobject_link', 'id')
1899
        )->set(
1900
            $this->dbHandler->quoteColumn('contentclassattribute_id'),
1901
            $q->bindValue((int)$createStruct->sourceFieldDefinitionId, null, \PDO::PARAM_INT)
1902
        )->set(
1903
            $this->dbHandler->quoteColumn('from_contentobject_id'),
1904
            $q->bindValue($createStruct->sourceContentId, null, \PDO::PARAM_INT)
1905
        )->set(
1906
            $this->dbHandler->quoteColumn('from_contentobject_version'),
1907
            $q->bindValue($createStruct->sourceContentVersionNo, null, \PDO::PARAM_INT)
1908
        )->set(
1909
            $this->dbHandler->quoteColumn('relation_type'),
1910
            $q->bindValue($createStruct->type, null, \PDO::PARAM_INT)
1911
        )->set(
1912
            $this->dbHandler->quoteColumn('to_contentobject_id'),
1913
            $q->bindValue($createStruct->destinationContentId, null, \PDO::PARAM_INT)
1914
        );
1915
1916
        $q->prepare()->execute();
1917
1918
        return $this->dbHandler->lastInsertId(
1919
            $this->dbHandler->getSequenceName('ezcontentobject_link', 'id')
1920
        );
1921
    }
1922
1923
    /**
1924
     * Deletes the relation with the given $relationId.
1925
     *
1926
     * @param int $relationId
1927
     * @param int $type {@see \eZ\Publish\API\Repository\Values\Content\Relation::COMMON,
1928
     *                 \eZ\Publish\API\Repository\Values\Content\Relation::EMBED,
1929
     *                 \eZ\Publish\API\Repository\Values\Content\Relation::LINK,
1930
     *                 \eZ\Publish\API\Repository\Values\Content\Relation::FIELD}
1931
     */
1932
    public function deleteRelation($relationId, $type)
1933
    {
1934
        // Legacy Storage stores COMMON, LINK and EMBED types using bitmask, therefore first load
1935
        // existing relation type by given $relationId for comparison
1936
        /** @var $query \eZ\Publish\Core\Persistence\Database\SelectQuery */
1937
        $query = $this->dbHandler->createSelectQuery();
1938
        $query->select(
1939
            $this->dbHandler->quoteColumn('relation_type')
1940
        )->from(
1941
            $this->dbHandler->quoteTable('ezcontentobject_link')
1942
        )->where(
1943
            $query->expr->eq(
1944
                $this->dbHandler->quoteColumn('id'),
1945
                $query->bindValue($relationId, null, \PDO::PARAM_INT)
1946
            )
1947
        );
1948
1949
        $statement = $query->prepare();
1950
        $statement->execute();
1951
        $loadedRelationType = $statement->fetchColumn();
1952
1953
        if (!$loadedRelationType) {
1954
            return;
1955
        }
1956
1957
        // If relation type matches then delete
1958
        if ($loadedRelationType == $type) {
1959
            /** @var $query \eZ\Publish\Core\Persistence\Database\DeleteQuery */
1960
            $query = $this->dbHandler->createDeleteQuery();
1961
            $query->deleteFrom(
1962
                'ezcontentobject_link'
1963
            )->where(
1964
                $query->expr->eq(
1965
                    $this->dbHandler->quoteColumn('id'),
1966
                    $query->bindValue($relationId, null, \PDO::PARAM_INT)
1967
                )
1968
            );
1969
1970
            $query->prepare()->execute();
1971
        } elseif ($loadedRelationType & $type) { // If relation type is composite update bitmask
1972
            /** @var $query \eZ\Publish\Core\Persistence\Database\UpdateQuery */
1973
            $query = $this->dbHandler->createUpdateQuery();
1974
            $query->update(
1975
                $this->dbHandler->quoteTable('ezcontentobject_link')
1976
            )->set(
1977
                $this->dbHandler->quoteColumn('relation_type'),
1978
                $query->expr->bitAnd(
1979
                    $this->dbHandler->quoteColumn('relation_type'),
1980
                    $query->bindValue(~$type, null, \PDO::PARAM_INT)
1981
                )
1982
            )->where(
1983
                $query->expr->eq(
1984
                    $this->dbHandler->quoteColumn('id'),
1985
                    $query->bindValue($relationId, null, \PDO::PARAM_INT)
1986
                )
1987
            );
1988
1989
            $query->prepare()->execute();
1990
        } else {
1991
            // No match, do nothing
1992
        }
1993
    }
1994
1995
    /**
1996
     * Returns all Content IDs for a given $contentTypeId.
1997
     *
1998
     * @param int $contentTypeId
1999
     *
2000
     * @return int[]
2001
     */
2002
    public function getContentIdsByContentTypeId($contentTypeId)
2003
    {
2004
        $query = $this->dbHandler->createSelectQuery();
2005
        $query
2006
            ->select($this->dbHandler->quoteColumn('id'))
2007
            ->from($this->dbHandler->quoteTable('ezcontentobject'))
2008
            ->where(
2009
                $query->expr->eq(
2010
                    $this->dbHandler->quoteColumn('contentclass_id'),
2011
                    $query->bindValue($contentTypeId, null, PDO::PARAM_INT)
2012
                )
2013
            );
2014
2015
        $statement = $query->prepare();
2016
        $statement->execute();
2017
2018
        return $statement->fetchAll(PDO::FETCH_COLUMN);
2019
    }
2020
2021
    /**
2022
     * Load name data for set of content id's and corresponding version number.
2023
     *
2024
     * @param array[] $rows array of hashes with 'id' and 'version' to load names for
2025
     *
2026
     * @return array
2027
     */
2028
    public function loadVersionedNameData($rows)
2029
    {
2030
        $query = $this->queryBuilder->createNamesQuery();
2031
        $conditions = array();
2032
        foreach ($rows as $row) {
2033
            $conditions[] = $query->expr->lAnd(
2034
                $query->expr->eq(
2035
                    $this->dbHandler->quoteColumn('contentobject_id'),
2036
                    $query->bindValue($row['id'], null, \PDO::PARAM_INT)
2037
                ),
2038
                $query->expr->eq(
2039
                    $this->dbHandler->quoteColumn('content_version'),
2040
                    $query->bindValue($row['version'], null, \PDO::PARAM_INT)
2041
                )
2042
            );
2043
        }
2044
2045
        $query->where($query->expr->lOr($conditions));
2046
        $stmt = $query->prepare();
2047
        $stmt->execute();
2048
2049
        return $stmt->fetchAll(\PDO::FETCH_ASSOC);
2050
    }
2051
2052
    /**
2053
     * Batch method for copying all relation meta data for copied Content object.
2054
     *
2055
     * {@inheritdoc}
2056
     *
2057
     * @param int $originalContentId
2058
     * @param int $copiedContentId
2059
     * @param int|null $versionNo If specified only copy for a given version number, otherwise all.
2060
     */
2061
    public function copyRelations($originalContentId, $copiedContentId, $versionNo = null)
2062
    {
2063
        // Given we can retain all columns, we just create copies with new `from_contentobject_id` using INSERT INTO SELECT
2064
        $sql = 'INSERT INTO ezcontentobject_link ( contentclassattribute_id, from_contentobject_id, from_contentobject_version, relation_type, to_contentobject_id )
2065
                SELECT  L2.contentclassattribute_id, :copied_id, L2.from_contentobject_version, L2.relation_type, L2.to_contentobject_id
2066
                FROM    ezcontentobject_link AS L2
2067
                WHERE   L2.from_contentobject_id = :original_id';
2068
2069
        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...
2070
            $stmt = $this->connection->prepare($sql . ' AND L2.from_contentobject_version = :version');
2071
            $stmt->bindValue('version', $versionNo, PDO::PARAM_INT);
2072
        } else {
2073
            $stmt = $this->connection->prepare($sql);
2074
        }
2075
2076
        $stmt->bindValue('original_id', $originalContentId, PDO::PARAM_INT);
2077
        $stmt->bindValue('copied_id', $copiedContentId, PDO::PARAM_INT);
2078
2079
        $stmt->execute();
2080
    }
2081
2082
    /**
2083
     * Remove the specified translation from the Content Object Version.
2084
     *
2085
     * @param int $contentId
2086
     * @param string $languageCode language code of the translation
2087
     * @throws \Doctrine\DBAL\DBALException
2088
     */
2089 View Code Duplication
    public function deleteTranslationFromContent($contentId, $languageCode)
2090
    {
2091
        $language = $this->languageHandler->loadByLanguageCode($languageCode);
2092
2093
        $this->connection->beginTransaction();
2094
        try {
2095
            $this->deleteTranslationFromContentVersions($contentId, $language->id);
2096
            $this->deleteTranslationFromContentNames($contentId, $languageCode);
2097
            $this->deleteTranslationFromContentObject($contentId, $language->id);
2098
2099
            $this->connection->commit();
2100
        } catch (DBALException $e) {
2101
            $this->connection->rollBack();
2102
            throw $e;
2103
        }
2104
    }
2105
2106
    /**
2107
     * Delete Content fields (attributes) for the given Translation.
2108
     * If $versionNo is given, fields for that Version only will be deleted.
2109
     *
2110
     * @param string $languageCode
2111
     * @param int $contentId
2112
     * @param int $versionNo (optional) filter by versionNo
2113
     */
2114 View Code Duplication
    public function deleteTranslatedFields($languageCode, $contentId, $versionNo = null)
2115
    {
2116
        $query = $this->connection->createQueryBuilder();
2117
        $query
2118
            ->delete('ezcontentobject_attribute')
2119
            ->where('contentobject_id = :contentId')
2120
            ->andWhere('language_code = :languageCode')
2121
            ->setParameters(
2122
                [
2123
                    ':contentId' => $contentId,
2124
                    ':languageCode' => $languageCode,
2125
                ]
2126
            )
2127
        ;
2128
2129
        if (null !== $versionNo) {
2130
            $query
2131
                ->andWhere('version = :versionNo')
2132
                ->setParameter(':versionNo', $versionNo)
2133
            ;
2134
        }
2135
2136
        $query->execute();
2137
    }
2138
2139
    /**
2140
     * Delete the specified Translation from the given Version.
2141
     *
2142
     * @param int $contentId
2143
     * @param int $versionNo
2144
     * @param string $languageCode
2145
     * @throws \Doctrine\DBAL\DBALException
2146
     */
2147 View Code Duplication
    public function deleteTranslationFromVersion($contentId, $versionNo, $languageCode)
2148
    {
2149
        $language = $this->languageHandler->loadByLanguageCode($languageCode);
2150
2151
        $this->connection->beginTransaction();
2152
        try {
2153
            $this->deleteTranslationFromContentVersions($contentId, $language->id, $versionNo);
2154
            $this->deleteTranslationFromContentNames($contentId, $languageCode, $versionNo);
2155
2156
            $this->connection->commit();
2157
        } catch (DBALException $e) {
2158
            $this->connection->rollBack();
2159
            throw $e;
2160
        }
2161
    }
2162
2163
    /**
2164
     * Delete translation from the ezcontentobject_name table.
2165
     *
2166
     * @param int $contentId
2167
     * @param string $languageCode
2168
     * @param int $versionNo optional, if specified, apply to this Version only.
2169
     */
2170 View Code Duplication
    private function deleteTranslationFromContentNames($contentId, $languageCode, $versionNo = null)
2171
    {
2172
        $query = $this->connection->createQueryBuilder();
2173
        $query
2174
            ->delete('ezcontentobject_name')
2175
            ->where('contentobject_id=:contentId')
2176
            ->andWhere('real_translation=:languageCode')
2177
            ->setParameters(
2178
                [
2179
                    ':languageCode' => $languageCode,
2180
                    ':contentId' => $contentId,
2181
                ]
2182
            )
2183
        ;
2184
2185
        if (null !== $versionNo) {
2186
            $query
2187
                ->andWhere('content_version = :versionNo')
2188
                ->setParameter(':versionNo', $versionNo)
2189
            ;
2190
        }
2191
2192
        $query->execute();
2193
    }
2194
2195
    /**
2196
     * Remove language from language_mask of ezcontentobject.
2197
     *
2198
     * @param int $contentId
2199
     * @param int $languageId
2200
     * @throws \eZ\Publish\Core\Base\Exceptions\BadStateException
2201
     */
2202
    private function deleteTranslationFromContentObject($contentId, $languageId)
2203
    {
2204
        $query = $this->connection->createQueryBuilder();
2205
        $query->update('ezcontentobject')
2206
            // parameter for bitwise operation has to be placed verbatim (w/o binding) for this to work cross-DBMS
2207
            ->set('language_mask', 'language_mask & ~ ' . $languageId)
2208
            ->set('modified', ':now')
2209
            ->where('id = :contentId')
2210
            ->andWhere(
2211
            // make sure removed translation is not the last one (incl. alwaysAvailable)
2212
                $query->expr()->andX(
2213
                    'language_mask & ~ ' . $languageId . ' <> 0',
2214
                    'language_mask & ~ ' . $languageId . ' <> 1'
2215
                )
2216
            )
2217
            ->setParameter(':now', time())
2218
            ->setParameter(':contentId', $contentId)
2219
        ;
2220
2221
        $rowCount = $query->execute();
2222
2223
        // no rows updated means that most likely somehow it was the last remaining translation
2224
        if ($rowCount === 0) {
2225
            throw new BadStateException(
2226
                '$languageCode',
2227
                'Specified translation is the only one Content Object Version has'
2228
            );
2229
        }
2230
    }
2231
2232
    /**
2233
     * Remove language from language_mask of ezcontentobject_version and update initialLanguageId
2234
     * if it matches the removed one.
2235
     *
2236
     * @param int $contentId
2237
     * @param int $languageId
2238
     * @param int $versionNo optional, if specified, apply to this Version only.
2239
     * @throws \eZ\Publish\Core\Base\Exceptions\BadStateException
2240
     */
2241
    private function deleteTranslationFromContentVersions($contentId, $languageId, $versionNo = null)
2242
    {
2243
        $query = $this->connection->createQueryBuilder();
2244
        $query->update('ezcontentobject_version')
2245
            // parameter for bitwise operation has to be placed verbatim (w/o binding) for this to work cross-DBMS
2246
            ->set('language_mask', 'language_mask & ~ ' . $languageId)
2247
            ->set('modified', ':now')
2248
            // update initial_language_id only if it matches removed translation languageId
2249
            ->set(
2250
                'initial_language_id',
2251
                'CASE WHEN initial_language_id = :languageId ' .
2252
                'THEN (SELECT initial_language_id AS main_language_id FROM ezcontentobject c WHERE c.id = :contentId) ' .
2253
                'ELSE initial_language_id END'
2254
            )
2255
            ->where('contentobject_id = :contentId')
2256
            ->andWhere(
2257
            // make sure removed translation is not the last one (incl. alwaysAvailable)
2258
                $query->expr()->andX(
2259
                    'language_mask & ~ ' . $languageId . ' <> 0',
2260
                    'language_mask & ~ ' . $languageId . ' <> 1'
2261
                )
2262
            )
2263
            ->setParameter(':now', time())
2264
            ->setParameter(':contentId', $contentId)
2265
            ->setParameter(':languageId', $languageId)
2266
        ;
2267
2268
        if (null !== $versionNo) {
2269
            $query
2270
                ->andWhere('version = :versionNo')
2271
                ->setParameter(':versionNo', $versionNo)
2272
            ;
2273
        }
2274
2275
        $rowCount = $query->execute();
2276
2277
        // no rows updated means that most likely somehow it was the last remaining translation
2278
        if ($rowCount === 0) {
2279
            throw new BadStateException(
2280
                '$languageCode',
2281
                'Specified translation is the only one Content Object Version has'
2282
            );
2283
        }
2284
    }
2285
}
2286