1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2026-01-22 10:54:46 +00:00

Compare commits

...

29 Commits

Author SHA1 Message Date
jeremy@jermolene.com
75c1e4b4d8 Fix typo 2021-10-27 12:46:25 +01:00
Jeremy Ruston
979f079c7a Merge branch 'master' into external-tasks 2021-10-27 12:27:35 +01:00
jeremy@jermolene.com
894fb1ad35 Fix merging error 2021-03-30 21:28:48 +01:00
jeremy@jermolene.com
9a3c60173a Merge branch 'master' into external-tasks 2021-03-30 21:26:01 +01:00
Jeremy Ruston
2b4619dcbe Merge branch 'master' into external-tasks 2019-10-22 21:52:41 +01:00
Jeremy Ruston
bb20d43cbf Merge branch 'master' into external-tasks 2019-09-24 13:23:42 +01:00
Jeremy Ruston
9c29b15fcd Merge branch 'master' into external-tasks 2019-08-06 21:16:52 +01:00
Jermolene
994a91001d Merge branch 'master' into external-tasks 2019-01-06 17:33:20 +00:00
Jermolene
c85c172fe4 Merge branch 'master' into external-tasks 2018-10-24 10:33:34 +01:00
Jermolene
eeb06a75a6 Add new tagger demo 2018-10-24 10:31:58 +01:00
Jermolene
ff9539059a Refactor pipe command
To make it easier to handle state, and enable us to add support for the "incomingTitle" parameter
2018-10-24 10:31:42 +01:00
Jermolene
5831df9ece Docs updates 2018-10-24 10:30:41 +01:00
Jermolene
b7f758bbbe Docs improvements 2018-10-19 17:56:37 +01:00
Jermolene
36509509bc Decrease server polling interval
5 * 1000 millseconds, instead of the default 60 * 1000
2018-10-19 17:25:41 +01:00
Jermolene
e83d0fb6f5 Merge branch 'master' into external-tasks 2018-10-19 16:32:53 +01:00
Jermolene
a65e9a7b42 @joearm's fixes 2018-10-19 16:29:45 +01:00
Jermolene
9b912f6d65 Update socket-erlang example 2018-10-19 10:18:08 +01:00
Jermolene
4b45afc11f Improvements to sample text 2018-10-19 10:17:38 +01:00
Jermolene
e714693cfe Preliminary support for length+type+message 2018-10-18 17:15:59 +01:00
Jermolene
dffd4e56b5 Bring "Alice in Wonderland" properly into the wiki
We were referencing it in the tw5.com edition, but that makes it harder to use the externalpipesdemo edition independently.
2018-10-18 14:21:59 +01:00
Jermolene
a0b3e1a564 Docs improvements 2018-10-17 21:27:46 +01:00
Jermolene
4efd5288d0 Merge branch 'master' into external-tasks 2018-10-14 18:35:11 +01:00
Jermolene
a2d3778465 Improve demo 2018-10-14 18:35:07 +01:00
Jermolene
f2917c3355 Add support for remote commands
Makes it possible to invoke any of TW5's Node.js commands from the browser. Useful for the new pipe command, but also handy for e.g. rendering tiddlers on the server, fetching remote files, or importing local files etc

Docs to come.
2018-10-14 18:34:55 +01:00
Jermolene
4fcbaa2b12 Mimic - don't crash if there's no source text 2018-10-14 18:32:31 +01:00
Jermolene
d29b9c2726 Merge branch 'master' into external-tasks 2018-10-13 17:25:05 +01:00
Jermolene
97bb1fa8c9 Rename external tasks to external pipes
And add support for connecting via sockets to existing processers/tasks
2018-10-13 14:50:21 +01:00
Jermolene
2e5035ec2a Merge branch 'master' into external-tasks 2018-10-09 21:31:22 +01:00
Jermolene
b292985df3 Initial commit 2018-10-01 19:44:48 +01:00
29 changed files with 5389 additions and 371 deletions

View File

@@ -0,0 +1,13 @@
title: $:/language/Help/pipe
description: Pipe data to/from external processes
Pipe data to/from external processes.
```
--pipe <pipename> <filter> <incomingTitle> <arguments>...
```
* ''pipename'': identifies the pipe, matching the name defined in the `tiddlywiki.info` file
* ''filter'': identifies the tiddlers to be passed to the pipe
* ''incomingTitle'': provides a title to be applied to incoming tiddlers for the `raw-text` output format
* ''arguments'': passed through to external task pipes, and ignored for other types of pipe

View File

@@ -0,0 +1,278 @@
/*\
title: $:/core/modules/commands/pipe.js
type: application/javascript
module-type: command
Command to execute an external task
\*/
(function(){
/*jslint node: true, browser: true */
/*global $tw: false */
"use strict";
exports.info = {
name: "pipe",
synchronous: false
};
var Command = function(params,commander,callback) {
this.params = params;
this.commander = commander;
this.callback = callback;
};
Command.prototype.execute = function() {
var self = this;
if(this.params.length < 2) {
return "Missing parameters";
}
var name = self.params[0], // External pipe name
outgoingFilter = self.params[1], // Filter of tiddlers to write to the pipe
incomingTitle = self.params[2],
args = self.params.slice(3); // Remaining arguments are passed on as tasks arguments
// Find the pipe information
var pipeInfo = ($tw.boot.wikiInfo["external-pipes"] || {})[name];
if(!pipeInfo) {
return this.callback("External pipe \"" + name + "\" not found");
}
// Create the pipe instance and process a message
var pipe = new Pipe({
name: name,
pipeInfo: pipeInfo,
outgoingFilter: outgoingFilter,
incomingTitle: incomingTitle,
args: args,
command: this
});
pipe.processMessage(this.callback);
};
function Pipe(options) {
this.name = options.name;
this.pipeInfo = options.pipeInfo;
this.outgoingFilter = options.outgoingFilter;
this.incomingTitle = options.incomingTitle;
this.args = options.args;
this.command = options.command;
}
Pipe.prototype.processMessage = function(callback) {
// Get the outgoing data
var data = this.composeOutgoingData(this.outgoingFilter);
// Connect to the pipe
switch(this.pipeInfo.type) {
case "task":
this.pipeExternalTask(data,callback);
break;
case "socket":
this.pipeSocket(data,callback);
break;
case "socket-erlang":
this.pipeSocketErlang(data,callback);
break;
default:
callback("Invalid pipe specifier '" + this.name + "': " + this.pipeInfo.type);
break;
}
};
Pipe.prototype.log = function(args) {
this.command.commander.log("Pipe: " + Array.prototype.slice.call(arguments,0).join(" "));
};
Pipe.prototype.pipeExternalTask = function(data,callback) {
var self = this,
spawn = require("child_process").spawn,
path = require("path"),
childProcess = spawn(path.resolve($tw.boot.wikiPath,this.pipeInfo.path),this.args,{
stdio: ["pipe","pipe",process.stderr],
shell: true,
env: $tw.utils.extend({},process.env,this.pipeInfo.environment)
});
// Pass the tiddlers over the outgoing stream
childProcess.stdin.on("error",function(err) {
self.log("Task stdin error",err)
});
childProcess.stdin.write(data);
childProcess.stdin.end();
// Catch the output
var chunks = [];
childProcess.stdout.on("data",function(chunk) {
chunks.push(chunk.toString());
});
childProcess.stdout.on("close",function() {
self.log("Task stdout close");
self.processIncomingData(chunks.join(""));
});
childProcess.stdout.on("error",function(err) {
self.log("Task stdout error",err)
});
// Pick up the output when the process ends
childProcess.on("error",function(err) {
self.log("Task error",err)
});
childProcess.on("exit",function(code,signal) {
self.log("Task exit",code,signal)
if(code !== 0) {
return callback("Error executing external task: " + code);
}
// Exit successfully
callback(null);
});
};
Pipe.prototype.pipeSocket = function(data,callback) {
var self = this,
net = require("net"),
socket = new net.Socket({
allowHalfOpen: true
}),
chunks = [];
socket.connect(this.pipeInfo.port,this.pipeInfo.host || 8081,function() {
self.log("Socket connection",this.pipeInfo.port,this.pipeInfo.host);
socket.write(data);
socket.end();
});
socket.on("error",function(e) {
self.log("Socket error",e)
});
socket.on("data",function(data) {
chunks.push(data.toString());
});
socket.on("end",function() {
self.processIncomingData(chunks.join(""));
self.log("Socket end");
socket.destroy();
});
// Add a "close" event handler for the client socket
socket.on("close",function() {
self.log("Socket closed");
return callback(null);
});
return null;
};
Pipe.prototype.pipeSocketErlang = function(data,callback) {
var self = this,
encoding = this.pipeInfo.encoding || "utf8",
net = require("net"),
socket = new net.Socket(),
accumulator = Buffer.alloc(0);
socket.connect(this.pipeInfo.port,this.pipeInfo.host || 8081,function() {
self.log("Socket connection",self.pipeInfo.port,self.pipeInfo.host);
var dataBytes = Buffer.from(data,encoding);
// Write 32-bit big endian message length
var lengthBytes = Buffer.alloc(4);
lengthBytes.writeUInt32BE(dataBytes.length + 1,0)
console.log("Writing bytes",dataBytes.length + 1);
socket.write(lengthBytes);
// Write 8-bit type
var typeByte = Buffer.alloc(1);
typeByte.writeUInt8(1,0);
socket.write(typeByte);
// Write data
socket.write(dataBytes);
});
socket.on("error",function(e) {
self.log("Socket error",e)
});
socket.on("data",function(data) {
console.log("Received data",data.length)
accumulator = Buffer.concat([accumulator,data]);
while(accumulator.length > 4) {
var length = accumulator.readInt32BE(0);
if(accumulator.length >= (length + 4)) {
if(length < 1) {
throw "ERROR: Incoming message length field is less than 1";
}
var type = accumulator.readUInt8(4),
dataLength = length - 1,
data = accumulator.toString(encoding,5,dataLength + 5);
console.log("Got message",length,type)
self.processIncomingData(data);
accumulator = accumulator.slice(length + 4);
socket.end();
return callback(null);
} else {
break;
}
}
});
socket.on("end",function() {
self.log("Socket end");
socket.destroy();
});
// Add a "close" event handler for the client socket
socket.on("close",function() {
self.log("Socket closed");
return callback(null);
});
return null;
};
Pipe.prototype.composeOutgoingData = function(outgoingFilter) {
var self = this,
pipeInfoInput = this.pipeInfo.input || {},
data;
switch(pipeInfoInput.format || "json-raw-tiddlers") {
case "rendered-text":
var titles = self.command.commander.wiki.filterTiddlers(outgoingFilter),
output = [];
$tw.utils.each(titles,function(title) {
output.push(self.command.commander.wiki.renderTiddler("text/plain",title));
});
data = output.join("");
break;
case "json-rendered-text-tiddlers":
var titles = self.command.commander.wiki.filterTiddlers(outgoingFilter),
tiddlers = [];
$tw.utils.each(titles,function(title) {
tiddlers.push({
title: title,
text: self.command.commander.wiki.renderTiddler("text/plain",title)
})
});
data = JSON.stringify(tiddlers);
break;
case "json-raw-tiddlers":
// Intentional fall-through
default:
data = this.command.commander.wiki.getTiddlersAsJson(outgoingFilter);
break;
}
return data;
};
Pipe.prototype.processIncomingData = function(data) {
var pipeInfoOutput = this.pipeInfo.output || {},
jsonData;
switch(pipeInfoOutput.format || "text") {
case "json-raw-tiddlers":
try {
jsonData = JSON.parse(data);
} catch(e) {
this.log("Error parsing returned JSON: " + e + "\n\n\n->\n" + data);
}
// Add the tiddlers
if(jsonData) {
this.command.commander.wiki.addTiddlers(jsonData);
}
break;
case "text":
// Intentional fall-through
default:
console.log("Writing tiddler",pipeInfoOutput.tiddler,{
text: data, title: this.incomingTitle
})
this.command.commander.wiki.addTiddler(new $tw.Tiddler(pipeInfoOutput.tiddler,{
text: data, title: this.incomingTitle || pipeInfoOutput.tiddler.title
}));
break;
}
};
exports.Command = Command;
})();

