Changeset 9166

Timestamp:

2005-02-24T13:57:06+13:00 (19 years ago)

Author:

mdewsnip

Message:

More improvements to the GLI applet, by Matthew Whyte. Now only uploads source documents if the files or metadata has changed, and only downloads the doc.xml files rather than the whole archives directory.

Location:

trunk/gli/src/org/greenstone/gatherer

Files:

• GathererApplet.java (modified) (2 diffs)
• cdm/CollectionDesignManager.java (modified) (1 diff)
• collection/Collection.java (modified) (2 diffs)
• collection/CollectionManager.java (modified) (4 diffs)
• gui/CreatePane.java (modified) (1 diff)
• gui/EnrichPane.java (modified) (3 diffs)
• shell/GShell.java (modified) (6 diffs)
• util/Utility.java (modified) (12 diffs)

trunk/gli/src/org/greenstone/gatherer/GathererApplet.java

@@ -209 +209 @@
 
 
-    static public void download_url_zip(String col_name, String dir, GShell source)
+    static public void download_url_zip(String col_name, String dir, GShell source, String accept_expr, String reject_expr)
     {
     try {
@@ -219 +219 @@
         String dir_encoded = URLEncoder.encode(dir,"UTF-8");
         String cgi_args = "c=" + col_name_encoded;
-        cgi_args += "&dir=" + dir_encoded;
+        cgi_args += "&dir=" + dir_encoded + "&a=" + accept_expr + "&r=" + reject_expr;
 
         URL download_url = new URL(download_cgi);

trunk/gli/src/org/greenstone/gatherer/cdm/CollectionDesignManager.java

@@ -216 +216 @@
         if (formats_changed && Gatherer.c_man.built()) {
         // upload etc/collect.cfg to server to reflect changes
-        Utility.zipup(Gatherer.getCollectDirectoryPath(), collection_name, Utility.CONFIG_FILE, null);
+        Utility.zipup(Gatherer.getCollectDirectoryPath(), collection_name, Utility.CONFIG_FILE, null, "", "");
         GathererApplet.upload_url_zip(collection_name, "etc", null);
         }

trunk/gli/src/org/greenstone/gatherer/collection/Collection.java

@@ -67 +67 @@
     /** <i>true</i> if the currently loaded collection has been saved since the last significant change, <i>false</i> otherwise. */
     private boolean saved = false;
+    /*<i>true</i> if the currently loaded collection has had files added since its last build */
+    private boolean filesChanged = true;
+    /*<i>true</i> if the currently loaded collection has had metadata added since its last build */
+    private boolean metadataChanged = true;
     /** The document around which this collection class is based. */
     private Document document;
@@ -175 +179 @@
     return saved;
     }
-    
+
+    /** Determine if this collection has had its collection files changed since the last build.
+     * @return <i>true</i> if they have been saved, <i>false</i> otherwise.
+     */
+    public boolean getFilesChanged() {
+    return filesChanged;
+    }
+    
+    /** Set the flag that marks weather or not the files has been changed since the last build.
+    @param changed if files has been added/removed, as a <strong>boolean</strong>
+    */
+    public void setFilesChanged(boolean changed) {
+    filesChanged = changed;
+    }
+
+    /** Determine if this collection has had metadata changed since the last build.
+     * @return <i>true</i> if it has been changed, <i>false</i> otherwise.
+     */
+    public boolean getMetadataChanged() {
+    return metadataChanged;
+    }
+    
+    /** Set the flag that marks weather or not the metadata has been changed since the last build.
+    @param changed if metadata has been added/changed/removed, as a <strong>boolean</strong>
+    */
+    public void setMetadataChanged(boolean changed) {
+    metadataChanged = changed;
+    }
+
     /** Retrieve the title of this collection.
      * @return The title as a <strong>String</strong>.

trunk/gli/src/org/greenstone/gatherer/collection/CollectionManager.java

@@ -1064 +1064 @@
         JOptionPane.showMessageDialog(Gatherer.g_man, Dictionary.get("CollectionManager.Preview_Ready_Failed"), Dictionary.get("CollectionManager.Preview_Ready_Title"), JOptionPane.ERROR_MESSAGE);
         Gatherer.refresh(Gatherer.COLLECTION_REBUILT);
+        DebugStream.println("Status is ok but !installCollection()");
         }
     }
@@ -1491 +1492 @@
         if(collection != null) {
         collection.setSaved(false);
+        collection.setFilesChanged(true);
         }
     }
@@ -1499 +1501 @@
         if(collection != null) {
         collection.setSaved(false);
+        collection.setFilesChanged(true);
         }
     }
@@ -1507 +1510 @@
         if(collection != null) {
         collection.setSaved(false);
+        collection.setFilesChanged(true);
+
         }
     }

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

@@ -643 +643 @@
      */
     public void actionPerformed(ActionEvent event) {
-        build_button.setEnabled(true);
+        build_button.setEnabled(false);
         cancel_button.setEnabled(false);
         preview_button.setEnabled(false);
 
-        simple_build_button.setEnabled(true);
+        simple_build_button.setEnabled(false);
         simple_cancel_button.setEnabled(false);
         simple_preview_button.setEnabled(false);

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

@@ -186 +186 @@
     // Add button pressed
     if (esrc == add) {
+        Gatherer.c_man.getCollection().setMetadataChanged(true);
         MetadataElement metadata_element = metadata_value_table.getSelectedMetadataElement();
         MetadataValueTreeNode metadata_value_tree_node = metadata_element.addMetadataValue(metadata_value_tree.getSelectedValue());
@@ -195 +196 @@
     // Replace button pressed
     else if (esrc == update) {
+        Gatherer.c_man.getCollection().setMetadataChanged(true);
         MetadataElement metadata_element = metadata_value_table.getSelectedMetadataElement();
         MetadataValueTreeNode metadata_value_tree_node = metadata_element.addMetadataValue(metadata_value_tree.getSelectedValue());
@@ -204 +206 @@
     // Remove button pressed
     else if (esrc == remove) {
+        Gatherer.c_man.getCollection().setMetadataChanged(true);
         (new RemoveMetadataTask()).start();
     }

trunk/gli/src/org/greenstone/gatherer/shell/GShell.java

@@ -241 +241 @@
         String collect_directory_path = Gatherer.getCollectDirectoryPath();
         
-        // zip up import folder
-        Utility.zipup(collect_directory_path, col_name, "import", this);
-
-        if(hasSignalledStop()) { return; }
-        // upload it to gsdl server
-        GathererApplet.upload_url_zip(col_name, "import", this);
-
+        //Only upload the import directory if the files or metadata has changed.
+        System.err.println("getFilesChanged(): " + Gatherer.c_man.getCollection().getFilesChanged());
+        System.err.println("getMetadataChanged(): " + Gatherer.c_man.getCollection().getMetadataChanged());
+        if(Gatherer.c_man.getCollection().getFilesChanged() || Gatherer.c_man.getCollection().getMetadataChanged()) {
+            // zip up import folder
+            Utility.zipup(collect_directory_path, col_name, "import", this, "", "");
+            System.err.println("collect_directory_path: " + collect_directory_path);
+            System.err.println("col_name: " + col_name);
+
+            if(hasSignalledStop()) { return; }
+            // upload it to gsdl server
+            GathererApplet.upload_url_zip(col_name, "import", this);
+
+            Gatherer.c_man.getCollection().setFilesChanged(false);
+            Gatherer.c_man.getCollection().setMetadataChanged(false);
+        }
+        
         if(hasSignalledStop()) { return; }
         // upload etc folder to server (need collect.cfg and any hfiles)
-        Utility.zipup(collect_directory_path, col_name, "etc", this);
+        Utility.zipup(collect_directory_path, col_name, "etc", this, "", "");
 
         if(hasSignalledStop()) { return; }
@@ -260 +270 @@
             // upload images/ directory to server
             if(hasSignalledStop()) { return; }
-            Utility.zipup(collect_directory_path, col_name, "images", this);
+            Utility.zipup(collect_directory_path, col_name, "images", this, "", "");
 
             if(hasSignalledStop()) { return; }
@@ -354 +364 @@
             fireMessage(type, typeAsString(type) + "> " + line, status, bos);
         }
-        System.err.println("Wants to stop (1)."); 
+        //System.err.println("Wants to stop (1)."); //debug --Matthew 
         }
         stdbr.close();
@@ -533 +543 @@
         if (type == NEW) {
         if (Gatherer.isGsdlRemote) {
-            GathererApplet.download_url_zip(col_name, ".", this);
+            GathererApplet.download_url_zip(col_name, ".", this, "", "");
             if (!hasSignalledStop()) {
             Utility.unzip(Gatherer.getCollectDirectoryPath(), col_name);
@@ -549 +559 @@
 
             Utility.delete(Gatherer.c_man.getCollectionArchivesDirectoryPath()); // remove current archives
-            GathererApplet.download_url_zip(col_name, "archives", this);
-               if (!hasSignalledStop()) {
-               Utility.unzip(Gatherer.getCollectDirectoryPath(), col_name);
-               }
-               if (progress!=null) {
-               progress.messageOnProgressBar("");
-               }      
+            //new File(Gatherer.c_man.getCollectionArchivesDirectoryPath()).mkdir(); //Make a clean dir
+            GathererApplet.download_url_zip(col_name, "archives", this, ".*doc\\.xml", "");
+            if (hasSignalledStop()) {
+            // Clean up, then exit
+            fireProcessComplete(type, status);
+            // Close bos
+            if(bos != null) {
+                try {
+                bos.close();
+                bos = null;
+                }
+                catch(Exception error) {
+                DebugStream.printStackTrace(error);
+                }
+            }
+            return;
+            }
+            Utility.unzip(Gatherer.getCollectDirectoryPath(), col_name);
+            
+            if (progress!=null) {
+            progress.messageOnProgressBar("");
+            }      
         }
 
@@ -574 +599 @@
             File buildDir = new File(Gatherer.c_man.getCollectionBuildingDirectoryPath());
             Utility.delete(buildDir); // remove current build dir
-            buildDir.mkdir(); //Make a clean dir
-            GathererApplet.download_url_zip(col_name, "building/build.cfg", this); //Only need build.cfg
+            //buildDir.mkdir(); //Make a clean dir
+            GathererApplet.download_url_zip(col_name, "building/build.cfg", this, "", ""); //Only need build.cfg
+            //Maybe change to GathererApplet.download_url_zip(col_name, "building", this, "build.cfg")
             if (!hasSignalledStop()) {
             Utility.unzip(Gatherer.getCollectDirectoryPath(), col_name);

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

@@ -602 +602 @@
     }
 
-    static protected void zipFunc (ZipOutputStream zos, String file_path, int prefix_strip, GShell source) 
-    {
+    /*
+      Method to handle zipping up of a file. Called by zipup and dirFunc.
+
+      @param zos the zip output stream, as a <strong>ZipOutputStream</strong>
+      @param file_path the <strong>String</strong> containing the path to the file/directory tozip up
+      @param prefix_strip the <strong>int</strong> used to substring the file_path
+      @param source the <strong>GShell</strong> that is calling this method, so that we can check to see if the process has been cancelled. null if GShell is not the calling object.
+      @param accept_expr a <strong>String</strong> containing a regular expression of files to include in the archive. All other files will be excluded.
+      @param reject_expr a <strong>String</strong> containing a regular expression of files not to include in the archive.
+
+      @return boolean
+
+      @see dirFunc
+      @see zipup
+     */
+    static protected boolean zipFunc (ZipOutputStream zos, String file_path, int prefix_strip, GShell source, boolean encountered_file, String accept_expr, String reject_expr) 
+    {
+    
+    if((reject_expr != "") && (file_path.matches(reject_expr))) {
+        // matches reject expression
+        DebugStream.println("File \'" + file_path + "\' matches the reject expression \'" + reject_expr + "\'");
+        return encountered_file;
+    }
+
+    if ((accept_expr != "") && (!file_path.matches(accept_expr))) {
+        // does not match accept expression
+        DebugStream.println("File \'" + file_path + "\' doesn't match accept expression \'" + accept_expr + "\'");
+        return encountered_file;
+    }
+
     // Using try is required because of file io.
     try {
         // Exit if pressed cancel.
         if (source != null && source.hasSignalledStop()) {
-        return;
-        }
+        return false;
+        }
+
         // Create a Zip Entry and put it into the archive (no data yet).
 
@@ -616 +645 @@
         // Zip files use '/' for directory separator
         String unix_style_path = unixStylePath(zip_path);
+
         ZipEntry fileEntry = new ZipEntry(unix_style_path);
         zos.putNextEntry(fileEntry);
@@ -637 +667 @@
         zos.write(data, 0, byteCount);
         }
+        encountered_file = true;
     } 
     catch (IOException e) {
@@ -642 +673 @@
     }
     
-    DebugStream.println("    Zipping up: " + file_path);
-    }
-
-    static protected void dirFunc (ZipOutputStream zos, String dir_name, int prefix_strip, GShell source) 
-    {
+    DebugStream.println("Zipping up: " + file_path);
+    return encountered_file;
+    }
+
+    /*
+      Method to handle ziping up of a directory.
+
+      @param zos
+      @param dir_name
+      @param prefix_strip
+      @param source
+      @param encountered_file ??What's this??
+      @param accept_expr
+      @param reject_expr
+
+      @see zipup
+      @see zipFunc
+     */
+    static protected boolean dirFunc (ZipOutputStream zos, String dir_name, int prefix_strip, GShell source, boolean encountered_file, String accept_expr, String reject_expr) 
+    {
+    /*
+    if (reject_expr != "" && (dir_name.matches(reject_expr))) {
+        // matches reject expression
+        System.err.println("matches reject expression");
+        return encountered_file;
+    }
+    
+    if ((accept_expr != "") && (!dir_name.matches(accept_expr))) {
+        // does not match accept expression
+        System.err.println("doesn't match accept expression");
+        return encountered_file;
+    }
+    */
+
     File dirObj = new File(dir_name);
 
@@ -656 +716 @@
         // Loop through File array and display.
         for (int i = 0; i < fileList.length; i++) {
-            if(source != null) {
-            if(source.hasSignalledStop()) {
-                break;
-            }
-            }
+            if(source != null && source.hasSignalledStop()) { break; }
             File file = fileList[i];
             if (file.isDirectory()) {
@@ -677 +733 @@
             }
 
-            dirFunc(zos,dir_path,prefix_strip, source);
+            encountered_file = dirFunc(zos, dir_path, prefix_strip, source, encountered_file, accept_expr, reject_expr);
             } else if (file.isFile()) {
             // Call the zipFunc function
             String file_path = fileList[i].getPath();
-            zipFunc(zos,file_path,prefix_strip, source);
+            encountered_file = zipFunc(zos,file_path,prefix_strip, source, encountered_file, accept_expr, reject_expr);
             }
-        } 
+        }
         } 
         else { 
@@ -692 +748 @@
         System.err.println ("Directory "+dir_name+" does not exist."); 
     }
+    return encountered_file;
     }
     
