Email::normalize() - Code Metrics - Inspection of "Email class" - pryley/castor-framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 53ee13...d8eab8 )

by Paul

created 2017-03-25 20:41 UTC

Email::normalize() A

↳ Parent: Email

Complexity

Conditions	2
Paths	2

Size

Total Lines	18
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace GeminiLabs\Castor;

use GeminiLabs\Castor\Helpers\Template;
use GeminiLabs\Castor\Helpers\Utility;

class Email
{
	/**
	 * @var Template
	 */
	public $template;

	/**
	 * @var Utility
	 */
	public $utility;

	/**
	 * @var array
	 */
	protected $attachments;

	/**
	 * @var array
	 */
	protected $headers;

	/**
	 * @var string
	 */
	protected $message;

	/**
	 * @var string
	 */
	protected $subject;

	/**
	 * @var string
	 */
	protected $to;

	public function __construct( Template $template, Utility $utility )
	{
		$this->template = $template;
		$this->utility  = $utility;
	}

	/**
	 * @return Email
	 */
	public function compose( array $email )
	{
		$email = $this->normalize( $email );

		$this->attachments = $email['attachments'];
		$this->headers     = $this->buildHeaders( $email );
		$this->message     = $this->buildHtmlMessage( $email );
		$this->subject     = $email['subject'];
		$this->to          = $email['to'];

		add_action( 'phpmailer_init', function( PHPMailer $phpmailer ) {
			if( $phpmailer->ContentType === 'text/plain' || !empty( $phpmailer->AltBody ))return;
			$phpmailer->AltBody = $this->buildPlainTextMessage( $phpmailer->Body );
		});

		return $this;
	}

	/**
	 * @param bool $plaintext
	 *
	 * @return string|null
	 */
	public function read( $plaintext = false )
	{
		return $plaintext
			? $this->buildPlainTextMessage( $this->message )
			: $this->message;
	}

	/**
	 * @return bool|null
	 */
	public function send()
	{
		if( !$this->message || !$this->subject || !$this->to )return;

		$sent = wp_mail(
			$this->to,
			$this->subject,
			$this->message,
			$this->headers,
			$this->attachments
		);

		$this->reset();

		return $sent;
	}

	/**
	 * @return array
	 */
	protected function buildHeaders( array $email )
	{
		$allowed = [
			'bcc',
			'cc',
			'from',
			'reply-to',
		];

		$headers = array_intersect_key( $email, array_flip( $allowed ));
		$headers = array_filter( $headers );

		foreach( $headers as $key => $value ) {
			unset( $headers[ $key ] );
			$headers[] = sprintf( '%s: %s', $key, $value );
		}

		$headers[] = 'Content-Type: text/html';

		return apply_filters( 'castor/email/headers', $headers, $this );
	}

	/**
	 * @return string
	 */
	protected function buildHtmlMessage( array $email )
	{
		$body = $this->renderTemplate( 'email' );

		$message = !empty( $email['template'] )
			? $this->renderTemplate( $email['template'], $email['template-tags'] )
			: $email['message'];

		$message = $this->filterHtml( $email['before'] . $message . $email['after'] );
		$message = str_replace( '{message}', $message, $body );

		return apply_filters( 'castor/email/message', $message, 'html', $this );
	}

	/**
	 * @param string $message
	 *
	 * @return string
	 */
	protected function buildPlainTextMessage( $message )
	{
		return apply_filters( 'castor/email/message', $this->stripHtmlTags( $message ), 'text', $this );
	}

	/**
	 * @param string $message
	 *
	 * @return string
	 */
	protected function filterHtml( $message )
	{
		$message = strip_shortcodes( $message );
		$message = wptexturize( $message );
		$message = wpautop( $message );
		$message = str_replace( ['&lt;&gt; ', ']]>'], ['', ']]&gt;'], $message );
		$message = stripslashes( $message );
		return $message;
	}

