Process eventsubscriber

modules/sms_user/tests/src/Kernel/SmsFrameworkUserActiveHoursServiceTest.php

@@ -229,12 +229,13 @@ public function testDelaySmsMessage() {
     $user = $this->createUser();
     $sms_message = SmsMessage::create()
       ->setMessage($this->randomString())
+      ->addRecipients($this->randomPhoneNumbers())
       ->setDirection(Direction::OUTGOING)
       ->setRecipientEntity($user)
       ->setAutomated(TRUE);
-    $this->smsProvider->queue($sms_message);
+    $return = $this->smsProvider->queue($sms_message);
 
-    $this->assertEquals($timestamp, $sms_message->getSendTime());
+    $this->assertEquals($timestamp, $return[0]->getSendTime());
   }
 
   /**
@@ -249,6 +250,7 @@ public function testDelaySmsMessageNotAutomated() {
 
     $user = $this->createUser();
     $sms_message = SmsMessage::create()
+      ->addRecipients($this->randomPhoneNumbers(1))
       ->setMessage($this->randomString())
       ->setDirection(Direction::OUTGOING)
       ->setRecipientEntity($user)

sms.api.php

@@ -47,6 +47,95 @@ function hook_sms_incoming_postprocess(\Drupal\sms\Message\SmsMessageInterface $
  * @param \Symfony\Component\HttpFoundation\Response $response
  *   The HTTP response that will be sent back to the server.
  */
