Finally finished the massive refactor... transitions still broke but it's fine for now.

This commit is contained in:
2018-10-28 11:23:51 +11:00
parent 8cf714500c
commit d5d0c7edd2
36 changed files with 397 additions and 531 deletions

86
private/server/api/API.js Normal file
View File

@ -0,0 +1,86 @@
// Copyright (c) 2018 Dominic Masters
//
// MIT License
//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
const
path = require('path'),
fs = require('fs')
;
const API_BASE = path.resolve(__dirname, 'methods');
const API_URL_BASE = '/api';
module.exports = class API {
constructor(server) {
this.server = server;
this.handlers = [];
}
getHandlers() {return this.handlers;}
getServer() {return this.server;}
getApp() {return this.getServer().getApp();}
getExpress() {return this.getServer().getExpress();}
getConfig() {return this.getApp().getConfig();}
getEmail() {return this.getApp().getEmail();}
addHandler(handler) {this.handlers.push(handler);}
registerHandlers() {
this.handlers.forEach(handler => {
handler.getMethods().forEach(method => {
method = method.toLowerCase();
//For each method, there's perhaps multiple paths (e.g. post /test, get /test, post /ayy, get /ayy)
handler.getPaths().forEach(path => {
let url = API_URL_BASE;
if(!path.startsWith('/')) url += '/';
url += path;
this.getExpress()[method](url, handler.onMethod.bind(handler));
console.log('Registering ' + url + '...');
});
});
});
}
loadHandlers() {
this.loadHandlersInDirectory(API_BASE);
this.registerHandlers();
}
loadHandlersInDirectory(dir) {
let assets = fs.readdirSync(dir);
assets.forEach(asset => {
let assetPath = path.join(dir, asset);
let stats = fs.statSync(assetPath);
if(stats.isDirectory()) {
this.loadHandlersInDirectory(assetPath );
return;
}
let method = require(assetPath);
let instance = new method(this);
this.addHandler(instance);
});
}
}

View File

@ -0,0 +1,54 @@
// Copyright (c) 2018 Dominic Masters
//
// MIT License
//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
const
API = require('./API'),
APIRequest = require('./APIRequest')
;
class APIHandler {
constructor(api, methods, paths) {
if(!(api instanceof API)) throw new Error('Invalid API Supplied!');
if(typeof methods === typeof undefined) methods = ['GET'];
if(typeof paths === typeof undefined) paths = [];
if(typeof methods === "string") methods = [ methods ];
if(typeof paths === "string") paths = [ paths ];
this.api = api;
this.methods = methods;
this.paths = paths;
}
getAPI() {return this.api;}
getMethods() {return this.methods;}
getPaths() {return this.paths;}
onMethod(req, res) {
//Now that we have a request we need to create a nice wrapper for it, pass
//it to our method, and then expect a nice JSON object to send back to the
//client.
let request = new APIRequest(this, req, res);
request.process();
}
}
module.exports = APIHandler;

View File

