Merge pull request #35557 from nextcloud/enh/31667/extend-reference-a…

…pi-for-frontend-picker

build/psalm-baseline.xml

@@ -2015,6 +2015,11 @@
  <code>addServiceListener</code>
  </InvalidArgument>
  </file>
+ <file src="lib/private/Collaboration/Reference/RenderReferenceEventListener.php">
+ <InvalidArgument occurrences="1">
+ <code>addServiceListener</code>
+ </InvalidArgument>
+ </file>
  <file src="lib/private/Command/CallableJob.php">
  <ParamNameMismatch occurrences="1">
  <code>$serializedCallable</code>

core/Controller/ReferenceApiController.php

@@ -25,15 +25,21 @@
 namespace OC\Core\Controller;
 
 use OCP\AppFramework\Http\DataResponse;
+use OCP\Collaboration\Reference\IDiscoverableReferenceProvider;
 use OCP\Collaboration\Reference\IReferenceManager;
 use OCP\IRequest;
 
 class ReferenceApiController extends \OCP\AppFramework\OCSController {
  private IReferenceManager $referenceManager;
+ private ?string $userId;
 
- public function __construct(string $appName, IRequest $request, IReferenceManager $referenceManager) {
+ public function __construct(string $appName,
+ IRequest $request,
+ IReferenceManager $referenceManager,
+ ?string $userId) {
  parent::__construct($appName, $request);
  $this->referenceManager = $referenceManager;
+ $this->userId = $userId;
  }
 
  /**
@@ -88,4 +94,26 @@ public function resolve(array $references, int $limit = 1): DataResponse {
  'references' => array_filter($result)
  ]);
  }
+
+ /**
+ * @NoAdminRequired
+ */
+ public function getProvidersInfo(): DataResponse {
+ $providers = $this->referenceManager->getDiscoverableProviders();
+ $jsonProviders = array_map(static function (IDiscoverableReferenceProvider $provider) {
+ return $provider->jsonSerialize();
+ }, $providers);
+ return new DataResponse($jsonProviders);
+ }
+
+ /**
+ * @NoAdminRequired
+ */
+ public function touchProvider(string $providerId, ?int $timestamp = null): DataResponse {
+ if ($this->userId !== null) {
+ $success = $this->referenceManager->touchProvider($this->userId, $providerId, $timestamp);
+ return new DataResponse(['success' => $success]);
+ }
+ return new DataResponse(['success' => false]);
+ }
 }

core/routes.php

@@ -134,6 +134,8 @@
  ['root' => '/references', 'name' => 'ReferenceApi#resolveOne', 'url' => '/resolve', 'verb' => 'GET'],
  ['root' => '/references', 'name' => 'ReferenceApi#extract', 'url' => '/extract', 'verb' => 'POST'],
  ['root' => '/references', 'name' => 'ReferenceApi#resolve', 'url' => '/resolve', 'verb' => 'POST'],
+ ['root' => '/references', 'name' => 'ReferenceApi#getProvidersInfo', 'url' => '/providers', 'verb' => 'GET'],
+ ['root' => '/references', 'name' => 'ReferenceApi#touchProvider', 'url' => '/provider/{providerId}', 'verb' => 'PUT'],
 
  ['root' => '/profile', 'name' => 'ProfileApi#setVisibility', 'url' => '/{targetUserId}', 'verb' => 'PUT'],
 

lib/base.php

@@ -762,6 +762,7 @@ public static function init(): void {
  self::registerAccountHooks();
  self::registerResourceCollectionHooks();
  self::registerFileReferenceEventListener();
+ self::registerRenderReferenceEventListener();
  self::registerAppRestrictionsHooks();
 
  // Make sure that the application class is not loaded before the database is setup
@@ -925,6 +926,10 @@ private static function registerFileReferenceEventListener(): void {
  \OC\Collaboration\Reference\File\FileReferenceEventListener::register(Server::get(IEventDispatcher::class));
  }
 
+ private static function registerRenderReferenceEventListener() {
+ \OC\Collaboration\Reference\RenderReferenceEventListener::register(Server::get(IEventDispatcher::class));
+ }
+
  /**
  * register hooks for sharing
  */

lib/composer/composer/autoload_classmap.php

@@ -144,9 +144,12 @@
  'OCP\\Collaboration\\Collaborators\\ISearchPlugin' => $baseDir . '/lib/public/Collaboration/Collaborators/ISearchPlugin.php',
  'OCP\\Collaboration\\Collaborators\\ISearchResult' => $baseDir . '/lib/public/Collaboration/Collaborators/ISearchResult.php',
  'OCP\\Collaboration\\Collaborators\\SearchResultType' => $baseDir . '/lib/public/Collaboration/Collaborators/SearchResultType.php',
+ 'OCP\\Collaboration\\Reference\\ADiscoverableReferenceProvider' => $baseDir . '/lib/public/Collaboration/Reference/ADiscoverableReferenceProvider.php',
+ 'OCP\\Collaboration\\Reference\\IDiscoverableReferenceProvider' => $baseDir . '/lib/public/Collaboration/Reference/IDiscoverableReferenceProvider.php',
  'OCP\\Collaboration\\Reference\\IReference' => $baseDir . '/lib/public/Collaboration/Reference/IReference.php',
  'OCP\\Collaboration\\Reference\\IReferenceManager' => $baseDir . '/lib/public/Collaboration/Reference/IReferenceManager.php',
  'OCP\\Collaboration\\Reference\\IReferenceProvider' => $baseDir . '/lib/public/Collaboration/Reference/IReferenceProvider.php',
+ 'OCP\\Collaboration\\Reference\\ISearchableReferenceProvider' => $baseDir . '/lib/public/Collaboration/Reference/ISearchableReferenceProvider.php',
  'OCP\\Collaboration\\Reference\\Reference' => $baseDir . '/lib/public/Collaboration/Reference/Reference.php',
  'OCP\\Collaboration\\Reference\\RenderReferenceEvent' => $baseDir . '/lib/public/Collaboration/Reference/RenderReferenceEvent.php',
  'OCP\\Collaboration\\Resources\\CollectionException' => $baseDir . '/lib/public/Collaboration/Resources/CollectionException.php',
@@ -837,6 +840,7 @@
  'OC\\Collaboration\\Reference\\File\\FileReferenceProvider' => $baseDir . '/lib/private/Collaboration/Reference/File/FileReferenceProvider.php',
  'OC\\Collaboration\\Reference\\LinkReferenceProvider' => $baseDir . '/lib/private/Collaboration/Reference/LinkReferenceProvider.php',
  'OC\\Collaboration\\Reference\\ReferenceManager' => $baseDir . '/lib/private/Collaboration/Reference/ReferenceManager.php',
+ 'OC\\Collaboration\\Reference\\RenderReferenceEventListener' => $baseDir . '/lib/private/Collaboration/Reference/RenderReferenceEventListener.php',
  'OC\\Collaboration\\Resources\\Collection' => $baseDir . '/lib/private/Collaboration/Resources/Collection.php',
  'OC\\Collaboration\\Resources\\Listener' => $baseDir . '/lib/private/Collaboration/Resources/Listener.php',
  'OC\\Collaboration\\Resources\\Manager' => $baseDir . '/lib/private/Collaboration/Resources/Manager.php',

lib/composer/composer/autoload_static.php

@@ -177,9 +177,12 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
  'OCP\\Collaboration\\Collaborators\\ISearchPlugin' => __DIR__ . '/../../..' . '/lib/public/Collaboration/Collaborators/ISearchPlugin.php',
  'OCP\\Collaboration\\Collaborators\\ISearchResult' => __DIR__ . '/../../..' . '/lib/public/Collaboration/Collaborators/ISearchResult.php',
  'OCP\\Collaboration\\Collaborators\\SearchResultType' => __DIR__ . '/../../..' . '/lib/public/Collaboration/Collaborators/SearchResultType.php',
+ 'OCP\\Collaboration\\Reference\\ADiscoverableReferenceProvider' => __DIR__ . '/../../..' . '/lib/public/Collaboration/Reference/ADiscoverableReferenceProvider.php',
+ 'OCP\\Collaboration\\Reference\\IDiscoverableReferenceProvider' => __DIR__ . '/../../..' . '/lib/public/Collaboration/Reference/IDiscoverableReferenceProvider.php',
  'OCP\\Collaboration\\Reference\\IReference' => __DIR__ . '/../../..' . '/lib/public/Collaboration/Reference/IReference.php',
  'OCP\\Collaboration\\Reference\\IReferenceManager' => __DIR__ . '/../../..' . '/lib/public/Collaboration/Reference/IReferenceManager.php',
  'OCP\\Collaboration\\Reference\\IReferenceProvider' => __DIR__ . '/../../..' . '/lib/public/Collaboration/Reference/IReferenceProvider.php',
+ 'OCP\\Collaboration\\Reference\\ISearchableReferenceProvider' => __DIR__ . '/../../..' . '/lib/public/Collaboration/Reference/ISearchableReferenceProvider.php',
  'OCP\\Collaboration\\Reference\\Reference' => __DIR__ . '/../../..' . '/lib/public/Collaboration/Reference/Reference.php',
  'OCP\\Collaboration\\Reference\\RenderReferenceEvent' => __DIR__ . '/../../..' . '/lib/public/Collaboration/Reference/RenderReferenceEvent.php',
  'OCP\\Collaboration\\Resources\\CollectionException' => __DIR__ . '/../../..' . '/lib/public/Collaboration/Resources/CollectionException.php',
@@ -870,6 +873,7 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
  'OC\\Collaboration\\Reference\\File\\FileReferenceProvider' => __DIR__ . '/../../..' . '/lib/private/Collaboration/Reference/File/FileReferenceProvider.php',
  'OC\\Collaboration\\Reference\\LinkReferenceProvider' => __DIR__ . '/../../..' . '/lib/private/Collaboration/Reference/LinkReferenceProvider.php',
  'OC\\Collaboration\\Reference\\ReferenceManager' => __DIR__ . '/../../..' . '/lib/private/Collaboration/Reference/ReferenceManager.php',
+ 'OC\\Collaboration\\Reference\\RenderReferenceEventListener' => __DIR__ . '/../../..' . '/lib/private/Collaboration/Reference/RenderReferenceEventListener.php',
  'OC\\Collaboration\\Resources\\Collection' => __DIR__ . '/../../..' . '/lib/private/Collaboration/Resources/Collection.php',
  'OC\\Collaboration\\Resources\\Listener' => __DIR__ . '/../../..' . '/lib/private/Collaboration/Resources/Listener.php',
  'OC\\Collaboration\\Resources\\Manager' => __DIR__ . '/../../..' . '/lib/private/Collaboration/Resources/Manager.php',

lib/private/Collaboration/Reference/File/FileReferenceEventListener.php

@@ -27,11 +27,13 @@
 use OCP\Collaboration\Reference\IReferenceManager;
 use OCP\EventDispatcher\Event;
 use OCP\EventDispatcher\IEventDispatcher;
+use OCP\EventDispatcher\IEventListener;
 use OCP\Files\Events\Node\NodeDeletedEvent;
 use OCP\Share\Events\ShareCreatedEvent;
 use OCP\Share\Events\ShareDeletedEvent;
 
-class FileReferenceEventListener implements \OCP\EventDispatcher\IEventListener {
+/** @template-implements IEventListener<Event|NodeDeletedEvent|ShareDeletedEvent|ShareCreatedEvent> */
+class FileReferenceEventListener implements IEventListener {
  private IReferenceManager $manager;
 
  public function __construct(IReferenceManager $manager) {

lib/private/Collaboration/Reference/ReferenceManager.php

@@ -26,13 +26,16 @@
 
 use OC\AppFramework\Bootstrap\Coordinator;
 use OC\Collaboration\Reference\File\FileReferenceProvider;
+use OCP\Collaboration\Reference\IDiscoverableReferenceProvider;
 use OCP\Collaboration\Reference\IReference;
 use OCP\Collaboration\Reference\IReferenceManager;
 use OCP\Collaboration\Reference\IReferenceProvider;
 use OCP\Collaboration\Reference\Reference;
 use OCP\ICache;
 use OCP\ICacheFactory;
+use OCP\IConfig;
 use OCP\IURLGenerator;
+use OCP\IUserSession;
 use Psr\Container\ContainerInterface;
 use Psr\Log\LoggerInterface;
 use Throwable;
@@ -47,15 +50,31 @@ class ReferenceManager implements IReferenceManager {
  private ContainerInterface $container;
  private LinkReferenceProvider $linkReferenceProvider;
  private LoggerInterface $logger;
+ private IConfig $config;
+ private IUserSession $userSession;
 
- public function __construct(LinkReferenceProvider $linkReferenceProvider, ICacheFactory $cacheFactory, Coordinator $coordinator, ContainerInterface $container, LoggerInterface $logger) {
+ public function __construct(LinkReferenceProvider $linkReferenceProvider,
+ ICacheFactory $cacheFactory,
+ Coordinator $coordinator,
+ ContainerInterface $container,
+ LoggerInterface $logger,
+ IConfig $config,
+ IUserSession $userSession) {
  $this->linkReferenceProvider = $linkReferenceProvider;
  $this->cache = $cacheFactory->createDistributed('reference');
  $this->coordinator = $coordinator;
  $this->container = $container;
  $this->logger = $logger;
+ $this->config = $config;
+ $this->userSession = $userSession;
  }
 
+ /**
+ * Extract a list of URLs from a text
+ *
+ * @param string $text
+ * @return string[]
+ */
  public function extractReferences(string $text): array {
  preg_match_all(IURLGenerator::URL_REGEX, $text, $matches);
  $references = $matches[0] ?? [];
@@ -64,6 +83,12 @@ public function extractReferences(string $text): array {
  }, $references);
  }
 
+ /**
+ * Try to get a cached reference object from a reference string
+ *
+ * @param string $referenceId
+ * @return IReference|null
+ */
  public function getReferenceFromCache(string $referenceId): ?IReference {
  $matchedProvider = $this->getMatchedProvider($referenceId);
 
@@ -75,6 +100,12 @@ public function getReferenceFromCache(string $referenceId): ?IReference {
  return $this->getReferenceByCacheKey($cacheKey);
  }
 
+ /**
+ * Try to get a cached reference object from a full cache key
+ *
+ * @param string $cacheKey
+ * @return IReference|null
+ */
  public function getReferenceByCacheKey(string $cacheKey): ?IReference {
  $cached = $this->cache->get($cacheKey);
  if ($cached) {
@@ -84,6 +115,13 @@ public function getReferenceByCacheKey(string $cacheKey): ?IReference {
  return null;
  }
 
+ /**
+ * Get a reference object from a reference string with a matching provider
+ * Use a cached reference if possible
+ *
+ * @param string $referenceId
+ * @return IReference|null
+ */
  public function resolveReference(string $referenceId): ?IReference {
  $matchedProvider = $this->getMatchedProvider($referenceId);
 
@@ -106,6 +144,13 @@ public function resolveReference(string $referenceId): ?IReference {
  return null;
  }
 
+ /**
+ * Try to match a reference string with all the registered providers
+ * Fallback to the link reference provider (using OpenGraph)
+ *
+ * @param string $referenceId
+ * @return IReferenceProvider|null the first matching provider
+ */
  private function getMatchedProvider(string $referenceId): ?IReferenceProvider {
  $matchedProvider = null;
  foreach ($this->getProviders() as $provider) {
@@ -122,13 +167,27 @@ private function getMatchedProvider(string $referenceId): ?IReferenceProvider {
  return $matchedProvider;
  }
 
+ /**
+ * Get a hashed full cache key from a key and prefix given by a provider
+ *
+ * @param IReferenceProvider $provider
+ * @param string $referenceId
+ * @return string
+ */
  private function getFullCacheKey(IReferenceProvider $provider, string $referenceId): string {
  $cacheKey = $provider->getCacheKey($referenceId);
  return md5($provider->getCachePrefix($referenceId)) . (
  $cacheKey !== null ? ('-' . md5($cacheKey)) : ''
  );
  }
 
+ /**
+ * Remove a specific cache entry from its key+prefix
+ *
+ * @param string $cachePrefix
+ * @param string|null $cacheKey
+ * @return void
+ */
  public function invalidateCache(string $cachePrefix, ?string $cacheKey = null): void {
  if ($cacheKey === null) {
  $this->cache->clear(md5($cachePrefix));
@@ -167,4 +226,59 @@ public function getProviders(): array {
 
  return $this->providers;
  }
+
+ /**
+ * @inheritDoc
+ */
+ public function getDiscoverableProviders(): array {
+ // preserve 0 based index to avoid returning an object in data responses
+ return array_values(
+ array_filter($this->getProviders(), static function (IReferenceProvider $provider) {
+ return $provider instanceof IDiscoverableReferenceProvider;
+ })
+ );
+ }
+
+ /**
+ * @inheritDoc
+ */
+ public function touchProvider(string $userId, string $providerId, ?int $timestamp = null): bool {
+ $providers = $this->getDiscoverableProviders();
+ $matchingProviders = array_filter($providers, static function (IDiscoverableReferenceProvider $provider) use ($providerId) {
+ return $provider->getId() === $providerId;
+ });
+ if (!empty($matchingProviders)) {
+ if ($timestamp === null) {
+ $timestamp = time();
+ }
+
+ $configKey = 'provider-last-use_' . $providerId;
+ $this->config->setUserValue($userId, 'references', $configKey, (string) $timestamp);
+ return true;
+ }
+ return false;
+ }
+
+ /**
+ * @inheritDoc
+ */
+ public function getUserProviderTimestamps(): array {
+ $user = $this->userSession->getUser();
+ if ($user === null) {
+ return [];
+ }
+ $userId = $user->getUID();
+ $keys = $this->config->getUserKeys($userId, 'references');
+ $prefix = 'provider-last-use_';
+ $keys = array_filter($keys, static function (string $key) use ($prefix) {
+ return str_starts_with($key, $prefix);
+ });
+ $timestamps = [];
+ foreach ($keys as $key) {
+ $providerId = substr($key, strlen($prefix));
+ $timestamp = (int) $this->config->getUserValue($userId, 'references', $key);
+ $timestamps[$providerId] = $timestamp;
+ }
+ return $timestamps;
+ }
 }