Refactor cache handling

Signed-off-by: Julius Härtl <jus@bitgrid.net>

2 files changed, 28 insertions, 2 deletions

diff --git a/lib/public/Collaboration/Reference/IReferenceManager.php b/lib/public/Collaboration/Reference/IReferenceManager.php
index e9a53e8a61a..487e243c7ed 100644
--- a/lib/public/Collaboration/Reference/IReferenceManager.php
+++ b/lib/public/Collaboration/Reference/IReferenceManager.php
@@ -31,6 +31,7 @@ interface IReferenceManager {
 	/**
 	 * Return all reference identifiers within a string as an array
 	 *
+	 * @return string[] Array of found references (urls)
 	 * @since 25.0.0
 	 */
 	public function extractReferences(string $text): array;
@@ -44,4 +45,26 @@ interface IReferenceManager {
 	 * @since 25.0.0
 	 */
 	public function resolveReference(string $referenceId): ?IReference;
+
+	/**
+	 * Get a reference by its cache key
+	 *
+	 * @since 25.0.0
+	 */
+	public function getReferenceByCacheKey(string $cacheKey): ?IReference;
+
+	/**
+	 * Explicitly get a reference from the cache to avoid heavy fetches for cases
+	 * the cache can then be filled with a separate request from the frontend
+	 *
+	 * @since 25.0.0
+	 */
+	public function getReferenceFromCache(string $referenceId): ?IReference;
+
+	/**
+	 * Invalidate all cache entries with a prefix or just one if the cache key is provided
+	 *
+	 * @since 25.0.0
+	 */
+	public function invalidateCache(string $cachePrefix, ?string $cacheKey = null): void;
 }
diff --git a/lib/public/Collaboration/Reference/IReferenceProvider.php b/lib/public/Collaboration/Reference/IReferenceProvider.php
index d2f3601a475..100374b78b3 100644
--- a/lib/public/Collaboration/Reference/IReferenceProvider.php
+++ b/lib/public/Collaboration/Reference/IReferenceProvider.php
@@ -47,14 +47,17 @@ interface IReferenceProvider {
 	 *
 	 * @since 25.0.0
 	 */
-	public function isGloballyCacheable(): bool;
+	public function getCachePrefix(string $referenceId): string;
 
 	/**
 	 * Return a custom cache key to be used for caching the metadata
 	 * This could be for example the current user id if the reference
 	 * access permissions are different for each user
 	 *
+	 * Should return null, if the cache is only related to the
+	 * reference id and has no further dependency
+	 *
 	 * @since 25.0.0
 	 */
-	public function getCacheKey(string $referenceId): string;
+	public function getCacheKey(string $referenceId): ?string;
 }