EmailLog\Core\EmailLogger

Complexity

Total Complexity

12

Size/Duplication

Total Lines	142
Duplicated Lines	0 %

Test Coverage

Coverage

60.38%

Importance

Changes	9
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	load()	0	3	1
A	update_email_fail_status()	0	21	4
B	log_email()	0	95	7

<?php namespace EmailLog\Core;

/**
 * Log's emails sent through `wp_mail`.
 *
 * @package EmailLog\Core
 * @since   2.0
 */
class EmailLogger implements Loadie {

	/**
	 * Load the logger.
	 */
	public function load() {
		add_filter( 'wp_mail', array( $this, 'log_email' ) );
		add_action( 'wp_mail_failed', array( $this, 'update_email_fail_status' ) );
	}

	/**
	 * Logs email to database.
	 *
	 * @param array $mail_info Information about email.
	 *
	 * @return array Information about email.
	 */
	public function log_email( $mail_info ) {
		$email_log = email_log();
		/**
		 * Hook to modify wp_mail contents before Email Log plugin logs.
		 *
		 * @since Genesis
		 *
		 * @param array $mail_info {
		 *     @type string|array $to
		 *     @type string       $subject
		 *     @type string       $message
		 *     @type string       $headers
		 *     @type string       $attachment
		 *     @type string|array $headers
		 *     @type string|array $attachment
		 * }
		 */
		$mail_info = apply_filters( 'el_wp_mail_log', $mail_info );

		// Sometimes the array passed to the `wp_mail` filter may not contain all the required keys.
		// See https://wordpress.org/support/topic/illegal-string-offset-attachments/.
		$cleaned_mail_info = wp_parse_args(
			$mail_info,
			array(
				'attachments' => array(),
				'to'          => '',
				'subject'     => '',
				'headers'     => '',
			)
		);

		// ! empty() check on attachments handles both empty string and empty array.
		$data = array(
			'attachments'     => ( ! empty( $cleaned_mail_info['attachments'] ) ) ? 'true' : 'false',
			'subject'         => $cleaned_mail_info['subject'],
			'headers'         => is_array( $cleaned_mail_info['headers'] ) ? implode( "\n", $cleaned_mail_info['headers'] ) : $cleaned_mail_info['headers'],
			'sent_date'       => current_time( 'mysql' ),
			'attachment_name' => implode( ',', $cleaned_mail_info['attachments'] ),
			// TODO: Improve the Client's IP using https://www.virendrachandak.com/techtalk/getting-real-client-ip-address-in-php-2/.
			'ip_address'      => $_SERVER['REMOTE_ADDR'],
			'result'          => 1,
		);

		$to = '';
		if ( empty( $cleaned_mail_info['to'] ) ) {
			$to = '';
		} elseif ( is_array( $cleaned_mail_info['to'] ) ) {
			$to = implode( ',', $cleaned_mail_info['to'] );
		} else {
			$to = $cleaned_mail_info['to'];
		}

		$data['to_email'] = $to;

		$message = '';

		if ( isset( $cleaned_mail_info['message'] ) ) {
			$message = $cleaned_mail_info['message'];
		} else {
			// wpmandrill plugin is changing "message" key to "html". See https://github.com/sudar/email-log/issues/20
			// Ideally this should be fixed in wpmandrill, but I am including this hack here till it is fixed by them.
			if ( isset( $cleaned_mail_info['html'] ) ) {
				$message = $cleaned_mail_info['html'];
			}
		}

		$data['message'] = $message;

		/**
		 * Filters the mail info right before inserting on the table.
		 *
		 * Masked fields would use this filter to avoid modifying the original data sent to
		 * `wp_mail() function`
		 *
		 * @since 2.3.2
		 */
		$data = apply_filters( 'el_email_log_before_insert', $data );

		$email_log->table_manager->insert_log( $data );

		/**
		 * Fires the `el_email_log_inserted` action right after the log is inserted in to DB.
		 *
		 * @param array $data {
		 *      @type string $to
		 *      @type string $subject
		 *      @type string $message
		 *      @type string $headers
		 *      @type string $attachments
		 *      @type string $sent_date
		 * }
		 */
		do_action( 'el_email_log_inserted', $data );

		return $mail_info;
	}

	/**
	 * Updates the failed email in the DB.
	 *
	 * @since 2.3.0
	 *
	 * @param \WP_Error $wp_error The error instance.
	 */
	public function update_email_fail_status( $wp_error ) {
		if ( ! ( $wp_error instanceof \WP_Error ) ) {

$wp_error is always a sub-type of WP_Error.

			return;
		}

		$email_log       = email_log();
		$mail_error_data = $wp_error->get_error_data( 'wp_mail_failed' );

		// $mail_error_data can be of type mixed.
		if ( ! is_array( $mail_error_data ) ) {
			return;
		}

		// @see wp-includes/pluggable.php#484
		$log_item_id = $email_log->table_manager->fetch_log_item_by_item_data( $mail_error_data );
		// Empty will handle 0 and return FALSE.
		if ( empty( $log_item_id ) ) {
			return;
		}

		$email_log->table_manager->set_log_item_fail_status_by_id( $log_item_id );
	}
}