- Updates cron/mailer/scheduler code to work with the new sending queue

task scheduler and mailer log

lib/Config/TaskScheduler.php

@@ -5,6 +5,7 @@ use MailPoet\Cron\CronHelper;
 use MailPoet\Cron\Supervisor;
 use MailPoet\Cron\Workers\Scheduler as SchedulerWorker;
 use MailPoet\Cron\Workers\SendingQueue\SendingQueue as SendingQueueWorker;
+use MailPoet\Mailer\MailerLog;
 use MailPoet\Models\Setting;
 
 if(!defined('ABSPATH')) exit;
@@ -45,14 +46,17 @@ class TaskScheduler {
   function configureWordpressScheduler() {
     $scheduled_queues = SchedulerWorker::getScheduledQueues();
     $running_queues = SendingQueueWorker::getRunningQueues();
-    // run cron only when there are scheduled queues ready to be processed
+    $sending_limit_reached = MailerLog::isSendingLimitReached();
-    // or are already being processed
+    // run cron only when:
-    if($scheduled_queues || $running_queues) {
+    //   1) there are scheduled queues ready to be processed
+    //   2) queues are already being processed
+    //   3) sending limit has not been reached
+    if(($scheduled_queues || $running_queues) && !$sending_limit_reached) {
       return $this->configureMailpoetScheduler();
     }
-    // stop (delete) daemon since the WP task scheduler is enabled
+    // in all other cases stop (delete) the daemon
     $cron_daemon = CronHelper::getDaemon();
-    if ($cron_daemon) {
+    if($cron_daemon) {
       CronHelper::deleteDaemon();
     }
     return;

lib/Cron/CronHelper.php

@@ -81,7 +81,7 @@ class CronHelper {
     throw new \Exception(__('Site URL is unreachable.'));
   }
 
-  static function checkExecutionTimer($timer) {
+  static function enforceExecutionLimit($timer) {
     $elapsed_time = microtime(true) - $timer;
     if($elapsed_time >= self::DAEMON_EXECUTION_LIMIT) {
       throw new \Exception(__('Maximum execution time has been reached.'));

lib/Cron/Workers/Scheduler.php

@@ -20,7 +20,8 @@ class Scheduler {
 
   function __construct($timer = false) {
     $this->timer = ($timer) ? $timer : microtime(true);
-    CronHelper::checkExecutionTimer($this->timer);
+    // abort if execution limit is reached
+    CronHelper::enforceExecutionLimit($this->timer);
   }
 
   function process() {
@@ -38,7 +39,7 @@ class Scheduler {
       } elseif($newsletter->type === 'standard') {
         $this->processScheduledStandardNewsletter($newsletter, $queue);
       }
-      CronHelper::checkExecutionTimer($this->timer);
+      CronHelper::enforceExecutionLimit($this->timer);
     }
   }
 

lib/Cron/Workers/SendingQueue/SendingQueue.php

@@ -5,7 +5,7 @@ use MailPoet\Cron\CronHelper;
 use MailPoet\Cron\Workers\SendingQueue\Tasks\Mailer as MailerTask;
 use MailPoet\Cron\Workers\SendingQueue\Tasks\Newsletter as NewsletterTask;
 use MailPoet\Cron\Workers\SendingQueue\Tasks\Subscribers as SubscribersTask;
-use MailPoet\Models\Newsletter as NewsletterModel;
+use MailPoet\Cron\Workers\SendingQueue\Tasks\TaskScheduler as TaskSchedulerTask;
 use MailPoet\Models\SendingQueue as SendingQueueModel;
 use MailPoet\Models\StatisticsNewsletters as StatisticsNewslettersModel;
 use MailPoet\Models\Subscriber as SubscriberModel;
@@ -23,10 +23,12 @@ class SendingQueue {
     $this->mailer_task = new MailerTask();
     $this->newsletter_task = new NewsletterTask();
     $this->timer = ($timer) ? $timer : microtime(true);
+    // abort if sending and/or execution limit are reached
+    $this->mailer_task->enforceSendingLimit();
+    CronHelper::enforceExecutionLimit($this->timer);
   }
 
   function process() {
-    $this->mailer_task->checkSendingLimit();
     foreach(self::getRunningQueues() as $queue) {
       // get and pre-process newsletter (render, replace shortcodes/links, etc.)
       $newsletter = $this->newsletter_task->getAndPreProcess($queue->asArray());
@@ -67,8 +69,14 @@ class SendingQueue {
           $newsletter,
           $found_subscribers
         );
+        if($queue->status === SendingQueueModel::STATUS_COMPLETED) {
+          $this->newsletter_task->markNewsletterAsSent($queue->newsletter_id);
+        }
+        // abort if execution limit is reached
+        CronHelper::enforceExecutionLimit($this->timer);
       }
     }
+    TaskSchedulerTask::complete();
   }
 
   function processQueue($queue, $newsletter, $subscribers) {
@@ -141,6 +149,7 @@ class SendingQueue {
         $prepared_subscribers_ids,
         $queue->subscribers
       );
+      $queue = $this->updateQueue($queue);
     } else {
       // update processed/to process list
       $queue->subscribers = SubscribersTask::updateProcessedList(
@@ -152,22 +161,14 @@ class SendingQueue {
       // keep track of sent items
       $this->mailer_task->updateMailerLog();
       $subscribers_to_process_count = count($queue->subscribers['to_process']);
+      $queue = $this->updateQueue($queue);
+      // check sending limit if there are still subscribers left to send
+      if(isset($subscribers_to_process_count)) {
+        $this->mailer_task->enforceSendingLimit();
+      }
     }
-    $queue = $this->updateQueue($queue);
-    if($subscribers_to_process_count) {
-      $this->mailer_task->checkSendingLimit();
-    }
-    CronHelper::checkExecutionTimer($this->timer);
     return $queue;
   }
-
-  function getQueues() {
-    return SendingQueueModel::orderByDesc('priority')
-      ->whereNull('deleted_at')
-      ->whereNull('status')
-      ->findMany();
-  }
-
   static function getRunningQueues() {
     return SendingQueueModel::orderByDesc('priority')
       ->whereNull('deleted_at')
@@ -185,13 +186,6 @@ class SendingQueue {
     if(!$queue->count_to_process) {
       $queue->processed_at = current_time('mysql');
       $queue->status = SendingQueueModel::STATUS_COMPLETED;
-      // if it's a standard or post notificaiton newsletter, update its status to sent
-      $newsletter = NewsletterModel::findOne($queue->newsletter_id);
-      if($newsletter->type === NewsletterModel::TYPE_STANDARD ||
-         $newsletter->type === NewsletterModel::TYPE_NOTIFICATION_HISTORY
-      ) {
-        $newsletter->setStatus(NewsletterModel::STATUS_SENT);
-      }
     }
     return $queue->save();
   }

lib/Cron/Workers/SendingQueue/Tasks/Mailer.php

@@ -2,19 +2,17 @@
 namespace MailPoet\Cron\Workers\SendingQueue\Tasks;
 
 use MailPoet\Mailer\Mailer as MailerFactory;
-use MailPoet\Models\Setting;
+use MailPoet\Mailer\MailerLog;
 
 if(!defined('ABSPATH')) exit;
 
 class Mailer {
-  public $mta_config;
-  public $mta_log;
   public $mailer;
+  public $mailer_log;
 
   function __construct() {
-    $this->mta_config = $this->getMailerConfig();
-    $this->mta_log = $this->getMailerLog();
     $this->mailer = $this->configureMailer();
+    $this->mailer_log = $this->getMailerLog();
   }
 
   function configureMailer(array $newsletter = null) {
@@ -40,33 +38,17 @@ class Mailer {
     return $this->mailer;
   }
 
-  function getMailerConfig() {
-    $mta_config = Setting::getValue('mta');
-    if(!$mta_config) {
-      throw new \Exception(__('Mailer is not configured'));
-    }
-    return $mta_config;
-  }
-
   function getMailerLog() {
-    $mta_log = Setting::getValue('mta_log');
+    return MailerLog::getMailerLog();
-    if(!$mta_log) {
-      $mta_log = array(
-        'sent' => 0,
-        'started' => time()
-      );
-      Setting::setValue('mta_log', $mta_log);
-    }
-    return $mta_log;
   }
 
   function updateMailerLog() {
-    $this->mta_log['sent']++;
+    $this->mailer_log['sent']++;
-    Setting::setValue('mta_log', $this->mta_log);
+    return MailerLog::updateMailerLog($this->mailer_log);
   }
 
   function getProcessingMethod() {
-    return ($this->mta_config['method'] === 'MailPoet') ?
+    return ($this->mailer->mailer['method'] === MailerFactory::METHOD_MAILPOET) ?
       'bulk' :
       'individual';
   }
@@ -82,22 +64,9 @@ class Mailer {
     );
   }
 
-  function checkSendingLimit() {
+  function enforceSendingLimit() {
-    if($this->mta_config['method'] === 'MailPoet') return;
+    if(MailerLog::isSendingLimitReached()) {
-    $frequency_interval = (int)$this->mta_config['frequency']['interval'] * 60;
-    $frequency_limit = (int)$this->mta_config['frequency']['emails'];
-    $elapsed_time = time() - (int)$this->mta_log['started'];
-    if($this->mta_log['sent'] === $frequency_limit &&
-      $elapsed_time <= $frequency_interval
-    ) {
       throw new \Exception(__('Sending frequency limit has been reached'));
     }
-    if($elapsed_time > $frequency_interval) {
-      $this->mta_log = array(
-        'sent' => 0,
-        'started' => time()
-      );
-      Setting::setValue('mta_log', $this->mta_log);
-    }
   }
-}
+}

lib/Cron/Workers/SendingQueue/Tasks/Newsletter.php

@@ -104,8 +104,8 @@ class Newsletter {
     );
   }
 
-  function markNewsletterAsSent($queue_id) {
+  function markNewsletterAsSent($newsletter_id) {
-    $newsletter = NewsletterModel::findOne($queue_id);
+    $newsletter = NewsletterModel::findOne($newsletter_id);
     // if it's a standard newsletter, update its status
     if($newsletter->type === NewsletterModel::TYPE_STANDARD) {
       $newsletter->setStatus(NewsletterModel::STATUS_SENT);

lib/Mailer/Mailer.php

@@ -12,9 +12,18 @@ class Mailer {
   public $sender;
   public $reply_to;
   public $mailer_instance;
+  const MAILER_CONFIG = 'mta';
+  const SENDING_LIMIT_INTERVAL_MULTIPLIER = 60;
+  const METHOD_MAILPOET = 'MailPoet';
+  const METHOD_MAILGUN = 'MailGun';
+  const METHOD_ELASTICEMAIL = 'ElasticEmail';
+  const METHOD_AMAZONSES = 'AmazonSES';
+  const METHOD_SENDGRID = 'SendGrid';
+  const METHOD_PHPMAIL = 'PHPMail';
+  const METHOD_SMTP = 'SMTP';
 
   function __construct($mailer = false, $sender = false, $reply_to = false) {
-    $this->mailer = $this->getMailer($mailer);
+    $this->mailer = self::getMailer($mailer);
     $this->sender = $this->getSender($sender);
     $this->reply_to = $this->getReplyTo($reply_to);
     $this->mailer_instance = $this->buildMailer();
@@ -27,7 +36,7 @@ class Mailer {
 
   function buildMailer() {
     switch($this->mailer['method']) {
-      case 'AmazonSES':
+      case self::METHOD_AMAZONSES:
         $mailer_instance = new $this->mailer['class'](
           $this->mailer['region'],
           $this->mailer['access_key'],
@@ -35,43 +44,43 @@ class Mailer {
           $this->sender,
           $this->reply_to
         );
-        break;
+      break;
-      case 'ElasticEmail':
+      case self::METHOD_ELASTICEMAIL:
         $mailer_instance = new $this->mailer['class'](
           $this->mailer['api_key'],
           $this->sender,
           $this->reply_to
         );
-        break;
+      break;
-      case 'MailGun':
+      case self::METHOD_MAILGUN:
         $mailer_instance = new $this->mailer['class'](
           $this->mailer['domain'],
           $this->mailer['api_key'],
           $this->sender,
           $this->reply_to
         );
-        break;
+      break;
-      case 'MailPoet':
+      case self::METHOD_MAILPOET:
         $mailer_instance = new $this->mailer['class'](
           $this->mailer['mailpoet_api_key'],
           $this->sender,
           $this->reply_to
         );
-        break;
+      break;
-      case 'SendGrid':
+      case self::METHOD_SENDGRID:
         $mailer_instance = new $this->mailer['class'](
           $this->mailer['api_key'],
           $this->sender,
           $this->reply_to
         );
-        break;
+      break;
-      case 'PHPMail':
+      case self::METHOD_PHPMAIL:
         $mailer_instance = new $this->mailer['class'](
           $this->sender,
           $this->reply_to
         );
-        break;
+      break;
-      case 'SMTP':
+      case self::METHOD_SMTP:
         $mailer_instance = new $this->mailer['class'](
           $this->mailer['host'],
           $this->mailer['port'],
@@ -82,19 +91,22 @@ class Mailer {
           $this->sender,
           $this->reply_to
         );
-        break;
+      break;
       default:
         throw new \Exception(__('Mailing method does not exist'));
     }
     return $mailer_instance;
   }
 
-  function getMailer($mailer = false) {
+  static function getMailer($mailer = false) {
     if(!$mailer) {
-      $mailer = Setting::getValue('mta');
+      $mailer = Setting::getValue(self::MAILER_CONFIG);
       if(!$mailer || !isset($mailer['method'])) throw new \Exception(__('Mailer is not configured'));
     }
     $mailer['class'] = 'MailPoet\\Mailer\\Methods\\' . $mailer['method'];
+    $mailer['frequency_interval'] =
+      (int)$mailer['frequency']['interval'] * self::SENDING_LIMIT_INTERVAL_MULTIPLIER;
+    $mailer['frequency_limit'] = (int)$mailer['frequency']['emails'];
     return $mailer;
   }
 
@@ -140,4 +152,4 @@ class Mailer {
     $subscriber = trim(preg_replace('!\s\s+!', ' ', $subscriber));
     return $subscriber;
   }
-}
+}