solid-logic 1.3.17-f7bdc345 → 2.0.0

package/src/logic/SolidLogic.ts

@@ -1,259 +0,0 @@
-import { Session } from "@inrupt/solid-client-authn-browser";
-import * as rdf from "rdflib";
-import { NamedNode, Statement, LiveStore } from "rdflib";
-import solidNamespace from "solid-namespace";
-import { SolidAuthnLogic } from "../authn/SolidAuthnLogic";
-import { ChatLogic } from "../chat/ChatLogic";
-import { ProfileLogic } from "../profile/ProfileLogic";
-import { AuthnLogic, SolidNamespace } from "../types";
-import * as debug from "../util/debug";
-import { UtilityLogic } from "../util/UtilityLogic";
-import { CrossOriginForbiddenError, FetchError, NotFoundError, SameOriginForbiddenError, UnauthorizedError } from "./CustomError";
-/*
-** It is important to distinquish `fetch`, a function provided by the browser
-** and `Fetcher`, a helper object for the rdflib Store which turns it
-** into a `ConnectedStore` or a `LiveStore`.  A Fetcher object is
-** available at store.fetcher, and `fetch` function at `store.fetcher._fetch`,
-*/
-
-const ns: SolidNamespace = solidNamespace(rdf);
-
-export class SolidLogic {
-    cache: {
-        profileDocument: {
-        [WebID: string]: NamedNode;
-        };
-        preferencesFile: {
-        [WebID: string]: NamedNode;
-        };
-    };
-
-    store: LiveStore;
-    me: string | undefined;
-    chat: ChatLogic;
-    profile: ProfileLogic;
-    authn: AuthnLogic;
-    util: UtilityLogic;
-
-    constructor(specialFetch: { fetch: (url: any, requestInit: any) => any }, session: Session) {
-  // would xpect to be able to do it this way: but get TypeError:  Failed to execute 'fetch' on 'Window': Illegal invocation status: 999
-        // this.store = new rdf.LiveStore({})
-        // this.store.fetcher._fetch = fetch
-        console.log("SolidLogic: Unique instance created.  There should only be one of these.")
-        this.store = rdf.graph() as LiveStore; // Make a Quad store
-        rdf.fetcher(this.store, { fetch: specialFetch.fetch}); // Attach a web I/O module, store.fetcher
-        this.store.updater = new rdf.UpdateManager(this.store); // Add real-time live updates store.updater
-
-        this.store.features = [] // disable automatic node merging on store load
-        this.cache = {
-        profileDocument: {},
-        preferencesFile: {},
-        };
-        this.authn = new SolidAuthnLogic(session);
-        debug.log('SolidAuthnLogic initialized')
-        this.profile = new ProfileLogic(this.store, ns, this.authn);
-        this.chat = new ChatLogic(this.store, ns, this.profile);
-        this.util = new UtilityLogic(this.store, ns);
-    }
-
-    findAclDocUrl(url: string) {
-        return this.util.findAclDocUrl(url);
-    }
-
-    async loadProfile(me: NamedNode): Promise<NamedNode> {
-        /*
-      // console.log('loadProfile cache ', this.cache)
-        if (this.cache.profileDocument[me.value]) {
-        return this.cache.profileDocument[me.value];
-      }    @@ just use the cache in the store
-        */
-        console.log('loadProfile  me ', me)
-        const profileDocument = me.doc()
-        try {
-          await this.store.fetcher.load(profileDocument);
-          return profileDocument;
-        } catch (err) {
-        const message = `Cannot load profile ${profileDocument} : ${err}`;
-        throw new Error(message);
-        }
-    }
-
-    async loadPreferences(me: NamedNode): Promise<NamedNode> {
-        console.log('loadPreferences cache ', this.cache)
-        if (this.cache.preferencesFile[me.value]) {
-        return this.cache.preferencesFile[me.value];
-        }
-        await this.loadProfile(me) // Load pointer to pref file
-        const preferencesFile = this.store.any(me, ns.space('preferencesFile'), null, me.doc());
-
-        // console.log('this.store.any()', this.store.any())
-        /**
-         * Are we working cross-origin?
-         * Returns True if we are in a webapp at an origin, and the file origin is different
-         */
-        function differentOrigin(): boolean {
-        if (!preferencesFile) {
-            return true;
-        }
-        return (
-            `${window.location.origin}/` !== new URL(preferencesFile.value).origin
-        );
-        }
-
-        if (!preferencesFile) {
-        throw new Error(
-            `Can't find a preference file pointer in profile ${me.doc()}`
-        );
-        }
-
-        // //// Load preference file
-        try {
-        await this.store.fetcher.load(preferencesFile as NamedNode, {
-            withCredentials: true,
-        });
-        } catch (err) {
-        // Really important to look at why
-        const status = err.status;
-        debug.log(`HTTP status ${status} for preference file ${preferencesFile}`);
-        if (status === 401) {
-            throw new UnauthorizedError();
-        }
-        if (status === 403) {
-            if (differentOrigin()) {
-            throw new CrossOriginForbiddenError();
-            }
-            throw new SameOriginForbiddenError();
-        }
-        if (status === 404) {
-            throw new NotFoundError(preferencesFile.value);
-        }
-        throw new FetchError(err.status, err.message);
-        }
-        return preferencesFile as NamedNode;
-    }
-
-    getTypeIndex(
-        me: NamedNode | string,
-        preferencesFile: NamedNode | string,
-        isPublic: boolean
-    ): NamedNode[] {
-        // console.log('getTypeIndex', this.store.each(me, undefined, undefined, preferencesFile), isPublic, preferencesFile)
-        return this.store.each(
-        me as NamedNode,
-        isPublic ? ns.solid("publicTypeIndex") : ns.solid("privateTypeIndex"),
-        undefined,
-        preferencesFile as NamedNode
-        ) as NamedNode[];
-    }
-
-    getRegistrations(instance, theClass) {
-        return this.store
-        .each(undefined, ns.solid("instance"), instance)
-        .filter((r) => {
-            return this.store.holds(r, ns.solid("forClass"), theClass);
-        });
-    }
-
-    load(doc: NamedNode | NamedNode[] | string) {
-        return this.store.fetcher.load(doc);
-    }
-
-    async loadIndexes(
-        me: NamedNode | string,
-        publicProfile: NamedNode | string | null,
-        preferencesFile: NamedNode | string | null,
-        onWarning = async (_err: Error) => {
-            return undefined;
-        }
-    ): Promise<{
-        private: any;
-        public: any;
-    }> {
-        let privateIndexes: any[] = [];
-        let publicIndexes: any[] = [];
-        if (publicProfile) {
-        publicIndexes = this.getTypeIndex(me, publicProfile, true);
-        try {
-            await this.load(publicIndexes as NamedNode[]);
-        } catch (err) {
-            onWarning(new Error(`loadIndex: loading public type index(es) ${err}`));
-        }
-        }
-        if (preferencesFile) {
-        privateIndexes = this.getTypeIndex(me, preferencesFile, false);
-        // console.log({ privateIndexes })
-        if (privateIndexes.length === 0) {
-            await onWarning(
-            new Error(
-                `Your preference file ${preferencesFile} does not point to a private type index.`
-            )
-            );
-        } else {
-            try {
-            await this.load(privateIndexes);
-            } catch (err) {
-            onWarning(
-                new Error(`loadIndex: loading private type index(es) ${err}`)
-            );
-            }
-        }
-        // } else {
-        //   debug.log(
-        //     'We know your preference file is not available, so we are not bothering with private type indexes.'
-        //   )
-        }
-
-        return {
-        private: privateIndexes,
-        public: publicIndexes,
-        };
-    }
-
-    async createEmptyRdfDoc(doc: NamedNode, comment: string) {
-        await this.store.fetcher.webOperation("PUT", doc.uri, {
-        data: `# ${new Date()} ${comment}
-    `,
-        contentType: "text/turtle",
-        });
-    }
-
-    // @@@@ use the one in rdflib.js when it is available and delete this
-    updatePromise(
-        del: Array<Statement>,
-        ins: Array<Statement> = []
-    ): Promise<void> {
-        return new Promise((resolve, reject) => {
-        this.store.updater.update(del, ins, function (_uri, ok, errorBody) {
-            if (!ok) {
-            reject(new Error(errorBody));
-            } else {
-            resolve();
-            }
-        }); // callback
-        }); // promise
-    }
-
-    isContainer(url: string) {
-        return this.util.isContainer(url);
-    }
-
-    getContainerElements(containerNode: NamedNode): NamedNode[] {
-        return this.util.getContainerElements(containerNode);
-    }
-
-    getContainerMembers(containerUrl: string): Promise<string[]> {
-        return this.util.getContainerMembers(containerUrl);
-    }
-
-    async recursiveDelete(url: string) {
-        return this.util.recursiveDelete(url);
-    }
-
-    clearStore() {
-        return this.util.clearStore();
-    }
-
-    async fetch(url: string, options?: any) {
-        return this.store.fetcher._fetch(url, options);
-    }
-}

