HtaccessFirewall\HtaccessFirewall

Complexity

Total Complexity

40

Size/Duplication

Total Lines	332
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes	4
Bugs	0	Features	0

18 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	2
A	deny()	0	4	1
A	undeny()	0	4	1
A	getDenied()	0	11	2
A	deactivate()	0	11	2
A	reactivate()	0	13	2
B	set403Message()	0	24	2
A	remove403Message()	0	4	1
A	exists()	0	4	1
A	readable()	0	4	1
A	writable()	0	4	1
A	addLine()	0	11	1
A	removeLine()	0	13	3
B	readLinesWithPrefix()	0	19	5
B	readLines()	0	20	5
C	writeLines()	0	42	8
A	isBeginOfSection()	0	4	1
A	isEndOfSection()	0	4	1

<?php

namespace HtaccessFirewall;

use HtaccessFirewall\Filesystem\Filesystem;
use HtaccessFirewall\Filesystem\BuiltInFilesystem;
use HtaccessFirewall\Filesystem\Exception\FileException;
use HtaccessFirewall\Host\Host;

/**
 * Firewall using Htaccess files.
 */
class HtaccessFirewall
{
    /**
     * @var string
     */
    public static $sectionLabel = 'Firewall';

    /**
     * @var string
     */
    private $path;

    /**
     * @var Filesystem
     */
    private $fileSystem;

    /**
     * Initialize HtaccessFirewall.
     *
     * @param $path
     * @param Filesystem $fileSystem
     */
    public function __construct($path, Filesystem $fileSystem = null)
    {
        $this->fileSystem = $fileSystem ?: new BuiltInFilesystem();

        $this->path = $path;
    }

    /**
     * Deny host.
     *
     * @param Host $host
     */
    public function deny(Host $host)
    {
        $this->addLine('deny from ' . $host->toString());
    }

    /**
     * Undeny host.
     *
     * @param Host $host
     */
    public function undeny(Host $host)
    {
        $this->removeLine('deny from ' . $host->toString());
    }

    /**
     * Get all denied hosts.
     *
     * @return string[]
     */
    public function getDenied()
    {
        $lines = $this->readLinesWithPrefix('deny from ');

        foreach ($lines as $key => $line) {
            $host = substr($line, 10);
            $lines[$key] = $host;
        }

        return $lines;
    }

    /**
     * Deactivate all denials.
     */
    public function deactivate()
    {
        $lines = $this->readLinesWithPrefix(array('ErrorDocument 403 ', 'deny from '));

        $insertion = array();
        foreach ($lines as $line) {
            $insertion[] = '#' . $line;
        }

        $this->writeLines($insertion);
    }

    /**
     * Reactivate all deactivated denials.
     */
    public function reactivate()
    {
        $lines = $this->readLinesWithPrefix(array('#ErrorDocument 403 ', '#deny from '));

        $insertion = array();
        $insertion[] = 'order allow,deny';
        foreach ($lines as $line) {
            $insertion[] = substr($line, 1);
        }
        $insertion[] = 'allow from all';

        $this->writeLines($insertion);
    }

    /**
     * Set 403 error message.
     *
     * @param string $message
     *
     * @return string
     */
    public function set403Message($message)
    {
        if (empty($message)) {
            $this->remove403Message();
            return '';
        }

        $message = preg_replace('/\s+/', ' ', $message);
        $message = trim($message);
        $message = htmlentities($message);

        $line = 'ErrorDocument 403 "' . $message . '"';

        $insertion = array_merge(
            array('order allow,deny'),
            array($line),
            $this->readLinesWithPrefix('deny from '),
            array('allow from all')
        );

        $this->writeLines($insertion);

        return $message;
    }

    /**
     * Remove 403 error message.
     */
    public function remove403Message()
    {
        $this->removeLine('ErrorDocument 403 ');
    }

