FrmEmail::set_bcc() - Code Metrics - Inspection of "If the reply to is not set, use only the from emai..." - Strategy11/formidable-forms - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( cd1d04...d7e2d0 )

by Stephanie

created 2018-02-19 23:40 UTC

FrmEmail::set_bcc() A

↳ Parent: FrmEmail

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	1
dl	0
loc	3
rs	10
c	0
b	0
f	0

<?php

/**
 * @since 2.03.04
 */
class FrmEmail {

	private $email_key = '';
	private $to = array();
	private $cc = array();
	private $bcc = array();
	private $from = '';
	private $reply_to = '';
	private $subject = '';
	private $message = '';
	private $attachments = array();

	private $is_plain_text = false;
	private $is_single_recipient = false;
	private $include_user_info = false;

	private $charset = '';
	private $content_type = 'text/html';

	private $settings = array();
	private $entry;
	private $form;

	/**
	 * FrmEmail constructor
	 *
	 * @param object $action
	 * @param object $entry
	 * @param object $form
	 */
	public function __construct( $action, $entry, $form ) {
		$this->set_email_key( $action );
		$this->entry    = $entry;
		$this->form     = $form;
		$this->settings = $action->post_content;

		$user_id_args = self::get_user_id_args( $form->id );
		$this->set_to( $user_id_args );
		$this->set_cc( $user_id_args );
		$this->set_bcc( $user_id_args );

		if ( ! $this->has_recipients() ) {
			return;
		}

		$this->set_from( $user_id_args );
		$this->set_reply_to( $user_id_args );

		$this->set_include_user_info();
		$this->set_is_plain_text();
		$this->set_is_single_recipient( $action );

		$this->set_charset();
		$this->set_content_type();

		$this->set_subject();
		$this->set_message();
		$this->set_attachments();
	}

	/**
	 * Set the email key property
	 *
	 * @since 2.03.04
	 *
	 * @param object $action
	 */
	private function set_email_key( $action ) {
		$this->email_key = $action->ID;
	}

	/**
	 * Set the to addresses
	 *
	 * @since 2.03.04
	 *
	 * @param array $user_id_args
	 */
	private function set_to( $user_id_args ) {
		$to = $this->prepare_email_setting( $this->settings['email_to'], $user_id_args );
		$to = $this->explode_emails( $to );

		$where = array(
			'it.field_id !' => 0,
			'it.item_id'    => $this->entry->id,
		);
		$values = FrmEntryMeta::getAll( $where, ' ORDER BY fi.field_order' );
		$args   = array(
			'email_key' => $this->email_key,
			'entry'     => $this->entry,
			'form'      => $this->form,
		);
		$to     = apply_filters( 'frm_to_email', $to, $values, $this->form->id, $args );

		$this->to = array_unique( (array) $to );

		if ( empty( $this->to ) ) {
			return;
		}

		$this->handle_phone_numbers();

		$this->to = $this->format_recipients( $this->to );
	}

	/**
	 * Set the CC addresses
	 *
	 * @since 2.03.04
	 *
	 * @param array $user_id_args
	 */
	private function set_cc( $user_id_args ) {
		$this->cc = $this->prepare_additional_recipients( $this->settings['cc'], $user_id_args );
	}

	/**
	 * Set the BCC addresses
	 *
	 * @since 2.03.04
	 *
	 * @param array $user_id_args
	 */
	private function set_bcc( $user_id_args ) {
		$this->bcc = $this->prepare_additional_recipients( $this->settings['bcc'], $user_id_args );
	}

	/**
	 * Prepare CC and BCC recipients
	 *
	 * @since 2.03.04
	 *
	 * @param string $recipients
	 * @param array $user_id_args
	 *
	 * @return array
	 */
	private function prepare_additional_recipients( $recipients, $user_id_args ) {
		$recipients = $this->prepare_email_setting( $recipients, $user_id_args );
		$recipients = $this->explode_emails( $recipients );

		$recipients = array_unique( (array) $recipients );
		$recipients = $this->format_recipients( $recipients );

		return $recipients;
	}

	/**
	 * Set the From addresses
	 *
	 * @since 2.03.04
	 *
	 * @param array $user_id_args
	 */
	private function set_from( $user_id_args ) {
		if ( empty( $this->settings['from'] ) ) {
			$from = get_option( 'admin_email' );
		} else {
			$from = $this->prepare_email_setting( $this->settings['from'], $user_id_args );
		}

		$this->from = $this->format_from( $from );
	}

	/**
	 * Set the Reply To addresses
	 *
	 * @since 2.03.04
	 *
	 * @param array $user_id_args
	 */
	private function set_reply_to( $user_id_args ) {
		$this->reply_to = trim( $this->settings['reply_to'] );

		if ( empty( $this->reply_to ) ) {
			$this->reply_to = $this->get_email_from_name( $this->from );
		} else {
			$this->reply_to = $this->prepare_email_setting( $this->settings['reply_to'], $user_id_args );
		}
		$this->reply_to = $this->format_reply_to( $this->reply_to );
	}

	/**
	 * Set the is_plain_text property
	 * This should be set before the message
	 *
	 * @since 2.03.04
	 */
	private function set_is_plain_text() {
		if ( $this->settings['plain_text'] ) {
			$this->is_plain_text = true;
		}
	}

	/**
	 * Set the include_user_info property
	 * This should be set before the message
	 *
	 * @since 2.03.04
	 */
	private function set_include_user_info() {
		if ( isset( $this->settings['inc_user_info'] ) ) {
			$this->include_user_info = $this->settings['inc_user_info'];
		}
	}

