X-Git-Url: https://git.pterodactylus.net/?a=blobdiff_plain;f=src%2Fnet%2Fpterodactylus%2Ffcp%2Fhighlevel%2FHighLevelClient.java;h=e62c4286b9a5a38ea9f68965306a816225e8bb88;hb=fe63c7b7081dec41b85df862cb8358fcfbeb452e;hp=d5252add3dbca752784bbb9a0dae428e0d99d930;hpb=2f02ab2738b81ca887fcdd2fa88db8eb07cc58b7;p=jFCPlib.git diff --git a/src/net/pterodactylus/fcp/highlevel/HighLevelClient.java b/src/net/pterodactylus/fcp/highlevel/HighLevelClient.java index d5252ad..e62c428 100644 --- a/src/net/pterodactylus/fcp/highlevel/HighLevelClient.java +++ b/src/net/pterodactylus/fcp/highlevel/HighLevelClient.java @@ -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,11 +85,12 @@ 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 * node. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> * @version $Id$ */ @@ -109,9 +114,15 @@ public class HighLevelClient { /** The FCP connection to the node. */ private FcpConnection fcpConnection; + /** Listeners for high-level client events. */ + private List highLevelClientListeners = Collections.synchronizedList(new ArrayList()); + /** The listener for the connection. */ private HighLevelClientFcpListener highLevelClientFcpListener = new HighLevelClientFcpListener(); + /** The listeners for progress events. */ + private List highLevelProgressListeners = Collections.synchronizedList(new ArrayList()); + /** The callback for {@link #connect()}. */ private HighLevelCallback connectCallback; @@ -130,10 +141,13 @@ public class HighLevelClient { /** Mapping from request identifiers to download callbacks. */ private Map> downloadCallbacks = Collections.synchronizedMap(new HashMap>()); + /** The callback for {@link #getRequests()}. */ + private HighLevelCallback requestListCallback; + /** * Creates a new high-level client that connects to a node on * localhost. - * + * * @param clientName * The name of the client * @throws UnknownHostException @@ -146,7 +160,7 @@ public class HighLevelClient { /** * Creates a new high-level client that connects to a node on the given * host. - * + * * @param clientName * The name of the client * @param host @@ -161,7 +175,7 @@ public class HighLevelClient { /** * Creates a new high-level client that connects to a node on the given * host. - * + * * @param clientName * The name of the client * @param host @@ -178,7 +192,7 @@ public class HighLevelClient { /** * Creates a new high-level client that connects to a node at the given * address. - * + * * @param clientName * The name of the client * @param address @@ -193,6 +207,87 @@ 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 null + * 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 // @@ -200,7 +295,7 @@ public class HighLevelClient { * 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() { @@ -213,7 +308,7 @@ public class HighLevelClient { /** * Connects the client. - * + * * @return A callback with a connection result * @throws IOException * if an I/O error occurs communicating with the node @@ -221,6 +316,7 @@ public class HighLevelClient { public HighLevelCallback connect() throws IOException { fcpConnection = new FcpConnection(address, port); fcpConnection.addFcpListener(highLevelClientFcpListener); + fcpConnection.connect(); ClientHello clientHello = new ClientHello(clientName); connectCallback = new HighLevelCallback(new ConnectResult()); fcpConnection.sendMessage(clientHello); @@ -231,12 +327,12 @@ public class HighLevelClient { * Disconnects the client from the node. */ public void disconnect() { - fcpConnection.close(); + disconnect(null); } /** * Generates a new SSK keypair. - * + * * @return A callback with the keypair * @throws IOException * if an I/O error occurs communicating with the node @@ -251,8 +347,23 @@ public class HighLevelClient { } /** + * Sets whether to watch the global queue. + * + * @param enabled + * true to watch the global queue in addition to + * the client-local queue, false 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 * @throws IOException * if an I/O error occurs with the node @@ -268,7 +379,7 @@ public class HighLevelClient { /** * Adds the peer whose noderef is stored in the given file. - * + * * @param nodeRefFile * The name of the file the peer’s noderef is stored in * @return A peer callback @@ -286,7 +397,7 @@ public class HighLevelClient { /** * Adds the peer whose noderef is stored in the given file. - * + * * @param nodeRefURL * The URL where the peer’s noderef is stored * @return A peer callback @@ -304,7 +415,7 @@ public class HighLevelClient { /** * Adds the peer whose noderef is stored in the given file. - * + * * @param nodeRef * The peer’s noderef * @return A peer callback @@ -324,7 +435,7 @@ public class HighLevelClient { * Checks whether direct disk access for the given directory is possible. * You have to perform this check before you can upload or download anything * from or the disk directly! - * + * * @param directory * The directory to check * @param wantRead @@ -346,7 +457,7 @@ public class HighLevelClient { * Starts a download. Files can either be download to disk or streamed from * the node. When downloading to disk you have to perform a direct disk * access check for the directory you want to put the downloaded file in! - * + * * @see #checkDirectDiskAccess(String, boolean, boolean) * @param uri * The URI to get @@ -370,13 +481,33 @@ 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 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(new RequestListResult(identifier)); + } + fcpConnection.sendMessage(listPersistentRequests); + return requestListCallback; + } + // // PRIVATE METHODS // /** * Generates an identifier for the given function. - * + * * @param function * The name of the function * @return An identifier @@ -386,8 +517,23 @@ 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 null + * if there was no exception + */ + private void disconnect(Throwable throwable) { + if (fcpConnection != null) { + fcpConnection.close(); + } + fireClientDisconnected(throwable); + } + + /** * FCP listener for {@link HighLevelClient}. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> * @version $Id$ */ @@ -410,7 +556,7 @@ public class HighLevelClient { /** * Searches all callback collections for a callback with the given * identifier and cancels it. - * + * * @param identifier * The identifier to search for, or null to * cancel all pending requests @@ -423,6 +569,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 */ @@ -491,7 +642,7 @@ public class HighLevelClient { /** * Reads the given file and returns the first line of the file. - * + * * @param readFilename * The name of the file to read * @return The content of the file @@ -515,7 +666,7 @@ public class HighLevelClient { /** * Writes the given content to the given file. - * + * * @param directDiskAccessResult * The DDA result * @param writeFilename @@ -541,7 +692,7 @@ public class HighLevelClient { /** * Cleans up any files that written for the given result. - * + * * @param directDiskAccessResult * The direct disk access result */ @@ -560,14 +711,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); } /** @@ -631,8 +784,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) { - /* TODO */ + 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; + } } /** @@ -701,6 +865,7 @@ public class HighLevelClient { connectCallback.setDone(); connectCallback = null; } + fireClientConnected(); } /** @@ -755,9 +920,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; } } @@ -766,16 +938,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) { - /* TODO */ + 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) { - /* TODO */ + if (fcpConnection != HighLevelClient.this.fcpConnection) { + return; + } + synchronized (syncObject) { + if (requestListCallback != null) { + RequestListResult requestListResult = requestListCallback.getIntermediaryResult(); + requestListResult.addRequestResult(new PutDirRequestResult(persistentPutDir)); + return; + } + } } /** @@ -883,8 +1075,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); } /**