EE_Email_messenger

Complexity

Total Complexity

36

Size/Duplication

Total Lines	516
Duplicated Lines	2.13 %

Coupling/Cohesion

Components	8
Dependencies	4

Importance

Changes

0

20 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	13	1
A	_set_admin_pages()	0	5	1
A	_set_valid_shortcodes()	0	7	1
B	_set_validator_config()	0	36	1
A	do_secondary_messenger_hooks()	0	5	2
A	add_email_css()	0	8	1
B	_set_test_settings_fields()	0	25	1
B	_set_template_fields()	0	89	1
A	_set_default_message_types()	0	9	1
A	_set_valid_message_types()	0	14	1
A	_set_admin_settings_fields()	0	1	1
A	_send_message()	11	20	2
A	_preview()	0	3	1
A	_headers()	0	15	1
A	_ensure_has_from_email_address()	0	5	2
A	_parse_from()	0	17	3
A	set_from_address()	0	6	3
A	set_from_name()	0	11	4
B	_body()	0	31	5
A	get_existing_test_settings()	0	8	3

<?php

if (!defined('EVENT_ESPRESSO_VERSION') )
	exit('NO direct script access allowed');

/**
 * Event Espresso
 *
 * Event Registration and Management Plugin for WordPress
 *
 * @ package			Event Espresso
 * @ author				Seth Shoultes
 * @ copyright			(c) 2008-2011 Event Espresso  All Rights Reserved.
 * @ license			http://eventespresso.com/support/terms-conditions/   * see Plugin Licensing *
 * @ link				http://www.eventespresso.com
 * @ version		 	4.0
 *
 * ------------------------------------------------------------------------
 *
 * Messenger class
 *
 * @package			Event Espresso
 * @subpackage		includes/core/messages
 * @author			Darren Ethier, Brent Christensen
 *
 * ------------------------------------------------------------------------
 */

/**
 * This sets up the email messenger for the EE_messages (notifications) subsystem in EE.
 */
class EE_Email_messenger extends EE_messenger  {

	/**
	 * The following are the properties that email requires for the message going out.
	 */
	protected $_to;
	protected $_from;
	protected $_subject;
	protected $_content;



	/**
	 * constructor
	 *
	 * @access public
	 */
	public function __construct() {
		//set name and description properties
		$this->name = 'email';
		$this->description = __('This messenger delivers messages via email using the built-in <code>wp_mail</code> function included with WordPress', 'event_espresso');
		$this->label = array(
			'singular' => __('email', 'event_espresso'),
			'plural' => __('emails', 'event_espresso')
			);
		$this->activate_on_install = TRUE;

		//we're using defaults so let's call parent constructor that will take care of setting up all the other properties
		parent::__construct();
	}


	/**
	 * see abstract declaration in parent class for details.
	 */
	protected function _set_admin_pages() {
		$this->admin_registered_pages = array(
			'events_edit' => true,
		);
	}


	/**
	 * see abstract declaration in parent class for details
	 */
	protected function _set_valid_shortcodes() {
		//remember by leaving the other fields not set, those fields will inherit the valid shortcodes from the message type.
		$this->_valid_shortcodes = array(
			'to' => array('email','event_author', 'primary_registration_details', 'recipient_details'),
			'from' => array('email', 'event_author', 'primary_registration_details', 'recipient_details')
			);
	}







	/**
	 * see abstract declaration in parent class for details
	 *
	 *
	 * @access protected
	 * @return void
	 */
	protected function _set_validator_config() {
		$valid_shortcodes = $this->get_valid_shortcodes();

		$this->_validator_config = array(
			'to' => array(
				'shortcodes' => $valid_shortcodes['to'],
				'type' => 'email'
				),
			'from' => array(
				'shortcodes' => $valid_shortcodes['from'],
				'type' => 'email'
				),
			'subject' => array(
				'shortcodes' => array('organization', 'primary_registration_details', 'event_author', 'primary_registration_details', 'recipient_details')
				),
			'content' => array(
				'shortcodes' => array('event_list','attendee_list', 'ticket_list', 'organization', 'primary_registration_details', 'primary_registration_list', 'event_author', 'recipient_details', 'recipient_list', 'transaction', 'messenger')
				),
			'attendee_list' => array(
				'shortcodes' => array('attendee', 'event_list', 'ticket_list'),
				'required' => array('[ATTENDEE_LIST]')
				),
			'event_list' => array(
				'shortcodes' => array('event', 'attendee_list', 'ticket_list', 'venue', 'datetime_list', 'attendee', 'primary_registration_details', 'primary_registration_list', 'event_author', 'recipient_details', 'recipient_list'),
				'required' => array('[EVENT_LIST]')
				),
			'ticket_list' => array(
				'shortcodes' => array('event_list', 'attendee_list', 'ticket', 'datetime_list','primary_registration_details', 'recipient_details'),
				'required' => array('[TICKET_LIST]')
				),
			'datetime_list' => array(
				'shortcodes' => array('datetime'),
				'required' => array('[DATETIME_LIST]')
				)
			);
	}