	/**
	 * @return string
	 */
	protected function getDefaultFrom()
	{
		return sprintf( '%s <%s>',
			wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES ),
			get_option( 'admin_email' )
		);
	}

	/**
	 * @return array
	 */
	protected function normalize( $email )
	{
		$defaults = array_flip([
			'after', 'attachments', 'bcc', 'before', 'cc', 'from', 'message', 'reply-to', 'subject',
			'template', 'template-tags', 'to',
		]);

		$defaults['attachments'] = $defaults['template-tags'] = [];
		$defaults['from'] = $this->getDefaultFrom();

		$email = shortcode_atts( $defaults, $email );

		if( empty( $email['reply-to'] )) {
			$email['reply-to'] = $email['from'];
		}

		return apply_filters( 'castor/email/compose', $email, $this );
	}

	/**
	 * @return void
	 */
	protected function reset()
	{
		$this->attachments = [];
		$this->headers = [];
		$this->message = null;
		$this->subject = null;
		$this->to = null;
	}

	/**
	 * @param string $templatePath
	 *
	 * @return void|string
	 */
	protected function renderTemplate( $templatePath, array $args = [] )
	{
		$file = $this->template->get( sprintf( 'castor/%s', $templatePath ));

		if( !file_exists( $file )) {
			$file = sprintf( '%s/templates/%s.php', dirname( __DIR__ ), $templatePath );
		}
		if( !file_exists( $file ))return;

		ob_start();
		include $file;
		$template = ob_get_clean();

		return $this->renderTemplateString( $template, $args );
	}

	/**
	 * @param string $template
	 *
	 * @return string
	 */
	protected function renderTemplateString( $template, array $args = [] )
	{
		foreach( $args as $key => $value ) {
			$template = str_replace( sprintf( '{%s}', $key ), $value, $template );
		}
		return trim( $template );
	}

	/**
	 * - remove invisible elements
	 * - replace certain elements with a line-break
	 * - replace certain table elements with a space
	 * - add a placeholder for plain-text bullets to list elements
	 * - strip all remaining HTML tags
	 * @return string
	 */
	protected function stripHtmlTags( $string )
	{
		$string = preg_replace( '@<(embed|head|noembed|noscript|object|script|style)[^>]*?>.*?</\\1>@siu', '', $string );
		$string = preg_replace( '@</(div|h[1-9]|p|pre|tr)@iu', "\r\n\$0", $string );
		$string = preg_replace( '@</(td|th)@iu', " \$0", $string );
		$string = preg_replace( '@<(li)[^>]*?>@siu', "\$0-o-^-o-", $string );
		$string = wp_strip_all_tags( $string );
		$string = wp_specialchars_decode( $string, ENT_QUOTES );
		$string = preg_replace( '/\v(?:[\v\h]+){2,}/', "\r\n\r\n", $string );
		$string = str_replace( '-o-^-o-', ' - ', $string );
		return html_entity_decode( $string, ENT_QUOTES, 'UTF-8' );
	}
}


