Controller.php

<?php

/**
 * ClickHeat - Clicks' heatmap
 *
 * @link http://www.dugwood.com/clickheat/index.html
 * @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
 * @version $Id$
 *
 * @package Piwik\Plugins\ClickHeat
 */

namespace Piwik\Plugins\ClickHeat;

use Piwik\Container\StaticContainer;
use Piwik\Cookie;
use Piwik\IP;
use Piwik\Network\IPUtils;
use Piwik\NoAccessException;
use Piwik\Plugins\ClickHeat\Adapter\HeatMapAdapterFactory;
use Piwik\Plugins\ClickHeat\Logger\AbstractLogger;
use Piwik\Plugins\ClickHeat\Utils\AbstractHeatmap;
use Piwik\Plugins\ClickHeat\Utils\CacheStorage;
use Piwik\Plugins\ClickHeat\Utils\DrawingTarget;
use Piwik\Plugins\ClickHeat\Utils\Helper;
use Piwik\Plugins\SitesManager\API;
use Piwik\Site;
use Piwik\Translate;
use Piwik\Piwik;
use Piwik\Common;

class Controller extends \Piwik\Plugin\Controller
{
    static $conf = [];

    /**
     * @var AbstractLogger
     */
    protected $logger;

    public function init()
    {
        Config::init();
        if (isset($_SERVER['REQUEST_URI']) && $_SERVER['REQUEST_URI'] !== '') {
            $realPath = &$_SERVER['REQUEST_URI'];
        } elseif (isset($_SERVER['SCRIPT_NAME']) && $_SERVER['SCRIPT_NAME'] !== '') {
            $realPath = &$_SERVER['SCRIPT_NAME'];
        } else {
            exit(LANG_UNKNOWN_DIR);
        }
        /** First of all, check if we are inside Piwik */
        $dirName = dirname($realPath);
        if ($dirName === '/') {
            $dirName = '';
        }
        if (!defined('CLICKHEAT_PATH')) {
            define('CLICKHEAT_PATH', $dirName . '/plugins/ClickHeat/libs/');
        }
        if (!defined('CLICKHEAT_INDEX_PATH')) {
            define('CLICKHEAT_INDEX_PATH', 'index.php?module=ClickHeat&');
        }
        if (!defined('CLICKHEAT_ROOT')) {
            define('CLICKHEAT_ROOT', PIWIK_INCLUDE_PATH . '/plugins/ClickHeat/libs/');
        }
        if (!defined('CLICKHEAT_CONFIG')) {
            define('CLICKHEAT_CONFIG', PIWIK_INCLUDE_PATH . '/plugins/ClickHeat/config.php');
        }
        if (!defined('IS_PIWIK_MODULE')) {
            define('IS_PIWIK_MODULE', true);
        }
        if (!defined('CLICKHEAT_LANGUAGE')) {
            define('CLICKHEAT_LANGUAGE', Translate::getLanguageToLoad());
        }
        if (!defined('CLICKHEAT_ADMIN')) {
            if (Piwik::hasUserSuperUserAccess()) {
                define('CLICKHEAT_ADMIN', true);
            } else {
                define('CLICKHEAT_ADMIN', false);
            }
        }
        // Manually load the class since Click Heat is not available in Composer
        require_once(CLICKHEAT_ROOT . "classes/Heatmap.class.php");

        if (!$this->logger) {
            $logger = Config::get('logger');
            $this->logger = new $logger(Config::all());
        }
    }

    public function getGroupUrl()
    {
        // if you are not valid user, force login.
        Piwik::checkUserIsNotAnonymous();
        $group = str_replace('/', '', Common::getRequestVar('group'));
        $adapter = StaticContainer::get(Config::get('adapter'));

        return $adapter->getGroupUrl($group);
    }

