Re: svn commit: r921421 - /ofbiz/trunk/framework/example/config/ExampleUiLabels.xml

[Jacques Le Roux]

From: "Scott Gray" <[hidden email]>
On 10/03/2010, at 12:00 PM, Adam Heath wrote:

> Scott Gray wrote:
>> On 10/03/2010, at 11:39 AM, Adam Heath wrote:
>>
>>> Scott Gray wrote:
>>>> On 10/03/2010, at 11:03 AM, Adam Heath wrote:
>>>>
>>>>> Scott Gray wrote:
>>>>>> On 10/03/2010, at 10:35 AM, Adam Heath wrote:
>>>>>>
>>>>>>> Scott Gray wrote:
>>>>>>>> On 10/03/2010, at 9:48 AM, Adam Heath wrote:
>>>>>>>>
>>>>>>>>> [hidden email] wrote:
>>>>>>>>>> Author: jleroux
>>>>>>>>>> Date: Wed Mar 10 16:12:30 2010
>>>>>>>>>> New Revision: 921421
>>>>>>>>>>
>>>>>>>>>> URL: http://svn.apache.org/viewvc?rev=921421&view=rev
>>>>>>>>>> Log:
>>>>>>>>>> You can't use double quote in tooltips. I tried to find a quick way to allow this in MacroFormRenderer.appendTooltip()
>>>>>>>>>> but gave up, too narrow need.
>>>>>>>>>>
>>>>>>>>>> Modified:
>>>>>>>>>> ofbiz/trunk/framework/example/config/ExampleUiLabels.xml
>>>>>>>>>>
>>>>>>>>>> Modified: ofbiz/trunk/framework/example/config/ExampleUiLabels.xml
>>>>>>>>>> URL:
>>>>>>>>>> http://svn.apache.org/viewvc/ofbiz/trunk/framework/example/config/ExampleUiLabels.xml?rev=921421&r1=921420&r2=921421&view=diff
>>>>>>>>>> ==============================================================================
>>>>>>>>>> --- ofbiz/trunk/framework/example/config/ExampleUiLabels.xml (original)
>>>>>>>>>> +++ ofbiz/trunk/framework/example/config/ExampleUiLabels.xml Wed Mar 10 16:12:30 2010
>>>>>>>>>> @@ -97,7 +97,7 @@
>>>>>>>>>> </property>
>>>>>>>>>> <property key="ExampleDateField10Tooltip">
>>>>>>>>>>     <value xml:lang="en">Same as above, uses the nowTimestamp variable (always available in the form context) to set the
>>>>>>>>>> default value to now</value>
>>>>>>>>>> -        <value xml:lang="fr">La mÃfªme chose mais la variable nowTimestamp (toujours disponible dans context) est
>>>>>>>>>> utilisÃf©e pour affecter la valeur par dÃf©faut Ãf  "maintenant"</value>
>>>>>>>>>> +        <value xml:lang="fr">La mÃfªme chose mais la variable nowTimestamp (toujours disponible dans context) est
>>>>>>>>>> utilisÃf©e pour affecter la valeur par dÃf©faut Ãf  'maintenant'</value>
>>>>>>>>>>     <value xml:lang="it">Lo stesso di sopra, usare la variabile nowTimestamp (sempre disponibile nel contesto della form)
>>>>>>>>>> per impostare il valore di default ad adesso</value>
>>>>>>>>>>     <value xml:lang="zh">åÅ'上ï¼Å'使çâ?Â¨nowTimstampåËoéâ?¡Â(Ã¥Å"¨è¡¨åâ?¢Ã¤Â¸
>>>>>>>>>> æâ,¬Â»Ã¦Ëo¯å¯çâ?Â¨Ã§Å¡â?z)来把缺çÅ"åâ,¬Â¼Ã¨Â®Â¾Ã§Â½Â®Ã¤Â¸ÂºÃ§Å½Â°Ã¥Å"¨</value>
>>>>>>>>>> </property>
>>>>>>>>> tooltip.replaceAll("\"", "&quot;"), also handling any other weird html
>>>>>>>>> characters, like < or > or &.
>>>>>>>> It would probably be easiest to just encode the tooltip string before generating the macro call.  There are examples of
>>>>>>>> that all over.
>>>>>>>> tooltip = encode(tooltip, modelFormField, context);
>>>>>>> That's what I mean, I went and looked at the method he referenced, to
>>>>>>> know what the variable name was.
>>>>>>>
>>>>>>> I also looked at the macro files themselves, and they will work if
>>>>>>> passed this encoded string value.
>>>>>>>
>>>>>>> However, from a perfectionist standpoint, it doesn't sit well with me.
>>>>>>> What happens if these macros use a string from a map, that is already
>>>>>>> encoded, then try to double-encode it?
>>>>>> It shouldn't be encoded until it is about to be rendered, ModelFormField.getEntry(...) encodes early and it is a PITA.  A
>>>>>> late as possible encoding strategy is definitely the way to go.
>>>>>>
>>>>>>> Ideally, MacroFormRenderer is calling freemarker.  So it should use
>>>>>>> freemarker encodings of special characters.  Freemarker should then
>>>>>>> decode said special markup, so that the macros it ends up calling can
>>>>>>> do what they need for it.
>>>>>> Agreed, allowing freemarker to do the encoding would certainly be easier but until we get rid of ALL of the earlier encodings
>>>>>> we'll end up with double encoding.  Also any encoding that takes place outside of the renderer methods, like in
>>>>>> ModelFormField, requires us to update all the other form renderers before we can remove them.
>>>>> Finall output encoding is not the same as encoding when it leaves your
>>>>> control.
>>>>>
>>>>> A -> B -> C -> D
>>>>>
>>>>> A needs to encode it's output to get around any issues that B has.
>>>>> Then B needs decode it's input, and then encode it's output as it
>>>>> passes to C.  And so on, and so on.
>>>>>
>>>>> The real problem here is using strings to pass data around.  It should
>>>>> be passed as part of the context.
>>>> You've lost me, IMO each renderer should be responsible for handling the encoding required of the output it's generating.
>>>> Multiple encoding/decoding points just seems like it will add unnecessary complexity.
>>> Each stage of the rendering pipline needs to allow it's caller to
>>> encode things as input.  Then, the stage has to decode these incoming
>>> parameters for it's internal use, then encode them again for the next
>>> stage.
>>
>> Pipeline? What pipeline?  We only have two things, a model and a renderer.  The model should be concerned with encoding, it
>> should deal with raw unencoded strings.  The renderer should encode data just before it outputs it.
>>
>>> It's not just that each rendering stage has to encode for it's output.
>>> But the incoming has to be encoded to pass whatever requirements are
>>> nescessary for the stage.
>>
>> I still only consider there to be one stage: take the model and render it.  The model doesn't have any output, it's a model.
>
> There-in lies the problem.
>
> The model exists as plain objects.  But then MacroFormRender starts.
> This is stage one.  It has to encode for freemarker to be able to
> parse it.
>
> Stage two is when freemarker runs, and finally outputs html.
>
> Stage one is encoding the parameters as strings.  It needs to be able
> to allow freemarker to parse it, while getting the actual real value.
> Freemarker is xml-like, so xml encoding should be used.  Of course,
> not doing any encoding at all in stage one would be better.
>
> In stage two, freemarker will parse the raw text, converting it
> internally to objects in the macro call.  The final called macro has
> to then encode it properly for the final output, maybe html, maybe
> csv, maybe xml/pdf or something.