1			<?php
2
3			namespace GeminiLabs\Castor;
4
5			use GeminiLabs\Castor\Helpers\Template;
6			use GeminiLabs\Castor\Helpers\Utility;
7
8			class Email
9			{
10			/**
11			* @var Template
12			*/
13			public $template;
14
15			/**
16			* @var Utility
17			*/
18			public $utility;
19
20			/**
21			* @var array
22			*/
23			protected $attachments;
24
25			/**
26			* @var array
27			*/
28			protected $headers;
29
30			/**
31			* @var string
32			*/
33			protected $message;
34
35			/**
36			* @var string
37			*/
38			protected $subject;
39
40			/**
41			* @var string
42			*/
43			protected $to;
44
45			public function __construct( Template $template, Utility $utility )
46			{
47			$this->template = $template;
48			$this->utility = $utility;
49			}
50
51			/**
52			* @return Email
53			*/
54			public function compose( array $email )
55			{
56			$email = $this->normalize( $email );
57
58			$this->attachments = $email['attachments'];
59			$this->headers = $this->buildHeaders( $email );
60			$this->message = $this->buildHtmlMessage( $email );
61			$this->subject = $email['subject'];
62			$this->to = $email['to'];
63
64			add_action( 'phpmailer_init', function( PHPMailer $phpmailer ) {
65			if( $phpmailer->ContentType === 'text/plain' \|\| !empty( $phpmailer->AltBody ))return;
66			$phpmailer->AltBody = $this->buildPlainTextMessage( $phpmailer->Body );
67			});
68
69			return $this;
70			}
71
72			/**
73			* @param bool $plaintext
74			*
75			* @return string\|null
76			*/
77			public function read( $plaintext = false )
78			{
79			return $plaintext
80			? $this->buildPlainTextMessage( $this->message )
81			: $this->message;
82			}
83
84			/**
85			* @return bool\|null
86			*/
87			public function send()
88			{
89			if( !$this->message \|\| !$this->subject \|\| !$this->to )return;
90
91			$sent = wp_mail(
92			$this->to,
93			$this->subject,
94			$this->message,
95			$this->headers,
96			$this->attachments
97			);
98
99			$this->reset();
100
101			return $sent;
102			}
103
104			/**
105			* @return array
106			*/
107			protected function buildHeaders( array $email )
108			{
109			$allowed = [
110			'bcc',
111			'cc',
112			'from',
113			'reply-to',
114			];
115
116			$headers = array_intersect_key( $email, array_flip( $allowed ));
117			$headers = array_filter( $headers );
118
119			foreach( $headers as $key => $value ) {
120			unset( $headers[ $key ] );
121			$headers[] = sprintf( '%s: %s', $key, $value );
122			}
123
124			$headers[] = 'Content-Type: text/html';
125
126			return apply_filters( 'castor/email/headers', $headers, $this );
127			}
128
129			/**
130			* @return string
131			*/
132			protected function buildHtmlMessage( array $email )
133			{
134			$body = $this->renderTemplate( 'email' );
135
136			$message = !empty( $email['template'] )
137			? $this->renderTemplate( $email['template'], $email['template-tags'] )
138			: $email['message'];
139
140			$message = $this->filterHtml( $email['before'] . $message . $email['after'] );
141			$message = str_replace( '{message}', $message, $body );
142
143			return apply_filters( 'castor/email/message', $message, 'html', $this );
144			}
145
146			/**
147			* @param string $message
148			*
149			* @return string
150			*/
151			protected function buildPlainTextMessage( $message )
152			{
153			return apply_filters( 'castor/email/message', $this->stripHtmlTags( $message ), 'text', $this );
154			}
155
156			/**
157			* @param string $message
158			*
159			* @return string
160			*/
161			protected function filterHtml( $message )
162			{
163			$message = strip_shortcodes( $message );
164			$message = wptexturize( $message );
165			$message = wpautop( $message );
166			$message = str_replace( ['<> ', ']]>'], ['', ']]>'], $message );
167			$message = stripslashes( $message );
168			return $message;
169			}
170
171			/**
172			* @return string
173			*/
174			protected function getDefaultFrom()
175			{
176			return sprintf( '%s <%s>',
177			wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES ),
178			get_option( 'admin_email' )
179			);
180			}
181
182			/**
183			* @return array
184			*/
185			protected function normalize( $email )
186			{
187			$defaults = array_flip([
188			'after', 'attachments', 'bcc', 'before', 'cc', 'from', 'message', 'reply-to', 'subject',
189			'template', 'template-tags', 'to',
190			]);
191
192			$defaults['attachments'] = $defaults['template-tags'] = [];
193			$defaults['from'] = $this->getDefaultFrom();
194
195			$email = shortcode_atts( $defaults, $email );
196
197			if( empty( $email['reply-to'] )) {
198			$email['reply-to'] = $email['from'];
199			}
200
201			return apply_filters( 'castor/email/compose', $email, $this );
202			}
203
204			/**
205			* @return void
206			*/
207			protected function reset()
208			{
209			$this->attachments = [];
210			$this->headers = [];
211			$this->message = null;
212			$this->subject = null;
213			$this->to = null;
214			}
215
216			/**
217			* @param string $templatePath
218			*
219			* @return void\|string
220			*/
221			protected function renderTemplate( $templatePath, array $args = [] )
222			{
223			$file = $this->template->get( sprintf( 'castor/%s', $templatePath ));
224
225			if( !file_exists( $file )) {
226			$file = sprintf( '%s/templates/%s.php', dirname( __DIR__ ), $templatePath );
227			}
228			if( !file_exists( $file ))return;
229
230			ob_start();
231			include $file;
232			$template = ob_get_clean();
233
234			return $this->renderTemplateString( $template, $args );
235			}
236
237			/**
238			* @param string $template
239			*
240			* @return string
241			*/
242			protected function renderTemplateString( $template, array $args = [] )
243			{
244			foreach( $args as $key => $value ) {
245			$template = str_replace( sprintf( '{%s}', $key ), $value, $template );
246			}
247			return trim( $template );
248			}
249
250			/**
251			* - remove invisible elements
252			* - replace certain elements with a line-break
253			* - replace certain table elements with a space
254			* - add a placeholder for plain-text bullets to list elements
255			* - strip all remaining HTML tags
256			* @return string
257			*/
258			protected function stripHtmlTags( $string )
259			{
260			$string = preg_replace( '@<(embed\|head\|noembed\|noscript\|object\|script\|style)[^>]?>.?</\\1>@siu', '', $string );
261			$string = preg_replace( '@</(div\|h[1-9]\|p\|pre\|tr)@iu', "\r\n\$0", $string );
262			$string = preg_replace( '@</(td\|th)@iu', " \$0", $string );
263			$string = preg_replace( '@<(li)[^>]*?>@siu', "\$0-o-^-o-", $string );
264			$string = wp_strip_all_tags( $string );
265			$string = wp_specialchars_decode( $string, ENT_QUOTES );
266			$string = preg_replace( '/\v(?:[\v\h]+){2,}/', "\r\n\r\n", $string );
267			$string = str_replace( '-o-^-o-', ' - ', $string );
268			return html_entity_decode( $string, ENT_QUOTES, 'UTF-8' );
269			}
270			}
271

pryley / castor-framework

Push — develop ( 53ee13...d8eab8 )

Email::normalize() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like