    public function javascript()
    {
        // TODO: should return from a twig view
        // if you are not valid user, force login.
        Piwik::checkUserIsNotAnonymous();
        foreach (['', '_GROUP', '_GROUP0', '_GROUP1', '_GROUP2', '_GROUP3', '_DEBUG', '_QUOTA', '_IMAGE', '_SHORT', '_PASTE'] as $value) {
            define("LANG_JAVASCRIPT$value", Piwik::Translate("ClickHeat_LANG_JAVASCRIPT$value"));
        }
        require_once(CLICKHEAT_ROOT . 'javascript.php');
    }

    public function layout()
    {
        // TODO: should return from a twig view
        // if you are not valid user, force login.
        Piwik::checkUserIsNotAnonymous();
        include(CLICKHEAT_ROOT . 'layout.php');
    }

    public function generate()
    {
        // if you are not valid user, force login.
        Piwik::checkUserIsNotAnonymous();

        /* Time and memory limits */
        if (Config::get('timeout', 0)) {
            set_time_limit(Config::get('timeout'));
        }
        if (Config::get('memory')) {
            ini_set('memory_limit', Config::get('memory') . 'M');
        }
        /* Browser */
        $browser = $this->getBrowser();
        $screenInfo = $this->getScreenSize();
        if ($screenInfo === null) {
            return $this->error(Piwik::Translate('ClickHeat_LANG_ERROR_SCREEN'));
        }

        list($screen, $width, $minScreen, $maxScreen) = $screenInfo;
        /* Selected Group */
        $group = str_replace('/', '', Common::getRequestVar('group'));
        $isRequestHeatMap = Common::getRequestVar('heatmap') === '1';
        /* Date and days */
        $now = isset($_SERVER['REQUEST_TIME']) ? date('Y-m-d', $_SERVER['REQUEST_TIME']) : date('Y-m-d');
        $requestDate = Common::getRequestVar('date') ? Common::getRequestVar('date') : $now;

        $range = Common::getRequestVar('range');
        list($minDate, $maxDate, $cacheTime) = $this->getDate($requestDate, $range);

        $imagePath = $group . '-' . $requestDate . '-' . $range . '-' . $screen . '-' . $browser . '-' . ($isRequestHeatMap === true ? 'heat' : 'click');
        $htmlPath = Config::get('cachePath') . $imagePath . '.html';

        /* If images are already created, just stop script here if these have less than 120 seconds (today's log) or 86400 seconds (old logs) */
        if (file_exists($htmlPath) && (filemtime($htmlPath) > (strtotime($now) - $cacheTime))) {
            $content = readfile($htmlPath);
            if($content == 0) {
	            return $this->error(Piwik::Translate('ClickHeat_LANG_ERROR_DATA'));
            }
            return true;
        }

        $target = new DrawingTarget([
            'groupId'   => $group,
            'browser'   => $browser,
            'minScreen' => $minScreen,
            'maxScreen' => $maxScreen,
            'minDate'   => $minDate,
            'maxDate'   => $maxDate,
            'logPath'   => Config::get('logPath')
        ]);
        $heatmapObject = $this->createHeatMap($target, $isRequestHeatMap, $browser, $minScreen, $maxScreen, $imagePath);
        $result = $heatmapObject->generate($width);
        if ($result === false) {
            return $this->error($heatmapObject->error);
        }
        $html = '';
        for ($i = 0; $i < $result['count']; $i++) {
            $html .= '<img src="' . CLICKHEAT_INDEX_PATH . 'action=png&amp;file=' . $result['filenames'][$i] . '&amp;rand=' . strtotime($now) . '" width="' . $result['width'] . '" height="' . $result['height'] . '" alt="" id="heatmap-' . $i . '" /><br />';
        }
        /* Save the HTML code to speed up following queries (only over two minutes) */
        $f = fopen($htmlPath, 'w');
        fputs($f, $html);
        fclose($f);
	    if(empty($html)) {
		    return $this->error(Piwik::Translate('ClickHeat_LANG_ERROR_DATA'));
	    }
        return $html;
    }

