- Joins bulk and individual processing into one method

- Refactors code as per code review comments

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

@@ -7,7 +7,15 @@ use MailPoet\Models\Setting;
 if(!defined('ABSPATH')) exit;
 
 class Mailer {
-  static function configureMailer(array $newsletter) {
+  public $mta_config;
+  public $mta_log;
+
+  function __construct() {
+    $this->mta_config = $this->getMailerConfig();
+    $this->mta_log = $this->getMailerLog();
+  }
+
+  function configureMailer(array $newsletter) {
     $sender['address'] = (!empty($newsletter['sender_address'])) ?
       $newsletter['sender_address'] :
       false;
@@ -30,7 +38,7 @@ class Mailer {
     return $mailer;
   }
 
-  static function getMailerConfig() {
+  function getMailerConfig() {
     $mta_config = Setting::getValue('mta');
     if(!$mta_config) {
       throw new \Exception(__('Mailer is not configured.'));
@@ -38,13 +46,7 @@ class Mailer {
     return $mta_config;
   }
 
-  static function updateMailerLog($mta_log) {
-    $mta_log['sent']++;
-    Setting::setValue('mta_log', $mta_log);
-    return $mta_log;
-  }
-
-  static function getMailerLog() {
+  function getMailerLog() {
     $mta_log = Setting::getValue('mta_log');
     if(!$mta_log) {
       $mta_log = array(
@@ -56,40 +58,45 @@ class Mailer {
     return $mta_log;
   }
 
-  static function getProcessingMethod($mta_config) {
-    return ($mta_config['method'] === 'MailPoet') ?
-      'processBulkSubscribers' :
-      'processIndividualSubscriber';
+  function updateMailerLog() {
+    $this->mta_log['sent']++;
+    Setting::setValue('mta_log', $this->mta_log);
   }
 
-  static function prepareSubscriberForSending($mailer, $subscriber) {
+  function getProcessingMethod() {
+    return ($this->mta_config['method'] === 'MailPoet') ?
+      'bulk' :
+      'individual';
+  }
+
+  function prepareSubscriberForSending($mailer, $subscriber) {
     return ($mailer instanceof \MailPoet\Mailer\Mailer) ?
       $mailer->transformSubscriber($subscriber) :
       false;
   }
 
-  static function send($mailer, $newsletter, $subscriber) {
+  function send($mailer, $newsletter, $subscriber) {
     return ($mailer instanceof \MailPoet\Mailer\Mailer) ?
       $mailer->mailer_instance->send($newsletter, $subscriber) :
       false;
   }
 
-  static function checkSendingLimit($mta_config, $mta_log) {
-    $frequency_interval = (int) $mta_config['frequency']['interval'] * 60;
-    $frequency_limit = (int) $mta_config['frequency']['emails'];
-    $elapsed_time = time() - (int) $mta_log['started'];
-    if($mta_log['sent'] === $frequency_limit &&
+  function checkSendingLimit() {
+    if($this->mta_config['method'] === 'MailPoet') return;
+    $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) {
-      $mta_log = array(
+      $this->mta_log = array(
         'sent' => 0,
         'started' => time()
       );
-      Setting::setValue('mta_log', $mta_log);
+      Setting::setValue('mta_log', $this->mta_log);
     }
-    return;
   }
 }

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

@@ -14,13 +14,21 @@ use MailPoet\Util\Helpers;
 if(!defined('ABSPATH')) exit;
 
 class Newsletter {
-  static function get($newsletter_id) {
+  public $tracking_enabled;
+  public $tracking_image_inserted;
+
+  function __construct() {
+    $this->tracking_enabled = (boolean) Setting::getValue('tracking.enabled');
+    $this->tracking_image_inserted = false;
+  }
+
+  function get($newsletter_id) {
     $newsletter = NewsletterModel::findOne($newsletter_id);
     return ($newsletter) ? $newsletter->asArray() : false;
   }
 
-  static function getAndPreProcess(array $queue) {
-    $newsletter = self::get($queue['newsletter_id']);
+  function getAndPreProcess(array $queue) {
+    $newsletter = $this->get($queue['newsletter_id']);
     if(!$newsletter) {
       return false;
     }
@@ -31,16 +39,18 @@ class Newsletter {
       return $newsletter;
     }
     // if tracking is enabled, do additional processing
-    if((boolean) Setting::getValue('tracking.enabled')) {
-      // add tracking image
-      OpenTracking::addTrackingImage();
+    if($this->tracking_enabled) {
+      // hook once to the newsletter post-processing filter and add tracking image
+      if(!$this->tracking_image_inserted) {
+        $this->tracking_image_inserted = OpenTracking::addTrackingImage();
+      }
       // render newsletter
-      $newsletter = self::render($newsletter);
+      $newsletter = $this->render($newsletter);
       // hash and save all links
       $newsletter = LinksTask::process($newsletter, $queue);
     } else {
       // render newsletter
-      $newsletter = self::render($newsletter);
+      $newsletter = $this->render($newsletter);
     }
     // check if this is a post notification and if it contains posts
     $newsletter_contains_posts = strpos($newsletter['rendered_body']['html'], 'data-post-id');
@@ -52,13 +62,13 @@ class Newsletter {
     return $newsletter;
   }
 
-  static function render($newsletter) {
+  function render($newsletter) {
     $renderer = new Renderer($newsletter);
     $newsletter['rendered_body'] = $renderer->render();
     return $newsletter;
   }
 
-  static function prepareNewsletterForSending(
+  function prepareNewsletterForSending(
     array $newsletter, array $subscriber, array $queue
   ) {
     // shortcodes and links will be replaced in the subject, html and text body
@@ -76,7 +86,7 @@ class Newsletter {
       $subscriber,
       $queue
     );
-    if((boolean) Setting::getValue('tracking.enabled')) {
+    if($this->tracking_enabled) {
       $prepared_newsletter = NewsletterLinks::replaceSubscriberData(
         $newsletter['id'],
         $subscriber['id'],

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

@@ -1,28 +0,0 @@
-<?php
-namespace MailPoet\Cron\Workers\SendingQueue\Tasks;
-
-use MailPoet\Models\StatisticsNewsletters;
-use MailPoet\Util\Helpers;
-
-if(!defined('ABSPATH')) exit;
-
-class Statistics {
-  static function processAndLogBulkNewsletterStatistics(
-    array $processed_subscribers_ids, $newsletter_id, $queue_id
-  ) {
-    $newsletter_statistics = array();
-    foreach($processed_subscribers_ids as $subscriber_id) {
-      $newsletter_statistics[] = array(
-        $newsletter_id,
-        $subscriber_id,
-        $queue_id
-      );
-    }
-    $newsletter_statistics = Helpers::flattenArray($newsletter_statistics);
-    return self::logStatistics($newsletter_statistics);
-  }
-
-  static function logStatistics($newsletter_statistics) {
-    return StatisticsNewsletters::createMultiple($newsletter_statistics);
-  }
-}

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

@@ -4,8 +4,8 @@ namespace MailPoet\Cron\Workers\SendingQueue\Tasks;
 if(!defined('ABSPATH')) exit;
 
 class Subscribers {
-  static function get(array $queue) {
-    $subscribers = unserialize($queue['subscribers']);
+  static function get($subscribers) {
+    $subscribers = unserialize($subscribers);
     if(empty($subscribers['processed'])) {
       $subscribers['processed'] = array();
     }
@@ -41,8 +41,8 @@ class Subscribers {
       $failed_subscribers
     );
     $queue_subscribers['to_process'] = array_diff(
-      $failed_subscribers,
-      $queue_subscribers['to_process']
+      $queue_subscribers['to_process'],
+      $failed_subscribers
     );
     return $queue_subscribers;
   }
@@ -55,8 +55,8 @@ class Subscribers {
       $processed_subscribers
     );
     $queue_subscribers['to_process'] = array_diff(
-      $processed_subscribers,
-      $queue_subscribers['to_process']
+      $queue_subscribers['to_process'],
+      $processed_subscribers
     );
     return $queue_subscribers;
   }