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
|
<?php
/**
* Matomo - free/libre analytics platform
*
* @link https://matomo.org
* @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*/
declare(strict_types=1);
namespace Piwik\Plugins\BotTracking\tests\Integration\Tracker;
use Piwik\Common;
use Piwik\Db;
use Piwik\Log\NullLogger;
use Piwik\Plugins\BotTracking\Dao\BotRequestsDao;
use Piwik\Plugins\BotTracking\Tracker\BotRequestProcessor;
use Piwik\Tests\Framework\Fixture;
use Piwik\Tests\Framework\TestCase\IntegrationTestCase;
use Piwik\Tracker\Action;
use Piwik\Tracker\Request;
/**
* @group BotTracking
* @group BotRequestProcessor
* @group Plugins
*/
class BotRequestProcessorTest extends IntegrationTestCase
{
/**
* @var BotRequestProcessor
*/
private $requestProcessor;
/**
* @var int
*/
private $idSite;
public function setUp(): void
{
parent::setUp();
$this->idSite = Fixture::createWebsite('2025-01-01 00:00:00');
$this->requestProcessor = new BotRequestProcessor(new BotRequestsDao(), new NullLogger());
}
public function testProcessRequestParamsDetectsBotRequest(): void
{
$request = $this->makeRequest([
'idsite' => $this->idSite,
'url' => 'https://example.com/test',
'ua' => 'ChatGPT-User/1.0',
]);
$result = $this->requestProcessor->handleRequest($request);
self::assertTrue($result);
}
public function testProcessRequestParamsDoesNotDetectNonBotRequest(): void
{
$request = $this->makeRequest([
'idsite' => $this->idSite,
'url' => 'https://example.com/test',
'ua' => 'Mozilla/5.0 (Windows NT 10.0; Win64; x64)',
]);
$result = $this->requestProcessor->handleRequest($request);
self::assertFalse($result);
$tableName = BotRequestsDao::getPrefixedTableName();
$sql = "SELECT COUNT(*) as count FROM `{$tableName}` WHERE idsite = ?";
$count = Db::fetchOne($sql, [$this->idSite]);
self::assertEquals(0, $count);
}
public function testRecordLogsHandlesOptionalParameters(): void
{
$request = $this->makeRequest([
'idsite' => $this->idSite,
'url' => 'https://example.com/test',
'ua' => 'Perplexity-User/1.0',
// No optional parameters
]);
$this->requestProcessor->handleRequest($request);
// Verify data was stored with NULL optional fields
$tableName = BotRequestsDao::getPrefixedTableName();
$sql = "SELECT * FROM `{$tableName}` WHERE idsite = ?";
$records = Db::fetchAll($sql, [$this->idSite]);
$this->assertCount(1, $records);
$record = $records[0];
self::assertNull($record['http_status_code']);
self::assertNull($record['response_size_bytes']);
self::assertNull($record['response_time_ms']);
self::assertNull($record['source']);
}
public function testRecordLogsHandlesDownloadParameter(): void
{
$request = $this->makeRequest([
'idsite' => $this->idSite,
'url' => 'https://example.com/page',
'download' => 'https://example.com/document.pdf',
'ua' => 'Claude-User/2.0',
]);
$this->requestProcessor->handleRequest($request);
$tableName = BotRequestsDao::getPrefixedTableName();
$sql = "SELECT * FROM `{$tableName}` WHERE idsite = ?";
$records = Db::fetchAll($sql, [$this->idSite]);
self::assertCount(1, $records);
self::assertNotNull($records[0]['idaction_url']);
$tableName = Common::prefixTable('log_action');
$action = Db::fetchAll("SELECT * FROM `{$tableName}` WHERE idaction = ?", [$records[0]['idaction_url']]);
self::assertCount(1, $action);
self::assertEquals('example.com/document.pdf', $action[0]['name']);
self::assertEquals(Action::TYPE_DOWNLOAD, $action[0]['type']);
}
/**
* @dataProvider getBotUserAgents
*/
public function testMultipleBotTypesAreDetected(string $userAgent, string $expectedBotName): void
{
$request = $this->makeRequest([
'idsite' => $this->idSite,
'url' => 'https://example.com/test',
'ua' => $userAgent,
]);
$this->requestProcessor->handleRequest($request);
$tableName = BotRequestsDao::getPrefixedTableName();
$sql = "SELECT bot_name FROM `{$tableName}` WHERE idsite = ? ORDER BY idrequest DESC LIMIT 1";
$botName = Db::fetchOne($sql, [$this->idSite]);
self::assertEquals($expectedBotName, $botName);
}
/**
* @return array<array{0: string, 1: string}>
*/
public function getBotUserAgents(): array
{
return [
['ChatGPT-User/1.0', 'ChatGPT-User'],
['MistralAI-User/2.0', 'MistralAI-User'],
['Gemini-Deep-Research/1.0', 'Gemini-Deep-Research'],
['Claude-User/3.0', 'Claude-User'],
['Perplexity-User/1.0', 'Perplexity-User'],
['Google-NotebookLM/1.0', 'Google-NotebookLM'],
];
}
private function makeRequest(array $params): Request
{
$params = array_merge([
'rec' => 1,
], $params);
return new Request($params);
}
}
|
