/*
- * jFCPlib - FcpClient.java - Copyright Ā© 2009 David Roden
+ * jFCPlib - FcpClient.java - Copyright Ā© 2009ā2016 David Roden
*
- * This program is free software; you can redistribute it and/or modify
+ * This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
+ * the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package net.pterodactylus.fcp.highlevel;
+import static com.google.common.collect.FluentIterable.from;
+import static java.util.stream.Collectors.toMap;
+
+import java.io.Closeable;
import java.io.IOException;
import java.io.InputStream;
import java.net.InetAddress;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
-import java.util.Set;
import java.util.Map.Entry;
+import java.util.Set;
import java.util.concurrent.CountDownLatch;
+import java.util.concurrent.atomic.AtomicReference;
import net.pterodactylus.fcp.AddPeer;
+import net.pterodactylus.fcp.AllData;
+import net.pterodactylus.fcp.ClientGet;
import net.pterodactylus.fcp.ClientHello;
import net.pterodactylus.fcp.CloseConnectionDuplicateClientName;
+import net.pterodactylus.fcp.ConfigData;
import net.pterodactylus.fcp.DataFound;
import net.pterodactylus.fcp.EndListPeerNotes;
import net.pterodactylus.fcp.EndListPeers;
import net.pterodactylus.fcp.FcpConnection;
import net.pterodactylus.fcp.FcpListener;
import net.pterodactylus.fcp.GenerateSSK;
+import net.pterodactylus.fcp.GetConfig;
import net.pterodactylus.fcp.GetFailed;
import net.pterodactylus.fcp.GetNode;
import net.pterodactylus.fcp.ListPeerNotes;
import net.pterodactylus.fcp.SSKKeypair;
import net.pterodactylus.fcp.SimpleProgress;
import net.pterodactylus.fcp.WatchGlobal;
-import net.pterodactylus.util.filter.Filter;
-import net.pterodactylus.util.filter.Filters;
-import net.pterodactylus.util.thread.ObjectWrapper;
+
+import com.google.common.base.Predicate;
/**
* High-level FCP client that hides the details of the underlying FCP
*
* @author David āBombeā Roden <bombe@freenetproject.org>
*/
-public class FcpClient {
+public class FcpClient implements Closeable {
/** Object used for synchronization. */
private final Object syncObject = new Object();
/** Listener management. */
private final FcpClientListenerManager fcpClientListenerManager = new FcpClientListenerManager(this);
- /** The name of this client. */
- private final String name;
-
/** The underlying FCP connection. */
private final FcpConnection fcpConnection;
+ /** The {@link NodeHello} data sent by the node on connection. */
+ private volatile NodeHello nodeHello;
+
/** Whether the client is currently connected. */
private volatile boolean connected;
+ /** The listener for āconnection closedā events. */
+ private FcpListener connectionClosedListener;
+
/**
* Creates an FCP client with the given name.
*
- * @param name
- * The name of the FCP client
* @throws UnknownHostException
* if the hostname ālocalhostā is unknown
*/
- public FcpClient(String name) throws UnknownHostException {
- this(name, "localhost");
+ public FcpClient() throws UnknownHostException {
+ this("localhost");
}
/**
* Creates an FCP client.
*
- * @param name
- * The name of the FCP client
* @param hostname
* The hostname of the Freenet node
* @throws UnknownHostException
* if the given hostname can not be resolved
*/
- public FcpClient(String name, String hostname) throws UnknownHostException {
- this(name, hostname, FcpConnection.DEFAULT_PORT);
+ public FcpClient(String hostname) throws UnknownHostException {
+ this(hostname, FcpConnection.DEFAULT_PORT);
}
/**
* Creates an FCP client.
*
- * @param name
- * The name of the FCP client
* @param hostname
* The hostname of the Freenet node
* @param port
* @throws UnknownHostException
* if the given hostname can not be resolved
*/
- public FcpClient(String name, String hostname, int port) throws UnknownHostException {
- this(name, InetAddress.getByName(hostname), port);
+ public FcpClient(String hostname, int port) throws UnknownHostException {
+ this(InetAddress.getByName(hostname), port);
}
/**
* Creates an FCP client.
*
- * @param name
- * The name of the FCP client
* @param host
* The host address of the Freenet node
*/
- public FcpClient(String name, InetAddress host) {
- this(name, host, FcpConnection.DEFAULT_PORT);
+ public FcpClient(InetAddress host) {
+ this(host, FcpConnection.DEFAULT_PORT);
}
/**
* Creates an FCP client.
*
- * @param name
- * The name of the FCP client
* @param host
* The host address of the Freenet node
* @param port
* The Freenet nodeās FCP port
*/
- public FcpClient(String name, InetAddress host, int port) {
- this.name = name;
- fcpConnection = new FcpConnection(host, port);
- fcpConnection.addFcpListener(new FcpAdapter() {
+ public FcpClient(InetAddress host, int port) {
+ this(new FcpConnection(host, port), false);
+ }
+
+ /**
+ * Creates a new high-level FCP client that will use the given connection.
+ * This constructor will assume that the FCP connection is already
+ * connected.
+ *
+ * @param fcpConnection
+ * The FCP connection to use
+ */
+ public FcpClient(FcpConnection fcpConnection) {
+ this(fcpConnection, true);
+ }
+
+ /**
+ * Creates a new high-level FCP client that will use the given connection.
+ *
+ * @param fcpConnection
+ * The FCP connection to use
+ * @param connected
+ * The initial status of the FCP connection
+ */
+ public FcpClient(FcpConnection fcpConnection, boolean connected) {
+ this.fcpConnection = fcpConnection;
+ this.connected = connected;
+ connectionClosedListener = new FcpAdapter() {
/**
* {@inheritDoc}
@Override
@SuppressWarnings("synthetic-access")
public void connectionClosed(FcpConnection fcpConnection, Throwable throwable) {
- connected = false;
+ FcpClient.this.connected = false;
fcpClientListenerManager.fireFcpClientDisconnected();
}
- });
+ };
+ fcpConnection.addFcpListener(connectionClosedListener);
}
//
}
//
+ // ACCESSORS
+ //
+
+ /**
+ * Returns the {@link NodeHello} object that the node returned when
+ * connecting.
+ *
+ * @return The {@code NodeHello} data container
+ */
+ public NodeHello getNodeHello() {
+ return nodeHello;
+ }
+
+ /**
+ * Returns the underlying FCP connection.
+ *
+ * @return The underlying FCP connection
+ */
+ public FcpConnection getConnection() {
+ return fcpConnection;
+ }
+
+ //
// ACTIONS
//
/**
* Connects the FCP client.
*
+ * @param name
+ * The name of the client
* @throws IOException
* if an I/O error occurs
* @throws FcpException
* if an FCP error occurs
*/
- public void connect() throws IOException, FcpException {
+ public void connect(final String name) throws IOException, FcpException {
checkConnected(false);
connected = true;
new ExtendedFcpAdapter() {
* {@inheritDoc}
*/
@Override
+ @SuppressWarnings("synthetic-access")
public void receivedNodeHello(FcpConnection fcpConnection, NodeHello nodeHello) {
- completionLatch.countDown();
+ FcpClient.this.nodeHello = nodeHello;
+ complete();
}
}.execute();
}
/**
+ * Returns the file with the given URI. The retrieved data will be run
+ * through Freenetās content filter.
+ *
+ * @param uri
+ * The URI to get
+ * @return The result of the get request
+ * @throws IOException
+ * if an I/O error occurs
+ * @throws FcpException
+ * if an FCP error occurs
+ */
+ public GetResult getURI(final String uri) throws IOException, FcpException {
+ return getURI(uri, true);
+ }
+
+ /**
+ * Returns the file with the given URI.
+ *
+ * @param uri
+ * The URI to get
+ * @param filterData
+ * {@code true} to filter the retrieved data, {@code false}
+ * otherwise
+ * @return The result of the get request
+ * @throws IOException
+ * if an I/O error occurs
+ * @throws FcpException
+ * if an FCP error occurs
+ */
+ public GetResult getURI(final String uri, final boolean filterData) throws IOException, FcpException {
+ checkConnected(true);
+ final GetResult getResult = new GetResult();
+ new ExtendedFcpAdapter() {
+
+ @SuppressWarnings("synthetic-access")
+ private final String identifier = createIdentifier("client-get");
+
+ @Override
+ @SuppressWarnings("synthetic-access")
+ public void run() throws IOException {
+ ClientGet clientGet = new ClientGet(uri, identifier);
+ clientGet.setFilterData(filterData);
+ fcpConnection.sendMessage(clientGet);
+ }
+
+ @Override
+ public void receivedGetFailed(FcpConnection fcpConnection, GetFailed getFailed) {
+ if (!getFailed.getIdentifier().equals(identifier)) {
+ return;
+ }
+ if ((getFailed.getCode() == 27) || (getFailed.getCode() == 24)) {
+ /* redirect! */
+ String newUri = getFailed.getRedirectURI();
+ getResult.realUri(newUri);
+ try {
+ ClientGet clientGet = new ClientGet(newUri, identifier);
+ clientGet.setFilterData(filterData);
+ fcpConnection.sendMessage(clientGet);
+ } catch (IOException ioe1) {
+ getResult.success(false).exception(ioe1);
+ complete();
+ }
+ } else {
+ getResult.success(false).errorCode(getFailed.getCode());
+ complete();
+ }
+ }
+
+ @Override
+ public void receivedAllData(FcpConnection fcpConnection, AllData allData) {
+ if (!allData.getIdentifier().equals(identifier)) {
+ return;
+ }
+ getResult.success(true).contentType(allData.getContentType()).contentLength(allData.getDataLength()).inputStream(allData.getPayloadInputStream());
+ complete();
+ }
+
+ }.execute();
+ return getResult;
+ }
+
+ /**
* Disconnects the FCP client.
*/
public void disconnect() {
}
/**
+ * {@inheritDoc}
+ */
+ @Override
+ public void close() {
+ disconnect();
+ }
+
+ /**
* Returns whether this client is currently connected.
*
* @return {@code true} if the client is currently connected, {@code false}
return connected;
}
+ /**
+ * Detaches this client from its underlying FCP connection.
+ */
+ public void detach() {
+ fcpConnection.removeFcpListener(connectionClosedListener);
+ }
+
//
// PEER MANAGEMENT
//
@Override
public void receivedEndListPeers(FcpConnection fcpConnection, EndListPeers endListPeers) {
if (endListPeers.getIdentifier().equals(identifier)) {
- completionLatch.countDown();
+ complete();
}
}
}.execute();
/**
* Adds a peer, reading the noderef of the peer from the given file.
- * <strong>Note:</strong> the file to read the noderef from has to reside on
- * the same machine as the node!
+ * <strong>Note:</strong> the file to read the noderef from has to reside
+ * on the same machine as the node!
*
* @param file
* The name of the file containing the peerās noderef
*/
@Override
public void receivedPeer(FcpConnection fcpConnection, Peer peer) {
- completionLatch.countDown();
+ complete();
}
}.execute();
}
*/
@Override
public void receivedPeer(FcpConnection fcpConnection, Peer peer) {
- completionLatch.countDown();
+ complete();
}
}.execute();
}
*/
@Override
public void receivedPeerRemoved(FcpConnection fcpConnection, PeerRemoved peerRemoved) {
- completionLatch.countDown();
+ complete();
}
}.execute();
}
* if an FCP error occurs
*/
public PeerNote getPeerNote(final Peer peer) throws IOException, FcpException {
- final ObjectWrapper<PeerNote> objectWrapper = new ObjectWrapper<PeerNote>();
+ final AtomicReference<PeerNote> objectWrapper = new AtomicReference<PeerNote>();
new ExtendedFcpAdapter() {
/**
*/
@Override
public void receivedEndListPeerNotes(FcpConnection fcpConnection, EndListPeerNotes endListPeerNotes) {
- completionLatch.countDown();
+ complete();
}
}.execute();
return objectWrapper.get();
@Override
public void receivedPeer(FcpConnection fcpConnection, Peer receivedPeer) {
if (receivedPeer.getIdentity().equals(peer.getIdentity())) {
- completionLatch.countDown();
+ complete();
}
}
}.execute();
* if an FCP error occurs
*/
public SSKKeypair generateKeyPair() throws IOException, FcpException {
- final ObjectWrapper<SSKKeypair> sskKeypairWrapper = new ObjectWrapper<SSKKeypair>();
+ final AtomicReference<SSKKeypair> sskKeypairWrapper = new AtomicReference<SSKKeypair>();
new ExtendedFcpAdapter() {
/**
@Override
public void receivedSSKKeypair(FcpConnection fcpConnection, SSKKeypair sskKeypair) {
sskKeypairWrapper.set(sskKeypair);
- completionLatch.countDown();
+ complete();
}
}.execute();
return sskKeypairWrapper.get();
* if an FCP error occurs
*/
public Collection<Request> getGetRequests(final boolean global) throws IOException, FcpException {
- return Filters.filteredCollection(getRequests(global), new Filter<Request>() {
-
- /**
- * {@inheritDoc}
- */
- public boolean filterObject(Request request) {
+ return from(getRequests(global)).filter(new Predicate<Request>() {
+ @Override
+ public boolean apply(Request request) {
return request instanceof GetRequest;
}
- });
+ }).toList();
}
/**
* if an FCP error occurs
*/
public Collection<Request> getPutRequests(final boolean global) throws IOException, FcpException {
- return Filters.filteredCollection(getRequests(global), new Filter<Request>() {
-
- /**
- * {@inheritDoc}
- */
- public boolean filterObject(Request request) {
+ return from(getRequests(global)).filter(new Predicate<Request>() {
+ @Override
+ public boolean apply(Request request) {
return request instanceof PutRequest;
}
- });
+ }).toList();
}
/**
*
* @param global
* <code>true</code> to return requests from the global queue,
- * <code>false</code> to only show requests from the client-local
- * queue
+ * <code>false</code> to only show requests from the
+ * client-local queue
* @return All requests
* @throws IOException
* if an I/O error occurs
*/
@Override
public void receivedEndListPersistentRequests(FcpConnection fcpConnection, EndListPersistentRequests endListPersistentRequests) {
- completionLatch.countDown();
+ complete();
}
}.execute();
return requests.values();
return;
}
pluginReplies.putAll(fcpPluginReply.getReplies());
- completionLatch.countDown();
+ complete();
}
}.execute();
* if an I/O error occurs
*/
public NodeData getNodeInformation(final Boolean giveOpennetRef, final Boolean withPrivate, final Boolean withVolatile) throws IOException, FcpException {
- final ObjectWrapper<NodeData> nodeDataWrapper = new ObjectWrapper<NodeData>();
+ final AtomicReference<NodeData> nodeDataWrapper = new AtomicReference<NodeData>();
new ExtendedFcpAdapter() {
@Override
@Override
public void receivedNodeData(FcpConnection fcpConnection, NodeData nodeData) {
nodeDataWrapper.set(nodeData);
- completionLatch.countDown();
+ complete();
}
}.execute();
return nodeDataWrapper.get();
}
//
+ // CONFIG MANAGEMENT
+ //
+
+ public Map<String, String> getConfig() throws IOException, FcpException {
+ Map<String, String> results = new HashMap<>();
+ new ExtendedFcpAdapter() {
+ @Override
+ public void run() throws IOException {
+ GetConfig getConfig = new GetConfig(createIdentifier("get-config"));
+ getConfig.setWithCurrent(true);
+ getConfig.setWithDefaults(true);
+ getConfig.setWithShortDescription(true);
+ getConfig.setWithLongDescription(true);
+ getConfig.setWithDataTypes(true);
+ getConfig.setWithExpertFlag(true);
+ getConfig.setWithForceWriteFlag(true);
+ getConfig.setWithSortOrder(true);
+ fcpConnection.sendMessage(getConfig);
+ }
+
+ @Override
+ public void receivedConfigData(FcpConnection fcpConnection, ConfigData configData) {
+ results.putAll(filterByResponseType(configData, "current"));
+ results.putAll(filterByResponseType(configData, "default"));
+ results.putAll(filterByResponseType(configData, "shortDescription"));
+ results.putAll(filterByResponseType(configData, "longDescription"));
+ results.putAll(filterByResponseType(configData, "expertFlag"));
+ results.putAll(filterByResponseType(configData, "dataType"));
+ results.putAll(filterByResponseType(configData, "sortOrder"));
+ results.putAll(filterByResponseType(configData, "forceWriteFlag"));
+ complete();
+ }
+
+ private Map<String, String> filterByResponseType(ConfigData configData, String responseType) {
+ return configData.getFields().entrySet().stream()
+ .filter(e -> e.getKey().startsWith(responseType + "."))
+ .collect(toMap(Entry::getKey, Entry::getValue));
+ }
+ }.execute();
+ return results;
+ }
+
+ //
// PRIVATE METHODS
//
private abstract class ExtendedFcpAdapter extends FcpAdapter {
/** The count down latch used to wait for completion. */
- protected final CountDownLatch completionLatch = new CountDownLatch(1);
+ private final CountDownLatch completionLatch = new CountDownLatch(1);
/** The FCP exception, if any. */
protected FcpException fcpException;
public abstract void run() throws IOException;
/**
+ * Signals completion of the command processing.
+ */
+ protected void complete() {
+ completionLatch.countDown();
+ }
+
+ /**
* {@inheritDoc}
*/
@Override
*/
@Override
public void receivedProtocolError(FcpConnection fcpConnection, ProtocolError protocolError) {
- fcpException = new FcpException("Protocol error (" + protocolError.getCode() + ", " + protocolError.getCodeDescription());
+ fcpException = FcpProtocolException.from(protocolError);
completionLatch.countDown();
}