Changeset 23433 for main/trunk/gli/src/org/greenstone/gatherer/file/FileNode.java

Timestamp:

2010-12-09T22:27:33+13:00 (13 years ago)

Author:

ak19

Message:

GLI now has a gs.FilenameEncoding metadata field which appears like all the others in GLI's EnrichPane, but is unique in that this metadata (once set, changed or removed) must be applied to the affected filenames in the Collection Tree. More importantly, the changes made for this are to allow GLI's java code to interact with the recent changes to Perl where strings were made unicode-aware (for proper regex matching) but which required other changes elsewhere. To still support filenames with different encodings Perl used URL encoded versions of filenames representing characters' code point values in URL encoding. This required that GLI write out URL encoded filenames to the metadata.xml files that are associated with each folder level of a collection, so that Perl can read them. In this way, they can both speak of the same filenames. Only works on unicode 16 (such as latin-1), non-UTF8 systems. The latter is a requirement since Java uses the filesystem encoding from startup. If it is UTF8, non-recognised characters are replaced by the invalid char for UTF8. This process being destructive, we can't get the original filenames' bytecodes back. The changes made to GLI will work on Windows which is UTF-16 (windows codepage 1252), presumably also Macs (some kind of UTF-16) and also works on Native Latin 1 Linux systems. UTF-8 Linux systems need to be reconfigured to Native Latin-1, or if not installed, an administrator can install it easily.

File:

• main/trunk/gli/src/org/greenstone/gatherer/file/FileNode.java (modified) (4 diffs)

main/trunk/gli/src/org/greenstone/gatherer/file/FileNode.java

@@ -8 +8 @@
 import javax.swing.tree.*;
 import org.greenstone.gatherer.DebugStream;
+import org.greenstone.gatherer.metadata.FilenameEncoding;
 import org.greenstone.gatherer.util.ArrayTools;
 
@@ -19 +20 @@
     protected File file = null;
     protected FileSystemModel model = null;
-    protected MutableTreeNode parent = null;
+    protected MutableTreeNode parent = null;    
+
+    protected String urlEncodedFileName = "";
+    protected String urlEncodedFilePath = "";
+    protected String filenameEncoding = "";
     /** The string that is displayed as the filename. Attempts to be in the correct encoding. */
     protected String displayFileName = null;
-
+    
 
     public FileNode(File file)
     {
-    this.file = file;
-
-    // Files cannot have children
-    if (file != null && !file.isDirectory()) { //file.isFile()) {
-        // Cache this result to prevent unceasing missing disk messages being thrown if the
-        // removable media was, um, removed after directory mapped
-        this.allows_children = false;
-        displayFileName = calcDisplayString();
-    }   
-    }
-
-
-     /** This method returns a string representation of the filenodes in the Collection
-     * Tree, that can then be displayed in the tree. 
-     * We'll initially assume that the filenames are utf8 encoded and so convert the
-     * filename into utf8 for proper presentation in the Collection tree pane.
-     * If the filenames are not utf8, then the conversion would have introduced funny
-     * characters. Therefore, when converting to utf8, if the converted filename 
-     * contains the special character '\ufffd', then we know the conversion did not work
-     * and we return the original string which may or may not be properly presented by
-     * default.
-     * See http://java.sun.com/j2se/1.4.2/docs/api/java/nio/charset/CharsetDecoder.html
-     * which says "How a decoding error is handled depends upon the action requested for 
-     * that type of error, which is described by an instance of the CodingErrorAction class.
-     * The possible error actions are to ignore the erroneous input, report the error to
-     * the invoker via the returned CoderResult object, or replace the erroneous input with
-     * the current value of the replacement string. The replacement has the initial value 
-     * "\uFFFD"; its value may be changed via the replaceWith method."
-     * The following made me think that String(byte[], String charsetName) constructor may
-     * use the replacement value \uFFFD.
-     * http://www.experts-exchange.com/Programming/Programming_Languages/Java/Q_20512969.html
-     * mentions the following which made me think of this: 
-     * convertedStr = convertedStr.replace('\ufffd', ' ');
-     */
-    protected String calcDisplayString() {
-    String filename = file.getName();
-    try{
-        String utf8filename = new String(filename.getBytes(), "UTF8");
-        if(utf8filename.indexOf('\ufffd') == -1) {
-        return utf8filename;
-        } else { // contains the character indicating that it's invalid utf8
-        // return the original string
-        return filename;
-        }
-    } catch(java.io.UnsupportedEncodingException e) {
-        return filename;
-    }
+        this.file = file;
+
+        if (file != null) {
+            // Files cannot have children
+            if(file.isFile()) {
+                // Cache this result to prevent unceasing missing disk messages being thrown if the
+                // removable media was, um, removed after directory mapped
+                this.allows_children = false;
+            }
+            filenameEncoding = "";
+            urlEncodedFilePath = FilenameEncoding.calcURLEncodedFilePath(file);
+            urlEncodedFileName = FilenameEncoding.calcURLEncodedFileName(urlEncodedFilePath);
+
+            // work out the display string (extra special processing for CollectionTreeNodes)
+            displayFileName = calcDisplayString();      
+        }
+    }
+
+    public String getURLEncodedFileName() { return urlEncodedFileName; }
+
+    public String getURLEncodedFilePath() { return urlEncodedFilePath; }
+
+    public String getFilenameEncoding() { return filenameEncoding; }
+
+
+    /** This method returns a string representation of the filenodes in the tree, 
+    * that can then be displayed in the tree. Overridden in subclass CollectionTreeNode.
+    * Turn FilenameEncoding.DEBUGGING on to see URLEncoded filenames.
+    */
+    protected String calcDisplayString() {  
+        if(FilenameEncoding.DEBUGGING) {
+            return getURLEncodedFileName();
+        } else {
+            return file.getName();
+        }
     }
 
@@ -314 +307 @@
             }
         }
+        
+            // in case any filename encodings had gone stale, 
+            // (recalculate these and) refresh the display name
+            refreshDescendantEncodings();           
+                    
         }
 
@@ -327 +325 @@
     }
 
-
+    // overridden in subclass CollectionTreeNode to reset and reencode display strings
+    public void resetDescendantEncodings() {}
+    public void refreshDescendantEncodings() {}
+    
+    
     public void setModel(FileSystemModel model) {
     this.model = model;