365 lines
14 KiB
PHP
365 lines
14 KiB
PHP
<?php
|
|
/**
|
|
* 2007-2017 PrestaShop
|
|
*
|
|
* NOTICE OF LICENSE
|
|
*
|
|
* This source file is subject to the Academic Free License (AFL 3.0)
|
|
* that is bundled with this package in the file LICENSE.txt.
|
|
* It is also available through the world-wide-web at this URL:
|
|
* http://opensource.org/licenses/afl-3.0.php
|
|
* If you did not receive a copy of the license and are unable to
|
|
* obtain it through the world-wide-web, please send an email
|
|
* to license@prestashop.com so we can send you a copy immediately.
|
|
*
|
|
* DISCLAIMER
|
|
*
|
|
* Do not edit or add to this file if you wish to upgrade PrestaShop to newer
|
|
* versions in the future. If you wish to customize PrestaShop for your
|
|
* needs please refer to https://www.prestashop.com for more information.
|
|
*
|
|
* @author Hennes Hervé <contact@h-hennes.fr>
|
|
* @copyright 2013-2017 Hennes Hervé
|
|
* @license http://opensource.org/licenses/afl-3.0.php Academic Free License (AFL 3.0)
|
|
* http://www.h-hennes.fr/blog/
|
|
*/
|
|
|
|
if (!defined('_PS_VERSION_')) {
|
|
exit;
|
|
}
|
|
|
|
class EiCaptcha extends Module
|
|
{
|
|
private $_html = '';
|
|
|
|
public function __construct()
|
|
{
|
|
$this->author = 'hhennes';
|
|
$this->name = 'eicaptcha';
|
|
$this->tab = 'front_office_features';
|
|
$this->version = '2.0.2';
|
|
$this->need_instance = 1;
|
|
|
|
$this->bootstrap = true;
|
|
parent::__construct();
|
|
|
|
$this->displayName = $this->l('Ei Captcha');
|
|
$this->description = $this->l('Add a captcha to your website form');
|
|
|
|
if ($this->active && (!Configuration::get('CAPTCHA_PUBLIC_KEY') || !Configuration::get('CAPTCHA_PRIVATE_KEY'))) {
|
|
$this->warning = $this->l('Captcha Module need to be configurated');
|
|
}
|
|
$this->themes = array( 0 => 'light', 1 => 'dark');
|
|
$this->dependencies = array('contactform');
|
|
$this->ps_versions_compliancy = array('min' => '1.7.1.0', 'max' => _PS_VERSION_);
|
|
}
|
|
|
|
public function install()
|
|
{
|
|
if (!parent::install()
|
|
|| !$this->registerHook('header')
|
|
|| !$this->registerHook('displayCustomerAccountForm')
|
|
|| !$this->registerHook('actionContactFormSubmitCaptcha')
|
|
|| !$this->registerHook('actionContactFormSubmitBefore')
|
|
|| !Configuration::updateValue('CAPTCHA_ENABLE_ACCOUNT', 0)
|
|
|| !Configuration::updateValue('CAPTCHA_ENABLE_CONTACT', 0)
|
|
|| !Configuration::updateValue('CAPTCHA_THEME', 0)
|
|
) {
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
public function uninstall()
|
|
{
|
|
if (!parent::uninstall()) {
|
|
return false;
|
|
}
|
|
|
|
if (!Configuration::deleteByName('CAPTCHA_PUBLIC_KEY') || !Configuration::deleteByName('CAPTCHA_PRIVATE_KEY') || !Configuration::deleteByName('CAPTCHA_ENABLE_ACCOUNT')
|
|
|| !Configuration::deleteByName('CAPTCHA_ENABLE_CONTACT') || !Configuration::deleteByName('CAPTCHA_FORCE_LANG') || !Configuration::deleteByName('CAPTCHA_THEME')
|
|
) {
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Post Process in back office
|
|
*/
|
|
public function postProcess()
|
|
{
|
|
if (Tools::isSubmit('SubmitCaptchaConfiguration')) {
|
|
Configuration::updateValue('CAPTCHA_PUBLIC_KEY', Tools::getValue('CAPTCHA_PUBLIC_KEY'));
|
|
Configuration::updateValue('CAPTCHA_PRIVATE_KEY', Tools::getValue('CAPTCHA_PRIVATE_KEY'));
|
|
Configuration::updateValue('CAPTCHA_ENABLE_ACCOUNT', (int) Tools::getValue('CAPTCHA_ENABLE_ACCOUNT'));
|
|
Configuration::updateValue('CAPTCHA_ENABLE_CONTACT', (int) Tools::getValue('CAPTCHA_ENABLE_CONTACT'));
|
|
Configuration::updateValue('CAPTCHA_FORCE_LANG', Tools::getValue('CAPTCHA_FORCE_LANG'));
|
|
Configuration::updateValue('CAPTCHA_THEME', (int)Tools::getValue('CAPTCHA_THEME'));
|
|
|
|
$this->_html .= $this->displayConfirmation($this->l('Settings updated'));
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Module Configuration in Back Office
|
|
*/
|
|
public function getContent()
|
|
{
|
|
$this->_html .= $this->_checkComposer();
|
|
$this->_html .= $this->postProcess();
|
|
$this->_html .= $this->renderForm();
|
|
|
|
return $this->_html;
|
|
}
|
|
|
|
/**
|
|
* Admin Form for module Configuration
|
|
*/
|
|
public function renderForm()
|
|
{
|
|
$fields_form = array(
|
|
'form' => array(
|
|
'legend' => array(
|
|
'title' => $this->l('Eicaptcha Configuration'),
|
|
'icon' => 'icon-cogs'
|
|
),
|
|
'description' => $this->l('To get your own public and private keys please click on the folowing link').'<br /><a href="https://www.google.com/recaptcha/intro/index.html" target="_blank">https://www.google.com/recaptcha/intro/index.html</a>',
|
|
'input' => array(
|
|
array(
|
|
'type' => 'text',
|
|
'label' => $this->l('Captcha public key (Site key)'),
|
|
'name' => 'CAPTCHA_PUBLIC_KEY',
|
|
'required' => true,
|
|
'empty_message' => $this->l('Please fill the captcha public key'),
|
|
),
|
|
array(
|
|
'type' => 'text',
|
|
'label' => $this->l('Captcha private key (Secret key)'),
|
|
'name' => 'CAPTCHA_PRIVATE_KEY',
|
|
'required' => true,
|
|
'empty_message' => $this->l('Please fill the captcha private key'),
|
|
),
|
|
array(
|
|
'type' => 'radio',
|
|
'label' => $this->l('Enable Captcha for contact form'),
|
|
'name' => 'CAPTCHA_ENABLE_CONTACT',
|
|
'required' => true,
|
|
'class' => 't',
|
|
'is_bool' => true,
|
|
'values' => array(
|
|
array(
|
|
'id' => 'active_on',
|
|
'value'=> 1,
|
|
'label'=> $this->l('Enabled'),
|
|
),
|
|
array(
|
|
'id' => 'active_off',
|
|
'value'=> 0,
|
|
'label'=> $this->l('Disabled'),
|
|
),
|
|
),
|
|
),
|
|
array(
|
|
'type' => 'radio',
|
|
'label' => $this->l('Enable Captcha for account creation'),
|
|
'name' => 'CAPTCHA_ENABLE_ACCOUNT',
|
|
'required' => true,
|
|
'class' => 't',
|
|
'is_bool' => true,
|
|
'values' => array(
|
|
array(
|
|
'id' => 'active_on',
|
|
'value'=> 1,
|
|
'label'=> $this->l('Enabled'),
|
|
),
|
|
array(
|
|
'id' => 'active_off',
|
|
'value'=> 0,
|
|
'label'=> $this->l('Disabled'),
|
|
),
|
|
),
|
|
),
|
|
array(
|
|
'type' => 'text',
|
|
'label' => $this->l('Force Captcha language'),
|
|
'hint' => $this->l('Language code ( en-GB | fr | de | de-AT | ... ) - Leave empty for autodetect'),
|
|
'desc' => $this->l('For available language codes see: https://developers.google.com/recaptcha/docs/language'),
|
|
'name' => 'CAPTCHA_FORCE_LANG',
|
|
'required' => false,
|
|
),
|
|
array(
|
|
'type' => 'radio',
|
|
'label' => $this->l('Theme'),
|
|
'name' => 'CAPTCHA_THEME',
|
|
'required' => true,
|
|
'is_bool' => true,
|
|
'values' => array(
|
|
array(
|
|
'id' => 'clight',
|
|
'value' => 0,
|
|
'label' => $this->l('Light'),
|
|
),
|
|
array(
|
|
'id' => 'cdark',
|
|
'value' => 1,
|
|
'label' => $this->l('Dark'),
|
|
),
|
|
),
|
|
),
|
|
),
|
|
'submit' => array(
|
|
'title' => $this->l('Save'),
|
|
'class' => 'button btn btn-default pull-right',
|
|
)
|
|
),
|
|
);
|
|
|
|
$helper = new HelperForm();
|
|
$helper->show_toolbar = false;
|
|
$lang = new Language((int)Configuration::get('PS_LANG_DEFAULT'));
|
|
$helper->default_form_language = $lang->id;
|
|
$helper->allow_employee_form_lang = Configuration::get('PS_BO_ALLOW_EMPLOYEE_FORM_LANG') ? Configuration::get('PS_BO_ALLOW_EMPLOYEE_FORM_LANG') : 0;
|
|
$helper->id = 'eicaptcha';
|
|
//$helper->identifier = $this->identifier;
|
|
$helper->submit_action = 'SubmitCaptchaConfiguration';
|
|
$helper->currentIndex = $this->context->link->getAdminLink('AdminModules', false).'&configure='.$this->name.'&tab_module='.$this->tab.'&module_name='.$this->name;
|
|
$helper->token = Tools::getAdminTokenLite('AdminModules');
|
|
$helper->tpl_vars = array(
|
|
'fields_value' => $this->getConfigFieldsValues(),
|
|
'languages' => $this->context->controller->getLanguages(),
|
|
'id_language' => $this->context->language->id
|
|
);
|
|
|
|
return $helper->generateForm(array($fields_form));
|
|
}
|
|
|
|
/**
|
|
* Get config values to hydrate the helperForm
|
|
*/
|
|
public function getConfigFieldsValues()
|
|
{
|
|
return array(
|
|
'CAPTCHA_PRIVATE_KEY' => Tools::getValue('CAPTCHA_PRIVATE_KEY', Configuration::get('CAPTCHA_PRIVATE_KEY')),
|
|
'CAPTCHA_PUBLIC_KEY' => Tools::getValue('CAPTCHA_PUBLIC_KEY', Configuration::get('CAPTCHA_PUBLIC_KEY')),
|
|
'CAPTCHA_ENABLE_ACCOUNT' => Tools::getValue('CAPTCHA_ENABLE_ACCOUNT', Configuration::get('CAPTCHA_ENABLE_ACCOUNT')),
|
|
'CAPTCHA_ENABLE_CONTACT' => Tools::getValue('CAPTCHA_ENABLE_CONTACT', Configuration::get('CAPTCHA_ENABLE_CONTACT')),
|
|
'CAPTCHA_FORCE_LANG' => Tools::getValue('CAPTCHA_FORCE_LANG', Configuration::get('CAPTCHA_FORCE_LANG')),
|
|
'CAPTCHA_THEME' => Tools::getValue('CAPTCHA_THEME', Configuration::get('CAPTCHA_THEME')),
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Hook Header
|
|
*/
|
|
public function hookHeader($params)
|
|
{
|
|
//Add Content box to contact form page in order to display captcha
|
|
if ( $this->context->controller instanceof ContactController
|
|
&& Configuration::get('CAPTCHA_ENABLE_CONTACT') == 1
|
|
) {
|
|
|
|
$this->context->controller->registerJavascript(
|
|
'modules-eicaptcha-contact-form',
|
|
'modules/'.$this->name.'/views/js/eicaptcha-contact-form.js'
|
|
);
|
|
$this->context->controller->registerStylesheet(
|
|
'module-eicaptcha',
|
|
'modules/'.$this->name.'/views/css/eicaptcha.css'
|
|
);
|
|
}
|
|
|
|
if ( $this->context->controller instanceof ContactController
|
|
|| $this->context->controller instanceof AuthController
|
|
) {
|
|
|
|
$this->context->controller->registerStylesheet(
|
|
'module-eicaptcha',
|
|
'modules/'.$this->name.'/views/css/eicaptcha.css'
|
|
);
|
|
|
|
//Dynamic insertion of the content
|
|
$js = '<script type="text/javascript">
|
|
//Recaptcha CallBack Function
|
|
var onloadCallback = function() {grecaptcha.render("captcha-box", {"theme" : "' . $this->themes[Configuration::get('CAPTCHA_THEME')] . '", "sitekey" : "' . Configuration::get('CAPTCHA_PUBLIC_KEY') . '"});};
|
|
</script>';
|
|
|
|
$js .= '<script src="https://www.google.com/recaptcha/api.js?onload=onloadCallback&render=explicit&hl=' . Configuration::get('CAPTCHA_FORCE_LANG') . '" async defer></script>';
|
|
|
|
return $js;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Add Captcha on the Customer Registration Form
|
|
*/
|
|
public function hookDisplayCustomerAccountForm($params)
|
|
{
|
|
if (Configuration::get('CAPTCHA_ENABLE_ACCOUNT') == 1) {
|
|
$this->context->smarty->assign('publicKey', Configuration::get('CAPTCHA_PUBLIC_KEY'));
|
|
$this->context->smarty->assign('captchaforcelang', Configuration::get('CAPTCHA_FORCE_LANG'));
|
|
$this->context->smarty->assign('captchatheme', $this->themes[Configuration::get('CAPTCHA_THEME')]);
|
|
return $this->display(__FILE__, 'views/templates/hook/hookDisplayCustomerAccountForm.tpl');
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Check captcha before submit account
|
|
* Custom hook
|
|
* @param type $params
|
|
* @return boolean
|
|
*/
|
|
public function hookActionContactFormSubmitCaptcha($params)
|
|
{
|
|
if ( Configuration::get('CAPTCHA_ENABLE_ACCOUNT') == 1) {
|
|
$this->_validateCaptcha();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Check captcha before submit contact form
|
|
* new custom hook
|
|
* @return int
|
|
*/
|
|
public function hookActionContactFormSubmitBefore()
|
|
{
|
|
if (Configuration::get('CAPTCHA_ENABLE_CONTACT') == 1) {
|
|
$this->_validateCaptcha();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Validate Captcha
|
|
*/
|
|
protected function _validateCaptcha()
|
|
{
|
|
$context = Context::getContext();
|
|
require_once(__DIR__ . '/vendor/autoload.php');
|
|
$captcha = new \ReCaptcha\ReCaptcha(Configuration::get('CAPTCHA_PRIVATE_KEY'));
|
|
$result = $captcha->verify(Tools::getValue('g-recaptcha-response'),
|
|
Tools::getRemoteAddr());
|
|
|
|
if (! $result->isSuccess()) {
|
|
$context->controller->errors[] = $this->l('Please validate the captcha field before submitting your request');
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Check if needed composer directory is present
|
|
*/
|
|
protected function _checkComposer()
|
|
{
|
|
if (!is_dir(dirname(__FILE__).'/vendor')) {
|
|
$errorMessage = $this->l('This module need composer to work, please go into module directory %s and run composer install or dowload and install latest release from %s');
|
|
return $this->displayError(
|
|
sprintf($errorMessage, dirname(__FILE__),
|
|
'https://github.com/nenes25/eicaptcha/releases')
|
|
);
|
|
}
|
|
return '';
|
|
}
|
|
|
|
}
|