hfs 0.1.6 → 0.26.2

package/lib/vfs.js

@@ -1,403 +0,0 @@
-/**
- * @author Massimo Melina <a@rejetto.com> 
- */ 
-require('./common');
-
-exports.Vfs = Vfs = function(){
-    this.root = new FileNode(NK.FIXED);
-    this.root.name = '/';
-}; // Vfs
-
-Vfs.prototype.fromUrl = function(url, cb) {
-    assert(cb, 'no cb');
-    assert( typeof url === 'string', 'url');
-    var separator = 0;
-    var run = this.root;
-    while (separator < url.length-1) {
-        var from = separator+1;
-        var nextSep = url.indexOf('/', from);
-        if (nextSep < 0) {
-            nextSep = url.length;
-        }
-        var piece = url.substring(from, nextSep);
-        if (piece && !run.isFolder() // something has left but we cannot go deeper
-        || run.hasDeleted(piece)) { 
-            cb(false);
-            return this;
-        }
-        var child = run.getChildByName(piece);
-        if (!child && run.isOnDisk()) { // if not in the VFS tree, try to fill the gap with the disk
-            run.createFileNodeFromRelativeUri(url.substring(from), function(newNode){
-                cb(newNode || false);
-            });
-            return this;
-        }
-        if (!child) { // we did our best
-            cb(false);
-            return this;
-        }
-        run = child; 
-        separator = nextSep;
-    }
-    cb(run);
-    return this;
-}; // fromUrl
-
-exports.FileNode = FileNode = function(nodeKind, name, more, cb) {
-    this.nodeKind = nodeKind;
-    this.itemKind = FK.VIRTUAL_FOLDER;
-    this.set( name||'', cb );
-    this.extend(more||{});
-    //this.children = []; // as a list. An object with fast by-name access would be nice, but it would not work for case-insensitive OSs  
-    this.deletedItems = [];
-    this.permissions = {};
-}; // FileNode
-
-/* Node kinds
-    FIXED: is a node manually entered in the tree.
-    MOD: it was a TEMP or SEMITEMP node, then modified some way (name, permissions, etc).  
-    SEMITEMP: it's a folder between 2 non-temp nodes. It's just storing the file structure between these two.          
-    TEMP: a node created on the fly, from the disk, for occasional usage. 
-*/
-NK = FileNode.NODE_KIND = Enum('FIXED TEMP SEMITEMP MOD');
-FK = FileNode.FILE_KIND = Enum('FILE FOLDER VIRTUAL_FILE VIRTUAL_FOLDER LINK');
-
-FileNode.prototype.__defineSetter__('name', function(v){
-    this.customName = (v === this.getExpectedName()) ? null : v;
-    this.reconsiderNodeKind(); 
-});
-FileNode.prototype.__defineGetter__('name', function(){
-    return this.customName || this.getExpectedName();
-});
-
-FileNode.prototype.__defineSetter__('parent', function(v){
-    var p = this._parent; 
-    if (p && p.children) {
-        var idx = p.children.indexOf(this);
-        p.children.splice(idx, idx+1); // unbind from old parent
-    }
-    this._parent = v; // bind this way    
-    if (!v || this.isTemp()) return; // TEMP are linked one-way 
-    if (!v.children) v.children = [];
-    v.children.push(this); // bind other way 
-});
-FileNode.prototype.__defineGetter__('parent', function(){
-    return this._parent;
-});
-
-FileNode.prototype.getExpectedName = function(){
-    return this.isUnit() ? this.resource
-        : path.basename(this.resource); 
-};
-
-FileNode.prototype.resourceAncestorOf = function(child){
-    return isPathAndSubpath(this.resource, child.resource);
-};
-
-function isPathAndSubpath(path_, sub) {
-    path_ = path.resolve(path_); 
-    sub = path.resolve(sub); 
-    return misc.sameFileName(path_, sub.substr(0, path_.length));
-} // isPathAndSubpath
-
-FileNode.prototype.getFolder = function(cb){
-    var p = this.parent;
-    var parentTreeIsNotParentFolder = false;
-    if (this.isTemp()) {
-        var rel = this.resourceOnlyRelativeTo(p);
-        parentTreeIsNotParentFolder = rel && isPath(rel);  
-    }  
-    if (parentTreeIsNotParentFolder) {
-        return new FileNode(NK.TEMP, path.dirname(this.resource), {parent:p}, cb); // we must create a temp node
-    }     
-    if (cb) cb(p);
-    return p;
-};
-
-/** calculates the path relative to other, but only if other is an ancestor 
- * @param {FileNode}
- * @return {string} relative path
- */
-FileNode.prototype.resourceOnlyRelativeTo = function(other){
-    return other.resourceAncestorOf(this)
-        ? this.resource.substr(other.resource.length+1)
-        : false;  
-}; // resourceOnlyRelativeTo
-
-/** calculates the path relative to other, or return the absolute path if they are not related 
- * @param {FileNode}
- * @return {string} path, possibly relative
- */
-FileNode.prototype.resourceRelativeTo = function(other){ 
-    return this.resourceOnlyRelativeTo(other) || this.resource
-}; // resourceRelativeTo
-
-FileNode.prototype.isRoot = function() { return !this.parent };
-FileNode.prototype.isFolder = function() { return this.itemKind.isIn(FK.FOLDER, FK.VIRTUAL_FOLDER) };
-FileNode.prototype.isFile = function() { return this.itemKind.isIn(FK.FILE, FK.VIRTUAL_FILE) };
-FileNode.prototype.isLink = function() { return this.itemKind === FK.LINK };
-FileNode.prototype.isOnDisk = function() { return this.itemKind.isIn(FK.FILE, FK.FOLDER) };
-FileNode.prototype.isVirtual = function() { return this.itemKind.isIn(FK.VIRTUAL_FILE, FK.VIRTUAL_FOLDER) };
-FileNode.prototype.isTemp = function() { return this.nodeKind === NK.TEMP };
-
-FileNode.prototype.toString = function() { return "FileNode({name})".format(this) };
-
-FileNode.prototype.isUnit = function() {
-    return misc.isWindows
-        && this.resource
-        && this.resource.length === 2
-        && this.resource[1] === ':';
-};
-
-FileNode.prototype.setPath = function(what, cb/*optional*/) {
-    this.resource = path.normalize(what);
-    this.stats = null; // 'null' stands for non-calculated
-    this.itemKind = null; // we don't know yet
-    var x = this;
-    fs.stat(this.resource, function onStat(err,stats){
-        x.stats = err ? false : stats; // 'false' stands for 'error'
-        x.itemKind = (!err && stats.isDirectory()) ? FK.FOLDER : FK.FILE;
-        if (cb) cb(x);
-    });
-
-    return this;
-}; // setPath
-
-function isPath(s) { return s.match(/[\\\/]/) } // we know it's a path because of the slashes
-
-FileNode.prototype.set = function(what, cb/*optional*/) {
-    if (isPath(what)) {
-        this.setPath(what, cb);
-    }
-    else {
-        this.name = what;
-        this.resource = null;
-        this.itemKind = FK.VIRTUAL_FOLDER; 
-        if (cb) cb(this);
-    }
-    return this;
-}; // set
-
-FileNode.prototype.add = function(what, cb/*optional*/) {
-    var restored = isPath(what)
-        && this.deletedItems
-        && isPathAndSubpath(this.resource, what)
-        && this.restoreDeleted(path.basename(what));
-    new FileNode(restored ? NK.TEMP : NK.FIXED, what, {parent:this}, cb); // create child
-    return this;    
-}; // add
-
-// return child as it is in the tree. Temp items will not be created. 
-FileNode.prototype.getChildByName = function(name) {
-    if (!this.children) return false;
-    for (var i=0, a=this.children, l=a.length; i<l; ++i) {
-        var v = a[i];
-        if (v.testName(name)) {
-            return v;
-        }
-    }
-    return false;
-}; // getChildByName
-
-// return children as an array. This is not only to ensure it's a copy (to protect the real property) but also to hide the detail that children is an array (in case this changes in the future)
-FileNode.prototype.getChildren = function() { 
-    var a = this.children;
-    return a ? a.slice() : [];
-}; // getChildren
-
-// compares filenames accordingly to the operating system's case policy
-FileNode.prototype.testName = function(name) {
-    if (name instanceof FileNode) {
-        name = name.name;
-    }
-    assert(typeof name === 'string', 'bad name');
-    return misc.sameFileName(name, this.name);
-}; // testName
-
-FileNode.prototype.idxDeleted = function(name) {
-    name = name.excludeTrailing('/');
-    for (var i=0, a=this.deletedItems, l=a.length; i<l; ++i) {
-        if (misc.sameFileName(name, a[i].excludeTrailing('/'))) {
-            return i;
-        }
-    }
-    return false;
-}; // idxDeleted
-
-FileNode.prototype.hasDeleted = function(name) { 
-    return this.idxDeleted(name) !== false;
-}; // hasDeleted
-
-FileNode.prototype.restoreDeleted = function(name) {
-    var i = this.idxDeleted(name);
-    if (i === false) {
-        return false;
-    }
-    this.deletedItems.splice(i,1); // remove from the array
-    return true;
-}; // restoreDeleted
-
-FileNode.prototype.createFileNodeFromRelativeUri = function(uri, cb) {
-    assert(cb, 'cb');
-    var p = path.join(this.resource, decodeURI(uri).excludeTrailing('/'));
-    var _this = this;
-    fs.exists(p, function(yes){
-        if (yes) {
-            new FileNode(NK.TEMP, p, {parent:_this}, cb);
-            return;
-        }
-        cb(null);
-    });
-
-    return this;
-}; // createFileNodeFromRelativeUri
- 
-// used for serialization
-FileNode.prototype.toJSON = function(){
-    var o = misc.clone(this);
-    delete o.parent; // avoid circular reference
-    o.name = this.name;
-    if (this.children) { 
-        // children will be replaced by an array of names  
-        var names = [];
-        for (var i=0, a=this.children, l=a.length; i<l; ++i) { // must work on this.children and not on o.children, that's not cloned correctly
-            names.push(a[i].name);
-        }
-        o.children = names;            
-    }
-    return o;
-}; // toJSON
-
-
-FileNode.prototype.dir = function(cb) {
-    var _this = this; // used inside some callbacks that override this
-    var directoryLoaded = arguments[1]; // used internally
-    if (!directoryLoaded) {
-        if (this.isOnDisk()) { // for real folders we must first load files
-            fs.readdir(this.resource, function onReaddir(err, files) { // read them
-                assert(!err, 'err'); // ** handle it!
-                _this.dir(cb, files); // restart
-            });
-            return; // recurring, break this flow
-        }
-        directoryLoaded = []; // this is a virtual this, so there is no directory to load from disk
-    }
-
-
-    // create FileNodes for every file found in the directory, except the deleted ones
-    var toNode = function(filename,cb){
-        _this.hasDeleted(filename)
-            ? cb(null,false) // don't create a filenode, so this file will be skipped
-            : _this.createFileNodeFromRelativeUri(filename, cb.bind(this,null)); // the just-created filenode is appended as parameter to the cb's calling
-    };  
-    async.map(directoryLoaded, toNode, function(err, mappedNodes){
-        // collect all items in an object to avoid duplicates (by using filename as key)
-        var items = {};
-        // first the items from the disk
-        for (var a=directoryLoaded, i=a.length; i--;) {
-            var fnode = mappedNodes[i];
-            if (fnode) {
-                items[a[i]] = fnode;
-            }
-        }
-        // then items from the VFS, so they eventually overwrite
-        if (_this.children) {
-            _this.children.forEach(function(e){
-                items[e.name] = e;
-            });
-        }
-        // now collect more data about items (through fs.stat)
-        async.forEach(items.getProperties(), function(it,doneThis) { 
-            if (!it.isOnDisk()) return doneThis(); // no need to work this item
-            fs.stat(it.resource, function onStat(err,stats){
-                if (err) { // if we can't stat() it ...
-                    delete items[it.name]; // ... we don't want it
-                }
-                else {
-                    it.stats = stats; // bind the data
-                    it.itemKind = stats.isDirectory() ? FK.FOLDER : FK.FILE; // determine item's nature
-                }
-                doneThis(); // notify async
-            });//stat
-        }, cb.bind(this, items)); // finally returns (asynchronously)
-    });
-}; // dir
-
-FileNode.prototype.reconsiderNodeKind = function() {
-    var anyMod = this.resource && (this.customName || this.permissions || this.deletedItems); // is this node storing any modification
-    
-    switch (this.nodeKind) {
-        case NK.FIXED:
-            return; // we'll never change this
-        case NK.MOD:
-            if (anyMod) return; // no change needed
-            // we should not be MOD anymore. We must be SEMITEMP if any child is non-temp, otherwise TEMP.
-            anyNonTemp = false;
-            for (var i=0, a=this.children, l=a.length; i<l; ++i) {
-                if (anyNonTemp = (!a[i].isTemp())) break;
-            }
-            if (anyNonTemp) {
-                this.nodeKind = NK.SEMITEMP;
-                return;
-            }        
-            this.nodeKind = NK.TEMP;
-            // becoming TEMP, we must remove the reference hold by the parent
-            var v = this.parent;
-            if (!v) return;
-            v = v.children;
-            var i = v && v.indexOf(this);
-            assert(v && i>=0, 'mod-nodes should be always linked to their parents');
-            v.splice(i, 1);
-            this.parent.reconsiderNodeKind();
-            return;
-        case NK.TEMP:
-        case NK.SEMITEMP:
-            if (!anyMod) return;   
-            this.nodeKind = NK.MOD; // we got some mods, so this is now a MOD
-            // create a filenode for each subfolder between "this" and its parent 
-            var p = this.parent; 
-            assert(p, 'parent');
-            var v = this.resourceRelativeTo(p); // path relative to the parent
-            v = v.split(/[\\/]/); // to pieces
-            v.pop(); // take out last piece, already incarnated by "this"
-            v.forEach(function(v) {
-                p = new FileNode(NK.SEMITEMP, v, {parent:p}); // make a new node, and link it to the last one
-            });
-            this.parent = p; // now link to the last node
-            if (p.isTemp()) {
-                p.nodeKind = NK.SEMITEMP;
-            }
-            return;
-        default:
-            assert(0, 'bad nodeKind');             
-    }    
-}; // reconsiderNodeKind
-
-FileNode.prototype.getURI = function(trailingSlashForFolders) {
-    if (this.isRoot()) return '/';
-    return this.parent.getURI()
-        + encodeURI(this.name)
-        + (this.isFolder() ? '/' : '');
-}; // getURI 
-
-FileNode.prototype.delete = function(cb){
-    switch (this.nodeKind) {
-        case NK.TEMP:
-            var _this = this;
-            this.getFolder(function(fldr){
-                assert(fldr, 'root?');
-                if (fldr.hasDeleted(_this.resource)) return; // we have it already in                 
-                fldr.deletedItems.push(
-                    path.basename(_this.resource) + (_this.isFolder() ? '/' : '')
-                );
-                fldr.reconsiderNodeKind();
-            });
-            break;
-        case NK.MOD:
-        case NK.FIXED:
-            this.parent = null;
-            break;
-        default:
-            assert(0, 'bad nodeKind');             
-    }
-}; // delete

