Classic UI: escape HTML characters

[lolodomo]

Fix #3743

Signed-off-by: Laurent Garnier lg.hc@free.fr

[lolodomo]

For information, I was not able to fix the particular case of the selection element: when you open the sub-page to select amongs a list, if your label is defined as "TV <TV-ok>" in the sitemap mapping, only "TV" will be displayed.

[lolodomo]

As a side note, I replaced the code in escapeURLPath by the code from Basic UI. Using new URI(null, null, path, null).toString();was failing with the exception in cases where URLEncoder.encode(path, "UTF-8");is working. Of course, icons are still displayed correctly.

[lolodomo]

@resetnow : could you please review this PR ? The changes are more or less the same changes you already reviewed for Basic UI.

[vlad-ivanov-name]

The following testcase still demonstrates lack of escaping:

1. Add the following to the sitemap:

   Text item=DemoString label="Message [%s]" {
       Text item=DemoString label="Message [%s]"
   }
   

2. Open ClassicUI and navigate into "Message" frame
3. Type smarthome update DemoString "test <i>test</i>"
4. Page will update, and HTML tags in the frame header (at the top of the page) will not be escaped.

[lolodomo]

How do you enter a console command when you start OH from Eclipse ?

An alternative to test your case would be to define a rule.

[vlad-ivanov-name]

I think console for input is already allocated in the default run configuration, just paste the command where the output is.

[lolodomo]

I was not aware that it was possible ! But it works.I can confirm your test case.

[lolodomo]

@resetnow : what's wrong with that HTML code:
<title set="wa0201" style="">Message test &lt;i&gt;test&lt;/i&gt;</title>
The text betwen <i> and </i> appears in italic

[lolodomo]

Same problem with an hardcoded label in sitemap like this one:

Text label="Group <i>Demo</i>" icon="firstfloor" {
}

[lolodomo]

It seems to be exactly the same problem I found in the selection list and I was not able to fix it !
I hope you can tell me what's wrong with this HTML code and what to do to fix it.

[9037568]

I'm curious why you'd ask something to be rendered in italics and then be surprised when it's rendered in italics?

[lolodomo]

We just want to display the value of an item that can contain anything without any interpretation by the HTML browser. Italic was just an example but the problem is in fact with any XML tag.
I don"t understand why escaping is working everywhere except in the title tag. Probably something obvious but I am not a confirmed HTML developer.

[9037568]

Maybe this has a solution?

[lolodomo]

I will have to try how Basic UI handles that case. As the escaping code is the same in Basic UI and Classic UI, U would not understand why it us correct in Basic UI and not in Classic UI.

[vlad-ivanov-name]

One possible case is that the data transferred in a long-polling request are escaped only once. Since long-polling response is an XML document itself and "title" element doesn't have CDATA escaping, all the HTML entities are transformed back into their respective symbols once the document tree is parsed in broswer.  https://github.com/eclipse/smarthome/blob/067bd5122b4666452bda319cb4e1de13eda9ab00/extensions/ui/org.eclipse.smarthome.ui.classic/snippets/layer.html#L216:56

[lolodomo]

I just checked the layer.html in Basic UI and I can find this:
<title><![CDATA[ %label% ]]></title>
while in Classic UI:
<title set="wa%id%" style="%labelstyle%">%label%</title>
Il will try to add CDATA...

[lolodomo]

Problem with title is now fixed.

[vlad-ivanov-name]

LGTM

[sjsf]

Thank you all!