Introduce "Multi Wiki Server" Plugin

.gitignore

@@ -5,7 +5,9 @@
 tmp/
 output/
 node_modules/
+store/
 /test-results/
 /playwright-report/
 /playwright/.cache/
 $__StoryList.tid
+/editions/test/test-store/*

TODO BEFORE MERGING THIS PR.md

@@ -0,0 +1,4 @@
+The `multi-wiki-support` branch includes some changes that are not intended to be merged into the `master` branch:
+
+* Readme update (see `editions/tw5.com/tiddlers/readme/ReadMe.tid`)
+* Remove `multiwikiserver` plugin from `readme-bld.sh` (see `bin/readme-bld.sh`)

bin/ci-test.sh

@@ -2,6 +2,8 @@
 
 # test TiddlyWiki5 for tiddlywiki.com
 
+npm install
+
 node ./tiddlywiki.js \
 	./editions/test \
 	--verbose \

bin/readme-bld.sh

@@ -10,6 +10,7 @@ fi
 
 # tw5.com readmes
 node $TW5_BUILD_TIDDLYWIKI \
+	+plugins/tiddlywiki/multiwikiserver \
 	editions/tw5.com \
 	--verbose \
 	--output . \

core/language/en-GB/Buttons.multids

@@ -159,6 +159,8 @@ ListBullet/Caption: bulleted list
 ListBullet/Hint: Apply bulleted list formatting to lines containing selection
 ListNumber/Caption: numbered list
 ListNumber/Hint: Apply numbered list formatting to lines containing selection
+ManageACL/Caption: manage access control
+ManageACL/Hint: Manage access control configuration for this wiki
 MonoBlock/Caption: monospaced block
 MonoBlock/Hint: Apply monospaced block formatting to lines containing selection
 MonoLine/Caption: monospaced

core/modules/commander.js

@@ -38,6 +38,13 @@ Commander.prototype.log = function(str) {
 	}
 };
 
+/*
+Clear pending commands
+*/
+Commander.prototype.clearCommands = function() {
+	this.commandTokens = this.commandTokens.slice(0,this.nextToken);
+};
+
 /*
 Write a string if verbose flag is set
 */

core/modules/commands/listen.js

@@ -16,7 +16,7 @@ var Server = require("$:/core/modules/server/server.js").Server;
 
 exports.info = {
 	name: "listen",
-	synchronous: true,
+	synchronous: false,
 	namedParameterMode: true,
 	mandatoryParameters: []
 };
@@ -38,7 +38,11 @@ Command.prototype.execute = function() {
 		wiki: this.commander.wiki,
 		variables: self.params
 	});
-	var nodeServer = this.server.listen();
+	var nodeServer = this.server.listen(null,null,null,{
+		callback: function() {
+			self.callback();
+		}
+	});
 	$tw.hooks.invokeHook("th-server-command-post-start",this.server,nodeServer,"tiddlywiki");
 	return null;
 };

core/modules/commands/quit.js

@@ -0,0 +1,37 @@
+/*\
+title: $:/core/modules/commands/quit.js
+type: application/javascript
+module-type: command
+
+Immediately ends the TiddlyWiki process
+
+\*/
+(function(){
+
+/*jslint node: true, browser: true */
+/*global $tw: false */
+"use strict";
+
+exports.info = {
+	name: "quit",
+	synchronous: true
+};
+
+var Command = function(params,commander,callback) {
+	var self = this;
+	this.params = params;
+	this.commander = commander;
+	this.callback = callback;
+};
+
+Command.prototype.execute = function() {
+	// Clear any pending commands
+	this.commander.clearCommands();
+	// We don't actually quit, we just issue the "th-quit" hook to give listeners a chance to exit
+	$tw.hooks.invokeHook("th-quit");
+	return null;
+};
+
+exports.Command = Command;
+
+})();

core/modules/server/server.js

@@ -364,6 +364,11 @@ Server.prototype.listen = function(port,host,prefix) {
 	}
 	// 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() {
+		// Stop listening when we get the "th-quit" hook
+		$tw.hooks.addHook("th-quit",function() {
+			server.close();
+		});
+		// Log listening details
 		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");

core/modules/syncer.js

