Merge pull request #23 from BBrunekreeft/master

Store complete Swift_Message object in mail_queue database

Author: nterms

MailQueue.php

@@ -1,4 +1,4 @@
-<?php 
+<?php
 
 /**
  * MailQueue.php
@@ -13,11 +13,11 @@
 use nterms\mailqueue\models\Queue;
 
 /**
- * MailQueue is a sub class of [yii\switmailer\Mailer](https://github.com/yiisoft/yii2-swiftmailer/blob/master/Mailer.php) 
+ * MailQueue is a sub class of [yii\switmailer\Mailer](https://github.com/yiisoft/yii2-swiftmailer/blob/master/Mailer.php)
  * which intends to replace it.
- * 
+ *
  * Configuration is the same as in `yii\switmailer\Mailer` with some additional properties to control the mail queue
- * 
+ *
  * ~~~
  * 	'components' => [
  * 		...
@@ -38,49 +38,49 @@
  * 		...
  * 	],
  * ~~~
- * 
+ *
  * @see http://www.yiiframework.com/doc-2.0/yii-swiftmailer-mailer.html
  * @see http://www.yiiframework.com/doc-2.0/ext-swiftmailer-index.html
- * 
- * This extension replaces `yii\switmailer\Message` with `nterms\mailqueue\Message' 
+ *
+ * This extension replaces `yii\switmailer\Message` with `nterms\mailqueue\Message'
  * to enable queuing right from the message.
- * 
+ *
  */
 class MailQueue extends Mailer
 {
 	const NAME = 'mailqueue';
-	
+
 	/**
 	 * @var string message default class name.
 	 */
 	public $messageClass = 'nterms\mailqueue\Message';
-	
+
 	/**
 	 * @var string the name of the database table to store the mail queue.
 	 */
 	public $table = '{{%mail_queue}}';
-	
+
 	/**
 	 * @var integer the default value for the number of mails to be sent out per processing round.
 	 */
 	public $mailsPerRound = 10;
-	
+
 	/**
 	 * @var integer maximum number of attempts to try sending an email out.
 	 */
 	public $maxAttempts = 3;
-	
+
 	/**
 	 * Initializes the MailQueue component.
 	 */
 	public function init()
 	{
 		parent::init();
 	}
-	
+
 	/**
 	 * Sends out the messages in email queue and update the database.
-	 * 
+	 *
 	 * @return boolean true if all messages are successfully sent out
 	 */
 	public function process()
@@ -90,33 +90,26 @@ public function process()
 		}
 
 		$success = true;
-		
-		$items = Queue::find()->where(['and', ['sent_time' => NULL], ['!=', 'to', 'a:0:{}'], ['<', 'attempts', $this->maxAttempts], ['<=', 'time_to_send', date('Y-m-d H:i:s')]])->orderBy(['created_at' => SORT_ASC])->limit($this->mailsPerRound)->all();
-		// dd($items);
-		if (!empty($items)) {
-			$n = count($items);
-			$pad = strlen($this->mailsPerRound);
-			foreach ($items as $i => $item) {
-				$j = str_pad($i + 1, $pad, ' ', STR_PAD_LEFT);
-				if ($message = $item->toMessage()) {
-					$attributes = ['attempts', 'last_attempt_time'];
-					$to = array_keys($message->to);
-					$to = $to[0];
-					if ($message->send($this)) {
-						$item->sent_time = new \yii\db\Expression('NOW()');
-						$attributes[] = 'sent_time';
-					} else {
-						$success = false;
-					}
-					
-					$item->attempts++;
-					$item->last_attempt_time = new \yii\db\Expression('NOW()');
-					
-					$item->updateAttributes($attributes);
-				}
+
+		$items = Queue::find()->where(['and', ['sent_time' => NULL], ['!=', 'to', 'a:0:{}'], ['<', 'attempts', $this->maxAttempts], ['<=', 'time_to_send', date('Y-m-d H:i:s')]])->orderBy(['created_at' => SORT_ASC])->limit($this->mailsPerRound);
+		foreach ($items->each() as $item) {
+		    if ($message = $item->toMessage()) {
+			$attributes = ['attempts', 'last_attempt_time'];
+			if ($this->send($message)) {
+			    $item->sent_time = new \yii\db\Expression('NOW()');
+			    $attributes[] = 'sent_time';
+			} else {
+			    $success = false;
 			}
-		} 
-		
+
+			$item->attempts++;
+			$item->last_attempt_time = new \yii\db\Expression('NOW()');
+
+			$item->updateAttributes($attributes);
+		    }
+		}
+
+
 		return $success;
 	}
 }

Message.php

@@ -39,6 +39,7 @@ public function queue($time_to_send = 'now')
         $item->charset = $this->getCharset();
         $item->subject = $this->getSubject();
         $item->attempts = 0;
+        $item->swift_message = serialize($this);
         $item->time_to_send = date('Y-m-d H:i:s', $time_to_send);
 
         $parts = $this->getSwiftMessage()->getChildren();

migrations/m161111_080914_add_swift_message_column_to_mail_queue_table.php

@@ -0,0 +1,25 @@
+<?php
+
+use yii\db\Migration;
+
+/**
+ * Handles adding swift_message to table `mail_queue`.
+ */
+class m161111_080914_add_swift_message_column_to_mail_queue_table extends Migration
+{
+    /**
+     * @inheritdoc
+     */
+    public function up()
+    {
+        $this->addColumn(Yii::$app->get(MailQueue::NAME)->table, 'swift_message', $this->longtext());
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function down()
+    {
+        $this->dropColumn(Yii::$app->get(MailQueue::NAME)->table, 'swift_message');
+    }
+}

models/Queue.php

@@ -24,6 +24,7 @@
  * @property integer $last_attempt_time
  * @property integer $sent_time
  * @property string $time_to_send
+ * @property string swift_message
  */
 class Queue extends ActiveRecord
 {
@@ -59,53 +60,13 @@ public function rules()
     {
         return [
             [['created_at', 'attempts', 'last_attempt_time', 'sent_time'], 'integer'],
-            [['time_to_send'], 'required'],
+            [['time_to_send', 'swift_message'], 'required'],
             [['to', 'cc', 'bcc', 'subject', 'html_body', 'text_body', 'charset'], 'safe'],
         ];
     }
-	
+
 	public function toMessage()
 	{
-		$from = unserialize($this->from);
-		$to = unserialize($this->to);
-		
-		if( !empty($from) && !empty($to) ) {
-			$cc = unserialize($this->cc);
-			$bcc = unserialize($this->bcc);
-			$reply_to = unserialize($this->reply_to);
-			
-			$message = new Message();
-			$message->setFrom($from)->setTo($to);
-			
-			if(!empty($cc)) {
-				$message->setCc($cc);
-			}
-			
-			if(!empty($bcc)) {
-				$message->setBcc($bcc);
-			}
-			
-			if(!empty($reply_to)) {
-				$message->setReplyTo($reply_to);
-			}
-
-			if(!empty($this->charset)) {
-				$message->setCharset($this->charset);
-			}
-			
-			$message->setSubject($this->subject);
-			
-			if(!empty($this->html_body)) {
-				$message->setHtmlBody($this->html_body);
-			}
-			
-			if(!empty($this->text_body)) {
-				$message->setTextBody($this->text_body);
-			}
-			
-			return $message;
-		}
-		
-		return null;
+		return unserialize($this->swift_message);
 	}
 }