MaintenanceModeExtension

Complexity

Total Complexity

14

Size/Duplication

Total Lines	77
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes	7
Bugs	1	Features	2

7 Methods

Rating	Name	Duplication	Size	Complexity
A	isDownForMaintenance()	0	4	1
A	get503File()	0	6	2
A	onBeforeInit()	0	7	3
A	throw503()	0	8	2
A	clientIpIsAllowedInMaintenanceMode()	0	7	3
A	getClientIp()	0	6	2
A	getAllowedIpAddresses()	0	4	1

<?php

/**
 * Class MaintenanceModeExtension.
 *
 * throw a 503 if mysite/down exists
 *
 * @property Controller $owner
 */
class MaintenanceModeExtension extends Extension

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{

    /**
     * @throws SS_HTTPResponse_Exception
     */
    public function onBeforeInit()
    {
        if($this->isDownForMaintenance() && !$this->clientIpIsAllowedInMaintenanceMode())
        {
            $this->throw503();
        }
    }

    /**
     * @return bool
     */
    public function isDownForMaintenance()
    {
        return file_exists(BASE_PATH.'/mysite/down');
    }

    /**
     * Somehow $this->owner->httpError keeps the website spinning.
     *
     * Maybe not very Silverstripe'sch, but at least this works
     *
     * @throws SS_HTTPResponse_Exception
     */
    protected function throw503()
    {
        $message   = 'Website is down for maintenance';
        $errorFile = $this->get503File();
        $content   = is_file($errorFile) ? file_get_contents($errorFile) : '<h1>'.$message.'</h1>';

        throw new SS_HTTPResponse_Exception(new SS_HTTPResponse($content, 503, $message));
    }

    /**
     * @return string
     */
    protected function get503File()
    {
        $custom = BASE_PATH.(string)Config::inst()->get('MaintenanceMode', 'file');

        return is_file($custom) ? $custom : BASE_PATH.'/assets/error-503.html';
    }

    /**
     * @return bool
     */
    protected function clientIpIsAllowedInMaintenanceMode()
    {
        $ip      = $this->getClientIp();
        $allowed = $this->getAllowedIpAddresses();

        return (bool)$allowed && $ip && in_array($ip, $allowed);

The expression $ip of type string|false is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== false instead.

    }

    /**
     * @return string|false
     */
    protected function getClientIp()
    {
        $request = $this->owner->getRequest();

        return (bool)$request ? $request->getIP() : false;
    }

    /**
     * @return array
     */
    protected function getAllowedIpAddresses()
    {
        return (array)Config::inst()->get('MaintenanceMode', 'allowed_ips');
    }
}