@@ -257,7 +257,11 @@ Save an incoming tiddler in the store, and updates the associated tiddlerInfo
 Syncer.prototype.storeTiddler = function(tiddlerFields) {
 	// Save the tiddler
 	var tiddler = new $tw.Tiddler(tiddlerFields);
-	this.wiki.addTiddler(tiddler);
+	// Only save the tiddler if it has changed
+	var existingTiddler = this.wiki.getTiddler(tiddlerFields.title);
+	if(!existingTiddler || !existingTiddler.isEqual(tiddler)) {
+		this.wiki.addTiddler(tiddler);
+	}
 	// Save the tiddler revision and changeCount details
 	this.tiddlerInfo[tiddlerFields.title] = {
 		revision: this.getTiddlerRevision(tiddlerFields.title),
@@ -556,6 +560,7 @@ SaveTiddlerTask.prototype.run = function(callback) {
 			// Invoke the callback
 			callback(null);
 		},{
+			syncer: self.syncer,
 			tiddlerInfo: self.syncer.tiddlerInfo[self.title]
 		});
 	} else {
@@ -586,6 +591,7 @@ DeleteTiddlerTask.prototype.run = function(callback) {
 		// Invoke the callback
 		callback(null);
 	},{
+		syncer: self.syncer,
 		tiddlerInfo: self.syncer.tiddlerInfo[this.title]
 	});
 };
@@ -614,6 +620,8 @@ LoadTiddlerTask.prototype.run = function(callback) {
 		}
 		// Invoke the callback
 		callback(null);
+	},{
+		syncer: self.syncer
 	});
 };
 

core/modules/widgets/image.js

@@ -163,4 +163,4 @@ ImageWidget.prototype.refresh = function(changedTiddlers) {
 
 exports.image = ImageWidget;
 
-})();
+})();

core/modules/widgets/navigator.js

@@ -44,7 +44,8 @@ NavigatorWidget.prototype.render = function(parent,nextSibling) {
 		{type: "tm-fold-tiddler", handler: "handleFoldTiddlerEvent"},
 		{type: "tm-fold-other-tiddlers", handler: "handleFoldOtherTiddlersEvent"},
 		{type: "tm-fold-all-tiddlers", handler: "handleFoldAllTiddlersEvent"},
-		{type: "tm-unfold-all-tiddlers", handler: "handleUnfoldAllTiddlersEvent"}
+		{type: "tm-unfold-all-tiddlers", handler: "handleUnfoldAllTiddlersEvent"},
+		{type: "tm-manage-acl", handler: "handleManageACLTiddlersEvent"}
 	]);
 	this.parentDomNode = parent;
 	this.computeAttributes();
@@ -635,6 +636,14 @@ NavigatorWidget.prototype.handleUnfoldAllTiddlersEvent = function(event) {
 	});
 };
 
+NavigatorWidget.prototype.handleManageACLTiddlersEvent = function() {
+	var pathname = window.location.pathname;
+	var paths = pathname.split("/");
+	var recipeName = paths[paths.length - 1];
+	var bagName = document.querySelector("h1.tc-site-title").innerHTML;
+	window.location.href = "/admin/acl/"+recipeName+"/"+bagName
+};
+
 exports.navigator = NavigatorWidget;
 
 })();

core/ui/PageControls/manage-acl.tid

@@ -0,0 +1,15 @@
+title: $:/core/ui/Buttons/manage-acl
+tags: $:/tags/PageControls
+caption: {{$:/core/images/globe}} {{$:/language/Buttons/ManageACL/Caption}}
+description: {{$:/language/Buttons/ManageACL/Hint}}
+
+\whitespace trim
+<$button tooltip={{$:/language/Buttons/ManageACL/Hint}} aria-label={{$:/language/Buttons/ManageACL/Caption}} class=<<tv-config-toolbar-class>>>
+<$action-managetiddler tiddler=<<currentTiddler>>/>
+{{$:/core/images/globe}}
+<%if [<tv-config-toolbar-text>match[yes]] %>
+<span class="tc-btn-text">
+<$text text={{$:/language/Buttons/ManageACL/Caption}}/>
+</span>
+<%endif%>
+</$button>

