From 8314c99b56e66c2b86dd32432bcf5ed94a3ece02 Mon Sep 17 00:00:00 2001
From: Frederic Guillot <fred@kanboard.net>
Date: Mon, 23 May 2016 20:43:51 -0400
Subject: Added QueueManager to process background jobs

---
 app/Core/Base.php               |  1 +
 app/Core/Mail/Client.php        | 31 +++++++++++-------
 app/Core/Queue/JobHandler.php   | 50 +++++++++++++++++++++++++++++
 app/Core/Queue/QueueManager.php | 71 +++++++++++++++++++++++++++++++++++++++++
 4 files changed, 141 insertions(+), 12 deletions(-)
 create mode 100644 app/Core/Queue/JobHandler.php
 create mode 100644 app/Core/Queue/QueueManager.php

(limited to 'app/Core')

diff --git a/app/Core/Base.php b/app/Core/Base.php
index 39a8ccd6..e490484c 100644
--- a/app/Core/Base.php
+++ b/app/Core/Base.php
@@ -27,6 +27,7 @@ use Pimple\Container;
  * @property \Kanboard\Core\Http\Response                               $response
  * @property \Kanboard\Core\Http\Router                                 $router
  * @property \Kanboard\Core\Http\Route                                  $route
+ * @property \Kanboard\Core\Queue\QueueManager                          $queueManager
  * @property \Kanboard\Core\Mail\Client                                 $emailClient
  * @property \Kanboard\Core\ObjectStorage\ObjectStorageInterface        $objectStorage
  * @property \Kanboard\Core\Plugin\Hook                                 $hook
diff --git a/app/Core/Mail/Client.php b/app/Core/Mail/Client.php
index 641b6abe..44f4753a 100644
--- a/app/Core/Mail/Client.php
+++ b/app/Core/Mail/Client.php
@@ -2,6 +2,7 @@
 
 namespace Kanboard\Core\Mail;
 
+use Kanboard\Job\EmailJob;
 use Pimple\Container;
 use Kanboard\Core\Base;
 
@@ -46,23 +47,29 @@ class Client extends Base
     public function send($email, $name, $subject, $html)
     {
         if (! empty($email)) {
-            $this->logger->debug('Sending email to '.$email.' ('.MAIL_TRANSPORT.')');
-
-            $start_time = microtime(true);
-            $author = 'Kanboard';
+            $this->queueManager->push(EmailJob::getInstance($this->container)
+                ->withParams($email, $name, $subject, $html, $this->getAuthor())
+            );
+        }
 
-            if ($this->userSession->isLogged()) {
-                $author = e('%s via Kanboard', $this->helper->user->getFullname());
-            }
+        return $this;
+    }
 
-            $this->getTransport(MAIL_TRANSPORT)->sendEmail($email, $name, $subject, $html, $author);
+    /**
+     * Get email author
+     *
+     * @access public
+     * @return string
+     */
+    public function getAuthor()
+    {
+        $author = 'Kanboard';
 
-            if (DEBUG) {
-                $this->logger->debug('Email sent in '.round(microtime(true) - $start_time, 6).' seconds');
-            }
+        if ($this->userSession->isLogged()) {
+            $author = e('%s via Kanboard', $this->helper->user->getFullname());
         }
 
-        return $this;
+        return $author;
     }
 
     /**
diff --git a/app/Core/Queue/JobHandler.php b/app/Core/Queue/JobHandler.php
new file mode 100644
index 00000000..a2c4a2c7
--- /dev/null
+++ b/app/Core/Queue/JobHandler.php
@@ -0,0 +1,50 @@
+<?php
+
+namespace Kanboard\Core\Queue;
+
+use Kanboard\Core\Base;
+use Kanboard\Job\BaseJob;
+use SimpleQueue\Job;
+
+/**
+ * Class JobHandler
+ *
+ * @package Kanboard\Core\Queue
+ * @author  Frederic Guillot
+ */
+class JobHandler extends Base
+{
+    /**
+     * Serialize a job
+     *
+     * @access public
+     * @param  BaseJob $job
+     * @return Job
+     */
+    public function serializeJob(BaseJob $job)
+    {
+        return new Job(array(
+            'class' => get_class($job),
+            'params' => $job->getJobParams(),
+        ));
+    }
+
+    /**
+     * Execute a job
+     *
+     * @access public
+     * @param Job $job
+     */
+    public function executeJob(Job $job)
+    {
+        $payload = $job->getBody();
+        $className = $payload['class'];
+
+        if (DEBUG) {
+            $this->logger->debug(__METHOD__.' Received job => '.$className);
+        }
+
+        $worker = new $className($this->container);
+        call_user_func_array(array($worker, 'execute'), $payload['params']);
+    }
+}
diff --git a/app/Core/Queue/QueueManager.php b/app/Core/Queue/QueueManager.php
new file mode 100644
index 00000000..f34cb220
--- /dev/null
+++ b/app/Core/Queue/QueueManager.php
@@ -0,0 +1,71 @@
+<?php
+
+namespace Kanboard\Core\Queue;
+
+use Kanboard\Core\Base;
+use Kanboard\Job\BaseJob;
+use LogicException;
+use SimpleQueue\Queue;
+
+/**
+ * Class QueueManager
+ *
+ * @package Kanboard\Core\Queue
+ * @author  Frederic Guillot
+ */
+class QueueManager extends Base
+{
+    /**
+     * @var Queue
+     */
+    protected $queue = null;
+
+    /**
+     * Set queue driver
+     *
+     * @access public
+     * @param  Queue $queue
+     * @return $this
+     */
+    public function setQueue(Queue $queue)
+    {
+        $this->queue = $queue;
+        return $this;
+    }
+
+    /**
+     * Send a new job to the queue
+     *
+     * @access public
+     * @param  BaseJob $job
+     * @return $this
+     */
+    public function push(BaseJob $job)
+    {
+        if ($this->queue !== null) {
+            $this->queue->push(JobHandler::getInstance($this->container)->serializeJob($job));
+        } else {
+            call_user_func_array(array($job, 'execute'), $job->getJobParams());
+        }
+
+        return $this;
+    }
+
+    /**
+     * Wait for new jobs
+     *
+     * @access public
+     * @throws LogicException
+     */
+    public function listen()
+    {
+        if ($this->queue === null) {
+            throw new LogicException('No Queue Driver defined!');
+        }
+
+        while ($job = $this->queue->pull()) {
+            JobHandler::getInstance($this->container)->executeJob($job);
+            $this->queue->completed($job);
+        }
+    }
+}
-- 
cgit v1.2.3