View File

@@ -0,0 +1,55 @@
/*\
title: $:/core/modules/server/routes/post-commands.js
type: application/javascript
module-type: route
POST /commands/
\*/
(function() {
/*jslint node: true, browser: true */
/*global $tw: false */
"use strict";
exports.method = "POST";
exports.path = /^\/commands\/$/;
exports.handler = function(request,response,state) {
// Check we're enabled
if(!($tw.boot.wikiInfo.config || {})["allow-remote-commands"]) {
response.writeHead(404);
response.end();
return;
}
// Get the job descriptor
var jobDescriptor = JSON.parse(state.data);
console.log("JOB START:",jobDescriptor)
// Respond OK
response.writeHead(204, "OK",{
"Content-Type": "application/json"
});
// Maintain status
var setStatus = function(status,message) {
if(jobDescriptor.statusTitle) {
state.wiki.addTiddler(new $tw.Tiddler({title: jobDescriptor.statusTitle,text: status,message: message}));
}
}
setStatus("started");
// Initiate the commands
var commander = new $tw.Commander(
jobDescriptor.commands || [],
function(err) {
setStatus(err ? "error" : "ok",err ? err : undefined);
console.log("JOB END:",err)
},
state.wiki,
{output: process.stdout, error: process.stderr}
);
commander.execute();
// Return results
response.end(JSON.stringify({}),"utf8"); // Nothing useful for us to return
};
}());

View File