	/**
	 * @see parent EE_messenger class for docs
	 *
	 * @since 4.5.0
	 */
	public function do_secondary_messenger_hooks( $sending_messenger_name ) {
		if ( $sending_messenger_name = 'html' ) {

$sending_messenger_name is not used, you could remove the assignment.

			add_filter( 'FHEE__EE_Messages_Template_Pack__get_variation', array( $this, 'add_email_css' ), 10, 8 );
		}
	}




	public function add_email_css( $variation_path, $messenger, $message_type, $type, $variation, $file_extension, $url, EE_Messages_Template_Pack $template_pack ) {
		//prevent recursion on this callback.
		remove_filter( 'FHEE__EE_Messages_Template_Pack__get_variation', array( $this, 'add_email_css' ), 10 );
		$variation = $this->get_variation( $template_pack, $message_type, $url, 'main', $variation, FALSE  );

		add_filter( 'FHEE__EE_Messages_Template_Pack__get_variation', array( $this, 'add_email_css' ), 10, 8 );
		return $variation;
	}




	/**
	 * See parent for details
	 *
	 * @access protected
	 * @return void
	 */
	protected function _set_test_settings_fields() {
		$this->_test_settings_fields = array(
			'to' => array(
				'input' => 'text',
				'label' => __('Send a test email to', 'event_espresso'),
				'type' => 'email',
				'required' => TRUE,
				'validation' => TRUE,
				'css_class' => 'large-text',
				'format' => '%s',
				'default' => get_bloginfo('admin_email')
				),
			'subject' => array(
				'input' => 'hidden',
				'label' => '',
				'type' => 'string',
				'required' => FALSE,
				'validation' => FALSE,
				'format' => '%s',
				'value' => sprintf( __('Test email sent from %s', 'event_espresso'), get_bloginfo('name') ),
				'default'=> '',
				'css_class' => ''
				)
			);
	}





	/**
	 * _set_template_fields
	 * This sets up the fields that a messenger requires for the message to go out.
	 *
	 * @access  protected
	 * @return void
	 */
	protected function _set_template_fields() {
		// any extra template fields that are NOT used by the messenger but will get used by a messenger field for shortcode replacement get added to the 'extra' key in an associated array indexed by the messenger field they relate to.  This is important for the Messages_admin to know what fields to display to the user.  Also, notice that the "values" are equal to the field type that messages admin will use to know what kind of field to display. The values ALSO have one index labeled "shortcode".  the values in that array indicate which ACTUAL SHORTCODE (i.e. [SHORTCODE]) is required in order for this extra field to be displayed.  If the required shortcode isn't part of the shortcodes array then the field is not needed and will not be displayed/parsed.
		$this->_template_fields = array(
			'to' => array(
				'input' => 'text',
				'label' => __('To', 'event_espresso'),
				'type' => 'string',
				'required' => TRUE,
				'validation' => TRUE,
				'css_class' => 'large-text',
				'format' => '%s'
			),
			'from' => array(
				'input' => 'text',
				'label' => __('From', 'event_espresso'),
				'type' => 'string',
				'required' => TRUE,
				'validation' => TRUE,
				'css_class' => 'large-text',
				'format' => '%s'
			),
			'subject' => array(
				'input' => 'text',
				'label' => __('Subject', 'event_espresso'),
				'type' => 'string',
				'required' => TRUE,
				'validation' => TRUE,
				'css_class' => 'large-text',
				'format' => '%s'
			),
			'content' => '', //left empty b/c it is in the "extra array" but messenger still needs needs to know this is a field.
			'extra' => array(
				'content' => array(
					'main' => array(
						'input' => 'wp_editor',
						'label' => __('Main Content', 'event_espresso'),
						'type' => 'string',
						'required' => TRUE,
						'validation' => TRUE,
						'format' => '%s',
						'rows' => '15'
					),
					'event_list' => array(
						'input' => 'wp_editor',
						'label' => '[EVENT_LIST]',
						'type' => 'string',
						'required' => TRUE,
						'validation' => TRUE,
						'format' => '%s',
						'rows' => '15',
						'shortcodes_required' => array('[EVENT_LIST]')
						),
					'attendee_list' => array(
						'input' => 'textarea',
						'label' => '[ATTENDEE_LIST]',
						'type' => 'string',
						'required' => TRUE,
						'validation' => TRUE,
						'format' => '%s',
						'css_class' => 'large-text',
						'rows' => '5',
						'shortcodes_required' => array('[ATTENDEE_LIST]')
					),
					'ticket_list' => array(
						'input' => 'textarea',
						'label' => '[TICKET_LIST]',
						'type' => 'string',
						'required' => TRUE,
						'validation' => TRUE,
						'format' => '%s',
						'css_class' => 'large-text',
						'rows' => '10',
						'shortcodes_required' => array('[TICKET_LIST]')
						),
					'datetime_list' => array(
						'input' => 'textarea',
						'label' => '[DATETIME_LIST]',
						'type' => 'string',
						'required' => TRUE,
						'validation' => TRUE,
						'format' => '%s',
						'css_class' => 'large-text',
						'rows' => '10',
						'shortcodes_required' => array('[DATETIME_LIST]')
						)
				)
			)
		);
	}





