class SubscriptionController in Feeds 8.3

Returns responses for PuSH module routes.

Hierarchy

class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\feeds\Controller\SubscriptionController implements ContainerInjectionInterface

Expanded class hierarchy of SubscriptionController

1 file declares its use of SubscriptionController

SubscriptionControllerTest.php in tests/src/Unit/Controller/SubscriptionControllerTest.php

File

src/Controller/SubscriptionController.php, line 19

Namespace

Drupal\feeds\Controller

View source

class SubscriptionController extends ControllerBase implements ContainerInjectionInterface {

  /**
   * The key value expirable factory.
   *
   * @var \Drupal\Core\KeyValueStore\KeyValueExpirableFactoryInterface
   */
  protected $keyValueExpireFactory;

  /**
   * Constructs a SubscriptionController object.
   *
   * @param \Drupal\Core\KeyValueStore\KeyValueExpirableFactoryInterface $key_value_expire_factory
   *   The key value expirable factory.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   */
  public function __construct(KeyValueExpirableFactoryInterface $key_value_expire_factory, EntityTypeManagerInterface $entity_type_manager) {
    $this->keyValueExpireFactory = $key_value_expire_factory;
    $this->entityTypeManager = $entity_type_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('keyvalue.expirable'), $container
      ->get('entity_type.manager'));
  }

  /**
   * Handles subscribe/unsubscribe requests.
   *
   * @param int $feeds_subscription_id
   *   The subscription entity id.
   * @param string $feeds_push_token
   *   The subscription token.
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request object.
   *
   * @return Symfony\Component\HttpFoundation\Response
   *   The response object.
   *
   * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
   *   Thrown if the subscription was not found, or if the request is invalid.
   */
  public function subscribe($feeds_subscription_id, $feeds_push_token, Request $request) {

    // This is an invalid request.
    if ($request->query
      ->get('hub_challenge') === NULL || $request->query
      ->get('hub_topic') === NULL) {
      throw new NotFoundHttpException();
    }

    // A subscribe request.
    if ($request->query
      ->get('hub_mode') === 'subscribe') {
      return $this
        ->handleSubscribe((int) $feeds_subscription_id, $feeds_push_token, $request);
    }

    // An unsubscribe request.
    if ($request->query
      ->get('hub_mode') === 'unsubscribe') {
      return $this
        ->handleUnsubscribe((int) $feeds_subscription_id, $feeds_push_token, $request);
    }

    // Whatever.
    throw new NotFoundHttpException();
  }

  /**
   * Handles a subscribe request.
   *
   * @param int $subscription_id
   *   The subscription entity id.
   * @param string $token
   *   The subscription token.
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request object.
   *
   * @return \Symfony\Component\HttpFoundation\Response
   *   The response challenge.
   *
   * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
   *   Thrown if anything seems amiss.
   */
  protected function handleSubscribe($subscription_id, $token, Request $request) {
    if (!($subscription = $this
      ->entityTypeManager()
      ->getStorage('feeds_subscription')
      ->load($subscription_id))) {
      throw new NotFoundHttpException();
    }
    if ($subscription
      ->getToken() !== $token || $subscription
      ->getTopic() !== $request->query
      ->get('hub_topic')) {
      throw new NotFoundHttpException();
    }
    if ($subscription
      ->getState() !== 'subscribing' && $subscription
      ->getState() !== 'subscribed') {
      throw new NotFoundHttpException();
    }
    if ($lease_time = $request->query
      ->get('hub_lease_seconds')) {
      $subscription
        ->setLease($lease_time);
    }
    $subscription
      ->setState('subscribed');
    $subscription
      ->save();
    return new Response(Html::escape($request->query
      ->get('hub_challenge')), 200);
  }

  /**
   * Handles an unsubscribe request.
   *
   * @param int $subscription_id
   *   The subscription entity id.
   * @param string $token
   *   The subscription token.
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request object.
   *
   * @return \Symfony\Component\HttpFoundation\Response
   *   The response challenge.
   *
   * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
   *   Thrown if anything seems amiss.
   */
  protected function handleUnsubscribe($subscription_id, $token, Request $request) {

    // The subscription id already deleted, but waiting in the keyvalue store.
    $id = $token . ':' . $subscription_id;
    $subscription = $this->keyValueExpireFactory
      ->get('feeds_push_unsubscribe')
      ->get($id);
    if (!$subscription) {
      throw new NotFoundHttpException();
    }
    $this->keyValueExpireFactory
      ->get('feeds_push_unsubscribe')
      ->delete($id);
    return new Response(Html::escape($request->query
      ->get('hub_challenge')), 200);
  }

  /**
   * Receives a notification.
   *
   * @param \Drupal\feeds\SubscriptionInterface $feeds_subscription
   *   The subscription entity.
   * @param string $feeds_push_token
   *   The subscription token.
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request object.
   *
   * @return Symfony\Component\HttpFoundation\Response
   *   The response object.
   *
   * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
   *   Thrown if anything seems amiss.
   */
  public function receive(SubscriptionInterface $feeds_subscription, $feeds_push_token, Request $request) {
    if ($feeds_subscription
      ->getToken() !== $feeds_push_token) {
      throw new NotFoundHttpException();
    }

    // X-Hub-Signature is in the format sha1=signature.
    parse_str($request->headers
      ->get('X-Hub-Signature'), $result);
    if (empty($result['sha1']) || !$feeds_subscription
      ->checkSignature($result['sha1'], $request
      ->getContent())) {
      throw new NotFoundHttpException();
    }
    $feed = $this
      ->entityTypeManager()
      ->getStorage('feeds_feed')
      ->load($feeds_subscription
      ->id());
    try {
      $feed
        ->pushImport($request
        ->getContent());
    } catch (\Exception $e) {
      return new Response('', 500);
    }
    return new Response('', 200);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ControllerBase::$configFactory	protected	property	The configuration factory.
ControllerBase::$currentUser	protected	property	The current user service.	1
ControllerBase::$entityFormBuilder	protected	property	The entity form builder.
ControllerBase::$entityManager	protected	property	The entity manager.
ControllerBase::$entityTypeManager	protected	property	The entity type manager.
ControllerBase::$formBuilder	protected	property	The form builder.	2
ControllerBase::$keyValue	protected	property	The key-value storage.	1
ControllerBase::$languageManager	protected	property	The language manager.	1
ControllerBase::$moduleHandler	protected	property	The module handler.	2
ControllerBase::$stateService	protected	property	The state service.
ControllerBase::cache	protected	function	Returns the requested cache bin.
ControllerBase::config	protected	function	Retrieves a configuration object.
ControllerBase::container	private	function	Returns the service container.
ControllerBase::currentUser	protected	function	Returns the current user.	1
ControllerBase::entityFormBuilder	protected	function	Retrieves the entity form builder.
ControllerBase::entityManager Deprecated	protected	function	Retrieves the entity manager service.
ControllerBase::entityTypeManager	protected	function	Retrieves the entity type manager.
ControllerBase::formBuilder	protected	function	Returns the form builder service.	2
ControllerBase::keyValue	protected	function	Returns a key/value storage collection.	1
ControllerBase::languageManager	protected	function	Returns the language manager service.	1
ControllerBase::moduleHandler	protected	function	Returns the module handler.	2
ControllerBase::redirect	protected	function	Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state	protected	function	Returns the state storage service.
LinkGeneratorTrait::$linkGenerator	protected	property	The link generator.	1
LinkGeneratorTrait::getLinkGenerator Deprecated	protected	function	Returns the link generator.
LinkGeneratorTrait::l Deprecated	protected	function	Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated	public	function	Sets the link generator service.
LoggerChannelTrait::$loggerFactory	protected	property	The logger channel factory service.
LoggerChannelTrait::getLogger	protected	function	Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory	public	function	Injects the logger channel factory.
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
RedirectDestinationTrait::getDestinationArray	protected	function	Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination	protected	function	Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination	public	function	Sets the redirect destination service.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
SubscriptionController::$keyValueExpireFactory	protected	property	The key value expirable factory.
SubscriptionController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
SubscriptionController::handleSubscribe	protected	function	Handles a subscribe request.
SubscriptionController::handleUnsubscribe	protected	function	Handles an unsubscribe request.
SubscriptionController::receive	public	function	Receives a notification.
SubscriptionController::subscribe	public	function	Handles subscribe/unsubscribe requests.
SubscriptionController::__construct	public	function	Constructs a SubscriptionController object.
UrlGeneratorTrait::$urlGenerator	protected	property	The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated	protected	function	Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated	public	function	Sets the URL generator service.
UrlGeneratorTrait::url Deprecated	protected	function	Generates a URL or path for a specific route based on the given parameters.

You are here

class SubscriptionController in Feeds 8.3

Hierarchy

File

Namespace

Members

API Navigation