HealthCheckController::canProvide() - Code Metrics - sunnysideup/silverstripe-health-check-provider - Measure and Improve Code Quality continuously with Scrutinizer

HealthCheckController::canProvide() A
last analyzed 2021-04-01 23:44 UTC

↳ Parent: HealthCheckController

Complexity

Conditions	2
Paths	2

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	3
c	1
b	0
f	0
dl	0
loc	6
rs	10
cc	2
nc	2
nop	0

<?php

namespace Sunnysideup\HealthCheckProvider\Control;

use SilverStripe\Control\Controller;
use SilverStripe\Core\Environment;
use Sunnysideup\HealthCheckProvider\Model\HealthCheckProvider;
use Sunnysideup\HealthCheckProvider\Model\HealthCheckProviderSecurity;

class HealthCheckController extends Controller
{
    protected $editorID = 0;

    private static $url_segment = 'health-check-provider';


    private static $allowed_actions = [

        'ping' => '->canProvide',
        'provide' => '->canProvide',
        'confirmreceipt' => '->canProvide',
    ];

    public function index($request)
    public function index(/** @scrutinizer ignore-unused */ $request)
    {
        return $this->httpError(404);
    }

    public function ping()
    {
        $this->getResponse()->addHeader('Content-type', 'application/json');
        return '{"Success": ' . ($this->canProvide() ? 'true' : 'false') . '}';
    }

    public function provide($request)
    {
        $check = $this->checkSecurity($request);
        if ($check !== 'all-good') {
            return $check;
        }

        //we are ready!~
        $this->getResponse()->addHeader('Content-type', 'application/json');
        return $this->provideData();
    }

    public function confirmreceipt($request)
    {
        $check = $this->checkSecurity($request);
        if ($check !== 'all-good') {
            return $check;
        }

        $outcome = $this->recordReceipt($request);

        $this->getResponse()->addHeader('Content-type', 'application/json');

        return '{"Success": ' . $outcome . '}';
    }

    protected function provideData(): string
    {
        $obj = HealthCheckProvider::create();
        $obj->EditorID = $this->editorID;
        $obj->SendNow = true;
        $id = $obj->write();
        sleep(2);
        HealthCheckProvider::get()->byID($id);
        return (string) $obj->Data;
    }

    protected function recordReceipt($request): bool
    {
        $success = false;
        $id = (int) $request->param('ID');
        $code = $request->param('OtherID');
        /** @var HealthCheckProvider|null $obj */
        $obj = HealthCheckProvider::get()->byID($id);
        if ($obj) {

            if (! $code) {
                $code = 'no code provided';
            }
            $obj->ResponseCode = $code;

            $obj->Sent = true;

            $obj->SendNow = false;

            $obj->write();
            $success = $obj->getCodesMatch();
        }

        return $success;
    }

    protected function checkSecurity($request)
    {
        $headers = $request->getHeaders();
        $key = $headers['handshake'] ?? '';
        $ip = $request->getIp();
        $outcome = HealthCheckProviderSecurity::check($key, $ip);
        if ($outcome) {
            $this->editorID = HealthCheckProviderSecurity::get_editor_id($key, $ip);

            return 'all-good';
        }
        return $this->httpError(403, 'Sorry, we can not provide access.');
    }

    protected function canProvide(): bool
    {
        if (Environment::getEnv('SS_HEALTH_CHECK_PROVIDER_ALLOW_RETRIEVAL')) {
            return true;
        }
        die('Please set SS_HEALTH_CHECK_PROVIDER_ALLOW_RETRIEVAL to use this facility.');
interface ReturnsInt {
    public function returnsIntHinted(): int;
}

class MyClass implements ReturnsInt {
    public function returnsIntHinted(): int
    {
        if (foo()) {
            return 123;
        }
        // here: null is implicitly returned
    }
}
    }
}


sunnysideup / silverstripe-health-check-provider

HealthCheckController::canProvide() A last analyzed 2021-04-01 23:44 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

HealthCheckController::canProvide() A
last analyzed 2021-04-01 23:44 UTC