@ -0,0 +1,232 @@
// Copyright (c) 2018 Dominic Masters
//
// MIT License
//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
const Forms = require('./../../../common/Forms.js');
class APIRequest {
constructor(handler, req, res) {
this.handler = handler;
this.req = req;
this.res = res;
}
getHandler() {return this.handler;}
getRequest() {return this.req;}
getResponse() {return this.res;}
getHandleFunction() {return this.getHandler().handle;}
getFormData(name) {return Forms[name];}
//Some nice shorthands
getAPI() {return this.getHandler().getAPI();}
getConfig() {return this.getAPI().getConfig();}
getServer() {return this.getAPI().getServer();}
getExpress() {return this.getAPI().getExpress();}
getEmail() {return this.getAPI().getEmail();}
getApp() {return this.getAPI().getApp();}
//Our process method
process() {
if(typeof this.processPromise !== typeof undefined) return;//Woops, already processing?
this.processPromise = this.processHandler();
this.processPromise.then(this.onResult.bind(this)).catch(this.onError.bind(this));
}
async processHandler() {
//Awesome, now we have a nice async function!
let response = { ok: false };
if(typeof this.getHandleFunction() === "function") {
try {
response = await this.getHandleFunction()(this);
} catch(e) {
console.error(e);
response = { ok: 500, data: "An unknown error occured" };
}
}
if(typeof response.data === typeof undefined || typeof response.ok === typeof undefined) {
throw new Error("Invalid response object.");
}
if(response.ok !== true) {
response.code = typeof response.ok === "number" ? response.ok : 400;
}
this.res.status(response.code || 200).json(response.data);
}
onResult(result) {
}
onError(error) {
this.res.status(500).json("An unexpected error occured");
}
//Some really nice API handlers
get(key) {
if(typeof this.req === typeof undefined) return null;
let data = this.req.body || {};
if(this.req.method == "GET") {
data = this.req.query || {};
}
if(typeof data === typeof undefined) return null;
if(typeof key === typeof undefined) return data;
return this.getRecursive(key.split("."), data);
}
getRecursive(key_array, data_obj) {
if(typeof data_obj === typeof undefined) return null;
let k = key_array[0];
let o = data_obj[k];
if(typeof o === typeof undefined) return null;
//Awesome
if(key_array.length > 1) {
if(typeof o !== typeof {}) return null;
key_array.shift();
return this.getRecursive(key_array, o);
}
return o;
}
getInteger(key) {
if(!this.hasInteger(key)) throw new Error("Invalid Data Type!");
return parseInt(this.get(key));
}
getDouble(key) {
if(!this.hasDouble(key)) throw new Error("Invalid Data Type!");
return parseFloat(this.get(key));
}
getBool(key) {
if(!this.hasBool(key)) throw new Error("Invalid Type");
let t = this.get(key);
if(t === true || t === "true" || t === 1 || t === "1") return true;
return false;
}
getString(key, maxLength, allowBlank) {
if(typeof allowBlank === typeof undefined) allowBlank = true;
if(!this.hasString(key, maxLength, allowBlank)) throw new Error("Missing Data");
return this.get(key)+"";
}
has(key) {
if(typeof this.req === typeof undefined) return false;
if(typeof this.req === typeof undefined) return false;
let data = this.req.body || {};
if(this.req.method == "GET") {
data = this.req.query || {};
}
if(typeof data === typeof undefined) return false;
if(typeof key === typeof undefined) return data;
return this.hasRecursive(key.split("."), data);
}
hasRecursive(key_array, data_obj) {
if(typeof data_obj === typeof undefined) return false;
let k = key_array[0];
let o = data_obj[k];
if(typeof o === typeof undefined) return false;
//Awesome
if(key_array.length > 1) {
if(typeof o !== typeof {}) return false;
key_array.shift();
return this.hasRecursive(key_array, o);
}
return true;
}
hasInteger(key) {
if(!this.has(key)) return false;
let t = parseInt(this.get(key));
if(typeof t !== "number" || isNaN(t) || !isFinite(t)) return false;
let tf = parseFloat(this.get(key));
if(tf !== t) return false;
return true;
}
hasDouble(key) {
if(!this.has(key)) return false;
let t = parseFloat(this.get(key));
return typeof t === typeof 1.00 && !isNaN(t) && isFinite(t);
}
hasBool(bool) {
if(!this.has(bool)) return false;
let t = this.get(bool);
return (
t === true || t === false ||
t === "true" || t === "false" ||
t === 1 || t === 0 ||
t === "1" || t === "0"
);
}
hasString(str, maxLength, allowBlank) {
if(typeof maxLength === typeof undefined) throw new Error("MaxLength check missing.");
if(typeof allowBlank === typeof undefined) allowBlank = false;
if(!this.has(str)) return false;
let t = this.get(str);
let v = typeof t === typeof "" && t.length <= maxLength;
if(!v) return false;
if(!allowBlank) {
t = t.replace(/\s/g, "");
if(!t.length) return false;
}
return typeof t === typeof "" && (t.length <= maxLength ? true : false);
}
//Files (if supported)
hasFiles() {
if(typeof this.req === typeof undefined) return false;
if(typeof this.req.files === typeof undefined) return false;
if(!this.req || !this.req.files) return false;
return Object.keys(this.req.files).length ? true : false;
}
hasFile(name) {
if(!this.hasFiles()) return false;
if(typeof this.req.files[name] === typeof undefined) return false;
return true;
}
getFile(name) {
if(!this.hasFile(name)) return false;
return this.req.files[name];
}
//Headers
hasHeader(header) {
return this.req && typeof this.req.get(header) !== typeof undefined
}
getHeader(header) {
return this.req.get(header);
}
}
module.exports = APIRequest;

View File

@ -0,0 +1,101 @@
// Copyright (c) 2018 Dominic Masters
//
// MIT License
//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
const
APIHandler = require('./../../APIHandler'),
sanitizeHtml = require('sanitize-html')
;
const ERRORS = {
name: "Invalid name",
email: "Invalid email",
message: "Invalid message",
sending: "An unknown error occured"
};
module.exports = class Send extends APIHandler {
constructor(api) {
super(api, ['GET', 'POST'], '/contact/send');
}
async handle(request) {
let form = request.getFormData("contact");
let name,email,message;
if(form.name.required && !request.hasString('name', form.name.maxLength)) return {ok: false, data: ERRORS.name};
name = request.getString('name', form.name.maxLength);
if(form.email.required) {
if(!request.hasString('email', form.email.maxLength)) return { ok: false, data: ERRORS.email };
email = request.getString('email', form.email.maxLength);
if(!form.email.regex.test(email)) return { ok: false, data: ERRORS.email };
}
if(form.message.required && !request.hasString('message', form.message.maxLength)) return {ok: false, data: ERRORS.message};
message = request.getString('message', form.name.maxLength);
//Now let's create our message, we're gonna have to do some rudementry HTML...
let textMessage = '';
let htmlMessage = '';
//First the name
textMessage += 'Name: ' + name;
htmlMessage += '<p><strong>Name: </strong>' + sanitizeHtml(name) + '</p>';
//Now the response Email
textMessage += '\nEmail: ' + email;
htmlMessage += '<p><strong>Email: </strong>' + sanitizeHtml(email) + '</p>';
//Message!
textMessage += '\nMessage: ' + message;
htmlMessage += '<p><strong>Message:</strong></p>';
htmlMessage += '<p>' + sanitizeHtml(message) + '</p>';
htmlMessage += '<hr />';
htmlMessage += '<p>Reply: <a href="mailto:'+email+'">'+email+'</a></p>';
//Now we can send it!
try {
await request.getEmail().sendMailClean(
request.getEmail().getDestinationEmail(),
request.getEmail().getSourceName(),
request.getEmail().getSourceEmail(),
"domsPlace Contact Enquiry",
htmlMessage,
textMessage
);
return {
ok: true,
data: true
};
} catch(e) {
console.error('Failed to send contact message');
console.error(e);
return {
ok: false,
data: ERRORS.sending
};
}
}
}