lekoala / silverstripe-email-templates

src/Models/SentEmail.php

<?php

namespace LeKoala\EmailTemplates\Models;

use LeKoala\CmsActions\CustomAction;

The type LeKoala\CmsActions\CustomAction was not found. Maybe you did not declare it correctly or list all dependencies?

use SilverStripe\Admin\AdminRootController;
use LeKoala\EmailTemplates\Admin\EmailTemplatesAdmin;
use LeKoala\EmailTemplates\Email\BetterEmail;
use SilverStripe\Control\Director;
use SilverStripe\Control\Email\Email;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\LiteralField;
use SilverStripe\Forms\ReadonlyField;
use SilverStripe\ORM\DB;
use SilverStripe\ORM\DataObject;
use SilverStripe\Security\Member;
use SilverStripe\Security\Permission;

/**
 * Defines a record that stores an email
 *
 * @link https://github.com/nyeholt/silverstripe-mailcapture/blob/master/src/Model/CapturedEmail.php
 * @property string $To
 * @property string $From
 * @property string $Subject
 * @property string $Body
 * @property string $CC
 * @property string $BCC
 * @property string|null $Results
 * @property string $ReplyTo
 * @property string $Headers
 * @author lekoala
 */
class SentEmail extends DataObject
{
    private static $table_name = 'SentEmail';

The private property $table_name is not used, and could be removed.

    private static $db = [

The private property $db is not used, and could be removed.

        'To' => 'Varchar(191)',
        'From' => 'Varchar(191)',
        'ReplyTo' => 'Varchar(191)',
        'Subject' => 'Varchar(191)',
        'Body' => 'HTMLText',
        'Headers' => 'Text',
        'CC' => 'Text',
        'BCC' => 'Text',
        'Results' => 'Text',
    ];
    private static $summary_fields = [

The private property $summary_fields is not used, and could be removed.

        'Created.Nice' => 'Date',
        'To' => 'To',
        'Subject' => 'Subject',
        'IsSuccess' => 'Success',
    ];

    private static $default_sort = 'Created DESC';

The private property $default_sort is not used, and could be removed.

    private static $compress_body = false;

The private property $compress_body is not used, and could be removed.

    public function setBody(string $v)
    {
        if ($this->config()->get('compress_body') && function_exists('gzdeflate')) {
            $compressed = self::COMPRESSED_SIGNATURE . base64_encode(gzdeflate($v, 9)); // Use maximum compression level
            if ($compressed !== false) {

The condition $compressed !== false is always true.

                $this->record['Body'] = $compressed;
                return;
            }
        }
        $this->record['Body'] = $v;
    }

    const COMPRESSED_SIGNATURE = 'base64/deflate:';
    public function getBody(): string
    {
        $body = $this->record['Body'];

        if (substr($body, 0, strlen(self::COMPRESSED_SIGNATURE)) == self::COMPRESSED_SIGNATURE) {
            if (!function_exists('gzinflate')) {
                return 'This email body is compressed with zlib. Please install zlib module to see it.';
            }
            $raw = base64_decode(substr($body, strlen(self::COMPRESSED_SIGNATURE)));
            if ($raw !== false) {
                return gzinflate($raw);
            }
        }

        return $body;
    }

    /**
     * Gets a list of actions for the ModelAdmin interface
     * @return FieldList
     */
    public function getCMSActions()
    {
        $fields = parent::getCMSActions();

        if (class_exists(CustomAction::class)) {
            $fields->push(
                CustomAction::create('resend', 'Resend')
            );
        }

        return $fields;
    }

    /**
     * Gets a list of form fields for editing the record.
     * These records should never be edited, so a readonly list of fields
     * is forced.
     *
     * @return FieldList
     */
    public function getCMSFields()
    {
        $f = FieldList::create();

        $f->push(ReadonlyField::create('Created'));
        $f->push(ReadonlyField::create('From'));
        $f->push(ReadonlyField::create('To'));
        $f->push(ReadonlyField::create('Subject'));

        if ($this->BCC) {
            $f->push(ReadonlyField::create('BCC'));
        }
        if ($this->CC) {
            $f->push(ReadonlyField::create('CC'));
        }

        $f->push(ReadonlyField::create('Results'));

        $sanitisedModel =  str_replace('\\', '-', SentEmail::class);
        $adminSegment = EmailTemplatesAdmin::config()->get('url_segment');
        $adminBaseSegment = AdminRootController::config()->get('url_base');
        $iframeSrc = Director::baseURL() . $adminBaseSegment . '/' . $adminSegment . '/' . $sanitisedModel . '/ViewSentEmail/?id=' . $this->ID;
        $iframe = new LiteralField('iframe', '<iframe src="' . $iframeSrc . '" style="width:800px;background:#fff;border:1px solid #ccc;min-height:500px;vertical-align:top"></iframe>');
        $f->push($iframe);

        $this->extend('updateCMSFields', $f);

        return $f;
    }

    /**
     * @return bool
     */
    public function IsSuccess()
    {
        return $this->Results == 'true';
    }

    /**
     * Gets the BetterEmail object that was used to send this email
     * @return BetterEmail
     */
    public function getEmail()
    {
        /** @var BetterEmail */
        $email = Email::create();

        $email->setTo($this->To);
        $email->setCc($this->CC);
        $email->setBCC($this->BCC);
        $email->setSubject($this->Subject);
        $email->setReplyTo($this->ReplyTo);
        $email->setBody($this->Body);

        return $email;
    }

    /**
     * A BetterButtons custom action that allows the email to be resent
     */
    public function resend()
    {
        if ($e = $this->getEmail()) {
            $results = $e->doSend();

            // Update results
            $this->Results = json_encode($results);
            $this->write();

            return 'Sent';
        }

        return 'Could not send email';
    }


    /**
     * Cleanup sent emails based on your config
     *
     * @return void
     */
    public static function cleanup()
    {
        $max = self::config()->get('max_records');
        if ($max && self::get()->count() > $max) {
            $method = self::config()->get('cleanup_method');

            // Delete all records older than cleanup_time (7 days by default)
            if ($method == 'time') {
                $time = self::config()->get('cleanup_time');
                $date = date('Y-m-d H:i:s', strtotime($time));
                DB::query("DELETE FROM \"SentEmail\" WHERE Created < '$date'");
            }

            // Delete all records that are after half the maximum number of records
            if ($method == 'max') {
                $maxID = SentEmail::get()->max('ID') - ($max / 2);
                DB::query("DELETE FROM \"SentEmail\" WHERE ID < '$maxID'");
            }
        }
    }

    /**
     * Defines the view permission
     * @param  Member $member
     * @return boolean
     */
    public function canView($member = null)
    {
        return Permission::check('CMS_ACCESS');
    }

    /**
     * Defines the edit permission
     * @param  Member $member
     * @return boolean
     */
    public function canEdit($member = null)
    {
        return false;
    }

    /**
     * Defines the create permission
     * @param  Member $member
     * @return boolean
     */
    public function canCreate($member = null, $context = [])
    {
        return false;
    }

    /**
     * Defines the delete permission
     * @param  Member $member
     * @return boolean
     */
    public function canDelete($member = null)
    {
        return Permission::check('CMS_ACCESS');
    }
}