479 lines
18 KiB
PHP
479 lines
18 KiB
PHP
<?php
|
||
/*
|
||
+--------------------------------------------------------------------+
|
||
| CiviCRM version 4.7 |
|
||
+--------------------------------------------------------------------+
|
||
| Copyright CiviCRM LLC (c) 2004-2017 |
|
||
+--------------------------------------------------------------------+
|
||
| This file is a part of CiviCRM. |
|
||
| |
|
||
| CiviCRM is free software; you can copy, modify, and distribute it |
|
||
| under the terms of the GNU Affero General Public License |
|
||
| Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
|
||
| |
|
||
| CiviCRM 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 Affero General Public License for more details. |
|
||
| |
|
||
| You should have received a copy of the GNU Affero General Public |
|
||
| License and the CiviCRM Licensing Exception along |
|
||
| with this program; if not, contact CiviCRM LLC |
|
||
| at info[AT]civicrm[DOT]org. If you have questions about the |
|
||
| GNU Affero General Public License or the licensing of CiviCRM, |
|
||
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
|
||
+--------------------------------------------------------------------+
|
||
*/
|
||
|
||
/**
|
||
*
|
||
* @package CRM
|
||
* @copyright CiviCRM LLC (c) 2004-2017
|
||
*/
|
||
|
||
// we should consider moving these to the settings table
|
||
// before the 4.1 release
|
||
define('EMAIL_ACTIVITY_TYPE_ID', NULL);
|
||
define('MAIL_BATCH_SIZE', 50);
|
||
|
||
/**
|
||
* Class CRM_Utils_Mail_EmailProcessor.
|
||
*/
|
||
class CRM_Utils_Mail_EmailProcessor {
|
||
|
||
/**
|
||
* Process the default mailbox (ie. that is used by civiMail for the bounce)
|
||
*
|
||
* @param bool $is_create_activities
|
||
* Should activities be created
|
||
*/
|
||
public static function processBounces($is_create_activities) {
|
||
$dao = new CRM_Core_DAO_MailSettings();
|
||
$dao->domain_id = CRM_Core_Config::domainID();
|
||
$dao->is_default = TRUE;
|
||
$dao->find();
|
||
|
||
while ($dao->fetch()) {
|
||
self::_process(TRUE, $dao, $is_create_activities);
|
||
}
|
||
}
|
||
|
||
/**
|
||
* Delete old files from a given directory (recursively).
|
||
*
|
||
* @param string $dir
|
||
* Directory to cleanup.
|
||
* @param int $age
|
||
* Files older than this many seconds will be deleted (default: 60 days).
|
||
*/
|
||
public static function cleanupDir($dir, $age = 5184000) {
|
||
// return early if we can’t read/write the dir
|
||
if (!is_writable($dir) or !is_readable($dir) or !is_dir($dir)) {
|
||
return;
|
||
}
|
||
|
||
foreach (scandir($dir) as $file) {
|
||
|
||
// don’t go up the directory stack and skip new files/dirs
|
||
if ($file == '.' or $file == '..') {
|
||
continue;
|
||
}
|
||
if (filemtime("$dir/$file") > time() - $age) {
|
||
continue;
|
||
}
|
||
|
||
// it’s an old file/dir, so delete/recurse
|
||
is_dir("$dir/$file") ? self::cleanupDir("$dir/$file", $age) : unlink("$dir/$file");
|
||
}
|
||
}
|
||
|
||
/**
|
||
* Process the mailboxes that aren't default (ie. that aren't used by civiMail for the bounce).
|
||
*/
|
||
public static function processActivities() {
|
||
$dao = new CRM_Core_DAO_MailSettings();
|
||
$dao->domain_id = CRM_Core_Config::domainID();
|
||
$dao->is_default = FALSE;
|
||
$dao->find();
|
||
$found = FALSE;
|
||
while ($dao->fetch()) {
|
||
$found = TRUE;
|
||
self::_process(FALSE, $dao, TRUE);
|
||
}
|
||
if (!$found) {
|
||
CRM_Core_Error::fatal(ts('No mailboxes have been configured for Email to Activity Processing'));
|
||
}
|
||
return $found;
|
||
}
|
||
|
||
/**
|
||
* Process the mailbox for all the settings from civicrm_mail_settings.
|
||
*
|
||
* @param bool|string $civiMail if true, processing is done in CiviMail context, or Activities otherwise.
|
||
*/
|
||
public static function process($civiMail = TRUE) {
|
||
$dao = new CRM_Core_DAO_MailSettings();
|
||
$dao->domain_id = CRM_Core_Config::domainID();
|
||
$dao->find();
|
||
|
||
while ($dao->fetch()) {
|
||
self::_process($civiMail, $dao);
|
||
}
|
||
}
|
||
|
||
/**
|
||
* @param $civiMail
|
||
* @param CRM_Core_DAO_MailSettings $dao
|
||
* @param bool $is_create_activities
|
||
* Create activities.
|
||
*
|
||
* @throws Exception
|
||
*/
|
||
public static function _process($civiMail, $dao, $is_create_activities) {
|
||
// 0 = activities; 1 = bounce;
|
||
$usedfor = $dao->is_default;
|
||
|
||
$emailActivityTypeId
|
||
= (defined('EMAIL_ACTIVITY_TYPE_ID') && EMAIL_ACTIVITY_TYPE_ID)
|
||
? EMAIL_ACTIVITY_TYPE_ID
|
||
: CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Inbound Email');
|
||
|
||
if (!$emailActivityTypeId) {
|
||
CRM_Core_Error::fatal(ts('Could not find a valid Activity Type ID for Inbound Email'));
|
||
}
|
||
|
||
$config = CRM_Core_Config::singleton();
|
||
$verpSeperator = preg_quote($config->verpSeparator);
|
||
$twoDigitStringMin = $verpSeperator . '(\d+)' . $verpSeperator . '(\d+)';
|
||
$twoDigitString = $twoDigitStringMin . $verpSeperator;
|
||
$threeDigitString = $twoDigitString . '(\d+)' . $verpSeperator;
|
||
|
||
// FIXME: legacy regexen to handle CiviCRM 2.1 address patterns, with domain id and possible VERP part
|
||
$commonRegex = '/^' . preg_quote($dao->localpart) . '(b|bounce|c|confirm|o|optOut|r|reply|re|e|resubscribe|u|unsubscribe)' . $threeDigitString . '([0-9a-f]{16})(-.*)?@' . preg_quote($dao->domain) . '$/';
|
||
$subscrRegex = '/^' . preg_quote($dao->localpart) . '(s|subscribe)' . $twoDigitStringMin . '@' . preg_quote($dao->domain) . '$/';
|
||
|
||
// a common-for-all-actions regex to handle CiviCRM 2.2 address patterns
|
||
$regex = '/^' . preg_quote($dao->localpart) . '(b|c|e|o|r|u)' . $twoDigitString . '([0-9a-f]{16})@' . preg_quote($dao->domain) . '$/';
|
||
|
||
// a tighter regex for finding bounce info in soft bounces’ mail bodies
|
||
$rpRegex = '/Return-Path:\s*' . preg_quote($dao->localpart) . '(b)' . $twoDigitString . '([0-9a-f]{16})@' . preg_quote($dao->domain) . '/';
|
||
|
||
// a regex for finding bound info X-Header
|
||
$rpXheaderRegex = '/X-CiviMail-Bounce: ' . preg_quote($dao->localpart) . '(b)' . $twoDigitString . '([0-9a-f]{16})@' . preg_quote($dao->domain) . '/i';
|
||
// CiviMail in regex and Civimail in header !!!
|
||
|
||
// retrieve the emails
|
||
try {
|
||
$store = CRM_Mailing_MailStore::getStore($dao->name);
|
||
}
|
||
catch (Exception$e) {
|
||
$message = ts('Could not connect to MailStore for ') . $dao->username . '@' . $dao->server . '<p>';
|
||
$message .= ts('Error message: ');
|
||
$message .= '<pre>' . $e->getMessage() . '</pre><p>';
|
||
CRM_Core_Error::fatal($message);
|
||
}
|
||
|
||
// process fifty at a time, CRM-4002
|
||
while ($mails = $store->fetchNext(MAIL_BATCH_SIZE)) {
|
||
foreach ($mails as $key => $mail) {
|
||
|
||
// for every addressee: match address elements if it's to CiviMail
|
||
$matches = array();
|
||
$action = NULL;
|
||
|
||
if ($usedfor == 1) {
|
||
foreach ($mail->to as $address) {
|
||
if (preg_match($regex, $address->email, $matches)) {
|
||
list($match, $action, $job, $queue, $hash) = $matches;
|
||
break;
|
||
// FIXME: the below elseifs should be dropped when we drop legacy support
|
||
}
|
||
elseif (preg_match($commonRegex, $address->email, $matches)) {
|
||
list($match, $action, $_, $job, $queue, $hash) = $matches;
|
||
break;
|
||
}
|
||
elseif (preg_match($subscrRegex, $address->email, $matches)) {
|
||
list($match, $action, $_, $job) = $matches;
|
||
break;
|
||
}
|
||
}
|
||
|
||
// CRM-5471: if $matches is empty, it still might be a soft bounce sent
|
||
// to another address, so scan the body for ‘Return-Path: …bounce-pattern…’
|
||
if (!$matches and preg_match($rpRegex, $mail->generateBody(), $matches)) {
|
||
list($match, $action, $job, $queue, $hash) = $matches;
|
||
}
|
||
|
||
// if $matches is still empty, look for the X-CiviMail-Bounce header
|
||
// CRM-9855
|
||
if (!$matches and preg_match($rpXheaderRegex, $mail->generateBody(), $matches)) {
|
||
list($match, $action, $job, $queue, $hash) = $matches;
|
||
}
|
||
// With Mandrilla, the X-CiviMail-Bounce header is produced by generateBody
|
||
// is base64 encoded
|
||
// Check all parts
|
||
if (!$matches) {
|
||
$all_parts = $mail->fetchParts();
|
||
foreach ($all_parts as $k_part => $v_part) {
|
||
if ($v_part instanceof ezcMailFile) {
|
||
$p_file = $v_part->__get('fileName');
|
||
$c_file = file_get_contents($p_file);
|
||
if (preg_match($rpXheaderRegex, $c_file, $matches)) {
|
||
list($match, $action, $job, $queue, $hash) = $matches;
|
||
}
|
||
}
|
||
}
|
||
}
|
||
|
||
// if all else fails, check Delivered-To for possible pattern
|
||
if (!$matches and preg_match($regex, $mail->getHeader('Delivered-To'), $matches)) {
|
||
list($match, $action, $job, $queue, $hash) = $matches;
|
||
}
|
||
}
|
||
|
||
// preseve backward compatibility
|
||
if ($usedfor == 0 || $is_create_activities) {
|
||
// if its the activities that needs to be processed ..
|
||
try {
|
||
$mailParams = CRM_Utils_Mail_Incoming::parseMailingObject($mail);
|
||
}
|
||
catch (Exception $e) {
|
||
echo $e->getMessage();
|
||
$store->markIgnored($key);
|
||
continue;
|
||
}
|
||
|
||
require_once 'CRM/Utils/DeprecatedUtils.php';
|
||
$params = _civicrm_api3_deprecated_activity_buildmailparams($mailParams, $emailActivityTypeId);
|
||
|
||
$params['version'] = 3;
|
||
if (!empty($dao->activity_status)) {
|
||
$params['status_id'] = $dao->activity_status;
|
||
}
|
||
$result = civicrm_api('activity', 'create', $params);
|
||
|
||
if ($result['is_error']) {
|
||
$matches = FALSE;
|
||
echo "Failed Processing: {$mail->subject}. Reason: {$result['error_message']}\n";
|
||
}
|
||
else {
|
||
$matches = TRUE;
|
||
CRM_Utils_Hook::emailProcessor('activity', $params, $mail, $result);
|
||
echo "Processed as Activity: {$mail->subject}\n";
|
||
}
|
||
}
|
||
|
||
// if $matches is empty, this email is not CiviMail-bound
|
||
if (!$matches) {
|
||
$store->markIgnored($key);
|
||
continue;
|
||
}
|
||
|
||
// get $replyTo from either the Reply-To header or from From
|
||
// FIXME: make sure it works with Reply-Tos containing non-email stuff
|
||
$replyTo = $mail->getHeader('Reply-To') ? $mail->getHeader('Reply-To') : $mail->from->email;
|
||
|
||
// handle the action by passing it to the proper API call
|
||
// FIXME: leave only one-letter cases when dropping legacy support
|
||
if (!empty($action)) {
|
||
$result = NULL;
|
||
|
||
switch ($action) {
|
||
case 'b':
|
||
case 'bounce':
|
||
$text = '';
|
||
if ($mail->body instanceof ezcMailText) {
|
||
$text = $mail->body->text;
|
||
}
|
||
elseif ($mail->body instanceof ezcMailMultipart) {
|
||
if ($mail->body instanceof ezcMailMultipartReport) {
|
||
$part = $mail->body->getMachinePart();
|
||
if ($part instanceof ezcMailDeliveryStatus) {
|
||
foreach ($part->recipients as $rec) {
|
||
if (isset($rec["Diagnostic-Code"])) {
|
||
$text = $rec["Diagnostic-Code"];
|
||
break;
|
||
}
|
||
elseif (isset($rec["Description"])) {
|
||
$text = $rec["Description"];
|
||
break;
|
||
}
|
||
// no diagnostic info present - try getting the human readable part
|
||
elseif (isset($rec["Status"])) {
|
||
$text = $rec["Status"];
|
||
$textpart = $mail->body->getReadablePart();
|
||
if ($textpart != NULL and isset($textpart->text)) {
|
||
$text .= " " . $textpart->text;
|
||
}
|
||
else {
|
||
$text .= " Delivery failed but no diagnostic code or description.";
|
||
}
|
||
break;
|
||
}
|
||
}
|
||
}
|
||
elseif ($part != NULL and isset($part->text)) {
|
||
$text = $part->text;
|
||
}
|
||
elseif (($part = $mail->body->getReadablePart()) != NULL) {
|
||
$text = $part->text;
|
||
}
|
||
}
|
||
elseif ($mail->body instanceof ezcMailMultipartRelated) {
|
||
foreach ($mail->body->getRelatedParts() as $part) {
|
||
if (isset($part->subType) and $part->subType == 'plain') {
|
||
$text = $part->text;
|
||
break;
|
||
}
|
||
}
|
||
}
|
||
else {
|
||
foreach ($mail->body->getParts() as $part) {
|
||
if (isset($part->subType) and $part->subType == 'plain') {
|
||
$text = $part->text;
|
||
break;
|
||
}
|
||
}
|
||
}
|
||
}
|
||
|
||
if (
|
||
empty($text) &&
|
||
$mail->subject == "Delivery Status Notification (Failure)"
|
||
) {
|
||
// Exchange error - CRM-9361
|
||
foreach ($mail->body->getParts() as $part) {
|
||
if ($part instanceof ezcMailDeliveryStatus) {
|
||
foreach ($part->recipients as $rec) {
|
||
if ($rec["Status"] == "5.1.1") {
|
||
if (isset($rec["Description"])) {
|
||
$text = $rec["Description"];
|
||
}
|
||
else {
|
||
$text = $rec["Status"] . " Delivery to the following recipients failed";
|
||
}
|
||
break;
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
|
||
if (empty($text)) {
|
||
// If bounce processing fails, just take the raw body. Cf. CRM-11046
|
||
$text = $mail->generateBody();
|
||
|
||
// if text is still empty, lets fudge a blank text so the api call below will succeed
|
||
if (empty($text)) {
|
||
$text = ts('We could not extract the mail body from this bounce message.');
|
||
}
|
||
}
|
||
|
||
$params = array(
|
||
'job_id' => $job,
|
||
'event_queue_id' => $queue,
|
||
'hash' => $hash,
|
||
'body' => $text,
|
||
'version' => 3,
|
||
// Setting is_transactional means it will rollback if
|
||
// it crashes part way through creating the bounce.
|
||
// If the api were standard & had a create this would be the
|
||
// default. Adding the standard api & deprecating this one
|
||
// would probably be the
|
||
// most consistent way to address this - but this is
|
||
// a quick hack.
|
||
'is_transactional' => 1,
|
||
);
|
||
$result = civicrm_api('Mailing', 'event_bounce', $params);
|
||
break;
|
||
|
||
case 'c':
|
||
case 'confirm':
|
||
// CRM-7921
|
||
$params = array(
|
||
'contact_id' => $job,
|
||
'subscribe_id' => $queue,
|
||
'hash' => $hash,
|
||
'version' => 3,
|
||
);
|
||
$result = civicrm_api('Mailing', 'event_confirm', $params);
|
||
break;
|
||
|
||
case 'o':
|
||
case 'optOut':
|
||
$params = array(
|
||
'job_id' => $job,
|
||
'event_queue_id' => $queue,
|
||
'hash' => $hash,
|
||
'version' => 3,
|
||
);
|
||
$result = civicrm_api('MailingGroup', 'event_domain_unsubscribe', $params);
|
||
break;
|
||
|
||
case 'r':
|
||
case 'reply':
|
||
// instead of text and HTML parts (4th and 6th params) send the whole email as the last param
|
||
$params = array(
|
||
'job_id' => $job,
|
||
'event_queue_id' => $queue,
|
||
'hash' => $hash,
|
||
'bodyTxt' => NULL,
|
||
'replyTo' => $replyTo,
|
||
'bodyHTML' => NULL,
|
||
'fullEmail' => $mail->generate(),
|
||
'version' => 3,
|
||
);
|
||
$result = civicrm_api('Mailing', 'event_reply', $params);
|
||
break;
|
||
|
||
case 'e':
|
||
case 're':
|
||
case 'resubscribe':
|
||
$params = array(
|
||
'job_id' => $job,
|
||
'event_queue_id' => $queue,
|
||
'hash' => $hash,
|
||
'version' => 3,
|
||
);
|
||
$result = civicrm_api('MailingGroup', 'event_resubscribe', $params);
|
||
break;
|
||
|
||
case 's':
|
||
case 'subscribe':
|
||
$params = array(
|
||
'email' => $mail->from->email,
|
||
'group_id' => $job,
|
||
'version' => 3,
|
||
);
|
||
$result = civicrm_api('MailingGroup', 'event_subscribe', $params);
|
||
break;
|
||
|
||
case 'u':
|
||
case 'unsubscribe':
|
||
$params = array(
|
||
'job_id' => $job,
|
||
'event_queue_id' => $queue,
|
||
'hash' => $hash,
|
||
'version' => 3,
|
||
);
|
||
$result = civicrm_api('MailingGroup', 'event_unsubscribe', $params);
|
||
break;
|
||
}
|
||
|
||
if ($result['is_error']) {
|
||
echo "Failed Processing: {$mail->subject}, Action: $action, Job ID: $job, Queue ID: $queue, Hash: $hash. Reason: {$result['error_message']}\n";
|
||
}
|
||
else {
|
||
CRM_Utils_Hook::emailProcessor('mailing', $params, $mail, $result, $action);
|
||
}
|
||
}
|
||
|
||
$store->markProcessed($key);
|
||
}
|
||
// CRM-7356 – used by IMAP only
|
||
$store->expunge();
|
||
}
|
||
}
|
||
|
||
}
|