add listener for progress events
[jFCPlib.git] / src / net / pterodactylus / fcp / highlevel / HighLevelClient.java
index 0ec6da6..a09b289 100644 (file)
@@ -27,10 +27,13 @@ import java.io.IOException;
 import java.net.InetAddress;
 import java.net.URL;
 import java.net.UnknownHostException;
+import java.util.ArrayList;
 import java.util.Collections;
 import java.util.HashMap;
+import java.util.List;
 import java.util.Map;
 import java.util.Map.Entry;
+import java.util.logging.Level;
 import java.util.logging.Logger;
 
 import net.pterodactylus.fcp.AddPeer;
@@ -53,6 +56,7 @@ import net.pterodactylus.fcp.GenerateSSK;
 import net.pterodactylus.fcp.GetFailed;
 import net.pterodactylus.fcp.IdentifierCollision;
 import net.pterodactylus.fcp.ListPeers;
+import net.pterodactylus.fcp.ListPersistentRequests;
 import net.pterodactylus.fcp.NodeData;
 import net.pterodactylus.fcp.NodeHello;
 import net.pterodactylus.fcp.NodeRef;
@@ -81,6 +85,7 @@ import net.pterodactylus.fcp.TestDDAResponse;
 import net.pterodactylus.fcp.URIGenerated;
 import net.pterodactylus.fcp.UnknownNodeIdentifier;
 import net.pterodactylus.fcp.UnknownPeerNoteType;
+import net.pterodactylus.fcp.WatchGlobal;
 
 /**
  * A high-level client that allows simple yet full-featured access to a Freenet
@@ -109,9 +114,15 @@ public class HighLevelClient {
        /** The FCP connection to the node. */
        private FcpConnection fcpConnection;
 
+       /** Listeners for high-level client events. */
+       private List<HighLevelClientListener> highLevelClientListeners = Collections.synchronizedList(new ArrayList<HighLevelClientListener>());
+
        /** The listener for the connection. */
        private HighLevelClientFcpListener highLevelClientFcpListener = new HighLevelClientFcpListener();
 
+       /** The listeners for progress events. */
+       private List<HighLevelProgressListener> highLevelProgressListeners = Collections.synchronizedList(new ArrayList<HighLevelProgressListener>());
+
        /** The callback for {@link #connect()}. */
        private HighLevelCallback<ConnectResult> connectCallback;
 
