mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-05 01:26:18 +00:00
Code Issues Releases Wiki Activity

Stop using the existing core server infrastructure

Browse Source 
Too much of a constraint now that we're starting work on client-server sync
This commit is contained in:
Jeremy Ruston 2024-03-18 08:44:45 +00:00
parent 09de91940e
commit f606e33415
18 changed files with 659 additions and 214 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

140
core/modules/server/server.js
View File

@ -74,6 +74,7 @@ function Server(options) {
});
// Load route handlers
$tw.modules.forEachModuleOfType("route", function(title,routeDefinition) {
// console.log("Loading server route " + title);
self.addRoute(routeDefinition);
});
// Initialise the http vs https
@ -162,108 +163,6 @@ function sendResponse(request,response,statusCode,headers,data,encoding) {
response.end(data,encoding);
}
function redirect(request,response,statusCode,location) {
response.setHeader("Location",location);
response.statusCode = statusCode;
response.end()
}
/*
Options include:
cbPartStart(headers,name,filename) - invoked when a file starts being received
cbPartChunk(chunk) - invoked when a chunk of a file is received
cbPartEnd() - invoked when a file finishes being received
cbFinished(err) - invoked when the all the form data has been processed
*/
function streamMultipartData(request,options) {
// Check that the Content-Type is multipart/form-data
const contentType = request.headers['content-type'];
if(!contentType.startsWith("multipart/form-data")) {
return options.cbFinished("Expected multipart/form-data content type");
}
// Extract the boundary string from the Content-Type header
const boundaryMatch = contentType.match(/boundary=(.+)$/);
if(!boundaryMatch) {
return options.cbFinished("Missing boundary in multipart/form-data");
}
const boundary = boundaryMatch[1];
const boundaryBuffer = Buffer.from("--" + boundary);
// Initialise
let buffer = Buffer.alloc(0);
let processingPart = false;
// Process incoming chunks
request.on("data", (chunk) => {
// Accumulate the incoming data
buffer = Buffer.concat([buffer, chunk]);
// Loop through any parts within the current buffer
while (true) {
if(!processingPart) {
// If we're not processing a part then we try to find a boundary marker
const boundaryIndex = buffer.indexOf(boundaryBuffer);
if(boundaryIndex === -1) {
// Haven't reached the boundary marker yet, so we should wait for more data
break;
}
// Look for the end of the headers
const endOfHeaders = buffer.indexOf("\r\n\r\n",boundaryIndex + boundaryBuffer.length);
if(endOfHeaders === -1) {
// Haven't reached the end of the headers, so we should wait for more data
break;
}
// Extract and parse headers
const headersPart = Uint8Array.prototype.slice.call(buffer,boundaryIndex + boundaryBuffer.length,endOfHeaders).toString();
const currentHeaders = {};
headersPart.split("\r\n").forEach(headerLine => {
const [key, value] = headerLine.split(": ");
currentHeaders[key.toLowerCase()] = value;
});
// Parse the content disposition header
const contentDisposition = {
name: null,
filename: null
};
if(currentHeaders["content-disposition"]) {
// Split the content-disposition header into semicolon-delimited parts
const parts = currentHeaders["content-disposition"].split(";").map(part => part.trim());
// Iterate over each part to extract name and filename if they exist
parts.forEach(part => {
if(part.startsWith("name=")) {
// Remove "name=" and trim quotes
contentDisposition.name = part.substring(6,part.length - 1);
} else if(part.startsWith("filename=")) {
// Remove "filename=" and trim quotes
contentDisposition.filename = part.substring(10,part.length - 1);
}
});
}
processingPart = true;
options.cbPartStart(currentHeaders,contentDisposition.name,contentDisposition.filename);
// Slice the buffer to the next part
buffer = Uint8Array.prototype.slice.call(buffer,endOfHeaders + 4);
} else {
const boundaryIndex = buffer.indexOf(boundaryBuffer);
if(boundaryIndex >= 0) {
// Return the part up to the boundary minus the terminating LF CR
options.cbPartChunk(Uint8Array.prototype.slice.call(buffer,0,boundaryIndex - 2));
options.cbPartEnd();
processingPart = false;
buffer = Uint8Array.prototype.slice.call(buffer,boundaryIndex);
} else {
// Return the rest of the buffer
options.cbPartChunk(buffer);
// Reset the buffer and wait for more data
buffer = Buffer.alloc(0);
break;
}
}
}
});
// All done
request.on("end", () => {
options.cbFinished(null);
});
}
Server.prototype.defaultVariables = {
port: "8080",
host: "127.0.0.1",
@ -356,10 +255,14 @@ Server.prototype.requestHandler = function(request,response,options) {
state.queryParameters = querystring.parse(state.urlInfo.query);
state.pathPrefix = options.pathPrefix || this.get("path-prefix") || "";
state.sendResponse = sendResponse.bind(self,request,response);
state.redirect = redirect.bind(self,request,response);
state.streamMultipartData = streamMultipartData.bind(self,request);
// Get the principals authorized to access this resource
state.authorizationType = options.authorizationType || this.methodMappings[request.method] || "readers";
// Check for the CSRF header if this is a write
if(!this.csrfDisable && state.authorizationType === "writers" && request.headers["x-requested-with"] !== "TiddlyWiki") {
response.writeHead(403,"'X-Requested-With' header required to login to '" + this.servername + "'");
response.end();
return;
}
// Check whether anonymous access is granted
state.allowAnon = this.isAuthorized(state.authorizationType,null);
// Authenticate with the first active authenticator
@ -389,12 +292,6 @@ Server.prototype.requestHandler = function(request,response,options) {
response.end();
return;
}
// If this is a write, check for the CSRF header unless globally disabled, or disabled for this route
if(!this.csrfDisable && !route.csrfDisable && state.authorizationType === "writers" && request.headers["x-requested-with"] !== "TiddlyWiki") {
response.writeHead(403,"'X-Requested-With' header required to login to '" + this.servername + "'");
response.end();
return;
}
// Receive the request body if necessary and hand off to the route handler
if(route.bodyFormat === "stream" || request.method === "GET" || request.method === "HEAD") {
// Let the route handle the request stream itself
@ -430,9 +327,8 @@ Listen for requests
port: optional port number (falls back to value of "port" variable)
host: optional host address (falls back to value of "host" variable)
prefix: optional prefix (falls back to value of "path-prefix" variable)
callback: optional callback(err) to be invoked when the listener is up and running
*/
Server.prototype.listen = function(port,host,prefix,options) {
Server.prototype.listen = function(port,host,prefix) {
var self = this;
// Handle defaults for port and host
port = port || this.get("port");
@ -445,7 +341,7 @@ Server.prototype.listen = function(port,host,prefix,options) {
// Warn if required plugins are missing
var missing = [];
for (var index=0; index<this.requiredPlugins.length; index++) {
if(!this.wiki.getTiddler(this.requiredPlugins[index])) {
if (!this.wiki.getTiddler(this.requiredPlugins[index])) {
missing.push(this.requiredPlugins[index]);
}
}
@ -455,24 +351,18 @@ Server.prototype.listen = function(port,host,prefix,options) {
$tw.utils.warning(error);
}
// Create the server
var server = this.transport.createServer(this.listenOptions || {},function(request,response,options) {
if(self.get("debug-level") !== "none") {
var start = $tw.utils.timer();
response.on("finish",function() {
console.log("Response time:",request.method,request.url,$tw.utils.timer() - start);
});
}
self.requestHandler(request,response,options);
});
var server;
if(this.listenOptions) {
server = this.transport.createServer(this.listenOptions,this.requestHandler.bind(this));
} else {
server = this.transport.createServer(this.requestHandler.bind(this));
}
// Display the port number after we've started listening (the port number might have been specified as zero, in which case we will get an assigned port)
server.on("listening",function() {
var address = server.address(),
url = self.protocol + "://" + (address.family === "IPv6" ? "[" + address.address + "]" : address.address) + ":" + address.port + prefix;
$tw.utils.log("Serving on " + url,"brown/orange");
$tw.utils.log("(press ctrl-C to exit)","red");
if(options.callback) {
options.callback(null);
}
});
// Listen
return server.listen(port,host);

2
plugins/tiddlywiki/multiwikiserver/docs/readme.tid
View File

@ -21,7 +21,7 @@ npm start
The `npm start` command is a shortcut for the following command:
```
node ./tiddlywiki.js ./editions/multiwikiserver --listen
node ./tiddlywiki.js ./editions/multiwikiserver --mws-listen
```
Then visit the administration interface in a browser:

48
plugins/tiddlywiki/multiwikiserver/modules/commands/mws-listen.js Normal file
View File

@ -0,0 +1,48 @@
/*\
title: $:/plugins/tiddlywiki/multiwikiserver/commands/mws-listen.js
type: application/javascript
module-type: command
Listen for HTTP requests and serve tiddlers
\*/
(function(){
/*jslint node: true, browser: true */
/*global $tw: false */
"use strict";
exports.info = {
name: "mws-listen",
synchronous: false,
namedParameterMode: true,
mandatoryParameters: []
};
var Command = function(params,commander,callback) {
var self = this;
this.params = params;
this.commander = commander;
this.callback = callback;
};
Command.prototype.execute = function() {
var self = this;
if(!$tw.boot.wikiTiddlersPath) {
$tw.utils.warning("Warning: Wiki folder '" + $tw.boot.wikiPath + "' does not exist or is missing a tiddlywiki.info file");
}
// Set up server
this.server = $tw.mws.serverManager.createServer({
wiki: $tw.wiki
});
this.server.listen(null,null,null,{
callback: function() {
self.callback();
}
});
return null;
};
exports.Command = Command;
})();

76
plugins/tiddlywiki/multiwikiserver/modules/init.js
View File

@ -1,76 +0,0 @@
/*\
title: $:/plugins/tiddlywiki/multiwikiserver/init.js
type: application/javascript
module-type: startup
Multi wiki server initialisation
\*/
(function(){
/*jslint node: true, browser: true */
/*global $tw: false */
"use strict";
// Export name and synchronous status
exports.name = "multiwikiserver";
exports.platforms = ["node"];
exports.before = ["story"];
exports.synchronous = true;
exports.startup = function() {
var path = require("path");
// Create and initialise the tiddler store and upload manager
var AttachmentStore = require("$:/plugins/tiddlywiki/multiwikiserver/store/attachments.js").AttachmentStore,
attachmentStore = new AttachmentStore({
storePath: path.resolve($tw.boot.wikiPath,"store/")
}),
SqlTiddlerStore = require("$:/plugins/tiddlywiki/multiwikiserver/store/sql-tiddler-store.js").SqlTiddlerStore,
store = new SqlTiddlerStore({
databasePath: path.resolve($tw.boot.wikiPath,"store/database.sqlite"),
engine: $tw.wiki.getTiddlerText("$:/config/MultiWikiServer/Engine","better"), // better || wasm
attachmentStore: attachmentStore
});
$tw.mws = {
store: store
};
// Performance timing
console.time("mws-initial-load");
// Copy TiddlyWiki core editions
function copyEdition(options) {
console.log(`Copying edition ${options.tiddlersPath}`);
$tw.mws.store.createBag(options.bagName,options.bagDescription);
$tw.mws.store.createRecipe(options.recipeName,[options.bagName],options.recipeDescription);
$tw.mws.store.saveTiddlersFromPath(path.resolve($tw.boot.corePath,$tw.config.editionsPath,options.tiddlersPath),options.bagName);
}
copyEdition({
bagName: "docs",
bagDescription: "TiddlyWiki Documentation from https://tiddlywiki.com",
recipeName: "docs",
recipeDescription: "TiddlyWiki Documentation from https://tiddlywiki.com",
tiddlersPath: "tw5.com/tiddlers"
});
copyEdition({
bagName: "dev-docs",
bagDescription: "TiddlyWiki Developer Documentation from https://tiddlywiki.com/dev",
recipeName: "dev-docs",
recipeDescription: "TiddlyWiki Developer Documentation from https://tiddlywiki.com/dev",
tiddlersPath: "dev/tiddlers"
});
// Create bags and recipes
$tw.mws.store.createBag("bag-alpha","A test bag");
$tw.mws.store.createBag("bag-beta","Another test bag");
$tw.mws.store.createBag("bag-gamma","A further test bag");
$tw.mws.store.createRecipe("recipe-rho",["bag-alpha","bag-beta"],"First wiki");
$tw.mws.store.createRecipe("recipe-sigma",["bag-alpha","bag-gamma"],"Second Wiki");
$tw.mws.store.createRecipe("recipe-tau",["bag-alpha"],"Third Wiki");
$tw.mws.store.createRecipe("recipe-upsilon",["bag-alpha","bag-gamma","bag-beta"],"Fourth Wiki");
// Save tiddlers
$tw.mws.store.saveBagTiddler({title: "$:/SiteTitle",text: "Bag Alpha"},"bag-alpha");
$tw.mws.store.saveBagTiddler({title: "😀😃😄😁😆🥹😅😂",text: "Bag Alpha"},"bag-alpha");
$tw.mws.store.saveBagTiddler({title: "$:/SiteTitle",text: "Bag Beta"},"bag-beta");
$tw.mws.store.saveBagTiddler({title: "$:/SiteTitle",text: "Bag Gamma"},"bag-gamma");
console.timeEnd("mws-initial-load");
};
})();

483
plugins/tiddlywiki/multiwikiserver/modules/mws-server.js Normal file
View File

@ -0,0 +1,483 @@
/*\
title: $:/plugins/tiddlywiki/multiwikiserver/mws-server.js
type: application/javascript
module-type: library
Serve tiddlers over http
\*/
(function(){
/*jslint node: true, browser: true */
/*global $tw: false */
"use strict";
if($tw.node) {
var util = require("util"),
fs = require("fs"),
url = require("url"),
path = require("path"),
querystring = require("querystring"),
crypto = require("crypto"),
zlib = require("zlib");
}
/*
A simple HTTP server with regexp-based routes
options: variables - optional hashmap of variables to set (a misnomer - they are really constant parameters)
routes - optional array of routes to use
wiki - reference to wiki object
*/
function Server(options) {
var self = this;
this.routes = options.routes || [];
this.authenticators = options.authenticators || [];
this.wiki = options.wiki;
this.boot = options.boot || $tw.boot;
// Initialise the variables
this.variables = $tw.utils.extend({},this.defaultVariables);
if(options.variables) {
for(var variable in options.variables) {
if(options.variables[variable]) {
this.variables[variable] = options.variables[variable];
}
}
}
// Setup the default required plugins
this.requiredPlugins = this.get("required-plugins").split(',');
// Initialise CSRF
this.csrfDisable = this.get("csrf-disable") === "yes";
// Initialize Gzip compression
this.enableGzip = this.get("gzip") === "yes";
// Initialize browser-caching
this.enableBrowserCache = this.get("use-browser-cache") === "yes";
// Initialise authorization
var authorizedUserName;
if(this.get("username") && this.get("password")) {
authorizedUserName = this.get("username");
} else if(this.get("credentials")) {
authorizedUserName = "(authenticated)";
} else {
authorizedUserName = "(anon)";
}
this.authorizationPrincipals = {
readers: (this.get("readers") || authorizedUserName).split(",").map($tw.utils.trim),
writers: (this.get("writers") || authorizedUserName).split(",").map($tw.utils.trim)
}
if(this.get("admin") || authorizedUserName !== "(anon)") {
this.authorizationPrincipals["admin"] = (this.get("admin") || authorizedUserName).split(',').map($tw.utils.trim)
}
// Load and initialise authenticators
$tw.modules.forEachModuleOfType("authenticator", function(title,authenticatorDefinition) {
// console.log("Loading authenticator " + title);
self.addAuthenticator(authenticatorDefinition.AuthenticatorClass);
});
// Load route handlers
$tw.modules.forEachModuleOfType("mws-route", function(title,routeDefinition) {
self.addRoute(routeDefinition);
});
// Initialise the http vs https
this.listenOptions = null;
this.protocol = "http";
var tlsKeyFilepath = this.get("tls-key"),
tlsCertFilepath = this.get("tls-cert"),
tlsPassphrase = this.get("tls-passphrase");
if(tlsCertFilepath && tlsKeyFilepath) {
this.listenOptions = {
key: fs.readFileSync(path.resolve(this.boot.wikiPath,tlsKeyFilepath),"utf8"),
cert: fs.readFileSync(path.resolve(this.boot.wikiPath,tlsCertFilepath),"utf8"),
passphrase: tlsPassphrase || ''
};
this.protocol = "https";
}
this.transport = require(this.protocol);
// Name the server and init the boot state
this.servername = $tw.utils.transliterateToSafeASCII(this.get("server-name") || this.wiki.getTiddlerText("$:/SiteTitle") || "TiddlyWiki5");
this.boot.origin = this.get("origin")? this.get("origin"): this.protocol+"://"+this.get("host")+":"+this.get("port");
this.boot.pathPrefix = this.get("path-prefix") || "";
}
/*
Send a response to the client. This method checks if the response must be sent
or if the client alrady has the data cached. If that's the case only a 304
response will be transmitted and the browser will use the cached data.
Only requests with status code 200 are considdered for caching.
request: request instance passed to the handler
response: response instance passed to the handler
statusCode: stauts code to send to the browser
headers: response headers (they will be augmented with an `Etag` header)
data: the data to send (passed to the end method of the response instance)
encoding: the encoding of the data to send (passed to the end method of the response instance)
*/
function sendResponse(request,response,statusCode,headers,data,encoding) {
if(this.enableBrowserCache && (statusCode == 200)) {
var hash = crypto.createHash('md5');
// Put everything into the hash that could change and invalidate the data that
// the browser already stored. The headers the data and the encoding.
hash.update(data);
hash.update(JSON.stringify(headers));
if(encoding) {
hash.update(encoding);
}
var contentDigest = hash.digest("hex");
// RFC 7232 section 2.3 mandates for the etag to be enclosed in quotes
headers["Etag"] = '"' + contentDigest + '"';
headers["Cache-Control"] = "max-age=0, must-revalidate";
// Check if any of the hashes contained within the if-none-match header
// matches the current hash.
// If one matches, do not send the data but tell the browser to use the
// cached data.
// We do not implement "*" as it makes no sense here.
var ifNoneMatch = request.headers["if-none-match"];
if(ifNoneMatch) {
var matchParts = ifNoneMatch.split(",").map(function(etag) {
return etag.replace(/^[ "]+|[ "]+$/g, "");
});
if(matchParts.indexOf(contentDigest) != -1) {
response.writeHead(304,headers);
response.end();
return;
}
}
}
/*
If the gzip=yes is set, check if the user agent permits compression. If so,
compress our response if the raw data is bigger than 2k. Compressing less
data is inefficient. Note that we use the synchronous functions from zlib
to stay in the imperative style. The current `Server` doesn't depend on
this, and we may just as well use the async versions.
*/
if(this.enableGzip && (data.length > 2048)) {
var acceptEncoding = request.headers["accept-encoding"] || "";
if(/\bdeflate\b/.test(acceptEncoding)) {
headers["Content-Encoding"] = "deflate";
data = zlib.deflateSync(data);
} else if(/\bgzip\b/.test(acceptEncoding)) {
headers["Content-Encoding"] = "gzip";
data = zlib.gzipSync(data);
}
}
response.writeHead(statusCode,headers);
response.end(data,encoding);
}
function redirect(request,response,statusCode,location) {
response.setHeader("Location",location);
response.statusCode = statusCode;
response.end()
}
/*
Options include:
cbPartStart(headers,name,filename) - invoked when a file starts being received
cbPartChunk(chunk) - invoked when a chunk of a file is received
cbPartEnd() - invoked when a file finishes being received
cbFinished(err) - invoked when the all the form data has been processed
*/
function streamMultipartData(request,options) {
// Check that the Content-Type is multipart/form-data
const contentType = request.headers['content-type'];
if(!contentType.startsWith("multipart/form-data")) {
return options.cbFinished("Expected multipart/form-data content type");
}
// Extract the boundary string from the Content-Type header
const boundaryMatch = contentType.match(/boundary=(.+)$/);
if(!boundaryMatch) {
return options.cbFinished("Missing boundary in multipart/form-data");
}
const boundary = boundaryMatch[1];
const boundaryBuffer = Buffer.from("--" + boundary);
// Initialise
let buffer = Buffer.alloc(0);
let processingPart = false;
// Process incoming chunks
request.on("data", (chunk) => {
// Accumulate the incoming data
buffer = Buffer.concat([buffer, chunk]);
// Loop through any parts within the current buffer
while (true) {
if(!processingPart) {
// If we're not processing a part then we try to find a boundary marker
const boundaryIndex = buffer.indexOf(boundaryBuffer);
if(boundaryIndex === -1) {
// Haven't reached the boundary marker yet, so we should wait for more data
break;
}
// Look for the end of the headers
const endOfHeaders = buffer.indexOf("\r\n\r\n",boundaryIndex + boundaryBuffer.length);
if(endOfHeaders === -1) {
// Haven't reached the end of the headers, so we should wait for more data
break;
}
// Extract and parse headers
const headersPart = Uint8Array.prototype.slice.call(buffer,boundaryIndex + boundaryBuffer.length,endOfHeaders).toString();
const currentHeaders = {};
headersPart.split("\r\n").forEach(headerLine => {
const [key, value] = headerLine.split(": ");
currentHeaders[key.toLowerCase()] = value;
});
// Parse the content disposition header
const contentDisposition = {
name: null,
filename: null
};
if(currentHeaders["content-disposition"]) {
// Split the content-disposition header into semicolon-delimited parts
const parts = currentHeaders["content-disposition"].split(";").map(part => part.trim());
// Iterate over each part to extract name and filename if they exist
parts.forEach(part => {
if(part.startsWith("name=")) {
// Remove "name=" and trim quotes
contentDisposition.name = part.substring(6,part.length - 1);
} else if(part.startsWith("filename=")) {
// Remove "filename=" and trim quotes
contentDisposition.filename = part.substring(10,part.length - 1);
}
});
}
processingPart = true;
options.cbPartStart(currentHeaders,contentDisposition.name,contentDisposition.filename);
// Slice the buffer to the next part
buffer = Uint8Array.prototype.slice.call(buffer,endOfHeaders + 4);
} else {
const boundaryIndex = buffer.indexOf(boundaryBuffer);
if(boundaryIndex >= 0) {
// Return the part up to the boundary minus the terminating LF CR
options.cbPartChunk(Uint8Array.prototype.slice.call(buffer,0,boundaryIndex - 2));
options.cbPartEnd();
processingPart = false;
buffer = Uint8Array.prototype.slice.call(buffer,boundaryIndex);
} else {
// Return the rest of the buffer
options.cbPartChunk(buffer);
// Reset the buffer and wait for more data
buffer = Buffer.alloc(0);
break;
}
}
}
});
// All done
request.on("end", () => {
options.cbFinished(null);
});
}
Server.prototype.defaultVariables = {
port: "8080",
host: "127.0.0.1",
"required-plugins": "$:/plugins/tiddlywiki/filesystem,$:/plugins/tiddlywiki/tiddlyweb",
"root-tiddler": "$:/core/save/all",
"root-render-type": "text/plain",
"root-serve-type": "text/html",
"tiddler-render-type": "text/html",
"tiddler-render-template": "$:/core/templates/server/static.tiddler.html",
"system-tiddler-render-type": "text/plain",
"system-tiddler-render-template": "$:/core/templates/wikified-tiddler",
"debug-level": "none",
"gzip": "no",
"use-browser-cache": "no"
};
Server.prototype.get = function(name) {
return this.variables[name];
};
Server.prototype.addRoute = function(route) {
this.routes.push(route);
};
Server.prototype.addAuthenticator = function(AuthenticatorClass) {
// Instantiate and initialise the authenticator
var authenticator = new AuthenticatorClass(this),
result = authenticator.init();
if(typeof result === "string") {
$tw.utils.error("Error: " + result);
} else if(result) {
// Only use the authenticator if it initialised successfully
this.authenticators.push(authenticator);
}
};
Server.prototype.findMatchingRoute = function(request,state) {
for(var t=0; t<this.routes.length; t++) {
var potentialRoute = this.routes[t],
pathRegExp = potentialRoute.path,
pathname = state.urlInfo.pathname,
match;
if(state.pathPrefix) {
if(pathname.substr(0,state.pathPrefix.length) === state.pathPrefix) {
pathname = pathname.substr(state.pathPrefix.length) || "/";
match = potentialRoute.path.exec(pathname);
} else {
match = false;
}
} else {
match = potentialRoute.path.exec(pathname);
}
if(match && request.method === potentialRoute.method) {
state.params = [];
for(var p=1; p<match.length; p++) {
state.params.push(match[p]);
}
return potentialRoute;
}
}
return null;
};
Server.prototype.methodMappings = {
"GET": "readers",
"OPTIONS": "readers",
"HEAD": "readers",
"PUT": "writers",
"POST": "writers",
"DELETE": "writers"
};
/*
Check whether a given user is authorized for the specified authorizationType ("readers" or "writers"). Pass null or undefined as the username to check for anonymous access
*/
Server.prototype.isAuthorized = function(authorizationType,username) {
var principals = this.authorizationPrincipals[authorizationType] || [];
return principals.indexOf("(anon)") !== -1 || (username && (principals.indexOf("(authenticated)") !== -1 || principals.indexOf(username) !== -1));
}
Server.prototype.requestHandler = function(request,response,options) {
options = options || {};
// Compose the state object
var self = this;
var state = {};
state.wiki = options.wiki || self.wiki;
state.boot = options.boot || self.boot;
state.server = self;
state.urlInfo = url.parse(request.url);
state.queryParameters = querystring.parse(state.urlInfo.query);
state.pathPrefix = options.pathPrefix || this.get("path-prefix") || "";
state.sendResponse = sendResponse.bind(self,request,response);
state.redirect = redirect.bind(self,request,response);
state.streamMultipartData = streamMultipartData.bind(self,request);
// Get the principals authorized to access this resource
state.authorizationType = options.authorizationType || this.methodMappings[request.method] || "readers";
// Check whether anonymous access is granted
state.allowAnon = this.isAuthorized(state.authorizationType,null);
// Authenticate with the first active authenticator
if(this.authenticators.length > 0) {
if(!this.authenticators[0].authenticateRequest(request,response,state)) {
// Bail if we failed (the authenticator will have sent the response)
return;
}
}
// Authorize with the authenticated username
if(!this.isAuthorized(state.authorizationType,state.authenticatedUsername)) {
response.writeHead(401,"'" + state.authenticatedUsername + "' is not authorized to access '" + this.servername + "'");
response.end();
return;
}
// Find the route that matches this path
var route = self.findMatchingRoute(request,state);
// Optionally output debug info
if(self.get("debug-level") !== "none") {
console.log("Request path:",JSON.stringify(state.urlInfo));
console.log("Request headers:",JSON.stringify(request.headers));
console.log("authenticatedUsername:",state.authenticatedUsername);
}
// Return a 404 if we didn't find a route
if(!route) {
response.writeHead(404);
response.end();
return;
}
// If this is a write, check for the CSRF header unless globally disabled, or disabled for this route
if(!this.csrfDisable && !route.csrfDisable && state.authorizationType === "writers" && request.headers["x-requested-with"] !== "TiddlyWiki") {
response.writeHead(403,"'X-Requested-With' header required to login to '" + this.servername + "'");
response.end();
return;
}
// Receive the request body if necessary and hand off to the route handler
if(route.bodyFormat === "stream" || request.method === "GET" || request.method === "HEAD") {
// Let the route handle the request stream itself
route.handler(request,response,state);
} else if(route.bodyFormat === "string" || !route.bodyFormat) {
// Set the encoding for the incoming request
request.setEncoding("utf8");
var data = "";
request.on("data",function(chunk) {
data += chunk.toString();
});
request.on("end",function() {
state.data = data;
route.handler(request,response,state);
});
} else if(route.bodyFormat === "buffer") {
var data = [];
request.on("data",function(chunk) {
data.push(chunk);
});
request.on("end",function() {
state.data = Buffer.concat(data);
route.handler(request,response,state);
})
} else {
response.writeHead(400,"Invalid bodyFormat " + route.bodyFormat + " in route " + route.method + " " + route.path.source);
response.end();
}
};
/*
Listen for requests
port: optional port number (falls back to value of "port" variable)
host: optional host address (falls back to value of "host" variable)
prefix: optional prefix (falls back to value of "path-prefix" variable)
callback: optional callback(err) to be invoked when the listener is up and running
*/
Server.prototype.listen = function(port,host,prefix,options) {
var self = this;
// Handle defaults for port and host
port = port || this.get("port");
host = host || this.get("host");
prefix = prefix || this.get("path-prefix") || "";
// Check for the port being a string and look it up as an environment variable
if(parseInt(port,10).toString() !== port) {
port = process.env[port] || 8080;
}
// Warn if required plugins are missing
var missing = [];
for (var index=0; index<this.requiredPlugins.length; index++) {
if(!this.wiki.getTiddler(this.requiredPlugins[index])) {
missing.push(this.requiredPlugins[index]);
}
}
if(missing.length > 0) {
var error = "Warning: Plugin(s) required for client-server operation are missing.\n"+
"\""+ missing.join("\", \"")+"\"";
$tw.utils.warning(error);
}
// Create the server
var server = this.transport.createServer(this.listenOptions || {},function(request,response,options) {
if(self.get("debug-level") !== "none") {
var start = $tw.utils.timer();
response.on("finish",function() {
console.log("Response time:",request.method,request.url,$tw.utils.timer() - start);
});
}
self.requestHandler(request,response,options);
});
// Display the port number after we've started listening (the port number might have been specified as zero, in which case we will get an assigned port)
server.on("listening",function() {
var address = server.address(),
url = self.protocol + "://" + (address.family === "IPv6" ? "[" + address.address + "]" : address.address) + ":" + address.port + prefix;
$tw.utils.log("Serving on " + url,"brown/orange");
$tw.utils.log("(press ctrl-C to exit)","red");
if(options.callback) {
options.callback(null);
}
});
// Listen
return server.listen(port,host);
};
exports.Server = Server;
})();

2
plugins/tiddlywiki/multiwikiserver/modules/routes/handlers/delete-recipe-tiddler.js
View File

@ -1,7 +1,7 @@
/*\
title: $:/plugins/tiddlywiki/multiwikiserver/routes/handlers/delete-recipe-tiddler.js
type: application/javascript
module-type: route
module-type: mws-route
DELETE /wiki/:recipe_name/recipes/:bag_name/tiddler/:title

2
plugins/tiddlywiki/multiwikiserver/modules/routes/handlers/get-bag-tiddler-blob.js
View File

@ -1,7 +1,7 @@
/*\
title: $:/plugins/tiddlywiki/multiwikiserver/routes/handlers/get-bag-tiddler-blob.js
type: application/javascript
module-type: route
module-type: mws-route
GET /wiki/:bag_name/bags/:bag_name/tiddler/:title/blob

2
plugins/tiddlywiki/multiwikiserver/modules/routes/handlers/get-bag-tiddler.js
View File

@ -1,7 +1,7 @@
/*\
title: $:/plugins/tiddlywiki/multiwikiserver/routes/handlers/get-bag-tiddler.js
type: application/javascript
module-type: route
module-type: mws-route
GET /wiki/:bag_name/bags/:bag_name/tiddler/:title

2
plugins/tiddlywiki/multiwikiserver/modules/routes/handlers/get-bag.js
View File

@ -1,7 +1,7 @@
/*\
title: $:/plugins/tiddlywiki/multiwikiserver/routes/handlers/get-bag.js
type: application/javascript
module-type: route
module-type: mws-route
GET /wiki/:bag_name/bags/:bag_name/
GET /wiki/:bag_name/bags/:bag_name

2
plugins/tiddlywiki/multiwikiserver/modules/routes/handlers/get-recipe-tiddler.js
View File

@ -1,7 +1,7 @@
/*\
title: $:/plugins/tiddlywiki/multiwikiserver/routes/handlers/get-recipe-tiddler.js
type: application/javascript
module-type: route
module-type: mws-route
GET /wiki/:recipe_name/recipes/:recipe_name/tiddler/:title

2
plugins/tiddlywiki/multiwikiserver/modules/routes/handlers/get-recipe-tiddlers-json.js
View File

@ -1,7 +1,7 @@
/*\
title: $:/plugins/tiddlywiki/multiwikiserver/routes/handlers/get-recipe-tiddlers-json.js
type: application/javascript
module-type: route
module-type: mws-route
GET /wiki/:recipe_name/recipes/:recipe_name/tiddlers.json?filter=:filter

2
plugins/tiddlywiki/multiwikiserver/modules/routes/handlers/get-recipe.js
View File

@ -1,7 +1,7 @@
/*\
title: $:/plugins/tiddlywiki/multiwikiserver/routes/handlers/get-recipe.js
type: application/javascript
module-type: route
module-type: mws-route
GET /wiki/:recipe_name

2
plugins/tiddlywiki/multiwikiserver/modules/routes/handlers/get-status.js
View File

@ -1,7 +1,7 @@
/*\
title: $:/plugins/tiddlywiki/multiwikiserver/routes/handlers/get-status.js
type: application/javascript
module-type: route
module-type: mws-route
GET /wiki/:recipe_name/status

2
plugins/tiddlywiki/multiwikiserver/modules/routes/handlers/post-bag-tiddlers.js
View File

@ -1,7 +1,7 @@
/*\
title: $:/plugins/tiddlywiki/multiwikiserver/routes/handlers/post-bag-tiddlers.js
type: application/javascript
module-type: route
module-type: mws-route
POST /wiki/:bag_name/bags/:bag_name/tiddlers/

2
plugins/tiddlywiki/multiwikiserver/modules/routes/handlers/put-bag.js
View File

@ -1,7 +1,7 @@
/*\
title: $:/plugins/tiddlywiki/multiwikiserver/routes/handlers/put-bag.js
type: application/javascript
module-type: route
module-type: mws-route
PUT /wiki/:bag_name/bags/:bag_name

2
plugins/tiddlywiki/multiwikiserver/modules/routes/handlers/put-recipe-tiddler.js
View File

@ -1,7 +1,7 @@
/*\
title: $:/plugins/tiddlywiki/multiwikiserver/routes/handlers/put-recipe-tiddler.js
type: application/javascript
module-type: route
module-type: mws-route
PUT /wiki/:recipe_name/recipes/:recipe_name/tiddlers/:title

2
plugins/tiddlywiki/multiwikiserver/modules/routes/handlers/put-recipe.js
View File

@ -1,7 +1,7 @@
/*\
title: $:/plugins/tiddlywiki/multiwikiserver/routes/handlers/put-recipe.js
type: application/javascript
module-type: route
module-type: mws-route
PUT /wiki/:recipe_name/recipes/:recipe_name

100
plugins/tiddlywiki/multiwikiserver/modules/startup.js Normal file
View File

@ -0,0 +1,100 @@
/*\
title: $:/plugins/tiddlywiki/multiwikiserver/startup.js
type: application/javascript
module-type: startup
Multi wiki server initialisation
\*/
(function(){
/*jslint node: true, browser: true */
/*global $tw: false */
"use strict";
// Export name and synchronous status
exports.name = "multiwikiserver";
exports.platforms = ["node"];
exports.before = ["story"];
exports.synchronous = true;
exports.startup = function() {
const store = setupStore();
loadStore(store);
$tw.mws = {
store: store,
serverManager: new ServerManager({
store: store
})
};
}
function setupStore() {
const path = require("path");
// Create and initialise the attachment store and the tiddler store
const AttachmentStore = require("$:/plugins/tiddlywiki/multiwikiserver/store/attachments.js").AttachmentStore,
attachmentStore = new AttachmentStore({
storePath: path.resolve($tw.boot.wikiPath,"store/")
}),
SqlTiddlerStore = require("$:/plugins/tiddlywiki/multiwikiserver/store/sql-tiddler-store.js").SqlTiddlerStore,
store = new SqlTiddlerStore({
databasePath: path.resolve($tw.boot.wikiPath,"store/database.sqlite"),
engine: $tw.wiki.getTiddlerText("$:/config/MultiWikiServer/Engine","better"), // better || wasm
attachmentStore: attachmentStore
});
return store;
}
function loadStore(store) {
const path = require("path");
// Performance timing
console.time("mws-initial-load");
// Copy TiddlyWiki core editions
function copyEdition(options) {
console.log(`Copying edition ${options.tiddlersPath}`);
store.createBag(options.bagName,options.bagDescription);
store.createRecipe(options.recipeName,[options.bagName],options.recipeDescription);
store.saveTiddlersFromPath(path.resolve($tw.boot.corePath,$tw.config.editionsPath,options.tiddlersPath),options.bagName);
}
copyEdition({
bagName: "docs",
bagDescription: "TiddlyWiki Documentation from https://tiddlywiki.com",
recipeName: "docs",
recipeDescription: "TiddlyWiki Documentation from https://tiddlywiki.com",
tiddlersPath: "tw5.com/tiddlers"
});
copyEdition({
bagName: "dev-docs",
bagDescription: "TiddlyWiki Developer Documentation from https://tiddlywiki.com/dev",
recipeName: "dev-docs",
recipeDescription: "TiddlyWiki Developer Documentation from https://tiddlywiki.com/dev",
tiddlersPath: "dev/tiddlers"
});
// Create bags and recipes
store.createBag("bag-alpha","A test bag");
store.createBag("bag-beta","Another test bag");
store.createBag("bag-gamma","A further test bag");
store.createRecipe("recipe-rho",["bag-alpha","bag-beta"],"First wiki");
store.createRecipe("recipe-sigma",["bag-alpha","bag-gamma"],"Second Wiki");
store.createRecipe("recipe-tau",["bag-alpha"],"Third Wiki");
store.createRecipe("recipe-upsilon",["bag-alpha","bag-gamma","bag-beta"],"Fourth Wiki");
// Save tiddlers
store.saveBagTiddler({title: "$:/SiteTitle",text: "Bag Alpha"},"bag-alpha");
store.saveBagTiddler({title: "😀😃😄😁😆🥹😅😂",text: "Bag Alpha"},"bag-alpha");
store.saveBagTiddler({title: "$:/SiteTitle",text: "Bag Beta"},"bag-beta");
store.saveBagTiddler({title: "$:/SiteTitle",text: "Bag Gamma"},"bag-gamma");
console.timeEnd("mws-initial-load");
}
function ServerManager(store) {
this.servers = [];
}
ServerManager.prototype.createServer = function(options) {
const MWSServer = require("$:/plugins/tiddlywiki/multiwikiserver/mws-server.js").Server,
server = new MWSServer(options);
this.servers.push(server);
return server;
}
})();