First upload
This commit is contained in:
@@ -0,0 +1,36 @@
|
||||
<?php
|
||||
/**
|
||||
* This file is part of O3-Shop GDPR opt-in module.
|
||||
*
|
||||
* O3-Shop is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, version 3.
|
||||
*
|
||||
* O3-Shop is distributed in the hope that it will be useful, but
|
||||
* WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||
* General Public License for more details.
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with O3-Shop. If not, see <http://www.gnu.org/licenses/>
|
||||
*
|
||||
* @copyright Copyright (c) 2022 OXID eSales AG (https://www.oxid-esales.com)
|
||||
* @copyright Copyright (c) 2022 O3-Shop (https://www.o3-shop.com)
|
||||
* @license https://www.gnu.org/licenses/gpl-3.0 GNU General Public License 3 (GPLv3)
|
||||
*/
|
||||
|
||||
$sLangName = 'Deutsch';
|
||||
|
||||
$aLang = [
|
||||
'charset' => 'UTF-8', // Supports german language specific chars like: ä, ö. ß, etc.
|
||||
'OEGDPROPTIN_STORE_DELIVERY_ADDRESS' => "Ich bin damit einverstanden, dass meine Lieferadresse dauerhaft gespeichert wird. Unter 'Mein Konto' kann ich die Lieferadresse endgültig löschen.",
|
||||
'OEGDPROPTIN_CONFIRM_STORE_DELIVERY_ADDRESS' => 'Bitte stimmen Sie dem Speichern der Lieferadresse zu!',
|
||||
'OEGDPROPTIN_CONTACT_FORM_ERROR_MESSAGE' => 'Bitte stimmen Sie den Bedingungen der Verarbeitung Ihrer Daten zu!',
|
||||
'OEGDPROPTIN_CONTACT_FORM_MESSAGE_DELETION' => 'Ihre Kontaktdaten werden nach Bearbeitung der Anfrage gelöscht.',
|
||||
'OEGDPROPTIN_CONTACT_FORM_MESSAGE_STATISTICAL' => 'Ich stimme der Verwendung meiner Daten zur Beantwortung dieser Anfrage und für statistische Zwecke zu.',
|
||||
'OEGDPROPTIN_USER_REGISTRATION_OPTIN' => 'Ich bin damit einverstanden, dass meine Daten dauerhaft für das Kundenkonto verwendet werden. Ein Widerruf meiner Einwilligung ist jederzeit mit Wirkung für die Zukunft möglich.',
|
||||
'OEGDPROPTIN_CONFIRM_USER_REGISTRATION_OPTIN' => 'Bitte stimmen Sie dem Speichern der Daten zu!',
|
||||
'OEGDPROPTIN_REVIEW_FORM_MESSAGE' => 'Ich stimme zu, dass meine Bewertung und mein Name auf dieser Seite veröffentlicht werden. Diese Einwilligung kann ich jederzeit mit Wirkung für die Zukunft widerrufen.',
|
||||
'OEGDPROPTIN_REVIEW_FORM_ERROR_MESSAGE' => 'Bitte stimmen Sie der Veröffentlichung Ihrer Bewertung und Ihres Namens zu!',
|
||||
'OEGDPROPTIN_STORE_INVOICE_ADDRESS' => "Ich bin damit einverstanden, dass meine Rechnungsadresse dauerhaft gespeichert wird.",
|
||||
'OEGDPROPTIN_CONFIRM_STORE_INVOICE_ADDRESS' => 'Bitte stimmen Sie dem Speichern der Rechnungsadresse zu!',
|
||||
];
|
||||
@@ -0,0 +1,36 @@
|
||||
<?php
|
||||
/**
|
||||
* This file is part of O3-Shop GDPR opt-in module.
|
||||
*
|
||||
* O3-Shop is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, version 3.
|
||||
*
|
||||
* O3-Shop is distributed in the hope that it will be useful, but
|
||||
* WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||
* General Public License for more details.
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with O3-Shop. If not, see <http://www.gnu.org/licenses/>
|
||||
*
|
||||
* @copyright Copyright (c) 2022 OXID eSales AG (https://www.oxid-esales.com)
|
||||
* @copyright Copyright (c) 2022 O3-Shop (https://www.o3-shop.com)
|
||||
* @license https://www.gnu.org/licenses/gpl-3.0 GNU General Public License 3 (GPLv3)
|
||||
*/
|
||||
|
||||
$sLangName = 'English';
|
||||
|
||||
$aLang = [
|
||||
'charset' => 'UTF-8',
|
||||
'OEGDPROPTIN_STORE_DELIVERY_ADDRESS' => "I agree that my shipping address will be permanently stored. Under 'My account' I am able to remove the shipping address definitively.",
|
||||
'OEGDPROPTIN_CONFIRM_STORE_DELIVERY_ADDRESS' => 'Please agree to shipping address being stored!',
|
||||
'OEGDPROPTIN_CONTACT_FORM_ERROR_MESSAGE' => "Please agree to the conditions of processing your data!",
|
||||
'OEGDPROPTIN_CONTACT_FORM_MESSAGE_DELETION' => "Your contact details will be deleted after processing the request.",
|
||||
'OEGDPROPTIN_CONTACT_FORM_MESSAGE_STATISTICAL' => "I agree to the use of my data to answer this request and for statistical purposes.",
|
||||
'OEGDPROPTIN_USER_REGISTRATION_OPTIN' => "I agree that my data will be used permanently for the customer account. A revocation of my consent is possible at any time with effect for the future.",
|
||||
'OEGDPROPTIN_CONFIRM_USER_REGISTRATION_OPTIN' => 'Please agree to your data being stored!',
|
||||
'OEGDPROPTIN_REVIEW_FORM_MESSAGE' => "I agree that my review and name will be published on this page. I may revoke this consent at any time, with effect for the future.",
|
||||
'OEGDPROPTIN_REVIEW_FORM_ERROR_MESSAGE' => 'Please agree to your review and name being published here!',
|
||||
'OEGDPROPTIN_STORE_INVOICE_ADDRESS' => "I agree that my invoice address will be permanently stored.",
|
||||
'OEGDPROPTIN_CONFIRM_STORE_INVOICE_ADDRESS' => 'Please agree to invoice address being stored!',
|
||||
];
|
||||
@@ -0,0 +1,37 @@
|
||||
<?php
|
||||
/**
|
||||
* This file is part of O3-Shop GDPR opt-in module.
|
||||
*
|
||||
* O3-Shop is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, version 3.
|
||||
*
|
||||
* O3-Shop is distributed in the hope that it will be useful, but
|
||||
* WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||
* General Public License for more details.
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with O3-Shop. If not, see <http://www.gnu.org/licenses/>
|
||||
*
|
||||
* @copyright Copyright (c) 2022 OXID eSales AG (https://www.oxid-esales.com)
|
||||
* @copyright Copyright (c) 2022 O3-Shop (https://www.o3-shop.com)
|
||||
* @license https://www.gnu.org/licenses/gpl-3.0 GNU General Public License 3 (GPLv3)
|
||||
*/
|
||||
|
||||
$sLangName = 'Deutsch';
|
||||
|
||||
$aLang = [
|
||||
'charset' => 'UTF-8', // Supports german language specific chars like: ä, ö. ß, etc.
|
||||
'oegdproptin' => 'OE GDPR Opt-in Modul',
|
||||
|
||||
'SHOP_MODULE_GROUP_oegdproptin_settings' => 'DSGVO-Einstellungen',
|
||||
'SHOP_MODULE_blOeGdprOptinInvoiceAddress' => 'Opt-in für Rechnungsadresse anzeigen',
|
||||
'SHOP_MODULE_blOeGdprOptinDeliveryAddress' => 'Opt-in für Lieferadresse anzeigen',
|
||||
'SHOP_MODULE_blOeGdprOptinUserRegistration' => 'Opt-in für die Benutzerregistrierung anzeigen',
|
||||
'SHOP_MODULE_blOeGdprOptinProductReviews' => 'Opt-in für Artikelbewertungen anzeigen',
|
||||
|
||||
'SHOP_MODULE_GROUP_oegdproptin_contact_form' => 'Einstellungen für das Kontaktformular',
|
||||
'SHOP_MODULE_OeGdprOptinContactFormMethod' => '', // right side of the inputs, if some notes will be needed
|
||||
'SHOP_MODULE_OeGdprOptinContactFormMethod_deletion' => 'Hinweis auf Löschen der Daten nach Verarbeitung anzeigen',
|
||||
'SHOP_MODULE_OeGdprOptinContactFormMethod_statistical' => 'Opt-in für Verarbeitung und statistische Verwendung der Daten anzeigen',
|
||||
];
|
||||
@@ -0,0 +1,37 @@
|
||||
<?php
|
||||
/**
|
||||
* This file is part of O3-Shop GDPR opt-in module.
|
||||
*
|
||||
* O3-Shop is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, version 3.
|
||||
*
|
||||
* O3-Shop is distributed in the hope that it will be useful, but
|
||||
* WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||
* General Public License for more details.
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with O3-Shop. If not, see <http://www.gnu.org/licenses/>
|
||||
*
|
||||
* @copyright Copyright (c) 2022 OXID eSales AG (https://www.oxid-esales.com)
|
||||
* @copyright Copyright (c) 2022 O3-Shop (https://www.o3-shop.com)
|
||||
* @license https://www.gnu.org/licenses/gpl-3.0 GNU General Public License 3 (GPLv3)
|
||||
*/
|
||||
|
||||
$sLangName = 'English';
|
||||
|
||||
$aLang = [
|
||||
'charset' => 'UTF-8',
|
||||
'oegdproptin' => 'OE GDPR opt-in module',
|
||||
|
||||
'SHOP_MODULE_GROUP_oegdproptin_settings' => 'GDPR settings',
|
||||
'SHOP_MODULE_blOeGdprOptinInvoiceAddress' => 'Show opt-in for invoice address',
|
||||
'SHOP_MODULE_blOeGdprOptinDeliveryAddress' => 'Show opt-in for shipping address',
|
||||
'SHOP_MODULE_blOeGdprOptinUserRegistration' => 'Show opt-in for user registration',
|
||||
'SHOP_MODULE_blOeGdprOptinProductReviews' => 'Show opt-in for product reviews',
|
||||
|
||||
'SHOP_MODULE_GROUP_oegdproptin_contact_form' => 'Settings for the contact form',
|
||||
'SHOP_MODULE_OeGdprOptinContactFormMethod' => '', // right side of the inputs, if some notes will be needed
|
||||
'SHOP_MODULE_OeGdprOptinContactFormMethod_deletion' => 'Show a note for deletion of the data after processing',
|
||||
'SHOP_MODULE_OeGdprOptinContactFormMethod_statistical' => 'Show an opt-in for processing and statistical usage of the data',
|
||||
];
|
||||
@@ -0,0 +1,21 @@
|
||||
[{$smarty.block.parent}]
|
||||
|
||||
<div class="form-group">
|
||||
<div class="col-lg-offset-[{$leftCol|default:2}] col-lg-[{$rightCol|default:10}]">
|
||||
[{if $oView->isOptInValidationRequired()}]
|
||||
<label for="c_oegdproptin">
|
||||
<input type="hidden" name="c_oegdproptin" value="0">
|
||||
<input type="checkbox"
|
||||
name="c_oegdproptin"
|
||||
id="c_oegdproptin"
|
||||
value="1">
|
||||
<strong>[{oxmultilang ident="OEGDPROPTIN_CONTACT_FORM_MESSAGE_STATISTICAL" }]</strong>
|
||||
</label>
|
||||
[{if $oView->isOptInError()}]
|
||||
<div class="text-danger">[{oxmultilang ident="OEGDPROPTIN_CONTACT_FORM_ERROR_MESSAGE" }]</div>
|
||||
[{/if}]
|
||||
[{else}]
|
||||
[{oxmultilang ident="OEGDPROPTIN_CONTACT_FORM_MESSAGE_DELETION"}]
|
||||
[{/if}]
|
||||
</div>
|
||||
</div>
|
||||
@@ -0,0 +1,21 @@
|
||||
[{if !isset($oConfig)}]
|
||||
[{assign var="oConfig" value=$oViewConf->getConfig()}]
|
||||
[{/if}]
|
||||
|
||||
[{if true == $oConfig->getConfigParam('blOeGdprOptinDeliveryAddress')}]
|
||||
[{if $Errors.oegdproptin_deliveryaddress}]
|
||||
[{assign var=oError value=$Errors.oegdproptin_deliveryaddress.0}]
|
||||
<div class="alert alert-danger">[{$oError->getOxMessage()}]</div>
|
||||
<div class="help-block"></div>
|
||||
[{/if}]
|
||||
[{/if}]
|
||||
|
||||
[{if true == $oConfig->getConfigParam('blOeGdprOptinInvoiceAddress')}]
|
||||
[{if $Errors.oegdproptin_invoiceaddress}]
|
||||
[{assign var=oError value=$Errors.oegdproptin_invoiceaddress.0}]
|
||||
<div class="alert alert-danger">[{$oError->getOxMessage()}]</div>
|
||||
<div class="help-block"></div>
|
||||
[{/if}]
|
||||
[{/if}]
|
||||
|
||||
[{$smarty.block.parent}]
|
||||
@@ -0,0 +1,21 @@
|
||||
[{$smarty.block.parent}]
|
||||
|
||||
[{if !isset($oConfig)}]
|
||||
[{assign var="oConfig" value=$oViewConf->getConfig()}]
|
||||
[{/if}]
|
||||
|
||||
[{if true == $oConfig->getConfigParam('blOeGdprOptinUserRegistration')}]
|
||||
<div class="form-group row">
|
||||
<div class="col-lg-9 col-lg-offset-3 offset-lg-3">
|
||||
<div class="checkbox">
|
||||
<label for="oegdproptin_userregistration">
|
||||
<input type="checkbox" name="oegdproptin_userregistration" id="oegdproptin_userregistration" value="1"> [{oxmultilang ident="OEGDPROPTIN_USER_REGISTRATION_OPTIN"}]
|
||||
</label>
|
||||
</div>
|
||||
[{if $Errors.oegdproptin_userregistration}]
|
||||
[{assign var=oError value=$Errors.oegdproptin_userregistration.0}]
|
||||
<div class="text-danger">[{$oError->getOxMessage()}]</div>
|
||||
[{/if}]
|
||||
</div>
|
||||
</div>
|
||||
[{/if}]
|
||||
@@ -0,0 +1,51 @@
|
||||
[{if !isset($oConfig)}]
|
||||
[{assign var="oConfig" value=$oViewConf->getConfig()}]
|
||||
[{/if}]
|
||||
|
||||
[{if $oxcmp_user}]
|
||||
[{assign var="delivadr" value=$oxcmp_user->getSelectedAddress()}]
|
||||
[{/if}]
|
||||
|
||||
[{if true == $oConfig->getConfigParam('blOeGdprOptinDeliveryAddress')}]
|
||||
[{if $delivadr}]
|
||||
[{oxscript add="$('#showShipAddress').change( function() { $('#GdprShippingAddressOptin, #shippingAddressForm').hide($(this).is(':checked'));});"}]
|
||||
[{oxscript add="$('.dd-edit-shipping-address').click(function(){ $('#GdprShippingAddressOptin').toggle($(this).is(':not(:checked)')); document.getElementById('oegdproptin_changeDelAddress').value=1; });"}]
|
||||
[{oxscript add="$('.dd-add-delivery-address').click( function(){ $('#GdprShippingAddressOptin').toggle($(this).is(':not(:checked)')); });"}]
|
||||
[{else}]
|
||||
[{oxscript add="$('#showShipAddress').change( function() { $('#GdprShippingAddressOptin').toggle($(this).is(':not(:checked)')); });"}]
|
||||
[{/if}]
|
||||
[{/if}]
|
||||
|
||||
[{if true == $oConfig->getConfigParam('blOeGdprOptinInvoiceAddress')}]
|
||||
[{oxscript add="$('#userChangeAddress').click( function() { $('#GdprInvoiceAddressOptin').show();$('#userChangeAddress').hide();return false;});"}]
|
||||
[{/if}]
|
||||
|
||||
[{capture assign="optinValidationJS"}]
|
||||
[{strip}]
|
||||
$("#accUserSaveTop").click(function(event){
|
||||
$("#oegdproptin_deliveryaddress_error").hide();
|
||||
$("#oegdproptin_invoiceaddress_error").hide();
|
||||
|
||||
var success = true;
|
||||
if ( $('#oegdproptin_invoiceaddress').is(':visible') && $('#oegdproptin_invoiceaddress').is(':not(:checked)') )
|
||||
{
|
||||
event.preventDefault();
|
||||
$("#oegdproptin_invoiceaddress_error").show();
|
||||
}
|
||||
if ($('#oegdproptin_deliveryaddress').is(':visible') && $('#oegdproptin_deliveryaddress').is(':not(:checked)'))
|
||||
{
|
||||
event.preventDefault();
|
||||
$("#oegdproptin_deliveryaddress_error").show();
|
||||
}
|
||||
|
||||
$(this).submit();
|
||||
if (!success){
|
||||
return false;
|
||||
}
|
||||
});
|
||||
[{/strip}]
|
||||
[{/capture}]
|
||||
|
||||
[{oxscript add=$optinValidationJS}]
|
||||
|
||||
[{$smarty.block.parent}]
|
||||
@@ -0,0 +1,22 @@
|
||||
[{$smarty.block.parent}]
|
||||
|
||||
[{if !isset($oConfig)}]
|
||||
[{assign var="oConfig" value=$oViewConf->getConfig()}]
|
||||
[{/if}]
|
||||
|
||||
[{if true == $oConfig->getConfigParam('blOeGdprOptinInvoiceAddress')}]
|
||||
<div class="form-group[{if $Errors.oegdproptin_invoiceaddress}] oxInValid[{/if}]" id="GdprInvoiceAddressOptin" style="display: none;">
|
||||
<div class="col-lg-9 col-lg-offset-3 offset-lg-3">
|
||||
<div class="checkbox">
|
||||
<label for="oegdproptin_invoiceaddress">
|
||||
<input type="hidden" class="hidden" id="oegdproptin_changeInvAddress" name="oegdproptin_changeInvAddress" value="0">
|
||||
<input type="checkbox" name="oegdproptin_invoiceaddress" id="oegdproptin_invoiceaddress" value="1"> <strong>[{oxmultilang ident="OEGDPROPTIN_STORE_INVOICE_ADDRESS"}]</strong>
|
||||
</label>
|
||||
</div>
|
||||
</div>
|
||||
<div class="col-lg-9 col-lg-offset-3 offset-lg-3">
|
||||
<div id="oegdproptin_invoiceaddress_error" style="display:none;" class="text-danger">[{oxmultilang ident="OEGDPROPTIN_CONFIRM_STORE_INVOICE_ADDRESS" }]</div>
|
||||
<div class="help-block"></div>
|
||||
</div>
|
||||
</div>
|
||||
[{/if}]
|
||||
@@ -0,0 +1,59 @@
|
||||
[{if !isset($oConfig)}]
|
||||
[{assign var="oConfig" value=$oViewConf->getConfig()}]
|
||||
[{/if}]
|
||||
|
||||
[{$smarty.block.parent}]
|
||||
|
||||
[{if $oxcmp_user}]
|
||||
[{assign var="delivadr" value=$oxcmp_user->getSelectedAddress()}]
|
||||
[{/if}]
|
||||
|
||||
[{if true == $oConfig->getConfigParam('blOeGdprOptinDeliveryAddress')}]
|
||||
[{if $delivadr}]
|
||||
[{oxscript add="function toggleGdprOptinShipAddress() { $('#GdprOptinShipAddress, #shippingAddressForm').hide($(this).is(':checked'));}"}]
|
||||
[{oxscript add="$('#showShipAddress').change(toggleGdprOptinShipAddress);"}]
|
||||
[{oxscript add="toggleGdprOptinShipAddress.bind($('#showShipAddress')[0])();"}]
|
||||
[{oxscript add="$( '.dd-edit-shipping-address' ).click(function(){ $('#GdprOptinShipAddress').toggle($(this).is(':not(:checked)')); document.getElementById('oegdproptin_changeDelAddress').value=1; });"}]
|
||||
[{oxscript add="$( '.dd-add-delivery-address' ).click( function(){ $('#GdprOptinShipAddress').toggle($(this).is(':not(:checked)')); });"}]
|
||||
[{else}]
|
||||
[{oxscript add="function toggleGdprOptinShipAddress() { $('#GdprOptinShipAddress').toggle($(this).is(':not(:checked)'));}"}]
|
||||
[{oxscript add="toggleGdprOptinShipAddress.bind($('#showShipAddress')[0])();"}]
|
||||
[{oxscript add="$('#showShipAddress').change(toggleGdprOptinShipAddress);"}]
|
||||
[{/if}]
|
||||
[{/if}]
|
||||
|
||||
[{if true == $oConfig->getConfigParam('blOeGdprOptinInvoiceAddress')}]
|
||||
[{oxscript add="$('#userChangeAddress').click( function() { $('#GdprInvoiceAddressOptin').toggle();return false;});"}]
|
||||
[{/if}]
|
||||
|
||||
[{if !isset($oConfig)}]
|
||||
[{assign var="oConfig" value=$oViewConf->getConfig()}]
|
||||
[{/if}]
|
||||
|
||||
[{capture assign="optinValidationJS"}]
|
||||
[{strip}]
|
||||
$("#userNextStepBottom, #userNextStepTop").click(function(event){
|
||||
$("#oegdproptin_deliveryaddress_error").hide();
|
||||
$("#oegdproptin_invoiceaddress_error").hide();
|
||||
|
||||
var success = true;
|
||||
if ( $('#oegdproptin_invoiceaddress').is(':visible') && $('#oegdproptin_invoiceaddress').is(':not(:checked)') )
|
||||
{
|
||||
event.preventDefault();
|
||||
$("#oegdproptin_invoiceaddress_error").show();
|
||||
}
|
||||
if ($('#oegdproptin_deliveryaddress').is(':visible') && $('#oegdproptin_deliveryaddress').is(':not(:checked)'))
|
||||
{
|
||||
event.preventDefault();
|
||||
$("#oegdproptin_deliveryaddress_error").show();
|
||||
}
|
||||
|
||||
$(this).submit();
|
||||
if (!success){
|
||||
return false;
|
||||
}
|
||||
});
|
||||
[{/strip}]
|
||||
[{/capture}]
|
||||
|
||||
[{oxscript add=$optinValidationJS}]
|
||||
@@ -0,0 +1,22 @@
|
||||
[{$smarty.block.parent}]
|
||||
|
||||
[{if !isset($oConfig)}]
|
||||
[{assign var="oConfig" value=$oViewConf->getConfig()}]
|
||||
[{/if}]
|
||||
|
||||
[{if true == $oConfig->getConfigParam('blOeGdprOptinDeliveryAddress')}]
|
||||
<div class="form-group[{if $Errors.oegdproptin_deliveryaddress}] oxInValid[{/if}]" id="GdprOptinShipAddress" style="display: none;">
|
||||
<div class="col-lg-9 col-lg-offset-3 offset-lg-3">
|
||||
<div class="checkbox">
|
||||
<label for="oegdproptin_deliveryaddress">
|
||||
<input type="hidden" class="hidden" id="oegdproptin_changeDelAddress" name="oegdproptin_changeDelAddress" value="0">
|
||||
<input type="checkbox" name="oegdproptin_deliveryaddress" id="oegdproptin_deliveryaddress" value="1"> <strong>[{oxmultilang ident="OEGDPROPTIN_STORE_DELIVERY_ADDRESS"}]</strong>
|
||||
</label>
|
||||
</div>
|
||||
</div>
|
||||
<div class="col-lg-9 col-lg-offset-3 offset-lg-3">
|
||||
<div id="oegdproptin_deliveryaddress_error" style="display:none;" class="text-danger">[{oxmultilang ident="OEGDPROPTIN_CONFIRM_STORE_DELIVERY_ADDRESS" }]</div>
|
||||
<div class="help-block"></div>
|
||||
</div>
|
||||
</div>
|
||||
[{/if}]
|
||||
@@ -0,0 +1,21 @@
|
||||
[{$smarty.block.parent}]
|
||||
|
||||
[{if !isset($oConfig)}]
|
||||
[{assign var="oConfig" value=$oViewConf->getConfig()}]
|
||||
[{/if}]
|
||||
|
||||
[{if true == $oConfig->getConfigParam('blOeGdprOptinInvoiceAddress')}]
|
||||
<div class="clearfix"></div>
|
||||
<div id="GdprInvoiceAddressOptin" class="form-group" style="display: none;">
|
||||
<div class="col-lg-9 col-lg-offset-3 offset-lg-3">
|
||||
<div class="checkbox">
|
||||
<label class="req">
|
||||
<input type="hidden" class="hidden" id="oegdproptin_changeInvAddress" name="oegdproptin_changeInvAddress" value="0">
|
||||
<input type="checkbox" name="oegdproptin_invoiceaddress" id="oegdproptin_invoiceaddress" value="1" >
|
||||
<strong>[{oxmultilang ident="OEGDPROPTIN_STORE_INVOICE_ADDRESS"}]</strong>
|
||||
</label>
|
||||
</div>
|
||||
<div id="oegdproptin_invoiceaddress_error" style="display:none;" class="text-danger">[{oxmultilang ident="OEGDPROPTIN_CONFIRM_STORE_INVOICE_ADDRESS" }]</div>
|
||||
</div>
|
||||
</div>
|
||||
[{/if}]
|
||||
@@ -0,0 +1,25 @@
|
||||
[{if !isset($oConfig)}]
|
||||
[{assign var="oConfig" value=$oViewConf->getConfig()}]
|
||||
[{/if}]
|
||||
|
||||
[{$smarty.block.parent}]
|
||||
|
||||
[{if $oxcmp_user}]
|
||||
[{assign var="delivadr" value=$oxcmp_user->getSelectedAddress()}]
|
||||
[{/if}]
|
||||
|
||||
[{if true == $oConfig->getConfigParam('blOeGdprOptinDeliveryAddress')}]
|
||||
<div class="clearfix"></div>
|
||||
<div id="GdprShippingAddressOptin" class="form-group" style="[{if $delivadr || !$oView->showShipAddress()}]display: none;[{/if}]">
|
||||
<div class="col-lg-9 col-lg-offset-3 offset-lg-3">
|
||||
<div class="checkbox">
|
||||
<label class="req">
|
||||
<input type="hidden" class="hidden" id="oegdproptin_changeDelAddress" name="oegdproptin_changeDelAddress" value="0">
|
||||
<input type="checkbox" name="oegdproptin_deliveryaddress" id="oegdproptin_deliveryaddress" value="1" >
|
||||
<strong>[{oxmultilang ident="OEGDPROPTIN_STORE_DELIVERY_ADDRESS"}]</strong>
|
||||
</label>
|
||||
</div>
|
||||
<div id="oegdproptin_deliveryaddress_error" style="display:none;" class="text-danger">[{oxmultilang ident="OEGDPROPTIN_CONFIRM_USER_REGISTRATION_OPTIN" }]</div>
|
||||
</div>
|
||||
</div>
|
||||
[{/if}]
|
||||
@@ -0,0 +1,37 @@
|
||||
[{capture name="optInJs" assign="optInJs"}]
|
||||
$("#rvw_oegdproptin").parents("form").first().submit(function(event){
|
||||
event.preventDefault();
|
||||
$("#rvw_oegdproptin_error").addClass("hidden");
|
||||
|
||||
if ($("#rvw_oegdproptin:checked").length === 1) {
|
||||
this.submit();
|
||||
} else {
|
||||
$("#rvw_oegdproptin_error").removeClass("hidden");
|
||||
}
|
||||
});
|
||||
[{/capture}]
|
||||
|
||||
[{capture name="optIn" assign="optIn"}]
|
||||
[{if $oView->isReviewOptInValidationRequired()}]
|
||||
<div style="margin-top:10px;" class="rvw_oegdproptin_block">
|
||||
<input type="hidden" name="rvw_oegdproptin" value="0">
|
||||
<label for="rvw_oegdproptin">
|
||||
<input type="checkbox"
|
||||
name="rvw_oegdproptin"
|
||||
id="rvw_oegdproptin"
|
||||
value="1">
|
||||
<strong>[{oxmultilang ident="OEGDPROPTIN_REVIEW_FORM_MESSAGE" }]</strong>
|
||||
</label>
|
||||
|
||||
<div id="rvw_oegdproptin_error"
|
||||
class="[{if !$oView->isReviewOptInError()}]hidden [{/if}] text-danger">
|
||||
[{oxmultilang ident="OEGDPROPTIN_REVIEW_FORM_ERROR_MESSAGE" }]
|
||||
</div>
|
||||
</div>
|
||||
|
||||
[{oxscript add=$optInJs}]
|
||||
[{/if}]
|
||||
[{/capture}]
|
||||
|
||||
[{$smarty.block.parent}]
|
||||
[{$smarty.capture.optIn}]
|
||||
119
shop/source/modules/oe/gdproptin/CHANGELOG.md
Normal file
119
shop/source/modules/oe/gdproptin/CHANGELOG.md
Normal file
@@ -0,0 +1,119 @@
|
||||
# Change Log for O3-Shop GDPR Opt-In Module
|
||||
|
||||
All notable changes to this project will be documented in this file.
|
||||
The format is based on [Keep a Changelog](http://keepachangelog.com/)
|
||||
and this project adheres to [Semantic Versioning](http://semver.org/).
|
||||
|
||||
## [unreleased]
|
||||
|
||||
## [v1.0.1] - 2023-04-25
|
||||
|
||||
### Changed
|
||||
- annotate class instance to prevent IDE error messages
|
||||
|
||||
## [v1.0.0] - 2023-03-05
|
||||
|
||||
# [O3-Shop]
|
||||
|
||||
> All changes from this moment on will be published as O3-Shop.
|
||||
> Earlier code components were created by OXID eSales AG and published under the GNU General Public License v3.0.
|
||||
|
||||
> The version number is reset to 1.0.0. All references to version numbers refer to the new versioning.
|
||||
|
||||
* * * * * * * * * *
|
||||
|
||||
## [v2.3.3] - 2021-04-09
|
||||
|
||||
### Fixed
|
||||
- Fix tests for 6.3 compilation testing library
|
||||
|
||||
## [v2.3.2] - 2021-03-12
|
||||
|
||||
### Fixed
|
||||
- Remove deprecated getSession method usage
|
||||
- Renamed language files to be coherent with other modules naming [PR-9](https://github.com/OXID-eSales/gdpr-optin-module/pull/9)
|
||||
|
||||
## [v2.3.1] - 2020-07-08
|
||||
|
||||
### Changed
|
||||
- Improved the documentation
|
||||
|
||||
## [v2.3.0] - 2019-10-22
|
||||
|
||||
### Changed
|
||||
- Dropped support for PHP 7.0.
|
||||
|
||||
## [v2.2.2] - 2020-11-27
|
||||
|
||||
### Changed
|
||||
- Documentation was removed from repository. Check readme file for the new documentation location.
|
||||
|
||||
### Fixed
|
||||
- Fixed compatibility section in readme
|
||||
|
||||
## [v2.2.1] - 2019-10-21
|
||||
|
||||
### Fixed
|
||||
- Add checkboxes offset class for wave theme in registration, billing and shipping forms
|
||||
- Fix checkboxes highlight on click (green text) in registration form to work separately for each checkbox.
|
||||
- Module version number is now correct.
|
||||
|
||||
## [v2.2.0] - 2019-07-12
|
||||
|
||||
### Added
|
||||
- Column witdth is now flexible in contact form [PR-8](https://github.com/OXID-eSales/gdpr-optin-module/pull/8)
|
||||
|
||||
### Changed
|
||||
- Dropped support for PHP 5.6.
|
||||
|
||||
### Fixed
|
||||
- Check if checkbox should be visible on load [PR-7](https://github.com/OXID-eSales/gdpr-optin-module/pull/7)
|
||||
|
||||
## [v2.1.2] - 2018-10-11
|
||||
|
||||
### Fixed
|
||||
- Fix unclosed "<strong>" elements [PR-6](https://github.com/OXID-eSales/gdpr-optin-module/pull/6)
|
||||
- Remove unnecessary "checkbox" class usage [PR-6](https://github.com/OXID-eSales/gdpr-optin-module/pull/6)
|
||||
|
||||
## [v2.1.1] - 2018-07-06
|
||||
|
||||
### Changed
|
||||
- Use dropdown instead of radio buttons for contact form module settings.
|
||||
|
||||
## [v2.1.0] - 2018-05-07
|
||||
|
||||
### Added
|
||||
- Added opt-in for updating invoice address.
|
||||
* New module setting blOeGdprOptinInvoiceAddress.
|
||||
* Application/views/blocks/user_checkout_billing_feedback.tpl
|
||||
* Application/views/blocks/user_invoice_address_form.tpl
|
||||
|
||||
### Changed
|
||||
- The following templates have been changed
|
||||
* Application/views/blocks/user_shipping_address.tpl renamed to Application/views/blocks/user_address.tpl
|
||||
* Application/views/blocks/user_checkout_shipping_change.tpl renamed to Application/views/blocks/user_checkout_change.tpl
|
||||
* Application/views/blocks/user.tpl
|
||||
* Application/views/blocks/user_shipping_address_form.tpl
|
||||
* Application/views/blocks/user_checkout_shipping_feedback.tpl
|
||||
- Documentation was updated.
|
||||
|
||||
## [v2.0.0] - 2018-04-06
|
||||
|
||||
### Changed
|
||||
- The GDPR Opt-In Module was fully ported as described in
|
||||
[modules porting guide](https://docs.oxid-esales.com/developer/en/6.0/update/eshop_from_53_to_6/modules.html).
|
||||
|
||||
[v1.0.1]: https://gitlab.o3-shop.com/o3/gdpr-optin-module/-/compare/v1.0.0...v1.0.1
|
||||
[v1.0.0]: https://gitlab.o3-shop.com/o3/gdpr-optin-module/-/tags/v1.0.0
|
||||
[O3-Shop]: https://www.o3-shop.com/
|
||||
[v2.3.3]: https://github.com/OXID-eSales/gdpr-optin-module/compare/v2.3.2...v2.3.3
|
||||
[v2.3.2]: https://github.com/OXID-eSales/gdpr-optin-module/compare/v2.3.1...v2.3.2
|
||||
[v2.3.1]: https://github.com/OXID-eSales/gdpr-optin-module/compare/v2.3.0...v2.3.1
|
||||
[v2.3.0]: https://github.com/OXID-eSales/gdpr-optin-module/compare/v2.2.1...v2.3.0
|
||||
[v2.2.2]: https://github.com/OXID-eSales/gdpr-optin-module/compare/v2.2.1...v2.2.2
|
||||
[v2.2.1]: https://github.com/OXID-eSales/gdpr-optin-module/compare/v2.2.0...v2.2.1
|
||||
[v2.2.0]: https://github.com/OXID-eSales/gdpr-optin-module/compare/v2.1.2...v2.2.0
|
||||
[v2.1.2]: https://github.com/OXID-eSales/gdpr-optin-module/compare/v2.1.1...v2.1.2
|
||||
[v2.1.1]: https://github.com/OXID-eSales/gdpr-optin-module/compare/v2.1.0...v2.1.1
|
||||
[v2.1.0]: https://github.com/OXID-eSales/gdpr-optin-module/compare/v2.0.0...v2.1.0
|
||||
[v2.0.0]: https://github.com/OXID-eSales/gdpr-optin-module/compare/v1.0.0...v2.0.0
|
||||
170
shop/source/modules/oe/gdproptin/Component/UserComponent.php
Normal file
170
shop/source/modules/oe/gdproptin/Component/UserComponent.php
Normal file
@@ -0,0 +1,170 @@
|
||||
<?php
|
||||
/**
|
||||
* This file is part of O3-Shop GDPR opt-in module.
|
||||
*
|
||||
* O3-Shop is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, version 3.
|
||||
*
|
||||
* O3-Shop is distributed in the hope that it will be useful, but
|
||||
* WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||
* General Public License for more details.
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with O3-Shop. If not, see <http://www.gnu.org/licenses/>
|
||||
*
|
||||
* @copyright Copyright (c) 2022 OXID eSales AG (https://www.oxid-esales.com)
|
||||
* @copyright Copyright (c) 2022 O3-Shop (https://www.o3-shop.com)
|
||||
* @license https://www.gnu.org/licenses/gpl-3.0 GNU General Public License 3 (GPLv3)
|
||||
*/
|
||||
|
||||
namespace OxidEsales\GdprOptinModule\Component;
|
||||
|
||||
/**
|
||||
* Class oeGdprOptinOxcmp_user.
|
||||
* Extends oxcmp_user.
|
||||
*
|
||||
* @see \OxidEsales\Eshop\Application\Component\UserComponent
|
||||
*/
|
||||
class UserComponent extends UserComponent_parent
|
||||
{
|
||||
/**
|
||||
* Create new user.
|
||||
*
|
||||
* @return mixed
|
||||
*/
|
||||
public function createUser()
|
||||
{
|
||||
if (false == $this->validateRegistrationOptin()) {
|
||||
//show error message on submit but not on page reload.
|
||||
if ($this->getRequestParameter('stoken')) {
|
||||
\OxidEsales\Eshop\Core\Registry::get(\OxidEsales\Eshop\Core\UtilsView::class)->addErrorToDisplay('OEGDPROPTIN_CONFIRM_USER_REGISTRATION_OPTIN', false, true);
|
||||
\OxidEsales\Eshop\Core\Registry::get(\OxidEsales\Eshop\Core\UtilsView::class)->addErrorToDisplay('OEGDPROPTIN_CONFIRM_USER_REGISTRATION_OPTIN', false, true, 'oegdproptin_userregistration');
|
||||
}
|
||||
} else {
|
||||
return parent::createUser();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Mostly used for customer profile editing screen (O3-Shop ->
|
||||
* MY ACCOUNT). Checks if oUser is set (\OxidEsales\Eshop\Application\Component\UserComponent::oUser) - if
|
||||
* not - executes \OxidEsales\Eshop\Application\Component\UserComponent::_loadSessionUser(). If user unchecked newsletter
|
||||
* subscription option - removes him from this group. There is an
|
||||
* additional MUST FILL fields checking. Function returns true or false
|
||||
* according to user data submission status.
|
||||
*
|
||||
* Session variables:
|
||||
* <b>ordrem</b>
|
||||
*
|
||||
* @return bool true on success, false otherwise
|
||||
*/
|
||||
protected function _changeUser_noRedirect()
|
||||
{
|
||||
$session = \OxidEsales\Eshop\Core\Registry::getSession();
|
||||
if (!$session->checkSessionChallenge()) {
|
||||
return;
|
||||
}
|
||||
|
||||
// no user ?
|
||||
$user = $this->getUser();
|
||||
if (!$user) {
|
||||
return;
|
||||
}
|
||||
|
||||
$deliveryOptinValid = $this->validateDeliveryAddressOptIn();
|
||||
$invoiceOptinValid = $this->validateInvoiceAddressOptIn();
|
||||
|
||||
if (false == $deliveryOptinValid) {
|
||||
\OxidEsales\Eshop\Core\Registry::get(\OxidEsales\Eshop\Core\UtilsView::class)->addErrorToDisplay('OEGDPROPTIN_CONFIRM_STORE_DELIVERY_ADDRESS', false, true);
|
||||
\OxidEsales\Eshop\Core\Registry::get(\OxidEsales\Eshop\Core\UtilsView::class)->addErrorToDisplay('OEGDPROPTIN_CONFIRM_STORE_DELIVERY_ADDRESS', false, true, 'oegdproptin_deliveryaddress');
|
||||
}
|
||||
if (false == $invoiceOptinValid) {
|
||||
\OxidEsales\Eshop\Core\Registry::get(\OxidEsales\Eshop\Core\UtilsView::class)->addErrorToDisplay('OEGDPROPTIN_CONFIRM_STORE_INVOICE_ADDRESS', false, true);
|
||||
\OxidEsales\Eshop\Core\Registry::get(\OxidEsales\Eshop\Core\UtilsView::class)->addErrorToDisplay('OEGDPROPTIN_CONFIRM_STORE_INVOICE_ADDRESS', false, true, 'oegdproptin_invoiceaddress');
|
||||
}
|
||||
|
||||
$return = false;
|
||||
if ( (true == $deliveryOptinValid) && (true == $invoiceOptinValid)) {
|
||||
$return = parent::_changeUser_noRedirect();
|
||||
}
|
||||
|
||||
return $return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Validate delivery address optin.
|
||||
* Needed if we get delivery address data from request.
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
protected function validateDeliveryAddressOptIn()
|
||||
{
|
||||
$return = true;
|
||||
$optin = (int) $this->getRequestParameter('oegdproptin_deliveryaddress');
|
||||
$changeExistigAddress = (int) $this->getRequestParameter('oegdproptin_changeDelAddress');
|
||||
$addressId = $this->getRequestParameter('oxaddressid');
|
||||
$deliveryAddressData = $this->_getDelAddressData();
|
||||
|
||||
if (\OxidEsales\Eshop\Core\Registry::getConfig()->getConfigParam('blOeGdprOptinDeliveryAddress')
|
||||
&& ((null == $addressId) || ('-1' == $addressId) || (1 == $changeExistigAddress))
|
||||
&& !empty($deliveryAddressData)
|
||||
&& (1 !== $optin)
|
||||
) {
|
||||
$return = false;
|
||||
}
|
||||
return $return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Validate user registration optin.
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
protected function validateRegistrationOptin()
|
||||
{
|
||||
$return = true;
|
||||
$optin = (int) $this->getRequestParameter('oegdproptin_userregistration');
|
||||
//1 is for guest buy, 3 for account creation
|
||||
$registrationOption = (int) $this->getRequestParameter('option');
|
||||
if (\OxidEsales\Eshop\Core\Registry::getConfig()->getConfigParam('blOeGdprOptinUserRegistration') && (3 == $registrationOption) && (1 !== $optin)) {
|
||||
$return = false;
|
||||
}
|
||||
return $return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Validate invoice address optin.
|
||||
* Needed if user changes invoice address.
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
protected function validateInvoiceAddressOptIn()
|
||||
{
|
||||
$return = true;
|
||||
$optin = (int) $this->getRequestParameter('oegdproptin_invoiceaddress');
|
||||
$changeExistigAddress = (int) $this->getRequestParameter('oegdproptin_changeInvAddress');
|
||||
|
||||
if (\OxidEsales\Eshop\Core\Registry::getConfig()->getConfigParam('blOeGdprOptinInvoiceAddress')
|
||||
&& (1 == $changeExistigAddress)
|
||||
&& (1 !== $optin)
|
||||
) {
|
||||
$return = false;
|
||||
}
|
||||
return $return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Wrapper for \OxidEsales\Eshop\Core\Request::getRequestParameter()
|
||||
*
|
||||
* @param string $name Parameter name
|
||||
*
|
||||
* @return mixed
|
||||
*/
|
||||
protected function getRequestParameter($name)
|
||||
{
|
||||
$request = \OxidEsales\Eshop\Core\Registry::get(\OxidEsales\Eshop\Core\Request::class);
|
||||
|
||||
return $request->getRequestParameter($name);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,53 @@
|
||||
<?php
|
||||
/**
|
||||
* This file is part of O3-Shop GDPR opt-in module.
|
||||
*
|
||||
* O3-Shop is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, version 3.
|
||||
*
|
||||
* O3-Shop is distributed in the hope that it will be useful, but
|
||||
* WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||
* General Public License for more details.
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with O3-Shop. If not, see <http://www.gnu.org/licenses/>
|
||||
*
|
||||
* @copyright Copyright (c) 2022 OXID eSales AG (https://www.oxid-esales.com)
|
||||
* @copyright Copyright (c) 2022 O3-Shop (https://www.o3-shop.com)
|
||||
* @license https://www.gnu.org/licenses/gpl-3.0 GNU General Public License 3 (GPLv3)
|
||||
*/
|
||||
|
||||
namespace OxidEsales\GdprOptinModule\Component\Widget;
|
||||
|
||||
/**
|
||||
* Class ArticleDetails
|
||||
* Extends \OxidEsales\Eshop\Application\Component\Widget\ArticleDetails
|
||||
*
|
||||
* @package OxidEsales\GdprOptinModule\Component\Widget
|
||||
* @see \OxidEsales\Eshop\Application\Component\Widget\ArticleDetails
|
||||
*/
|
||||
class ArticleDetails extends ArticleDetails_parent
|
||||
{
|
||||
/**
|
||||
* Is optin for product review required.
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function isReviewOptInValidationRequired()
|
||||
{
|
||||
$review = oxNew(\OxidEsales\Eshop\Application\Controller\ReviewController::class);
|
||||
return $review->isReviewOptInValidationRequired();
|
||||
}
|
||||
|
||||
/**
|
||||
* Was there an error for shop side review optin validation?
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function isReviewOptInError()
|
||||
{
|
||||
$review = oxNew(\OxidEsales\Eshop\Application\Controller\ReviewController::class);
|
||||
return $review->isReviewOptInError();
|
||||
}
|
||||
}
|
||||
53
shop/source/modules/oe/gdproptin/Component/Widget/Review.php
Normal file
53
shop/source/modules/oe/gdproptin/Component/Widget/Review.php
Normal file
@@ -0,0 +1,53 @@
|
||||
<?php
|
||||
/**
|
||||
* This file is part of O3-Shop GDPR opt-in module.
|
||||
*
|
||||
* O3-Shop is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, version 3.
|
||||
*
|
||||
* O3-Shop is distributed in the hope that it will be useful, but
|
||||
* WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||
* General Public License for more details.
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with O3-Shop. If not, see <http://www.gnu.org/licenses/>
|
||||
*
|
||||
* @copyright Copyright (c) 2022 OXID eSales AG (https://www.oxid-esales.com)
|
||||
* @copyright Copyright (c) 2022 O3-Shop (https://www.o3-shop.com)
|
||||
* @license https://www.gnu.org/licenses/gpl-3.0 GNU General Public License 3 (GPLv3)
|
||||
*/
|
||||
|
||||
namespace OxidEsales\GdprOptinModule\Component\Widget;
|
||||
|
||||
/**
|
||||
* Class Review
|
||||
* Extends \OxidEsales\Eshop\Application\Component\Widget\Review.
|
||||
*
|
||||
* @package OxidEsales\GdprOptinModule\Component\Widget
|
||||
* @see \OxidEsales\Eshop\Application\Component\Widget\Review
|
||||
*/
|
||||
class Review extends Review_parent
|
||||
{
|
||||
/**
|
||||
* Is optin for product review required.
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function isReviewOptInValidationRequired()
|
||||
{
|
||||
$review = oxNew(\OxidEsales\Eshop\Application\Controller\ReviewController::class);
|
||||
return $review->isReviewOptInValidationRequired();
|
||||
}
|
||||
|
||||
/**
|
||||
* Was there an error for shop side review optin validation?
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function isReviewOptInError()
|
||||
{
|
||||
$review = oxNew(\OxidEsales\Eshop\Application\Controller\ReviewController::class);
|
||||
return $review->isReviewOptInError();
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,47 @@
|
||||
<?php
|
||||
/**
|
||||
* This file is part of O3-Shop GDPR opt-in module.
|
||||
*
|
||||
* O3-Shop is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, version 3.
|
||||
*
|
||||
* O3-Shop is distributed in the hope that it will be useful, but
|
||||
* WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||
* General Public License for more details.
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with O3-Shop. If not, see <http://www.gnu.org/licenses/>
|
||||
*
|
||||
* @copyright Copyright (c) 2022 OXID eSales AG (https://www.oxid-esales.com)
|
||||
* @copyright Copyright (c) 2022 O3-Shop (https://www.o3-shop.com)
|
||||
* @license https://www.gnu.org/licenses/gpl-3.0 GNU General Public License 3 (GPLv3)
|
||||
*/
|
||||
|
||||
namespace OxidEsales\GdprOptinModule\Controller;
|
||||
|
||||
/**
|
||||
* Class ArticleDetailsController
|
||||
* Extends \OxidEsales\Eshop\Application\Controller\ArticleDetailsController.
|
||||
*
|
||||
* @package OxidEsales\GdprOptinModule\Controller
|
||||
* @see \OxidEsales\Eshop\Application\Controller\ArticleDetailsController
|
||||
*/
|
||||
class ArticleDetailsController extends ArticleDetailsController_parent
|
||||
{
|
||||
/**
|
||||
* Saves user ratings and review text (oxReview object)
|
||||
*
|
||||
* @return null
|
||||
*/
|
||||
public function saveReview()
|
||||
{
|
||||
$reviewController = oxNew(\OxidEsales\Eshop\Application\Controller\ReviewController::class);
|
||||
if (!$reviewController->validateOptIn()) {
|
||||
\OxidEsales\Eshop\Core\Registry::get(\OxidEsales\Eshop\Core\UtilsView::class)->addErrorToDisplay('OEGDPROPTIN_REVIEW_FORM_ERROR_MESSAGE');
|
||||
return false;
|
||||
}
|
||||
|
||||
return parent::saveReview();
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,92 @@
|
||||
<?php
|
||||
/**
|
||||
* This file is part of O3-Shop GDPR opt-in module.
|
||||
*
|
||||
* O3-Shop is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, version 3.
|
||||
*
|
||||
* O3-Shop is distributed in the hope that it will be useful, but
|
||||
* WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||
* General Public License for more details.
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with O3-Shop. If not, see <http://www.gnu.org/licenses/>
|
||||
*
|
||||
* @copyright Copyright (c) 2022 OXID eSales AG (https://www.oxid-esales.com)
|
||||
* @copyright Copyright (c) 2022 O3-Shop (https://www.o3-shop.com)
|
||||
* @license https://www.gnu.org/licenses/gpl-3.0 GNU General Public License 3 (GPLv3)
|
||||
*/
|
||||
|
||||
namespace OxidEsales\GdprOptinModule\Controller;
|
||||
|
||||
/**
|
||||
* Class ContactController
|
||||
* Extends \OxidEsales\Eshop\Application\Controller\ContactController
|
||||
*
|
||||
* @package OxidEsales\GdprOptinModule\Controller
|
||||
*/
|
||||
class ContactController extends ContactController_parent
|
||||
{
|
||||
const CONTACT_FORM_METHOD_DEFAULT = 'deletion';
|
||||
|
||||
/**
|
||||
* Flag which shows if validation failed because of optin is not checked
|
||||
*
|
||||
* @var bool
|
||||
*/
|
||||
protected $optInError = false;
|
||||
|
||||
/**
|
||||
* Validation and contacts email sending
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function send()
|
||||
{
|
||||
$optInValue = \OxidEsales\Eshop\Core\Registry::getConfig()->getRequestParameter('c_oegdproptin');
|
||||
if ($this->isOptInValidationRequired() && !$optInValue) {
|
||||
\OxidEsales\Eshop\Core\Registry::get(\OxidEsales\Eshop\Core\UtilsView::class)->addErrorToDisplay('OEGDPROPTIN_CONTACT_FORM_ERROR_MESSAGE');
|
||||
$this->optInError = true;
|
||||
return false;
|
||||
}
|
||||
|
||||
return parent::send();
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if validation failed because of the optin checkbox not checked
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function isOptInError()
|
||||
{
|
||||
return $this->optInError;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if opt in validation is required.
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function isOptInValidationRequired()
|
||||
{
|
||||
return $this->getContactFormMethod() != self::CONTACT_FORM_METHOD_DEFAULT;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get currently selected contact form opt in method
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
private function getContactFormMethod()
|
||||
{
|
||||
$method = self::CONTACT_FORM_METHOD_DEFAULT;
|
||||
|
||||
if ($configMethod = \OxidEsales\Eshop\Core\Registry::getConfig()->getConfigParam('OeGdprOptinContactFormMethod')) {
|
||||
$method = $configMethod;
|
||||
}
|
||||
|
||||
return $method;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,91 @@
|
||||
<?php
|
||||
/**
|
||||
* This file is part of O3-Shop GDPR opt-in module.
|
||||
*
|
||||
* O3-Shop is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, version 3.
|
||||
*
|
||||
* O3-Shop is distributed in the hope that it will be useful, but
|
||||
* WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||
* General Public License for more details.
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with O3-Shop. If not, see <http://www.gnu.org/licenses/>
|
||||
*
|
||||
* @copyright Copyright (c) 2022 OXID eSales AG (https://www.oxid-esales.com)
|
||||
* @copyright Copyright (c) 2022 O3-Shop (https://www.o3-shop.com)
|
||||
* @license https://www.gnu.org/licenses/gpl-3.0 GNU General Public License 3 (GPLv3)
|
||||
*/
|
||||
|
||||
namespace OxidEsales\GdprOptinModule\Controller;
|
||||
|
||||
/**
|
||||
* Class ReviewController
|
||||
* Extends \OxidEsales\Eshop\Application\Controller\ArticleDetailsController.
|
||||
*
|
||||
* @package OxidEsales\GdprOptinModule\Controller
|
||||
* @see \OxidEsales\Eshop\Application\Controller\ArticleDetailsController
|
||||
*/
|
||||
class ReviewController extends ReviewController_parent
|
||||
{
|
||||
const REVIEW_OPTIN_PARAM = 'blOeGdprOptinProductReviews';
|
||||
|
||||
/**
|
||||
* Saves user ratings and review text (oxReview object)
|
||||
*
|
||||
* @return null
|
||||
*/
|
||||
public function saveReview()
|
||||
{
|
||||
if (!$this->validateOptIn()) {
|
||||
\OxidEsales\Eshop\Core\Registry::get(\OxidEsales\Eshop\Core\UtilsView::class)->addErrorToDisplay('OEGDPROPTIN_REVIEW_FORM_ERROR_MESSAGE');
|
||||
return false;
|
||||
}
|
||||
|
||||
return parent::saveReview();
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if opt in validation for review is required.
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function isReviewOptInValidationRequired()
|
||||
{
|
||||
return (bool)\OxidEsales\Eshop\Core\Registry::getConfig()->getConfigParam(self::REVIEW_OPTIN_PARAM);
|
||||
}
|
||||
|
||||
/**
|
||||
* Validate current request data, regardless if form was submitted or not
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function validateOptIn()
|
||||
{
|
||||
$optInValue = \OxidEsales\Eshop\Core\Registry::getConfig()->getRequestParameter('rvw_oegdproptin');
|
||||
if ($this->isReviewOptInValidationRequired() && !$optInValue) {
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if form was sent but optin not checked when required
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function isReviewOptInError()
|
||||
{
|
||||
$formSent = \OxidEsales\Eshop\Core\Registry::getConfig()->getRequestParameter('rvw_oegdproptin') !== null;
|
||||
$review = oxNew(\OxidEsales\Eshop\Application\Controller\ReviewController::class);
|
||||
$result = false;
|
||||
|
||||
if ($formSent && !$review->validateOptIn()) {
|
||||
$result = true;
|
||||
}
|
||||
|
||||
return $result;
|
||||
}
|
||||
}
|
||||
131
shop/source/modules/oe/gdproptin/Core/GdprOptinModule.php
Normal file
131
shop/source/modules/oe/gdproptin/Core/GdprOptinModule.php
Normal file
@@ -0,0 +1,131 @@
|
||||
<?php
|
||||
/**
|
||||
* This file is part of O3-Shop GDPR opt-in module.
|
||||
*
|
||||
* O3-Shop is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, version 3.
|
||||
*
|
||||
* O3-Shop is distributed in the hope that it will be useful, but
|
||||
* WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||
* General Public License for more details.
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with O3-Shop. If not, see <http://www.gnu.org/licenses/>
|
||||
*
|
||||
* @copyright Copyright (c) 2022 OXID eSales AG (https://www.oxid-esales.com)
|
||||
* @copyright Copyright (c) 2022 O3-Shop (https://www.o3-shop.com)
|
||||
* @license https://www.gnu.org/licenses/gpl-3.0 GNU General Public License 3 (GPLv3)
|
||||
*/
|
||||
|
||||
namespace OxidEsales\GdprOptinModule\Core;
|
||||
|
||||
/**
|
||||
* Class GdprOptinModule
|
||||
* Handles module setup, provides additional tools and module related helpers.
|
||||
*
|
||||
* @codeCoverageIgnore
|
||||
*
|
||||
* @package OxidEsales\GdprOptinModule\Core
|
||||
*/
|
||||
class GdprOptinModule extends \OxidEsales\Eshop\Core\Module\Module
|
||||
{
|
||||
/**
|
||||
* Class constructor.
|
||||
* Sets current module main data and loads the rest module info.
|
||||
*/
|
||||
public function __construct()
|
||||
{
|
||||
$moduleId = 'oegdproptin';
|
||||
|
||||
$this->setModuleData(
|
||||
[
|
||||
'id' => $moduleId,
|
||||
'title' => 'oegdproptin',
|
||||
'description' => 'OE GDPR opt-in Module',
|
||||
]
|
||||
);
|
||||
|
||||
$this->load($moduleId);
|
||||
|
||||
\OxidEsales\Eshop\Core\Registry::set('oeGdprOptinModule', $this);
|
||||
}
|
||||
|
||||
/**
|
||||
* Module activation script.
|
||||
*/
|
||||
public static function onActivate()
|
||||
{
|
||||
self::clearTmp();
|
||||
}
|
||||
|
||||
/**
|
||||
* Module deactivation script.
|
||||
*/
|
||||
public static function onDeactivate()
|
||||
{
|
||||
self::clearTmp();
|
||||
}
|
||||
|
||||
/**
|
||||
* Clean temp folder content.
|
||||
*
|
||||
* @param string $clearFolderPath Sub-folder path to delete from. Should be a full, valid path inside temp folder.
|
||||
*
|
||||
* @return boolean
|
||||
*/
|
||||
public static function clearTmp($clearFolderPath = '')
|
||||
{
|
||||
$folderPath = self::_getFolderToClear($clearFolderPath);
|
||||
$directoryHandler = opendir($folderPath);
|
||||
|
||||
if (!empty($directoryHandler)) {
|
||||
while (false !== ($fileName = readdir($directoryHandler))) {
|
||||
$filePath = $folderPath . DIRECTORY_SEPARATOR . $fileName;
|
||||
self::_clear($fileName, $filePath);
|
||||
}
|
||||
|
||||
closedir($directoryHandler);
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if provided path is inside Shop `tpm/` folder or use the `tmp/` folder path.
|
||||
*
|
||||
* @param string $clearFolderPath
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
protected static function _getFolderToClear($clearFolderPath = '')
|
||||
{
|
||||
$templateFolderPath = (string) \OxidEsales\Eshop\Core\Registry::getConfig()->getConfigParam('sCompileDir');
|
||||
|
||||
if (!empty($clearFolderPath) and (strpos($clearFolderPath, $templateFolderPath) !== false)) {
|
||||
$folderPath = $clearFolderPath;
|
||||
} else {
|
||||
$folderPath = $templateFolderPath;
|
||||
}
|
||||
|
||||
return $folderPath;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if resource could be deleted, then delete it's a file or
|
||||
* call recursive folder deletion if it's a directory.
|
||||
*
|
||||
* @param string $fileName
|
||||
* @param string $filePath
|
||||
*/
|
||||
protected static function _clear($fileName, $filePath)
|
||||
{
|
||||
if (!in_array($fileName, ['.', '..', '.gitkeep', '.htaccess'])) {
|
||||
if (is_file($filePath)) {
|
||||
@unlink($filePath);
|
||||
} else {
|
||||
self::clearTmp($filePath);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
674
shop/source/modules/oe/gdproptin/LICENSE
Normal file
674
shop/source/modules/oe/gdproptin/LICENSE
Normal file
@@ -0,0 +1,674 @@
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||
29
shop/source/modules/oe/gdproptin/README.md
Normal file
29
shop/source/modules/oe/gdproptin/README.md
Normal file
@@ -0,0 +1,29 @@
|
||||
GDPR opt-in module
|
||||
==================
|
||||
|
||||
Module adds opt-in functionality which is required for GDPR law.
|
||||
|
||||
### Installation
|
||||
|
||||
System requirements and installation instructions are described in the module documentation: https://docs.o3-shop.com/modules/gdpr-optin/de/2.3/installation.html.
|
||||
|
||||
### Module installation via composer
|
||||
|
||||
* **composer require o3-shop/gdpr-optin-module:^1.0** to install the released version compatible with O3-Shop 1.x compilation
|
||||
|
||||
### Features
|
||||
|
||||
Module allows to control:
|
||||
* the opt-in option for delivery addresses to be conform with GDPR
|
||||
* the opt-in option for user registration to be conform with GDPR
|
||||
* the opt-in option for review writing form to be conform with GDPR
|
||||
* the information customer is shown regarding what happens to the contact form data
|
||||
after the request has been processed.
|
||||
|
||||
### Bugs and Issues
|
||||
|
||||
If you experience any bugs or issues, please report them in the section **Module GDPR Opt-in** of https://issues.o3-shop.com.
|
||||
|
||||
### Documentation
|
||||
|
||||
The module documentation can be found on our documentation platform: https://docs.o3-shop.com/modules/gdpr-optin/de/2.3/index.html.
|
||||
@@ -0,0 +1,66 @@
|
||||
<?php
|
||||
/**
|
||||
* This file is part of O3-Shop GDPR opt-in module.
|
||||
*
|
||||
* O3-Shop is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, version 3.
|
||||
*
|
||||
* O3-Shop is distributed in the hope that it will be useful, but
|
||||
* WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||
* General Public License for more details.
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with O3-Shop. If not, see <http://www.gnu.org/licenses/>
|
||||
*
|
||||
* @copyright Copyright (c) 2022 OXID eSales AG (https://www.oxid-esales.com)
|
||||
* @copyright Copyright (c) 2022 O3-Shop (https://www.o3-shop.com)
|
||||
* @license https://www.gnu.org/licenses/gpl-3.0 GNU General Public License 3 (GPLv3)
|
||||
*/
|
||||
|
||||
namespace OxidEsales\GdprOptinModule\Tests\Integration;
|
||||
|
||||
/**
|
||||
* Class ContactControllerTest
|
||||
*
|
||||
* @package OxidEsales\GdprOptinModule\Tests\Integration
|
||||
*/
|
||||
class ContactControllerTest extends \OxidEsales\TestingLibrary\UnitTestCase
|
||||
{
|
||||
/**
|
||||
* Test checkbox validation.
|
||||
*
|
||||
* @dataProvider dataProviderOptInValidationRequired
|
||||
*/
|
||||
public function testOptInValidationRequired($configValue, $expected)
|
||||
{
|
||||
\OxidEsales\Eshop\Core\Registry::getConfig()->setConfigParam('OeGdprOptinContactFormMethod', $configValue);
|
||||
|
||||
$controller = oxNew(\OxidEsales\Eshop\Application\Controller\ContactController::class);
|
||||
$this->assertSame($expected, $controller->isOptInValidationRequired());
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array
|
||||
*/
|
||||
public function dataProviderOptInValidationRequired()
|
||||
{
|
||||
return [
|
||||
'formMethod-deletion' => ['deletion', false],
|
||||
'formMethod-statistical' => ['statistical', true],
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Test validation error appears if needed
|
||||
*/
|
||||
public function testSendError()
|
||||
{
|
||||
\OxidEsales\Eshop\Core\Registry::getConfig()->setConfigParam('OeGdprOptinContactFormMethod', "statistical");
|
||||
|
||||
$controller = oxNew(\OxidEsales\Eshop\Application\Controller\ContactController::class);
|
||||
$this->assertFalse($controller->isOptInError());
|
||||
$this->assertFalse($controller->send());
|
||||
$this->assertTrue($controller->isOptInError());
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,536 @@
|
||||
<?php
|
||||
/**
|
||||
* This file is part of O3-Shop GDPR opt-in module.
|
||||
*
|
||||
* O3-Shop is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, version 3.
|
||||
*
|
||||
* O3-Shop is distributed in the hope that it will be useful, but
|
||||
* WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||
* General Public License for more details.
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with O3-Shop. If not, see <http://www.gnu.org/licenses/>
|
||||
*
|
||||
* @copyright Copyright (c) 2022 OXID eSales AG (https://www.oxid-esales.com)
|
||||
* @copyright Copyright (c) 2022 O3-Shop (https://www.o3-shop.com)
|
||||
* @license https://www.gnu.org/licenses/gpl-3.0 GNU General Public License 3 (GPLv3)
|
||||
*/
|
||||
|
||||
namespace OxidEsales\GdprOptinModule\Tests\Integration;
|
||||
|
||||
use OxidEsales\Eshop\Application\Component\BasketComponent;
|
||||
use OxidEsales\Eshop\Application\Component\Widget\ArticleDetails;
|
||||
use OxidEsales\Eshop\Application\Controller\AccountUserController;
|
||||
use OxidEsales\Eshop\Application\Controller\ContactController;
|
||||
use OxidEsales\Eshop\Application\Controller\RegisterController;
|
||||
use OxidEsales\Eshop\Application\Controller\UserController;
|
||||
use OxidEsales\Eshop\Application\Model\Article;
|
||||
use OxidEsales\Eshop\Application\Model\Basket;
|
||||
use OxidEsales\Eshop\Application\Model\User;
|
||||
use OxidEsales\Eshop\Core\DatabaseProvider;
|
||||
use OxidEsales\Eshop\Core\Field;
|
||||
use OxidEsales\Eshop\Core\Output;
|
||||
use OxidEsales\Eshop\Core\Registry;
|
||||
use OxidEsales\Eshop\Core\UtilsView;
|
||||
use OxidEsales\TestingLibrary\UnitTestCase;
|
||||
|
||||
/**
|
||||
* Class FrontendTest
|
||||
*
|
||||
* @package OxidEsales\GdprOptinModule\Tests\Integration
|
||||
*/
|
||||
class FrontendTest extends UnitTestCase
|
||||
{
|
||||
const TEST_USER_ID = '_gdprtest';
|
||||
|
||||
const TEST_ARTICLE_OXID = '_gdpr_test_product';
|
||||
|
||||
/**
|
||||
* Test product.
|
||||
*
|
||||
* @var Article
|
||||
*/
|
||||
private $product =null;
|
||||
|
||||
/**
|
||||
* Test set up.
|
||||
*/
|
||||
protected function setUp(): void
|
||||
{
|
||||
parent::setUp();
|
||||
|
||||
$this->replaceBlocks();
|
||||
|
||||
$this->createTestUser();
|
||||
$this->createTestProduct();
|
||||
$this->createBasket();
|
||||
Registry::get(UtilsView::class)->getSmarty(true);
|
||||
}
|
||||
|
||||
/**
|
||||
* Tear down.
|
||||
*/
|
||||
protected function tearDown(): void
|
||||
{
|
||||
$this->cleanUpTable('oxuser', 'oxid');
|
||||
$this->cleanUpTable('oxarticles', 'oxid');
|
||||
$this->cleanUpTable('oxtplblocks', 'oxid');
|
||||
|
||||
parent::tearDown();
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array
|
||||
*/
|
||||
public function providerDeliveryAddressOptin()
|
||||
{
|
||||
return [
|
||||
'enable_optin_true_flow' => [true, 'doAssertStringContainsString', 'flow'],
|
||||
'enable_optin_false_flow' => [false, 'doAssertStringNotContainsString', 'flow']
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Test checkbox visibility.
|
||||
*
|
||||
* @dataProvider providerDeliveryAddressOptin
|
||||
*
|
||||
* @param bool $reqireOptinDeliveryAddress
|
||||
* @param string $assertMethod
|
||||
* @param string $theme
|
||||
*/
|
||||
public function testDeliveryAddressOptinForCheckout($reqireOptinDeliveryAddress, $assertMethod, $theme)
|
||||
{
|
||||
Registry::getSession()->setVariable('blshowshipaddress', true);
|
||||
Registry::getConfig()->setConfigParam('blOeGdprOptinDeliveryAddress', $reqireOptinDeliveryAddress);
|
||||
Registry::getConfig()->setConfigParam('sTheme', $theme);
|
||||
|
||||
$content = $this->getTemplateOutput(UserController::class, 'form/user_checkout_change.tpl');
|
||||
|
||||
$this->$assertMethod('id="oegdproptin_deliveryaddress"', $content);
|
||||
}
|
||||
|
||||
/**
|
||||
* Test checkbox visibility.
|
||||
*
|
||||
* @dataProvider providerDeliveryAddressOptin
|
||||
*
|
||||
* @param bool $reqireOptinDeliveryAddress
|
||||
* @param string $assertMethod
|
||||
* @param string $theme
|
||||
*/
|
||||
public function testDeliveryAddressOptinForUserAccount($reqireOptinDeliveryAddress, $assertMethod, $theme)
|
||||
{
|
||||
Registry::getSession()->setVariable('blshowshipaddress', true);
|
||||
Registry::getConfig()->setConfigParam('blOeGdprOptinDeliveryAddress', $reqireOptinDeliveryAddress);
|
||||
Registry::getConfig()->setConfigParam('sTheme', $theme);
|
||||
|
||||
$content = $this->getTemplateOutput(AccountUserController::class, 'form/user.tpl');
|
||||
|
||||
$this->$assertMethod('id="oegdproptin_deliveryaddress"', $content);
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array
|
||||
*/
|
||||
public function providerInvoiceAddressOptin()
|
||||
{
|
||||
return [
|
||||
'enable_optin_true_flow' => [true, 'doAssertStringContainsString', 'flow'],
|
||||
'enable_optin_false_flow' => [false, 'doAssertStringNotContainsString', 'flow']
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Test checkbox visibility.
|
||||
*
|
||||
* @dataProvider providerInvoiceAddressOptin
|
||||
*
|
||||
* @param bool $reqireOptinInvoiceAddress
|
||||
* @param string $assertMethod
|
||||
* @param string $theme
|
||||
*/
|
||||
public function testInvoiceAddressOptinForCheckout($reqireOptinInvoiceAddress, $assertMethod, $theme)
|
||||
{
|
||||
Registry::getConfig()->setConfigParam('blOeGdprOptinInvoiceAddress', $reqireOptinInvoiceAddress);
|
||||
Registry::getConfig()->setConfigParam('sTheme', $theme);
|
||||
|
||||
$content = $this->getTemplateOutput(UserController::class, 'form/user_checkout_change.tpl');
|
||||
|
||||
$this->$assertMethod('id="oegdproptin_invoiceaddress"', $content);
|
||||
}
|
||||
|
||||
/**
|
||||
* Test checkbox visibility.
|
||||
*
|
||||
* @dataProvider providerInvoiceAddressOptin
|
||||
*
|
||||
* @param bool $reqireOptinInvoiceAddress
|
||||
* @param string $assertMethod
|
||||
* @param string $theme
|
||||
*/
|
||||
public function testInvoiceAddressOptinForUserAccount($reqireOptinInvoiceAddress, $assertMethod, $theme)
|
||||
{
|
||||
Registry::getConfig()->setConfigParam('blOeGdprOptinInvoiceAddress', $reqireOptinInvoiceAddress);
|
||||
Registry::getConfig()->setConfigParam('sTheme', $theme);
|
||||
|
||||
$content = $this->getTemplateOutput(AccountUserController::class, 'form/user.tpl');
|
||||
|
||||
$this->$assertMethod('id="oegdproptin_invoiceaddress"', $content);
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array
|
||||
*/
|
||||
public function providerUserRegistrationOptin()
|
||||
{
|
||||
return [
|
||||
'enable_optin_true_flow' => [true, 'doAssertStringContainsString', 'flow'],
|
||||
'enable_optin_false_flow' => [false, 'doAssertStringNotContainsString', 'flow']
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Test checkbox visibility.
|
||||
* NOTE: user must not be logged in here. Need to simulate user registration.
|
||||
*
|
||||
* @dataProvider providerUserRegistrationOptin
|
||||
*
|
||||
* @param bool $blOeGdprOptinUserRegistration
|
||||
* @param string $assertMethod
|
||||
* @param string $theme
|
||||
*/
|
||||
public function testUserRegistrationOptin($blOeGdprOptinUserRegistration, $assertMethod, $theme)
|
||||
{
|
||||
Registry::getConfig()->setConfigParam('blOeGdprOptinUserRegistration', $blOeGdprOptinUserRegistration);
|
||||
Registry::getConfig()->setConfigParam('sTheme', $theme);
|
||||
Registry::getSession()->setUser(null);
|
||||
|
||||
$addViewData = [];
|
||||
$addViewData['oxcmp_basket'] = oxNew(Basket::class);
|
||||
$addViewData['oConfig'] = Registry::getConfig();
|
||||
$addViewData['sidebar'] = '';
|
||||
|
||||
$content = $this->getTemplateOutput(RegisterController::class, 'page/account/register.tpl', $addViewData);
|
||||
$this->$assertMethod('id="oegdproptin_userregistration"', $content);
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array
|
||||
*/
|
||||
public function providerUserCheckoutRegistrationOptin()
|
||||
{
|
||||
return [
|
||||
'enable_optin_true_flow_noreg' => [true, 'doAssertStringNotContainsString', 'flow', 1],
|
||||
'enable_optin_false_flow_noreg' => [false, 'doAssertStringNotContainsString', 'flow', 1],
|
||||
'enable_optin_true_flow_reg' => [true, 'doAssertStringContainsString', 'flow', 3],
|
||||
'enable_optin_false_flow_reg' => [false, 'doAssertStringNotContainsString', 'flow', 3]
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Test checkbox visibility during registration.
|
||||
* NOTE: user must not be logged in here. Need to simulate user registration.
|
||||
*
|
||||
* @dataProvider providerUserCheckoutRegistrationOptin
|
||||
*
|
||||
* @param bool $blOeGdprOptinUserRegistration
|
||||
* @param string $assertMethod
|
||||
* @param string $theme
|
||||
* @param int $option
|
||||
*/
|
||||
public function testUserRegistrationOptinDuringCheckout($blOeGdprOptinUserRegistration, $assertMethod, $theme, $option)
|
||||
{
|
||||
$this->setRequestParameter('option', $option);
|
||||
Registry::getConfig()->setConfigParam('blOeGdprOptinUserRegistration', $blOeGdprOptinUserRegistration);
|
||||
Registry::getConfig()->setConfigParam('sTheme', $theme);
|
||||
Registry::getSession()->setUser(null);
|
||||
|
||||
$addViewData = [];
|
||||
$addViewData['oxcmp_basket'] = oxNew(Basket::class);
|
||||
$addViewData['oConfig'] = Registry::getConfig();
|
||||
$addViewData['sidebar'] = '';
|
||||
|
||||
$content = $this->getTemplateOutput(UserController::class, 'page/checkout/user.tpl', $addViewData);
|
||||
|
||||
$this->$assertMethod('id="oegdproptin_userregistration"', $content);
|
||||
}
|
||||
|
||||
/**
|
||||
* Test contact form deletion optin
|
||||
*/
|
||||
public function testContactFormDeletionOptIn()
|
||||
{
|
||||
Registry::getConfig()->setConfigParam('OeGdprOptinContactFormMethod', 'deletion');
|
||||
Registry::getConfig()->setConfigParam('sTheme', 'flow');
|
||||
$expected = Registry::getLang()->translateString("OEGDPROPTIN_CONTACT_FORM_MESSAGE_DELETION");
|
||||
|
||||
$content = $this->getTemplateOutput(ContactController::class, 'form/contact.tpl');
|
||||
|
||||
$this->doAssertStringContainsString($expected, $content);
|
||||
$this->doAssertStringNotContainsString('name="c_oegdproptin"', $content);
|
||||
}
|
||||
|
||||
/**
|
||||
* Test contact form statistical optin
|
||||
*/
|
||||
public function testContactFormStatisticalOptIn()
|
||||
{
|
||||
Registry::getConfig()->setConfigParam('OeGdprOptinContactFormMethod', 'statistical');
|
||||
Registry::getConfig()->setConfigParam('sTheme', 'flow');
|
||||
$expected = Registry::getLang()->translateString("OEGDPROPTIN_CONTACT_FORM_MESSAGE_STATISTICAL");
|
||||
|
||||
$content = $this->getTemplateOutput(ContactController::class, 'form/contact.tpl');
|
||||
|
||||
$this->doAssertStringContainsString($expected, $content);
|
||||
$this->doAssertStringContainsString('name="c_oegdproptin"', $content);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates filled basket object and stores it in session.
|
||||
*/
|
||||
private function createBasket()
|
||||
{
|
||||
Registry::getSession()->getBasket();
|
||||
$this->assertNull(Registry::getSession()->getVariable('_newitem'));
|
||||
|
||||
$basketComponent = oxNew(BasketComponent::class);
|
||||
$basketComponent->toBasket(self::TEST_ARTICLE_OXID, 1);
|
||||
$basket = $basketComponent->render();
|
||||
$this->assertEquals(1, $basket->getProductsCount());
|
||||
|
||||
Registry::getSession()->setBasket($basket);
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a test product.
|
||||
*/
|
||||
private function createTestProduct()
|
||||
{
|
||||
$product = oxNew(Article::class);
|
||||
$product->setId(self::TEST_ARTICLE_OXID);
|
||||
$product->oxarticles__oxshopid = new Field(1);
|
||||
$product->oxarticles__oxtitle = new Field(self::TEST_ARTICLE_OXID);
|
||||
$product->oxarticles__oxprice = new Field(6.66);
|
||||
$product->save();
|
||||
|
||||
$this->product = $product;
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a test user.
|
||||
*/
|
||||
private function createTestUser()
|
||||
{
|
||||
$user = oxNew(User::class);
|
||||
$user->setId(self::TEST_USER_ID);
|
||||
$user->assign(
|
||||
[
|
||||
'oxfname' => 'Max',
|
||||
'oxlname' => 'Mustermann',
|
||||
'oxusername' => 'gdpruser@oxid.de',
|
||||
'oxpassword' => md5('agent'),
|
||||
'oxactive' => 1,
|
||||
'oxshopid' => 1,
|
||||
'oxcountryid' => 'a7c40f631fc920687.20179984',
|
||||
'oxboni' => '600',
|
||||
'oxstreet' => 'Teststreet',
|
||||
'oxstreetnr' => '101',
|
||||
'oxcity' => 'Hamburg',
|
||||
'oxzip' => '22769'
|
||||
]
|
||||
);
|
||||
$user->save();
|
||||
|
||||
//Ensure we have it in session and as active user
|
||||
$this->ensureActiveUser();
|
||||
}
|
||||
|
||||
/**
|
||||
* Make sure we have the test user as active user.
|
||||
*/
|
||||
private function ensureActiveUser()
|
||||
{
|
||||
$this->setSessionParam('usr', self::TEST_USER_ID);
|
||||
$this->setSessionParam('auth', self::TEST_USER_ID);
|
||||
|
||||
$user = oxNew(User::class);
|
||||
$user->load(self::TEST_USER_ID);
|
||||
Registry::getSession()->setUser($user);
|
||||
$user->setUser($user);
|
||||
$this->assertTrue($user->loadActiveUser());
|
||||
}
|
||||
|
||||
/**
|
||||
* Test helper to replace header and footer as they are not needed for our tests.
|
||||
*/
|
||||
private function replaceBlocks()
|
||||
{
|
||||
$shopId = Registry::getConfig()->getShopId();
|
||||
$query = "INSERT INTO oxtplblocks (OXID, OXACTIVE, OXSHOPID, OXTEMPLATE, OXBLOCKNAME, OXPOS, OXFILE, OXMODULE) VALUES " .
|
||||
"('_test_header', 1, '{$shopId}', 'layout/page.tpl', 'layout_header', 1, 'Tests/Integration/views/blocks/empty.tpl', 'oegdproptin'), " .
|
||||
"('_test_footer', 1, '{$shopId}', 'layout/footer.tpl', 'footer_main', 1, 'Tests/Integration/views/blocks/empty.tpl', 'oegdproptin'), " .
|
||||
"('_test_sidebar', 1, '{$shopId}', 'layout/sidebar.tpl', 'sidebar', 1, 'Tests/Integration/views/blocks/empty.tpl', 'oegdproptin'), " .
|
||||
"('_test_sgvo_icons', 1, '{$shopId}', 'layout/base.tpl', 'theme_svg_icons', 1, 'Tests/Integration/views/blocks/empty.tpl', 'oegdproptin'), " .
|
||||
"('_test_listitem', 1, '{$shopId}', 'page/review/review.tpl', 'widget_product_listitem_line_picturebox', 1, 'Tests/Integration/views/blocks/empty.tpl', 'oegdproptin')";
|
||||
|
||||
DatabaseProvider::getDb()->execute($query);
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array
|
||||
*/
|
||||
public function providerContactForm()
|
||||
{
|
||||
return [
|
||||
'flow' => ['flow']
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array
|
||||
*/
|
||||
public function providerDetailsReviewOptin()
|
||||
{
|
||||
return [
|
||||
'enable_optin_true_flow_art' => [true, 'doAssertStringContainsString', 'flow', 'oxwArticleDetails'],
|
||||
'enable_optin_false_flow_art' => [false, 'doAssertStringNotContainsString', 'flow', 'oxwArticleDetails']
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Test review form optin visibility.
|
||||
*
|
||||
* @dataProvider providerDetailsReviewOptin
|
||||
*
|
||||
* @param bool $blOeGdprOptinProductReviews
|
||||
* @param string $assertMethod
|
||||
* @param string $theme
|
||||
* @param string $class
|
||||
*/
|
||||
public function testDetailsReviewFormOptIn($blOeGdprOptinProductReviews, $assertMethod, $theme, $class)
|
||||
{
|
||||
Registry::getConfig()->setConfigParam('blOeGdprOptinProductReviews', $blOeGdprOptinProductReviews);
|
||||
Registry::getConfig()->setConfigParam('sTheme', $theme);
|
||||
|
||||
$content = $this->getTemplateOutput($class, 'widget/reviews/reviews.tpl', null, true);
|
||||
|
||||
$this->$assertMethod('id="rvw_oegdproptin"', $content);
|
||||
|
||||
//Error message always present in DOM, if checkbox present, but is hidden by default
|
||||
$message = Registry::getLang()->translateString("OEGDPROPTIN_REVIEW_FORM_ERROR_MESSAGE");
|
||||
$this->$assertMethod($message, $content);
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array
|
||||
*/
|
||||
public function providerOxwArticleDetailsReviewOptinError()
|
||||
{
|
||||
return [
|
||||
'enable_optin_true_flow_art' => [true, 'doAssertStringContainsString', 'flow', 1],
|
||||
'enable_optin_false_flow_art' => [false, 'doAssertStringNotContainsString', 'flow', 0]
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Test review form optin error message visibility.
|
||||
*
|
||||
* @dataProvider providerOxwArticleDetailsReviewOptinError
|
||||
*
|
||||
* @param bool $blOeGdprOptinProductReviews
|
||||
* @param string $assertMethod
|
||||
* @param string $theme
|
||||
* @param int $count
|
||||
*/
|
||||
public function testOxwArticleDetailsReviewFormOptInError($blOeGdprOptinProductReviews, $assertMethod, $theme, $count)
|
||||
{
|
||||
Registry::getConfig()->setConfigParam('blOeGdprOptinProductReviews', $blOeGdprOptinProductReviews);
|
||||
Registry::getConfig()->setConfigParam('sTheme', $theme);
|
||||
|
||||
$controller = $this->getMock(ArticleDetails::class, ['isReviewOptInError']);
|
||||
$controller->expects($this->exactly($count))->method('isReviewOptInError')->will($this->returnValue(true));
|
||||
$controller->init();
|
||||
$controller->setViewProduct($this->product);
|
||||
|
||||
$content = $this->doRender($controller, 'widget/reviews/reviews.tpl');
|
||||
|
||||
$expected = Registry::getLang()->translateString("OEGDPROPTIN_REVIEW_FORM_ERROR_MESSAGE");
|
||||
$this->$assertMethod($expected, $content);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $controllerName
|
||||
* @param string $template
|
||||
* @param null $addViewData
|
||||
* @param bool $setProduct Set true to add test product to view (needed for review tests)
|
||||
*
|
||||
* @return mixed
|
||||
*/
|
||||
protected function getTemplateOutput($controllerName, $template, $addViewData = null, $setProduct = false)
|
||||
{
|
||||
$controller = oxNew($controllerName);
|
||||
$controller->init();
|
||||
|
||||
if ($setProduct) {
|
||||
$controller->setViewProduct($this->product);
|
||||
}
|
||||
|
||||
return $this->doRender($controller, $template, $addViewData);
|
||||
}
|
||||
|
||||
/**
|
||||
* Test helper to render output.
|
||||
*
|
||||
* @param object $controller
|
||||
* @param string $template
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
protected function doRender($controller, $template, $addViewData = null)
|
||||
{
|
||||
//prepare output
|
||||
$output = oxNew(Output::class);
|
||||
$viewData = $output->processViewArray($controller->getViewData(), $controller->getClassName());
|
||||
if (is_array($addViewData)) {
|
||||
$viewData = array_merge($viewData, $addViewData);
|
||||
} else {
|
||||
$viewData['oxcmp_user'] = Registry::getSession()->getUser();
|
||||
$viewData['oxcmp_basket'] = Registry::getSession()->getBasket();
|
||||
$viewData['oConfig'] = Registry::getConfig();
|
||||
}
|
||||
|
||||
$controller->setViewData($viewData);
|
||||
return Registry::get(UtilsView::class)->getTemplateOutput($template, $controller);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $needle
|
||||
* @param string $haystack
|
||||
* @param string $message
|
||||
*/
|
||||
protected function doAssertStringContainsString($needle, $haystack, $message = '')
|
||||
{
|
||||
if (method_exists($this, 'assertStringContainsString')) {
|
||||
parent::assertStringContainsString($needle, $haystack, $message);
|
||||
} else {
|
||||
parent::assertContains($needle, $haystack, $message);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $needle
|
||||
* @param string $haystack
|
||||
* @param string $message
|
||||
*/
|
||||
protected function doAssertStringNotContainsString($needle, $haystack, $message = '')
|
||||
{
|
||||
if (method_exists($this, 'assertStringNotContainsString')) {
|
||||
parent::assertStringNotContainsString($needle, $haystack, $message);
|
||||
} else {
|
||||
parent::assertNotContains($needle, $haystack, $message);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,137 @@
|
||||
<?php
|
||||
/**
|
||||
* This file is part of O3-Shop GDPR opt-in module.
|
||||
*
|
||||
* O3-Shop is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, version 3.
|
||||
*
|
||||
* O3-Shop is distributed in the hope that it will be useful, but
|
||||
* WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||
* General Public License for more details.
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with O3-Shop. If not, see <http://www.gnu.org/licenses/>
|
||||
*
|
||||
* @copyright Copyright (c) 2022 OXID eSales AG (https://www.oxid-esales.com)
|
||||
* @copyright Copyright (c) 2022 O3-Shop (https://www.o3-shop.com)
|
||||
* @license https://www.gnu.org/licenses/gpl-3.0 GNU General Public License 3 (GPLv3)
|
||||
*/
|
||||
|
||||
namespace OxidEsales\GdprOptinModule\Tests\Integration;
|
||||
|
||||
use OxidEsales\GdprOptinModule\Controller\ReviewController;
|
||||
|
||||
/**
|
||||
* Class ReviewControllerTest
|
||||
*
|
||||
* @package OxidEsales\GdprOptinModule\Tests\Integration
|
||||
*/
|
||||
class ReviewControllerTest extends \OxidEsales\TestingLibrary\UnitTestCase
|
||||
{
|
||||
/**
|
||||
* Test validation error appears if needed
|
||||
*/
|
||||
public function testSendError()
|
||||
{
|
||||
/** @var ReviewController $controller */
|
||||
$controller = oxNew(\OxidEsales\Eshop\Application\Controller\ReviewController::class);
|
||||
\OxidEsales\Eshop\Core\Registry::getConfig()->setConfigParam($controller::REVIEW_OPTIN_PARAM, true);
|
||||
$this->assertFalse($controller->saveReview());
|
||||
}
|
||||
|
||||
/**
|
||||
* Test validation error appears if needed
|
||||
*/
|
||||
public function testSendNotError()
|
||||
{
|
||||
/** @var ReviewController $controller */
|
||||
$controller = oxNew(\OxidEsales\Eshop\Application\Controller\ReviewController::class);
|
||||
\OxidEsales\Eshop\Core\Registry::getConfig()->setConfigParam($controller::REVIEW_OPTIN_PARAM, false);
|
||||
$this->assertNull($controller->saveReview());
|
||||
}
|
||||
|
||||
/**
|
||||
* Test if validation is required.
|
||||
*
|
||||
* @dataProvider dataProviderReviewOptInValidationRequired
|
||||
*/
|
||||
public function testReviewOptInValidationRequired($configValue, $expected)
|
||||
{
|
||||
/** @var ReviewController $controller */
|
||||
$controller = oxNew(\OxidEsales\Eshop\Application\Controller\ReviewController::class);
|
||||
\OxidEsales\Eshop\Core\Registry::getConfig()->setConfigParam($controller::REVIEW_OPTIN_PARAM, $configValue);
|
||||
$this->assertSame($expected, $controller->isReviewOptInValidationRequired());
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array
|
||||
*/
|
||||
public function dataProviderReviewOptInValidationRequired()
|
||||
{
|
||||
return [
|
||||
'required' => [true, true],
|
||||
'not-required' => [false, false]
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Test opt in validation
|
||||
*
|
||||
* @dataProvider dataProviderValidateOptIn
|
||||
*/
|
||||
public function testValidateOptIn($configValue, $checkboxStatus, $expectedValue)
|
||||
{
|
||||
/** @var ReviewController $controller */
|
||||
$controller = oxNew(\OxidEsales\Eshop\Application\Controller\ReviewController::class);
|
||||
\OxidEsales\Eshop\Core\Registry::getConfig()->setConfigParam($controller::REVIEW_OPTIN_PARAM, $configValue);
|
||||
$this->setRequestParameter('rvw_oegdproptin', $checkboxStatus);
|
||||
|
||||
$this->assertSame($expectedValue, $controller->validateOptIn());
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array
|
||||
*/
|
||||
public function dataProviderValidateOptIn()
|
||||
{
|
||||
return [
|
||||
'required-checked' => [true, 1, true],
|
||||
'required-not-checked' => [true, 0, false],
|
||||
'required-not-exist' => [true, null, false],
|
||||
'not-required-checked' => [false, 1, true],
|
||||
'not-required-not-checked' => [false, 0, true],
|
||||
'not-required-not-exits' => [false, null, true]
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Test opt in validation
|
||||
*
|
||||
* @dataProvider dataProviderReviewOptInError
|
||||
*/
|
||||
public function testReviewOptInError($configValue, $checkboxStatus, $expectedValue)
|
||||
{
|
||||
/** @var ReviewController $controller */
|
||||
$controller = oxNew(\OxidEsales\Eshop\Application\Controller\ReviewController::class);
|
||||
\OxidEsales\Eshop\Core\Registry::getConfig()->setConfigParam($controller::REVIEW_OPTIN_PARAM, $configValue);
|
||||
$this->setRequestParameter('rvw_oegdproptin', $checkboxStatus);
|
||||
|
||||
$this->assertSame($expectedValue, $controller->isReviewOptInError());
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array
|
||||
*/
|
||||
public function dataProviderReviewOptInError()
|
||||
{
|
||||
return [
|
||||
'required-checked' => [true, 1, false],
|
||||
'required-not-checked' => [true, 0, true],
|
||||
'required-not-exist' => [true, null, false],
|
||||
'not-required-checked' => [false, 1, false],
|
||||
'not-required-not-checked' => [false, 0, false],
|
||||
'not-required-not-exits' => [false, null, false]
|
||||
];
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,365 @@
|
||||
<?php
|
||||
/**
|
||||
* This file is part of O3-Shop GDPR opt-in module.
|
||||
*
|
||||
* O3-Shop is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, version 3.
|
||||
*
|
||||
* O3-Shop is distributed in the hope that it will be useful, but
|
||||
* WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||
* General Public License for more details.
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with O3-Shop. If not, see <http://www.gnu.org/licenses/>
|
||||
*
|
||||
* @copyright Copyright (c) 2022 OXID eSales AG (https://www.oxid-esales.com)
|
||||
* @copyright Copyright (c) 2022 O3-Shop (https://www.o3-shop.com)
|
||||
* @license https://www.gnu.org/licenses/gpl-3.0 GNU General Public License 3 (GPLv3)
|
||||
*/
|
||||
|
||||
namespace OxidEsales\GdprOptinModule\Tests\Integration;
|
||||
|
||||
use OxidEsales\Eshop\Application\Component\UserComponent;
|
||||
use OxidEsales\Eshop\Application\Controller\RegisterController;
|
||||
use OxidEsales\Eshop\Application\Controller\UserController;
|
||||
use OxidEsales\Eshop\Application\Model\User;
|
||||
use OxidEsales\Eshop\Core\Registry;
|
||||
use OxidEsales\TestingLibrary\UnitTestCase;
|
||||
|
||||
/**
|
||||
* Class UserComponentTest
|
||||
*
|
||||
* @package OxidEsales\GdprOptinModule\Tests\Integration
|
||||
*/
|
||||
class UserComponentTest extends UnitTestCase
|
||||
{
|
||||
const TEST_USER_ID = '_gdprtest';
|
||||
|
||||
/**
|
||||
* Test set up.
|
||||
*/
|
||||
protected function setUp(): void
|
||||
{
|
||||
parent::setUp();
|
||||
|
||||
$this->createTestUser();
|
||||
}
|
||||
|
||||
/**
|
||||
* Tear down.
|
||||
*/
|
||||
protected function tearDown(): void
|
||||
{
|
||||
$this->cleanUpTable('oxuser', 'oxid');
|
||||
|
||||
parent::tearDown();
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array
|
||||
*/
|
||||
public function providerDeliveryAddressOptin()
|
||||
{
|
||||
//Optin will only be required on changed or new address.
|
||||
$addAddress = ['oxaddressid' => '-1'];
|
||||
$changedAddress = ['oxaddressid' => 'someuniqueid', 'oegdproptin_changeDelAddress' => '1'];
|
||||
|
||||
return [
|
||||
'optin_true_checkbox_true_show_true_new' => [true, true, 'assertFalse', true, $addAddress],
|
||||
'optin_true_checkbox_true_show_true_change' => [true, true, 'assertFalse', true, $changedAddress],
|
||||
'optin_true_checkbox_true_show_true' => [true, true, 'assertFalse', true, []],
|
||||
|
||||
'optin_true_checkbox_false_show_true_new' => [true, false, 'assertTrue', true, $addAddress],
|
||||
'optin_true_checkbox_false_show_true_change' => [true, false, 'assertTrue', true, $changedAddress],
|
||||
'optin_true_checkbox_false_show_true' => [true, false, 'assertTrue', true, []],
|
||||
|
||||
'optin_false_checkbox_true_show_true' => [false, true, 'assertFalse', true, []],
|
||||
'optin_false_checkbox_false_show_true' => [false, false, 'assertFalse', true, []],
|
||||
|
||||
'optin_true_checkbox_true_show_false' => [true, true, 'assertFalse', false, []],
|
||||
'optin_true_checkbox_false_show_false' => [true, false, 'assertFalse', false, []],
|
||||
|
||||
'optin_false_checkbox_true_show_false' => [false, true, 'assertFalse', false, []],
|
||||
'optin_false_checkbox_false_show_false' => [false, false, 'assertFalse', false, []],
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Test checkbox validation.
|
||||
*
|
||||
* @dataProvider providerDeliveryAddressOptin
|
||||
*
|
||||
* @param bool $requireGdprOptinDeliveryAddress
|
||||
* @param bool $checkboxChecked
|
||||
* @param string $assertDisplayExc
|
||||
* @param bool $showShip
|
||||
* @param array $parameters
|
||||
*/
|
||||
public function testDeliveryAddressOptinValidationCheckoutUser($requireGdprOptinDeliveryAddress, $checkboxChecked, $assertDisplayExc, $showShip, $parameters)
|
||||
{
|
||||
Registry::getConfig()->setConfigParam('blOeGdprOptinDeliveryAddress', $requireGdprOptinDeliveryAddress);
|
||||
|
||||
$parameters['oegdproptin_deliveryaddress'] = (int) $checkboxChecked;
|
||||
$parameters['blshowshipaddress'] = (int) $showShip;
|
||||
$this->addRequestParameters($parameters);
|
||||
|
||||
$cmpUser = oxNew(UserComponent::class);
|
||||
$cmpUser->changeuser();
|
||||
|
||||
$displayErrors = Registry::getSession()->getVariable('Errors');
|
||||
$this->$assertDisplayExc(array_key_exists('oegdproptin_deliveryaddress', $displayErrors));
|
||||
}
|
||||
|
||||
/**
|
||||
* Test checkbox validation.
|
||||
*
|
||||
* @dataProvider providerDeliveryAddressOptin
|
||||
*
|
||||
* @param bool $requireGdprOptinDeliveryAddress
|
||||
* @param bool $checkboxChecked
|
||||
* @param string $assertDisplayExc
|
||||
* @param bool $showShip
|
||||
* @param array $parameters
|
||||
*/
|
||||
public function testDeliveryAddressOptinValidationAccountUser($requireGdprOptinDeliveryAddress, $checkboxChecked, $assertDisplayExc, $showShip, $parameters)
|
||||
{
|
||||
Registry::getConfig()->setConfigParam('blOeGdprOptinDeliveryAddress', $requireGdprOptinDeliveryAddress);
|
||||
|
||||
$parameters['oegdproptin_deliveryaddress'] = (int) $checkboxChecked;
|
||||
$parameters['blshowshipaddress'] = (int) $showShip;
|
||||
$this->addRequestParameters($parameters);
|
||||
|
||||
$cmpUser = oxNew(UserComponent::class);
|
||||
$cmpUser->changeuser_testvalues();
|
||||
|
||||
$displayErrors = Registry::getSession()->getVariable('Errors');
|
||||
$this->$assertDisplayExc(array_key_exists('oegdproptin_deliveryaddress', $displayErrors));
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array
|
||||
*/
|
||||
public function providerInvoiceAddressOptin()
|
||||
{
|
||||
//Optin will be required on changed invoice address
|
||||
$changedAddress = ['oegdproptin_changeInvAddress' => '1'];
|
||||
|
||||
return [
|
||||
'optin_true_checkbox_true_change' => [true, true, 'assertFalse', $changedAddress],
|
||||
'optin_true_checkbox_true_no_change' => [true, true, 'assertFalse', []],
|
||||
|
||||
'optin_true_checkbox_false_change' => [true, false, 'assertTrue', $changedAddress],
|
||||
'optin_true_checkbox_false_no_change' => [true, false, 'assertFalse', []],
|
||||
|
||||
'optin_false_checkbox_false_change' => [false, false, 'assertFalse', $changedAddress],
|
||||
'optin_false_checkbox_false_no_change' => [false, false, 'assertFalse', []],
|
||||
|
||||
'optin_false_checkbox_true_change' => [false, true, 'assertFalse', $changedAddress],
|
||||
'optin_false_checkbox_true_no_change' => [false, true, 'assertFalse', []],
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Test checkbox validation.
|
||||
*
|
||||
* @dataProvider providerInvoiceAddressOptin
|
||||
*
|
||||
* @param bool $requireGdprOptinInvoiceAddress
|
||||
* @param bool $checkboxChecked
|
||||
* @param string $assertDisplayExc
|
||||
* @param array $parameters
|
||||
*/
|
||||
public function testInvoiceAddressOptinValidationCheckoutUser($requireGdprOptinInvoiceAddress, $checkboxChecked, $assertDisplayExc, $parameters)
|
||||
{
|
||||
Registry::getConfig()->setConfigParam('blOeGdprOptinInvoiceAddress', $requireGdprOptinInvoiceAddress);
|
||||
|
||||
$parameters['oegdproptin_invoiceaddress'] = (int) $checkboxChecked;
|
||||
$this->addRequestParameters($parameters);
|
||||
|
||||
$cmpUser = oxNew(UserComponent::class);
|
||||
$cmpUser->changeuser();
|
||||
|
||||
$displayErrors = Registry::getSession()->getVariable('Errors');
|
||||
$this->$assertDisplayExc(array_key_exists('oegdproptin_invoiceaddress', $displayErrors));
|
||||
}
|
||||
|
||||
/**
|
||||
* Test checkbox validation.
|
||||
*
|
||||
* @dataProvider providerInvoiceAddressOptin
|
||||
*
|
||||
* @param bool $requireGdprOptinInvoiceAddress
|
||||
* @param bool $checkboxChecked
|
||||
* @param string $assertDisplayExc
|
||||
* @param array $parameters
|
||||
*/
|
||||
public function testInvoiceAddressOptinValidationAccountUser($requireGdprOptinInvoiceAddress, $checkboxChecked, $assertDisplayExc, $parameters)
|
||||
{
|
||||
Registry::getConfig()->setConfigParam('blOeGdprOptinInvoiceAddress', $requireGdprOptinInvoiceAddress);
|
||||
|
||||
$parameters['oegdproptin_invoiceaddress'] = (int) $checkboxChecked;
|
||||
$this->addRequestParameters($parameters);
|
||||
|
||||
$cmpUser = oxNew(UserComponent::class);
|
||||
$cmpUser->changeuser_testvalues();
|
||||
|
||||
$displayErrors = Registry::getSession()->getVariable('Errors');
|
||||
$this->$assertDisplayExc(array_key_exists('oegdproptin_invoiceaddress', $displayErrors));
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array
|
||||
*/
|
||||
public function providerUserRegistrationOptin()
|
||||
{
|
||||
return [
|
||||
'enable_true_optin_true_register' => [true, true, 'assertFalse'],
|
||||
'enable_true_optin_false_register' => [true, false, 'assertTrue'],
|
||||
'enable_false_optin_true_register' => [false, true, 'assertFalse'],
|
||||
'enable_false_optin_false_register' => [false, false, 'assertFalse']
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Test checkbox validation.
|
||||
*
|
||||
* @dataProvider providerUserRegistrationOptin
|
||||
*
|
||||
* @param bool $oeGdprUserRegistrationAddress
|
||||
* @param bool $checkboxChecked
|
||||
* @param string $assertDisplayExc
|
||||
* @param string $parent
|
||||
*/
|
||||
public function testUserRegistrationOptinValidation($oeGdprUserRegistrationAddress, $checkboxChecked, $assertDisplayExc)
|
||||
{
|
||||
Registry::getSession()->setUser(null);
|
||||
Registry::getConfig()->setConfigParam('blOeGdprOptinUserRegistration', $oeGdprUserRegistrationAddress);
|
||||
|
||||
$parameters = ['oegdproptin_userregistration' => (int) $checkboxChecked,
|
||||
'option' => 3];
|
||||
$this->addRequestParameters($parameters);
|
||||
|
||||
$cmpUser = oxNew(UserComponent::class);
|
||||
$parentView = oxNew(RegisterController::class);
|
||||
$cmpUser->setParent($parentView);
|
||||
$cmpUser->createUser();
|
||||
|
||||
$displayErrors = Registry::getSession()->getVariable('Errors');
|
||||
$this->$assertDisplayExc(array_key_exists('oegdproptin_userregistration', $displayErrors));
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array
|
||||
*/
|
||||
public function providerUserCheckoutRegistrationOptin()
|
||||
{
|
||||
return [
|
||||
'enable_true_optin_true_guestbuy' => [true, true, 'assertFalse', 1],
|
||||
'enable_true_optin_false_guestbuy' => [true, false, 'assertFalse', 1],
|
||||
'enable_false_optin_true_guestbuy' => [false, true, 'assertFalse', 1],
|
||||
'enable_false_optin_false_guestbuy' => [false, false, 'assertFalse', 1],
|
||||
'enable_true_optin_true_createuser' => [true, true, 'assertFalse', 3],
|
||||
'enable_true_optin_false_createuser' => [true, false, 'assertTrue', 3],
|
||||
'enable_false_optin_true_createuser' => [false, true, 'assertFalse', 3],
|
||||
'enable_false_optin_false_createuser' => [false, false, 'assertFalse', 3]
|
||||
];
|
||||
}
|
||||
/**
|
||||
* Test checkbox validation.
|
||||
*
|
||||
* @dataProvider providerUserCheckoutRegistrationOptin
|
||||
*
|
||||
* @param bool $oeGdprUserRegistrationAddress
|
||||
* @param bool $checkboxChecked
|
||||
* @param string $assertDisplayExc
|
||||
* @param int $option (1 = guest buy/no optin, 3 = create account)
|
||||
*/
|
||||
public function testUserRegistrationOptinValidationCheckoutUser($oeGdprUserRegistrationAddress, $checkboxChecked, $assertDisplayExc, $option)
|
||||
{
|
||||
Registry::getSession()->setUser(null);
|
||||
Registry::getConfig()->setConfigParam('blOeGdprOptinUserRegistration', $oeGdprUserRegistrationAddress);
|
||||
|
||||
$parameters = ['oegdproptin_userregistration' => (int) $checkboxChecked,
|
||||
'option' => $option];
|
||||
$this->addRequestParameters($parameters);
|
||||
|
||||
$cmpUser = oxNew(UserComponent::class);
|
||||
$parentView = oxNew(UserController::class);
|
||||
$cmpUser->setParent($parentView);
|
||||
$cmpUser->createUser();
|
||||
|
||||
$displayErrors = Registry::getSession()->getVariable('Errors');
|
||||
$this->$assertDisplayExc(array_key_exists('oegdproptin_userregistration', $displayErrors));
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a test user.
|
||||
*/
|
||||
private function createTestUser()
|
||||
{
|
||||
$user = oxNew(User::class);
|
||||
$user->setId(self::TEST_USER_ID);
|
||||
$user->assign(
|
||||
[
|
||||
'oxfname' => 'Max',
|
||||
'oxlname' => 'Mustermann',
|
||||
'oxusername' => 'gdpruser@oxid.de',
|
||||
'oxpassword' => md5('agent'),
|
||||
'oxactive' => 1,
|
||||
'oxshopid' => 1,
|
||||
'oxcountryid' => 'a7c40f631fc920687.20179984',
|
||||
'oxboni' => '600',
|
||||
'oxstreet' => 'Teststreet',
|
||||
'oxstreetnr' => '101',
|
||||
'oxcity' => 'Hamburg',
|
||||
'oxzip' => '22769'
|
||||
]
|
||||
);
|
||||
$user->save();
|
||||
|
||||
//Ensure we have it in session and as active user
|
||||
$this->ensureActiveUser();
|
||||
}
|
||||
|
||||
/**
|
||||
* Make sure we have the test user as active user.
|
||||
*/
|
||||
private function ensureActiveUser()
|
||||
{
|
||||
$this->setSessionParam('usr', self::TEST_USER_ID);
|
||||
$this->setSessionParam('auth', self::TEST_USER_ID);
|
||||
|
||||
$user = oxNew(User::class);
|
||||
$user->load(self::TEST_USER_ID);
|
||||
Registry::getSession()->setUser($user);
|
||||
$user->setUser($user);
|
||||
$this->assertTrue($user->loadActiveUser());
|
||||
}
|
||||
|
||||
/**
|
||||
* Test helper for setting requets parameters.
|
||||
*
|
||||
* @param array $parameters
|
||||
*/
|
||||
private function addRequestParameters($additionalParameters = [])
|
||||
{
|
||||
$address = 'a:13:{s:16:"oxaddress__oxsal";s:2:"MR";s:18:"oxaddress__oxfname";s:4:"Moxi";' .
|
||||
's:18:"oxaddress__oxlname";s:6:"Muster";s:20:"oxaddress__oxcompany";s:0:"";' .
|
||||
's:20:"oxaddress__oxaddinfo";s:0:"";s:19:"oxaddress__oxstreet";s:10:"Nicestreet";' .
|
||||
's:21:"oxaddress__oxstreetnr";s:3:"666";s:16:"oxaddress__oxzip";s:5:"12345";' .
|
||||
's:17:"oxaddress__oxcity";s:9:"Somewhere";s:22:"oxaddress__oxcountryid";' .
|
||||
's:26:"a7c40f631fc920687.20179984";s:20:"oxaddress__oxstateid";s:0:"";' .
|
||||
's:16:"oxaddress__oxfon";s:0:"";s:16:"oxaddress__oxfax";s:0:"";}';
|
||||
|
||||
$deliveryAddress = unserialize($address);
|
||||
$parameters = ['deladr' => $deliveryAddress,
|
||||
'stoken' => Registry::getSession()->getSessionChallengeToken()];
|
||||
|
||||
$parameters = array_merge($parameters, $additionalParameters);
|
||||
|
||||
foreach ($parameters as $key => $value) {
|
||||
$this->setRequestParameter($key, $value);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1 @@
|
||||
[{* empty *}]
|
||||
24
shop/source/modules/oe/gdproptin/Tests/phpunit.xml
Normal file
24
shop/source/modules/oe/gdproptin/Tests/phpunit.xml
Normal file
@@ -0,0 +1,24 @@
|
||||
<phpunit backupGlobals="true"
|
||||
backupStaticAttributes="false"
|
||||
cacheTokens="true"
|
||||
colors="false"
|
||||
convertErrorsToExceptions="true"
|
||||
convertNoticesToExceptions="true"
|
||||
convertWarningsToExceptions="true"
|
||||
forceCoversAnnotation="false"
|
||||
printerClass="\OxidEsales\TestingLibrary\Printer"
|
||||
processIsolation="false"
|
||||
stopOnError="false"
|
||||
stopOnFailure="false"
|
||||
stopOnIncomplete="false"
|
||||
stopOnSkipped="false"
|
||||
verbose="false">
|
||||
<filter>
|
||||
<whitelist processUncoveredFilesFromWhitelist="true">
|
||||
<directory suffix=".php">../Component</directory>
|
||||
<directory suffix=".php">../Controller</directory>
|
||||
<directory suffix=".php">../Core</directory>
|
||||
<directory suffix=".php">../Application</directory>
|
||||
</whitelist>
|
||||
</filter>
|
||||
</phpunit>
|
||||
43
shop/source/modules/oe/gdproptin/composer.json
Normal file
43
shop/source/modules/oe/gdproptin/composer.json
Normal file
@@ -0,0 +1,43 @@
|
||||
{
|
||||
"name": "o3-shop/gdpr-optin-module",
|
||||
"description": "This is the GDPR opt-in module for the O3-Shop.",
|
||||
"type": "oxideshop-module",
|
||||
"keywords": ["o3-shop", "modules", "eShop"],
|
||||
"homepage": "https://www.o3-shop.com/",
|
||||
"license": [
|
||||
"GPL-3.0-only"
|
||||
],
|
||||
"author": [
|
||||
{
|
||||
"name": "OXID eSales AG",
|
||||
"email": "info@oxid-esales.com",
|
||||
"homepage": "https://oxid-esales.com",
|
||||
"role": "Developer"
|
||||
},
|
||||
{
|
||||
"name": "O3-Shop",
|
||||
"email": "info@o3-shop.com",
|
||||
"homepage": "https://www.o3-shop.com",
|
||||
"role": "Developer"
|
||||
}
|
||||
],
|
||||
"extra": {
|
||||
"oxideshop": {
|
||||
"blacklist-filter": [
|
||||
"documentation/**/*.*"
|
||||
],
|
||||
"target-directory": "oe/gdproptin"
|
||||
}
|
||||
},
|
||||
"require": {
|
||||
"php": ">=7.1"
|
||||
},
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
"OxidEsales\\GdprOptinModule\\": "../../../source/modules/oe/gdproptin"
|
||||
}
|
||||
},
|
||||
"replace": {
|
||||
"oxid-esales/gdpr-optin-module": "2.3.3"
|
||||
}
|
||||
}
|
||||
BIN
shop/source/modules/oe/gdproptin/logo.png
Normal file
BIN
shop/source/modules/oe/gdproptin/logo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 9.5 KiB |
141
shop/source/modules/oe/gdproptin/metadata.php
Normal file
141
shop/source/modules/oe/gdproptin/metadata.php
Normal file
@@ -0,0 +1,141 @@
|
||||
<?php
|
||||
/**
|
||||
* This file is part of O3-Shop GDPR opt-in module.
|
||||
*
|
||||
* O3-Shop is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, version 3.
|
||||
*
|
||||
* O3-Shop is distributed in the hope that it will be useful, but
|
||||
* WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||
* General Public License for more details.
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with O3-Shop. If not, see <http://www.gnu.org/licenses/>
|
||||
*
|
||||
* @copyright Copyright (c) 2022 OXID eSales AG (https://www.oxid-esales.com)
|
||||
* @copyright Copyright (c) 2022 O3-Shop (https://www.o3-shop.com)
|
||||
* @license https://www.gnu.org/licenses/gpl-3.0 GNU General Public License 3 (GPLv3)
|
||||
*/
|
||||
|
||||
/**
|
||||
* Metadata version
|
||||
*/
|
||||
$sMetadataVersion = '2.0';
|
||||
|
||||
/**
|
||||
* Module information
|
||||
*/
|
||||
$aModule = [
|
||||
'id' => 'oegdproptin',
|
||||
'title' => [
|
||||
'de' => 'GDPR Opt-in',
|
||||
'en' => 'GDPR Opt-in',
|
||||
],
|
||||
'description' => [
|
||||
'de' => 'Das Modul stellt Opt-in-Funktionalität für die Datenschutz-Grundverordnung (DSGVO) bereit',
|
||||
'en' => 'This module provides the opt-in functionality for the European General Data Protection Regulation (GDPR)',
|
||||
],
|
||||
'thumbnail' => 'logo.png',
|
||||
'version' => '1.0.1',
|
||||
'author' => 'O3-Shop',
|
||||
'url' => 'https://www.o3-shop.com/',
|
||||
'email' => '',
|
||||
'extend' => [
|
||||
\OxidEsales\Eshop\Application\Component\Widget\ArticleDetails::class => \OxidEsales\GdprOptinModule\Component\Widget\ArticleDetails::class,
|
||||
\OxidEsales\Eshop\Application\Component\Widget\Review::class => \OxidEsales\GdprOptinModule\Component\Widget\Review::class,
|
||||
\OxidEsales\Eshop\Application\Component\UserComponent::class => \OxidEsales\GdprOptinModule\Component\UserComponent::class,
|
||||
\OxidEsales\Eshop\Application\Controller\ReviewController::class => \OxidEsales\GdprOptinModule\Controller\ReviewController::class,
|
||||
\OxidEsales\Eshop\Application\Controller\ArticleDetailsController::class => \OxidEsales\GdprOptinModule\Controller\ArticleDetailsController::class,
|
||||
\OxidEsales\Eshop\Application\Controller\ContactController::class => \OxidEsales\GdprOptinModule\Controller\ContactController::class
|
||||
],
|
||||
'blocks' => [
|
||||
[
|
||||
'template' => 'form/user.tpl',
|
||||
'block' => 'user_billing_address_form',
|
||||
'file' => 'Application/views/blocks/user_invoice_address_form.tpl',
|
||||
],
|
||||
[
|
||||
'template' => 'form/user.tpl',
|
||||
'block' => 'user_shipping_address_form',
|
||||
'file' => 'Application/views/blocks/user_shipping_address_form.tpl',
|
||||
],
|
||||
[
|
||||
'template' => 'form/user.tpl',
|
||||
'block' => 'user_form',
|
||||
'file' => 'Application/views/blocks/user_address.tpl',
|
||||
],
|
||||
[
|
||||
'template' => 'form/user.tpl',
|
||||
'block' => 'user',
|
||||
'file' => 'Application/views/blocks/user.tpl',
|
||||
],
|
||||
[
|
||||
'template' => 'form/user_checkout_change.tpl',
|
||||
'block' => 'user_checkout_change',
|
||||
'file' => 'Application/views/blocks/user_checkout_change.tpl',
|
||||
],
|
||||
[
|
||||
'template' => 'form/user_checkout_change.tpl',
|
||||
'block' => 'user_checkout_shipping_feedback',
|
||||
'file' => 'Application/views/blocks/user_checkout_shipping_feedback.tpl',
|
||||
],
|
||||
[
|
||||
'template' => 'form/user_checkout_change.tpl',
|
||||
'block' => 'user_checkout_billing_feedback',
|
||||
'file' => 'Application/views/blocks/user_checkout_billing_feedback.tpl',
|
||||
],
|
||||
[
|
||||
'template' => 'form/fieldset/user_account.tpl',
|
||||
'block' => 'user_account_newsletter',
|
||||
'file' => 'Application/views/blocks/user_account_newsletter.tpl',
|
||||
],
|
||||
[
|
||||
'template' => 'form/contact.tpl',
|
||||
'block' => 'contact_form_fields',
|
||||
'file' => 'Application/views/blocks/contact_form_fields.tpl',
|
||||
],
|
||||
[
|
||||
'template' => 'widget/reviews/reviews.tpl',
|
||||
'block' => 'widget_reviews_form_fields',
|
||||
'file' => 'Application/views/blocks/widget_reviews_form_fields.tpl',
|
||||
]
|
||||
],
|
||||
'settings' => [
|
||||
[
|
||||
'group' => 'oegdproptin_settings',
|
||||
'name' => 'blOeGdprOptinInvoiceAddress',
|
||||
'type' => 'bool',
|
||||
'value' => 'false'
|
||||
],
|
||||
[
|
||||
'group' => 'oegdproptin_settings',
|
||||
'name' => 'blOeGdprOptinDeliveryAddress',
|
||||
'type' => 'bool',
|
||||
'value' => 'false'
|
||||
],
|
||||
[
|
||||
'group' => 'oegdproptin_settings',
|
||||
'name' => 'blOeGdprOptinUserRegistration',
|
||||
'type' => 'bool',
|
||||
'value' => 'false'
|
||||
],
|
||||
[
|
||||
'group' => 'oegdproptin_settings',
|
||||
'name' => 'blOeGdprOptinProductReviews',
|
||||
'type' => 'bool',
|
||||
'value' => 'false'
|
||||
],
|
||||
[
|
||||
'group' => 'oegdproptin_contact_form',
|
||||
'name' => 'OeGdprOptinContactFormMethod',
|
||||
'type' => 'select',
|
||||
'value' => 'deletion',
|
||||
'constraints' => 'deletion|statistical',
|
||||
],
|
||||
],
|
||||
'events' => [
|
||||
'onActivate' => '\OxidEsales\GdprOptinModule\Core\GdprOptinModule::onActivate',
|
||||
'onDeactivate' => '\OxidEsales\GdprOptinModule\Core\GdprOptinModule::onDeactivate',
|
||||
],
|
||||
];
|
||||
Reference in New Issue
Block a user