Switch drive management to /system/drives.json and update related APIs and beaker://drives

Author: pfrazee

app/bg/filesystem/index.js

@@ -7,20 +7,26 @@ import * as db from '../dbs/profile-data-db'
 import * as users from './users'
 import * as trash from './trash'
 import { PATHS } from '../../lib/const'
+import lock from '../../lib/lock'
 
 // typedefs
 // =
 
 /**
  * @typedef {import('../dat/daemon').DaemonHyperdrive} DaemonHyperdrive
  * @typedef {import('./users').User} User
+ * 
+ * @typedef {Object} DriveConfig
+ * @property {string} key
+ * @property {boolean} seeding
  */
 
 // globals
 // =
 
 var browsingProfile
 var rootDrive
+var drives = []
 
 // exported api
 // =
@@ -72,8 +78,6 @@ export async function setup () {
     await ensureDir(PATHS.LIBRARY_NS('media'))
     await ensureDir(PATHS.LIBRARY_NS('projects'))
     await ensureDir(PATHS.SYSTEM)
-    await ensureDir(PATHS.SYSTEM_NS('drives'))
-    await ensureDir(PATHS.SYSTEM_NS('templates'))
     await ensureDir(PATHS.SYSTEM_NS('webterm'))
     await ensureDir(PATHS.SYSTEM_NS('webterm/cmds'))
 
@@ -87,6 +91,14 @@ export async function setup () {
     console.error('Error while constructing the root drive', e.toString())
     logger.error('Error while constructing the root drive', {error: e.toString()})
   }
+
+  // load drive config
+  try {
+    drives = JSON.parse(await rootDrive.pda.readFile(PATHS.SYSTEM_NS('drives.json'))).drives
+  } catch (e) {
+    console.error('Error while reading the drive configuration at /system/drives.json', e.toString())
+    logger.error('Error while reading the drive configuration at /system/drives.json', {error: e.toString()})
+  }
 }
 
 /**
@@ -97,14 +109,51 @@ export async function setDefaultUser (url) {
   await ensureMount(PATHS.DEFAULT_USER, url)
 }
 
+/**
+ * @returns {Array<DriveConfig>}
+ */
+export function listDrives () {
+  return drives
+}
+
+/**
+ * @param {string} url
+ * @param {Object} [opts]
+ * @param {Boolean} [opts.seeding]
+ * @returns {Promise<void>}
+ */
+export async function configDrive (url, {seeding} = {seeding: false}) {
+  var release = await lock('filesystem:drives')
+  try {
+    var key = await hyper.drives.fromURLToKey(url, true)
+    var drive = drives.find(drive => drive.key === key)
+    if (!drive) {
+      drive = /** @type DriveConfig */({key, seeding})
+      drives.push(drive)
+    } else {
+      drive.seeding = seeding
+    }
+    await rootDrive.pda.writeFile(PATHS.SYSTEM_NS('drives.json'), JSON.stringify({drives}, null, 2))
+  } finally {
+    release()
+  }
+}
+
 /**
  * @param {string} url
- * @param {string} title
  * @returns {Promise<void>}
  */
