DelayedEmailService.php

Go to the documentation of this file.

<?php

namespace Elgg\Email;

use Elgg\Database\DelayedEmailQueueTable;
use Elgg\Email;
use Elgg\Email\DelayedQueue\DatabaseRecord;
use Elgg\EmailService;
use Elgg\Exceptions\DatabaseException;
use Elgg\I18n\Translator;
use Elgg\Invoker;
use Elgg\Notifications\Notification;
use Elgg\Traits\Loggable;
use Elgg\ViewsService;

class DelayedEmailService {
    
    use Loggable;
    
    protected const NOTIFICATIONS_BATCH_SIZE = 500;
    
    protected $queue_table;
    
    protected $email;
    
    protected $views;
    
    protected $translator;
    
    protected $invoker;
    
    public function __construct(DelayedEmailQueueTable $queue_table, EmailService $email, ViewsService $views, Translator $translator, Invoker $invoker) {
        $this->queue_table = $queue_table;
        $this->email = $email;
        $this->views = $views;
        $this->translator = $translator;
        $this->invoker = $invoker;
    }
    
    public function enqueueNotification(Notification $notification): bool {
        $recipient = $notification->getRecipient();
        
        $delivery_interval = $recipient->delayed_email_interval ?: 'daily';
        
        try {
            return $this->queue_table->queueEmail($recipient->guid, $delivery_interval, $notification);
        } catch (DatabaseException $e) {
            $this->getLogger()->error($e);
        }
        
        return false;
    }
    
    public function processQueuedNotifications(string $delivery_interval, int $timestamp): int {
        // processing could take a while
        set_time_limit(0);
        
        return ($this->invoker->call(ELGG_IGNORE_ACCESS, function() use ($delivery_interval, $timestamp) {
            $count = 0;
            
            // process one recipient
            $processRecipient = function(int $recipient_guid, array $notifications, int $max_id) use ($delivery_interval, $timestamp) {
                try {
                    $this->processRecipientNotifications($recipient_guid, $notifications, $delivery_interval);
                } catch (\Throwable $t) {
                    $this->getLogger()->error($t);
                }
                
                // cleanup the queue for this recipient
                return $this->queue_table->deleteRecipientRows($recipient_guid, $delivery_interval, $timestamp, $max_id);
            };
            
            // get the next recipient to process
            $recipient_guid = $this->queue_table->getNextRecipientGUID($delivery_interval, $timestamp);
            while ($recipient_guid > 0) {
                // get a notification batch to process for this recipient
                $rows = $this->queue_table->getRecipientRows($recipient_guid, $delivery_interval, $timestamp, self::NOTIFICATIONS_BATCH_SIZE);
                while (!empty($rows)) {
                    $notifications = [];
                    $max_id = 0;
                    foreach ($rows as $row) {
                        $max_id = max($max_id, $row->id);
                        
                        $notification = $row->getNotification();
                        if (!$notification instanceof Notification) {
                            continue;
                        }
                        
                        $notifications[] = $notification;
                    }
                    
                    // send all notifications in this batch
                    $count += $processRecipient($recipient_guid, $notifications, $max_id);
                    
                    // get next batch
                    $rows = $this->queue_table->getRecipientRows($recipient_guid, $delivery_interval, $timestamp, static::NOTIFICATIONS_BATCH_SIZE);
                }
                
                // get next recipient to process
                $recipient_guid = $this->queue_table->getNextRecipientGUID($delivery_interval, $timestamp);
            }
            
            return $count;
        }));
    }
    
    protected function processRecipientNotifications(int $recipient_guid, array $notifications, string $delivery_interval): bool {
        $recipient = get_entity($recipient_guid);
        if (!$recipient instanceof \ElggEntity || !isset($recipient->email)) {
            return false;
        }
        
        $view_vars = [
            'recipient' => $recipient,
            'notifications' => $notifications,
            'delivery_interval' => $delivery_interval,
        ];
        
        $body = $this->views->renderView('email/delayed_email/plaintext', $view_vars);
        if (empty($body)) {
            return true;
        }
        
        $html_body = $this->views->renderView('email/delayed_email/html', $view_vars);
        
        $email = Email::factory([
            'to' => $recipient,
            'subject' => $this->translator->translate("notifications:delayed_email:subject:{$delivery_interval}", [], (string) $recipient->language),
            'body' => $body,
            'params' => [
                'html_body' => $html_body,
            ],
        ]);
        
        return $this->email->send($email);
    }
}