-
-
Notifications
You must be signed in to change notification settings - Fork 159
/
Factory.php
222 lines (182 loc) · 6.69 KB
/
Factory.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
<?php
declare(strict_types=1);
/*
* This file is part of Contao.
*
* (c) Leo Feyer
*
* @license LGPL-3.0-or-later
*/
namespace Contao\CoreBundle\Crawl\Escargot;
use Contao\CoreBundle\Crawl\Escargot\Subscriber\EscargotSubscriberInterface;
use Contao\CoreBundle\Framework\ContaoFramework;
use Contao\PageModel;
use Doctrine\DBAL\Connection;
use Nyholm\Psr7\Uri;
use Ramsey\Uuid\Uuid;
use Symfony\Component\HttpClient\HttpClient;
use Symfony\Contracts\HttpClient\HttpClientInterface;
use Terminal42\Escargot\BaseUriCollection;
use Terminal42\Escargot\Escargot;
use Terminal42\Escargot\Exception\InvalidJobIdException;
use Terminal42\Escargot\Queue\DoctrineQueue;
use Terminal42\Escargot\Queue\InMemoryQueue;
use Terminal42\Escargot\Queue\LazyQueue;
use Terminal42\Escargot\Queue\QueueInterface;
use Terminal42\Escargot\Subscriber\HtmlCrawlerSubscriber;
use Terminal42\Escargot\Subscriber\RobotsSubscriber;
class Factory
{
public const USER_AGENT = 'contao/crawler';
private Connection $connection;
private ContaoFramework $framework;
private array $defaultHttpClientOptions;
/**
* @var array<string>
*/
private array $additionalUris;
/**
* @var array<EscargotSubscriberInterface>
*/
private array $subscribers = [];
public function __construct(Connection $connection, ContaoFramework $framework, array $additionalUris = [], array $defaultHttpClientOptions = [])
{
$this->connection = $connection;
$this->framework = $framework;
$this->additionalUris = $additionalUris;
$this->defaultHttpClientOptions = $defaultHttpClientOptions;
}
public function addSubscriber(EscargotSubscriberInterface $subscriber): self
{
$this->subscribers[] = $subscriber;
return $this;
}
/**
* @return array<EscargotSubscriberInterface>
*/
public function getSubscribers(array $selectedSubscribers = []): array
{
if (0 === \count($selectedSubscribers)) {
return $this->subscribers;
}
return array_filter(
$this->subscribers,
static fn (EscargotSubscriberInterface $subscriber): bool => \in_array($subscriber->getName(), $selectedSubscribers, true)
);
}
/**
* @return array<string>
*/
public function getSubscriberNames(): array
{
return array_map(
static fn (EscargotSubscriberInterface $subscriber): string => $subscriber->getName(),
$this->subscribers
);
}
public function createLazyQueue(): LazyQueue
{
return new LazyQueue(
new InMemoryQueue(),
new DoctrineQueue($this->connection, static fn (): string => Uuid::uuid4()->toString(), 'tl_crawl_queue')
);
}
public function getDefaultHttpClientOptions(): array
{
return $this->defaultHttpClientOptions;
}
public function getCrawlUriCollection(): BaseUriCollection
{
return $this->getRootPageUriCollection()->mergeWith($this->getAdditionalCrawlUriCollection());
}
public function getAdditionalCrawlUriCollection(): BaseUriCollection
{
$collection = new BaseUriCollection();
foreach ($this->additionalUris as $additionalUri) {
$collection->add(new Uri($additionalUri));
}
return $collection;
}
public function getRootPageUriCollection(): BaseUriCollection
{
$this->framework->initialize();
$collection = new BaseUriCollection();
/** @var PageModel $pageModel */
$pageModel = $this->framework->getAdapter(PageModel::class);
$rootPages = $pageModel->findPublishedRootPages();
if (null === $rootPages) {
return $collection;
}
foreach ($rootPages as $rootPage) {
$collection->add(new Uri($rootPage->getAbsoluteUrl()));
}
return $collection;
}
/**
* @throws \InvalidArgumentException
*/
public function create(BaseUriCollection $baseUris, QueueInterface $queue, array $selectedSubscribers, array $clientOptions = []): Escargot
{
$escargot = Escargot::create($baseUris, $queue)->withHttpClient($this->createHttpClient($clientOptions));
$this->registerDefaultSubscribers($escargot);
$this->registerSubscribers($escargot, $this->validateSubscribers($selectedSubscribers));
return $escargot;
}
/**
* @throws \InvalidArgumentException
* @throws InvalidJobIdException
*/
public function createFromJobId(string $jobId, QueueInterface $queue, array $selectedSubscribers, array $clientOptions = []): Escargot
{
$escargot = Escargot::createFromJobId($jobId, $queue)->withHttpClient($this->createHttpClient($clientOptions));
$this->registerDefaultSubscribers($escargot);
$this->registerSubscribers($escargot, $this->validateSubscribers($selectedSubscribers));
return $escargot;
}
private function createHttpClient(array $options = []): HttpClientInterface
{
return HttpClient::create(
array_merge_recursive(
[
'headers' => [
'accept' => 'text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8',
'user-agent' => self::USER_AGENT,
],
'max_duration' => 10, // Ignore requests that take longer than 10 seconds
],
array_merge_recursive($this->getDefaultHttpClientOptions(), $options)
)
);
}
private function registerDefaultSubscribers(Escargot $escargot): void
{
$escargot->addSubscriber(new RobotsSubscriber());
$escargot->addSubscriber(new HtmlCrawlerSubscriber());
}
private function registerSubscribers(Escargot $escargot, array $selectedSubscribers): void
{
foreach ($this->subscribers as $subscriber) {
if (\in_array($subscriber->getName(), $selectedSubscribers, true)) {
$escargot->addSubscriber($subscriber);
}
}
}
/**
* @throws \InvalidArgumentException
*/
private function validateSubscribers(array $selectedSubscribers): array
{
$msg = sprintf(
'You have to specify at least one valid subscriber name. Valid subscribers are: %s',
implode(', ', $this->getSubscriberNames())
);
if (0 === \count($selectedSubscribers)) {
throw new \InvalidArgumentException($msg);
}
$selectedSubscribers = array_intersect($this->getSubscriberNames(), $selectedSubscribers);
if (0 === \count($selectedSubscribers)) {
throw new \InvalidArgumentException($msg);
}
return $selectedSubscribers;
}
}