	/**
	 * Set the is_single_recipient property
	 *
	 * @since 2.03.04
	 *
	 * @param $action
	 */
	private function set_is_single_recipient( $action ) {
		$args = array(
			'form'   => $this->form,
			'entry'  => $this->entry,
			'action' => $action,
		);

		/**
		 * Send a separate email for email address in the "to" section
		 *
		 * @since 2.2.13
		 */
		$this->is_single_recipient = apply_filters( 'frm_send_separate_emails', false, $args );
	}

	/**
	 * Set the charset
	 *
	 * @since 2.03.04
	 */
	private function set_charset() {
		$this->charset = get_option( 'blog_charset' );
	}

	/**
	 * Set the content type
	 *
	 * @since 2.03.04
	 */
	private function set_content_type() {
		if ( $this->is_plain_text ) {
			$this->content_type = 'text/plain';
		}
	}

	/**
	 * Set the subject
	 *
	 * @since 2.03.04
	 */
	private function set_subject() {
		if ( empty( $this->settings['email_subject'] ) ) {
			/* translators: %1$s: Form name, %2$s: Site name */
			$this->subject = sprintf( __( '%1$s Form submitted on %2$s', 'formidable' ), $this->form->name, '[sitename]' );
		} else {
			$this->subject = $this->settings['email_subject'];
		}

		$this->subject = FrmFieldsHelper::basic_replace_shortcodes( $this->subject, $this->form, $this->entry );

		$args          = array(
			'form'      => $this->form,
			'entry'     => $this->entry,
			'email_key' => $this->email_key,
		);
		$this->subject = apply_filters( 'frm_email_subject', $this->subject, $args );

		$this->subject = wp_specialchars_decode( strip_tags( stripslashes( $this->subject ) ), ENT_QUOTES );
	}

	/**
	 * Set the email message
	 *
	 * @since 2.03.04
	 */
	private function set_message() {
		$this->message = FrmFieldsHelper::basic_replace_shortcodes( $this->settings['email_message'], $this->form, $this->entry );

		$prev_mail_body = $this->message;
		$pass_entry     = clone $this->entry; // make a copy to prevent changes by reference
		$mail_body      = FrmEntriesHelper::replace_default_message( $prev_mail_body, array(
			'id'         => $this->entry->id,
			'entry'      => $pass_entry,
			'plain_text' => $this->is_plain_text,
			'user_info'  => $this->include_user_info,
		) );

		// Add the user info if it isn't already included
		if ( $this->include_user_info && $prev_mail_body === $mail_body ) {
			$data = maybe_unserialize( $this->entry->description );
			$mail_body .= "\r\n\r\n" . __( 'User Information', 'formidable' ) . "\r\n";
			$this->maybe_add_ip( $mail_body );
			$mail_body .= __( 'User-Agent (Browser/OS)', 'formidable' ) . ': ' . FrmEntriesHelper::get_browser( $data['browser'] ) . "\r\n";

			$mail_body .= __( 'Referrer', 'formidable' ) . ': ' . $data['referrer'] . "\r\n";

		}

		$this->message = $mail_body;

		$this->message = do_shortcode( $this->message );

		if ( $this->is_plain_text ) {
			$this->message = wp_specialchars_decode( strip_tags( $this->message ), ENT_QUOTES );
		}

		$this->message = apply_filters( 'frm_email_message', $this->message, $this->package_atts() );
	}

	private function maybe_add_ip( &$mail_body ) {
		if ( ! empty( $this->entry->ip ) ) {
			$mail_body .= __( 'IP Address', 'formidable' ) . ': ' . $this->entry->ip . "\r\n";

		}
	}

	/**
	 * Set the attachments for an email message
	 *
	 * @since 2.03.04
	 */
	private function set_attachments() {
		$args = array(
			'entry'     => $this->entry,
			'email_key' => $this->email_key,
		);

		$this->attachments = apply_filters( 'frm_notification_attachment', array(), $this->form, $args );
	}

	/**
	 * Check if an email should send
	 *
	 * @since 2.03.04
	 *
	 * @return bool|mixed|void
	 */
	public function should_send() {
		if ( ! $this->has_recipients() ) {
			$send = false;
		} else {

			/**
			 * Stop an email based on the message, subject, recipient,
			 * or any information included in the email header
			 *
			 * @since 2.2.8
			 */
			$send = apply_filters( 'frm_send_email', true, array(
				'message'   => $this->message,
				'subject'   => $this->subject,
				'recipient' => $this->to,
				'header'    => $this->package_header(),
			) );
		}

		return $send;
	}

	/**
	 * Check if an email has any recipients
	 *
	 * @since 2.03.04
	 *
	 * @return bool
	 */
	private function has_recipients() {
		if ( empty( $this->to ) && empty( $this->cc ) && empty( $this->bcc ) ) {
			return false;
		} else {
			return true;
		}
	}

	/**
	 * Send an email
	 *
	 * @since 2.03.04
	 *
	 * @return bool
	 */
	public function send() {
		$this->remove_buddypress_filters();
		$this->add_mandrill_filter();

		$sent = false;
		if ( count( $this->to ) > 1 && $this->is_single_recipient ) {
			foreach ( $this->to as $recipient ) {
				$sent = $this->send_single( $recipient );
			}
		} else {
			$sent = $this->send_single( $this->to );
		}

		$this->remove_mandrill_filter();

		return $sent;
	}

