mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-07-12 15:04:32 +00:00
Code Issues Releases Wiki Activity

HttpClient object shouldn't need to know about events

Browse Source
This commit is contained in:
jeremy@jermolene.com 2023-05-01 17:04:35 +01:00
parent 585c7339de
commit 0adc0518a6
2 changed files with 65 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
core/modules/startup/rootwidget.js
View File

@ -22,8 +22,31 @@ exports.synchronous = true;
exports.startup = function() { exports.startup = function() {
// Install the HTTP client event handler // Install the HTTP client event handler
$tw.httpClient = new $tw.utils.HttpClient(); $tw.httpClient = new $tw.utils.HttpClient();
var getPropertiesWithPrefix = function(properties,prefix) {
var result = Object.create(null);
$tw.utils.each(properties,function(value,name) {
if(name.indexOf(prefix) === 0) {
result[name.substring(prefix.length)] = properties[name];
}
});
return result;
};
$tw.rootWidget.addEventListener("tm-http-request",function(event) { $tw.rootWidget.addEventListener("tm-http-request",function(event) {
$tw.httpClient.handleHttpRequest(event); var params = event.paramObject || {};
$tw.httpClient.initiateHttpRequest({
wiki: event.widget.wiki,
url: params.url,
method: params.method,
oncompletion: params.oncompletion,
onprogress: params.onprogress,
bindStatus: params["bind-status"],
bindProgress: params["bind-progress"],
variables: getPropertiesWithPrefix(params,"var-"),
headers: getPropertiesWithPrefix(params,"header-"),
passwordHeaders: getPropertiesWithPrefix(params,"password-header-"),
queryStrings: getPropertiesWithPrefix(params,"query-"),
passwordQueryStrings: getPropertiesWithPrefix(params,"password-query-")
});
}); });
// Install the modal message mechanism // Install the modal message mechanism
$tw.modal = new $tw.utils.Modal($tw.wiki); $tw.modal = new $tw.utils.Modal($tw.wiki);

84
core/modules/utils/dom/http.js
View File

@ -13,31 +13,39 @@ HTTP support
"use strict"; "use strict";
/* /*
Manage tm-http-request events. Options are: Manage tm-http-request events
wiki - the wiki object to use
*/ */
function HttpClient(options) { function HttpClient(options) {
options = options || {}; options = options || {};
} }
HttpClient.prototype.handleHttpRequest = function(event) { /*
console.log("Initiating an HTTP request",event) Initiate an HTTP request. Options:
wiki: wiki to be used for executing action strings
url: URL for request
method: method eg GET, POST
body: text of request body
oncompletion: action string to be invoked on completion
onprogress: action string to be invoked on progress updates
bindStatus: optional title of tiddler to which status ("pending", "complete", "error") should be written
bindProgress: optional title of tiddler to which the progress of the request (0 to 100) should be bound
variables: hashmap of variable name to string value passed to action strings
headers: hashmap of header name to header value to be sent with the request
passwordHeaders: hashmap of header name to password store name to be sent with the request
queryStrings: hashmap of query string parameter name to parameter value to be sent with the request
passwordQueryStrings: hashmap of query string parameter name to password store name to be sent with the request
*/
HttpClient.prototype.initiateHttpRequest = function(options) {
console.log("Initiating an HTTP request",options)
var self = this, var self = this,
wiki = event.widget.wiki, wiki = options.wiki,
paramObject = event.paramObject || {}, url = options.url,
url = paramObject.url, completionActions = options.oncompletion,
completionActions = paramObject.oncompletion || "", progressActions = options.onprogress,
progressActions = paramObject.onprogress || "", bindStatus = options["bind-status"],
bindStatus = paramObject["bind-status"], bindProgress = options["bind-progress"],
bindProgress = paramObject["bind-progress"], method = options.method || "GET",
method = paramObject.method || "GET",
HEADER_PARAMETER_PREFIX = "header-",
QUERY_PARAMETER_PREFIX = "query-",
PASSWORD_HEADER_PARAMETER_PREFIX = "password-header-",
PASSWORD_QUERY_PARAMETER_PREFIX = "password-query-",
CONTEXT_VARIABLE_PARAMETER_PREFIX = "var-",
requestHeaders = {}, requestHeaders = {},
contextVariables = {},
setBinding = function(title,text) { setBinding = function(title,text) {
if(title) { if(title) {
wiki.addTiddler(new $tw.Tiddler({title: title, text: text})); wiki.addTiddler(new $tw.Tiddler({title: title, text: text}));
@ -46,27 +54,17 @@ HttpClient.prototype.handleHttpRequest = function(event) {
if(url) { if(url) {
setBinding(bindStatus,"pending"); setBinding(bindStatus,"pending");
setBinding(bindProgress,"0"); setBinding(bindProgress,"0");
$tw.utils.each(paramObject,function(value,name) { $tw.utils.each(options.queryStrings,function(value,name) {
// Look for query- parameters url = $tw.utils.setQueryStringParameter(url,name,value);
if(name.substr(0,QUERY_PARAMETER_PREFIX.length) === QUERY_PARAMETER_PREFIX) { });
url = $tw.utils.setQueryStringParameter(url,name.substr(QUERY_PARAMETER_PREFIX.length),value); $tw.utils.each(options.passwordQueryStrings,function(value,name) {
} url = $tw.utils.setQueryStringParameter(url,name,$tw.utils.getPassword(value) || "");
// Look for header- parameters });
if(name.substr(0,HEADER_PARAMETER_PREFIX.length) === HEADER_PARAMETER_PREFIX) { $tw.utils.each(options.headers,function(value,name) {
requestHeaders[name.substr(HEADER_PARAMETER_PREFIX.length)] = value; requestHeaders[name] = value;
} });
// Look for password-header- parameters $tw.utils.each(options.passwordHeaders,function(value,name) {
if(name.substr(0,PASSWORD_QUERY_PARAMETER_PREFIX.length) === PASSWORD_QUERY_PARAMETER_PREFIX) { requestHeaders[name] = $tw.utils.getPassword(value) || "";
url = $tw.utils.setQueryStringParameter(url,name.substr(PASSWORD_QUERY_PARAMETER_PREFIX.length),$tw.utils.getPassword(value) || "");
}
// Look for password-query- parameters
if(name.substr(0,PASSWORD_HEADER_PARAMETER_PREFIX.length) === PASSWORD_HEADER_PARAMETER_PREFIX) {
requestHeaders[name.substr(PASSWORD_HEADER_PARAMETER_PREFIX.length)] = $tw.utils.getPassword(value) || "";
}
// Look for var- parameters
if(name.substr(0,CONTEXT_VARIABLE_PARAMETER_PREFIX.length) === CONTEXT_VARIABLE_PARAMETER_PREFIX) {
contextVariables[name.substr(CONTEXT_VARIABLE_PARAMETER_PREFIX.length)] = value;
}
}); });
// Set the request tracker tiddler // Set the request tracker tiddler
var requestTrackerTitle = wiki.generateNewTitle("$:/temp/HttpRequest"); var requestTrackerTitle = wiki.generateNewTitle("$:/temp/HttpRequest");
@ -78,14 +76,14 @@ HttpClient.prototype.handleHttpRequest = function(event) {
type: method, type: method,
status: "inprogress", status: "inprogress",
headers: requestHeaders, headers: requestHeaders,
data: paramObject.body data: options.body
}) })
}); });
$tw.utils.httpRequest({ $tw.utils.httpRequest({
url: url, url: url,
type: method, type: method,
headers: requestHeaders, headers: requestHeaders,
data: paramObject.body, data: options.body,
callback: function(err,data,xhr) { callback: function(err,data,xhr) {
var success = (xhr.status >= 200 && xhr.status < 300) ? "complete" : "error", var success = (xhr.status >= 200 && xhr.status < 300) ? "complete" : "error",
headers = {}; headers = {};
@ -97,7 +95,7 @@ HttpClient.prototype.handleHttpRequest = function(event) {
}); });
setBinding(bindStatus,success); setBinding(bindStatus,success);
setBinding(bindProgress,"100"); setBinding(bindProgress,"100");
var results = { var resultVariables = {
status: xhr.status.toString(), status: xhr.status.toString(),
statusText: xhr.statusText, statusText: xhr.statusText,
error: (err || "").toString(), error: (err || "").toString(),
@ -108,7 +106,7 @@ HttpClient.prototype.handleHttpRequest = function(event) {
wiki.addTiddler(new $tw.Tiddler(wiki.getTiddler(requestTrackerTitle),{ wiki.addTiddler(new $tw.Tiddler(wiki.getTiddler(requestTrackerTitle),{
status: success, status: success,
})); }));
wiki.invokeActionString(completionActions,undefined,$tw.utils.extend({},contextVariables,results),{parentWidget: $tw.rootWidget}); wiki.invokeActionString(completionActions,undefined,$tw.utils.extend({},options.variables,resultVariables),{parentWidget: $tw.rootWidget});
// console.log("Back!",err,data,xhr); // console.log("Back!",err,data,xhr);
}, },
progress: function(lengthComputable,loaded,total) { progress: function(lengthComputable,loaded,total) {