class FeedsYouTubeFetcherFeedForm in Feeds: YouTube Parser 8

Provides a form on the feed edit page for the FeedsYouTubeFetcher.

Hierarchy

class \Drupal\feeds\Plugin\Type\ExternalPluginFormBase implements PluginFormInterface, PluginAwareInterface uses DependencySerializationTrait, StringTranslationTrait
- class \Drupal\feeds_youtube\Feeds\Fetcher\Form\FeedsYouTubeFetcherFeedForm implements ContainerInjectionInterface

Expanded class hierarchy of FeedsYouTubeFetcherFeedForm

File

src/Feeds/Fetcher/Form/FeedsYouTubeFetcherFeedForm.php, line 21

Namespace

Drupal\feeds_youtube\Feeds\Fetcher\Form

View source

class FeedsYouTubeFetcherFeedForm extends ExternalPluginFormBase implements ContainerInjectionInterface {

  /**
   * The Feeds plugin.
   *
   * @var \Drupal\feeds\Plugin\Type\FeedsPluginInterface
   */
  protected $plugin;

  /**
   * The tempstore factory.
   *
   * @var \Drupal\Core\TempStore\PrivateTempStoreFactory
   */
  protected $privateTempStoreFactory;

  /**
   * Constructs a FeedsYouTubeFetcherFeedForm form object.
   *
   * @param \Drupal\Core\TempStore\PrivateTempStoreFactory $temp_store_factory
   *   The tempstore factory.
   */
  public function __construct(PrivateTempStoreFactory $temp_store_factory) {
    $this->privateTempStoreFactory = $temp_store_factory;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('tempstore.private'));
  }

  /**
   * {@inheritdoc}
   */
  public function setPlugin(FeedsPluginInterface $plugin) {
    $this->plugin = $plugin;
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state, FeedInterface $feed = NULL) {
    $form['source'] = [
      '#title' => $this
        ->t('Feed URL'),
      '#type' => 'url',
      '#default_value' => $feed
        ->getSource(),
      '#maxlength' => 2048,
      '#required' => TRUE,
    ];

    // Authenticate/revoke access to Google Account.
    $config = $this->plugin
      ->getConfiguration();
    if ($feed
      ->id() && !empty($config['google_oauth_client_id']) && !empty($config['google_oauth_client_secret']) && !empty($config['google_developer_key'])) {

      // Get existing token (if one exists) and check for code query parameter.
      $cid = $this->plugin
        ->getAccessTokenCacheId($feed
        ->id());
      $google_access_token = \Drupal::service('cache.feeds_youtube_tokens')
        ->get($cid);
      $code = \Drupal::request()->query
        ->get('code');
      $form['google_access_token'] = [
        '#type' => 'fieldset',
        '#title' => $this
          ->t('Google OAuth 2.0 Authentication'),
      ];
      if (!empty($code)) {
        $state = \Drupal::request()->query
          ->get('state');
        $tempstore_state = $this->privateTempStoreFactory
          ->get('feeds_youtube')
          ->get('state');
        if (strval($tempstore_state) !== strval($state)) {
          \Drupal::messenger()
            ->addError($this
            ->t('The session state did not match. Please try again.'));
        }
        else {
          $client = $this->plugin
            ->getClientFactory($feed
            ->id());
          $client
            ->authenticate($code);

          // Save access token.
          $cache_tags = [
            'feeds_youtube:google_access_token',
            $cid,
          ];
          \Drupal::service('cache.feeds_youtube_tokens')
            ->set($cid, $client
            ->getAccessToken(), CacheBackendInterface::CACHE_PERMANENT, $cache_tags);

          // Clean up and let the user know they successfully authenticated.
          $this->privateTempStoreFactory
            ->get('feeds_youtube')
            ->delete('state');
          \Drupal::messenger()
            ->addStatus($this
            ->t('You have successfully authenticated your website to use the Google API.'));

          // Redirect back to the original page.
          $current_path = \Drupal::service('path.current')
            ->getPath();
          $response = new RedirectResponse($current_path, 302);
          $response
            ->send();
        }
      }
      elseif (empty($google_access_token->data)) {
        $current_path = \Drupal::service('path.current')
          ->getPath();
        $path_alias = \Drupal::service('path_alias.manager')
          ->getAliasByPath($current_path);
        $form['google_access_token']['info'] = [
          '#type' => 'markup',
          '#markup' => '<p><em>' . $this
            ->t('Before authenticating, you must add <a href=":link">this URL</a> as an authorized redirect URI to your Google OAuth 2.0 client ID.', [
            ':link' => Url::fromUserInput($path_alias, [
              'absolute' => TRUE,
            ])
              ->toString(),
          ]) . '</em></p>',
        ];
        $client = $this->plugin
          ->getClientFactory($feed
          ->id());
        $state = mt_rand();
        $client
          ->setState($state);
        $this->privateTempStoreFactory
          ->get('feeds_youtube')
          ->set('state', $state);

        // Create authentication link.
        $url = Url::fromUri($client
          ->createAuthUrl());
        $auth_link = Link::fromTextAndUrl($this
          ->t('Authenticate Google Account'), $url);
        $auth_link = $auth_link
          ->toRenderable();
        $auth_link['#attributes'] = [
          'class' => [
            'button',
            'button--primary',
          ],
        ];
        $form['google_access_token']['grant_access'] = [
          '#type' => 'markup',
          '#markup' => '<p>' . render($auth_link) . '</p>',
        ];
      }
      else {
        $form['google_access_token']['info'] = [
          '#type' => 'markup',
          '#markup' => '<p><em>' . $this
            ->t('Last authenticated: @date', [
            '@date' => \Drupal::service('date.formatter')
              ->format($google_access_token->data['created'], 'long'),
          ]) . '</em></p>',
        ];
        $form['google_access_token']['revoke_access'] = [
          '#type' => 'checkbox',
          '#title' => $this
            ->t('Revoke access to Google Account'),
          '#default_value' => FALSE,
        ];
      }
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state, FeedInterface $feed = NULL) {
    $source = $form_state
      ->getValue('source');
    try {
      $test = $this->plugin
        ->requestUrl($source);
    } catch (\Google_Service_Exception $e) {
      $form_state
        ->setError($form['source'], $this
        ->t('A service error occurred: %error', [
        '%error' => htmlspecialchars($e
          ->getMessage()),
      ]));
    } catch (\Google_Exception $e) {
      $form_state
        ->setError($form['source'], $this
        ->t('A client error occurred: %error', [
        '%error' => htmlspecialchars($e
          ->getMessage()),
      ]));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state, FeedInterface $feed = NULL) {
    if ($form_state
      ->getValue([
      'google_access_token',
      'revoke_access',
    ])) {

      // Revoke access token.
      $client = $this->plugin
        ->getClientFactory($feed
        ->id());
      $client
        ->revokeToken($client
        ->getAccessToken());

      // Clear cached token.
      Cache::invalidateTags([
        $this->plugin
          ->getAccessTokenCacheId($feed
          ->id()),
      ]);

      // Let user know the access token has been revoked.
      \Drupal::messenger()
        ->addStatus($this
        ->t('Google API access token revoked.'));
    }
    $feed
      ->setSource($form_state
      ->getValue('source'));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
FeedsYouTubeFetcherFeedForm::$plugin	protected	property	The Feeds plugin. Overrides ExternalPluginFormBase::$plugin
FeedsYouTubeFetcherFeedForm::$privateTempStoreFactory	protected	property	The tempstore factory.
FeedsYouTubeFetcherFeedForm::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm
FeedsYouTubeFetcherFeedForm::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create
FeedsYouTubeFetcherFeedForm::setPlugin	public	function	Sets the plugin for this object. Overrides ExternalPluginFormBase::setPlugin
FeedsYouTubeFetcherFeedForm::submitConfigurationForm	public	function	Form submission handler. Overrides ExternalPluginFormBase::submitConfigurationForm
FeedsYouTubeFetcherFeedForm::validateConfigurationForm	public	function	Form validation handler. Overrides ExternalPluginFormBase::validateConfigurationForm
FeedsYouTubeFetcherFeedForm::__construct	public	function	Constructs a FeedsYouTubeFetcherFeedForm form object.
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.

You are here

class FeedsYouTubeFetcherFeedForm in Feeds: YouTube Parser 8

Hierarchy

File

Namespace

Members

API Navigation