2012-04-30 11:23:03 +00:00
|
|
|
/*\
|
2012-05-03 20:47:16 +00:00
|
|
|
title: $:/core/modules/wiki.js
|
2012-04-30 11:23:03 +00:00
|
|
|
type: application/javascript
|
|
|
|
module-type: wikimethod
|
|
|
|
|
|
|
|
Extension methods for the $tw.Wiki object
|
|
|
|
|
|
|
|
Adds the following properties to the wiki object:
|
|
|
|
|
|
|
|
* `eventListeners` is an array of {filter: <string>, listener: fn}
|
|
|
|
* `changedTiddlers` is a hashmap describing changes to named tiddlers since wiki change events were
|
|
|
|
last dispatched. Each entry is a hashmap containing two fields:
|
|
|
|
modified: true/false
|
|
|
|
deleted: true/false
|
|
|
|
* `changeCount` is a hashmap by tiddler title containing a numerical index that starts at zero and is
|
|
|
|
incremented each time a tiddler is created changed or deleted
|
|
|
|
* `caches` is a hashmap by tiddler title containing a further hashmap of named cache objects. Caches
|
|
|
|
are automatically cleared when a tiddler is modified or deleted
|
|
|
|
* `macros` is a hashmap by macro name containing an object class inheriting from the Macro tree node
|
|
|
|
|
|
|
|
\*/
|
|
|
|
(function(){
|
|
|
|
|
2012-05-04 17:49:04 +00:00
|
|
|
/*jslint node: true, browser: true */
|
|
|
|
/*global $tw: false */
|
2012-04-30 11:23:03 +00:00
|
|
|
"use strict";
|
|
|
|
|
2012-06-19 07:56:15 +00:00
|
|
|
/*
|
2012-10-18 22:20:27 +00:00
|
|
|
Get the value of a text reference. Text references can have any of these forms:
|
|
|
|
<tiddlertitle>
|
|
|
|
<tiddlertitle>##<fieldname>
|
|
|
|
##<fieldname> - specifies a field of the current tiddlers
|
2012-06-19 07:56:15 +00:00
|
|
|
*/
|
|
|
|
exports.getTextReference = function(textRef,defaultText,currTiddlerTitle) {
|
|
|
|
var tr = this.parseTextReference(textRef),
|
|
|
|
title = tr.title || currTiddlerTitle,
|
|
|
|
field = tr.field || "text",
|
|
|
|
tiddler = this.getTiddler(title);
|
|
|
|
if(tiddler && $tw.utils.hop(tiddler.fields,field)) {
|
|
|
|
return tiddler.fields[field];
|
|
|
|
} else {
|
|
|
|
return defaultText;
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
2012-11-11 14:31:45 +00:00
|
|
|
exports.setTextReference = function(textRef,value,currTiddlerTitle) {
|
2012-06-19 15:47:25 +00:00
|
|
|
var tr = this.parseTextReference(textRef),
|
|
|
|
title,tiddler,fields;
|
|
|
|
// Check if it is a reference to a tiddler
|
|
|
|
if(tr.title && !tr.field) {
|
|
|
|
tiddler = this.getTiddler(tr.title);
|
2012-11-11 14:31:45 +00:00
|
|
|
this.addTiddler(new $tw.Tiddler(tiddler,{title: tr.title,text: value}));
|
2012-06-19 15:47:25 +00:00
|
|
|
// Else check for a field reference
|
|
|
|
} else if(tr.field) {
|
|
|
|
title = tr.title || currTiddlerTitle;
|
|
|
|
tiddler = this.getTiddler(title);
|
|
|
|
if(tiddler) {
|
2012-06-19 15:56:40 +00:00
|
|
|
fields = {};
|
2012-06-19 15:47:25 +00:00
|
|
|
fields[tr.field] = value;
|
|
|
|
this.addTiddler(new $tw.Tiddler(tiddler,fields));
|
|
|
|
}
|
|
|
|
}
|
2012-06-19 07:56:15 +00:00
|
|
|
};
|
|
|
|
|
2012-06-19 15:47:25 +00:00
|
|
|
exports.deleteTextReference = function(textRef,currTiddlerTitle) {
|
|
|
|
var tr = this.parseTextReference(textRef),
|
|
|
|
title,tiddler,fields;
|
|
|
|
// Check if it is a reference to a tiddler
|
|
|
|
if(tr.title && !tr.field) {
|
|
|
|
this.deleteTiddler(tr.title);
|
|
|
|
// Else check for a field reference
|
|
|
|
} else if(tr.field) {
|
|
|
|
title = tr.title || currTiddlerTitle;
|
|
|
|
tiddler = this.getTiddler(title);
|
|
|
|
if(tiddler && $tw.utils.hop(tiddler.fields,tr.field)) {
|
2012-06-19 15:56:40 +00:00
|
|
|
fields = {};
|
2012-06-19 15:47:25 +00:00
|
|
|
fields[tr.field] = undefined;
|
|
|
|
this.addTiddler(new $tw.Tiddler(tiddler,fields));
|
|
|
|
}
|
|
|
|
}
|
2012-06-19 07:56:15 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
/*
|
|
|
|
Parse a text reference into its constituent parts
|
|
|
|
*/
|
|
|
|
exports.parseTextReference = function(textRef,currTiddlerTitle) {
|
|
|
|
// Look for a metadata field separator
|
|
|
|
var pos = textRef.indexOf("!!");
|
|
|
|
if(pos !== -1) {
|
|
|
|
if(pos === 0) {
|
2012-10-18 22:20:27 +00:00
|
|
|
// Just a field
|
2012-06-19 07:56:15 +00:00
|
|
|
return {
|
2012-10-18 22:20:27 +00:00
|
|
|
field: textRef.substring(2)
|
2012-06-19 07:56:15 +00:00
|
|
|
};
|
|
|
|
} else {
|
2012-10-18 22:20:27 +00:00
|
|
|
// Field and title
|
2012-06-19 07:56:15 +00:00
|
|
|
return {
|
2012-10-18 22:20:27 +00:00
|
|
|
title: textRef.substring(0,pos),
|
2012-06-19 07:56:15 +00:00
|
|
|
field: textRef.substring(pos + 2)
|
|
|
|
};
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
// Otherwise, we've just got a title
|
|
|
|
return {
|
|
|
|
title: textRef
|
|
|
|
};
|
|
|
|
}
|
2012-04-30 11:23:03 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
exports.addEventListener = function(filter,listener) {
|
|
|
|
this.eventListeners = this.eventListeners || [];
|
|
|
|
this.eventListeners.push({
|
|
|
|
filter: filter,
|
|
|
|
listener: listener
|
|
|
|
});
|
|
|
|
};
|
|
|
|
|
|
|
|
exports.removeEventListener = function(filter,listener) {
|
|
|
|
for(var c=this.eventListeners.length-1; c>=0; c--) {
|
|
|
|
var l = this.eventListeners[c];
|
|
|
|
if(l.filter === filter && l.listener === listener) {
|
|
|
|
this.eventListeners.splice(c,1);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
/*
|
|
|
|
Causes a tiddler to be marked as changed, incrementing the change count, and triggers event handlers.
|
|
|
|
This method should be called after the changes it describes have been made to the wiki.tiddlers[] array.
|
|
|
|
title: Title of tiddler
|
|
|
|
isDeleted: defaults to false (meaning the tiddler has been created or modified),
|
|
|
|
true if the tiddler has been created
|
|
|
|
*/
|
|
|
|
exports.touchTiddler = function(title,isDeleted) {
|
|
|
|
// Record the touch in the list of changed tiddlers
|
|
|
|
this.changedTiddlers = this.changedTiddlers || {};
|
|
|
|
this.changedTiddlers[title] = this.changedTiddlers[title] || [];
|
|
|
|
this.changedTiddlers[title][isDeleted ? "deleted" : "modified"] = true;
|
|
|
|
// Increment the change count
|
|
|
|
this.changeCount = this.changeCount || {};
|
2012-05-09 07:51:16 +00:00
|
|
|
if($tw.utils.hop(this.changeCount,title)) {
|
2012-04-30 11:23:03 +00:00
|
|
|
this.changeCount[title]++;
|
|
|
|
} else {
|
|
|
|
this.changeCount[title] = 1;
|
|
|
|
}
|
|
|
|
// Trigger events
|
|
|
|
this.eventListeners = this.eventListeners || [];
|
|
|
|
if(!this.eventsTriggered) {
|
|
|
|
var me = this;
|
|
|
|
$tw.utils.nextTick(function() {
|
|
|
|
var changes = me.changedTiddlers;
|
|
|
|
me.changedTiddlers = {};
|
|
|
|
me.eventsTriggered = false;
|
|
|
|
for(var e=0; e<me.eventListeners.length; e++) {
|
|
|
|
var listener = me.eventListeners[e];
|
|
|
|
listener.listener(changes);
|
|
|
|
}
|
|
|
|
});
|
|
|
|
this.eventsTriggered = true;
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
exports.getChangeCount = function(title) {
|
|
|
|
this.changeCount = this.changeCount || {};
|
2012-05-09 07:51:16 +00:00
|
|
|
if($tw.utils.hop(this.changeCount,title)) {
|
2012-04-30 11:23:03 +00:00
|
|
|
return this.changeCount[title];
|
|
|
|
} else {
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
exports.deleteTiddler = function(title) {
|
|
|
|
delete this.tiddlers[title];
|
|
|
|
this.clearCache(title);
|
|
|
|
this.touchTiddler(title,true);
|
|
|
|
};
|
|
|
|
|
|
|
|
exports.tiddlerExists = function(title) {
|
2012-06-06 11:07:33 +00:00
|
|
|
return !!this.tiddlers[title];
|
2012-04-30 11:23:03 +00:00
|
|
|
};
|
|
|
|
|
2012-11-11 14:31:45 +00:00
|
|
|
exports.addTiddler = function(tiddler) {
|
2012-04-30 11:23:03 +00:00
|
|
|
// Check if we're passed a fields hashmap instead of a tiddler
|
|
|
|
if(!(tiddler instanceof $tw.Tiddler)) {
|
|
|
|
tiddler = new $tw.Tiddler(tiddler);
|
|
|
|
}
|
2012-06-07 10:31:44 +00:00
|
|
|
// Get the title, and the current tiddler with that title
|
2012-06-06 21:19:34 +00:00
|
|
|
var title = tiddler.fields.title,
|
|
|
|
prevTiddler = this.tiddlers[title];
|
2012-06-07 10:31:44 +00:00
|
|
|
// Save the tiddler
|
2012-04-30 11:23:03 +00:00
|
|
|
this.tiddlers[title] = tiddler;
|
|
|
|
this.clearCache(title);
|
|
|
|
this.touchTiddler(title);
|
|
|
|
};
|
|
|
|
|
2012-05-29 21:01:35 +00:00
|
|
|
/*
|
2012-09-02 19:28:32 +00:00
|
|
|
Serialise tiddlers to a specified text serialization format
|
2012-05-29 21:01:35 +00:00
|
|
|
*/
|
2012-09-02 19:28:32 +00:00
|
|
|
exports.serializeTiddlers = function(tiddlers,type) {
|
2012-08-03 14:09:48 +00:00
|
|
|
var serializer = $tw.Wiki.tiddlerSerializerModules[type];
|
2012-09-02 19:28:32 +00:00
|
|
|
if(serializer) {
|
|
|
|
return serializer.call(this,tiddlers);
|
2012-05-05 12:15:19 +00:00
|
|
|
} else {
|
|
|
|
return null;
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
2012-04-30 11:23:03 +00:00
|
|
|
/*
|
|
|
|
Return a sorted array of tiddler titles, optionally filtered by a tag
|
|
|
|
*/
|
2012-05-08 15:02:24 +00:00
|
|
|
exports.getTiddlers = function(sortField,excludeTag) {
|
2012-04-30 11:23:03 +00:00
|
|
|
sortField = sortField || "title";
|
|
|
|
var tiddlers = [], t, titles = [];
|
|
|
|
for(t in this.tiddlers) {
|
2012-11-11 14:31:45 +00:00
|
|
|
if($tw.utils.hop(this.tiddlers,t) && !this.tiddlers[t].isShadow()) {
|
2012-06-06 12:21:20 +00:00
|
|
|
tiddlers.push(this.tiddlers[t]);
|
|
|
|
}
|
2012-04-30 11:23:03 +00:00
|
|
|
}
|
|
|
|
tiddlers.sort(function(a,b) {
|
2012-10-16 20:41:12 +00:00
|
|
|
var aa = a.fields[sortField].toLowerCase() || "",
|
|
|
|
bb = b.fields[sortField].toLowerCase() || "";
|
2012-04-30 11:23:03 +00:00
|
|
|
if(aa < bb) {
|
|
|
|
return -1;
|
|
|
|
} else {
|
|
|
|
if(aa > bb) {
|
|
|
|
return 1;
|
|
|
|
} else {
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
});
|
|
|
|
for(t=0; t<tiddlers.length; t++) {
|
|
|
|
if(!excludeTag || !tiddlers[t].hasTag(excludeTag)) {
|
|
|
|
titles.push(tiddlers[t].fields.title);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return titles;
|
|
|
|
};
|
|
|
|
|
2012-05-08 15:02:24 +00:00
|
|
|
/*
|
|
|
|
Sort an array of tiddler titles by a specified field
|
|
|
|
titles: array of titles (sorted in place)
|
|
|
|
sortField: name of field to sort by
|
|
|
|
isDescending: true if the sort should be descending
|
2012-06-14 10:36:26 +00:00
|
|
|
isCaseSensitive: true if the sort should consider upper and lower case letters to be different
|
2012-05-08 15:02:24 +00:00
|
|
|
*/
|
2012-06-14 10:36:26 +00:00
|
|
|
exports.sortTiddlers = function(titles,sortField,isDescending,isCaseSensitive) {
|
2012-05-08 15:02:24 +00:00
|
|
|
var self = this;
|
|
|
|
titles.sort(function(a,b) {
|
2012-06-19 09:40:05 +00:00
|
|
|
if(sortField !== "title") {
|
2012-10-16 20:41:12 +00:00
|
|
|
a = self.getTiddler(a).fields[sortField] || "";
|
|
|
|
b = self.getTiddler(b).fields[sortField] || "";
|
2012-06-19 09:40:05 +00:00
|
|
|
}
|
2012-06-14 10:36:26 +00:00
|
|
|
if(!isCaseSensitive) {
|
2012-10-23 15:28:38 +00:00
|
|
|
if(typeof a === "string") {
|
|
|
|
a = a.toLowerCase();
|
|
|
|
}
|
|
|
|
if(typeof b === "string") {
|
|
|
|
b = b.toLowerCase();
|
|
|
|
}
|
2012-06-14 10:36:26 +00:00
|
|
|
}
|
2012-06-19 09:40:05 +00:00
|
|
|
if(a < b) {
|
2012-05-08 15:02:24 +00:00
|
|
|
return isDescending ? +1 : -1;
|
|
|
|
} else {
|
2012-06-19 09:40:05 +00:00
|
|
|
if(a > b) {
|
2012-05-08 15:02:24 +00:00
|
|
|
return isDescending ? -1 : +1;
|
|
|
|
} else {
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
});
|
|
|
|
};
|
|
|
|
|
2012-04-30 11:23:03 +00:00
|
|
|
exports.forEachTiddler = function(/* [sortField,[excludeTag,]]callback */) {
|
|
|
|
var arg = 0,
|
|
|
|
sortField = arguments.length > 1 ? arguments[arg++] : null,
|
|
|
|
excludeTag = arguments.length > 2 ? arguments[arg++] : null,
|
|
|
|
callback = arguments[arg++],
|
2012-05-08 15:02:24 +00:00
|
|
|
titles = this.getTiddlers(sortField,excludeTag),
|
2012-04-30 11:23:03 +00:00
|
|
|
t, tiddler;
|
|
|
|
for(t=0; t<titles.length; t++) {
|
|
|
|
tiddler = this.tiddlers[titles[t]];
|
|
|
|
if(tiddler) {
|
|
|
|
callback.call(this,tiddler.fields.title,tiddler);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
exports.getMissingTitles = function() {
|
|
|
|
return []; // Todo
|
|
|
|
};
|
|
|
|
|
|
|
|
exports.getOrphanTitles = function() {
|
|
|
|
return []; // Todo
|
|
|
|
};
|
|
|
|
|
|
|
|
exports.getShadowTitles = function() {
|
2012-06-06 12:21:20 +00:00
|
|
|
var titles = [];
|
|
|
|
for(var title in this.tiddlers) {
|
2012-11-11 14:31:45 +00:00
|
|
|
if(this.tiddlers[title].isShadow()) {
|
2012-06-06 12:21:20 +00:00
|
|
|
titles.push(title);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
titles.sort();
|
|
|
|
return titles;
|
2012-04-30 11:23:03 +00:00
|
|
|
};
|
|
|
|
|
2012-06-13 08:10:03 +00:00
|
|
|
/*
|
|
|
|
Retrieves a list of the tiddler titles that are tagged with a given tag
|
|
|
|
*/
|
|
|
|
exports.getTiddlersWithTag = function(tag) {
|
|
|
|
var titles = [];
|
|
|
|
for(var title in this.tiddlers) {
|
|
|
|
var tiddler = this.tiddlers[title];
|
|
|
|
if(tiddler.fields.tags && tiddler.fields.tags.indexOf(tag) !== -1) {
|
|
|
|
titles.push(title);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return titles;
|
|
|
|
};
|
|
|
|
|
2012-07-22 21:03:06 +00:00
|
|
|
/*
|
|
|
|
Get a tiddlers content as a JavaScript object. How this is done depends on the type of the tiddler:
|
|
|
|
|
|
|
|
application/json: the tiddler JSON is parsed into an object
|
|
|
|
|
|
|
|
Other types currently just return null.
|
|
|
|
*/
|
|
|
|
exports.getTiddlerData = function(title,defaultData) {
|
|
|
|
var tiddler = this.tiddlers[title],
|
|
|
|
data;
|
|
|
|
if(tiddler && tiddler.fields.text && tiddler.fields.type === "application/json") {
|
|
|
|
// JSON tiddler
|
|
|
|
try {
|
|
|
|
data = JSON.parse(tiddler.fields.text);
|
|
|
|
} catch(ex) {
|
|
|
|
return defaultData;
|
|
|
|
}
|
|
|
|
return data;
|
|
|
|
}
|
|
|
|
return defaultData;
|
|
|
|
};
|
|
|
|
|
|
|
|
/*
|
|
|
|
Set a tiddlers content to a JavaScript object. Currently this is done by setting the tiddler's type to "application/json" and setting the text to the JSON text of the data.
|
|
|
|
*/
|
|
|
|
exports.setTiddlerData = function(title,data) {
|
|
|
|
var tiddler = this.getTiddler(title);
|
|
|
|
this.addTiddler(new $tw.Tiddler(tiddler,{title: title, type: "application/json", text: JSON.stringify(data)}));
|
|
|
|
};
|
|
|
|
|
2012-10-25 13:57:33 +00:00
|
|
|
/*
|
|
|
|
Return the content of a tiddler as an array containing each line
|
|
|
|
*/
|
|
|
|
exports.getTiddlerList = function(title) {
|
|
|
|
var tiddler = this.getTiddler(title);
|
2012-10-25 21:44:00 +00:00
|
|
|
if(tiddler && tiddler.fields.text && tiddler.fields.text.length > 0) {
|
2012-10-25 13:57:33 +00:00
|
|
|
return tiddler.fields.text.split("\n");
|
|
|
|
}
|
|
|
|
return [];
|
|
|
|
};
|
|
|
|
|
2012-04-30 11:23:03 +00:00
|
|
|
// Return the named cache object for a tiddler. If the cache doesn't exist then the initializer function is invoked to create it
|
|
|
|
exports.getCacheForTiddler = function(title,cacheName,initializer) {
|
|
|
|
this.caches = this.caches || {};
|
|
|
|
var caches = this.caches[title];
|
|
|
|
if(caches && caches[cacheName]) {
|
|
|
|
return caches[cacheName];
|
|
|
|
} else {
|
|
|
|
if(!caches) {
|
|
|
|
caches = {};
|
|
|
|
this.caches[title] = caches;
|
|
|
|
}
|
|
|
|
caches[cacheName] = initializer();
|
|
|
|
return caches[cacheName];
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
// Clear all caches associated with a particular tiddler
|
|
|
|
exports.clearCache = function(title) {
|
|
|
|
this.caches = this.caches || {};
|
2012-05-09 07:51:16 +00:00
|
|
|
if($tw.utils.hop(this.caches,title)) {
|
2012-04-30 11:23:03 +00:00
|
|
|
delete this.caches[title];
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
exports.initParsers = function(moduleType) {
|
|
|
|
// Install the parser modules
|
|
|
|
moduleType = moduleType || "parser";
|
2012-11-14 11:23:43 +00:00
|
|
|
$tw.wiki.parsers = {};
|
|
|
|
var self = this;
|
|
|
|
$tw.modules.forEachModuleOfType(moduleType,function(title,module) {
|
|
|
|
for(var f in module) {
|
|
|
|
if($tw.utils.hop(module,f)) {
|
|
|
|
$tw.wiki.parsers[f] = new module[f]({wiki: self}); // Store an instance of the parser
|
2012-04-30 11:23:03 +00:00
|
|
|
}
|
|
|
|
}
|
2012-11-14 11:23:43 +00:00
|
|
|
});
|
2012-05-27 08:19:37 +00:00
|
|
|
// Install the rules for the old wikitext parser rules
|
2012-07-14 17:08:00 +00:00
|
|
|
var wikitextparser = this.parsers["text/x-tiddlywiki-old"];
|
2012-11-14 11:23:43 +00:00
|
|
|
if(wikitextparser) {
|
2012-05-27 08:19:37 +00:00
|
|
|
wikitextparser.installRules();
|
2012-04-30 11:23:03 +00:00
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
/*
|
|
|
|
Parse a block of text of a specified MIME type
|
|
|
|
|
|
|
|
Options are:
|
|
|
|
defaultType: Default MIME type to use if the specified one is unknown
|
2012-08-25 11:05:57 +00:00
|
|
|
with: Optional array of strings to be substituted for $1, $2 etc.
|
2012-04-30 11:23:03 +00:00
|
|
|
*/
|
|
|
|
exports.parseText = function(type,text,options) {
|
|
|
|
options = options || {};
|
2012-08-25 11:05:57 +00:00
|
|
|
// Select a parser
|
2012-04-30 11:23:03 +00:00
|
|
|
var parser = this.parsers[type];
|
2012-06-08 10:47:05 +00:00
|
|
|
if(!parser && $tw.config.fileExtensionInfo[type]) {
|
|
|
|
parser = this.parsers[$tw.config.fileExtensionInfo[type].type];
|
2012-05-09 16:35:08 +00:00
|
|
|
}
|
2012-04-30 11:23:03 +00:00
|
|
|
if(!parser) {
|
|
|
|
parser = this.parsers[options.defaultType || "text/x-tiddlywiki"];
|
|
|
|
}
|
2012-08-25 11:05:57 +00:00
|
|
|
if(!parser) {
|
2012-04-30 11:23:03 +00:00
|
|
|
return null;
|
|
|
|
}
|
2012-08-25 11:05:57 +00:00
|
|
|
// Substitute any `with` tokens
|
|
|
|
if("with" in options) {
|
|
|
|
for(var token in options["with"]) {
|
|
|
|
var placeholderRegExp = new RegExp("\\$"+token,"mg");
|
|
|
|
text = text.replace(placeholderRegExp,options["with"][token]);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return parser.parse(type,text);
|
2012-04-30 11:23:03 +00:00
|
|
|
};
|
|
|
|
|
2012-08-25 11:05:57 +00:00
|
|
|
/*
|
|
|
|
Parse a tiddler according to its MIME type
|
|
|
|
|
|
|
|
Options are:
|
|
|
|
defaultType: Default MIME type to use if the specified one is unknown
|
|
|
|
with: Optional array of strings to be substituted for $1, $2 etc.
|
|
|
|
*/
|
|
|
|
exports.parseTiddler = function(title,options) {
|
|
|
|
options = options || {};
|
2012-04-30 11:23:03 +00:00
|
|
|
var me = this,
|
|
|
|
tiddler = this.getTiddler(title);
|
2012-08-25 11:05:57 +00:00
|
|
|
if("with" in options) {
|
|
|
|
return this.parseText(tiddler.fields.type,tiddler.fields.text,options);
|
|
|
|
} else {
|
|
|
|
return tiddler ? this.getCacheForTiddler(title,"parseTree",function() {
|
|
|
|
return me.parseText(tiddler.fields.type,tiddler.fields.text,options);
|
|
|
|
}) : null;
|
|
|
|
}
|
2012-04-30 11:23:03 +00:00
|
|
|
};
|
|
|
|
|
2012-05-02 10:02:47 +00:00
|
|
|
/*
|
|
|
|
Parse text in a specified format and render it into another format
|
|
|
|
outputType: content type for the output
|
|
|
|
textType: content type of the input text
|
|
|
|
text: input text
|
2012-07-22 21:03:06 +00:00
|
|
|
options: see wiki.parseText()
|
2012-05-02 10:02:47 +00:00
|
|
|
Options are:
|
|
|
|
defaultType: Default MIME type to use if the specified one is unknown
|
2012-08-25 11:05:57 +00:00
|
|
|
with: Optional array of strings to be substituted for $1, $2 etc.
|
2012-05-02 10:02:47 +00:00
|
|
|
*/
|
|
|
|
exports.renderText = function(outputType,textType,text,options) {
|
2012-05-02 16:24:23 +00:00
|
|
|
var renderer = this.parseText(textType,text,options);
|
2012-05-02 10:02:47 +00:00
|
|
|
renderer.execute([]);
|
|
|
|
return renderer.render(outputType);
|
|
|
|
};
|
|
|
|
|
2012-08-25 11:05:57 +00:00
|
|
|
/*
|
|
|
|
Parse text from a tiddler and render it into another format
|
|
|
|
outputType: content type for the output
|
|
|
|
title: title of the tiddler to be rendered
|
|
|
|
options: see wiki.parseText()
|
|
|
|
Options are:
|
|
|
|
defaultType: Default MIME type to use if the specified one is unknown
|
|
|
|
with: Optional array of strings to be substituted for $1, $2 etc.
|
|
|
|
*/
|
|
|
|
exports.renderTiddler = function(outputType,title,options) {
|
|
|
|
var renderer = this.parseTiddler(title,options);
|
2012-05-02 16:24:23 +00:00
|
|
|
renderer.execute([],title);
|
|
|
|
return renderer.render(outputType);
|
|
|
|
};
|
|
|
|
|
2012-04-30 11:23:03 +00:00
|
|
|
/*
|
2012-08-03 14:09:48 +00:00
|
|
|
Install macro modules into this wiki
|
|
|
|
moduleType: Module type to install (defaults to "macro")
|
2012-04-30 11:23:03 +00:00
|
|
|
|
|
|
|
It's useful to remember what the `new` keyword does. It:
|
|
|
|
|
|
|
|
# Creates a new object. It's type is a plain `object`
|
|
|
|
# Sets the new objects internal, inaccessible, `[[prototype]]` property to the
|
|
|
|
constructor function's external, accessible, `prototype` object
|
|
|
|
# Executes the constructor function, passing the new object as `this`
|
|
|
|
|
|
|
|
*/
|
|
|
|
exports.initMacros = function(moduleType) {
|
|
|
|
moduleType = moduleType || "macro";
|
2012-11-14 11:23:43 +00:00
|
|
|
$tw.wiki.macros = {};
|
2012-04-30 11:23:03 +00:00
|
|
|
var MacroClass = require("./treenodes/macro.js").Macro,
|
|
|
|
subclassMacro = function(module) {
|
|
|
|
// Make a copy of the Macro() constructor function
|
|
|
|
var MacroMaker = function Macro() {
|
|
|
|
MacroClass.apply(this,arguments);
|
|
|
|
};
|
|
|
|
// Set the prototype to a new instance of the prototype of the Macro class
|
|
|
|
MacroMaker.prototype = new MacroClass();
|
|
|
|
// Add the prototype methods for this instance of the macro
|
|
|
|
for(var f in module) {
|
2012-11-14 11:23:43 +00:00
|
|
|
if($tw.utils.hop(module,f)) {
|
|
|
|
MacroMaker.prototype[f] = module[f];
|
|
|
|
}
|
2012-04-30 11:23:03 +00:00
|
|
|
}
|
|
|
|
// Make a more convenient reference to the macro info
|
|
|
|
return MacroMaker;
|
|
|
|
};
|
2012-11-14 11:23:43 +00:00
|
|
|
$tw.modules.forEachModuleOfType(moduleType,function(title,module) {
|
|
|
|
$tw.wiki.macros[module.info.name] = subclassMacro(module);
|
|
|
|
});
|
2012-04-30 11:23:03 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
/*
|
2012-08-03 14:09:48 +00:00
|
|
|
Install editor modules for the edit macro
|
2012-04-30 11:23:03 +00:00
|
|
|
*/
|
|
|
|
exports.initEditors = function(moduleType) {
|
|
|
|
moduleType = moduleType || "editor";
|
|
|
|
var editMacro = this.macros.edit;
|
|
|
|
if(editMacro) {
|
|
|
|
editMacro.editors = {};
|
2012-08-03 14:09:48 +00:00
|
|
|
$tw.modules.applyMethods(moduleType,editMacro.editors);
|
2012-04-30 11:23:03 +00:00
|
|
|
}
|
|
|
|
};
|
|
|
|
|
2012-10-18 17:27:27 +00:00
|
|
|
/*
|
2012-10-23 16:13:47 +00:00
|
|
|
Install field viewer modules for the view macro
|
2012-10-18 17:27:27 +00:00
|
|
|
*/
|
2012-10-23 15:40:22 +00:00
|
|
|
exports.initFieldViewers = function(moduleType) {
|
|
|
|
moduleType = moduleType || "fieldviewer";
|
2012-10-18 17:27:27 +00:00
|
|
|
var viewMacro = this.macros.view;
|
|
|
|
if(viewMacro) {
|
2012-10-23 15:40:22 +00:00
|
|
|
viewMacro.fieldviewers = {};
|
|
|
|
$tw.modules.applyMethods(moduleType,viewMacro.fieldviewers);
|
2012-10-18 17:27:27 +00:00
|
|
|
}
|
|
|
|
};
|
|
|
|
|
2012-10-23 16:13:47 +00:00
|
|
|
/*
|
|
|
|
Install list viewer modules for the list macro
|
|
|
|
*/
|
|
|
|
exports.initListViews = function(moduleType) {
|
|
|
|
moduleType = moduleType || "listview";
|
|
|
|
var listMacro = this.macros.list;
|
|
|
|
if(listMacro) {
|
|
|
|
listMacro.listviews = {};
|
|
|
|
$tw.modules.applyMethods(moduleType,listMacro.listviews);
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
2012-07-10 22:18:44 +00:00
|
|
|
/*
|
|
|
|
Select the appropriate saver modules and set them up
|
|
|
|
*/
|
|
|
|
exports.initSavers = function(moduleType) {
|
|
|
|
moduleType = moduleType || "saver";
|
|
|
|
// Instantiate the available savers
|
|
|
|
this.savers = [];
|
2012-11-14 11:23:43 +00:00
|
|
|
var self = this;
|
|
|
|
$tw.modules.forEachModuleOfType(moduleType,function(title,module) {
|
|
|
|
if(module.canSave(self)) {
|
|
|
|
self.savers.push(module.create(self));
|
2012-07-10 22:18:44 +00:00
|
|
|
}
|
2012-11-14 11:23:43 +00:00
|
|
|
});
|
2012-07-10 22:18:44 +00:00
|
|
|
// Sort the savers into priority order
|
|
|
|
this.savers.sort(function(a,b) {
|
|
|
|
if(a.info.priority < b.info.priority) {
|
|
|
|
return -1;
|
|
|
|
} else {
|
|
|
|
if(a.info.priority > b.info.priority) {
|
|
|
|
return +1;
|
|
|
|
} else {
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
});
|
|
|
|
};
|
|
|
|
|
|
|
|
/*
|
|
|
|
Invoke the highest priority saver that successfully handles a method
|
|
|
|
*/
|
|
|
|
exports.callSaver = function(method /*, args */ ) {
|
|
|
|
for(var t=this.savers.length-1; t>=0; t--) {
|
|
|
|
var saver = this.savers[t];
|
|
|
|
if(saver[method].apply(saver,Array.prototype.slice.call(arguments,1))) {
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return false;
|
|
|
|
};
|
|
|
|
|
|
|
|
/*
|
2012-08-25 16:32:43 +00:00
|
|
|
Save the wiki contents. Options are:
|
2012-07-10 22:18:44 +00:00
|
|
|
template: the tiddler containing the template to save
|
|
|
|
downloadType: the content type for the saved file
|
|
|
|
*/
|
|
|
|
exports.saveWiki = function(options) {
|
|
|
|
options = options || {};
|
|
|
|
var template = options.template || "$:/core/templates/tiddlywiki5.template.html",
|
2012-11-16 22:40:25 +00:00
|
|
|
downloadType = options.downloadType || "text/plain";
|
|
|
|
var text = this.renderTiddler(downloadType,template);
|
2012-07-10 22:18:44 +00:00
|
|
|
this.callSaver("save",text);
|
|
|
|
};
|
|
|
|
|
2012-10-17 13:34:59 +00:00
|
|
|
/*
|
|
|
|
Return an array of tiddler titles that match a search string
|
|
|
|
text: The text string to search for
|
2012-10-17 13:57:13 +00:00
|
|
|
options: see below
|
|
|
|
Options available:
|
|
|
|
titles: Hashmap or array of tiddler titles to limit search
|
|
|
|
exclude: An array of tiddler titles to exclude from the search
|
|
|
|
invert: If true returns tiddlers that do not contain the specified string
|
2012-10-17 19:38:36 +00:00
|
|
|
caseSensitive: If true forces a case sensitive search
|
|
|
|
literal: If true, searches for literal string, rather than separate search terms
|
2012-10-17 13:34:59 +00:00
|
|
|
*/
|
2012-10-17 13:57:13 +00:00
|
|
|
exports.search = function(text,options) {
|
|
|
|
options = options || {};
|
2012-10-17 19:38:36 +00:00
|
|
|
var me = this,t;
|
|
|
|
// Convert the search string into a regexp for each term
|
|
|
|
var terms, searchTermsRegExps,
|
|
|
|
flags = options.caseSensitive ? "" : "i";
|
|
|
|
if(options.literal) {
|
|
|
|
if(text.length === 0) {
|
|
|
|
return [];
|
|
|
|
}
|
|
|
|
searchTermsRegExps = [new RegExp("(" + $tw.utils.escapeRegExp(text) + ")",flags)];
|
|
|
|
} else {
|
|
|
|
terms = text.replace(/( +)/g," ").split(" ");
|
|
|
|
searchTermsRegExps = [];
|
|
|
|
if(terms.length === 0) {
|
|
|
|
return [];
|
|
|
|
}
|
|
|
|
for(t=0; t<terms.length; t++) {
|
|
|
|
searchTermsRegExps.push(new RegExp("(" + $tw.utils.escapeRegExp(terms[t]) + ")",flags));
|
|
|
|
}
|
|
|
|
}
|
2012-10-17 13:34:59 +00:00
|
|
|
// Function to check a given tiddler for the search term
|
|
|
|
var searchTiddler = function(title) {
|
2012-10-17 19:38:36 +00:00
|
|
|
var tiddler = me.getTiddler(title);
|
|
|
|
if(!tiddler) {
|
|
|
|
return !!options.invert;
|
|
|
|
}
|
|
|
|
var contentTypeInfo = $tw.config.contentTypeInfo[tiddler.fields.type];
|
|
|
|
if(contentTypeInfo ? contentTypeInfo.encoding === "utf8" : true) {
|
|
|
|
var match = true;
|
|
|
|
for(var t=0; t<searchTermsRegExps.length; t++) {
|
2012-10-18 17:27:58 +00:00
|
|
|
// Search title and body
|
2012-10-17 19:38:36 +00:00
|
|
|
if(match) {
|
2012-10-18 17:27:58 +00:00
|
|
|
match = searchTermsRegExps[t].test(tiddler.fields.title) || searchTermsRegExps[t].test(tiddler.fields.text);
|
2012-10-18 09:51:52 +00:00
|
|
|
}
|
2012-10-17 19:38:36 +00:00
|
|
|
}
|
|
|
|
return options.invert ? !match : match;
|
|
|
|
}
|
|
|
|
return false;
|
2012-11-06 17:21:56 +00:00
|
|
|
};
|
2012-10-17 13:34:59 +00:00
|
|
|
// Loop through all the tiddlers doing the search
|
2012-10-17 19:38:36 +00:00
|
|
|
var results = [];
|
2012-10-17 13:57:13 +00:00
|
|
|
if($tw.utils.isArray(options.titles)) {
|
|
|
|
for(t=0; t<options.titles.length; t++) {
|
|
|
|
if(searchTiddler(options.titles[t])) {
|
|
|
|
results.push(options.titles[t]);
|
2012-10-17 13:34:59 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
} else {
|
2012-10-17 13:57:13 +00:00
|
|
|
var source = options.titles || this.tiddlers;
|
|
|
|
for(t in source) {
|
2012-10-17 13:34:59 +00:00
|
|
|
if(searchTiddler(t)) {
|
|
|
|
results.push(t);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
2012-10-17 13:57:13 +00:00
|
|
|
// Remove any of the results we have to exclude
|
|
|
|
if(options.exclude) {
|
|
|
|
for(t=0; t<options.exclude.length; t++) {
|
|
|
|
var p = results.indexOf(options.exclude[t]);
|
|
|
|
if(p !== -1) {
|
|
|
|
results.splice(p,1);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
2012-10-17 13:34:59 +00:00
|
|
|
return results;
|
|
|
|
};
|
|
|
|
|
2012-11-17 20:18:36 +00:00
|
|
|
/*
|
|
|
|
Initialise syncers
|
|
|
|
*/
|
|
|
|
exports.initSyncers = function() {
|
|
|
|
this.syncers = {};
|
|
|
|
var self = this;
|
|
|
|
$tw.modules.forEachModuleOfType("syncer",function(title,module) {
|
|
|
|
if(module.name && module.syncer) {
|
|
|
|
self.syncers[module.name] = new module.syncer({
|
|
|
|
wiki: self
|
|
|
|
});
|
|
|
|
}
|
|
|
|
});
|
|
|
|
};
|
|
|
|
|
|
|
|
/*
|
|
|
|
Initialise server connections
|
|
|
|
*/
|
|
|
|
exports.initServerConnections = function() {
|
|
|
|
this.serverConnections = {};
|
|
|
|
var self = this;
|
|
|
|
$tw.modules.forEachModuleOfType("serverconnection",function(title,module) {
|
2012-11-17 21:15:19 +00:00
|
|
|
// Get the associated syncer
|
|
|
|
if(module.syncer) {
|
|
|
|
var syncer = self.syncers[module.syncer];
|
|
|
|
if(syncer) {
|
|
|
|
// Add the connection and save information about it
|
|
|
|
var connection = syncer.addConnection(module);
|
|
|
|
if(connection instanceof Error) {
|
|
|
|
console.log("Error adding connection: " + connection);
|
|
|
|
} else {
|
|
|
|
self.serverConnections[title] = {
|
|
|
|
syncer: syncer,
|
|
|
|
connection: connection
|
|
|
|
};
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
2012-11-17 20:18:36 +00:00
|
|
|
});
|
|
|
|
};
|
|
|
|
|
2012-11-18 13:14:28 +00:00
|
|
|
/*
|
|
|
|
Invoke all the active server connections
|
|
|
|
*/
|
|
|
|
exports.invokeServerConnections = function(method /* ,args */) {
|
|
|
|
var args = Array.prototype.slice.call(arguments,1);
|
|
|
|
for(var title in this.serverConnections) {
|
|
|
|
var connection = this.serverConnections[title];
|
|
|
|
connection.syncer[method].apply(connection.syncer,[connection.connection].concat(args));
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
2012-11-17 20:18:36 +00:00
|
|
|
/*
|
|
|
|
Handle a syncer message
|
|
|
|
*/
|
|
|
|
exports.handleSyncerEvent = function(event) {
|
|
|
|
for(var syncer in this.syncers) {
|
|
|
|
this.syncers[syncer].handleEvent(event);
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
2012-11-18 13:14:28 +00:00
|
|
|
/*
|
|
|
|
Trigger a load for a tiddler if it is skinny. Returns the text, or undefined if the tiddler is missing, null if the tiddler is being lazily loaded.
|
|
|
|
*/
|
|
|
|
exports.getTiddlerText = function(title) {
|
|
|
|
var tiddler = this.getTiddler(title);
|
|
|
|
// Return undefined if the tiddler isn't found
|
|
|
|
if(!tiddler) {
|
|
|
|
return undefined;
|
|
|
|
}
|
|
|
|
if(tiddler.fields.text) {
|
|
|
|
// Just return the text if we've got it
|
|
|
|
return tiddler.fields.text;
|
|
|
|
} else {
|
|
|
|
// Ask all the server connections to load the tiddler if they can
|
|
|
|
this.invokeServerConnections("lazyLoad",title,tiddler);
|
|
|
|
// Indicate that the text is being loaded
|
|
|
|
return null;
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
2012-04-30 11:23:03 +00:00
|
|
|
})();
|