alchemymvc 1.3.22 → 1.4.0-alpha.2

package/lib/{init/functions.js → core/alchemy_functions.js}

@@ -1,5 +1,3 @@
-'use strict';
-
 let mkdirp       = alchemy.use('mkdirp')?.mkdirp,
     ncp          = alchemy.use('ncp').ncp,
     fs           = alchemy.use('fs'),
@@ -27,7 +25,7 @@ spawnQueue.start();
 /**
  * Attach a conduit to a certain instance
  * 
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  0.2.0
  *
@@ -40,15 +38,15 @@ Informer.setMethod(function attachConduit(conduit) {
 /**
  * Get a model, attach a conduit if possible
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.3.0
  * @version  1.1.8
  *
- * @param   {String}   name      The name of the model to get
- * @param   {Boolean}  init      Initialize the class [true]
- * @param   {Object}   options
+ * @param    {string}   name      The name of the model to get
+ * @param    {boolean}  init      Initialize the class [true]
+ * @param    {Object}   options
  *
- * @return  {Model}
+ * @return   {Model}
  */
 Informer.setMethod(function getModel(name, init, options) {
 	return Blast.Classes.Alchemy.Base.prototype.getModel.apply(this, arguments);
@@ -57,11 +55,11 @@ Informer.setMethod(function getModel(name, init, options) {
 /**
  * Create a debug entry
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  0.2.0
  *
- * @param   {Number}   verbosity
+ * @param    {number}   verbosity
  */
 Informer.setMethod(function debug(verbosity) {
 
@@ -91,7 +89,7 @@ Informer.setMethod(function debug(verbosity) {
 	}
 
 	// Do nothing if debugging is off and verbosity is too high
-	if (!alchemy.settings.debug && options.verbosity > log.ERROR) {
+	if (!alchemy.settings.debugging.debug && options.verbosity > log.ERROR) {
 		return;
 	}
 
@@ -148,7 +146,7 @@ Informer.setMethod(function debug(verbosity) {
 		return item;
 	}
 
-	if (!duplicate && alchemy.settings.debug && options.data && options.data.args) {
+	if (!duplicate && alchemy.settings.debugging.debug && options.data && options.data.args) {
 		if (typeof options.level != 'number') {
 			options.level = 1;
 		}
@@ -162,11 +160,11 @@ Informer.setMethod(function debug(verbosity) {
 /**
  * Create a debug mark
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  0.2.0
  *
- * @param   {String}   message
+ * @param    {string}   message
  */
 Informer.setMethod(function debugMark(message) {
 	if (this._debugObject) {
@@ -331,12 +329,12 @@ Debugger.setMethod(function stop(message) {
 /**
  * Schedule a function in a low priority queue
  * 
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.0.1
  * @version  0.4.0
  *
  * @param    {Function}   fnc
- * @param    {Number}     wait   How long to wait before executing
+ * @param    {number}     wait   How long to wait before executing
  */
 Alchemy.setMethod(function lowPriority(fnc, wait) {
 
@@ -399,13 +397,13 @@ var _duplicateCheck = {};
 /**
  * Copy a directory
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.0.1
  * @version  0.4.0
  *
- * @param   {String}   source     The source path
- * @param   {String}   target     The target path
- * @param   {Function} callback   The function to call when done
+ * @param    {string}   source     The source path
+ * @param    {string}   target     The target path
+ * @param    {Function} callback   The function to call when done
  */
 Alchemy.setMethod(function copyDir(source, target, callback) {
 
@@ -418,14 +416,14 @@ Alchemy.setMethod(function copyDir(source, target, callback) {
 /**
  * Create a directory
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.0.1
  * @version  1.1.0
  *
- * @param   {String}   target     The target path
- * @param   {Function} callback   The function to call when done
+ * @param    {string}   target     The target path
+ * @param    {Function} callback   The function to call when done
  *
- * @return  {Promise}
+ * @return   {Promise}
  */
 Alchemy.setMethod(function createDir(target, callback) {
 
@@ -441,7 +439,7 @@ Alchemy.setMethod(function createDir(target, callback) {
 /**
  * Return the key:items of the first object that are no longer in the second
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.0.1
  * @version  1.3.22
  *
@@ -493,7 +491,7 @@ Alchemy.setMethod(function getDifference(first, second) {
 /**
  * Return the shared items
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.0.1
  * @version  1.3.22
  *
@@ -539,7 +537,7 @@ Alchemy.setMethod(function getShared(first, second) {
  * Make JSON-Dry handle ObjectIDs when drying
  * (Old class name)
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  0.2.0
  */
@@ -551,7 +549,7 @@ JSON.registerDrier('ObjectID', function dryOI(holder, key, value) {
  * Correctly un-dry ObjectIDs
  * (Old class name)
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  0.2.0
  */
@@ -562,7 +560,7 @@ JSON.registerUndrier('ObjectID', function undryOI(holder, key, value) {
 /**
  * Make JSON-Dry handle ObjectIds when drying
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.16
  * @version  1.3.16
  */
@@ -573,7 +571,7 @@ JSON.registerDrier('ObjectId', function dryOI(holder, key, value) {
 /**
  * Correctly un-dry ObjectIds
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.16
  * @version  1.3.16
  */
@@ -584,7 +582,7 @@ JSON.registerUndrier('ObjectId', function undryOI(holder, key, value) {
 /**
  * Monkey-patch checksum support to the ObjectId class
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.16
  * @version  1.3.16
  */
@@ -597,7 +595,7 @@ if (typeof mongo?.ObjectId == 'function') {
 /**
  * Create a new ObjectId
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.16
  * @version  1.3.16
  *
@@ -614,14 +612,14 @@ Alchemy.setMethod(function ObjectId(object_id) {
  * 
  * @deprecated Use Classes.Alchemy.Inode.File.getMimetype(path)
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  1.3.0
  *
- * @param    {String}   filepath   A path to the file
+ * @param    {string}   filepath   A path to the file
  * @param    {Function} callback
  *
- * @return   {Pledge<String>}
+ * @return   {Pledge<string>}
  */
 Alchemy.setMethod(function getMimetype(filepath, callback) {
 	const pledge = Classes.Alchemy.Inode.File.getMimetype(filepath);
@@ -632,11 +630,11 @@ Alchemy.setMethod(function getMimetype(filepath, callback) {
 /**
  * Get a medhash
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.7
  * @version  1.0.7
  *
- * @param    {String}    file_path   A path to the file
+ * @param    {string}    file_path   A path to the file
  * @param    {Object}    options
  */
 Alchemy.setMethod(function getMedhash(file_path, options) {
@@ -776,11 +774,11 @@ Alchemy.setMethod(function getMedhash(file_path, options) {
 /**
  * Hash the given file_path using the given hash
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.7
  * @version  1.3.0
  *
- * @param    {String}   file_path
+ * @param    {string}   file_path
  * @param    {Object}   options
  */
 Alchemy.setMethod(function hashFile(file_path, options) {
@@ -799,7 +797,7 @@ Alchemy.setMethod(function hashFile(file_path, options) {
 		};
 	}
 
-	hash_algorithm = options.algorithm || options.type || alchemy.settings.file_hash_algorithm || 'sha1';
+	hash_algorithm = options.algorithm || options.type || alchemy.settings.data_management.file_hash_algorithm || 'sha1';
 	digest_type = options.digest_type || 'hex';
 
 	let checksum = crypto.createHash(hash_algorithm),
@@ -836,11 +834,11 @@ Alchemy.setMethod(function hashFile(file_path, options) {
 /**
  * Get file statistics
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.7
  * @version  1.0.7
  *
- * @param    {String}   path      Path to stat
+ * @param    {string}   path      Path to stat
  * @param    {Object}   options
  *
  * @return   {Pledge}
@@ -868,11 +866,11 @@ Alchemy.setMethod(function statPath(path, options) {
 /**
  * Get basic file information
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.0.1
- * @version  1.3.0
+ * @version  1.4.0
  *
- * @param    {String}   filePath   A path to the file
+ * @param    {string}   filePath   A path to the file
  * @param    {Object}   options
  * @param    {Function} callback
  */
@@ -891,7 +889,7 @@ Alchemy.setMethod(function getFileInfo(filePath, options, callback) {
 
 	// Use sha1 as hashing default
 	if (typeof options.hash == 'undefined' || options.hash === true) {
-		options.hash = alchemy.settings.file_hash_algorithm || 'sha1';
+		options.hash = alchemy.settings.data_management.file_hash_algorithm || 'sha1';
 	}
 
 	// Get basic file information
@@ -906,11 +904,15 @@ Alchemy.setMethod(function getFileInfo(filePath, options, callback) {
 		tasks.hash = this.hashFile(filePath, options.hash);
 	}
 
-	// Get the filename
-	tasks.filename = function getFilename(next) {
-		var pieces = filePath.split('/');
-		next(null, pieces[pieces.length-1]);
-	};
+	if (options.filename) {
+		tasks.filename = options.filename;
+	} else {
+		// Get the filename
+		tasks.filename = next => {
+			let pieces = filePath.split('/');
+			next(null, pieces[pieces.length-1]);
+		};
+	}
 
 	// Get the extension
 	tasks.extension = function getExtension(next) {
@@ -970,12 +972,12 @@ Alchemy.setMethod(function getFileInfo(filePath, options, callback) {
 /**
  * Move or copy a file
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.0.1
  * @version  1.0.5
  *
- * @param    {String}   source     Origin path
- * @param    {String}   target     Target path
+ * @param    {string}   source     Origin path
+ * @param    {string}   target     Target path
  * @param    {Function} cb
  */
 function mcFile(type, source, target, cb) {
@@ -1049,12 +1051,12 @@ function mcFile(type, source, target, cb) {
 /**
  * Copy a file
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.0.1
  * @version  0.4.0
  *
- * @param    {String}   source     Origin path
- * @param    {String}   target     Target path
+ * @param    {string}   source     Origin path
+ * @param    {string}   target     Target path
  * @param    {Function} cb
  */
 Alchemy.setMethod(function copyFile(source, target, cb) {
@@ -1064,11 +1066,11 @@ Alchemy.setMethod(function copyFile(source, target, cb) {
 /**
  * Make an HTTP(S) request
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  1.1.0
  *
- * @param    {String}   url       The url
+ * @param    {string}   url       The url
  * @param    {Object}   options
  * @param    {Function} callback  Callback
  *
@@ -1102,11 +1104,11 @@ Alchemy.setMethod(function request(url, options, callback) {
 /**
  * Download a file
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.0
  * @version  1.3.0
  *
- * @param    {String}   url
+ * @param    {string}   url
  *
  * @return   {Pledge<File>}
  */
@@ -1201,13 +1203,13 @@ Alchemy.setMethod(function download(url, options) {
 /**
  * Download a url to a temporary location
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.1.0
  * @version  1.3.0
  * 
  * @deprecated   Use `download` instead
  *
- * @param    {String}   url       The url
+ * @param    {string}   url       The url
  * @param    {Object}   options
  * @param    {Function} callback  Callback
  */
@@ -1226,12 +1228,12 @@ Alchemy.setMethod(function downloadFile(url, options, callback) {
 /**
  * Move a file
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.0.1
  * @version  0.4.0
  *
- * @param    {String}   source     Origin path
- * @param    {String}   target     Target path
+ * @param    {string}   source     Origin path
+ * @param    {string}   target     Target path
  * @param    {Function} cb
  */
 Alchemy.setMethod(function moveFile(source, target, cb) {
@@ -1241,15 +1243,15 @@ Alchemy.setMethod(function moveFile(source, target, cb) {
 /**
  * Return the first path that works
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.5
  * @version  1.0.7
  *
- * @param    {String}   name             The name of the binary
- * @param    {String}   preferred_path   The preferred path
+ * @param    {string}   name             The name of the binary
+ * @param    {string}   preferred_path   The preferred path
  * @param    {Array}    fallbacks        Optional fallbacks
  *
- * @return   {String}
+ * @return   {string}
  */
 Alchemy.setMethod(function findPathToBinarySync(name, preferred_path, fallbacks) {
 
@@ -1296,7 +1298,7 @@ var shown_list_warning = false;
 /**
  * Create a list, an array with extra methods
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.0.1
  * @version  1.0.7
  * @deprecated
@@ -1324,11 +1326,11 @@ function listToString() {
 /**
  * Get the current time in nanoseconds
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.0.1
  * @version  0.4.0
  *
- * @return   {Number}
+ * @return   {number}
  */
 Alchemy.setMethod(function nanotime() {
 	var hrTime = process.hrtime();
@@ -1338,11 +1340,11 @@ Alchemy.setMethod(function nanotime() {
 /**
  * Start a very precise timer
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.0.1
  * @version  0.4.0
  *
- * @return   {String}   name
+ * @return   {string}   name
  */
 Alchemy.setMethod(function time(name) {
 
@@ -1363,11 +1365,11 @@ Alchemy.setMethod(function time(name) {
  * output the duration since the start to the console
  * and return the duration too.
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.0.1
  * @version  0.4.0
  *
- * @return   {String}   name
+ * @return   {string}   name
  */
 Alchemy.setMethod(function timeEnd(name, showNano, extra, iterated) {
 
@@ -1396,11 +1398,11 @@ Alchemy.setMethod(function timeEnd(name, showNano, extra, iterated) {
 /**
  * Get the total of all the registered durations for the given name
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.0.1
  * @version  0.4.0
  *
- * @return   {String}   name
+ * @return   {string}   name
  */
 Alchemy.setMethod(function timeTotal(name, showNano) {
 
@@ -1421,11 +1423,11 @@ Alchemy.setMethod(function timeTotal(name, showNano) {
  * (The value will be serialized once and then cached, so it should not change)
  * Alias method for Hawkejs#exposeStatic()
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.0
  * @version  1.1.0
  *
- * @param    {String}    name
+ * @param    {string}    name
  * @param    {Object}    value
  */
 Alchemy.setMethod(function exposeStatic(name, value) {
@@ -1435,7 +1437,7 @@ Alchemy.setMethod(function exposeStatic(name, value) {
 /**
  * Expose the default static variables
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.0
  * @version  1.3.1
  */
@@ -1456,12 +1458,12 @@ Alchemy.setMethod(function exposeDefaultStaticVariables() {
 	// Sort the models by their ancestor count
 	model_info.sortByPath(1, 'ancestors');
 
-	model_code = `function inheritModel(parent, child) {
-		return Classes.Hawkejs.Model.getClass(child, true, parent);
+	model_code = `function inheritModel(parent_model_name, child_model_name) {
+		return Classes.Hawkejs.Model.getClass(child_model_name, true, parent_model_name);
 	}\n`;
 
 	for (let info of model_info) {
-		model_code += 'inheritModel(' + JSON.stringify(info.parent) + ', ' + JSON.stringify(info.name) + ')\n';
+		model_code += 'inheritModel(' + JSON.stringify(info.parent) + ', ' + JSON.stringify(info.model_name) + ')\n';
 	}
 
 	// Expose the model configuration
@@ -1484,15 +1486,17 @@ Alchemy.setMethod(function exposeDefaultStaticVariables() {
 	// Expose prefixes
 	hawkejs.exposeStatic('prefixes', Prefix.all());
 
+	const websockets = alchemy.settings.network.use_websockets;
+
 	// Are websockets enabled?
-	if (!alchemy.settings.websockets || alchemy.settings.websockets == 'optional') {
+	if (!websockets || websockets == 'optional' || websockets == 'never') {
 		hawkejs.exposeStatic('enable_websockets', false);
 	} else {
 		hawkejs.exposeStatic('enable_websockets', true);
 	}
 
 	// Expose the layout settings
-	hawkejs.exposeStatic('alchemy_layout', alchemy.settings.layout);
+	hawkejs.exposeStatic('alchemy_layout', alchemy.settings.frontend.ui.layout);
 
 	let app_version = alchemy.package.version;
 
@@ -1513,7 +1517,7 @@ Alchemy.setMethod(function exposeDefaultStaticVariables() {
 /**
  * Regenerate exposed route data
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.0
  * @version  1.3.0
  */
@@ -1536,7 +1540,7 @@ Alchemy.setMethod(function exposeRouteData() {
  * Flush the exposed route data
  * (Will only regenerate if default static variables haven't been generated yet)
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.0
  * @version  1.3.0
  */
@@ -1552,11 +1556,11 @@ Alchemy.setMethod(function checkExposedRouteData() {
 /**
  * Read directory contents
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.0
  * @version  1.1.0
  *
- * @param    {String}   path
+ * @param    {string}   path
  * @param    {Object}   options
  *
  * @return   {Pledge}
@@ -1629,4 +1633,22 @@ Alchemy.setMethod(function readDir(path, options) {
 	});
 
 	return pledge;
+});
+
+/**
+ * Connect to another alchemy instance
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.0
+ * @version  0.4.0
+ */
+Alchemy.setMethod(function callServer(address, data, callback) {
+
+	var server = new Classes.ClientSocket();
+
+	server.reconnect = false;
+
+	server.connect(address, data, callback);
+
+	return server;
 });