    public function png()
    {
        // if you are not valid user, force login.
        Piwik::checkUserIsNotAnonymous();
        $imagePath = Config::get('cachePath') . (isset($_GET['file']) ? str_replace('/', '', $_GET['file']) : '**unknown**');

        header('Content-Type: image/png');
        if (file_exists($imagePath)) {
            readfile($imagePath);
        } else {
            readfile(CLICKHEAT_ROOT . 'images/warning.png');
        }
    }

    public function cleaner()
    {
        // if you are not valid user, force login.
        Piwik::checkUserIsNotAnonymous();
        if (Config::get('flush')) {
            $this->logger->clean();
        }
        $cacheCleaner = StaticContainer::get(CacheStorage::class);
        $cacheCleaner->clean(Config::get('cachePath'));
    }

    /**
     * Track the click
     * @return bool|string
     */
    public function click()
    {
        $validateRequest = $this->isValidRequest();
        if ($validateRequest !== true) {
            return $validateRequest;
        }
        @ignore_user_abort(true);
        $this->logger->log(
            Common::getRequestVar('s'),
            Common::getRequestVar('g'),
            $_SERVER['HTTP_REFERER'],
            Helper::getBrowser(Common::getRequestVar('b')),
            Common::getRequestVar('w'),
            Common::getRequestVar('x'),
            Common::getRequestVar('y')
        );

        return 'ClickHeat: OK';

    }

    /**
     * @param string $refererHost
     * @return bool
     */
    private function checkReferrer($refererHost)
    {
        $siteUrls = API::getInstance()->getSiteUrlsFromId(Common::getRequestVar('s'));
        foreach ($siteUrls as $siteUrl) {
            $siteHost = parse_url($siteUrl, PHP_URL_HOST);
            if (strtolower($siteHost) === strtolower($refererHost)) {
                return true;
            }
        }

        return false;
    }

    /**
     * @return bool|string
     */
    protected function isValidRequest()
    {
        $group = Common::getRequestVar('g');
        if (
            !isset($_GET['x'])
            || !isset($_GET['y'])
            || !isset($_GET['w'])
            || empty($group)
            || !isset($_GET['s'])
            || !isset($_GET['b'])
            || !isset($_GET['c'])
        ) {
            return "\"ClickHeat: Parameters or config error\"";
        }

        // check referer
        if (Config::get('checkReferrer')) {
            if (!isset($_SERVER['HTTP_REFERER'])) {
                return 'ClickHeat: No domain in referer';
            }
            try {
                $refererHost = parse_url($_SERVER['HTTP_REFERER'], PHP_URL_HOST);
                if (!$this->checkReferrer($refererHost)) {
                    return 'ClickHeat: Forbidden domain (' . $refererHost . '), change or remove security settings in the /config panel to allow this one';
                }
            } catch (NoAccessException $e) {
                // try to access site info and compare host name
            }
        }

        // check browser
        $browser = Helper::getBrowser(Common::getRequestVar('b'));
        if ($browser === '') {
            return 'ClickHeat: Browser empty';
        }
        if ($isSkipped = $this->isSkippable()) {
            return $isSkipped;
        }

        return true;
    }

    /**
     * @return bool|string
     */
    private function isSkippable()
    {
        $adminCookie = new Cookie('clickheat-admin');
        if ($adminCookie->isCookieFound()) {
            return "ClickHeat: OK, but click not logged as you selected it in the admin panel";
        } else {
            try {
                $site = API::getInstance()->getSiteFromId(Common::getRequestVar('s'));
                if ($excludedIps = $site['excluded_ips']) {
                    $ip = IPUtils::stringToBinaryIP(\Piwik\Network\IP::fromStringIP(IP::getIpFromHeader()));
                    if (Helper::isIpInRange($ip, explode(',', $excludedIps))) {
                        return 'OK, but click not logged as you prevent this IP to be tracked in Piwik\'s configuration';
                    }
                }
            } catch (NoAccessException $e) {
                // just try to access excluded IPs
            }
        }

        return false;
    }

