Shieldon\Firewall\Panel\Ajax

Complexity

Total Complexity

66

Size/Duplication

Total Lines	416
Duplicated Lines	0 %

Importance

Changes	3
Bugs	0	Features	0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	_test_line_notify()	0	10	3
A	_test_rocket_chat()	0	19	6
A	tryMessenger()	0	48	4
A	__call()	0	3	1
A	_test_slack()	0	11	4
B	_test_sendgrid()	0	30	8
C	_test_smtp()	0	53	14
A	changeLocale()	0	12	1
A	respondJson()	0	13	1
B	_test_native_php_mail()	0	29	7
A	_test_telegram()	0	11	4
A	_test_slack_webhook()	0	10	3
B	_test_mailgun()	0	31	9

<?php
/*
 * This file is part of the Shieldon package.
 *
 * (c) Terry L. <contact@terryl.in>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace Shieldon\Firewall\Panel;

use Psr\Http\Message\ResponseInterface;
use Shieldon\Firewall\Panel\BaseController;
use Shieldon\Messenger as Messenger;
use function Shieldon\Firewall\__;
use function Shieldon\Firewall\get_request;
use function Shieldon\Firewall\get_response;
use function Shieldon\Firewall\get_session;
use function Shieldon\Firewall\set_request;
use function explode;
use function filter_var;
use function gethostname;
use function is_numeric;
use function json_encode;
use function str_replace;

/**
 * User
 */
class Ajax extends BaseController
{
    /**
     * Constructor.
     */
    public function __construct() 
    {
        parent::__construct();
    }

    /**
     * Fallback for undefined methods.
     *
     * @param string $function The method name.
     * @param array  $args     The arguments.
     *
     * @return bool
     */
    public function  __call($function , $args)
    {
        return false;
    }

    /**
     * Change the user's language of the UI.
     *
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function changeLocale(): ResponseInterface
    {
        $langCode = get_request()->getQueryParams()['langCode'] ?? 'en';
        get_session()->set('shieldon_panel_lang', $langCode);

        $data['status'] = 'success';

$data was never initialized. Although not strictly required by PHP, it is generally a good practice to add $data = array(); before regardless.

        $data['lang_code'] = $langCode;
        $data['session_lang_code'] = $langCode;
 
        $output = json_encode($data);

        return $this->respondJson($output);
    }


    /**
     * Test messenger modules.
     *
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function tryMessenger(): ResponseInterface
    {
        $request = get_request();

        $getParams = $request->getQueryParams();
        $serverParams = $request->getServerParams();

        $serverName = $serverParams['SERVER_NAME'] ?? gethostname();
        $moduleName = $getParams['module'] ?? '';
        $moduleName = str_replace('-', '_', $moduleName);

        $data = [];
        $data['status'] = 'undefined';
        $data['result']['moduleName'] = $moduleName;

        $message['title'] = __('panel', 'test_msg_title', 'Testing Message from Host: ') . $serverName;

$message was never initialized. Although not strictly required by PHP, it is generally a good practice to add $message = array(); before regardless.

        $message['body'] = __('panel', 'test_msg_body', 'Messenger module "{0}" has been tested and confirmed successfully.', [$moduleName]);
    
        // @codeCoverageIgnoreStart

        // Name the testing method.
        $method = '_test_' . $moduleName;

        // Call testing method if exists.
        if ($this->{$method}($getParams, $message)) {
            $data['status'] = 'success';
        }

        $postParams = $request->getParsedBody();
        $postKey = 'messengers__' . $moduleName . '__confirm_test';

        if ('success' === $data['status']) {
            $postParams[$postKey] = 'on';
            $this->saveConfig();
        } elseif ('error' === $data['status']) {
            $postParams[$postKey] = 'off';
            $this->saveConfig();
        }

        set_request($request->withParsedBody($postParams));

        // @codeCoverageIgnoreStart

        $data['result']['postKey'] = $postKey;

        $output = json_encode($data);

        return $this->respondJson($output);
    }

    // @codeCoverageIgnoreStart

    /**
     * Test Telegram.
     *
     * @param array $getParams The GET params passed from tryMessenger method.
     * @param array $message   The message title and body.
     *
     * @return bool
     */
    private function _test_telegram($getParams, $message)
    {
        $apiKey = $getParams['apiKey'] ?? '';
        $channel = $getParams['channel'] ?? '';
        if (!empty($apiKey) && !empty($channel)) {
            $messenger = new Messenger\Telegram($apiKey, $channel);
            if ($messenger->send($message['body'])) {
                return true;
            }
        }
        return false;
    }

