@environment-safe/file 0.0.1 → 0.1.0

package/src/index.mjs

@@ -1,378 +1,138 @@
-/*
-import { isBrowser, isJsDom } from 'browser-or-node';
-import * as mod from 'module';
-import * as path from 'path';
-let internalRequire = null;
-if(typeof require !== 'undefined') internalRequire = require;
-const ensureRequire = ()=> (!internalRequire) && (internalRequire = mod.createRequire(import.meta.url));
-//*/
-
 /**
  * A JSON object
  * @typedef { object } JSON
  */
  
-import { isBrowser, isJsDom } from 'browser-or-node';
+// Isn't the fact that we had 2 path scenarios driven by OS, fixed it, (win, unix)
+// and we now have an explosion an obvious indicator that we went wrong?
+// win, posix, file:win, file:posix, known dirs, web urls, plus file: behavior is different on local vs server
+ 
 import { FileBuffer } from './buffer.mjs';
-import * as fs from 'fs';
-import * as path from 'path';
-
-const inputQueue = [];
-const attachInputGenerator = (eventType)=>{
-    const handler = (event)=>{
-        if(inputQueue.length){
-            const input = inputQueue.shift();
-            try{
-                input.handler(event, input.resolve, input.reject);
-            }catch(ex){
-                inputQueue.unshift(input);
-            }
-        }
-    };
-    window.addEventListener('load', (event) => {
-        document.body.addEventListener(eventType, handler, false);
-    });
-    //document.body.addEventListener(eventType, handler, false);
-};
-
-if(isBrowser || isJsDom){
-    attachInputGenerator('mousedown');
-    // mousemove is cleanest, but seems unreliable
-    // attachInputGenerator('mousemove');
-}
-
-const wantInput = async (id, handler, cache)=>{
-    const promise = new Promise((resolve, reject)=>{
-        inputQueue.push({ resolve, reject, handler });
-    });
-    const input = await promise;
-    return await input;
+import {
+    isServer, // is running on a server runtime
+    isLocalFileRoot, // run within a page using a file: url
+    variables
+} from '@environment-safe/runtime-context';
+import { localFile as lf, serverFile as sf, file as f, remote as r, setInputHandler, bindInput} from './filesystem.mjs';
+import { Path } from './path.mjs';
+export { Path, setInputHandler, bindInput };
+const handleCanonicalPath = (dir, os, user)=>{
+    
 };
 
-const getFilePickerOptions = (name, path)=>{
-    let suffix = name.split('.').pop();
-    if(suffix.length > 6) suffix = '';
-    const options = {
-        suggestedName: name
-    };
-    if(path) options.startIn = path;
-    if(suffix){
-        const accept = {};
-        accept[mimesBySuffix[suffix]] = '.'+suffix;
-        options.types = [{
-            description: suffix,
-            accept,
-        }];
-        options.excludeAcceptAllOption = true;
-    }
-    return options;
-};
+let localFile=null;
+let serverFile=null;
+let file=null;
+let remote=null;
 
-const makeLocation = (path, dir)=>{
-    if(dir && dir[0] === '.'){
-        if(dir[1] === '.'){
-            if(dir[2] === '/' && dir[3]){
-                return pathJoin(File.directory.current, '..', dir.substring(3), path);
-            }else{
-                if(dir[2]){
-                    return pathJoin(File.directory.current, '..', dir.substring(3), path);
-                }else{
-                    return pathJoin(File.directory.current, '..', path);
-                }
-            }
+export const initialized = async (path, options={})=>{
+    if(isServer){
+        if(serverFile) return;
+        serverFile = await sf.initialize();
+    }else{
+        if(isLocalFileRoot){
+            if(file) return;
+            file = await f.initialize();
         }else{
-            if(dir[1] === '/'){
-                return pathJoin(File.directory.current, dir.substring(2), path);
+            if(path.indexOf('://') !== -1){
+                if(path.indexOf('file://') === 0){
+                    try{
+                        Path.relative(path);
+                    }catch(ex){
+                        //if it's not
+                        // 1) A file url root
+                        // 2) within the web root
+                        // we have no idea what to do
+                        console.log(ex);
+                        throw new Error(`Could not resolve path:${path}`);
+                    }
+                }
+                if(remote) return;
+                //remote url
+                remote = await r.initialize();
             }else{
-                if(dir[1]){
-                    return pathJoin(File.directory.current, dir, path);
+                if(options.filesystemAPI){
+                    if(localFile) return;
+                    //an absolute or relative file path
+                    localFile = await lf.initialize();
                 }else{
-                    return pathJoin(File.directory.current, path);
+                    if(remote) return;
+                    //remote url
+                    remote = await r.initialize();
                 }
             }
         }
     }
-    return dir?handleCanonicalPath(dir, File.os, File.user)+ '/' + path:path;
 };
 
-export const save = async (name, dir, buffer, meta={})=>{
-    const location = makeLocation(name, dir);
-    if(isBrowser || isJsDom){
-        const options = getFilePickerOptions(name, dir);
-        const newHandle = await wantInput(location, (event, resolve, reject)=>{
-            try{
-                window.showSaveFilePicker(options).then((thisHandle)=>{
-                    resolve(thisHandle);
-                }).catch((ex)=>{
-                    reject(ex);
-                });
-            }catch(ex){
-                reject(ex);
-            }
-        }, meta.cache);
-        const writableStream = await newHandle.createWritable();
-        // write our file
-        await writableStream.write(buffer);
-        // close the file and write the contents to disk.
-        await writableStream.close();
+export const act = async (action, ...args)=>{
+    const path = args[0];
+    const options = args[1] || {};
+    await initialized(path, options);
+    if(isServer){
+        return serverFile[action].apply(serverFile, args);
     }else{
-        return await new Promise((resolve, reject)=>{
-            fs.writeFile(location, buffer, (err)=>{
-                if(err) return reject(err);
-                resolve();
-            });
-        });
-    }
-};
-
-const mimesBySuffix = {
-    json : 'application/json',
-    jpg : 'image/jpeg',
-    jpeg : 'image/jpeg',
-    gif : 'image/gif',
-    png : 'image/png',
-    svg : 'image/sxg+xml',
-    webp : 'image/webp',
-    csv : 'text/csv',
-    tsv : 'text/tsv',
-    ssv : 'text/ssv',
-    js : 'text/javascript',
-    mjs : 'text/javascript',
-    cjs : 'text/javascript',
-    css : 'text/css',
-};
-
-export const pathJoin = (...parts)=>{ //returns buffer, eventually stream
-    if(isBrowser || isJsDom){
-        return parts.join('/');
-    }else{
-        return path.join.apply(path, parts);
-    }
-};
-
-
-//todo: should I remove export (no one should use this)?
-export const fileBody = async (path, dir, baseDir, allowRedirect, forceReturn)=>{
-    try{
-        //let location = dir?dir+ '/' + path:path; //todo: looser handling
-        let location = makeLocation(path, dir);
-        if(canonicalLocationToPath['darwin'][dir]){
-            if(baseDir){
-                throw new Error('custom directories unsupported');
+        if(isLocalFileRoot){
+            return file[action].apply(file, args);
+        }else{
+            if(path.indexOf('://') !== -1){
+                if(path.indexOf('file://') === 0){
+                    try{
+                        const currentProtocol = variables.location?variables.location.protocol:'http:';
+                        const relativePath = Path.from(path).toUrl(currentProtocol, true);
+                        args[0] = '../'+relativePath;
+                    }catch(ex){
+                        //if it's not
+                        // 1) A file url root
+                        // 2) within the web root
+                        // we have no idea what to do
+                        throw new Error(`Could not resolve path:${path}`);
+                    }
+                }
+                return remote[action].apply(remote, args);
+                
             }else{
-                location = 'file://'+handleCanonicalPath(dir, File.os, File.user)+'/'+path;
+                if(options.filesystemAPI){
+                    return localFile[action].apply(localFile, args);
+                }else{
+                    return remote[action].apply(remote, args);
+                }
             }
         }
-        const response = await fetch(location);
-        const text = await response.text();
-        if(!(response.ok || (allowRedirect && response.redirected) || forceReturn)){
-            return null;
-        }
-        return text;
-    }catch(ex){
-        //console.log(location, ex);
-        return null;
     }
 };
 
-export const handle = async (path, dir, writable, cache={})=>{ //returns buffer, eventually stream
-    let suffix = path.split('.').pop();
-    if(suffix.length > 6) suffix = '';
-    const location = makeLocation(path, dir);
-    if(isBrowser || isJsDom){
-        if(cache && cache[path]) return cache[path];
-        const options = getFilePickerOptions(path);
-        try{
-            const response = await fileBody(path, dir);
-            if(response === null) throw new Error('File not found');
-        }catch(ex){
-            const newHandle = await wantInput(location, (event, resolve, reject)=>{
-                try{
-                    window.showSaveFilePicker(options).then((thisHandle)=>{
-                        resolve(thisHandle);
-                    }).catch((ex)=>{
-                        reject(ex);
-                    });
-                }catch(ex){
-                    reject(ex);
-                }
-            });
-            return newHandle;
-        }
-        const fileHandle = await wantInput(location, (event, resolve, reject)=>{
-            try{
-                window.showOpenFilePicker(options).then(([ handle ])=>{
-                    resolve(handle);
-                }).catch((ex)=>{
-                    reject(ex);
-                });
-            }catch(ex){
-                reject(ex);
-            }
-        }, cache);
-        // eslint-disable-next-line no-undef
-        if(cache) cache[location] = fileHandle;
-        // eslint-disable-next-line no-undef
-        return fileHandle;
-    }else{
-        // todo: impl
-    }
+//*
+export const read = async (path, options)=>{
+    return await act('read', path, options);
 };
 
-export const load = async (path, dir, cache)=>{ //returns buffer, eventually stream
-    const location = makeLocation(path, dir);
-    if(isBrowser || isJsDom){
-        try{
-            const response = await fetch(location);
-            if(!response){
-                return new ArrayBuffer();
-            }
-            const buffer = await response.arrayBuffer();
-            buffer;
-            return buffer;
-        }catch(ex){
-            return new ArrayBuffer();
-        }
-    }else{
-        return await new Promise((resolve, reject)=>{
-            fs.readFile(location, (err, body)=>{
-                if(err) return reject(err);
-                resolve(body);
-            });
-        });
-    }
+export const list = async (path, options)=>{
+    return await act('list', path, options);
 };
 
-export const exists = async (path, dir, cache, incomingHandle)=>{ //returns buffer, eventually stream
-    if(isBrowser || isJsDom){
-        if(incomingHandle){
-            const fileHandle = incomingHandle;
-            const file = await fileHandle.getFile();
-            const buffer = await file.arrayBuffer();
-            return !!buffer;
-        }else{
-            const body = await fileBody(path, dir);
-            return body !== null;
-        }
-    }else{
-        return await new Promise((resolve, reject)=>{
-            const location = makeLocation(path, dir);
-            fs.stat(location, (err, res)=>{
-                if(err) resolve(false);
-                resolve(true);
-            });
-        });
-    }
+export const write = async (path, buffer, options)=>{
+    return await act('write', path, buffer, options);
 };
 
-export const remove = async (path, dir, cache)=>{
-    if(isBrowser || isJsDom){
-        const fileHandle = await handle(path, dir, true, cache);
-        if(fileHandle.remove) fileHandle.remove(); //non-standard, but supported
-    }else{
-        // todo: impl
-    }
+export const create = async (path)=>{
+    return await act('create', path);
 };
 
-export const info = async (path, dir, cache)=>{
-    if(isBrowser || isJsDom){
-        // todo: impl
-    }else{
-        // todo: impl
-    }
+export const exists = async (path)=>{
+    return await act('exists', path);
 };
 
-export const list = async (path, options={})=>{
-    if(isBrowser || isJsDom){
-        // todo: impl
-        switch(File.agent.name){
-            case 'chrome': {
-                const page = await fileBody('', path, null, null, true);
-                let rows = (page && page.match( /<script>addRow\((.*)\);<\/script>/g ) ) || [];
-                rows = rows.map((row)=>{
-                    return row.match( /<script>addRow\((.*)\);<\/script>/ )[1];
-                });
-                const jsonData = `[[${rows.join('], [')}]]`;
-                const data = JSON.parse(jsonData);
-                let results = data.map((meta)=>{
-                    return {
-                        name: meta[0],
-                        isFile: ()=>{
-                            return !!meta[2];
-                        }
-                    };
-                });
-                if(Object.keys(options).length){
-                    if(options.files === false){
-                        results = results.filter((file)=>{
-                            return !file.isFile();
-                        });
-                    }
-                    if(options.directories === false){
-                        results = results.filter((file)=>{
-                            return file.isFile();
-                        });
-                    }
-                    if(!options.hidden){
-                        results = results.filter((file)=>{
-                            return file !== '.' && file !== '..';
-                        });
-                    }
-                }
-                return results.map((file)=>{
-                    return file.name;
-                });
-                //TODO: apache fallback
-                //break;
-            }
-            default: throw new Error(`Usupported Browser: ${File.os}`);
-        }
-    }else{
-        //todo: platform safe separator
-        const target = path.indexOf('/') === -1?makeLocation('', path):path;
-        return await new Promise((resolve, reject)=>{
-            fs.readdir(target, { withFileTypes: true }, (err, files)=>{
-                if(err) return reject(err);
-                let results = files;
-                if(Object.keys(options).length){
-                    if(options.files === false){
-                        results = results.filter((file)=>{
-                            return !file.isFile();
-                        });
-                    }
-                    if(options.directories === false){
-                        results = results.filter((file)=>{
-                            return file.isFile();
-                        });
-                    }
-                    if(!options.hidden){
-                        results = results.filter((file)=>{
-                            return file !== '.' && file !== '..';
-                        });
-                    }
-                }
-                resolve(results.map((file)=>{
-                    return file.name;
-                }));
-            });
-        });
-    }
+export const remove = async (path)=>{
+    return await act('delete', path);
 };
 
 const internalCache = {};
 
-export const listFiles = (path)=>{
-    return list(path).map((src)=>{
-        const url = src.indexOf('://') !== -1?src:`file://${src}`;
-        return new File(url);
-    });
-};
-
-
 export class File{
     constructor(path, options={}){
         //todo: clean this rats nest up
-        const location = ( (path && path[0] === '/')?`file:${path}`:path ) || 
+        const location = ( path ) || 
             ( (!path) && options.directory && handleCanonicalPath(options.directory, File.os, File.user) ) ||
             ('/tmp/' + Math.floor( Math.random() * 10000 ));
         if(options.cache === true) options.cache = internalCache;
@@ -380,220 +140,87 @@ export class File{
         //one of: desktop, documents, downloads, music, pictures, videos
         this.directory = options.directory || '.';
         this.path = location;
-        this.buffer = new FileBuffer();
+        this.setBuffer(FileBuffer.from(''));
     }
     
     async save(){
-        await save(this.path, this.directory, this.buffer, this.options);
+        await write(this.path, this.buffer, this.options);
         return this;
     }
     
-    async load(){
-        const dir = this.path.indexOf('/') === -1?this.directory:'';
-        this.buffer = await load(this.path, dir, this.options);
+    setBuffer(buffer){
+        this.buffer = buffer;
+        if(!this.buffer) throw new Error(`Error: ${this.path} ${this.options}`);
         this.buffer.cast = (type)=>{
             return FileBuffer.to(type, this.buffer);
         };
+    }
+    
+    async load(){
+        this.setBuffer(await read(this.path, this.options));
         return this;
     }
     
     body(value){
         if(value === null || value === undefined) return this.buffer;
-        this.buffer = FileBuffer.from(value);
-        this.buffer.cast = (type)=>{
-            return FileBuffer.to(type, this.buffer);
-        };
-        if(value) return this;
-        return this.buffer;
+        this.setBuffer(FileBuffer.from(value));
+        return this;
     }
     
     async info(){
-        return await info(this.path, this.directory);
+        //return await info(this.path);
     }
     
     async 'delete'(){
-        await remove(this.path, this.directory, this.options);
+        await remove(this.path, this.options);
         return this;
     }
     
-    static exists(path, directory){
-        return exists(path, directory);
+    static async exists(path, directory){
+        return await exists(path, directory);
     }
     
-    static list(path, options){
-        return list(path, options);
+    static async list(path, options){
+        return await list(path, options);
     }
 }
-let user = '';
-Object.defineProperty(File, 'user', {
-    get() {
-        if(isBrowser || isJsDom){
-            return user || 'khrome'; //todo: something real;
-        }else{
-            return user || 'khrome'; //todo: something real;
-        }
-    },
-    set(newValue) {
-        user = newValue;
-    },
-    enumerable: true,
-    configurable: true,
-});
-
-Object.defineProperty(File, 'os', {
-    get() {
-        if(isBrowser || isJsDom){
-            return 'darwin'; //todo: something real;
-        }else{
-            return 'darwin';
-        }
-    },
-    set(newValue) {
-        //do nothing
-    },
-    enumerable: true,
-    configurable: true,
-});
-
-const canonicalLocationToPath = {
-    darwin : {
-        'desktop': '~/Desktop', 
-        'documents': '~/Documents', 
-        'downloads': '~/Downloads', 
-        'music': '~/Music', 
-        'pictures': '~/Pictures', 
-        'home': '~/Pictures',
-        'videos': '~/Movies'
-    },
-    win : {},
-    linux : {},
-};
 
-const osToHome = {
-    darwin : '/Users/${user}',
-    win : 'C:/',
-    linux : '/Users/${user}',
-};
-
-/*const handlePath = (path, os, username)=>{
-    return path.replace('~', osToHome[os].replace('${user}', username));
-};*/
-
-const handleCanonicalPath = (name, os, username)=>{
-    const path = canonicalLocationToPath[os][name];
-    return path.replace('~', osToHome[os].replace('${user}', username));
-};
-
-File.directory = {};
-Object.defineProperty(File.directory, 'current', {
-    get() {
-        if(isBrowser || isJsDom){
-            const base = document.getElementsByTagName('base')[0];
-            let basedir = null;
-            if(base && (basedir = base.getAttribute('href'))){
-                return basedir;
-            }else{
-                let path = window.location.pathname;
-                path = path.split('/');
-                path.pop(); // drop the top one
-                return path .join('/');
-            }
-        }else{
-            return process.cwd();
-        }
-    },
-    set(newValue) {
-        //do nothing
-    },
-    enumerable: true,
-    configurable: true,
-});
-
-Object.defineProperty(File, 'agent', {
-    get() {
-        if(isBrowser || isJsDom){
-            //var nVer = navigator.appVersion;
-            var nAgt = navigator.userAgent;
-            var browserName  = navigator.appName;
-            var fullVersion  = ''+parseFloat(navigator.appVersion); 
-            var majorVersion = parseInt(navigator.appVersion,10);
-            var nameOffset,verOffset,ix;
-            
-            // In Opera, the true version is after "Opera" or after "Version"
-            if ((verOffset=nAgt.indexOf('Opera'))!=-1) {
-                browserName = 'Opera';
-                fullVersion = nAgt.substring(verOffset+6);
-                if ((verOffset=nAgt.indexOf('Version'))!=-1) 
-                    fullVersion = nAgt.substring(verOffset+8);
-            }
-            // In MSIE, the true version is after 'MSIE' in userAgent
-            else if ((verOffset=nAgt.indexOf('MSIE'))!=-1) {
-                browserName = 'Microsoft Internet Explorer';
-                fullVersion = nAgt.substring(verOffset+5);
-            }
-            // In Chrome, the true version is after 'Chrome' 
-            else if ((verOffset=nAgt.indexOf('Chrome'))!=-1) {
-                browserName = 'Chrome';
-                fullVersion = nAgt.substring(verOffset+7);
-            }
-            // In Safari, the true version is after 'Safari' or after 'Version' 
-            else if ((verOffset=nAgt.indexOf('Safari'))!=-1) {
-                browserName = 'Safari';
-                fullVersion = nAgt.substring(verOffset+7);
-                if ((verOffset=nAgt.indexOf('Version'))!=-1) 
-                    fullVersion = nAgt.substring(verOffset+8);
-            }
-            // In Firefox, the true version is after 'Firefox' 
-            else if ((verOffset=nAgt.indexOf('Firefox'))!=-1) {
-                browserName = 'Firefox';
-                fullVersion = nAgt.substring(verOffset+8);
-            }
-            // In most other browsers, 'name/version' is at the end of userAgent 
-            else if ( (nameOffset=nAgt.lastIndexOf(' ')+1) < (verOffset=nAgt.lastIndexOf('/')) ) {
-                browserName = nAgt.substring(nameOffset,verOffset);
-                fullVersion = nAgt.substring(verOffset+1);
-                if (browserName.toLowerCase()==browserName.toUpperCase()) {
-                    browserName = navigator.appName;
-                }
-            }
-            // trim the fullVersion string at semicolon/space if present
-            if ((ix=fullVersion.indexOf(';'))!=-1)
-                fullVersion=fullVersion.substring(0,ix);
-            if ((ix=fullVersion.indexOf(' '))!=-1)
-                fullVersion=fullVersion.substring(0,ix);
-            
-            majorVersion = parseInt(''+fullVersion,10);
-            if (isNaN(majorVersion)) {
-                fullVersion  = ''+parseFloat(navigator.appVersion); 
-                majorVersion = parseInt(navigator.appVersion,10);
-            }
-            return { name: browserName.toLowerCase(), version: fullVersion, major: majorVersion };
-        }else{
-            return {};
+let staticInstance = null;
+export class Download{
+    constructor(){
+        if(staticInstance) return staticInstance;
+        this.promise = null;
+        staticInstance = this;
+    }
+    expect(){
+        this.promise = new Promise((resolve)=>{
+            this.resolve = resolve;
+        });
+        //if(isServer) this.flushPromise();
+        return this.promise;
+    }
+    flushPromise(result){
+        if(this.resolve){
+            this.resolve(result);
+            this.resolve = null;
         }
-    },
-    set(newValue) {
-        //do nothing
-    },
-    enumerable: true,
-    configurable: true,
-});
-
-const directoryGet = (type)=>{
-    if(isBrowser || isJsDom){
-        return handleCanonicalPath('home', File.os, File.user);
-    }else{
-        return process.cwd();
+        this.promise = null;
     }
-};
+    async observe(download){
+        const text = await download.text();
+        this.flushPromise(text);
+    }
+}
 
-Object.keys(canonicalLocationToPath['darwin']).forEach((key)=>{
-    // register all available keys
-    Object.defineProperty(File.directory, key, {
-        enumerable: true, configurable: true,
-        get() {
-            return directoryGet(key);
-        },
-        set(newValue){ }
-    });
-});
+(()=>{
+    globalThis.handleDownload = async (download)=>{
+        const root = Path.location('downloads');
+        const file = download.suggestedFilename();
+        const path = Path.join(root, file);
+        await download.saveAs(path);
+    };
+    if(variables.moka && variables.moka.bind){
+        //bind the input mechanics of File to moka
+        variables.moka.bind(bindInput());
+    }
+})();