ProgressListener is now a method arg (was an instance arg)

Author: Federico Fissore

app/src/cc/arduino/contributions/ContributionsSelfCheck.java

@@ -24,6 +24,7 @@ public class ContributionsSelfCheck extends TimerTask {
   private final ContributionInstaller contributionInstaller;
   private final LibrariesIndexer librariesIndexer;
   private final LibraryInstaller libraryInstaller;
+  private final ProgressListener progressListener;
 
   public ContributionsSelfCheck(Base base, HyperlinkListener hyperlinkListener, ContributionsIndexer contributionsIndexer, ContributionInstaller contributionInstaller, LibrariesIndexer librariesIndexer, LibraryInstaller libraryInstaller) {
     this.base = base;
@@ -32,6 +33,7 @@ public ContributionsSelfCheck(Base base, HyperlinkListener hyperlinkListener, Co
     this.contributionInstaller = contributionInstaller;
     this.librariesIndexer = librariesIndexer;
     this.libraryInstaller = libraryInstaller;
+    this.progressListener = new NoopProgressListener();
   }
 
   @Override
@@ -67,15 +69,15 @@ public void run() {
 
   private void updateLibrariesIndex() {
     try {
-      libraryInstaller.updateIndex();
+      libraryInstaller.updateIndex(progressListener);
     } catch (Exception e) {
       // ignore
     }
   }
 
   private void updateContributionIndex() {
     try {
-      contributionInstaller.updateIndex();
+      contributionInstaller.updateIndex(progressListener);
     } catch (Exception e) {
       // ignore
     }

app/src/cc/arduino/contributions/libraries/ui/LibraryManagerUI.java

@@ -183,12 +183,7 @@ public void setIndexer(LibrariesIndexer indexer) {
     filterField.setEnabled(contribModel.getRowCount() > 0);
 
     // Create LibrariesInstaller tied with the provided index
-    installer = new LibraryInstaller(indexer, platform) {
-      @Override
-      public void onProgress(Progress progress) {
-        setProgress(progress);
-      }
-    };
+    installer = new LibraryInstaller(indexer, platform);
   }
 
   public void selectDropdownItemByClassName(String dropdownItem) {
@@ -216,7 +211,7 @@ protected void onUpdatePressed() {
     installerThread = new Thread(() -> {
       try {
         setProgressVisible(true, "");
-        installer.updateIndex();
+        installer.updateIndex(this::setProgress);
         onIndexesUpdated();
       } catch (Exception e) {
         throw new RuntimeException(e);
@@ -233,7 +228,7 @@ public void onInstallPressed(final ContributedLibrary lib, final ContributedLibr
     installerThread = new Thread(() -> {
       try {
         setProgressVisible(true, tr("Installing..."));
-        installer.install(lib, replaced);
+        installer.install(lib, replaced, this::setProgress);
         onIndexesUpdated(); // TODO: Do a better job in refreshing only the needed element
         //getContribModel().updateLibrary(lib);
       } catch (Exception e) {
@@ -260,7 +255,7 @@ public void onRemovePressed(final ContributedLibrary lib) {
     installerThread = new Thread(() -> {
       try {
         setProgressVisible(true, tr("Removing..."));
-        installer.remove(lib);
+        installer.remove(lib, this::setProgress);
         onIndexesUpdated(); // TODO: Do a better job in refreshing only the needed element
         //getContribModel().updateLibrary(lib);
       } catch (Exception e) {

app/src/cc/arduino/contributions/packages/ui/ContributionManagerUI.java

@@ -118,7 +118,7 @@ public void setIndexer(ContributionsIndexer indexer) {
     }
 
     // Create ConstributionInstaller tied with the provided index
-    installer = new ContributionInstaller(indexer, platform, new GPGDetachedSignatureVerifier(), this::setProgress);
+    installer = new ContributionInstaller(indexer, platform, new GPGDetachedSignatureVerifier());
   }
 
   public void setProgress(Progress progress) {
@@ -146,7 +146,7 @@ public void onUpdatePressed() {
     installerThread = new Thread(() -> {
       try {
         setProgressVisible(true, "");
-        List<String> downloadedPackageIndexFiles = installer.updateIndex();
+        List<String> downloadedPackageIndexFiles = installer.updateIndex(this::setProgress);
         installer.deleteUnknownFiles(downloadedPackageIndexFiles);
         onIndexesUpdated();
       } catch (Exception e) {
@@ -165,7 +165,7 @@ public void onInstallPressed(final ContributedPlatform platformToInstall, final
       List<String> errors = new LinkedList<>();
       try {
         setProgressVisible(true, tr("Installing..."));
-        errors.addAll(installer.install(platformToInstall));
+        errors.addAll(installer.install(platformToInstall, this::setProgress));
         if (platformToRemove != null && !platformToRemove.isReadOnly()) {
           errors.addAll(installer.remove(platformToRemove));
         }

app/src/processing/app/Base.java

@@ -33,7 +33,6 @@
 import cc.arduino.contributions.packages.ui.ContributionManagerUI;
 import cc.arduino.files.DeleteFilesOnShutdown;
 import cc.arduino.packages.DiscoveryManager;
-import cc.arduino.utils.Progress;
 import cc.arduino.view.Event;
 import cc.arduino.view.JMenuUtils;
 import cc.arduino.view.SplashScreenHelper;
@@ -341,19 +340,10 @@ public Base(String[] args) throws Exception {
 
     if (parser.isInstallBoard()) {
       ContributionsIndexer indexer = new ContributionsIndexer(BaseNoGui.getSettingsFolder(), BaseNoGui.getPlatform(), new GPGDetachedSignatureVerifier());
-      ContributionInstaller installer = new ContributionInstaller(indexer, BaseNoGui.getPlatform(), new GPGDetachedSignatureVerifier(), new ProgressListener() {
-        private String lastStatus = "";
+      ProgressListener progressListener = new ConsoleProgressListener();
+      ContributionInstaller installer = new ContributionInstaller(indexer, BaseNoGui.getPlatform(), new GPGDetachedSignatureVerifier());
 
-        @Override
-        public void onProgress(Progress progress) {
-          if (!lastStatus.equals(progress.getStatus())) {
-            System.out.println(progress.getStatus());
-          }
-          lastStatus = progress.getStatus();
-        }
-      });
-
-      List<String> downloadedPackageIndexFiles = installer.updateIndex();
+      List<String> downloadedPackageIndexFiles = installer.updateIndex(progressListener);
       installer.deleteUnknownFiles(downloadedPackageIndexFiles);
       indexer.parseIndex();
       indexer.syncWithFilesystem(BaseNoGui.getHardwareFolder());
@@ -378,7 +368,7 @@ public void onProgress(Progress progress) {
       ContributedPlatform installed = indexer.getInstalled(boardToInstallParts[0], boardToInstallParts[1]);
 
       if (!selected.isReadOnly()) {
-        installer.install(selected);
+        installer.install(selected, progressListener);
       }
 
       if (installed != null && !installed.isReadOnly()) {
@@ -389,22 +379,13 @@ public void onProgress(Progress progress) {
 
     } else if (parser.isInstallLibrary()) {
       LibrariesIndexer indexer = new LibrariesIndexer(BaseNoGui.getSettingsFolder(), new ContributionsIndexer(BaseNoGui.getSettingsFolder(), BaseNoGui.getPlatform(), new GPGDetachedSignatureVerifier()));
-      LibraryInstaller installer = new LibraryInstaller(indexer, BaseNoGui.getPlatform()) {
-        private String lastStatus = "";
-
-        @Override
-        protected void onProgress(Progress progress) {
-          if (!lastStatus.equals(progress.getStatus())) {
-            System.out.println(progress.getStatus());
-          }
-          lastStatus = progress.getStatus();
-        }
-      };
+      ProgressListener progressListener = new ConsoleProgressListener();
+      LibraryInstaller installer = new LibraryInstaller(indexer, BaseNoGui.getPlatform());
       indexer.parseIndex();
       BaseNoGui.onBoardOrPortChange();
       indexer.setSketchbookLibrariesFolder(BaseNoGui.getSketchbookLibrariesFolder());
       indexer.setLibrariesFolders(BaseNoGui.getLibrariesPath());
-      installer.updateIndex();
+      installer.updateIndex(progressListener);
 
       for (String library : parser.getLibraryToInstall().split(",")) {
         String[] libraryToInstallParts = library.split(":");
@@ -426,9 +407,9 @@ protected void onProgress(Progress progress) {
 
         ContributedLibrary installed = indexer.getIndex().getInstalled(libraryToInstallParts[0]);
         if (selected.isReadOnly()) {
-          installer.remove(installed);
+          installer.remove(installed, progressListener);
         } else {
-          installer.install(selected, installed);
+          installer.install(selected, installed, progressListener);
         }
       }
 

app/test/cc/arduino/contributions/GzippedJsonDownloaderTest.java

@@ -38,7 +38,7 @@ public void tearDown() throws Exception {
 
   @Test
   public void testJsonDownload() throws Exception {
-    new GZippedJsonDownloader(downloader, new URL("http://downloads.arduino.cc/libraries/library_index.json"), new URL("http://downloads.arduino.cc/libraries/library_index.json.gz")).download(tempFile, new MultiStepProgress(1), "");
+    new GZippedJsonDownloader(downloader, new URL("http://downloads.arduino.cc/libraries/library_index.json"), new URL("http://downloads.arduino.cc/libraries/library_index.json.gz")).download(tempFile, new MultiStepProgress(1), "", new NoopProgressListener());
 
     InputStream indexIn = new FileInputStream(tempFile);
     ObjectMapper mapper = new ObjectMapper();

app/test/cc/arduino/contributions/JsonDownloaderTest.java

@@ -38,7 +38,7 @@ public void tearDown() throws Exception {
 
   @Test
   public void testJsonDownload() throws Exception {
-    new JsonDownloader(downloader, new URL("http://downloads.arduino.cc/libraries/library_index.json")).download(tempFile, new MultiStepProgress(1), "");
+    new JsonDownloader(downloader, new URL("http://downloads.arduino.cc/libraries/library_index.json")).download(tempFile, new MultiStepProgress(1), "", new NoopProgressListener());
 
     InputStream indexIn = new FileInputStream(tempFile);
     ObjectMapper mapper = new ObjectMapper();

arduino-core/src/cc/arduino/contributions/ConsoleProgressListener.java

@@ -0,0 +1,15 @@
+package cc.arduino.contributions;
+
+import cc.arduino.utils.Progress;
+
+public class ConsoleProgressListener implements ProgressListener {
+  private String lastStatus = "";
+
+  @Override
+  public void onProgress(Progress progress) {
+    if (!lastStatus.equals(progress.getStatus())) {
+      System.out.println(progress.getStatus());
+    }
+    lastStatus = progress.getStatus();
+  }
+}

arduino-core/src/cc/arduino/contributions/DownloadableContributionsDownloader.java

@@ -51,7 +51,7 @@ public DownloadableContributionsDownloader(File _stagingFolder) {
     stagingFolder = _stagingFolder;
   }
 
-  public File download(DownloadableContribution contribution, Progress progress, final String statusText) throws Exception {
+  public File download(DownloadableContribution contribution, Progress progress, final String statusText, ProgressListener progressListener) throws Exception {
     URL url = new URL(contribution.getUrl());
     Path outputFile = Paths.get(stagingFolder.getAbsolutePath(), contribution.getArchiveFileName());
 
@@ -64,12 +64,12 @@ public File download(DownloadableContribution contribution, Progress progress, f
 
     // Need to download or resume downloading?
     if (!Files.isRegularFile(outputFile, LinkOption.NOFOLLOW_LINKS) || (Files.size(outputFile) < contribution.getSize())) {
-      download(url, outputFile.toFile(), progress, statusText);
+      download(url, outputFile.toFile(), progress, statusText, progressListener);
     }
 
     // Test checksum
     progress.setStatus(tr("Verifying archive integrity..."));
-    onProgress(progress);
+    progressListener.onProgress(progress);
     String checksum = contribution.getChecksum();
     if (hasChecksum(contribution)) {
       String algo = checksum.split(":")[0];
@@ -94,7 +94,7 @@ private boolean hasChecksum(DownloadableContribution contribution) {
     return algo != null && !algo.isEmpty();
   }
 
-  public void download(URL url, File tmpFile, Progress progress, String statusText) throws Exception {
+  public void download(URL url, File tmpFile, Progress progress, String statusText, ProgressListener progressListener) throws Exception {
     FileDownloader downloader = new FileDownloader(url, tmpFile);
     downloader.addObserver((o, arg) -> {
       FileDownloader me = (FileDownloader) o;
@@ -106,16 +106,12 @@ public void download(URL url, File tmpFile, Progress progress, String statusText
       }
       progress.setStatus(statusText + " " + msg);
       progress.setProgress(me.getProgress());
-      onProgress(progress);
+      progressListener.onProgress(progress);
     });
     downloader.download();
     if (!downloader.isCompleted()) {
       throw new Exception(format(tr("Error downloading {0}"), url), downloader.getError());
     }
   }
 
-  protected void onProgress(Progress progress) {
-    // Empty
-  }
-
 }

arduino-core/src/cc/arduino/contributions/GZippedJsonDownloader.java

@@ -49,14 +49,14 @@ public GZippedJsonDownloader(DownloadableContributionsDownloader downloader, URL
     this.gzippedUrl = gzippedUrl;
   }
 
-  public void download(File tmpFile, Progress progress, String statusText) throws Exception {
+  public void download(File tmpFile, Progress progress, String statusText, ProgressListener progressListener) throws Exception {
     try {
-      new JsonDownloader(downloader, gzippedUrl).download(tmpFile, progress, statusText);
+      new JsonDownloader(downloader, gzippedUrl).download(tmpFile, progress, statusText, progressListener);
       File gzipTmpFile = new File(tmpFile.getParentFile(), GzipUtils.getCompressedFilename(tmpFile.getName()));
       tmpFile.renameTo(gzipTmpFile);
       decompress(gzipTmpFile, tmpFile);
     } catch (Exception e) {
-      new JsonDownloader(downloader, url).download(tmpFile, progress, statusText);
+      new JsonDownloader(downloader, url).download(tmpFile, progress, statusText, progressListener);
     }
   }
 

arduino-core/src/cc/arduino/contributions/JsonDownloader.java

@@ -44,9 +44,9 @@ public JsonDownloader(DownloadableContributionsDownloader downloader, URL url) {
     this.url = url;
   }
 
-  public void download(File tmpFile, Progress progress, String statusText) throws Exception {
+  public void download(File tmpFile, Progress progress, String statusText, ProgressListener progressListener) throws Exception {
     try {
-      downloader.download(url, tmpFile, progress, statusText);
+      downloader.download(url, tmpFile, progress, statusText, progressListener);
     } catch (InterruptedException e) {
       // Download interrupted... just exit
     }