GeminiLabs\SiteReviews\Modules\Email

Complexity

Total Complexity

27

Size/Duplication

Total Lines	214
Duplicated Lines	0 %

Test Coverage

Coverage

85.34%

Importance

Changes	1
Bugs	0	Features	1

17 Methods

Rating	Name	Duplication	Size	Complexity
A	validate()	0	12	2
A	defaults()	0	3	1
A	buildHeaders()	0	13	2
A	buildHtmlMessage()	0	15	1
A	stripHtmlTags()	0	23	2
A	app()	0	3	1
A	buildPlainTextMessage()	0	10	4
A	logMailError()	0	8	1
A	template()	0	3	1
A	reset()	0	9	1
A	read()	0	7	2
A	send()	0	17	2
A	test()	0	14	1
A	normalize()	0	5	1
A	data()	0	3	1
A	buildMessage()	0	12	3
A	compose()	0	11	1

<?php

namespace GeminiLabs\SiteReviews\Modules;

use GeminiLabs\SiteReviews\Arguments;
use GeminiLabs\SiteReviews\Contracts\EmailContract;
use GeminiLabs\SiteReviews\Contracts\PluginContract;
use GeminiLabs\SiteReviews\Contracts\TemplateContract;
use GeminiLabs\SiteReviews\Database\OptionManager;
use GeminiLabs\SiteReviews\Defaults\DefaultsAbstract;
use GeminiLabs\SiteReviews\Defaults\EmailDefaults;
use GeminiLabs\SiteReviews\Helpers\Str;
use GeminiLabs\SiteReviews\Modules\Html\Template;

class Email implements EmailContract
{
    public array $attachments = [];
    public array $data = [];
    public array $email = [];
    public array $headers = [];
    public string $message = '';
    public array $recipients = [];
    public string $subject = '';

    public function app(): PluginContract
    {
        return glsr();
    }

    public function compose(array $email, array $data = []): EmailContract
    {
        $this->data = $data;
        $this->email = $this->normalize($email);
        $this->attachments = $this->email['attachments'];
        $this->headers = $this->buildHeaders();
        $this->message = $this->buildHtmlMessage();
        $this->recipients = $this->email['recipients'];
        $this->subject = $this->email['subject'];
        add_action('phpmailer_init', [$this, 'buildPlainTextMessage']);
        return $this;
    }

    public function data(): Arguments
    {
        return glsr()->args($this->data);
    }

    public function defaults(): DefaultsAbstract
    {
        return glsr(EmailDefaults::class);
    }

    public function logMailError(\WP_Error $error): void
    {
        glsr_log()
            ->error('[wp_mail] Email was not sent: '.$error->get_error_message())
            ->debug([
                'headers' => $this->headers,
                'attachments' => $this->attachments,
                'email' => $this->email,
            ]);
    }

    public function read(string $format = ''): string
    {
        if ('plaintext' === $format) {
            $message = $this->stripHtmlTags($this->message);
            return $this->app()->filterString('email/message', $message, 'text', $this);
        }
        return $this->message;
    }

    public function send(): bool
    {
        if (!$this->validate()) {
            glsr_log()->warning(sprintf('The email is missing the %s', Str::naturalJoin($missing)));

The variable $missing seems to be never defined.

            return false;
        }
        add_action('wp_mail_failed', [$this, 'logMailError']);
        $sent = wp_mail(
            $this->recipients,
            $this->subject,
            $this->message,
            $this->headers,
            $this->attachments
        );
        remove_action('wp_mail_failed', [$this, 'logMailError']);
        $this->reset();
        return $sent;
    }

    public function test(): bool
    {
        $recipient = get_bloginfo('admin_email');
        $subject = "[TEST EMAIL] {$this->subject}";
        add_action('wp_mail_failed', [$this, 'logMailError']);
        $sent = wp_mail(
            $recipient,
            $subject,
            $this->message,
            $this->headers,
            $this->attachments
        );
        remove_action('wp_mail_failed', [$this, 'logMailError']);
        return $sent;
    }

    public function template(): TemplateContract
    {
        return glsr(Template::class);
    }

    /**
     * @action phpmailer_init
     */
    public function buildPlainTextMessage($phpmailer): void
    {
        if (empty($this->email)) {
            return;
        }
        if ('text/plain' === $phpmailer->ContentType || !empty($phpmailer->AltBody)) {
            return;
        }
        $message = $this->stripHtmlTags($phpmailer->Body);
        $phpmailer->AltBody = $this->app()->filterString('email/message', $message, 'text', $this);
    }

    protected function buildHeaders(): array
    {
        $allowed = [
            'bcc', 'cc', 'from', 'reply-to',
        ];
        $headers = array_intersect_key($this->email, array_flip($allowed));
        $headers = array_filter($headers);
        foreach ($headers as $key => $value) {
            unset($headers[$key]);
            $headers[] = "{$key}: {$value}";
        }
        $headers[] = 'Content-Type: text/html';
        return $this->app()->filterArray('email/headers', $headers, $this);
    }

    protected function buildHtmlMessage(): string
    {
        $message = $this->buildMessage();
        $message = $this->email['before'].$message.$this->email['after'];
        $message = strip_shortcodes($message);
        $message = wptexturize($message);
        $message = wpautop($message);
        $message = str_replace('<> ', '', $message);
        $message = str_replace(']]>', ']]>', $message);
        $context = wp_parse_args(['message' => $message], $this->email['template-tags']);
        $template = $this->email['template'];
        $message = $this->template()->build("templates/emails/{$template}", [
            'context' => $context,
        ]);
        return $this->app()->filterString('email/message', stripslashes($message), 'html', $this);
    }

    protected function buildMessage(): string
    {
        if (!empty($this->email['message'])) {
            return $this->email['message'];
        }
        $template = trim(glsr(OptionManager::class)->get('settings.general.notification_message'));
        if (!empty($template)) {
            $context = ['context' => $this->email['template-tags']];
            $templatePathForHook = 'notification_message';
            return $this->template()->interpolate($template, $templatePathForHook, $context);
        }
        return '';
    }

    protected function normalize(array $email = []): array
    {
        $email = $this->defaults()->restrict($email);
        $email = $this->app()->filterArray('email/compose', $email, $this);
        return $email;
    }

    protected function reset(): void
    {
        $this->attachments = [];
        $this->data = [];
        $this->email = [];
        $this->headers = [];
        $this->message = '';
        $this->recipients = [];
        $this->subject = '';
    }

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

    protected function validate(): bool
    {
        $required = [
            'message' => !empty($this->message),
            'recipient' => !empty($this->recipients),
            'subject' => !empty($this->subject),
        ];
        $missing = array_keys(array_diff($required, array_filter($required)));
        if (empty($missing)) {
            return true;
        }
        return false;
    }
}