solid-logic 1.3.17-9d25ceb7 → 1.3.17-a27c1702

package/src/discovery/discoveryLogic.ts

@@ -1,288 +0,0 @@
-import * as $rdf from 'rdflib'
-import { LiveStore, NamedNode, st, sym } from 'rdflib'
-import solidNamespace from 'solid-namespace'
-import { solidLogicSingleton } from '../logic/solidLogicSingleton'
-import { newThing } from '../util/uri'
-
-const { authn } = solidLogicSingleton
-const { currentUser } = authn
-const ns = solidNamespace($rdf)
-
-type TypeIndexScope = { label: string, index: NamedNode, agent: NamedNode }
-type ScopedApp = { instance: NamedNode, scope: TypeIndexScope }
-
-/**
- * Create a resource if it really does not exist
- * Be absolutely sure something does not exist before creating a new empty file
- * as otherwise existing could  be deleted.
- * @param doc {NamedNode} - The resource
- */
-export async function loadOrCreateIfNotExists (store: LiveStore, doc: NamedNode) {
-  let response
-  // console.log('@@ loadOrCreateIfNotExists doc ', doc)
-  try {
-    response = await store.fetcher.load(doc)
-  } catch (err) {
-      if (err.response.status === 404) {
-        // console.log('createIfNotExists doc does NOT exist, will create: ' + doc)
-        try {
-          store.fetcher.webOperation('PUT', doc, {data: '', contentType: 'text/turtle'})
-        } catch (err) {
-          const msg = 'createIfNotExists: PUT FAILED: ' + doc + ': ' + err
-          // console.log(msg)
-          throw new Error(msg)
-        }
-        delete store.fetcher.requested[doc.uri] // delete cached 404 error
-        // console.log('createIfNotExists doc created ok ' + doc)
-      } else {
-        const msg =  'createIfNotExists doc load error NOT 404:  ' + doc + ': ' + err
-        // console.log(msg)
-        throw new Error(msg) // @@ add nested errors
-      }
-  }
-  // console.log('createIfNotExists doc exists, all good ' + doc)
-  return response
-}
-
-export function suggestPreferencesFile (me:NamedNode) {
-  const stripped = me.uri.replace('/profile/', '/').replace('/public/', '/')
-  // const stripped = me.uri.replace(\/[p|P]rofile/\g, '/').replace(\/[p|P]ublic/\g, '/')
-  const folderURI = stripped.split('/').slice(0,-1).join('/') + '/Settings/'
-  const fileURI = folderURI + 'Preferences.ttl'
-  return sym(fileURI)
-}
-
-export function suggestPublicTypeIndex (me:NamedNode) {
-  return sym(me.doc().dir()?.uri + 'publicTypeIndex.ttl')
-}
-// Note this one is based off the pref file not the profile
-
-export function suggestPrivateTypeIndex (preferencesFile:NamedNode) {
-  return sym(preferencesFile.doc().dir()?.uri + 'privateTypeIndex.ttl')
-}
-
-/* Follow link from this doc to another thing, or else make a new link
-**
-** return: null no ld one and failed to make a new one
-*/
-export async function followOrCreateLink(store: LiveStore, subject: NamedNode, predicate: NamedNode,
-  object: NamedNode, doc:NamedNode):Promise<NamedNode | null> {
-  await store.fetcher.load(doc)
-  const result = store.any(subject, predicate, null, doc)
-  // console.log('@@ followOrCreateLink result ', result)
-
-  if (result) return result as NamedNode
-  if (!store.updater.editable(doc)) {
-    // console.log(`followOrCreateLink:  Can't modify ${doc} so can't make new link to ${object}.`)
-    // console.log('followOrCreateLink @@ connectedStatements', store.connectedStatements(subject))
-    return null
-  }
-  try {
-    await store.updater.update([], [ st(subject, predicate, object, doc)])
-  } catch (err) {
-    console.warn(`followOrCreateLink: Error making link in ${doc} to ${object}: ${err}`)
-    return null
-  }
-
-  // console.log(`Success making link in ${doc} to ${object}` )
-
-  try {
-    await loadOrCreateIfNotExists(store, object)
-    // store.fetcher.webOperation('PUT', object, { data: '', contentType: 'text/turtle'})
-  } catch (err) {
-    console.warn(`followOrCreateLink: Error loading or saving new linked document: ${object}: ${err}`)
-  }
-  // console.log(`followOrCreateLink: Success loading or saving new linked document: ${object}.`)
-  return object
-}
-
-export async function loadProfile(store: LiveStore, user: NamedNode) {
-  // console.log(' @@  loadProfile: user', user)
-  if (!user) {
-    throw new Error(`loadProfile: no user given.`)
-  }
-  // try {
-    await store.fetcher.load(user.doc())
-  // } catch (err) {
-  //  throw new Error(`Unable to load profile of user ${user}: ${err}`)
-  //}
-  return user.doc()
-}
-
-export async function loadPreferences(store: LiveStore, user: NamedNode): Promise <NamedNode | undefined > {
-  // console.log('loadPreferences @@ user', user)
-  await loadProfile(store as LiveStore, user)
-
-  const possiblePreferencesFile = suggestPreferencesFile(user)
-
-  const preferencesFile = await followOrCreateLink(store, user,  ns.space('preferencesFile') as NamedNode, possiblePreferencesFile, user.doc())
-
-  // console.log('loadPreferences @@ pref file', preferencesFile)
-  if (!preferencesFile) {
-    const message = `User ${user} has no pointer in profile to preferences file.`
-    console.warn(message)
-    // throw new Error()
-    return undefined
-  }
-  try {
-    await store.fetcher.load(preferencesFile as NamedNode)
-  } catch (err) { // Maybe a permission propblem or origin problem
-    return undefined
-    // throw new Error(`Unable to load preferences file ${preferencesFile} of user <${user}>: ${err}`)
-  }
-  return preferencesFile as NamedNode
-}
-
-export async function loadTypeIndexesFor(store: LiveStore, user:NamedNode): Promise<Array<TypeIndexScope>> {
-  // console.log('@@ loadTypeIndexesFor user', user)
-  if (!user) throw new Error(`loadTypeIndexesFor: No user given`)
-  const profile = await loadProfile(store, user)
-
-  const suggestion = suggestPublicTypeIndex(user)
-
-  const publicTypeIndex = await followOrCreateLink(store, user, ns.solid('publicTypeIndex') as NamedNode, suggestion, profile)
-
-  // const publicTypeIndex = store.any(user, ns.solid('publicTypeIndex'), undefined, profile)
-  // console.log('@@ loadTypeIndexesFor publicTypeIndex', publicTypeIndex)
-
-  const  publicScopes = publicTypeIndex ? [ { label: 'public', index: publicTypeIndex as NamedNode, agent: user } ] : []
-
-  let preferencesFile
-  try {
-    preferencesFile = await loadPreferences(store, user)
-  } catch (err) {
-    preferencesFile = null
-  }
-
-  let privateScopes
-  if (preferencesFile) { // watch out - can be in either as spec was not clear.  Legacy is profile.
-    // If there is a legacy one linked from the profile, use that.
-    // Otherwiae use or make one linked from Preferences
-    const suggestedPrivateTypeIndex = suggestPrivateTypeIndex(preferencesFile)
-
-    const privateTypeIndex = store.any(user, ns.solid('privateTypeIndex'), undefined, profile) ||
-
-    await followOrCreateLink(store, user, ns.solid('privateTypeIndex') as NamedNode, suggestedPrivateTypeIndex, preferencesFile);
-
-    privateScopes = privateTypeIndex ? [ { label: 'private', index: privateTypeIndex as NamedNode, agent: user } ] : []
-  } else {
-    privateScopes = []
-  }
-  const scopes =  publicScopes.concat(privateScopes)
-  if (scopes.length === 0) return scopes
-  const files = scopes.map(scope => scope.index)
-  // console.log('@@ loadTypeIndexesFor files ', files)
-  try {
-    await store.fetcher.load(files)
-  } catch (err) {
-    console.warn('Problems loading type index: ', err)
-  }
-  return scopes
-}
-
-export async function loadCommunityTypeIndexes (store:LiveStore, user:NamedNode): Promise<TypeIndexScope[][]> {
-  const preferencesFile = await loadPreferences(store, user)
-  if (preferencesFile) { // For now, pick up communities as simple links from the preferences file.
-    const communities = store.each(user, ns.solid('community'), undefined, preferencesFile as NamedNode)
-    // console.log('loadCommunityTypeIndexes communities: ',communities)
-    let result = []
-    for (const org of communities) {
-      result = result.concat(await loadTypeIndexesFor(store, org as NamedNode) as any)
-    }
-    // const communityTypeIndexesPromises = communities.map(async community => await loadTypeIndexesFor(store, community as NamedNode))
-    // const result1 = Promise.all(communityTypeIndexesPromises)
-    return result
-  }
-  return [] // No communities
-}
-
-export async function loadAllTypeIndexes (store:LiveStore, user:NamedNode) {
-  return (await loadTypeIndexesFor(store, user)).concat((await loadCommunityTypeIndexes(store, user)).flat())
-}
-
-// Utility: remove duplicates from Array of NamedNodes
-export function uniqueNodes (arr: NamedNode[]): NamedNode[] {
-  const uris = arr.map(x => x.uri)
-  const set = new Set(uris)
-  const uris2 = Array.from(set)
-  const arr2 = uris2.map(u => new NamedNode(u))
-  return arr2 // Array.from(new Set(arr.map(x => x.uri))).map(u => sym(u))
-}
-
-export async function getScopedAppsfromIndex (store, scope, theClass: NamedNode) {
-  // console.log(`getScopedAppsfromIndex agent ${scope.agent} index: ${scope.index}` )
-  const index = scope.index
-  const registrations = store.each(undefined, ns.solid('forClass'), theClass, index)
-  // console.log('    registrations', registrations )
-
-  const directInstances = registrations.map(reg => store.each(reg as NamedNode, ns.solid('instance'), null, index)).flat()
-  // console.log('    directInstances', directInstances )
-  let instances = uniqueNodes(directInstances)
-
-  const instanceContainers = registrations.map(
-    reg => store.each(reg as NamedNode, ns.solid('instanceContainer'), null, index)
-  ).flat()
-
-  //  instanceContainers may be deprocatable if no one has used them
-  const containers = uniqueNodes(instanceContainers)
-  for (let i = 0; i < containers.length; i++) {
-    const cont = containers[i]
-    await store.fetcher.load(cont)
-    const contents = store.each(cont, ns.ldp('contains'), null, cont)
-    // if (contents.length) console.log('getScopedAppsfromIndex @@ instanceContainer contents:', contents)
-    instances = instances.concat(contents)
-  }
-  return instances.map(instance => { return {instance, scope}})
-}
-
-export async function getScopedAppInstances (store:LiveStore, klass: NamedNode, user: NamedNode):Promise<ScopedApp[]> {
-  // console.log('getScopedAppInstances @@ ' + user)
-  const scopes = await loadAllTypeIndexes(store, user)
-  let scopedApps = []
-  for (const scope of scopes) {
-    const scopedApps0 = await getScopedAppsfromIndex(store, scope, klass) as any
-    scopedApps = scopedApps.concat(scopedApps0)
-  }
-  return scopedApps
-}
-
-// This is the function signature which used to be in solid-ui/logic
-// Recommended to use getScopedAppInstances instead as it provides more information.
-//
-export async function getAppInstances (store:LiveStore, klass: NamedNode): Promise<NamedNode[]> {
-  const user = currentUser()
-  if (!user) throw new Error('getAppInstances: Must be logged in to find apps.')
-  const scopedAppInstances = await getScopedAppInstances(store, klass, user)
-  return scopedAppInstances.map(scoped => scoped.instance)
-}
-
-/*
- * Register a new app in a type index
- * used in chat in bookmark.js (solid-ui)
- * Returns the registration object if successful else null
- */
-export async function registerInstanceInTypeIndex (
-  store:LiveStore,
-  instance: NamedNode,
-  index: NamedNode,
-  theClass: NamedNode,
-  // agent: NamedNode
-): Promise<NamedNode | null> {
-  const registration = newThing(index)
-  const ins = [
-      // See https://github.com/solid/solid/blob/main/proposals/data-discovery.md
-      st(registration, ns.rdf('type'), ns.solid('TypeRegistration'), index),
-      st(registration, ns.solid('forClass'), theClass, index),
-      st(registration, ns.solid('instance'), instance, index)
-  ]
-  try {
-    console.log('patching index', ins)
-      await store.updater.update([], ins)
-  } catch (err) {
-      const msg = `Unable to register ${instance} in index ${index}: ${err}`
-      console.warn(msg)
-      return null
-  }
-  return registration
-}
-// ENDS