package/main.js

@@ -1,24 +0,0 @@
-/**
- * @author Massimo Melina <a@rejetto.com> 
- */ 
-require('./lib/common');
-debug();
-GLOBAL.vfs = new vfsLib.Vfs();
-vfs.root.set('C:\\vedere').add('c:\\data\\pics\\fantasy');
-vfs.root.add('2', function(node){ node.add('3') });
-
-var fileServer = require('./file-server');
-var listenOn = {port:8, ip:'0.0.0.0'};
-fileServer.start(listenOn);
-
-var adminServer = require('./admin-server');
-var adminOn = {port:88, ip:'127.0.0.1'};
-adminServer.start(adminOn);
-
-
-// still trying
-function debug(){
-    require('net').createServer(function(sock){
-        require('repl').start('debug> ', sock, undefined, true);
-    }).listen('6969');
-}

package/note.txt

@@ -1,104 +0,0 @@
-=== FEASIBILITY
-distribution: how? size?
-    https://github.com/wearefractal/npkg
-    npm install hfs
-system integration
-    some of these features are expected to not be possible with Node, but must be verified.
-    Those who are not possible will be achieved with a different executable communicating with node possibly via socket.
-        background notifications
-            Windows' tray icons
-        automatic handling starting/restaring of the server
-            Windows' services
-        easy way to add to the VFS, possibly starting HFS if it's not running
-            Windows' shell context menu                   
-
-=== DESIGN
-- GUI: all web
-- admin on different port, to eventually accept connection only in local
-- executable helper to get some features:
-    - tray icon for
-        - start/stop
-        - easy access to administration
-        - notification
-    - shell context menu
-        - add files via right click
-    - Windows' service
-- webservices
-    - it should be possible to build an ajax-based webapp, like a straight template like for HFS 2.2
-        - both webservices and template engine
-        - does the webapp need a template engine at all or should it all be done via ajax?
-            - login
-            - folder list
-            - navigate folders (get folder by folder, or whole tree for speed?)
-            - search
-            - select & action (archive, delete, rename...)
-- the web apps must perfectly working offline, don't rely on online resources (or do it just as an option or gracefully degrade)
-           
-=== GUI
-libraries to evaluate
-    extjs
-    amplesdk http://www.amplesdk.com/examples/markup/xul/
-    pergola http://www.dotuscomus.com/pergola/examples.html            
-
-=== FRONT END
-login (cookie based)
-
-switch on url resource type
-    case 'file': serve file
-    case 'link': redirect
-    case 'folder':
-        switch ($format)
-            case nothing: serve front-end web app, with this folder already selected
-            case 'tar': serve archive
-            case 'zip': serve archive
-            default: unknown
-
-http://superdit.com/2011/06/01/extjs-simple-file-browser/
-    
-=== VFS
-- able to
-    - add virtual items, (will override others with same name)
-    - add real items, (override) 
-    - renamed, (a real item with customName. Remember that an existance check is always done)
-    - deleted, (this make the item with same resource to be skipped)
-        these are not child nodes, but are the names are kept in an object of the folder
-    - various options set (like hidden, permission, log, counting, comment, realm, icon)
-- file node permissions by account (values: anyone, anonymous, any account, account list)
-    - NOT the old "access", it's just download+browse         
-    - visible (this will make this item appear or not in lists, but won't prevent download)
-        default: anyone
-    - browse (only folders: prevent display of items inside, but with a message, not as if the folder was empty [recursive])
-        default: anyone
-    - download/stream [recursive] 
-        default: anyone
-    - archive [recursive]
-        default: anyone
-    - upload (only folders [recursive])
-        default: no one
-    - delete [recursive]
-        default: no one
-- options and metadata
-    - log (allow logging of this item [recursive])
-        default: yes
-    - logMask (only folders [recursive])
-        default: *
-    - count as download [recursive]
-        default: yes
-    - count as download Mask (only folders [recursive])
-        default: *
-    - upload mask (only folders [recursive])
-        default: * 
-    - visibility mask (only folders [recursive])
-        default: *
-    - download mask (only folders [recursive])
-        default: *  
-    - default file mask (only folders [recursive])
-        default: index.htm*;default.html*
-    - ?(leave it to future versions) auto-hide empty folders (folders only)
-        default: no
-    - hide extension [recursive]
-        default: no                
-    - comment            
-    - icon
-    - ? message when not allowed
-- permissions and options have default values that are enforced when not assigned, to not clutter the stored data structure

package/speedtest.js

@@ -1,21 +0,0 @@
-/**
- * @fileOverview This should show the best performance we can expect
- * @author Massimo Melina <a@rejetto.com> 
- */ 
-var v = process.argv;
-var myGigFile = v.length >= 3 ? v[2] : '/bigfile.avi';
-
-var http = require('http');
-var fs = require('fs');
-
-var srv = http.createServer(function(httpReq,httpRes){
-    console.log('serving');
-
-    httpRes.writeHead(200);
-    fs.createReadStream(myGigFile).pipe(httpRes);
-});
-
-var port = 888;
-srv.listen(port, '0.0.0.0', function onListen(){
-    console.log('listening on '+port);
-});

package/static/backend.css

@@ -1,14 +0,0 @@
-body { font:10pt verdana, arial, sans-serif; }
-a img { border:0; } /* conform IE */
-#vfs ul { list-style:none; padding:0; }
-#vfs ul ul { list-style:none; padding-left:3em; }
-#vfs li { border:2px solid transparent; padding:0.1em 0.2em }
-#vfs li.selected { background:#ddf; border-color:#99f; }
-#vfs li.hovered { background:#eee; }
-#vfs .expansion-button { margin-right:0.5em; cursor:pointer; }
-#vfs .expansion-button.hovered { background-color:#ddd; }
-#vfs li.collapsed>ul { display:none; } 
-#vfs .no-children { color:#888; }
-#vfs .no-children:before,
-#vfs .no-children:after { content:"..."; }
-#vfs li .icon img { height:1.5em; margin-right:0.5em; vertical-align:middle;  }

package/static/backend.html

@@ -1,32 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-	<meta charset="UTF-8" />
-	<title>HFS 3 back end</title>
-    <link rel="stylesheet" type="text/css" href="/~/backend.css" /> 
-
-	<!--[if lt IE 9 ]> <script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script> <![endif]-->
-	<script src='/socket.io/socket.io.js'></script>
-    <script src='/~/jquery.js'></script> 
-    <script src='/~/extending.js'></script> 
-    <script src='/~/misc.js'></script> 
-	<script src='/~/backend.js'></script>
-    </head>
-<body>
-    <h1>Back end</h1>
-    <div id='pane-vfs'>
-        <h2>Virtual File System</h2>
-        <div id='vfs-buttons'>
-            <button id='bindItem'>bind to disk</button>
-            <button id='addItem'>add item</button>
-            <button id='renameItem'>rename</button>
-            <button id='deleteItem'>delete</button>
-        </div>
-        <div id='vfs'>
-        </div>        
-    </div>
-    <form>
-        <input id='just-for-focus-tests' />
-    </form>
-</body>
-</html>