Skip to content

Commit

Permalink
Allow user-defined block explorers
Browse files Browse the repository at this point in the history 
In Settings/General Preferences the Bitcoin Explorer and Bisq Explorer may
now be user defined in addition to the hard coded block explorer choices.

This implementation takes advantage of the existing Protobuf implementation
that stores a BlockExplorer Name/UrlTx/UrlAddress for BTC and for BSQ.

A new popup dialog is implemented which allows editing of the explorer
details (name, txUrl, and addressUrl).  Any of the system-defined
explorer details may be selected into the edit fields thus allowing
them to be used as templates, customized or an entirely new explorer to
be used.

If the user switches choice from a customized back to a pre-defined
explorer then the customized settings are gone; this is because the
Protobuf storage only allows saving one selection.

Fixes #4371
Closes #4634
  • Loading branch information
jmacxx committed Nov 2, 2020
1 parent 50ab428 commit 8a9d05e
Show file tree
Hide file tree
Showing 5 changed files with 278 additions and 58 deletions.
13 changes: 2 additions & 11 deletions core/src/main/java/bisq/core/user/Preferences.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -280,12 +280,12 @@ public void readPersisted() {

// if no valid Bitcoin block explorer is set, select the 1st valid Bitcoin block explorer
ArrayList<BlockChainExplorer> btcExplorers = getBlockChainExplorers();
if (!blockExplorerExists(btcExplorers, getBlockChainExplorer()))
if (getBlockChainExplorer() == null || getBlockChainExplorer().name.length() == 0)
setBlockChainExplorer(btcExplorers.get(0));

// if no valid BSQ block explorer is set, randomly select a valid BSQ block explorer
ArrayList<BlockChainExplorer> bsqExplorers = getBsqBlockChainExplorers();
if (!blockExplorerExists(bsqExplorers, getBsqBlockChainExplorer()))
if (getBsqBlockChainExplorer() == null || getBsqBlockChainExplorer().name.length() == 0)
setBsqBlockChainExplorer(bsqExplorers.get((new Random()).nextInt(bsqExplorers.size())));

tradeCurrenciesAsObservable.addAll(prefPayload.getFiatCurrencies());
Expand Down Expand Up @@ -902,15 +902,6 @@ else if (change.wasRemoved() && change.getRemovedSize() == 1 && initialReadDone)
requestPersistence();
}

private boolean blockExplorerExists(ArrayList<BlockChainExplorer> explorers,
BlockChainExplorer explorer) {
if (explorer != null && explorers != null && explorers.size() > 0)
for (int i = 0; i < explorers.size(); i++)
if (explorers.get(i).name.equals(explorer.name))
return true;
return false;
}

