X-Git-Url: https://git.pterodactylus.net/?a=blobdiff_plain;f=src%2Fnet%2Fpterodactylus%2Ffcp%2Fhighlevel%2FFcpClient.java;h=12768f5010a63078a515630bec31f8b26491ebfd;hb=403b889946c2be0f8cb5b2ffc86ff31d2095e54b;hp=a5fba45da6699ac78e4283fd99d64d923f6eeac9;hpb=1555e0cac7e8fda8a301941497ce64a8b3244990;p=jFCPlib.git diff --git a/src/net/pterodactylus/fcp/highlevel/FcpClient.java b/src/net/pterodactylus/fcp/highlevel/FcpClient.java index a5fba45..12768f5 100644 --- a/src/net/pterodactylus/fcp/highlevel/FcpClient.java +++ b/src/net/pterodactylus/fcp/highlevel/FcpClient.java @@ -21,21 +21,46 @@ package net.pterodactylus.fcp.highlevel; import java.io.IOException; import java.net.InetAddress; +import java.net.URL; import java.net.UnknownHostException; +import java.util.Collection; +import java.util.Collections; +import java.util.HashMap; import java.util.HashSet; +import java.util.Map; import java.util.Set; import java.util.concurrent.CountDownLatch; +import net.pterodactylus.fcp.AddPeer; import net.pterodactylus.fcp.ClientHello; import net.pterodactylus.fcp.CloseConnectionDuplicateClientName; +import net.pterodactylus.fcp.DataFound; +import net.pterodactylus.fcp.EndListPeerNotes; import net.pterodactylus.fcp.EndListPeers; +import net.pterodactylus.fcp.EndListPersistentRequests; import net.pterodactylus.fcp.FcpAdapter; import net.pterodactylus.fcp.FcpConnection; import net.pterodactylus.fcp.FcpListener; +import net.pterodactylus.fcp.GenerateSSK; +import net.pterodactylus.fcp.GetFailed; +import net.pterodactylus.fcp.ListPeerNotes; import net.pterodactylus.fcp.ListPeers; +import net.pterodactylus.fcp.ListPersistentRequests; +import net.pterodactylus.fcp.ModifyPeer; +import net.pterodactylus.fcp.ModifyPeerNote; import net.pterodactylus.fcp.NodeHello; +import net.pterodactylus.fcp.NodeRef; import net.pterodactylus.fcp.Peer; +import net.pterodactylus.fcp.PeerNote; +import net.pterodactylus.fcp.PeerRemoved; +import net.pterodactylus.fcp.PersistentGet; +import net.pterodactylus.fcp.PersistentPut; import net.pterodactylus.fcp.ProtocolError; +import net.pterodactylus.fcp.RemovePeer; +import net.pterodactylus.fcp.SSKKeypair; +import net.pterodactylus.fcp.SimpleProgress; +import net.pterodactylus.fcp.WatchGlobal; +import net.pterodactylus.util.thread.ObjectWrapper; /** * High-level FCP client that hides the details of the underlying FCP @@ -136,7 +161,20 @@ public class FcpClient { * if an FCP error occurs */ public void connect() throws IOException, FcpException { - ExtendedFcpAdapter fcpListener = new ExtendedFcpAdapter() { + new ExtendedFcpAdapter() { + + /** + * {@inheritDoc} + */ + @Override + @SuppressWarnings("synthetic-access") + public void run() throws IOException { + fcpConnection.connect(); + ClientHello clientHello = new ClientHello(name); + fcpConnection.sendMessage(clientHello); + WatchGlobal watchGlobal = new WatchGlobal(true); + fcpConnection.sendMessage(watchGlobal); + } /** * {@inheritDoc} @@ -145,26 +183,7 @@ public class FcpClient { public void receivedNodeHello(FcpConnection fcpConnection, NodeHello nodeHello) { completionLatch.countDown(); } - }; - fcpConnection.addFcpListener(fcpListener); - try { - fcpConnection.connect(); - ClientHello clientHello = new ClientHello(name); - fcpConnection.sendMessage(clientHello); - while (true) { - try { - fcpListener.complete(); - break; - } catch (InterruptedException e) { - /* ignore, we’ll loop. */ - } - } - } finally { - fcpConnection.removeFcpListener(fcpListener); - } - if (fcpListener.getFcpException() != null) { - throw fcpListener.getFcpException(); - } + }.execute(); } /** @@ -184,22 +203,41 @@ public class FcpClient { /** * Returns all peers that the node has. * + * @param withMetadata + * true to include peer metadata + * @param withVolatile + * true to include volatile peer data * @return A set containing the node’s peers * @throws IOException * if an I/O error occurs * @throws FcpException * if an FCP error occurs */ - public Set getPeers() throws IOException, FcpException { - final Set peers = new HashSet(); - ExtendedFcpAdapter fcpListener = new ExtendedFcpAdapter() { + public Collection getPeers(final boolean withMetadata, final boolean withVolatile) throws IOException, FcpException { + final Set peers = Collections.synchronizedSet(new HashSet()); + new ExtendedFcpAdapter() { + + /** The ID of the “ListPeers” request. */ + @SuppressWarnings("synthetic-access") + private String identifier = createIdentifier("list-peers"); + + /** + * {@inheritDoc} + */ + @Override + @SuppressWarnings("synthetic-access") + public void run() throws IOException { + fcpConnection.sendMessage(new ListPeers(identifier, withMetadata, withVolatile)); + } /** * {@inheritDoc} */ @Override public void receivedPeer(FcpConnection fcpConnection, Peer peer) { - peers.add(peer); + if (peer.getIdentifier().equals(identifier)) { + peers.add(peer); + } } /** @@ -207,27 +245,531 @@ public class FcpClient { */ @Override public void receivedEndListPeers(FcpConnection fcpConnection, EndListPeers endListPeers) { - completionLatch.countDown(); - } - }; - fcpConnection.addFcpListener(fcpListener); - fcpConnection.sendMessage(new ListPeers("list-peers")); - try { - while (true) { - try { - fcpListener.complete(); - break; - } catch (InterruptedException e) { - /* ignore, we’ll loop. */ + if (endListPeers.getIdentifier().equals(identifier)) { + completionLatch.countDown(); } } - } finally { - fcpConnection.removeFcpListener(fcpListener); + }.execute(); + return peers; + } + + /** + * Returns all darknet peers. + * + * @param withMetadata + * true to include peer metadata + * @param withVolatile + * true to include volatile peer data + * @return A set containing the node’s darknet peers + * @throws IOException + * if an I/O error occurs + * @throws FcpException + * if an FCP error occurs + */ + public Collection getDarknetPeers(boolean withMetadata, boolean withVolatile) throws IOException, FcpException { + Collection allPeers = getPeers(withMetadata, withVolatile); + Collection darknetPeers = new HashSet(); + for (Peer peer : allPeers) { + if (!peer.isOpennet() && !peer.isSeed()) { + darknetPeers.add(peer); + } + } + return darknetPeers; + } + + /** + * Returns all opennet peers. + * + * @param withMetadata + * true to include peer metadata + * @param withVolatile + * true to include volatile peer data + * @return A set containing the node’s opennet peers + * @throws IOException + * if an I/O error occurs + * @throws FcpException + * if an FCP error occurs + */ + public Collection getOpennetPeers(boolean withMetadata, boolean withVolatile) throws IOException, FcpException { + Collection allPeers = getPeers(withMetadata, withVolatile); + Collection opennetPeers = new HashSet(); + for (Peer peer : allPeers) { + if (peer.isOpennet() && !peer.isSeed()) { + opennetPeers.add(peer); + } } - if (fcpListener.getFcpException() != null) { - throw fcpListener.getFcpException(); + return opennetPeers; + } + + /** + * Returns all seed peers. + * + * @param withMetadata + * true to include peer metadata + * @param withVolatile + * true to include volatile peer data + * @return A set containing the node’s seed peers + * @throws IOException + * if an I/O error occurs + * @throws FcpException + * if an FCP error occurs + */ + public Collection getSeedPeers(boolean withMetadata, boolean withVolatile) throws IOException, FcpException { + Collection allPeers = getPeers(withMetadata, withVolatile); + Collection seedPeers = new HashSet(); + for (Peer peer : allPeers) { + if (peer.isSeed()) { + seedPeers.add(peer); + } } - return peers; + return seedPeers; + } + + /** + * Adds the given peer to the node. + * + * @param peer + * The peer to add + * @throws IOException + * if an I/O error occurs + * @throws FcpException + * if an FCP error occurs + */ + public void addPeer(Peer peer) throws IOException, FcpException { + addPeer(peer.getNodeRef()); + } + + /** + * Adds the peer defined by the noderef to the node. + * + * @param nodeRef + * The noderef that defines the new peer + * @throws IOException + * if an I/O error occurs + * @throws FcpException + * if an FCP error occurs + */ + public void addPeer(NodeRef nodeRef) throws IOException, FcpException { + addPeer(new AddPeer(nodeRef)); + } + + /** + * Adds a peer, reading the noderef from the given URL. + * + * @param url + * The URL to read the noderef from + * @throws IOException + * if an I/O error occurs + * @throws FcpException + * if an FCP error occurs + */ + public void addPeer(URL url) throws IOException, FcpException { + addPeer(new AddPeer(url)); + } + + /** + * Adds a peer, reading the noderef of the peer from the given file. + * Note: 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 + * @throws IOException + * if an I/O error occurs + * @throws FcpException + * if an FCP error occurs + */ + public void addPeer(String file) throws IOException, FcpException { + addPeer(new AddPeer(file)); + } + + /** + * Sends the given {@link AddPeer} message to the node. This method should + * not be called directly. Use one of {@link #addPeer(Peer)}, + * {@link #addPeer(NodeRef)}, {@link #addPeer(URL)}, or + * {@link #addPeer(String)} instead. + * + * @param addPeer + * The “AddPeer” message + * @throws IOException + * if an I/O error occurs + * @throws FcpException + * if an FCP error occurs + */ + private void addPeer(final AddPeer addPeer) throws IOException, FcpException { + new ExtendedFcpAdapter() { + + /** + * {@inheritDoc} + */ + @Override + @SuppressWarnings("synthetic-access") + public void run() throws IOException { + fcpConnection.sendMessage(addPeer); + } + + /** + * {@inheritDoc} + */ + @Override + public void receivedPeer(FcpConnection fcpConnection, Peer peer) { + completionLatch.countDown(); + } + }.execute(); + } + + /** + * Modifies the given peer. + * + * @param peer + * The peer to modify + * @param allowLocalAddresses + * true to allow local address, false + * to not allow local address, null to not change + * the setting + * @param disabled + * true to disable the peer, false to + * enable the peer, null to not change the setting + * @param listenOnly + * true to enable “listen only” for the peer, + * false to disable it, null to not + * change it + * @throws IOException + * if an I/O error occurs + * @throws FcpException + * if an FCP error occurs + */ + public void modifyPeer(final Peer peer, final Boolean allowLocalAddresses, final Boolean disabled, final Boolean listenOnly) throws IOException, FcpException { + new ExtendedFcpAdapter() { + + /** + * {@inheritDoc} + */ + @Override + @SuppressWarnings("synthetic-access") + public void run() throws IOException { + fcpConnection.sendMessage(new ModifyPeer(peer.getIdentity(), allowLocalAddresses, disabled, listenOnly)); + } + + /** + * {@inheritDoc} + */ + @Override + public void receivedPeer(FcpConnection fcpConnection, Peer peer) { + completionLatch.countDown(); + } + }.execute(); + } + + /** + * Removes the given peer. + * + * @param peer + * The peer to remove + * @throws IOException + * if an I/O error occurs + * @throws FcpException + * if an FCP error occurs + */ + public void removePeer(final Peer peer) throws IOException, FcpException { + new ExtendedFcpAdapter() { + + /** + * {@inheritDoc} + */ + @Override + @SuppressWarnings("synthetic-access") + public void run() throws IOException { + fcpConnection.sendMessage(new RemovePeer(peer.getIdentity())); + } + + /** + * {@inheritDoc} + */ + @Override + public void receivedPeerRemoved(FcpConnection fcpConnection, PeerRemoved peerRemoved) { + completionLatch.countDown(); + } + }.execute(); + } + + // + // PEER NOTES MANAGEMENT + // + + /** + * Returns the peer note of the given peer. + * + * @param peer + * The peer to get the note for + * @return The peer’s note + * @throws IOException + * if an I/O error occurs + * @throws FcpException + * if an FCP error occurs + */ + public PeerNote getPeerNote(final Peer peer) throws IOException, FcpException { + final ObjectWrapper objectWrapper = new ObjectWrapper(); + new ExtendedFcpAdapter() { + + /** + * {@inheritDoc} + */ + @Override + @SuppressWarnings("synthetic-access") + public void run() throws IOException { + fcpConnection.sendMessage(new ListPeerNotes(peer.getIdentity())); + } + + /** + * {@inheritDoc} + */ + @Override + public void receivedPeerNote(FcpConnection fcpConnection, PeerNote peerNote) { + if (peerNote.getNodeIdentifier().equals(peer.getIdentity())) { + objectWrapper.set(peerNote); + } + } + + /** + * {@inheritDoc} + */ + @Override + public void receivedEndListPeerNotes(FcpConnection fcpConnection, EndListPeerNotes endListPeerNotes) { + completionLatch.countDown(); + } + }.execute(); + return objectWrapper.get(); + } + + /** + * Replaces the peer note for the given peer. + * + * @param peer + * The peer + * @param noteText + * The new base64-encoded note text + * @param noteType + * The type of the note (currently only 1 is + * allowed) + * @throws IOException + * if an I/O error occurs + * @throws FcpException + * if an FCP error occurs + */ + public void modifyPeerNote(final Peer peer, final String noteText, final int noteType) throws IOException, FcpException { + new ExtendedFcpAdapter() { + + /** + * {@inheritDoc} + */ + @Override + @SuppressWarnings("synthetic-access") + public void run() throws IOException { + fcpConnection.sendMessage(new ModifyPeerNote(peer.getIdentity(), noteText, noteType)); + } + + /** + * {@inheritDoc} + */ + @Override + public void receivedPeer(FcpConnection fcpConnection, Peer receivedPeer) { + if (receivedPeer.getIdentity().equals(peer.getIdentity())) { + completionLatch.countDown(); + } + } + }.execute(); + } + + // + // KEY GENERATION + // + + /** + * Generates a new SSK key pair. + * + * @return The generated key pair + * @throws IOException + * if an I/O error occurs + * @throws FcpException + * if an FCP error occurs + */ + public SSKKeypair generateKeyPair() throws IOException, FcpException { + final ObjectWrapper sskKeypairWrapper = new ObjectWrapper(); + new ExtendedFcpAdapter() { + + /** + * {@inheritDoc} + */ + @Override + @SuppressWarnings("synthetic-access") + public void run() throws IOException { + fcpConnection.sendMessage(new GenerateSSK()); + } + + /** + * {@inheritDoc} + */ + @Override + public void receivedSSKKeypair(FcpConnection fcpConnection, SSKKeypair sskKeypair) { + sskKeypairWrapper.set(sskKeypair); + completionLatch.countDown(); + } + }.execute(); + return sskKeypairWrapper.get(); + } + + // + // REQUEST MANAGEMENT + // + + /** + * Returns all currently visible persistent get requests. + * + * @param global + * true to return get requests from the global + * queue, false to only show requests from the + * client-local queue + * @return All get requests + * @throws IOException + * if an I/O error occurs + * @throws FcpException + * if an FCP error occurs + */ + public Collection getGetRequests(final boolean global) throws IOException, FcpException { + return getRequests(global); + } + + /** + * Returns all currently visible persistent requests. + * + * @param global + * true to return requests from the global queue, + * false to only show requests from the client-local + * queue + * @return All requests + * @throws IOException + * if an I/O error occurs + * @throws FcpException + * if an FCP error occurs + */ + public Collection getRequests(final boolean global) throws IOException, FcpException { + final Map requests = Collections.synchronizedMap(new HashMap()); + new ExtendedFcpAdapter() { + + /** + * {@inheritDoc} + */ + @Override + @SuppressWarnings("synthetic-access") + public void run() throws IOException { + fcpConnection.sendMessage(new ListPersistentRequests()); + } + + /** + * {@inheritDoc} + */ + @Override + public void receivedPersistentGet(FcpConnection fcpConnection, PersistentGet persistentGet) { + if (!persistentGet.isGlobal() || global) { + GetRequest getRequest = new GetRequest(persistentGet); + requests.put(persistentGet.getIdentifier(), getRequest); + } + } + + /** + * {@inheritDoc} + * + * @see net.pterodactylus.fcp.FcpAdapter#receivedDataFound(net.pterodactylus.fcp.FcpConnection, + * net.pterodactylus.fcp.DataFound) + */ + @Override + public void receivedDataFound(FcpConnection fcpConnection, DataFound dataFound) { + Request getRequest = requests.get(dataFound.getIdentifier()); + if (getRequest == null) { + return; + } + getRequest.setComplete(true); + getRequest.setLength(dataFound.getDataLength()); + getRequest.setContentType(dataFound.getMetadataContentType()); + } + + /** + * {@inheritDoc} + * + * @see net.pterodactylus.fcp.FcpAdapter#receivedGetFailed(net.pterodactylus.fcp.FcpConnection, + * net.pterodactylus.fcp.GetFailed) + */ + @Override + public void receivedGetFailed(FcpConnection fcpConnection, GetFailed getFailed) { + Request getRequest = requests.get(getFailed.getIdentifier()); + if (getRequest == null) { + return; + } + getRequest.setComplete(true); + getRequest.setFailed(true); + getRequest.setFatal(getFailed.isFatal()); + getRequest.setErrorCode(getFailed.getCode()); + } + + /** + * {@inheritDoc} + * + * @see net.pterodactylus.fcp.FcpAdapter#receivedPersistentPut(net.pterodactylus.fcp.FcpConnection, + * net.pterodactylus.fcp.PersistentPut) + */ + @Override + public void receivedPersistentPut(FcpConnection fcpConnection, PersistentPut persistentPut) { + if (!persistentPut.isGlobal() || global) { + PutRequest putRequest = new PutRequest(persistentPut); + requests.put(persistentPut.getIdentifier(), putRequest); + } + } + + /** + * {@inheritDoc} + * + * @see net.pterodactylus.fcp.FcpAdapter#receivedSimpleProgress(net.pterodactylus.fcp.FcpConnection, + * net.pterodactylus.fcp.SimpleProgress) + */ + @Override + public void receivedSimpleProgress(FcpConnection fcpConnection, SimpleProgress simpleProgress) { + Request request = requests.get(simpleProgress.getIdentifier()); + if (request == null) { + return; + } + request.setTotalBlocks(simpleProgress.getTotal()); + request.setRequiredBlocks(simpleProgress.getRequired()); + request.setFailedBlocks(simpleProgress.getFailed()); + request.setFatallyFailedBlocks(simpleProgress.getFatallyFailed()); + request.setSucceededBlocks(simpleProgress.getSucceeded()); + request.setFinalizedTotal(simpleProgress.isFinalizedTotal()); + } + + /** + * {@inheritDoc} + */ + @Override + public void receivedEndListPersistentRequests(FcpConnection fcpConnection, EndListPersistentRequests endListPersistentRequests) { + completionLatch.countDown(); + } + }.execute(); + return requests.values(); + } + + // + // PRIVATE METHODS + // + + /** + * Creates a unique request identifier. + * + * @param basename + * The basename of the request + * @return The created request identifier + */ + private String createIdentifier(String basename) { + return basename + "-" + System.currentTimeMillis() + "-" + (int) (Math.random() * Integer.MAX_VALUE); } /** @@ -236,7 +778,7 @@ public class FcpClient { * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ - private static class ExtendedFcpAdapter extends FcpAdapter { + private abstract class ExtendedFcpAdapter extends FcpAdapter { /** The count down latch used to wait for completion. */ protected final CountDownLatch completionLatch = new CountDownLatch(1); @@ -252,24 +794,42 @@ public class FcpClient { } /** - * Returns the FCP exception that occured. If no FCP exception occured, - * null is returned. + * Executes the FCP commands in {@link #run()}, wrapping the execution + * and catching exceptions. * - * @return The FCP exception that occured, or null + * @throws IOException + * if an I/O error occurs + * @throws FcpException + * if an FCP error occurs */ - public FcpException getFcpException() { - return fcpException; + @SuppressWarnings("synthetic-access") + public void execute() throws IOException, FcpException { + fcpConnection.addFcpListener(this); + try { + run(); + while (true) { + try { + completionLatch.await(); + break; + } catch (InterruptedException ie1) { + /* ignore, we’ll loop. */ + } + } + } finally { + fcpConnection.removeFcpListener(this); + } + if (fcpException != null) { + throw fcpException; + } } /** - * Waits for the completion of the command. + * The FCP commands that actually get executed. * - * @throws InterruptedException - * if {@link CountDownLatch#await()} is interrupted + * @throws IOException + * if an I/O error occurs */ - public void complete() throws InterruptedException { - completionLatch.await(); - } + public abstract void run() throws IOException; /** * {@inheritDoc}