You are here

Home » API reference » Cookie Content Blocker 8 » HtmlResponseAttachmentsProcessor.php

class HtmlResponseAttachmentsProcessor in Cookie Content Blocker 8

Processes attachments of HTML responses.

Hierarchy

Expanded class hierarchy of HtmlResponseAttachmentsProcessor

See also

\Drupal\Core\Render\HtmlResponseAttachmentsProcessor

1 string reference to 'HtmlResponseAttachmentsProcessor'
cookie_content_blocker.services.yml in ./cookie_content_blocker.services.yml
cookie_content_blocker.services.yml
1 service uses HtmlResponseAttachmentsProcessor
html_response.attachments_processor.cookie_content_blocker in ./cookie_content_blocker.services.yml
Drupal\cookie_content_blocker\Render\HtmlResponseAttachmentsProcessor

File

src/Render/HtmlResponseAttachmentsProcessor.php, line 38

Namespace

Drupal\cookie_content_blocker\Render
View source 
class HtmlResponseAttachmentsProcessor extends CoreHtmlResponseAttachmentsProcessor {

  /**
   * The drupal settings.
   *
   * @var array
   */
  protected static $drupalSettings = [
    'type' => 'setting',
    'group' => JS_SETTING,
    'weight' => 0,
    'browsers' => [],
    'data' => [],
    'position' => 'scripts_bottom',
  ];

  /**
   * The allowed assets.
   *
   * @var \Drupal\Core\Asset\AttachedAssetsInterface
   */
  protected $allowedAssets;

  /**
   * The blocked assets.
   *
   * @var \Drupal\Core\Asset\AttachedAssetsInterface
   */
  protected $blockedAssets;

  /**
   * The library manager.
   *
   * @var \Drupal\cookie_content_blocker\BlockedLibraryManagerInterface
   */
  protected $libraryManager;

  /**
   * Constructs a HtmlResponseAttachmentsProcessor object.
   *
   * @param \Drupal\cookie_content_blocker\BlockedLibraryManagerInterface $library_manager
   *   The library manager for blocked libraries.
   * @param \Drupal\Core\Asset\AssetResolverInterface $asset_resolver
   *   An asset resolver.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   A config factory for retrieving required config objects.
   * @param \Drupal\Core\Asset\AssetCollectionRendererInterface $css_collection_renderer
   *   The CSS asset collection renderer.
   * @param \Drupal\Core\Asset\AssetCollectionRendererInterface $js_collection_renderer
   *   The JS asset collection renderer.
   * @param \Symfony\Component\HttpFoundation\RequestStack $request_stack
   *   The request stack.
   * @param \Drupal\Core\Render\RendererInterface $renderer
   *   The renderer.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler service.
   */
  public function __construct(BlockedLibraryManagerInterface $library_manager, AssetResolverInterface $asset_resolver, ConfigFactoryInterface $config_factory, AssetCollectionRendererInterface $css_collection_renderer, AssetCollectionRendererInterface $js_collection_renderer, RequestStack $request_stack, RendererInterface $renderer, ModuleHandlerInterface $module_handler) {
    parent::__construct($asset_resolver, $config_factory, $css_collection_renderer, $js_collection_renderer, $request_stack, $renderer, $module_handler);
    $this->libraryManager = $library_manager;
    $this->blockedAssets = $this->allowedAssets = new AttachedAssets();
  }

  /**
   * Merge additional settings into the drupal settings.
   *
   * @param array $settings
   *   The settings to merge.
   */
  protected function mergeSettings(array $settings) : void {
    self::$drupalSettings = NestedArray::mergeDeepArray([
      self::$drupalSettings,
      $settings,
    ], TRUE);
  }

