Add “getPutRequests” method.
[jFCPlib.git] / src / net / pterodactylus / fcp / highlevel / FcpClient.java
index 3014aa9..f90ab77 100644 (file)
@@ -23,25 +23,46 @@ 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.filter.Filter;
+import net.pterodactylus.util.filter.Filters;
+import net.pterodactylus.util.thread.ObjectWrapper;
 
 /**
  * High-level FCP client that hides the details of the underlying FCP
@@ -142,7 +163,7 @@ public class FcpClient {
         *             if an FCP error occurs
         */
        public void connect() throws IOException, FcpException {
-               ExtendedFcpAdapter fcpListener = new ExtendedFcpAdapter() {
+               new ExtendedFcpAdapter() {
 
                        /**
                         * {@inheritDoc}
@@ -153,6 +174,8 @@ public class FcpClient {
                                fcpConnection.connect();
                                ClientHello clientHello = new ClientHello(name);
                                fcpConnection.sendMessage(clientHello);
+                               WatchGlobal watchGlobal = new WatchGlobal(true);
+                               fcpConnection.sendMessage(watchGlobal);
                        }
 
                        /**
@@ -162,8 +185,7 @@ public class FcpClient {
                        public void receivedNodeHello(FcpConnection fcpConnection, NodeHello nodeHello) {
                                completionLatch.countDown();
                        }
-               };
-               fcpListener.execute();
+               }.execute();
        }
 
        /**
@@ -193,9 +215,13 @@ public class FcpClient {
         * @throws FcpException
         *             if an FCP error occurs
         */
-       public Set<Peer> getPeers(final boolean withMetadata, final boolean withVolatile) throws IOException, FcpException {
-               final Set<Peer> peers = new HashSet<Peer>();
-               ExtendedFcpAdapter fcpListener = new ExtendedFcpAdapter() {
+       public Collection<Peer> getPeers(final boolean withMetadata, final boolean withVolatile) throws IOException, FcpException {
+               final Set<Peer> peers = Collections.synchronizedSet(new HashSet<Peer>());
+               new ExtendedFcpAdapter() {
+
+                       /** The ID of the “ListPeers” request. */
+                       @SuppressWarnings("synthetic-access")
+                       private String identifier = createIdentifier("list-peers");
 
                        /**
                         * {@inheritDoc}
@@ -203,7 +229,7 @@ public class FcpClient {
                        @Override
                        @SuppressWarnings("synthetic-access")
                        public void run() throws IOException {
-                               fcpConnection.sendMessage(new ListPeers("list-peers", withMetadata, withVolatile));
+                               fcpConnection.sendMessage(new ListPeers(identifier, withMetadata, withVolatile));
                        }
 
                        /**
@@ -211,7 +237,9 @@ public class FcpClient {
                         */
                        @Override
                        public void receivedPeer(FcpConnection fcpConnection, Peer peer) {
-                               peers.add(peer);
+                               if (peer.getIdentifier().equals(identifier)) {
+                                       peers.add(peer);
+                               }
                        }
 
                        /**
@@ -219,14 +247,87 @@ public class FcpClient {
                         */
                        @Override
                        public void receivedEndListPeers(FcpConnection fcpConnection, EndListPeers endListPeers) {
-                               completionLatch.countDown();
+                               if (endListPeers.getIdentifier().equals(identifier)) {
+                                       completionLatch.countDown();
+                               }
                        }
-               };
-               fcpListener.execute();
+               }.execute();
                return peers;
        }
 
        /**
+        * Returns all darknet peers.
+        *
+        * @param withMetadata
+        *            <code>true</code> to include peer metadata
+        * @param withVolatile
+        *            <code>true</code> 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<Peer> getDarknetPeers(boolean withMetadata, boolean withVolatile) throws IOException, FcpException {
+               Collection<Peer> allPeers = getPeers(withMetadata, withVolatile);
+               Collection<Peer> darknetPeers = new HashSet<Peer>();
+               for (Peer peer : allPeers) {
+                       if (!peer.isOpennet() && !peer.isSeed()) {
+                               darknetPeers.add(peer);
+                       }
+               }
+               return darknetPeers;
+       }
+
+       /**
+        * Returns all opennet peers.
+        *
+        * @param withMetadata
+        *            <code>true</code> to include peer metadata
+        * @param withVolatile
+        *            <code>true</code> 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<Peer> getOpennetPeers(boolean withMetadata, boolean withVolatile) throws IOException, FcpException {
+               Collection<Peer> allPeers = getPeers(withMetadata, withVolatile);
+               Collection<Peer> opennetPeers = new HashSet<Peer>();
+               for (Peer peer : allPeers) {
+                       if (peer.isOpennet() && !peer.isSeed()) {
+                               opennetPeers.add(peer);
+                       }
+               }
+               return opennetPeers;
+       }
+
+       /**
+        * Returns all seed peers.
+        *
+        * @param withMetadata
+        *            <code>true</code> to include peer metadata
+        * @param withVolatile
+        *            <code>true</code> 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<Peer> getSeedPeers(boolean withMetadata, boolean withVolatile) throws IOException, FcpException {
+               Collection<Peer> allPeers = getPeers(withMetadata, withVolatile);
+               Collection<Peer> seedPeers = new HashSet<Peer>();
+               for (Peer peer : allPeers) {
+                       if (peer.isSeed()) {
+                               seedPeers.add(peer);
+                       }
+               }
+               return seedPeers;
+       }
+
+       /**
         * Adds the given peer to the node.
         *
         * @param peer
@@ -298,7 +399,7 @@ public class FcpClient {
         *             if an FCP error occurs
         */
        private void addPeer(final AddPeer addPeer) throws IOException, FcpException {
-               ExtendedFcpAdapter fcpListener = new ExtendedFcpAdapter() {
+               new ExtendedFcpAdapter() {
 
                        /**
                         * {@inheritDoc}
@@ -316,8 +417,7 @@ public class FcpClient {
                        public void receivedPeer(FcpConnection fcpConnection, Peer peer) {
                                completionLatch.countDown();
                        }
-               };
-               fcpListener.execute();
+               }.execute();
        }
 
        /**
@@ -342,7 +442,7 @@ public class FcpClient {
         *             if an FCP error occurs
         */
        public void modifyPeer(final Peer peer, final Boolean allowLocalAddresses, final Boolean disabled, final Boolean listenOnly) throws IOException, FcpException {
-               ExtendedFcpAdapter fcpListener = new ExtendedFcpAdapter() {
+               new ExtendedFcpAdapter() {
 
                        /**
                         * {@inheritDoc}
@@ -360,8 +460,7 @@ public class FcpClient {
                        public void receivedPeer(FcpConnection fcpConnection, Peer peer) {
                                completionLatch.countDown();
                        }
-               };
-               fcpListener.execute();
+               }.execute();
        }
 
        /**
@@ -375,7 +474,7 @@ public class FcpClient {
         *             if an FCP error occurs
         */
        public void removePeer(final Peer peer) throws IOException, FcpException {
-               ExtendedFcpAdapter fcpListener = new ExtendedFcpAdapter() {
+               new ExtendedFcpAdapter() {
 
                        /**
                         * {@inheritDoc}
@@ -393,8 +492,319 @@ public class FcpClient {
                        public void receivedPeerRemoved(FcpConnection fcpConnection, PeerRemoved peerRemoved) {
                                completionLatch.countDown();
                        }
-               };
-               fcpListener.execute();
+               }.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<PeerNote> objectWrapper = new ObjectWrapper<PeerNote>();
+               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 <code>1</code> 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<SSKKeypair> sskKeypairWrapper = new ObjectWrapper<SSKKeypair>();
+               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
+        *            <code>true</code> to return get requests from the global
+        *            queue, <code>false</code> 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<Request> getGetRequests(final boolean global) throws IOException, FcpException {
+               return Filters.filteredCollection(getRequests(global), new Filter<Request>() {
+
+                       /**
+                        * {@inheritDoc}
+                        */
+                       public boolean filterObject(Request request) {
+                               return request instanceof GetRequest;
+                       }
+               });
+       }
+
+       /**
+        * Returns all currently visible persistent put requests.
+        *
+        * @param global
+        *            <code>true</code> to return put requests from the global
+        *            queue, <code>false</code> to only show requests from the
+        *            client-local queue
+        * @return All put requests
+        * @throws IOException
+        *             if an I/O error occurs
+        * @throws FcpException
+        *             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 request instanceof PutRequest;
+                       }
+               });
+       }
+
+       /**
+        * Returns all currently visible persistent requests.
+        *
+        * @param global
+        *            <code>true</code> to return requests from the global queue,
+        *            <code>false</code> 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<Request> getRequests(final boolean global) throws IOException, FcpException {
+               final Map<String, Request> requests = Collections.synchronizedMap(new HashMap<String, Request>());
+               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);
        }
 
        /**