Passed
Push — master ( 073a46...48994e )
by Tomas Norre
08:01 queued 04:23
created

CrawlerController   F

Complexity

Total Complexity 200

Size/Duplication

Total Lines 1902
Duplicated Lines 0 %

Test Coverage

Coverage 58.81%

Importance

Changes 15
Bugs 0 Features 0
Metric Value
wmc 200
eloc 815
c 15
b 0
f 0
dl 0
loc 1902
ccs 447
cts 760
cp 0.5881
rs 1.785

42 Methods

Rating   Name   Duplication   Size   Complexity  
A drawURLs_PIfilter() 0 12 4
C getUrlsForPageId() 0 93 16
A getPageTSconfigForId() 0 21 4
B getConfigurationsForBranch() 0 38 8
A flushQueue() 0 37 4
A cleanUpOldQueueEntries() 0 9 1
A getDisabled() 0 3 1
A getAccessMode() 0 3 1
A __construct() 0 26 3
A setDisabled() 0 7 3
A getProcessFilename() 0 3 1
A setAccessMode() 0 3 1
A setProcessFilename() 0 3 1
A setExtensionSettings() 0 3 1
A hasGroupAccess() 0 11 4
A compileUrls() 0 22 6
B checkIfPageShouldBeSkipped() 0 33 9
A swapIfFirstIsLargerThanSecond() 0 10 2
B CLI_run() 0 66 8
A getUrlFromPageAndQueryParameters() 0 4 1
A getCurrentTime() 0 3 1
A CLI_debug() 0 5 2
A CLI_buildProcessId() 0 6 2
A getConfigurationHash() 0 5 1
A CLI_releaseProcesses() 0 43 3
A getQueryBuilder() 0 3 1
A addQueueEntry_callBack() 0 17 3
B getLogEntriesForSetId() 0 40 6
A getLogEntriesForPageId() 0 36 5
A getBackendUser() 0 8 2
A CLI_runHooks() 0 6 3
A CLI_checkAndAcquireNewProcess() 0 46 5
A getDuplicateRowsIfExist() 0 49 5
B getPageTreeAndUrls() 0 80 7
B expandExcludeString() 0 44 9
A getUrlsForPageRow() 0 17 3
A readUrlFromArray() 0 28 1
F expandParameters() 0 129 25
B urlListFromUrlArray() 0 68 8
C drawURLs_addRowsForPage() 0 106 12
B addUrl() 0 84 6
C readUrl() 0 89 11

How to fix   Complexity   

Complex Class

Complex classes like CrawlerController often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use CrawlerController, and based on these observations, apply Extract Interface, too.

1
<?php
2
3
declare(strict_types=1);
4
5
namespace AOE\Crawler\Controller;
6
7
/***************************************************************
8
 *  Copyright notice
9
 *
10
 *  (c) 2020 AOE GmbH <[email protected]>
11
 *
12
 *  All rights reserved
13
 *
14
 *  This script is part of the TYPO3 project. The TYPO3 project is
15
 *  free software; you can redistribute it and/or modify
16
 *  it under the terms of the GNU General Public License as published by
17
 *  the Free Software Foundation; either version 3 of the License, or
18
 *  (at your option) any later version.
19
 *
20
 *  The GNU General Public License can be found at
21
 *  http://www.gnu.org/copyleft/gpl.html.
22
 *
23
 *  This script is distributed in the hope that it will be useful,
24
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
25
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26
 *  GNU General Public License for more details.
27
 *
28
 *  This copyright notice MUST APPEAR in all copies of the script!
29
 ***************************************************************/
30
31
use AOE\Crawler\Configuration\ExtensionConfigurationProvider;
32
use AOE\Crawler\Converter\JsonCompatibilityConverter;
33
use AOE\Crawler\Crawler;
34
use AOE\Crawler\CrawlStrategy\CrawlStrategyFactory;
35
use AOE\Crawler\Domain\Model\Process;
36
use AOE\Crawler\Domain\Repository\ConfigurationRepository;
37
use AOE\Crawler\Domain\Repository\ProcessRepository;
38
use AOE\Crawler\Domain\Repository\QueueRepository;
39
use AOE\Crawler\QueueExecutor;
40
use AOE\Crawler\Service\UrlService;
41
use AOE\Crawler\Utility\SignalSlotUtility;
42
use AOE\Crawler\Value\QueueFilter;
43
use PDO;
44
use Psr\Http\Message\UriInterface;
45
use Psr\Log\LoggerAwareInterface;
46
use Psr\Log\LoggerAwareTrait;
47
use TYPO3\CMS\Backend\Tree\View\PageTreeView;
48
use TYPO3\CMS\Backend\Utility\BackendUtility;
49
use TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
50
use TYPO3\CMS\Core\Compatibility\PublicMethodDeprecationTrait;
51
use TYPO3\CMS\Core\Compatibility\PublicPropertyDeprecationTrait;
52
use TYPO3\CMS\Core\Core\Bootstrap;
53
use TYPO3\CMS\Core\Core\Environment;
54
use TYPO3\CMS\Core\Database\Connection;
55
use TYPO3\CMS\Core\Database\ConnectionPool;
56
use TYPO3\CMS\Core\Database\Query\QueryBuilder;
57
use TYPO3\CMS\Core\Database\Query\Restriction\DeletedRestriction;
58
use TYPO3\CMS\Core\Database\QueryGenerator;
59
use TYPO3\CMS\Core\Exception\SiteNotFoundException;
60
use TYPO3\CMS\Core\Imaging\Icon;
61
use TYPO3\CMS\Core\Imaging\IconFactory;
62
use TYPO3\CMS\Core\Routing\InvalidRouteArgumentsException;
63
use TYPO3\CMS\Core\Site\Entity\Site;
64
use TYPO3\CMS\Core\Type\Bitmask\Permission;
65
use TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser;
66
use TYPO3\CMS\Core\Utility\DebugUtility;
67
use TYPO3\CMS\Core\Utility\GeneralUtility;
68
use TYPO3\CMS\Core\Utility\MathUtility;
69
use TYPO3\CMS\Extbase\Object\ObjectManager;
70
use TYPO3\CMS\Frontend\Page\PageRepository;
71
72
/**
73
 * Class CrawlerController
74
 *
75
 * @package AOE\Crawler\Controller
76
 */
