Fixed VisitsTracker to take into account the X-Forwarded-For header in case the server is behind a load balabncer or proxy

This commit is contained in:
Alejandro Celaya 2016-08-09 09:13:39 +02:00
parent 73a236b3d0
commit 7c5d8cf244
2 changed files with 37 additions and 11 deletions

View file

@ -36,8 +36,6 @@ class VisitsTracker implements VisitsTrackerInterface
*/ */
public function track($shortCode, ServerRequestInterface $request) public function track($shortCode, ServerRequestInterface $request)
{ {
$visitorData = $request->getServerParams();
/** @var ShortUrl $shortUrl */ /** @var ShortUrl $shortUrl */
$shortUrl = $this->em->getRepository(ShortUrl::class)->findOneBy([ $shortUrl = $this->em->getRepository(ShortUrl::class)->findOneBy([
'shortCode' => $shortCode, 'shortCode' => $shortCode,
@ -45,22 +43,27 @@ class VisitsTracker implements VisitsTrackerInterface
$visit = new Visit(); $visit = new Visit();
$visit->setShortUrl($shortUrl) $visit->setShortUrl($shortUrl)
->setUserAgent($this->getArrayValue($visitorData, 'HTTP_USER_AGENT')) ->setUserAgent($request->getHeaderLine('User-Agent'))
->setReferer($this->getArrayValue($visitorData, 'HTTP_REFERER')) ->setReferer($request->getHeaderLine('Referer'))
->setRemoteAddr($this->getArrayValue($visitorData, 'REMOTE_ADDR')); ->setRemoteAddr($this->findOutRemoteAddr($request));
$this->em->persist($visit); $this->em->persist($visit);
$this->em->flush(); $this->em->flush();
} }
/** /**
* @param array $array * @param ServerRequestInterface $request
* @param $key * @return string
* @param null $default
* @return mixed|null
*/ */
protected function getArrayValue(array $array, $key, $default = null) protected function findOutRemoteAddr(ServerRequestInterface $request)
{ {
return isset($array[$key]) ? $array[$key] : $default; $forwardedFor = $request->getHeaderLine('X-Forwarded-For');
if (empty($forwardedFor)) {
$serverParams = $request->getServerParams();
return isset($serverParams['REMOTE_ADDR']) ? $serverParams['REMOTE_ADDR'] : null;
}
$ips = explode(',', $forwardedFor);
return $ips[0];
} }
/** /**

View file

@ -45,6 +45,29 @@ class VisitsTrackerTest extends TestCase
$this->visitsTracker->track($shortCode, ServerRequestFactory::fromGlobals()); $this->visitsTracker->track($shortCode, ServerRequestFactory::fromGlobals());
} }
/**
* @test
*/
public function trackUsesForwardedForHeaderIfPresent()
{
$shortCode = '123ABC';
$test = $this;
$repo = $this->prophesize(EntityRepository::class);
$repo->findOneBy(['shortCode' => $shortCode])->willReturn(new ShortUrl());
$this->em->getRepository(ShortUrl::class)->willReturn($repo->reveal())->shouldBeCalledTimes(1);
$this->em->persist(Argument::any())->will(function ($args) use ($test) {
/** @var Visit $visit */
$visit = $args[0];
$test->assertEquals('4.3.2.1', $visit->getRemoteAddr());
})->shouldBeCalledTimes(1);
$this->em->flush()->shouldBeCalledTimes(1);
$this->visitsTracker->track($shortCode, ServerRequestFactory::fromGlobals(
['REMOTE_ADDR' => '1.2.3.4']
)->withHeader('X-Forwarded-For', '4.3.2.1,99.99.99.99'));
}
/** /**
* @test * @test
*/ */