feat(Reference): Add public API endpoints to get references #46378

mejo- · 2024-07-09T16:18:10Z

Calling the public API endpoints will check for matching registered reference providers that implement IPublicReferenceProvider and call their respective functions. If no matching provider is found, the default LinkReferenceProvider will be used to provide open graph data.

The frontend reference widget components will call these endpoints from unauthorized sessions, e.g. in public shares.

If present, the sharing token of the origin URL is passed to resolveReferencePublic() as additional information for the reference provider to determine the access scope. This allows the respective reference providers to determine whether the origin share has access to the linked resource.

getCacheKeyPublic also gets the sharing token so it can scope the cached entry to it.

Contributes to #45978

Checklist

Code is properly formatted
Sign-off message is added to all commits
Tests (unit, integration, api and/or acceptance) are included
Documentation (manuals or wiki) has been updated or is not required
Backports requested where applicable (ex: critical bugfixes)

* Depends on nextcloud/server#46378 * Contributes to nextcloud/server#45978 Signed-off-by: Jonas <jonas@freesources.org>

lib/private/Collaboration/Reference/ReferenceManager.php

core/Controller/ReferenceApiController.php

juliushaertl

Haven't tested yet but looks good from a first read

core/Controller/ReferenceApiController.php

max-nextcloud · 2024-07-17T10:09:05Z

lib/private/Collaboration/Reference/ReferenceManager.php

 		$cached = $this->cache->get($cacheKey);
 		if ($cached) {
 			return Reference::fromCache($cached);
 		}

-		$reference = $matchedProvider->resolveReference($referenceId);
+		if ($public) {
+			$reference = $matchedProvider->resolveReferencePublic($referenceId, $sharingToken);


core/Controller/ReferenceApiController.php

+				break;
+			}
+
+			$result[$reference] = $resolve ? $this->referenceManager->resolveReference($reference, true, $sharingToken)->jsonSerialize() : null;


* Depends on nextcloud/server#46378 * Contributes to nextcloud/server#45978 Signed-off-by: Jonas <jonas@freesources.org>

Allow to resolve page references by share token to support lookups from public shares. This adds link previews for links to other pages in the same collective in public shares. It requires the new public reference API from nextcloud/server#46378 and the Text app being built with nextcloud-libraries/nextcloud-vue#5800. Fixes: #1275 Contributes to nextcloud/text#5520 Signed-off-by: Jonas <jonas@freesources.org>

max-nextcloud

One comment that will need to be addressed I think.

max-nextcloud · 2024-07-17T10:09:05Z

lib/private/Collaboration/Reference/ReferenceManager.php

 		$cached = $this->cache->get($cacheKey);
 		if ($cached) {
 			return Reference::fromCache($cached);
 		}