77
class CrawlerController implements LoggerAwareInterface
78
{
79
    use LoggerAwareTrait;
80
    use PublicMethodDeprecationTrait;
81
    use PublicPropertyDeprecationTrait;
82
83
    public const CLI_STATUS_NOTHING_PROCCESSED = 0;
84
85
    //queue not empty
86
    public const CLI_STATUS_REMAIN = 1;
87
88
    //(some) queue items where processed
89
    public const CLI_STATUS_PROCESSED = 2;
90
91
    //instance didn't finish
92
    public const CLI_STATUS_ABORTED = 4;
93
94
    public const CLI_STATUS_POLLABLE_PROCESSED = 8;
95
96
    /**
97
     * @var integer
98
     */
99
    public $setID = 0;
100
101
    /**
102
     * @var string
103
     */
104
    public $processID = '';
105
106
    /**
107
     * @var array
108
     */
109
    public $duplicateTrack = [];
110
111
    /**
112
     * @var array
113
     */
114
    public $downloadUrls = [];
115
116
    /**
117
     * @var array
118
     */
119
    public $incomingProcInstructions = [];
120
121
    /**
122
     * @var array
123
     */
124
    public $incomingConfigurationSelection = [];
125
126
    /**
127
     * @var bool
128
     */
129
    public $registerQueueEntriesInternallyOnly = false;
130
131
    /**
132
     * @var array
133
     */
134
    public $queueEntries = [];
135
136
    /**
137
     * @var array
138
     */
139
    public $urlList = [];
140
141
    /**
142
     * @var array
143
     */
144
    public $extensionSettings = [];
145
146
    /**
147
     * Mount Point
148
     *
149
     * @var bool
150
     * Todo: Check what this is used for and adjust the type hint or code, as bool doesn't match the current code.
151
     */
152
    public $MP = false;
153
154
    /**
155
     * @var string
156
     * @deprecated
157
     */
158
    protected $processFilename;
159
160
    /**
161
     * Holds the internal access mode can be 'gui','cli' or 'cli_im'
162
     *
163
     * @var string
164
     * @deprecated
165
     */
166
    protected $accessMode;
167
168
    /**
169
     * @var QueueRepository
170
     */
171
    protected $queueRepository;
172
173
    /**
174
     * @var ProcessRepository
175
     */
176
    protected $processRepository;
177
178
    /**
179
     * @var ConfigurationRepository
180
     */
181
    protected $configurationRepository;
182
183
    /**
184
     * @var string
185
     */
186
    protected $tableName = 'tx_crawler_queue';
187
188
    /**
189
     * @var QueueExecutor
190
     */
191
    protected $queueExecutor;
192
193
    /**
194
     * @var int
195
     */
196
    protected $maximumUrlsToCompile = 10000;
197
198
    /**
199
     * @var IconFactory
200
     */
201
    protected $iconFactory;
202
203
    /**
204
     * @var string[]
205
     */
206
    private $deprecatedPublicMethods = [
0 ignored issues
show
introduced by
The private property $deprecatedPublicMethods is not used, and could be removed.
Loading history...
207
        'cleanUpOldQueueEntries' => 'Using CrawlerController::cleanUpOldQueueEntries() is deprecated since 9.0.1 and will be removed in v11.x, please use QueueRepository->cleanUpOldQueueEntries() instead.',
208
        'CLI_debug' => 'Using CrawlerController->CLI_debug() is deprecated since 9.1.3 and will be removed in v11.x',
209
        'getAccessMode' => 'Using CrawlerController->getAccessMode() is deprecated since 9.1.3 and will be removed in v11.x',
210
        'getLogEntriesForSetId' => 'Using crawlerController::getLogEntriesForSetId() is deprecated since 9.0.1 and will be removed in v11.x',
211
        'flushQueue' => 'Using CrawlerController::flushQueue() is deprecated since 9.0.1 and will be removed in v11.x, please use QueueRepository->flushQueue() instead.',
212
        'setAccessMode' => 'Using CrawlerController->setAccessMode() is deprecated since 9.1.3 and will be removed in v11.x',
213
        'getDisabled' => 'Using CrawlerController->getDisabled() is deprecated since 9.1.3 and will be removed in v11.x, please use Crawler->isDisabled() instead',
214
        'setDisabled' => 'Using CrawlerController->setDisabled() is deprecated since 9.1.3 and will be removed in v11.x, please use Crawler->setDisabled() instead',
215
        'getProcessFilename' => 'Using CrawlerController->getProcessFilename() is deprecated since 9.1.3 and will be removed in v11.x',
216
        'setProcessFilename' => 'Using CrawlerController->setProcessFilename() is deprecated since 9.1.3 and will be removed in v11.x',
217
        'getDuplicateRowsIfExist' => 'Using CrawlerController->getDuplicateRowsIfExist() is deprecated since 9.1.4 and will be remove in v11.x, please use QueueRepository->getDuplicateQueueItemsIfExists() instead',
218
219
    ];
220
221
    /**
222
     * @var string[]
223
     */
224
    private $deprecatedPublicProperties = [
1 ignored issue
show
introduced by
The private property $deprecatedPublicProperties is not used, and could be removed.
Loading history...
225
        'accessMode' => 'Using CrawlerController->accessMode is deprecated since 9.1.3 and will be removed in v11.x',
226
        'processFilename' => 'Using CrawlerController->accessMode is deprecated since 9.1.3 and will be removed in v11.x',
227
    ];
228
229
    /**
230
     * @var BackendUserAuthentication|null
231
     */
232
    private $backendUser;
233
234
    /**
235
     * @var integer
236
     */
237
    private $scheduledTime = 0;
238
239
    /**
240
     * @var integer
241
     */
242
    private $reqMinute = 0;
243
244
    /**
245
     * @var bool
246
     */
247
    private $submitCrawlUrls = false;
248
249
    /**
250
     * @var bool
251
     */
252
    private $downloadCrawlUrls = false;
253
254
    /**
255
     * @var PageRepository
256
     */
257
    private $pageRepository;
258
259
    /**
260
     * @var Crawler
261
     */
262
    private $crawler;
263
264
    /************************************
265
     *
266
     * Getting URLs based on Page TSconfig
267
     *
268
     ************************************/
269
270 36
    public function __construct()
271
    {
272 36
        $objectManager = GeneralUtility::makeInstance(ObjectManager::class);
273 36
        $crawlStrategyFactory = GeneralUtility::makeInstance(CrawlStrategyFactory::class);
274 36
        $this->queueRepository = $objectManager->get(QueueRepository::class);
275 36
        $this->processRepository = $objectManager->get(ProcessRepository::class);
276 36
        $this->configurationRepository = $objectManager->get(ConfigurationRepository::class);
277 36
        $this->pageRepository = $objectManager->get(PageRepository::class);
278 36
        $this->queueExecutor = GeneralUtility::makeInstance(QueueExecutor::class, $crawlStrategyFactory);
279 36
        $this->iconFactory = GeneralUtility::makeInstance(IconFactory::class);
280 36
        $this->crawler = GeneralUtility::makeInstance(Crawler::class);
281
282 36
        $this->processFilename = Environment::getVarPath() . '/lock/tx_crawler.proc';
0 ignored issues
show
Deprecated Code introduced by
The property AOE\Crawler\Controller\C...oller::$processFilename has been deprecated. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-deprecated  annotation

282
        /** @scrutinizer ignore-deprecated */ $this->processFilename = Environment::getVarPath() . '/lock/tx_crawler.proc';
Loading history...
283
284
        /** @var ExtensionConfigurationProvider $configurationProvider */
285 36
        $configurationProvider = GeneralUtility::makeInstance(ExtensionConfigurationProvider::class);
286 36
        $settings = $configurationProvider->getExtensionConfiguration();
287 36
        $this->extensionSettings = is_array($settings) ? $settings : [];
0 ignored issues
show
introduced by
The condition is_array($settings) is always true.
Loading history...
288
289
        // set defaults:
290 36
        if (MathUtility::convertToPositiveInteger($this->extensionSettings['countInARun']) === 0) {
291
            $this->extensionSettings['countInARun'] = 100;
292
        }
293
294 36
        $this->extensionSettings['processLimit'] = MathUtility::forceIntegerInRange($this->extensionSettings['processLimit'], 1, 99, 1);
295 36
        $this->maximumUrlsToCompile = MathUtility::forceIntegerInRange($this->extensionSettings['maxCompileUrls'], 1, 1000000000, 10000);
296 36
    }
297
298
    /**
299
     * Method to set the accessMode can be gui, cli or cli_im
300
     *
301
     * @return string
302
     * @deprecated
303
     */
304 1
    public function getAccessMode()
305
    {
306 1
        return $this->accessMode;
0 ignored issues
show
Deprecated Code introduced by
The property AOE\Crawler\Controller\C...Controller::$accessMode has been deprecated. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-deprecated  annotation

306
        return /** @scrutinizer ignore-deprecated */ $this->accessMode;
Loading history...
307
    }
308
309
    /**
310
     * @param string $accessMode
311
     * @deprecated
312
     */
313 1
    public function setAccessMode($accessMode): void
314
    {
315 1
        $this->accessMode = $accessMode;
0 ignored issues
show
Deprecated Code introduced by
The property AOE\Crawler\Controller\C...Controller::$accessMode has been deprecated. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-deprecated  annotation

315
        /** @scrutinizer ignore-deprecated */ $this->accessMode = $accessMode;
Loading history...
316 1
    }
317
318
    /**
319
     * Set disabled status to prevent processes from being processed
320
     *
321
     * @param bool $disabled (optional, defaults to true)
322
     * @deprecated
323
     */
324 2
    public function setDisabled($disabled = true): void
325
    {
326 2
        if ($disabled) {
327 1
            GeneralUtility::writeFile($this->processFilename, '');
0 ignored issues
show
Deprecated Code introduced by
The property AOE\Crawler\Controller\C...oller::$processFilename has been deprecated. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-deprecated  annotation

327
            GeneralUtility::writeFile(/** @scrutinizer ignore-deprecated */ $this->processFilename, '');
Loading history...
328
        } else {
329 1
            if (is_file($this->processFilename)) {
0 ignored issues
show
Deprecated Code introduced by
The property AOE\Crawler\Controller\C...oller::$processFilename has been deprecated. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-deprecated  annotation

329
            if (is_file(/** @scrutinizer ignore-deprecated */ $this->processFilename)) {
Loading history...
330 1
                unlink($this->processFilename);
0 ignored issues
show
Deprecated Code introduced by
The property AOE\Crawler\Controller\C...oller::$processFilename has been deprecated. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-deprecated  annotation

330
                unlink(/** @scrutinizer ignore-deprecated */ $this->processFilename);
Loading history...
331
            }
332
        }
333 2
    }
334
335
    /**
336
     * Get disable status
337
     *
338
     * @return bool true if disabled
339
     * @deprecated
340
     */
341 2
    public function getDisabled()
342
    {
343 2
        return is_file($this->processFilename);
0 ignored issues
show
Deprecated Code introduced by
The property AOE\Crawler\Controller\C...oller::$processFilename has been deprecated. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-deprecated  annotation

343
        return is_file(/** @scrutinizer ignore-deprecated */ $this->processFilename);
Loading history...
344
    }
345
346
    /**
347
     * @param string $filenameWithPath
348
     * @deprecated
349
     */
350 3
    public function setProcessFilename($filenameWithPath): void
351
    {
352 3
        $this->processFilename = $filenameWithPath;
0 ignored issues
show
Deprecated Code introduced by
The property AOE\Crawler\Controller\C...oller::$processFilename has been deprecated. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-deprecated  annotation

352
        /** @scrutinizer ignore-deprecated */ $this->processFilename = $filenameWithPath;
Loading history...
353 3
    }
354
355
    /**
356
     * @return string
357
     * @deprecated
358
     */
359 1
    public function getProcessFilename()
360
    {
361 1
        return $this->processFilename;
0 ignored issues
show
Deprecated Code introduced by
The property AOE\Crawler\Controller\C...oller::$processFilename has been deprecated. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-deprecated  annotation

361
        return /** @scrutinizer ignore-deprecated */ $this->processFilename;
Loading history...
362
    }
363
364
    /**
365
     * Sets the extensions settings (unserialized pendant of $TYPO3_CONF_VARS['EXT']['extConf']['crawler']).
366
     */
367 14
    public function setExtensionSettings(array $extensionSettings): void
368
    {
369 14
        $this->extensionSettings = $extensionSettings;
370 14
    }
371
372
    /**
373
     * Check if the given page should be crawled
374
     *
375
     * @return false|string false if the page should be crawled (not excluded), true / skipMessage if it should be skipped
376
     */
377 12
    public function checkIfPageShouldBeSkipped(array $pageRow)
378
    {
379
        // if page is hidden
380 12
        if (! $this->extensionSettings['crawlHiddenPages'] && $pageRow['hidden']) {
381 1
            return 'Because page is hidden';
382
        }
383
384 11
        if (GeneralUtility::inList('3,4,199,254,255', $pageRow['doktype'])) {
385 3
            return 'Because doktype is not allowed';
386
        }
387
388 8
        foreach ($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['crawler']['excludeDoktype'] ?? [] as $key => $doktypeList) {
389 1
            if (GeneralUtility::inList($doktypeList, $pageRow['doktype'])) {
390 1
                return 'Doktype was excluded by "' . $key . '"';
391
            }
392
        }
393
394
        // veto hook
395 7
        foreach ($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['crawler']['pageVeto'] ?? [] as $key => $func) {
396
            $params = [
397 2
                'pageRow' => $pageRow,
398
            ];
399
            // expects "false" if page is ok and "true" or a skipMessage if this page should _not_ be crawled
400 2
            $veto = GeneralUtility::callUserFunction($func, $params, $this);
401 2
            if ($veto !== false) {
402 2
                if (is_string($veto)) {
403 1
                    return $veto;
404
                }
405 1
                return 'Veto from hook "' . htmlspecialchars($key) . '"';
406
            }
407
        }
408
409 5
        return false;
410
    }
411
412
    /**
413
     * Wrapper method for getUrlsForPageId()
414
     * It returns an array of configurations and no urls!
415
     *
416
     * @param array $pageRow Page record with at least dok-type and uid columns.
417
     * @param string $skipMessage
418
     * @return array
419
     * @see getUrlsForPageId()
420
     */
421 6
    public function getUrlsForPageRow(array $pageRow, &$skipMessage = '')
422
    {
423 6
        if (! is_int($pageRow['uid'])) {
424
            $skipMessage = 'PageUid ' . $pageRow['uid'] . ' was not an integer';
425
            return [];
426
        }
427
428 6
        $message = $this->checkIfPageShouldBeSkipped($pageRow);
429 6
        if ($message === false) {
430 5
            $res = $this->getUrlsForPageId($pageRow['uid']);
431 5
            $skipMessage = '';
432
        } else {
433 1
            $skipMessage = $message;
434 1
            $res = [];
435
        }
436
437 6
        return $res;
438
    }
439
440
    /**
441
     * Creates a list of URLs from input array (and submits them to queue if asked for)
442
     * See Web > Info module script + "indexed_search"'s crawler hook-client using this!
443
     *
444
     * @param array $vv Information about URLs from pageRow to crawl.
445
     * @param array $pageRow Page row
446
     * @param int $scheduledTime Unix time to schedule indexing to, typically time()
447
     * @param int $reqMinute Number of requests per minute (creates the interleave between requests)
448
     * @param bool $submitCrawlUrls If set, submits the URLs to queue
449
     * @param bool $downloadCrawlUrls If set (and submitcrawlUrls is false) will fill $downloadUrls with entries)
450
     * @param array $duplicateTrack Array which is passed by reference and contains the an id per url to secure we will not crawl duplicates
451
     * @param array $downloadUrls Array which will be filled with URLS for download if flag is set.
452
     * @param array $incomingProcInstructions Array of processing instructions
453
     * @return string List of URLs (meant for display in backend module)
454
     */
455 4
    public function urlListFromUrlArray(
456
        array $vv,
457
        array $pageRow,
458
        $scheduledTime,
459
        $reqMinute,
460
        $submitCrawlUrls,
461
        $downloadCrawlUrls,
462
        array &$duplicateTrack,
463
        array &$downloadUrls,
464
        array $incomingProcInstructions
465
    ) {
466 4
        if (! is_array($vv['URLs'])) {
467
            return 'ERROR - no URL generated';
468
        }
469 4
        $urlLog = [];
470 4
        $pageId = (int) $pageRow['uid'];
471 4
        $configurationHash = $this->getConfigurationHash($vv);
472 4
        $skipInnerCheck = $this->queueRepository->noUnprocessedQueueEntriesForPageWithConfigurationHashExist($pageId, $configurationHash);
473
474 4
        $urlService = new UrlService();
475
476 4
        foreach ($vv['URLs'] as $urlQuery) {
477 4
            if (! $this->drawURLs_PIfilter($vv['subCfg']['procInstrFilter'], $incomingProcInstructions)) {
478
                continue;
479
            }
480 4
            $url = (string) $urlService->getUrlFromPageAndQueryParameters(
481 4
                $pageId,
482 4
                $urlQuery,
483 4
                $vv['subCfg']['baseUrl'] ?? null,
484 4
                $vv['subCfg']['force_ssl'] ?? 0
485
            );
486
487
            // Create key by which to determine unique-ness:
488 4
            $uKey = $url . '|' . $vv['subCfg']['userGroups'] . '|' . $vv['subCfg']['procInstrFilter'];
489
490 4
            if (isset($duplicateTrack[$uKey])) {
491
                //if the url key is registered just display it and do not resubmit is
492
                $urlLog[] = '<em><span class="text-muted">' . htmlspecialchars($url) . '</span></em>';
493
            } else {
494
                // Scheduled time:
495 4
                $schTime = $scheduledTime + round(count($duplicateTrack) * (60 / $reqMinute));
496 4
                $schTime = intval($schTime / 60) * 60;
497 4
                $formattedDate = BackendUtility::datetime($schTime);
498 4
                $this->urlList[] = '[' . $formattedDate . '] ' . $url;
499 4
                $urlList = '[' . $formattedDate . '] ' . htmlspecialchars($url);
500
501
                // Submit for crawling!
502 4
                if ($submitCrawlUrls) {
503 4
                    $added = $this->addUrl(
504 4
                        $pageId,
505 4
                        $url,
506 4
                        $vv['subCfg'],
507 4
                        $scheduledTime,
508 4
                        $configurationHash,
509 4
                        $skipInnerCheck
510
                    );
511 4
                    if ($added === false) {
512 4
                        $urlList .= ' (URL already existed)';
513
                    }
514
                } elseif ($downloadCrawlUrls) {
515
                    $downloadUrls[$url] = $url;
516
                }
517 4
                $urlLog[] = $urlList;
518
            }
519 4
            $duplicateTrack[$uKey] = true;
520
        }
521
522 4
        return implode('<br>', $urlLog);
523
    }
524
525
    /**
526
     * Returns true if input processing instruction is among registered ones.
527
     *
528
     * @param string $piString PI to test
529
     * @param array $incomingProcInstructions Processing instructions
530
     * @return boolean
531
     */
532 5
    public function drawURLs_PIfilter($piString, array $incomingProcInstructions)
533
    {
534 5
        if (empty($incomingProcInstructions)) {
535 1
            return true;
536
        }
537
538 4
        foreach ($incomingProcInstructions as $pi) {
539 4
            if (GeneralUtility::inList($piString, $pi)) {
540 2
                return true;
541
            }
542
        }
543 2
        return false;
544
    }
545
546 5
    public function getPageTSconfigForId($id): array
547
    {
548 5
        if (! $this->MP) {
549 5
            $pageTSconfig = BackendUtility::getPagesTSconfig($id);
0 ignored issues
show
Deprecated Code introduced by
The function TYPO3\CMS\Backend\Utilit...ity::getPagesTSconfig() has been deprecated. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-deprecated  annotation

549
            $pageTSconfig = /** @scrutinizer ignore-deprecated */ BackendUtility::getPagesTSconfig($id);
Loading history...
550
        } else {
551
            // TODO: Please check, this makes no sense to split a boolean value.
552
            [, $mountPointId] = explode('-', $this->MP);
0 ignored issues
show
Bug introduced by
$this->MP of type true is incompatible with the type string expected by parameter $string of explode(). ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

552
            [, $mountPointId] = explode('-', /** @scrutinizer ignore-type */ $this->MP);
Loading history...
553
            $pageTSconfig = BackendUtility::getPagesTSconfig($mountPointId);
0 ignored issues
show
Bug introduced by
$mountPointId of type string is incompatible with the type integer expected by parameter $id of TYPO3\CMS\Backend\Utilit...ity::getPagesTSconfig(). ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

553
            $pageTSconfig = BackendUtility::getPagesTSconfig(/** @scrutinizer ignore-type */ $mountPointId);
Loading history...
Deprecated Code introduced by
The function TYPO3\CMS\Backend\Utilit...ity::getPagesTSconfig() has been deprecated. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-deprecated  annotation

553
            $pageTSconfig = /** @scrutinizer ignore-deprecated */ BackendUtility::getPagesTSconfig($mountPointId);
Loading history...
554
        }
555
556
        // Call a hook to alter configuration
557 5
        if (is_array($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['crawler']['getPageTSconfigForId'])) {
558
            $params = [
559
                'pageId' => $id,
560
                'pageTSConfig' => &$pageTSconfig,
561
            ];
562
            foreach ($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['crawler']['getPageTSconfigForId'] as $userFunc) {
563
                GeneralUtility::callUserFunction($userFunc, $params, $this);
564
            }
565
        }
566 5
        return $pageTSconfig;
567
    }
568
569
    /**
570
     * This methods returns an array of configurations.
571
     * Adds no urls!
572
     */
573 4
    public function getUrlsForPageId(int $pageId): array
574
    {
575
        // Get page TSconfig for page ID
576 4
        $pageTSconfig = $this->getPageTSconfigForId($pageId);
577
578 4
        $res = [];
579
580
        // Fetch Crawler Configuration from pageTSconfig
581 4
        $crawlerCfg = $pageTSconfig['tx_crawler.']['crawlerCfg.']['paramSets.'] ?? [];
582 4
        foreach ($crawlerCfg as $key => $values) {
583 3
            if (! is_array($values)) {
584 3
                continue;
585
            }
586 3
            $key = str_replace('.', '', $key);
587
            // Sub configuration for a single configuration string:
588 3
            $subCfg = (array) $crawlerCfg[$key . '.'];
589 3
            $subCfg['key'] = $key;
590
591 3
            if (strcmp($subCfg['procInstrFilter'] ?? '', '')) {
592 3
                $subCfg['procInstrFilter'] = implode(',', GeneralUtility::trimExplode(',', $subCfg['procInstrFilter']));
593
            }
594 3
            $pidOnlyList = implode(',', GeneralUtility::trimExplode(',', $subCfg['pidsOnly'], true));
595
596
            // process configuration if it is not page-specific or if the specific page is the current page:
597
            // TODO: Check if $pidOnlyList can be kept as Array instead of imploded
598 3
            if (! strcmp((string) $subCfg['pidsOnly'], '') || GeneralUtility::inList($pidOnlyList, strval($pageId))) {
599
600
                // Explode, process etc.:
601 3
                $res[$key] = [];
602 3
                $res[$key]['subCfg'] = $subCfg;
603 3
                $res[$key]['paramParsed'] = GeneralUtility::explodeUrl2Array($crawlerCfg[$key]);
604 3
                $res[$key]['paramExpanded'] = $this->expandParameters($res[$key]['paramParsed'], $pageId);
605 3
                $res[$key]['origin'] = 'pagets';
606
607
                // recognize MP value
608 3
                if (! $this->MP) {
609 3
                    $res[$key]['URLs'] = $this->compileUrls($res[$key]['paramExpanded'], ['?id=' . $pageId]);
610
                } else {
611
                    $res[$key]['URLs'] = $this->compileUrls($res[$key]['paramExpanded'], ['?id=' . $pageId . '&MP=' . $this->MP]);
0 ignored issues
show
Bug introduced by
Are you sure $this->MP of type true can be used in concatenation? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

611
                    $res[$key]['URLs'] = $this->compileUrls($res[$key]['paramExpanded'], ['?id=' . $pageId . '&MP=' . /** @scrutinizer ignore-type */ $this->MP]);
Loading history...
612
                }
613
            }
614
        }
615
616
        // Get configuration from tx_crawler_configuration records up the rootline
617 4
        $crawlerConfigurations = $this->configurationRepository->getCrawlerConfigurationRecordsFromRootLine($pageId);
618 4
        foreach ($crawlerConfigurations as $configurationRecord) {
619
620
            // check access to the configuration record
621 1
            if (empty($configurationRecord['begroups']) || $this->getBackendUser()->isAdmin() || $this->hasGroupAccess($this->getBackendUser()->user['usergroup_cached_list'], $configurationRecord['begroups'])) {
622 1
                $pidOnlyList = implode(',', GeneralUtility::trimExplode(',', $configurationRecord['pidsonly'], true));
623
624
                // process configuration if it is not page-specific or if the specific page is the current page:
625
                // TODO: Check if $pidOnlyList can be kept as Array instead of imploded
626 1
                if (! strcmp($configurationRecord['pidsonly'], '') || GeneralUtility::inList($pidOnlyList, strval($pageId))) {
627 1
                    $key = $configurationRecord['name'];
628
629
                    // don't overwrite previously defined paramSets
630 1
                    if (! isset($res[$key])) {
631
632
                        /* @var $TSparserObject TypoScriptParser */
633 1
                        $TSparserObject = GeneralUtility::makeInstance(TypoScriptParser::class);
634 1
                        $TSparserObject->parse($configurationRecord['processing_instruction_parameters_ts']);
635
636
                        $subCfg = [
637 1
                            'procInstrFilter' => $configurationRecord['processing_instruction_filter'],
638 1
                            'procInstrParams.' => $TSparserObject->setup,
639 1
                            'baseUrl' => $configurationRecord['base_url'],
640 1
                            'force_ssl' => (int) $configurationRecord['force_ssl'],
641 1
                            'userGroups' => $configurationRecord['fegroups'],
642 1
                            'exclude' => $configurationRecord['exclude'],
643 1
                            'key' => $key,
644
                        ];
645
646 1
                        if (! in_array($pageId, $this->expandExcludeString($subCfg['exclude']), true)) {
647 1
                            $res[$key] = [];
648 1
                            $res[$key]['subCfg'] = $subCfg;
649 1
                            $res[$key]['paramParsed'] = GeneralUtility::explodeUrl2Array($configurationRecord['configuration']);
650 1
                            $res[$key]['paramExpanded'] = $this->expandParameters($res[$key]['paramParsed'], $pageId);
651 1
                            $res[$key]['URLs'] = $this->compileUrls($res[$key]['paramExpanded'], ['?id=' . $pageId]);
652 1
                            $res[$key]['origin'] = 'tx_crawler_configuration_' . $configurationRecord['uid'];
653
                        }
654
                    }
655
                }
656
            }
657
        }
658
659 4
        foreach ($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['crawler']['processUrls'] ?? [] as $func) {
660
            $params = [
661
                'res' => &$res,
662
            ];
663
            GeneralUtility::callUserFunction($func, $params, $this);
664
        }
665 4
        return $res;
666
    }
667
668
    /**
669
     * Find all configurations of subpages of a page
670
     * TODO: Write Functional Tests
671
     */
672 1
    public function getConfigurationsForBranch(int $rootid, int $depth): array
673
    {
674 1
        $configurationsForBranch = [];
675 1
        $pageTSconfig = $this->getPageTSconfigForId($rootid);
676 1
        $sets = $pageTSconfig['tx_crawler.']['crawlerCfg.']['paramSets.'] ?? [];
677 1
        foreach ($sets as $key => $value) {
678
            if (! is_array($value)) {
679
                continue;
680
            }
681
            $configurationsForBranch[] = substr($key, -1) === '.' ? substr($key, 0, -1) : $key;
682
        }
683 1
        $pids = [];
684 1
        $rootLine = BackendUtility::BEgetRootLine($rootid);
685 1
        foreach ($rootLine as $node) {
686 1
            $pids[] = $node['uid'];
687
        }
688
        /* @var PageTreeView $tree */
689 1
        $tree = GeneralUtility::makeInstance(PageTreeView::class);
690 1
        $perms_clause = $this->getBackendUser()->getPagePermsClause(Permission::PAGE_SHOW);
691 1
        $tree->init(empty($perms_clause) ? '' : ('AND ' . $perms_clause));
692 1
        $tree->getTree($rootid, $depth, '');
693 1
        foreach ($tree->tree as $node) {
694
            $pids[] = $node['row']['uid'];
695
        }
696
697 1
        $queryBuilder = $this->getQueryBuilder('tx_crawler_configuration');
698
        $statement = $queryBuilder
699 1
            ->select('name')
700 1
            ->from('tx_crawler_configuration')
701 1
            ->where(
702 1
                $queryBuilder->expr()->in('pid', $queryBuilder->createNamedParameter($pids, Connection::PARAM_INT_ARRAY))
703
            )
704 1
            ->execute();
705
706 1
        while ($row = $statement->fetch()) {
707 1
            $configurationsForBranch[] = $row['name'];
708
        }
709 1
        return $configurationsForBranch;
710
    }
711
712
    /**
713
     * Check if a user has access to an item
714
     * (e.g. get the group list of the current logged in user from $GLOBALS['TSFE']->gr_list)
715
     *
716
     * @param string $groupList Comma-separated list of (fe_)group UIDs from a user
717
     * @param string $accessList Comma-separated list of (fe_)group UIDs of the item to access
718
     * @return bool TRUE if at least one of the users group UIDs is in the access list or the access list is empty
719
     * @see \TYPO3\CMS\Frontend\Page\PageRepository::getMultipleGroupsWhereClause()
720
     */
721 3
    public function hasGroupAccess($groupList, $accessList)
722
    {
723 3
        if (empty($accessList)) {
724 1
            return true;
725
        }
726 2
        foreach (GeneralUtility::intExplode(',', $groupList) as $groupUid) {
727 2
            if (GeneralUtility::inList($accessList, $groupUid)) {
728 1
                return true;
729
            }
730
        }
731 1
        return false;
732
    }
733
734
    /**
735
     * Will expand the parameters configuration to individual values. This follows a certain syntax of the value of each parameter.
736
     * Syntax of values:
737
     * - Basically: If the value is wrapped in [...] it will be expanded according to the following syntax, otherwise the value is taken literally
738
     * - Configuration is splitted by "|" and the parts are processed individually and finally added together
739
     * - For each configuration part:
740
     *         - "[int]-[int]" = Integer range, will be expanded to all values in between, values included, starting from low to high (max. 1000). Example "1-34" or "-40--30"
741
     *         - "_TABLE:[TCA table name];[_PID:[optional page id, default is current page]];[_ENABLELANG:1]" = Look up of table records from PID, filtering out deleted records. Example "_TABLE:tt_content; _PID:123"
742
     *        _ENABLELANG:1 picks only original records without their language overlays
743
     *         - Default: Literal value
744
     *
745
     * @param array $paramArray Array with key (GET var name) and values (value of GET var which is configuration for expansion)
746
     * @param integer $pid Current page ID
747
     * @return array
748
     *
749
     * TODO: Write Functional Tests
750
     */
751 11
    public function expandParameters($paramArray, $pid)
752
    {
753
        // Traverse parameter names:
754 11
        foreach ($paramArray as $p => $v) {
755 11
            $v = trim($v);
756
757
            // If value is encapsulated in square brackets it means there are some ranges of values to find, otherwise the value is literal
758 11
            if (strpos($v, '[') === 0 && substr($v, -1) === ']') {
759
                // So, find the value inside brackets and reset the paramArray value as an array.
760 11
                $v = substr($v, 1, -1);
761 11
                $paramArray[$p] = [];
762
763
                // Explode parts and traverse them:
764 11
                $parts = explode('|', $v);
765 11
                foreach ($parts as $pV) {
766
767
                    // Look for integer range: (fx. 1-34 or -40--30 // reads minus 40 to minus 30)
768 11
                    if (preg_match('/^(-?[0-9]+)\s*-\s*(-?[0-9]+)$/', trim($pV), $reg)) {
769 1
                        $reg = $this->swapIfFirstIsLargerThanSecond($reg);
770
771
                        // Traverse range, add values:
772
                        // Limit to size of range!
773 1
                        $runAwayBrake = 1000;
774 1
                        for ($a = $reg[1]; $a <= $reg[2]; $a++) {
775 1
                            $paramArray[$p][] = $a;
776 1
                            $runAwayBrake--;
777 1
                            if ($runAwayBrake <= 0) {
778
                                break;
779
                            }
780
                        }
781 10
                    } elseif (strpos(trim($pV), '_TABLE:') === 0) {
782
783
                        // Parse parameters:
784 6
                        $subparts = GeneralUtility::trimExplode(';', $pV);
785 6
                        $subpartParams = [];
786 6
                        foreach ($subparts as $spV) {
787 6
                            [$pKey, $pVal] = GeneralUtility::trimExplode(':', $spV);
788 6
                            $subpartParams[$pKey] = $pVal;
789
                        }
790
791
                        // Table exists:
792 6
                        if (isset($GLOBALS['TCA'][$subpartParams['_TABLE']])) {
793 6
                            $lookUpPid = isset($subpartParams['_PID']) ? intval($subpartParams['_PID']) : intval($pid);
794 6
                            $recursiveDepth = isset($subpartParams['_RECURSIVE']) ? intval($subpartParams['_RECURSIVE']) : 0;
795 6
                            $pidField = isset($subpartParams['_PIDFIELD']) ? trim($subpartParams['_PIDFIELD']) : 'pid';
796 6
                            $where = $subpartParams['_WHERE'] ?? '';
797 6
                            $addTable = $subpartParams['_ADDTABLE'] ?? '';
798
799 6
                            $fieldName = $subpartParams['_FIELD'] ? $subpartParams['_FIELD'] : 'uid';
800 6
                            if ($fieldName === 'uid' || $GLOBALS['TCA'][$subpartParams['_TABLE']]['columns'][$fieldName]) {
801 6
                                $queryBuilder = $this->getQueryBuilder($subpartParams['_TABLE']);
802
803 6
                                if ($recursiveDepth > 0) {
804
                                    /** @var QueryGenerator $queryGenerator */
805 2
                                    $queryGenerator = GeneralUtility::makeInstance(QueryGenerator::class);
806 2
                                    $pidList = $queryGenerator->getTreeList($lookUpPid, $recursiveDepth, 0, 1);
807 2
                                    $pidArray = GeneralUtility::intExplode(',', $pidList);
808
                                } else {
809 4
                                    $pidArray = [(string) $lookUpPid];
810
                                }
811
812 6
                                $queryBuilder->getRestrictions()
813 6
                                    ->removeAll()
814 6
                                    ->add(GeneralUtility::makeInstance(DeletedRestriction::class));
815
816
                                $queryBuilder
817 6
                                    ->select($fieldName)
818 6
                                    ->from($subpartParams['_TABLE'])
819 6
                                    ->where(
820 6
                                        $queryBuilder->expr()->in($pidField, $queryBuilder->createNamedParameter($pidArray, Connection::PARAM_INT_ARRAY)),
821 6
                                        $where
822
                                    );
823
824 6
                                if (! empty($addTable)) {
825
                                    // TODO: Check if this works as intended!
826
                                    $queryBuilder->add('from', $addTable);
827
                                }
828 6
                                $transOrigPointerField = $GLOBALS['TCA'][$subpartParams['_TABLE']]['ctrl']['transOrigPointerField'];
829
830 6
                                if ($subpartParams['_ENABLELANG'] && $transOrigPointerField) {
831
                                    $queryBuilder->andWhere(
832
                                        $queryBuilder->expr()->lte(
833
                                            $transOrigPointerField,
834
                                            0
835
                                        )
836
                                    );
837
                                }
838
839 6
                                $statement = $queryBuilder->execute();
840
841 6
                                $rows = [];
842 6
                                while ($row = $statement->fetch()) {
843 6
                                    $rows[$row[$fieldName]] = $row;
844
                                }
845
846 6
                                if (is_array($rows)) {
847 6
                                    $paramArray[$p] = array_merge($paramArray[$p], array_keys($rows));
848
                                }
849
                            }
850
                        }
851
                    } else {
852
                        // Just add value:
853 4
                        $paramArray[$p][] = $pV;
854
                    }
855
                    // Hook for processing own expandParameters place holder
856 11
                    if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['crawler/class.tx_crawler_lib.php']['expandParameters'])) {
857
                        $_params = [
858
                            'pObj' => &$this,
859
                            'paramArray' => &$paramArray,
860
                            'currentKey' => $p,
861
                            'currentValue' => $pV,
862
                            'pid' => $pid,
863
                        ];
864
                        foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['crawler/class.tx_crawler_lib.php']['expandParameters'] as $_funcRef) {
865
                            GeneralUtility::callUserFunction($_funcRef, $_params, $this);
866
                        }
867
                    }
868
                }
869
870
                // Make unique set of values and sort array by key:
871 11
                $paramArray[$p] = array_unique($paramArray[$p]);
872 11
                ksort($paramArray);
873
            } else {
874
                // Set the literal value as only value in array:
875 4
                $paramArray[$p] = [$v];
876
            }
877
        }