	/**
	 * See definition of this class in parent
	 */
	protected function _set_default_message_types() {
		$this->_default_message_types = array(
			'payment',
			'payment_refund',
			'registration',
			'not_approved_registration',
			'pending_approval'
			);
	}




	/**
	 * @see definition of this class in parent
	 *
	 * @since 4.5.0
	 *
	 */
	protected function _set_valid_message_types() {
		$this->_valid_message_types = array(
			'payment',
			'registration',
			'not_approved_registration',
			'declined_registration',
			'cancelled_registration',
			'pending_approval',
			'registration_summary',
			'payment_reminder',
			'payment_declined',
			'payment_refund'
			);
	}




	/**
	 * setting up admin_settings_fields for messenger.
	 */
	protected function _set_admin_settings_fields() {}

	/**
	 * We just deliver the messages don't kill us!!
	 * @return bool | WP_Error  true if message delivered, false if it didn't deliver OR bubble up any error object if present.
	 */
	protected function _send_message() {
		$success =  wp_mail(
			html_entity_decode( $this->_to, ENT_QUOTES, "UTF-8" ),
			stripslashes( html_entity_decode( $this->_subject, ENT_QUOTES, "UTF-8" )),
			$this->_body(),
			$this->_headers()
		);
		if ( ! $success ) {
			EE_Error::add_error(
				sprintf(
					__( 'The email did not send successfully.%3$sThe WordPress wp_mail function is used for sending mails but does not give any useful information when an email fails to send.%3$sIt is possible the "to" address (%1$s) or "from" address (%2$s) is invalid.%3$s', 'event_espresso'),
					$this->_to,
					$this->_from,
					'<br />'
				),
				__FILE__, __FUNCTION__, __LINE__
			);
		}
		return $success;
	}




	/**
	 * see parent for definition
	 * @return string html body of the message content and the related css.
	 */
	protected function _preview() {
		return $this->_body( true );
	}





	/**
	 * Setup headers for email
	 *
	 * @access protected
	 * @return string formatted header for email
	 */
	protected function _headers() {
		$this->_ensure_has_from_email_address();
		$from = stripslashes_deep( html_entity_decode($this->_from,  ENT_QUOTES,"UTF-8" ) );
		$headers = array(
			'MIME-Version: 1.0',
			'From:' . $from,
			'Reply-To:' . $from,
			'Content-Type:text/html; charset=utf-8'
			);

		//but wait!  Header's for the from is NOT reliable because some plugins don't respect From: as set in the header.
		add_filter( 'wp_mail_from',  array( $this, 'set_from_address' ), 100 );
		add_filter( 'wp_mail_from_name', array( $this, 'set_from_name' ), 100 );
		return apply_filters( 'FHEE__EE_Email_messenger___headers', $headers, $this->_incoming_message_type, $this );
	}


	/**
	 * This simply ensures that the from address is not empty.  If it is, then we use whatever is set as the site email
	 * address for the from address to avoid problems with sending emails.
	 */
	protected function _ensure_has_from_email_address() {
		if ( empty( $this->_from ) ) {
			$this->_from = get_bloginfo('admin_email');
		}
	}