	/**
	 * Send a single email
	 *
	 * @since 2.03.04
	 *
	 * @param array|string $recipient
	 *
	 * @return bool
	 */
	private function send_single( $recipient ) {
		$header = apply_filters( 'frm_email_header', $this->package_header(), array(
			'to_email' => $recipient,
			'subject'  => $this->subject,
		) );

		$subject = $this->encode_subject( $this->subject );

		$sent = wp_mail( $recipient, $subject, $this->message, $header, $this->attachments );

		if ( ! $sent ) {
			$header    = 'From: ' . $this->from . "\r\n";
			$recipient = implode( ',', (array) $recipient );
			$sent      = mail( $recipient, $subject, $this->message, $header );
		}

		do_action( 'frm_notification', $recipient, $subject, $this->message );

		return $sent;
	}

	/**
	 * Package the email header
	 *
	 * @since 2.03.04
	 *
	 * @return array
	 */
	private function package_header() {
		$header   = array();

		if ( ! empty( $this->cc ) ) {
			$header[] = 'CC: ' . implode( ',', $this->cc );
		}

		if ( ! empty( $this->bcc ) ) {
			$header[] = 'BCC: ' . implode( ',', $this->bcc );
		}

		$header[] = 'From: ' . $this->from;
		$header[] = 'Reply-To: ' . $this->reply_to;
		$header[] = 'Content-Type: ' . $this->content_type . '; charset="' . esc_attr( $this->charset ) . '"';

		return $header;
	}

	/**
	 * Get the userID field ID and key for email settings
	 *
	 * @since 2.03.04
	 *
	 * @param $form_id
	 *
	 * @return array
	 */
	private function get_user_id_args( $form_id ) {
		$user_id_args = array(
			'field_id'  => '',
			'field_key' => '',
		);

		$user_id_args['field_id'] = FrmEmailHelper::get_user_id_field_for_form( $form_id );
		if ( $user_id_args['field_id'] ) {
			$user_id_args['field_key'] = FrmField::get_key_by_id( $user_id_args['field_id'] );
		}

		return $user_id_args;
	}

	/**
	 * Prepare the to, cc, bcc, reply_to, and from setting
	 *
	 * @since 2.03.04
	 *
	 * @param string $value
	 * @param array $user_id_args
	 *
	 * @return string
	 */
	private function prepare_email_setting( $value, $user_id_args ) {
		if ( strpos( $value, '[' . $user_id_args['field_id'] . ']' ) !== false ) {
			$value = str_replace( '[' . $user_id_args['field_id'] . ']', '[' . $user_id_args['field_id'] . ' show="user_email"]', $value );
		} elseif ( strpos( $value, '[' . $user_id_args['field_key'] . ']' ) !== false ) {
			$value = str_replace( '[' . $user_id_args['field_key'] . ']', '[' . $user_id_args['field_key'] . ' show="user_email"]', $value );
		}

		$value = FrmFieldsHelper::basic_replace_shortcodes( $value, $this->form, $this->entry );

		// Remove brackets and add a space in case there isn't one
		$value = str_replace( '<', ' ', $value );
		$value = str_replace( array( '"', '>' ), '', $value );

		return $value;
	}

	/**
	 * Extract the emails from cc and bcc. Allow separation by , or ;.
	 * Trim the emails here as well
	 *
	 * @since 2.03.04
	 *
	 * @param string $emails
	 * @return array|string $emails
	 */
	private function explode_emails( $emails ) {
		$emails = ( ! empty( $emails ) ? preg_split( '/(,|;)/', $emails ) : '' );
		if ( is_array( $emails ) ) {
			$emails = array_map( 'trim', $emails );
		} else {
			$emails = trim( $emails );
		}

		return $emails;
	}

	/**
	 * Format the recipients( to, cc, bcc)
	 *
	 * @param array $recipients
	 *
	 * @return array
	 */
	private function format_recipients( $recipients ) {
		if ( empty( $recipients ) ) {
			return $recipients;
		}

		foreach ( $recipients as $key => $val ) {
			$val = trim( $val );

			if ( is_email( $val ) ) {
				// If a plain email is used, no formatting is needed
				continue;
			} else {
				$parts = explode( ' ', $val );
				$email = end( $parts );

				if ( is_email( $email ) ) {
					// If user enters a name and email
					$name = trim( str_replace( $email, '', $val ) );
				} else {
					// If user enters a name without an email
					unset( $recipients[ $key ] );
					continue;
				}
			}

			$recipients[ $key ] = $this->format_from_email( $name, $email );
		}

		return $recipients;
	}

	/**
	 * Format the From header
	 *
	 * @param string $from
	 *
	 * @return string
	 */
	private function format_from( $from ) {
		$from = trim( $from );

		if ( is_email( $from ) ) {
			// If a plain email is used, add the site name so "WordPress" doesn't get added
			$from_name  = wp_specialchars_decode( FrmAppHelper::site_name(), ENT_QUOTES );
			$from_email = $from;
		} else {
			list( $from_name, $from_email ) = $this->get_name_and_email_for_sender( $from );
		}

		// if sending the email from a yahoo address, change it to the WordPress default
		if ( strpos( $from_email, '@yahoo.com' ) ) {

			// Get the site domain and get rid of www.
			$sitename = strtolower( FrmAppHelper::get_server_value( 'SERVER_NAME' ) );
			if ( substr( $sitename, 0, 4 ) === 'www.' ) {
				$sitename = substr( $sitename, 4 );
			}

			$from_email = 'wordpress@' . $sitename;
		}

		return $this->format_from_email( $from_name, $from_email );
	}

	/**
	 * Format the Reply To property
	 *
	 * @since 2.03.04
	 *
	 * @param string $reply_to
	 *
	 * @return string
	 */
	private function format_reply_to( $reply_to ) {
		$reply_to = trim( $reply_to );

		if ( ! is_email( $reply_to ) ) {
			list( $name, $email ) = $this->get_name_and_email_for_sender( $reply_to );
			$reply_to = $this->format_from_email( $name, $email );
		}

		return $reply_to;
	}