878
879 11
        return $paramArray;
880
    }
881
882
    /**
883
     * Compiling URLs from parameter array (output of expandParameters())
884
     * The number of URLs will be the multiplication of the number of parameter values for each key
885
     *
886
     * @param array $paramArray Output of expandParameters(): Array with keys (GET var names) and for each an array of values
887
     * @param array $urls URLs accumulated in this array (for recursion)
888
     * @return array
889
     */
890 7
    public function compileUrls($paramArray, array $urls)
891
    {
892 7
        if (empty($paramArray)) {
893 7
            return $urls;
894
        }
895
        // shift first off stack:
896 6
        reset($paramArray);
897 6
        $varName = key($paramArray);
898 6
        $valueSet = array_shift($paramArray);
899
900
        // Traverse value set:
901 6
        $newUrls = [];
902 6
        foreach ($urls as $url) {
903 5
            foreach ($valueSet as $val) {
904 5
                $newUrls[] = $url . (strcmp((string) $val, '') ? '&' . rawurlencode($varName) . '=' . rawurlencode((string) $val) : '');
905
906 5
                if (count($newUrls) > $this->maximumUrlsToCompile) {
907
                    break;
908
                }
909
            }
910
        }
911 6
        return $this->compileUrls($paramArray, $newUrls);
912
    }