package/src/profile/ProfileLogic.ts

@@ -1,44 +0,0 @@
-import { NamedNode, LiveStore } from "rdflib";
-import { AuthnLogic, SolidNamespace } from "../types";
-
-export class ProfileLogic {
-  store: LiveStore;
-  ns: SolidNamespace;
-  authn: AuthnLogic;
-
-  constructor(store: LiveStore, ns: SolidNamespace, authn: AuthnLogic) {
-    this.store = store;
-    this.ns = ns;
-    this.authn = authn;
-  }
-
-  async loadMe(): Promise<NamedNode> {
-    const me = this.authn.currentUser();
-    if (me === null) {
-      throw new Error("Current user not found! Not logged in?");
-    }
-    await this.store.fetcher?.load(me.doc());
-    return me;
-  }
-
-  getPodRoot(user: NamedNode): NamedNode {
-    const podRoot = this.findStorage(user);
-    if (!podRoot) {
-      throw new Error("User pod root not found!");
-    }
-    return podRoot as NamedNode;
-  }
-
-  async getMainInbox(user: NamedNode): Promise<NamedNode> {
-    await this.store.fetcher?.load(user);
-    const mainInbox = this.store.any(user, this.ns.ldp("inbox"), undefined, user.doc());
-    if (!mainInbox) {
-      throw new Error("User main inbox not found!");
-    }
-    return mainInbox as NamedNode;
-  }
-
-  private findStorage(me: NamedNode) {
-    return this.store.any(me, this.ns.space("storage"), undefined, me.doc());
-  }
-}