package/src/inbox/InboxLogic.ts

@@ -1,66 +0,0 @@
-import { NamedNode, LiveStore } from "rdflib";
-import { ProfileLogic } from "../profile/ProfileLogic";
-import { SolidNamespace } from "../types";
-import { UtilityLogic } from "../util/UtilityLogic";
-
-/**
- * Inbox-related logic
- */
-export class InboxLogic {
-  store: LiveStore;
-  ns: SolidNamespace;
-  profile: ProfileLogic;
-  util: UtilityLogic;
-
-  constructor(store: LiveStore, ns: SolidNamespace, profile: ProfileLogic, util: UtilityLogic) {
-    this.store = store;
-    this.ns = ns;
-    this.profile = profile;
-    this.util = util;
-  }
-
-  async getNewMessages(
-    user?: NamedNode
-  ): Promise<string[]> {
-    if (!user) {
-      user = await this.profile.loadMe();
-    }
-    const inbox = await this.profile.getMainInbox(user);
-    const urls = await this.util.getContainerMembers(inbox.value);
-    return urls.filter(url => !this.util.isContainer(url));
-  }
-  async createInboxFor(peerWebId: string, nick: string) {
-    const myWebId: NamedNode = (await this.profile.loadMe());
-    const podRoot: NamedNode = await this.profile.getPodRoot(myWebId);
-    const ourInbox = `${podRoot.value}p2p-inboxes/${encodeURIComponent(nick)}/`;
-    await this.util.createContainer(ourInbox);
-    const aclDocUrl = await this.util.findAclDocUrl(ourInbox);
-    await this.util.setSinglePeerAccess({
-      ownerWebId: myWebId.value,
-      peerWebId,
-      accessToModes: 'acl:Append',
-      target: ourInbox
-    });
-    return ourInbox;
-  }
-  async markAsRead(url: string, date: Date) {
-    const downloaded = await this.util.underlyingFetch.fetch(url);
-    if (downloaded.status !== 200) {
-      throw new Error(`Not OK! ${url}`);
-    }
-    const archiveUrl = this.util.getArchiveUrl(url, date);
-    const options =  {
-      method: 'PUT',
-      body: await downloaded.text(),
-      headers: [
-        [ 'Content-Type', downloaded.headers.get('Content-Type') || 'application/octet-stream' ]
-      ]
-    };
-    const uploaded = await this.util.underlyingFetch.fetch(archiveUrl, options);
-    if (uploaded.status.toString()[0] === '2') {
-      await this.store.fetcher?._fetch(url, {
-        method: 'DELETE'
-      });
-    }
-  }
-}

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,161 +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;
-  underlyingFetch: { fetch: (url: string, options?: any) => any };
-
-  constructor(store: LiveStore, ns: SolidNamespace, underlyingFetch: { fetch: (url: string, options?: any) => any }) {
-    this.store = store;
-    this.ns = ns;
-    this.underlyingFetch = underlyingFetch;
-  }
-
-  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.underlyingFetch.fetch(aclDocUrl, {
-      method: 'PUT',
-      body: str,
-      headers: [
-        [ 'Content-Type', 'text/turtle' ]
-      ]
-    });
-  }
-
-  async loadDoc(doc: NamedNode): Promise<void> {
-    // Load a document into the knowledge base (fetcher.store)
-    //   withCredentials: Web arch should let us just load by turning off creds helps CORS
-    //   reload: Gets around a specific old Chrome bug caching/origin/cors
-    // console.log('loading', profileDocument)
-    if (!this.store.fetcher) {
-      throw new Error("Cannot load doc, have no fetcher");
-    }
-    await this.store.fetcher.load(doc, {
-      withCredentials: false, // @@ BUT this won't work when logged in an accessing private stuff!
-      cache: "reload",
-    });
-    // console.log('loaded', profileDocument, this.store)
-  }
-
-  isContainer(url: string) {
-    return url.substr(-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.underlyingFetch.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.underlyingFetch.fetch(aclDocUrl, { method: "DELETE" });
-        const containerMembers = await this.getContainerMembers(url);
-        await Promise.all(
-          containerMembers.map((url) => this.recursiveDelete(url))
-        );
-      }
-      return this.underlyingFetch.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()));
-}