-export async function addToLibrary (url, title) {
-  var name = await getAvailableName(PATHS.SYSTEM_NS('drives'), slugify((title || '').trim() || 'untitled').toLowerCase())
-  await ensureMount(joinPath(PATHS.SYSTEM_NS('drives'), name), url)
+export async function removeDrive (url) {
+  var release = await lock('filesystem:drives')
+  try {
+    var key = await hyper.drives.fromURLToKey(url, true)
+    var driveIndex = drives.findIndex(drive => drive.key === key)
+    if (driveIndex === -1) return
+    drives.splice(driveIndex, 1)
+    await rootDrive.pda.writeFile(PATHS.SYSTEM_NS('drives.json'), JSON.stringify({drives}, null, 2))
+  } finally {
+    release()
+  }
 }
 
 /**

app/bg/hyper/drives.js

@@ -6,6 +6,7 @@ import _debounce from 'lodash.debounce'
 import pda from 'pauls-dat-api2'
 import { wait } from '../../lib/functions'
 import * as logLib from '../logger'
+import { listDrives } from '../filesystem/index'
 const baseLogger = logLib.get()
 const logger = baseLogger.child({category: 'dat', subcategory: 'drives'})
 
@@ -93,7 +94,7 @@ export async function setup () {
  */
 export async function loadSavedDrives () {
   // load all saved drives
-  var drives = [] // TODO uwg await datLibrary.list({isHosting: true})
+  var drives = listDrives()
 
   // HACK
   // load the drives one at a time and give 5 seconds between each
@@ -103,9 +104,11 @@ export async function loadSavedDrives () {
   // so spacing out the loads has no visible impact on the user
   // (except for reducing the overall load for the user)
   // -prf
-  for (let a of drives) {
-    loadDrive(a.key)
-    await new Promise(r => setTimeout(r, 5e3)) // wait 5s
+  for (let drive of drives) {
+    if (drive.seeding) {
+      loadDrive(drive.key)
+      await new Promise(r => setTimeout(r, 5e3)) // wait 5s
+    }
   }
 };
 

app/bg/web-apis/bg/drives.js

@@ -1,6 +1,7 @@
 import hyperDns from '../../hyper/dns'
 import * as drives from '../../hyper/drives'
 import * as archivesDb from '../../dbs/archives'
+import { listDrives, configDrive, removeDrive, isRootUrl } from '../../filesystem/index'
 import * as trash from '../../filesystem/trash'
 import * as users from '../../filesystem/users'
 import { PermissionsError } from 'beaker-error-constants'
@@ -19,6 +20,47 @@ export default {
     return status
   },
 
+  async get (key) {
+    key = await drives.fromURLToKey(key, true)
+    var drive = listDrives().find(drive => drive.key === key)
+    var info = await drives.getDriveInfo(key).catch(e => {})
+    var url = `hd://${key}`
+    var ident = getIdent(url)
+    return {
+      key,
+      url,
+      info,
+      saved: !!drive,
+      seeding: ident.user || (drive ? drive.seeding : false),
+      ident
+    }
+  },
+
+  async list () {
+    var records = []
+    for (let drive of listDrives()) {
+      let url = `hd://${drive.key}`
+      let ident = getIdent(url)
+      records.push({
+        key: drive.key,
+        url,
+        info: await drives.getDriveInfo(drive.key).catch(e => {}),
+        saved: true,
+        seeding: ident.user || drive.seeding,
+        ident
+      })
+    }
+    return records
+  },
+
+  async configure (key, opts) {
+    return configDrive(key, opts)
+  },
+
+  async remove (key) {
+    return removeDrive(key)
+  },
+
   async collectTrash () {
     return trash.collect({olderThan: 0})
   },
@@ -67,29 +109,8 @@ function assertDriveDeletable (key) {
   }
 }
 
-function massageRecord (record) {
-  return {
-    key: record.key,
-    url: `hd://${record.key}`,
-    author: record.author ? {
-      url: record.author.url,
-      title: record.author.title,
-      description: record.author.description,
-      type: record.author.type,
-      writable: record.author.writable
-    } : undefined,
-    meta: {
-      title: record.meta.title,
-      description: record.meta.description,
-      type: record.meta.type,
-      mtime: record.meta.mtime,
-      size: record.meta.size,
-      author: record.meta.author,
-      writable: record.meta.writable
-    },
-    isSaved: record.isSaved,
-    isHosting: record.isHosting,
-    visibility: record.visibility,
-    savedAt: Number(record.savedAt)
-  }
+function getIdent (url) {
+  var home = isRootUrl(url)
+  var user = users.isUser(url)
+  return {system: home || user, home, user}
 }

app/bg/web-apis/bg/hyperdrive.js

@@ -58,7 +58,7 @@ export default {
       // create
       try {
         var newDrive = await drives.createNewDrive({title, description, type, author, links})
-        await filesystem.addToLibrary(newDrive.url, title)
+        await filesystem.configDrive(newDrive.url, {seeding: true})
       } catch (e) {
         console.log(e)
         throw e
@@ -119,7 +119,7 @@ export default {
       // create
       let key = await lookupUrlDriveKey(url)
       let newDrive = await drives.cloneDrive(key, {title, description, type, author, links})
-      await filesystem.addToLibrary(newDrive.url, title)
+      await filesystem.configDrive(newDrive.url, {seeding: true})
       newDriveUrl = newDrive.url
     }
 

app/bg/web-apis/bg/navigator-filesystem.js

@@ -1,7 +1,6 @@
 import { PermissionsError } from 'beaker-error-constants'
 import * as sessionPerms from '../../lib/session-perms'
 import * as filesystem from '../../filesystem/index'
-import * as users from '../../filesystem/users'
 import _pick from 'lodash.pick'
 
 // typedefs
@@ -13,11 +12,6 @@ import _pick from 'lodash.pick'
  *
  * @typedef {Object} NavigatorFilesystemPublicAPIRootRecord
  * @prop {string} url
- *
- * @typedef {Object} NavigatorFilesystemPublicAPIDriveInfo
- * @prop {boolean} isSystemDrive
- * @prop {boolean} isRoot
- * @prop {boolean} isUser
  */
 
 // exported api
@@ -35,22 +29,5 @@ export default {
     return {
       url: filesystem.get().url
     }
-  },
-
-  /**
-   * @param {string} url
-   * @returns {Promise<NavigatorFilesystemPublicAPIDriveInfo>}
-   */
-  async identifyDrive (url) {
-    if (!(await sessionPerms.isTrustedApp(this.sender))) {
-      throw new PermissionsError()
-    }
-    var isRoot = url === filesystem.get().url
-    var isUser = users.isUser(url)
-    return {
-      isSystemDrive: isRoot || isUser,
-      isRoot,
-      isUser
-    }
   }
 }

app/bg/web-apis/fg/beaker.js

@@ -49,6 +49,10 @@ export const setup = function (rpc) {
     // beaker.drives
     beaker.drives = new EventTarget()
     beaker.drives.status = drivesRPC.status
+    beaker.drives.get = drivesRPC.get
+    beaker.drives.list = drivesRPC.list
+    beaker.drives.configure = drivesRPC.configure
+    beaker.drives.remove = drivesRPC.remove
     beaker.drives.listTrash = drivesRPC.listTrash
     beaker.drives.collectTrash = drivesRPC.collectTrash
     beaker.drives.delete = drivesRPC.delete

app/bg/web-apis/fg/navigator-methods.js

@@ -24,12 +24,6 @@ export const setup = function (rpc) {
   var filesystemApi = rpc.importAPI('navigator-filesystem', filesystemManifest, RPC_OPTS)
   try {
     navigator.filesystem = new Hyperdrive(filesystemApi.get().url)
-    navigator.filesystem.identifyDrive = async (url) => {
-      if (url instanceof Hyperdrive) {
-        url = url.url
-      }
-      return filesystemApi.identifyDrive(url)
-    }
   } catch (e) {
     // not supported
   }

app/bg/web-apis/manifests/external/navigator-filesystem.js

@@ -1,4 +1,3 @@
 export default {
-  get: 'sync',
-  identifyDrive: 'promise'
+  get: 'sync'
 }

app/bg/web-apis/manifests/internal/drives.js

@@ -1,5 +1,9 @@
 export default {
   status: 'promise',
+  get: 'promise',
+  list: 'promise',
+  configure: 'promise',
+  remove: 'promise',
   listTrash: 'promise',
   collectTrash: 'promise',
   delete: 'promise',

app/userland/app-stdlib/js/strings.js

@@ -125,13 +125,15 @@ export function toNiceDriveType (type = '') {
   if (!type) return 'files drive'
   if (type === 'unwalled.garden/person') return 'beaker user'
   if (type === 'unwalled.garden/template') return 'template'
+  if (type === 'webterm.sh/cmd-pkg') return 'webterm command'
   return type
 }
 
 export function getDriveTypeIcon (type = '') {
   switch (type) {
     case 'unwalled.garden/person': return 'fas fa-user'
     case 'unwalled.garden/template': return 'fas fa-drafting-compass'
+    case 'webterm.sh/cmd-pkg': return 'fas fa-terminal'
     case 'module': return 'fas fa-cube'
     case 'website': return 'fas fa-desktop'
     default: return 'far fa-folder-open'