    /**
     * Check whether Htaccess file exists.
     *
     * @return bool
     */
    public function exists()
    {
        return $this->fileSystem->exists($this->path);
    }

    /**
     * Check whether Htaccess file exists and is readable.
     *
     * @return bool
     */
    public function readable()
    {
        return $this->fileSystem->readable($this->path);
    }

    /**
     * Check whether Htaccess file exists and is writable.
     *
     * @return bool
     */
    public function writable()
    {
        return $this->fileSystem->writable($this->path);
    }

    /**
     * Add single line.
     *
     * @param string $line
     */
    private function addLine($line)
    {
        $insertion = array_merge(
            array('order allow,deny'),
            $this->readLinesWithPrefix(array('ErrorDocument 403 ', 'deny from ')),
            array($line),
            array('allow from all')
        );

        $this->writeLines(array_unique($insertion));
    }

    /**
     * Remove single line.
     *
     * @param string $content
     */
    private function removeLine($content)
    {
        $lines = $this->readLines();

        $insertion = array();
        foreach ($lines as $line) {
            if (strpos($line, $content) !== 0) {
                $insertion[] = $line;
            }
        }

        $this->writeLines($insertion);
    }

    /**
     * Get array of prefixed lines in section.
     *
     * @param string|string[] $prefixes
     *
     * @return string[]
     */
    private function readLinesWithPrefix($prefixes)
    {
        if (!is_array($prefixes)) {
            $prefixes = array($prefixes);
        }

        $lines = $this->readLines();

        $prefixedLines = array();
        foreach ($lines as $line) {
            foreach ($prefixes as $prefix) {
                if (strpos($line, $prefix) === 0) {
                    $prefixedLines[] = $line;
                }
            }
        }

        return $prefixedLines;
    }

    /**
     * Get array of all lines in section.
     *
     * @return string[]
     */
    private function readLines()
    {
        $lines = $this->fileSystem->read($this->path);

        $linesInSection = array();
        $inSection = false;
        foreach ($lines as $line) {
            if ($this->isEndOfSection($line)) {
                break;
            }
            if ($inSection) {
                $linesInSection[] = $line;
            }
            if ($this->isBeginOfSection($line)) {
                $inSection = true;
            }
        }

        return $linesInSection;
    }

    /**
     * Write array of lines to section.
     *
     * @param string[] $lines
     *
     * @throws FileException
     */
    private function writeLines($lines)
    {
        $oldLines = $this->fileSystem->read($this->path);

        $newLines = array();
        $sectionExists = false;
        $inSection = false;
        foreach ($oldLines as $oldLine) {
            if ($this->isBeginOfSection($oldLine)) {
                $inSection = true;
            }
            if (!$inSection) {
                $newLines[] = $oldLine;
            }
            if ($this->isEndOfSection($oldLine)) {
                $newLines = array_merge(
                    $newLines,
                    array('# BEGIN ' . self::$sectionLabel),
                    $lines,
                    array('# END ' . self::$sectionLabel)
                );

                $sectionExists = true;
                $inSection = false;
            }
        }

        if ($inSection && !$sectionExists) {
            throw new FileException('Missing END marker in Htaccess file.');
        }

        if (!$sectionExists) {
            $newLines = array_merge(
                $oldLines,
                array('# BEGIN ' . self::$sectionLabel),
                $lines,
                array('# END ' . self::$sectionLabel)
            );
        }

        $this->fileSystem->write($this->path, $newLines);
    }

    /**
     * Check whether line is the begin of the section.
     *
     * @param $line
     *
     * @return bool
     */
    private function isBeginOfSection($line)
    {
        return strpos($line, '# BEGIN ' . self::$sectionLabel) === 0;
    }

    /**
     * Check whether line is the end of the section.
     *
     * @param $line
     *
     * @return bool
     */
    private function isEndOfSection($line)
    {
        return strpos($line, '# END ' . self::$sectionLabel) === 0;
    }
}