Issue #3222632 by phenaproxima, imalabya, longwave, catch, larowlan: oEmbed... (913a9ebd) · Commits · project / drupal

core/modules/media/src/OEmbed/ProviderRepository.php

+14 −6

Original line number	Diff line number	Diff line
		@@ -5,7 +5,6 @@
		use Drupal\Component\Datetime\TimeInterface;
		use Drupal\Component\Serialization\Json;
		use Drupal\Core\Cache\CacheBackendInterface;
		use Drupal\Core\Cache\UseCacheBackendTrait;
		use Drupal\Core\Config\ConfigFactoryInterface;
		use GuzzleHttp\ClientInterface;
		use GuzzleHttp\Exception\TransferException;
		@@ -15,8 +14,6 @@
		*/
		class ProviderRepository implements ProviderRepositoryInterface {

		use UseCacheBackendTrait;

		/**
		* How long the provider data should be cached, in seconds.
		*
		@@ -45,6 +42,13 @@ class ProviderRepository implements ProviderRepositoryInterface {
		*/
		protected $time;

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

		/**
		* Constructs a ProviderRepository instance.
		*
		@@ -55,7 +59,7 @@ class ProviderRepository implements ProviderRepositoryInterface {
		* @param \Drupal\Component\Datetime\TimeInterface $time
		* The time service.
		* @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
		* (optional) The cache backend.
		* The cache backend.
		* @param int $max_age
		* (optional) How long the cache data should be kept. Defaults to a week.
		*/
		@@ -63,6 +67,10 @@ public function __construct(ClientInterface $http_client, ConfigFactoryInterface
		$this->httpClient = $http_client;
		$this->providersUrl = $config_factory->get('media.settings')->get('oembed_providers_url');
		$this->time = $time;
		if (empty($cache_backend)) {
		$cache_backend = \Drupal::cache();
		@trigger_error('Passing NULL as the $cache_backend parameter to ' . __METHOD__ . '() is deprecated in drupal:9.3.0 and is removed from drupal:10.0.0. See https://www.drupal.org/node/3223594', E_USER_DEPRECATED);
		}
		$this->cacheBackend = $cache_backend;
		$this->maxAge = (int) $max_age;
		}
		@@ -73,7 +81,7 @@ public function __construct(ClientInterface $http_client, ConfigFactoryInterface
		public function getAll() {
		$cache_id = 'media:oembed_providers';

		$cached = $this->cacheGet($cache_id);
		$cached = $this->cacheBackend->get($cache_id);
		if ($cached) {
		return $cached->data;
		}
		@@ -103,7 +111,7 @@ public function getAll() {
		}
		}

		$this->cacheSet($cache_id, $keyed_providers, $this->time->getCurrentTime() + $this->maxAge);
		$this->cacheBackend->set($cache_id, $keyed_providers, $this->time->getCurrentTime() + $this->maxAge);
		return $keyed_providers;
		}

core/modules/media/src/OEmbed/ResourceFetcher.php

+14 −7

Original line number	Diff line number	Diff line
		@@ -4,7 +4,6 @@

		use Drupal\Component\Serialization\Json;
		use Drupal\Core\Cache\CacheBackendInterface;
		use Drupal\Core\Cache\UseCacheBackendTrait;
		use GuzzleHttp\ClientInterface;
		use GuzzleHttp\Exception\TransferException;

		@@ -13,8 +12,6 @@
		*/
		class ResourceFetcher implements ResourceFetcherInterface {

		use UseCacheBackendTrait;

		/**
		* The HTTP client.
		*
		@@ -29,6 +26,13 @@ class ResourceFetcher implements ResourceFetcherInterface {
		*/
		protected $providers;

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

		/**
		* Constructs a ResourceFetcher object.
		*
		@@ -37,13 +41,16 @@ class ResourceFetcher implements ResourceFetcherInterface {
		* @param \Drupal\media\OEmbed\ProviderRepositoryInterface $providers
		* The oEmbed provider repository service.
		* @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
		* (optional) The cache backend.
		* The cache backend.
		*/
		public function __construct(ClientInterface $http_client, ProviderRepositoryInterface $providers, CacheBackendInterface $cache_backend = NULL) {
		$this->httpClient = $http_client;
		$this->providers = $providers;
		if (empty($cache_backend)) {
		$cache_backend = \Drupal::cache();
		@trigger_error('Passing NULL as the $cache_backend parameter to ' . __METHOD__ . '() is deprecated in drupal:9.3.0 and is removed from drupal:10.0.0. See https://www.drupal.org/node/3223594', E_USER_DEPRECATED);
		}
		$this->cacheBackend = $cache_backend;
		$this->useCaches = isset($cache_backend);
		}

		/**
		@@ -52,7 +59,7 @@ public function __construct(ClientInterface $http_client, ProviderRepositoryInte
		public function fetchResource($url) {
		$cache_id = "media:oembed_resource:$url";

		$cached = $this->cacheGet($cache_id);
		$cached = $this->cacheBackend->get($cache_id);
		if ($cached) {
		return $this->createResource($cached->data, $url);
		}
		@@ -82,7 +89,7 @@ public function fetchResource($url) {
		throw new ResourceException('The oEmbed resource could not be decoded.', $url);
		}

		$this->cacheSet($cache_id, $data);
		$this->cacheBackend->set($cache_id, $data);

		return $this->createResource($data, $url);
		}

core/modules/media/src/OEmbed/UrlResolver.php

+14 −7

Original line number	Diff line number	Diff line
		@@ -5,7 +5,6 @@
		use Drupal\Component\Utility\Html;
		use Drupal\Component\Utility\UrlHelper;
		use Drupal\Core\Cache\CacheBackendInterface;
		use Drupal\Core\Cache\UseCacheBackendTrait;
		use Drupal\Core\Extension\ModuleHandlerInterface;
		use GuzzleHttp\ClientInterface;
		use GuzzleHttp\Exception\TransferException;
		@@ -15,8 +14,6 @@
		*/
		class UrlResolver implements UrlResolverInterface {

		use UseCacheBackendTrait;

		/**
		* The HTTP client.
		*
		@@ -55,6 +52,13 @@ class UrlResolver implements UrlResolverInterface {
		*/
		protected $urlCache = [];

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

		/**
		* Constructs a UrlResolver object.
		*
		@@ -67,15 +71,18 @@ class UrlResolver implements UrlResolverInterface {
		* @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
		* The module handler service.
		* @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
		* (optional) The cache backend.
		* The cache backend.
		*/
		public function __construct(ProviderRepositoryInterface $providers, ResourceFetcherInterface $resource_fetcher, ClientInterface $http_client, ModuleHandlerInterface $module_handler, CacheBackendInterface $cache_backend = NULL) {
		$this->providers = $providers;
		$this->resourceFetcher = $resource_fetcher;
		$this->httpClient = $http_client;
		$this->moduleHandler = $module_handler;
		if (empty($cache_backend)) {
		$cache_backend = \Drupal::cache();
		@trigger_error('Passing NULL as the $cache_backend parameter to ' . __METHOD__ . '() is deprecated in drupal:9.3.0 and is removed from drupal:10.0.0. See https://www.drupal.org/node/3223594', E_USER_DEPRECATED);
		}
		$this->cacheBackend = $cache_backend;
		$this->useCaches = isset($cache_backend);
		}

		/**
		@@ -151,7 +158,7 @@ public function getResourceUrl($url, $max_width = NULL, $max_height = NULL) {
		// Try to get the resource URL from the persistent cache.
		$cache_id = "media:oembed_resource_url:$url:$max_width:$max_height";

		$cached = $this->cacheGet($cache_id);
		$cached = $this->cacheBackend->get($cache_id);
		if ($cached) {
		$this->urlCache[$url] = $cached->data;
		return $this->urlCache[$url];
		@@ -174,7 +181,7 @@ public function getResourceUrl($url, $max_width = NULL, $max_height = NULL) {
		$resource_url = $parsed_url['path'] . '?' . rawurldecode(UrlHelper::buildQuery($parsed_url['query']));

		$this->urlCache[$url] = $resource_url;
		$this->cacheSet($cache_id, $resource_url);
		$this->cacheBackend->set($cache_id, $resource_url);

		return $resource_url;
		}

core/modules/media/tests/modules/media_test_oembed/src/ProviderRepository.php

+4 −2

Original line number	Diff line number	Diff line
		@@ -2,6 +2,7 @@

		namespace Drupal\media_test_oembed;

		use Drupal\Core\Cache\NullBackend;
		use Drupal\media\OEmbed\Provider;
		use Drupal\media\OEmbed\ProviderRepository as BaseProviderRepository;

		@@ -16,8 +17,9 @@ class ProviderRepository extends BaseProviderRepository {
		/**
		* {@inheritdoc}
		*/
		protected function cacheGet($cid) {
		return FALSE;
		public function __construct(...$arguments) {
		parent::__construct(...$arguments);
		$this->cacheBackend = new NullBackend('default');
		}

		/**

core/modules/media/tests/src/Kernel/ProviderRepositoryTest.php

0 → 100644

+29 −0

Original line number	Diff line number	Diff line
		<?php

		namespace Drupal\Tests\media\Kernel;

		use Drupal\KernelTests\KernelTestBase;
		use Drupal\media\OEmbed\ProviderRepository;

		/**
		* @coversDefaultClass \Drupal\media\OEmbed\ProviderRepository
		*
		* @group media
		*/
		class ProviderRepositoryTest extends KernelTestBase {

		/**
		* @covers ::__construct
		*
		* @group legacy
		*/
		public function testDeprecations(): void {
		$this->expectDeprecation('Passing NULL as the $cache_backend parameter to Drupal\media\OEmbed\ProviderRepository::__construct() is deprecated in drupal:9.3.0 and is removed from drupal:10.0.0. See https://www.drupal.org/node/3223594');
		new ProviderRepository(
		$this->container->get('http_client'),
		$this->container->get('config.factory'),
		$this->container->get('datetime.time')
		);
		}

		}