  /**
   * {@inheritdoc}
   */
  protected function processAssetLibraries(AttachedAssetsInterface $assets, array $placeholders) : array {
    if (!$this->libraryManager
      ->hasBlockedLibraries()) {
      return parent::processAssetLibraries($assets, $placeholders);
    }
    $variables = [
      'styles' => [],
      'scripts' => [],
      'scripts_bottom' => [],
    ];
    $blocked_libraries = $this->libraryManager
      ->getBlockedLibraries();
    $allowed_libraries = array_filter($assets
      ->getLibraries(), function ($library) use ($blocked_libraries) {
      return !in_array($library, $blocked_libraries, TRUE);
    });
    $this->allowedAssets = $assets
      ->setLibraries($allowed_libraries);
    $this->blockedAssets = AttachedAssets::createFromRenderArray([
      '#attached' => [
        'library' => $blocked_libraries,
      ],
    ]);
    $this->blockedAssets
      ->setAlreadyLoadedLibraries($allowed_libraries);
    foreach (array_keys($variables) as $type) {
      $process_method = 'process' . Container::camelize($type);
      if (!isset($placeholders[$type]) || !is_callable([
        $this,
        $process_method,
      ])) {
        continue;
      }
      $variables[$type] = $this
        ->{$process_method}();
    }

    // After everything is processed we restore the drupal settings on its
    // original position, now containing our extra settings created by
    // placeholders as well.
    $settings = self::$drupalSettings;
    array_unshift($variables[$settings['position']], ...$this
      ->renderAssetCollection([
      $settings,
    ], $this->jsCollectionRenderer));
    return $variables;
  }

  /**
   * Generate a placeholder script referencing to the original asset.
   *
   * @param array $asset
   *   The asset to create a placeholder for.
   *
   * @return array
   *   The placeholder render array.
   */
  private function generateAssetPlaceholder(array $asset) : array {
    $id = Html::getUniqueId(Crypt::randomBytesBase64());
    $placeholder = [
      '#type' => 'html_tag',
      '#tag' => 'script',
      '#value' => '',
      '#attributes' => [
        'data-cookie-content-blocker-asset-id' => $id,
      ],
    ];
    $attached = [
      '#attached' => [
        'drupalSettings' => [
          'cookieContentBlocker' => [
            'blockedAssets' => [
              $id => (string) $this->renderer
                ->renderPlain($asset),
            ],
          ],
        ],
      ],
    ];

    // Merge attached settings back into the original assets.
    $placeholder_asset = AttachedAssets::createFromRenderArray($attached);
    $this->allowedAssets
      ->setSettings(NestedArray::mergeDeepArray([
      $placeholder_asset
        ->getSettings(),
      $this->allowedAssets
        ->getSettings(),
    ], TRUE));
    $this
      ->mergeSettings([
      'data' => $this->allowedAssets
        ->getSettings(),
    ]);
    return $placeholder;
  }

  /**
   * Collects the CSS assets.
   *
   * @return array
   *   The CSS asset collection.
   */
  private function getCssAssetCollection() : array {
    $optimize_css = !defined('MAINTENANCE_MODE') && $this->config
      ->get('css.preprocess');
    return $this
      ->getMergedAndSortedAssets(...$this
      ->resolveAssets([
      $this->assetResolver,
      'getCssAssets',
    ], $optimize_css));
  }

  /**
   * Collects the JS assets.
   *
   * @param string $region
   *   The region to retrieve assets for. Can either be 'header' or 'footer'.
   *
   * @return array
   *   The JS asset collection for the given region.
   */
  private function getJsAssetCollection(string $region) : array {
    static $header = NULL, $footer = NULL, $processed = FALSE;
    if ($processed) {
      return ${$region} ?? [];
    }
    $optimize_js = !defined('MAINTENANCE_MODE') && !Drupal::state()
      ->get('system.maintenance_mode') && $this->config
      ->get('js.preprocess');
    [
      [
        $allowed_js_assets_header,
        $allowed_js_assets_footer,
      ],
      [
        $allowed_js_assets_header_raw,
        $allowed_js_assets_footer_raw,
      ],
      [
        $blocked_js_assets_header,
        $blocked_js_assets_footer,
      ],
    ] = $this
      ->resolveAssets([
      $this->assetResolver,
      'getJsAssets',
    ], $optimize_js);

    // @codingStandardsIgnoreStart
    $header = $this
      ->getMergedAndSortedAssets($allowed_js_assets_header, $allowed_js_assets_header_raw, $blocked_js_assets_header);
    $footer = $this
      ->getMergedAndSortedAssets($allowed_js_assets_footer, $allowed_js_assets_footer_raw, $blocked_js_assets_footer);

    // We need to extract settings because we want to add extra settings
    // for generated placeholders, so we can identify them. Therefor we
    // render all the scripts first and attach the settings at the end, which
    // at that point will contain our placeholder settings.
    $settings = $header['drupalSettings'] ?? $footer['drupalSettings'] ?? [];
    $settings['position'] = array_key_exists('drupalSettings', $header) ? 'scripts' : 'scripts_bottom';
    $this
      ->mergeSettings($settings);
    unset($header['drupalSettings'], $footer['drupalSettings']);
    $processed = TRUE;
    return ${$region} ?? [];

    // @codingStandardsIgnoreEnd
  }

