wip queue implementation

composer.json

@@ -31,10 +31,12 @@
         "illuminate/container": "5.1.*",
         "illuminate/contracts": "5.1.*",
         "illuminate/database": "^5.1.31",
+        "illuminate/encryption": "5.1.*",
         "illuminate/events": "5.1.*",
         "illuminate/filesystem": "5.1.*",
         "illuminate/hashing": "5.1.*",
         "illuminate/mail": "5.1.*",
+        "illuminate/queue": "5.1.*",
         "illuminate/support": "5.1.*",
         "illuminate/validation": "5.1.*",
         "illuminate/view": "5.1.*",

src/Core/CoreServiceProvider.php

@@ -41,6 +41,7 @@ public function register()
         $this->app->register('Flarum\Core\Notification\NotificationServiceProvider');
         $this->app->register('Flarum\Core\Search\SearchServiceProvider');
         $this->app->register('Flarum\Formatter\FormatterServiceProvider');
+        $this->app->register('Flarum\Core\Queue\QueueServiceProvider');
     }
 
     protected function registerAvatarsFilesystem()

src/Core/Jobs/MailJob.php

@@ -0,0 +1,56 @@
+<?php
+
+/*
+ * This file is part of Flarum.
+ *
+ * (c) Toby Zerner <toby.zerner@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Flarum\Core\Jobs;
+
+use Flarum\Core\Queue\AbstractJob;
+use Illuminate\Contracts\Mail\Mailer;
+use Illuminate\Mail\Message;
+
+class MailJob extends AbstractJob
+{
+    /**
+     * Body of the mail message.
+     *
+     * @var string
+     */
+    protected $body;
+
+    /**
+     * Receiver email address.
+     *
+     * @var string
+     */
+    protected $to;
+
+    /**
+     * Subject of the mail message.
+     *
+     * @var string
+     */
+    protected $subject;
+
+    public function __construct($subject, $body, $to)
+    {
+        $this->subject = $subject;
+        $this->body = $body;
+        $this->to = $to;
+    }
+
+    public function handle(Mailer $mailer)
+    {
+        $mailer->raw($this->body, function (Message $message) {
+            $message
+                ->to($this->to)
+                ->subject($this->subject);
+        });
+    }
+}

src/Core/Listener/EmailConfirmationMailer.php

@@ -11,20 +11,22 @@
 
 namespace Flarum\Core\Listener;
 
-use Flarum\Core;
 use Flarum\Core\EmailToken;
+use Flarum\Core\Jobs\MailJob;
+use Flarum\Core\Support\DispatchJobsTrait;
 use Flarum\Core\User;
 use Flarum\Event\UserEmailChangeWasRequested;
 use Flarum\Event\UserWasRegistered;
 use Flarum\Forum\UrlGenerator;
 use Flarum\Settings\SettingsRepositoryInterface;
+use Illuminate\Contracts\Bus\Dispatcher as JobDispatcher;
 use Illuminate\Contracts\Events\Dispatcher;
 use Illuminate\Contracts\Mail\Mailer;
