Merge pull request #503 from DropSnorz/feat/package-filters

Add remote package filter sidebar

Author: DropSnorz

owlplug-client/src/main/java/com/owlplug/core/components/LazyViewRegistry.java

@@ -37,7 +37,6 @@ public class LazyViewRegistry {
   public static final String NEW_ACCOUNT_VIEW = "NEW_ACCOUNT_VIEW";
   public static final String NEW_LINK_VIEW = "NEW_LINK_VIEW";
   public static final String WELCOME_VIEW = "WELCOME_VIEW";
-  public static final String SOURCE_MENU_VIEW = "SOURCE_MENU_VIEW";
   public static final String NEW_SOURCE_VIEW = "NEW_SOURCE_VIEW";
   public static final String CRASH_RECOVERY_VIEW = "CRASH_RECOVERY_VIEW";
   public static final String LIST_DIRECTORY_VIEW = "LIST_DIRECTORY_VIEW";
@@ -63,7 +62,6 @@ public void preload() {
     preloadFxml(NEW_ACCOUNT_VIEW, "/fxml/dialogs/NewAccount.fxml");
     preloadFxml(NEW_LINK_VIEW, "/fxml/dialogs/NewLinkView.fxml");
     preloadFxml(WELCOME_VIEW, "/fxml/dialogs/WelcomeView.fxml");
-    preloadFxml(SOURCE_MENU_VIEW, "/fxml/menu/SourceMenu.fxml");
     preloadFxml(NEW_SOURCE_VIEW, "/fxml/dialogs/NewSourceView.fxml");
     preloadFxml(CRASH_RECOVERY_VIEW, "/fxml/dialogs/CrashRecoveryView.fxml");
     preloadFxml(LIST_DIRECTORY_VIEW, "/fxml/dialogs/ListDirectoryView.fxml");

owlplug-client/src/main/java/com/owlplug/core/controllers/settings/InstallationSettingsController.java

@@ -18,23 +18,53 @@
 
 package com.owlplug.core.controllers.settings;
 
+import atlantafx.base.controls.ToggleSwitch;
+import atlantafx.base.theme.Styles;
+import com.owlplug.controls.Dialog;
+import com.owlplug.controls.DialogLayout;
 import com.owlplug.core.components.ApplicationDefaults.Prefs;
 import com.owlplug.core.controllers.BaseController;
+import com.owlplug.core.utils.FX;
+import com.owlplug.explore.controllers.NewSourceDialogController;
+import com.owlplug.explore.events.RemoteSourceUpdatedEvent;
+import com.owlplug.explore.model.RemoteSource;
+import com.owlplug.explore.services.ExploreService;
 import com.owlplug.plugin.ui.PluginFormatBadgeView;
 import java.io.File;
+import java.util.ArrayList;
+import java.util.List;
+import javafx.collections.FXCollections;
+import javafx.collections.ObservableList;
 import javafx.fxml.FXML;
+import javafx.geometry.Insets;
 import javafx.geometry.Pos;
+import javafx.scene.control.Button;
 import javafx.scene.control.CheckBox;
 import javafx.scene.control.Label;
+import javafx.scene.control.ListCell;
+import javafx.scene.control.ListView;
 import javafx.scene.control.TextField;
+import javafx.scene.control.Tooltip;
 import javafx.scene.layout.HBox;
 import javafx.scene.layout.Priority;
 import javafx.scene.layout.VBox;
+import org.kordamp.ikonli.javafx.FontIcon;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.context.event.EventListener;
 import org.springframework.stereotype.Controller;
 
 @Controller
 public class InstallationSettingsController extends BaseController {
 
+  @Autowired
+  private ExploreService exploreService;
+  @Autowired
+  private NewSourceDialogController newSourceDialogController;
+
+  @FXML
+  private ListView<RemoteSource> sourceListView;
+  @FXML
+  private Button addSourceButton;
   @FXML
   private CheckBox storeDirectoryCheckBox;
   @FXML
@@ -50,13 +80,38 @@ public class InstallationSettingsController extends BaseController {
   @FXML
   private VBox pathPreviewContainer;
 
+  private final ObservableList<RemoteSource> sourceItems = FXCollections.observableArrayList();
+
   private Label vst2PathLabel;
   private Label vst3PathLabel;
   private Label auPathLabel;
   private Label lv2PathLabel;
 
   @FXML
   public void initialize() {
+    Label sourcePlaceholder = new Label("No remote sources configured.");
+    sourcePlaceholder.getStyleClass().add("label-disabled");
+    sourceListView.setPlaceholder(sourcePlaceholder);
+    sourceListView.setItems(sourceItems);
+    sourceListView.setCellFactory(lv -> new ListCell<>() {
+      @Override
+      protected void updateItem(RemoteSource remoteSource, boolean empty) {
+        super.updateItem(remoteSource, empty);
+        setText(null);
+        setGraphic(empty || remoteSource == null ? null : buildSourceRow(remoteSource));
+      }
+    });
+
+    FontIcon addSourceIcon = new FontIcon("mdi2p-plus");
+    addSourceIcon.setIconSize(14);
+    addSourceButton.setGraphic(addSourceIcon);
+    addSourceButton.setOnAction(e -> {
+      newSourceDialogController.show();
+      newSourceDialogController.startCreateSequence();
+    });
+
+    refreshSources();
+
     storeDirectoryRow.visibleProperty().bind(storeDirectoryCheckBox.selectedProperty());
     storeDirectoryRow.managedProperty().bind(storeDirectoryCheckBox.selectedProperty());
     warningSubDirectory.managedProperty().bind(warningSubDirectory.visibleProperty());
@@ -102,6 +157,74 @@ public void refresh() {
     storeDirectoryTextField.setText(
         getPreferences().get(Prefs.Explore.STORE_DIRECTORY, ""));
     refreshPathPreview();
+    refreshSources();
+  }
+
+  private void refreshSources() {
+    List<RemoteSource> sources = new ArrayList<>();
+    exploreService.getRemoteSources().forEach(sources::add);
+    sourceItems.setAll(sources);
+  }
+
+  private HBox buildSourceRow(RemoteSource remoteSource) {
+    VBox infoBox = new VBox(2);
+    Label nameLabel = new Label(remoteSource.getName());
+    Label urlLabel = new Label(formatUrl(remoteSource.getDisplayUrl()));
+    urlLabel.getStyleClass().add("label-disabled");
+    infoBox.getChildren().addAll(nameLabel, urlLabel);
+    HBox.setHgrow(infoBox, Priority.ALWAYS);
+
+    ToggleSwitch enabledToggle = new ToggleSwitch();
+    enabledToggle.setSelected(remoteSource.isEnabled());
+    Tooltip.install(enabledToggle, new Tooltip("Enable or disable this source"));
+    enabledToggle.selectedProperty().addListener((obs, old, selected) ->
+        exploreService.enableSource(remoteSource, selected));
+
+    Button deleteButton = new Button();
+    deleteButton.getStyleClass().addAll(Styles.BUTTON_ICON, Styles.FLAT);
+    deleteButton.setGraphic(new FontIcon("mdi2d-delete-outline"));
+    Tooltip.install(deleteButton, new Tooltip("Remove source"));
+    deleteButton.setOnAction(e -> confirmAndDeleteSource(remoteSource));
+
+    HBox row = new HBox(12, infoBox, enabledToggle, deleteButton);
+    row.setAlignment(Pos.CENTER_LEFT);
+    row.setPadding(new Insets(4));
+    return row;
+  }
+
+  private void confirmAndDeleteSource(RemoteSource remoteSource) {
+    Dialog dialog = this.getDialogManager().newDialog();
+    DialogLayout layout = new DialogLayout();
+    layout.setHeading(new Label("Remove source"));
+    layout.setBody(new Label("Do you really want to remove \"" + remoteSource.getName()
+        + "\" ? Packages from this source will no longer be available in Explore."));
+
+    Button cancelButton = new Button("Cancel");
+    cancelButton.setOnAction(e -> dialog.close());
+
+    Button removeButton = new Button("Remove");
+    removeButton.getStyleClass().add("button-danger");
+    removeButton.setOnAction(e -> {
+      dialog.close();
+      exploreService.delete(remoteSource);
+      refreshSources();
+    });
+
+    layout.setActions(removeButton, cancelButton);
+    dialog.setContent(layout);
+    dialog.show();
+  }
+
+  private String formatUrl(String url) {
+    if (url == null) {
+      return null;
+    }
+    return url.replace("http://", "").replace("https://", "");
+  }
+
+  @EventListener
+  private void handle(RemoteSourceUpdatedEvent event) {
+    FX.run(this::refreshSources);
   }
 
   private void refreshPathPreview() {

owlplug-client/src/main/java/com/owlplug/explore/components/ExploreFilterState.java

@@ -0,0 +1,103 @@
+/* OwlPlug
+ * Copyright (C) 2021 Arthur <dropsnorz@gmail.com>
+ *
+ * This file is part of OwlPlug.
+ *
+ * OwlPlug is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 3
+ * as published by the Free Software Foundation.
+ *
+ * OwlPlug is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with OwlPlug.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package com.owlplug.explore.components;
+
+import com.owlplug.explore.model.search.ExploreFilterCriteria;
+import com.owlplug.explore.model.search.ExploreFilterCriteriaType;
+import com.owlplug.plugin.model.PluginFormat;
+import com.owlplug.plugin.model.PluginType;
+import java.util.ArrayList;
+import java.util.List;
+import javafx.beans.binding.Bindings;
+import javafx.beans.property.ObjectProperty;
+import javafx.beans.property.SimpleObjectProperty;
+import javafx.collections.FXCollections;
+import javafx.collections.ObservableSet;
+import org.springframework.stereotype.Component;
+
+/**
+ * Holds the current Explore view filter selections and derives the list of
+ * {@link ExploreFilterCriteria} to send to {@code ExploreService#getRemotePackages}, since
+ * package filtering is performed by a database query rather than an in-memory predicate.
+ */
+@Component
+public class ExploreFilterState {
+
+  private final ObservableSet<Long> selectedSourceIds = FXCollections.observableSet();
+  private final ObservableSet<PluginFormat> selectedFormats = FXCollections.observableSet();
+  private final ObservableSet<PluginType> selectedTypes = FXCollections.observableSet();
+  private final ObservableSet<String> selectedPlatformTags = FXCollections.observableSet();
+
+  private final ObjectProperty<List<ExploreFilterCriteria>> criteriaList = new SimpleObjectProperty<>();
+
+  public ExploreFilterState() {
+    criteriaList.bind(Bindings.createObjectBinding(this::buildCriteriaList,
+        selectedSourceIds, selectedFormats, selectedTypes, selectedPlatformTags));
+  }
+
+  private List<ExploreFilterCriteria> buildCriteriaList() {
+    List<ExploreFilterCriteria> criteria = new ArrayList<>();
+    if (!selectedSourceIds.isEmpty()) {
+      criteria.add(new ExploreFilterCriteria(new ArrayList<>(selectedSourceIds),
+          ExploreFilterCriteriaType.SOURCE_LIST));
+    }
+    if (!selectedFormats.isEmpty()) {
+      List<String> formats = selectedFormats.stream()
+          .map(format -> format.getName().toLowerCase())
+          .toList();
+      criteria.add(new ExploreFilterCriteria(formats, ExploreFilterCriteriaType.FORMAT_LIST));
+    }
+    if (!selectedTypes.isEmpty()) {
+      criteria.add(new ExploreFilterCriteria(new ArrayList<>(selectedTypes),
+          ExploreFilterCriteriaType.TYPE_LIST));
+    }
+    if (!selectedPlatformTags.isEmpty()) {
+      criteria.add(new ExploreFilterCriteria(new ArrayList<>(selectedPlatformTags),
+          ExploreFilterCriteriaType.PLATFORM_LIST));
+    }
+    return criteria;
+  }
+
+  public ObservableSet<Long> getSelectedSourceIds() {
+    return selectedSourceIds;
+  }
+
+  public ObservableSet<PluginFormat> getSelectedFormats() {
+    return selectedFormats;
+  }
+
+  public ObservableSet<PluginType> getSelectedTypes() {
+    return selectedTypes;
+  }
+
+  public ObservableSet<String> getSelectedPlatformTags() {
+    return selectedPlatformTags;
+  }
+
+  public ObjectProperty<List<ExploreFilterCriteria>> criteriaListProperty() {
+    return criteriaList;
+  }
+
+  public void clearAll() {
+    selectedSourceIds.clear();
+    selectedFormats.clear();
+    selectedTypes.clear();
+    selectedPlatformTags.clear();
+  }
+}