913
914
    /************************************
915
     *
916
     * Crawler log
917
     *
918
     ************************************/
919
920
    /**
921
     * Return array of records from crawler queue for input page ID
922
     *
923
     * @param integer $id Page ID for which to look up log entries.
924
     * @param boolean $doFlush If TRUE, then entries selected at DELETED(!) instead of selected!
925
     * @param boolean $doFullFlush
926
     * @param integer $itemsPerPage Limit the amount of entries per page default is 10
927
     * @return array
928
     */
929 4
    public function getLogEntriesForPageId($id, QueueFilter $queueFilter, $doFlush = false, $doFullFlush = false, $itemsPerPage = 10)
0 ignored issues
show
Unused Code introduced by
The parameter $doFullFlush is not used and could be removed. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-unused  annotation

929
    public function getLogEntriesForPageId($id, QueueFilter $queueFilter, $doFlush = false, /** @scrutinizer ignore-unused */ $doFullFlush = false, $itemsPerPage = 10)

This check looks for parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
930
    {
931 4
        $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable($this->tableName);
932
        $queryBuilder
933 4
            ->select('*')
934 4
            ->from($this->tableName)
935 4
            ->where(
936 4
                $queryBuilder->expr()->eq('page_id', $queryBuilder->createNamedParameter($id, PDO::PARAM_INT))
937
            )
938 4
            ->orderBy('scheduled', 'DESC');
939
940 4
        $expressionBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
941 4
            ->getConnectionForTable($this->tableName)
942 4
            ->getExpressionBuilder();
943 4
        $query = $expressionBuilder->andX();
0 ignored issues
show
Unused Code introduced by
The assignment to $query is dead and can be removed.
Loading history...
944
        // PHPStorm adds the highlight that the $addWhere is immediately overwritten,
945
        // but the $query = $expressionBuilder->andX() ensures that the $addWhere is written correctly with AND
946
        // between the statements, it's not a mistake in the code.
947 4
        switch ($queueFilter) {
948 4
            case 'pending':
949
                $queryBuilder->andWhere($queryBuilder->expr()->eq('exec_time', 0));
950
                break;
951 4
            case 'finished':
952
                $queryBuilder->andWhere($queryBuilder->expr()->gt('exec_time', 0));
953
                break;
954
        }
955
956 4
        if ($doFlush) {
957 2
            $this->queueRepository->flushQueue($queueFilter);
958
        }
959 4
        if ($itemsPerPage > 0) {
960
            $queryBuilder
961 4
                ->setMaxResults((int) $itemsPerPage);
962
        }
963
964 4
        return $queryBuilder->execute()->fetchAll();
965
    }