-use Illuminate\Mail\Message;
 use Symfony\Component\Translation\TranslatorInterface;
 
 class EmailConfirmationMailer
 {
+    use DispatchJobsTrait;
     /**
      * @var SettingsRepositoryInterface
      */
@@ -50,13 +52,15 @@ class EmailConfirmationMailer
      * @param Mailer $mailer
      * @param UrlGenerator $url
      * @param TranslatorInterface $translator
+     * @param JobDispatcher $queue
      */
-    public function __construct(SettingsRepositoryInterface $settings, Mailer $mailer, UrlGenerator $url, TranslatorInterface $translator)
+    public function __construct(SettingsRepositoryInterface $settings, Mailer $mailer, UrlGenerator $url, TranslatorInterface $translator, JobDispatcher $queue)
     {
         $this->settings = $settings;
         $this->mailer = $mailer;
         $this->url = $url;
         $this->translator = $translator;
+        $this->queue = $queue;
     }
 
     /**
@@ -83,10 +87,11 @@ public function whenUserWasRegistered(UserWasRegistered $event)
 
         $body = $this->translator->trans('core.email.activate_account.body', $data);
 
-        $this->mailer->raw($body, function (Message $message) use ($user, $data) {
-            $message->to($user->email);
-            $message->subject('['.$data['{forum}'].'] '.$this->translator->trans('core.email.activate_account.subject'));
-        });
+        $this->dispatch(new MailJob(
+            '['.$data['{forum}'].'] '.$this->translator->trans('core.email.activate_account.subject'),
+            $body,
+            $user->email
+        ));
     }
 
     /**
@@ -99,10 +104,11 @@ public function whenUserEmailChangeWasRequested(UserEmailChangeWasRequested $eve
 
         $body = $this->translator->trans('core.email.confirm_email.body', $data);
 
-        $this->mailer->raw($body, function (Message $message) use ($email, $data) {
-            $message->to($email);
-            $message->subject('['.$data['{forum}'].'] '.$this->translator->trans('core.email.confirm_email.subject'));
-        });
+        $this->dispatch(new MailJob(
+            '['.$data['{forum}'].'] '.$this->translator->trans('core.email.confirm_email.subject'),
+            $body,
+            $email
+        ));
     }
 
     /**

src/Core/Queue/AbstractJob.php

@@ -0,0 +1,22 @@
+<?php
+
+/*
+ * This file is part of Flarum.
+ *
+ * (c) Toby Zerner <toby.zerner@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Flarum\Core\Queue;
+
+use Illuminate\Contracts\Bus\SelfHandling;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Queue\InteractsWithQueue;
+use Illuminate\Queue\SerializesModels;
+
+abstract class AbstractJob implements ShouldQueue, SelfHandling
+{
+    use InteractsWithQueue, SerializesModels;
+}

src/Core/Queue/QueueManager.php

@@ -0,0 +1,37 @@
+<?php
+
+/*
+ * This file is part of Flarum.
+ *
+ * (c) Toby Zerner <toby.zerner@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Flarum\Core\Queue;
+
+use Illuminate\Queue\QueueManager as Manager;
+
+class QueueManager extends Manager
+{
+    /**
+     * {@inheritdoc}
+     */
+    protected function getConfig($name)
+    {
+        if ($name === 'sync') {
+            return ['driver' => 'sync'];
+        }
+
+        return parent::getConfig($name);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getDefaultDriver()
+    {
+        return 'sync';
+    }
+}

src/Core/Queue/QueueServiceProvider.php

@@ -0,0 +1,78 @@
+<?php
+
+/*
+ * This file is part of Flarum.
+ *
+ * (c) Toby Zerner <toby.zerner@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Flarum\Core\Queue;
+
+use Illuminate\Bus\Dispatcher;
+use Illuminate\Contracts\Bus\Dispatcher as DispatcherContract;
+use Illuminate\Encryption\Encrypter;
+use Illuminate\Encryption\McryptEncrypter;
+use Illuminate\Queue\QueueServiceProvider as Provider;
+
+class QueueServiceProvider extends Provider
+{
+    /**
+     * {@inheritdoc}
+     */
+    protected function registerManager()
+    {
+        $this->registerEncrypter();
+        $this->registerQueue();
+        $this->registerDispatcher();
+    }
+
+    protected function registerEncrypter()
+    {
+        $this->app->singleton('encrypter', function ($app) {
+            $key = md5($app->url());
+
+            $cipher = 'AES-256-CBC';
+
+            if (Encrypter::supported($key, $cipher)) {
+                return new Encrypter($key, $cipher);
+            } elseif (McryptEncrypter::supported($key, $cipher)) {
+                return new McryptEncrypter($key, $cipher);
+            } else {
+                throw new RuntimeException('No supported encrypter found. The cipher and / or key length are invalid.');
+            }
+        });
+    }
+
+    protected function registerQueue()
+    {
+        $this->app->singleton('queue', function ($app) {
+            // Once we have an instance of the queue manager, we will register the various
+            // resolvers for the queue connectors. These connectors are responsible for
+            // creating the classes that accept queue configs and instantiate queues.
+            $manager = new QueueManager($app);
+
+            // We've disabled all other queue connectors for now. Once we're able to
+            // configure any of the other connectors, we can easily reset the old
+            // behavior of the parent provider by registering all connectors.
+            $this->registerSyncConnector($manager);
+
+            return $manager;
+        });
+
+        $this->app->singleton('queue.connection', function ($app) {
+            return $app['queue']->connection();
+        });
+    }
+
+    protected function registerDispatcher()
+    {
+        $this->app->singleton(DispatcherContract::class, function ($app) {
+            return new Dispatcher($app, function () use ($app) {
+                return $app['queue']->connection();
+            });
+        });
+    }
+}

src/Core/Support/DispatchJobsTrait.php

@@ -0,0 +1,32 @@
+<?php
+
+/*
+ * This file is part of Flarum.
+ *
+ * (c) Toby Zerner <toby.zerner@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Flarum\Core\Support;
+
+use Flarum\Core\Queue\AbstractJob;
+use Illuminate\Contracts\Bus\Dispatcher;
+
+trait DispatchJobsTrait
+{
+    /**
+     * @var Dispatcher
+     */
+    protected $queue;
+
+    /**
+     * @param AbstractJob $job
+     * @return mixed
+     */
+    public function dispatch(AbstractJob $job)
+    {
+        return $this->queue->dispatch($job);
+    }
+}