[OFBIZ-6567] Wrong percent encoding in Webtool/SQL Processor

• Type: Bug
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: Release Branch 12.04, Release Branch 13.07, Release Branch 14.12, Trunk
• Fix Version/s: 14.12.01, 12.04.06, 13.07.03, 16.11.01
• Component/s: framework
• Assignee: Jacques Le Roux
• Reporter: Jacques Le Roux
• Created: 31/Jul/15 09:27
• Updated: 02/Aug/23 08:37
• Resolved: 31/Jul/15 13:50

Description

This was reported to me by Gareth Carter, the investigation is mine.

If for instance you use this SQL expression

select * from Party_Role where role_Type_Id LIKE  '%CA%'

It will be interpreted (and returned to UI) as

select * from Party_Role where role_Type_Id LIKE  'Ê%'

And no result will be returned when OOTB there is 6 <PartyRole partyId="***" roleTypeId="CARRIER"/> entities

This is because in UtilHttp.canonicalizeParameterMap() UtilHttp.canonicalizeParameter() is called. And inside the later UtilCodec.canonicalize() is used. So 2 ESAPI codecs are tested HTMLEntityCodec.decode() and PercentCodec.decode(). Only PercentCodec.decode() does a change so it's picked. In this case it should not, because nothing should be decoded. At this point, nothing has been encoded, the String the codec decodes is still "select * from Party_Role where role_Type_Id LIKE '%CA%'"

I read at https://en.wikipedia.org/wiki/Percent-encoding that though mostly planned for URL encoding percent encoding

is also used in the preparation of data of the application/x-www-form-urlencoded media type, as is often used in the submission of HTML form data in HTTP requests.

But in the specific case of a like in an SQL expression coming from the text area of webtools/control/EntitySQLProcessor it should not be used because the % followed by some chars, may be wrongly decoded.

Because there are no other ways provided by the percent codec to prevent the decoding (it's supposed to have been encoded before), I'm not quite proud of it but I found only this workaround so far

Index: framework/base/src/org/ofbiz/base/util/UtilCodec.java
===================================================================
--- framework/base/src/org/ofbiz/base/util/UtilCodec.java	(revision 1693397)
+++ framework/base/src/org/ofbiz/base/util/UtilCodec.java	(working copy)
@@ -164,16 +164,24 @@
             while (i.hasNext()) {
                 Codec codec = i.next();
                 String old = working;
-                working = codec.decode(working);
-                if (!old.equals(working)) {
-                    if (codecFound != null && codecFound != codec) {
-                        mixedCount++;
+                String upperWorking = working.toUpperCase();
+                if (codec instanceof PercentCodec
+                        && upperWorking.contains("WHERE")
+                        && upperWorking.contains("LIKE")
+                        && upperWorking.contains("%")) {
+                    continue;
+                } else {
+                    working = codec.decode(working);
+                    if (!old.equals(working)) {
+                        if (codecFound != null && codecFound != codec) {
+                            mixedCount++;
+                        }
+                        codecFound = codec;
+                        if (clean) {
+                            foundCount++;
+                        }
+                        clean = false;
                     }
-                    codecFound = codec;
-                    if (clean) {
-                        foundCount++;
-                    }
-                    clean = false;
                 }
             }
         }

Better ideas?