	/**
	 * This simply parses whatever is set as the $_from address and determines if it is in the format {name} <{email}> or just {email} and returns an array with the "from_name" and "from_email" as the values.
	 *
	 * Note from_name *MAY* be empty
	 *
	 * @since 4.3.1
	 *
	 * @return array
	 */
	private function _parse_from() {
		if ( strpos( $this->_from, '<' ) !== false ) {
			$from_name = substr( $this->_from, 0, strpos( $this->_from, '<' ) - 1 );
			$from_name = str_replace( '"', '', $from_name );
			$from_name = trim( $from_name );

			$from_email = substr( $this->_from, strpos( $this->_from, '<' ) + 1 );
			$from_email = str_replace( '>', '', $from_email );
			$from_email = trim( $from_email );
		} elseif ( trim( $this->_from ) !== '' ) {
			$from_name = '';
			$from_email = trim( $this->_from );
		} else {
			$from_name = $from_email = '';
		}
		return array( $from_name, $from_email );
	}




	/**
	 * Callback for the wp_mail_from filter.
	 *
	 * @since 4.3.1
	 *
	 * @param string $from_email What the original from_email is.
	 */
	public function set_from_address( $from_email ) {

The parameter $from_email is not used and could be removed.

		$parsed_from = $this->_parse_from();
		//includes fallback if the parsing failed.
		$from_email = is_array( $parsed_from ) && ! empty( $parsed_from[1] ) ? $parsed_from[1] : get_bloginfo( 'admin_email' );
		return $from_email;
	}




	/**
	 * Callback fro the wp_mail_from_name filter.
	 *
	 * @since 4.3.1
	 *
	 * @param string $from_name The original from_name.
	 */
	public function set_from_name( $from_name ) {
		$parsed_from = $this->_parse_from();
		if ( is_array( $parsed_from) && ! empty( $parsed_from[0] ) ) {
			$from_name =  $parsed_from[0];
		}

		//if from name is "WordPress" let's sub in the site name instead (more friendly!)
		$from_name = $from_name == 'WordPress' ? get_bloginfo() : $from_name;

		return stripslashes_deep( html_entity_decode($from_name,  ENT_QUOTES,"UTF-8" ) );
	}



	/**
	 * setup body for email
	 *
	 * @param bool $preview will determine whether this is preview template or not.
	 * @return string formatted body for email.
	 */
	protected function _body( $preview = false ) {
		//setup template args!
		$this->_template_args = array(
			'subject' => $this->_subject,
			'from' => $this->_from,
			'main_body' => wpautop(stripslashes_deep( html_entity_decode($this->_content,  ENT_QUOTES,"UTF-8" ) ))
			);
		$body =  $this->_get_main_template( $preview );

		/**
		 * This filter allows one to bypass the CSSToInlineStyles tool and leave the body untouched.
		 *
		 * @type    bool    $preview    Indicates whether a preview is being generated or not.
		 * @return  bool    true  indicates to use the inliner, false bypasses it.
		 */
		if ( apply_filters( 'FHEE__EE_Email_messenger__apply_CSSInliner ', true, $preview ) ) {

			//require CssToInlineStyles library and its dependencies via composer autoloader
			require_once EE_THIRD_PARTY . 'cssinliner/vendor/autoload.php';

			//now if this isn't a preview, let's setup the body so it has inline styles
			if ( ! $preview || ( $preview && defined( 'DOING_AJAX' ) ) ) {
				$style = file_get_contents( $this->get_variation( $this->_tmp_pack, $this->_incoming_message_type->name, FALSE, 'main', $this->_variation ), TRUE );
				$CSS = new TijsVerkoyen\CssToInlineStyles\CssToInlineStyles( $body, $style );
				$body = ltrim( $CSS->convert( true ), ">\n" ); //for some reason the library has a bracket and new line at the beginning.  This takes care of that.
				$body = ltrim( $body, "<?" ); //see https://events.codebasehq.com/projects/event-espresso/tickets/8609
			}

		}
		return $body;
	}




	/**
	 * This just returns any existing test settings that might be saved in the database
	 *
	 * @access public
	 * @return array
	 */
	public function get_existing_test_settings() {
		$settings = parent::get_existing_test_settings();
		//override subject if present because we always want it to be fresh.
		if ( is_array( $settings ) && ! empty( $settings['subject'] ) ) {
			$settings['subject'] = sprintf( __('Test email sent from %s', 'event_espresso'), get_bloginfo('name') );
		}
		return $settings;
	}


}

// end of file:	includes/core/messages/messengers/EE_Email_messenger.class.php