forked from giant-rabbit/com.giantrabbit.civimailchimp
/
civimailchimp.php
536 lines (499 loc) · 20 KB
/
civimailchimp.php
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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
<?php
require_once 'civimailchimp.civix.php';
require_once 'vendor/autoload.php';
function civimailchimp_civicrm_contact_added_to_group($group, $contact) {
$mailchimp_sync_setting = CRM_CiviMailchimp_BAO_SyncSettings::findByGroupId($group->id);
if ($mailchimp_sync_setting) {
$mailchimp_email = CRM_CiviMailchimp_Utils::determineMailchimpEmailForContact($contact);
if ($mailchimp_email !== NULL) {
$merge_fields = CRM_CiviMailchimp_Utils::getMailchimpMergeFields($mailchimp_sync_setting->mailchimp_list_id);
$merge_vars = CRM_CiviMailchimp_Utils::formatMailchimpMergeVars($merge_fields, $contact);
CRM_CiviMailchimp_Utils::addMailchimpSyncQueueItem('subscribeContactToMailchimpList', $mailchimp_sync_setting->mailchimp_list_id, $mailchimp_email, $merge_vars);
}
}
}
function civimailchimp_civicrm_contact_removed_from_group($group, $contact) {
$mailchimp_sync_setting = CRM_CiviMailchimp_BAO_SyncSettings::findByGroupId($group->id);
if ($mailchimp_sync_setting) {
$mailchimp_email = CRM_CiviMailchimp_Utils::determineMailchimpEmailForContact($contact);
if ($mailchimp_email !== NULL) {
CRM_CiviMailchimp_Utils::addMailchimpSyncQueueItem('unsubscribeContactFromMailchimpList', $mailchimp_sync_setting->mailchimp_list_id, $mailchimp_email);
}
}
}
function civimailchimp_civicrm_contact_updated($old_contact, $new_contact) {
$mailchimp_sync_settings = CRM_CiviMailchimp_BAO_SyncSettings::findByContactId($new_contact->id);
if ($mailchimp_sync_settings) {
$old_contact_email = CRM_CiviMailchimp_Utils::determineMailchimpEmailForContact($old_contact);
$new_contact_email = CRM_CiviMailchimp_Utils::determineMailchimpEmailForContact($new_contact);
if ($old_contact_email === NULL && $new_contact_email !== NULL) {
// Add contact to mailchimp list.
CRM_CiviMailchimp_Utils::addUpdatedContactToMailchimpList($new_contact, $new_contact_email, $mailchimp_sync_settings);
}
elseif ($old_contact_email !== NULL && $new_contact_email === NULL) {
// Remove contact from mailchimp list.
CRM_CiviMailchimp_Utils::removeUpdatedContactFromMailchimpList($old_contact_email, $mailchimp_sync_settings);
}
elseif ($old_contact_email !== NULL && $new_contact_email !== NULL) {
// Update contact record in mailcimp.
CRM_CiviMailchimp_Utils::updateContactInMailchimpList($old_contact_email, $new_contact_email, $old_contact, $new_contact, $mailchimp_sync_settings);
}
}
}
/**
* Implementation of hook_civicrm_pageRun
*/
function civimailchimp_civicrm_pageRun(&$page) {
if (CRM_Core_Permission::check('administer CiviCRM')) {
CRM_CiviMailchimp_BAO_SyncLog::renderMessages();
}
}
/**
* Implementation of hook_civicrm_buildForm
*/
function civimailchimp_civicrm_buildForm($formName, &$form) {
// Render any Sync Log Messages.
if (CRM_Core_Permission::check('administer CiviCRM')) {
CRM_CiviMailchimp_BAO_SyncLog::renderMessages();
}
// Don't display the Mailchimp fields if this is a Smart Group.
if ($formName === "CRM_Group_Form_Edit" && empty($form->_defaultValues['saved_search_id'])) {
$interest_groups_lookup = array();
try {
$mailchimp_lists = CRM_CiviMailchimp_Utils::getLists();
}
catch (Exception $e) {
$mailchimp_lists = NULL;
civimailchimp_catch_mailchimp_api_error($e);
}
if ($mailchimp_lists) {
$group_id = $form->getVar('_id');
$list_options = CRM_CiviMailchimp_Utils::formatListsAsSelectOptions($mailchimp_lists);
$interest_groups_lookup = CRM_CiviMailchimp_Utils::formatInterestGroupsLookup($mailchimp_lists);
$interest_groups_options = '';
if ($group_id) {
$mailchimp_sync_settings = CRM_CiviMailchimp_BAO_SyncSettings::findByGroupId($group_id);
if ($mailchimp_sync_settings) {
if (isset($interest_groups_lookup[$mailchimp_sync_settings->mailchimp_list_id])) {
$interest_groups_options = $interest_groups_lookup[$mailchimp_sync_settings->mailchimp_list_id];
}
civimailchimp_civicrm_setDefaults($form, $mailchimp_sync_settings);
}
}
$form->add('select', 'mailchimp_list', ts('Mailchimp List'), $list_options, FALSE, array('class' => 'crm-select2'));
$form->add('select', 'mailchimp_interest_groups', ts('Mailchimp Interest Groups'), $interest_groups_options, FALSE, array('multiple' => 'multiple', 'class' => 'crm-select2'));
$form->assign('mailchimp_lists', TRUE);
}
CRM_Core_Resources::singleton()
->addScriptFile('com.giantrabbit.civimailchimp', 'js/group_add_edit_form.js')
->addSetting(array('civiMailchimp' => array('interest_groups_lookup' => $interest_groups_lookup)));
}
}
/**
* Sets default values for the Mailchimp sync settings for a group.
*/
function civimailchimp_civicrm_setDefaults(&$form, $mailchimp_sync_setting) {
$defaults = civimailchimp_get_default_sync_settings_for_group($mailchimp_sync_setting);
$form->setDefaults($defaults);
}
/**
* Implementation of hook_civicrm_validateForm
*/
function civimailchimp_civicrm_validateForm($formName, &$fields, &$files, &$form, &$errors) {
if ($formName === "CRM_Group_Form_Edit") {
if (!empty($fields['mailchimp_list'])) {
$site_key = defined('CIVICRM_SITE_KEY') ? CIVICRM_SITE_KEY : NULL;
if (!$site_key) {
$doc_link = CRM_Utils_System::docURL2("Managing Scheduled Jobs", TRUE, NULL, NULL, NULL, "wiki");
$errors['mailchimp_list'] = ts("A valid CiviCRM site key in civicrm.settings.php is required to configure a Group to sync with Mailchimp. More info on generating a site key at %1.", array(1 => $doc_link));
}
$mailchimp_sync_setting = CRM_CiviMailchimp_BAO_SyncSettings::findByListId($fields['mailchimp_list'], FALSE);
if ($mailchimp_sync_setting) {
$group_id = $form->getVar('_id');
if ($mailchimp_sync_setting->civicrm_group_id != $group_id) {
$errors['mailchimp_list'] = ts("Another CiviCRM Group is already configured to sync to this Mailchimp list. Please select another list.");
}
}
}
}
}
/**
* Implementation of hook_civicrm_postProcess for the Group Edit form.
*/
function civimailchimp_civicrm_postProcess($formName, &$form) {
// If the Mailchimp API call fails, the mailchimp_list field will not be
// added to the form, so we want to retain the existing Mailchimp List
// sync settings for the group, if the group is edited.
if ($formName === "CRM_Group_Form_Edit" && isset($form->_elementIndex['mailchimp_list'])) {
$params['civicrm_group_id'] = $form->getVar('_id');
// When creating a new group, the group ID is only accessible from the
// 'amtgID' session variable.
if (empty($params['civicrm_group_id'])) {
$params['civicrm_group_id'] = $form->get('amtgID');
}
if ($form->_submitValues['mailchimp_list']) {
$params['mailchimp_list_id'] = $form->_submitValues['mailchimp_list'];
if (isset($form->_submitValues['mailchimp_interest_groups'])) {
$params['mailchimp_interest_groups'] = $form->_submitValues['mailchimp_interest_groups'];
}
CRM_CiviMailchimp_BAO_SyncSettings::saveSettings($params);
}
else {
$mailchimp_sync_setting = CRM_CiviMailchimp_BAO_SyncSettings::findByGroupId($params['civicrm_group_id']);
if ($mailchimp_sync_setting) {
CRM_CiviMailchimp_BAO_SyncSettings::deleteSettings($mailchimp_sync_setting);
}
}
}
}
/**
* Get the default values for the Group edit form for Mailchimp Sync Settings.
*/
function civimailchimp_get_default_sync_settings_for_group($mailchimp_sync_setting) {
$mailchimp_interest_groups_defaults = array();
if (!empty($mailchimp_sync_setting->mailchimp_interest_groups)) {
foreach ($mailchimp_sync_setting->mailchimp_interest_groups as $mailchimp_interest_grouping => $mailchimp_interest_groups) {
foreach ($mailchimp_interest_groups as $mailchimp_interest_group) {
$mailchimp_interest_groups_defaults[] = "{$mailchimp_interest_grouping}_{$mailchimp_interest_group->mailchimp_interest_group_id}";
}
}
}
$defaults = array(
'mailchimp_list' => $mailchimp_sync_setting->mailchimp_list_id,
'mailchimp_interest_groups' => $mailchimp_interest_groups_defaults,
);
return $defaults;
}
/**
* Catch a Mailchimp API error and add an entry to the CiviCRM log file.
*/
function civimailchimp_catch_mailchimp_api_error($exception) {
// If the Mailchimp API call fails, we want to still allow admins to
// create or edit a group.
$error = array(
'code' => get_class($exception),
'message' => $exception->getMessage(),
);
$message = ts("There was an error when trying to retrieve available Mailchimp Lists to sync to a group. {$error['code']}: {$error['message']}.");
if (CRM_Core_Permission::check('administer CiviCRM')) {
$session = CRM_Core_Session::singleton();
$session->setStatus($message, ts("Mailchimp API Error"), 'alert', array('expires' => 0));
}
CRM_Core_Error::debug_var('Fatal Error Details', $error);
CRM_Core_Error::backtrace('backTrace', TRUE);
}
/**
* Implements hook_civicrm_pre for GroupContact create.
*/
function civimailchimp_civicrm_pre_GroupContact_create($group_id, &$contact_ids) {
// The create operation for GroupContact is thrown for every existing and
// new group when a contact is saved, so we have to do some extra work
// to determine whether the contact has just been added to the group or
// not. We're storing the actually added Groups in a static variable for
// use in the civicrm_post hook.
foreach ($contact_ids as $contact_id) {
$contacts_added_to_group = array();
$contact_added_to_group = CRM_CiviMailchimp_Utils::contactAddedToGroup($group_id, $contact_id);
if ($contact_added_to_group) {
$contacts_added_to_group[] = $contact_id;
}
civimailchimp_static('contacts_added_to_group', $contacts_added_to_group);
}
}
/**
* Implements hook_civicrm_post for GroupContact create.
*/
function civimailchimp_civicrm_post_GroupContact_create($group_id, &$contact_ids) {
$contacts_added_to_group = civimailchimp_static('contacts_added_to_group');
if ($contacts_added_to_group) {
$group = CRM_CiviMailchimp_Utils::getGroupById($group_id);
foreach ($contacts_added_to_group as $contact_id) {
$contact = CRM_CiviMailchimp_Utils::getContactById($contact_id);
civimailchimp_civicrm_contact_added_to_group($group, $contact);
}
}
}
/**
* Implements hook_civicrm_post for GroupContact delete.
*/
function civimailchimp_civicrm_post_GroupContact_delete($group_id, &$contact_ids) {
$group = CRM_CiviMailchimp_Utils::getGroupById($group_id);
foreach ($contact_ids as $contact_id) {
$contact = CRM_CiviMailchimp_Utils::getContactById($contact_id);
civimailchimp_civicrm_contact_removed_from_group($group, $contact);
}
}
/**
* Implements hook_civicrm_pre for Individual and Organization Email.
*/
function civimailchimp_civicrm_pre_Email($op, $email_id, &$email) {
// We don't want to run this processing if the full contact record is edited
// so we check for a static variable we're setting in the contact pre edit
// hook and only continue if that is not set.
$old_contact = civimailchimp_static('old_contact');
if (!$old_contact) {
// When an email is deleted, $email is empty, so we have to lookup the
// contact ID.
if (!empty($email['contact_id'])) {
$contact_id = $email['contact_id'];
}
else {
$email = CRM_CiviMailchimp_Utils::getEmailbyId($email_id);
$contact_id = $email->contact_id;
}
$old_contact_from_email = CRM_CiviMailchimp_Utils::getContactById($contact_id);
civimailchimp_static('old_contact_from_email', $old_contact_from_email);
}
}
/**
* Implements hook_civicrm_post for Individual and Organization Email.
*/
function civimailchimp_civicrm_post_Email($op, $email_id, &$email) {
// We only want to run this if only the email address is changed since
// we're already handling the case where the full contact is editied.
$old_contact = civimailchimp_static('old_contact_from_email');
if ($old_contact) {
$new_contact = CRM_CiviMailchimp_Utils::getContactById($old_contact->id);
civimailchimp_civicrm_contact_updated($old_contact, $new_contact);
}
}
/**
* Implements hook_civicrm_pre for Individual and Organization edit.
*/
function civimailchimp_civicrm_pre_Contact_edit($contact_id, &$contact) {
$old_contact = CRM_CiviMailchimp_Utils::getContactById($contact_id);
civimailchimp_static('old_contact', $old_contact);
}
/**
* Implements hook_civicrm_post for Individual and Organization edit.
*/
function civimailchimp_civicrm_post_Contact_edit($contact_id, &$contact) {
$old_contact = civimailchimp_static('old_contact');
$new_contact = $contact;
civimailchimp_civicrm_contact_updated($old_contact, $new_contact);
}
/**
* Implements hook_civicrm_post for Individual and Organization delete.
*/
function civimailchimp_civicrm_post_Contact_delete($contact_id, &$contact) {
$params = array("contact_id" => $contact_id);
$contact_groups = CRM_Contact_BAO_Group::getGroups($params);
foreach ($contact_groups as $group) {
civimailchimp_civicrm_contact_removed_from_group($group, $contact);
}
}
/**
* Implements hook_civicrm_pre for Group delete.
*/
function civimailchimp_civicrm_pre_Group_delete($group_id, &$group) {
$mailchimp_sync_settings = CRM_CiviMailchimp_BAO_SyncSettings::findByGroupId($group_id);
if ($mailchimp_sync_settings) {
civimailchimp_static('mailchimp_sync_settings', $mailchimp_sync_settings);
}
}
/**
* Implements hook_civicrm_post for Group delete.
*/
function civimailchimp_civicrm_post_Group_delete($group_id, &$group) {
$mailchimp_sync_settings = civimailchimp_static('mailchimp_sync_settings');
if ($mailchimp_sync_settings) {
CRM_CiviMailchimp_Utils::deleteWebhookFromMailchimpList($mailchimp_sync_settings->mailchimp_list_id);
}
}
/**
* Implementation of hook_civicrm_pre
*/
function civimailchimp_civicrm_pre($op, $object_name, $id, &$params) {
if (!civimailchimp_static('mailchimp_do_not_run_hooks')) {
if ($object_name === "Individual" || $object_name === "Organization") {
$object_name = "Contact";
}
$function_name_object_op = "civimailchimp_civicrm_pre_{$object_name}_{$op}";
$function_name_object = "civimailchimp_civicrm_pre_{$object_name}";
if (is_callable($function_name_object_op)) {
call_user_func($function_name_object_op, $id, $params);
}
elseif (is_callable($function_name_object)) {
call_user_func($function_name_object, $op, $id, $params);
}
}
}
/**
* Implementation of hook_civicrm_post
*/
function civimailchimp_civicrm_post($op, $object_name, $object_id, &$object) {
if (!civimailchimp_static('mailchimp_do_not_run_hooks')) {
if ($object_name === "Individual" || $object_name === "Organization") {
$object_name = "Contact";
}
$function_name_object_op = "civimailchimp_civicrm_post_{$object_name}_{$op}";
$function_name_object = "civimailchimp_civicrm_post_{$object_name}";
if (is_callable($function_name_object_op)) {
call_user_func($function_name_object_op, $object_id, $object);
}
elseif (is_callable($function_name_object)) {
call_user_func($function_name_object, $op, $object_id, $object);
}
}
}
/**
* Stores a static variable of a certain name for later retrieval.
*/
function civimailchimp_static($name, $new_value = NULL, $reset = FALSE) {
static $data = NULL;
if ($reset) {
$data = array();
return $data;
}
if ($new_value !== NULL) {
$data[$name] = $new_value;
}
if (isset($data[$name])) {
return $data[$name];
}
}
/**
* Implementation of hook_civicrm_config
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_config
*/
function civimailchimp_civicrm_config(&$config) {
_civimailchimp_civix_civicrm_config($config);
}
/**
* Implementation of hook_civicrm_xmlMenu
*
* @param $files array(string)
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_xmlMenu
*/
function civimailchimp_civicrm_xmlMenu(&$files) {
_civimailchimp_civix_civicrm_xmlMenu($files);
}
/**
* Implementation of hook_civicrm_install
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_install
*/
function civimailchimp_civicrm_install() {
_civimailchimp_civix_civicrm_install();
CRM_CiviMailchimp_Utils::createSyncScheduledJob();
}
/**
* Implementation of hook_civicrm_uninstall
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_uninstall
*/
function civimailchimp_civicrm_uninstall() {
_civimailchimp_civix_civicrm_uninstall();
}
/**
* Implementation of hook_civicrm_enable
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_enable
*/
function civimailchimp_civicrm_enable() {
_civimailchimp_civix_civicrm_enable();
}
/**
* Implementation of hook_civicrm_disable
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_disable
*/
function civimailchimp_civicrm_disable() {
_civimailchimp_civix_civicrm_disable();
}
/**
* Implementation of hook_civicrm_upgrade
*
* @param $op string, the type of operation being performed; 'check' or 'enqueue'
* @param $queue CRM_Queue_Queue, (for 'enqueue') the modifiable list of pending up upgrade tasks
*
* @return mixed based on op. for 'check', returns array(boolean) (TRUE if upgrades are pending)
* for 'enqueue', returns void
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_upgrade
*/
function civimailchimp_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) {
return _civimailchimp_civix_civicrm_upgrade($op, $queue);
}
/**
* Implementation of hook_civicrm_managed
*
* Generate a list of entities to create/deactivate/delete when this module
* is installed, disabled, uninstalled.
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_managed
*/
function civimailchimp_civicrm_managed(&$entities) {
_civimailchimp_civix_civicrm_managed($entities);
}
/**
* Implementation of hook_civicrm_alterSettingsFolders
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_alterSettingsFolders
*/
function civimailchimp_civicrm_alterSettingsFolders(&$metaDataFolders = NULL) {
_civimailchimp_civix_civicrm_alterSettingsFolders($metaDataFolders);
}
/**
* Implementation of hook_civicrm_navigationMenu
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_navigationMenu
*/
function civimailchimp_civicrm_navigationMenu(&$params) {
$administer_nav_id = CRM_Core_DAO::getFieldValue('CRM_Core_BAO_Navigation', 'Administer', 'id', 'name');
if ($administer_nav_id) {
$weight = max(array_keys($params[$administer_nav_id]['child']));
$params[$administer_nav_id]['child'][$weight+1] = array(
'attributes' => array(
'label' => 'CiviMailchimp',
'name' => 'CiviMailchimp',
'url' => NULL,
'permission' => 'administer CiviCRM',
'operator' => NULL,
'parentID' => $administer_nav_id,
'navID' => NULL,
'active' => 1,
),
'child' => array(
0 => array(
'attributes' => array(
'label' => 'Mailchimp Settings',
'name' => 'Mailchimp Settings',
'url' => 'civicrm/admin/mailchimp/settings?reset=1',
'permission' => 'administer CiviCRM',
'operator' => NULL,
'parentID' => NULL,
'navID' => NULL,
'active' => 1,
),
),
1 => array(
'attributes' => array(
'label' => 'Force Sync',
'name' => 'Force Sync',
'url' => 'civicrm/admin/mailchimp/sync?reset=1',
'permission' => 'administer CiviCRM',
'operator' => NULL,
'parentID' => NULL,
'navID' => NULL,
'active' => 1,
),
),
2 => array(
'attributes' => array(
'label' => 'Sync Log',
'name' => 'Sync Log',
'url' => 'civicrm/admin/mailchimp/log?reset=1',
'permission' => 'administer CiviCRM',
'operator' => NULL,
'parentID' => NULL,
'navID' => NULL,
'active' => 1,
),
),
),
);
}
}