	/**
	 * Get only the email if the name and email have been combined
	 *
	 * @since 3.0.06
	 */
	private function get_email_from_name( $name ) {
		$email = $name;
		if ( strpos( $name, '<' ) !== false ) {
			list( $name, $email ) = explode( '<', $name );
<?php

function returnThreeValues() {
    return array('a', 'b', 'c');
}

list($a, $b, $c) = returnThreeValues();

print $a . " - " . $c;
			$email = trim( $email, '>' );
		}
		return $email;
	}

	/**
	 * Get the name and email for the From or Reply To header
	 *
	 * @since 2.03.04
	 *
	 * @param string $sender
	 *
	 * @return array
	 */
	private function get_name_and_email_for_sender( $sender ) {
		$parts = explode( ' ', $sender );
		$end   = end( $parts );

		if ( is_email( $end ) ) {
			$name = trim( str_replace( $end, '', $sender ) );
		} else {
			// Only a name was entered in the From or Reply To field
			$name = $sender;
			$end  = get_option( 'admin_email' );
		}

		return array( $name, $end );
	}

	/**
	 * @since 3.0.06
	 */
	private function format_from_email( $name, $email ) {
		if ( '' !== $name ) {
			$email = $name . ' <' . $email . '>';
		}
		return $email;
	}

	/**
	 * Remove phone numbers from To addresses
	 * Send the phone numbers to the frm_send_to_not_email hook
	 *
	 * @since 2.03.04
	 */
	private function handle_phone_numbers() {

		foreach ( $this->to as $key => $recipient ) {
			if ( '[admin_email]' !== $recipient && ! is_email( $recipient ) ) {
				$recipient = explode( ' ', $recipient );

				if ( is_email( end( $recipient ) ) ) {
					continue;
				}

				do_action( 'frm_send_to_not_email', array(
					'e'           => $recipient,
					'subject'     => $this->subject,
					'mail_body'   => $this->message,
					'reply_to'    => $this->reply_to,
					'from'        => $this->from,
					'plain_text'  => $this->is_plain_text,
					'attachments' => $this->attachments,
					'form'        => $this->form,
					'email_key'   => $key,
				) );

				// Remove phone number from to addresses
				unset( $this->to[ $key ] );
			}
		}
	}

	/**
	 * Package an array of FrmEmail properties
	 *
	 * @since 2.03.04
	 *
	 * @return array
	 */
	public function package_atts() {
		return array(
			'to_email'    => $this->to,
			'cc'          => $this->cc,
			'bcc'         => $this->bcc,
			'from'        => $this->from,
			'reply_to'    => $this->reply_to,
			'subject'     => $this->subject,
			'message'     => $this->message,
			'attachments' => $this->attachments,
			'plain_text'  => $this->is_plain_text,
			'form'        => $this->form,
			'entry'       => $this->entry,
		);
	}

	/**
	 * Remove the Buddypress email filters
	 *
	 * @since 2.03.04
	 */
	private function remove_buddypress_filters() {
		remove_filter( 'wp_mail_from', 'bp_core_email_from_address_filter' );
		remove_filter( 'wp_mail_from_name', 'bp_core_email_from_name_filter' );
	}

	/**
	 * Add Mandrill line break filter
	 * Remove line breaks in HTML emails to prevent conflicts with Mandrill
	 *
	 * @since 2.03.04
	 */
	private function add_mandrill_filter() {
		if ( ! $this->is_plain_text ) {
			add_filter( 'mandrill_nl2br', 'FrmEmailHelper::remove_mandrill_br' );
		}
	}

	/**
	 * Remove Mandrill line break filter
	 *
	 * @since 2.03.04
	 */
	private function remove_mandrill_filter() {
		remove_filter( 'mandrill_nl2br', 'FrmEmailHelper::remove_mandrill_br' );
	}

	/**
	 * Encode the email subject
	 *
	 * @param string $subject
	 *
	 * @return string
	 */
	private function encode_subject( $subject ) {
		if ( apply_filters( 'frm_encode_subject', 1, $subject ) ) {
			$subject = '=?' . $this->charset . '?B?' . base64_encode( $subject ) . '?=';
		}

		return $subject;
	}
}