private interface ExcludesDelegateMethods {
void setTacAccepted(boolean tacAccepted);

Expand Down
8 changes: 8 additions & 0 deletions core/src/main/resources/i18n/displayStrings.properties
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1237,6 +1237,14 @@ setting.preferences.dao.fullNodeInfo=For running Bisq as DAO full node you need
After changing the mode you need to restart.
setting.preferences.dao.fullNodeInfo.ok=Open docs page
setting.preferences.dao.fullNodeInfo.cancel=No, I stick with lite node mode
settings.preferences.editCustomExplorer.headline=Explorer Settings
settings.preferences.editCustomExplorer.description=Choose a system defined explorer from the list on the left, and/or \
customize to suit your own preferences.
settings.preferences.editCustomExplorer.available=Available explorers
settings.preferences.editCustomExplorer.chosen = Chosen explorer settings
settings.preferences.editCustomExplorer.name=Name
settings.preferences.editCustomExplorer.txUrl=Transaction URL
settings.preferences.editCustomExplorer.addressUrl=Address URL

settings.net.btcHeader=Bitcoin network
settings.net.p2pHeader=Bisq network
Expand Down
199 changes: 199 additions & 0 deletions desktop/src/main/java/bisq/desktop/main/overlays/windows/EditCustomExplorerWindow.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,199 @@
/*
* This file is part of Bisq.
*
* Bisq is free software: you can redistribute it and/or modify it
* under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or (at
* your option) any later version.
*
* Bisq 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 Affero General Public
* License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with Bisq. If not, see <http://www.gnu.org/licenses/>.
*/

package bisq.desktop.main.overlays.windows;

import bisq.desktop.components.AutoTooltipButton;
import bisq.desktop.components.AutoTooltipLabel;
import bisq.desktop.components.InputTextField;
import bisq.desktop.main.overlays.Overlay;
import bisq.desktop.util.Layout;
import bisq.desktop.util.validation.LengthValidator;

import bisq.core.locale.Res;
import bisq.core.util.validation.UrlInputValidator;

import bisq.common.util.Tuple2;

import bisq.core.user.BlockChainExplorer;

import javafx.scene.control.Button;
import javafx.scene.control.Label;
import javafx.scene.control.ListCell;
import javafx.scene.control.ListView;
import javafx.scene.input.MouseEvent;
import javafx.scene.layout.AnchorPane;
import javafx.scene.layout.ColumnConstraints;
import javafx.scene.layout.GridPane;
import javafx.scene.layout.HBox;
import javafx.scene.layout.VBox;

import javafx.geometry.Insets;
import javafx.geometry.Pos;
import javafx.geometry.VPos;

import javafx.event.EventHandler;

import javafx.collections.FXCollections;

import javafx.util.Callback;

import java.util.ArrayList;

import static bisq.desktop.util.FormBuilder.*;
import static javafx.beans.binding.Bindings.createBooleanBinding;

public class EditCustomExplorerWindow extends Overlay<EditCustomExplorerWindow> {

private InputTextField nameInputTextField, txUrlInputTextField, addressUrlInputTextField;
private UrlInputValidator urlInputValidator;
private BlockChainExplorer currentExplorer;
private ListView<BlockChainExplorer> listView;

public EditCustomExplorerWindow(String coin,
BlockChainExplorer currentExplorer,
ArrayList<BlockChainExplorer> availableExplorers) {
this.currentExplorer = currentExplorer;
listView = new ListView<>();
listView.setItems(FXCollections.observableArrayList(availableExplorers));
headLine = coin + " " + Res.get("settings.preferences.editCustomExplorer.headline");
}

public BlockChainExplorer getEditedBlockChainExplorer() {
return new BlockChainExplorer(nameInputTextField.getText(),
txUrlInputTextField.getText(), addressUrlInputTextField.getText());
}

public void show() {

width = 1000;
createGridPane();
addHeadLine();
addContent();
addButtons();

urlInputValidator = new UrlInputValidator();
txUrlInputTextField.setValidator(urlInputValidator);
addressUrlInputTextField.setValidator(urlInputValidator);
nameInputTextField.setValidator(new LengthValidator(1, 50));

actionButton.disableProperty().bind(createBooleanBinding(() -> {
String name = nameInputTextField.getText();
String txUrl = txUrlInputTextField.getText();
String addressUrl = addressUrlInputTextField.getText();

// Otherwise we require that input is valid
return !nameInputTextField.getValidator().validate(name).isValid ||
!txUrlInputTextField.getValidator().validate(txUrl).isValid ||
!addressUrlInputTextField.getValidator().validate(addressUrl).isValid;
},
nameInputTextField.textProperty(), txUrlInputTextField.textProperty(), addressUrlInputTextField.textProperty()));

applyStyles();
display();
}

@Override
protected void createGridPane() {
gridPane = new GridPane();
gridPane.setHgap(15);
gridPane.setVgap(15);
gridPane.setPadding(new Insets(64, 64, 64, 64));
gridPane.setPrefWidth(width);
ColumnConstraints columnConstraints1 = new ColumnConstraints();
ColumnConstraints columnConstraints2 = new ColumnConstraints();
columnConstraints1.setPercentWidth(45);
columnConstraints2.setPercentWidth(55);
gridPane.getColumnConstraints().addAll(columnConstraints1, columnConstraints2);
}

private void addContent() {
Label mlm = addMultilineLabel(gridPane, rowIndex++, Res.get("settings.preferences.editCustomExplorer.description"), 0);
GridPane.setColumnSpan(mlm, 2);
GridPane.setMargin(mlm, new Insets(40, 0, 0, 0));

Button button = new AutoTooltipButton(">>");
button.setOnAction(e -> {
BlockChainExplorer blockChainExplorer = listView.getSelectionModel().getSelectedItem();
if (blockChainExplorer != null) {
nameInputTextField.setText(blockChainExplorer.name);
txUrlInputTextField.setText(blockChainExplorer.txUrl);
addressUrlInputTextField.setText(blockChainExplorer.addressUrl);
}
});
button.setStyle("-fx-pref-width: 50px; -fx-pref-height: 30; -fx-padding: 3 3 3 3;");
VBox vBox = new VBox(button);
vBox.setAlignment(Pos.CENTER);
final Tuple2<Label, VBox> topLabelWithVBox = getTopLabelWithVBox(Res.get("settings.preferences.editCustomExplorer.available"), listView);
listView.setPrefWidth(300);
HBox hBox = new HBox(topLabelWithVBox.second, vBox);
hBox.setAlignment(Pos.CENTER_LEFT);
hBox.setSpacing(20);
hBox.setMaxHeight(200);
gridPane.add(hBox, 0, rowIndex);
GridPane.setColumnIndex(hBox, 0);
GridPane.setValignment(hBox, VPos.TOP);
GridPane.setMargin(hBox, new Insets(10, 0, 0, 0));

listView.setCellFactory(new Callback<>() {
@Override
public ListCell<BlockChainExplorer> call(ListView<BlockChainExplorer> list) {
ListCell<BlockChainExplorer> cell = new ListCell<>() {
final Label label = new AutoTooltipLabel();
final AnchorPane pane = new AnchorPane(label);
@Override
public void updateItem(final BlockChainExplorer item, boolean empty) {
super.updateItem(item, empty);
if (item != null && !empty) {
label.setText(item.name);
setGraphic(pane);
} else {
setGraphic(null);
}
}
};

cell.addEventFilter(MouseEvent.MOUSE_CLICKED, new EventHandler<MouseEvent>() {
@Override
public void handle(MouseEvent event) {
if (event.getClickCount() == 2) {
BlockChainExplorer blockChainExplorer = listView.getSelectionModel().getSelectedItem();
nameInputTextField.setText(blockChainExplorer.name);
txUrlInputTextField.setText(blockChainExplorer.txUrl);
addressUrlInputTextField.setText(blockChainExplorer.addressUrl);
}
}
});
return cell;
}
});

GridPane autoConfirmGridPane = new GridPane();
autoConfirmGridPane.setPrefHeight(150);
GridPane.setMargin(autoConfirmGridPane, new Insets(10, 0, 0, 0));
gridPane.add(autoConfirmGridPane, 1, rowIndex);
addTitledGroupBg(autoConfirmGridPane, 0, 6, Res.get("settings.preferences.editCustomExplorer.chosen"), 0);
int localRowIndex = 0;
nameInputTextField = addInputTextField(autoConfirmGridPane, ++localRowIndex, Res.get("settings.preferences.editCustomExplorer.name"), Layout.FIRST_ROW_DISTANCE);
nameInputTextField.setPrefWidth(Layout.INITIAL_WINDOW_WIDTH);
txUrlInputTextField = addInputTextField(autoConfirmGridPane, ++localRowIndex, Res.get("settings.preferences.editCustomExplorer.txUrl"));
addressUrlInputTextField = addInputTextField(autoConfirmGridPane, ++localRowIndex, Res.get("settings.preferences.editCustomExplorer.addressUrl"));
nameInputTextField.setText(currentExplorer.name);
txUrlInputTextField.setText(currentExplorer.txUrl);
addressUrlInputTextField.setText(currentExplorer.addressUrl);
}
}
Loading

0 comments on commit 8a9d05e

Please sign in to comment.