    /**
     * Test Line Notify.
     *
     * @param array $getParams The GET params passed from tryMessenger method.
     * @param array $message   The message title and body.
     *
     * @return bool
     */
    private function _test_line_notify($getParams, $message)
    {
        $accessToken = $getParams['accessToken'] ?? '';
        if (!empty($accessToken)) {
            $messenger = new Messenger\LineNotify($accessToken);
            if ($messenger->send($message['body'])) {
                return true;
            }
        }
        return false;
    }

    /**
     * Test Slack.
     *
     * @param array $getParams The GET params passed from tryMessenger method.
     * @param array $message   The message title and body.
     *
     * @return bool
     */
    private function _test_slack($getParams, $message)
    {
        $botToken = $getParams['botToken'] ?? '';
        $channel = $getParams['channel'] ?? '';
        if (!empty($botToken) && !empty($channel)) {
            $messenger = new Messenger\Slack($botToken, $channel);
            if ($messenger->send($message['body'])) {
                return true;
            }
        }
        return false;
    }

    /**
     * Test Slack WebHook.
     *
     * @param array $getParams The GET params passed from tryMessenger method.
     * @param array $message   The message title and body.
     *
     * @return bool
     */
    private function _test_slack_webhook($getParams, $message)
    {
        $webhookUrl = $getParams['webhookUrl'] ?? '';
        if (!empty($webhookUrl)) {
            $messenger = new Messenger\SlackWebhook($webhookUrl);
            if ($messenger->send($message['body'])) {
                return true;
            }
        }
        return false;
    }

    /**
     * Test Rocket Chat.
     *
     * @param array $getParams The GET params passed from tryMessenger method.
     * @param array $message   The message title and body.
     *
     * @return bool
     */
    private function _test_rocket_chat($getParams, $message)
    {
        $serverUrl = $getParams['serverUrl'] ?? '';
        $userId = $getParams['userId'] ?? '';
        $accessToken = $getParams['accessToken'] ?? '';
        $channel = $getParams['channel'] ?? '';

        if (
            !empty($serverUrl) &&
            !empty($userId) &&
            !empty($accessToken) &&
            !empty($channel)
        ) {
            $messenger = new Messenger\RocketChat($accessToken, $userId, $serverUrl, $channel);
            if ($messenger->send($message['body'])) {
                return true;
            }
        }
        return false;
    }

    /**
     * Test SMTP.
     *
     * @param array $getParams The GET params passed from tryMessenger method.
     * @param array $message   The message title and body.
     *
     * @return bool
     */
    private function _test_smtp($getParams, $message)
    {
        $type = $getParams['type'] ?? '';
        $host = $getParams['host'] ?? '';
        $user = $getParams['user'] ?? '';
        $pass = $getParams['pass'] ?? '';
        $port = $getParams['port'] ?? '';

        $sender = $getParams['sender'] ?? '';
        $recipients = $getParams['recipients'] ?? '';

        if (
            (
                !filter_var($host, FILTER_VALIDATE_IP) && 
                !filter_var($host, FILTER_VALIDATE_DOMAIN)
            ) || 
            !is_numeric($port) || 
            empty($user) || 
            empty($pass) 
        ) {
            $data['result']['message'] = 'Invalid fields.';

$data was never initialized. Although not strictly required by PHP, it is generally a good practice to add $data = array(); before regardless.

            $output = json_encode($data);
            return $this->respondJson($output);

The expression return $this->respondJson($output) returns the type Psr\Http\Message\ResponseInterface which is incompatible with the documented return type boolean.

        }

        if ('ssl' === $type || 'tls' === $type) {
            $host = $type . '://' . $host;
        }

        if (!empty($sender) && $recipients) {
            $recipients = str_replace("\r", '|', $recipients);
            $recipients = str_replace("\n", '|', $recipients);
            $recipients = explode('|', $recipients);

            $messenger = new Messenger\Smtp($user, $pass, $host, (int) $port);

            foreach($recipients as $recipient) {
                if (filter_var($recipient, FILTER_VALIDATE_EMAIL)) {
                    $messenger->addRecipient($recipient);
                }
            }

            if (filter_var($sender, FILTER_VALIDATE_EMAIL)) {
                $messenger->addSender($sender);
            }

            $messenger->setSubject($message['title']);

            if ($messenger->send($message['body'])) {
                return true;
            }
        }
        return false;
    }

