Skip to content

Fix bugs and harden tests (patch-safe) #595

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JayBizzle merged 3 commits into from
Apr 14, 2026
Merged

Fix bugs and harden tests (patch-safe) #595

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f97c710
Improve code quality: fix bugs, add type safety, and harden tests
JayBizzle Mar 24, 2026
9774604
Revert BC-breaking type hints and visibility change
JayBizzle Apr 14, 2026
3dfd142
Add test for preg_match error branch in isCrawler()
JayBizzle Apr 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 23 additions & 6 deletions src/CrawlerDetect.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ public function compileRegex($patterns)
*
* @param array|null $httpHeaders
*/
public function setHttpHeaders($httpHeaders)
public function setHttpHeaders($httpHeaders = null)
{
// Use global _SERVER if $httpHeaders aren't defined.
if (! is_array($httpHeaders) || ! count($httpHeaders)) {
Expand Down Expand Up @@ -139,14 +139,21 @@ public function getUaHttpHeaders()
*
* @param string|null $userAgent
*/
public function setUserAgent($userAgent)
public function setUserAgent($userAgent = null)
{
if (is_null($userAgent)) {
$userAgent = '';

foreach ($this->getUaHttpHeaders() as $altHeader) {
if (isset($this->httpHeaders[$altHeader])) {
$userAgent .= $this->httpHeaders[$altHeader].' ';
}
}

// If no headers were found, keep it as null.
if ($userAgent === '') {
$userAgent = null;
}
}

return $this->userAgent = $userAgent;
Expand All @@ -160,19 +167,29 @@ public function setUserAgent($userAgent)
*/
public function isCrawler($userAgent = null)
{
$agent = trim(preg_replace(
$this->matches = [];

$agent = preg_replace(
"/{$this->compiledExclusions}/i",
'',
$userAgent ?: $this->userAgent ?: ''
));
);

if ($agent === null || trim($agent) === '') {
return false;
}

$agent = trim($agent);

$result = preg_match("/{$this->compiledRegex}/i", $agent, $this->matches);

if ($agent === '') {
if ($result === false) {
$this->matches = [];

return false;
}

return (bool) preg_match("/{$this->compiledRegex}/i", $agent, $this->matches);
return (bool) $result;
}

/**
Expand Down
2 changes: 1 addition & 1 deletion src/Fixtures/Exclusions.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ class Exclusions extends AbstractProvider
'Firefox.[\d\.]*',
' Chrome.[\d\.]*',
'Chromium.[\d\.]*',
'MSIE.[\d\.]',
'MSIE.[\d\.]*',
'Opera\/[\d\.]*',
'Mozilla.[\d\.]*',
'AppleWebKit.[\d\.]*',
Expand Down
131 changes: 85 additions & 46 deletions tests/UserAgentTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,101 +15,98 @@

final class UserAgentTest extends TestCase
{
public $CrawlerDetect;
protected $crawlerDetect;

protected function setUp(): void
{
$this->crawlerDetect = new CrawlerDetect;
}

/** @test */
public function user_agents_are_bots()
{
$this->CrawlerDetect = new CrawlerDetect;
$lines = file(__DIR__.'/data/user_agent/crawlers.txt', FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);

foreach ($lines as $line) {
$test = $this->CrawlerDetect->isCrawler($line);
$test = $this->crawlerDetect->isCrawler($line);
$this->assertTrue($test, $line);
}
}

/** @test */
public function user_agents_are_devices()
{
$this->CrawlerDetect = new CrawlerDetect;
$lines = file(__DIR__.'/data/user_agent/devices.txt', FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);

foreach ($lines as $line) {
$test = $this->CrawlerDetect->isCrawler($line);
$test = $this->crawlerDetect->isCrawler($line);
$this->assertFalse($test, $line);
}
}

/** @test */
public function sec_ch_ua_are_bots()
{
$this->CrawlerDetect = new CrawlerDetect;
$lines = file(__DIR__.'/data/sec_ch_ua/crawlers.txt', FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);

foreach ($lines as $line) {
$test = $this->CrawlerDetect->isCrawler($line);
$test = $this->crawlerDetect->isCrawler($line);
$this->assertTrue($test, $line);
}
}

/** @test */
public function sec_ch_ua_are_devices()
{
$this->CrawlerDetect = new CrawlerDetect;
$lines = file(__DIR__.'/data/sec_ch_ua/devices.txt', FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);

foreach ($lines as $line) {
$test = $this->CrawlerDetect->isCrawler($line);
$test = $this->crawlerDetect->isCrawler($line);
$this->assertFalse($test, $line);
}
}

/** @test */
public function it_returns_correct_matched_bot_name()
{
$this->CrawlerDetect = new CrawlerDetect;
$this->CrawlerDetect->isCrawler('Mozilla/5.0 (iPhone; CPU iPhone OS 7_1 like Mac OS X) AppleWebKit (KHTML, like Gecko) Mobile (compatible; Yahoo Ad monitoring; https://help.yahoo.com/kb/yahoo-ad-monitoring-SLN24857.html)');
$this->crawlerDetect->isCrawler('Mozilla/5.0 (iPhone; CPU iPhone OS 7_1 like Mac OS X) AppleWebKit (KHTML, like Gecko) Mobile (compatible; Yahoo Ad monitoring; https://help.yahoo.com/kb/yahoo-ad-monitoring-SLN24857.html)');

$matches = $this->CrawlerDetect->getMatches();
$matches = $this->crawlerDetect->getMatches();

$this->assertEquals($this->CrawlerDetect->getMatches(), 'monitoring', $matches);
$this->assertEquals($this->crawlerDetect->getMatches(), 'monitoring', $matches);
}

/** @test */
public function it_returns_user_agent()
{
$ua = 'Mozilla/5.0 (iPhone; CPU iPhone OS 7_1 like Mac OS X) AppleWebKit (KHTML, like Gecko) Mobile (compatible; Yahoo Ad monitoring; https://help.yahoo.com/kb/yahoo-ad-monitoring-SLN24857.html)';
$this->CrawlerDetect = new CrawlerDetect(null, $ua);
$cd = new CrawlerDetect(null, $ua);

$this->assertEquals($this->CrawlerDetect->getUserAgent(), $ua);
$this->assertEquals($cd->getUserAgent(), $ua);
}

/** @test */
public function it_returns_full_matched_bot_name()
{
$this->CrawlerDetect = new CrawlerDetect;
$this->CrawlerDetect->isCrawler('somenaughtybot');
$this->crawlerDetect->isCrawler('somenaughtybot');

$matches = $this->CrawlerDetect->getMatches();
$matches = $this->crawlerDetect->getMatches();

$this->assertEquals($this->CrawlerDetect->getMatches(), 'somenaughtybot', $matches);
$this->assertEquals($this->crawlerDetect->getMatches(), 'somenaughtybot', $matches);
}

/** @test */
public function it_returns_null_when_no_bot_detected()
{
$this->CrawlerDetect = new CrawlerDetect;
$this->CrawlerDetect->isCrawler('nothing to see here');
$this->crawlerDetect->isCrawler('nothing to see here');

$this->assertNull($this->CrawlerDetect->getMatches());
$this->assertNull($this->crawlerDetect->getMatches());
}

/** @test */
public function empty_user_agent()
{
$this->CrawlerDetect = new CrawlerDetect;
$test = $this->CrawlerDetect->isCrawler(' ');
$test = $this->crawlerDetect->isCrawler(' ');

$this->assertFalse($test);
}
Expand All @@ -125,7 +122,7 @@ public function current_visitor()
}

/** @test */
public function user_agent_passed_via_contructor()
public function user_agent_passed_via_constructor()
{
$cd = new CrawlerDetect(null, 'Mozilla/5.0 (iPhone; CPU iPhone OS 7_1 like Mac OS X) AppleWebKit (KHTML, like Gecko) Mobile (compatible; Yahoo Ad monitoring; https://help.yahoo.com/kb/yahoo-ad-monitoring-SLN24857.html)');

Expand All @@ -143,26 +140,25 @@ public function http_from_header()
}

/** @test */
public function matches_does_not_persit_across_multiple_calls()
public function matches_does_not_persist_across_multiple_calls()
{
$this->CrawlerDetect = new CrawlerDetect;
$this->CrawlerDetect->isCrawler('Mozilla/5.0 (iPhone; CPU iPhone OS 7_1 like Mac OS X) AppleWebKit (KHTML, like Gecko) Mobile (compatible; Yahoo Ad monitoring; https://help.yahoo.com/kb/yahoo-ad-monitoring-SLN24857.html)');
$matches = $this->CrawlerDetect->getMatches();
$this->assertEquals($this->CrawlerDetect->getMatches(), 'monitoring', $matches);
$this->crawlerDetect->isCrawler('Mozilla/5.0 (iPhone; CPU iPhone OS 7_1 like Mac OS X) AppleWebKit (KHTML, like Gecko) Mobile (compatible; Yahoo Ad monitoring; https://help.yahoo.com/kb/yahoo-ad-monitoring-SLN24857.html)');
$matches = $this->crawlerDetect->getMatches();
$this->assertEquals($this->crawlerDetect->getMatches(), 'monitoring', $matches);

$this->CrawlerDetect->isCrawler('This should not match');
$matches = $this->CrawlerDetect->getMatches();
$this->assertNull($this->CrawlerDetect->getMatches());
$this->crawlerDetect->isCrawler('This should not match');
$matches = $this->crawlerDetect->getMatches();
$this->assertNull($this->crawlerDetect->getMatches());

// Empty
$this->CrawlerDetect->isCrawler('Mozilla/5.0 (iPhone; CPU iPhone OS 7_1 like Mac OS X) AppleWebKit (KHTML, like Gecko) Mobile (compatible; Yahoo Ad monitoring; https://help.yahoo.com/kb/yahoo-ad-monitoring-SLN24857.html)');
$this->CrawlerDetect->isCrawler('');
$this->assertNull($this->CrawlerDetect->getMatches());
$this->crawlerDetect->isCrawler('Mozilla/5.0 (iPhone; CPU iPhone OS 7_1 like Mac OS X) AppleWebKit (KHTML, like Gecko) Mobile (compatible; Yahoo Ad monitoring; https://help.yahoo.com/kb/yahoo-ad-monitoring-SLN24857.html)');
$this->crawlerDetect->isCrawler('');
$this->assertNull($this->crawlerDetect->getMatches());

// Excluded
$this->CrawlerDetect->isCrawler('Mozilla/5.0 (iPhone; CPU iPhone OS 7_1 like Mac OS X) AppleWebKit (KHTML, like Gecko) Mobile (compatible; Yahoo Ad monitoring; https://help.yahoo.com/kb/yahoo-ad-monitoring-SLN24857.html)');
$this->CrawlerDetect->isCrawler('iPod');
$this->assertNull($this->CrawlerDetect->getMatches());
$this->crawlerDetect->isCrawler('Mozilla/5.0 (iPhone; CPU iPhone OS 7_1 like Mac OS X) AppleWebKit (KHTML, like Gecko) Mobile (compatible; Yahoo Ad monitoring; https://help.yahoo.com/kb/yahoo-ad-monitoring-SLN24857.html)');
$this->crawlerDetect->isCrawler('iPod');
$this->assertNull($this->crawlerDetect->getMatches());
}

/** @test */
Expand All @@ -177,16 +173,59 @@ public function the_regex_patterns_are_unique()
public function there_are_no_regex_collisions()
{
$crawlers = new Crawlers;
$all = $crawlers->getAll();

foreach ($crawlers->getAll() as $key1 => $regex) {
foreach ($crawlers->getAll() as $key2 => $compare) {
// Dont check this regex against itself
if ($key1 != $key2) {
preg_match('/'.$regex.'/i', stripslashes($compare), $matches);

$this->assertEmpty($matches, $regex.' collided with '.$compare);
foreach ($all as $key1 => $regex) {
foreach ($all as $key2 => $compare) {
// Only check each pair once, and skip self-comparison
if ($key1 >= $key2) {
continue;
}

preg_match('/'.$regex.'/i', stripslashes($compare), $matches);
$this->assertEmpty($matches, $regex.' collided with '.$compare);

preg_match('/'.$compare.'/i', stripslashes($regex), $matches);
$this->assertEmpty($matches, $compare.' collided with '.$regex);
}
}
}

/** @test */
public function is_crawler_with_explicit_agent_does_not_change_stored_agent()
{
$ua = 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36';
$cd = new CrawlerDetect(null, $ua);

$cd->isCrawler('Googlebot/2.1');

$this->assertEquals($ua, $cd->getUserAgent());
}

/** @test */
public function is_crawler_returns_false_when_preg_match_errors()
{
$originalLimit = ini_get('pcre.backtrack_limit');
ini_set('pcre.backtrack_limit', '1');

try {
$result = @$this->crawlerDetect->isCrawler('Mozilla/5.0 (compatible; Googlebot/2.1; +http://www.google.com/bot.html)');

$this->assertFalse($result);
$this->assertNull($this->crawlerDetect->getMatches());
} finally {
ini_set('pcre.backtrack_limit', $originalLimit);
}
}

/** @test */
public function all_regex_patterns_are_valid()
{
$crawlers = new Crawlers;

foreach ($crawlers->getAll() as $pattern) {
$result = @preg_match('/'.$pattern.'/i', '');
$this->assertNotFalse($result, 'Invalid regex pattern: '.$pattern);
}
}
}
Loading