jsgui3-server 0.0.82 → 0.0.85

package/resources/website-resource.js

@@ -2,6 +2,18 @@
  * Created by James on 29/07/2014.
  */
 
+// 2022 - Seems a little uncertain about what it is for, and what it does has grown over time.
+
+
+
+// A Website abstraction and a Website_Publisher seem like a good way forward.
+
+
+// Want to make a near future release have a web publishing system that is easier to use as well as more
+// powerful.
+
+// Publishing static sites, rendering and compiling.
+
 // Represents (and is?) a website itself, and its representation available through the Resource system.
 
 
@@ -49,6 +61,17 @@
 //  It would be much more secure to bring up an NTP provision service automatically than a file system one. Don't want to take that risk now.
 //
 
+// Possibly WebPack could be considered such a resource? Or find a different type for that type of resource?
+
+// Compilation_Resource and Compiler_Resource...
+
+
+// Maybe should do more to represent a website on a server.
+// Maybe it needs more docs, being rather critical.
+
+
+
+
 var Site_Images = require("./website-image-resource");
 
 //console.log('1) Site_Images', Site_Images);
@@ -61,19 +84,19 @@ const Resource = jsgui.Resource;
 const Router = jsgui.Router;
 //const Evented_Class = jsgui.Evented_Class;
 
-var Resource_Pool = require("./server-resource-pool");
+const Resource_Pool = require("./server-resource-pool");
 //var Resource_Web_Admin = require('../web-admin');
 
-var Site_JavaScript = require("./website-javascript-resource");
+const Site_JavaScript = require("./website-javascript-resource");
 //console.log('1) Site_JavaScript', Site_JavaScript);
-var Site_CSS = require("./website-css-resource");
-var Site_Static_HTML = require("./website-static-html-resource");
+const Site_CSS = require("./website-css-resource");
+const Site_Static_HTML = require("./website-static-html-resource");
 //var DB_Web_Resource = require('../../web/db-resource-postgres');
 //var database_resource_factory = require('../../db/resource/factory');
 
-const Resource_Publisher = require("../publishing/resource-publisher");
-const Observable_Publisher = require("../publishing/observable-publisher");
-const Function_Publisher = require("../publishing/function-publisher");
+const Resource_Publisher = require("../publishing/http-resource-publisher");
+const Observable_Publisher = require("../publishing/http-observable-publisher");
+const Function_Publisher = require("../publishing/http-function-publisher");
 //const Data_Resource = require("./data-resource");
 
 // Proxy_Server_Resource possibly.
@@ -84,279 +107,43 @@ const Function_Publisher = require("../publishing/function-publisher");
 
 //  May help with FirstPoint_Server.
 
+// Could move the publishing parts to Website_Resource_Publisher perhaps.
 
 
 