-		$reference = $matchedProvider->resolveReference($referenceId);
+		if ($public) {
+			$reference = $matchedProvider->resolveReferencePublic($referenceId, $sharingToken);


core/Controller/ReferenceApiController.php

Calling the public API endpoints will check for matching registered reference providers that implement `IPublicReferenceProvider` and call their respective functions. If no matching provider is found, the default `LinkReferenceProvider` will be used to provide open graph data. The frontend reference widget components will call these endpoints from unauthorized sessions, e.g. in public shares. If present, the sharing token of the origin URL is passed to `resolveReferencePublic()` as additional information for the reference provider to determine the access scope. This allows the respective reference providers to determine whether the origin share has access to the linked resource. `getCacheKeyPublic` also gets the sharing token so it can scope the cached entry to it. Contributes to #45978 Signed-off-by: Jonas <jonas@freesources.org>

* Depends on nextcloud/server#46378 * Contributes to nextcloud/server#45978 Signed-off-by: Jonas <jonas@freesources.org>

Allow to resolve page references by share token to support lookups from public shares. This adds link previews for links to other pages in the same collective in public shares. It requires the new public reference API from nextcloud/server#46378 and the Text app being built with nextcloud-libraries/nextcloud-vue#5800. Fixes: #1275 Contributes to nextcloud/text#5520 Signed-off-by: Jonas <jonas@freesources.org>

nickvergessen · 2024-07-18T10:04:47Z

lib/public/Collaboration/Reference/IPublicReferenceProvider.php

+/**
+ * @since 30.0.0
+ */
+interface IPublicReferenceProvider extends IReferenceProvider {


@mejo- Please document in https://docs.nextcloud.com/server/latest/developer_manual/app_publishing_maintenance/app_upgrade_guide/upgrade_to_30.html#id1

(also all other API additions/changes in lib/public/)

Done so now in nextcloud/documentation#12037. The HTTP API additions got already documented with nextcloud/documentation#12030

julien-nc

A bit late to the party... LGTM

julien-nc · 2024-07-22T09:22:10Z

lib/public/Collaboration/Reference/LinkReferenceProvider.php

@@ -26,7 +26,7 @@
 /**
 * @since 29.0.0
 */
-class LinkReferenceProvider implements IReferenceProvider {
+class LinkReferenceProvider implements IReferenceProvider, IPublicReferenceProvider {


IPublicReferenceProvider extends IReferenceProvider so LinkReferenceProvider could just extend IPublicReferenceProvider, right?

* Depends on nextcloud/server#46378 * Contributes to nextcloud/server#45978 Signed-off-by: Jonas <jonas@freesources.org>

Allow to resolve page references by share token to support lookups from public shares. This adds link previews for links to other pages in the same collective in public shares. It requires the new public reference API from nextcloud/server#46378 and the Text app being built with nextcloud-libraries/nextcloud-vue#5800. Fixes: #1275 Contributes to nextcloud/text#5520 Signed-off-by: Jonas <jonas@freesources.org>

mejo- added the 2. developing Work in progress label Jul 9, 2024

mejo- added this to the Nextcloud 30 milestone Jul 9, 2024

mejo- requested review from juliushaertl and julien-nc July 9, 2024 16:18

mejo- self-assigned this Jul 9, 2024

github-advanced-security bot found potential problems Jul 9, 2024

View reviewed changes

lib/private/Collaboration/Reference/ReferenceManager.php Fixed Show fixed Hide fixed

core/Controller/ReferenceApiController.php Fixed Show fixed Hide fixed

This was referenced Jul 9, 2024

feat(NcRichText): Call public reference API when unauthenticated nextcloud-libraries/nextcloud-vue#5800

Merged

Resolving references from public share #45978

Closed

juliushaertl reviewed Jul 9, 2024

View reviewed changes

core/Controller/ReferenceApiController.php Show resolved Hide resolved

mejo- commented Jul 9, 2024

View reviewed changes

core/Controller/ReferenceApiController.php Outdated Show resolved Hide resolved

mejo- force-pushed the feat/public_reference_api branch 2 times, most recently from 6922479 to 224d292 Compare July 10, 2024 09:55

mejo- requested a review from juliushaertl July 10, 2024 09:55

github-advanced-security bot found potential problems Jul 10, 2024

View reviewed changes

mejo- force-pushed the feat/public_reference_api branch from 224d292 to f447eb1 Compare July 15, 2024 12:48

mejo- requested a review from provokateurin as a code owner July 15, 2024 12:48

mejo- added 3. to review Waiting for reviews and removed 2. developing Work in progress labels Jul 15, 2024

mejo- requested a review from blizzz July 15, 2024 13:29

mejo- mentioned this pull request Jul 16, 2024

feat(PageReference): Public page reference lookups nextcloud/collectives#1369

Merged

3 tasks

juliushaertl approved these changes Jul 16, 2024

View reviewed changes

max-nextcloud requested changes Jul 17, 2024

View reviewed changes

mejo- force-pushed the feat/public_reference_api branch from f447eb1 to 1671bf3 Compare July 17, 2024 10:56

mejo- requested a review from max-nextcloud July 17, 2024 10:57

max-nextcloud approved these changes Jul 17, 2024

View reviewed changes

mejo- merged commit e4368f6 into master Jul 17, 2024
167 checks passed

mejo- deleted the feat/public_reference_api branch July 17, 2024 12:35

nickvergessen reviewed Jul 18, 2024

View reviewed changes

nickvergessen added the pending documentation This pull request needs an associated documentation update label Jul 18, 2024

mejo- removed the pending documentation This pull request needs an associated documentation update label Jul 18, 2024

julien-nc reviewed Jul 22, 2024

View reviewed changes

blizzz mentioned this pull request Jul 24, 2024

30.0.0 beta 1 #46713

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(Reference): Add public API endpoints to get references #46378

feat(Reference): Add public API endpoints to get references #46378

mejo- commented Jul 9, 2024 •

edited

Loading

juliushaertl left a comment

max-nextcloud Jul 17, 2024

max-nextcloud left a comment

max-nextcloud Jul 17, 2024

nickvergessen Jul 18, 2024

mejo- Jul 18, 2024

julien-nc left a comment

julien-nc Jul 22, 2024

feat(Reference): Add public API endpoints to get references #46378

feat(Reference): Add public API endpoints to get references #46378

Conversation

mejo- commented Jul 9, 2024 • edited Loading

Checklist

juliushaertl left a comment

Choose a reason for hiding this comment

max-nextcloud Jul 17, 2024

Choose a reason for hiding this comment

max-nextcloud left a comment

Choose a reason for hiding this comment

max-nextcloud Jul 17, 2024

Choose a reason for hiding this comment

nickvergessen Jul 18, 2024

Choose a reason for hiding this comment

mejo- Jul 18, 2024

Choose a reason for hiding this comment

julien-nc left a comment

Choose a reason for hiding this comment

julien-nc Jul 22, 2024

Choose a reason for hiding this comment

mejo- commented Jul 9, 2024 •

edited

Loading