The only actual encoding required by freemarker is that we escape double quotes because we use them to enclose the parameters in the
macro calls and also backslashes.  There is no need to use xml encoding and no need to decode the escaping because freemarker does
that automatically.

From http://freemarker.sourceforge.net/docs/dgui_template_exp.html#dgui_template_exp_direct_string
"If the text itself contains the character used for the quoting (either " or ') or backslashes, you have to precede them with a
backslash; this is called escaping. You can type any other character, including line breaks, in the text directly."

Nice, but you will still get the distinguish issue... (around, inside: which ones to escape which not?). If we want to handle this
we need something more complex and that's why I gave up, because the need is not important (double quotes in tooltip...)

Maybe as Adam said it's deeper rooted and there is another solution in executeMacro. I did not investigate, looks like Adam is on
it...

Jacques

[Jacques Le Roux]

Done at r921643

Jacques

From: "Jacques Le Roux" <[hidden email]>

> From: "Scott Gray" <[hidden email]>
> On 10/03/2010, at 12:00 PM, Adam Heath wrote:
>
>> Scott Gray wrote:
>>> On 10/03/2010, at 11:39 AM, Adam Heath wrote:
>>>
>>>> Scott Gray wrote:
>>>>> On 10/03/2010, at 11:03 AM, Adam Heath wrote:
>>>>>
>>>>>> Scott Gray wrote:
>>>>>>> On 10/03/2010, at 10:35 AM, Adam Heath wrote:
>>>>>>>
>>>>>>>> Scott Gray wrote:
>>>>>>>>> On 10/03/2010, at 9:48 AM, Adam Heath wrote:
>>>>>>>>>
>>>>>>>>>> [hidden email] wrote:
>>>>>>>>>>> Author: jleroux
>>>>>>>>>>> Date: Wed Mar 10 16:12:30 2010
>>>>>>>>>>> New Revision: 921421
>>>>>>>>>>>
>>>>>>>>>>> URL: http://svn.apache.org/viewvc?rev=921421&view=rev
>>>>>>>>>>> Log:
>>>>>>>>>>> You can't use double quote in tooltips. I tried to find a quick way to allow this in MacroFormRenderer.appendTooltip()
>>>>>>>>>>> but gave up, too narrow need.
>>>>>>>>>>>
>>>>>>>>>>> Modified:
>>>>>>>>>>> ofbiz/trunk/framework/example/config/ExampleUiLabels.xml
>>>>>>>>>>>
>>>>>>>>>>> Modified: ofbiz/trunk/framework/example/config/ExampleUiLabels.xml
>>>>>>>>>>> URL:
>>>>>>>>>>> http://svn.apache.org/viewvc/ofbiz/trunk/framework/example/config/ExampleUiLabels.xml?rev=921421&r1=921420&r2=921421&view=diff
>>>>>>>>>>> ==============================================================================
>>>>>>>>>>> --- ofbiz/trunk/framework/example/config/ExampleUiLabels.xml (original)
>>>>>>>>>>> +++ ofbiz/trunk/framework/example/config/ExampleUiLabels.xml Wed Mar 10 16:12:30 2010
>>>>>>>>>>> @@ -97,7 +97,7 @@
>>>>>>>>>>> </property>
>>>>>>>>>>> <property key="ExampleDateField10Tooltip">
>>>>>>>>>>>     <value xml:lang="en">Same as above, uses the nowTimestamp variable (always available in the form context) to set the
>>>>>>>>>>> default value to now</value>
>>>>>>>>>>> -        <value xml:lang="fr">La mÃfªme chose mais la variable nowTimestamp (toujours disponible dans context) est
>>>>>>>>>>> utilisÃf©e pour affecter la valeur par dÃf©faut Ãf  "maintenant"</value>
>>>>>>>>>>> +        <value xml:lang="fr">La mÃfªme chose mais la variable nowTimestamp (toujours disponible dans context) est
>>>>>>>>>>> utilisÃf©e pour affecter la valeur par dÃf©faut Ãf  'maintenant'</value>
>>>>>>>>>>>     <value xml:lang="it">Lo stesso di sopra, usare la variabile nowTimestamp (sempre disponibile nel contesto della
>>>>>>>>>>> form) per impostare il valore di default ad adesso</value>
>>>>>>>>>>>     <value xml:lang="zh">åÅ'上ï¼Å'使çâ?Â¨nowTimstampåËoéâ?¡Â(Ã¥Å"¨è¡¨åâ?¢Ã¤Â¸
>>>>>>>>>>> æâ,¬Â»Ã¦Ëo¯å¯çâ?Â¨Ã§Å¡â?z)来把缺çÅ"åâ,¬Â¼Ã¨Â®Â¾Ã§Â½Â®Ã¤Â¸ÂºÃ§Å½Â°Ã¥Å"¨</value>
>>>>>>>>>>> </property>
>>>>>>>>>> tooltip.replaceAll("\"", "&quot;"), also handling any other weird html
>>>>>>>>>> characters, like < or > or &.
>>>>>>>>> It would probably be easiest to just encode the tooltip string before generating the macro call.  There are examples of
>>>>>>>>> that all over.
>>>>>>>>> tooltip = encode(tooltip, modelFormField, context);
>>>>>>>> That's what I mean, I went and looked at the method he referenced, to
>>>>>>>> know what the variable name was.
>>>>>>>>
>>>>>>>> I also looked at the macro files themselves, and they will work if
>>>>>>>> passed this encoded string value.
>>>>>>>>
>>>>>>>> However, from a perfectionist standpoint, it doesn't sit well with me.
>>>>>>>> What happens if these macros use a string from a map, that is already
>>>>>>>> encoded, then try to double-encode it?
>>>>>>> It shouldn't be encoded until it is about to be rendered, ModelFormField.getEntry(...) encodes early and it is a PITA.  A
>>>>>>> late as possible encoding strategy is definitely the way to go.
>>>>>>>
>>>>>>>> Ideally, MacroFormRenderer is calling freemarker.  So it should use
>>>>>>>> freemarker encodings of special characters.  Freemarker should then
>>>>>>>> decode said special markup, so that the macros it ends up calling can
>>>>>>>> do what they need for it.
>>>>>>> Agreed, allowing freemarker to do the encoding would certainly be easier but until we get rid of ALL of the earlier
>>>>>>> encodings we'll end up with double encoding.  Also any encoding that takes place outside of the renderer methods, like in
>>>>>>> ModelFormField, requires us to update all the other form renderers before we can remove them.
>>>>>> Finall output encoding is not the same as encoding when it leaves your
>>>>>> control.
>>>>>>
>>>>>> A -> B -> C -> D
>>>>>>
>>>>>> A needs to encode it's output to get around any issues that B has.
>>>>>> Then B needs decode it's input, and then encode it's output as it
>>>>>> passes to C.  And so on, and so on.
>>>>>>
>>>>>> The real problem here is using strings to pass data around.  It should
>>>>>> be passed as part of the context.
>>>>> You've lost me, IMO each renderer should be responsible for handling the encoding required of the output it's generating.
>>>>> Multiple encoding/decoding points just seems like it will add unnecessary complexity.
>>>> Each stage of the rendering pipline needs to allow it's caller to
>>>> encode things as input.  Then, the stage has to decode these incoming
>>>> parameters for it's internal use, then encode them again for the next
>>>> stage.
>>>
>>> Pipeline? What pipeline?  We only have two things, a model and a renderer.  The model should be concerned with encoding, it
>>> should deal with raw unencoded strings.  The renderer should encode data just before it outputs it.
>>>
>>>> It's not just that each rendering stage has to encode for it's output.
>>>> But the incoming has to be encoded to pass whatever requirements are
>>>> nescessary for the stage.
>>>
>>> I still only consider there to be one stage: take the model and render it.  The model doesn't have any output, it's a model.
>>
>> There-in lies the problem.
>>
>> The model exists as plain objects.  But then MacroFormRender starts.
>> This is stage one.  It has to encode for freemarker to be able to
>> parse it.
>>
>> Stage two is when freemarker runs, and finally outputs html.
>>
>> Stage one is encoding the parameters as strings.  It needs to be able
>> to allow freemarker to parse it, while getting the actual real value.
>> Freemarker is xml-like, so xml encoding should be used.  Of course,
>> not doing any encoding at all in stage one would be better.
>>
>> In stage two, freemarker will parse the raw text, converting it
>> internally to objects in the macro call.  The final called macro has
>> to then encode it properly for the final output, maybe html, maybe
>> csv, maybe xml/pdf or something.
>
> The only actual encoding required by freemarker is that we escape double quotes because we use them to enclose the parameters in
> the macro calls and also backslashes.  There is no need to use xml encoding and no need to decode the escaping because freemarker
> does that automatically.
>
>>From http://freemarker.sourceforge.net/docs/dgui_template_exp.html#dgui_template_exp_direct_string
> "If the text itself contains the character used for the quoting (either " or ') or backslashes, you have to precede them with a
> backslash; this is called escaping. You can type any other character, including line breaks, in the text directly."
>
> Nice, but you will still get the distinguish issue... (around, inside: which ones to escape which not?). If we want to handle this
> we need something more complex and that's why I gave up, because the need is not important (double quotes in tooltip...)
>
> Maybe as Adam said it's deeper rooted and there is another solution in executeMacro. I did not investigate, looks like Adam is on
> it...
>
> Jacques
>