Changeset 8695

Timestamp:

2004-11-29T17:08:52+13:00 (19 years ago)

Author:

mdewsnip

Message:

Now remove invalid characters from metadata values when they are entered. This prevents the problem of writing out XML files with invalid characters, which are barfed on when reading them back in.

Location:

trunk/gli/src/org/greenstone/gatherer

Files:

• gui/EnrichPane.java (modified) (2 diffs)
• util/XMLTools.java (modified) (3 diffs)

trunk/gli/src/org/greenstone/gatherer/gui/EnrichPane.java

@@ -64 +64 @@
 import org.greenstone.gatherer.util.TreeSynchronizer;
 import org.greenstone.gatherer.util.Utility;
-
-
-/** Provides a view of controls for the editing of metadata. It makes use of several other important components such as a GTree, GTable and MetadataValueTree. While much of the gui content is left to these components, the EnrichPane is resposible for actioning metadata edit requests, listing for mouse clicks within its scope and other data functionality (such as providing a list of the selected files).
+import org.greenstone.gatherer.util.XMLTools;
+
+
+/** Provides a view of controls for the editing of metadata.
  */
 public class EnrichPane
@@ -1094 +1095 @@
     public String getSelectedValue()
     {
-        return metadata_value_text_field.getText().replaceAll("\\\\", MetadataValueTreeNode.METADATA_VALUE_TREE_NODE_HIERARCHY_TOKEN);
+        String metadata_value_raw = metadata_value_text_field.getText();
+        String metadata_value = XMLTools.removeInvalidCharacters(metadata_value_raw);
+        return metadata_value.replaceAll("\\\\", MetadataValueTreeNode.METADATA_VALUE_TREE_NODE_HIERARCHY_TOKEN);
     }
 

trunk/gli/src/org/greenstone/gatherer/util/XMLTools.java

@@ -96 +96 @@
     }
     return child;
-    }
-
-
-    /** Set the #text node value of some element.
-     * @param element the Element whose value we wish to set
-     * @param value the new value for the element as a String
-     * Soon to be deprecated!
-     */
-    static final public void setValue(Element element, String value) {
-    // Remove any existing child node(s)
-    clear(element);
-    // Add new text node.
-    if (value != null) {
-        element.appendChild(element.getOwnerDocument().createTextNode(value));
-    }
     }
 
@@ -136 +121 @@
     }
     catch (Exception exception) {
-        exception.printStackTrace();
+        DebugStream.printStackTrace(exception);
     }
 
     return document;
+    }
+
+
+    /** Removes characters that are invalid in XML (see http://www.w3.org/TR/2000/REC-xml-20001006#charsets) */
+    static public String removeInvalidCharacters(String text)
+    {
+    char[] safe_characters = new char[text.length()];
+    int j = 0;
+
+    char[] raw_characters = new char[text.length()];
+    text.getChars(0, text.length(), raw_characters, 0);
+    for (int i = 0; i < raw_characters.length; i++) {
+        char character = raw_characters[i];
+        if ((character >= 0x20 && character <= 0xD7FF) || character == 0x09 || character == 0x0A || character == 0x0D || (character >= 0xE000 && character <= 0xFFFD) || (character >= 0x10000 && character <= 0x10FFFF)) {
+        safe_characters[j] = character;
+        j++;
+        }
+    }
+
+    return new String(safe_characters, 0, j);
+    }
+
+
+    /** Set the #text node value of some element.
+     * @param element the Element whose value we wish to set
+     * @param value the new value for the element as a String
+     * Soon to be deprecated!
+     */
+    static final public void setValue(Element element, String value) {
+    // Remove any existing child node(s)
+    clear(element);
+    // Add new text node.
+    if (value != null) {
+        element.appendChild(element.getOwnerDocument().createTextNode(value));
+    }
     }
 
@@ -166 +186 @@
     }
     catch (Exception exception) {
-        exception.printStackTrace();
+        DebugStream.printStackTrace(exception);
     }
     }