Joomla\StatsServer\Controllers\DisplayControllerGet

Complexity

Total Complexity

7

Size/Duplication

Total Lines	98
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	7

Test Coverage

Coverage

96.3%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
B	execute()	0	48	5
A	cacheData()	0	7	1

<?php
/**
 * Joomla! Statistics Server
 *
 * @copyright  Copyright (C) 2013 - 2017 Open Source Matters, Inc. All rights reserved.
 * @license    http://www.gnu.org/licenses/gpl-2.0.txt GNU General Public License Version 2 or Later
 */

namespace Joomla\StatsServer\Controllers;

use Joomla\Controller\AbstractController;
use Joomla\Cache\Item\Item;
use Joomla\StatsServer\Views\Stats\StatsJsonView;
use Psr\Cache\CacheItemPoolInterface;

/**
 * Controller for displaying submitted statistics data.
 *
 * @method         \Joomla\StatsServer\WebApplication  getApplication()  Get the application object.
 * @property-read  \Joomla\StatsServer\WebApplication  $app              Application object
 */
class DisplayControllerGet extends AbstractController
{
	/**
	 * The cache item pool.
	 *
	 * @var  CacheItemPoolInterface
	 */
	private $cache;

	/**
	 * JSON view for displaying the statistics.
	 *
	 * @var  StatsJsonView
	 */
	private $view;

	/**
	 * Constructor.
	 *
	 * @param   StatsJsonView           $view   JSON view for displaying the statistics.
	 * @param   CacheItemPoolInterface  $cache  The cache item pool.
	 */
	public function __construct(StatsJsonView $view, CacheItemPoolInterface $cache)
	{
		$this->cache = $cache;
		$this->view  = $view;
	}

	/**
	 * Execute the controller.
	 *
	 * @return  boolean
	 */
	public function execute()
	{
		// Check if we are allowed to receive the raw data
		$authorizedRaw = $this->getInput()->server->getString('HTTP_JOOMLA_RAW', 'fail') === $this->getApplication()->get('stats.rawdata', false);

		// Check if a single data source is requested
		$source = $this->getInput()->getString('source', '');

		$this->view->isAuthorizedRaw($authorizedRaw);
		$this->view->setSource($source);

		// Serve cached data if the cache layer is enabled and the raw data source is not requested
		if ($this->getApplication()->get('cache.enabled', false) && !$authorizedRaw)
		{
			$key = md5(get_class($this->view) . __METHOD__ . $source);

			if ($this->cache->hasItem($key))
			{
				$item = $this->cache->getItem($key);

				// Make sure we got a hit on the item, otherwise we'll have to re-cache
				if ($item->isHit())
				{
					$body = $item->get();
				}
				else
				{
					$body = $this->view->render();

					$this->cacheData($key, $body);
				}
			}
			else
			{
				$body = $this->view->render();

				$this->cacheData($key, $body);
			}
		}
		else
		{
			$body = $this->view->render();
		}

		$this->getApplication()->setBody($body);

		return true;
	}

	/**
	 * Store the given data to the cache pool.
	 *
	 * @param   string  $key   The key for the cache item.
	 * @param   mixed   $data  The data to be stored to cache.
	 *
	 * @return  void
	 */
	private function cacheData(string $key, $data)
	{
		$item = (new Item($key, $this->getApplication()->get('cache.lifetime', 900)))
			->set($data);

		$this->cache->save($item);
	}
}