class LibraryPolicyBuilder in Content-Security-Policy 8

Service to build policy information for libraries.

Hierarchy

• class \Drupal\csp\LibraryPolicyBuilder

4 files declare their use of LibraryPolicyBuilder

CspSettingsForm.php in src/Form/CspSettingsForm.php

LibraryPolicyBuilderTest.php in tests/src/Unit/LibraryPolicyBuilderTest.php

ResponseCspSubscriber.php in src/EventSubscriber/ResponseCspSubscriber.php

ResponseCspSubscriberTest.php in tests/src/Unit/EventSubscriber/ResponseCspSubscriberTest.php

1 string reference to 'LibraryPolicyBuilder'

csp.services.yml in ./csp.services.yml

csp.services.yml

1 service uses LibraryPolicyBuilder

csp.library_policy_builder in ./csp.services.yml

Drupal\csp\LibraryPolicyBuilder

File

src/LibraryPolicyBuilder.php, line 16

Namespace

Drupal\csp

class LibraryPolicyBuilder {

  /**
   * The Library Discovery service.
   *
   * @var \Drupal\Core\Asset\LibraryDiscovery
   */
  protected $libraryDiscovery;

  /**
   * The cache bin.
   *
   * @var \Drupal\Core\Cache\CacheBackendInterface
   */
  protected $cache;

  /**
   * The module handler service.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * The Theme Handler service.
   *
   * @var \Drupal\Core\Extension\ThemeHandlerInterface
   */
  protected $themeHandler;

  /**
   * Static cache of library source information for each extension.
   *
   * This reduces lookup calls to the database when generating information for
   * an extension, or when retrieving data for multiple libraries in an
   * extension.
   *
   * @var array
   */
  protected $librarySourcesCache;

  /**
   * Constructs a new Library Parser.
   *
   * @param \Drupal\Core\Cache\CacheBackendInterface $cache
   *   The cache bin.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $moduleHandler
   *   The Module Handler service.
   * @param \Drupal\Core\Extension\ThemeHandlerInterface $themeHandler
   *   The Theme Handler service.
   * @param \Drupal\Core\Asset\LibraryDiscoveryInterface $libraryDiscovery
   *   The Library Discovery Collector service.
   */
  public function __construct(CacheBackendInterface $cache, ModuleHandlerInterface $moduleHandler, ThemeHandlerInterface $themeHandler, LibraryDiscoveryInterface $libraryDiscovery) {
    $this->cache = $cache;
    $this->moduleHandler = $moduleHandler;
    $this->themeHandler = $themeHandler;
    $this->libraryDiscovery = $libraryDiscovery;
  }

  /**
   * Retrieve all sources required for the active theme.
   *
   * @return array
   *   An array of sources keyed by type.
   */
  public function getSources() {
    $cid = implode(':', [
      'csp',
      'sources',
    ]);
    if ($cacheItem = $this->cache
      ->get($cid)) {
      return $cacheItem->data;
    }
    $extensions = array_merge([
      'core',
    ], array_keys($this->moduleHandler
      ->getModuleList()), array_keys($this->themeHandler
      ->listInfo()));
    $sources = [];
    foreach ($extensions as $extensionName) {
      $extensionSources = $this
        ->getExtensionSources($extensionName);
      $sources = NestedArray::mergeDeep($sources, $extensionSources);
    }
    foreach (array_keys($sources) as $type) {
      sort($sources[$type]);
      $sources[$type] = array_unique($sources[$type]);
    }
    $this->cache
      ->set($cid, $sources, Cache::PERMANENT, [
      'library_info',
      'config:core.extension',
    ]);
    return $sources;
  }

  /**
   * Get the required sources for an extension.
   *
   * @param string $extension
   *   The name of the extension that registered a library.
   *
   * @return array
   *   An array of sources keyed by type.
   */
  protected function getExtensionSources($extension) {
    $cid = implode(':', [
      'csp',
      'extension',
      $extension,
    ]);
    $cacheItem = $this->cache
      ->get($cid);
    if ($cacheItem) {
      return $cacheItem->data;
    }
    $sources = [];
    $moduleLibraries = $this->libraryDiscovery
      ->getLibrariesByExtension($extension);
    foreach ($moduleLibraries as $libraryName => $libraryInfo) {
      $librarySources = $this
        ->getLibrarySources($extension, $libraryName);
      $sources = NestedArray::mergeDeep($sources, $librarySources);
    }
    $this->cache
      ->set($cid, $sources, Cache::PERMANENT, [
      'library_info',
    ]);
    return $sources;
  }

  /**
   * Get the required sources for a single library.
   *
   * @param string $extension
   *   The name of the extension that registered a library.
   * @param string $name
   *   The name of a registered library to retrieve.
   *
   * @return array
   *   An array of sources keyed by type.
   */
  protected function getLibrarySources($extension, $name) {
    $cid = implode(':', [
      'csp',
      'libraries',
      $extension,
    ]);
    if (!isset($this->librarySourcesCache[$extension])) {
      $cacheItem = $this->cache
        ->get($cid);
      if ($cacheItem) {
        $this->librarySourcesCache[$extension] = $cacheItem->data;
      }
    }
    if (isset($this->librarySourcesCache[$extension][$name])) {
      return $this->librarySourcesCache[$extension][$name];
    }
    $libraryInfo = $this->libraryDiscovery
      ->getLibraryByName($extension, $name);
    $sources = [];
    foreach ($libraryInfo['js'] as $jsInfo) {
      if ($jsInfo['type'] == 'external') {
        $host = self::getHostFromUri($jsInfo['data']);
        $sources['script-src'][] = $host;
        $sources['script-src-elem'][] = $host;
      }
    }
    foreach ($libraryInfo['css'] as $cssInfo) {
      if ($cssInfo['type'] == 'external') {
        $host = self::getHostFromUri($cssInfo['data']);
        $sources['style-src'][] = $host;
        $sources['style-src-elem'][] = $host;
      }
    }
    $this->librarySourcesCache[$extension][$name] = $sources;
    $this->cache
      ->set($cid, $this->librarySourcesCache[$extension], Cache::PERMANENT, [
      'library_info',
    ]);
    return $this->librarySourcesCache[$extension][$name];
  }

  /**
   * Get host info from a URI.
   *
   * @param string $uri
   *   The URI.
   *
   * @return string
   *   The host info.
   */
  public static function getHostFromUri($uri) {
    $uri = new Uri($uri);
    $host = $uri
      ->getHost();

    // Only include scheme if restricted to HTTPS.
    if ($uri
      ->getScheme() === 'https') {
      $host = 'https://' . $host;
    }
    if ($port = $uri
      ->getPort()) {
      $host .= ':' . $port;
    }
    return $host;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
LibraryPolicyBuilder::$cache	protected	property	The cache bin.
LibraryPolicyBuilder::$libraryDiscovery	protected	property	The Library Discovery service.
LibraryPolicyBuilder::$librarySourcesCache	protected	property	Static cache of library source information for each extension.
LibraryPolicyBuilder::$moduleHandler	protected	property	The module handler service.
LibraryPolicyBuilder::$themeHandler	protected	property	The Theme Handler service.
LibraryPolicyBuilder::getExtensionSources	protected	function	Get the required sources for an extension.
LibraryPolicyBuilder::getHostFromUri	public static	function	Get host info from a URI.
LibraryPolicyBuilder::getLibrarySources	protected	function	Get the required sources for a single library.
LibraryPolicyBuilder::getSources	public	function	Retrieve all sources required for the active theme.
LibraryPolicyBuilder::__construct	public	function	Constructs a new Library Parser.