-
Notifications
You must be signed in to change notification settings - Fork 642
/
SlugService.php
403 lines (375 loc) · 17.3 KB
/
SlugService.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
<?php
declare(strict_types=1);
/*
* This file is part of the TYPO3 CMS project.
*
* It is free software; you can redistribute it and/or modify it under
* the terms of the GNU General Public License, either version 2
* of the License, or any later version.
*
* For the full copyright and license information, please read the
* LICENSE.txt file that was distributed with this source code.
*
* The TYPO3 project - inspiring people to share!
*/
namespace TYPO3\CMS\Redirects\Service;
use Psr\EventDispatcher\EventDispatcherInterface;
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerAwareTrait;
use TYPO3\CMS\Backend\Utility\BackendUtility;
use TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
use TYPO3\CMS\Core\Context\Context;
use TYPO3\CMS\Core\Context\DateTimeAspect;
use TYPO3\CMS\Core\Database\Connection;
use TYPO3\CMS\Core\Database\ConnectionPool;
use TYPO3\CMS\Core\Database\Query\QueryBuilder;
use TYPO3\CMS\Core\Database\Query\Restriction\DeletedRestriction;
use TYPO3\CMS\Core\Database\Query\Restriction\WorkspaceRestriction;
use TYPO3\CMS\Core\DataHandling\DataHandler;
use TYPO3\CMS\Core\DataHandling\History\RecordHistoryStore;
use TYPO3\CMS\Core\DataHandling\Model\CorrelationId;
use TYPO3\CMS\Core\DataHandling\Model\RecordStateFactory;
use TYPO3\CMS\Core\DataHandling\SlugHelper;
use TYPO3\CMS\Core\Domain\Repository\PageRepository;
use TYPO3\CMS\Core\LinkHandling\LinkService;
use TYPO3\CMS\Core\Site\Entity\Site;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Core\Utility\HttpUtility;
use TYPO3\CMS\Redirects\Event\AfterAutoCreateRedirectHasBeenPersistedEvent;
use TYPO3\CMS\Redirects\Event\ModifyAutoCreateRedirectRecordBeforePersistingEvent;
use TYPO3\CMS\Redirects\Hooks\DataHandlerSlugUpdateHook;
use TYPO3\CMS\Redirects\RedirectUpdate\SlugRedirectChangeItem;
use TYPO3\CMS\Redirects\RedirectUpdate\SlugRedirectChangeItemFactory;
/**
* @internal Due to some possible refactorings in TYPO3 v10+
*/
class SlugService implements LoggerAwareInterface
{
use LoggerAwareTrait;
/**
* `dechex(1569615472)` (similar to timestamps used with exceptions, but in hex)
*/
final public const CORRELATION_ID_IDENTIFIER = '5d8e6e70';
protected CorrelationId|string $correlationIdRedirectCreation = '';
protected CorrelationId|string $correlationIdSlugUpdate = '';
protected bool $autoUpdateSlugs = false;
protected bool $autoCreateRedirects = false;
protected int $redirectTTL = 0;
protected int $httpStatusCode = 307;
public function __construct(
private readonly Context $context,
private readonly PageRepository $pageRepository,
private readonly LinkService $linkService,
private readonly RedirectCacheService $redirectCacheService,
private readonly SlugRedirectChangeItemFactory $slugRedirectChangeItemFactory,
private readonly EventDispatcherInterface $eventDispatcher,
private readonly ConnectionPool $connectionPool,
) {}
public function rebuildSlugsForSlugChange(int $pageId, SlugRedirectChangeItem $changeItem, CorrelationId $correlationId): void
{
$this->initializeSettings($changeItem->getSite());
if ($this->autoUpdateSlugs || $this->autoCreateRedirects) {
$sourceHosts = [];
$this->createCorrelationIds($pageId, $correlationId);
if ($this->autoCreateRedirects) {
$sourceHosts = $this->createRedirects(
$changeItem,
$changeItem->getDefaultLanguagePageId(),
(int)$changeItem->getChanged()['sys_language_uid']
);
}
if ($this->autoUpdateSlugs) {
$sourceHosts += $this->checkSubPages($changeItem->getChanged(), $changeItem);
}
$this->sendNotification();
// rebuild caches only for matched source hosts
if ($sourceHosts !== []) {
foreach (array_unique($sourceHosts) as $sourceHost) {
$this->redirectCacheService->rebuildForHost($sourceHost);
}
}
}
}
protected function initializeSettings(Site $site): void
{
$settings = $site->getSettings();
$this->autoUpdateSlugs = (bool)$settings->get('redirects.autoUpdateSlugs', true);
$this->autoCreateRedirects = (bool)$settings->get('redirects.autoCreateRedirects', true);
if (!$this->context->getPropertyFromAspect('workspace', 'isLive')) {
$this->autoCreateRedirects = false;
}
$this->redirectTTL = (int)$settings->get('redirects.redirectTTL', 0);
$this->httpStatusCode = (int)$settings->get('redirects.httpStatusCode', 307);
}
protected function createCorrelationIds(int $pageId, CorrelationId $correlationId): void
{
if ($correlationId->getSubject() === null) {
$subject = md5('pages:' . $pageId);
$correlationId = $correlationId->withSubject($subject);
}
$this->correlationIdRedirectCreation = $correlationId->withAspects(self::CORRELATION_ID_IDENTIFIER, 'redirect');
$this->correlationIdSlugUpdate = $correlationId->withAspects(self::CORRELATION_ID_IDENTIFIER, 'slug');
}
/**
* @return string[] All unique source hosts for created redirects.
*/
protected function createRedirects(SlugRedirectChangeItem $changeItem, int $pageId, int $languageId): array
{
$sourceHosts = [];
$storagePid = $changeItem->getSite()->getRootPageId();
foreach ($changeItem->getSourcesCollection()->all() as $source) {
/** @var DateTimeAspect $date */
$date = $this->context->getAspect('date');
$endtime = $date->getDateTime()->modify('+' . $this->redirectTTL . ' days');
$targetLinkParameters = array_replace(['_language' => $languageId], $source->getTargetLinkParameters());
$targetLink = $this->linkService->asString([
'type' => 'page',
'pageuid' => $pageId,
'parameters' => HttpUtility::buildQueryString($targetLinkParameters),
]);
$record = array_replace(
$this->getTableDefaultValues('sys_redirect'),
[
'pid' => $storagePid,
'updatedon' => $date->get('timestamp'),
'createdon' => $date->get('timestamp'),
'deleted' => 0,
'disabled' => 0,
'starttime' => 0,
'endtime' => $this->redirectTTL > 0 ? $endtime->getTimestamp() : 0,
'source_host' => $source->getHost(),
'source_path' => $source->getPath(),
'is_regexp' => 0,
'force_https' => 0,
'respect_query_parameters' => 0,
'target' => $targetLink,
'target_statuscode' => $this->httpStatusCode,
'hitcount' => 0,
'lasthiton' => 0,
'disable_hitcount' => 0,
'creation_type' => 0,
]
);
$record = $this->eventDispatcher->dispatch(
new ModifyAutoCreateRedirectRecordBeforePersistingEvent(
slugRedirectChangeItem: $changeItem,
source: $source,
redirectRecord: $record,
)
)->getRedirectRecord();
// @todo Use dataHandler to create records
$connection = GeneralUtility::makeInstance(ConnectionPool::class)
->getConnectionForTable('sys_redirect');
$connection->insert('sys_redirect', $record);
$id = (int)$connection->lastInsertId();
$record['uid'] = $id;
$this->getRecordHistoryStore()->addRecord('sys_redirect', $id, $record, $this->correlationIdRedirectCreation);
$this->eventDispatcher->dispatch(
new AfterAutoCreateRedirectHasBeenPersistedEvent(
slugRedirectChangeItem: $changeItem,
source: $source,
redirectRecord: $record,
)
);
if (!in_array($source->getHost(), $sourceHosts)) {
$sourceHosts[] = $source->getHost();
}
}
return $sourceHosts;
}
/**
* @return string[] All unique source hosts for created redirects.
*/
protected function checkSubPages(array $currentPageRecord, SlugRedirectChangeItem $parentChangeItem): array
{
$sourceHosts = [];
$languageUid = (int)$currentPageRecord['sys_language_uid'];
// resolveSubPages needs the page id of the default language
$pageId = $languageUid === 0 ? (int)$currentPageRecord['uid'] : (int)$currentPageRecord['l10n_parent'];
$subPageRecords = $this->resolveSubPages($pageId, $languageUid);
foreach ($subPageRecords as $subPageRecord) {
$changeItem = $this->slugRedirectChangeItemFactory->create(
pageId: (int)$subPageRecord['uid'],
original: $subPageRecord
);
if ($changeItem === null) {
continue;
}
$updatedPageRecord = $this->updateSlug($subPageRecord, $parentChangeItem);
if ($updatedPageRecord !== null && $this->autoCreateRedirects) {
$subPageId = (int)$subPageRecord['sys_language_uid'] === 0 ? (int)$subPageRecord['uid'] : (int)$subPageRecord['l10n_parent'];
$changeItem = $changeItem->withChanged($updatedPageRecord);
$sourceHosts += array_values($this->createRedirects($changeItem, $subPageId, $languageUid));
}
}
return $sourceHosts;
}
protected function resolveSubPages(int $id, int $languageUid): array
{
// First resolve all sub-pages in default language
$queryBuilder = $this->getQueryBuilderForPages();
$subPages = $queryBuilder
->select('*')
->from('pages')
->where(
$queryBuilder->expr()->eq('pid', $queryBuilder->createNamedParameter($id, Connection::PARAM_INT)),
$queryBuilder->expr()->eq('sys_language_uid', $queryBuilder->createNamedParameter(0, Connection::PARAM_INT))
)
->orderBy('uid', 'ASC')
->executeQuery()
->fetchAllAssociative();
// if the language is not the default language, resolve the language related records.
if ($languageUid > 0) {
$queryBuilder = $this->getQueryBuilderForPages();
$subPages = $queryBuilder
->select('*')
->from('pages')
->where(
$queryBuilder->expr()->in('l10n_parent', $queryBuilder->createNamedParameter(array_column($subPages, 'uid'), Connection::PARAM_INT_ARRAY)),
$queryBuilder->expr()->eq('sys_language_uid', $queryBuilder->createNamedParameter($languageUid, Connection::PARAM_INT))
)
->orderBy('uid', 'ASC')
->executeQuery()
->fetchAllAssociative();
}
$results = [];
if (!empty($subPages)) {
$subPages = $this->pageRepository->getPagesOverlay($subPages, $languageUid);
foreach ($subPages as $subPage) {
$results[] = $subPage;
// resolveSubPages needs the page id of the default language
$pageId = $languageUid === 0 ? (int)$subPage['uid'] : (int)$subPage['l10n_parent'];
foreach ($this->resolveSubPages($pageId, $languageUid) as $page) {
$results[] = $page;
}
}
}
return $results;
}
/**
* Update a slug by given record, old parent page slug and new parent page slug.
* In case no update is required, the method returns null else the new slug.
*/
protected function updateSlug(array $subPageRecord, SlugRedirectChangeItem $changeItem): ?array
{
if ($changeItem->getChanged() === null
|| !str_starts_with($subPageRecord['slug'], $changeItem->getOriginal()['slug'])
) {
return null;
}
$oldSlugOfParentPage = $changeItem->getOriginal()['slug'];
$newSlugOfParentPage = $changeItem->getChanged()['slug'];
$newSlug = rtrim($newSlugOfParentPage, '/') . '/'
. substr($subPageRecord['slug'], strlen(rtrim($oldSlugOfParentPage, '/') . '/'));
$state = RecordStateFactory::forName('pages')
->fromArray($subPageRecord, $subPageRecord['pid'], $subPageRecord['uid']);
$fieldConfig = $GLOBALS['TCA']['pages']['columns']['slug']['config'] ?? [];
$slugHelper = GeneralUtility::makeInstance(SlugHelper::class, 'pages', 'slug', $fieldConfig);
if (!$slugHelper->isUniqueInSite($newSlug, $state)) {
$newSlug = $slugHelper->buildSlugForUniqueInSite($newSlug, $state);
}
$this->persistNewSlug((int)$subPageRecord['uid'], $newSlug);
return BackendUtility::getRecord('pages', (int)$subPageRecord['uid']);
}
protected function persistNewSlug(int $uid, string $newSlug): void
{
$this->disableHook();
$data = [];
$data['pages'][$uid]['slug'] = $newSlug;
$dataHandler = GeneralUtility::makeInstance(DataHandler::class);
$dataHandler->start($data, []);
$dataHandler->setCorrelationId($this->correlationIdSlugUpdate);
$dataHandler->process_datamap();
$this->enabledHook();
}
protected function sendNotification(): void
{
$data = [
'componentName' => 'redirects',
'eventName' => 'slugChanged',
'correlations' => [
'correlationIdSlugUpdate' => (string)$this->correlationIdSlugUpdate,
'correlationIdRedirectCreation' => (string)$this->correlationIdRedirectCreation,
],
'autoUpdateSlugs' => (bool)$this->autoUpdateSlugs,
'autoCreateRedirects' => (bool)$this->autoCreateRedirects,
];
BackendUtility::setUpdateSignal('redirects:slugChanged', $data);
}
protected function getRecordHistoryStore(): RecordHistoryStore
{
$backendUser = $this->getBackendUser();
return GeneralUtility::makeInstance(
RecordHistoryStore::class,
RecordHistoryStore::USER_BACKEND,
(int)$backendUser->user['uid'],
(int)$backendUser->getOriginalUserIdWhenInSwitchUserMode(),
$this->context->getPropertyFromAspect('date', 'timestamp'),
$backendUser->workspace
);
}
protected function getQueryBuilderForPages(): QueryBuilder
{
$queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
->getQueryBuilderForTable('pages');
/** @noinspection PhpStrictTypeCheckingInspection */
$queryBuilder
->getRestrictions()
->removeAll()
->add(GeneralUtility::makeInstance(DeletedRestriction::class))
->add(GeneralUtility::makeInstance(WorkspaceRestriction::class, $this->context->getPropertyFromAspect('workspace', 'id')));
return $queryBuilder;
}
protected function enabledHook(): void
{
$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_tcemain.php']['processDatamapClass']['redirects'] =
DataHandlerSlugUpdateHook::class;
}
protected function disableHook(): void
{
unset($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_tcemain.php']['processDatamapClass']['redirects']);
}
protected function getBackendUser(): BackendUserAuthentication
{
return $GLOBALS['BE_USER'];
}
/**
* Gather table default values from TCA and from the cached table schema information as fallback.
*
* @param string $tableName
* @return array<non-empty-string, string|float|int|bool|null>
* @todo Consider to provide this in Connection if use-full for different places.
*/
private function getTableDefaultValues(string $tableName): array
{
$defaults = [];
foreach ($GLOBALS['TCA'][$tableName]['columns'] ?? [] as $columnName => $columnConfig) {
if (!array_key_exists('default', $columnConfig['config'] ?? [])) {
continue;
}
$defaults[$columnName] = $columnConfig['config']['default'];
}
$connection = $this->connectionPool->getConnectionForTable($tableName);
$table = $connection->getSchemaInformation()->introspectTable($tableName);
foreach ($table->getColumns() as $column) {
$columnName = $column->getName();
if ($columnName === 'uid' || $column->getAutoincrement() === true) {
// Autoincrement fields and therefore the default TYPO3 `uid` column
// should be not provided in a data array to ensure the behaviour
// kicks correctly in.
continue;
}
if (array_key_exists($columnName, $defaults)) {
// Already having TCA default value, which weigths higher.
continue;
}
$columnDefaultValue = $column->getDefault();
if ($columnDefaultValue === null && $column->getNotnull() === false) {
// No need to set null as default value for a nullable column.
continue;
}
$defaults[$columnName] = $columnDefaultValue;
}
return $defaults;
}
}