genzo_turnstile.php

<?php

/**
 * Copyright (C) 2023 Emanuel Schiendorfer
 *
 * @author    Emanuel Schiendorfer <https://github.com/eschiendorfer>
 * @copyright 2023 Emanuel Schiendorfer
 * @license   http://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
 */

if (!defined('_PS_VERSION_'))
	exit;

class Genzo_Turnstile extends Module
{
    public $errors;

    private $turnstile_site_key;
    private $turnstile_secret_key;
    private $turnstile_if_logged;
    private $turnstile_controllers;

	function __construct() {
		$this->name = 'genzo_turnstile';
		$this->tab = 'front_office_features';
		$this->version = '1.0.0';
		$this->author = 'Emanuel Schiendorfer';
		$this->need_instance = 1;

		$this->bootstrap = true;

	 	parent::__construct();

		$this->displayName = $this->l('Cloudflare Turnstile');
		$this->description = $this->l('Secure your forms from spam');
		$this->confirmUninstall = $this->l('Are you sure you want to uninstall?');

        // Set global values
        $this->turnstile_site_key = Configuration::get('GENZO_TURNSTILE_SITE_KEY');
        $this->turnstile_secret_key = Configuration::get('GENZO_TURNSTILE_SECRET_KEY');
        $this->turnstile_if_logged = Configuration::get('GENZO_TURNSTILE_IF_LOGGED');

        $this->setControllerRules();

        if (! $this->isTurnstileConfigured()) {
            $this->warning = $this->l('Site or Secret key is not set');
        }
	}

	public function install() {
		if (!parent::install() OR
            !$this->registerHook('actionFrontControllerSetMedia') OR
            !$this->registerHook('displayFooter')
        ) {
            return false;
        }

		return true;
	}


	// Backoffice
    public function getContent() {

        if (Tools::isSubmit('submitTurnstileSettings')) {
            if ($this->saveTurnstileSettings()) {
                $url = $this->context->link->getAdminLink('AdminModules', true, ['module_name' => $this->name, 'configure' => $this->name, 'conf' => 4]);
                Tools::redirectAdmin($url);
            }
        }

        return $this->renderSettingsForm();

    }

    private function renderSettingsForm() {

        // Get Submits in correct form
        $turnstileSubmits = [];
        foreach ($this->turnstile_controllers as $controller) {
            foreach ($controller as $submitName => $turnstileAction) {
                $turnstileSubmits[] = [
                    'submit_name' => $submitName,
                    'turnstile_action' => $turnstileAction.' (submit: '.$submitName.')'
                ];
            }
        }

        $fieldsForm[0]['form'] = [
            'legend' => [
                'title' => $this->l('Cloudflare Turnstile Settings'),
                'icon'  => 'icon-cogs',
            ],
            'input'  => [
                [
                    'type'     => 'text',
                    'label'    => $this->l('Site key'),
                    'name'     => 'turnstile_site_key',
                    'size'     => 15,
                    'required' => true,
                ],
                [
                    'type'     => 'text',
                    'label'    => $this->l('Secret key'),
                    'name'     => 'turnstile_secret_key',
                    'size'     => 15,
                    'required' => true,
                ],
                [
                    'type' => 'switch',
                    'label' => $this->l('Logged Customer'),
                    'desc'  => $this->l('Do you want to use the captcha also for logged in customers?'),
                    'name' => 'turnstile_if_logged',
                    'is_bool' => true,
                    'values' => array(
                        array(
                            'id' => 'active_on',
                            'value' => 1,
                            'label' => $this->l('Yes')
                        ),
                        array(
                            'id' => 'active_off',
                            'value' => 0,
                            'label' => $this->l('No')
                        )
                    ),
                ],
                [
                    'type'   => 'checkbox',
                    'label'  => $this->l('Active Submits'),
                    'name'   => 'turnstile_submits',
                    'values' => [
                        'query' => $turnstileSubmits,
                        'id'    => 'submit_name',
                        'name'  => 'turnstile_action',
                    ],
                ],
                [
                    'type'     => 'text',
                    'label'    => $this->l('Custom Submits'),
                    'name'     => 'turnstile_submits_custom',
                    'desc'     => $this->l('Add custom forms (for example from modules), that you want to be checked before submission. For that you need to add the "submit name" of a form.').' '.
                                  $this->l('Use Browser Inspection, select the submit button and search for the "name" value. (Example: submitGenzoQuestion,postReview)'),
                    'hint'     => $this->l('Multiple values should be separated by ,'),
                ],
            ],
            'submit' => [
                'title' => $this->l('Save'),
                'name' => 'submitTurnstileSettings'
            ],
        ];

        $helper = new HelperForm();
        $helper->module = $this;
        $helper->name_controller = $this->name;
        $helper->token = Tools::getAdminTokenLite('AdminModules');

        $helper->fields_value = [
            'turnstile_site_key' => Configuration::get('GENZO_TURNSTILE_SITE_KEY'),
            'turnstile_secret_key' => Configuration::get('GENZO_TURNSTILE_SECRET_KEY'),
            'turnstile_if_logged' => Configuration::get('GENZO_TURNSTILE_IF_LOGGED'),
            'turnstile_submits_custom' => Configuration::get('GENZO_TURNSTILE_SUBMITS_CUSTOM'),
        ];

        $turnstileSubmitsValues = explode(',', (string)Configuration::get('GENZO_TURNSTILE_SUBMITS'));
        foreach ($turnstileSubmitsValues as $submitName) {
            $helper->fields_value['turnstile_submits_'.$submitName] = true;
        }

        return $helper->generateForm($fieldsForm);
    }

