Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 | import { throttle } from 'throttle-debounce'
import { PublishHook, UnixTree, Tree, File } from './types'
import { BaseLinks, Branch } from './types'
import { SemVer } from './semver'
import BareTree from './bare/tree'
import RootTree from './root/tree'
import PublicTree from './v1/PublicTree'
import PrivateTree from './v1/PrivateTree'
import * as cidLog from '../common/cid-log'
import * as dataRoot from '../data-root'
import * as debug from '../common/debug'
import * as identifiers from '../common/identifiers'
import * as keystore from '../keystore'
import * as pathUtil from './path'
import * as ucan from '../ucan'
import * as ucanInternal from '../ucan/internal'
import { Maybe } from '../common'
import { CID, FileContent } from '../ipfs'
import { NoPermissionError } from '../errors'
import { Permissions } from '../ucan/permissions'
import { Ucan } from '../ucan'
// TYPES
type AppPath =
(path?: string | Array<string>) => string
type ConstructorParams = {
localOnly?: boolean
permissions?: Permissions
root: RootTree
}
type FileSystemOptions = {
localOnly?: boolean
permissions?: Permissions
version?: SemVer
}
type NewFileSystemOptions = FileSystemOptions & {
rootKey: string
}
type MutationOptions = {
publish?: boolean
}
// CLASS
export class FileSystem {
root: RootTree
localOnly: boolean
appPath: AppPath | undefined
proofs: { [_: string]: Ucan }
publishHooks: Array<PublishHook>
publishWhenOnline: Array<[CID, Ucan]>
constructor({ root, permissions, localOnly }: ConstructorParams) {
this.localOnly = localOnly || false
this.proofs = {}
this.publishHooks = []
this.publishWhenOnline = []
this.root = root
if (
permissions &&
permissions.app &&
permissions.app.creator &&
permissions.app.name
) {
this.appPath = appPath(permissions)
}
// Add the root CID of the file system to the CID log
// (reverse list, newest cid first)
const logCid = (cid: CID) => {
cidLog.add(cid)
debug.log("📓 Adding to the CID ledger:", cid)
}
// Update the user's data root when making changes
const updateDataRootWhenOnline = throttle(3000, false, (cid, proof) => {
if (globalThis.navigator.onLine) return dataRoot.update(cid, proof)
this.publishWhenOnline.push([ cid, proof ])
}, false)
this.publishHooks.push(logCid)
this.publishHooks.push(updateDataRootWhenOnline)
// Publish when coming back online
globalThis.addEventListener('online', () => this._whenOnline())
}
// INITIALISATION
// --------------
/**
* Creates a file system with an empty public tree & an empty private tree at the root.
*/
static async empty(opts: NewFileSystemOptions): Promise<FileSystem> {
const { permissions, localOnly, rootKey } = opts
const root = await RootTree.empty({ rootKey })
const fs = new FileSystem({
root,
permissions,
localOnly
})
return fs
}
/**
* Loads an existing file system from a CID.
*/
static async fromCID(cid: CID, opts: FileSystemOptions = {}): Promise<FileSystem | null> {
const { permissions, localOnly } = opts
const root = await RootTree.fromCID({ cid, permissions })
const fs = new FileSystem({
root,
permissions,
localOnly
})
return fs
}
// DEACTIVATE
// ----------
/**
* Deactivate a file system.
*
* Use this when a user signs out.
* The only function of this is to stop listing to online/offline events.
*/
deactivate(): void {
globalThis.removeEventListener('online', this._whenOnline)
}
// POSIX INTERFACE
// ---------------
async mkdir(path: string, options: MutationOptions = {}): Promise<this> {
await this.runOnTree(path, true, (tree, relPath) => {
return tree.mkdir(relPath)
})
if(options.publish) {
await this.publish()
}
return this
}
async ls(path: string): Promise<BaseLinks> {
return this.runOnTree(path, false, (tree, relPath) => {
return tree.ls(relPath)
})
}
async add(path: string, content: FileContent, options: MutationOptions = {}): Promise<this> {
await this.runOnTree(path, true, (tree, relPath) => {
return tree.add(relPath, content)
})
if(options.publish) {
await this.publish()
}
return this
}
async cat(path: string): Promise<FileContent> {
return this.runOnTree(path, false, (tree, relPath) => {
return tree.cat(relPath)
})
}
async exists(path: string): Promise<boolean> {
return this.runOnTree(path, false, (tree, relPath) => {
return tree.exists(relPath)
})
}
async rm(path: string): Promise<this> {
await this.runOnTree(path, true, (tree, relPath) => {
return tree.rm(relPath)
})
return this
}
async get(path: string): Promise<Tree | File | null> {
return this.runOnTree(path, false, (tree, relPath) => {
return tree.get(relPath)
})
}
// This is only implemented on the same tree for now and will error otherwise
async mv(from: string, to: string): Promise<this> {
const sameTree = pathUtil.sameParent(from, to)
if (!sameTree) {
throw new Error("`mv` is only supported on the same tree for now")
}
if (await this.exists(to)) {
throw new Error("Destination already exists")
}
await this.runOnTree(from, true, (tree, relPath) => {
const { nextPath } = pathUtil.takeHead(to)
return tree.mv(relPath, nextPath || '')
})
return this
}
async read(path: string): Promise<FileContent | null> {
return this.cat(path)
}
async write(path: string, content: FileContent, options: MutationOptions = {}): Promise<this> {
return this.add(path, content, options)
}
// PUBLISH
// -------
/**
* Ensures the latest version of the file system is added to IPFS,
* updates your data root, and returns the root CID.
*/
async publish(): Promise<CID> {
const proofs = Array.from(Object.entries(this.proofs))
this.proofs = {}
const cid = await this.root.put()
proofs.forEach(([_, proof]) => {
this.publishHooks.forEach(hook => hook(cid, proof))
})
return cid
}
// INTERNAL
// --------
/** @internal */
async runOnTree<a>(
path: string,
isMutation: boolean,
fn: (tree: UnixTree, relPath: string) => Promise<a>
): Promise<a> {
const parts = pathUtil.splitParts(path)
const head = parts[0]
const relPath = pathUtil.join(parts.slice(1))
if (!this.localOnly) {
const proof = await ucanInternal.lookupFilesystemUcan(path)
if (!proof || ucan.isExpired(proof) || !proof.signature) {
throw new NoPermissionError("I don't have the necessary permissions to make these changes to the file system")
}
this.proofs[proof.signature] = proof
}
let result: a
let resultPretty: a
if (head === Branch.Public) {
result = await fn(this.root.publicTree, relPath)
if (isMutation && PublicTree.instanceOf(result)) {
resultPretty = await fn(this.root.prettyTree, relPath)
this.root.publicTree = result
this.root.prettyTree = resultPretty as unknown as BareTree
await Promise.all([
this.root.updatePuttable(Branch.Public, this.root.publicTree),
this.root.updatePuttable(Branch.Pretty, this.root.prettyTree)
])
}
} else if (head === Branch.Private) {
const [treePath, tree] = this.root.findPrivateTree(parts.slice(1))
if (!tree) {
throw new NoPermissionError("I don't have the necessary permissions to make these changes to the file system")
}
result = await fn(
tree,
relPath.replace(new RegExp("^" + treePath + "/?"), "")
)
if (isMutation && PrivateTree.instanceOf(result)) {
this.root.privateTrees[treePath] = result
await result.put()
await this.root.updatePuttable(Branch.Private, this.root.mmpt)
const cid = await this.root.mmpt.put()
await this.root.addPrivateLogEntry(cid)
}
} else if (head === Branch.Pretty && isMutation) {
throw new Error("The pretty path is read only")
} else if (head === Branch.Pretty) {
result = await fn(this.root.prettyTree, relPath)
} else {
throw new Error("Not a valid FileSystem path")
}
return result
}
/** @internal */
_whenOnline(): void {
const toPublish = [...this.publishWhenOnline]
this.publishWhenOnline = []
toPublish.forEach(([cid, proof]) => {
this.publishHooks.forEach(hook => hook(cid, proof))
})
}
}
export default FileSystem
// ㊙️
function appPath(permissions: Permissions): ((path?: string | Array<string>) => string) {
return (path?: string | Array<string>): string => (
`${Branch.Private}/Apps/`
+ (permissions.app ? permissions.app.creator + '/' : '')
+ (permissions.app ? permissions.app.name : '')
+ (path ? '/' + (typeof path == 'object' ? path.join('/') : path) : '')
)
}
|