--- /dev/null
+<?php
+/*
+ +--------------------------------------------------------------------+
+ | CiviCRM version 4.7 |
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC (c) 2004-2016 |
+ +--------------------------------------------------------------------+
+ | 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 |
+ +--------------------------------------------------------------------+
+ */
+
+/**
+ * Test that content produced by CiviMail looks the way it's expected.
+ *
+ * @package CiviCRM_APIv3
+ * @subpackage API_Job
+ *
+ * @copyright CiviCRM LLC (c) 2004-2016
+ * @version $Id: Job.php 30879 2010-11-22 15:45:55Z shot $
+ *
+ */
+
+/**
+ * Class CRM_Mailing_MailingSystemTest
+ * @group headless
+ * @see \Civi\FlexMailer\FlexMailerSystemTest
+ * @see CRM_Mailing_MailingSystemTest
+ */
+abstract class CRM_Mailing_BaseMailingSystemTest extends CiviUnitTestCase {
+ protected $_apiversion = 3;
+
+ public $DBResetRequired = FALSE;
+ public $defaultParams = array();
+ private $_groupID;
+
+ /**
+ * @var CiviMailUtils
+ */
+ private $_mut;
+
+ public function setUp() {
+ $this->useTransaction();
+ parent::setUp();
+ CRM_Mailing_BAO_MailingJob::$mailsProcessed = 0; // DGW
+
+ $this->_groupID = $this->groupCreate();
+ $this->createContactsInGroup(2, $this->_groupID);
+
+ $this->defaultParams = array(
+ 'name' => 'mailing name',
+ 'created_id' => 1,
+ 'groups' => array('include' => array($this->_groupID)),
+ 'scheduled_date' => 'now',
+ );
+ $this->_mut = new CiviMailUtils($this, TRUE);
+ $this->callAPISuccess('mail_settings', 'get',
+ array('api.mail_settings.create' => array('domain' => 'chaos.org')));
+ }
+
+ /**
+ */
+ public function tearDown() {
+ $this->_mut->stop();
+ CRM_Utils_Hook::singleton()->reset();
+ CRM_Mailing_BAO_MailingJob::$mailsProcessed = 0; // DGW
+ parent::tearDown();
+ }
+
+ /**
+ * Generate a fully-formatted mailing with standard email headers.
+ */
+ public function testBasicHeaders() {
+ $allMessages = $this->runMailingSuccess(array(
+ 'subject' => 'Accidents in cars cause children for {contact.display_name}!',
+ 'body_text' => 'BEWARE children need regular infusions of toys. Santa knows your {domain.address}. There is no {action.optOutUrl}.',
+ ));
+ foreach ($allMessages as $k => $message) {
+ /** @var ezcMail $message */
+
+ $offset = $k + 1;
+
+ $this->assertEquals("FIXME", $message->from->name);
+ $this->assertEquals("info@EXAMPLE.ORG", $message->from->email);
+ $this->assertEquals("Mr. Foo{$offset} Anderson II", $message->to[0]->name);
+ $this->assertEquals("mail{$offset}@nul.example.com", $message->to[0]->email);
+
+ $this->assertRegExp('#^text/plain; charset=utf-8#', $message->headers['Content-Type']);
+ $this->assertRegExp(';^b\.[\d\.a-f]+@chaos.org$;', $message->headers['Return-Path']);
+ $this->assertRegExp(';^b\.[\d\.a-f]+@chaos.org$;', $message->headers['X-CiviMail-Bounce'][0]);
+ $this->assertRegExp(';^\<mailto:u\.[\d\.a-f]+@chaos.org\>$;', $message->headers['List-Unsubscribe'][0]);
+ $this->assertEquals('bulk', $message->headers['Precedence'][0]);
+ }
+ }
+
+ /**
+ * Generate a fully-formatted mailing (with body_text content).
+ */
+ public function testText() {
+ $allMessages = $this->runMailingSuccess(array(
+ 'subject' => 'Accidents in cars cause children for {contact.display_name}!',
+ 'body_text' => 'BEWARE children need regular infusions of toys. Santa knows your {domain.address}. There is no {action.optOutUrl}.',
+ 'open_tracking' => 1,
+ // Note: open_tracking does nothing with text, but we'll just verify that it does nothing
+ ));
+ foreach ($allMessages as $k => $message) {
+ /** @var ezcMail $message */
+ /** @var ezcMailText $textPart */
+
+ $this->assertTrue($message->body instanceof ezcMailText);
+
+ $this->assertEquals('plain', $message->body->subType);
+ $this->assertRegExp(
+ ";" .
+ "Sample Header for TEXT formatted content.\n" . // Default header
+ "BEWARE children need regular infusions of toys. Santa knows your .*\\. There is no http.*civicrm/mailing/optout.*\\.\n" .
+ "to unsubscribe: http.*civicrm/mailing/optout" . // Default footer
+ ";",
+ $message->body->text
+ );
+ }
+ }
+
+ /**
+ * Generate a fully-formatted mailing (with body_html content).
+ */
+ public function testHtmlWithOpenTracking() {
+ $allMessages = $this->runMailingSuccess(array(
+ 'subject' => 'Example Subject',
+ 'body_html' => '<p>You can go to <a href="http://example.net/first?{contact.checksum}">Google</a> or <a href="{action.optOutUrl}">opt out</a>.</p>',
+ 'open_tracking' => 1,
+ 'url_tracking' => 0,
+ ));
+ foreach ($allMessages as $k => $message) {
+ /** @var ezcMail $message */
+ /** @var ezcMailText $htmlPart */
+ /** @var ezcMailText $textPart */
+
+ $this->assertTrue($message->body instanceof ezcMailMultipartAlternative);
+
+ list($textPart, $htmlPart) = $message->body->getParts();
+
+ $this->assertEquals('html', $htmlPart->subType);
+ $this->assertRegExp(
+ ";" .
+ "Sample Header for HTML formatted content.\n" . // Default header
+ // FIXME: CiviMail puts double " after hyperlink!
+ "<p>You can go to <a href=\"http://example.net/first\\?cs=[0-9a-f_]+\"\"?>Google</a> or <a href=\"http.*civicrm/mailing/optout.*\">opt out</a>.</p>\n" . // body_html
+ "Sample Footer for HTML formatted content" . // Default footer
+ ".*\n" .
+ "<img src=\".*extern/open.php.*\"" .
+ ";",
+ $htmlPart->text
+ );
+
+ $this->assertEquals('plain', $textPart->subType);
+ $this->assertRegExp(
+ ";" .
+ "Sample Header for TEXT formatted content.\n" . // Default header
+ "You can go to Google \\[1\\] or opt out \\[2\\]\\.\n" . // body_html, filtered
+ "\n" .
+ "Links:\n" .
+ "------\n" .
+ "\\[1\\] http://example.net/first\\?cs=[0-9a-f_]+\n" .
+ "\\[2\\] http.*civicrm/mailing/optout.*\n" .
+ "\n" .
+ "to unsubscribe: http.*civicrm/mailing/optout" . // Default footer
+ ";",
+ $textPart->text
+ );
+ }
+ }
+
+ /**
+ * Generate a fully-formatted mailing (with body_html content).
+ */
+ public function testHtmlWithOpenAndUrlTracking() {
+ $allMessages = $this->runMailingSuccess(array(
+ 'subject' => 'Example Subject',
+ 'body_html' => '<p>You can go to <a href="http://example.net">Google</a> or <a href="{action.optOutUrl}">opt out</a>.</p>',
+ 'open_tracking' => 1,
+ 'url_tracking' => 1,
+ ));
+ foreach ($allMessages as $k => $message) {
+ /** @var ezcMail $message */
+ /** @var ezcMailText $htmlPart */
+ /** @var ezcMailText $textPart */
+
+ $this->assertTrue($message->body instanceof ezcMailMultipartAlternative);
+
+ list($textPart, $htmlPart) = $message->body->getParts();
+
+ $this->assertEquals('html', $htmlPart->subType);
+ $this->assertRegExp(
+ ";" .
+ // body_html
+ "<p>You can go to <a href=['\"].*extern/url\.php\?u=\d+&\\;qid=\d+['\"]>Google</a>" .
+ " or <a href=\"http.*civicrm/mailing/optout.*\">opt out</a>.</p>\n" .
+ // Default footer
+ "Sample Footer for HTML formatted content" .
+ ".*\n" .
+ // Open-tracking code
+ "<img src=\".*extern/open.php.*\"" .
+ ";",
+ $htmlPart->text
+ );
+
+ $this->assertEquals('plain', $textPart->subType);
+ $this->assertRegExp(
+ ";" .
+ // body_html, filtered
+ "You can go to Google \\[1\\] or opt out \\[2\\]\\.\n" .
+ "\n" .
+ "Links:\n" .
+ "------\n" .
+ "\\[1\\] .*extern/url\.php\?u=\d+&qid=\d+\n" .
+ "\\[2\\] http.*civicrm/mailing/optout.*\n" .
+ "\n" .
+ // Default footer
+ "to unsubscribe: http.*civicrm/mailing/optout" .
+ ";",
+ $textPart->text
+ );
+ }
+ }
+
+ public function urlTrackingExamples() {
+ $cases = array();
+
+ // Each case comes in four parts:
+ // 1. Mailing HTML (body_html)
+ // 2. Regex to run against final HTML
+ // 3. Regex to run against final text
+ // 4. Additional mailing options
+
+ // Tracking disabled
+
+ $cases[] = array(
+ '<p><a href="http://example.net/">Foo</a></p>',
+ ';<p><a href="http://example\.net/">Foo</a></p>;',
+ ';\\[1\\] http://example\.net/;',
+ array('url_tracking' => 0),
+ );
+ $cases[] = array(
+ '<p><a href="http://example.net/?id={contact.contact_id}">Foo</a></p>',
+ // FIXME: Legacy tracker adds extra quote after URL
+ ';<p><a href="http://example\.net/\?id=\d+""?>Foo</a></p>;',
+ ';\\[1\\] http://example\.net/\?id=\d+;',
+ array('url_tracking' => 0),
+ );
+ $cases[] = array(
+ '<p><a href="{action.optOutUrl}">Foo</a></p>',
+ ';<p><a href="http.*civicrm/mailing/optout.*">Foo</a></p>;',
+ ';\\[1\\] http.*civicrm/mailing/optout.*;',
+ array('url_tracking' => 0),
+ );
+ $cases[] = array(
+ '<p>Look at <img src="http://example.net/foo.png">.</p>',
+ ';<p>Look at <img src="http://example\.net/foo\.png">\.</p>;',
+ ';Look at \.;',
+ array('url_tracking' => 0),
+ );
+ $cases[] = array(
+ // Plain-text URL's are tracked in plain-text emails...
+ // but not in HTML emails.
+ "<p>Please go to: http://example.net/</p>",
+ ";<p>Please go to: http://example\.net/</p>;",
+ ';Please go to: http://example\.net/;',
+ array('url_tracking' => 0),
+ );
+
+ // Tracking enabled
+
+ $cases[] = array(
+ '<p><a href="http://example.net/">Foo</a></p>',
+ ';<p><a href=[\'"].*extern/url\.php\?u=\d+.*[\'"]>Foo</a></p>;',
+ ';\\[1\\] .*extern/url\.php\?u=\d+.*;',
+ array('url_tracking' => 1),
+ );
+ $cases[] = array(
+ // FIXME: CiviMail URL tracking doesn't track tokenized links.
+ '<p><a href="http://example.net/?id={contact.contact_id}">Foo</a></p>',
+ // FIXME: Legacy tracker adds extra quote after URL
+ ';<p><a href="http://example\.net/\?id=\d+""?>Foo</a></p>;',
+ ';\\[1\\] http://example\.net/\?id=\d+;',
+ array('url_tracking' => 1),
+ );
+ $cases[] = array(
+ // It would be redundant/slow to track the action URLs?
+ '<p><a href="{action.optOutUrl}">Foo</a></p>',
+ ';<p><a href="http.*civicrm/mailing/optout.*">Foo</a></p>;',
+ ';\\[1\\] http.*civicrm/mailing/optout.*;',
+ array('url_tracking' => 1),
+ );
+ $cases[] = array(
+ // It would be excessive/slow to track every embedded image.
+ '<p>Look at <img src="http://example.net/foo.png">.</p>',
+ ';<p>Look at <img src="http://example\.net/foo\.png">\.</p>;',
+ ';Look at \.;',
+ array('url_tracking' => 1),
+ );
+ $cases[] = array(
+ // Plain-text URL's are tracked in plain-text emails...
+ // but not in HTML emails.
+ "<p>Please go to: http://example.net/</p>",
+ ";<p>Please go to: http://example\.net/</p>;",
+ ';Please go to: .*extern/url.php\?u=\d+&qid=\d+;',
+ array('url_tracking' => 1),
+ );
+
+ return $cases;
+ }
+
+ /**
+ * Generate a fully-formatted mailing (with body_html content).
+ *
+ * @dataProvider urlTrackingExamples
+ */
+ public function testUrlTracking($inputHtml, $htmlUrlRegex, $textUrlRegex, $params) {
+ $caseName = print_r(array('inputHtml' => $inputHtml, 'params' => $params), 1);
+
+ $allMessages = $this->runMailingSuccess($params + array(
+ 'subject' => 'Example Subject',
+ 'body_html' => $inputHtml,
+ ));
+ foreach ($allMessages as $k => $message) {
+ /** @var ezcMail $message */
+ /** @var ezcMailText $htmlPart */
+ /** @var ezcMailText $textPart */
+
+ $this->assertTrue($message->body instanceof ezcMailMultipartAlternative);
+
+ list($textPart, $htmlPart) = $message->body->getParts();
+
+ if ($htmlUrlRegex) {
+ $this->assertEquals('html', $htmlPart->subType, "Should have HTML part in case: $caseName");
+ $this->assertRegExp($htmlUrlRegex, $htmlPart->text, "Should have correct HTML in case: $caseName");
+ }
+
+ if ($textUrlRegex) {
+ $this->assertEquals('plain', $textPart->subType, "Should have text part in case: $caseName");
+ $this->assertRegExp($textUrlRegex, $textPart->text, "Should have correct text in case: $caseName");
+ }
+ }
+ }
+
+ /**
+ * Create contacts in group.
+ *
+ * @param int $count
+ * @param int $groupID
+ * @param string $domain
+ */
+ protected function createContactsInGroup(
+ $count,
+ $groupID,
+ $domain = 'nul.example.com'
+ ) {
+ for ($i = 1; $i <= $count; $i++) {
+ $contactID = $this->individualCreate(array(
+ 'first_name' => "Foo{$i}",
+ 'email' => 'mail' . $i . '@' . $domain,
+ ));
+ $this->callAPISuccess('group_contact', 'create', array(
+ 'contact_id' => $contactID,
+ 'group_id' => $groupID,
+ 'status' => 'Added',
+ ));
+ }
+ }
+
+ /**
+ * Create and execute a mailing. Return the matching messages.
+ *
+ * @param array $params
+ * List of parameters to send to Mailing.create API.
+ * @return array<ezcMail>
+ */
+ protected function runMailingSuccess($params) {
+ $mailingParams = array_merge($this->defaultParams, $params);
+ $this->callAPISuccess('mailing', 'create', $mailingParams);
+ $this->_mut->assertRecipients(array());
+ $this->callAPISuccess('job', 'process_mailing', array());
+
+ $allMessages = $this->_mut->getAllMessages('ezc');
+ // There are exactly two contacts produced by setUp().
+ $this->assertEquals(2, count($allMessages));
+
+ return $allMessages;
+ }
+
+}
--- /dev/null
+<?php
+/*
+ +--------------------------------------------------------------------+
+ | CiviCRM version 4.7 |
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC (c) 2004-2016 |
+ +--------------------------------------------------------------------+
+ | 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 |
+ +--------------------------------------------------------------------+
+ */
+
+/**
+ * Test that content produced by CiviMail looks the way it's expected.
+ *
+ * @package CiviCRM_APIv3
+ * @subpackage API_Job
+ *
+ * @copyright CiviCRM LLC (c) 2004-2016
+ * @version $Id: Job.php 30879 2010-11-22 15:45:55Z shot $
+ *
+ */
+
+/**
+ * Class CRM_Mailing_MailingSystemTest
+ *
+ * MailingSystemTest checks that overall composition and delivery of
+ * CiviMail blasts works. It extends CRM_Mailing_BaseMailingSystemTest
+ * which provides the general test scenarios -- but this variation
+ * checks that certain internal events/hooks fire.
+ *
+ * MailingSystemTest is the counterpart to FlexMailerSystemTest.
+ *
+ * @group headless
+ * @group civimail
+ * @see \Civi\FlexMailer\FlexMailerSystemTest
+ */
+class CRM_Mailing_MailingSystemTest extends CRM_Mailing_BaseMailingSystemTest {
+
+ private $counts;
+
+ public function setUp() {
+ parent::setUp();
+ Civi::settings()->add(array('experimentalFlexMailerEngine' => FALSE));
+
+ $hooks = \CRM_Utils_Hook::singleton();
+ $hooks->setHook('civicrm_alterMailParams',
+ array($this, 'hook_alterMailParams'));
+ }
+
+ /**
+ * @see CRM_Utils_Hook::alterMailParams
+ */
+ public function hook_alterMailParams(&$params, $context = NULL) {
+ $this->counts['hook_alterMailParams'] = 1;
+ $this->assertEquals('civimail', $context);
+ }
+
+ public function tearDown() {
+ parent::tearDown();
+ $this->assertNotEmpty($this->counts['hook_alterMailParams']);
+ }
+
+ // ---- Boilerplate ----
+
+ // The remainder of this class contains dummy stubs which make it easier to
+ // work with the tests in an IDE.
+
+ /**
+ * Generate a fully-formatted mailing (with body_html content).
+ *
+ * @dataProvider urlTrackingExamples
+ */
+ public function testUrlTracking(
+ $inputHtml,
+ $htmlUrlRegex,
+ $textUrlRegex,
+ $params
+ ) {
+ parent::testUrlTracking($inputHtml, $htmlUrlRegex, $textUrlRegex, $params);
+ }
+
+ public function testBasicHeaders() {
+ parent::testBasicHeaders();
+ }
+
+ public function testText() {
+ parent::testText();
+ }
+
+ public function testHtmlWithOpenTracking() {
+ parent::testHtmlWithOpenTracking();
+ }
+
+ public function testHtmlWithOpenAndUrlTracking() {
+ parent::testHtmlWithOpenAndUrlTracking();
+ }
+
+}
projects / civicrm-core.git / commitdiff