core/wiki/tags/PageControls.tid

@@ -1,2 +1,2 @@
 title: $:/tags/PageControls
-list: [[$:/core/ui/Buttons/home]] [[$:/core/ui/Buttons/close-all]] [[$:/core/ui/Buttons/fold-all]] [[$:/core/ui/Buttons/unfold-all]] [[$:/core/ui/Buttons/permaview]] [[$:/core/ui/Buttons/new-tiddler]] [[$:/core/ui/Buttons/new-journal]] [[$:/core/ui/Buttons/new-image]] [[$:/core/ui/Buttons/import]] [[$:/core/ui/Buttons/export-page]] [[$:/core/ui/Buttons/control-panel]] [[$:/core/ui/Buttons/advanced-search]] [[$:/core/ui/Buttons/manager]] [[$:/core/ui/Buttons/tag-manager]] [[$:/core/ui/Buttons/language]] [[$:/core/ui/Buttons/palette]] [[$:/core/ui/Buttons/theme]] [[$:/core/ui/Buttons/layout]] [[$:/core/ui/Buttons/storyview]] [[$:/core/ui/Buttons/encryption]] [[$:/core/ui/Buttons/timestamp]] [[$:/core/ui/Buttons/full-screen]] [[$:/core/ui/Buttons/print]] [[$:/core/ui/Buttons/save-wiki]] [[$:/core/ui/Buttons/refresh]] [[$:/core/ui/Buttons/network-activity]] [[$:/core/ui/Buttons/more-page-actions]]
+list: [[$:/core/ui/Buttons/home]] [[$:/core/ui/Buttons/close-all]] [[$:/core/ui/Buttons/fold-all]] [[$:/core/ui/Buttons/unfold-all]] [[$:/core/ui/Buttons/permaview]] [[$:/core/ui/Buttons/new-tiddler]] [[$:/core/ui/Buttons/new-journal]] [[$:/core/ui/Buttons/new-image]] [[$:/core/ui/Buttons/import]] [[$:/core/ui/Buttons/export-page]] [[$:/core/ui/Buttons/control-panel]] [[$:/core/ui/Buttons/advanced-search]] [[$:/core/ui/Buttons/manager]] [[$:/core/ui/Buttons/tag-manager]] [[$:/core/ui/Buttons/language]] [[$:/core/ui/Buttons/palette]] [[$:/core/ui/Buttons/theme]] [[$:/core/ui/Buttons/layout]] [[$:/core/ui/Buttons/storyview]] [[$:/core/ui/Buttons/encryption]]  [[$:/core/ui/Buttons/manage-acl]]  [[$:/core/ui/Buttons/timestamp]] [[$:/core/ui/Buttons/full-screen]] [[$:/core/ui/Buttons/print]] [[$:/core/ui/Buttons/save-wiki]] [[$:/core/ui/Buttons/refresh]] [[$:/core/ui/Buttons/network-activity]] [[$:/core/ui/Buttons/more-page-actions]]

editions/multiwikiserver/tiddlers/configMultiWikiServerEngine.tid

@@ -0,0 +1,2 @@
+title: $:/config/MultiWikiServer/Engine
+text: better

editions/multiwikiserver/tiddlywiki.info

