node-atlas
Version:
Create server-based and component-based websites easily!
1,100 lines (973 loc) • 38.3 kB
JavaScript
/*------------------------------------*\
$%WEB SERVER
\*------------------------------------*/
/* jslint node: true */
/**
* Run NodeAtlas with targeted directory (without webconfig) as a « public » directory.
* @private
* @function simpleWebServer
* @memberOf NA#
*/
exports.simpleWebServer = function () {
var NA = this,
fs = NA.modules.fs,
http = NA.modules.http,
https = NA.modules.https,
path = NA.modules.path,
url = NA.modules.url,
open = NA.modules.open,
express = NA.modules.express,
commander = NA.modules.commander,
httpHostname = commander.httpHostname || NA.configuration.httpHostname || "localhost",
httpPort = commander.httpPort || NA.configuration.httpPort || (NA.configuration.httpSecure ? 443 : 80),
staticOptions = { maxAge: 86400000 * 30 },
urlOutput = url.resolve('http' + (NA.configuration.httpSecure ? "s" : "") + '://' + httpHostname + ((httpPort === 80 || httpPort === 443) ? ":" + "" : ":" + httpPort) + '/', ((typeof NA.configuration.browse === 'string') ? NA.configuration.browse : ""));
/* Configure the server and... */
NA.httpServer = express();
NA.httpServer.set('strict routing', true);
NA.httpServer.set("x-powered-by", false);
if (NA.configuration.httpSecure && typeof NA.configuration.httpSecure === "string") {
NA.server = https.createServer({
key: fs.readFileSync(path.join(NA.serverPath, NA.configuration.httpSecure + ".key"), 'utf-8'),
cert: fs.readFileSync(path.join(NA.serverPath, NA.configuration.httpSecure + ".crt"), 'utf-8')
}, NA.httpServer);
} else {
NA.server = http.createServer(NA.httpServer);
}
/* No Cache */
if (!NA.configuration.cache) {
NA.httpServer.set('etag', false);
NA.httpServer.get('/*', function(request, response, next) {
response.header("Cache-Control", "no-cache, no-store, must-revalidate");
response.header("Pragma", "no-cache");
response.header("Expires", 0);
response.setHeader("Last-Modified", (new Date()).toUTCString());
next();
});
staticOptions.maxAge = 0;
staticOptions.etag = false;
staticOptions.lastModified = true;
}
/* ...from « public » directory. */
NA.httpServer.use(express.static(NA.serverPath, staticOptions));
if (NA.configuration.browse) {
open(urlOutput);
}
/* ...listen HTTP(s) request... */
NA.server.listen(httpPort, function () {
var data = {
path: path.join(NA.serverPath, NA.webconfigName)
},
message = NA.appLabels.running.publicMode.replace(/%([\-a-zA-Z0-9_]+)%/g, function (regex, matches) { return data[matches]; }),
limit = Math.max(message.length + 2, urlOutput.length + 7),
separator = "",
i;
for (i = 0; i < limit; i++) {
separator += "=";
}
NA.log("");
NA.log("\u001B[32m", separator);
NA.log(" " + message);
NA.log("\u001B[32m", " URL: \u001B[35m" + urlOutput);
NA.log(separator, "\u001B[32m");
NA.log("");
if (NA.afterRunning) {
NA.afterRunning();
}
});
/* Catch error. */
NA.server.on('error', function (err) {
if (err && err.code === "EADDRINUSE") {
NA.log(NA.appLabels.running.portAlreadyListened.replace(/%([\-a-zA-Z0-9_]+)%/g, function (regex, matches) { return err[matches]; }));
} else {
NA.log(err);
}
/* In case of error, kill current process. */
process.kill(process.pid);
});
};
/**
* Allow you to configure your own modules configuration.
* @private
* @function atlasConfigurations
* @memberOf NA#
* @param {Object} session Session Object.
* @param {Object} optionSession Property for Object Session.
*/
exports.atlasConfigurations = function (session, optionSession) {
var NA = this;
optionSession.store = NA.sessionStore;
NA.webconfig.session = optionSession;
/* Create a cookie Session. */
NA.httpServer.use(session(optionSession));
/* Use the `NA.websiteController[<commonController>].setConfigurations(...)` function if set... */
if (typeof NA.websiteController[NA.webconfig.commonController] !== 'undefined' &&
typeof NA.websiteController[NA.webconfig.commonController].setConfigurations !== 'undefined') {
/**
* Define this function for configure all modules of your application. Only for `common` controller file.
* @function setConfigurations
* @memberOf NA#websiteController[]
* @param {setConfigurations~callback} callback Next steps after configuration is done.
*/
NA.websiteController[NA.webconfig.commonController].setConfigurations.call(NA,
/**
* Next steps after configuration is done.
* @callback setConfigurations~callback
*/
function () {
NA.atlasServer();
});
/* ...else, just continue. */
} else {
NA.atlasServer();
}
};
/**
* Run the Server of NodeAtlas.
* @private
* @function atlasServer
* @memberOf NA#
*/
exports.atlasServer = function () {
var NA = this,
commander = NA.modules.commander,
open = NA.modules.open,
path = NA.modules.path,
url = NA.modules.url,
httpPort = ((NA.webconfig.httpSecure) ? 443 : 80),
urlOutput;
if (NA.webconfig.httpPort) {
httpPort = NA.webconfig.httpPort;
}
if (NA.configuration.httpPort) {
httpPort = NA.configuration.httpPort;
}
if (commander.httpPort) {
httpPort = commander.httpPort;
}
urlOutput = url.resolve(NA.webconfig.urlRoot, path.join(NA.webconfig.urlRelativeSubPath, ((typeof NA.configuration.browse === 'string') ? NA.configuration.browse : ""))),
/* Listen HTTP(s) request... */
NA.server.listen(httpPort, function () {
var data = {
httpPort: NA.webconfig.httpPort
},
message = NA.appLabels.running.isRunning.replace(/%([\-a-zA-Z0-9_]+)%/g, function (regex, matches) { return data[matches]; }),
limit = Math.max(message.length + 2, urlOutput.length + 7),
separator = "",
i;
for (i = 0; i < limit; i++) {
separator += "=";
}
NA.log("");
NA.log("\u001B[32m", separator);
NA.log(" " + message);
NA.log("\u001B[32m", " URL: \u001B[35m" + urlOutput);
NA.log("\u001B[32m", separator);
NA.log("");
if (NA.afterRunning) {
NA.afterRunning();
}
});
/* Catch error. */
NA.server.on('error', function (err) {
if (err && err.code === "EADDRINUSE") {
NA.log(NA.appLabels.running.portAlreadyListened.replace(/%([\-a-zA-Z0-9_]+)%/g, function (regex, matches) { return err[matches]; }));
} else {
NA.log(err);
}
/* In case of error, kill current process. */
process.kill(process.pid);
});
/* If enableIndex index exist, we go to url later. */
if (NA.configuration.browse && !NA.webconfig.enableIndex) {
open(urlOutput);
}
};
/**
* Active Mechanism for generate Less files.
* @private
* @function enableLessProcess
* @memberOf NA#
*/
exports.enableLessProcess = function () {
var NA = this,
lessMiddleware = NA.modules.lessMiddleware,
lessMiddlewareUtilities = NA.modules.lessMiddlewareUtilities,
fs = NA.modules.fs,
path = NA.modules.path,
mkpath = NA.modules.mkpath,
compressValue = false,
sourceMapValue = true,
regex = new RegExp(path.join(NA.serverPath, NA.webconfig.assetsRelativePath, NA.webconfig.urlRelativeSubPath).replace(/(\\|\/)/g, '\\' + path.sep), 'g');
if (NA.webconfig.enableLess && !NA.webconfig.stylesheetsBundlesBeforeResponse) {
/* Generate Less on the fly during the development phase. */
NA.httpServer.use(lessMiddleware(path.join(NA.webconfig.assetsRelativePath), {
dest: path.join(NA.webconfig.assetsRelativePath),
pathRoot: path.join(NA.serverPath),
preprocess: {
path: function (pathname) {
if (NA.webconfig.urlRelativeSubPath) {
pathname = pathname.replace(regex, path.join(NA.serverPath, NA.webconfig.assetsRelativePath) + path.sep);
}
return pathname;
}
},
postprocess: {
css: function (css, req) {
return css + "/*# sourceMappingURL=" + req.url.replace(/\.css$/i, '.css.map') + " */";
}
},
storeSourcemap: function (pathname, sourcemap) {
if (NA.webconfig.urlRelativeSubPath) {
pathname = pathname.replace(regex, path.join(NA.serverPath, NA.webconfig.assetsRelativePath) + path.sep);
}
fs.exists(path.join(pathname.replace(/\.css\.map/g,".less")), function (exists) {
if (exists) {
mkpath(path.dirname(pathname), function (error) {
if (error) {
lessMiddlewareUtilities.lessError(error);
return;
}
fs.writeFile(pathname, sourcemap, 'utf8');
});
}
});
},
storeCss: function (pathname, css, req, next) {
if (NA.webconfig.urlRelativeSubPath) {
pathname = pathname.replace(regex, path.join(NA.serverPath, NA.webconfig.assetsRelativePath) + path.sep);
}
mkpath(path.dirname(pathname), function (error) {
if (error) {
return next(error);
}
fs.writeFile(pathname, css, 'utf8', next);
});
},
render: {
compress: NA.webconfig.enableLess.compress || compressValue,
sourceMap: NA.webconfig.enableLess.sourceMap || sourceMapValue
}
}));
}
};
/**
* Active Mechanism for generate Stylus files.
* @private
* @function enableStylusProcess
* @memberOf NA#
*/
exports.enableStylusProcess = function () {
var NA = this,
path = NA.modules.path,
stylusMiddleware,
compressValue = false,
sourceMapValue = true,
forceValue = false,
firebugValue = false,
linenosValue = false;
if (NA.webconfig.enableStylus && !NA.webconfig.stylesheetsBundlesBeforeResponse) {
stylusMiddleware = NA.modules.stylus.middleware({
src: path.join(NA.serverPath, NA.webconfig.assetsRelativePath),
dest: path.join(NA.serverPath, NA.webconfig.assetsRelativePath),
compress: NA.webconfig.enableStylus.compress || compressValue,
sourcemap: NA.webconfig.enableStylus.sourceMap || sourceMapValue,
force: NA.webconfig.enableStylus.force || forceValue,
firebug: NA.webconfig.enableStylus.firebug || firebugValue,
linenos: NA.webconfig.enableStylus.linenos || linenosValue
});
/* Generate Stylus on the fly during the development phase. */
NA.httpServer.use(function (req, res, next) {
var regex = new RegExp("^" + NA.webconfig.urlRelativeSubPath, 'g'),
request = {
url: req.url.replace(regex, ""),
method: req.method
};
stylusMiddleware(request, res, next);
});
}
};
/**
* Set the Sessions variables possibility.
* @private
* @function atlasSessions
* @memberOf NA#
*/
exports.atlasSessions = function () {
var NA = this,
optionSession = {},
session = NA.modules.session;
/**
* Name for Session cookie of connected user.
* @public
* @alias sessionKey
* @type {string}
* @memberOf NA#webconfig
* @default "nodeatlas.sid".
*/
optionSession.key = NA.webconfig.sessionKey || 'nodeatlas.sid',
/**
* Secret for Session cookie of connected user.
* @public
* @alias sessionSecret
* @type {string}
* @memberOf NA#webconfig
* @default '1234567890bépo'.
*/
optionSession.secret = NA.webconfig.sessionSecret || '1234567890bépo',
optionSession.saveUninitialized = true,
optionSession.resave = true;
if (NA.webconfig.session) {
/**
* Use a more complexe session cookie options.
* Replace `NA#webconfig.sessionKey` and `NA#webconfig.sessionSecret` if set.
* @public
* @alias session
* @type {Object}
* @memberOf NA#webconfig
* @see {@link https://github.com/expressjs/session Session Middleware}
*/
optionSession = NA.webconfig.session;
}
/**
* A default session loaded with `NA#webconfig.sessionKey` and `NA#webconfig.sessionSecret` or `NA.webconfig#sessionKey` and `NA#webconfig.session`.
* @public
* @alias sessionStore
* @type {Object}
* @memberOf NA#
* @see {@link https://github.com/expressjs/session Session Middleware}
*/
NA.sessionStore = new session.MemoryStore();
/* Use the `NA.websiteController[<commonController>].setSessions(...)` function if set... */
if (typeof NA.websiteController[NA.webconfig.commonController] !== 'undefined' &&
typeof NA.websiteController[NA.webconfig.commonController].setSessions !== 'undefined') {
/**
* Define this function for configure sessions of application. Only for `common` controller file.
* @function setSessions
* @memberOf NA#websiteController[]
* @param {setSessions~callback} callback Next steps after configuration is done.
*/
NA.websiteController[NA.webconfig.commonController].setSessions.call(NA,
/**
* Next steps after set session is done.
* @callback setSessions~callback
*/
function () {
NA.atlasConfigurations(session, optionSession);
});
/* ...else, just continue. */
} else {
NA.atlasConfigurations(session, optionSession);
}
};
/**
* Start a real NodeAtlas Server.
* @private
* @function startingHttpServer
* @memberOf NA#
*/
exports.startingHttpServer = function () {
var NA = this,
express = NA.modules.express,
fs = NA.modules.fs,
path = NA.modules.path,
http = NA.modules.http,
https = NA.modules.https;
/**
* A simple HTTP server.
* @private
* @function httpServer
* @memberOf NA#
*/
NA.httpServer = express();
NA.httpServer.set("x-powered-by", false);
/** Server is case sensitive and slash sensitive. */
NA.httpServer.set('strict routing', true);
/* No Cache */
if (!NA.webconfig.cache) {
NA.httpServer.set('etag', false);
NA.httpServer.get('/*', function(request, response, next) {
response.header("Cache-Control", "no-cache, no-store, must-revalidate");
response.header("Pragma", "no-cache");
response.header("Expires", 0);
response.setHeader("Last-Modified", (new Date()).toUTCString());
next();
});
}
if (!NA.configuration.generate) {
if (typeof NA.webconfig.httpSecure !== "boolean" && NA.webconfig.httpSecureRelativeKeyPath && NA.webconfig.httpSecureRelativeCertificatePath) {
/* HTTPs version for a website. */
NA.server = https.createServer({
key: fs.readFileSync(path.join(NA.serverPath, NA.webconfig.httpSecureRelativeKeyPath), 'utf-8'),
cert: fs.readFileSync(path.join(NA.serverPath, NA.webconfig.httpSecureRelativeCertificatePath), 'utf-8')
}, NA.httpServer);
} else {
/**
* The global HTTP server.
* @private
* @function server
* @memberOf NA#
*/
NA.server = http.createServer(NA.httpServer);
}
}
/* Allow you to parse request and response. */
NA.httpServerParse(function () {
/* Allow you to use Session variables. */
NA.atlasSessions();
});
};
/**
* Add some parser for parse request and response.
* @private
* @function httpServerParse
* @memberOf NA#
*/
exports.httpServerParse = function (callback) {
var NA = this,
compress = NA.modules.compress,
bodyParser = NA.modules.bodyParser,
cookieParser = NA.modules.cookieParser,
forceDomain = NA.modules.forceDomain,
/**
* Force address and port if extra 'www' or 'port' is enter in browser url bar.
* @public
* @alias enableForceDomain
* @type {boolean}
* @memberOf NA#webconfig
* @default false
*/
enableForceDomain = NA.webconfig.enableForceDomain,
httpSecure = NA.webconfig.httpSecure;
/* NodeAtlas as Node.js Website. */
if (!NA.configuration.generate) {
/* Use gzip and others client-server data compression. */
NA.httpServer.use(compress());
/* Force utilisation of www and avoid using the original port in address. Necessary without reverse proxy. */
if (enableForceDomain) {
NA.httpServer.use(forceDomain({
hostname: NA.webconfig.urlHostname,
port: NA.webconfig.urlPort,
type: 'permanent',
protocol: 'http' + ((httpSecure) ? 's' : '')
}));
}
/* Allow you to parse the GET/POST data format. */
NA.httpServer.use(bodyParser.urlencoded({ extended: true }));
/* Allow you to parse the JSON data format. */
NA.httpServer.use(bodyParser.json());
/* Allow you to parse the Cookie data format. */
NA.httpServer.use(cookieParser());
/* Allow you to parse the Less files. */
NA.enableLessProcess();
/* Allow you to parse the Styl files. */
NA.enableStylusProcess();
if (typeof callback === 'function') {
callback();
}
}
};
/**
* Set the public directory for asset like CSS/JS and media.
* @private
* @function httpServerPublicFiles
* @memberOf NA#
*/
exports.httpServerPublicFiles = function () {
var NA = this,
express = NA.modules.express,
path = NA.modules.path,
staticOptions = { maxAge: 86400000 * 30 };
/* No Cache */
if (!NA.webconfig.cache) {
staticOptions.etag = false;
staticOptions.maxAge = 0;
staticOptions.lastModified = true;
}
/**
* Set information for static file from `assetsRelativePath`.
* @public
* @see http://expressjs.com/api.html#express.static for options.
* @alias staticOptions
* @type {string}
* @memberOf NA#webconfig
*/
staticOptions = NA.extend(staticOptions, NA.webconfig.staticOptions);
if (!NA.configuration.generate) {
NA.httpServer.use(NA.webconfig.urlRelativeSubPath, express.static(path.join(NA.serverPath, NA.webconfig.assetsRelativePath), staticOptions));
}
};
/**
* Send HTML result to the client.
* @private
* @function response
* @memberOf NA#
* @param {Object} request Initial request.
* @param {Object} response Initial response.
* @param {string} data HTML DOM ready for sending.
* @param {Object} currentRouteParameters Parameters set into `routes[<currentRoute>]`.
* @param {Object} currentVariation Variations for the current page.
*/
exports.response = function (request, response, data, currentRouteParameters, currentVariation) {
var NA = this,
header,
/**
* Charset used for render of this page.
* @public
* @alias charset
* @type {string}
* @memberOf NA#currentRouteParameters
* @default "utf-8"
*/
charset = currentVariation.currentRouteParameters.charset || currentRouteParameters.charset || NA.webconfig.charset,
/**
* Status Code used for respond with this page.
* @public
* @alias statusCode
* @type {number}
* @memberOf NA#currentRouteParameters
* @default 200
*/
statusCode = currentVariation.currentRouteParameters.statusCode || currentRouteParameters.statusCode || 200,
/**
* Content Type used for respond with this page.
* @public
* @alias mimeType
* @type {string}
* @memberOf NA#currentRouteParameters
* @default "text/html"
*/
mimeType = currentVariation.currentRouteParameters.mimeType || currentRouteParameters.mimeType || NA.webconfig.mimeType,
/**
* Headers value used for respond with this page.
* @public
* @alias mimeType
* @type {string}
* @memberOf NA#currentRouteParameters
* @default "text/html"
*/
headers = currentVariation.currentRouteParameters.headers || currentRouteParameters.headers || {};
/* Set charset and */
response.statusCode = statusCode;
/* Set headers into response */
response.setHeader("Content-Type", mimeType + ";" + " charset=" + charset);
for (header in NA.webconfig.headers) {
if (!NA.webconfig.headers.hasOwnProperty(header)) {
continue;
}
if (NA.webconfig.headers[header] === false) {
response.removeHeader(header);
} else {
response.setHeader(header, NA.webconfig.headers[header]);
}
}
for (header in headers) {
if (!headers.hasOwnProperty(header)) {
continue;
}
if (headers[header] === false) {
response.removeHeader(header);
} else {
response.setHeader(header, headers[header]);
}
}
/* Set/Send body */
response.write(data);
response.end();
};
/**
* Redirect a page to an other page if option page is set for that.
* @private
* @function redirect
* @memberOf NA#
* @param {Object} currentRouteParameters All information associate with the redirection.
* @param {Object} request Initial request.
* @param {Object} response Initial response.
*/
exports.redirect = function (currentRouteParameters, request, response) {
var NA = this,
location,
path = NA.modules.path;
/* Re-inject param into redirected url if is replaced by regex. */
if (currentRouteParameters.regExp) {
/**
* Represent route to redirect if current route matched.
* @public
* @alias redirect
* @type {string}
* @memberOf NA#currentRouteParameters
*/
location = currentRouteParameters.redirect.replace(/\$([0-9]+)/g, function (regex, matches) { return request.params[matches]; });
/* Or by standard selector. */
} else {
location = currentRouteParameters.redirect.replace(/\:([a-z0-9]+)/g, function (regex, matches) { return request.params[matches]; });
}
/* Set status and new location. */
response.writeHead(currentRouteParameters.statusCode, {
Location: path.join(NA.webconfig.urlRelativeSubPath, location)
});
/* No more data. */
response.end();
};
/**
* Affect support of GET/POST to a route.
* @private
* @function setSupport
* @memberOf NA#
* @param {boolean} support Type of support GET or POST.
* @param {boolean} path Instruction support for all page.
* @param {boolean} options Instruction support for current page.
*/
exports.setSupport = function (support, common, specific) {
/* Manage GET / POST / PUT / DELETE support for an url. */
if (common === false) {
support = false;
}
if (specific === false) {
support = false;
}
if (specific === true) {
support = true;
}
return support;
};
/**
* Ask for a page in GET, POST, UPDATE or DELETE.
* @private
* @function executeRequest
* @memberOf NA#
* @param {boolean} getSupport This page can be requested by GET ?
* @param {boolean} postSupport This page can be requested by POST ?
* @param {boolean} putSupport This page can be requested by PUT ?
* @param {boolean} deleteSupport This page can be requested by DELETE ?
* @param {string} objectPath The list of Url match for obtain response.
* @param {Object} options Option associate to this url.
* @param {string} path The Url in routes' webconfig.
*/
exports.executeRequest = function (getSupport, postSupport, putSupport, deleteSupport, objectPath, options, path) {
var NA = this,
currentRouteParameters;
/* Case of `path` is an object because `NA.webconfig.routes` is an array and not an object. */
if (typeof path === "object") {
currentRouteParameters = path;
} else {
currentRouteParameters = options[path];
}
/** Execute Get Request */
if (getSupport) {
NA.httpServer.get(objectPath, function (request, response) {
/* Verify if route is a redirection... */
if (currentRouteParameters.redirect && currentRouteParameters.statusCode) {
/* ...and if is it, redirect... */
NA.redirect(currentRouteParameters, request, response);
} else {
/* ...else execute render... */
NA.render(path, options, request, response);
}
});
}
/** Execute Post Request */
if (postSupport) {
NA.httpServer.post(objectPath, function (request, response) {
/* Verify if route is a redirection... */
if (currentRouteParameters.redirect && currentRouteParameters.statusCode) {
/* ...and if is it, redirect... */
NA.redirect(currentRouteParameters, request, response);
} else {
/* ...else execute render... */
NA.render(path, options, request, response);
}
});
}
/** Execute Put Request */
if (putSupport) {
NA.httpServer.put(objectPath, function (request, response) {
/* Verify if route is a redirection... */
if (currentRouteParameters.redirect && currentRouteParameters.statusCode) {
/* ...and if is it, redirect... */
NA.redirect(currentRouteParameters, request, response);
} else {
/* ...else execute render... */
NA.render(path, options, request, response);
}
});
}
/** Execute Delete Request */
if (deleteSupport) {
NA.httpServer.delete(objectPath, function (request, response) {
/* Verify if route is a redirection... */
if (currentRouteParameters.redirect && currentRouteParameters.statusCode) {
/* ...and if is it, redirect... */
NA.redirect(currentRouteParameters, request, response);
} else {
/* ...else execute render... */
NA.render(path, options, request, response);
}
});
}
};
/**
* Listen a specific request.
* @private
* @function request
* @memberOf NA#
* @param {string} path The url listening.
* @param {Object} options Option associate to this url.
*/
exports.request = function (path, options) {
var NA = this,
currentRouteParameters,
getSupport = true,
postSupport = true,
putSupport = false,
deleteSupport = false,
currentPath = path,
objectPath;
/* Case of `path` is an object because `NA.webconfig.routes` is an array and not an object. */
if (typeof path === "object") {
currentRouteParameters = path;
} else {
currentRouteParameters = options[path];
}
/* Case of `currentRouteParameters.url` replace `path` because `path` is used like a key. */
if (currentRouteParameters.url) {
/**
* If setted, replace « The url listening ». « The url listening. » become a « key » value.
* @public
* @alias url
* @type {string}
* @memberOf NA#currentRouteParameters
*/
currentPath = currentRouteParameters.url;
}
/* Adding of subfolder before url listening. */
objectPath = NA.webconfig.urlRelativeSubPath + currentPath;
/* Manage GET / POST / PUT / DELETE support for an url. */
getSupport = NA.setSupport(getSupport,
/**
* Allow you to avoid or authorize GET response for all page.
* @public
* @alias getSupport
* @type {boolean}
* @memberOf NA#webconfig
* @default true
*/
NA.webconfig.getSupport,
/**
* Allow you to avoid or authorize GET response for current page.
* @public
* @alias getSupport
* @type {boolean}
* @memberOf NA#currentRouteParameters
* @default true
*/
currentRouteParameters.getSupport
);
postSupport = NA.setSupport(postSupport,
/**
* Allow you to avoid or authorize POST response for all page.
* @public
* @alias postSupport
* @type {boolean}
* @memberOf NA#webconfig
* @default true
*/
NA.webconfig.postSupport,
/**
* Allow you to avoid or authorize POST response for current page.
* @public
* @alias postSupport
* @type {boolean}
* @memberOf NA#currentRouteParameters
* @default true
*/
currentRouteParameters.postSupport
);
putSupport = NA.setSupport(putSupport,
/**
* Allow you to avoid or authorize PUT response for all page.
* @public
* @alias putSupport
* @type {boolean}
* @memberOf NA#webconfig
* @default false
*/
NA.webconfig.putSupport,
/**
* Allow you to avoid or authorize PUT response for current page.
* @public
* @alias putSupport
* @type {boolean}
* @memberOf NA#currentRouteParameters
* @default false
*/
currentRouteParameters.putSupport
);
deleteSupport = NA.setSupport(deleteSupport,
/**
* Allow you to avoid or authorize DELETE response for all page.
* @public
* @alias deleteSupport
* @type {boolean}
* @memberOf NA#webconfig
* @default false
*/
NA.webconfig.deleteSupport,
/**
* Allow you to avoid or authorize DELETE response for current page.
* @public
* @alias deleteSupport
* @type {boolean}
* @memberOf NA#currentRouteParameters
* @default false
*/
currentRouteParameters.deleteSupport
);
/* Ask for a page in GET, POST, PUT or DELETE. */
NA.requestRegex(getSupport, postSupport, putSupport, deleteSupport, objectPath, options, path, currentRouteParameters);
};
/**
* Listen a specific request (Regex Part).
* @private
* @function requestRegex
* @memberOf NA#
* @param {boolean} getSupport This page can be requested by GET ?
* @param {boolean} postSupport This page can be requested by POST ?
* @param {boolean} putSupport This page can be requested by PUT ?
* @param {boolean} deleteSupport This page can be requested by DELETE ?
* @param {string} objectPath The list of Url match for obtain response.
* @param {Object} options Option associate to this url.
* @param {string} path The Url in routes' webconfig.
* @param {Object} currentRouteParameters Parameters for this route.
*/
exports.requestRegex = function (getSupport, postSupport, putSupport, deleteSupport, objectPath, options, path, currentRouteParameters) {
var NA = this;
/* Allow you to use regex into your url route... */
if (
/**
* Use RegExp expression as selector for route url If setted to true.
* Same if is a string but string represent option like "g".
* @public
* @alias regExp
* @type {string|boolean}
* @default false
* @memberOf NA#currentRouteParameters
*/
currentRouteParameters.regExp
) {
/* ...with options... */
if (typeof currentRouteParameters.regExp === 'string') {
objectPath = new RegExp(objectPath, currentRouteParameters.regExp);
/* ...or not... */
} else {
objectPath = new RegExp(objectPath);
}
}
/* Ask for a page in GET and in POST. */
NA.executeRequest(getSupport, postSupport, putSupport, deleteSupport, objectPath, options, path);
};
/**
* Define a page to display when no url match in route or in `NA#httpServerPublicFiles` directory.
* @private
* @function pageNotFound
* @memberOf NA#
*/
exports.pageNotFound = function () {
var NA = this,
pageNotFound,
key,
/**
* Represent route to use if no route match in all route.
* @public
* @alias pageNotFound
* @type {string}
* @memberOf NA#webconfig
*/
pageNotFoundUrl = NA.webconfig.pageNotFound;
if (NA.webconfig.routes instanceof Array) {
for (let route of NA.webconfig.routes) {
key = route.key || route.url;
if (NA.webconfig.pageNotFound && key === NA.webconfig.pageNotFound) {
pageNotFound = route;
pageNotFoundUrl = route;
}
}
} else if (NA.webconfig.pageNotFound && NA.webconfig.routes[NA.webconfig.pageNotFound]) {
pageNotFound = NA.webconfig.routes[NA.webconfig.pageNotFound];
}
if (pageNotFound) {
/* Match all Get Request */
NA.httpServer.get("*", function (request, response) {
/* Verify if route for `pageNotFound` is a redirection... */
if (pageNotFound.redirect && pageNotFound.statusCode) {
/* ...and if is it, redirect... */
NA.redirect(pageNotFound, request, response);
} else {
/* ...else execute render... */
NA.render(pageNotFoundUrl, NA.webconfig.routes, request, response);
}
});
/* Match all Post Request */
NA.httpServer.post("*", function (request, response) {
/* Verify if route for `pageNotFound` is a redirection... */
if (pageNotFound.redirect && pageNotFound.statusCode) {
/* ...and if is it, redirect... */
NA.redirect(pageNotFound, request, response);
} else {
/* ...else execute render... */
NA.render(pageNotFoundUrl, NA.webconfig.routes, request, response);
}
});
}
};
/**
* Run the Server Routes.
* @private
* @function atlasRoutes
* @memberOf NA#
* @param {atlasRoutes~callback} callback Calling next processus after route was loaded.
*/
exports.atlasRoutes = function (callback) {
var NA = this;
if (!NA.configuration.generate) {
/* For each `webconfig.routes`. */
NA.forEach(NA.webconfig.routes, function (currentUrl) {
NA.request(currentUrl, NA.webconfig.routes);
});
}
/**
* Next step !
* @callback atlasRoutes~callback
*/
callback();
};
/**
* Crawl all routes and execute each file with a request that it emit by client.
* @private
* @function routesPages
* @memberOf NA#
* @param {routesPages~callback} callback Calling next processus after route was loaded.
*/
exports.routesPages = function (callback) {
var NA = this;
if (typeof NA.websiteController[NA.webconfig.commonController] !== 'undefined' &&
typeof NA.websiteController[NA.webconfig.commonController].setRoutes !== 'undefined') {
/**
* Define this function for configure all modules of your application. Only for `common` controller file.
* @function setRoutes
* @memberOf NA#websiteController[]
* @param {setConfigurations~callback} callback Next steps after routes is done.
*/
NA.websiteController[NA.webconfig.commonController].setRoutes.call(NA,
/**
* Next steps after routes is done.
* @callback setRoutes~callback
*/
function () {
NA.atlasRoutes(callback);
});
/* ...else, just continue. */
} else {
NA.atlasRoutes(callback);
}
};