    /**
     * Test Native PHP mail.
     *
     * @param array $getParams The GET params passed from tryMessenger method.
     * @param array $message   The message title and body.
     *
     * @return bool
     */
    private function _test_native_php_mail($getParams, $message)
    {
        $sender = $getParams['sender'] ?? '';
        $recipients = $getParams['recipients'] ?? '';

        if (!empty($sender) && !empty($recipients)) {
            $recipients = str_replace("\r", '|', $recipients);
            $recipients = str_replace("\n", '|', $recipients);
            $recipients = explode('|', $recipients);

            $messenger = new Messenger\Mail();

            foreach($recipients as $recipient) {
                if (filter_var($recipient, FILTER_VALIDATE_EMAIL)) {
                    $messenger->addRecipient($recipient);
                }
            }

            if (filter_var($sender, FILTER_VALIDATE_EMAIL)) {
                $messenger->addSender($sender);
            }

            $messenger->setSubject($message['title']);

            if ($messenger->send($message['body'])) {
                return true;
            }
        }
        return false;
    }

    /**
     * Test Sendgrid.
     *
     * @param array $getParams The GET params passed from tryMessenger method.
     * @param array $message   The message title and body.
     *
     * @return bool
     */
    private function _test_sendgrid($getParams, $message)
    {
        $apiKey = $getParams['apiKey'] ?? '';
        $sender = $getParams['sender'] ?? '';
        $recipients = $getParams['recipients'] ?? '';

        if (!empty($sender) && !empty($recipients) && !empty($apiKey)) {
            $recipients = str_replace("\r", '|', $recipients);
            $recipients = str_replace("\n", '|', $recipients);
            $recipients = explode('|', $recipients);

            $messenger = new Messenger\Sendgrid($apiKey);

            foreach($recipients as $recipient) {
                if (filter_var($recipient, FILTER_VALIDATE_EMAIL)) {
                    $messenger->addRecipient($recipient);
                }
            }

            if (filter_var($sender, FILTER_VALIDATE_EMAIL)) {
                $messenger->addSender($sender);
            }

            $messenger->setSubject($message['title']);

            if ($messenger->send($message['body'])) {
                return true;
            }
        }
        return false;
    }

    /**
     * Test Mailgun.
     *
     * @param array $getParams The GET params passed from tryMessenger method.
     * @param array $message   The message title and body.
     *
     * @return bool
     */
    private function _test_mailgun($getParams, $message)
    {
        $apiKey = $getParams['apiKey'] ?? '';
        $domain = $getParams['domain'] ?? '';
        $sender = $getParams['sender'] ?? '';
        $recipients = $getParams['recipients'] ?? '';

        if (!empty($sender) && !empty($recipients) && !empty($apiKey) && !empty($domain)) {
            $recipients = str_replace("\r", '|', $recipients);
            $recipients = str_replace("\n", '|', $recipients);
            $recipients = explode('|', $recipients);

            $messenger = new Messenger\Mailgun($apiKey, $domain);

            foreach($recipients as $recipient) {
                if (filter_var($recipient, FILTER_VALIDATE_EMAIL)) {
                    $messenger->addRecipient($recipient);
                }
            }

            if (filter_var($sender, FILTER_VALIDATE_EMAIL)) {
                $messenger->addSender($sender);
            }

            $messenger->setSubject($message['title']);

            if ($messenger->send($message['body'])) {
                return true;
            }
        }
        return false;
    }

    // @codeCoverageIgnoreEnd

    /**
     * Respond the JSON format result.
     * 
     * @param string $output The string you want to output to the browser.
     *
     * @return \Psr\Http\Message\ResponseInterface
     */
    private function respondJson($output): ResponseInterface
    {
        $response = get_response();

        $stream = $response->getBody();
        $stream->write($output);
        $stream->rewind();

        $response = $response->withHeader('Content-Type', 'application/json');
        $response = $response->withAddedHeader('Content-Type', 'charset=utf-8');
        $response = $response->withBody($stream);

        return $response;
    }
}