Changeset 33045 for main/trunk/greenstone3/src/java/org/greenstone/gsdl3/util/GSXML.java

Timestamp:

2019-05-03T21:46:42+12:00 (5 years ago)

Author:

ak19

Message:

1. Dr Bainbridge's fix for the Windows encoding issue when online doc editing Title meta containing non-ASCII/non-basic unicode chars, was to URL encode the QUERY_STRING so that CGI.pm would then do the right thing. This was because the problem had turned out not to be env vars on Windows, which could set and recall unicode and win-1252 chars just fine and therefore retained what was entered. The problem was that on Windows, the perl did not get the actual chars transmitted in the case of UTF-8 whereas win-1252 was received looking apparently like a unicode codepoint, but then in the latter case the utf82unicode call in metadataaction would then clobber the codepoint in attempting to do utf82unicode on it. On linux, perl happened to receive the chars as utf8-encoded bytes and so utf82unicode worked (to make them unicode aware strings?). The real problem was that it could go wrong in different ways on windows, since utf8 chars weren't even received properly by perl/CGI, so we didn't even need to start worrying about them getting sometimes clobbered in metadataaction. URL encoding the QUERY_STRING was meant to solve this. Except that URL encoding the whole QUERY_STRING made CGI.pm choke on the equals signs between param name and param value and possibly other chars. I don't know why. I found that URL encoding just the param values in the QUERY_STRING works, so I am committing that. 2. Renaming the recently introduced string2hex() in JavaScript to debug_unicode_string and stringToHex() in Java to debugUnicodeString() to be more consistent with the perl variant, debug_unicode_string. Also like in the perl, the JavaScript and Java now print the unicode value inside curly braces for better legibility. 3. Leaving in some commented out encoding debugging statements in the Java and JavaScript code, but not committing the debugging on the perl side. 4. Some further improvements to overloaded functions in GSXML using debug_unicode_string for converting XML elements or printing them to logs.

File:

• main/trunk/greenstone3/src/java/org/greenstone/gsdl3/util/GSXML.java (modified) (3 diffs)

main/trunk/greenstone3/src/java/org/greenstone/gsdl3/util/GSXML.java

@@ -1624 +1624 @@
     }
 
-    public static void elementToLogAsString(Element e, boolean indent)
-    {
-        String str = elementToString(e, indent);
+    private static void elementToLogAsString(String prefix, Element e, boolean indent, boolean debugEncoding)
+    {
+        String str = prefix + "\n" + elementToString(e, indent, debugEncoding);
         System.err.println(str);
-        logger.error(str);
+        logger.info(str);
+    }
+    
+    // hex/unicode codepoint used only for those chars that are beyond printable/basic ASCII
+    public static void elementToLogAsUnicodeDebugString(String prefix, Element e, boolean indent)
+    {
+        elementToLogAsString(prefix, e, indent, true);
+    }
+    
+    public static void elementToLogAsString(String prefix, Element e, boolean indent)
+    {
+        elementToLogAsString(prefix, e, indent, false);
     }
 
     // pass in debugEncoding=true to investigate encoding issues. This function will then return non-basic ASCII characters in hex
-    public static String elementToString(Element e, boolean indent, boolean debugEncoding)
+    private static String elementToString(Element e, boolean indent, boolean debugEncoding)
     {
         String str = "";
@@ -1652 +1663 @@
             
             // if debugging encoding issues, then encode unicode code pts as hex for all but non-alphanumeric and space/tab/newline chars
-            if(debugEncoding) str = Misc.stringToHex(str);
+            if(debugEncoding) str = Misc.debugUnicodeString(str);
         }
         catch (Exception ex)
@@ -1667 +1678 @@
     {
         return elementToString(e, indent, false);
+    }
+    
+    // hex/unicode codepoint used only for those chars that are beyond printable/basic ASCII
+    public static String elementToUnicodeDebugString(Element e, boolean indent)
+    {
+        return elementToString(e, indent, true);
     }