-
-
-    static public void zipup(String col_dir, String col_name, String dir_or_file, GShell source)
+    /**
+      Method to zip up a given file or directory
+
+      @param col_dir
+      @param col_name
+      @param dir_or_file
+      @param source
+      @param filter
+
+      @see zipFunc
+      @see dirFunc
+     */
+    static public boolean zipup(String col_dir, String col_name, String dir_or_file, GShell source, String accept_expr, String reject_expr)
     {
     int prefix_strip = col_dir.length();
+    boolean encountered_file = false;
 
     String zip_fname = col_dir + col_name + ".zip";
@@ -711 +779 @@
         if (zip_dof.isDirectory()) {
             String zip_dir = zip_dir_or_file;
-            dirFunc(zos,zip_dir,prefix_strip, source);
+            encountered_file = dirFunc(zos, zip_dir, prefix_strip, source, encountered_file, accept_expr, reject_expr);
         }
         else {
@@ -730 +798 @@
             }
             }
-            zipFunc(zos,zip_full_file,prefix_strip, source);
+            encountered_file = zipFunc(zos, zip_full_file, prefix_strip, source, encountered_file, accept_expr, reject_expr);
         }
         }
@@ -744 +812 @@
     catch (IOException exception) {
         DebugStream.printStackTrace(exception);
-    }
+        return false;
+    }
+    return encountered_file;
     } 
     
@@ -760 +830 @@
         ZipEntry zipentry = (ZipEntry) e.nextElement();
         String zentryname = col_dir + zipentry.getName();
+        File file = new File(zentryname);
         DebugStream.println("    Unzipping: " + zentryname);
 
@@ -771 +842 @@
         else {
             // Write out file to disk
+
+            //Make sure it's parent directory exists.
+            File dir = new File(file.getParent());
+            dir.mkdirs();
 
             // set up input stream