1			<?php
2
3			/**
4			* @since 2.03.04
5			*/
6			class FrmEmail {
7
8			private $email_key = '';
9			private $to = array();
10			private $cc = array();
11			private $bcc = array();
12			private $from = '';
13			private $reply_to = '';
14			private $subject = '';
15			private $message = '';
16			private $attachments = array();
17
18			private $is_plain_text = false;
19			private $is_single_recipient = false;
20			private $include_user_info = false;
21
22			private $charset = '';
23			private $content_type = 'text/html';
24
25			private $settings = array();
26			private $entry;
27			private $form;
28
29			/**
30			* FrmEmail constructor
31			*
32			* @param object $action
33			* @param object $entry
34			* @param object $form
35			*/
36			public function __construct( $action, $entry, $form ) {
37			$this->set_email_key( $action );
38			$this->entry = $entry;
39			$this->form = $form;
40			$this->settings = $action->post_content;
41
42			$user_id_args = self::get_user_id_args( $form->id );
43			$this->set_to( $user_id_args );
44			$this->set_cc( $user_id_args );
45			$this->set_bcc( $user_id_args );
46
47			if ( ! $this->has_recipients() ) {
48			return;
49			}
50
51			$this->set_from( $user_id_args );
52			$this->set_reply_to( $user_id_args );
53
54			$this->set_include_user_info();
55			$this->set_is_plain_text();
56			$this->set_is_single_recipient( $action );
57
58			$this->set_charset();
59			$this->set_content_type();
60
61			$this->set_subject();
62			$this->set_message();
63			$this->set_attachments();
64			}
65
66			/**
67			* Set the email key property
68			*
69			* @since 2.03.04
70			*
71			* @param object $action
72			*/
73			private function set_email_key( $action ) {
74			$this->email_key = $action->ID;
75			}
76
77			/**
78			* Set the to addresses
79			*
80			* @since 2.03.04
81			*
82			* @param array $user_id_args
83			*/
84			private function set_to( $user_id_args ) {
85			$to = $this->prepare_email_setting( $this->settings['email_to'], $user_id_args );
86			$to = $this->explode_emails( $to );
87
88			$where = array(
89			'it.field_id !' => 0,
90			'it.item_id' => $this->entry->id,
91			);
92			$values = FrmEntryMeta::getAll( $where, ' ORDER BY fi.field_order' );
93			$args = array(
94			'email_key' => $this->email_key,
95			'entry' => $this->entry,
96			'form' => $this->form,
97			);
98			$to = apply_filters( 'frm_to_email', $to, $values, $this->form->id, $args );
99
100			$this->to = array_unique( (array) $to );
101
102			if ( empty( $this->to ) ) {
103			return;
104			}
105
106			$this->handle_phone_numbers();
107
108			$this->to = $this->format_recipients( $this->to );
109			}
110
111			/**
112			* Set the CC addresses
113			*
114			* @since 2.03.04
115			*
116			* @param array $user_id_args
117			*/
118			private function set_cc( $user_id_args ) {
119			$this->cc = $this->prepare_additional_recipients( $this->settings['cc'], $user_id_args );
120			}
121
122			/**
123			* Set the BCC addresses
124			*
125			* @since 2.03.04
126			*
127			* @param array $user_id_args
128			*/
129			private function set_bcc( $user_id_args ) {
130			$this->bcc = $this->prepare_additional_recipients( $this->settings['bcc'], $user_id_args );
131			}
132
133			/**
134			* Prepare CC and BCC recipients
135			*
136			* @since 2.03.04
137			*
138			* @param string $recipients
139			* @param array $user_id_args
140			*
141			* @return array
142			*/
143			private function prepare_additional_recipients( $recipients, $user_id_args ) {
144			$recipients = $this->prepare_email_setting( $recipients, $user_id_args );
145			$recipients = $this->explode_emails( $recipients );
146
147			$recipients = array_unique( (array) $recipients );
148			$recipients = $this->format_recipients( $recipients );
149
150			return $recipients;
151			}
152
153			/**
154			* Set the From addresses
155			*
156			* @since 2.03.04
157			*
158			* @param array $user_id_args
159			*/
160			private function set_from( $user_id_args ) {
161			if ( empty( $this->settings['from'] ) ) {
162			$from = get_option( 'admin_email' );
163			} else {
164			$from = $this->prepare_email_setting( $this->settings['from'], $user_id_args );
165			}
166
167			$this->from = $this->format_from( $from );
168			}
169
170			/**
171			* Set the Reply To addresses
172			*
173			* @since 2.03.04
174			*
175			* @param array $user_id_args
176			*/
177			private function set_reply_to( $user_id_args ) {
178			$this->reply_to = trim( $this->settings['reply_to'] );
179
180			if ( empty( $this->reply_to ) ) {
181			$this->reply_to = $this->get_email_from_name( $this->from );
182			} else {
183			$this->reply_to = $this->prepare_email_setting( $this->settings['reply_to'], $user_id_args );
184			}
185			$this->reply_to = $this->format_reply_to( $this->reply_to );
186			}
187
188			/**
189			* Set the is_plain_text property
190			* This should be set before the message
191			*
192			* @since 2.03.04
193			*/
194			private function set_is_plain_text() {
195			if ( $this->settings['plain_text'] ) {
196			$this->is_plain_text = true;
197			}
198			}
199
200			/**
201			* Set the include_user_info property
202			* This should be set before the message
203			*
204			* @since 2.03.04
205			*/
206			private function set_include_user_info() {
207			if ( isset( $this->settings['inc_user_info'] ) ) {
208			$this->include_user_info = $this->settings['inc_user_info'];
209			}
210			}
211
212			/**
213			* Set the is_single_recipient property
214			*
215			* @since 2.03.04
216			*
217			* @param $action
218			*/
219			private function set_is_single_recipient( $action ) {
220			$args = array(
221			'form' => $this->form,
222			'entry' => $this->entry,
223			'action' => $action,
224			);
225
226			/**
227			* Send a separate email for email address in the "to" section
228			*
229			* @since 2.2.13
230			*/
231			$this->is_single_recipient = apply_filters( 'frm_send_separate_emails', false, $args );
232			}
233
234			/**
235			* Set the charset
236			*
237			* @since 2.03.04
238			*/
239			private function set_charset() {
240			$this->charset = get_option( 'blog_charset' );
241			}
242
243			/**
244			* Set the content type
245			*
246			* @since 2.03.04
247			*/
248			private function set_content_type() {
249			if ( $this->is_plain_text ) {
250			$this->content_type = 'text/plain';
251			}
252			}
253
254			/**
255			* Set the subject
256			*
257			* @since 2.03.04
258			*/
259			private function set_subject() {
260			if ( empty( $this->settings['email_subject'] ) ) {
261			/* translators: %1$s: Form name, %2$s: Site name */
262			$this->subject = sprintf( __( '%1$s Form submitted on %2$s', 'formidable' ), $this->form->name, '[sitename]' );
263			} else {
264			$this->subject = $this->settings['email_subject'];
265			}
266
267			$this->subject = FrmFieldsHelper::basic_replace_shortcodes( $this->subject, $this->form, $this->entry );
268
269			$args = array(
270			'form' => $this->form,
271			'entry' => $this->entry,
272			'email_key' => $this->email_key,
273			);
274			$this->subject = apply_filters( 'frm_email_subject', $this->subject, $args );
275
276			$this->subject = wp_specialchars_decode( strip_tags( stripslashes( $this->subject ) ), ENT_QUOTES );
277			}
278
279			/**
280			* Set the email message
281			*
282			* @since 2.03.04
283			*/
284			private function set_message() {
285			$this->message = FrmFieldsHelper::basic_replace_shortcodes( $this->settings['email_message'], $this->form, $this->entry );
286
287			$prev_mail_body = $this->message;
288			$pass_entry = clone $this->entry; // make a copy to prevent changes by reference
289			$mail_body = FrmEntriesHelper::replace_default_message( $prev_mail_body, array(
290			'id' => $this->entry->id,
291			'entry' => $pass_entry,
292			'plain_text' => $this->is_plain_text,
293			'user_info' => $this->include_user_info,
294			) );
295
296			// Add the user info if it isn't already included
297			if ( $this->include_user_info && $prev_mail_body === $mail_body ) {
298			$data = maybe_unserialize( $this->entry->description );
299			$mail_body .= "\r\n\r\n" . __( 'User Information', 'formidable' ) . "\r\n";
300			$this->maybe_add_ip( $mail_body );
301			$mail_body .= __( 'User-Agent (Browser/OS)', 'formidable' ) . ': ' . FrmEntriesHelper::get_browser( $data['browser'] ) . "\r\n";
			0 ignored issues – show introduced 2017-08-09 00:03 UTC by Report Bug Copy Issue Report Expected a sanitizing function (see Codex for 'Data Validation'), but instead saw 'FrmEntriesHelper' Loading history...
302			$mail_body .= __( 'Referrer', 'formidable' ) . ': ' . $data['referrer'] . "\r\n";
			0 ignored issues – show introduced 2015-11-23 19:35 UTC by Report Bug Copy Issue Report Expected next thing to be a escaping function, not '$data' Loading history...
303			}
304
305			$this->message = $mail_body;
306
307			$this->message = do_shortcode( $this->message );
308
309			if ( $this->is_plain_text ) {
310			$this->message = wp_specialchars_decode( strip_tags( $this->message ), ENT_QUOTES );
311			}
312
313			$this->message = apply_filters( 'frm_email_message', $this->message, $this->package_atts() );
314			}
315
316			private function maybe_add_ip( &$mail_body ) {
317			if ( ! empty( $this->entry->ip ) ) {
318			$mail_body .= __( 'IP Address', 'formidable' ) . ': ' . $this->entry->ip . "\r\n";
			0 ignored issues – show introduced 2017-02-23 17:07 UTC by Report Bug Copy Issue Report Expected next thing to be a escaping function, not '$this' Loading history...
319			}
320			}
321
322			/**
323			* Set the attachments for an email message
324			*
325			* @since 2.03.04
326			*/
327			private function set_attachments() {
328			$args = array(
329			'entry' => $this->entry,
330			'email_key' => $this->email_key,
331			);
332
333			$this->attachments = apply_filters( 'frm_notification_attachment', array(), $this->form, $args );
334			}
335
336			/**
337			* Check if an email should send
338			*
339			* @since 2.03.04
340			*
341			* @return bool\|mixed\|void
342			*/
343			public function should_send() {
344			if ( ! $this->has_recipients() ) {
345			$send = false;
346			} else {
347
348			/**
349			* Stop an email based on the message, subject, recipient,
350			* or any information included in the email header
351			*
352			* @since 2.2.8
353			*/
354			$send = apply_filters( 'frm_send_email', true, array(
355			'message' => $this->message,
356			'subject' => $this->subject,
357			'recipient' => $this->to,
358			'header' => $this->package_header(),
359			) );
360			}
361
362			return $send;
363			}
364
365			/**
366			* Check if an email has any recipients
367			*
368			* @since 2.03.04
369			*
370			* @return bool
371			*/
372			private function has_recipients() {
373			if ( empty( $this->to ) && empty( $this->cc ) && empty( $this->bcc ) ) {
374			return false;
375			} else {
376			return true;
377			}
378			}
379
380			/**
381			* Send an email
382			*
383			* @since 2.03.04
384			*
385			* @return bool
386			*/
387			public function send() {
388			$this->remove_buddypress_filters();
389			$this->add_mandrill_filter();
390
391			$sent = false;
392			if ( count( $this->to ) > 1 && $this->is_single_recipient ) {
393			foreach ( $this->to as $recipient ) {
394			$sent = $this->send_single( $recipient );
395			}
396			} else {
397			$sent = $this->send_single( $this->to );
398			}
399
400			$this->remove_mandrill_filter();
401
402			return $sent;
403			}
404
405			/**
406			* Send a single email
407			*
408			* @since 2.03.04
409			*
410			* @param array\|string $recipient
411			*
412			* @return bool
413			*/
414			private function send_single( $recipient ) {
415			$header = apply_filters( 'frm_email_header', $this->package_header(), array(
416			'to_email' => $recipient,
417			'subject' => $this->subject,
418			) );
419
420			$subject = $this->encode_subject( $this->subject );
421
422			$sent = wp_mail( $recipient, $subject, $this->message, $header, $this->attachments );
423
424			if ( ! $sent ) {
425			$header = 'From: ' . $this->from . "\r\n";
426			$recipient = implode( ',', (array) $recipient );
427			$sent = mail( $recipient, $subject, $this->message, $header );
428			}
429
430			do_action( 'frm_notification', $recipient, $subject, $this->message );
431
432			return $sent;
433			}
434
435			/**
436			* Package the email header
437			*
438			* @since 2.03.04
439			*
440			* @return array
441			*/
442			private function package_header() {
443			$header = array();
444
445			if ( ! empty( $this->cc ) ) {
446			$header[] = 'CC: ' . implode( ',', $this->cc );
447			}
448
449			if ( ! empty( $this->bcc ) ) {
450			$header[] = 'BCC: ' . implode( ',', $this->bcc );
451			}
452
453			$header[] = 'From: ' . $this->from;
454			$header[] = 'Reply-To: ' . $this->reply_to;
455			$header[] = 'Content-Type: ' . $this->content_type . '; charset="' . esc_attr( $this->charset ) . '"';
456
457			return $header;
458			}
459
460			/**
461			* Get the userID field ID and key for email settings
462			*
463			* @since 2.03.04
464			*
465			* @param $form_id
466			*
467			* @return array
468			*/
469			private function get_user_id_args( $form_id ) {
470			$user_id_args = array(
471			'field_id' => '',
472			'field_key' => '',
473			);
474
475			$user_id_args['field_id'] = FrmEmailHelper::get_user_id_field_for_form( $form_id );
476			if ( $user_id_args['field_id'] ) {
477			$user_id_args['field_key'] = FrmField::get_key_by_id( $user_id_args['field_id'] );
478			}
479
480			return $user_id_args;
481			}
482
483			/**
484			* Prepare the to, cc, bcc, reply_to, and from setting
485			*
486			* @since 2.03.04
487			*
488			* @param string $value
489			* @param array $user_id_args
490			*
491			* @return string
492			*/
493			private function prepare_email_setting( $value, $user_id_args ) {
494			if ( strpos( $value, '[' . $user_id_args['field_id'] . ']' ) !== false ) {
495			$value = str_replace( '[' . $user_id_args['field_id'] . ']', '[' . $user_id_args['field_id'] . ' show="user_email"]', $value );
496			} elseif ( strpos( $value, '[' . $user_id_args['field_key'] . ']' ) !== false ) {
497			$value = str_replace( '[' . $user_id_args['field_key'] . ']', '[' . $user_id_args['field_key'] . ' show="user_email"]', $value );
498			}
499
500			$value = FrmFieldsHelper::basic_replace_shortcodes( $value, $this->form, $this->entry );
501
502			// Remove brackets and add a space in case there isn't one
503			$value = str_replace( '<', ' ', $value );
504			$value = str_replace( array( '"', '>' ), '', $value );
505
506			return $value;
507			}
508
509			/**
510			* Extract the emails from cc and bcc. Allow separation by , or ;.
511			* Trim the emails here as well
512			*
513			* @since 2.03.04
514			*
515			* @param string $emails
516			* @return array\|string $emails
517			*/
518			private function explode_emails( $emails ) {
519			$emails = ( ! empty( $emails ) ? preg_split( '/(,\|;)/', $emails ) : '' );
520			if ( is_array( $emails ) ) {
521			$emails = array_map( 'trim', $emails );
522			} else {
523			$emails = trim( $emails );
524			}
525
526			return $emails;
527			}
528
529			/**
530			* Format the recipients( to, cc, bcc)
531			*
532			* @param array $recipients
533			*
534			* @return array
535			*/
536			private function format_recipients( $recipients ) {
537			if ( empty( $recipients ) ) {
538			return $recipients;
539			}
540
541			foreach ( $recipients as $key => $val ) {
542			$val = trim( $val );
543
544			if ( is_email( $val ) ) {
545			// If a plain email is used, no formatting is needed
546			continue;
547			} else {
548			$parts = explode( ' ', $val );
549			$email = end( $parts );
550
551			if ( is_email( $email ) ) {
552			// If user enters a name and email
553			$name = trim( str_replace( $email, '', $val ) );
554			} else {
555			// If user enters a name without an email
556			unset( $recipients[ $key ] );
557			continue;
558			}
559			}
560
561			$recipients[ $key ] = $this->format_from_email( $name, $email );
562			}
563
564			return $recipients;
565			}
566
567			/**
568			* Format the From header
569			*
570			* @param string $from
571			*
572			* @return string
573			*/
574			private function format_from( $from ) {
575			$from = trim( $from );
576
577			if ( is_email( $from ) ) {
578			// If a plain email is used, add the site name so "WordPress" doesn't get added
579			$from_name = wp_specialchars_decode( FrmAppHelper::site_name(), ENT_QUOTES );
580			$from_email = $from;
581			} else {
582			list( $from_name, $from_email ) = $this->get_name_and_email_for_sender( $from );
583			}
584
585			// if sending the email from a yahoo address, change it to the WordPress default
586			if ( strpos( $from_email, '@yahoo.com' ) ) {
587
588			// Get the site domain and get rid of www.
589			$sitename = strtolower( FrmAppHelper::get_server_value( 'SERVER_NAME' ) );
590			if ( substr( $sitename, 0, 4 ) === 'www.' ) {
591			$sitename = substr( $sitename, 4 );
592			}
593
594			$from_email = 'wordpress@' . $sitename;
595			}
596
597			return $this->format_from_email( $from_name, $from_email );
598			}
599
600			/**
601			* Format the Reply To property
602			*
603			* @since 2.03.04
604			*
605			* @param string $reply_to
606			*
607			* @return string
608			*/
609			private function format_reply_to( $reply_to ) {
610			$reply_to = trim( $reply_to );
611
612			if ( ! is_email( $reply_to ) ) {
613			list( $name, $email ) = $this->get_name_and_email_for_sender( $reply_to );
614			$reply_to = $this->format_from_email( $name, $email );
615			}
616
617			return $reply_to;
618			}
619
620			/**
621			* Get only the email if the name and email have been combined
622			*
623			* @since 3.0.06
624			*/
625			private function get_email_from_name( $name ) {
626			$email = $name;
627			if ( strpos( $name, '<' ) !== false ) {
628			list( $name, $email ) = explode( '<', $name );
			0 ignored issues – show Unused Code introduced 2018-02-19 23:43 UTC by Report Bug Copy Issue Report The assignment to `$name` is unused. Consider omitting it like so `list($first,,$third)`. This checks looks for assignemnts to variables using the `list(...)` function, where not all assigned variables are subsequently used. Consider the following code example. <?php function returnThreeValues() { return array('a', 'b', 'c'); } list($a, $b, $c) = returnThreeValues(); print $a . " - " . $c; Only the variables `$a` and `$c` are used. There was no need to assign `$b`. Instead, the list call could have been. list($a,, $c) = returnThreeValues(); Loading history...
629			$email = trim( $email, '>' );
630			}
631			return $email;
632			}
633
634			/**
635			* Get the name and email for the From or Reply To header
636			*
637			* @since 2.03.04
638			*
639			* @param string $sender
640			*
641			* @return array
642			*/
643			private function get_name_and_email_for_sender( $sender ) {
644			$parts = explode( ' ', $sender );
645			$end = end( $parts );
646
647			if ( is_email( $end ) ) {
648			$name = trim( str_replace( $end, '', $sender ) );
649			} else {
650			// Only a name was entered in the From or Reply To field
651			$name = $sender;
652			$end = get_option( 'admin_email' );
653			}
654
655			return array( $name, $end );
656			}
657
658			/**
659			* @since 3.0.06
660			*/
661			private function format_from_email( $name, $email ) {
662			if ( '' !== $name ) {
663			$email = $name . ' <' . $email . '>';
664			}
665			return $email;
666			}
667
668			/**
669			* Remove phone numbers from To addresses
670			* Send the phone numbers to the frm_send_to_not_email hook
671			*
672			* @since 2.03.04
673			*/
674			private function handle_phone_numbers() {
675
676			foreach ( $this->to as $key => $recipient ) {
677			if ( '[admin_email]' !== $recipient && ! is_email( $recipient ) ) {
678			$recipient = explode( ' ', $recipient );
679
680			if ( is_email( end( $recipient ) ) ) {
681			continue;
682			}
683
684			do_action( 'frm_send_to_not_email', array(
685			'e' => $recipient,
686			'subject' => $this->subject,
687			'mail_body' => $this->message,
688			'reply_to' => $this->reply_to,
689			'from' => $this->from,
690			'plain_text' => $this->is_plain_text,
691			'attachments' => $this->attachments,
692			'form' => $this->form,
693			'email_key' => $key,
694			) );
695
696			// Remove phone number from to addresses
697			unset( $this->to[ $key ] );
698			}
699			}
700			}
701
702			/**
703			* Package an array of FrmEmail properties
704			*
705			* @since 2.03.04
706			*
707			* @return array
708			*/
709			public function package_atts() {
710			return array(
711			'to_email' => $this->to,
712			'cc' => $this->cc,
713			'bcc' => $this->bcc,
714			'from' => $this->from,
715			'reply_to' => $this->reply_to,
716			'subject' => $this->subject,
717			'message' => $this->message,
718			'attachments' => $this->attachments,
719			'plain_text' => $this->is_plain_text,
720			'form' => $this->form,
721			'entry' => $this->entry,
722			);
723			}
724
725			/**
726			* Remove the Buddypress email filters
727			*
728			* @since 2.03.04
729			*/
730			private function remove_buddypress_filters() {
731			remove_filter( 'wp_mail_from', 'bp_core_email_from_address_filter' );
732			remove_filter( 'wp_mail_from_name', 'bp_core_email_from_name_filter' );
733			}
734
735			/**
736			* Add Mandrill line break filter
737			* Remove line breaks in HTML emails to prevent conflicts with Mandrill
738			*
739			* @since 2.03.04
740			*/
741			private function add_mandrill_filter() {
742			if ( ! $this->is_plain_text ) {
743			add_filter( 'mandrill_nl2br', 'FrmEmailHelper::remove_mandrill_br' );
744			}
745			}
746
747			/**
748			* Remove Mandrill line break filter
749			*
750			* @since 2.03.04
751			*/
752			private function remove_mandrill_filter() {
753			remove_filter( 'mandrill_nl2br', 'FrmEmailHelper::remove_mandrill_br' );
754			}
755
756			/**
757			* Encode the email subject
758			*
759			* @param string $subject
760			*
761			* @return string
762			*/
763			private function encode_subject( $subject ) {
764			if ( apply_filters( 'frm_encode_subject', 1, $subject ) ) {
765			$subject = '=?' . $this->charset . '?B?' . base64_encode( $subject ) . '?=';
766			}
767
768			return $subject;
769			}
770			}
771

Strategy11 / formidable-forms

Push — master ( cd1d04...d7e2d0 )

FrmEmail::set_bcc() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like