-function hook_sms_delivery_report(array $reports, Response $response) {
+function hook_sms_delivery_report(array $reports, \Symfony\Component\HttpFoundation\Response $response) {
   $response->setContent('OK');
 }
+
+/**
+ * Event subscribers for SMS Framework.
+ *
+ * Service definition:
+ * <code>
+ * ```yaml
+ *  my_module.my_event_subscriber:
+ *    class: Drupal\my_module\EventSubscriber\MySmsEventSubscriber
+ *    tags:
+ *     - { name: event_subscriber }
+ * ```
+ * </code>
+ *
+ * <code>
+ * <?php
+ * namespace Drupal\my_module\EventSubscriber;
+ * ?>
+ * </code>
+ */
+class MySmsEventSubscriber implements \Symfony\Component\EventDispatcher\EventSubscriberInterface {
+
+  /**
+   * Process and chunk a SMS message before it is queued, sent, or received.
+   *
+   * @param \Drupal\sms\Event\SmsMessageEvent $event
+   *   The SmsMessageEvent event.
+   */
+  public function mySmsMessagePreprocess(\Drupal\sms\Event\SmsMessageEvent $event) {
+    $result = [];
+    foreach ($event->getMessages() as $message) {
+      // Modify or chunk messages.
+      $result[] = $message;
+    }
+    $event->setMessages($result);
+  }
+
+  /**
+   * Process and chunk a SMS message after it is queued, sent, or received.
+   *
+   * @param \Drupal\sms\Event\SmsMessageEvent $event
+   *   The SmsMessageEvent event.
+   */
+  public function mySmsMessagePostProcess(\Drupal\sms\Event\SmsMessageEvent $event) {
+    $result = [];
+    foreach ($event->getMessages() as $message) {
+      // Modify or chunk messages.
+      $result[] = $message;
+    }
+    $event->setMessages($result);
+  }
+
+  /**
+   * Determines valid gateways for a recipient phone number.
+   *
+   * This event is not always dispatched. It is only dispatch if no other
+   * preprocessors have added a gateway to a message.
+   *
+   * If you don't know whether you should add a gateway for a recipient, then
+   * it is best to not do anything at all. Let the rest of the framework
+   * continue to try to find a gateway.
+   *
+   * Only one gateway will be applied to the message for this recipient. The
+   * gateway with the largest priority wins.
+   *
+   * @param \Drupal\sms\Event\RecipientGatewayEvent $event
+   *   The RecipientGatewayEvent event.
+   */
+  public function mySmsMessageGateway(\Drupal\sms\Event\RecipientGatewayEvent $event) {
+    // The recipient phone number.
+    $event->getRecipient();
+    // Add a gateway for a phone number.
+    $event->addGateway($a_gateway);
+    // Add a gateway with a priority.
+    $event->addGateway($a_gateway, 333);
+    $event->addGateway($a_gateway, -333);
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function getSubscribedEvents() {
+    $events['sms.message.preprocess'][] = ['mySmsMessagePreprocess'];
+    $events['sms.message.postprocess'][] = ['mySmsMessagePostprocess'];
+    $events['sms.message.gateway'][] = ['mySmsMessageGateway'];
+    return $events;
+  }
+
+}

sms.services.yml

@@ -3,7 +3,7 @@ services:
     alias: sms_provider.default
   sms_provider.default:
     class: Drupal\sms\Provider\DefaultSmsProvider
-    arguments: ['@config.factory', '@module_handler']
+    arguments: ['@event_dispatcher', '@config.factory', '@module_handler']
   plugin.manager.sms_gateway:
     class: Drupal\sms\Plugin\SmsGatewayPluginManager
     arguments: ['@container.namespaces', '@cache.discovery', '@module_handler']
@@ -13,3 +13,8 @@ services:
   sms.queue:
     class: Drupal\sms\Provider\SmsQueueProcessor
     arguments: ['@entity_type.manager', '@queue', '@sms_provider']
+  sms.sms_message_processor:
+    class: Drupal\sms\EventSubscriber\SmsMessageProcessor
+    arguments: ['@event_dispatcher', '@config.factory']
+    tags:
+      - { name: event_subscriber }

src/Event/RecipientGatewayEvent.php

@@ -0,0 +1,140 @@
+<?php
+
+namespace Drupal\sms\Event;
+
+use Symfony\Component\EventDispatcher\Event;
+use Drupal\sms\Entity\SmsGatewayInterface;
+
+/**
+ * Event fired to determine valid gateways for a recipient.
+ */
+class RecipientGatewayEvent extends Event {
+
+  /**
+   * The recipient phone number.
+   *
+   * @var string
+   */
+  protected $recipient;
+
+  /**
+   * An array of gateway doubles.
+   *
+   * @var array
+   *   The array of gateway/priority doubles where:
+   *     - Key 0: SmsGatewayInterface $gateway
+   *     - Key 1: integer $priority
+   */
+  protected $gateways = [];
+
+  /**
+   * Constructs the object.
+   *
+   * @param string $recipient
+   *   The recipient phone number.
+   */
+  public function __construct($recipient) {
+    $this->setRecipient($recipient);
+  }
+
+  /**
+   * Get the phone number for this event.
+   *
+   * @return string
+   *   The phone number for this event.
+   */
+  public function getRecipient() {
+    return $this->recipient;
+  }
+
+  /**
+   * Set the phone number for this event.
+   *
+   * @param string $recipient
+   *   The phone number for this event.
+   *
+   * @return $this
+   *   Return this event for chaining.
+   */
+  public function setRecipient($recipient) {
+    $this->recipient = $recipient;
+    return $this;
+  }
+
+  /**
+   * Get the gateways for this event.
+   *
+   * @return array
+   *   An array of doubles gateway/priority doubles.
+   */
+  public function getGateways() {
+    return $this->gateways;
+  }
+
+  /**
+   * Return gateways ordered by priority from highest to lowest.
+   *
+   * @return \Drupal\sms\Entity\SmsGatewayInterface[]
+   */
+  public function getGatewaysSorted() {
+    $gateways = $this->gateways;
+    uasort($gateways, function($a, $b) {
+      list(, $priority_a) = $a;
+      list(, $priority_b) = $b;
+      if ($priority_a == $priority_b) {
+        return 0;
+      }
+      return ($priority_a > $priority_b) ? -1 : 1;
+    });
+
+    $gateways = [];
+    foreach ($gateways as $tuple) {
+      list($gateway, ) = $tuple;
+      $gateways[] = $gateway;
+    }
+
+    return $gateways;
+  }
+
+  /**
+   * Add a gateway for the recipient on this event.
+   *
+   * @param \Drupal\sms\Entity\SmsGatewayInterface $gateway
+   *   The gateway for the recipient
+   * @param int $priority
+   *   The priority for this gateway.
+   *
+   * @return $this
+   *   Return this event for chaining.
+   */
+  public function addGateway(SmsGatewayInterface $gateway, $priority = 0) {
+    $this->gateways[] = [$gateway, $priority];
+    return $this;
+  }
+
+  /**
+   * Remove a gateway from this event.
+   *
+   * @param $gateway_id
+   *   A gateway plugin ID.
+   *
+   * @param integer|NULL $priority
+   *   The priority of the gateway to remove, or NULL to remove all gateways
+   *   with the identifier.
+   *
+   * @return $this
+   *   Return this event for chaining.
+   */
+  public function removeGateway($gateway_id, $priority = NULL) {
+    foreach ($this->gateways as $k => $tuple) {
+      list($gateway, $gateway_priority) = $tuple;
+      if ($gateway_id == $gateway->id()) {
+        if (!isset($priority) || ($priority == $gateway_priority)) {
+          unset($this->gateways[$k]);
+        }
+      }
+    }
+    return $this;
+  }
+
+}

src/Event/SmsMessageEvent.php

@@ -0,0 +1,54 @@
+<?php
+
+namespace Drupal\sms\Event;
+
+use Symfony\Component\EventDispatcher\Event;
+
+/**
+ * Event fired when a new SMS message is being processed before or after send or
+ * queue.
+ */
+class SmsMessageEvent extends Event {
+
+  /**
+   * The SMS messages.
+   *
+   * @var \Drupal\sms\Message\SmsMessageInterface[]
+   */
+  protected $messages;
+
+  /**
+   * Constructs the object.
+   *
+   * @param \Drupal\sms\Message\SmsMessageInterface[] $messages
+   *   The SMS message.
+   */
+  public function __construct(array $messages) {
+    $this->setMessages($messages);
+  }
+
+  /**
+   * Get all messages on this event.
+   *
+   * @return \Drupal\sms\Message\SmsMessageInterface[]
+   *   The messages on this event.
+   */
+  public function getMessages() {
+    return $this->messages;
+  }
+
+  /**
+   * Set the messages on this event.
+   *
+   * @param $messages
+   *   The messages to set on this event.
+   *
+   * @return $this
+   *   Returns this event for chaining.
+   */
+  public function setMessages($messages) {
+    $this->messages = $messages;
+    return $this;
+  }
+
+}