initial spike to show how KT-1565 might look for auto-escaping of HTML/XML/JSON/JDBC/URLs etc
This commit is contained in:
@@ -0,0 +1,64 @@
|
||||
package kotlin.template
|
||||
|
||||
import kotlin.dom.toXmlString
|
||||
import org.w3c.dom.Node
|
||||
|
||||
|
||||
/**
|
||||
* Creates a string template from a string with $ expressions inside using HTML escaping of expressions.
|
||||
*/
|
||||
// TODO varargs on constructors seems to fail
|
||||
//class HtmlTemplate(vararg val text: String) {
|
||||
class HtmlTemplate(val constantText : Array<String>) {
|
||||
|
||||
/**
|
||||
* Creates a builder of string expressions which use HTML encoding on expressions
|
||||
*/
|
||||
fun builder() : HtmlTemplateBuilder {
|
||||
// TODO we should allow the caller to pass these in when we create the builder!
|
||||
val options = HtmlTemplateOptions()
|
||||
return HtmlTemplateBuilder(constantText, options)
|
||||
}
|
||||
}
|
||||
|
||||
class HtmlTemplateOptions() {
|
||||
var nullText : String = ""
|
||||
}
|
||||
|
||||
open class HtmlTemplateBuilder(constantText : Array<String>, val options : HtmlTemplateOptions) : StringTemplateBuilder(constantText) {
|
||||
|
||||
override fun expression(expression : Any) : Unit {
|
||||
val text = if (expression != null) expression.toString() ?: "" else options.nullText
|
||||
escape(text)
|
||||
}
|
||||
|
||||
/**
|
||||
* Appends the DOM node, no HTML escaping is done as we assume its already escaped
|
||||
*/
|
||||
fun expression(node : Node) : Unit {
|
||||
// no need to escape
|
||||
unescape(node.toXmlString(false))
|
||||
}
|
||||
|
||||
/**
|
||||
* Appends the given text escaped properly
|
||||
*/
|
||||
fun escape(text : String): Unit {
|
||||
appendNextConstant()
|
||||
for (c in text) {
|
||||
if (c == '<') buffer.append("<")
|
||||
else if (c == '>') buffer.append(">")
|
||||
else if (c == '&') buffer.append("&")
|
||||
else if (c == '"') buffer.append(""")
|
||||
else buffer.append(c)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Appends the unescaped text
|
||||
*/
|
||||
fun unescape(text : String) {
|
||||
appendNextConstant()
|
||||
buffer.append(text)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,44 @@
|
||||
package kotlin.template
|
||||
|
||||
/**
|
||||
* Creates a string template from a string with $ expressions inside.
|
||||
*/
|
||||
// TODO varargs on constructors seems to fail
|
||||
//class StringTemplate(vararg val text: String) {
|
||||
open class StringTemplate(val constantText : Array<String>) {
|
||||
|
||||
/**
|
||||
* Creates a builder of string expressions
|
||||
*/
|
||||
open fun builder() : StringTemplateBuilder = StringTemplateBuilder(constantText)
|
||||
}
|
||||
|
||||
/**
|
||||
* Used to build strings using expressions
|
||||
*/
|
||||
open class StringTemplateBuilder(val constantText : Array<String>){
|
||||
protected val buffer: StringBuilder = StringBuilder()
|
||||
var index : Int = 0
|
||||
|
||||
fun build() : String {
|
||||
while (appendNextConstant()) {}
|
||||
return buffer.toString() ?: ""
|
||||
}
|
||||
|
||||
open fun expression(expression : Any) {
|
||||
appendNextConstant()
|
||||
buffer.append(expression)
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the next static text value from the template
|
||||
*/
|
||||
protected fun appendNextConstant(): Boolean {
|
||||
if (index < constantText.size) {
|
||||
buffer.append(constantText[index++])
|
||||
return true
|
||||
} else {
|
||||
return false
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user