-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Discovery: Add DiscoveryLoader, convert CollaboraDiscovery to a value…
… object.
- Loading branch information
1 parent
104b6b9
commit 4cab629
Showing
12 changed files
with
302 additions
and
160 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,117 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * Copyright the Collabora Online contributors. | ||
| * | ||
| * SPDX-License-Identifier: MPL-2.0 | ||
| * | ||
| * This Source Code Form is subject to the terms of the Mozilla Public | ||
| * License, v. 2.0. If a copy of the MPL was not distributed with this | ||
| * file, You can obtain one at http://mozilla.org/MPL/2.0/. | ||
| */ | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace Drupal\collabora_online\Discovery; | ||
|
|
||
| use Drupal\collabora_online\Exception\CollaboraNotAvailableException; | ||
| use Drupal\Component\Datetime\TimeInterface; | ||
| use Drupal\Core\Cache\Cache; | ||
| use Drupal\Core\Cache\CacheableMetadata; | ||
| use Drupal\Core\Cache\MemoryCache\MemoryCacheInterface; | ||
| use Symfony\Component\ErrorHandler\ErrorHandler; | ||
|
|
||
| /** | ||
| * Creates a discovery value object. | ||
| */ | ||
| class DiscoveryLoader implements DiscoveryLoaderInterface { | ||
|
|
||
| protected const DEFAULT_CID = 'collabora_online.discovery.value'; | ||
|
|
||
| public function __construct( | ||
| protected readonly CollaboraDiscoveryFetcherInterface $discoveryFetcher, | ||
| protected readonly MemoryCacheInterface $cache, | ||
| protected readonly TimeInterface $time, | ||
| protected readonly string $cid = self::DEFAULT_CID, | ||
| ) {} | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function getDiscovery(): CollaboraDiscoveryInterface { | ||
| $cached = $this->cache->get($this->cid); | ||
| if ($cached) { | ||
| return $cached->data; | ||
| } | ||
| $discovery = $this->loadDiscovery(); | ||
|
|
||
| $max_age = $discovery->getCacheMaxAge(); | ||
| /* @see \Drupal\Core\Cache\VariationCache::maxAgeToExpire() */ | ||
| $expire = ($max_age === Cache::PERMANENT) | ||
| ? Cache::PERMANENT | ||
| : $max_age + $this->time->getRequestTime(); | ||
| $this->cache->set( | ||
| $this->cid, | ||
| $discovery, | ||
| $expire, | ||
| $discovery->getCacheTags(), | ||
| ); | ||
| return $discovery; | ||
| } | ||
|
|
||
| /** | ||
| * Loads the discovery. | ||
| * | ||
| * @return \Drupal\collabora_online\Discovery\CollaboraDiscoveryInterface | ||
| * Discovery object. | ||
| * | ||
| * @throws \Drupal\collabora_online\Exception\CollaboraNotAvailableException | ||
| * Fetching the discovery.xml failed, or the result is not valid xml. | ||
| */ | ||
| protected function loadDiscovery(): CollaboraDiscoveryInterface { | ||
| $cacheability = new CacheableMetadata(); | ||
| $xml = $this->discoveryFetcher->getDiscoveryXml($cacheability); | ||
| assert($cacheability->getCacheContexts() === []); | ||
| $parsed_xml = $this->parseXml($xml); | ||
| return new CollaboraDiscovery( | ||
| $parsed_xml, | ||
| $cacheability->getCacheTags(), | ||
| $cacheability->getCacheMaxAge(), | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * Parses an XML string. | ||
| * | ||
| * @param string $xml | ||
| * XML string. | ||
| * | ||
| * @return \SimpleXMLElement | ||
| * Parsed XML. | ||
| * | ||
| * @throws \Drupal\collabora_online\Exception\CollaboraNotAvailableException | ||
| * The XML is invalid or empty. | ||
| */ | ||
| protected function parseXml(string $xml): \SimpleXMLElement { | ||
| try { | ||
| // Avoid errors from XML parsing hitting the regular error handler. | ||
| // An alternative would be libxml_use_internal_errors(), but then we would | ||
| // have to deal with the results from libxml_get_errors(). | ||
| $parsed_xml = ErrorHandler::call( | ||
| fn () => simplexml_load_string($xml), | ||
| ); | ||
| } | ||
| catch (\ErrorException $e) { | ||
| throw new CollaboraNotAvailableException('Error in the retrieved discovery.xml file: ' . $e->getMessage(), previous: $e); | ||
| } | ||
| if ($parsed_xml === FALSE) { | ||
| // The parser returned FALSE, but no error was raised. | ||
| // This is known to happen when $xml is an empty string. | ||
| // Instead we could check for $xml === '' earlier, but we don't know for | ||
| // sure if this is, and always will be, the only such case. | ||
| throw new CollaboraNotAvailableException('The discovery.xml file is empty.'); | ||
| } | ||
| return $parsed_xml; | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * Copyright the Collabora Online contributors. | ||
| * | ||
| * SPDX-License-Identifier: MPL-2.0 | ||
| * | ||
| * This Source Code Form is subject to the terms of the Mozilla Public | ||
| * License, v. 2.0. If a copy of the MPL was not distributed with this | ||
| * file, You can obtain one at http://mozilla.org/MPL/2.0/. | ||
| */ | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace Drupal\collabora_online\Discovery; | ||
|
|
||
| /** | ||
| * Creates a WOPI discovery value object. | ||
| */ | ||
| interface DiscoveryLoaderInterface { | ||
|
|
||
| /** | ||
| * Gets a discovery value object. | ||
| * | ||
| * @return \Drupal\collabora_online\Discovery\CollaboraDiscoveryInterface | ||
| * Discovery value object. | ||
| * | ||
| * @throws \Drupal\collabora_online\Exception\CollaboraNotAvailableException | ||
| * Fetching the discovery.xml failed, or the result is not valid xml. | ||
| */ | ||
| public function getDiscovery(): CollaboraDiscoveryInterface; | ||
|
|
||
| } |
Oops, something went wrong.