-
Notifications
You must be signed in to change notification settings - Fork 638
/
BrokenLinkRepository.php
280 lines (261 loc) · 10.6 KB
/
BrokenLinkRepository.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
<?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\Linkvalidator\Repository;
use Doctrine\DBAL\Exception\TableNotFoundException;
use TYPO3\CMS\Core\Database\Connection;
use TYPO3\CMS\Core\Database\ConnectionPool;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Linkvalidator\QueryRestrictions\EditableRestriction;
/**
* Repository for finding broken links that were detected previously.
*/
class BrokenLinkRepository
{
protected const TABLE = 'tx_linkvalidator_link';
/**
* Check if linkTarget is in list of broken links.
*
* @param string $linkTarget Url to check for. Can be a URL (for external links)
* a page uid (for db links), a file reference (for file links), etc.
* @return bool is the link target a broken link
*/
public function isLinkTargetBrokenLink(string $linkTarget): bool
{
try {
$queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
->getQueryBuilderForTable(static::TABLE);
$queryBuilder
->count('uid')
->from(static::TABLE)
->where(
$queryBuilder->expr()->eq('url', $queryBuilder->createNamedParameter($linkTarget))
);
return (bool)$queryBuilder
->execute()
->fetchColumn(0);
} catch (TableNotFoundException $e) {
return false;
}
}
/**
* Returns all broken links found on the page record and all records on a page (or multiple pages)
* grouped by the link_type.
*
* @param array $pageIds
* @param array $searchFields [ table => [field1, field2, ...], ...]
* @return array
*/
public function getNumberOfBrokenLinksForRecordsOnPages(array $pageIds, array $searchFields): array
{
$queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
->getQueryBuilderForTable(static::TABLE);
$queryBuilder->getRestrictions()->removeAll();
if (!$GLOBALS['BE_USER']->isAdmin()) {
$queryBuilder->getRestrictions()
->add(GeneralUtility::makeInstance(EditableRestriction::class, $searchFields, $queryBuilder));
}
$statement = $queryBuilder->select('link_type')
->addSelectLiteral($queryBuilder->expr()->count(static::TABLE . '.uid', 'amount'))
->from(static::TABLE)
->join(
static::TABLE,
'pages',
'pages',
$queryBuilder->expr()->eq('record_pid', $queryBuilder->quoteIdentifier('pages.uid'))
)
->where(
$queryBuilder->expr()->orX(
$queryBuilder->expr()->andX(
$queryBuilder->expr()->in(
'record_uid',
$queryBuilder->createNamedParameter($pageIds, Connection::PARAM_INT_ARRAY)
),
$queryBuilder->expr()->eq('table_name', $queryBuilder->createNamedParameter('pages'))
),
$queryBuilder->expr()->andX(
$queryBuilder->expr()->in(
'record_pid',
$queryBuilder->createNamedParameter($pageIds, Connection::PARAM_INT_ARRAY)
),
$queryBuilder->expr()->neq('table_name', $queryBuilder->createNamedParameter('pages'))
)
)
)
->groupBy('link_type')
->execute();
$result = [
'total' => 0
];
while ($row = $statement->fetch()) {
$result[$row['link_type']] = $row['amount'];
$result['total']+= $row['amount'];
}
return $result;
}
public function setNeedsRecheckForRecord(int $recordUid, string $tableName): void
{
$queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
->getQueryBuilderForTable(static::TABLE);
$queryBuilder->update(static::TABLE)
->where(
$queryBuilder->expr()->eq(
'record_uid',
$queryBuilder->createNamedParameter($recordUid, \PDO::PARAM_INT)
),
$queryBuilder->expr()->eq(
'table_name',
$queryBuilder->createNamedParameter($tableName)
)
)
->set('needs_recheck', 1)
->execute();
}
public function removeBrokenLinksForRecord(string $tableName, int $recordUid): void
{
$queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
->getQueryBuilderForTable(static::TABLE);
$queryBuilder->delete(static::TABLE)
->where(
$queryBuilder->expr()->eq(
'record_uid',
$queryBuilder->createNamedParameter($recordUid, \PDO::PARAM_INT)
),
$queryBuilder->expr()->eq(
'table_name',
$queryBuilder->createNamedParameter($tableName)
)
)
->execute();
}
public function removeAllBrokenLinksOfRecordsOnPageIds(array $pageIds, array $linkTypes): void
{
$queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
->getQueryBuilderForTable(static::TABLE);
$queryBuilder->delete(static::TABLE)
->where(
$queryBuilder->expr()->orX(
$queryBuilder->expr()->andX(
$queryBuilder->expr()->in(
'record_uid',
$queryBuilder->createNamedParameter($pageIds, Connection::PARAM_INT_ARRAY)
),
$queryBuilder->expr()->eq('table_name', $queryBuilder->createNamedParameter('pages'))
),
$queryBuilder->expr()->andX(
$queryBuilder->expr()->in(
'record_pid',
$queryBuilder->createNamedParameter($pageIds, Connection::PARAM_INT_ARRAY)
),
$queryBuilder->expr()->neq(
'table_name',
$queryBuilder->createNamedParameter('pages')
)
)
),
$queryBuilder->expr()->in(
'link_type',
$queryBuilder->createNamedParameter($linkTypes, Connection::PARAM_STR_ARRAY)
)
)
->execute();
}
/**
* Prepare database query with pageList and keyOpt data.
*
* This takes permissions of current BE user into account
*
* @param int[] $pageIds Pages to check for broken links
* @param string[] $linkTypes Link types to validate
* @param string[] $searchFields table => [fields1, field2, ...], ... : fields in which linkvalidator should
* search for broken links
* @param int[] $languages Allowed languages
* @return array
*/
public function getAllBrokenLinksForPages(
array $pageIds,
array $linkTypes,
array $searchFields = [],
array $languages = []
): array {
$queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
->getQueryBuilderForTable(self::TABLE);
if (!$GLOBALS['BE_USER']->isAdmin()) {
$queryBuilder->getRestrictions()
->add(GeneralUtility::makeInstance(EditableRestriction::class, $searchFields, $queryBuilder));
}
$constraints = [
$queryBuilder->expr()->orX(
$queryBuilder->expr()->andX(
$queryBuilder->expr()->in(
'record_uid',
$queryBuilder->createNamedParameter($pageIds, Connection::PARAM_INT_ARRAY)
),
$queryBuilder->expr()->eq('table_name', $queryBuilder->createNamedParameter('pages'))
),
$queryBuilder->expr()->andX(
$queryBuilder->expr()->in(
'record_pid',
$queryBuilder->createNamedParameter($pageIds, Connection::PARAM_INT_ARRAY)
),
$queryBuilder->expr()->neq('table_name', $queryBuilder->createNamedParameter('pages'))
)
),
$queryBuilder->expr()->in(
'link_type',
$queryBuilder->createNamedParameter($linkTypes, Connection::PARAM_STR_ARRAY)
)
];
if ($languages !== []) {
$constraints[] = $queryBuilder->expr()->in(
'language',
$queryBuilder->createNamedParameter($languages, Connection::PARAM_INT_ARRAY)
);
}
$records = $queryBuilder
->select(self::TABLE . '.*')
->from(self::TABLE)
->join(
'tx_linkvalidator_link',
'pages',
'pages',
$queryBuilder->expr()->eq('tx_linkvalidator_link.record_pid', $queryBuilder->quoteIdentifier('pages.uid'))
)
->where(...$constraints)
->orderBy('tx_linkvalidator_link.record_uid')
->addOrderBy('tx_linkvalidator_link.uid')
->execute()
->fetchAll();
foreach ($records as &$record) {
$response = json_decode($record['url_response'], true);
// Fallback mechanism to still support the old serialized data, could be removed in TYPO3 v12 or later
if ($response === null) {
$response = unserialize($record['url_response'], ['allowed_classes' => false]);
}
$record['url_response'] = $response;
}
return $records;
}
public function addBrokenLink($record, bool $isValid, array $errorParams = null): void
{
$response = ['valid' => $isValid];
if ($errorParams) {
$response['errorParams'] = $errorParams;
}
$record['url_response'] = json_encode($response);
GeneralUtility::makeInstance(ConnectionPool::class)
->getConnectionForTable(self::TABLE)
->insert(self::TABLE, $record);
}
}