@@ -130,6 +130,11 @@ function Syncer(options) {
$tw.rootWidget.addEventListener("tm-server-refresh",function() {
self.handleRefreshEvent();
});
$tw.rootWidget.addEventListener("tm-execute-job",function(event) {
if(self.syncadaptor && self.syncadaptor.executeJob) {
self.syncadaptor.executeJob(event);
}
});
$tw.rootWidget.addEventListener("tm-copy-syncer-logs-to-clipboard",function() {
$tw.utils.copyToClipboard($tw.utils.getSystemInfo() + "\n\nLog:\n" + self.logger.getBuffer());
});

View File

@@ -0,0 +1,123 @@
created: 20181001171604072
modified: 20181001184306738
title: External Pipes
type: text/vnd.tiddlywiki
!! Introduction
The external pipes mechanism is intended to address the fact that it can be difficult for experienced developers to quickly get started working with TiddlyWiki's code because it requires a good understanding of JavaScript, and some relatively unusual concepts and techniques that are likely to be unfamiliar to most.
Many software developers are comfortable using and building text-based command line tools that follow the Unix philosophy of using stdin/stdout or TCP sockets for input and output, allowing tools to be chained together in powerful ways.
External pipes support data transfer with external programs via two techniques:
* By directly executing the program and communicating with it via stdin and stdout ([[mimic.js|External Pipes mimic.js]] and [[stats.js|External Pipes stats.js]])
* By connecting to an existing TCP socket via a host address and port ([[reverser.js|External Pipes reverser.js]])
Pipes are registered and executed under Node.js. Execution can be triggered via a server command or via a message propagated from the browser.
Pipes currently support a simple question/response model:
* TiddlyWiki opens a connection to the host/port, or starts the external task
* TiddlyWiki sends the outgoing data through the pipe
* TiddlyWiki receives the incoming data through the pipe
* The connection is close, or the external task exits
!! `externalpipesdemo` Edition
The edition at `editions/externalpipesdemo` in the TiddlyWiki 5 repo contains the example tasks referenced in this documentation.
!! Configuration
Pipes must be registered in the `tiddlywiki.info` file of a wiki folder. For example:
{{External Pipes tiddlywiki.info}}
!!! Task Configuration Properties
TBD
!!! Input Formats
The available input formats are:
* `raw-text` - concatenated raw text of the tiddlers
* `rendered-text` - concatenated rendered text of the tiddlers
* `rendered-html` - concatenated rendered html of the tiddlers
* `json-raw-tiddlers` - raw tiddlers in JSON
* `json-rendered-text-tiddlers` - rendered tiddlers in JSON
!!! Output Formats
The available output formats include:
* `raw-text` - raw text
* `json-raw-tiddlers` - raw tiddlers in JSON
!! Usage
Pipes can be invoked via the `--pipe` command, or via a widget message propagated from the browser to the server.
!!! `--pipe` Command
The `--pipe` command triggers the invocation of a pipe task. The parameters are:
```
tiddlywiki <wikifolder> --pipe <pipename> <filter> <incomingTitle> <arguments>...
```
The ''pipename'' identifies the pipe, and must match the name defined in the `tiddlywiki.info` file.
The ''filter'' identifies the tiddlers to be passed to the pipe
The ''incomingTitle'' provides a title to be applied to incoming tiddlers for the `raw-text` output format
The remaining ''arguments'' are passed through to external task pipes, and ignored for other types of pipe.
!!! `tm-exec-task` Message
TBD
!! Examples
The edition `editions/externalpipesdemo` in the TiddlyWiki5 repo contains a demo wiki that invokes sample tasks.
!!! Mimic
The `mimic.js` example is a simple command line tool that accepts source text via stdin and outputs a sort of statistical parody of the input text. It is written without any knowledge of TiddlyWiki, and so serves as an example of using an existing text-based tool with TiddlyWiki.
```
tiddlywiki editions/externalpipesdemo/ --verbose --pipe mimic '[[Alice in Wonderland]]' HelloThere 5 4000 --build index
```
View the resulting wiki at `editions/externaltaskdemo/output/index.html`: the tiddler "HelloThere" will contain a garbled version of the "Alice in Wonderland" text.
!!! Stats
The `stats.js` example is a simple command line tool that accepts source text via stdin and outputs a sort of statistical parody of the input text. It is written without any knowledge of TiddlyWiki, and so serves as an example of using an existing text-based tool with TiddlyWiki.
```
tiddlywiki editions/externalpipesdemo/ --verbose --pipe stats '[[Alice in Wonderland]]' HelloThere --build index
```
View the resulting wiki at `editions/externaltaskdemo/output/index.html`: the tiddler "HelloThere" will contain statistics about the "Alice in Wonderland" text.
!!! Reverser
The `reverser.js` example is an simple command line tool that listens for connections on a host address and port, accepts source text and then returns the same text with the characters reversed.
Two separate commands are needed to run the sample: one to get the server running, and the second to run TiddlyWiki and invoke the server.
To run the server, open a command prompt in the `demo-tasks` directory and run:
```
../reverser.js 8081
```
And then in another command prompt in the root of the repo run:
```
tiddlywiki editions/externalpipesdemo/ --verbose --pipe reverser '[[Alice in Wonderland]]' HelloThere --build index
```
View the resulting wiki at `editions/externaltaskdemo/output/index.html`: the tiddler "HelloThere" will contain the reversed text of "Alice in Wonderland".

View File

@@ -0,0 +1,32 @@
{
"tiddlers": [
{
"file": "../../../../../externalpipesdemo/tiddlywiki.info",
"fields": {
"type": "text/plain",
"title": "External Pipes tiddlywiki.info"
}
},
{
"file": "../../../../../externalpipesdemo/demo-tasks/mimic.js",
"fields": {
"type": "application/javascript",
"title": "External Pipes mimic.js"
}
},
{
"file": "../../../../../externalpipesdemo/demo-tasks/reverser.js",
"fields": {
"type": "application/javascript",
"title": "External Pipes reverser.js"
}
},
{
"file": "../../../../../externalpipesdemo/demo-tasks/stats.js",
"fields": {
"type": "application/javascript",
"title": "External Pipes stats.js"
}
}
]
}

View File

@@ -0,0 +1,80 @@
#!/usr/bin/env node
/*
A socket server that listens on a host/port for connections and suggests tags for the incoming text
badtagger.js <port> <host>
This utility is provided as an example of using an external task that doesn't have any prior knowledge of
TiddlyWiki. Like many Unix utilities, it just reads and writes to a socket.
*/
var net = require("net"),
port = parseInt(process.argv[2] || "",10) || 8081, // Port
host = process.argv[3] || "127.0.0.1"; // Host
var server = net.createServer();
server.listen(port,host);
server.on("connection", function(sock) {
console.log("CONNECTED: " + sock.remoteAddress +":"+ sock.remotePort);
// Trap errors
sock.on("error",function(e) {
console.log("ERROR: " + e);
});
// Read data until the end
var accumulator = Buffer.alloc(0);
sock.on("data",function(data) {
console.log("DATA " + sock.remoteAddress + ": " + data.length);
accumulator = Buffer.concat([accumulator,Buffer.from(data)]);
while(accumulator.length > 4) {
var length = accumulator.readInt32BE(0);
if(accumulator.length >= (length + 4)) {
if(length < 1) {
throw "ERROR: Incoming message length field is less than 1";
}
var type = accumulator.readUInt8(4),
dataLength = length - 1,
data = accumulator.toString("latin1",5,dataLength + 5);
accumulator = accumulator.slice(length + 4);
// Recase it
console.log("MESSAGE",length,type);
var suggestedTags = Buffer.from(suggestTags(data),"latin1");
// Send it back
var lengthBytes = Buffer.alloc(4);
lengthBytes.writeUInt32BE(suggestedTags.length + 1,0)
console.log("RESPONSE",1,suggestedTags.length)
sock.write(lengthBytes);
var typeByte = Buffer.alloc(1);
typeByte.writeUInt8(1,0);
sock.write(typeByte);
sock.write(suggestedTags);
} else {
break;
}
}
});
sock.on("end",function() {
console.log("END")
sock.end();
});
sock.on("close", function(data) {
console.log("CLOSED: " + sock.remoteAddress +" "+ sock.remotePort);
});
});
function suggestTags(str) {
var tags = [];
if(/e/mi.test(str)) {
tags.push("elephant");
}
if(/s/mi.test(str)) {
tags.push("snake");
}
if(/c/mi.test(str)) {
tags.push("cow");
}
return tags.join("\n");
}

View File

@@ -0,0 +1,109 @@
#!/usr/bin/env node
/*
Reads source text from stdin and mimics it to stdout to stdout using a simple statistical analysis of ngram frequency
mimic.js <ngram-length> <output-length>
This utility is provided as an example of using an external task that doesn't have any prior knowledge of
TiddlyWiki. Like many Unix utilities, it just reads input from stdin and writes its output to stdout.
*/
var paramNgramLength = parseInt(process.argv[2] || "",10) || 3, // Size of ngrams for mimicing
paramOutputLength = parseInt(process.argv[3] || "",10) || 1000;
process.stdin.resume();
process.stdin.setEncoding("utf8");
var inputChunks = [];
process.stdin.on("data",function(chunk) {
inputChunks.push(chunk);
});
process.stdin.on("end",function() {
// Do the mimicry
var output = mimic(inputChunks.join(""),paramNgramLength);
// Output the result
process.stdout.write(output);
});
function mimic(sourceText,paramNgramLength) {
if(!sourceText) {
return "";
}
var tree = {};
scanText(tree,sourceText,paramNgramLength);
return generateText(tree,sourceText,paramNgramLength,paramOutputLength);
}
/*
The source text is scanned to build a tree of the ngram prefixes as follows:
{
"abc": { // The ngram prefix described by this record
count: 42, // The number of times the prefix is found in the source text
next: [ // An array of information about each subsequent character encountered after the prefix
{char: "d", count: 41},
{char: " ", count: 1}
]
},
"def": ... etc
}
*/
// Process the source text into the specified tree with the chosen ngram size
function scanText(tree,sourceText,size) {
var currgram = [],ptr,c,ngram,branch,n;
if(sourceText.length <= size*2)
return tree;
sourceText += sourceText.substring(0,size*2-1); // Wrap the text around
for(ptr=0; ptr<size; ptr++) {
currgram.push(sourceText.substr(ptr,1));
}
while(ptr < sourceText.length) {
ngram = currgram.join("");
c = sourceText.substr(ptr++,1);
branch = tree[ngram];
if(branch === undefined) {
branch = tree[ngram] = {count: 0,next: []};
}
for(n = 0; n<branch.next.length; n++) {
if(branch.next[n].char === c)
break;
}
if(branch.next[n] === undefined) {
branch.next[n] = {char: c, count: 1};
} else {
branch.next[n].count++;
}
branch.count++;
currgram.push(c)
currgram.shift();
}
return tree;
}
// Use the tree to generate mimicry
function generateText(tree,sourceText,size,length) {
var currgram = [];
for(var t=0; t<size; t++) {
currgram.push(sourceText.substr(t,1));
}
var result = [];
var c,ngram,branch,r,n;
for(t=0; t<length; t++) {
ngram = currgram.join("");
branch = tree[ngram];
n = 0;
r = Math.floor(Math.random() * branch.count);
while(r >= branch.next[n].count) {
r = r - branch.next[n].count;
n++;
}
c = branch.next[n].char;
result.push(c);
currgram.push(c)
currgram.shift();
}
return result.join("");
}

View File

@@ -0,0 +1,3 @@
# Sample Processes for TiddlyWiki External Pipes
"External Pipes" are connections enabling a wiki to communicate with an external process to perform arbitrary processing on a group of tiddlers.

View File

@@ -0,0 +1,39 @@
#!/usr/bin/env escript
%% run with sh ./recase_erl.sh
-mode(compile).
main(_) ->
{ok, Listen} = gen_tcp:listen(8081, [binary,{packet,4},
{active,true}]),
spawn(fun() -> par_connect(Listen) end),
receive after infinity -> void end.
par_connect(Listen) ->
{ok, Socket} = gen_tcp:accept(Listen),
io:format("connected ~n"),
spawn(fun() -> par_connect(Listen) end),
loop(Socket).
loop(Socket) ->
receive
{tcp,Socket,Bin} ->
io:format("received ~p bytes ~s ~n",[size(Bin), Bin]),
Return = recase_binary(Bin),
io:format("sending: ~p bytes~n",[size(Return)]),
gen_tcp:send(Socket, Return),
loop(Socket);
Other ->
io:format("received ~p~n",[Other])
end.
recase_binary(<<1,B/binary>>) ->
L = binary_to_list(B),
L1 = [recase(I) || I <- L],
B1 = list_to_binary(L1),
<<1,B1/binary>>.
recase(I) when I >= $a, I =< $z -> I - $a + $A;
recase(I) when I >= $A, I =< $Z -> I - $A + $a;
recase(I) -> I.

View File

@@ -0,0 +1,77 @@
#!/usr/bin/env node
/*
A socket server that listens on a host/port for connections and reverses the case of incoming text
recaser.js <port> <host>
This utility is provided as an example of using an external task that doesn't have any prior knowledge of
TiddlyWiki. Like many Unix utilities, it just reads and writes to a socket.
*/
var net = require("net"),
port = parseInt(process.argv[2] || "",10) || 8081, // Port
host = process.argv[3] || "127.0.0.1"; // Host
var server = net.createServer();
server.listen(port,host);
server.on("connection", function(sock) {
console.log("CONNECTED: " + sock.remoteAddress +":"+ sock.remotePort);
// Trap errors
sock.on("error",function(e) {
console.log("ERROR: " + e);
});
// Read data until the end
var accumulator = Buffer.alloc(0);
sock.on("data",function(data) {
console.log("DATA " + sock.remoteAddress + ": " + data.length);
accumulator = Buffer.concat([accumulator,Buffer.from(data)]);
while(accumulator.length > 4) {
var length = accumulator.readInt32BE(0);
if(accumulator.length >= (length + 4)) {
if(length < 1) {
throw "ERROR: Incoming message length field is less than 1";
}
var type = accumulator.readUInt8(4),
dataLength = length - 1,
data = accumulator.toString("latin1",5,dataLength + 5);
accumulator = accumulator.slice(length + 4);
// Recase it
console.log("MESSAGE",length,type);
var recasedData = Buffer.from(recase(data),"latin1");
// Send it back
var lengthBytes = Buffer.alloc(4);
lengthBytes.writeUInt32BE(recasedData.length + 1,0)
console.log("RESPONSE",1,recasedData.length)
sock.write(lengthBytes);
var typeByte = Buffer.alloc(1);
typeByte.writeUInt8(1,0);
sock.write(typeByte);
sock.write(recasedData);
} else {
break;
}
}
});
sock.on("end",function() {
console.log("END")
sock.end();
});
sock.on("close", function(data) {
console.log("CLOSED: " + sock.remoteAddress +" "+ sock.remotePort);
});
});
function recase(str) {
return str.split("").map(function(char) {
if(char >= "A" && char <= "Z") {
return char.toLowerCase();
} else {
return char.toUpperCase();
}
}).join("");
}

View File

@@ -0,0 +1,49 @@
#!/usr/bin/env node
/*
A socket server that listens on a host/port for connections and reverses the order of incoming text
reverser.js <port> <host>
This utility is provided as an example of using an external task that doesn't have any prior knowledge of
TiddlyWiki. Like many Unix utilities, it just reads and writes to a socket.
*/
var net = require("net"),
port = parseInt(process.argv[2] || "",10) || 8081, // Port
host = process.argv[3] || "127.0.0.1"; // Host
var server = net.createServer({
allowHalfOpen: true
});
server.listen(port,host);
server.on("connection", function(sock) {
console.log("CONNECTED: " + sock.remoteAddress +":"+ sock.remotePort);
// Trap errors
sock.on("error",function(e) {
console.log("ERROR: " + e);
});
// Read data until the end
var chunks = [];
sock.on("data",function(data) {
console.log("DATA " + sock.remoteAddress + ": " + data);
chunks.push(data.toString());
});
sock.on("end",function() {
console.log("END")
// Write the data back to the socket
sock.write(reverse(chunks.join("")));
sock.end();
});
sock.on("close", function(data) {
console.log("CLOSED: " + sock.remoteAddress +" "+ sock.remotePort);
});
});
function reverse(str) {
return str.split("").reverse().join("");
}

View File

@@ -0,0 +1,82 @@
#!/usr/bin/env node
/*
Reads JSON tiddlers from stdin and outputs stats to stdout
stats.js
This utility is provided as an example of an external task that understands tiddler objects encoded in JSON.
It expects to read an array of tiddler objects from stdin in this format:
[
{
"title": "Tiddler Title",
"text": "Text of tiddler",
"tags": "MyTag [[My Other Tag]]"
},
...
]
The output is in the same format.
*/
process.stdin.resume();
process.stdin.setEncoding("utf8");
var inputChunks = [];
process.stdin.on("data",function(chunk) {
inputChunks.push(chunk);
});
process.stdin.on("end",function() {
// Read the JSON input
var json = inputChunks.join(""),
data;
try {
data = JSON.parse(json);
} catch(e) {
throw "Malformed JSON: " + e + "\n\n" + json;
}
// Compute some stats
var output = computeStats(data);
// Output the result
process.stdout.write(JSON.stringify(output));
});
function computeStats(tiddlers) {
var numTiddlers = tiddlers.length,
wordCount = 0,
wordFrequency = {};
tiddlers.forEach(function(tiddler) {
var matches = (tiddler.text || "").match(/[A-Za-z0-9\u00c0-\u00d6\u00d8-\u00de\u00df-\u00f6\u00f8-\u00ff\u0150\u0170\u0151\u0171]+/g);
if(matches) {
wordCount += matches.length;
matches.forEach(function(word) {
word = word.toLowerCase();
wordFrequency[word] = wordFrequency[word] || 0;
wordFrequency[word] += 1;
});
}
});
var sortedWords = Object.keys(wordFrequency).sort(function(a,b) {
if(wordFrequency[a] > wordFrequency[b]) {
return -1;
} else if(wordFrequency[a] < wordFrequency[b]) {
return +1;
} else {
return 0;
}
});
// Output
return [
{
title: "PipeOutput",
text: numTiddlers + " tiddlers in sample.\n" + wordCount + " words in sample.\n" + sortedWords.filter(function(word) {
return word.length > 1 && wordFrequency[word] > 1;
}).map(function(word) {
return word + " " + wordFrequency[word] + "\n";
}).join(""),
type: "text/plain"
}
];
};

View File

@@ -0,0 +1,360 @@
title: Alice in Wonderland License
tags: text/plain
End of Project Gutenberg's Alice's Adventures in Wonderland, by Lewis Carroll
*** END OF THIS PROJECT GUTENBERG EBOOK ALICE'S ADVENTURES IN WONDERLAND ***
***** This file should be named 11.txt or 11.zip *****
This and all associated files of various formats will be found in:
http://www.gutenberg.org/1/11/
Updated editions will replace the previous one--the old editions
will be renamed.
Creating the works from public domain print editions means that no
one owns a United States copyright in these works, so the Foundation
(and you!) can copy and distribute it in the United States without
permission and without paying copyright royalties. Special rules,
set forth in the General Terms of Use part of this license, apply to
copying and distributing Project Gutenberg-tm electronic works to
protect the PROJECT GUTENBERG-tm concept and trademark. Project
Gutenberg is a registered trademark, and may not be used if you
charge for the eBooks, unless you receive specific permission. If you
do not charge anything for copies of this eBook, complying with the
rules is very easy. You may use this eBook for nearly any purpose
such as creation of derivative works, reports, performances and
research. They may be modified and printed and given away--you may do
practically ANYTHING with public domain eBooks. Redistribution is
subject to the trademark license, especially commercial
redistribution.
*** START: FULL LICENSE ***
THE FULL PROJECT GUTENBERG LICENSE
PLEASE READ THIS BEFORE YOU DISTRIBUTE OR USE THIS WORK
To protect the Project Gutenberg-tm mission of promoting the free
distribution of electronic works, by using or distributing this work
(or any other work associated in any way with the phrase "Project
Gutenberg"), you agree to comply with all the terms of the Full Project
Gutenberg-tm License (available with this file or online at
http://gutenberg.org/license).
Section 1. General Terms of Use and Redistributing Project Gutenberg-tm
electronic works
1.A. By reading or using any part of this Project Gutenberg-tm
electronic work, you indicate that you have read, understand, agree to
and accept all the terms of this license and intellectual property
(trademark/copyright) agreement. If you do not agree to abide by all
the terms of this agreement, you must cease using and return or destroy
all copies of Project Gutenberg-tm electronic works in your possession.
If you paid a fee for obtaining a copy of or access to a Project
Gutenberg-tm electronic work and you do not agree to be bound by the
terms of this agreement, you may obtain a refund from the person or
entity to whom you paid the fee as set forth in paragraph 1.E.8.
1.B. "Project Gutenberg" is a registered trademark. It may only be
used on or associated in any way with an electronic work by people who
agree to be bound by the terms of this agreement. There are a few
things that you can do with most Project Gutenberg-tm electronic works
even without complying with the full terms of this agreement. See
paragraph 1.C below. There are a lot of things you can do with Project
Gutenberg-tm electronic works if you follow the terms of this agreement
and help preserve free future access to Project Gutenberg-tm electronic
works. See paragraph 1.E below.
1.C. The Project Gutenberg Literary Archive Foundation ("the Foundation"
or PGLAF), owns a compilation copyright in the collection of Project
Gutenberg-tm electronic works. Nearly all the individual works in the
collection are in the public domain in the United States. If an
individual work is in the public domain in the United States and you are
located in the United States, we do not claim a right to prevent you from
copying, distributing, performing, displaying or creating derivative
works based on the work as long as all references to Project Gutenberg
are removed. Of course, we hope that you will support the Project
Gutenberg-tm mission of promoting free access to electronic works by
freely sharing Project Gutenberg-tm works in compliance with the terms of
this agreement for keeping the Project Gutenberg-tm name associated with
the work. You can easily comply with the terms of this agreement by
keeping this work in the same format with its attached full Project
Gutenberg-tm License when you share it without charge with others.
1.D. The copyright laws of the place where you are located also govern
what you can do with this work. Copyright laws in most countries are in
a constant state of change. If you are outside the United States, check
the laws of your country in addition to the terms of this agreement
before downloading, copying, displaying, performing, distributing or
creating derivative works based on this work or any other Project
Gutenberg-tm work. The Foundation makes no representations concerning
the copyright status of any work in any country outside the United
States.
1.E. Unless you have removed all references to Project Gutenberg:
1.E.1. The following sentence, with active links to, or other immediate
access to, the full Project Gutenberg-tm License must appear prominently
whenever any copy of a Project Gutenberg-tm work (any work on which the
phrase "Project Gutenberg" appears, or with which the phrase "Project
Gutenberg" is associated) is accessed, displayed, performed, viewed,
copied or distributed:
This eBook is for the use of anyone anywhere at no cost and with
almost no restrictions whatsoever. You may copy it, give it away or
re-use it under the terms of the Project Gutenberg License included
with this eBook or online at www.gutenberg.org
1.E.2. If an individual Project Gutenberg-tm electronic work is derived
from the public domain (does not contain a notice indicating that it is
posted with permission of the copyright holder), the work can be copied
and distributed to anyone in the United States without paying any fees
or charges. If you are redistributing or providing access to a work
with the phrase "Project Gutenberg" associated with or appearing on the
work, you must comply either with the requirements of paragraphs 1.E.1
through 1.E.7 or obtain permission for the use of the work and the
Project Gutenberg-tm trademark as set forth in paragraphs 1.E.8 or
1.E.9.
1.E.3. If an individual Project Gutenberg-tm electronic work is posted
with the permission of the copyright holder, your use and distribution
must comply with both paragraphs 1.E.1 through 1.E.7 and any additional
terms imposed by the copyright holder. Additional terms will be linked
to the Project Gutenberg-tm License for all works posted with the
permission of the copyright holder found at the beginning of this work.
1.E.4. Do not unlink or detach or remove the full Project Gutenberg-tm
License terms from this work, or any files containing a part of this
work or any other work associated with Project Gutenberg-tm.
1.E.5. Do not copy, display, perform, distribute or redistribute this
electronic work, or any part of this electronic work, without
prominently displaying the sentence set forth in paragraph 1.E.1 with
active links or immediate access to the full terms of the Project
Gutenberg-tm License.
1.E.6. You may convert to and distribute this work in any binary,
compressed, marked up, nonproprietary or proprietary form, including any
word processing or hypertext form. However, if you provide access to or
distribute copies of a Project Gutenberg-tm work in a format other than
"Plain Vanilla ASCII" or other format used in the official version
posted on the official Project Gutenberg-tm web site (www.gutenberg.org),
you must, at no additional cost, fee or expense to the user, provide a
copy, a means of exporting a copy, or a means of obtaining a copy upon
request, of the work in its original "Plain Vanilla ASCII" or other
form. Any alternate format must include the full Project Gutenberg-tm
License as specified in paragraph 1.E.1.
1.E.7. Do not charge a fee for access to, viewing, displaying,
performing, copying or distributing any Project Gutenberg-tm works
unless you comply with paragraph 1.E.8 or 1.E.9.
1.E.8. You may charge a reasonable fee for copies of or providing
access to or distributing Project Gutenberg-tm electronic works provided
that
- You pay a royalty fee of 20% of the gross profits you derive from
the use of Project Gutenberg-tm works calculated using the method
you already use to calculate your applicable taxes. The fee is
owed to the owner of the Project Gutenberg-tm trademark, but he
has agreed to donate royalties under this paragraph to the
Project Gutenberg Literary Archive Foundation. Royalty payments
must be paid within 60 days following each date on which you
prepare (or are legally required to prepare) your periodic tax
returns. Royalty payments should be clearly marked as such and
sent to the Project Gutenberg Literary Archive Foundation at the
address specified in Section 4, "Information about donations to
the Project Gutenberg Literary Archive Foundation."
- You provide a full refund of any money paid by a user who notifies
you in writing (or by e-mail) within 30 days of receipt that s/he
does not agree to the terms of the full Project Gutenberg-tm
License. You must require such a user to return or
destroy all copies of the works possessed in a physical medium
and discontinue all use of and all access to other copies of
Project Gutenberg-tm works.
- You provide, in accordance with paragraph 1.F.3, a full refund of any
money paid for a work or a replacement copy, if a defect in the
electronic work is discovered and reported to you within 90 days
of receipt of the work.
- You comply with all other terms of this agreement for free
distribution of Project Gutenberg-tm works.
1.E.9. If you wish to charge a fee or distribute a Project Gutenberg-tm
electronic work or group of works on different terms than are set
forth in this agreement, you must obtain permission in writing from
both the Project Gutenberg Literary Archive Foundation and Michael
Hart, the owner of the Project Gutenberg-tm trademark. Contact the
Foundation as set forth in Section 3 below.
1.F.
1.F.1. Project Gutenberg volunteers and employees expend considerable
effort to identify, do copyright research on, transcribe and proofread
public domain works in creating the Project Gutenberg-tm
collection. Despite these efforts, Project Gutenberg-tm electronic
works, and the medium on which they may be stored, may contain
"Defects," such as, but not limited to, incomplete, inaccurate or
corrupt data, transcription errors, a copyright or other intellectual
property infringement, a defective or damaged disk or other medium, a
computer virus, or computer codes that damage or cannot be read by
your equipment.
1.F.2. LIMITED WARRANTY, DISCLAIMER OF DAMAGES - Except for the "Right
of Replacement or Refund" described in paragraph 1.F.3, the Project
Gutenberg Literary Archive Foundation, the owner of the Project
Gutenberg-tm trademark, and any other party distributing a Project
Gutenberg-tm electronic work under this agreement, disclaim all
liability to you for damages, costs and expenses, including legal
fees. YOU AGREE THAT YOU HAVE NO REMEDIES FOR NEGLIGENCE, STRICT
LIABILITY, BREACH OF WARRANTY OR BREACH OF CONTRACT EXCEPT THOSE
PROVIDED IN PARAGRAPH F3. YOU AGREE THAT THE FOUNDATION, THE
TRADEMARK OWNER, AND ANY DISTRIBUTOR UNDER THIS AGREEMENT WILL NOT BE
LIABLE TO YOU FOR ACTUAL, DIRECT, INDIRECT, CONSEQUENTIAL, PUNITIVE OR
INCIDENTAL DAMAGES EVEN IF YOU GIVE NOTICE OF THE POSSIBILITY OF SUCH
DAMAGE.
1.F.3. LIMITED RIGHT OF REPLACEMENT OR REFUND - If you discover a
defect in this electronic work within 90 days of receiving it, you can
receive a refund of the money (if any) you paid for it by sending a
written explanation to the person you received the work from. If you
received the work on a physical medium, you must return the medium with
your written explanation. The person or entity that provided you with
the defective work may elect to provide a replacement copy in lieu of a
refund. If you received the work electronically, the person or entity
providing it to you may choose to give you a second opportunity to
receive the work electronically in lieu of a refund. If the second copy
is also defective, you may demand a refund in writing without further
opportunities to fix the problem.
1.F.4. Except for the limited right of replacement or refund set forth
in paragraph 1.F.3, this work is provided to you 'AS-IS' WITH NO OTHER
WARRANTIES OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
WARRANTIES OF MERCHANTIBILITY OR FITNESS FOR ANY PURPOSE.
1.F.5. Some states do not allow disclaimers of certain implied
warranties or the exclusion or limitation of certain types of damages.
If any disclaimer or limitation set forth in this agreement violates the
law of the state applicable to this agreement, the agreement shall be
interpreted to make the maximum disclaimer or limitation permitted by
the applicable state law. The invalidity or unenforceability of any
provision of this agreement shall not void the remaining provisions.
1.F.6. INDEMNITY - You agree to indemnify and hold the Foundation, the
trademark owner, any agent or employee of the Foundation, anyone
providing copies of Project Gutenberg-tm electronic works in accordance
with this agreement, and any volunteers associated with the production,
promotion and distribution of Project Gutenberg-tm electronic works,
harmless from all liability, costs and expenses, including legal fees,
that arise directly or indirectly from any of the following which you do
or cause to occur: (a) distribution of this or any Project Gutenberg-tm
work, (b) alteration, modification, or additions or deletions to any
Project Gutenberg-tm work, and (c) any Defect you cause.
Section 2. Information about the Mission of Project Gutenberg-tm
Project Gutenberg-tm is synonymous with the free distribution of
electronic works in formats readable by the widest variety of computers
including obsolete, old, middle-aged and new computers. It exists
because of the efforts of hundreds of volunteers and donations from
people in all walks of life.
Volunteers and financial support to provide volunteers with the
assistance they need, is critical to reaching Project Gutenberg-tm's
goals and ensuring that the Project Gutenberg-tm collection will
remain freely available for generations to come. In 2001, the Project
Gutenberg Literary Archive Foundation was created to provide a secure
and permanent future for Project Gutenberg-tm and future generations.
To learn more about the Project Gutenberg Literary Archive Foundation
and how your efforts and donations can help, see Sections 3 and 4
and the Foundation web page at http://www.pglaf.org.
Section 3. Information about the Project Gutenberg Literary Archive
Foundation
The Project Gutenberg Literary Archive Foundation is a non profit
501(c)(3) educational corporation organized under the laws of the
state of Mississippi and granted tax exempt status by the Internal
Revenue Service. The Foundation's EIN or federal tax identification
number is 64-6221541. Its 501(c)(3) letter is posted at
http://pglaf.org/fundraising. Contributions to the Project Gutenberg
Literary Archive Foundation are tax deductible to the full extent
permitted by U.S. federal laws and your state's laws.
The Foundation's principal office is located at 4557 Melan Dr. S.
Fairbanks, AK, 99712., but its volunteers and employees are scattered
throughout numerous locations. Its business office is located at
809 North 1500 West, Salt Lake City, UT 84116, (801) 596-1887, email
business@pglaf.org. Email contact links and up to date contact
information can be found at the Foundation's web site and official
page at http://pglaf.org
For additional contact information:
Dr. Gregory B. Newby
Chief Executive and Director
gbnewby@pglaf.org
Section 4. Information about Donations to the Project Gutenberg
Literary Archive Foundation
Project Gutenberg-tm depends upon and cannot survive without wide
spread public support and donations to carry out its mission of
increasing the number of public domain and licensed works that can be
freely distributed in machine readable form accessible by the widest
array of equipment including outdated equipment. Many small donations
($1 to $5,000) are particularly important to maintaining tax exempt
status with the IRS.
The Foundation is committed to complying with the laws regulating
charities and charitable donations in all 50 states of the United
States. Compliance requirements are not uniform and it takes a
considerable effort, much paperwork and many fees to meet and keep up
with these requirements. We do not solicit donations in locations
where we have not received written confirmation of compliance. To
SEND DONATIONS or determine the status of compliance for any
particular state visit http://pglaf.org
While we cannot and do not solicit contributions from states where we
have not met the solicitation requirements, we know of no prohibition
against accepting unsolicited donations from donors in such states who
approach us with offers to donate.
International donations are gratefully accepted, but we cannot make
any statements concerning tax treatment of donations received from
outside the United States. U.S. laws alone swamp our small staff.
Please check the Project Gutenberg Web pages for current donation
methods and addresses. Donations are accepted in a number of other
ways including checks, online payments and credit card donations.
To donate, please visit: http://pglaf.org/donate
Section 5. General Information About Project Gutenberg-tm electronic
works.
Professor Michael S. Hart is the originator of the Project Gutenberg-tm
concept of a library of electronic works that could be freely shared
with anyone. For thirty years, he produced and distributed Project
Gutenberg-tm eBooks with only a loose network of volunteer support.
Project Gutenberg-tm eBooks are often created from several printed
editions, all of which are confirmed as Public Domain in the U.S.
unless a copyright notice is included. Thus, we do not necessarily
keep eBooks in compliance with any particular paper edition.
Most people start at our Web site which has the main PG search facility:
http://www.gutenberg.org
This Web site includes information about Project Gutenberg-tm,
including how to make donations to the Project Gutenberg Literary
Archive Foundation, how to help produce our new eBooks, and how to
subscribe to our email newsletter to hear about new eBooks.

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,15 @@
title: $:/plugins/tiddlywiki/externaltasksdemo/EditorToolbar/SuggestTags
tags: $:/tags/EditorToolbar
icon: $:/core/images/tag-button
caption: Suggest Tags
description: Invoke external programme to suggest tags for this tiddler
condition: [<targetTiddler>!has[type]] [<targetTiddler>type[text/vnd.tiddlywiki]]
button-classes: tc-text-editor-toolbar-item-start-group
shortcuts: ((suggest-tags))
dropdown: $:/plugins/tiddlywiki/externaltasksdemo/EditorToolbar/SuggestTagsDropdown
<$set name="inputFilter" filter="[<targetTiddler>]">
<$action-sendmessage $message="tm-execute-job" 1="--pipe" 2="badtagger" 3=<<inputFilter>> 4="PipeOutput" statusTitle="JobStatus"/>
</$set>
Suggest Tags - <$text text=<<targetTiddler>>/>

View File

@@ -0,0 +1,7 @@
title: $:/plugins/tiddlywiki/externaltasksdemo/EditorToolbar/SuggestTagsDropdown
<$button message="tm-server-refresh">Refresh</$button>
Status: {{JobStatus}} {{JobStatus!!message}}
Results: {{PipeOutput}}

View File

@@ -0,0 +1,6 @@
title: Sample Text
Aliquo déditum habet huius, non tempora. Affectus captet declarant retinere támque. Desiderabile dolor posuit státim uterque.
Arbitraretur civium epicureum extremo, gerendarum málá pacuvii. Accumsan alteram amaret conclusionémqué definitiones événiunt firmám homo noctesque quibus refert triá utens. Chóró egestas fugiamus fuissent, impénsa littéras magna ménté quia scientiam sensibus tibi. Bonas eas fieri i, lacinia legantur oratione urbes.

View File

@@ -0,0 +1,3 @@
title: $:/DefaultTiddlers
HelloThere

View File

@@ -0,0 +1,54 @@
title: HelloThere
! External Pipe Demos
Note that the browser polls the server every {{$:/config/SyncPollingInterval}}ms. You can trigger an instaneous poll: <$button message="tm-server-refresh">Refresh</$button>
Status: {{JobStatus}} {{JobStatus!!message}}
!! Reverser
This demo requires the example task `reverser.js 8081` to be running in a separate command window. You can edit the [[Sample Text]].
<$button>
<$action-sendmessage $message="tm-execute-job" 1="--pipe" 2="reverser" 3="[[Sample Text]]" 4="PipeOutput" statusTitle="JobStatus"/>
Reverser
</$button>
!! Recaser
This demo requires the example task `./recaser.js 8081` or `./recase_erl.sh` to be running in a separate command window. You can edit the [[Sample Text]].
<$button>
<$action-sendmessage $message="tm-execute-job" 1="--pipe" 2="recaser" 3="[[Sample Text]]" 4="PipeOutput" statusTitle="JobStatus"/>
Recaser
</$button>
!! Tagger
This demo requires the example task `./badtagger.js 8081` to be running in a separate command window. You can edit the [[Sample Text]].
<$button>
<$action-sendmessage $message="tm-execute-job" 1="--pipe" 2="badtagger" 3="[[Sample Text]]" 4="PipeOutput" statusTitle="JobStatus"/>
Tagger
</$button>
!! Mimic
<$button>
<$action-sendmessage $message="tm-execute-job" 1="--pipe" 2="mimic" 3="[[Alice in Wonderland]]" 4="PipeOutput" 5="5" 6="5000" statusTitle="JobStatus"/>
Mimic
</$button>
!! Stats
<$button>
<$action-sendmessage $message="tm-execute-job" 1="--pipe" 2="stats" 3="[[Alice in Wonderland]]" 4="PipeOutput" statusTitle="JobStatus"/>
Stats
</$button>
!! Demo Output
The output generated by the demos appears here:
{{PipeOutput}}

View File

@@ -0,0 +1,2 @@
title: $:/config/SyncPollingInterval
text: 5000

View File

@@ -0,0 +1,119 @@
{
"description": "Edition demonstrating external pipes",
"plugins": [
"tiddlywiki/tiddlyweb"
],
"themes": [
"tiddlywiki/vanilla",
"tiddlywiki/snowwhite"
],
"build": {
"index": [
"--rendertiddler","$:/core/save/all","index.html","text/plain"]
},
"config": {
"allow-remote-commands": true
},
"external-pipes": {
"reverser": {
"type": "socket",
"host": "127.0.0.1",
"port": 8081,
"input": {
"format": "rendered-text"
},
"output": {
"format": "text",
"tiddler": {
"title": "PipeOutput",
"type": "text/plain"
}
},
"environment": {
"MY_VARIABLE": "value"
},
"timeout": 100
},
"stats": {
"type": "task",
"path": "./demo-tasks/stats.js",
"input": {
"format": "json-raw-tiddlers"
},
"output": {
"format": "json-raw-tiddlers"
},
"error": {
"format": "text",
"tiddler": {
"title": "PipeOutput",
"type": "text/plain",
"result": "error"
}
},
"environment": {
"MY_VARIABLE": "value"
},
"timeout": 100
},
"mimic": {
"type": "task",
"path": "./demo-tasks/mimic.js",
"arguments": ["ngram-length"],
"input": {
"format": "rendered-text"
},
"output": {
"format": "text",
"tiddler": {
"title": "PipeOutput",
"type": "text/plain"
}
},
"environment": {
"MY_VARIABLE": "value"
},
"timeout": 100
},
"recaser": {
"type": "socket-erlang",
"host": "127.0.0.1",
"port": 8081,
"encoding": "latin1",
"input": {
"format": "rendered-text"
},
"output": {
"format": "text",
"tiddler": {
"title": "PipeOutput",
"type": "text/plain"
}
},
"environment": {
"MY_VARIABLE": "value"
},
"timeout": 100
},
"badtagger": {
"type": "socket-erlang",
"host": "127.0.0.1",
"port": 8081,
"encoding": "latin1",
"input": {
"format": "rendered-text"
},
"output": {
"format": "text",
"tiddler": {
"title": "PipeOutput",
"type": "text/plain"
}
},
"environment": {
"MY_VARIABLE": "value"
},
"timeout": 100
}
}
}

View File

@@ -0,0 +1,24 @@
caption: tm-execute-job
created: 20181017140932589
modified: 20181017171440568
tags: Messages
title: WidgetMessage: tm-execute-job
type: text/vnd.tiddlywiki
<<.from-version "5.1.18">> The "execute job" message triggers the execution of [[remote commands|Using remote commands]]. It uses the message parameters as follows:
|!Name |!Description |
|$param |Not used |
|commands |Command string to be executed |
|0...n |Command tokens to be executed |
|statusTitle |Optional title of tiddler in which to store status updates as the commands are executed |
Note that the command string to be executed can either be passed as a single string, or as a sequence of tokens:
* A single string:
*> `<$action-sendmessage $message="tm-execute-job" commands="--version"/>`
* Separate command tokens with numeric indices:
*> `<$action-sendmessage $message="tm-execute-job" 0="--version" 1="--version"/>`
** Note that the numeric indices must be non-negative integers with no leading zeros
The "execute job" message is handled by the TiddlyWiki core SyncMechanism which invokes the current [[SyncAdaptorModule|SyncAdaptorModules]] (typically the ''tiddlywiki/tiddlywebadaptor'' plugin).

View File

@@ -0,0 +1,360 @@
title: Alice in Wonderland License
tags: text/plain
End of Project Gutenberg's Alice's Adventures in Wonderland, by Lewis Carroll
*** END OF THIS PROJECT GUTENBERG EBOOK ALICE'S ADVENTURES IN WONDERLAND ***
***** This file should be named 11.txt or 11.zip *****
This and all associated files of various formats will be found in:
http://www.gutenberg.org/1/11/
Updated editions will replace the previous one--the old editions
will be renamed.
Creating the works from public domain print editions means that no
one owns a United States copyright in these works, so the Foundation
(and you!) can copy and distribute it in the United States without
permission and without paying copyright royalties. Special rules,
set forth in the General Terms of Use part of this license, apply to
copying and distributing Project Gutenberg-tm electronic works to
protect the PROJECT GUTENBERG-tm concept and trademark. Project
Gutenberg is a registered trademark, and may not be used if you
charge for the eBooks, unless you receive specific permission. If you
do not charge anything for copies of this eBook, complying with the
rules is very easy. You may use this eBook for nearly any purpose
such as creation of derivative works, reports, performances and
research. They may be modified and printed and given away--you may do
practically ANYTHING with public domain eBooks. Redistribution is
subject to the trademark license, especially commercial
redistribution.
*** START: FULL LICENSE ***
THE FULL PROJECT GUTENBERG LICENSE
PLEASE READ THIS BEFORE YOU DISTRIBUTE OR USE THIS WORK
To protect the Project Gutenberg-tm mission of promoting the free
distribution of electronic works, by using or distributing this work
(or any other work associated in any way with the phrase "Project
Gutenberg"), you agree to comply with all the terms of the Full Project
Gutenberg-tm License (available with this file or online at
http://gutenberg.org/license).
Section 1. General Terms of Use and Redistributing Project Gutenberg-tm
electronic works
1.A. By reading or using any part of this Project Gutenberg-tm
electronic work, you indicate that you have read, understand, agree to
and accept all the terms of this license and intellectual property
(trademark/copyright) agreement. If you do not agree to abide by all
the terms of this agreement, you must cease using and return or destroy
all copies of Project Gutenberg-tm electronic works in your possession.
If you paid a fee for obtaining a copy of or access to a Project
Gutenberg-tm electronic work and you do not agree to be bound by the
terms of this agreement, you may obtain a refund from the person or
entity to whom you paid the fee as set forth in paragraph 1.E.8.
1.B. "Project Gutenberg" is a registered trademark. It may only be
used on or associated in any way with an electronic work by people who
agree to be bound by the terms of this agreement. There are a few
things that you can do with most Project Gutenberg-tm electronic works
even without complying with the full terms of this agreement. See
paragraph 1.C below. There are a lot of things you can do with Project
Gutenberg-tm electronic works if you follow the terms of this agreement
and help preserve free future access to Project Gutenberg-tm electronic
works. See paragraph 1.E below.
1.C. The Project Gutenberg Literary Archive Foundation ("the Foundation"
or PGLAF), owns a compilation copyright in the collection of Project
Gutenberg-tm electronic works. Nearly all the individual works in the
collection are in the public domain in the United States. If an
individual work is in the public domain in the United States and you are
located in the United States, we do not claim a right to prevent you from
copying, distributing, performing, displaying or creating derivative
works based on the work as long as all references to Project Gutenberg
are removed. Of course, we hope that you will support the Project
Gutenberg-tm mission of promoting free access to electronic works by
freely sharing Project Gutenberg-tm works in compliance with the terms of
this agreement for keeping the Project Gutenberg-tm name associated with
the work. You can easily comply with the terms of this agreement by
keeping this work in the same format with its attached full Project
Gutenberg-tm License when you share it without charge with others.
1.D. The copyright laws of the place where you are located also govern
what you can do with this work. Copyright laws in most countries are in
a constant state of change. If you are outside the United States, check
the laws of your country in addition to the terms of this agreement
before downloading, copying, displaying, performing, distributing or
creating derivative works based on this work or any other Project
Gutenberg-tm work. The Foundation makes no representations concerning
the copyright status of any work in any country outside the United
States.
1.E. Unless you have removed all references to Project Gutenberg:
1.E.1. The following sentence, with active links to, or other immediate
access to, the full Project Gutenberg-tm License must appear prominently
whenever any copy of a Project Gutenberg-tm work (any work on which the
phrase "Project Gutenberg" appears, or with which the phrase "Project
Gutenberg" is associated) is accessed, displayed, performed, viewed,
copied or distributed:
This eBook is for the use of anyone anywhere at no cost and with
almost no restrictions whatsoever. You may copy it, give it away or
re-use it under the terms of the Project Gutenberg License included
with this eBook or online at www.gutenberg.org
1.E.2. If an individual Project Gutenberg-tm electronic work is derived
from the public domain (does not contain a notice indicating that it is
posted with permission of the copyright holder), the work can be copied
and distributed to anyone in the United States without paying any fees
or charges. If you are redistributing or providing access to a work
with the phrase "Project Gutenberg" associated with or appearing on the
work, you must comply either with the requirements of paragraphs 1.E.1
through 1.E.7 or obtain permission for the use of the work and the
Project Gutenberg-tm trademark as set forth in paragraphs 1.E.8 or
1.E.9.
1.E.3. If an individual Project Gutenberg-tm electronic work is posted
with the permission of the copyright holder, your use and distribution
must comply with both paragraphs 1.E.1 through 1.E.7 and any additional
terms imposed by the copyright holder. Additional terms will be linked
to the Project Gutenberg-tm License for all works posted with the
permission of the copyright holder found at the beginning of this work.
1.E.4. Do not unlink or detach or remove the full Project Gutenberg-tm
License terms from this work, or any files containing a part of this
work or any other work associated with Project Gutenberg-tm.
1.E.5. Do not copy, display, perform, distribute or redistribute this
electronic work, or any part of this electronic work, without
prominently displaying the sentence set forth in paragraph 1.E.1 with
active links or immediate access to the full terms of the Project
Gutenberg-tm License.
1.E.6. You may convert to and distribute this work in any binary,
compressed, marked up, nonproprietary or proprietary form, including any
word processing or hypertext form. However, if you provide access to or
distribute copies of a Project Gutenberg-tm work in a format other than
"Plain Vanilla ASCII" or other format used in the official version
posted on the official Project Gutenberg-tm web site (www.gutenberg.org),
you must, at no additional cost, fee or expense to the user, provide a
copy, a means of exporting a copy, or a means of obtaining a copy upon
request, of the work in its original "Plain Vanilla ASCII" or other
form. Any alternate format must include the full Project Gutenberg-tm
License as specified in paragraph 1.E.1.
1.E.7. Do not charge a fee for access to, viewing, displaying,
performing, copying or distributing any Project Gutenberg-tm works
unless you comply with paragraph 1.E.8 or 1.E.9.
1.E.8. You may charge a reasonable fee for copies of or providing
access to or distributing Project Gutenberg-tm electronic works provided
that
- You pay a royalty fee of 20% of the gross profits you derive from
the use of Project Gutenberg-tm works calculated using the method
you already use to calculate your applicable taxes. The fee is
owed to the owner of the Project Gutenberg-tm trademark, but he
has agreed to donate royalties under this paragraph to the
Project Gutenberg Literary Archive Foundation. Royalty payments
must be paid within 60 days following each date on which you
prepare (or are legally required to prepare) your periodic tax
returns. Royalty payments should be clearly marked as such and
sent to the Project Gutenberg Literary Archive Foundation at the
address specified in Section 4, "Information about donations to
the Project Gutenberg Literary Archive Foundation."
- You provide a full refund of any money paid by a user who notifies
you in writing (or by e-mail) within 30 days of receipt that s/he
does not agree to the terms of the full Project Gutenberg-tm
License. You must require such a user to return or
destroy all copies of the works possessed in a physical medium
and discontinue all use of and all access to other copies of
Project Gutenberg-tm works.
- You provide, in accordance with paragraph 1.F.3, a full refund of any
money paid for a work or a replacement copy, if a defect in the
electronic work is discovered and reported to you within 90 days
of receipt of the work.
- You comply with all other terms of this agreement for free
distribution of Project Gutenberg-tm works.
1.E.9. If you wish to charge a fee or distribute a Project Gutenberg-tm
electronic work or group of works on different terms than are set
forth in this agreement, you must obtain permission in writing from
both the Project Gutenberg Literary Archive Foundation and Michael
Hart, the owner of the Project Gutenberg-tm trademark. Contact the
Foundation as set forth in Section 3 below.
1.F.
1.F.1. Project Gutenberg volunteers and employees expend considerable
effort to identify, do copyright research on, transcribe and proofread
public domain works in creating the Project Gutenberg-tm
collection. Despite these efforts, Project Gutenberg-tm electronic
works, and the medium on which they may be stored, may contain
"Defects," such as, but not limited to, incomplete, inaccurate or
corrupt data, transcription errors, a copyright or other intellectual
property infringement, a defective or damaged disk or other medium, a
computer virus, or computer codes that damage or cannot be read by
your equipment.
1.F.2. LIMITED WARRANTY, DISCLAIMER OF DAMAGES - Except for the "Right
of Replacement or Refund" described in paragraph 1.F.3, the Project
Gutenberg Literary Archive Foundation, the owner of the Project
Gutenberg-tm trademark, and any other party distributing a Project
Gutenberg-tm electronic work under this agreement, disclaim all
liability to you for damages, costs and expenses, including legal
fees. YOU AGREE THAT YOU HAVE NO REMEDIES FOR NEGLIGENCE, STRICT
LIABILITY, BREACH OF WARRANTY OR BREACH OF CONTRACT EXCEPT THOSE
PROVIDED IN PARAGRAPH F3. YOU AGREE THAT THE FOUNDATION, THE
TRADEMARK OWNER, AND ANY DISTRIBUTOR UNDER THIS AGREEMENT WILL NOT BE
LIABLE TO YOU FOR ACTUAL, DIRECT, INDIRECT, CONSEQUENTIAL, PUNITIVE OR
INCIDENTAL DAMAGES EVEN IF YOU GIVE NOTICE OF THE POSSIBILITY OF SUCH
DAMAGE.
1.F.3. LIMITED RIGHT OF REPLACEMENT OR REFUND - If you discover a
defect in this electronic work within 90 days of receiving it, you can
receive a refund of the money (if any) you paid for it by sending a
written explanation to the person you received the work from. If you
received the work on a physical medium, you must return the medium with
your written explanation. The person or entity that provided you with
the defective work may elect to provide a replacement copy in lieu of a
refund. If you received the work electronically, the person or entity
providing it to you may choose to give you a second opportunity to
receive the work electronically in lieu of a refund. If the second copy
is also defective, you may demand a refund in writing without further
opportunities to fix the problem.
1.F.4. Except for the limited right of replacement or refund set forth
in paragraph 1.F.3, this work is provided to you 'AS-IS' WITH NO OTHER
WARRANTIES OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
WARRANTIES OF MERCHANTIBILITY OR FITNESS FOR ANY PURPOSE.
1.F.5. Some states do not allow disclaimers of certain implied
warranties or the exclusion or limitation of certain types of damages.
If any disclaimer or limitation set forth in this agreement violates the
law of the state applicable to this agreement, the agreement shall be
interpreted to make the maximum disclaimer or limitation permitted by
the applicable state law. The invalidity or unenforceability of any
provision of this agreement shall not void the remaining provisions.
1.F.6. INDEMNITY - You agree to indemnify and hold the Foundation, the
trademark owner, any agent or employee of the Foundation, anyone
providing copies of Project Gutenberg-tm electronic works in accordance
with this agreement, and any volunteers associated with the production,
promotion and distribution of Project Gutenberg-tm electronic works,
harmless from all liability, costs and expenses, including legal fees,
that arise directly or indirectly from any of the following which you do
or cause to occur: (a) distribution of this or any Project Gutenberg-tm
work, (b) alteration, modification, or additions or deletions to any
Project Gutenberg-tm work, and (c) any Defect you cause.
Section 2. Information about the Mission of Project Gutenberg-tm
Project Gutenberg-tm is synonymous with the free distribution of
electronic works in formats readable by the widest variety of computers
including obsolete, old, middle-aged and new computers. It exists
because of the efforts of hundreds of volunteers and donations from
people in all walks of life.
Volunteers and financial support to provide volunteers with the
assistance they need, is critical to reaching Project Gutenberg-tm's
goals and ensuring that the Project Gutenberg-tm collection will
remain freely available for generations to come. In 2001, the Project
Gutenberg Literary Archive Foundation was created to provide a secure
and permanent future for Project Gutenberg-tm and future generations.
To learn more about the Project Gutenberg Literary Archive Foundation
and how your efforts and donations can help, see Sections 3 and 4
and the Foundation web page at http://www.pglaf.org.
Section 3. Information about the Project Gutenberg Literary Archive
Foundation
The Project Gutenberg Literary Archive Foundation is a non profit
501(c)(3) educational corporation organized under the laws of the
state of Mississippi and granted tax exempt status by the Internal
Revenue Service. The Foundation's EIN or federal tax identification
number is 64-6221541. Its 501(c)(3) letter is posted at
http://pglaf.org/fundraising. Contributions to the Project Gutenberg
Literary Archive Foundation are tax deductible to the full extent
permitted by U.S. federal laws and your state's laws.
The Foundation's principal office is located at 4557 Melan Dr. S.
Fairbanks, AK, 99712., but its volunteers and employees are scattered
throughout numerous locations. Its business office is located at
809 North 1500 West, Salt Lake City, UT 84116, (801) 596-1887, email
business@pglaf.org. Email contact links and up to date contact
information can be found at the Foundation's web site and official
page at http://pglaf.org
For additional contact information:
Dr. Gregory B. Newby
Chief Executive and Director
gbnewby@pglaf.org
Section 4. Information about Donations to the Project Gutenberg
Literary Archive Foundation
Project Gutenberg-tm depends upon and cannot survive without wide
spread public support and donations to carry out its mission of
increasing the number of public domain and licensed works that can be
freely distributed in machine readable form accessible by the widest
array of equipment including outdated equipment. Many small donations
($1 to $5,000) are particularly important to maintaining tax exempt
status with the IRS.
The Foundation is committed to complying with the laws regulating
charities and charitable donations in all 50 states of the United
States. Compliance requirements are not uniform and it takes a
considerable effort, much paperwork and many fees to meet and keep up
with these requirements. We do not solicit donations in locations
where we have not received written confirmation of compliance. To
SEND DONATIONS or determine the status of compliance for any
particular state visit http://pglaf.org
While we cannot and do not solicit contributions from states where we
have not met the solicitation requirements, we know of no prohibition
against accepting unsolicited donations from donors in such states who
approach us with offers to donate.
International donations are gratefully accepted, but we cannot make
any statements concerning tax treatment of donations received from
outside the United States. U.S. laws alone swamp our small staff.
Please check the Project Gutenberg Web pages for current donation
methods and addresses. Donations are accepted in a number of other
ways including checks, online payments and credit card donations.
To donate, please visit: http://pglaf.org/donate
Section 5. General Information About Project Gutenberg-tm electronic
works.
Professor Michael S. Hart is the originator of the Project Gutenberg-tm
concept of a library of electronic works that could be freely shared
with anyone. For thirty years, he produced and distributed Project
Gutenberg-tm eBooks with only a loose network of volunteer support.
Project Gutenberg-tm eBooks are often created from several printed
editions, all of which are confirmed as Public Domain in the U.S.
unless a copyright notice is included. Thus, we do not necessarily
keep eBooks in compliance with any particular paper edition.
Most people start at our Web site which has the main PG search facility:
http://www.gutenberg.org
This Web site includes information about Project Gutenberg-tm,
including how to make donations to the Project Gutenberg Literary
Archive Foundation, how to help produce our new eBooks, and how to
subscribe to our email newsletter to hear about new eBooks.

View File

@@ -1,15 +1,14 @@
title: Alice in Wonderland
tags: external-text
license: Alice in Wonderland License
//Included here as a demonstration of ExternalText text support. See the bottom for the license from Project Gutenberg//
---
# ALICE'S ADVENTURES IN WONDERLAND
! ALICE'S ADVENTURES IN WONDERLAND
## Lewis Carroll
THE MILLENNIUM FULCRUM EDITION 3.0
!! Lewis Carroll
!!! CHAPTER I. Down the Rabbit-Hole
@@ -3341,369 +3340,3 @@ all their simple sorrows, and find a pleasure in all their simple joys,
remembering her own child-life, and the happy summer days.
THE END
End of Project Gutenberg's Alice's Adventures in Wonderland, by Lewis Carroll
*** END OF THIS PROJECT GUTENBERG EBOOK ALICE'S ADVENTURES IN WONDERLAND ***
***** This file should be named 11.txt or 11.zip *****
This and all associated files of various formats will be found in:
http://www.gutenberg.org/1/11/
Updated editions will replace the previous one--the old editions
will be renamed.
Creating the works from public domain print editions means that no
one owns a United States copyright in these works, so the Foundation
(and you!) can copy and distribute it in the United States without
permission and without paying copyright royalties. Special rules,
set forth in the General Terms of Use part of this license, apply to
copying and distributing Project Gutenberg-tm electronic works to
protect the PROJECT GUTENBERG-tm concept and trademark. Project
Gutenberg is a registered trademark, and may not be used if you
charge for the eBooks, unless you receive specific permission. If you
do not charge anything for copies of this eBook, complying with the
rules is very easy. You may use this eBook for nearly any purpose
such as creation of derivative works, reports, performances and
research. They may be modified and printed and given away--you may do
practically ANYTHING with public domain eBooks. Redistribution is
subject to the trademark license, especially commercial
redistribution.
*** START: FULL LICENSE ***
THE FULL PROJECT GUTENBERG LICENSE
PLEASE READ THIS BEFORE YOU DISTRIBUTE OR USE THIS WORK
To protect the Project Gutenberg-tm mission of promoting the free
distribution of electronic works, by using or distributing this work
(or any other work associated in any way with the phrase "Project
Gutenberg"), you agree to comply with all the terms of the Full Project
Gutenberg-tm License (available with this file or online at
http://gutenberg.org/license).
Section 1. General Terms of Use and Redistributing Project Gutenberg-tm
electronic works
1.A. By reading or using any part of this Project Gutenberg-tm
electronic work, you indicate that you have read, understand, agree to
and accept all the terms of this license and intellectual property
(trademark/copyright) agreement. If you do not agree to abide by all
the terms of this agreement, you must cease using and return or destroy
all copies of Project Gutenberg-tm electronic works in your possession.
If you paid a fee for obtaining a copy of or access to a Project
Gutenberg-tm electronic work and you do not agree to be bound by the
terms of this agreement, you may obtain a refund from the person or
entity to whom you paid the fee as set forth in paragraph 1.E.8.
1.B. "Project Gutenberg" is a registered trademark. It may only be
used on or associated in any way with an electronic work by people who
agree to be bound by the terms of this agreement. There are a few
things that you can do with most Project Gutenberg-tm electronic works
even without complying with the full terms of this agreement. See
paragraph 1.C below. There are a lot of things you can do with Project
Gutenberg-tm electronic works if you follow the terms of this agreement
and help preserve free future access to Project Gutenberg-tm electronic
works. See paragraph 1.E below.
1.C. The Project Gutenberg Literary Archive Foundation ("the Foundation"
or PGLAF), owns a compilation copyright in the collection of Project
Gutenberg-tm electronic works. Nearly all the individual works in the
collection are in the public domain in the United States. If an
individual work is in the public domain in the United States and you are
located in the United States, we do not claim a right to prevent you from
copying, distributing, performing, displaying or creating derivative
works based on the work as long as all references to Project Gutenberg
are removed. Of course, we hope that you will support the Project
Gutenberg-tm mission of promoting free access to electronic works by
freely sharing Project Gutenberg-tm works in compliance with the terms of
this agreement for keeping the Project Gutenberg-tm name associated with
the work. You can easily comply with the terms of this agreement by
keeping this work in the same format with its attached full Project
Gutenberg-tm License when you share it without charge with others.
1.D. The copyright laws of the place where you are located also govern
what you can do with this work. Copyright laws in most countries are in
a constant state of change. If you are outside the United States, check
the laws of your country in addition to the terms of this agreement
before downloading, copying, displaying, performing, distributing or
creating derivative works based on this work or any other Project
Gutenberg-tm work. The Foundation makes no representations concerning
the copyright status of any work in any country outside the United
States.
1.E. Unless you have removed all references to Project Gutenberg:
1.E.1. The following sentence, with active links to, or other immediate
access to, the full Project Gutenberg-tm License must appear prominently
whenever any copy of a Project Gutenberg-tm work (any work on which the
phrase "Project Gutenberg" appears, or with which the phrase "Project
Gutenberg" is associated) is accessed, displayed, performed, viewed,
copied or distributed:
This eBook is for the use of anyone anywhere at no cost and with
almost no restrictions whatsoever. You may copy it, give it away or
re-use it under the terms of the Project Gutenberg License included
with this eBook or online at www.gutenberg.org
1.E.2. If an individual Project Gutenberg-tm electronic work is derived
from the public domain (does not contain a notice indicating that it is
posted with permission of the copyright holder), the work can be copied
and distributed to anyone in the United States without paying any fees
or charges. If you are redistributing or providing access to a work
with the phrase "Project Gutenberg" associated with or appearing on the
work, you must comply either with the requirements of paragraphs 1.E.1
through 1.E.7 or obtain permission for the use of the work and the
Project Gutenberg-tm trademark as set forth in paragraphs 1.E.8 or
1.E.9.
1.E.3. If an individual Project Gutenberg-tm electronic work is posted
with the permission of the copyright holder, your use and distribution
must comply with both paragraphs 1.E.1 through 1.E.7 and any additional
terms imposed by the copyright holder. Additional terms will be linked
to the Project Gutenberg-tm License for all works posted with the
permission of the copyright holder found at the beginning of this work.
1.E.4. Do not unlink or detach or remove the full Project Gutenberg-tm
License terms from this work, or any files containing a part of this
work or any other work associated with Project Gutenberg-tm.
1.E.5. Do not copy, display, perform, distribute or redistribute this
electronic work, or any part of this electronic work, without
prominently displaying the sentence set forth in paragraph 1.E.1 with
active links or immediate access to the full terms of the Project
Gutenberg-tm License.
1.E.6. You may convert to and distribute this work in any binary,
compressed, marked up, nonproprietary or proprietary form, including any
word processing or hypertext form. However, if you provide access to or
distribute copies of a Project Gutenberg-tm work in a format other than
"Plain Vanilla ASCII" or other format used in the official version
posted on the official Project Gutenberg-tm web site (www.gutenberg.org),
you must, at no additional cost, fee or expense to the user, provide a
copy, a means of exporting a copy, or a means of obtaining a copy upon
request, of the work in its original "Plain Vanilla ASCII" or other
form. Any alternate format must include the full Project Gutenberg-tm
License as specified in paragraph 1.E.1.
1.E.7. Do not charge a fee for access to, viewing, displaying,
performing, copying or distributing any Project Gutenberg-tm works
unless you comply with paragraph 1.E.8 or 1.E.9.
1.E.8. You may charge a reasonable fee for copies of or providing
access to or distributing Project Gutenberg-tm electronic works provided
that
- You pay a royalty fee of 20% of the gross profits you derive from
the use of Project Gutenberg-tm works calculated using the method
you already use to calculate your applicable taxes. The fee is
owed to the owner of the Project Gutenberg-tm trademark, but he
has agreed to donate royalties under this paragraph to the
Project Gutenberg Literary Archive Foundation. Royalty payments
must be paid within 60 days following each date on which you
prepare (or are legally required to prepare) your periodic tax
returns. Royalty payments should be clearly marked as such and
sent to the Project Gutenberg Literary Archive Foundation at the
address specified in Section 4, "Information about donations to
the Project Gutenberg Literary Archive Foundation."
- You provide a full refund of any money paid by a user who notifies
you in writing (or by e-mail) within 30 days of receipt that s/he
does not agree to the terms of the full Project Gutenberg-tm
License. You must require such a user to return or
destroy all copies of the works possessed in a physical medium
and discontinue all use of and all access to other copies of
Project Gutenberg-tm works.
- You provide, in accordance with paragraph 1.F.3, a full refund of any
money paid for a work or a replacement copy, if a defect in the
electronic work is discovered and reported to you within 90 days
of receipt of the work.
- You comply with all other terms of this agreement for free
distribution of Project Gutenberg-tm works.
1.E.9. If you wish to charge a fee or distribute a Project Gutenberg-tm
electronic work or group of works on different terms than are set
forth in this agreement, you must obtain permission in writing from
both the Project Gutenberg Literary Archive Foundation and Michael
Hart, the owner of the Project Gutenberg-tm trademark. Contact the
Foundation as set forth in Section 3 below.
1.F.
1.F.1. Project Gutenberg volunteers and employees expend considerable
effort to identify, do copyright research on, transcribe and proofread
public domain works in creating the Project Gutenberg-tm
collection. Despite these efforts, Project Gutenberg-tm electronic
works, and the medium on which they may be stored, may contain
"Defects," such as, but not limited to, incomplete, inaccurate or
corrupt data, transcription errors, a copyright or other intellectual
property infringement, a defective or damaged disk or other medium, a
computer virus, or computer codes that damage or cannot be read by
your equipment.
1.F.2. LIMITED WARRANTY, DISCLAIMER OF DAMAGES - Except for the "Right
of Replacement or Refund" described in paragraph 1.F.3, the Project
Gutenberg Literary Archive Foundation, the owner of the Project
Gutenberg-tm trademark, and any other party distributing a Project
Gutenberg-tm electronic work under this agreement, disclaim all
liability to you for damages, costs and expenses, including legal
fees. YOU AGREE THAT YOU HAVE NO REMEDIES FOR NEGLIGENCE, STRICT
LIABILITY, BREACH OF WARRANTY OR BREACH OF CONTRACT EXCEPT THOSE
PROVIDED IN PARAGRAPH F3. YOU AGREE THAT THE FOUNDATION, THE
TRADEMARK OWNER, AND ANY DISTRIBUTOR UNDER THIS AGREEMENT WILL NOT BE
LIABLE TO YOU FOR ACTUAL, DIRECT, INDIRECT, CONSEQUENTIAL, PUNITIVE OR
INCIDENTAL DAMAGES EVEN IF YOU GIVE NOTICE OF THE POSSIBILITY OF SUCH
DAMAGE.
1.F.3. LIMITED RIGHT OF REPLACEMENT OR REFUND - If you discover a
defect in this electronic work within 90 days of receiving it, you can
receive a refund of the money (if any) you paid for it by sending a
written explanation to the person you received the work from. If you
received the work on a physical medium, you must return the medium with
your written explanation. The person or entity that provided you with
the defective work may elect to provide a replacement copy in lieu of a
refund. If you received the work electronically, the person or entity
providing it to you may choose to give you a second opportunity to
receive the work electronically in lieu of a refund. If the second copy
is also defective, you may demand a refund in writing without further
opportunities to fix the problem.
1.F.4. Except for the limited right of replacement or refund set forth
in paragraph 1.F.3, this work is provided to you 'AS-IS' WITH NO OTHER
WARRANTIES OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
WARRANTIES OF MERCHANTIBILITY OR FITNESS FOR ANY PURPOSE.
1.F.5. Some states do not allow disclaimers of certain implied
warranties or the exclusion or limitation of certain types of damages.
If any disclaimer or limitation set forth in this agreement violates the
law of the state applicable to this agreement, the agreement shall be
interpreted to make the maximum disclaimer or limitation permitted by
the applicable state law. The invalidity or unenforceability of any
provision of this agreement shall not void the remaining provisions.
1.F.6. INDEMNITY - You agree to indemnify and hold the Foundation, the
trademark owner, any agent or employee of the Foundation, anyone
providing copies of Project Gutenberg-tm electronic works in accordance
with this agreement, and any volunteers associated with the production,
promotion and distribution of Project Gutenberg-tm electronic works,
harmless from all liability, costs and expenses, including legal fees,
that arise directly or indirectly from any of the following which you do
or cause to occur: (a) distribution of this or any Project Gutenberg-tm
work, (b) alteration, modification, or additions or deletions to any
Project Gutenberg-tm work, and (c) any Defect you cause.
Section 2. Information about the Mission of Project Gutenberg-tm
Project Gutenberg-tm is synonymous with the free distribution of
electronic works in formats readable by the widest variety of computers
including obsolete, old, middle-aged and new computers. It exists
because of the efforts of hundreds of volunteers and donations from
people in all walks of life.
Volunteers and financial support to provide volunteers with the
assistance they need, is critical to reaching Project Gutenberg-tm's
goals and ensuring that the Project Gutenberg-tm collection will
remain freely available for generations to come. In 2001, the Project
Gutenberg Literary Archive Foundation was created to provide a secure
and permanent future for Project Gutenberg-tm and future generations.
To learn more about the Project Gutenberg Literary Archive Foundation
and how your efforts and donations can help, see Sections 3 and 4
and the Foundation web page at http://www.pglaf.org.
Section 3. Information about the Project Gutenberg Literary Archive
Foundation
The Project Gutenberg Literary Archive Foundation is a non profit
501(c)(3) educational corporation organized under the laws of the
state of Mississippi and granted tax exempt status by the Internal
Revenue Service. The Foundation's EIN or federal tax identification
number is 64-6221541. Its 501(c)(3) letter is posted at
http://pglaf.org/fundraising. Contributions to the Project Gutenberg
Literary Archive Foundation are tax deductible to the full extent
permitted by U.S. federal laws and your state's laws.
The Foundation's principal office is located at 4557 Melan Dr. S.
Fairbanks, AK, 99712., but its volunteers and employees are scattered
throughout numerous locations. Its business office is located at
809 North 1500 West, Salt Lake City, UT 84116, (801) 596-1887, email
business@pglaf.org. Email contact links and up to date contact
information can be found at the Foundation's web site and official
page at http://pglaf.org
For additional contact information:
Dr. Gregory B. Newby
Chief Executive and Director
gbnewby@pglaf.org
Section 4. Information about Donations to the Project Gutenberg
Literary Archive Foundation
Project Gutenberg-tm depends upon and cannot survive without wide
spread public support and donations to carry out its mission of
increasing the number of public domain and licensed works that can be
freely distributed in machine readable form accessible by the widest
array of equipment including outdated equipment. Many small donations
($1 to $5,000) are particularly important to maintaining tax exempt
status with the IRS.
The Foundation is committed to complying with the laws regulating
charities and charitable donations in all 50 states of the United
States. Compliance requirements are not uniform and it takes a
considerable effort, much paperwork and many fees to meet and keep up
with these requirements. We do not solicit donations in locations
where we have not received written confirmation of compliance. To
SEND DONATIONS or determine the status of compliance for any
particular state visit http://pglaf.org
While we cannot and do not solicit contributions from states where we
have not met the solicitation requirements, we know of no prohibition
against accepting unsolicited donations from donors in such states who
approach us with offers to donate.
International donations are gratefully accepted, but we cannot make
any statements concerning tax treatment of donations received from
outside the United States. U.S. laws alone swamp our small staff.
Please check the Project Gutenberg Web pages for current donation
methods and addresses. Donations are accepted in a number of other
ways including checks, online payments and credit card donations.
To donate, please visit: http://pglaf.org/donate
Section 5. General Information About Project Gutenberg-tm electronic
works.
Professor Michael S. Hart is the originator of the Project Gutenberg-tm
concept of a library of electronic works that could be freely shared
with anyone. For thirty years, he produced and distributed Project
Gutenberg-tm eBooks with only a loose network of volunteer support.
Project Gutenberg-tm eBooks are often created from several printed
editions, all of which are confirmed as Public Domain in the U.S.
unless a copyright notice is included. Thus, we do not necessarily
keep eBooks in compliance with any particular paper edition.
Most people start at our Web site which has the main PG search facility:
http://www.gutenberg.org
This Web site includes information about Project Gutenberg-tm,
including how to make donations to the Project Gutenberg Literary
Archive Foundation, how to help produce our new eBooks, and how to
subscribe to our email newsletter to hear about new eBooks.

View File

@@ -1,5 +1,5 @@
created: 20161015114042793
modified: 20161015121622327
modified: 20181017171429110
tags: TiddlyWikiFolders
title: tiddlywiki.info Files
type: text/vnd.tiddlywiki
@@ -32,6 +32,8 @@ Configuration options include:
* ''retain-original-tiddler-path'' - If true, the server will generate a tiddler [[$:/config/OriginalTiddlerPaths]] containing the original file paths of each tiddler in the wiki
* ''allow-remote-commands'' - <<.from-version "5.1.18">> if true, [[remote commands|Using remote commands]] will be permitted for all authorized users
!!! Example
For example:

View File

@@ -0,0 +1,80 @@
created: 20181014180409461
modified: 20181017202202358
tags: [[WebServer Guides]]
title: Using remote commands
type: text/vnd.tiddlywiki
The remote commands mechanism allows browsers connected to TiddlyWiki's WebServer to initiate the execution of [[commands|Commands]] on the server.
In the browser it is initiated by the [[tm-execute-job|WidgetMessage: tm-execute-job]] message:
```
<$action-sendmessage $message="tm-execute-job" commands="--version" statusTitle="JobStatus"/>
```
On the server, it is implemented by the [[WebServer API: Post Commands]].
<<.warning """To avoid potential security risks the remote commands mechanism is disabled by default. Please carefully read the security notes below before enabling it. """>>
!! Security Considerations for Remote Commands
Enabling the remote command mechanism allows any authenticated user connecting via the [[WebServer API]] to execute arbitrary [[commands|Commands]] on the server. TiddlyWiki's built-in commands are generally unfettered: for example, they include the ability to write to any file in the file system. This risks giving an adversary complete control of the system.
The risks can be mitigated in several ways:
* Restrict listening to [[host|WebServer Parameter: host]] 127.0.0.1 so that only processes running on the same machine can connect to the server
* Require [[authentication|WebServer Authentication]]
* Enable [[HTTPS|Using HTTPS]]
!! Enabling Remote Commands
Remote command execution is enabled by setting to 'true' the property `allow-remote-commands` of the `config` section of [[tiddlywiki.info Files]]. For example:
```
"config": {
"allow-remote-commands": true
},
```
!! Using Remote Commands
Remote commands are invoked from the browser using the [[tm-execute-job|WidgetMessage: tm-execute-job]] message.
This example fetches JSON data from `http://api.open-notify.org/astros.json` and places it in a tiddler called [[http://api.open-notify.org/astros.json]].
```
<$button>
<$action-sendmessage $message="tm-execute-job" 0="--verbose" 1="--fetch" 2="raw-file" 3="http://api.open-notify.org/astros.json" statusTitle="JobStatus"/>
Fetch number of people in space
</$button>
```
!! Remote Command Tests
<$button message="tm-server-refresh">Refresh</$button>
Status: {{JobStatus}} {{JobStatus!!message}}
These tests don't produce any output.
<$button>
<$action-sendmessage $message="tm-execute-job" commands="--version" statusTitle="JobStatus"/>
Job!
</$button>
<$button>
<$action-sendmessage $message="tm-execute-job" commands="--versionitis" statusTitle="JobStatus"/>
Illegal command
</$button>
<$button>
<$action-sendmessage $message="tm-execute-job" 0="--verbose" 1="--fetch" 2="raw-file" 3="http://api.open-notify.org/astros.json" statusTitle="JobStatus"/>
Fetch number of people in space
</$button>
Output:
{{http://api.open-notify.org/astros.json}}

View File

@@ -0,0 +1,27 @@
created: 20181014175732191
modified: 20181014180331643
tags: [[WebServer API]]
title: WebServer API: Post Commands
type: text/vnd.tiddlywiki
Posts a string of command tokens for execution by the server.
Note that remote command execution is only permitted if explicitly enabled -- see [[Using remote commands]].
```
POST /commands/
```
The body should be an object in JSON format with the following properties:
* ''commands'' - an array of command token strings
* ''statusTitle'' - the title of a tiddler to receive a status string resulting from executing the commands
Parameters:
* none
Response:
* 204 No Content
* 404 Not Found

View File

@@ -159,6 +159,46 @@ TiddlyWebAdaptor.prototype.getCsrfToken = function() {
return csrf;
};
/*
*/
TiddlyWebAdaptor.prototype.executeJob = function(event,callback) {
var paramObject = event.paramObject || {};
// Collect the commands
var commands;
if(paramObject.commands) {
commands = $tw.utils.parseStringArray(paramObject.commands);
} else {
// Get the values of the numeric parameters and sort them by their numeric name
commands = Object.keys(paramObject).filter(function(name) {
// We just include parameters that are identical to their numeric representation
return (parseInt(name,10) + "") === name;
}).map(function(name) {
return parseInt(name,10);
}).sort().map(function(index) {
return paramObject[index + ""];
});
}
// Compose the request
var options = {
url: this.host + "commands/",
type: "POST",
data: JSON.stringify({
commands: commands,
statusTitle: paramObject.statusTitle,
outputTitle: paramObject.outputTitle,
errorTitle: paramObject.errorTitle
}),
callback: function(err,data) {
if(callback) {
callback(err,data);
}
}
};
// Send the request
this.logger.log("Executing job:",options);
$tw.utils.httpRequest(options);
};
/*
Get an array of skinny tiddler fields from the server
*/