From fc5615dd18147f7076af51840f460ddb94a16ab9 Mon Sep 17 00:00:00 2001 From: NuttyShrimp Date: Fri, 11 Oct 2024 13:43:25 +0200 Subject: [PATCH 01/35] feat(header): move header to layout & add new request page --- loama/src/components/header/HeaderTab.vue | 5 +++-- loama/src/components/layouts/HeaderLayout.vue | 13 +++++++++++++ loama/src/router/index.ts | 19 ++++++++++++++++--- loama/src/views/HomeView.vue | 7 ------- loama/src/views/RequestView.vue | 5 +++++ 5 files changed, 37 insertions(+), 12 deletions(-) create mode 100644 loama/src/components/layouts/HeaderLayout.vue create mode 100644 loama/src/views/RequestView.vue diff --git a/loama/src/components/header/HeaderTab.vue b/loama/src/components/header/HeaderTab.vue index ac7ad5f..5884e2a 100644 --- a/loama/src/components/header/HeaderTab.vue +++ b/loama/src/components/header/HeaderTab.vue @@ -1,7 +1,7 @@ diff --git a/loama/src/router/index.ts b/loama/src/router/index.ts index 5cff680..1c70724 100644 --- a/loama/src/router/index.ts +++ b/loama/src/router/index.ts @@ -1,9 +1,11 @@ import { createRouter, createWebHistory } from 'vue-router' import HomeView from '@/views/HomeView.vue' import LoginView from '@/views/LoginView.vue' +import RequestView from '@/views/RequestView.vue' import { store } from 'loama-app' import { listPodUrls } from 'loama-common' import { activeController } from 'loama-controller' +import HeaderLayout from '@/components/layouts/HeaderLayout.vue' const router = createRouter({ history: createWebHistory(import.meta.env.BASE_URL), @@ -14,9 +16,20 @@ const router = createRouter({ component: LoginView }, { - path: `/home/:filePath(.*)`, - name: 'home', - component: HomeView + path: "/", + component: HeaderLayout, + children: [ + { + path: `/home/:filePath(.*)`, + name: 'home', + component: HomeView + }, + { + path: "/request", + name: "request", + component: RequestView, + } + ] } ] }) diff --git a/loama/src/views/HomeView.vue b/loama/src/views/HomeView.vue index fc0d76a..9bd1ab3 100644 --- a/loama/src/views/HomeView.vue +++ b/loama/src/views/HomeView.vue @@ -1,9 +1,4 @@ diff --git a/loama/src/views/RequestView.vue b/loama/src/views/RequestView.vue new file mode 100644 index 0000000..ec9a5fa --- /dev/null +++ b/loama/src/views/RequestView.vue @@ -0,0 +1,5 @@ + + From a4a639df4dd79bf57b20142f0b4e5b45b887f1a8 Mon Sep 17 00:00:00 2001 From: NuttyShrimp Date: Fri, 11 Oct 2024 15:16:21 +0200 Subject: [PATCH 02/35] feat(controller): add controls for resources.json --- controller/src/classes/Controller.ts | 21 +++++++ controller/src/classes/stores/BaseStore.ts | 12 +++- controller/src/classes/stores/InruptStore.ts | 59 ++++++++++++++++++-- controller/src/types/index.ts | 5 ++ controller/src/types/modules.ts | 19 ++++++- 5 files changed, 109 insertions(+), 7 deletions(-) diff --git a/controller/src/classes/Controller.ts b/controller/src/classes/Controller.ts index 753ddd9..ae52db1 100644 --- a/controller/src/classes/Controller.ts +++ b/controller/src/classes/Controller.ts @@ -306,4 +306,25 @@ export class Controller> }, permissionsPerSubject) } } + + async allowAccessRequest(resourceUrl: string) { + const resources = await this.store.getCurrentResources(); + if (resources.items.includes(resourceUrl)) { + return; + } + resources.items.push(resourceUrl); + + await this.store.saveToRemoteResources(); + } + + async denyAccessRequest(resourceUrl: string) { + const resources = await this.store.getCurrentResources(); + if (!resources.items.includes(resourceUrl)) { + return; + } + const idx = resources.items.indexOf(resourceUrl); + resources.items.splice(idx, 1); + + await this.store.saveToRemoteResources(); + } } diff --git a/controller/src/classes/stores/BaseStore.ts b/controller/src/classes/stores/BaseStore.ts index 4b207e8..0b8e4ae 100644 --- a/controller/src/classes/stores/BaseStore.ts +++ b/controller/src/classes/stores/BaseStore.ts @@ -1,9 +1,10 @@ import { SubjectKey } from "@/types/modules"; -import { BaseSubject, Index } from "../../types"; +import { BaseSubject, Index, Resources } from "../../types"; export abstract class BaseStore>> { protected podUrl?: string = undefined; protected index?: Index = undefined; + protected resources?: Resources = undefined; setPodUrl(url: string): void { this.podUrl = url; @@ -13,6 +14,15 @@ export abstract class BaseStore; + + async getCurrentResources() { + if (!this.resources) { + this.resources = await this.getOrCreateResources(); + } + return this.resources as Resources; + } + abstract getOrCreateIndex(): Promise>; async getCurrentIndex>() { diff --git a/controller/src/classes/stores/InruptStore.ts b/controller/src/classes/stores/InruptStore.ts index 4fcdd83..2eabfa3 100644 --- a/controller/src/classes/stores/InruptStore.ts +++ b/controller/src/classes/stores/InruptStore.ts @@ -1,8 +1,9 @@ import { FetchError, getFile, overwriteFile, saveFileInContainer, WithResourceInfo } from "@inrupt/solid-client"; -import { BaseSubject, Index } from "../../types"; +import { BaseSubject, Index, Resources } from "../../types"; import { IStore } from "../../types/modules"; import { BaseStore } from "./BaseStore"; import { getDefaultSession, Session } from "@inrupt/solid-client-authn-browser"; +import { setPublicAccess } from "@inrupt/solid-client/universal"; /** * A store implementation using the inrupt sdk to actually communicate with the pod @@ -12,6 +13,7 @@ import { getDefaultSession, Session } from "@inrupt/solid-client-authn-browser"; export class InruptStore>> extends BaseStore implements IStore { // TODO this should be a more resilient path: be.ugent.idlab.knows.solid.loama.index.js or smth private indexPath = "index.json"; + private resourcesPath = "resources.json"; private session: Session; constructor() { @@ -19,12 +21,46 @@ export class InruptStore this.session = getDefaultSession() } - private indexToIndexFile(): File { - return new File([JSON.stringify(this.index)], this.indexPath, { + private toJsonFile(data: unknown, path: string): File { + return new File([JSON.stringify(data)], path, { type: "application/json", }); } + async getOrCreateResources(): Promise { + if (!this.podUrl) { + throw new Error("Cannot get current resources file: pod location is not set"); + } + + if (this.resources) { + return this.resources; + } + + const resourcesPath = `${this.podUrl}${this.resourcesPath}`; + let file: (Blob & WithResourceInfo) | undefined = undefined + try { + file = await getFile(resourcesPath, { fetch: this.session.fetch }) + } catch (error: unknown) { + if (error instanceof FetchError && error.statusCode === 404) { + this.resources = { id: resourcesPath, items: [] } + file = await saveFileInContainer( + this.podUrl, + this.toJsonFile(this.resources, this.resourcesPath), + { fetch: this.session.fetch } + ); + await setPublicAccess(resourcesPath, { read: true }, { fetch: this.session.fetch }); + } + } + + const fileText = await file?.text(); + this.resources = JSON.parse(fileText ?? "{}"); + if (!this.resources) { + throw new Error("Resources not found or invalid"); + } + + return this.resources; + } + // NOTE: Possible will move the podUrl to the parameters, this works for the current POC async getOrCreateIndex(): Promise> { if (!this.podUrl) { @@ -44,7 +80,7 @@ export class InruptStore this.index = { id: indexUrl, items: [] } file = await saveFileInContainer( this.podUrl, - this.indexToIndexFile(), + this.toJsonFile(this.index, this.indexPath), { fetch: this.session.fetch } ); } @@ -67,7 +103,20 @@ export class InruptStore throw new Error("Index not found or invalid"); } - overwriteFile(this.index.id, this.indexToIndexFile(), { + overwriteFile(this.index.id, this.toJsonFile(this.index, this.indexPath), { + fetch: this.session.fetch, + }); + } + + async saveToRemoteResources() { + if (!this.resources) { + await this.getOrCreateResources(); + } + if (!this.resources) { + throw new Error("Resources not found or invalid"); + } + + overwriteFile(this.resources.id, this.toJsonFile(this.resources, this.resourcesPath), { fetch: this.session.fetch, }); } diff --git a/controller/src/types/index.ts b/controller/src/types/index.ts index 7eeb5a1..d3b93c1 100644 --- a/controller/src/types/index.ts +++ b/controller/src/types/index.ts @@ -1,5 +1,10 @@ import { url } from "loama-common"; +export interface Resources { + id: url; + items: string[] +} + /** * The json schema for the index configuration file inside a Solid data pod. */ diff --git a/controller/src/types/modules.ts b/controller/src/types/modules.ts index f299986..700aa52 100644 --- a/controller/src/types/modules.ts +++ b/controller/src/types/modules.ts @@ -1,4 +1,4 @@ -import { BaseSubject, Index, IndexItem, Permission, ResourcePermissions, SubjectPermissions } from "../types"; +import { BaseSubject, Index, IndexItem, Permission, ResourcePermissions, Resources, SubjectPermissions } from "../types"; export type SubjectKey = keyof T & string; export type SubjectType> = T[K]; @@ -30,6 +30,9 @@ export interface IController[]> getResourcePermissionList(resourceUrl: string): Promise> + + allowAccessRequest(resourceUrl: string): Promise + denyAccessRequest(resourceUrl: string): Promise } export interface IStore>> { @@ -55,6 +58,20 @@ export interface IStore> * Saves the index to the pod */ saveToRemoteIndex(): Promise; + + /** + * Returns the currently stored index or calls getOrCreateIndex if the index is not set + */ + getCurrentResources(): Promise; + + /** + * Tries to retrieve the stored index.json from the pod. If it doesn't exist, it creates an empty one. + */ + getOrCreateResources(): Promise; + /** + * Saves the index to the pod + */ + saveToRemoteResources(): Promise; } export interface ISubjectResolver> { From 1c8b197f1c52fee5349c030de11e5e64a2d09103 Mon Sep 17 00:00:00 2001 From: NuttyShrimp Date: Fri, 11 Oct 2024 17:01:00 +0200 Subject: [PATCH 03/35] feat(loama): add toggle to allow access request for a resource --- controller/src/classes/Controller.ts | 11 ++++++- .../inrupt/InruptPermissionManager.ts | 4 +++ controller/src/types/index.ts | 1 + controller/src/types/modules.ts | 3 +- .../src/components/explorer/SelectedEntry.vue | 32 ++++++++++++++++++- loama/src/lib/state.ts | 7 +++- 6 files changed, 54 insertions(+), 4 deletions(-) diff --git a/controller/src/classes/Controller.ts b/controller/src/classes/Controller.ts index ae52db1..bab0962 100644 --- a/controller/src/classes/Controller.ts +++ b/controller/src/classes/Controller.ts @@ -195,6 +195,7 @@ export class Controller> const configs: SubjectConfig[] = Object.values(this.subjectConfigs); const index = await this.store.getCurrentIndex(); + const requestAccessResources = await this.store.getCurrentResources(); const resourcesToSkip = index.items.filter(i => { if (!i.resource.includes(containerUrl)) { return false; @@ -265,6 +266,7 @@ export class Controller> } else { arr.push({ resourceUrl: v.resource, + canRequestAccess: requestAccessResources.items.includes(v.resource), permissionsPerSubject: [{ permissions: v.permissions, subject: v.subject, @@ -281,12 +283,14 @@ export class Controller> // Need to put it in a variable because the type declaration vanishes const configs: SubjectConfig[] = Object.values(this.subjectConfigs); const index = await this.store.getCurrentIndex(); + const requestAccessResources = await this.store.getCurrentResources(); const results = await Promise.allSettled(configs.map(c => c.manager.getRemotePermissions(resourceUrl))) let permissionsPerSubject = index.items.filter(i => i.resource === resourceUrl) return { resourceUrl, + canRequestAccess: requestAccessResources.items.includes(resourceUrl), permissionsPerSubject: results.reduce[]>((arr, v) => { if (v.status === "fulfilled") { v.value.forEach(remotePps => { @@ -307,6 +311,11 @@ export class Controller> } } + async canRequestAccessToResource(resourceUrl: string) { + const resources = await this.store.getCurrentResources(); + return resources.items.includes(resourceUrl); + } + async allowAccessRequest(resourceUrl: string) { const resources = await this.store.getCurrentResources(); if (resources.items.includes(resourceUrl)) { @@ -317,7 +326,7 @@ export class Controller> await this.store.saveToRemoteResources(); } - async denyAccessRequest(resourceUrl: string) { + async disallowAccessRequest(resourceUrl: string) { const resources = await this.store.getCurrentResources(); if (!resources.items.includes(resourceUrl)) { return; diff --git a/controller/src/classes/permissionManager/inrupt/InruptPermissionManager.ts b/controller/src/classes/permissionManager/inrupt/InruptPermissionManager.ts index 1d9bf12..c91d194 100644 --- a/controller/src/classes/permissionManager/inrupt/InruptPermissionManager.ts +++ b/controller/src/classes/permissionManager/inrupt/InruptPermissionManager.ts @@ -87,11 +87,15 @@ export abstract class InruptPermissionManager> { export interface ResourcePermissions> { resourceUrl: url; + canRequestAccess: boolean; permissionsPerSubject: SubjectPermissions[] } diff --git a/controller/src/types/modules.ts b/controller/src/types/modules.ts index 700aa52..24720ad 100644 --- a/controller/src/types/modules.ts +++ b/controller/src/types/modules.ts @@ -31,8 +31,9 @@ export interface IController> + canRequestAccessToResource(resourceUrl: string): Promise allowAccessRequest(resourceUrl: string): Promise - denyAccessRequest(resourceUrl: string): Promise + disallowAccessRequest(resourceUrl: string): Promise } export interface IStore>> { diff --git a/loama/src/components/explorer/SelectedEntry.vue b/loama/src/components/explorer/SelectedEntry.vue index 9da0f49..10d0a46 100644 --- a/loama/src/components/explorer/SelectedEntry.vue +++ b/loama/src/components/explorer/SelectedEntry.vue @@ -6,11 +6,17 @@ -
+

Subjects with permissions:

Edit
+
+ + Can people ask access to this resource? +
+

Subjects with access:

  • @@ -35,10 +41,24 @@ import LoButton from '../LoButton.vue'; import { ref } from 'vue'; import Drawer from 'primevue/drawer'; import SubjectPermissionTable from './SubjectPermissionTable.vue'; +import ToggleSwitch from 'primevue/toggleswitch'; const podStore = usePodStore(); const permissionDrawerVisible = ref(false); + +const handleSubjectRequestAccess = (canRequest: boolean) => { + if (!podStore.selectedEntry) { + throw new Error('No entry selected, this should not be possible'); + } + if (canRequest) { + activeController.allowAccessRequest(podStore.selectedEntry.resourceUrl) + } else { + activeController.disallowAccessRequest(podStore.selectedEntry.resourceUrl) + } + + podStore.refreshRequestAccessAllowance(); +} diff --git a/loama/src/views/RequestView.vue b/loama/src/views/RequestView.vue index ec9a5fa..0c7f859 100644 --- a/loama/src/views/RequestView.vue +++ b/loama/src/views/RequestView.vue @@ -1,5 +1,64 @@ + diff --git a/solid-common-lib/src/index.ts b/solid-common-lib/src/index.ts index 9979e06..3b83358 100644 --- a/solid-common-lib/src/index.ts +++ b/solid-common-lib/src/index.ts @@ -11,9 +11,12 @@ export { url } from "./types"; * @returns The URL's to the pods the user has access to */ export async function listPodUrls(session: Session): Promise { - const webId = session.info.webId! + return listWebIdPodUrls(session.info.webId!, session.fetch); +} + +export async function listWebIdPodUrls(webId: string, fetch?: typeof globalThis.fetch): Promise { const urls = await getPodUrlAll(webId, { - fetch: session.fetch, + fetch, }); const fetchedUrl = await fetchStorageTriple(webId); diff --git a/yarn.lock b/yarn.lock index 57b9aaa..bbd08ce 100644 --- a/yarn.lock +++ b/yarn.lock @@ -527,6 +527,11 @@ jose "^5.1.3" uuid "^10.0.0" +"@inrupt/solid-client-errors@^0.0.1": + version "0.0.1" + resolved "https://registry.yarnpkg.com/@inrupt/solid-client-errors/-/solid-client-errors-0.0.1.tgz#e93c1d6b0f2b728f4d886b5b9eb2d068b1cbbb82" + integrity sha512-7OgjR6pdNVZEVZptL/2EzOWOArjFARg60ogiH/pFUkWSaiyx5bU//WG+pjlBlxiGJSXdxHOZ0lvH6zGv/p7rmQ== + "@inrupt/solid-client@^2.0.1": version "2.0.1" resolved "https://registry.yarnpkg.com/@inrupt/solid-client/-/solid-client-2.0.1.tgz#103c1f2b75f1710d67180c2f28f3d2a609408527" @@ -542,6 +547,22 @@ optionalDependencies: fsevents "^2.3.3" +"@inrupt/solid-client@^2.1.0": + version "2.1.0" + resolved "https://registry.yarnpkg.com/@inrupt/solid-client/-/solid-client-2.1.0.tgz#28a05b9219168d07ebc13f8c961d84f013d10428" + integrity sha512-nUvgmS8UbxMzID9+CIHh2xrwpnZNmbXsmbSoO0kQjSt7ufhDmggeovmnBVH5WjtzG6Gy+aZUyW/RH8SltAawRQ== + dependencies: + "@inrupt/solid-client-errors" "^0.0.1" + "@rdfjs/dataset" "^1.1.1" + buffer "^6.0.3" + http-link-header "^1.1.1" + jsonld-context-parser "^3.0.0" + jsonld-streaming-parser "^3.3.0" + n3 "^1.17.2" + uuid "^10.0.0" + optionalDependencies: + fsevents "^2.3.3" + "@inrupt/vocab-common-rdf@^1.0.5": version "1.0.5" resolved "https://registry.yarnpkg.com/@inrupt/vocab-common-rdf/-/vocab-common-rdf-1.0.5.tgz#e5aac57e85da55823bd54f5dfe419c05a49ffcac" @@ -2460,6 +2481,16 @@ jsonld-context-parser@^2.4.0: http-link-header "^1.0.2" relative-to-absolute-iri "^1.0.5" +jsonld-context-parser@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/jsonld-context-parser/-/jsonld-context-parser-3.0.0.tgz#43992862fc3eabcee9940cf4c44bb2b0dbe2542c" + integrity sha512-Kg6TVtBUdIm057ht/8WNhM9BROt+BeYaDGXbzrKaa3xA99csee+CsD8IMCTizRgzoO8PIzvzcxxCoRvpq1xNQw== + dependencies: + "@types/http-link-header" "^1.0.1" + "@types/node" "^18.0.0" + http-link-header "^1.0.2" + relative-to-absolute-iri "^1.0.5" + jsonld-streaming-parser@^3.3.0: version "3.4.0" resolved "https://registry.yarnpkg.com/jsonld-streaming-parser/-/jsonld-streaming-parser-3.4.0.tgz#ea0c74b7a108c4aacd4eaa8518348bd89b9fff0a" From e918c0ac83ca021a8d0abfd93410bb8f222a5150 Mon Sep 17 00:00:00 2001 From: NuttyShrimp Date: Mon, 14 Oct 2024 17:00:43 +0200 Subject: [PATCH 05/35] refactor(controller): make store more abstract for re-usability sake --- controller/src/classes/Controller.ts | 70 +++++--------- controller/src/classes/stores/BaseStore.ts | 32 +++---- controller/src/classes/stores/InruptStore.ts | 96 +++++--------------- controller/src/controllers.ts | 7 +- controller/src/types/modules.ts | 30 ++---- 5 files changed, 73 insertions(+), 162 deletions(-) diff --git a/controller/src/classes/Controller.ts b/controller/src/classes/Controller.ts index bab0962..68e94de 100644 --- a/controller/src/classes/Controller.ts +++ b/controller/src/classes/Controller.ts @@ -1,14 +1,16 @@ -import { BaseSubject, IndexItem, Permission, ResourcePermissions, SubjectPermissions } from "../types"; -import { IController, IStore, SubjectConfig, SubjectConfigs, SubjectKey, SubjectType } from "../types/modules"; +import { BaseSubject, Index, IndexItem, Permission, ResourcePermissions, SubjectPermissions } from "../types"; +import { IAccessRequest, IController, IStore, SubjectConfig, SubjectConfigs, SubjectKey, SubjectType } from "../types/modules"; import { Mutex } from "./utils/Mutex"; export class Controller>> extends Mutex implements IController { - private store: IStore + private index: IStore> + private accessRequest: IAccessRequest; private subjectConfigs: SubjectConfigs - constructor(store: IStore, subjects: SubjectConfigs) { + constructor(indexStore: IStore>, accessRequest: IAccessRequest, subjects: SubjectConfigs) { super(); - this.store = store; + this.index = indexStore; + this.accessRequest = accessRequest; this.subjectConfigs = subjects; } @@ -56,12 +58,12 @@ export class Controller> subject: subject, } - const index = await this.store.getCurrentIndex(); + const index = await this.index.getCurrent(); index.items.push(item); } if (!alwaysKeepItem && permissions.length === 0 && manager.shouldDeleteOnAllRevoked()) { - const index = await this.store.getCurrentIndex(); + const index = await this.index.getCurrent(); const idx = index.items.findIndex(i => i.id === item.id); index.items.splice(idx, 1); } else { @@ -78,19 +80,19 @@ export class Controller> } } - await this.store.saveToRemoteIndex(); + await this.index.saveToRemote(); } setPodUrl(podUrl: string) { - this.store.setPodUrl(podUrl); + this.index.setPodUrl(podUrl); } unsetPodUrl() { - this.store.unsetPodUrl(); + this.index.unsetPodUrl(); } async getOrCreateIndex() { - return this.store.getOrCreateIndex(); + return this.index.getOrCreate(); } getLabelForSubject>(subject: T[K]): string { @@ -101,7 +103,7 @@ export class Controller> async getItem>(resourceUrl: string, subject: SubjectType): Promise | undefined> { const { resolver } = this.getSubjectConfig(subject); - const index = await this.store.getCurrentIndex(); + const index = await this.index.getCurrent(); return resolver.getItem(index, resourceUrl, subject.selector) } @@ -130,7 +132,7 @@ export class Controller> await this.updateItem(resourceUrl, subject, []); const subjectConfig = this.getSubjectConfig(subject); - const index = await this.store.getCurrentIndex(); + const index = await this.index.getCurrent(); const item = subjectConfig.resolver.getItem(index, resourceUrl, subject.selector); if (!item) return; @@ -140,7 +142,7 @@ export class Controller> const idx = index.items.findIndex(i => subjectConfig.resolver.checkMatch(i.subject, subject)); index.items.splice(idx, 1); - await this.store.saveToRemoteIndex(); + await this.index.saveToRemote(); } async removePermission>(resourceUrl: string, removedPermission: Permission, subject: SubjectType) { @@ -174,7 +176,7 @@ export class Controller> await manager.createPermissions(resource, subject, item.permissions); item.isEnabled = true; - await this.store.saveToRemoteIndex() + await this.index.saveToRemote() } async disablePermissions>(resourceUrl: string, subject: SubjectType) { @@ -188,14 +190,14 @@ export class Controller> item.isEnabled = false; - await this.store.saveToRemoteIndex() + await this.index.saveToRemote() } async getContainerPermissionList(containerUrl: string): Promise[]> { const configs: SubjectConfig[] = Object.values(this.subjectConfigs); - const index = await this.store.getCurrentIndex(); - const requestAccessResources = await this.store.getCurrentResources(); + const index = await this.index.getCurrentIndex(); + const requestAccessResources = await this.index.getCurrentResources(); const resourcesToSkip = index.items.filter(i => { if (!i.resource.includes(containerUrl)) { return false; @@ -248,7 +250,7 @@ export class Controller> } })); - await this.store.saveToRemoteIndex(); + await this.index.saveToRemoteIndex(); return index.items.reduce[]>((arr, v) => { const resourcePath = v.resource.replace(containerUrl, ""); @@ -282,8 +284,8 @@ export class Controller> async getResourcePermissionList(resourceUrl: string) { // Need to put it in a variable because the type declaration vanishes const configs: SubjectConfig[] = Object.values(this.subjectConfigs); - const index = await this.store.getCurrentIndex(); - const requestAccessResources = await this.store.getCurrentResources(); + const index = await this.index.getCurrent(); + const requestAccessResources = await this.index.getCurrentResources(); const results = await Promise.allSettled(configs.map(c => c.manager.getRemotePermissions(resourceUrl))) let permissionsPerSubject = index.items.filter(i => i.resource === resourceUrl) @@ -310,30 +312,4 @@ export class Controller> }, permissionsPerSubject) } } - - async canRequestAccessToResource(resourceUrl: string) { - const resources = await this.store.getCurrentResources(); - return resources.items.includes(resourceUrl); - } - - async allowAccessRequest(resourceUrl: string) { - const resources = await this.store.getCurrentResources(); - if (resources.items.includes(resourceUrl)) { - return; - } - resources.items.push(resourceUrl); - - await this.store.saveToRemoteResources(); - } - - async disallowAccessRequest(resourceUrl: string) { - const resources = await this.store.getCurrentResources(); - if (!resources.items.includes(resourceUrl)) { - return; - } - const idx = resources.items.indexOf(resourceUrl); - resources.items.splice(idx, 1); - - await this.store.saveToRemoteResources(); - } } diff --git a/controller/src/classes/stores/BaseStore.ts b/controller/src/classes/stores/BaseStore.ts index 0b8e4ae..4036fa6 100644 --- a/controller/src/classes/stores/BaseStore.ts +++ b/controller/src/classes/stores/BaseStore.ts @@ -1,10 +1,11 @@ -import { SubjectKey } from "@/types/modules"; -import { BaseSubject, Index, Resources } from "../../types"; - -export abstract class BaseStore>> { +export abstract class BaseStore { protected podUrl?: string = undefined; - protected index?: Index = undefined; - protected resources?: Resources = undefined; + protected filePath: string; + protected data?: T = undefined; + + constructor(filePath: string) { + this.filePath = filePath + } setPodUrl(url: string): void { this.podUrl = url; @@ -14,21 +15,12 @@ export abstract class BaseStore; - - async getCurrentResources() { - if (!this.resources) { - this.resources = await this.getOrCreateResources(); - } - return this.resources as Resources; - } - - abstract getOrCreateIndex(): Promise>; + abstract getOrCreate(): Promise; - async getCurrentIndex>() { - if (!this.index) { - this.index = await this.getOrCreateIndex(); + async getCurrent() { + if (!this.data) { + this.data = await this.getOrCreate(); } - return this.index as Index; + return this.data; } } diff --git a/controller/src/classes/stores/InruptStore.ts b/controller/src/classes/stores/InruptStore.ts index 2eabfa3..0c06c34 100644 --- a/controller/src/classes/stores/InruptStore.ts +++ b/controller/src/classes/stores/InruptStore.ts @@ -1,23 +1,21 @@ import { FetchError, getFile, overwriteFile, saveFileInContainer, WithResourceInfo } from "@inrupt/solid-client"; -import { BaseSubject, Index, Resources } from "../../types"; import { IStore } from "../../types/modules"; import { BaseStore } from "./BaseStore"; import { getDefaultSession, Session } from "@inrupt/solid-client-authn-browser"; -import { setPublicAccess } from "@inrupt/solid-client/universal"; /** * A store implementation using the inrupt sdk to actually communicate with the pod * The "Inrupt" prefix is to indicate the usage of the inrupt sdk * This store can be used without the the InruptPermissionManager */ -export class InruptStore>> extends BaseStore implements IStore { - // TODO this should be a more resilient path: be.ugent.idlab.knows.solid.loama.index.js or smth - private indexPath = "index.json"; - private resourcesPath = "resources.json"; +export class InruptStore extends BaseStore implements IStore { private session: Session; + private templateGenerator: () => T; - constructor() { - super() + // TODO this should be a more resilient path: be.ugent.idlab.knows.solid.loama.index.js or smth + constructor(filePath: string, templateGenerator: () => T) { + super(filePath) + this.templateGenerator = templateGenerator; this.session = getDefaultSession() } @@ -27,96 +25,50 @@ export class InruptStore }); } - async getOrCreateResources(): Promise { - if (!this.podUrl) { - throw new Error("Cannot get current resources file: pod location is not set"); - } - - if (this.resources) { - return this.resources; - } - - const resourcesPath = `${this.podUrl}${this.resourcesPath}`; - let file: (Blob & WithResourceInfo) | undefined = undefined - try { - file = await getFile(resourcesPath, { fetch: this.session.fetch }) - } catch (error: unknown) { - if (error instanceof FetchError && error.statusCode === 404) { - this.resources = { id: resourcesPath, items: [] } - file = await saveFileInContainer( - this.podUrl, - this.toJsonFile(this.resources, this.resourcesPath), - { fetch: this.session.fetch } - ); - await setPublicAccess(resourcesPath, { read: true }, { fetch: this.session.fetch }); - } - } - - const fileText = await file?.text(); - this.resources = JSON.parse(fileText ?? "{}"); - if (!this.resources) { - throw new Error("Resources not found or invalid"); - } - - return this.resources; - } - // NOTE: Possible will move the podUrl to the parameters, this works for the current POC - async getOrCreateIndex(): Promise> { + async getOrCreate(): Promise { if (!this.podUrl) { throw new Error("Cannot get current index file: pod location is not set"); } - if (this.index) { - return this.index; + if (this.data) { + return this.data; } - const indexUrl = `${this.podUrl}${this.indexPath}`; + const dataUrl = `${this.podUrl}${this.filePath}`; let file: (Blob & WithResourceInfo) | undefined = undefined try { - file = await getFile(indexUrl, { fetch: this.session.fetch }) + file = await getFile(dataUrl, { fetch: this.session.fetch }) } catch (error: unknown) { if (error instanceof FetchError && error.statusCode === 404) { - this.index = { id: indexUrl, items: [] } + this.data = this.templateGenerator(); file = await saveFileInContainer( this.podUrl, - this.toJsonFile(this.index, this.indexPath), + this.toJsonFile(this.data, this.filePath), { fetch: this.session.fetch } ); } } const fileText = await file?.text(); - this.index = JSON.parse(fileText ?? "{}"); - if (!this.index) { - throw new Error("Index not found or invalid"); + this.data = JSON.parse(fileText ?? "{}"); + if (!this.data) { + throw new Error(`Store data(${this.filePath}) not found or invalid`); } - return this.index; - } - - async saveToRemoteIndex() { - if (!this.index) { - await this.getOrCreateIndex(); - } - if (!this.index) { - throw new Error("Index not found or invalid"); - } - - overwriteFile(this.index.id, this.toJsonFile(this.index, this.indexPath), { - fetch: this.session.fetch, - }); + return this.data; } - async saveToRemoteResources() { - if (!this.resources) { - await this.getOrCreateResources(); + async saveToRemote() { + if (!this.data) { + await this.getOrCreate(); } - if (!this.resources) { - throw new Error("Resources not found or invalid"); + if (!this.data) { + throw new Error(`Store data(${this.filePath}) not found or invalid`); } - overwriteFile(this.resources.id, this.toJsonFile(this.resources, this.resourcesPath), { + // NOTE: the fileUrl was stored in the file, do we want to enforce our generic to atleast have this id property available? + overwriteFile(`${this.podUrl}${this.filePath}`, this.toJsonFile(this.data, this.filePath), { fetch: this.session.fetch, }); } diff --git a/controller/src/controllers.ts b/controller/src/controllers.ts index ff98ee5..1465d23 100644 --- a/controller/src/controllers.ts +++ b/controller/src/controllers.ts @@ -1,3 +1,4 @@ +import { AccessRequest } from "./classes/AccessRequest"; import { Controller } from "./classes/Controller"; import { PublicManager } from "./classes/permissionManager/inrupt/PublicManager"; import { WebIdManager } from "./classes/permissionManager/inrupt/WebIdManager"; @@ -10,7 +11,8 @@ export const activeController = new Controller<{ webId: WebIdSubject, public: PublicSubject, }>( - new InruptStore(), + new InruptStore("index.json", () => ({ id: "", items: [] })), + new AccessRequest(new InruptStore("resources.json", () => ({ id: "", items: [] }))), { webId: { resolver: new WebIdResolver(), @@ -28,7 +30,8 @@ export const createBasicController = () => { webId: WebIdSubject, public: PublicSubject, }>( - new InruptStore(), + new InruptStore("index.json", () => ({ id: "", items: [] })), + new AccessRequest(new InruptStore("resources.json", () => ({ id: "", items: [] }))), { webId: { resolver: new WebIdResolver(), diff --git a/controller/src/types/modules.ts b/controller/src/types/modules.ts index 24720ad..3b4bfbd 100644 --- a/controller/src/types/modules.ts +++ b/controller/src/types/modules.ts @@ -30,13 +30,15 @@ export interface IController[]> getResourcePermissionList(resourceUrl: string): Promise> +} +export interface IAccessRequest { canRequestAccessToResource(resourceUrl: string): Promise allowAccessRequest(resourceUrl: string): Promise disallowAccessRequest(resourceUrl: string): Promise } -export interface IStore>> { +export interface IStore { /** * Implemented by BaseStore * Will set the protected pod url property @@ -47,32 +49,18 @@ export interface IStore> */ unsetPodUrl(): void; /** - * Returns the currently stored index or calls getOrCreateIndex if the index is not set - */ - getCurrentIndex>(): Promise>; - - /** - * Tries to retrieve the stored index.json from the pod. If it doesn't exist, it creates an empty one. - */ - getOrCreateIndex(): Promise; - /** - * Saves the index to the pod - */ - saveToRemoteIndex(): Promise; - - /** - * Returns the currently stored index or calls getOrCreateIndex if the index is not set + * Returns the currently stored data or calls getOrCreate if the data is not set */ - getCurrentResources(): Promise; + getCurrent(): Promise; /** - * Tries to retrieve the stored index.json from the pod. If it doesn't exist, it creates an empty one. + * Tries to retrieve the stored file from the pod. If it doesn't exist, it creates an empty one. */ - getOrCreateResources(): Promise; + getOrCreate(): Promise; /** - * Saves the index to the pod + * Saves the data to the pod */ - saveToRemoteResources(): Promise; + saveToRemote(): Promise; } export interface ISubjectResolver> { From bae195027432ce4b0df79c14634f4458f63e2f39 Mon Sep 17 00:00:00 2001 From: NuttyShrimp Date: Mon, 14 Oct 2024 17:00:59 +0200 Subject: [PATCH 06/35] refactor(controller): move request logic to seperate class --- controller/src/classes/AccessRequest.ts | 36 +++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 controller/src/classes/AccessRequest.ts diff --git a/controller/src/classes/AccessRequest.ts b/controller/src/classes/AccessRequest.ts new file mode 100644 index 0000000..d500aae --- /dev/null +++ b/controller/src/classes/AccessRequest.ts @@ -0,0 +1,36 @@ +import { Resources } from "@/types"; +import { IAccessRequest, IStore } from "@/types/modules"; + +export class AccessRequest implements IAccessRequest { + private resources: IStore; + + constructor(resources: IStore) { + this.resources = resources; + } + + async canRequestAccessToResource(resourceUrl: string) { + const resources = await this.resources.getCurrent(); + return resources.items.includes(resourceUrl); + } + + async allowAccessRequest(resourceUrl: string) { + const resources = await this.resources.getCurrent(); + if (resources.items.includes(resourceUrl)) { + return; + } + resources.items.push(resourceUrl); + + await this.resources.saveToRemote(); + } + + async disallowAccessRequest(resourceUrl: string) { + const resources = await this.resources.getCurrent(); + if (!resources.items.includes(resourceUrl)) { + return; + } + const idx = resources.items.indexOf(resourceUrl); + resources.items.splice(idx, 1); + + await this.resources.saveToRemote(); + } +} From ffd2523c16e390f7317c70b23ac7c0b8cf3d24e6 Mon Sep 17 00:00:00 2001 From: NuttyShrimp Date: Fri, 18 Oct 2024 09:25:11 +0200 Subject: [PATCH 07/35] fix: update loama to match changes of previous commit --- controller/src/classes/Controller.ts | 36 +++++++++++-------- controller/src/controllers.ts | 4 +-- controller/src/types/modules.ts | 1 + .../src/components/explorer/SelectedEntry.vue | 4 +-- loama/src/lib/state.ts | 2 +- 5 files changed, 28 insertions(+), 19 deletions(-) diff --git a/controller/src/classes/Controller.ts b/controller/src/classes/Controller.ts index 68e94de..80963ef 100644 --- a/controller/src/classes/Controller.ts +++ b/controller/src/classes/Controller.ts @@ -1,16 +1,19 @@ -import { BaseSubject, Index, IndexItem, Permission, ResourcePermissions, SubjectPermissions } from "../types"; +import { BaseSubject, Index, IndexItem, Permission, ResourcePermissions, Resources, SubjectPermissions } from "../types"; import { IAccessRequest, IController, IStore, SubjectConfig, SubjectConfigs, SubjectKey, SubjectType } from "../types/modules"; +import { AccessRequest } from "./AccessRequest"; import { Mutex } from "./utils/Mutex"; export class Controller>> extends Mutex implements IController { private index: IStore> + private resources: IStore private accessRequest: IAccessRequest; private subjectConfigs: SubjectConfigs - constructor(indexStore: IStore>, accessRequest: IAccessRequest, subjects: SubjectConfigs) { + constructor(indexStore: IStore>, resourcesStore: IStore, subjects: SubjectConfigs) { super(); this.index = indexStore; - this.accessRequest = accessRequest; + this.resources = resourcesStore; + this.accessRequest = new AccessRequest(resourcesStore); this.subjectConfigs = subjects; } @@ -83,12 +86,18 @@ export class Controller> await this.index.saveToRemote(); } + AccessRequest(): IAccessRequest { + return this.accessRequest; + } + setPodUrl(podUrl: string) { this.index.setPodUrl(podUrl); + this.resources.setPodUrl(podUrl); } unsetPodUrl() { this.index.unsetPodUrl(); + this.resources.unsetPodUrl(); } async getOrCreateIndex() { @@ -103,7 +112,7 @@ export class Controller> async getItem>(resourceUrl: string, subject: SubjectType): Promise | undefined> { const { resolver } = this.getSubjectConfig(subject); - const index = await this.index.getCurrent(); + const index = await this.index.getCurrent() as Index; return resolver.getItem(index, resourceUrl, subject.selector) } @@ -132,7 +141,7 @@ export class Controller> await this.updateItem(resourceUrl, subject, []); const subjectConfig = this.getSubjectConfig(subject); - const index = await this.index.getCurrent(); + const index = await this.index.getCurrent() as Index; const item = subjectConfig.resolver.getItem(index, resourceUrl, subject.selector); if (!item) return; @@ -197,7 +206,6 @@ export class Controller> const configs: SubjectConfig[] = Object.values(this.subjectConfigs); const index = await this.index.getCurrentIndex(); - const requestAccessResources = await this.index.getCurrentResources(); const resourcesToSkip = index.items.filter(i => { if (!i.resource.includes(containerUrl)) { return false; @@ -252,13 +260,14 @@ export class Controller> await this.index.saveToRemoteIndex(); - return index.items.reduce[]>((arr, v) => { + return await index.items.reduce[]>>(async (arr, v) => { const resourcePath = v.resource.replace(containerUrl, ""); const amountOfSlashes = resourcePath.replace(/[^\/]/g, "").length; if ((amountOfSlashes == 1 && !resourcePath.endsWith("/")) || resourcePath.startsWith("/") || amountOfSlashes > 1) { return arr; } - let existingInfo = arr.find((info) => info.resourceUrl === v.resource); + let indexItems = await arr; + let existingInfo = indexItems.find((info) => info.resourceUrl === v.resource); if (existingInfo) { existingInfo.permissionsPerSubject.push({ permissions: v.permissions, @@ -266,9 +275,9 @@ export class Controller> isEnabled: v.isEnabled, }) } else { - arr.push({ + indexItems.push({ resourceUrl: v.resource, - canRequestAccess: requestAccessResources.items.includes(v.resource), + canRequestAccess: await this.accessRequest.canRequestAccessToResource(v.resource), permissionsPerSubject: [{ permissions: v.permissions, subject: v.subject, @@ -276,8 +285,8 @@ export class Controller> }] }) } - return arr; - }, []); + return indexItems; + }, Promise.resolve([])); } // NOTE: Do we want to force this to only use the index stored in the store? @@ -285,14 +294,13 @@ export class Controller> // Need to put it in a variable because the type declaration vanishes const configs: SubjectConfig[] = Object.values(this.subjectConfigs); const index = await this.index.getCurrent(); - const requestAccessResources = await this.index.getCurrentResources(); const results = await Promise.allSettled(configs.map(c => c.manager.getRemotePermissions(resourceUrl))) let permissionsPerSubject = index.items.filter(i => i.resource === resourceUrl) return { resourceUrl, - canRequestAccess: requestAccessResources.items.includes(resourceUrl), + canRequestAccess: await this.accessRequest.canRequestAccessToResource(resourceUrl), permissionsPerSubject: results.reduce[]>((arr, v) => { if (v.status === "fulfilled") { v.value.forEach(remotePps => { diff --git a/controller/src/controllers.ts b/controller/src/controllers.ts index 1465d23..aa6f440 100644 --- a/controller/src/controllers.ts +++ b/controller/src/controllers.ts @@ -12,7 +12,7 @@ export const activeController = new Controller<{ public: PublicSubject, }>( new InruptStore("index.json", () => ({ id: "", items: [] })), - new AccessRequest(new InruptStore("resources.json", () => ({ id: "", items: [] }))), + new InruptStore("resources.json", () => ({ id: "", items: [] })), { webId: { resolver: new WebIdResolver(), @@ -31,7 +31,7 @@ export const createBasicController = () => { public: PublicSubject, }>( new InruptStore("index.json", () => ({ id: "", items: [] })), - new AccessRequest(new InruptStore("resources.json", () => ({ id: "", items: [] }))), + new InruptStore("resources.json", () => ({ id: "", items: [] })), { webId: { resolver: new WebIdResolver(), diff --git a/controller/src/types/modules.ts b/controller/src/types/modules.ts index 3b4bfbd..d8ab0af 100644 --- a/controller/src/types/modules.ts +++ b/controller/src/types/modules.ts @@ -11,6 +11,7 @@ export type SubjectConfigs>> { setPodUrl(podUrl: string): void; unsetPodUrl(podUrl: string): void; + AccessRequest(): IAccessRequest; getLabelForSubject>(subject: T[K]): string; getOrCreateIndex(): Promise; getItem>(resourceUrl: string, subject: SubjectType): Promise | undefined>; diff --git a/loama/src/components/explorer/SelectedEntry.vue b/loama/src/components/explorer/SelectedEntry.vue index 10d0a46..8d256c8 100644 --- a/loama/src/components/explorer/SelectedEntry.vue +++ b/loama/src/components/explorer/SelectedEntry.vue @@ -52,9 +52,9 @@ const handleSubjectRequestAccess = (canRequest: boolean) => { throw new Error('No entry selected, this should not be possible'); } if (canRequest) { - activeController.allowAccessRequest(podStore.selectedEntry.resourceUrl) + activeController.AccessRequest().allowAccessRequest(podStore.selectedEntry.resourceUrl) } else { - activeController.disallowAccessRequest(podStore.selectedEntry.resourceUrl) + activeController.AccessRequest().disallowAccessRequest(podStore.selectedEntry.resourceUrl) } podStore.refreshRequestAccessAllowance(); diff --git a/loama/src/lib/state.ts b/loama/src/lib/state.ts index eaee513..1e4fd60 100644 --- a/loama/src/lib/state.ts +++ b/loama/src/lib/state.ts @@ -57,7 +57,7 @@ export const usePodStore = defineStore("pod", { if (!this.selectedEntry) { throw new Error('No selected entry to update permissions for'); } - this.selectedEntry.canRequestAccess = await activeController.canRequestAccessToResource(this.selectedEntry.resourceUrl); + this.selectedEntry.canRequestAccess = await activeController.AccessRequest().canRequestAccessToResource(this.selectedEntry.resourceUrl); } } }) From 0b0d84efebe7509cc1d0c15f5618039d6a9a2353 Mon Sep 17 00:00:00 2001 From: NuttyShrimp Date: Fri, 18 Oct 2024 14:34:11 +0200 Subject: [PATCH 08/35] feat: get data as tree + transform into usable data for library --- controller/src/classes/AccessRequest.ts | 34 ++++++++++++++++++- controller/src/types/index.ts | 6 ++++ controller/src/types/modules.ts | 6 +++- loama/src/lib/utils.ts | 14 ++++++++ loama/src/views/RequestView.vue | 43 +++++++++++++++++-------- 5 files changed, 88 insertions(+), 15 deletions(-) diff --git a/controller/src/classes/AccessRequest.ts b/controller/src/classes/AccessRequest.ts index d500aae..3c9a279 100644 --- a/controller/src/classes/AccessRequest.ts +++ b/controller/src/classes/AccessRequest.ts @@ -1,4 +1,4 @@ -import { Resources } from "@/types"; +import { ResourceAccessRequestNode, Resources } from "@/types"; import { IAccessRequest, IStore } from "@/types/modules"; export class AccessRequest implements IAccessRequest { @@ -8,6 +8,38 @@ export class AccessRequest implements IAccessRequest { this.resources = resources; } + async getRequestableResources(containerUrl: string) { + const requestableResources = await this.resources.getCurrent(); + const filteredRequestableResources = requestableResources.items.filter(item => item.startsWith(containerUrl) && item !== containerUrl); + let masterNode: ResourceAccessRequestNode = { + resourceUrl: containerUrl, + canRequestAccess: requestableResources.items.includes(containerUrl), + children: {}, + }; + + filteredRequestableResources.forEach(resource => { + const pathParts = resource.replace(containerUrl, "").split('/'); + pathParts.reduce(function(parentNode, pathPart, index) { + if (pathPart == "") { + return parentNode; + } + if (!parentNode.children) { + parentNode.children = {}; + } + if (parentNode.children[pathPart]) { + parentNode.children[pathPart].canRequestAccess = pathParts.length === index; + } + return parentNode.children[pathPart] || (parentNode.children[pathPart] = { + resourceUrl: `${parentNode.resourceUrl}${parentNode.resourceUrl.endsWith("/") ? "" : "/"}${pathPart}`, + canRequestAccess: (pathParts.length - 1) === index, + children: {}, + }); + }, masterNode) + }) + + return masterNode; + } + async canRequestAccessToResource(resourceUrl: string) { const resources = await this.resources.getCurrent(); return resources.items.includes(resourceUrl); diff --git a/controller/src/types/index.ts b/controller/src/types/index.ts index efdf116..91ba297 100644 --- a/controller/src/types/index.ts +++ b/controller/src/types/index.ts @@ -47,3 +47,9 @@ export interface ResourcePermissions> { canRequestAccess: boolean; permissionsPerSubject: SubjectPermissions[] } + +export interface ResourceAccessRequestNode { + resourceUrl: url; + canRequestAccess: boolean; + children?: Record; +} diff --git a/controller/src/types/modules.ts b/controller/src/types/modules.ts index d8ab0af..4bc70ec 100644 --- a/controller/src/types/modules.ts +++ b/controller/src/types/modules.ts @@ -1,4 +1,4 @@ -import { BaseSubject, Index, IndexItem, Permission, ResourcePermissions, Resources, SubjectPermissions } from "../types"; +import { BaseSubject, Index, IndexItem, Permission, ResourceAccessRequestNode, ResourcePermissions, Resources, SubjectPermissions } from "../types"; export type SubjectKey = keyof T & string; export type SubjectType> = T[K]; @@ -34,6 +34,10 @@ export interface IController canRequestAccessToResource(resourceUrl: string): Promise allowAccessRequest(resourceUrl: string): Promise disallowAccessRequest(resourceUrl: string): Promise diff --git a/loama/src/lib/utils.ts b/loama/src/lib/utils.ts index 15e166f..55d0bed 100644 --- a/loama/src/lib/utils.ts +++ b/loama/src/lib/utils.ts @@ -3,3 +3,17 @@ export const uriToName = (uri: string, isContainer: boolean) => { return isContainer ? splitted[splitted.length - 2] : splitted[splitted.length - 1]; } + +export const debounce = (fn: Function, wait: number) => { + let timer: NodeJS.Timeout; + return function(...args: any[]) { + if (timer) { + clearTimeout(timer); // clear any pre-existing timer + } + // @ts-expect-error this is the current context + const context = this; // get the current context + timer = setTimeout(() => { + fn.apply(context, args); // call the function if time expires + }, wait); + } +} diff --git a/loama/src/views/RequestView.vue b/loama/src/views/RequestView.vue index 0c7f859..9236790 100644 --- a/loama/src/views/RequestView.vue +++ b/loama/src/views/RequestView.vue @@ -4,19 +4,22 @@