package/src/util/UtilityLogic.ts

@@ -1,144 +0,0 @@
-import { NamedNode, Statement, sym, LiveStore } from "rdflib";
-import { SolidNamespace } from "../types";
-
-export const ACL_LINK = sym(
-  "http://www.iana.org/assignments/link-relations/acl"
-);
-
-/**
- * Utility-related logic
- */
-export class UtilityLogic {
-  store: LiveStore;
-  ns: SolidNamespace;
-
-  constructor(store: LiveStore, ns: SolidNamespace) {
-    this.store = store;
-    this.ns = ns;
-  }
-
-  async findAclDocUrl(url: string) {
-    const doc = this.store.sym(url);
-    await this.store.fetcher?.load(doc);
-    const docNode = this.store.any(doc, ACL_LINK);
-    if (!docNode) {
-      throw new Error(`No ACL link discovered for ${url}`);
-    }
-    return docNode.value;
-  }
-
-  // Copied from https://github.com/solidos/web-access-control-tests/blob/v3.0.0/test/surface/delete.test.ts#L5
-  async setSinglePeerAccess(options: {
-    ownerWebId: string,
-    peerWebId: string,
-    accessToModes?: string,
-    defaultModes?: string,
-    target: string
-  }) {
-    let str = [
-      '@prefix acl: <http://www.w3.org/ns/auth/acl#>.',
-      '',
-      `<#alice> a acl:Authorization;\n  acl:agent <${options.ownerWebId}>;`,
-      `  acl:accessTo <${options.target}>;`,
-      `  acl:default <${options.target}>;`,
-      '  acl:mode acl:Read, acl:Write, acl:Control.',
-      ''
-    ].join('\n')
-    if (options.accessToModes) {
-      str += [
-        '<#bobAccessTo> a acl:Authorization;',
-        `  acl:agent <${options.peerWebId}>;`,
-        `  acl:accessTo <${options.target}>;`,
-        `  acl:mode ${options.accessToModes}.`,
-        ''
-      ].join('\n')
-    }
-    if (options.defaultModes) {
-      str += [
-        '<#bobDefault> a acl:Authorization;',
-        `  acl:agent <${options.peerWebId}>;`,
-        `  acl:default <${options.target}>;`,
-        `  acl:mode ${options.defaultModes}.`,
-        ''
-      ].join('\n')
-    }
-    const aclDocUrl = await this.findAclDocUrl(options.target);
-    return this.store.fetcher._fetch(aclDocUrl, {
-      method: 'PUT',
-      body: str,
-      headers: [
-        [ 'Content-Type', 'text/turtle' ]
-      ]
-    });
-  }
-
-  isContainer(url: string) {
-    return url.charAt(url.length-1) === "/";
-  }
-
-  async createContainer(url: string) {
-    if (!this.isContainer(url)) {
-      throw new Error(`Not a container URL ${url}`);
-    }
-    // Copied from https://github.com/solidos/solid-crud-tests/blob/v3.1.0/test/surface/create-container.test.ts#L56-L64
-    const result = await this.store.fetcher._fetch(url, {
-      method: "PUT",
-      headers: {
-        "Content-Type": "text/turtle",
-        "If-None-Match": "*",
-        Link: '<http://www.w3.org/ns/ldp#BasicContainer>; rel="type"', // See https://github.com/solidos/node-solid-server/issues/1465
-      },
-      body: " ", // work around https://github.com/michielbdejong/community-server/issues/4#issuecomment-776222863
-    });
-    if (result.status.toString()[0] !== '2') {
-      throw new Error(`Not OK: got ${result.status} response while creating container at ${url}`);
-    }
-  }
-
-  getContainerElements(containerNode: NamedNode): NamedNode[] {
-    return this.store
-      .statementsMatching(
-        containerNode,
-        this.store.sym("http://www.w3.org/ns/ldp#contains"),
-        undefined,
-        containerNode.doc()
-      )
-      .map((st: Statement) => st.object as NamedNode);
-  }
-
-  async getContainerMembers(containerUrl: string): Promise<string[]> {
-    const containerNode = this.store.sym(containerUrl);
-    await this.store.fetcher?.load(containerNode);
-    const nodes = this.getContainerElements(containerNode);
-    return nodes.map(node => node.value);
-  }
-
-  async recursiveDelete(url: string) {
-    try {
-      if (this.isContainer(url)) {
-        const aclDocUrl = await this.findAclDocUrl(url);
-        await this.store.fetcher._fetch(aclDocUrl, { method: "DELETE" });
-        const containerMembers = await this.getContainerMembers(url);
-        await Promise.all(
-          containerMembers.map((url) => this.recursiveDelete(url))
-        );
-      }
-      return this.store.fetcher._fetch(url, { method: "DELETE" });
-    } catch (e) {
-      // console.log(`Please manually remove ${url} from your system under test.`, e);
-    }
-  }
-
-  clearStore() {
-    this.store.statements.slice().forEach(this.store.remove.bind(this.store));
-  }
-
-  getArchiveUrl(baseUrl: string, date: Date) {
-    const year = date.getUTCFullYear();
-    const month = ('0' + (date.getUTCMonth()+1)).slice(-2);
-    const day = ('0' + (date.getUTCDate())).slice(-2);
-    const parts = baseUrl.split('/');
-    const filename = parts[parts.length -1 ];
-    return new URL(`./archive/${year}/${month}/${day}/${filename}`, baseUrl).toString();
-  }
-}

package/src/util/uri.ts

@@ -1,5 +0,0 @@
-import { NamedNode, sym } from "rdflib";
-
-export function newThing(doc: NamedNode): NamedNode {
-  return sym(doc.uri + "#" + "id" + ("" + Date.now()));
-}