966
967
    /**
968
     * Return array of records from crawler queue for input set ID
969
     *
970
     * @param int $set_id Set ID for which to look up log entries.
971
     * @param string $filter Filter: "all" => all entries, "pending" => all that is not yet run, "finished" => all complete ones
972
     * @param bool $doFlush If TRUE, then entries selected at DELETED(!) instead of selected!
973
     * @param int $itemsPerPage Limit the amount of entries per page default is 10
974
     * @return array
975
     *
976
     * @deprecated
977
     */
978 6
    public function getLogEntriesForSetId(int $set_id, string $filter = '', bool $doFlush = false, bool $doFullFlush = false, int $itemsPerPage = 10)
979
    {
980 6
        $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable($this->tableName);
981
        $queryBuilder
982 6
            ->select('*')
983 6
            ->from($this->tableName)
984 6
            ->where(
985 6
                $queryBuilder->expr()->eq('set_id', $queryBuilder->createNamedParameter($set_id, PDO::PARAM_INT))
986
            )
987 6
            ->orderBy('scheduled', 'DESC');
988
989 6
        $expressionBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
990 6
            ->getConnectionForTable($this->tableName)
991 6
            ->getExpressionBuilder();
992 6
        $query = $expressionBuilder->andX();
993
        // PHPStorm adds the highlight that the $addWhere is immediately overwritten,
994
        // but the $query = $expressionBuilder->andX() ensures that the $addWhere is written correctly with AND
995
        // between the statements, it's not a mistake in the code.
996 6
        $addWhere = '';
997 6
        switch ($filter) {
998 6
            case 'pending':
999 1
                $queryBuilder->andWhere($queryBuilder->expr()->eq('exec_time', 0));
1000 1
                $addWhere = $query->add($expressionBuilder->eq('exec_time', 0));
0 ignored issues
show
Unused Code introduced by
The assignment to $addWhere is dead and can be removed.
Loading history...
1001 1
                break;
1002 5
            case 'finished':
1003 1
                $queryBuilder->andWhere($queryBuilder->expr()->gt('exec_time', 0));
1004 1
                $addWhere = $query->add($expressionBuilder->gt('exec_time', 0));
1005 1
                break;
1006
        }
1007 6
        if ($doFlush) {
1008 4
            $addWhere = $query->add($expressionBuilder->eq('set_id', (int) $set_id));
1009 4
            $this->flushQueue($doFullFlush ? '' : $addWhere);
0 ignored issues
show
Deprecated Code introduced by
The function AOE\Crawler\Controller\C...ontroller::flushQueue() has been deprecated. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-deprecated  annotation

1009
            /** @scrutinizer ignore-deprecated */ $this->flushQueue($doFullFlush ? '' : $addWhere);
Loading history...
1010 4
            return [];
1011
        }
1012 2
        if ($itemsPerPage > 0) {
1013
            $queryBuilder
1014 2
                ->setMaxResults((int) $itemsPerPage);
1015
        }
1016
1017 2
        return $queryBuilder->execute()->fetchAll();
1018
    }
1019
1020
    /**
1021
     * Adding call back entries to log (called from hooks typically, see indexed search class "class.crawler.php"
1022
     *
1023
     * @param integer $setId Set ID
1024
     * @param array $params Parameters to pass to call back function
1025
     * @param string $callBack Call back object reference, eg. 'EXT:indexed_search/class.crawler.php:&tx_indexedsearch_crawler'
1026
     * @param integer $page_id Page ID to attach it to
1027
     * @param integer $schedule Time at which to activate
1028
     */
1029
    public function addQueueEntry_callBack($setId, $params, $callBack, $page_id = 0, $schedule = 0): void
1030
    {
1031
        if (! is_array($params)) {
0 ignored issues
show
introduced by
The condition is_array($params) is always true.
Loading history...
1032
            $params = [];
1033
        }
1034
        $params['_CALLBACKOBJ'] = $callBack;
1035
1036
        GeneralUtility::makeInstance(ConnectionPool::class)->getConnectionForTable('tx_crawler_queue')
1037
            ->insert(
1038
                'tx_crawler_queue',
1039
                [
1040
                    'page_id' => (int) $page_id,
1041
                    'parameters' => json_encode($params),
1042
                    'scheduled' => (int) $schedule ?: $this->getCurrentTime(),
1043
                    'exec_time' => 0,
1044
                    'set_id' => (int) $setId,
1045
                    'result_data' => '',
1046
                ]
1047
            );
1048
    }
1049
1050
    /************************************
1051
     *
1052
     * URL setting
1053
     *
1054
     ************************************/
1055
1056
    /**
1057
     * Setting a URL for crawling:
1058
     *
1059
     * @param integer $id Page ID
1060
     * @param string $url Complete URL
1061
     * @param array $subCfg Sub configuration array (from TS config)
1062
     * @param integer $tstamp Scheduled-time
1063
     * @param string $configurationHash (optional) configuration hash
1064
     * @param bool $skipInnerDuplicationCheck (optional) skip inner duplication check
1065
     * @return bool
1066
     */
1067 8
    public function addUrl(
1068
        $id,
1069
        $url,
1070
        array $subCfg,
1071
        $tstamp,
1072
        $configurationHash = '',
1073
        $skipInnerDuplicationCheck = false
1074
    ) {
1075 8
        $urlAdded = false;
1076 8
        $rows = [];
1077
1078
        // Creating parameters:
1079
        $parameters = [
1080 8
            'url' => $url,
1081
        ];
1082
1083
        // fe user group simulation:
1084 8
        $uGs = implode(',', array_unique(GeneralUtility::intExplode(',', $subCfg['userGroups'], true)));
1085 8
        if ($uGs) {
1086 1
            $parameters['feUserGroupList'] = $uGs;
1087
        }
1088
1089
        // Setting processing instructions
1090 8
        $parameters['procInstructions'] = GeneralUtility::trimExplode(',', $subCfg['procInstrFilter']);
1091 8
        if (is_array($subCfg['procInstrParams.'])) {
1092 5
            $parameters['procInstrParams'] = $subCfg['procInstrParams.'];
1093
        }
1094
1095
        // Compile value array:
1096 8
        $parameters_serialized = json_encode($parameters);
1097
        $fieldArray = [
1098 8
            'page_id' => (int) $id,
1099 8
            'parameters' => $parameters_serialized,
1100 8
            'parameters_hash' => GeneralUtility::shortMD5($parameters_serialized),
1101 8
            'configuration_hash' => $configurationHash,
1102 8
            'scheduled' => $tstamp,
1103 8
            'exec_time' => 0,
1104 8
            'set_id' => (int) $this->setID,
1105 8
            'result_data' => '',
1106 8
            'configuration' => $subCfg['key'],
1107
        ];
1108
1109 8
        if ($this->registerQueueEntriesInternallyOnly) {
1110
            //the entries will only be registered and not stored to the database
1111 1
            $this->queueEntries[] = $fieldArray;
1112
        } else {
1113 7
            if (! $skipInnerDuplicationCheck) {
1114
                // check if there is already an equal entry
1115 6
                $rows = $this->queueRepository->getDuplicateQueueItemsIfExists(
1116 6
                    (bool) $this->extensionSettings['enableTimeslot'],
1117 6
                    $tstamp,
1118 6
                    $this->getCurrentTime(),
1119 6
                    $fieldArray['page_id'],
1120 6
                    $fieldArray['parameters_hash']
1121
                );
1122
            }
1123
1124 7
            if (empty($rows)) {
1125 6
                $connectionForCrawlerQueue = GeneralUtility::makeInstance(ConnectionPool::class)->getConnectionForTable('tx_crawler_queue');
1126 6
                $connectionForCrawlerQueue->insert(
1127 6
                    'tx_crawler_queue',
1128 6
                    $fieldArray
1129
                );
1130 6
                $uid = $connectionForCrawlerQueue->lastInsertId('tx_crawler_queue', 'qid');
1131 6
                $rows[] = $uid;
1132 6
                $urlAdded = true;
1133
1134 6
                $signalPayload = ['uid' => $uid, 'fieldArray' => $fieldArray];
1135 6
                SignalSlotUtility::emitSignal(
1136 6
                    self::class,
1137 6
                    SignalSlotUtility::SIGNAL_URL_ADDED_TO_QUEUE,
1138 6
                    $signalPayload
1139
                );
1140
            } else {
1141 3
                $signalPayload = ['rows' => $rows, 'fieldArray' => $fieldArray];
1142 3
                SignalSlotUtility::emitSignal(
1143 3
                    self::class,
1144 3
                    SignalSlotUtility::SIGNAL_DUPLICATE_URL_IN_QUEUE,
1145 3
                    $signalPayload
1146
                );
1147
            }
1148
        }
1149
1150 8
        return $urlAdded;
1151
    }
1152
1153
    /**
1154
     * Returns the current system time
1155
     *
1156
     * @return int
1157
     */
1158 2
    public function getCurrentTime()
1159
    {
1160 2
        return time();
1161
    }
1162
1163
    /************************************
1164
     *
1165
     * URL reading
1166
     *
1167
     ************************************/
1168
1169
    /**
1170
     * Read URL for single queue entry
1171
     *
1172
     * @param integer $queueId
1173
     * @param boolean $force If set, will process even if exec_time has been set!
1174
     * @return integer
1175
     */
1176
    public function readUrl($queueId, $force = false)
