UserLibrary doesn't extend ContributedLibrary anymore

ContributedLibrary is used to decode library_index.json and it's
intended to keep data coming only from the index.

Now, when the library_index is synced with the filesystem, the
metadata about installed libraries are kept in a separate list
to not mess up with the main index.

Author: cmaglie

app/src/cc/arduino/contributions/libraries/LibraryByTypeComparator.java

@@ -31,7 +31,9 @@
 
 import java.util.Comparator;
 
-public class LibraryByTypeComparator implements Comparator<ContributedLibrary> {
+import processing.app.packages.UserLibrary;
+
+public class LibraryByTypeComparator implements Comparator<UserLibrary> {
 
   private final LibraryTypeComparator libraryTypeComparator;
 
@@ -44,7 +46,7 @@ public LibraryByTypeComparator(LibraryTypeComparator libraryTypeComparator) {
   }
 
   @Override
-  public int compare(ContributedLibrary o1, ContributedLibrary o2) {
+  public int compare(UserLibrary o1, UserLibrary o2) {
     if (o1.getTypes() == null) {
       return 1;
     }

app/src/cc/arduino/contributions/libraries/LibraryOfSameTypeComparator.java

@@ -31,10 +31,12 @@
 
 import java.util.Comparator;
 
-public class LibraryOfSameTypeComparator implements Comparator<ContributedLibrary> {
+import processing.app.packages.UserLibrary;
+
+public class LibraryOfSameTypeComparator implements Comparator<UserLibrary> {
 
   @Override
-  public int compare(ContributedLibrary o1, ContributedLibrary o2) {
+  public int compare(UserLibrary o1, UserLibrary o2) {
     if (o1.getTypes() == null) {
       return 1;
     }

app/src/cc/arduino/contributions/libraries/filters/InstalledLibraryPredicate.java

@@ -29,7 +29,6 @@
 
 package cc.arduino.contributions.libraries.filters;
 
-import cc.arduino.contributions.filters.InstalledPredicate;
 import cc.arduino.contributions.libraries.ContributedLibrary;
 import processing.app.BaseNoGui;
 
@@ -40,14 +39,14 @@ public class InstalledLibraryPredicate implements Predicate<ContributedLibrary>
 
   @Override
   public boolean test(ContributedLibrary input) {
-    if (input.isInstalled()) {
+    if (input.isLibraryInstalled()) {
       return true;
     }
 
     List<ContributedLibrary> libraries = BaseNoGui.librariesIndexer.getIndex().find(input.getName());
 
     return libraries.stream()
-      .filter(new InstalledPredicate())
+      .filter(l -> l.isLibraryInstalled())
       .count() > 0;
   }
 

app/src/cc/arduino/contributions/libraries/filters/OnlyUpstreamReleasePredicate.java

@@ -29,15 +29,14 @@
 
 package cc.arduino.contributions.libraries.filters;
 
-import cc.arduino.contributions.libraries.ContributedLibrary;
 import processing.app.packages.UserLibrary;
 
 import java.util.function.Predicate;
 
-public class OnlyUpstreamReleasePredicate implements Predicate<ContributedLibrary> {
+public class OnlyUpstreamReleasePredicate implements Predicate<Object> {
 
   @Override
-  public boolean test(ContributedLibrary input) {
+  public boolean test(Object input) {
     return !(input instanceof UserLibrary);
   }
 

app/src/cc/arduino/contributions/libraries/filters/UpdatableLibraryPredicate.java

@@ -35,20 +35,21 @@
 import processing.app.packages.UserLibrary;
 
 import java.util.List;
+import java.util.Optional;
 import java.util.function.Predicate;
 
 public class UpdatableLibraryPredicate implements Predicate<ContributedLibrary> {
 
   @Override
-  public boolean test(ContributedLibrary contributedLibrary) {
-    String libraryName = contributedLibrary.getName();
-    UserLibrary installed = BaseNoGui.librariesIndexer.getInstalledLibraries().getByName(libraryName);
-    if (installed == null) {
+  public boolean test(ContributedLibrary lib) {
+    Optional<UserLibrary> installed = lib.getInstalledLibrary();
+    if (!installed.isPresent()) {
       return false;
     }
+    String installedVersion = installed.get().getVersion();
+    String libraryName = lib.getName();
     List<ContributedLibrary> libraries = BaseNoGui.librariesIndexer.getIndex().find(libraryName);
     return libraries.stream()
-      .filter(library -> VersionComparator.greaterThan(library.getParsedVersion(), installed.getParsedVersion()))
-      .count() > 0;
+      .anyMatch(library -> VersionComparator.greaterThan(library.getParsedVersion(), installedVersion));
   }
 }

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

@@ -30,7 +30,6 @@
 package cc.arduino.contributions.libraries.ui;
 
 import cc.arduino.contributions.DownloadableContributionBuiltInAtTheBottomComparator;
-import cc.arduino.contributions.filters.InstalledPredicate;
 import cc.arduino.contributions.libraries.ContributedLibrary;
 import cc.arduino.contributions.ui.FilteredAbstractTableModel;
 
@@ -78,13 +77,11 @@ public void add(ContributedLibrary library) {
   }
 
   public Optional<ContributedLibrary> getInstalled() {
-    List<ContributedLibrary> installedReleases = releases.stream().filter(new InstalledPredicate()).collect(Collectors.toList());
-    Collections.sort(installedReleases, new DownloadableContributionBuiltInAtTheBottomComparator());
-
+    List<ContributedLibrary> installedReleases = releases.stream().filter(l -> l.isLibraryInstalled()).collect(Collectors.toList());
     if (installedReleases.isEmpty()) {
       return Optional.empty();
     }
-
+    Collections.sort(installedReleases, new DownloadableContributionBuiltInAtTheBottomComparator());
     return Optional.of(installedReleases.get(0));
   }
 

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

@@ -45,7 +45,6 @@
 import cc.arduino.contributions.DownloadableContributionVersionComparator;
 import cc.arduino.contributions.VersionComparator;
 import cc.arduino.contributions.filters.BuiltInPredicate;
-import cc.arduino.contributions.filters.InstalledPredicate;
 import cc.arduino.contributions.libraries.ContributedLibrary;
 import cc.arduino.contributions.libraries.filters.OnlyUpstreamReleasePredicate;
 import cc.arduino.contributions.ui.InstallerTableCell;
@@ -92,10 +91,10 @@ public Component getTableCellEditorComponent(JTable table, Object value,
         .filter(new OnlyUpstreamReleasePredicate())
         .collect(Collectors.toList());
     List<ContributedLibrary> uninstalledReleases = releases.stream()
-        .filter(new InstalledPredicate().negate()).collect(Collectors.toList());
+        .filter(l -> !l.isLibraryInstalled()).collect(Collectors.toList());
 
     List<ContributedLibrary> installedBuiltIn = releases.stream()
-        .filter(new InstalledPredicate()).filter(new BuiltInPredicate())
+        .filter(l -> !l.isLibraryInstalled()).filter(new BuiltInPredicate())
         .collect(Collectors.toList());
 
     if (mayInstalled.isPresent() && !installedBuiltIn.contains(mayInstalled.get())) {

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

@@ -38,6 +38,7 @@
 import java.util.Collection;
 import java.util.Collections;
 import java.util.LinkedList;
+import java.util.List;
 import java.util.Optional;
 import java.util.function.Predicate;
 
@@ -134,7 +135,6 @@ public void updateUI() {
     categoryChooser.removeActionListener(categoryChooserActionListener);
     typeChooser.removeActionListener(typeChooserActionListener);
 
-
     // Load categories
     categoryFilter = x -> true;
     categoryChooser.removeAllItems();
@@ -158,7 +158,7 @@ public void updateUI() {
     typeChooser.addItem(new DropdownAllLibraries());
     typeChooser.addItem(new DropdownUpdatableLibrariesItem());
     typeChooser.addItem(new DropdownInstalledLibraryItem());
-    java.util.List<String> types = new LinkedList<>(BaseNoGui.librariesIndexer.getIndex().getTypes());
+    List<String> types = new LinkedList<>(BaseNoGui.librariesIndexer.getIndex().getTypes());
     Collections.sort(types, new LibraryTypeComparator());
     for (String type : types) {
       typeChooser.addItem(new DropdownLibraryOfTypeItem(type));

app/src/processing/app/Base.java

@@ -1059,8 +1059,8 @@ protected void rebuildSketchbookMenu(JMenu menu) {
     }
   }
 
-  private List<ContributedLibrary> getSortedLibraries() {
-    List<ContributedLibrary> installedLibraries = new LinkedList<>(BaseNoGui.librariesIndexer.getInstalledLibraries());
+  private LibraryList getSortedLibraries() {
+    LibraryList installedLibraries = BaseNoGui.librariesIndexer.getInstalledLibraries();
     Collections.sort(installedLibraries, new LibraryByTypeComparator());
     Collections.sort(installedLibraries, new LibraryOfSameTypeComparator());
     return installedLibraries;
@@ -1097,9 +1097,9 @@ public void actionPerformed(ActionEvent e) {
     TargetPlatform targetPlatform = BaseNoGui.getTargetPlatform();
 
     if (targetPlatform != null) {
-      List<ContributedLibrary> libs = getSortedLibraries();
+      LibraryList libs = getSortedLibraries();
       String lastLibType = null;
-      for (ContributedLibrary lib : libs) {
+      for (UserLibrary lib : libs) {
         String libType = lib.getTypes().get(0);
         if (!libType.equals(lastLibType)) {
           if (lastLibType != null) {

app/src/processing/app/syntax/PdeKeywords.java

@@ -24,12 +24,12 @@
 
 package processing.app.syntax;
 
-import cc.arduino.contributions.libraries.ContributedLibrary;
 import org.apache.commons.compress.utils.IOUtils;
 import org.fife.ui.rsyntaxtextarea.TokenMap;
 import org.fife.ui.rsyntaxtextarea.TokenTypes;
 import processing.app.Base;
 import processing.app.BaseNoGui;
+import processing.app.packages.UserLibrary;
 import processing.app.debug.TargetPlatform;
 
 import java.io.BufferedReader;
@@ -89,7 +89,7 @@ public void reload() {
         File platformKeywords = new File(tp.getFolder(), "keywords.txt");
         if (platformKeywords.exists()) parseKeywordsTxt(platformKeywords);
       }
-      for (ContributedLibrary lib : BaseNoGui.librariesIndexer.getInstalledLibraries()) {
+      for (UserLibrary lib : BaseNoGui.librariesIndexer.getInstalledLibraries()) {
         File keywords = new File(lib.getInstalledFolder(), "keywords.txt");
         if (keywords.exists()) {
           parseKeywordsTxt(keywords);

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

@@ -35,6 +35,7 @@
 
 public abstract class DownloadableContribution {
 
+  // XXX: maybe installed fields should not be here but in UserLibrary and ContributedPlatform?
   private boolean installed;
   private File installedFolder;
 

arduino-core/src/cc/arduino/contributions/libraries/ContributedLibrary.java

@@ -31,9 +31,11 @@
 
 import cc.arduino.contributions.DownloadableContribution;
 import processing.app.I18n;
+import processing.app.packages.UserLibrary;
 
 import java.util.Comparator;
 import java.util.List;
+import java.util.Optional;
 
 import static processing.app.I18n.tr;
 
@@ -65,6 +67,24 @@ public abstract class ContributedLibrary extends DownloadableContribution {
 
   public static final Comparator<ContributedLibrary> CASE_INSENSITIVE_ORDER = (o1, o2) -> o1.getName().compareToIgnoreCase(o2.getName());
 
+  private Optional<UserLibrary> installedLib = Optional.empty();
+
+  public Optional<UserLibrary> getInstalledLibrary() {
+    return installedLib;
+  }
+
+  public boolean isLibraryInstalled() {
+    return installedLib.isPresent();
+  }
+
+  public void setInstalledUserLibrary(UserLibrary installed) {
+    this.installedLib = Optional.of(installed);
+  }
+
+  public void unsetInstalledUserLibrary() {
+    installedLib = Optional.empty();
+  }
+
   /**
    * Returns <b>true</b> if the library declares to support the specified
    * architecture (through the "architectures" property field).

arduino-core/src/cc/arduino/contributions/libraries/LibrariesIndex.java

@@ -30,7 +30,6 @@
 package cc.arduino.contributions.libraries;
 
 import cc.arduino.contributions.DownloadableContributionBuiltInAtTheBottomComparator;
-import cc.arduino.contributions.filters.InstalledPredicate;
 import cc.arduino.contributions.libraries.filters.LibraryWithNamePredicate;
 
 import java.util.*;
@@ -92,7 +91,7 @@ public List<String> getTypes() {
   }
 
   public Optional<ContributedLibrary> getInstalled(String name) {
-    List<ContributedLibrary> installedReleases = find(name).stream().filter(new InstalledPredicate()).collect(Collectors.toList());
+    List<ContributedLibrary> installedReleases = find(name).stream().filter(l -> l.isLibraryInstalled()).collect(Collectors.toList());
     Collections.sort(installedReleases, new DownloadableContributionBuiltInAtTheBottomComparator());
 
     if (installedReleases.isEmpty()) {

arduino-core/src/cc/arduino/contributions/libraries/LibrariesIndexer.java

@@ -122,7 +122,7 @@ public void rescanLibraries() {
     }
 
     for (ContributedLibrary lib : index.getLibraries()) {
-      lib.setInstalled(false);
+      lib.unsetInstalledUserLibrary();
     }
 
     // Rescan libraries
@@ -176,7 +176,6 @@ private void scanLibrary(File folder, boolean isSketchbook) throws IOException {
     if (!check.exists() || !check.isFile()) {
       // Create a legacy library and exit
       LegacyUserLibrary lib = LegacyUserLibrary.create(folder);
-      lib.setReadOnly(readOnly);
       String[] headers = BaseNoGui.headerListFromIncludePath(lib.getSrcFolder());
       if (headers.length == 0) {
         throw new IOException(lib.getSrcFolder().getAbsolutePath());
@@ -187,7 +186,6 @@ private void scanLibrary(File folder, boolean isSketchbook) throws IOException {
 
     // Create a regular library
     UserLibrary lib = UserLibrary.create(folder);
-    lib.setReadOnly(readOnly);
     String[] headers = BaseNoGui.headerListFromIncludePath(lib.getSrcFolder());
     if (headers.length == 0) {
       throw new IOException(lib.getSrcFolder().getAbsolutePath());
@@ -196,15 +194,13 @@ private void scanLibrary(File folder, boolean isSketchbook) throws IOException {
 
     // Check if we can find the same library in the index
     // and mark it as installed
-    ContributedLibrary foundLib = index.find(lib.getName(), lib.getParsedVersion());
+    ContributedLibrary foundLib = index.find(lib.getName(), lib.getVersion());
     if (foundLib != null) {
-      foundLib.setInstalled(true);
-      foundLib.setInstalledFolder(folder);
-      foundLib.setReadOnly(readOnly);
+      foundLib.setInstalledUserLibrary(lib);
       lib.setTypes(foundLib.getTypes());
     }
 
-    if (lib.isReadOnly() && lib.getTypes() == null && !lib.getDeclaredTypes().isEmpty()) {
+    if (readOnly && lib.getTypes() == null && !lib.getDeclaredTypes().isEmpty()) {
       lib.setTypes(lib.getDeclaredTypes());
     }
 

arduino-core/src/cc/arduino/contributions/libraries/LibraryInstaller.java

@@ -84,7 +84,7 @@ public synchronized void updateIndex(ProgressListener progressListener) throws E
   }
 
   public synchronized void install(ContributedLibrary lib, Optional<ContributedLibrary> mayReplacedLib, ProgressListener progressListener) throws Exception {
-    if (lib.isInstalled()) {
+    if (lib.isLibraryInstalled()) {
       System.out.println(I18n.format(tr("Library is already installed: {0} version {1}"), lib.getName(), lib.getParsedVersion()));
       return;
     }
@@ -141,7 +141,7 @@ public synchronized void remove(ContributedLibrary lib, ProgressListener progres
     // Step 1: Remove library
     progress.setStatus(I18n.format(tr("Removing library: {0}"), lib.getName()));
     progressListener.onProgress(progress);
-    FileUtils.recursiveDelete(lib.getInstalledFolder());
+    FileUtils.recursiveDelete(lib.getInstalledLibrary().get().getInstalledFolder());
     progress.stepDone();
 
     // Step 2: Rescan index

arduino-core/src/cc/arduino/contributions/libraries/filters/LibraryInstalledInsideCore.java

@@ -29,15 +29,15 @@
 
 package cc.arduino.contributions.libraries.filters;
 
-import cc.arduino.contributions.libraries.ContributedLibrary;
 import processing.app.BaseNoGui;
+import processing.app.packages.UserLibrary;
 
 import java.util.function.Predicate;
 
-public class LibraryInstalledInsideCore implements Predicate<ContributedLibrary> {
+public class LibraryInstalledInsideCore implements Predicate<UserLibrary> {
 
   @Override
-  public boolean test(ContributedLibrary contributedLibrary) {
+  public boolean test(UserLibrary contributedLibrary) {
     return BaseNoGui.indexer.isFolderInsidePlatform(contributedLibrary.getInstalledFolder());
   }
 

arduino-core/src/cc/arduino/contributions/libraries/filters/TypePredicate.java

@@ -29,11 +29,11 @@
 
 package cc.arduino.contributions.libraries.filters;
 
-import cc.arduino.contributions.libraries.ContributedLibrary;
+import processing.app.packages.UserLibrary;
 
 import java.util.function.Predicate;
 
-public class TypePredicate implements Predicate<ContributedLibrary> {
+public class TypePredicate implements Predicate<UserLibrary> {
 
   private final String type;
 
@@ -42,7 +42,7 @@ public TypePredicate(String type) {
   }
 
   @Override
-  public boolean test(ContributedLibrary input) {
+  public boolean test(UserLibrary input) {
     return input.getTypes() != null && input.getTypes().contains(type);
   }
 

arduino-core/src/processing/app/packages/LegacyUserLibrary.java

@@ -39,8 +39,7 @@ public class LegacyUserLibrary extends UserLibrary {
   public static LegacyUserLibrary create(File libFolder) {
     // construct an old style library
     LegacyUserLibrary res = new LegacyUserLibrary();
-    res.setInstalledFolder(libFolder);
-    res.setInstalled(true);
+    res.installedFolder = libFolder;
     res.layout = LibraryLayout.FLAT;
     res.name = libFolder.getName();
     res.setTypes(Arrays.asList("Contributed"));