';
+
}
public function formatAdminBox($path, $settingGroup, &$box, &$fields, &$values, $changes) {
@@ -309,6 +310,17 @@ public function formatAdminBox($path, $settingGroup, &$box, &$fields, &$values,
$box['tabs']['meta_data']['notices']['test_send_sucesses']['message'] = $success;
}
}
+
+
+ $newsletterConsentPolicy = ze::setting('zenario_newsletter__newsletter_consent_policy');
+ $values['unsub_exclude/exclude_recipients_with_no_consent'] = ($newsletterConsentPolicy == 'consent_required');
+ if (!$newsletterConsentPolicy) {
+ //If the newsletter consent flag is not set, show a link to the site settings tab
+ $link= ze\link::absolute() . 'zenario/admin/organizer.php#zenario__administration/panels/site_settings//zenario_newsletter__site_settings_group~.site_settings~tzenario_newsletter__site_settings~k' . urlencode('{"id":"zenario_newsletter__site_settings_group"}');
+ $fields['unsub_exclude/exclude_recipients_with_no_consent']['note_below'] = ze\admin::phrase('Select a flag that represents a recipients consent to recieve newsletters here.', ['link' => $link]);
+ } else {
+ unset($fields['unsub_exclude/exclude_recipients_with_no_consent']['note_below']);
+ }
}
public function validateAdminBox($path, $settingGroup, &$box, &$fields, &$values, $changes, $saving) {
@@ -319,7 +331,14 @@ public function validateAdminBox($path, $settingGroup, &$box, &$fields, &$values
ZENARIO_NEWSLETTER_PREFIX. 'newsletters',
['newsletter_name' => $values['meta_data/newsletter_name'], 'id' => ['!' => $box['key']['id']]]
)) {
- $box['tabs']['meta_data']['errors'][] = ze\admin::phrase('Please ensure the Name you give this Newsletter is Unique.');
+ $box['tabs']['meta_data']['errors'][] = ze\admin::phrase('Please ensure the name you give this newsletter is unique.');
+ }
+ }
+
+ if (ze\ring::engToBoolean($box['tabs']['unsub_exclude']['edit_mode']['on'] ?? false)) {
+ //The consent flag must be chosen in the site-settings to proceed
+ if (!ze::setting('zenario_newsletter__newsletter_consent_policy')) {
+ $fields['unsub_exclude/exclude_recipients_with_no_consent']['error'] = ze\admin::phrase('You have not yet selected a consent policy for users receiving newsletters');
}
}
}
diff --git a/zenario/modules/zenario_newsletter/classes/admin_boxes/site_settings.php b/zenario/modules/zenario_newsletter/classes/admin_boxes/site_settings.php
index a013812ea..37e5aafed 100644
--- a/zenario/modules/zenario_newsletter/classes/admin_boxes/site_settings.php
+++ b/zenario/modules/zenario_newsletter/classes/admin_boxes/site_settings.php
@@ -33,8 +33,11 @@ class zenario_newsletter__admin_boxes__site_settings extends zenario_newsletter
public function fillAdminBox($path, $settingGroup, &$box, &$fields, &$values) {
switch($settingGroup) {
case 'zenario_newsletter__site_settings_group':
- $box['tabs']['zenario_newsletter__site_settings']['fields']['zenario_newsletter__all_newsletters_opt_out']['values'] =
- ze\datasetAdm::listCustomFields('users', $flat = false, 'boolean_and_groups_only', $customOnly = true, $useOptGroups = true);
+ $fields['zenario_newsletter__all_newsletters_opt_out']['values'] =
+ ze\datasetAdm::listCustomFields('users', $flat = false, 'boolean_and_groups_only', $customOnly = true, $useOptGroups = true, $hideEmptyOptGroupParents = true);
+
+ $fields['zenario_newsletter__newsletter_consent_flag']['values'] =
+ ze\datasetAdm::listCustomFields('users', $flat = false, 'consent', $customOnly = false, $useOptGroups = true, $hideEmptyOptGroupParents = true);
break;
}
}
diff --git a/zenario/modules/zenario_newsletter/module_code.php b/zenario/modules/zenario_newsletter/module_code.php
index 74691368f..6a1107010 100644
--- a/zenario/modules/zenario_newsletter/module_code.php
+++ b/zenario/modules/zenario_newsletter/module_code.php
@@ -114,8 +114,7 @@ protected static function newsletterRecipientsPart($id, $mode, $smartGroupId) {
ON ucd.user_id = u.id";
$whereStatement = "
- WHERE u.email != ''";
- //AND u.status IN('active', 'contact')";
+ WHERE TRUE " . ze\row::whereCol('users', 'u', 'email', '!=', "");
if (!ze\smartGroup::sql($whereStatement, $sql, $smartGroupId)) {
return false;
@@ -135,23 +134,37 @@ protected static function newsletterRecipientsPart($id, $mode, $smartGroupId) {
AND nul_". (int) $sentNewsletterId. ".user_id IS NULL";
}
- $cField = false;
- if (($cFieldId = ze::setting('zenario_newsletter__all_newsletters_opt_out'))
- && ($cField = ze\dataset::fieldDetails($cFieldId))) {
+ //Exclude users who have opted out of newsletters
+ $optOutFlag = false;
+ if (($optOutFlagId = ze::setting('zenario_newsletter__all_newsletters_opt_out'))
+ && ($optOutFlag = ze\dataset::fieldDetails($optOutFlagId))) {
$sql .= "
LEFT JOIN ". DB_PREFIX. "users_custom_data AS noo
ON noo.user_id = u.id
- AND noo.`". ze\escape::sql($cField['db_column']). "` = 1";
+ AND noo.`". ze\escape::sql($optOutFlag['db_column']). "` = 1";
+ $whereStatement .= "
+ AND noo.user_id IS NULL";
+ }
+
+ //Exclude users who have not given consent to recieve newsletters
+ $consentFlag = false;
+ if (ze::setting('zenario_newsletter__newsletter_consent_policy') == 'consent_required'
+ && ($consentFlagId = ze::setting('zenario_newsletter__newsletter_consent_flag'))
+ && ($consentFlagId != 'no_consent_required')
+ && ($consentFlag = ze\dataset::fieldDetails($consentFlagId))) {
+
+ if ($consentFlag['is_system_field']) {
+ $whereStatement .= "
+ AND u.`". ze\escape::sql($consentFlag['db_column']). "` = 1";
+ } else {
+ $whereStatement .= "
+ AND ucd.`" . ze\escape::sql($consentFlag['db_column']) . "` = 1";
+ }
}
$sql .= "
". $whereStatement;
- if ($cField) {
- $sql .= "
- AND noo.user_id IS NULL";
- }
-
return $sql;
}
diff --git a/zenario/modules/zenario_newsletter/tuix/admin_boxes/newsletter.yaml b/zenario/modules/zenario_newsletter/tuix/admin_boxes/newsletter.yaml
index b5ae327d4..3f1fe9f50 100644
--- a/zenario/modules/zenario_newsletter/tuix/admin_boxes/newsletter.yaml
+++ b/zenario/modules/zenario_newsletter/tuix/admin_boxes/newsletter.yaml
@@ -184,6 +184,10 @@ zenario_newsletter:
value: 1
readonly: true
+ exclude_recipients_with_no_consent:
+ label: Exclude recipients without consent to recieve newsletters
+ type: checkbox
+ readonly: true
unsubscribe_link:
label: 'Unsubscribe link:'
diff --git a/zenario/modules/zenario_newsletter/tuix/admin_boxes/site_settings.yaml b/zenario/modules/zenario_newsletter/tuix/admin_boxes/site_settings.yaml
index 9ed943271..203d5fa74 100644
--- a/zenario/modules/zenario_newsletter/tuix/admin_boxes/site_settings.yaml
+++ b/zenario/modules/zenario_newsletter/tuix/admin_boxes/site_settings.yaml
@@ -51,7 +51,35 @@ site_settings:
empty_value: '-- Select --'
validation:
required: Please select the flag on the user/contact record that should be set when a recipient clicks an Unsubscribe link.
-
+
+
+ zenario_newsletter__newsletter_consent_policy:
+ label: 'Consent policy:'
+ site_setting:
+ name: zenario_newsletter__newsletter_consent_policy
+ type: select
+ empty_value: '-- Select --'
+ values:
+ consent_required:
+ label: 'Users must consent to receiving newsletters (recommended)'
+ no_consent_required:
+ label: 'No consent required'
+ redraw_onchange: true
+ validation:
+ required: Please choose a consent policy for newsletters.
+
+ zenario_newsletter__newsletter_consent_flag:
+ indent: 1
+ visible_if: zenarioAB.value('zenario_newsletter__newsletter_consent_policy') == 'consent_required'
+ label: 'User consent flag:'
+ side_note: 'The flag that indicates a user has consented to receive newsletters'
+ site_setting:
+ name: zenario_newsletter__newsletter_consent_flag
+ type: select
+ empty_value: '-- Select --'
+ validation:
+ required_if_not_hidden: Please select the flag on the user/contact record that shows consent to receive newsletters.
+
zenario_newsletter__enable_opened_emails:
label: 'Enable opened-email tracking'
side_note: 'Check this option to enable tracking of opened emails.'
diff --git a/zenario/modules/zenario_user_forms/module_code.php b/zenario/modules/zenario_user_forms/module_code.php
index 6e1835bf5..24e1f36f7 100644
--- a/zenario/modules/zenario_user_forms/module_code.php
+++ b/zenario/modules/zenario_user_forms/module_code.php
@@ -57,7 +57,7 @@ public function init() {
//This plugin must have a form selected
if (!$formId) {
if (ze\admin::id()) {
- $this->data['form_HTML'] = '
' . ze\admin::phrase('You must select a form for this plugin.') . '
';
+ $this->data['form_HTML'] = '
' . htmlspecialchars(ze\admin::phrase('You must select a form for this plugin.')) . '
';
}
return true;
}
@@ -73,9 +73,9 @@ public function init() {
if (isset($_GET['confirm_email']) && isset($_GET['hash'])) {
$user = ze\row::get('users', ['id', 'email_verified'], ['hash' => $_GET['hash']]);
if (!$user) {
- $this->data['form_HTML'] = '
' . static::fPhrase('We are sorry, but we were unable to find your registration. Please check whether the verification link is correct.', [], $t) . '
';
+ $this->data['form_HTML'] = '
' . htmlspecialchars(static::fPhrase('We are sorry, but we were unable to find your registration. Please check whether the verification link is correct.', [], $t)) . '
';
$html .= $this->closeForm();
@@ -162,13 +162,13 @@ public function init() {
$privacy = ze\row::get('translation_chains', 'privacy', ['equiv_id' => $equivId, 'type' => $this->cType]);
if ($privacy == 'public') {
if (ze\admin::id()) {
- $this->data['form_HTML'] = '
' . ze\admin::phrase('This form has the "save and complete later" feature enabled and so must be placed on a password-protected page.') . '
';
+ $this->data['form_HTML'] = '
' . htmlspecialchars(ze\admin::phrase('This form has the "save and complete later" feature enabled and so must be placed on a password-protected page.')) . '
';
}
return true;
}
if (!$this->userId) {
if (ze\admin::id()) {
- $this->data['form_HTML'] = '
' . ze\admin::phrase('You must be logged in as an Extranet User to see this Plugin.') . '
';
+ $this->data['form_HTML'] = '
' . htmlspecialchars(ze\admin::phrase('You must be logged in as an Extranet User to see this Plugin.')) . '
';
}
return true;
}
@@ -212,7 +212,7 @@ public function init() {
//Logged in user duplicate submission check
if ($this->userId && $this->form['no_duplicate_submissions']) {
if (ze\row::exists(ZENARIO_USER_FORMS_PREFIX . 'user_response', ['user_id' => $this->userId, 'form_id' => $formId])) {
- $html = '