@naanlang/naan 1.0.1 → 1.0.4

package/frameworks/client/apiclient.nlg

@@ -6,7 +6,7 @@
  *
  * column positioning:                          //                          //                      !
  *
- * Copyright (c) 2017-2021 by Richard C. Zulch
+ * Copyright (c) 2017-2022 by Richard C. Zulch
  *
  */
 
@@ -20,9 +20,10 @@
  *
  */
 
-closure MakeNideAPIclient(url, local client) {
+closure MakeNideAPIclient(url, guid, local client) {
     client = new(object, this)
     client.url = url
+    client.guid = guid
     client.notifyAfter = 0
 
     // clientRequest() - general request routine
@@ -51,6 +52,8 @@ closure MakeNideAPIclient(url, local client) {
             request.responseType = options.responseType
         if options.contentType
             request.setRequestHeader("Content-Type", options.contentType)
+        if guid
+            request.setRequestHeader("x-naanlang-api-guid", guid)
         request.send(options.putdata)
     }
 
@@ -117,7 +120,7 @@ closure MakeNideAPIclient(url, local client) {
     // Otherwise if communication failed then the result is:
     //      callback(<error>).
 
-    client.psmRemote = closure psmRemote(options, data, callback, local query, method, reqOptions) {
+    client.psmRemote = closure psmRemote(options, data, callback, local query, method, reqOptions, error) {
         query = EncodeQuery("/psm/?", options)
         if data
             method = "PUT"
@@ -131,6 +134,16 @@ closure MakeNideAPIclient(url, local client) {
                 reqOptions.contentType = "application/octet-stream"         // we are sending binary data
             else
                 reqOptions.responseType = "arraybuffer"                     // we are requesting binary data
+        } else if options.encoding == "json" {
+            if data {
+                reqOptions.contentType = "application/json;charset=UTF-8"   // we are sending JSON
+                `(error, data) = JsonStringify(data)
+                if error
+                    return (callback(Error("psmRemote failed:", error)))
+                reqOptions.putdata = data
+            }
+            else
+                reqOptions.responseType = "application/json"                // we are requesting JSON
         }
         clientRequest(method, url.concat(query), reqOptions, function (error, req, event, local data) {
             if !error && req.status != 200
@@ -172,7 +185,7 @@ closure MakeNideAPIclient(url, local client) {
 
 function apicInit(local manifest) {
 
-    manifest = `(apic, apicInit)
+    manifest = `(MakeNideAPIclient, apicInit)
 
     Naan.module.build(module.id, "apiclient", function(modobj, compobj) {
         Naan.module.require("./client.nlg")

package/frameworks/client/psm_client.nlg

@@ -22,6 +22,44 @@ closure psmcFsView(api, rootpath, local view, pathmod) {
     view = new(object, this)
     view.api = api
     view.rootpath = rootpath
+    
+    // data
+    //
+    // Return the filesystem data, i.e. the tree data field. The minimum information is:
+    //      platform    -- e.g. "darwin" or "win32"
+    //      semantics   -- e.g. "win32" or "posix"
+    //      pathsep     -- e.g. / or \
+
+    view.data = closure data(callback) {
+        if !callback
+            return (syncAdapter(data))
+        params = {
+            path: ""
+            op: "tree"
+            depthlimit: 0
+        }
+        api.psmRemote(params, false, function(error, tree) {
+            view.fsdata = tree.data
+            callback(error, tree.data)
+        })
+    }
+    
+    // pathInit
+    //
+    // Initialize our path module for the applicable path type.
+    
+    closure pathInit(local result) {
+        result = view.data()
+        if result.0
+            pathmod = false
+        else {
+            if view.fsdata.pathsep == "\\"
+                pathmod = JSpath.win32
+            else
+                pathmod = JSpath.posix
+            false
+        }
+    }
 
     // psmRemote
     //
@@ -30,10 +68,14 @@ closure psmcFsView(api, rootpath, local view, pathmod) {
     closure psmRemote(path, op, options, putdata, callback, local params, item) {
         if !callback
             return (syncAdapter(psmRemote, path, op, options, putdata))
+        if !pathmod && pathInit()
+            return                                                          // failed to initialize path module
         if !string(path)
             return (asyncResult(callback, Error("invalid path:", typeof(path))))
+        if rootpath != ""
+            path = pathmod.resolve(rootpath, path)
         params = {
-            path: JSpath.resolve(rootpath, path)
+            path: path
             op: op
         }
         for item in options
@@ -59,38 +101,30 @@ closure psmcFsView(api, rootpath, local view, pathmod) {
 
     // path
     //
-    // The path sub-object remotes calls to the NodeJS path module.
+    // Redirect path calls to module chosen for filesystem semantics. It is possible for this to fail
+    // on first connection to the filesystem, in which case we return false for the path result.
+    // Throwing an error would complicate our callers and testing. This way there's a small chance
+    // that a transient error will give a bad path, but that will be detected downstream.
 
     view.path = new(object, this)
-    view.path[".undefined"] = closure path args {
-        closure (selector, arglist, local error, info) {
-            if !pathmod {
-                `(error, data) = view.data()
-                if error
-                    return (list(error))
-                if info.pathsep == "\\"
-                    pathmod = JSpath.win32
-                else
-                    pathmod = JSpath.posix
-            }
-            xapply(pathmod, selector, arglist)
-        } (args.0, args.-1)
+    view.path[".undefined"] = function path args {
+        if !pathmod
+            pathInit()
+        xapply(pathmod, args.0, args.-1)
     }
     
-    // data
+    // folderPath
     //
-    // Return the filesystem data, i.e. the tree data field. The minimum information is:
-    //      platform    -- e.g. "darwin" or "win32"
-    //      semantics   -- e.g. "win32" or "posix"
-    //      pathsep     -- e.g. / or \
-
-    view.data = closure data(callback) {
-        if !callback
-            return (syncAdapter(data))
-        psmRemote("", "tree", { depthlimit: 0 }, false, function(error, tree) {
-            view.fsdata = tree.data
-            callback(error, tree.data)
-        })
+    // Return the path of the specified special folder:
+    //      "HomeDir"
+    //      "TempDir"
+    //      "PackageDir"
+    // The returned path is relative to our root if within it, or absolute otherwise.
+    
+    view.folderPath = function folderPath(folderID, callback) {
+        psmRemote("", "folderPath", {
+            folderid: folderID
+        }, false, callback)
     }
                
     // readLines
@@ -123,7 +157,28 @@ closure psmcFsView(api, rootpath, local view, pathmod) {
     view.writeFile = function writeFile(path, data, options, callback) {
         psmRemote(path, "writeFile", options, data, callback)
     }
-            
+      
+    // readlink
+    //
+    // Read the contents of a symbolic link at the specified path
+    
+    view.readlink = function readlink(path, callback) {
+        psmRemote(path, "readlink", { }, false, callback)
+    }
+
+    // symlink
+    //
+    // Create a symbolic link path pointing to (containing the string) target
+    
+    view.symlink = function symlink(target, path, options, callback) {
+        if options
+            options = new(options)
+        else
+            options = { }
+        options.target = target
+        psmRemote(path, "symlink", options, false, callback)
+    }
+      
     // delete
     //
     // Delete a file or directory at the specified path
@@ -134,12 +189,45 @@ closure psmcFsView(api, rootpath, local view, pathmod) {
 
     // info
     //
-    // Get file info at the specified path
+    // Get file or directory info at the specified path
+    
+    view.info = function info(path, options, callback) {
+        if !options
+            options = { }
+        psmRemote(path, "info", options, false, callback)
+    }
+          
+    // setInfo
+    //
+    // Set file or directory info obtained from info() call.
     
-    view.info = function info(path, callback) {
-        psmRemote(path, "info", { }, false, callback)
+    view.setInfo = function setInfo(path, info, callback) {
+        psmRemote(path, "setInfo", {
+            encoding: "json"
+        }, info, callback)
     }
      
+    // setOwnerGroup
+    //
+    // Set file or directory owner or group at the specified path
+    
+    view.setOwnerGroup = function setOwnerGroup(path, uid, gid, callback) {
+        psmRemote(path, "setOwnerGroup", {
+            uid: uid
+            gid: gid
+        }, false, callback)
+    }
+     
+    // setMode
+    //
+    // Set file or directory mode at the specified path
+    
+    view.setMode = function setMode(path, mode, callback) {
+        psmRemote(path, "setMode", {
+            mode: mode
+        }, false, callback)
+    }
+
     // setTimes
     //
     // Set file modify and access times at the specified path
@@ -157,7 +245,7 @@ closure psmcFsView(api, rootpath, local view, pathmod) {
     
     view.dirList = function dirList(path, options, callback) {
         psmRemote(path, "dirList", {
-            head: options.head
+            stat: options.stat
         }, false, callback)
     }
 
@@ -167,7 +255,7 @@ closure psmcFsView(api, rootpath, local view, pathmod) {
     
     view.readir = function readir(path, callback) {
         psmRemote(path, "dirList", {
-            head: true
+            stat: true
         }, false, callback)
     }
 
@@ -209,7 +297,9 @@ closure psmcFsView(api, rootpath, local view, pathmod) {
     // delete the source after the copy.
     
     view.copy = closure copy(srcpath, dest, options, callback, local parameters) {
-        if !options
+        if options
+            options = new(options)
+        else
             options = { }
         options.destination = JSpath.resolve(rootpath, dest)
         psmRemote(srcpath, "copy", options, false, callback)
@@ -325,7 +415,7 @@ closure psmcFsConnector(psm, nicc, local connClassID, connector, watch) {
     connector.psm = psm
     connector.api = nicc.api
     connector.vault = psm.vault(connClassID)
-    connector.label = "Naan IDE Server"
+    connector.label = "Naan-Server"
     watch = psm.watchable(connector)
 
     // uifields
@@ -337,57 +427,44 @@ closure psmcFsConnector(psm, nicc, local connClassID, connector, watch) {
             placeholder:    "http://host.com/endpoint"
             key:            "urlName" },
         {
-            label:          "Auth Name"
-            placeholder:    "account name"
-            key:            "authName" },
-        {
-            label:          "Auth Password"
-            placeholder:    "account password"
-            key:            "authPW"
-            type:           "password" },
+            label:          "Auth Secret"
+            placeholder:    "guid"
+            key:            "authSecret" }
         ]
     }
-        
-    // hashResourceID
-    //
-    // Make a stable hash based on the resource credentials that we can persist or share between
-    // different domains accessing the same resource.
-    connector.hashResourceID = function hashResourceID(resource, local ident) {
-        ident = resource.urlName
-        if resource.label
-            ident = ident.concat(resource.label)
-        HashSHA256(ident)
-    }
 
     // findResource
     //
-    // Find a resource with the specified contents, returning the resID or false. The loose criteria
-    // is: if added, would the specified contents be redundant to an existing resource?
+    // Find a resource with the specified contents, returning the resID or false.
     connector.findResource = function findResource(resource, local resID, creds) {
         for resID in listResources().1 {
             creds = access(resID).1
-            if resource.urlName == creds.urlName
-                && (!resource.label || resource.label == creds.label)
-                && resource.authName == creds.authName
+            if ((!resource.urlName || resource.urlName == creds.urlName)
+                && (!resource.label || resource.label == creds.label))
                 return (resID)
         }
         false
     }
 
-    // addResource
+
+    // writeResource
     //
-    // Add credentials for a named resource. The resource is a dictionary comprising these keys:
+    // Add or update credentials for a named resource. If no resID is specified this adds a new
+    // resource; otherwise it updates an existing one. The resource is a dictionary comprising these
+    // keys:
     //      label       - [optional] label we use for this resource
     //      urlName     - URL (e.g. "http://host.com/node/fsapi")
-    //      authName    - [optional] the authentication name for a URL
-    //      authPW      - [optional] the autentication password, required if authname is provided
+    //      authSecret  - access-control token for this URL
     //      hidden      - [optional] don't enumerate to user
     //      locked      - [optional] don't allow user delete
     //
-    // The return value is (error, resID) tuple. Error, if non-false, is a dictionary of field
+    // The return value is an (error, resID) tuple. Error, if non-false, is a dictionary of field
     // keys and error diagnostic strings.
-    connector.addResource = function addResource(resource, local creds, errors, error, resID, data) {
+    connector.writeResource = function writeResource(resource, resID,
+        local creds, errors, error, data, change) {
+        // badField - test for a bad string
         function badField(str) { !string(str) || str.trim().length == 0 }
+
         creds = { urlName: resource.urlName }
         errors = { }
         if resource.label
@@ -396,13 +473,13 @@ closure psmcFsConnector(psm, nicc, local connClassID, connector, watch) {
             creds.label = resource.urlName
         if badField(creds.label)
             errors.label = "invalid label"
+        else if !resID && findResource({ label: creds.label })
+            errors.label = "duplicate name"
         if badField(resource.urlName)
             errors.urlName = "required field"
-        if !badField(resource.authName) {
-            creds.authName = resource.authName
-            creds.authPW = resource.authPW
-            if badField(resource.authPW)
-                errors.authPW = "required if Auth Name specified" }
+        if badField(resource.authSecret)
+            errors.authSecret = "required field"
+        creds.authSecret = resource.authSecret
         if length(errors) > 0
             error = errors
         else {
@@ -410,14 +487,36 @@ closure psmcFsConnector(psm, nicc, local connClassID, connector, watch) {
                 creds.hidden = resource.hidden
             if resource.locked
                 creds.locked = resource.locked
-            resID = hashResourceID(resource)
-            `(error, data) = connector.vault.addResource(resID, creds)
+            if resID {
+                `(error, data) = connector.vault.updateResource(resID, creds)
+                change = { changed: [resID] }
+            } else {
+                resID = UUID()
+                `(error, data) = connector.vault.addResource(resID, creds)
+                change = { added: [resID] }
+            }
             if data {
-                watch.notify(connClassID, { added: [resID] })
-                data = resID } }
+                watch.notify(connClassID, change)
+                data = resID
+            }
+        }
         list(error, data)
     }
-    
+
+    // addResource
+    //
+    // Add a new resource, returning a standard error tuple per writeResource.
+    connector.addResource = function addResource(resource) {
+        writeResource(resource)
+    }
+
+    // updateResource
+    //
+    // Update an existing resource, returning a standard error tuple per writeResource.
+    connector.updateResource = function updateResource(resID, resource) {
+        writeResource(resource, resID)
+    }
+
     // getResource
     //
     // Get credentials for a named resource, matching the dictionary semantics of addResource. The
@@ -432,10 +531,8 @@ closure psmcFsConnector(psm, nicc, local connClassID, connector, watch) {
         }
         if string(creds.urlName)
             resource.urlName = creds.urlName
-        if string(creds.authName)
-            resource.authName = creds.authName
-        if string(creds.authPW)
-            resource.authPW = creds.authPW
+        if string(creds.authSecret)
+            resource.authSecret = creds.authSecret
         list(false, resource)
     }
     
@@ -510,7 +607,7 @@ closure psmcFsConnector(psm, nicc, local connClassID, connector, watch) {
             if creds == "HostFS"
                 api = connector.api
             else
-                `(error, api) = MakeNideAPIclient(creds.urlName)            // API to remote NodeJS filesystem
+                api = MakeNideAPIclient(creds.urlName, creds.authSecret)    // API to remote NodeJS filesystem
         }
         if error
             list(error)

package/frameworks/common/common.nlg

@@ -66,7 +66,7 @@ function JsonParse(data) {
         list(false, data)
     } catch {
         if true
-             list(exception)
+            list(exception)
     }
 };
 
@@ -84,7 +84,7 @@ function JsonStringify(data) {
         list(false, data)
     } catch {
         if true
-             list(exception)
+            list(exception)
     }
 };
 
@@ -256,6 +256,8 @@ TextEncoder = false;
 TextDecoder = false;
 EncodeURIComponent = false;
 DecodeURIComponent = false;
+EncodeBase64 = false;
+DecodeBase64 = false;
 JSONstringify = false;
 JSONparse = false;
 
@@ -289,6 +291,10 @@ function comrInit(local manifest) {
             EncodeURIComponent = wsg.encodeURIComponent
             DecodeURIComponent = wsg.decodeURIComponent
             //
+            // everywhere: Base65
+            EncodeBase64 = wsg.btoa
+            DecodeBase64 = wsg.atob
+            //
             // everywhere: JSON
             JSONstringify = wsg.JSON.stringify
             JSONparse = wsg.JSON.parse
@@ -338,7 +344,7 @@ function comrInit(local manifest) {
             //
             DecodeBase64url = function decodeBase64url(base64url, local padding) {
                 base64url = base64url.replace(RegExp("-", "g"), '+').replace(RegExp("_", "g"), '/')
-                wsg.atob(base64url)
+                DecodeBase64(base64url)
             }
             //
             // For browser windows and web workers
@@ -358,7 +364,7 @@ function comrInit(local manifest) {
                 //
                 // HashMD5 in base64
                 HashMD5_base64 = function browserMD5_base64(data) {
-                    wsg.btoa(browserMD5(data, true)) }
+                    EncodeBase64(browserMD5(data, true)) }
                 //
                 // browserDigest - only in secure contexts (localhost and HTTPS)
                 //
@@ -431,6 +437,8 @@ function comrInit(local manifest) {
                     HashMD5 =
                     HashMD5_base64 =
                     HashSHA1 =
+                    HashSHA256 =
+                    HashSHA256_base64 =
                     RandomBytes = function() { throw(Error("crypto functions unavailable")) }
                 }
             }
@@ -442,6 +450,8 @@ function comrInit(local manifest) {
             modobj.exports.TextDecoder = TextDecoder
             modobj.exports.EncodeURIComponent = EncodeURIComponent
             modobj.exports.DecodeURIComponent = DecodeURIComponent
+            modobj.exports.EncodeBase64 = EncodeBase64
+            modobj.exports.DecodeBase64 = DecodeBase64
             modobj.exports.JSONstringify = JSONstringify
             modobj.exports.JSONparse = JSONparse
             modobj.exports.JsonStringify = JsonStringify

package/frameworks/node/apiserver.nlg

@@ -6,7 +6,7 @@
  *
  * column positioning:                          //                          //                      !
  *
- * Copyright (c) 2017-2021 by Richard C. Zulch
+ * Copyright (c) 2017-2022 by Richard C. Zulch
  *
  */
 
@@ -36,6 +36,7 @@ closure MakeAPI(port, options, callback, local chroot, server) {
     server.psm = require("./psm_server.nlg").MakeServerPSM(server)
     server.root = chroot
     server.app = express()
+    server.guid = options.guid
     server.notifyq = []
     server.responseq = []
     server.projects = { }
@@ -99,8 +100,9 @@ closure MakeAPI(port, options, callback, local chroot, server) {
     // body parsing
     //
 
-    server.app.use(bodyParser.text({limit: "20mb"}))
-    server.app.use(bodyParser.raw({limit: "20mb"}))
+    server.app.use(bodyParser.json({limit: "5mb"}))
+    server.app.use(bodyParser.text({limit: "25mb"}))
+    server.app.use(bodyParser.raw({limit: "25mb"}))
 
     //
     // Express.js endpoints
@@ -108,8 +110,12 @@ closure MakeAPI(port, options, callback, local chroot, server) {
 
     server.app.use(function(req,res,next) {
         res.header("Access-Control-Allow-Origin", "*")
-        res.header("Access-Control-Allow-Methods", "GET, POST, PUT, DELETE")
-        next()
+        res.header("Access-Control-Allow-Methods", "GET, HEAD, POST, PUT, PATCH, DELETE, OPTIONS")
+        res.header("Access-Control-Allow-Headers", "x-naanlang-api-guid")
+        if req.method == "OPTIONS"
+            res.sendStatus(200)
+        else
+            next()
     })
 
     server.app.use("", express.static(chroot))
@@ -121,15 +127,18 @@ closure MakeAPI(port, options, callback, local chroot, server) {
     //  "/"
 
     server.app.get("/", function(req, res) {
-        res.send("<u>NaanIDE API</u><br>\r\n"
+        res.send("<u>naan-server API</u><br>\r\n"
         "   /readfile?path=<i>filepath</i><br>\r\n"
         "   /status?timeout=<i>msec</i>&after=<i>stamp</i><br>\r\n")
     })
 
     //  "/readfile"
 
-    server.app.get("/readfile", closure(req, res) {
-        if not string(req.query.path)
+    server.app.get("/readfile", closure(req, res, local guid) {
+        guid = req.get("x-naanlang-api-guid")
+        if server.guid && guid != server.guid
+            res.status(403).send("unauthorized")
+        else if not string(req.query.path)
             res.status(400).send("Invalid filename")
         else if RegExp("^\\.\\.[/\\\\]|[/\\\\]\\.\\.$|[/\\\\]\\.\\.[/\\\\]").test(req.query.path)
             res.status(403).send("\"Parent path references forbidden\"")
@@ -156,7 +165,10 @@ closure MakeAPI(port, options, callback, local chroot, server) {
 
     //  "/status"
 
-    server.app.get("/status", closure(req,res, local timeoutms, after, responder) {
+    server.app.get("/status", closure(req, res, local guid, timeoutms, after, responder) {
+        guid = req.get("x-naanlang-api-guid")
+        if server.guid && guid != server.guid
+            res.status(403).send("unauthorized")
         timeoutms = toint(req.query.timeout)
         after = toint(req.query.after)
         if not integer(timeoutms) or timeoutms > 10000
@@ -187,8 +199,11 @@ closure MakeAPI(port, options, callback, local chroot, server) {
 
     //  "/psm"
 
-    server.app.all("/psm", closure(req, res) {
-        if !server.hostfs
+    server.app.all("/psm", closure(req, res, local guid) {
+        guid = req.get("x-naanlang-api-guid")
+        if server.guid && guid != server.guid && req.method !== "OPTIONS"
+            res.status(403).send("unauthorized")
+        else if !server.hostfs
             res.status(503).send("host filesystem not available")
         else
             server.hostfs.api(req, res)
@@ -227,7 +242,6 @@ closure MakeAPI(port, options, callback, local chroot, server) {
         server.ws = WebSocketServer(server)
         server.port = port
         callback(false, port, server)                                           // notify of success
-        debuglog("server open on port", port)
         result = server.psm.conns.NodeFS.connect("Host", "NideFS", list(""))    // ### this should go through resource tracker
         if result.0
             ErrorDebuglog(Error("can't access HostFS", result.0))
@@ -264,7 +278,7 @@ closure WebSocketServer(server, local websocks) {
     // Event handlers
 
     websocks.wss.on("connection", function(socket, request) {
-        websocks.conns.push(WesCon(websocks, socket, request))
+        websocks.conns.push(WesCon(server, websocks, socket, request))
     })
                 
     server.wss.on("error", function(error) {
@@ -303,7 +317,7 @@ closure WebSocketServer(server, local websocks) {
  *
  */
 
-closure WesCon(websocks, socket, request, local wescon) {
+closure WesCon(server, websocks, socket, request, local wescon) {
     wescon = new(object, this)
     wescon.socket = socket
     wescon.serverIDs = []
@@ -315,7 +329,9 @@ closure WesCon(websocks, socket, request, local wescon) {
     socket.on("message", function onmessage(text, local message, error) {
         try {
             message = new(js.g.JSON.parse(text))
-            if message.clientID && websocks.subsystems[message.serverID] {
+            if server.guid && message.guid != server.guid
+                error = Error("unauthorized")
+            else if message.clientID && websocks.subsystems[message.serverID] {
                 wescon.serverIDs.push(message.serverID)                     // ### track subsystems for closing
                 websocks.subsystems[message.serverID].wsReceive(message, wescon)
             }