# HG changeset patch # User Kim Alvefur # Date 1557989141 -7200 # Node ID 1921ae4449b8162caada8ecb73e127be6a04a6a0 # Parent da7ec4ed6ddf6d3aa723f9d71f7a2a311291bb97 mod_conversejs: Separate out templates into separate configurable files (breaks 0.9 compat) diff -r da7ec4ed6ddf -r 1921ae4449b8 mod_conversejs/README.markdown --- a/mod_conversejs/README.markdown Thu May 16 07:46:05 2019 +0200 +++ b/mod_conversejs/README.markdown Thu May 16 08:45:41 2019 +0200 @@ -48,6 +48,21 @@ `/conversejs`. More details on configuring HTTP modules in Prosody can be found in our [HTTP documentation](http://prosody.im/doc/http). +## Templates + +The HTML and JS can be customized either by editing the included +`template.html` and `template.js` files or configuring your own like: + +```lua +conversejs_html_template = "/path/to/my-template.html" +conversejs_js_template = "/path/to/my-template.js" +``` + +The HTML template uses Prosodys +[`util.interpolation`][doc:developers:util:interpolation] template +library while the JS template has `%s` where generated settings are +injected. + Other ----- @@ -119,4 +134,9 @@ Compatibility ============= -Should work with Prosody 0.9 and later. Websocket support requires 0.10. + Prosody version state + ----------------- --------------- + 0.9 Does not work + 0.10 Should work + 0.11 Should work + trunk Works diff -r da7ec4ed6ddf -r 1921ae4449b8 mod_conversejs/mod_conversejs.lua --- a/mod_conversejs/mod_conversejs.lua Thu May 16 07:46:05 2019 +0200 +++ b/mod_conversejs/mod_conversejs.lua Thu May 16 08:45:41 2019 +0200 @@ -2,6 +2,8 @@ -- Copyright (C) 2017 Kim Alvefur local json_encode = require"util.json".encode; +local xml_escape = require "util.stanza".xml_escape; +local render = require "util.interpolation".new("%b{}", xml_escape, { json = json_encode }); module:depends"http"; @@ -24,50 +26,38 @@ local js_url = module:get_option_string("conversejs_script", cdn_url..version.."/dist/converse.min.js"); local css_url = module:get_option_string("conversejs_css", cdn_url..version.."/css/converse.min.css"); -local html_template = ([[ - - - - - - -Prosody IM and Converse.js - - - - - - -]]):gsub("$([%w_]+)", { js_url = js_url, css_url = css_url }); +local html_template; -js_template = [[ -if(typeof converse == 'undefined') { - var div = document.createElement("div"); - var noscript = document.getElementsByTagName("noscript")[0]; - div.innerHTML = noscript.innerText; - document.body.appendChild(div); -} else { - converse.initialize(%s); -} -]]; +do + local template_filename = module:get_option_string(module.name .. "_html_template", "template.html"); + local template_file, err = module:load_resource(template_filename); + if template_file then + html_template, err = template_file:read("*a"); + template_file:close(); + end + if not html_template then + module:log("error", "Error loading HTML template: %s", err); + html_template = render("

mod_{module} could not read the template

\ +

Tried to open {filename}

\ + 
{error}
", + { module = module.name, filename = template_filename, error = err }); + end +end + +local js_template; +do + local template_filename = module:get_option_string(module.name .. "_js_template", "template.js"); + local template_file, err = module:load_resource(template_filename); + if template_file then + js_template, err = template_file:read("*a"); + template_file:close(); + end + if not js_template then + module:log("error", "Error loading JS template: %s", err); + js_template = render("console.log(\"mod_{module} could not read the JS template: %s\", {error|json})", + { module = module.name, filename = template_filename, error = err }); + end +end local user_options = module:get_option("conversejs_options"); @@ -93,15 +83,7 @@ return converse_options; end -local add_tags = module:get_option_set("conversejs_tags"); - -if add_tags then - local tags = {}; - for tag in add_tags do - table.insert(tags, tag); - end - html_template = html_template:gsub("", table.concat(tags, "\n"):gsub("%%", "%%").."\n"); -end +local add_tags = module:get_option_array("conversejs_tags", {}); module:provides("http", { title = "Converse.js"; @@ -110,7 +92,15 @@ local converse_options = get_converse_options(); event.response.headers.content_type = "text/html"; - return html_template:format(js_template:format(json_encode(converse_options))); + return render(html_template, { + header_scripts = { js_url }; + header_style = { css_url }; + header_tags = add_tags; + conversejs = { + options = converse_options; + startup = { script = js_template:format(json_encode(converse_options)); } + }; + }); end; ["GET /prosody-converse.js"] = function (event) diff -r da7ec4ed6ddf -r 1921ae4449b8 mod_conversejs/template.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mod_conversejs/template.html Thu May 16 08:45:41 2019 +0200 @@ -0,0 +1,35 @@ + + + + +{header_style# +} +{header_scripts# +} +Prosody IM and Converse.js +{header_tags# +{item!}} + + + + + + diff -r da7ec4ed6ddf -r 1921ae4449b8 mod_conversejs/template.js --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mod_conversejs/template.js Thu May 16 08:45:41 2019 +0200 @@ -0,0 +1,8 @@ +if(typeof converse == 'undefined') { + var div = document.createElement("div"); + var noscript = document.getElementsByTagName("noscript")[0]; + div.innerHTML = noscript.innerText; + document.body.appendChild(div); +} else { + converse.initialize(%s); +}