1177
    {
1178
        $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable($this->tableName);
1179
        $ret = 0;
1180
        $this->logger->debug('crawler-readurl start ' . microtime(true));
1181
        // Get entry:
1182
        $queryBuilder
1183
            ->select('*')
1184
            ->from('tx_crawler_queue')
1185
            ->where(
1186
                $queryBuilder->expr()->eq('qid', $queryBuilder->createNamedParameter($queueId, PDO::PARAM_INT))
1187
            );
1188
        if (! $force) {
1189
            $queryBuilder
1190
                ->andWhere('exec_time = 0')
1191
                ->andWhere('process_scheduled > 0');
1192
        }
1193
        $queueRec = $queryBuilder->execute()->fetch();
1194
1195
        if (! is_array($queueRec)) {
1196
            return;
1197
        }
1198
1199
        SignalSlotUtility::emitSignal(
1200
            self::class,
1201
            SignalSlotUtility::SIGNAL_QUEUEITEM_PREPROCESS,
1202
            [$queueId, &$queueRec]
1203
        );
1204
1205
        // Set exec_time to lock record:
1206
        $field_array = ['exec_time' => $this->getCurrentTime()];
1207
1208
        if (isset($this->processID)) {
1209
            //if mulitprocessing is used we need to store the id of the process which has handled this entry
1210
            $field_array['process_id_completed'] = $this->processID;
1211
        }
1212
1213
        GeneralUtility::makeInstance(ConnectionPool::class)->getConnectionForTable('tx_crawler_queue')
1214
            ->update(
1215
                'tx_crawler_queue',
1216
                $field_array,
1217
                ['qid' => (int) $queueId]
1218
            );
1219
1220
        $result = $this->queueExecutor->executeQueueItem($queueRec, $this);
1221
        if ($result['content'] === null) {
1222
            $resultData = 'An errors happened';
1223
        } else {
1224
            /** @var JsonCompatibilityConverter $jsonCompatibilityConverter */
1225
            $jsonCompatibilityConverter = GeneralUtility::makeInstance(JsonCompatibilityConverter::class);
1226
            $resultData = $jsonCompatibilityConverter->convert($result['content']);
1227
        }
1228
1229
        //atm there's no need to point to specific pollable extensions
1230
        if (is_array($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['crawler']['pollSuccess'])) {
1231
            foreach ($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['crawler']['pollSuccess'] as $pollable) {
1232
                // only check the success value if the instruction is runnig
1233
                // it is important to name the pollSuccess key same as the procInstructions key
1234
                if (is_array($resultData['parameters']['procInstructions'])
1235
                    && in_array(
1236
                        $pollable,
1237
                        $resultData['parameters']['procInstructions'], true
1238
                    )
1239
                ) {
1240
                    if (! empty($resultData['success'][$pollable]) && $resultData['success'][$pollable]) {
1241
                        $ret |= self::CLI_STATUS_POLLABLE_PROCESSED;
1242
                    }
1243
                }
1244
            }
1245
        }
1246
1247
        // Set result in log which also denotes the end of the processing of this entry.
1248
        $field_array = ['result_data' => json_encode($result)];
1249
1250
        SignalSlotUtility::emitSignal(
1251
            self::class,
1252
            SignalSlotUtility::SIGNAL_QUEUEITEM_POSTPROCESS,
1253
            [$queueId, &$field_array]
1254
        );
1255
1256
        GeneralUtility::makeInstance(ConnectionPool::class)->getConnectionForTable('tx_crawler_queue')
1257
            ->update(
1258
                'tx_crawler_queue',
1259
                $field_array,
1260
                ['qid' => (int) $queueId]
1261
            );
1262
1263
        $this->logger->debug('crawler-readurl stop ' . microtime(true));
1264
        return $ret;
1265
    }
1266
1267
    /**
1268
     * Read URL for not-yet-inserted log-entry
1269
     *
1270
     * @param array $field_array Queue field array,
1271
     *
1272
     * @return array|bool|mixed|string
1273
     */
1274
    public function readUrlFromArray($field_array)
1275
    {
1276
        // Set exec_time to lock record:
1277
        $field_array['exec_time'] = $this->getCurrentTime();
1278
        $connectionForCrawlerQueue = GeneralUtility::makeInstance(ConnectionPool::class)->getConnectionForTable($this->tableName);
1279
        $connectionForCrawlerQueue->insert(
1280
            $this->tableName,
1281
            $field_array
1282
        );
1283
        $queueId = $connectionForCrawlerQueue->lastInsertId($this->tableName, 'qid');
1284
        $result = $this->queueExecutor->executeQueueItem($field_array, $this);
1285
1286
        // Set result in log which also denotes the end of the processing of this entry.
1287
        $field_array = ['result_data' => json_encode($result)];
1288
1289
        SignalSlotUtility::emitSignal(
1290
            self::class,
1291
            SignalSlotUtility::SIGNAL_QUEUEITEM_POSTPROCESS,
1292
            [$queueId, &$field_array]
1293
        );
1294
1295
        $connectionForCrawlerQueue->update(
1296
            $this->tableName,
1297
            $field_array,
1298
            ['qid' => $queueId]
1299
        );
1300
1301
        return $result;
1302
    }
1303
1304
    /*****************************
1305
     *
1306
     * Compiling URLs to crawl - tools
1307
     *
1308
     *****************************/
1309
1310
    /**
1311
     * @param integer $id Root page id to start from.
1312
     * @param integer $depth Depth of tree, 0=only id-page, 1= on sublevel, 99 = infinite
1313
     * @param integer $scheduledTime Unix Time when the URL is timed to be visited when put in queue
1314
     * @param integer $reqMinute Number of requests per minute (creates the interleave between requests)
1315
     * @param boolean $submitCrawlUrls If set, submits the URLs to queue in database (real crawling)
1316
     * @param boolean $downloadCrawlUrls If set (and submitcrawlUrls is false) will fill $downloadUrls with entries)
1317
     * @param array $incomingProcInstructions Array of processing instructions
1318
     * @param array $configurationSelection Array of configuration keys
1319
     * @return string
1320
     */
