').html($(elem).html().replace(/\n/g, ' \n')) },
wikiword: function(context, elem){
return $('')
.html(setWikiWords($(elem).html(), true, this.__include_marker__)) },
// XXX need to remove all on* event handlers...
noscript: function(context, elem){
return $(elem)
// remove script tags...
.find('script')
.remove()
.end()
// remove js links...
.find('[href]')
.filter(function(i, e){ return /javascript:/i.test($(e).attr('href')) })
.attr('href', '#')
.end()
.end()
// remove event handlers...
// XXX .off() will not work here as we need to remove on* handlers...
},
// XXX move this to a plugin...
markdown: function(context, elem){
var converter = new showdown.Converter({
strikethrough: true,
tables: true,
tasklists: true,
})
return $('')
.html(converter.makeHtml($(elem).html()))
// XXX add click handling to checkboxes...
.find('[checked]')
.parent()
.addClass('checked')
.end()
.end()
},
},
// Parsing:
// 1) expand macros
// 2) apply filters
// 3) merge and parse included pages:
// 1) expand macros
// 2) apply filters
// 4) fill slots
// 5) expand post-macros
//
// NOTE: stage 4 parsing is executed on the final merged page only
// once. i.e. it is not performed on the included pages.
// NOTE: included pages are parsed in their own context.
// NOTE: slots are parsed in the context of their containing page
// and not in the location they are being placed.
//
// XXX support quoted text...
// XXX need to quote regexp chars of .__include_marker__...
parse: function(context, text, state, skip_post, pattern){
var that = this
state = state || {}
state.filters = state.filters || []
state.slots = state.slots || {}
state.include = state.include || []
//pattern = pattern || RegExp('@([a-zA-Z-_]+)\\(([^)]*)\\)', 'mg')
pattern = pattern || RegExp.apply(null, this.__macro__pattern__)
// XXX need to quote regexp chars...
var include_marker = RegExp(this.__include_marker__, 'g')
var parsed = typeof(text) == typeof('str') ?
$('').html(text)
: text
var _parseText = function(context, text, macro){
return text.replace(pattern, function(match){
// XXX parse match...
var d = match.match(/@([a-zA-Z-_:]*)\(([^)]*)\)/)
var name = d[1]
if(name in macro){
var elem = $('<'+name+'/>')
// format positional args....
var a = d[2]
.split(/((['"]).*?\2)|\s+/g)
// cleanup...
.filter(function(e){ return e && e != '' && !/^['"]$/.test(e)})
// remove quotes...
.map(function(e){ return /^(['"]).*\1$/.test(e) ? e.slice(1, -1) : e })
// add the attrs to the element...
a.forEach(function(e, i){
var k = ((macro[name] || {}).macro_args || [])[i]
k && elem.attr(k, e)
})
// call macro...
var res = macro[name]
.call(that, context, elem, state,
function(elem, c){
return _parse(c || context, elem, macro) })
return res instanceof jQuery ?
// merge html of the returned set of elements...
res.map(function(i, e){ return e.outerHTML })
.toArray()
.join('\n')
: typeof(res) != typeof('str') ? res.outerHTML
: res
}
return match
})
}
// NOTE: this modifies parsed in-place...
var _parse = function(context, parsed, macro){
$(parsed).contents().each(function(_, e){
// #text / comment node -> parse the @... macros...
if(e.nodeType == e.TEXT_NODE || e.nodeType == e.COMMENT_NODE){
// get actual element content...
var text = $('
').append($(e).clone()).html()
$(e).replaceWith(_parseText(context, text, macro))
// node -> html-style + attrs...
} else {
var name = e.nodeName.toLowerCase()
// macro match -> call macro...
if(name in macro){
$(e).replaceWith(macro[name]
.call(that, context, e, state,
function(elem, c){
return _parse(c || context, elem, macro) }))
// normal tag -> attrs + sub-tree...
} else {
// parse attr values...
for(var i=0; i < e.attributes.length; i++){
var attr = e.attributes[i]
attr.value = _parseText(context, attr.value, macro)
}
// parse sub-tree...
_parse(context, e, macro)
}
}
})
return parsed
}
// macro stage...
_parse(context, parsed, this.macro)
// filter stage...
state.filters
.concat(this.__filters__)
// unique -- leave last occurance..
.filter(function(k, i, lst){
return k[0] != '-'
// filter dupplicates...
&& lst.slice(i+1).indexOf(k) == -1
// filter disabled...
&& lst.slice(0, i).indexOf('-' + k) == -1
})
// unique -- leave first occurance..
//.filter(function(k, i, lst){ return lst.slice(0, i).indexOf(k) == -1 })
// apply the filters...
.forEach(function(f){
var k = f
// get filter aliases...
var seen = []
while(typeof(k) == typeof('str') && seen.indexOf(k) == -1){
seen.push(k)
k = that.filter[k]
}
// could not find the filter...
if(!k){
//console.warn('Unknown filter:', f)
return
}
// use the filter...
parsed = k.call(that, context, parsed)
})
// merge includes...
parsed
.html(parsed.html().replace(include_marker, function(){
var page = state.include.shift()
var elem = $(page.shift())
page = page.pop()
return page.map(function(page){
return $('
')
.append(elem
.clone()
.attr('src', page.path)
.append(that
.parse(page,
page.raw,
{ slots: state.slots },
true)))
.html()
}).join('\n')
}))
// post processing...
if(!skip_post){
// fill slots...
// XXX need to prevent this from processing slots in editable
// elements...
slots = {}
// get slots...
parsed.find('slot')
.each(function(i, e){
e = $(e)
var n = e.attr('name')
n in slots && e.detach()
slots[n] = e
})
// place slots...
parsed.find('slot')
.each(function(i, e){
e = $(e)
var n = e.attr('name')
e.replaceWith(slots[n])
})
// post-macro...
this.post_macro
&& _parse(context, parsed, this.post_macro)
}
// XXX shuld we get rid of the rot span???
return parsed
},
}
/*********************************************************************/
// XXX not sure about these...
// XXX add docs...
var BaseData = {
// Macro acces to standard page attributes (paths)...
'System/title': function(){ return this.get('..').title },
'System/path': function(){ return this.dir },
'System/dir': function(){ return this.get('..').dir },
'System/location': function(){ return this.dir },
'System/resolved': function(){ return this.get('..').acquire() },
// page data...
//
// NOTE: special case: ./raw is treated a differently when getting .text
// i.e:
// .get('./raw').text
// is the same as:
// .get('.').raw
'System/raw': function(){ return this.get('..').raw },
'System/text': function(){ return this.get('..').text },
// XXX move this to Wiki.children + rename...
'System/list': function(){
var p = this.dir
return Object.keys(this.__wiki_data)
.map(function(k){
if(k.indexOf(p) == 0){
return path2lst(k.slice(p.length)).shift()
}
return null
})
.filter(function(e){ return e != null })
.sort()
.map(function(e){ return '['+ e +']' })
.join(' ')
},
// list links to this page...
'System/links': function(){
var that = this
var p = this.dir
var res = []
var wiki = this.__wiki_data
Object.keys(wiki).forEach(function(k){
(wiki[k].links || []).forEach(function(l){
(l == p || that.get(path2lst(l).slice(0, -1)).acquire('./'+path2lst(l).pop()) == p)
&& res.push([l, k])
})
})
return res
//.map(function(e){ return '['+ e[0] +'] from page: ['+ e[1] +']' })
.map(function(e){ return '['+ e[1] +'] -> ['+ e[0] +']' })
.sort()
.join(' ')
},
// Page modifiers/actions...
// XXX these needs redirecting...
//'System/sort': function(){ return this.get('..').sort() },
//'System/reverse': function(){ return this.get('..').reverse() },
'System/delete': function(){
var p = this.dir
delete this.__wiki_data[p]
//return this.get('../..').text
return 'Removed...'
},
}
// data store...
// Format:
// {
// : {
// text: ,
//
// links: [
// : ,
// ],
// }
// }
//
// XXX add .json support...
var data = {
// System pages...
'System/style': {
text: ''
+'.raw,\n'
+'.text {\n'
+' display: block;\n'
+'}\n'
+'\n'
+'input[type="checkbox"][checked]~*,'
+'.checked {\n'
+' text-decoration: line-through;\n'
+'}\n'
+'\n'
+'.button {\n'
+' text-decoration: none;\n'
+' margin: 5px;\n'
+'}\n'
+'\n'
+'.separator~* {\n'
+' float: right;\n'
+'}\n'
+'',
},
'System/settings': {
text: JSON.stringify({}),
},
// Templates...
'Templates': {
text: '@filter(nl2br) @filter(-wikiword)'
+'XXX Genereal template description...\n'
+'\n'
+''
+''
+'
'
+''
+'\n',
},
// ToDo viewer...
'Templates/_todo': {
text: ''
+'\n'
+'\n'
// XXX temporary until I figure out how to deal with the saveto=".."
// in implicit vs. explicit _view
+''
+'@source(../title)'
+'\n'
+'\n'
+'\n'
+'@include(../todo)'
+''
+'\n',
},
}
data.__proto__ = BaseData
/*********************************************************************/
// XXX add .json support...
var Wiki = {
__wiki_data: data,
__config_page__: 'System/Settings',
__home_page__: 'WikiHome',
__default_page__: 'EmptyPage',
// Special sub-paths to look in on each level...
__acquesition_order__: [
'Templates',
],
__post_acquesition_order__: [
],
// XXX should this be read only???
__system__: 'System',
//__redirect_template__: 'RedirectTemplate',
__wiki_link__: RegExp('('+[
'(\\./|\\.\\./|[A-Z][a-z0-9]+[A-Z/])[a-zA-Z0-9/]*',
'\\[[^\\]]+\\]',
].join('|') +')', 'g'),
__macro_parser__: macro,
// Resolve path variables...
//
// Supported vars:
// $NOW - resolves to 'P'+Date.now()
//
resolvePathVars: function(path){
return path
.replace(/\$NOW|\$\{NOW\}/g, ''+Date.now())
},
// Resolve '.' and '..' relative to current page...
//
// NOTE: '.' is relative to .path and not to .dir
// NOTE: this is a method as it needs the context to resolve...
resolveDotPath: function(path){
path = normalizePath(path)
// '.' or './*'
return path == '.' || /^\.\//.test(path) ?
//path.replace(/^\./, this.dir)
path.replace(/^\./, this.path)
// '..' or '../*'
: path == '..' || /^\.\.\//.test(path) ?
//path.replace(/^\.\./,
// normalizePath(path2lst(this.dir).slice(0, -1)))
path.replace(/^\.\./, this.dir)
: path
},
// Get list of paths resolving '*' and '**'
//
// XXX should we list parent pages???
// XXX should this acquire stuff???
// XXX should this support sorting and reversing???
resolveStarPath: function(path){
// no pattern in path -> return as-is...
if(path.indexOf('*') < 0){
return [ path ]
}
// get the tail...
var tail = path.split(/\*/g).pop()
tail = tail == path ? '' : tail
var pattern = RegExp('^'
+normalizePath(path)
// quote regexp chars...
.replace(/([\.\\\/\(\)\[\]\$\+\-\{\}\@\^\&\?\<\>])/g, '\\$1')
// convert '*' and '**' to regexp...
.replace(/\*\*/g, '.*')
.replace(/^\*|([^.])\*/g, '$1[^\\/]*')
+'$')
var data = this.__wiki_data
return Object.keys(data)
// XXX is this correct???
.concat(Object.keys(data.__proto__)
// do not repeat overloaded stuff...
.filter(function(e){ return !data.hasOwnProperty(e) }))
.map(function(p){ return tail != '' ?
normalizePath(p +'/'+ tail)
: p })
.filter(function(p){ return pattern.test(p) })
},
// current location...
get location(){
return this.__location || this.__home_page__ },
set location(value){
delete this.__order
delete this.__order_by
this.__location = this.resolvePathVars(this.resolveDotPath(value))
},
get data(){
return this.__wiki_data[this.acquire()] },
// XXX experimental...
get config(){
try{
return JSON.parse(this.get(this.__config_page__).code) || {}
} catch(err){
console.error('CONFIG:', err)
return {}
}
},
clone: function(){
var o = Object.create(Wiki)
o.location = this.location
//o.__location_at = this.__location_at
// XXX
o.__parent = this
return o
},
end: function(){
return this.__parent || this },
// page path...
//
// Format:
// /
//
// NOTE: changing this will move the page to the new path and change
// .location acordingly...
// NOTE: same applies to path parts below...
// NOTE: changing path will update all the links to the moving page.
// NOTE: if a link can't be updated without a conflit then it is left
// unchanged, and a redirect page will be created.
get path(){
return (this.__order || this.resolveStarPath(this.location))[this.at()] },
// XXX should link updating be part of this???
// XXX use a template for the redirect page...
// XXX need to skip explicit '.' and '..' paths...
set path(value){
value = this.resolvePathVars(this.resolveDotPath(value))
var l = this.location
if(value == l || value == ''){
return
}
// old...
var otitle = this.title
var odir = this.dir
if(this.exists(l)){
this.__wiki_data[value] = this.__wiki_data[l]
}
this.location = value
// new...
var ntitle = this.title
var ndir = this.dir
var redirect = false
// update links to this page...
this.pages(function(page){
//this.get('**').map(function(page){
// skip the old page...
if(page.location == l){
return
}
page.raw = page.raw.replace(page.__wiki_link__, function(lnk){
var from = lnk[0] == '[' ? lnk.slice(1, -1) : lnk
// get path/title...
var p = path2lst(from)
var t = p.pop()
p = normalizePath(p)
var target = page.get(p).acquire('./'+t)
// page target changed...
// NOTE: this can happen either when a link was an orphan
// or if the new page path shadowed the original
// target...
// XXX should we report the exact condition here???
if(target == value){
console.log('Link target changed:', lnk, '->', value)
return lnk
// skip links that do not resolve to target...
} else if(page.get(p).acquire('./'+t) != l){
return lnk
}
// format the new link...
var to = p == '' ? ntitle : p +'/'+ ntitle
to = lnk[0] == '[' ? '['+to+']' : to
// explicit link change -- replace...
if(from == l){
//console.log(lnk, '->', to)
return to
// path did not change -- change the title...
} else if(ndir == odir){
// conflict: the new link will not resolve to the
// target page...
if(page.get(p).acquire('./'+ntitle) != value){
console.log('ERR:', lnk, '->', to,
'is shadowed by:', page.get(p).acquire('./'+ntitle))
// XXX should we add a note to the link???
redirect = true
// replace title...
} else {
//console.log(lnk, '->', to)
return to
}
// path changed -- keep link + add redirect page...
} else {
redirect = true
}
// no change...
return lnk
})
})
// redirect...
//
// XXX should we use a template here???
// ...might be a good idea to set a .redirect attr and either
// do an internal/transparent redirect or show a redirect
// template
// ...might also be good to add an option to fix the link from
// the redirect page...
if(redirect){
console.log('CREATING REDIRECT PAGE:', l, '->', value, '')
this.__wiki_data[l].raw = 'REDIRECT TO: ' + value
+' '
+' NOTE: This page was created when renaming the target '
+'page that resulted new link being broken (i.e. resolved '
+'to a different page from the target)'
this.__wiki_data[l].redirect = value
// cleaup...
} else {
delete this.__wiki_data[l]
}
},
// path parts: directory...
//
// NOTE: see .path for details...
get dir(){
return path2lst(this.path).slice(0, -1).join('/') },
set dir(value){
this.path = value +'/'+ this.title },
// path parts: title...
//
// NOTE: see .path for details...
get title(){
return path2lst(this.path).pop() },
set title(value){
if(value == '' || value == null){
return
}
this.path = this.dir +'/'+ value
},
// page content...
get raw(){
var data = this.data
data = data instanceof Function ? data.call(this, this) : data
return typeof(data) == typeof('str') ? data
: data != null && 'raw' in data ? data.raw
: data != null ? data.text
: ''
},
set raw(value){
var l = this.location
// prevent overwriting actions...
if(this.data instanceof Function){
return
}
this.__wiki_data[l] = this.__wiki_data[l] || {}
this.__wiki_data[l].text = value
// cache links...
delete this.__wiki_data[l].links
this.__wiki_data[l].links = this.links
},
get text(){
//return this.parse()
// special case: if we are getting ./raw then do not parse text...
return this.title == 'raw' ? this.raw
: this.__macro_parser__.parse(this, this.raw) },
get code(){
return this.text.html() },
// NOTE: this is set by setting .text
get links(){
var data = this.data || {}
var links = data.links = data.links
|| (this.raw.match(this.__wiki_link__) || [])
// unwrap explicit links...
.map(function(e){ return e[0] == '[' ? e.slice(1, -1) : e })
// unique...
.filter(function(e, i, l){ return l.slice(0, i).indexOf(e) == -1 })
return links
},
// navigation...
get parent(){
return this.get('..') },
get children(){
return this
.get('./*') },
get siblings(){
return this
.get('../*') },
// NOTE: .get() is not the same as .clone() in that .get() will resolve
// the path to a specific location while .clone() will keep
// everything as-is...
//
// XXX add prpper insyantiation ( .clone() )...
get: function(path){
//var o = Object.create(this)
var o = this.clone()
// NOTE: this is here to resolve path patterns...
o.location = this.path
o.location = path || this.path
return o
},
exists: function(path){
return normalizePath(path || this.path) in this.__wiki_data },
// get title from dir and then go up the tree...
//
// XXX should we also acquire each path part???
acquire: function(path, no_default){
var that = this
// handle paths and relative paths...
var p = this.get(path)
var title = p.title
path = path2lst(p.dir)
var acquire_from = this.__acquesition_order__ || []
var post_acquire_from = this.__post_acquesition_order__ || []
var data = this.__wiki_data
var _get = function(path, title, lst){
lst = (lst == null || lst.length == 0) ? [''] : lst
for(var i=0; i < lst.length; i++){
var p = path.concat([lst[i], title])
if(that.exists(p)){
p = normalizePath(p)
return that.__wiki_data[p] && p
}
}
}
while(true){
// get title from path...
var p = _get(path, title)
// get title from special paths in path...
|| _get(path, title, acquire_from)
if(p != null){
return p
}
if(path.length == 0){
break
}
path.pop()
}
// default paths...
var p = _get(path, title, post_acquire_from)
// system path...
|| this.__system__
&& _get([this.__system__], title)
// NOTE: this may be null...
return p
|| ((!no_default && title != this.__default_page__) ?
this.acquire('./'+this.__default_page__)
: null)
},
// iteration...
get length(){
return (this.__order || this.resolveStarPath(this.location)).length },
// get/srt postion in list of pages...
// XXX do we need to min/max normalize n??
at: function(n){
// get position...
if(n == null){
return this.__location_at || 0
}
var l = this.length
// end of list...
if(n >= l || n < -l){
return null
}
var res = this.clone()
if(this.__order){
res.__order = this.__order.slice()
}
n = n < 0 ? l - n : n
// XXX do we min/max n???
n = Math.max(n, 0)
n = Math.min(l-1, n)
res.__location_at = n
return res
},
prev: function(){
var i = this.at() - 1
// NOTE: need to guard against overflows...
return i >= 0 ? this.at(i) : null },
next: function(){
return this.at(this.at() + 1) },
map: function(func){
var res = []
for(var i=0; i < this.length; i++){
var page = this.at(i)
res.push(func.call(page, page, i))
}
return res
},
filter: function(func){
var res = []
for(var i=0; i < this.length; i++){
var page = this.at(i)
func.call(page, page, i) && res.push(page)
}
return res
},
forEach: function(func){
this.map(func)
return this
},
// sorting...
__default_sort_methods__: ['path'],
__sort_methods__: {
title: function(a, b){
return a.title < b.title ? -1
: a.title > b.title ? 1
: 0
},
path: function(a, b){
return a.path < b.path ? -1
: a.path > b.path ? 1
: 0
},
// XXX date, ...
},
// Sort siblings...
//
// Sort pages via default method
// .sort()
// -> page
//
// Sort pages via method
// .sort(method)
// -> page
//
// Sort pages via method1, then method2, ...
// .sort(method1, method2, ...)
// -> page
// NOTE: the next method is used iff the previous returns 0,
// i.e. the items are equal.
//
// NOTE: the sort is local to the returned object.
// NOTE: the sorted object may loose sync form the actual wiki as the
// list of siblings is cached.
// ...the resulting object is not to be stored for long.
sort: function(){
var that = this
var res = this.clone()
var path = res.path
var methods = [].slice.call(arguments)
res.__order_by = methods = methods.length == 0 ?
this.__default_sort_methods__
: methods
res.update()
return res
},
reverse: function(){
var res = this.clone()
res.__order_by = (this.__order_by || []).slice()
var i = res.__order_by.indexOf('reverse')
i >= 0 ?
res.__order_by.splice(i, 1)
: res.__order_by.push('reverse')
res.update()
return res
},
// XXX not sure if this is the way to go...
update: function(){
var that = this
if(this.__order || this.__order_by){
var path = this.path
var reverse = false
var methods = (this.__order_by || this.__default_sort_methods__)
.map(function(m){
if(m == 'reverse'){
reverse = !reverse
return null
}
return typeof(m) == typeof('str') ? that.__sort_methods__[m]
: m instanceof Function ? m
: null
})
.filter(function(m){ return !!m })
this.__order = this.resolveStarPath(this.location)
if(methods.length > 0){
var method = function(a, b){
for(var i=0; i < methods.length; i++){
var res = methods[i].call(that, a, b)
if(res != 0){
return res
}
}
return 0
}
this.__order = this.__order
.map(function(t){ return that.get(t) })
.sort(method)
.map(function(t){ return t.path })
}
reverse
&& this.__order.reverse()
this.__location_at = this.__order.indexOf(path)
}
return this
},
// serialization...
// XXX need to account for '*' and '**' in path...
// XXX
json: function(path){
return path == null ? JSON.parse(JSON.stringify(this.__wiki_data))
: path == '.' ? {
path: this.location,
text: this.raw,
}
: {
path: path,
text: (this.__wiki_data[path] || {}).raw,
}
},
// XXX should we inherit from the default???
load: function(json){
this.__wiki_data = json
},
// iteration...
// XXX this is not page specific, might need refactoring...
pages: function(callback){
var that = this
Object.keys(this.__wiki_data).forEach(function(location){
// XXX not sure if this is the right way to go...
//var o = Object.create(that)
var o = that.clone()
o.location = location
callback.call(o, o)
})
return this
},
}
/**********************************************************************
* vim:set ts=4 sw=4 : */