@@ -130,6 +141,9 @@ public class HighLevelClient {
        /** Mapping from request identifiers to download callbacks. */
        private Map<String, HighLevelProgressCallback<DownloadResult>> downloadCallbacks = Collections.synchronizedMap(new HashMap<String, HighLevelProgressCallback<DownloadResult>>());
 
+       /** The callback for {@link #getRequests()}. */
+       private HighLevelCallback<RequestListResult> requestListCallback;
+
        /**
         * Creates a new high-level client that connects to a node on
         * <code>localhost</code>.
@@ -193,9 +207,101 @@ public class HighLevelClient {
        }
 
        //
+       // EVENT MANAGEMENT
+       //
+
+       /**
+        * Adds the given high-level client listener to list of listeners.
+        * 
+        * @param highLevelClientListener
+        *            The listener to add
+        */
+       public void addHighLevelClientListener(HighLevelClientListener highLevelClientListener) {
+               highLevelClientListeners.add(highLevelClientListener);
+       }
+
+       /**
+        * Removes the given high-level client listener from the list of listeners.
+        * 
+        * @param highLevelClientListener
+        *            The listener to remove
+        */
+       public void removeHighLevelClientListener(HighLevelClientListener highLevelClientListener) {
+               highLevelClientListeners.remove(highLevelClientListener);
+       }
+
+       /**
+        * Notifies all listeners that a client has connected.
+        */
+       private void fireClientConnected() {
+               for (HighLevelClientListener highLevelClientListener: highLevelClientListeners) {
+                       highLevelClientListener.clientConnected(this);
+               }
+       }
+
+       /**
+        * Notifies all listeners that a client has disconnected.
+        * 
+        * @param throwable
+        *            The exception that caused the disconnect, or <code>null</code>
+        *            if there was no exception
+        */
+       private void fireClientDisconnected(Throwable throwable) {
+               for (HighLevelClientListener highLevelClientListener: highLevelClientListeners) {
+                       highLevelClientListener.clientDisconnected(this, throwable);
+               }
+       }
+
+       /**
+        * Adds a high-level progress listener.
+        * 
+        * @param highLevelProgressListener
+        *            The high-level progress listener to add
+        */
+       public void addHighLevelProgressListener(HighLevelProgressListener highLevelProgressListener) {
+               highLevelProgressListeners.add(highLevelProgressListener);
+       }
+
+       /**
+        * Removes a high-level progress listener.
+        * 
+        * @param highLevelProgressListener
+        *            The high-level progress listener to remove
+        */
+       public void removeHighLevelProgressListener(HighLevelProgressListener highLevelProgressListener) {
+               highLevelProgressListeners.remove(highLevelProgressListener);
+       }
+
+       /**
+        * Notifies all listeners that the request with the given identifier made
+        * some progress.
+        * 
+        * @param identifier
+        *            The identifier of the request
+        * @param highLevelProgress
+        *            The progress of the request
+        */
+       private void fireProgressReceived(String identifier, HighLevelProgress highLevelProgress) {
+               for (HighLevelProgressListener highLevelProgressListener: highLevelProgressListeners) {
+                       highLevelProgressListener.progressReceived(identifier, highLevelProgress);
+               }
+       }
+
+       //
        // ACCESSORS
        //
 
+       /**
+        * Returns the FCP connection that backs this high-level client. This method
+        * should be used with care as fiddling around with the FCP connection can
+        * easily break the high-level client if you don’t know what you’re doing!
+        * 
+        * @return The FCP connection of this client
+        */
+       public FcpConnection getFcpConnection() {
+               return fcpConnection;
+       }
+
        //
        // ACTIONS
        //
@@ -210,6 +316,7 @@ public class HighLevelClient {
        public HighLevelCallback<ConnectResult> connect() throws IOException {
                fcpConnection = new FcpConnection(address, port);
                fcpConnection.addFcpListener(highLevelClientFcpListener);
+               fcpConnection.connect();
                ClientHello clientHello = new ClientHello(clientName);
                connectCallback = new HighLevelCallback<ConnectResult>(new ConnectResult());
                fcpConnection.sendMessage(clientHello);
@@ -220,6 +327,7 @@ public class HighLevelClient {
         * Disconnects the client from the node.
         */
        public void disconnect() {
+               disconnect(null);
        }
 
        /**
@@ -239,6 +347,21 @@ public class HighLevelClient {
        }
 
        /**
+        * Sets whether to watch the global queue.
+        * 
+        * @param enabled
+        *            <code>true</code> to watch the global queue in addition to
+        *            the client-local queue, <code>false</code> to only watch the
+        *            client-local queue
+        * @throws IOException
+        *             if an I/O error occurs communicating with the node
+        */
+       public void setWatchGlobal(boolean enabled) throws IOException {
+               WatchGlobal watchGlobal = new WatchGlobal(enabled);
+               fcpConnection.sendMessage(watchGlobal);
+       }
+
+       /**
         * Gets a list of all peers from the node.
         * 
         * @return A callback with the peer list
@@ -358,6 +481,26 @@ public class HighLevelClient {
                return downloadCallback;
        }
 
+       /**
+        * Requests a list of all running requests from the node.
+        * 
+        * @return The request list result
+        * @throws IOException
+        *             if an I/O errors communicating with the node
+        */
+       public HighLevelCallback<RequestListResult> getRequests() throws IOException {
+               String identifier = generateIdentifier("list-persistent-requests");
+               ListPersistentRequests listPersistentRequests = new ListPersistentRequests();
+               synchronized (syncObject) {
+                       if (requestListCallback != null) {
+                               logger.log(Level.SEVERE, "getRequests() called with request still running!");
+                       }
+                       requestListCallback = new HighLevelCallback<RequestListResult>(new RequestListResult(identifier));
+               }
+               fcpConnection.sendMessage(listPersistentRequests);
+               return requestListCallback;
+       }
+
        //
        // PRIVATE METHODS
        //
@@ -374,6 +517,19 @@ public class HighLevelClient {
        }
 
        /**
+        * Disconnects the client from the node, handing the given Throwable to
+        * {@link #fireClientDisconnected(Throwable)}.
+        * 
+        * @param throwable
+        *            The exception that caused the disconnect, or <code>null</code>
+        *            if there was no exception
+        */
+       private void disconnect(Throwable throwable) {
+               fcpConnection.close();
+               fireClientDisconnected(throwable);
+       }
+
+       /**
         * FCP listener for {@link HighLevelClient}.
         * 
         * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
@@ -388,6 +544,7 @@ public class HighLevelClient {
                 * Creates a new FCP listener for {@link HighLevelClient}.
                 */
                HighLevelClientFcpListener() {
+                       /* do nothing. */
                }
 
                //
@@ -410,6 +567,11 @@ public class HighLevelClient {
                                        connectCallback.setDone();
                                        connectCallback = null;
                                }
+                               if (requestListCallback != null) {
+                                       requestListCallback.getIntermediaryResult().setFailed(true);
+                                       requestListCallback.setDone();
+                                       requestListCallback = null;
+                               }
                        }
                        if (identifier == null) {
                                /* key generation callbacks */
@@ -547,14 +709,16 @@ public class HighLevelClient {
                //
 
                /**
-                * @see net.pterodactylus.fcp.FcpListener#connectionClosed(net.pterodactylus.fcp.FcpConnection)
+                * @see net.pterodactylus.fcp.FcpListener#connectionClosed(net.pterodactylus.fcp.FcpConnection,
+                *      Throwable)
                 */
                @SuppressWarnings("synthetic-access")
-               public void connectionClosed(FcpConnection fcpConnection) {
+               public void connectionClosed(FcpConnection fcpConnection, Throwable throwable) {
                        if (fcpConnection != HighLevelClient.this.fcpConnection) {
                                return;
                        }
                        cancelIdentifier(null);
+                       disconnect(throwable);
                }
 
                /**
@@ -562,6 +726,7 @@ public class HighLevelClient {
                 *      net.pterodactylus.fcp.AllData)
                 */
                public void receivedAllData(FcpConnection fcpConnection, AllData allData) {
+                       /* TODO */
                }
 
                /**
@@ -569,6 +734,7 @@ public class HighLevelClient {
                 *      net.pterodactylus.fcp.CloseConnectionDuplicateClientName)
                 */
                public void receivedCloseConnectionDuplicateClientName(FcpConnection fcpConnection, CloseConnectionDuplicateClientName closeConnectionDuplicateClientName) {
+                       /* TODO */
                }
 
                /**
@@ -576,6 +742,7 @@ public class HighLevelClient {
                 *      net.pterodactylus.fcp.ConfigData)
                 */
                public void receivedConfigData(FcpConnection fcpConnection, ConfigData configData) {
+                       /* TODO */
                }
 
                /**
@@ -583,6 +750,7 @@ public class HighLevelClient {
                 *      net.pterodactylus.fcp.DataFound)
                 */
                public void receivedDataFound(FcpConnection fcpConnection, DataFound dataFound) {
+                       /* TODO */
                }
 
                /**
@@ -590,6 +758,7 @@ public class HighLevelClient {
                 *      net.pterodactylus.fcp.EndListPeerNotes)
                 */
                public void receivedEndListPeerNotes(FcpConnection fcpConnection, EndListPeerNotes endListPeerNotes) {
+                       /* TODO */
                }
 
                /**
@@ -613,7 +782,19 @@ public class HighLevelClient {
                 * @see net.pterodactylus.fcp.FcpListener#receivedEndListPersistentRequests(net.pterodactylus.fcp.FcpConnection,
                 *      net.pterodactylus.fcp.EndListPersistentRequests)
                 */
+               @SuppressWarnings("synthetic-access")
                public void receivedEndListPersistentRequests(FcpConnection fcpConnection, EndListPersistentRequests endListPersistentRequests) {
+                       if (fcpConnection != HighLevelClient.this.fcpConnection) {
+                               return;
+                       }
+                       synchronized (syncObject) {
+                               if (HighLevelClient.this.requestListCallback == null) {
+                                       logger.log(Level.WARNING, "got EndListPersistentRequests without running request!");
+                                       return;
+                               }
+                               requestListCallback.setDone();
+                               requestListCallback = null;
+                       }
                }
 
                /**
@@ -621,6 +802,7 @@ public class HighLevelClient {
                 *      net.pterodactylus.fcp.FCPPluginReply)
                 */
                public void receivedFCPPluginReply(FcpConnection fcpConnection, FCPPluginReply fcpPluginReply) {
+                       /* TODO */
                }
 
                /**
@@ -648,6 +830,7 @@ public class HighLevelClient {
                 *      net.pterodactylus.fcp.IdentifierCollision)
                 */
                public void receivedIdentifierCollision(FcpConnection fcpConnection, IdentifierCollision identifierCollision) {
+                       /* TODO */
                }
 
                /**
@@ -655,6 +838,7 @@ public class HighLevelClient {
                 *      net.pterodactylus.fcp.FcpMessage)
                 */
                public void receivedMessage(FcpConnection fcpConnection, FcpMessage fcpMessage) {
+                       /* TODO */
                }
 
                /**
@@ -662,6 +846,7 @@ public class HighLevelClient {
                 *      net.pterodactylus.fcp.NodeData)
                 */
                public void receivedNodeData(FcpConnection fcpConnection, NodeData nodeData) {
+                       /* TODO */
                }
 
                /**
@@ -678,6 +863,7 @@ public class HighLevelClient {
                                connectCallback.setDone();
                                connectCallback = null;
                        }
+                       fireClientConnected();
                }
 
                /**
@@ -712,6 +898,7 @@ public class HighLevelClient {
                 *      net.pterodactylus.fcp.PeerNote)
                 */
                public void receivedPeerNote(FcpConnection fcpConnection, PeerNote peerNote) {
+                       /* TODO */
                }
 
                /**
@@ -719,6 +906,7 @@ public class HighLevelClient {
                 *      net.pterodactylus.fcp.PeerRemoved)
                 */
                public void receivedPeerRemoved(FcpConnection fcpConnection, PeerRemoved peerRemoved) {
+                       /* TODO */
                }
 
                /**
@@ -730,9 +918,16 @@ public class HighLevelClient {
                        if (fcpConnection != HighLevelClient.this.fcpConnection) {
                                return;
                        }
+                       synchronized (syncObject) {
+                               if (requestListCallback != null) {
+                                       RequestListResult requestListResult = requestListCallback.getIntermediaryResult();
+                                       requestListResult.addRequestResult(new GetRequestResult(persistentGet));
+                                       return;
+                               }
+                       }
                        String identifier = persistentGet.getIdentifier();
                        if (downloadCallbacks.containsKey(identifier)) {
-                               /* ignore, because a download does not care about this. */
+                               /* TODO */
                                return;
                        }
                }
@@ -741,14 +936,36 @@ public class HighLevelClient {
                 * @see net.pterodactylus.fcp.FcpListener#receivedPersistentPut(net.pterodactylus.fcp.FcpConnection,
                 *      net.pterodactylus.fcp.PersistentPut)
                 */
+               @SuppressWarnings("synthetic-access")
                public void receivedPersistentPut(FcpConnection fcpConnection, PersistentPut persistentPut) {
+                       if (fcpConnection != HighLevelClient.this.fcpConnection) {
+                               return;
+                       }
+                       synchronized (syncObject) {
+                               if (requestListCallback != null) {
+                                       RequestListResult requestListResult = requestListCallback.getIntermediaryResult();
+                                       requestListResult.addRequestResult(new PutRequestResult(persistentPut));
+                                       return;
+                               }
+                       }
                }
 
                /**
                 * @see net.pterodactylus.fcp.FcpListener#receivedPersistentPutDir(net.pterodactylus.fcp.FcpConnection,
                 *      net.pterodactylus.fcp.PersistentPutDir)
                 */
+               @SuppressWarnings("synthetic-access")
                public void receivedPersistentPutDir(FcpConnection fcpConnection, PersistentPutDir persistentPutDir) {
+                       if (fcpConnection != HighLevelClient.this.fcpConnection) {
+                               return;
+                       }
+                       synchronized (syncObject) {
+                               if (requestListCallback != null) {
+                                       RequestListResult requestListResult = requestListCallback.getIntermediaryResult();
+                                       requestListResult.addRequestResult(new PutDirRequestResult(persistentPutDir));
+                                       return;
+                               }
+                       }
                }
 
                /**
@@ -756,6 +973,7 @@ public class HighLevelClient {
                 *      net.pterodactylus.fcp.PersistentRequestModified)
                 */
                public void receivedPersistentRequestModified(FcpConnection fcpConnection, PersistentRequestModified persistentRequestModified) {
+                       /* TODO */
                }
 
                /**
@@ -763,6 +981,7 @@ public class HighLevelClient {
                 *      net.pterodactylus.fcp.PersistentRequestRemoved)
                 */
                public void receivedPersistentRequestRemoved(FcpConnection fcpConnection, PersistentRequestRemoved persistentRequestRemoved) {
+                       /* TODO */
                }
 
                /**
@@ -770,6 +989,7 @@ public class HighLevelClient {
                 *      net.pterodactylus.fcp.PluginInfo)
                 */
                public void receivedPluginInfo(FcpConnection fcpConnection, PluginInfo pluginInfo) {
+                       /* TODO */
                }
 
                /**
@@ -793,6 +1013,7 @@ public class HighLevelClient {
                 *      net.pterodactylus.fcp.PutFailed)
                 */
                public void receivedPutFailed(FcpConnection fcpConnection, PutFailed putFailed) {
+                       /* TODO */
                }
 
                /**
@@ -800,6 +1021,7 @@ public class HighLevelClient {
                 *      net.pterodactylus.fcp.PutFetchable)
                 */
                public void receivedPutFetchable(FcpConnection fcpConnection, PutFetchable putFetchable) {
+                       /* TODO */
                }
 
                /**
@@ -807,6 +1029,7 @@ public class HighLevelClient {
                 *      net.pterodactylus.fcp.PutSuccessful)
                 */
                public void receivedPutSuccessful(FcpConnection fcpConnection, PutSuccessful putSuccessful) {
+                       /* TODO */
                }
 
                /**
@@ -850,8 +1073,8 @@ public class HighLevelClient {
                                downloadCallback.progressUpdated();
                                return;
                        }
-                       /* unknown identifier? */
-                       logger.warning("unknown identifier for SimpleProgress: " + identifier);
+                       HighLevelProgress highLevelProgress = new HighLevelProgress(identifier, simpleProgress.getTotal(), simpleProgress.getRequired(), simpleProgress.getSucceeded(), simpleProgress.getFailed(), simpleProgress.getFatallyFailed(), simpleProgress.isFinalizedTotal());
+                       fireProgressReceived(identifier, highLevelProgress);
                }
 
                /**
@@ -859,6 +1082,7 @@ public class HighLevelClient {
                 *      net.pterodactylus.fcp.StartedCompression)
                 */
                public void receivedStartedCompression(FcpConnection fcpConnection, StartedCompression startedCompression) {
+                       /* TODO */
                }
 
                /**
@@ -866,6 +1090,7 @@ public class HighLevelClient {
                 *      net.pterodactylus.fcp.SubscribedUSKUpdate)
                 */
                public void receivedSubscribedUSKUpdate(FcpConnection fcpConnection, SubscribedUSKUpdate subscribedUSKUpdate) {
+                       /* TODO */
                }
 
                /**
@@ -921,6 +1146,7 @@ public class HighLevelClient {
                 *      net.pterodactylus.fcp.URIGenerated)
                 */
                public void receivedURIGenerated(FcpConnection fcpConnection, URIGenerated uriGenerated) {
+                       /* TODO */
                }
 
                /**
@@ -928,6 +1154,7 @@ public class HighLevelClient {
                 *      net.pterodactylus.fcp.UnknownNodeIdentifier)
                 */
                public void receivedUnknownNodeIdentifier(FcpConnection fcpConnection, UnknownNodeIdentifier unknownNodeIdentifier) {
+                       /* TODO */
                }
 
                /**
@@ -935,6 +1162,7 @@ public class HighLevelClient {
                 *      net.pterodactylus.fcp.UnknownPeerNoteType)
                 */
                public void receivedUnknownPeerNoteType(FcpConnection fcpConnection, UnknownPeerNoteType unknownPeerNoteType) {
+                       /* TODO */
                }
 
                /**
@@ -942,6 +1170,7 @@ public class HighLevelClient {
                 *      net.pterodactylus.fcp.FinishedCompression)
                 */
                public void receviedFinishedCompression(FcpConnection fcpConnection, FinishedCompression finishedCompression) {
+                       /* TODO */
                }
 
        }