    /**
     * @param $error
     *
     * @return string
     */
    private function error($error)
    {
        return '&nbsp;<div style="line-height:20px;"><span class="error">' . $error . '</span></div>';
    }

    /**
     * @param DrawingTarget $target
     * @param               $isRequestHeatMap
     * @param               $browser
     * @param               $minScreen
     * @param               $maxScreen
     * @param               $imagePath
     *
     * @return null|AbstractHeatmap
     */
    private function createHeatMap(DrawingTarget $target, $isRequestHeatMap, $browser, $minScreen, $maxScreen, $imagePath)
    {
        $obj = HeatMapAdapterFactory::create(Config::get('adapter'));
        $obj->setTarget($target);
        $obj->heatmap = $isRequestHeatMap;
        $obj->browser = $browser;
        $obj->minScreen = $minScreen;
        $obj->maxScreen = $maxScreen;
        $obj->layout = ['', 0, 0, 0]; // not support change layout at this time
        $obj->step = Config::get('step');
        $obj->dot = Config::get('dot');
        $obj->palette = Config::get('palette');
        $obj->path = Config::get('cachePath');
        $obj->cache = Config::get('cachePath');
        $obj->file = $imagePath . '-%d.png';
        $obj->memory = 128 * 1048576;
        return $obj;
    }

    /**
     * @return string
     */
    private function getBrowser()
    {
        $browser = Common::getRequestVar('browser');
        $supportedBrowsers = Config::get('__browsersList');
        if (!isset($supportedBrowsers[$browser])) {
            $browser = 'all';
        }

        return $browser;
    }

    /**
     * @return array|null
     */
    private function getScreenSize()
    {
        $screen = Common::getRequestVar('screen', 0);
        if (!is_numeric($screen)) {
            return null;
        }
        $screen = (int)$screen;
        if ($screen === 0) {
            return null;
        }
        $minScreen = 0;
        if ($screen >= 0) {
            $screenConfig = Config::get('__screenSizes');
            if (!in_array($screen, $screenConfig, true) || $screen === 0) {
                return null;
            }
            $maxScreen = $screen;
            for ($i = 1; $i < count($screenConfig); $i++) {
                if ($screenConfig[$i] === $screen) {
                    $minScreen = $screenConfig[$i - 1];
                    break;
                }
            }
            $width = $screen - 25;
        } else {
            $width = abs($screen);
            $maxScreen = 3000;
        }

        return [
            $screen,
            $width,
            $minScreen,
            $maxScreen
        ];
    }

    /**
     * @param $requestDate
     * @param $requestRange
     *
     * @return array
     */
    private function getDate($requestDate, $requestRange)
    {
        $requestRange = $requestRange[0];
        $range = in_array($requestRange, ['d', 'w', 'm', 'r']) ? $requestRange : 'd';
        $date = explode(',', $requestDate);
        $minDate = $date[0];
        switch ($range) {
            case 'd': {
                $maxDate = $minDate;
                $cacheTime = date('dmy', strtotime($minDate)) !== date('dmy') ? 86400 : 120;
                break;
            }
            case 'w': {
                $maxDate = date('Y-m-d', strtotime($minDate . " +7 days"));
                $cacheTime = date('Wy', strtotime($minDate)) !== date('Wy') ? 86400 : 120;
                break;
            }
            case 'm': {
                $days = date('t', strtotime($minDate));
                $maxDate = date('Y-m-d', strtotime($minDate . " +{$days} days"));
                $cacheTime = date('my', strtotime($minDate)) !== date('my') ? 86400 : 120;
                break;
            }
            case 'r': {
                $maxDate = $date[1];
                $cacheTime = date('my', strtotime($minDate)) !== date('my') ? 86400 : 120;
                break;
            }
        }

        return [
            $minDate,
            $maxDate,
            $cacheTime
        ];
    }

}