Changeset 34241 for main

Timestamp:

2020-07-03T12:18:35+12:00 (4 years ago)

Author:

ak19

Message:

The previous commit fixed the issue where HTML in collection descriptions was not being preserved when GLI was not involved. This commit fixes the remaining problems with preserving HTML in coll descriptions when GLI is involved.

Location:

main/trunk/gli/src/org/greenstone/gatherer

Files:

• cdm/CollectionConfigXMLReadWrite.java (modified) (2 diffs)
• cdm/CollectionMeta.java (modified) (1 diff)
• cdm/GeneralManager.java (modified) (1 diff)
• util/Codec.java (modified) (2 diffs)
• util/XMLTools.java (modified) (1 diff)

main/trunk/gli/src/org/greenstone/gatherer/cdm/CollectionConfigXMLReadWrite.java

@@ -94 +94 @@
         {
             Element item = (Element) item_list.get(i);
-            String text = XMLTools.getNodeText(item);           
-
+            boolean isCollDescr = name_value.equals(StaticStrings.COLLECTIONMETADATA_COLLECTIONEXTRA_STR);
+
+            // Sadly, XMLTools.getNodeText(item) returns empty for any HTML in displayItem
+            // so we have to do it the hard way
+            String text = isCollDescr ? preserveHTMLInDescriptionDisplayItem(item)
+                : XMLTools.getNodeText(item); // else as before for all other displayItems
+
+            
             //If there is nothing to display, don't bother creating the element
             // Either lang or key should be set. If key set, no textnode.
@@ -2800 +2806 @@
     }
 
+    /**
+     * For now it only makes sends to allow a collection's about page description to contain HTML.
+     * Collection titles may go into a pre tag or text only context or into HTML headings,
+     * where preserving any HTML int coll title would become meaningless or even a hindrance.
+     * TODO: if users used HTML pre tags, they'll have wanted whitespace preserved.
+     * TODO There's probably a better way to do this, but I'm unable to think of it. Messy but works.
+     */
+    static private String preserveHTMLInDescriptionDisplayItem(Element collDescription) {
+    // First get the <displayItem> as text
+    String text = XMLTools.elementToString(collDescription, true);
+
+    // We only want the contents, not the xml processing instruction or the
+    // <displayItem></displayItem> or self-closing(!) <displayItem/> when no text for colldescr
+    // Remove xml processing instr too by removing <displayItem until first > after that
+    // this will also handle self-closing tag case
+    String lookFor = "<displayItem";
+    int start = text.indexOf(lookFor);
+    if(start != -1) {
+        start += lookFor.length();
+        start = text.indexOf(">", start);
+        text = text.substring(start+1).trim(); // trim to ensure no empty lines to deceive us
+        // especially after a self-closing tag
+    }
+
+    // If we have a positive number of lines remaining, it means it wasn't a self-closing
+    // tag. Remove the closing tag
+    String[] lines = text.split("\\r?\\n");
+    text = "";              
+    if(lines.length > 1) {
+        for (int j = 0; j < lines.length-1; j++) { // skip last line: closing tag
+        text += lines[j].trim() + "\n"; // Easiest solution:
+                                   // trim white space introduced by the one extra level of
+                                   // indentation intoduced when enclosing <dispItem> tags removed
+        }
+    }
+
+    text = text.replaceAll("&amp;", "&");// feels stupid, when we're going to change it back again soon
+               // but it's the last bit needed to get GLI to preserve html coll descriptions
+               // while displaying the html as html (without char entities) in the config file editor
+    
+    return text;//.trim(); // don't want trailing whitespace within displayItem
+    }
+    
     static public String generateStringVersion(Document doc)
     {

main/trunk/gli/src/org/greenstone/gatherer/cdm/CollectionMeta.java

@@ -162 +162 @@
      */
     public void setValue(String raw_value) {
+    setValue(raw_value, false);
+    }
+
+    public void setValue(String raw_value, boolean preserveTags) {
     // we need to check if the value has changed
     String current_value = XMLTools.getValue(element);
-    String new_value = Codec.transform(raw_value, Codec.TEXT_TO_DOM);
+    
+    String new_value = preserveTags ?
+        Codec.transform(raw_value, Codec.TEXT_TO_DOM_PRESERVE_TAGS)
+        : Codec.transform(raw_value, Codec.TEXT_TO_DOM);
     if (!current_value.equals(new_value)) {
-    // Only raw html text can be given to setValue so we need to encode it
+        // Only raw html text can be given to setValue so we need to encode it
         XMLTools.setValue(element, new_value);
         text = null; // Reset text

main/trunk/gli/src/org/greenstone/gatherer/cdm/GeneralManager.java

@@ -320 +320 @@
             if (!ready) return;
 
+        boolean preserveTags = true; // for coll description, allow HTML tags to be saved as HTML tags
         public_collectionmeta.setValue((public_checkbox.isSelected() ? StaticStrings.TRUE_STR : StaticStrings.FALSE_STR));
         String creator_email_str = creator_emailfield.getText();
         creator_collectionmeta.setValue(creator_email_str);
-        collection_extra_collectionmeta.setValue(description_textarea.getText());
+        collection_extra_collectionmeta.setValue(description_textarea.getText(), preserveTags);
         icon_collection_collectionmeta.setValue(icon_textfield.getText());
         maintainer_collectionmeta.setValue(maintainer_emailfield.getText());
         icon_collection_small_collectionmeta.setValue(small_icon_textfield.getText());
         collection_name_collectionmeta.setValue(name_textfield.getText());
-     
-    
+        
     }
 

main/trunk/gli/src/org/greenstone/gatherer/util/Codec.java

@@ -45 +45 @@
     static final public String GREENSTONE_TO_TEXT = "GREENSTONE_TO_TEXT";
     static final public String TEXT_TO_DOM = "TEXT_TO_DOM";
+    static final public String TEXT_TO_DOM_PRESERVE_TAGS = "TEXT_TO_DOM_PRESERVE_TAGS";
     static final public String TEXT_TO_GREENSTONE = "TEXT_TO_GREENSTONE";
     static final public String TEXT_TO_REGEXP = "TEXT_TO_REGEXP";
@@ -169 +170 @@
     TRANSFORMS.put(TEXT_TO_DOM, text_to_dom);
     text_to_dom = null;
+
+    // Same as above, but preserve html element tags
+    String[] text_to_dom_preserve_tags = {
+        "&", "&",
+        "\"", """,
+        "\'", "'"
+    };
+    TRANSFORMS.put(TEXT_TO_DOM_PRESERVE_TAGS, text_to_dom_preserve_tags);
+    text_to_dom_preserve_tags = null;
 
     // Unescape html (or xml) text

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

@@ -957 +957 @@
             // And close.
             os.close();
+
+            // Useful for debugging unescaped chars that may otherwise break stuff
+            // w = new StringWriter();
+            // // Generate a new serializer from the above.
+            // s = new XMLSerializer(w, f);
+            // s.asDOMSerializer();
+            // // Finally serialize the document to file.
+            // s.serialize(document);
+
+            // System.err.println("@@@@ XMLTools: wrote out to doc:\n" + w.toString());
+            
         }
         catch (Exception exception)