@@ -0,0 +1,47 @@
+{
+	"description": "Multiple wiki client-server edition",
+	"plugins": [
+		"tiddlywiki/tiddlyweb",
+		"tiddlywiki/filesystem",
+		"tiddlywiki/multiwikiclient",
+		"tiddlywiki/multiwikiserver"
+	],
+	"themes": [
+		"tiddlywiki/vanilla",
+		"tiddlywiki/snowwhite"
+	],
+	"build": {
+		"mws-add-user": [
+			"--mws-add-permission", "READ", "Allows user to create tiddlers",
+			"--mws-add-permission", "WRITE", "Gives the user the permission to edit and delete tiddlers",
+			"--mws-add-role", "ADMIN", "System Administrator",
+			"--mws-assign-role-permission", "ADMIN", "READ",
+			"--mws-assign-role-permission", "ADMIN", "WRITE",
+			"--mws-add-user", "user", "pass123",
+			"--mws-assign-user-role", "user", "ADMIN"
+		],
+		"load-mws-demo-data": [
+			"--mws-load-wiki-folder","./editions/tw5.com","docs", "TiddlyWiki Documentation from https://tiddlywiki.com","docs","TiddlyWiki Documentation from https://tiddlywiki.com",
+			"--mws-load-wiki-folder","./editions/dev","dev","TiddlyWiki Developer Documentation from https://tiddlywiki.com/dev","dev-docs", "TiddlyWiki Developer Documentation from https://tiddlywiki.com/dev",
+			"--mws-load-wiki-folder","./editions/tour","tour","TiddlyWiki Interactive Tour from https://tiddlywiki.com","tour", "TiddlyWiki Interactive Tour from https://tiddlywiki.com",
+			"--mws-create-bag","bag-alpha","A test bag",
+			"--mws-create-bag","bag-beta","Another test bag",
+			"--mws-create-bag","bag-gamma","A further test bag",
+			"--mws-create-recipe","recipe-rho","bag-alpha bag-beta","First wiki",
+			"--mws-create-recipe","recipe-sigma","bag-alpha bag-gamma","Second Wiki",
+			"--mws-create-recipe","recipe-tau","bag-alpha","Third Wiki",
+			"--mws-create-recipe","recipe-upsilon","bag-alpha bag-gamma bag-beta","Fourth Wiki",
+			"--mws-save-tiddler-text","bag-alpha","$:/SiteTitle","bag-alpha",
+			"--mws-save-tiddler-text","bag-alpha","😀😃😄😁😆🥹😅😂","bag-alpha",
+			"--mws-save-tiddler-text","bag-beta","$:/SiteTitle","bag-beta",
+			"--mws-save-tiddler-text","bag-gamma","$:/SiteTitle","bag-gamma",
+			"--mws-add-permission", "READ", "Allows user to create tiddlers",
+			"--mws-add-permission", "WRITE", "Gives the user the permission to edit and delete tiddlers",
+			"--mws-add-role", "ADMIN", "System Administrator",
+			"--mws-add-role", "USER", "Basic User",
+			"--mws-assign-role-permission", "ADMIN", "READ",
+			"--mws-assign-role-permission", "ADMIN", "WRITE",
+			"--mws-assign-role-permission", "USER", "READ"
+			]
+	}
+}

editions/test/playwright.spec.js

@@ -12,9 +12,9 @@ test('get started link', async ({ page }) => {
 
     // Load the generated test TW html
     await page.goto(`file:///${crossPlatformIndexPath}`);
-
+    const title = await page.title();    
     // Sanity check
-    await expect(page.locator('.tc-site-title'), "Expected correct page title to verify the test page was loaded").toHaveText('TiddlyWiki5');
+    await expect(title, "Expected correct page title to verify the test page was loaded").toContain('TiddlyWiki5');
 
     // Wait for jasmine results bar to appear
     await expect(page.locator('.jasmine-overall-result'), "Expected jasmine test results bar to be present").toBeVisible({timeout});

editions/test/tiddlywiki.info

@@ -2,6 +2,7 @@
 	"description": "TiddlyWiki core tests",
 	"plugins": [
 		"tiddlywiki/jasmine",
+		"tiddlywiki/multiwikiserver",
 		"tiddlywiki/geospatial"
 	],
 	"themes": [

editions/tw5.com/tiddlers/readme/ReadMe.tid

@@ -6,7 +6,23 @@ type: text/vnd.tiddlywiki
 \define tv-wikilink-template() https://tiddlywiki.com/static/$uri_doubleencoded$.html
 \import [subfilter{$:/core/config/GlobalImportFilter}]
 
-! Welcome
+---
+
+! ~TiddlyWiki ~MultiWikiServer
+
+UNDER DEVELOPMENT
+
+This is a branch of TiddlyWiki that adds the ~MultiWikiServer plugin.
+
+!! Readme
+
+{{$:/plugins/tiddlywiki/multiwikiserver/readme}}
+
+!! Docs
+
+{{$:/plugins/tiddlywiki/multiwikiserver/docs}}
+
+---
 
 Welcome to TiddlyWiki, a non-linear personal web notebook that anyone can use and keep forever, independently of any corporation.