  /**
   * Merges and sorts allowed and blocked assets back together.
   *
   * Marks blocked assets to be able to identify them.
   *
   * @param array $allowed_assets
   *   The allowed assets.
   * @param array $allowed_assets_raw
   *   The raw allowed assets (un-optimized) used for comparison/diff.
   * @param array $blocked_assets
   *   The blocked assets.
   *
   * @return array
   *   The merged and sorted assets,
   */
  private function getMergedAndSortedAssets(array $allowed_assets, array $allowed_assets_raw, array $blocked_assets) : array {

    // Filter out assets that are allowed. This leaves us with only the
    // assets we want to block and (optional) additional dependent assets that
    // are not required by any other asset.
    $assets = array_merge($allowed_assets, $this
      ->markAssetsAsBlocked(array_diff_key($blocked_assets, $allowed_assets_raw)));
    uasort($assets, [
      AssetResolver::class,
      'sort',
    ]);
    return $assets;
  }

  /**
   * Mark all individual assets as blocked.
   *
   * Makes sure they are not preprocesses or cached.
   *
   * @param array $assets
   *   The assets to mark.
   *
   * @return array
   *   The marked assets.
   */
  private function markAssetsAsBlocked(array $assets) : array {
    return array_map(function ($asset) {
      $asset['preprocess'] = $asset['cache'] = FALSE;
      $asset['is_blocked'] = TRUE;
      return $asset;
    }, $assets);
  }

  /**
   * Processes css assets and creates output for the 'styles' variable.
   *
   * @noinspection PhpUnusedPrivateMethodInspection
   *
   * @return array
   *   The output for the 'styles' variable.
   */
  private function processStyles() : array {
    return $this
      ->renderAssetCollection($this
      ->getCssAssetCollection(), $this->cssCollectionRenderer);
  }

  /**
   * Processes js assets and creates output for the 'scripts' variable.
   *
   * @noinspection PhpUnusedPrivateMethodInspection
   *
   * @return array
   *   The output for the 'styles' variable.
   */
  private function processScripts() : array {
    return $this
      ->renderAssetCollection($this
      ->getJsAssetCollection('header'), $this->jsCollectionRenderer);
  }

  /**
   * Processes js assets and creates output for the 'scripts_bottom' variable.
   *
   * @noinspection PhpUnusedPrivateMethodInspection
   *
   * @return array
   *   The output for the 'styles' variable.
   */
  private function processScriptsBottom() : array {
    return $this
      ->renderAssetCollection($this
      ->getJsAssetCollection('footer'), $this->jsCollectionRenderer);
  }

  /**
   * Renders asset collections and inserts placeholders for blocked assets.
   *
   * @param array $collection
   *   The asset collection to render.
   * @param \Drupal\Core\Asset\AssetCollectionRendererInterface $renderer
   *   The renderer to use to render the collection.
   *
   * @return array
   *   The render array for the asset collection.
   */
  private function renderAssetCollection(array $collection, AssetCollectionRendererInterface $renderer) : array {
    $rendered = [
      [],
    ];
    foreach ($collection as $asset) {
      $rendered_asset = $renderer
        ->render([
        $asset,
      ]);
      $rendered[] = !empty($asset['is_blocked']) ? [
        $this
          ->generateAssetPlaceholder(...$rendered_asset),
      ] : $rendered_asset;
    }
    return array_merge(...$rendered);
  }