1321
    public function getPageTreeAndUrls(
1322
        $id,
1323
        $depth,
1324
        $scheduledTime,
1325
        $reqMinute,
1326
        $submitCrawlUrls,
1327
        $downloadCrawlUrls,
1328
        array $incomingProcInstructions,
1329
        array $configurationSelection
1330
    ) {
1331
        $this->scheduledTime = $scheduledTime;
1332
        $this->reqMinute = $reqMinute;
1333
        $this->submitCrawlUrls = $submitCrawlUrls;
1334
        $this->downloadCrawlUrls = $downloadCrawlUrls;
1335
        $this->incomingProcInstructions = $incomingProcInstructions;
1336
        $this->incomingConfigurationSelection = $configurationSelection;
1337
1338
        $this->duplicateTrack = [];
1339
        $this->downloadUrls = [];
1340
1341
        // Drawing tree:
1342
        /* @var PageTreeView $tree */
1343
        $tree = GeneralUtility::makeInstance(PageTreeView::class);
1344
        $perms_clause = $this->getBackendUser()->getPagePermsClause(Permission::PAGE_SHOW);
1345
        $tree->init('AND ' . $perms_clause);
1346
1347
        $pageInfo = BackendUtility::readPageAccess($id, $perms_clause);
1348
        if (is_array($pageInfo)) {
0 ignored issues
show
introduced by
The condition is_array($pageInfo) is always true.
Loading history...
1349
            // Set root row:
1350
            $tree->tree[] = [
1351
                'row' => $pageInfo,
1352
                'HTML' => $this->iconFactory->getIconForRecord('pages', $pageInfo, Icon::SIZE_SMALL),
1353
            ];
1354
        }
1355
1356
        // Get branch beneath:
1357
        if ($depth) {
1358
            $tree->getTree($id, $depth, '');
1359
        }
1360
1361
        // Traverse page tree:
1362
        $code = '';
1363
1364
        foreach ($tree->tree as $data) {
1365
            $this->MP = false;
1366
1367
            // recognize mount points
1368
            if ($data['row']['doktype'] === PageRepository::DOKTYPE_MOUNTPOINT) {
1369
                $mountpage = $this->pageRepository->getPage($data['row']['uid']);
1370
1371
                // fetch mounted pages
1372
                $this->MP = $mountpage[0]['mount_pid'] . '-' . $data['row']['uid'];
0 ignored issues
show
Documentation Bug introduced by
The property $MP was declared of type boolean, but $mountpage[0]['mount_pid...' . $data['row']['uid'] is of type string. Maybe add a type cast?

This check looks for assignments to scalar types that may be of the wrong type.

To ensure the code behaves as expected, it may be a good idea to add an explicit type cast.

$answer = 42;

$correct = false;

$correct = (bool) $answer;
Loading history...
1373
1374
                $mountTree = GeneralUtility::makeInstance(PageTreeView::class);
1375
                $mountTree->init('AND ' . $perms_clause);
1376
                $mountTree->getTree($mountpage[0]['mount_pid'], $depth);
1377
1378
                foreach ($mountTree->tree as $mountData) {
1379
                    $code .= $this->drawURLs_addRowsForPage(
1380
                        $mountData['row'],
1381
                        $mountData['HTML'] . BackendUtility::getRecordTitle('pages', $mountData['row'], true)
1382
                    );
1383
                }
1384
1385
                // replace page when mount_pid_ol is enabled
1386
                if ($mountpage[0]['mount_pid_ol']) {
1387
                    $data['row']['uid'] = $mountpage[0]['mount_pid'];
1388
                } else {
1389
                    // if the mount_pid_ol is not set the MP must not be used for the mountpoint page
1390
                    $this->MP = false;
1391
                }
1392
            }
1393
1394
            $code .= $this->drawURLs_addRowsForPage(
1395
                $data['row'],
1396
                $data['HTML'] . BackendUtility::getRecordTitle('pages', $data['row'], true)
1397
            );
1398
        }
1399
1400
        return $code;
1401
    }
1402
1403
    /**
1404
     * Expands exclude string
1405
     *
1406
     * @param string $excludeString Exclude string
1407
     * @return array
1408
     */
1409 2
    public function expandExcludeString($excludeString)
1410
    {
1411
        // internal static caches;
1412 2
        static $expandedExcludeStringCache;
1413 2
        static $treeCache;
1414
1415 2
        if (empty($expandedExcludeStringCache[$excludeString])) {
1416 2
            $pidList = [];
1417
1418 2
            if (! empty($excludeString)) {
1419
                /** @var PageTreeView $tree */
1420 1
                $tree = GeneralUtility::makeInstance(PageTreeView::class);
1421 1
                $tree->init('AND ' . $this->getBackendUser()->getPagePermsClause(Permission::PAGE_SHOW));
1422
1423 1
                $excludeParts = GeneralUtility::trimExplode(',', $excludeString);
1424
1425 1
                foreach ($excludeParts as $excludePart) {
1426 1
                    [$pid, $depth] = GeneralUtility::trimExplode('+', $excludePart);
1427
1428
                    // default is "page only" = "depth=0"
1429 1
                    if (empty($depth)) {
1430 1
                        $depth = (stristr($excludePart, '+')) ? 99 : 0;
1431
                    }
1432
1433 1
                    $pidList[] = (int) $pid;
1434
1435 1
                    if ($depth > 0) {
1436
                        if (empty($treeCache[$pid][$depth])) {
1437
                            $tree->reset();
1438
                            $tree->getTree($pid, $depth);
0 ignored issues
show
Bug introduced by
$pid of type string is incompatible with the type integer expected by parameter $uid of TYPO3\CMS\Backend\Tree\V...ractTreeView::getTree(). ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

1438
                            $tree->getTree(/** @scrutinizer ignore-type */ $pid, $depth);
Loading history...
1439
                            $treeCache[$pid][$depth] = $tree->tree;
1440
                        }
1441
1442
                        foreach ($treeCache[$pid][$depth] as $data) {
1443
                            $pidList[] = (int) $data['row']['uid'];
1444
                        }
1445
                    }
1446
                }
1447
            }
1448
1449 2
            $expandedExcludeStringCache[$excludeString] = array_unique($pidList);
1450
        }
1451
1452 2
        return $expandedExcludeStringCache[$excludeString];
1453
    }
1454
1455
    /**
1456
     * Create the rows for display of the page tree
1457
     * For each page a number of rows are shown displaying GET variable configuration
1458
     */
1459
    public function drawURLs_addRowsForPage(array $pageRow, string $pageTitle): string
1460
    {
1461
        $skipMessage = '';
1462
1463
        // Get list of configurations
1464
        $configurations = $this->getUrlsForPageRow($pageRow, $skipMessage);
1465
1466
        if (! empty($this->incomingConfigurationSelection)) {
1467
            // remove configuration that does not match the current selection
1468
            foreach ($configurations as $confKey => $confArray) {
1469
                if (! in_array($confKey, $this->incomingConfigurationSelection, true)) {
1470
                    unset($configurations[$confKey]);
1471
                }
1472
            }
1473
        }
1474
1475
        // Traverse parameter combinations:
1476
        $c = 0;
1477
        $content = '';
1478
        if (! empty($configurations)) {
1479
            foreach ($configurations as $confKey => $confArray) {
1480
1481
                // Title column:
1482
                if (! $c) {
1483
                    $titleClm = '<td rowspan="' . count($configurations) . '">' . $pageTitle . '</td>';
1484
                } else {
1485
                    $titleClm = '';
1486
                }
1487
1488
                if (! in_array($pageRow['uid'], $this->expandExcludeString($confArray['subCfg']['exclude']), true)) {
1489
1490
                    // URL list:
1491
                    $urlList = $this->urlListFromUrlArray(
1492
                        $confArray,
1493
                        $pageRow,
1494
                        $this->scheduledTime,
1495
                        $this->reqMinute,
1496
                        $this->submitCrawlUrls,
1497
                        $this->downloadCrawlUrls,
1498
                        $this->duplicateTrack,
1499
                        $this->downloadUrls,
1500
                        // if empty the urls won't be filtered by processing instructions
1501
                        $this->incomingProcInstructions
1502
                    );
1503
1504
                    // Expanded parameters:
1505
                    $paramExpanded = '';
1506
                    $calcAccu = [];
1507
                    $calcRes = 1;
1508
                    foreach ($confArray['paramExpanded'] as $gVar => $gVal) {
1509
                        $paramExpanded .= '
1510
                            <tr>
1511
                                <td>' . htmlspecialchars('&' . $gVar . '=') . '<br/>' .
1512
                            '(' . count($gVal) . ')' .
1513
                            '</td>
1514
                                <td nowrap="nowrap">' . nl2br(htmlspecialchars(implode(chr(10), $gVal))) . '</td>
1515
                            </tr>
1516
                        ';
1517
                        $calcRes *= count($gVal);
1518
                        $calcAccu[] = count($gVal);
1519
                    }
1520
                    $paramExpanded = '<table>' . $paramExpanded . '</table>';
1521
                    $paramExpanded .= 'Comb: ' . implode('*', $calcAccu) . '=' . $calcRes;
1522
1523
                    // Options
1524
                    $optionValues = '';
1525
                    if ($confArray['subCfg']['userGroups']) {
1526
                        $optionValues .= 'User Groups: ' . $confArray['subCfg']['userGroups'] . '<br/>';
1527
                    }
1528
                    if ($confArray['subCfg']['procInstrFilter']) {
1529
                        $optionValues .= 'ProcInstr: ' . $confArray['subCfg']['procInstrFilter'] . '<br/>';
1530
                    }
1531
1532
                    // Compile row:
1533
                    $content .= '
1534
                        <tr>
1535
                            ' . $titleClm . '
1536
                            <td>' . htmlspecialchars($confKey) . '</td>
1537
                            <td>' . nl2br(htmlspecialchars(rawurldecode(trim(str_replace('&', chr(10) . '&', GeneralUtility::implodeArrayForUrl('', $confArray['paramParsed'])))))) . '</td>
1538
                            <td>' . $paramExpanded . '</td>
1539
                            <td nowrap="nowrap">' . $urlList . '</td>
1540
                            <td nowrap="nowrap">' . $optionValues . '</td>
1541
                            <td nowrap="nowrap">' . DebugUtility::viewArray($confArray['subCfg']['procInstrParams.']) . '</td>
1542
                        </tr>';
1543
                } else {
1544
                    $content .= '<tr>
1545
                            ' . $titleClm . '
1546
                            <td>' . htmlspecialchars($confKey) . '</td>
1547
                            <td colspan="5"><em>No entries</em> (Page is excluded in this configuration)</td>
1548
                        </tr>';
1549
                }
1550
1551
                $c++;
1552
            }
1553
        } else {
1554
            $message = ! empty($skipMessage) ? ' (' . $skipMessage . ')' : '';
1555
1556
            // Compile row:
1557
            $content .= '
1558
                <tr>
1559
                    <td>' . $pageTitle . '</td>
1560
                    <td colspan="6"><em>No entries</em>' . $message . '</td>
1561
                </tr>';
1562
        }
1563
1564
        return $content;
1565
    }
1566
1567
    /*****************************
1568
     *
1569
     * CLI functions
1570
     *
1571
     *****************************/
1572
1573
    /**
1574
     * Running the functionality of the CLI (crawling URLs from queue)
1575
     */
1576
    public function CLI_run(int $countInARun, int $sleepTime, int $sleepAfterFinish): int
1577
    {
1578
        $result = 0;
1579
        $counter = 0;
1580
1581
        // First, run hooks:
1582
        $this->CLI_runHooks();
1583
1584
        // Clean up the queue
1585
        $this->queueRepository->cleanupQueue();
1586
1587
        // Select entries:
1588
        $rows = $this->queueRepository->fetchRecordsToBeCrawled($countInARun);
1589
1590
        if (! empty($rows)) {
1591
            $quidList = [];
1592
1593
            foreach ($rows as $r) {
1594
                $quidList[] = $r['qid'];
1595
            }
1596
1597
            $processId = $this->CLI_buildProcessId();
1598
1599
            //save the number of assigned queue entries to determine how many have been processed later
1600
            $numberOfAffectedRows = $this->queueRepository->updateProcessIdAndSchedulerForQueueIds($quidList, $processId);
1601
            $this->processRepository->updateProcessAssignItemsCount($numberOfAffectedRows, $processId);
1602
1603
            if ($numberOfAffectedRows !== count($quidList)) {
1604
                $this->CLI_debug('Nothing processed due to multi-process collision (' . $this->CLI_buildProcessId() . ')');
0 ignored issues
show
Deprecated Code introduced by
The function AOE\Crawler\Controller\C...Controller::CLI_debug() has been deprecated. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-deprecated  annotation

1604
                /** @scrutinizer ignore-deprecated */ $this->CLI_debug('Nothing processed due to multi-process collision (' . $this->CLI_buildProcessId() . ')');
Loading history...
1605
                return ($result | self::CLI_STATUS_ABORTED);
1606
            }
1607
1608
            foreach ($rows as $r) {
1609
                $result |= $this->readUrl($r['qid']);
1610
1611
                $counter++;
1612
                // Just to relax the system
1613
                usleep((int) $sleepTime);
1614
1615
                // if during the start and the current read url the cli has been disable we need to return from the function
1616
                // mark the process NOT as ended.
1617
                if ($this->crawler->isDisabled()) {
1618
                    return ($result | self::CLI_STATUS_ABORTED);
1619
                }
1620
1621
                if (! $this->processRepository->isProcessActive($this->CLI_buildProcessId())) {
1622
                    $this->CLI_debug('conflict / timeout (' . $this->CLI_buildProcessId() . ')');
0 ignored issues
show
Deprecated Code introduced by
The function AOE\Crawler\Controller\C...Controller::CLI_debug() has been deprecated. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-deprecated  annotation

1622
                    /** @scrutinizer ignore-deprecated */ $this->CLI_debug('conflict / timeout (' . $this->CLI_buildProcessId() . ')');
Loading history...
1623
                    $result |= self::CLI_STATUS_ABORTED;
1624
                    //possible timeout
1625
                    break;
1626
                }
1627
            }
1628
1629
            sleep((int) $sleepAfterFinish);
1630
1631
            $msg = 'Rows: ' . $counter;
1632
            $this->CLI_debug($msg . ' (' . $this->CLI_buildProcessId() . ')');
0 ignored issues
show
Deprecated Code introduced by
The function AOE\Crawler\Controller\C...Controller::CLI_debug() has been deprecated. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-deprecated  annotation

1632
            /** @scrutinizer ignore-deprecated */ $this->CLI_debug($msg . ' (' . $this->CLI_buildProcessId() . ')');
Loading history...
1633
        } else {
1634
            $this->CLI_debug('Nothing within queue which needs to be processed (' . $this->CLI_buildProcessId() . ')');
0 ignored issues
show
Deprecated Code introduced by
The function AOE\Crawler\Controller\C...Controller::CLI_debug() has been deprecated. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-deprecated  annotation

1634
            /** @scrutinizer ignore-deprecated */ $this->CLI_debug('Nothing within queue which needs to be processed (' . $this->CLI_buildProcessId() . ')');
Loading history...
1635
        }
1636
1637
        if ($counter > 0) {
1638
            $result |= self::CLI_STATUS_PROCESSED;
1639
        }
1640
1641
        return $result;
1642
    }
1643
1644
    /**
1645
     * Activate hooks
1646
     */
1647
    public function CLI_runHooks(): void
1648
    {
1649
        foreach ($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['crawler']['cli_hooks'] ?? [] as $objRef) {
1650
            $hookObj = GeneralUtility::makeInstance($objRef);
1651
            if (is_object($hookObj)) {
1652
                $hookObj->crawler_init($this);
1653
            }
1654
        }
1655
    }
1656
1657
    /**
1658
     * Try to acquire a new process with the given id
1659
     * also performs some auto-cleanup for orphan processes
1660
     * @param string $id identification string for the process
1661
     * @return boolean
1662
     * @todo preemption might not be the most elegant way to clean up
1663
     */
1664
    public function CLI_checkAndAcquireNewProcess($id)
1665
    {
1666
        $ret = true;
1667
1668
        $systemProcessId = getmypid();
1669
        if (! $systemProcessId) {
1670
            return false;
1671
        }
1672
1673
        $processCount = 0;
1674
        $orphanProcesses = [];
1675
1676
        $activeProcesses = $this->processRepository->findAllActive();
1677
        $currentTime = $this->getCurrentTime();
1678
1679
        /** @var Process $process */
1680
        foreach ($activeProcesses as $process) {
1681
            if ($process->getTtl() < $currentTime) {
1682
                $orphanProcesses[] = $process->getProcessId();
1683
            } else {
1684
                $processCount++;
1685
            }
1686
        }
1687
1688
        // if there are less than allowed active processes then add a new one
1689
        if ($processCount < (int) $this->extensionSettings['processLimit']) {
1690
            $this->CLI_debug('add process ' . $this->CLI_buildProcessId() . ' (' . ($processCount + 1) . '/' . (int) $this->extensionSettings['processLimit'] . ')');
0 ignored issues
show
Deprecated Code introduced by
The function AOE\Crawler\Controller\C...Controller::CLI_debug() has been deprecated. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-deprecated  annotation

1690
            /** @scrutinizer ignore-deprecated */ $this->CLI_debug('add process ' . $this->CLI_buildProcessId() . ' (' . ($processCount + 1) . '/' . (int) $this->extensionSettings['processLimit'] . ')');
Loading history...
1691
1692
            GeneralUtility::makeInstance(ConnectionPool::class)->getConnectionForTable('tx_crawler_process')->insert(
1693
                'tx_crawler_process',
1694
                [
1695
                    'process_id' => $id,
1696
                    'active' => 1,
1697
                    'ttl' => $currentTime + (int) $this->extensionSettings['processMaxRunTime'],
1698
                    'system_process_id' => $systemProcessId,
1699
                ]
1700
            );
1701
        } else {
1702
            $this->CLI_debug('Processlimit reached (' . ($processCount) . '/' . (int) $this->extensionSettings['processLimit'] . ')');
0 ignored issues
show
Deprecated Code introduced by
The function AOE\Crawler\Controller\C...Controller::CLI_debug() has been deprecated. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-deprecated  annotation

1702
            /** @scrutinizer ignore-deprecated */ $this->CLI_debug('Processlimit reached (' . ($processCount) . '/' . (int) $this->extensionSettings['processLimit'] . ')');
Loading history...
1703
            $ret = false;
1704
        }
1705
1706
        $this->processRepository->deleteProcessesMarkedAsDeleted();
1707
        $this->CLI_releaseProcesses($orphanProcesses);
1708
1709
        return $ret;
1710
    }
1711
1712
    /**
1713
     * Release a process and the required resources
1714
     *
1715
     * @param mixed $releaseIds string with a single process-id or array with multiple process-ids
1716
     * @return boolean
1717
     */
1718
    public function CLI_releaseProcesses($releaseIds)
1719
    {
1720
        $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable($this->tableName);
1721
1722
        if (! is_array($releaseIds)) {
1723
            $releaseIds = [$releaseIds];
1724
        }
1725
1726
        if (empty($releaseIds)) {
1727
            //nothing to release
1728
            return false;
1729
        }
1730
1731
        // some kind of 2nd chance algo - this way you need at least 2 processes to have a real cleanup
1732
        // this ensures that a single process can't mess up the entire process table
1733
1734
        // mark all processes as deleted which have no "waiting" queue-entires and which are not active
1735
1736
        $queryBuilder
1737
            ->update($this->tableName, 'q')
1738
            ->where(
1739
                'q.process_id IN(SELECT p.process_id FROM tx_crawler_process as p WHERE p.active = 0)'
1740
            )
1741
            ->set('q.process_scheduled', 0)
1742
            ->set('q.process_id', '')
1743
            ->execute();
1744
1745
        // FIXME: Not entirely sure that this is equivalent to the previous version
1746
        $queryBuilder->resetQueryPart('set');
1747
1748
        $queryBuilder
1749
            ->update('tx_crawler_process')
1750
            ->where(
1751
                $queryBuilder->expr()->eq('active', 0),
1752
                'process_id IN(SELECT q.process_id FROM tx_crawler_queue as q WHERE q.exec_time = 0)'
1753
            )
1754
            ->set('system_process_id', 0)
1755
            ->execute();
1756
1757
        $this->processRepository->markRequestedProcessesAsNotActive($releaseIds);
1758
        $this->queueRepository->unsetProcessScheduledAndProcessIdForQueueEntries($releaseIds);
1759
1760
        return true;
1761
    }
1762
1763
    /**
1764
     * Create a unique Id for the current process
1765
     *
1766
     * @return string the ID
1767
     */
1768 1
    public function CLI_buildProcessId()
1769
    {
1770 1
        if (! $this->processID) {
1771
            $this->processID = GeneralUtility::shortMD5(microtime(true));
1772
        }
1773 1
        return $this->processID;
1774
    }
1775
1776
    /**
1777
     * Prints a message to the stdout (only if debug-mode is enabled)
1778
     *
1779
     * @param string $msg the message
1780
     * @deprecated
1781
     * @codeCoverageIgnore
1782
     */
1783
    public function CLI_debug($msg): void
1784
    {
1785
        if ((int) $this->extensionSettings['processDebug']) {
1786
            echo $msg . "\n";
1787
            flush();
1788
        }
1789
    }
1790
1791
    /**
1792
     * Cleans up entries that stayed for too long in the queue. These are:
1793
     * - processed entries that are over 1.5 days in age
1794
     * - scheduled entries that are over 7 days old
1795
     *
1796
     * @deprecated
1797
     */
1798 1
    public function cleanUpOldQueueEntries(): void
1799
    {
1800
        // 24*60*60 Seconds in 24 hours
1801 1
        $processedAgeInSeconds = $this->extensionSettings['cleanUpProcessedAge'] * 86400;
1802 1
        $scheduledAgeInSeconds = $this->extensionSettings['cleanUpScheduledAge'] * 86400;
1803
1804 1
        $now = time();
1805 1
        $condition = '(exec_time<>0 AND exec_time<' . ($now - $processedAgeInSeconds) . ') OR scheduled<=' . ($now - $scheduledAgeInSeconds);
1806 1
        $this->flushQueue($condition);
0 ignored issues
show
Deprecated Code introduced by
The function AOE\Crawler\Controller\C...ontroller::flushQueue() has been deprecated. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-deprecated  annotation

1806
        /** @scrutinizer ignore-deprecated */ $this->flushQueue($condition);
Loading history...
1807 1
    }
1808
1809
    /**
1810
     * Removes queue entries
1811
     *
1812
     * @param string $where SQL related filter for the entries which should be removed
1813
     *
1814
     * @deprecated
1815
     */
1816 5
    protected function flushQueue($where = ''): void
1817
    {
1818 5
        $realWhere = strlen((string) $where) > 0 ? $where : '1=1';
1819
1820 5
        $queryBuilder = $this->getQueryBuilder($this->tableName);
1821
1822
        $groups = $queryBuilder
1823 5
            ->selectLiteral('DISTINCT set_id')
1824 5
            ->from($this->tableName)
1825 5
            ->where($realWhere)
1826 5
            ->execute()
1827 5
            ->fetchAll();
1828 5
        if (is_array($groups)) {
0 ignored issues
show
introduced by
The condition is_array($groups) is always true.
Loading history...
1829 5
            foreach ($groups as $group) {
1830
                $subSet = $queryBuilder
1831 4
                    ->select('qid', 'set_id')
1832 4
                    ->from($this->tableName)
1833 4
                    ->where(
1834 4
                        $realWhere,
1835 4
                        $queryBuilder->expr()->eq('set_id', $group['set_id'])
1836
                    )
1837 4
                    ->execute()
1838 4
                    ->fetchAll();
1839
1840 4
                $payLoad = ['subSet' => $subSet];
1841 4
                SignalSlotUtility::emitSignal(
1842 4
                    self::class,
1843 4
                    SignalSlotUtility::SIGNAL_QUEUE_ENTRY_FLUSH,
1844 4
                    $payLoad
1845
                );
1846
            }
1847
        }
1848
1849
        $queryBuilder
1850 5
            ->delete($this->tableName)
1851 5
            ->where($realWhere)
1852 5
            ->execute();
1853 5
    }
1854
1855
    /**
1856
     * This method determines duplicates for a queue entry with the same parameters and this timestamp.
1857
     * If the timestamp is in the past, it will check if there is any unprocessed queue entry in the past.
1858
     * If the timestamp is in the future it will check, if the queued entry has exactly the same timestamp
1859
     *
1860
     * @param int $tstamp
1861
     * @param array $fieldArray
1862
     *
1863
     * @return array
1864
     * @deprecated
1865
     */
1866 5
    protected function getDuplicateRowsIfExist($tstamp, $fieldArray)
1867
    {
1868 5
        $rows = [];
1869
1870 5
        $currentTime = $this->getCurrentTime();
1871
1872 5
        $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable($this->tableName);
1873
        $queryBuilder
1874 5
            ->select('qid')
1875 5
            ->from('tx_crawler_queue');
1876
        //if this entry is scheduled with "now"
1877 5
        if ($tstamp <= $currentTime) {
1878 2
            if ($this->extensionSettings['enableTimeslot']) {
1879 1
                $timeBegin = $currentTime - 100;
1880 1
                $timeEnd = $currentTime + 100;
1881
                $queryBuilder
1882 1
                    ->where(
1883 1
                        'scheduled BETWEEN ' . $timeBegin . ' AND ' . $timeEnd . ''
1884
                    )
1885 1
                    ->orWhere(
1886 1
                        $queryBuilder->expr()->lte('scheduled', $currentTime)
1887
                    );
1888
            } else {
1889
                $queryBuilder
1890 1
                    ->where(
1891 2
                        $queryBuilder->expr()->lte('scheduled', $currentTime)
1892
                    );
1893
            }
1894 3
        } elseif ($tstamp > $currentTime) {
1895
            //entry with a timestamp in the future need to have the same schedule time
1896
            $queryBuilder
1897 3
                ->where(
1898 3
                    $queryBuilder->expr()->eq('scheduled', $tstamp)
1899
                );
1900
        }
1901
1902
        $queryBuilder
1903 5
            ->andWhere('NOT exec_time')
1904 5
            ->andWhere('NOT process_id')
1905 5
            ->andWhere($queryBuilder->expr()->eq('page_id', $queryBuilder->createNamedParameter($fieldArray['page_id'], PDO::PARAM_INT)))
1906 5
            ->andWhere($queryBuilder->expr()->eq('parameters_hash', $queryBuilder->createNamedParameter($fieldArray['parameters_hash'], PDO::PARAM_STR)));
1907
1908 5
        $statement = $queryBuilder->execute();
1909
1910 5
        while ($row = $statement->fetch()) {
1911 5
            $rows[] = $row['qid'];
1912
        }
1913
1914 5
        return $rows;
1915
    }
1916
1917
    /**
1918
     * Returns a md5 hash generated from a serialized configuration array.
1919
     *
1920
     * @return string
1921
     */
1922 10
    protected function getConfigurationHash(array $configuration)
1923
    {
1924 10
        unset($configuration['paramExpanded']);
1925 10
        unset($configuration['URLs']);
1926 10
        return md5(serialize($configuration));
1927
    }
1928
1929
    /**
1930
     * Build a URL from a Page and the Query String. If the page has a Site configuration, it can be built by using
1931
     * the Site instance.
1932
     *
1933
     * @param int $httpsOrHttp see tx_crawler_configuration.force_ssl
1934
     * @throws SiteNotFoundException
1935
     * @throws InvalidRouteArgumentsException
1936
     *
1937
     * @deprecated Using CrawlerController::getUrlFromPageAndQueryParameters() is deprecated since 9.1.1 and will be removed in v11.x, please use UrlService->getUrlFromPageAndQueryParameters() instead.
1938
     * @codeCoverageIgnore
1939
     */
1940
    protected function getUrlFromPageAndQueryParameters(int $pageId, string $queryString, ?string $alternativeBaseUrl, int $httpsOrHttp): UriInterface
1941
    {
1942
        $urlService = new UrlService();
1943
        return $urlService->getUrlFromPageAndQueryParameters($pageId, $queryString, $alternativeBaseUrl, $httpsOrHttp);
1944
    }
1945
1946 1
    protected function swapIfFirstIsLargerThanSecond(array $reg): array
1947
    {
1948
        // Swap if first is larger than last:
1949 1
        if ($reg[1] > $reg[2]) {
1950
            $temp = $reg[2];
1951
            $reg[2] = $reg[1];
1952
            $reg[1] = $temp;
1953
        }
1954
1955 1
        return $reg;
1956
    }
1957
1958
    /**
1959
     * @return BackendUserAuthentication
1960
     */
1961 2
    private function getBackendUser()
1962
    {
1963
        // Make sure the _cli_ user is loaded
1964 2
        Bootstrap::initializeBackendAuthentication();
1965 2
        if ($this->backendUser === null) {
1966 2
            $this->backendUser = $GLOBALS['BE_USER'];
1967
        }
1968 2
        return $this->backendUser;
1969
    }
1970
1971
    /**
1972
     * Get querybuilder for given table
1973
     *
1974
     * @return QueryBuilder
1975
     */
1976 12
    private function getQueryBuilder(string $table)
1977
    {
1978 12
        return GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable($table);
1979
    }
1980
}
1981