Skip to content
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

Jump to bottom

remove extra two parameters in VisitExcluded constructor to prevent confusion #10593

Merged
merged 1 commit into from Sep 28, 2016
Merged

remove extra two parameters in VisitExcluded constructor to prevent confusion #10593

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
17 changes: 4 additions & 13 deletions core/Tracker/VisitExcluded.php
View file
Open in desktop
Expand Up @@ -28,25 +28,16 @@ class VisitExcluded

/**
* @param Request $request
* @param bool|string $ip
* @param bool|string $userAgent
*/
public function __construct(Request $request, $ip = false, $userAgent = false)
public function __construct(Request $request)
{
$this->spamFilter = new ReferrerSpamFilter();

if (false === $ip) {
$ip = $request->getIp();
}

if (false === $userAgent) {
$userAgent = $request->getUserAgent();
}

$this->request = $request;
$this->idSite = $request->getIdSite();
$this->userAgent = $userAgent;
$this->ip = $ip;
$userAgent = $request->getUserAgent();
$this->userAgent = Common::unsanitizeInputValue($userAgent);
$this->ip = $request->getIp();
}

/**
Expand Down
3 changes: 1 addition & 2 deletions plugins/CoreHome/Tracker/VisitRequestProcessor.php
View file
Open in desktop
Expand Up @@ -87,8 +87,7 @@ public function processRequestParams(VisitProperties $visitProperties, Request $
// the IP is needed by isExcluded() and GoalManager->recordGoals()
$visitProperties->setProperty('location_ip', $request->getIp());

// TODO: move VisitExcluded logic to here (or move to service class stored in DI)
$excluded = new VisitExcluded($request, $visitProperties->getProperty('location_ip'));
$excluded = new VisitExcluded($request);
if ($excluded->isExcluded()) {
return true;
}
Expand Down
10 changes: 10 additions & 0 deletions tests/PHPUnit/Framework/Mock/Tracker/RequestAuthenticated.php
View file
Open in desktop
@@ -0,0 +1,10 @@
<?php
namespace Piwik\Tests\Framework\Mock\Tracker;

use Piwik\Tracker\Request;

class RequestAuthenticated extends Request
{
protected $isAuthenticated = true;

}
24 changes: 13 additions & 11 deletions tests/PHPUnit/Integration/Tracker/VisitTest.php
View file
Open in desktop
Expand Up @@ -16,6 +16,7 @@
use Piwik\Plugins\SitesManager\API;
use Piwik\Tests\Framework\Fixture;
use Piwik\Tests\Framework\Mock\FakeAccess;
use Piwik\Tests\Framework\Mock\Tracker\RequestAuthenticated;
use Piwik\Tracker\Request;
use Piwik\Tracker\Visit;
use Piwik\Tracker\VisitExcluded;
Expand Down Expand Up @@ -88,14 +89,14 @@ public function testIsVisitorIpExcluded($excludedIp, $tests)
$idsite = API::getInstance()->addSite("name", "http://piwik.net/", $ecommerce = 0,
$siteSearch = 1, $searchKeywordParameters = null, $searchCategoryParameters = null, $excludedIp);

$request = new Request(array('idsite' => $idsite));
$request = new RequestAuthenticated(array('idsite' => $idsite));

// test that IPs within the range, or the given IP, are excluded
foreach ($tests as $ip => $expected) {
$testIpIsExcluded = IPUtils::stringToBinaryIP($ip);
$request->setParam('cip', $ip);

$excluded = new VisitExcluded_public($request, $testIpIsExcluded);
$this->assertSame($expected, $excluded->public_isVisitorIpExcluded($testIpIsExcluded));
$excluded = new VisitExcluded_public($request);
$this->assertSame($expected, $excluded->public_isVisitorIpExcluded($ip));
}
}

Expand Down Expand Up @@ -176,13 +177,12 @@ public function testVisitShouldNotBeExcluded_IfMadeViaChromeDataSaverCompression
$idsite = API::getInstance()->addSite("name", "http://piwik.net/", $ecommerce = 0,
$siteSearch = 1, $searchKeywordParameters = null, $searchCategoryParameters = null);

$request = new Request(array('idsite' => $idsite));

$testIpIsExcluded = IPUtils::stringToBinaryIP($ip);
$request = new RequestAuthenticated(array('idsite' => $idsite, 'cip' => $ip));

$_SERVER['HTTP_VIA'] = '1.1 Chrome-Compression-Proxy';
$excluded = new VisitExcluded_public($request, $testIpIsExcluded);
$isBot = $excluded->public_isNonHumanBot($testIpIsExcluded);
$excluded = new VisitExcluded_public($request);
$isBot = $excluded->public_isNonHumanBot();
unset($_SERVER['HTTP_VIA']);
$this->assertSame($isNonHumanBot, $isBot);
}
Expand Down Expand Up @@ -239,7 +239,8 @@ public function testIsVisitorUserAgentExcluded($excludedUserAgent, $tests)

// test that user agents that contain excluded user agent strings are excluded
foreach ($tests as $ua => $expected) {
$excluded = new VisitExcluded_public($request, $ip = false, $ua);
$request->setParam('ua', $ua);
$excluded = new VisitExcluded_public($request);

$this->assertSame($expected, $excluded->public_isUserAgentExcluded(), "Result if isUserAgentExcluded('$ua') was not " . ($expected ? 'true' : 'false') . ".");
}
Expand Down Expand Up @@ -306,10 +307,11 @@ public function testIsVisitor_ipIsKnownBot()
);

$idsite = API::getInstance()->addSite("name", "http://piwik.net/");
$request = new Request(array('idsite' => $idsite, 'bots' => 0));
$request = new RequestAuthenticated(array('idsite' => $idsite, 'bots' => 0));

foreach ($isIpBot as $ip => $isBot) {
$excluded = new VisitExcluded_public($request, IPUtils::stringToBinaryIP($ip));
$request->setParam('cip', $ip);
$excluded = new VisitExcluded_public($request);

$this->assertSame($isBot, $excluded->public_isNonHumanBot(), $ip);
}
Expand Down