-class Website_Resource extends Resource {
-  constructor(spec = {}) {
-    super(spec);
-    // A bit of a special resource here because it has its own resource_pool.
-    var resource_pool = new Resource_Pool({
-      name: "Website Resource Pool"
-    });
-    this.resource_pool = resource_pool;
-    var database_spec = spec.database;
-    var web_database_resource;
-
-    if (database_spec) {
-      database_spec.name = database_spec.name || database_spec.database_name;
-      var database_resource = database_resource_factory(database_spec);
-      database_resource.start();
-      // should start automatically when in the pool?
-      //  does the pool need to be told to start?
-      // Though probably don't want to start the resource on initialization.
-      resource_pool.add(database_resource);
-      web_database_resource = new DB_Web_Resource({
-        database: database_resource,
-        meta: {
-          name: "Web DB",
-          pool: resource_pool
-        }
-      });
-    }
-
-    if (web_database_resource) {
-      resource_pool.add(web_database_resource);
-    }
-
-    var router = new Router({
-      name: "Site Router"
-    });
+// Maybe worth just having a Website object.
+//  Then the Website_Resource can encapsulate that.
 
-    this.router = router;
+// Better if this wraps the Website object?
 
-    var spec_web_admin = {
-      //'web_database': web_database_resource,
-      meta: {
-        name: "Web Admin"
-      }
-    };
-
-    //if (web_database_resource) {
-    //  spec_web_admin.web_database = web_database_resource;
-    //}
-
-    var img_resource = new Site_Images({
-      //'meta': {
-      name: "Site Images",
-      pool: resource_pool
-      // }
-    });
-
-    var js_resource = new Site_JavaScript({
-      //'meta': {
-      name: "Site JavaScript",
-      pool: resource_pool
-      //}
-    });
+// A Website has its own Website Resource Pool?
 
-    // Also want a static HTML server.
-    //  Would serve index.html by default I think???
-    //   Probably with the static or simplest settings.
-
-    var static_html_resource;
-
-    if (spec == "static") {
-      static_html_resource = new Site_Static_HTML({
-        //'meta': {
-        name: "Static HTML",
-        pool: resource_pool
-        //}
-      });
-      resource_pool.push(static_html_resource);
-      // Perhaps set it up with the specific files (automatically)?
-      //  Probably with the index.html
-    }
-    var css_resource = new Site_CSS({
-      //'meta': {
-      name: "Site CSS",
-      pool: resource_pool
-      //}
-    });
+// Make Website_Resource into the wrapper that wraps Website?
+// Or we don't need that, just use HTTP_Website_Publisher.
 
+// Maybe this won't be necessary in various cases.
 
-    js_resource.on('extracted-controls-css', str_extracted_css => {
-      css_resource.serve_str_css('controls.css', str_extracted_css);
-      // Will serve this as controls.css
-      //  Separate HTTP request, will get more CSS for the moment.
+// For the moment won't make this website resource do all that much.
 
-    });
-    // javascript and css resources.
-    resource_pool.push(router);
-    resource_pool.push(img_resource);
-    resource_pool.push(js_resource);
-    resource_pool.push(css_resource);
-    //resource_pool.push(data_resource);
-
-    // anything ending in .css as well.
-    //  Routing maybe wouldn't work like that.
-    //router.set_route('*.css', css_resource, css_resource.process);
-
-    router.set_route("css/*", css_resource, css_resource.process);
-    router.set_route("js/*", js_resource, js_resource.process);
-    // As well as this, it could get the JavaScript resource to serve the JavaScript from the app's js directory.
-    js_resource.serve_directory("js");
-    router.set_route("i/*", img_resource, img_resource.process);
-    router.set_route("img/*", img_resource, img_resource.process);
-    router.set_route("imgs/*", img_resource, img_resource.process);
-    router.set_route("images/*", img_resource, img_resource.process);
-    this.map_resource_publishers = this.map_resource_publishers || {};
-    router.set_route("resources/:resource_name/*", this, (req, res) => {
-      let { url, method } = req;
-      let s_url = url.split("/");
-      let resource_short_name = s_url[2];
-      let resource_publisher = this.map_resource_publishers[resource_short_name];
-      if (resource_publisher) {
-        resource_publisher.handle_http(req, res);
+class Website_Resource extends Resource {
+  constructor(spec = {}) {
+    super(spec);
+    // A bit of a special resource here because it has its own resource_pool.
+    let website;
+    if (spec.website) website = spec.website;
+    Object.defineProperty(this, 'website', {
+      get() {
+        return website;
       }
     });
-    if (!is_defined(spec)) spec = {};
-    this.resource_pool = resource_pool;
-  }
-
-  publishing_get_pub(item) {
-    let pub;
-    if (item instanceof jsgui.Resource) {
-      pub = new Resource_Publisher({
-        resource: item
-      });
-    } else {
-      // if its a function
-      //  return that function call to the response.
-      let t_item = typeof item;
-      if (t_item === "function") {
-        // Function_Call_Publisher
-        // could respec this.
-        // And the Function_Publisher operates through the Publisher API. Not sure what that is right now though.
-
-        pub = new Function_Publisher({
-            fn: item
-        });
-        //this.map_resource_publishers[published_name] = pub;
-        // 
-      } else {
-        if (item.next && item.complete && item.error) {
-          // assuming observable
-          // Observable publisher
-          //  One way sending...
-          //console.log('using Observable_Publisher');
-          pub = new Observable_Publisher({
-              obs: item
-          });
-          // or not a resource publisher, an observable publisher.
-          //this.map_resource_publishers = this.map_resource_publishers || {};
-          //this.map_resource_publishers[published_name] = obs_pub;
-
-          //console.log('2) this', this);
-          //console.log('this.map_resource_publishers', this.map_resource_publishers);
-          //console.trace();
-        } else {
-          console.log("item", item);
-          throw "Unrecognised item type. Possibly node module versions are wrong / have not been linked fully.";
-        }
-      }
-      //if (item instanceof Evented_Class) {
-    }
-    return pub;
-  }
-
-  // publish within resources?
-  publish(published_name, item, schema) {
-    let sig = get_a_sig(arguments),
-      a = arguments,
-      l = a.length;
-    const single = (published_name, item) => {
-      if (item instanceof jsgui.Resource) {
-        let resource_publisher = new Resource_Publisher({
-          resource: item,
-          name: published_name
-        });
-        this.map_resource_publishers[published_name] = resource_publisher;
-
-        item.name = item.name || published_name;
-        // add that resource!
-        //  (to the pool?)
-        //console.log('item', item);
-        this.resource_pool.add(item);
-
-        //console.log('Object.keys(this.map_resource_publishers)', Object.keys(this.map_resource_publishers));
-      } else {
-        // if its a function
-        //  return that function call to the response.
-        let t_item = typeof item;
-        if (t_item === "function") {
-          // Function_Call_Publisher
-          // could respec this.
-
-          // And the Function_Publisher operates through the Publisher API. Not sure what that is right now though.
-          //   directly attaching the resource publishers?
-          let pub = new Function_Publisher({
-              fn: item,
-              schema: schema
-          });
-          this.map_resource_publishers[published_name] = pub;
-          // 
-
-        } else {
-          if (item.next && item.complete && item.error) {
-            let obs_pub = new Observable_Publisher({
-                obs: item,
-                schema: schema
-            });
-            this.map_resource_publishers[published_name] = obs_pub;
-          } else {
-            console.log("item", item);
-            throw "Unrecognised item type. Possibly node module versions are wrong / have not been linked fully.";
-          }
-        }
-        //if (item instanceof Evented_Class) {
-      }
-    };
-
-    if (sig === "[o]") {
-        each(a[0], (v, i) => {
-            single(i, v);
-        })
-    } else {
 
-        single(published_name, item);
-    }
-  }
-
-  get resource_names() {
-    //console.log('this.resource_pool', this.resource_pool);
-    return this.resource_pool.resource_names;
-  }
-
-  get_resource(resource_name) {
-    var resource_pool = this.resource_pool;
-    //console.log('resource_pool', resource_pool);
-
-    //console.log('this._.resource_pool', this._.resource_pool);
-
-    //throw 'stop';
-    return resource_pool.get_resource(resource_name);
-  }
-
-  get def_resource_publishers() {
-    const res = {};
-    each(this.map_resource_publishers, (rp, name) => {
-
-        let def = {
-            name: name,
-            type: rp.type
-        }
-        res[name] = def;
-        if (rp.type === 'function') {
-            if (rp.schema) def.schema = rp.schema;
-        }
-    });
-    return res;
   }
 
   start(callback) {
-    var resource_pool = this.resource_pool;
-    resource_pool.start(callback);
+    //var resource_pool = this.resource_pool;
+    //resource_pool.start(callback);
+
+    callback(null, true);
   }
 
   meets_requirements() {
@@ -366,37 +153,6 @@ class Website_Resource extends Resource {
 
     return true;
   }
-
-  // Needs to be able to process HTTP requests. A bit like the Router in that way.
-  process(req, res) {
-    //console.log('website process request req.url', req.url);
-    //throw 'stop';
-
-    var remoteAddress = req.connection.remoteAddress;
-    var router = this.router;
-    var res_process = router.process(req, res);
-    if (res_process === false) {
-      if (req.url === "/") {
-        // Send this to the static HTML processing system.
-
-        var static_html_resource = this.resource_pool.get_resource(
-          "Static HTML"
-        );
-        //console.log('static_html_resource', static_html_resource);
-        // And lets get the static resource to process it
-        if (static_html_resource) {
-          static_html_resource.process(req, res);
-        }
-      } else {
-        // show a 404
-        res.writeHead(404, {
-          "Content-Type": "text/plain"
-        });
-        res.write("404 Not Found\n");
-        res.end();
-      }
-    }
-  }
 }
 
 module.exports = Website_Resource;

package/resources/website-static-html-resource.js

@@ -47,7 +47,6 @@ var serve_html_file_from_disk = function(filePath, response) {
 //  jsx may seem / be easiest at this stage for long term expansion and integration.
 
 
-
 class Site_Static_HTML extends Resource {
 
 	constructor(spec) {

package/resources/website-template-html-resource.js

@@ -0,0 +1,231 @@
+var path = require('path'), fs = require('fs'),
+	url = require('url'), jsgui = require('jsgui3-html'), os = require('os'), http = require('http'), libUrl = require('url'),
+	Resource = jsgui.Resource,
+	Cookies = require('cookies'), fs2 = require('../fs2');
+
+var stringify = jsgui.stringify, each = jsgui.each, arrayify = jsgui.arrayify, tof = jsgui.tof;
+var filter_map_by_regex = jsgui.filter_map_by_regex;
+var Class = jsgui.Class, Data_Object = jsgui.Data_Object, Enhanced_Data_Object = jsgui.Enhanced_Data_Object;
+var fp = jsgui.fp, is_defined = jsgui.is_defined;
+var Collection = jsgui.Collection;
+
+// Extends AutoStart_Resource?
+// May need to change around a fair few references to make it workable.
+// May need some more complicated logic to change it to the path for service.
+
+// Maybe this will be / need a Compiler.
+
+// website-html-resource....
+//  may be useful to have / use a Resource for the HTML servinh=g / compilation.
+
+// Consider the server as an HTML compiler? Or a more complex compiler?
+
+// Seems more like loading server-side compilers is the way.
+//  Load them into jsgui.
+
+// lang.load_compiler
+
+
+
+
+
+
+
+var serve_fn_html_template_from_disk = function(filePath, fn_template, obj_data, response) {
+
+    // serve templated file as html...
+
+	fs2.load_file_as_string(filePath, function (err, data) {
+
+
+		if (err) {
+			throw err;
+		} else {
+            const templated = fn_template(data, obj_data);
+
+
+
+
+			//var servableJs = updateReferencesForServing(data);
+			response.writeHead(200, {'Content-Type': 'text/html'});
+			response.end(templated);
+		}
+	});
+}
+
+
+// File_Server_Resource?
+//  So the resource has code to route to the file and then serve it.
+
+// Also a Templated_HTML resource?
+//  Connects to HTML_Template
+//  Connects to Data_Resource
+//  Populates the HTML_Template data from the Data_Resource
+
+// HTML_Template being a Data_Transformation / Data_Transformation_Resource / Transformation_Resource
+//  Codecs could be another type of Transformation_Resource
+
+// Transformation Resource could / should appear in jsgui3-client. Makes sense on the client too.
+
+// Separate loading of transformation resource, data resource, and template (resource)
+//  The transformation resource can itself load / be provided with the data resource and template resource.
+
+// jsx processing may be the best way (by far)?
+
+// or jsui templates?
+//  jsx may seem / be easiest at this stage for long term expansion and integration.
+
+
+
+class Site_Template_HTML extends Resource {
+
+	constructor(spec) {
+		super(spec);
+
+		this.meta.set('custom_paths', new Data_Object({}));
+		// Those are custom file paths.
+
+		// could have a collection of directories, indexed by name, that get served.
+
+		// Index the collection by string value?
+		this.meta.set('served_directories', new Collection({'index_by': 'name'}));
+	}
+	'start'(callback) {
+		callback(null, true);
+	}
+	'set_custom_path'(url, file_path) {
+		// But change the URL to have a smiley face instead of fullstops
+		//console.log('url', url);
+		var escaped_url = url.replace(/\./g, '☺');
+		//console.log('escaped_url', escaped_url);
+
+		//this.meta.set('custom_paths.' + escaped_url, file_path);
+		var custom_paths = this.meta.get('custom_paths');
+		//console.log('custom_paths', custom_paths);
+		custom_paths.set(escaped_url, file_path);
+
+	}
+	'serve_directory'(path) {
+		// Serves that directory, as any files given in that directory can be served from /js
+		var served_directories = this.meta.get('served_directories');
+		//console.log('served_directories ' + stringify(served_directories));
+		//served_directories.push(path);
+		served_directories.push({
+			'name': path
+		});
+		//console.log('served_directories ' + stringify(served_directories));
+		//console.log('path ' + path);
+
+		//throw 'stop';
+
+	}
+	'process'(req, res) {
+		//console.log('Site_Static_HTML processing');
+		var remoteAddress = req.connection.remoteAddress;
+		var custom_paths = this.custom_paths;
+		var rurl = req.url;
+		var pool = this.pool;
+		// should have a bunch of resources from the pool.
+		//var pool_resources = pool.resources();
+		//console.log('pool_resources ' + stringify(pool_resources));
+
+		var url_parts = url.parse(req.url, true);
+		//console.log('url_parts ' + stringify(url_parts));
+		var splitPath = url_parts.path.substr(1).split('/');
+		//console.log('resource site css splitPath ' + stringify(splitPath));
+
+		if (rurl.substr(0, 1) == '/') rurl = rurl.substr(1);
+		rurl = rurl.replace(/\./g, '☺');
+		//console.log('rurl ' + rurl);
+
+		if (rurl == '') rurl = '/';
+		var custom_response_entry = custom_paths.get(rurl);
+		//console.log('Static HTML Resource process url', req.url);
+
+
+		//console.log('custom_response_entry ' + stringify(custom_response_entry));
+
+		if (custom_response_entry) {
+			var tcr = tof(custom_response_entry);
+			//console.log('tcr ' + tcr);
+			if (tcr == 'data_value') {
+				var val = custom_response_entry.value();
+				//console.log('val ' + val);
+				var tval = tof(val);
+				if (tval === 'string') {
+					// then it should be a local file path, serve it.
+                    // need to specify a template resource / algorithm.
+
+					serve_html_file_from_disk(val, res);
+				}
+			}
+			//throw 'stop';
+		} else {
+			//console.log('splitPath', splitPath);
+			//console.log('splitPath.length', splitPath.length);
+
+			if (splitPath.length > 0) {
+
+				// Can check for /js folder.
+				//  There will be some fixed resources for the site.
+				//   They will be served by Resource objects.
+				//  There may be some overlap of resources, with there being some very fixed purpose
+				//   specific resources that could duplicate some features of the more general ones.
+				//   Eventually, some of the code from the more specific resources will be
+				//   replacable with code from the more general ones.
+
+				// Site_JavaScript resource
+				//  Will serve JavaScript files needed for the site.
+				//   Could become more advanced at some points, serving particular builds.
+
+				if (splitPath.length == 1) {
+					if (splitPath[0] == '') {
+						// Serve the default page.
+						// serve index.html
+						//serve_html_file_from_disk('./index.html', res);
+						serve_html_file_from_disk('index.html', res);
+
+
+
+
+					}
+				} else {
+					if (splitPath[0] == 'html') {
+						//var sjs = pool.get_resource('Site JavaScript');
+						//console.log('sjs ' + sjs);
+
+						//throw 'stop';
+
+						// determine the name of the file to serve, serve that file
+						//  Could use some more general kind of file server.
+
+						if (splitPath.length > 1) {
+							if (splitPath.length == 2) {
+								var fileName = splitPath[1];
+								//console.log('url_parts.path ' + url_parts.path);
+								var filePath = url_parts.path.substr(1);
+								//console.log('module.uri ' + module.uri);
+
+								// No, need the current module's relative path....
+
+								//var val2 =  path.dirname(module.uri);
+								//console.log('val2 ' + val2);
+								//throw '9) stop';
+
+								//var diskPath = val2 + '/../css/' + fileName;
+								var diskPath = '../../ws/css/' + fileName;
+
+								serve_html_file_from_disk(diskPath, res);
+							} else {
+								if (splitPath.length == 3) {
+
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+}
+module.exports = Site_Template_HTML;