  /**
   * Resolves assets.
   *
   * @param callable $resolver
   *   The resolver to use to resolve the assets.
   * @param bool $optimize
   *   Whether to optimize the assets.
   *
   * @return array
   *   A keyed array containing:
   *    - (0) Array of (possibly) optimized allowed assets.
   *    - (1) Array of un-optimized/raw allowed assets.
   *    - (2) Array of un-optimized/raw blocked assets
   */
  private function resolveAssets(callable $resolver, bool $optimize) : array {
    if (!is_callable($resolver)) {
      return [];
    }
    return [
      $resolver($this->allowedAssets, $optimize),
      $resolver($this->allowedAssets, FALSE),
      $resolver($this->blockedAssets, FALSE),
    ];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
HtmlResponseAttachmentsProcessor::$allowedAssets protected property The allowed assets.
HtmlResponseAttachmentsProcessor::$assetResolver protected property The asset resolver service.
HtmlResponseAttachmentsProcessor::$blockedAssets protected property The blocked assets.
HtmlResponseAttachmentsProcessor::$config protected property A config object for the system performance configuration.
HtmlResponseAttachmentsProcessor::$cssCollectionRenderer protected property The CSS asset collection renderer service.
HtmlResponseAttachmentsProcessor::$drupalSettings protected static property The drupal settings.
HtmlResponseAttachmentsProcessor::$jsCollectionRenderer protected property The JS asset collection renderer service.
HtmlResponseAttachmentsProcessor::$libraryManager protected property The library manager.
HtmlResponseAttachmentsProcessor::$moduleHandler protected property The module handler service.
HtmlResponseAttachmentsProcessor::$renderer protected property The renderer.
HtmlResponseAttachmentsProcessor::$requestStack protected property The request stack.
HtmlResponseAttachmentsProcessor::formatHttpHeaderAttributes public static function Formats an attribute string for an HTTP header.
HtmlResponseAttachmentsProcessor::generateAssetPlaceholder private function Generate a placeholder script referencing to the original asset.
HtmlResponseAttachmentsProcessor::getCssAssetCollection private function Collects the CSS assets.
HtmlResponseAttachmentsProcessor::getJsAssetCollection private function Collects the JS assets.
HtmlResponseAttachmentsProcessor::getMergedAndSortedAssets private function Merges and sorts allowed and blocked assets back together.
HtmlResponseAttachmentsProcessor::markAssetsAsBlocked private function Mark all individual assets as blocked.
HtmlResponseAttachmentsProcessor::mergeSettings protected function Merge additional settings into the drupal settings.
HtmlResponseAttachmentsProcessor::processAssetLibraries protected function Processes asset libraries into render arrays. Overrides HtmlResponseAttachmentsProcessor::processAssetLibraries
HtmlResponseAttachmentsProcessor::processAttachments public function Processes the attachments of a response that has attachments. Overrides AttachmentsResponseProcessorInterface::processAttachments 1
HtmlResponseAttachmentsProcessor::processFeed protected function Transform a 'feed' attachment into an 'html_head_link' attachment.
HtmlResponseAttachmentsProcessor::processHtmlHead protected function Ensure proper key/data order and defaults for renderable head items.
HtmlResponseAttachmentsProcessor::processHtmlHeadLink protected function Transform a html_head_link array into html_head and http_header arrays.
HtmlResponseAttachmentsProcessor::processScripts private function Processes js assets and creates output for the 'scripts' variable.
HtmlResponseAttachmentsProcessor::processScriptsBottom private function Processes js assets and creates output for the 'scripts_bottom' variable.
HtmlResponseAttachmentsProcessor::processStyles private function Processes css assets and creates output for the 'styles' variable.
HtmlResponseAttachmentsProcessor::renderAssetCollection private function Renders asset collections and inserts placeholders for blocked assets.
HtmlResponseAttachmentsProcessor::renderHtmlResponseAttachmentPlaceholders protected function Renders HTML response attachment placeholders.
HtmlResponseAttachmentsProcessor::renderPlaceholders protected function Renders placeholders (#attached['placeholders']).
HtmlResponseAttachmentsProcessor::resolveAssets private function Resolves assets.
HtmlResponseAttachmentsProcessor::setHeaders protected function Sets headers on a response object.
HtmlResponseAttachmentsProcessor::__construct public function Constructs a HtmlResponseAttachmentsProcessor object. Overrides HtmlResponseAttachmentsProcessor::__construct