Changeset 7168

Timestamp:

Jun 8, 2016, 1:07:43 PM (7 years ago)

Author:

Nicklas Nordborg

Message:

Fixes #2017: Improve progress reporting in "Packed file exporter" plug-in

We can't send a progress reporter to the packer implementation without breaking the API. Instead we use the ProgressInputStream for wrapping the stream and reporting the progress at the same time as reading data from the source file.

Location:

trunk/src

Files:

• core/net/sf/basedb/util/ProgressInputStream.java (added)
• core/net/sf/basedb/util/Values.java (modified) (1 diff)
• plugins/core/net/sf/basedb/plugins/PackedFileExporter.java (modified) (4 diffs)

trunk/src/core/net/sf/basedb/util/Values.java

@@ -601 +601 @@
   }
 
-  private static final long GB = 1073741824;
-  private static final long MB = 1048576;
-  private static final long kB = 1024;
+  public static final long GB = 1073741824;
+  public static final long MB = 1048576;
+  public static final long kB = 1024;
   
   /**

trunk/src/plugins/core/net/sf/basedb/plugins/PackedFileExporter.java

@@ -42 +42 @@
 import net.sf.basedb.core.ProgressReporter;
 import net.sf.basedb.core.RequestInformation;
+import net.sf.basedb.core.SimpleAbsoluteProgressReporter;
 import net.sf.basedb.core.StringParameterType;
 import net.sf.basedb.core.Job.ExecutionTime;
@@ -56 +57 @@
 import net.sf.basedb.core.signal.SignalTarget;
 import net.sf.basedb.core.signal.ThreadSignalHandler;
+import net.sf.basedb.util.ChainedProgressReporter;
 import net.sf.basedb.util.FileUtil;
+import net.sf.basedb.util.ProgressInputStream;
 import net.sf.basedb.util.Values;
 import net.sf.basedb.util.zip.FilePacker;
@@ -357 +360 @@
     FilePacker packer = getPacker();
 
+    ChainedProgressReporter chained = null;
     if (progress != null)
     {
       progress.display(0, "Checking selected files and directories...");
+      chained = new ChainedProgressReporter(progress);
     }
     
@@ -414 +419 @@
             currentFile + " of " + numFiles + " file(s) (" +
             Values.formatBytes(completedBytes) + " of " + Values.formatBytes(totalBytes) + ")");
+          
+          if (in != null && size > Values.MB)
+          {
+            // Wrap in ProgressInputStream so we get progress reporting while the packer is working
+            chained.setRange(percent, (int)((size+completedBytes)*progressFactor));
+
+            // Progress message template '@' is replaced with actual bytes read
+            final String msgTemplate = 
+              "Compressing '" + entryPath + "' (@ of " + Values.formatBytes(size) + ")";
+            
+            in = new ProgressInputStream(in, new SimpleAbsoluteProgressReporter(chained, size))
+              {
+                @Override
+                protected void progressReport(String msg) 
+                {
+                  super.progressReport(msgTemplate.replace("@", msg));
+                }
+              };
+          }
         }