fireguard/report

<?php
namespace Fireguard\Report\Exporters;

use Fireguard\Report\Contracts\ExporterInterface;
use Fireguard\Report\Contracts\ReportInterface;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpFoundation\ResponseHeaderBag;

abstract class AbstractExporter implements ExporterInterface
{
    /**
     * @var array
     */
    protected $config;

    /**
     * @var string
     */
    protected $fileName;

    /**
     * @var string
     */
    protected $extension;

    /**
     * Path for save file
     *
     * @var string
     */
    protected $path;

    /**
     * Time for expire process
     *
     * @var int
     */
    protected $timeout = 10;

    /**
     * Config Valid Options file to Exporter Format
     *
     * @var array
     */
    protected $configValidOptions = [];

    /**
     * Config Default Options file to Exporter Format
     *
     * @var array
     */
    protected $configDefaultOptions = [];

    /**
     * ExporterInterface constructor.
     * @param string $path
     * @param string $fileName
     * @param array $config
     */
    public function __construct($path = '', $fileName = '', $config = [])
    {
        $this->configure($config);
        $this->setPath($path);
        $this->setFileName($fileName);
    }

    /**
     * @return string
     */
    public function getPath()
    {
        return $this->path;
    }

    /**
     * @param string $path
     * @param unix_permission $mode Permission
     * @return ExporterInterface
     */
    public function setPath($path, $mode = 0777)
    {
        $tmpPath = rtrim($path, DIRECTORY_SEPARATOR).DIRECTORY_SEPARATOR;
        if ( empty($path)
            || ( !file_exists($path) && !mkdir($path, $mode, true) )
//            || ( !empty($this->fileName) && !(touch($tmpPath.$this->getFileName(), $mode)))
        ) {
            $this->path = sys_get_temp_dir().DIRECTORY_SEPARATOR;
            return $this;
        }

        $this->path = $tmpPath;
        return $this;
    }

    /**
     * @return string
     */
    public function getFileName()
    {
        return $this->fileName;
    }

    /**
     * @param $fileName
     * @return ExporterInterface
     */
    public function setFileName($fileName)
    {
        $tmpFileName = $fileName.$this->extension;
        if ( empty($fileName)
            || (file_exists($this->getPath().$tmpFileName) && !is_writable($this->getPath().$tmpFileName) )
        ) {
            $this->fileName = 'report-'.sha1(uniqid(rand(), true));
            return $this;
        }
        $this->fileName = $fileName;
        return $this;
    }

    /**
     * @return string
     */
    public function getFullPath()
    {
        return $this->getPath().$this->getFileName().$this->extension;
    }

    /**
     * @return int
     */
    public function getTimeout()
    {
        return $this->timeout;
    }

    /**
     * @param int $timeout
     * @return ExporterInterface
     */
    public function setTimeout($timeout)
    {
        $this->timeout = $timeout;
        return $this;
    }

    /**
     * @return array
     */
    public function getConfigDefaultOptions()
    {
        return $this->configDefaultOptions;
    }

    /**
     * @param array $options
     * @return ExporterInterface
     */
    public function setConfigDefaultOptions($options)
    {
        $this->configDefaultOptions = $options;
        return $this;
    }

    /**
     * @return array
     */
    public function getConfigValidOptions()
    {
        return $this->configValidOptions;
    }

    /**
     * @param array $options
     * @return ExporterInterface
     */
    public function setConfigValidOptions(array $options)
    {
        $this->configValidOptions = $options;
        return $this;
    }

    public function getDefaultConfiguration()
    {
        $ds = DIRECTORY_SEPARATOR;
        $path = __DIR__.$ds.'..'.$ds.'..'.$ds.'..'.$ds.'config'.$ds.'report.php';
        return file_exists($path) ? include $path : [];
    }

    /**
     * Compress html e js removed comments e break lines
     * @param $buffer
     * @return mixed
     */
    public function compress($buffer)
    {
        // remove comments
        $buffer = preg_replace('!/\*[^*]*\*+([^/][^*]*\*+)*/!', '', $buffer);

        // remove tabs, spaces, newlines, etc.
        $buffer = str_replace(array("\r\n", "\r", "\n", "\t", '  ', '   ', '    '), ' ', $buffer);
        return trim($buffer);
    }

    /**
     * @param array $config
     * @return ExporterInterface
     */
    abstract public function configure(array $config);

    /**
     * @param ReportInterface $report
     * @return string
     */
    abstract public function generate(ReportInterface $report);


    /**
     * @return string
     */
    abstract public function getMimeType();


    /**
     * @param boolean $forceDownload
     * @param ReportInterface $report
     * @return Response
     */
    public function response(ReportInterface $report, $forceDownload = false)
    {
        $file = $this->generate($report);

        $response = new Response( file_get_contents($file) , Response::HTTP_OK, ['Content-Type' => $this->getMimeType()]);
        if ($forceDownload) {
            $disposition =  $response->headers->makeDisposition(
                ResponseHeaderBag::DISPOSITION_ATTACHMENT,
                $this->getFileName().$this->extension
            );
            $response->headers->set('Content-Disposition', $disposition);
        }
        return $response;
    }
}