    private function saveTurnstileSettings() {

        $turnstileSubmitsActive = [];

        foreach ($this->turnstile_controllers as $controller) {
            foreach ($controller as $submitName => $turnstileAction) {
                $inputName = 'turnstile_submits_'.$submitName;
                if (Tools::getValue($inputName)) {
                    $turnstileSubmitsActive[] = $submitName;
                }
            }
        }

        return Configuration::updateValue('GENZO_TURNSTILE_SITE_KEY', Tools::getValue('turnstile_site_key')) &&
            Configuration::updateValue('GENZO_TURNSTILE_SECRET_KEY', Tools::getValue('turnstile_secret_key')) &&
            Configuration::updateValue('GENZO_TURNSTILE_IF_LOGGED', Tools::getValue('turnstile_if_logged')) &&
            Configuration::updateValue('GENZO_TURNSTILE_SUBMITS_CUSTOM', Tools::getValue('turnstile_submits_custom')) &&
            Configuration::updateValue('GENZO_TURNSTILE_SUBMITS', implode(',', $turnstileSubmitsActive));
    }

    //Hooks
    public function hookActionFrontControllerSetMedia() {
        if (! $this->isTurnstileConfigured()) {
            return;
        }

        if ($submitsToCheck = $this->checkIfControllerNeedsValidation()) {

            Media::addJsDef(['turnstileSiteKey' => $this->turnstile_site_key, 'submitsToCheck' => $submitsToCheck]);
            $this->context->controller->addJS($this->_path.'/views/js/genzo_turnstile.js');

            foreach ($submitsToCheck as $submitToCheck => $action) {
                if (Tools::isSubmit($submitToCheck)) {
                    if (!$this->validateFormSubmitToken()) {
                        unset($_POST[$submitToCheck]);
                        $this->context->controller->errors[] = $this->l('Captcha Validation failed');
                    }
                }
            }
        }

    }

    public function hookDisplayFooter() {
        if ($this->isTurnstileConfigured()) {
            return '<script src="https://challenges.cloudflare.com/turnstile/v0/api.js" async defer nonce="strict-dynamic"></script>';
        }
        return '';
    }

    private function checkIfControllerNeedsValidation() {

        // Check if the customer is logged
        if (!$this->turnstile_if_logged && $this->context->customer->isLogged()) {
            return false;
        }

        // Get active submits (BO configuration)
        $submitsActive = [];

        $turnstileSubmitsValues = explode(',', (string)Configuration::get('GENZO_TURNSTILE_SUBMITS'));

        // Add custom submits to the active array (note: customs submits aren't checked for controller)
        $turnstileSubmitsCustomValues = explode(',', (string)Configuration::get('GENZO_TURNSTILE_SUBMITS_CUSTOM'));
        foreach ($turnstileSubmitsCustomValues as $customSubmitName) {
            $submitsActive[$customSubmitName] = $customSubmitName;
        }

        foreach ($this->turnstile_controllers as $instance => $submitsToCheck) {

            // Check the current controller (has it any possible validation)
            if ($this->context->controller instanceof $instance) {
                $submitsActive = [];

                // Check if the current controller has any active validations
                foreach ($submitsToCheck as $submitName => $turnstileAction) {
                    if (in_array($submitName, $turnstileSubmitsValues)) {
                        $submitsActive[$submitName] = $turnstileAction;
                    }
                }

                return $submitsActive;
            }
        }

        return $submitsActive;
    }

    private function setControllerRules() {
        $this->turnstile_controllers = [
            'ContactController' => [
                'submitMessage' => 'ContactForm',
            ],
            'AuthController' => [
                'SubmitCreate' => 'CreateAccount',
                'SubmitLogin' => 'Login',
            ],
        ];
    }

    private function validateFormSubmitToken() {
        $data = [
            'secret'   => $this->turnstile_secret_key,
            'response' => Tools::getValue('cf-turnstile-response'),
        ];

        $ch = curl_init();
        curl_setopt($ch, CURLOPT_URL, 'https://challenges.cloudflare.com/turnstile/v0/siteverify');
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
        curl_setopt($ch, CURLOPT_POST, true);
        curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
        curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 3);
        curl_setopt($ch, CURLOPT_TIMEOUT, 3);

        $result = json_decode(curl_exec($ch), true);

        if (isset($result['success'])) {
            return (bool)$result['success'];
        }

        return false;
    }

    /**
     * Returns true, if turnstile is configured properly.
     *
     * @return bool
     */
    protected function isTurnstileConfigured()
    {
        return $this->turnstile_site_key && $this->turnstile_secret_key;
    }

}