/
campaignion_newsletters.module
219 lines (204 loc) · 6.68 KB
/
campaignion_newsletters.module
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
<?php
/**
* @file
* Campaignion newsletter module.
*/
use \Drupal\campaignion_newsletters\CronRunner;
use \Drupal\campaignion_newsletters\ProviderFactory;
use \Drupal\campaignion_newsletters\FormSubmission;
use \Drupal\campaignion_newsletters\Subscription;
use \Drupal\campaignion_newsletters\Subscriptions;
use \Drupal\campaignion\CRM\Import\Source\WebformSubmission;
use \Drupal\little_helpers\Webform\Submission;
/**
* Implements hook_cron().
*/
function campaignion_newsletters_cron() {
_campaignion_newsletters_poll();
}
/**
* Polling function.
*/
function _campaignion_newsletters_poll() {
$factory = ProviderFactory::getInstance();
foreach ($factory->providers() as $source) {
$provider = $factory->providerByKey($source);
foreach ($provider->getLists() as $list) {
$list->save();
}
}
}
/**
* Implements hook_permission().
*/
function campaignion_newsletters_permission() {
return array(
'administer newsletters' => array(
'title' => t('Administer Newsletters'),
),
);
}
/**
* Implements hook_menu().
*/
function campaignion_newsletters_menu() {
$items['admin/config/services/campaignion_newsletters'] = array(
'title' => t('Newsletter settings'),
'description' => t('Configure newsletter API behavior'),
'page callback' => 'drupal_get_form',
'page arguments' => array('campaignion_newsletters_admin_settings'),
'access arguments' => array('administer newsletters'),
'file' => 'includes/pages.php',
'type' => MENU_NORMAL_ITEM,
);
return $items;
}
/**
* Implements hook_form_FORM_ID_alter().
* Implements hook_form_redhen_contact_contact_form_alter().
*/
function campaignion_newsletters_form_redhen_contact_contact_form_alter(&$form, &$form_state) {
form_load_include($form_state, 'php', 'campaignion_newsletters', 'includes/pages');
_campaignion_newsletters_form_redhen_contact_contact_form_alter($form, $form_state);
}
/**
* Implements hook_webform_component_info().
*/
function campaignion_newsletters_webform_component_info() {
return array(
'newsletter' => array(
'label' => t('Newsletter Subscription'),
'description' => t('Offers a user to subscribe to a given newsletter.'),
'features' => array(
'conditional' => TRUE,
'description' => FALSE,
),
'file' => 'campaignion_newsletters.component.inc',
),
);
}
/**
* Implements hook_webform_submission_confirmed().
*/
function campaignion_newsletters_webform_submission_confirmed(Submission $submission) {
$s = new WebformSubmission($submission->node, $submission);
// use value of the component with key 'email' as email address
if (!($email = $s->value('email'))) {
return;
}
foreach ($s->webform->componentsByType('newsletter') as $component) {
if ($s->valueByCid($component['cid'])) {
$needs_opt_in = !$component['extra']['opt_in_implied'];
foreach ($component['extra']['lists'] as $list_id => $value) {
if (!empty($value)) {
$subscription = Subscription::byData($list_id, $email);
$subscription->delete = FALSE;
$subscription->source = $s;
$subscription->needs_opt_in = $needs_opt_in;
$subscription->send_welcome = (bool) $component['extra']['send_welcome'];
$subscription->optin_info = FormSubmission::fromWebformSubmission($s);
$subscription->save();
}
}
}
}
}
/**
* Implements hook_form_builder_element_types().
*
* Defines a new form_builder field:
* - 'title'
* - in which ['palette_group'] it appears. @see hook_form_builder_palette_groups().
* - it's ['default'] representation (is used when dragging it into the preview area) including:
* - ['#webform_component'] the component array for webform (most important it's ['#webform_component']['type'].
* @see hook_webform_component_info().
* - ['#type'] the form-API type is used as the default form_builder element_type.
* @see hook_element_info().
* - ['#form_builder'] the form_builder type (again).
* @see hook_form_builder_element_types().
* - whether or not the field is ['unique'].
*
* Fields are defined per form_type (so far only 'webform' is relevant for us).
*/
function campaignion_newsletters_form_builder_element_types($form_type, $form_id) {
if ($form_type != 'webform') {
return;
}
require_once dirname(__FILE__) . '/campaignion_newsletters.component.inc';
$map = _form_builder_webform_property_map('newsletter');
// default value is handled by the newsletter property.
unset($map['properties']['default_value']);
unset($map['properties']['description']);
$fields['newsletter'] = array(
'title' => t('Newsletter'),
'properties' => array_keys($map['properties']),
'default' => array(
'#form_builder' => array('element_type' => 'newsletter'),
) + _form_builder_webform_default('newsletter'),
);
return $fields;
}
/**
* Implements hook_form_builder_element_types_alter().
*
* Remove the email_newsletter field from campaignion_form_builder.
*/
function campaignion_newsletters_form_builder_element_types_alter(&$fields, $form_type, $form_id) {
if ($form_type == 'webform') {
unset($fields['email_newsletter']);
}
}
/**
* Implements hook_entity_insert().
*
* Save all subscriptions for the redhen_contact.
*/
function campaignion_newsletters_entity_insert($entity, $entity_type) {
campaignion_newsletters_entity_update($entity, $entity_type);
}
/**
* Implements hook_entity_update().
*
* Save all subscriptions for the redhen_contact.
*/
function campaignion_newsletters_entity_update($entity, $entity_type) {
if ($entity_type != 'redhen_contact') {
return;
}
if (empty($entity->newsletters)) {
$entity->newsletters = Subscriptions::byContact($entity);
}
$entity->newsletters->save();
}
/**
* Implements hook_entity_delete().
*
* Unsubscribe from all newsletters.
*/
function campaignion_newsletters_entity_delete($entity, $entity_type) {
if ($entity_type != 'redhen_contact') {
return;
}
if (empty($entity->newsletters)) {
$entity->newsletters = Subscriptions::byContact($entity);
}
$entity->newsletters->unsubscribeAll();
$entity->newsletters->save();
}
/**
* Implements hook_cronapi().
*/
function campaignion_newsletters_cronapi($op, $job = NULL) {
$items['campaignion_newsletters_send_queue'] = array(
'description' => 'Send queue data to newsletter providers',
'rule' => '*/2+@ * * * *',
'weight' => 100,
'callback' => [CronRunner::class, 'cronSendQueue'],
);
$items['campaignion_newsletters_poll_subscriptions'] = [
'descriptions' => 'Let providers poll their subscriptions in order to cach changes from the provider side.',
'rule' => '*/2+@ * * * *',
'callback' => [CronRunner::class, 'cronPoll'],
];
return $items;
}